scripts/convert-ly.py

   1 #!@PYTHON@
   2 #
   3 # convert-ly.py -- Update old LilyPond input files (fix name?)
   4 #
   5 # source file of the GNU LilyPond music typesetter
   6 #
   7 # (c) 1998--2006  Han-Wen Nienhuys <hanwen@cs.uu.nl>
   8 #                 Jan Nieuwenhuizen <janneke@gnu.org>
   9 #
  10 # converting rules are found in python/convertrules.py
  11 #
  12
  13 import os
  14 import sys
  15 import string
  16 import re
  17
  18
  19 datadir = '@local_lilypond_datadir@'
  20 if not os.path.isdir (datadir):
  21         datadir = '@lilypond_datadir@'
  22
  23 sys.path.insert (0, os.path.join (datadir, 'python'))
  24
  25 if os.environ.has_key ('LILYPONDPREFIX'):
  26         datadir = os.environ['LILYPONDPREFIX']
  27         while datadir[-1] == os.sep:
  28                 datadir= datadir[:-1]
  29
  30         datadir = os.path.join (datadir, "share/lilypond/current/")
  31 sys.path.insert (0, os.path.join (datadir, 'python'))
  32
  33 # dynamic relocation, for GUB binaries.
  34 bindir = os.path.split (sys.argv[0])[0]
  35 for p in ['share', 'lib']:
  36         datadir = os.path.abspath (bindir + '/../%s/lilypond/current/python/' % p)
  37         sys.path.insert (0, datadir)
  38
  39 import lilylib as ly
  40 global _;_=ly._
  41
  42 from convertrules import *
  43
  44 lilypond_version_re_str = '\\\\version *\"([0-9.]+)"'
  45 lilypond_version_re = re.compile (lilypond_version_re_str)
  46
  47
  48 help_summary = _ (
  49 '''Update LilyPond input to newer version.  By default, update from the
  50 version taken from the \\version command, to the current LilyPond version.
  51
  52 Examples:
  53
  54   convert-ly -e old.ly
  55   convert-ly --from=2.3.28 --to 2.5.21 foobar.ly
  56 ''')
  57
  58 copyright = ('Jan Nieuwenhuizen <janneke@gnu.org>',
  59              'Han-Wen Nienhuys <hanwen@cs.uu.nl>')
  60
  61 program_name = os.path.basename (sys.argv[0])
  62 program_version = '@TOPLEVEL_VERSION@'
  63
  64 add_version = 1
  65
  66 def warning (s):
  67         sys.stderr.write (program_name + ": " + _ ("warning: %s") % s + '\n')
  68
  69 def error (s):
  70         sys.stderr.write (program_name + ": " + _ ("error: %s") % s + '\n')
  71
  72 def identify (port=sys.stderr):
  73         port.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
  74
  75 def warranty ():
  76         identify ()
  77         sys.stdout.write ('''
  78 Copyright (c) %s by
  79
  80   Han-Wen Nienhuys
  81   Jan Nieuwenhuizen
  82
  83 %s
  84 %s
  85 '''  ( '2001--2006',
  86        _('Distributed under terms of the GNU General Public License.'),
  87        _('It comes with NO WARRANTY.')))
  88
  89
  90
  91 def get_option_parser ():
  92         p = ly.get_option_parser (usage='lilypond-book [OPTIONS] FILE',
  93                                   version="@TOPLEVEL_VERSION@",
  94                                   description=help_summary)
  95
  96         p.add_option ('-f', '--from',
  97                       action="store",
  98                       metavar=_ ("VERSION"),
  99                       dest="from_version",
 100                       help=_('start from VERSION [default: \\version found in file]'),
 101                       default='')
 102
 103         p.add_option ('-e', '--edit', help=_('edit in place'),
 104                       action='store_true')
 105         p.add_option ('-n', '--no-version',
 106                       help=_ ('do not add \\version command if missing'),
 107                       action='store_true',
 108                       dest='skip_version_add',
 109                       default=False)
 110
 111         p.add_option ("-s", '--show-rules',
 112                       help=_('print rules [default: --from=0, --to=@TOPLEVEL_VERSION@]'),
 113                       action='store_true', default=False)
 114
 115         p.add_option ('-t', '--to',
 116                       help=_('convert to VERSION [default: @TOPLEVEL_VERSION@]'),
 117                       metavar=_('VERSION'),
 118                       action='store',
 119                       dest="to_version",
 120                       default='')
 121
 122         p.add_option_group  ('bugs',
 123                              description='''Report bugs via http://post.gmane.org/post.php'''
 124                              '''?group=gmane.comp.gnu.lilypond.bugs\n''')
 125
 126         return p
 127
 128
 129
 130 def str_to_tuple (s):
 131         return tuple (map (int, string.split (s, '.')))
 132
 133 def tup_to_str (t):
 134         return string.join (map (lambda x: '%s' % x, list (t)), '.')
 135
 136 def version_cmp (t1, t2):
 137         for x in [0, 1, 2]:
 138                 if t1[x] - t2[x]:
 139                         return t1[x] - t2[x]
 140         return 0
 141
 142 def get_conversions (from_version, to_version):
 143         def is_applicable (v, f = from_version, t = to_version):
 144                 return version_cmp (v[0], f) > 0 and version_cmp (v[0], t) <= 0
 145         return filter (is_applicable, conversions)
 146
 147 def latest_version ():
 148         return conversions[-1][0]
 149
 150 def show_rules (file, from_version, to_version):
 151         for x in conversions:
 152                 if (not from_version or x[0] > from_version) \
 153                    and (not to_version or x[0] <= to_version):
 154                         file.write  ('%s: %s\n' % (tup_to_str (x[0]), x[2]))
 155
 156 def do_conversion (str, from_version, to_version):
 157         """Apply conversions from FROM_VERSION to TO_VERSION.  Return
 158 tuple (LAST,STR), with the last succesful conversion and the resulting
 159 string."""
 160         conv_list = get_conversions (from_version, to_version)
 161
 162         if error_file:
 163                 error_file.write (_ ("Applying conversion: "))
 164
 165         last_conversion = ()
 166         try:
 167                 for x in conv_list:
 168                         error_file.write (tup_to_str (x[0]))
 169                         if x != conv_list[-1]:
 170                                 error_file.write (', ')
 171                         str = x[1] (str)
 172                         last_conversion = x[0]
 173
 174         except FatalConversionError:
 175                 error_file.write (_ ("error while converting"))
 176                 error_file.write ('\n')
 177                 error_file.write (_ ("Aborting"))
 178                 error_file.write ('\n')
 179
 180
 181
 182         return (last_conversion, str)
 183
 184
 185
 186 def guess_lilypond_version (filename):
 187         s = open (filename).read ()
 188         m = lilypond_version_re.search (s)
 189         if m:
 190                 return m.group (1)
 191         else:
 192                 return ''
 193
 194 class FatalConversionError:
 195         pass
 196
 197 class UnknownVersion:
 198         pass
 199
 200 def do_one_file (infile_name):
 201         sys.stderr.write (_ ("Processing `%s\'... ") % infile_name)
 202         sys.stderr.write ('\n')
 203
 204         from_version = None
 205         to_version = None
 206         if global_options.from_version:
 207                 from_version = global_options.from_version
 208         else:
 209                 guess = guess_lilypond_version (infile_name)
 210                 if not guess:
 211                         raise UnknownVersion ()
 212                 from_version = str_to_tuple (guess)
 213
 214         if global_options.to_version:
 215                 to_version = global_options.to_version
 216         else:
 217                 to_version = latest_version ()
 218
 219
 220         if infile_name:
 221                 infile = open (infile_name, 'r')
 222         else:
 223                 infile = sys.stdin
 224
 225
 226         (last, result) = do_conversion (infile.read (), from_version, to_version)
 227         infile.close ()
 228
 229         if last:
 230                 newversion = r'\version "%s"' % tup_to_str (last)
 231                 if lilypond_version_re.search (result):
 232                         result = re.sub (lilypond_version_re_str,
 233                                          '\\' + newversion, result)
 234                 elif add_version:
 235                         result = newversion + '\n' + result
 236
 237                 error_file.write ('\n')
 238
 239                 if global_options.edit:
 240                         try:
 241                                 os.remove(infile_name + '~')
 242                         except:
 243                                 pass
 244                         os.rename (infile_name, infile_name + '~')
 245                         outfile = open (infile_name, 'w')
 246                 else:
 247                         outfile = sys.stdout
 248
 249
 250                 outfile.write (result)
 251
 252         sys.stderr.flush ()
 253
 254 def do_options ():
 255         opt_parser = get_option_parser()
 256         (options, args) = opt_parser.parse_args ()
 257
 258
 259         if options.from_version:
 260                 options.from_version = str_to_tuple (options.from_version)
 261         if options.to_version:
 262                 options.to_version = str_to_tuple (options.to_version)
 263
 264         options.outfile_name = ''
 265         global global_options
 266         global_options = options
 267
 268         if not args:
 269                 opt_parser.print_help ()
 270                 sys.exit (2)
 271
 272         return args
 273
 274 def main ():
 275         files = do_options ()
 276
 277         # should parse files[] to read \version?
 278         if global_options.show_rules:
 279                 show_rules (sys.stdout, global_options.from_version, global_options.to_version)
 280                 sys.exit (0)
 281
 282         identify (sys.stderr)
 283
 284         for f in files:
 285                 if f == '-':
 286                         f = ''
 287                 elif not os.path.isfile (f):
 288                         error (_ ("can't open file: `%s'") % f)
 289                         if len (files) == 1:
 290                                 sys.exit (1)
 291                         continue
 292                 try:
 293                         do_one_file (f)
 294                 except UnknownVersion:
 295                         error (_ ("can't determine version for `%s'. Skipping") % f)
 296
 297         sys.stderr.write ('\n')
 298
 299 main ()