]> git.donarmstrong.com Git - lilypond.git/blobdiff - scripts/convert-ly.py
Add '-dcrop' option to ps and svg backends
[lilypond.git] / scripts / convert-ly.py
index e613eb39c0f8802e713cb84c5d0b8e6a30a9d831..d473ec26f5f416ab7fb5472ffb878d7f8168455a 100644 (file)
@@ -5,7 +5,7 @@
 
 # This file is part of LilyPond, the GNU music typesetter.
 #
-# Copyright (C) 1998--2010  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
@@ -24,6 +24,7 @@
 import os
 import sys
 import re
+import shutil
 
 """
 @relocate-preamble@
@@ -39,10 +40,15 @@ import convertrules
 lilypond_version_re_str = '\\\\version *\"([0-9.]+)"'
 lilypond_version_re = re.compile (lilypond_version_re_str)
 
+lilypond_version_strict_re_str = '\\\\version *\"([0-9]+[.][0-9]+[.][0-9]+)"'
+lilypond_version_strict_re = re.compile (lilypond_version_strict_re_str)
 
 help_summary = (
 _ ('''Update LilyPond input to newer version.  By default, update from the
 version taken from the \\version command, to the current LilyPond version.''')
++ "\n"
++ _ ("If FILE is `-', read from standard input.")
++ "\n\n"
 + _ ("Examples:")
 + '''
   $ convert-ly -e old.ly
@@ -58,16 +64,8 @@ program_version = '@TOPLEVEL_VERSION@'
 authors = ('Jan Nieuwenhuizen <janneke@gnu.org>',
            'Han-Wen Nienhuys <hanwen@xs4all.nl>')
 
-error_file_write = ly.stderr_write
-
-def warning (s):
-    ly.stderr_write (program_name + ": " + _ ("warning: %s") % s + '\n')
-
-def error (s):
-    ly.stderr_write (program_name + ": " + _ ("error: %s") % s + '\n')
-
-def identify (port=sys.stderr):
-    ly.encoded_write (port, '%s (GNU LilyPond) %s\n' % (program_name, program_version))
+def identify ():
+    ly.progress ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
 
 def warranty ():
     identify ()
@@ -78,7 +76,7 @@ def warranty ():
 
 %s
 %s
-''' % ( _ ('Copyright (c) %s by') % '2001--2010',
+''' % ( _ ('Copyright (c) %s by') % '2001--2015',
         ' '.join (authors),
         _ ('Distributed under terms of the GNU General Public License.'),
         _ ('It comes with NO WARRANTY.')))
@@ -107,6 +105,14 @@ def get_option_parser ():
     p.add_option ('-e', '--edit', help=_ ("edit in place"),
               action='store_true')
 
+    p.add_option ("-l", "--loglevel",
+                  help=_ ("Print log messages according to LOGLEVEL "
+                          "(NONE, ERROR, WARNING, PROGRESS (default), DEBUG)"),
+                  metavar=_ ("LOGLEVEL"),
+                  action='callback',
+                  callback=ly.handle_loglevel_option,
+                  type='string')
+
     p.add_option ('-n', '--no-version',
               help=_ ("do not add \\version command if missing"),
               action='store_true',
@@ -124,18 +130,25 @@ def get_option_parser ():
               action='store_true',
               dest='diff_version_update',
               default=False)
-    
+
     p.add_option ("-s", '--show-rules',
               help=_ ("show rules [default: -f 0, -t %s]") % program_version,
               dest='show_rules',
               action='store_true', default=False)
-    
+
     p.add_option ('-t', '--to',
               help=_ ("convert to VERSION [default: %s]") % program_version,
               metavar=_ ('VERSION'),
               action='store',
               dest="to_version",
               default='')
+
+    p.add_option ('-b', '--backup-numbered',
+              help=_ ("make a numbered backup [default: filename.ext~]"),
+              action='store_true',
+              dest="backup_numbered",
+              default='')
+
     p.add_option ('-w', '--warranty', help=_ ("show warranty and copyright"),
            action='store_true',
            ),
@@ -147,8 +160,6 @@ def get_option_parser ():
     
     return p
 
-
-
 def str_to_tuple (s):
     return tuple ([int(n) for n in s.split ('.')])
 
@@ -177,36 +188,44 @@ def show_rules (file, from_version, to_version):
 
 def do_conversion (str, from_version, to_version):
     """Apply conversions from FROM_VERSION to TO_VERSION.  Return
-tuple (LAST,STR), with the last successful conversion and the resulting
-string."""
+tuple (LAST,LASTCHANGED,STR,ERRORS), with the last applied conversion,
+the last conversion resulting in a change, the resulting
+string and the number of errors."""
     conv_list = get_conversions (from_version, to_version)
 
-    error_file_write (_ ("Applying conversion: "))
-        
-    last_conversion = ()
+    ly.progress (_ ("Applying conversion: "), newline = False)
+
+    last_conversion = None
+    last_change = None
+    errors = 0
     try:
         for x in conv_list:
-            error_file_write (tup_to_str (x[0]))
             if x != conv_list[-1]:
-                error_file_write (', ')
-            str = x[1] (str)
+                ly.progress (tup_to_str (x[0]), newline = False)
+                ly.progress (', ', newline = False)
+            else:
+                ly.progress (tup_to_str (x[0]))
+            newstr = x[1] (str)
             last_conversion = x[0]
+            if (newstr != str):
+                last_change = last_conversion
+            str = newstr
 
     except convertrules.FatalConversionError:
-        error_file_write ('\n'
-                          + _ ("Error while converting")
-                          + '\n'
-                          + _ ("Stopping at last successful rule")
-                          + '\n')
-
-    return (last_conversion, str)
-
+        ly.error (_ ("Error while converting")
+                  + '\n'
+                  + _ ("Stopping at last successful rule"))
+        errors += 1
 
+    return (last_conversion, last_change, str, errors)
 
 def guess_lilypond_version (input):
-    m = lilypond_version_re.search (input)
+    m = lilypond_version_strict_re.search (input)
     if m:
         return m.group (1)
+    m = lilypond_version_re.search (input)
+    if m:
+        raise InvalidVersion (m.group (1))
     else:
         return ''
 
@@ -220,9 +239,21 @@ class InvalidVersion (Exception):
     def __init__ (self, version):
       self.version = version
 
+def back_up (file, numbered):
+    if numbered:
+      n = 0
+      while True:
+        n = n + 1
+        back_up = file + '.~' + str(n) + '~'
+        if not os.path.exists (back_up):
+            break
+    else:
+      back_up = file + '~'
+    shutil.copy2 (file, back_up)
+    return back_up
+
 def do_one_file (infile_name):
-    ly.stderr_write (_ ("Processing `%s\'... ") % infile_name)
-    sys.stderr.write ('\n')
+    ly.progress (_ (u"Processing `%s\'... ") % infile_name, True)
 
     if infile_name:
         infile = open (infile_name, 'r')
@@ -231,15 +262,13 @@ def do_one_file (infile_name):
     else:
         input = sys.stdin.read ()
 
-    from_version = None
     to_version = None
-    if global_options.from_version:
-        from_version = global_options.from_version
-    else:
-        guess = guess_lilypond_version (input)
-        if not guess:
-            raise UnknownVersion ()
-        from_version = str_to_tuple (guess)
+    org_version = None
+    guess = guess_lilypond_version (input)
+    org_version = guess and str_to_tuple (guess)
+    from_version = global_options.from_version or org_version
+    if not from_version:
+        raise UnknownVersion ()
 
     if global_options.to_version:
         to_version = global_options.to_version
@@ -250,23 +279,29 @@ def do_one_file (infile_name):
         raise InvalidVersion (".".join ([str(n) for n in from_version]))
 
 
-    (last, result) = do_conversion (input, from_version, to_version)
+    (last, last_change, result, errors) = \
+        do_conversion (input, from_version, to_version)
 
+    if global_options.force_current_version and \
+            (last is None or last == to_version):
+        last = str_to_tuple (program_version)
     if last:
-        if global_options.force_current_version and last == to_version:
-            last = str_to_tuple (program_version)
-
         if global_options.diff_version_update:
+            # Note that last_change can be set even if the result is
+            # the same if two conversion rules cancelled out
             if result == input:
-                # check the y in x.y.z  (minor version number)
-                previous_stable = (last[0], 2*(last[1]/2), 0)
-                if ((last[0:2] != from_version[0:2]) and
-                    (previous_stable > from_version)):
-                    # previous stable version
-                    last = previous_stable
-                else:
-                    # make no (actual) change to the version number
-                    last = from_version
+                # make no (actual) change to the version number
+                last = org_version or from_version
+            else:
+                last = last_change
+                # If the last update was to an unstable version
+                # number, and the final update target is no longer in
+                # the same unstable series, we update to the stable
+                # series following the unstable version.
+                if last[1]%2: # unstable
+                    next_stable = (last[0], last[1]+1, 0)
+                    if next_stable <= to_version:
+                        last = next_stable
 
         newversion = r'\version "%s"' % tup_to_str (last)
         if lilypond_version_re.search (result):
@@ -274,24 +309,21 @@ def do_one_file (infile_name):
                      '\\' + newversion, result)
         elif not global_options.skip_version_add:
             result = newversion + '\n' + result
-            
-        error_file_write ('\n')            
-    
-        if global_options.edit:
-            try:
-                os.remove(infile_name + '~')
-            except:
-                pass
-            os.rename (infile_name, infile_name + '~')
-            outfile = open (infile_name, 'w')
-        else:
-            outfile = sys.stdout
 
+    ly.progress ('\n')
 
-        outfile.write (result)
+    if global_options.edit:
+        backup = back_up (infile_name, global_options.backup_numbered)
+        outfile = open (infile_name, 'w')
+    else:
+        outfile = sys.stdout
 
+    outfile.write (result)
+    
     sys.stderr.flush ()
 
+    return errors
+
 def do_options ():
     opt_parser = get_option_parser()
     (options, args) = opt_parser.parse_args ()
@@ -323,28 +355,34 @@ def main ():
         show_rules (sys.stdout, global_options.from_version, global_options.to_version)
         sys.exit (0)
 
-    identify (sys.stderr)
+    identify ()
 
+    errors = 0
     for f in files:
+        f = f.decode (sys.stdin.encoding or "utf-8")
         if f == '-':
             f = ''
         elif not os.path.isfile (f):
-            error (_ ("%s: Unable to open file") % f)
-            if len (files) == 1:
-                sys.exit (1)
+            ly.error (_ (u"%s: Unable to open file") % f)
+            errors += 1
             continue
         try:
-            do_one_file (f)
+            errors += do_one_file (f)
         except UnknownVersion:
-            error (_ ("%s: Unable to determine version.  Skipping") % f)
+            ly.error (_ (u"%s: Unable to determine version.  Skipping") % f)
+            errors += 1
         except InvalidVersion:
             # Compat code for 2.x and 3.0 syntax ("except .. as v" doesn't 
             # work in python 2.4!):
             t, v, b = sys.exc_info ()
-            error (_ ("%s: Invalid version string `%s' \n"
-                      "Valid version strings consist of three numbers, "
-                      "separated by dots, e.g. `2.8.12'") % (f, v.version) )
-
-    sys.stderr.write ('\n')
+            ly.error (_ (u"%s: Invalid version string `%s' \n"
+                         "Valid version strings consist of three numbers, "
+                         "separated by dots, e.g. `2.8.12'") % (f, v.version) )
+            errors += 1
+
+    if errors:
+        ly.warning (ly.ungettext ("There was %d error.",
+            "There were %d errors.", errors) % errors)
+        sys.exit (1)
 
 main ()