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
|
#! /usr/bin/env python3
# Copyright (C) 2013 Canonical Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# Authored by: Michi Henning <michi.henning@canonical.com>
#
# Little helper program to test that source files do not contain trailing whitespace
# or tab indentation.
#
# Usage: check_whitespace.py directory [ignore_prefix]
#
# The directory specifies the (recursive) location of the source files. Any
# files with a path that starts with ignore_prefix are not checked. This is
# useful to exclude files that are generated into the build directory.
#
# See the file_pat definition below for a list of files that are checked.
#
import argparse
import os
import re
import sys
# Print msg on stderr, preceded by program name and followed by newline
def error(msg):
print(os.path.basename(sys.argv[0]) + ": " + msg, file=sys.stderr)
# Function to raise errors encountered by os.walk
def raise_error(e):
raise e
# Scan lines in file_path for bad whitespace. For each file,
# print the line numbers that have whitespace issues
whitespace_pat = re.compile(r'.*[ \t]$')
tab_indent_pat = re.compile(r'^ *\t')
def scan_for_bad_whitespace(file_path):
global tab_indent_pat, whitespace_pat
errors = []
newlines_at_end = 0
with open(file_path, 'rt', encoding='utf-8') as ifile:
for lino, line in enumerate(ifile, start=1):
if whitespace_pat.match(line) or tab_indent_pat.match(line):
errors.append(lino)
if line == "\n" and lino != 1: # Don't complain about empty file with only a single line
newlines_at_end += 1
else:
newlines_at_end = 0
if 0 < len(errors) <= 10:
if len(errors) > 1:
plural = 's'
else:
plural = ''
print("%s: bad whitespace in line%s %s" % (file_path, plural, ", ".join((str(i) for i in errors))))
elif errors:
print("%s: bad whitespace in multiple lines" % file_path)
if newlines_at_end:
print("%s: multiple new lines at end of file" % file_path)
return bool(errors) or newlines_at_end
# Parse args
parser = argparse.ArgumentParser(description = 'Test that source files do not contain trailing whitespace.')
parser.add_argument('dir', nargs = 1, help = 'The directory to (recursively) search for source files')
parser.add_argument('ignore_prefix', nargs = '+', default=None,
help = 'Ignore source files with a path that starts with the given prefix.')
args = parser.parse_args()
# Files we want to check for trailing whitespace.
file_pat = r'(.*\.(c|cpp|h|hpp|hh|in|install|js|py|qml|sh)$)|(.*CMakeLists\.txt$)'
pat = re.compile(file_pat)
# Find all the files with matching file extension in the specified
# directory and check them for trailing whitespace.
directory = os.path.abspath(args.dir[0])
ignores = args.ignore_prefix and args.ignore_prefix or []
found_whitespace = False
try:
for root, dirs, files in os.walk(directory, onerror = raise_error):
for file in files:
path = os.path.join(root, file)
ignored = False
for ignore in ignores:
if ignore and path.startswith(os.path.abspath(ignore)):
ignored = True
break
if not ignored and pat.match(file) and scan_for_bad_whitespace(path):
found_whitespace = True
except OSError as e:
error("cannot create file list for \"" + dir + "\": " + e.strerror)
sys.exit(1)
if found_whitespace:
sys.exit(1)
|
