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
|
#!/usr/bin/env python3
#
# Arm SCP/MCP Software
# Copyright (c) 2015-2018, Arm Limited and Contributors. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
"""
Check for tabs 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',
'cmsis',
]
#
# Exclude patterns (applied to files only)
#
EXCLUDE = [
'Makefile',
'*.mk',
'*.html',
'*.xml',
'*.css',
'*.gif',
'*.dat',
'*.swp',
'*.pyc',
'.gitmodules',
'*.svg',
'*.a',
]
def convert(path):
print("\tConverting all tabs in %s into spaces..." % path)
try:
file, temp_file = tempfile.mkstemp(prefix='tabs_to_spaces_')
print("Using %s" % temp_file)
subprocess.check_call('expand -t4 %s > %s' % (path, temp_file),
shell=True)
shutil.copyfile(temp_file, path)
except Exception as e:
print("Error: Failed to convert file %s with %s" % (path, e))
sys.exit(1)
finally:
if os.path.exists(temp_file):
os.remove(temp_file)
def main(argv=[], prog_name=''):
parser = argparse.ArgumentParser(prog=prog_name)
parser.add_argument('-c', '--convert',
help='Convert tabs to 4 spaces.',
action='store_true',
default=False)
args = parser.parse_args(argv)
print('Checking the presence of tabs in the code...')
if args.convert:
print("Conversion mode is enabled.")
tabs_found_count = 0
# Get the files ignored by Git
# (This is better than 'git check-ignore' because it includes the files
# excluded by .git/info/exclude)
git_clean_output = subprocess.check_output("git clean -ndX".split())
git_clean_output = git_clean_output.decode()
git_ignores = [l.split()[-1] for l in git_clean_output.splitlines()]
cwd = os.getcwd()
print("Executing from %s" % cwd)
for i, directory in enumerate(EXCLUDE_DIRECTORIES):
EXCLUDE_DIRECTORIES[i] = os.path.abspath(directory)
print("\tAdding to the exclude list: %s" % 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 and the files
# Git ignores.
#
matches = list()
files = [f for f in files
if os.path.join(root, f) not in git_ignores]
for filename in files:
for file_pattern in (EXCLUDE + git_ignores):
if fnmatch.fnmatch(filename, file_pattern):
matches.append(filename)
break
for match in matches:
files.remove(match)
#
# Check files
#
for filename in files:
path = os.path.join(root, filename)
print("processing %s" % filename)
with open(path, encoding="utf-8") as file:
for line, string in enumerate(file):
if '\t' in string:
print('%d:%s has tab' % (line, path))
tabs_found_count += 1
if args.convert:
convert(path)
break
if tabs_found_count == 0:
print("No tabs found")
return 0
else:
print('%d tab(s) found.' % tabs_found_count)
return 1
if __name__ == '__main__':
sys.exit(main(sys.argv[1:], sys.argv[0]))
|
