summaryrefslogtreecommitdiffstats
path: root/Tools/scripts/classfix.py
blob: 7ec0e7a44d654b2203ed247bd186ad1a5613a9b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
#! /ufs/guido/bin/sgi/python
#! /usr/local/bin/python

# Fix Python source files to use the new class definition syntax, i.e.,
#	class C() = base(), base(), ...: ...
# is changed to
#	class C(base, base, ...): ...
# The script uses heuristics to find class definitions that usually
# work but occasionally can fail; carefully check the output!
#
# Command line arguments are files or directories to be processed.
# Directories are searched recursively for files whose name looks
# like a python module.
# Symbolic links are always ignored (except as explicit directory
# arguments).  Of course, the original file is kept as a back-up
# (with a "~" attached to its name).
#
# Changes made are reported to stdout in a diff-like format.
#
# Undoubtedly you can do this using find and sed or perl, but this is
# a nice example of Python code that recurses down a directory tree
# and uses regular expressions.  Also note several subtleties like
# preserving the file's mode and avoiding to even write a temp file
# when no changes are needed for a file.
#
# NB: by changing only the function fixline() you can turn this
# into a program for a different change to Python programs...

import sys
import regex
import os
from stat import *

err = sys.stderr.write
dbg = err
rep = sys.stdout.write

def main():
	bad = 0
	if not sys.argv[1:]: # No arguments
		err('usage: ' + sys.argv[0] + ' file-or-directory ...\n')
		sys.exit(2)
	for arg in sys.argv[1:]:
		if os.path.isdir(arg):
			if recursedown(arg): bad = 1
		elif os.path.islink(arg):
			err(arg + ': will not process symbolic links\n')
			bad = 1
		else:
			if fix(arg): bad = 1
	sys.exit(bad)

ispythonprog = regex.compile('^[a-zA-Z0-9_]+\.py$')
def ispython(name):
	return ispythonprog.match(name) >= 0

def recursedown(dirname):
	dbg('recursedown(' + `dirname` + ')\n')
	bad = 0
	try:
		names = os.listdir(dirname)
	except os.error, msg:
		err(dirname + ': cannot list directory: ' + `msg` + '\n')
		return 1
	names.sort()
	subdirs = []
	for name in names:
		if name in (os.curdir, os.pardir): continue
		fullname = os.path.join(dirname, name)
		if os.path.islink(fullname): pass
		elif os.path.isdir(fullname):
			subdirs.append(fullname)
		elif ispython(name):
			if fix(fullname): bad = 1
	for fullname in subdirs:
		if recursedown(fullname): bad = 1
	return bad

def fix(filename):
##	dbg('fix(' + `filename` + ')\n')
	try:
		f = open(filename, 'r')
	except IOError, msg:
		err(filename + ': cannot open: ' + `msg` + '\n')
		return 1
	head, tail = os.path.split(filename)
	tempname = os.path.join(head, '@' + tail)
	g = None
	# If we find a match, we rewind the file and start over but
	# now copy everything to a temp file.
	lineno = 0
	while 1:
		line = f.readline()
		if not line: break
		lineno = lineno + 1
		while line[-2:] == '\\\n':
			nextline = f.readline()
			if not nextline: break
			line = line + nextline
			lineno = lineno + 1
		newline = fixline(line)
		if newline != line:
			if g is None:
				try:
					g = open(tempname, 'w')
				except IOError, msg:
					f.close()
					err(tempname+': cannot create: '+\
					    `msg`+'\n')
					return 1
				f.seek(0)
				lineno = 0
				rep(filename + ':\n')
				continue # restart from the beginning
			rep(`lineno` + '\n')
			rep('< ' + line)
			rep('> ' + newline)
		if g is not None:
			g.write(newline)

	# End of file
	f.close()
	if not g: return 0 # No changes

	# Finishing touch -- move files

	# First copy the file's mode to the temp file
	try:
		statbuf = os.stat(filename)
		os.chmod(tempname, statbuf[ST_MODE] & 07777)
	except os.error, msg:
		err(tempname + ': warning: chmod failed (' + `msg` + ')\n')
	# Then make a backup of the original file as filename~
	try:
		os.rename(filename, filename + '~')
	except os.error, msg:
		err(filename + ': warning: backup failed (' + `msg` + ')\n')
	# Now move the temp file to the original file
	try:
		os.rename(tempname, filename)
	except os.error, msg:
		err(filename + ': rename failed (' + `msg` + ')\n')
		return 1
	# Return succes
	return 0

# This expression doesn't catch *all* class definition headers,
# but it's pretty darn close.
classexpr = '^\([ \t]*class +[a-zA-Z0-9_]+\) *( *) *\(\(=.*\)?\):'
classprog = regex.compile(classexpr)

# Expressions for finding base class expressions.
baseexpr = '^ *\(.*\) *( *) *$'
baseprog = regex.compile(baseexpr)

import string

def fixline(line):
	if classprog.match(line) < 0: # No 'class' keyword -- no change
		return line
	
	(a0, b0), (a1, b1), (a2, b2) = classprog.regs[:3]
	# a0, b0 = Whole match (up to ':')
	# a1, b1 = First subexpression (up to classname)
	# a2, b2 = Second subexpression (=.*)
	head = line[:b1]
	tail = line[b0:] # Unmatched rest of line
	
	if a2 == b2: # No base classes -- easy case
		return head + ':' + tail
	
	# Get rid of leading '='
	basepart = line[a2+1:b2]

	# Extract list of base expressions
	bases = string.splitfields(basepart, ',')
	
	# Strip trailing '()' from each base expression
	for i in range(len(bases)):
		if baseprog.match(bases[i]) >= 0:
			x1, y1 = baseprog.regs[1]
			bases[i] = bases[i][x1:y1]
	
	# Join the bases back again and build the new line
	basepart = string.joinfields(bases, ', ')
	
	return head + '(' + basepart + '):' + tail

main()
/span> count; } /* Generic argument list parser */ static int do_arg PROTO((object *arg, char** p_format, va_list *p_va)); static int do_arg(arg, p_format, p_va) object *arg; char** p_format; va_list *p_va; { char *format = *p_format; va_list va = *p_va; if (arg == NULL) return 0; /* Incomplete tuple or list */ switch (*format++) { case '(': /* tuple, distributed over C parameters */ { int i, n; if (!is_tupleobject(arg)) return 0; n = gettuplesize(arg); for (i = 0; i < n; i++) { if (!do_arg(gettupleitem(arg, i), &format, &va)) return 0; } if (*format++ != ')') return 0; break; } case ')': /* End of format -- too many arguments */ return 0; case 'b': /* byte -- very short int */ { char *p = va_arg(va, char *); if (is_intobject(arg)) *p = getintvalue(arg); else return 0; break; } case 'h': /* short int */ { short *p = va_arg(va, short *); if (is_intobject(arg)) *p = getintvalue(arg); else return 0; break; } case 'i': /* int */ { int *p = va_arg(va, int *); if (is_intobject(arg)) *p = getintvalue(arg); else return 0; break; } case 'l': /* long int */ { long *p = va_arg(va, long *); if (is_intobject(arg)) *p = getintvalue(arg); else return 0; break; } case 'f': /* float */ { float *p = va_arg(va, float *); if (is_floatobject(arg)) *p = getfloatvalue(arg); else if (is_intobject(arg)) *p = (float)getintvalue(arg); else return 0; break; } case 'd': /* double */ { double *p = va_arg(va, double *); if (is_floatobject(arg)) *p = getfloatvalue(arg); else if (is_intobject(arg)) *p = (double)getintvalue(arg); else return 0; break; } case 'c': /* char */ { char *p = va_arg(va, char *); if (is_stringobject(arg) && getstringsize(arg) == 1) *p = getstringvalue(arg)[0]; else return 0; break; } case 's': /* string */ { char **p = va_arg(va, char **); if (is_stringobject(arg)) *p = getstringvalue(arg); else return 0; if (*format == '#') { int *q = va_arg(va, int *); *q = getstringsize(arg); format++; } else if (strlen(*p) != getstringsize(arg)) { err_setstr(ValueError, "embedded '\\0' in string arg"); return 0; } break; } case 'z': /* string, may be NULL (None) */ { char **p = va_arg(va, char **); if (arg == None) *p = 0; else if (is_stringobject(arg)) *p = getstringvalue(arg); else return 0; if (*format == '#') { int *q = va_arg(va, int *); if (arg == None) *q = 0; else *q = getstringsize(arg); format++; } else if (*p != NULL && strlen(*p) != getstringsize(arg)) { err_setstr(ValueError, "embedded '\\0' in string arg"); return 0; } break; } case 'S': /* string object */ { object **p = va_arg(va, object **); if (is_stringobject(arg)) *p = arg; else return 0; break; } case 'O': /* object */ { object **p = va_arg(va, object **); *p = arg; break; } default: fprintf(stderr, "bad do_arg format: x%x '%c'\n", format[-1], format[-1]); return 0; } *p_va = va; *p_format = format; return 1; } #ifdef USE_STDARG /* VARARGS2 */ int getargs(object *arg, char *format, ...) #else /* VARARGS */ int getargs(va_alist) va_dcl #endif { char *f; int ok; va_list va; #ifdef USE_STDARG va_start(va, format); #else object *arg; char *format; va_start(va); arg = va_arg(va, object *); format = va_arg(va, char *); #endif if (*format == '\0') { va_end(va); if (arg != NULL) { err_setstr(TypeError, "no arguments needed"); return 0; } return 1; } f = format; ok = do_arg(arg, &f, &va) && *f == '\0'; va_end(va); if (!ok) { char buf[256]; if (!err_occurred()) { sprintf(buf, "bad argument list (format '%s')", format); err_setstr(TypeError, buf); } } return ok; } int getlongtuplearg(args, a, n) object *args; long *a; /* [n] */ int n; { int i; if (!is_tupleobject(args) || gettuplesize(args) != n) { return err_badarg(); } for (i = 0; i < n; i++) { object *v = gettupleitem(args, i); if (!is_intobject(v)) { return err_badarg(); } a[i] = getintvalue(v); } return 1; } int getshorttuplearg(args, a, n) object *args; short *a; /* [n] */ int n; { int i; if (!is_tupleobject(args) || gettuplesize(args) != n) { return err_badarg(); } for (i = 0; i < n; i++) { object *v = gettupleitem(args, i); if (!is_intobject(v)) { return err_badarg(); } a[i] = getintvalue(v); } return 1; } int getlonglistarg(args, a, n) object *args; long *a; /* [n] */ int n; { int i; if (!is_listobject(args) || getlistsize(args) != n) { return err_badarg(); } for (i = 0; i < n; i++) { object *v = getlistitem(args, i); if (!is_intobject(v)) { return err_badarg(); } a[i] = getintvalue(v); } return 1; } int getshortlistarg(args, a, n) object *args; short *a; /* [n] */ int n; { int i; if (!is_listobject(args) || getlistsize(args) != n) { return err_badarg(); } for (i = 0; i < n; i++) { object *v = getlistitem(args, i); if (!is_intobject(v)) { return err_badarg(); } a[i] = getintvalue(v); } return 1; } /* Generic function to create a value -- the inverse of getargs() */ /* After an original idea and first implementation by Steven Miale */ static object *do_mktuple PROTO((char**, va_list *, int, int)); static object *do_mkvalue PROTO((char**, va_list *)); static object * do_mktuple(p_format, p_va, endchar, n) char **p_format; va_list *p_va; int endchar; int n; { object *v; int i; if (n < 0) return NULL; if ((v = newtupleobject(n)) == NULL) return NULL; for (i = 0; i < n; i++) { object *w = do_mkvalue(p_format, p_va); if (w == NULL) { DECREF(v); return NULL; } settupleitem(v, i, w); } if (v != NULL && **p_format != endchar) { DECREF(v); v = NULL; err_setstr(SystemError, "Unmatched paren in format"); } else if (endchar) ++*p_format; return v; } static object * do_mkvalue(p_format, p_va) char **p_format; va_list *p_va; { switch (*(*p_format)++) { case '(': return do_mktuple(p_format, p_va, ')', countformat(*p_format, ')')); case 'b': case 'h': case 'i': return newintobject((long)va_arg(*p_va, int)); case 'l': return newintobject((long)va_arg(*p_va, long)); case 'f': case 'd': return newfloatobject((double)va_arg(*p_va, double)); case 'c': { char p[1]; p[0] = va_arg(*p_va, int); return newsizedstringobject(p, 1); } case 's': case 'z': { object *v; char *str = va_arg(*p_va, char *); int n; if (**p_format == '#') { ++*p_format; n = va_arg(*p_va, int); } else n = -1; if (str == NULL) { v = None; INCREF(v); } else { if (n < 0) n = strlen(str); v = newsizedstringobject(str, n); } return v; } case 'S': case 'O': { object *v; v = va_arg(*p_va, object *); if (v != NULL) INCREF(v); else if (!err_occurred()) /* If a NULL was passed because a call that should have constructed a value failed, that's OK, and we pass the error on; but if no error occurred it's not clear that the caller knew what she was doing. */ err_setstr(SystemError, "NULL object passed to mkvalue"); return v; } default: err_setstr(SystemError, "bad format char passed to mkvalue"); return NULL; } } #ifdef USE_STDARG /* VARARGS 2 */ object *mkvalue(char *format, ...) #else /* VARARGS */ object *mkvalue(va_alist) va_dcl #endif { int n; char *f; va_list va; object* retval; #ifdef USE_STDARG va_start(va, format); #else char *format; va_start(va); format = va_arg(va, char *); #endif f = format; n = countformat(f, '\0'); if (n < 0) retval = NULL; /* Error in the format */ else if (n == 0) { retval = None; INCREF(retval); } else if (n == 1) retval = do_mkvalue(&f, &va); else retval = do_mktuple(&f, &va, '\0', n); va_end(va); if (retval == NULL) fprintf(stderr, "format \"%s\", f \"%s\"\n", format, f); return retval; }