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
|
#!/usr/bin/env python3
#
# Arm SCP/MCP Software
# Copyright (c) 2015-2020, Arm Limited and Contributors. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
"""
Check for trailing spaces and non-UNIX line endings in the source code.
"""
import argparse
import os
import re
import shutil
import subprocess
import sys
import tempfile
import fnmatch
#
# Directories to exclude
#
EXCLUDE_DIRECTORIES = [
'.git',
'build',
'tools',
'cmsis',
'product/rcar/src/CMSIS-FreeRTOS',
]
#
# Exclude patterns (applied to files only)
#
EXCLUDE = [
'*.html',
'*.xml',
'*.css',
'*.gif',
'*.dat',
'*.pyc',
'*.jar',
'*.md',
'*.swp',
'*.a',
'*.pdf',
]
KEYWORDS = [
'for',
'if',
'switch',
'while',
]
#
# File types for which spaces after keywords will be corrected
#
FILE_TYPES = [
'*.c',
'*.h',
]
def is_valid_type(filename):
for file_type in FILE_TYPES:
if fnmatch.fnmatch(filename, file_type):
return True
return False
def main(argv=[], prog_name=''):
parser = argparse.ArgumentParser(prog=prog_name)
parser.add_argument('-t', '--trim',
help='Remove trailing spaces.',
action='store_true',
default=False)
parser.add_argument('-c', '--correct',
help='Correct spaces after keywords.',
action='store_true',
default=False)
args = parser.parse_args(argv)
print('Checking for incorrect spacing in the code...')
if args.trim:
print("Trim mode is enabled.")
if args.correct:
print("Correct mode is enabled.")
regex_patterns = dict.fromkeys(KEYWORDS, 0)
trailing_spaces_count = 0
trailing_lines_count = 0
correct_spaces_count = 0
modified_files = 0
non_unix_eol_files = 0
cwd = os.getcwd()
print("Executing from {}".format(cwd))
for i, directory in enumerate(EXCLUDE_DIRECTORIES):
EXCLUDE_DIRECTORIES[i] = os.path.abspath(directory)
print("\tAdding to the exclude list: {}"
.format(EXCLUDE_DIRECTORIES[i]))
for root, dirs, files in os.walk(cwd, topdown=True):
#
# Exclude directories based on the EXCLUDE_DIRECTORIES pattern list
#
dirs[:] = [d for d in dirs
if os.path.join(root, d) not in EXCLUDE_DIRECTORIES]
#
# Exclude files based on the EXCLUDE pattern list
#
matches = list()
for filename in files:
for file_pattern in EXCLUDE:
if fnmatch.fnmatch(filename, file_pattern):
matches.append(filename)
break
for match in matches:
files.remove(match)
for keyword in KEYWORDS:
regex_patterns[keyword] = re.compile(
'(.*\\W)(%s)(\\s*)(\\(.*)' % keyword)
#
# Check files
#
for filename in files:
path = os.path.join(root, filename)
content = ''
trailing_spaces = 0
trailing_lines = 0
incorrect_spaces = 0
with open(path, encoding="utf-8") as file:
for line, string in enumerate(file):
# Note that all newlines are converted to '\n',
# so the following will work regardless of
# what the underlying file format is using to
# represent a line break.
if string.endswith(' \n'):
print('{}:{} has trailing space'.format(line, path))
trailing_spaces += 1
if args.trim:
string = string.rstrip()+'\n'
if not is_valid_type(os.path.basename(path)):
content += string
continue
for keyword in KEYWORDS:
key_index = string.find(keyword)
if key_index == -1:
continue
m = regex_patterns[keyword].search(string)
if m and m.group(3) != ' ':
incorrect_spaces += 1
print('Abnormal spacing. "{}", {}:{} --> {}'
.format(keyword, path, line,
string.rstrip()))
if args.correct:
string = m.group(1) + m.group(2) + ' ' + \
m.group(4) + '\n'
content += string
if content.endswith('\n\n'):
print('Blank line at the end of file --> {}'.format(path))
c_len = len(content)
if args.trim:
content = content.rstrip()+'\n'
trailing_lines += c_len - len(content.rstrip() + '\n')
#
# If file.newlines has been set it is either a string with
# the determined line ending or a tuple with all the line
# endings we have encountered
#
if file.newlines:
if isinstance(file.newlines, tuple):
print('{} has mixed line endings'.format(path))
non_unix_eol_files += 1
elif file.newlines != '\n':
print('{} has non-UNIX line endings'.format(path))
non_unix_eol_files += 1
#
# Trim and/or correct file, depending on the provided arguments
#
write_file = False
if args.trim and (trailing_spaces or trailing_lines) != 0:
print("Trimming {}...".format(path))
write_file = True
if args.correct and incorrect_spaces != 0:
print("Correcting {}...".format(path))
write_file = True
if write_file:
modified_files += 1
with open(path, 'w') as file:
file.write(content)
trailing_spaces_count += trailing_spaces
trailing_lines_count += trailing_lines
correct_spaces_count += incorrect_spaces
if trailing_spaces_count == 0:
print("No trailing spaces found")
else:
print('{} trailing spaces found.'.format(trailing_spaces_count))
if trailing_lines_count == 0:
print("No trailing lines found")
else:
print('{} trailing lines found.'.format(trailing_lines_count))
if correct_spaces_count == 0:
print("No abnormal spaces found")
else:
print('Abnormal spaces found on {} lines.'
.format(correct_spaces_count))
if (args.trim or args.correct) and modified_files:
print("{} files modified".format(modified_files))
if non_unix_eol_files == 0:
print("No files with non-UNIX or mixed line endings found")
else:
print("{} files have non-UNIX or mixed line endings"
.format(non_unix_eol_files))
if (trailing_spaces_count or
trailing_lines_count or
correct_spaces_count or
non_unix_eol_files):
return 1
return 0
if __name__ == '__main__':
sys.exit(main(sys.argv[1:], sys.argv[0]))
|
