Commit cb3ed5b7e09c6c0462e396d55e3fecc0980a333a

Authored by H. Peter Anvin
Committed by Sam Ravnborg
1 parent d72e5edbf4

scripts: Make cleanfile/cleanpatch warn about long lines

Make the "cleanfile" and "cleanpatch" script warn about long lines,
by default lines whose visual width exceeds 79 characters.

Per suggestion from Auke Kok.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>

Showing 2 changed files with 107 additions and 5 deletions Side-by-side Diff

... ... @@ -7,7 +7,9 @@
7 7 use bytes;
8 8 use File::Basename;
9 9  
10   -#
  10 +# Default options
  11 +$max_width = 79;
  12 +
11 13 # Clean up space-tab sequences, either by removing spaces or
12 14 # replacing them with tabs.
13 15 sub clean_space_tabs($)
14 16  
... ... @@ -48,9 +50,49 @@
48 50 return $lo;
49 51 }
50 52  
  53 +# Compute the visual width of a string
  54 +sub strwidth($) {
  55 + no bytes; # Tab alignment depends on characters
  56 +
  57 + my($li) = @_;
  58 + my($c, $i);
  59 + my $pos = 0;
  60 + my $mlen = 0;
  61 +
  62 + for ($i = 0; $i < length($li); $i++) {
  63 + $c = substr($li,$i,1);
  64 + if ($c eq "\t") {
  65 + $pos = ($pos+8) & ~7;
  66 + } elsif ($c eq "\n") {
  67 + $mlen = $pos if ($pos > $mlen);
  68 + $pos = 0;
  69 + } else {
  70 + $pos++;
  71 + }
  72 + }
  73 +
  74 + $mlen = $pos if ($pos > $mlen);
  75 + return $mlen;
  76 +}
  77 +
51 78 $name = basename($0);
52 79  
53   -foreach $f ( @ARGV ) {
  80 +@files = ();
  81 +
  82 +while (defined($a = shift(@ARGV))) {
  83 + if ($a =~ /^-/) {
  84 + if ($a eq '-width' || $a eq '-w') {
  85 + $max_width = shift(@ARGV)+0;
  86 + } else {
  87 + print STDERR "Usage: $name [-width #] files...\n";
  88 + exit 1;
  89 + }
  90 + } else {
  91 + push(@files, $a);
  92 + }
  93 +}
  94 +
  95 +foreach $f ( @files ) {
54 96 print STDERR "$name: $f\n";
55 97  
56 98 if (! -f $f) {
57 99  
... ... @@ -90,8 +132,10 @@
90 132  
91 133 @blanks = ();
92 134 @lines = ();
  135 + $lineno = 0;
93 136  
94 137 while ( defined($line = <FILE>) ) {
  138 + $lineno++;
95 139 $in_bytes += length($line);
96 140 $line =~ s/[ \t\r]*$//; # Remove trailing spaces
97 141 $line = clean_space_tabs($line);
... ... @@ -106,6 +150,12 @@
106 150 $out_bytes += length($line);
107 151 @blanks = ();
108 152 $blank_bytes = 0;
  153 + }
  154 +
  155 + $l_width = strwidth($line);
  156 + if ($max_width && $l_width > $max_width) {
  157 + print STDERR
  158 + "$f:$lineno: line exceeds $max_width characters ($l_width)\n";
109 159 }
110 160 }
111 161  
... ... @@ -7,7 +7,9 @@
7 7 use bytes;
8 8 use File::Basename;
9 9  
10   -#
  10 +# Default options
  11 +$max_width = 79;
  12 +
11 13 # Clean up space-tab sequences, either by removing spaces or
12 14 # replacing them with tabs.
13 15 sub clean_space_tabs($)
14 16  
... ... @@ -48,9 +50,49 @@
48 50 return $lo;
49 51 }
50 52  
  53 +# Compute the visual width of a string
  54 +sub strwidth($) {
  55 + no bytes; # Tab alignment depends on characters
  56 +
  57 + my($li) = @_;
  58 + my($c, $i);
  59 + my $pos = 0;
  60 + my $mlen = 0;
  61 +
  62 + for ($i = 0; $i < length($li); $i++) {
  63 + $c = substr($li,$i,1);
  64 + if ($c eq "\t") {
  65 + $pos = ($pos+8) & ~7;
  66 + } elsif ($c eq "\n") {
  67 + $mlen = $pos if ($pos > $mlen);
  68 + $pos = 0;
  69 + } else {
  70 + $pos++;
  71 + }
  72 + }
  73 +
  74 + $mlen = $pos if ($pos > $mlen);
  75 + return $mlen;
  76 +}
  77 +
51 78 $name = basename($0);
52 79  
53   -foreach $f ( @ARGV ) {
  80 +@files = ();
  81 +
  82 +while (defined($a = shift(@ARGV))) {
  83 + if ($a =~ /^-/) {
  84 + if ($a eq '-width' || $a eq '-w') {
  85 + $max_width = shift(@ARGV)+0;
  86 + } else {
  87 + print STDERR "Usage: $name [-width #] files...\n";
  88 + exit 1;
  89 + }
  90 + } else {
  91 + push(@files, $a);
  92 + }
  93 +}
  94 +
  95 +foreach $f ( @files ) {
54 96 print STDERR "$name: $f\n";
55 97  
56 98 if (! -f $f) {
... ... @@ -86,6 +128,7 @@
86 128  
87 129 $in_bytes = 0;
88 130 $out_bytes = 0;
  131 + $lineno = 0;
89 132  
90 133 @lines = ();
91 134  
92 135  
... ... @@ -93,10 +136,12 @@
93 136 $err = 0;
94 137  
95 138 while ( defined($line = <FILE>) ) {
  139 + $lineno++;
96 140 $in_bytes += length($line);
97 141  
98 142 if (!$in_hunk) {
99   - if ($line =~ /^\@\@\s+\-([0-9]+),([0-9]+)\s+\+([0-9]+),([0-9]+)\s\@\@/) {
  143 + if ($line =~
  144 + /^\@\@\s+\-([0-9]+),([0-9]+)\s+\+([0-9]+),([0-9]+)\s\@\@/) {
100 145 $minus_lines = $2;
101 146 $plus_lines = $4;
102 147 if ($minus_lines || $plus_lines) {
... ... @@ -116,6 +161,13 @@
116 161 $text = substr($line, 1);
117 162 $text =~ s/[ \t\r]*$//; # Remove trailing spaces
118 163 $text = clean_space_tabs($text);
  164 +
  165 + $l_width = strwidth($text);
  166 + if ($max_width && $l_width > $max_width) {
  167 + print STDERR
  168 + "$f:$lineno: adds line exceeds $max_width ",
  169 + "characters ($l_width)\n";
  170 + }
119 171  
120 172 push(@hunk_lines, '+'.$text);
121 173 } elsif ($line =~ /^\-/) {