scripts/convert-ly.py

   1 #!@TARGET_PYTHON@
   2
   3 # convert-ly.py -- Update old LilyPond input files (fix name?)
   4 # converting rules are found in python/convertrules.py
   5
   6 # This file is part of LilyPond, the GNU music typesetter.
   7 #
   8 # Copyright (C) 1998--2011  Han-Wen Nienhuys <hanwen@xs4all.nl>
   9 #                 Jan Nieuwenhuizen <janneke@gnu.org>
  10 #
  11 # LilyPond is free software: you can redistribute it and/or modify
  12 # it under the terms of the GNU General Public License as published by
  13 # the Free Software Foundation, either version 3 of the License, or
  14 # (at your option) any later version.
  15 #
  16 # LilyPond is distributed in the hope that it will be useful,
  17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 # GNU General Public License for more details.
  20 #
  21 # You should have received a copy of the GNU General Public License
  22 # along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 import os
  25 import sys
  26 import re
  27
  28 """
  29 @relocate-preamble@
  30 """
  31
  32 import lilylib as ly
  33 global _;_=ly._
  34
  35 ly.require_python_version ()
  36
  37 import convertrules
  38
  39 lilypond_version_re_str = '\\\\version *\"([0-9.]+)"'
  40 lilypond_version_re = re.compile (lilypond_version_re_str)
  41
  42
  43 help_summary = (
  44 _ ('''Update LilyPond input to newer version.  By default, update from the
  45 version taken from the \\version command, to the current LilyPond version.''')
  46 + _ ("Examples:")
  47 + '''
  48   $ convert-ly -e old.ly
  49   $ convert-ly --from=2.3.28 --to=2.5.21 foobar.ly > foobar-new.ly
  50 ''')
  51
  52 copyright = ('Jan Nieuwenhuizen <janneke@gnu.org>',
  53              'Han-Wen Nienhuys <hanwen@xs4all.nl>')
  54
  55 program_name = os.path.basename (sys.argv[0])
  56 program_version = '@TOPLEVEL_VERSION@'
  57
  58 authors = ('Jan Nieuwenhuizen <janneke@gnu.org>',
  59            'Han-Wen Nienhuys <hanwen@xs4all.nl>')
  60
  61 def identify ():
  62     ly.progress ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
  63
  64 def warranty ():
  65     identify ()
  66     ly.encoded_write (sys.stdout, '''
  67 %s
  68
  69 %s
  70
  71 %s
  72 %s
  73 ''' % ( _ ('Copyright (c) %s by') % '2001--2011',
  74         ' '.join (authors),
  75         _ ('Distributed under terms of the GNU General Public License.'),
  76         _ ('It comes with NO WARRANTY.')))
  77
  78 def get_option_parser ():
  79     p = ly.get_option_parser (usage=_ ("%s [OPTION]... FILE") % 'convert-ly',
  80                   description=help_summary,
  81                   add_help_option=False)
  82
  83     p.version="@TOPLEVEL_VERSION@"
  84     p.add_option("--version",
  85                  action="version",
  86                  help=_ ("show version number and exit"))
  87
  88     p.add_option("-h", "--help",
  89                  action="help",
  90                  help=_ ("show this help and exit"))
  91
  92     p.add_option ('-f', '--from',
  93               action="store",
  94               metavar=_ ("VERSION"),
  95               dest="from_version",
  96               help=_ ("start from VERSION [default: \\version found in file]"),
  97               default='')
  98
  99     p.add_option ('-e', '--edit', help=_ ("edit in place"),
 100               action='store_true')
 101
 102     p.add_option ("-l", "--loglevel",
 103                   help=_ ("Print log messages according to LOGLEVEL "
 104                           "(NONE, ERROR, WARNING, PROGRESS (default), DEBUG)"),
 105                   metavar=_ ("LOGLEVEL"),
 106                   action='callback',
 107                   callback=ly.handle_loglevel_option,
 108                   type='string')
 109
 110     p.add_option ('-n', '--no-version',
 111               help=_ ("do not add \\version command if missing"),
 112               action='store_true',
 113               dest='skip_version_add',
 114               default=False)
 115
 116     p.add_option ('-c', '--current-version',
 117               help=_ ("force updating \\version number to %s") % program_version,
 118               action='store_true',
 119               dest='force_current_version',
 120               default=False)
 121
 122     p.add_option ('-d', '--diff-version-update',
 123               help=_ ("only update \\version number if file is modified"),
 124               action='store_true',
 125               dest='diff_version_update',
 126               default=False)
 127
 128     p.add_option ("-s", '--show-rules',
 129               help=_ ("show rules [default: -f 0, -t %s]") % program_version,
 130               dest='show_rules',
 131               action='store_true', default=False)
 132
 133     p.add_option ('-t', '--to',
 134               help=_ ("convert to VERSION [default: %s]") % program_version,
 135               metavar=_ ('VERSION'),
 136               action='store',
 137               dest="to_version",
 138               default='')
 139     p.add_option ('-w', '--warranty', help=_ ("show warranty and copyright"),
 140            action='store_true',
 141            ),
 142     p.add_option_group ('',
 143                         description=(
 144             _ ("Report bugs via %s")
 145             % 'http://post.gmane.org/post.php'
 146             '?group=gmane.comp.gnu.lilypond.bugs') + '\n')
 147
 148     return p
 149
 150
 151
 152 def str_to_tuple (s):
 153     return tuple ([int(n) for n in s.split ('.')])
 154
 155 def tup_to_str (t):
 156     return '.'.join (['%s' % x for x in t])
 157
 158 def version_cmp (t1, t2):
 159     for x in [0, 1, 2]:
 160         if t1[x] - t2[x]:
 161             return t1[x] - t2[x]
 162     return 0
 163
 164 def get_conversions (from_version, to_version):
 165     def is_applicable (v, f = from_version, t = to_version):
 166         return version_cmp (v[0], f) > 0 and version_cmp (v[0], t) <= 0
 167     return filter (is_applicable, convertrules.conversions)
 168
 169 def latest_version ():
 170     return convertrules.conversions[-1][0]
 171
 172 def show_rules (file, from_version, to_version):
 173     for x in convertrules.conversions:
 174         if (not from_version or x[0] > from_version) \
 175            and (not to_version or x[0] <= to_version):
 176             ly.encoded_write  (file, '%s: %s\n' % (tup_to_str (x[0]), x[2]))
 177
 178 def do_conversion (str, from_version, to_version):
 179     """Apply conversions from FROM_VERSION to TO_VERSION.  Return
 180 tuple (LAST,STR), with the last successful conversion and the resulting
 181 string."""
 182     conv_list = get_conversions (from_version, to_version)
 183
 184     ly.progress (_ ("Applying conversion: "), newline = False)
 185
 186     last_conversion = ()
 187     try:
 188         if not conv_list:
 189             last_conversion = to_version
 190         for x in conv_list:
 191             if x != conv_list[-1]:
 192                 ly.progress (tup_to_str (x[0]), newline = False)
 193                 ly.progress (', ', newline = False)
 194             else:
 195                 ly.progress (tup_to_str (x[0]))
 196             str = x[1] (str)
 197             last_conversion = x[0]
 198
 199     except convertrules.FatalConversionError:
 200         ly.error (_ ("Error while converting")
 201                   + '\n'
 202                   + _ ("Stopping at last successful rule"))
 203
 204     return (last_conversion, str)
 205
 206
 207
 208 def guess_lilypond_version (input):
 209     m = lilypond_version_re.search (input)
 210     if m:
 211         return m.group (1)
 212     else:
 213         return ''
 214
 215 class FatalConversionError (Exception):
 216     pass
 217
 218 class UnknownVersion (Exception):
 219     pass
 220
 221 class InvalidVersion (Exception):
 222     def __init__ (self, version):
 223       self.version = version
 224
 225 def do_one_file (infile_name):
 226     ly.progress (_ ("Processing `%s\'... ") % infile_name, True)
 227
 228     if infile_name:
 229         infile = open (infile_name, 'r')
 230         input = infile.read ()
 231         infile.close ()
 232     else:
 233         input = sys.stdin.read ()
 234
 235     from_version = None
 236     to_version = None
 237     if global_options.from_version:
 238         from_version = global_options.from_version
 239     else:
 240         guess = guess_lilypond_version (input)
 241         if not guess:
 242             raise UnknownVersion ()
 243         from_version = str_to_tuple (guess)
 244
 245     if global_options.to_version:
 246         to_version = global_options.to_version
 247     else:
 248         to_version = latest_version ()
 249
 250     if len (from_version) != 3:
 251         raise InvalidVersion (".".join ([str(n) for n in from_version]))
 252
 253
 254     (last, result) = do_conversion (input, from_version, to_version)
 255
 256     if last:
 257         if global_options.force_current_version and last == to_version:
 258             last = str_to_tuple (program_version)
 259
 260         if global_options.diff_version_update:
 261             if result == input:
 262                 # check the y in x.y.z  (minor version number)
 263                 previous_stable = (last[0], 2*(last[1]/2), 0)
 264                 if ((last[0:2] != from_version[0:2]) and
 265                     (previous_stable > from_version)):
 266                     # previous stable version
 267                     last = previous_stable
 268                 else:
 269                     # make no (actual) change to the version number
 270                     last = from_version
 271
 272         newversion = r'\version "%s"' % tup_to_str (last)
 273         if lilypond_version_re.search (result):
 274             result = re.sub (lilypond_version_re_str,
 275                      '\\' + newversion, result)
 276         elif not global_options.skip_version_add:
 277             result = newversion + '\n' + result
 278
 279         ly.progress ('\n')
 280
 281         if global_options.edit:
 282             try:
 283                 os.remove(infile_name + '~')
 284             except:
 285                 pass
 286             os.rename (infile_name, infile_name + '~')
 287             outfile = open (infile_name, 'w')
 288         else:
 289             outfile = sys.stdout
 290
 291
 292         outfile.write (result)
 293
 294     sys.stderr.flush ()
 295
 296 def do_options ():
 297     opt_parser = get_option_parser()
 298     (options, args) = opt_parser.parse_args ()
 299
 300     if options.warranty:
 301         warranty ()
 302         sys.exit (0)
 303
 304     if options.from_version:
 305         options.from_version = str_to_tuple (options.from_version)
 306     if options.to_version:
 307         options.to_version = str_to_tuple (options.to_version)
 308
 309     options.outfile_name = ''
 310     global global_options
 311     global_options = options
 312
 313     if not args and not options.show_rules:
 314         opt_parser.print_help ()
 315         sys.exit (2)
 316
 317     return args
 318
 319 def main ():
 320     files = do_options ()
 321
 322     # should parse files[] to read \version?
 323     if global_options.show_rules:
 324         show_rules (sys.stdout, global_options.from_version, global_options.to_version)
 325         sys.exit (0)
 326
 327     identify ()
 328
 329     for f in files:
 330         if f == '-':
 331             f = ''
 332         elif not os.path.isfile (f):
 333             ly.error (_ ("%s: Unable to open file") % f)
 334             if len (files) == 1:
 335                 sys.exit (1)
 336             continue
 337         try:
 338             do_one_file (f)
 339         except UnknownVersion:
 340             ly.error (_ ("%s: Unable to determine version.  Skipping") % f)
 341         except InvalidVersion:
 342             # Compat code for 2.x and 3.0 syntax ("except .. as v" doesn't
 343             # work in python 2.4!):
 344             t, v, b = sys.exc_info ()
 345             ly.error (_ ("%s: Invalid version string `%s' \n"
 346                          "Valid version strings consist of three numbers, "
 347                          "separated by dots, e.g. `2.8.12'") % (f, v.version) )
 348
 349
 350 main ()