mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2024-11-27 05:21:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

check-format.pl: Allow extra space before end-of-line comments unless -e|--eol-cmt given

Browse Source 
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15077)
This commit is contained in:
Dr. David von Oheimb 2021-04-29 22:02:41 +02:00 committed by Dr. David von Oheimb
parent f35a9b6a2d
commit eb9b532089
3 changed files with 24 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
util/check-format-test-negatives.c
View File

@ -21,7 +21,7 @@ int f(void) /*
* trailing multi-line comment
*/
{
if (ctx == NULL) { /* non-leading intra-line comment */
if (ctx == NULL) { /* non-leading end-of-line comment */
if (/* comment after '(' */ pem_name != NULL /* comment before ')' */)
/* entire-line comment indent usually like for the following line */
return NULL; /* hanging indent also for this line after comment */

2
util/check-format-test-positives.c
View File

@ -52,7 +52,7 @@
#define Y 2 /*@ indent of preprocessor directive off by 1 (must be 0) */
typedef struct { /*@0 extra space in code, reported unless sloppy-spc */
enum { /*@1 extra space in comment, reported unless sloppy-spc */
w = 0 /*@2 hanging expr indent off by 1, or 3 for lines after '{' */
w = 0 /*@ hanging expr indent off by 1, or 3 for lines after '{' */
&& 1, /*@ hanging expr indent off by 3, or -1 for leading '&&' */
x = 1, /*@ hanging expr indent off by -1 */
y,z /*@ no space after ',', reported unless sloppy-spc */

40
util/check-format.pl
View File

@ -15,7 +15,7 @@
# check-format.pl [-l|--sloppy-len] [-l|--sloppy-bodylen]
# [-s|--sloppy-space] [-c|--sloppy-cmt]
# [-m|--sloppy-macro] [-h|--sloppy-hang]
# [-e|--extra-spc] [-1|--1-stmt]
# [-e|--eol-cmt] [-1|--1-stmt]
# <files>
#
# run self-tests:
@ -44,7 +44,7 @@
# * same indentation as non-hanging indent level
# * indentation moved left (not beyond non-hanging indent)
# just to fit contents within the line length limit
# -e | --extra-spc report needless intermediate multiple consecutive spaces
# -e | --eol-cmt report needless intermediate multiple consecutive spaces also before end-of-line comments
# -1 | --1-stmt do more aggressive checks for { 1 stmt } - see below
#
# There are non-trivial false positives and negatives such as the following.
@ -66,8 +66,8 @@
# Yet with the --1-stmt option false positives are preferred over negatives.
# False negatives occur if the braces are more than two non-empty lines apart.
#
# * When the -e or --extra-spc option if given, the presence of
# multiple consecutive spaces is regarded a coding style nit
# * The presence of multiple consecutive spaces is regarded a coding style nit
# except when this is before end-of-line comments (unless the --eol-cmt is given) and
# except when done in order to align certain columns over multiple lines, e.g.:
# # define AB 1
# # define CDE 22
@ -105,7 +105,7 @@ my $sloppy_SPC = 0;
my $sloppy_hang = 0;
my $sloppy_cmt = 0;
my $sloppy_macro = 0;
my $extra_spc = 0;
my $eol_cmt = 0;
my $extended_1_stmt = 0;
while ($ARGV[0] =~ m/^-(\w|-[\w\-]+)$/) {
@ -122,8 +122,8 @@ while ($ARGV[0] =~ m/^-(\w|-[\w\-]+)$/) {
$sloppy_macro = 1;
} elsif ($arg =~ m/^(h|-sloppy-hang)$/) {
$sloppy_hang = 1;
} elsif ($arg =~ m/^(e|-extra-space)$/) {
$extra_spc = 1;
} elsif ($arg =~ m/^(e|-eol-cmt)$/) {
$eol_cmt = 1;
} elsif ($arg =~ m/^(1|-1-stmt)$/) {
$extended_1_stmt = 1;
} else {
@ -136,10 +136,11 @@ my $self_test; # whether the current input file is regarded to conta
my $line; # current line number
my $line_before; # number of previous not essentially empty line (containing at most whitespace and '\')
my $line_before2; # number of not essentially empty line before previous not essentially empty line
my $contents; # contents of current line
my $contents_before; # contents of $line_before, if $line_before > 0
my $contents; # contents of current line (without blinding)
# $_ # current line, where comments etc. get blinded
my $contents_before; # contents of $line_before (without blinding), if $line_before > 0
my $contents_before_; # contents of $line_before after blinding comments etc., if $line_before > 0
my $contents_before2; # contents of $line_before2, if $line_before2 > 0
my $contents_before2; # contents of $line_before2 (without blinding), if $line_before2 > 0
my $contents_before_2; # contents of $line_before2 after blinding comments etc., if $line_before2 > 0
my $in_multiline_string; # line starts within multi-line string literal
my $count; # -1 or number of leading whitespace characters (except newline) in current line,
@ -616,7 +617,7 @@ while (<>) { # loop over all lines of all input files
$in_comment != 0 ? " in multi-line comment"
: " in intra-line comment" : "");
}
sub split_line_head {
sub split_line_head { # split line contents into header containing leading spaces and the first non-space char, and the rest of the line
my $comment_symbol =
$in_comment != 0 ? "@" : ""; # '@' will match the blinded leading '*' in multi-line comment
# $in_comment may pertain to the following line due to delayed check
@ -627,16 +628,19 @@ while (<>) { # loop over all lines of all input files
my ($head , $intra_line ) = split_line_head($_);
my ($head1, $intra_line1) = split_line_head($contents_before_ ) if $line_before > 0;
my ($head2, $intra_line2) = split_line_head($contents_before_2) if $line_before2 > 0;
if ($extra_spc && $line_before > 0) { # check with one line delay, such that at least $contents_before is available
sub column_alignments_only {
my $head = shift;
my $intra = shift;
my $contents = shift;
if ($line_before > 0) { # check with one line delay, such that at least $contents_before is available
sub column_alignments_only { # return 1 if the given line has multiple consecutive spaces only at columns that match the reference line
# all parameter strings are assumed to contain contents after blinding comments etc.
my $head = shift; # leading spaces and the first non-space char
my $intra = shift; # the rest of the line contents
my $contents = shift; # reference line
# check if all extra SPC in $intra is used only for multi-line column alignment with $contents
my $offset = length($head);
for (my $col = 0; $col < length($intra) - 2; $col++) {
return 0 if substr($intra , $col, 3) =~ m/\s\s\S/ # extra SPC (after leading space)
&& !(substr($contents, $col + $offset + 1, 2) =~ m/\s\S/)
my $substr = substr($intra, $col);
next unless $substr =~ m/^\s\s\S/; # extra SPC (but not in leading spaces of the line)
next if !$eol_cmt && $substr =~ m/^[@\s]+$/; # end-of-line comment
return 0 unless substr($contents, $col + $offset + 1, 2) =~ m/\s\S/; # reference line contents do not match
}
return 1;
}