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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
#!/usr/bin/env python3
# encoding: utf-8
"""Script to find unused includes.
Call from src directory.
"""
import copy
import os.path
import re
import sys
# Find includes
HEADER_REGEX = re.compile(r'^#include\s+\"(\S+)\"$')
# Detect symbols
USING_OR_CONSTEXPR_REGEX = re.compile(r'.*(using|constexpr).*\s+(\w+)\s+=')
CLASS_REGEX = re.compile(r'.*(class|enum|struct)\s+(\S+)\s+.*{')
DEFINE_REGEX = re.compile(r'\#define\s+(\w+)')
STRING_CONSTANT_REGEX = re.compile(
r'.*const\sstd::string\s+(k\w+|\w+_\w+)\s+=\s+\"\S+\";')
EXTERN_OR_TYPEDEF_REGEX = re.compile(r'(extern|typedef)\s+\S+\s+(\S+);')
INLINE_FUNCTION_OR_STATIC_CONST_REGEX = re.compile(
r'(inline|static const)\s+\S+\s+(\S+)\(')
FORWARD_DECLARATION_REGEX = re.compile(r'(class|struct)\s+(\S+);')
# Special regex for #include "graphic/text/rt_errors.h" and Map_Object_Packet
MACRO_CLASS_DEFINITION_REGEX = re.compile(r'^[A-Z_0-9]+\((\w+)\)$')
# For .cc files and DIFFICULT_FILES
FUNCTION_REGEX = re.compile(
r'(^|.*\s+)([a-zA-Z_0-9][a-zA-Z_0-9]{2,})\(.*(\)|,).*')
# Header files with contents that are too hard to detect by regex
FILE_EXCLUDES = {'graphic/gl/system_headers.h', 'scripting/lua.h',
'third_party/eris/lua.hpp', 'scripting/eris.h',
'base/format/abstract_node.h',
'third_party/tinygettext/include/tinygettext/tinygettext.hpp'}
# Headers files with contents that need to be detected by functions
DIFFICULT_FILES = {'graphic/build_texture_atlas.h', 'base/string.h', 'wlapplication_options.h',
'scripting/report_error.h', 'editor/tools/set_resources_tool.h',
'third_party/libmd/include/sha2.h'}
# Remove overgenerated symbols
FUNCTION_EXCLUDES = {'_Pragma',
'assert',
'memset',
'operator',
'time',
'TODO',
'what'}
INCLUDE_GUARD_REGEX = re.compile(r'WL_[A-Z_]+_H')
def find_classes(file_to_check, include_functions, special_regex, special_regex_group):
"""Returns a set of classes defined by this file."""
classes = set()
with open(file_to_check, 'r', encoding='utf-8') as f:
for line in f.readlines():
line = line.strip()
# Skip comments
if line.startswith('*') or line.startswith('/'):
continue
match = CLASS_REGEX.match(line)
if match and len(match.groups()) == 2:
classes.add(match.groups()[1])
match = USING_OR_CONSTEXPR_REGEX.match(line)
if match and len(match.groups()) > 1:
classes.add(match.groups()[1])
match = DEFINE_REGEX.match(line)
if match and len(match.groups()) == 1:
classes.add(match.groups()[0])
match = STRING_CONSTANT_REGEX.match(line)
if match and len(match.groups()) == 1:
classes.add(match.groups()[0])
match = EXTERN_OR_TYPEDEF_REGEX.match(line)
if match and len(match.groups()) > 1:
classes.add(match.groups()[1])
match = MACRO_CLASS_DEFINITION_REGEX.match(line)
if match and len(match.groups()) == 1:
classes.add(match.groups()[0])
match = INLINE_FUNCTION_OR_STATIC_CONST_REGEX.match(line)
if match and len(match.groups()) == 2:
classes.add(match.groups()[1])
match = FORWARD_DECLARATION_REGEX.match(line)
if match and len(match.groups()) == 2:
classes.add(match.groups()[1])
if include_functions:
match = FUNCTION_REGEX.match(line)
if match and len(match.groups()) > 1:
if not match.groups()[1] in FUNCTION_EXCLUDES:
classes.add(match.groups()[1])
return classes
def find_includes(file_to_check):
"""Returns a set of includes."""
files = set()
with open(file_to_check, 'r', encoding='utf-8') as f:
for line in f.readlines():
line = line.strip()
# Skip comments
if line.startswith('*') or line.startswith('/'):
continue
match = HEADER_REGEX.match(line)
if match and len(match.groups()) == 1:
include_file = match.groups()[0]
if os.path.isfile(include_file):
files.add(include_file)
return files
def check_file(file_to_check, include_functions):
"""Checks if the includes in this file are needed, and returns the ones
that aren't."""
hits = []
with open(file_to_check, 'r', encoding='utf-8') as f:
file_contents = f.read()
header_files = find_includes(file_to_check)
for header_file in header_files:
header_classes = set()
is_useful = False
if header_file in FILE_EXCLUDES:
# Too hard to detect, so we assume the include is needed
continue
elif header_file in DIFFICULT_FILES:
# Search with function regex switched on
header_classes = find_classes(header_file, True, None, 0)
else:
# Search with function regex switched on/off according to include_functions
header_classes = find_classes(
header_file, include_functions, None, 0)
for header_class in header_classes:
if INCLUDE_GUARD_REGEX.match(header_class):
# We're not interested in the include guards
continue
if header_class in file_contents:
is_useful = True
break
if not is_useful:
hits.append(header_file)
return hits
def check_forward_declarations(file_to_check):
"""Detect unused and extraneous forward declarations."""
hits = set()
# Collect al classes defined in all headers
header_classes = set()
header_files = find_includes(file_to_check)
for header_file in header_files:
for header_class in find_classes(header_file, False, None, 0):
header_classes.add(header_class)
with open(file_to_check, 'r', encoding='utf-8') as f:
forward_declarations = set()
for line in f.readlines():
line = line.strip()
# Skip comments
if line.startswith('*') or line.startswith('/'):
continue
match = FORWARD_DECLARATION_REGEX.match(line)
if match and len(match.groups()) == 2:
# Add new forward declaration to set
forward_declarations.add(match.groups()[1])
else:
# We can't remove while iterating, so we create a copy
temp_declarations = copy.copy(forward_declarations)
for forward_declaration in forward_declarations:
if forward_declaration in line:
# Forward declaration is being used, so we remove it from the
# set of declarations to check/report
temp_declarations.remove(forward_declaration)
# Let's check if it's already defined by a directly included
# header though.
# If it is, we report it anyway.
if forward_declaration in header_classes:
hits.add(forward_declaration)
forward_declarations = temp_declarations
for forward_declaration in forward_declarations:
hits.add(forward_declaration)
return hits
def main():
"""Script to find unused includes and print them to console.
Call from src directory.
"""
error_count = 0
print('Tool to check for superfluous includes in header files. Call from src directory.')
print('Checking...')
for (dirpath, _, filenames) in os.walk('.'):
for filename in filenames:
full_path = os.path.join(dirpath, filename)
hits = []
if filename.endswith('.h') or filename.endswith('.hpp'):
hits = check_file(full_path, False)
forward_declarations = check_forward_declarations(full_path)
if forward_declarations:
print('\nSuperfluous forward declarations in ' + full_path)
for hit in forward_declarations:
print('\t' + hit)
error_count = error_count + len(forward_declarations)
elif filename.endswith('.cc'):
hits = check_file(full_path, True)
if hits:
print('\nSuperfluous includes in ' + full_path)
for hit in hits:
print('\t' + hit)
error_count = error_count + len(hits)
if error_count > 0:
print('\nFound %d error(s).' % error_count)
return 1
else:
print('\nDone, files are clean.')
return 0
if __name__ == '__main__':
sys.exit(main())
|