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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
#!/usr/bin/env python3
from __future__ import unicode_literals, division, print_function, absolute_import
import os
import re
import sys
from abirules_tools import find_abinit_toplevel_directory, find_src_dirs
# Init regular expressions
re_m4file = re.compile("\.m4$")
re_hdrfile = re.compile("\.h$")
re_f90file = re.compile("\.F90$")
re_acdef = re.compile("AC_DEFINE\\(")
re_cppdef = re.compile("^([ ]?)+#([ ]?)+define [0-9A-Z_]*")
re_cppline = re.compile("^#")
re_cppcont = re.compile("\\$")
#re_cppskip = re.compile("^#(include|define|undef|if 0|if 1|endif|error)")
re_cppskip = re.compile("(^#(include|define|undef|if 0|if 1|endif|error|warning))|(__\w+)")
re_cppdev = re.compile("DEV_")
# Init CPP options
cpp_blocks = [["HAVE"],["CONFIG"],["H"]]
cpp_explicit = [
"HAVE_TEST_TIME_PARTITIONING",
"i386",
"DFTI_CHECK",
"XC_MAJOR_VERSION",
"XC_MINOR_VERSION",
]
cpp_ignored = [
"HAVE_CONFIG_H",
"HAVE_IBM6",
"HAVE_LIBPAW_ABINIT",
"LIBPAW_HAVE_FOX",
]
cpp_keywords = ("#","endif","ifdef","ifndef","elif","if","else","defined","[<>=]=?[ ]*[0-9]*","\\|\\|","&&","\\(","\\)","!")
# Naming convention checker
def check_name(cpp_option,cpp_blocks):
opt = cpp_option.split("_")
ret = True
for i in range(len(opt)):
ret = (opt[i] in cpp_blocks[i])
if ( not ret ):
break
return ret
def main():
top = find_abinit_toplevel_directory()
verbose = 0
# Extract CPP options from the libPAW header files
#libpaw_dir = os.path.join(top, "src", "39_libpaw")
libpaw_dir = os.path.join(top, "shared", "libpaw")
assert os.path.isdir(libpaw_dir)
cpp_libpaw = list()
for root,dirs,files in os.walk(libpaw_dir):
for src in files:
if ( re_hdrfile.search(src) ):
with open(os.path.join(root,src), "rt") as fh:
for line in fh:
if ( re_cppdef.search(line) ):
tmp_def = re.sub("^[# ]*define[ ]*([0-9A-Z_]*).*","\\1",line).strip()
if ( not tmp_def in cpp_libpaw ):
cpp_libpaw.append(tmp_def)
# Extract CPP options from the libTetra header files
libtetra_dir = os.path.join(top, "shared", "common", "src", "17_libtetra_ext")
assert os.path.isdir(libtetra_dir)
cpp_libtetra = list()
for root,dirs,files in os.walk(libtetra_dir):
for src in files:
if ( re_hdrfile.search(src) ):
with open(os.path.join(root,src), "rt") as fh:
for line in fh:
if ( re_cppdef.search(line) ):
tmp_def = re.sub("^[# ]*define[ ]*([0-9A-Z_]*).*","\\1",line).strip()
if ( not tmp_def in cpp_libtetra ):
cpp_libtetra.append(tmp_def)
# Extract CPP options from the build system
cpp_buildsys = list()
m4_path = os.path.join(top, "config", "m4")
assert os.path.isdir(m4_path)
for root,dirs,files in os.walk(m4_path):
for src in files:
if ( src.endswith(".m4") ):
with open(os.path.join(root, src), "rt") as fh:
for line in fh:
if re_acdef.search(line):
tmp_def = re.sub(".*AC_DEFINE\\([\\[]?([^\\],]*).*","\\1",line).strip()
if not tmp_def in cpp_buildsys:
cpp_buildsys.append(tmp_def)
with open(os.path.join(top, "configure.ac"), "rt") as fh:
for line in fh:
if ( re_acdef.search(line) ):
tmp_def = re.sub(".*AC_DEFINE\\([\\[]?([^\\],]*).*","\\1",line).strip()
if ( not tmp_def in cpp_buildsys ):
cpp_buildsys.append(tmp_def)
cpp_buildsys = cpp_buildsys + cpp_libpaw + cpp_libtetra
cpp_buildsys.sort()
# Create CPP naming blocks
for opt in cpp_buildsys:
tmp = opt.split("_")
for i in range(len(tmp)):
if ( i >= len(cpp_blocks) ):
cpp_blocks.append(list())
if ( not tmp[i] in cpp_blocks[i] ):
cpp_blocks[i].append(tmp[i])
# Extract CPP options from the includes
incs_dir = os.path.join(top, "src", "incs")
assert os.path.isdir(incs_dir)
cpp_includes = list()
for root,dirs,files in os.walk(incs_dir):
for src in files:
if not re_hdrfile.search(src): continue
with open(os.path.join(root,src), "rt") as fh:
for line in fh:
if re_cppdef.search(line):
tmp_def = re.sub("^[# ]*define[ ]*([0-9A-Z_]*).*","\\1",line).strip()
if not tmp_def in cpp_includes:
cpp_includes.append(tmp_def)
cpp_includes.sort()
# Merge CPP information
cpp_allowed = cpp_explicit + cpp_buildsys
cpp_allowed.sort()
# Explore the source files
cpp_source = dict()
#src_dir = os.path.join(top, "src")
#assert os.path.isdir(src_dir)
for src_dir in find_src_dirs():
for root,dirs,files in os.walk(src_dir):
files.sort()
for src in files:
if re_f90file.search(src):
with open(os.path.join(root, src), "rt") as fh:
f90_buffer = fh.readlines()
cpp_load = False
for i in range(len(f90_buffer)):
line = f90_buffer[i]
# Record CPP lines
if ( re_cppline.search(line) ):
if ( cpp_load ):
sys.stderr.write("%s: %s:%d: Error: unterminated CPP directive\n" % \
(my_name,src,i+1))
sys.exit(1)
cpp_load = True
cpp_buffer = ""
# Process CPP lines
if ( cpp_load ):
cpp_buffer += line
if ( not re_cppcont.search(line) ):
if ( not re_cppskip.search(line) ):
# Extract CPP options
for kwd in cpp_keywords:
cpp_buffer = re.sub(kwd,"",cpp_buffer)
cpp_buffer = re.sub("[\n\t ]+"," ",cpp_buffer)
cpp_buffer = cpp_buffer.strip()
cpp_buffer = cpp_buffer.split()
# Register CPP options
for opt in cpp_buffer:
if ( not opt in cpp_ignored ):
if ( not opt in cpp_source ):
cpp_source[opt] = list()
cpp_source[opt].append("%s/%s:%d" % (root,src,i+1))
# Reset
cpp_load = False
# Process CPP option information
cpp_keys = list(cpp_source.keys())
cpp_keys.sort()
cpp_devel = [opt for opt in cpp_keys \
if ( opt in cpp_explicit or re_cppdev.match(opt) )]
cpp_undefined = [opt for opt in cpp_keys \
if not ( (opt in cpp_allowed) or (opt in cpp_devel) )]
cpp_misnamed = [opt for opt in cpp_keys \
if not ( check_name(opt,cpp_blocks) or (opt in cpp_undefined) or
(opt in cpp_devel) ) ]
cpp_misnamed += [opt for opt in cpp_includes \
if ( opt in cpp_source and not (check_name(opt,cpp_blocks) or opt in cpp_devel))]
cpp_misnamed.sort()
# Display forbidden CPP options
if ( (verbose and (len(cpp_devel) > 0)) or (len(cpp_undefined) > 0) ):
sys.stderr.write("%s: reporting preprocessing option discrepancies\n\n" % \
(os.path.basename(sys.argv[0])))
sys.stderr.write("X: N=Wrong Naming / U=Undefined\n\n")
if ( verbose and (len(cpp_devel) > 0) ):
sys.stderr.write("%s %-24s %-44s\n" % ("X","Developer option","Location"))
sys.stderr.write("%s %-24s %-44s\n" % ("-","-" *24,"-" * 48))
for opt in cpp_devel:
if ( len(cpp_source[opt]) <= 50 ):
for src in cpp_source[opt]:
sys.stderr.write("* %-24s %-48s\n" % (opt,src))
else:
sys.stderr.write("* %-24s Not shown (referenced %d times)\n" % \
(opt,len(cpp_source[opt])))
sys.stderr.write("\n")
retval = len(cpp_undefined) + len(cpp_misnamed)
if retval != 0:
sys.stderr.write("%s %-24s %-44s\n" % ("X","Forbidden option","Location"))
sys.stderr.write("%s %-24s %-44s\n" % ("-","-" *24,"-" * 48))
for opt in cpp_undefined:
if ( len(cpp_source[opt]) <= 50 ):
for src in cpp_source[opt]:
sys.stderr.write("U %-24s %-48s\n" % (opt,src))
else:
sys.stderr.write("U %-24s Not shown (referenced %d times)\n" % \
(opt,len(cpp_source[opt])))
for opt in cpp_misnamed:
sys.stderr.write("N %-24s N/A\n" % (opt))
sys.stderr.write("\n")
return retval
if __name__ == "__main__":
sys.exit(main())
|
