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 __main__
  16 import getopt
  17 import string
  18
  19 datadir = '@local_lilypond_datadir@'
  20 if not os.path.isdir (datadir):
  21         datadir = '@lilypond_datadir@'
  22 if os.environ.has_key ('LILYPONDPREFIX'):
  23         datadir = os.environ['LILYPONDPREFIX']
  24         while datadir[-1] == os.sep:
  25                 datadir = datadir[:-1]
  26
  27 if os.path.exists (os.path.join (datadir, 'share/lilypond/@TOPLEVEL_VERSION@/')):
  28         datadir = os.path.join (datadir, 'share/lilypond/@TOPLEVEL_VERSION@/')
  29
  30 sys.path.insert (0, os.path.join (datadir, 'python'))
  31
  32 import lilylib as ly
  33 import fontextract
  34 global _;_=ly._
  35 global re;re = ly.re
  36
  37 from convertrules import *
  38
  39
  40 help_summary = _ (
  41 '''Update LilyPond input to newer version.  By default, update from the
  42 version taken from the \\version command, to the current LilyPond version.
  43
  44 Examples:
  45
  46   convert-ly -e old.ly
  47   convert-ly --from=2.3.28 --to 2.5.21 foobar.ly
  48 ''')
  49
  50 copyright = ('Jan Nieuwenhuizen <janneke@gnu.org>',
  51              'Han-Wen Nienhuys <hanwen@cs.uu.nl>')
  52
  53 option_definitions = [
  54         ('', 'e', 'edit',_('edit in place')),
  55         (_('VERSION'), 'f', 'from',
  56          _('start from VERSION [default: \\version found in file]')),
  57         ('', 'h', 'help',_('print this help')),
  58         ('',  'n', 'no-version',_ ('do not add \\version command if missing')),
  59         ('','s', 'show-rules', _('print rules [default: --from=0, --to=@TOPLEVEL_VERSION@]')),
  60         (_('VERSION'), 't', 'to',_('convert to VERSION [default: @TOPLEVEL_VERSION@]')),
  61         ('','v','version',_('print program version"'))
  62 ]
  63
  64 program_name = os.path.basename (sys.argv[0])
  65 program_version = '@TOPLEVEL_VERSION@'
  66
  67 add_version = 1
  68
  69 def str_to_tuple (s):
  70         return tuple (map (string.atoi, string.split (s, '.')))
  71
  72 def tup_to_str (t):
  73         return string.join (map (lambda x: '%s' % x, list (t)), '.')
  74
  75 def version_cmp (t1, t2):
  76         for x in [0, 1, 2]:
  77                 if t1[x] - t2[x]:
  78                         return t1[x] - t2[x]
  79         return 0
  80
  81 def get_conversions (from_version, to_version):
  82         def is_applicable (v, f = from_version, t = to_version):
  83                 return version_cmp (v[0], f) > 0 and version_cmp (v[0], t) <= 0
  84         return filter (is_applicable, conversions)
  85
  86 def latest_version ():
  87         return conversions[-1][0]
  88
  89 def show_rules (file, from_version, to_version):
  90         for x in conversions:
  91                 if (not from_version or x[0] > from_version) \
  92                    and (not to_version or x[0] <= to_version):
  93                         file.write  ('%s: %s\n' % (tup_to_str (x[0]), x[2]))
  94
  95 def do_conversion (str, from_version, to_version):
  96         """Apply conversions from FROM_VERSION to TO_VERSION.  Return
  97 tuple (LAST,STR), with the last succesful conversion and the resulting
  98 string."""
  99         conv_list = get_conversions (from_version, to_version)
 100
 101         if error_file:
 102                 error_file.write (_ ("Applying conversion: "))
 103
 104         last_conversion = ()
 105         try:
 106                 for x in conv_list:
 107                         error_file.write (tup_to_str (x[0]))
 108                         if x != conv_list[-1]:
 109                                 error_file.write (', ')
 110                         str = x[1] (str)
 111                         last_conversion = x[0]
 112
 113         except FatalConversionError:
 114                 error_file.write (_ ("error while converting"))
 115                 error_file.write ('\n')
 116                 error_file.write (_ ("Aborting"))
 117                 error_file.write ('\n')
 118
 119
 120
 121         return (last_conversion, str)
 122
 123
 124
 125 def guess_lilypond_version (filename):
 126         s = open (filename).read ()
 127         m = lilypond_version_re.search (s)
 128         if m:
 129                 return m.group (1)
 130         else:
 131                 return ''
 132
 133 class FatalConversionError:
 134         pass
 135
 136 class UnknownVersion:
 137         pass
 138
 139 def do_one_file (infile_name):
 140         sys.stderr.write (_ ("Processing `%s\'... ") % infile_name)
 141         sys.stderr.write ('\n')
 142         outfile_name = ''
 143         if __main__.edit:
 144                 outfile_name = infile_name + '.NEW'
 145         elif __main__.outfile_name:
 146                 outfile_name = __main__.outfile_name
 147
 148         if __main__.from_version:
 149                 from_version = __main__.from_version
 150         else:
 151                 guess = guess_lilypond_version (infile_name)
 152                 if not guess:
 153                         raise UnknownVersion ()
 154                 from_version = str_to_tuple (guess)
 155
 156         if __main__.to_version:
 157                 to_version = __main__.to_version
 158         else:
 159                 to_version = latest_version ()
 160
 161
 162         if infile_name:
 163                 infile = open (infile_name, 'r')
 164         else:
 165                 infile = sys.stdin
 166
 167
 168         (last, result) = do_conversion (infile.read (), from_version, to_version)
 169         infile.close ()
 170
 171
 172         if last:
 173                 newversion = r'\version "%s"' % tup_to_str (last)
 174                 if lilypond_version_re.search (result):
 175                         result = re.sub (lilypond_version_re_str,
 176                                          '\\' + newversion, result)
 177                 elif add_version:
 178                         result = newversion + '\n' + result
 179
 180                 error_file.write ('\n')
 181
 182                 if __main__.edit:
 183                         try:
 184                                 os.remove(infile_name + '~')
 185                         except:
 186                                 pass
 187                         os.rename (infile_name, infile_name + '~')
 188                         outfile = open (infile_name, 'w')
 189                 else:
 190                         outfile = sys.stdout
 191
 192
 193                 outfile.write (result)
 194
 195         sys.stderr.flush ()
 196
 197 edit = 0
 198 to_version = ()
 199 from_version = ()
 200 outfile_name = ''
 201 show_rules_p = 0
 202
 203 def do_options ():
 204         global from_version, to_version, edit, show_rules_p, add_version
 205
 206         (sh, long) = ly.getopt_args (option_definitions)
 207         try:
 208                 (options, files) = getopt.getopt (sys.argv[1:], sh, long)
 209         except getopt.error, s:
 210                 sys.stderr.write ('\n')
 211                 ly.error (_ ("getopt says: `%s'" % s))
 212                 sys.stderr.write ('\n')
 213                 ly.help ()
 214                 ly.exit (2)
 215
 216         for opt in options:
 217                 o = opt[0]
 218                 a = opt[1]
 219
 220                 if o == '--help' or o == '-h':
 221                         ly.help ()
 222                         sys.exit (0)
 223                 elif o == '--version' or o == '-v':
 224                         ly.identify (sys.stdout)
 225                         sys.exit (0)
 226                 elif o== '--from' or o=='-f':
 227                         from_version = str_to_tuple (a)
 228                 elif o== '--to' or o=='-t':
 229                         to_version = str_to_tuple (a)
 230                 elif o== '--edit' or o == '-e':
 231                         edit = 1
 232                 elif o== '--show-rules' or o == '-s':
 233                         show_rules_p = 1
 234                 elif o == '--no-version' or o == '-n':
 235                         add_version = 0
 236                 else:
 237                         print o
 238                         raise getopt.error
 239
 240         return files
 241
 242
 243 def main ():
 244         files = do_options ()
 245
 246         # should parse files[] to read \version?
 247         if show_rules_p:
 248                 show_rules (sys.stdout, from_version, to_version)
 249                 sys.exit (0)
 250
 251         ly.identify (sys.stderr)
 252
 253         if not files:
 254                 ly.help ()
 255                 sys.exit (2)
 256
 257         for f in files:
 258                 if f == '-':
 259                         f = ''
 260                 elif not os.path.isfile (f):
 261                         ly.error (_ ("can't open file: `%s'") % f)
 262                         if len (files) == 1:
 263                                 sys.exit (1)
 264                         continue
 265                 try:
 266                         do_one_file (f)
 267                 except UnknownVersion:
 268                         ly.error (_ ("can't determine version for `%s'. Skipping") % f)
 269
 270         sys.stderr.write ('\n')
 271
 272 main ()