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
|
#!/usr/bin/env perl
use warnings;
use Encode;
use Text::Tabs;
use Getopt::Std;
use strict;
sub HELP_MESSAGE
{
my $fh = shift;
print $fh <<"EOF"
Usage: $0 [options] [files]
Correct whitespace errors in the Crawl repository.
If no files are specified, defaults to files found beneath the current
directory, modified by the following options (which have no effect if file
arguments were provided):
-a Check the whole repository, not just the current directory.
-m Check only files that have been modified and added to the index.
-M Check only files that have been modified.
Other options are:
-n Dry run: Do not actually modify files.
-t <N> When expanding tabs, assume N-column tab stops (default 8).
-r Do not remove carriage returns.
-h, --help Display this help and exit.
Exit status:
0 if there were no whitespace errors, or if errors were corrected.
1 if there are still whitespace errors (only with the -n option).
2 if an unknown option was supplied.
EOF
}
our ($opt_a, $opt_m, $opt_M, $opt_n, $opt_t, $opt_r, $opt_h);
# Send --help to stdout, and exit (with success) when it is provided.
$Getopt::Std::STANDARD_HELP_VERSION = 1;
# Fail, and display help to stderr, on a bad option.
getopts('amMnt:rh')
or do { HELP_MESSAGE(\*STDERR); exit 2; };
# Make -h work the same as --help.
$opt_h and do { HELP_MESSAGE(\*STDOUT); exit 0; };
my $top_level = $opt_a;
my $modified_only = $opt_m || $opt_M;
my $modified_cached = $opt_m && !$opt_M;
my $dry_run = $opt_n;
my $any_bad = 0;
# Imported from Text::Tabs, so use our, not my.
our $tabstop = $opt_t if ($opt_t);
my $strip_cr = !$opt_r;
my @files = @ARGV;
unless (@files)
{
if ($top_level)
{
my $tldir = `git rev-parse --show-toplevel`;
chomp $tldir;
chdir($tldir) or die "(-a) cannot chdir to $tldir: $!";
}
if ($modified_only)
{
my $cached = $modified_cached ? "--cached" : "";
open FLIST, "git diff-index -M --name-only $cached --relative HEAD|"
or die "Can't run git diff-index";
}
else
{
open FLIST, "git ls-files|" or die "Can't run git ls-files";
}
@files = <FLIST>;
close FLIST;
}
for (@files)
{
chomp;
next if -d $_;
next if -l $_;
-f $_ or (print(STDERR "Can't read $_\n"), next);
next if /webserver\/static\/scripts\/contrib\//i;
next if /util\/server\//i;
next if /dat\/dist_bones\//i;
next if /\.(png|gif|xpm|ttf|ico|icns|fig|tex|eps|pdf|psd|woff|woff2)$/i;
next if /\.(sln|vim|pbxproj|vsprops|plist|csproj|config|cs)$/i;
next if /\.(vcproj|vcproj\.user|vcxproj|vcxproj\.filters|terminal)$/i;
next if m[(^|/)\.git(modules|attributes)$];
next if /\.(lex|tab)\./;
# these files are autogenerated by the catch2 team, but manually placed
# into the dcss tree. Altering them to fit crawl's coding style would
# just be needlessly confusing.
next if /catch_amalgamated\.hpp/;
next if /catch_amalgamated\.cc/;
next if !/\./ and !/util\//;
my $tab = /Makefile/i; # Allow tabs for makefiles.
my $bom = /\.js$/; # And BOM for these.
my $french = /\.des$/; # these may need it for functionality
$bom = 1 if /CREDITS/;
undef local $/;
open F, "<$_" or die "Can't open $_";
my $file = $_;
my $cont=$_=<F>;
close F;
eval{decode("UTF-8", "$_", Encode::FB_CROAK)};
if ($@)
{
print "invalid UTF-8: $file\n";
# We don't know the actual encoding, assume a Windows-using american/
# frenchman/german/finn. Sorry, polacks and russkies.
Encode::from_to($_, "CP1252", "UTF-8");
}
$_.="\n", print "missing newline at eof: $file\n" unless /\n$/s or /^$/;
print "extra newlines at eof: $file\n" if s/\n+\n$/\n/s;
$_=expand $_, print "tab: $file\n" if !$tab && /\t/;
print "spaces at eol: $file\n" if s/ +\n/\n/sg;
print "CR: $file\n" if $strip_cr and s/\r//sg;
# Note: it's a byte string, as we had to handle invalid encodings above,
# and $cont may be invalid.
print "zero width space: $file\n" if s/\xe2\x80\x8b//sg; # U+200B
print "BOM: $file\n" if !$bom && s/\xef\xbb\xbf//sg; # U+FFEF
print "Control statement space: $file\n" if $file =~ /\.(cc|h|js)$/i
&& s/\b(if|while|for|switch|catch)\(/$1 (/sg;
print "French spacing fix: $file\n" if !$french && s/\. ( [[:upper:]])/.$1/sg;
if ($_ ne $cont)
{
$any_bad = 1;
if (!$dry_run)
{
open F, ">$file" or die;
print F;
close F;
}
}
}
if ($dry_run and $any_bad) {
print "Found unnecessary whitespace in the above files.\n";
print "Re-run this command (without -n) to automatically remove it.\n";
exit 1;
}
|
