annotate Tools/scripts/ifdef.py @ 27998:e27f58a50737 legacy-trunk

SF bug #690377: Dud footnote reference in distutils docs
author Raymond Hettinger <python@rcn.com>
date Fri, 21 Feb 2003 02:47:09 +0000
parents 8a7a2f1f88f0
children 93c92f20b6bf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4573
73758db2f464 /usr/local/bin/python -> /usr/bin/env python
Guido van Rossum <guido@python.org>
parents: 1624
diff changeset
1 #! /usr/bin/env python
1624
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
2
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
3 # Selectively preprocess #ifdef / #ifndef statements.
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
4 # Usage:
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
5 # ifdef [-Dname] ... [-Uname] ... [file] ...
15930
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
6 #
1624
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
7 # This scans the file(s), looking for #ifdef and #ifndef preprocessor
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 # commands that test for one of the names mentioned in the -D and -U
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 # options. On standard output it writes a copy of the input file(s)
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
10 # minus those code sections that are suppressed by the selected
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
11 # combination of defined/undefined symbols. The #if(n)def/#else/#else
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 # lines themselfs (if the #if(n)def tests for one of the mentioned
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
13 # names) are removed as well.
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
14
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 # Features: Arbitrary nesting of recognized and unrecognized
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 # preprocesor statements works correctly. Unrecognized #if* commands
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 # are left in place, so it will never remove too much, only too
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 # little. It does accept whitespace around the '#' character.
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
19
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
20 # Restrictions: There should be no comments or other symbols on the
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
21 # #if(n)def lines. The effect of #define/#undef commands in the input
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 # file or in included files is not taken into account. Tests using
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 # #if and the defined() pseudo function are not recognized. The #elif
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 # command is not recognized. Improperly nesting is not detected.
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 # Lines that look like preprocessor commands but which are actually
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
26 # part of comments or string literals will be mistaken for
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
27 # preprocessor commands.
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
28
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
29 import sys
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 import regex
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 import getopt
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
32
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 defs = []
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
34 undefs = []
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
35
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
36 def main():
15930
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
37 opts, args = getopt.getopt(sys.argv[1:], 'D:U:')
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
38 for o, a in opts:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
39 if o == '-D':
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
40 defs.append(a)
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
41 if o == '-U':
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
42 undefs.append(a)
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
43 if not args:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
44 args = ['-']
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
45 for file in args:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
46 if file == '-':
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
47 process(sys.stdin, sys.stdout)
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
48 else:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
49 f = open(file, 'r')
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
50 process(f, sys.stdout)
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
51 f.close()
1624
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
52
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
53 def process(fpi, fpo):
15930
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
54 keywords = ('if', 'ifdef', 'ifndef', 'else', 'endif')
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
55 ok = 1
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
56 stack = []
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
57 while 1:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
58 line = fpi.readline()
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
59 if not line: break
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
60 while line[-2:] == '\\\n':
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
61 nextline = fpi.readline()
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
62 if not nextline: break
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
63 line = line + nextline
25219
8a7a2f1f88f0 Apply diff2.txt from SF patch http://www.python.org/sf/572113
Walter Dörwald <walter@livinglogic.de>
parents: 15930
diff changeset
64 tmp = line.strip()
15930
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
65 if tmp[:1] != '#':
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
66 if ok: fpo.write(line)
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
67 continue
25219
8a7a2f1f88f0 Apply diff2.txt from SF patch http://www.python.org/sf/572113
Walter Dörwald <walter@livinglogic.de>
parents: 15930
diff changeset
68 tmp = tmp[1:].strip()
8a7a2f1f88f0 Apply diff2.txt from SF patch http://www.python.org/sf/572113
Walter Dörwald <walter@livinglogic.de>
parents: 15930
diff changeset
69 words = tmp.split()
15930
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
70 keyword = words[0]
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
71 if keyword not in keywords:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
72 if ok: fpo.write(line)
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
73 continue
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
74 if keyword in ('ifdef', 'ifndef') and len(words) == 2:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
75 if keyword == 'ifdef':
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
76 ko = 1
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
77 else:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
78 ko = 0
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
79 word = words[1]
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
80 if word in defs:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
81 stack.append((ok, ko, word))
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
82 if not ko: ok = 0
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
83 elif word in undefs:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
84 stack.append((ok, not ko, word))
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
85 if ko: ok = 0
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
86 else:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
87 stack.append((ok, -1, word))
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
88 if ok: fpo.write(line)
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
89 elif keyword == 'if':
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
90 stack.append((ok, -1, ''))
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
91 if ok: fpo.write(line)
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
92 elif keyword == 'else' and stack:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
93 s_ok, s_ko, s_word = stack[-1]
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
94 if s_ko < 0:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
95 if ok: fpo.write(line)
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
96 else:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
97 s_ko = not s_ko
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
98 ok = s_ok
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
99 if not s_ko: ok = 0
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
100 stack[-1] = s_ok, s_ko, s_word
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
101 elif keyword == 'endif' and stack:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
102 s_ok, s_ko, s_word = stack[-1]
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
103 if s_ko < 0:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
104 if ok: fpo.write(line)
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
105 del stack[-1]
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
106 ok = s_ok
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
107 else:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
108 sys.stderr.write('Unknown keyword %s\n' % keyword)
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
109 if stack:
14a27acc755a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 9309
diff changeset
110 sys.stderr.write('stack: %s\n' % stack)
1624
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
111
b6b50d94125f Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
112 main()