Doc-es: various updates.

[lilypond.git] / python / lilylib.py

diff --git a/python/lilylib.py b/python/lilylib.py
index c3eb98bc6fda38f815b5bc9ebf8d41f91dd46a85..a911cac23f0a2f8bdc77503a0e0c886becc7fa6f 100644 (file)
--- a/python/lilylib.py
+++ b/python/lilylib.py
@@ -1,6 +1,6 @@
 # This file is part of LilyPond, the GNU music typesetter.
 #
-# Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
+# Copyright (C) 1998--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 #                Jan Nieuwenhuizen <janneke@gnu.org>
 #
 # LilyPond is free software: you can redistribute it and/or modify
@@ -40,9 +40,14 @@ try:
     import gettext
     t = gettext.translation ('lilypond', localedir)
     _ = t.ugettext
+    ungettext = t.ungettext
 except:
     def _ (s):
         return s
+    def ungettext (s, p, n):
+        if n == 1:
+            return s
+        return p
 underscore = _
 
 # Urg, Python 2.4 does not define stderr/stdout encoding
@@ -78,29 +83,83 @@ if at_re.match (program_version):
     else:
         program_version = "unknown"
 
+
+# Logging framework: We have the following output functions:
+#    error
+#    warning
+#    progress
+#    debug
+
+loglevels = {"NONE":0, "ERROR":1, "WARN":2, "BASIC":3, "PROGRESS":4, "INFO":5, "DEBUG":6}
+
+loglevel = loglevels["PROGRESS"]
+
+def set_loglevel (l):
+    global loglevel
+    newlevel = loglevels.get (l, -1)
+    if newlevel > 0:
+        debug_output (_ ("Setting loglevel to %s") % l)
+        loglevel = newlevel
+    else:
+        error (_ ("Unknown or invalid loglevel '%s'") % l)
+
+
+def handle_loglevel_option (option, opt_str, value, parser, *args):
+    if value:
+        set_loglevel (value);
+    elif args:
+        set_loglevel (args[0]);
+
+def is_loglevel (l):
+    global loglevel
+    return loglevel >= loglevels[l];
+
+def is_verbose ():
+    return is_loglevel ("DEBUG")
+
 def stderr_write (s):
     encoded_write (sys.stderr, s)
 
-def warning (s):
-    stderr_write (program_name + ": " + _ ("warning: %s") % s + '\n')
+def print_logmessage (level, s, fullmessage = True, newline = True):
+    if (is_loglevel (level)):
+        if fullmessage:
+            stderr_write (program_name + ": " + s + '\n')
+        elif newline:
+            stderr_write (s + '\n')
+        else:
+            stderr_write (s)
 
 def error (s):
-    stderr_write (program_name + ": " + _ ("error: %s") % s + '\n')
+    print_logmessage ("ERROR", _ ("error: %s") % s);
+
+def warning (s):
+    print_logmessage ("WARN", _ ("warning: %s") % s);
+
+def basic_progress (s):
+    print_logmessage ("BASIC", s);
+
+def progress (s, fullmessage = False, newline = True):
+    print_logmessage ("PROGRESS", s, fullmessage, newline);
+
+def debug_output (s, fullmessage = False, newline = True):
+    print_logmessage ("DEBUG", s, fullmessage, newline);
 
-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\
+        error ("Python 2.4 or newer is required to run this program.\n\
 Please upgrade Python from http://python.org/download/, and if you use MacOS X,\n\
 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
-# double quotes (since Windows can't handle the single quotes:
+# A modified version of the commands.mkarg(x) that always uses
+# double quotes (since Windows can't handle the single quotes)
+# and escapes the characters \, $, ", and ` for unix shells.
 def mkarg(x):
+    if os.name == 'nt':
+        return ' "%s"' % x
     s = ' "'
     for c in x:
         if c in '\\$"`':
@@ -142,9 +201,7 @@ def subprocess_system (cmd,
         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_filename = log_file + '.log'
         stderr_setting = open(stderr_filename, 'w')
 
     proc = subprocess.Popen (cmd,
@@ -157,9 +214,8 @@ def subprocess_system (cmd,
 
     if redirect_output:
         while proc.poll()==None:
-            time.sleep(1)
+            time.sleep(0.01)
         retval = proc.returncode
-        stdout_setting.close()
         stderr_setting.close()
     else:
         if show_progress:
@@ -176,7 +232,7 @@ def subprocess_system (cmd,
             print >>sys.stderr, "Child returned", retval
 
         if ignore_error:
-            print >>sys.stderr, "Error ignored"
+            print >>sys.stderr, "Error ignored by lilylib"
         else:
             if not show_progress:
                 print log[0]
@@ -189,6 +245,7 @@ def ossystem_system (cmd,
                      ignore_error=False,
                      progress_p=True,
                      be_verbose=False,
+                     redirect_output=False,
                      log_file=None):
 
 
@@ -278,8 +335,15 @@ class NonDentedHeadingFormatter (optparse.IndentedHelpFormatter):
     def format_description(self, description):
         return description
 
+class NonEmptyOptionParser (optparse.OptionParser):
+    "A subclass of OptionParser that gobbles empty string arguments."
+
+    def parse_args (self, args=None, values=None):
+        options, args = optparse.OptionParser.parse_args (self, args, values)
+        return options, filter (None, args)
+
 def get_option_parser (*args, **kwargs):
-    p = optparse.OptionParser (*args, **kwargs)
+    p = NonEmptyOptionParser (*args, **kwargs)
     p.formatter = NonDentedHeadingFormatter ()
     p.formatter.set_parser (p)
     return p