2017-06-07 11:36:25

by Joe Perches

Subject: [PATCH] checkpatch: Improve tests for multiple line function definitions

Add a block that identifies multiple line function definitions.

Save the function name into $context_function to improve the embedded
function name test.

Look for misplaced open brace on the function definition.
Emit an OPEN_BRACE error when the function definition is similar to

void foo(int arg1,
int arg2) {

Miscellanea:

o Remove the $realfile test in function declaration w/o named arguments test
o Comment the function declaration w/o named arguments test

Signed-off-by: Joe Perches <[email protected]>
---
scripts/checkpatch.pl | 26 +++++++++++++++++++++++++-
1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 7fcaf5ca997b..3643d390eb1a 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -5897,7 +5897,8 @@ sub process {
"externs should be avoided in .c files\n" . $herecurr);
}

- if ($realfile =~ /\.[ch]$/ && defined $stat &&
+# check for function declarations that have arguments without identifier names
+ if (defined $stat &&
$stat =~ /^.\s*(?:extern\s+)?$Type\s*$Ident\s*\(\s*([^{]+)\s*\)\s*;/s &&
$1 ne "void") {
my $args = trim($1);
@@ -5910,6 +5911,29 @@ sub process {
}
}

+# check for function definitions
+ if ($^V && $^V ge 5.10.0 &&
+ defined $stat &&
+ $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
+ $context_function = $1;
+
+# check for multiline function definition with misplaced open brace
+ my $ok = 0;
+ my $cnt = statement_rawlines($stat);
+ my $herectx = $here . "\n";
+ for (my $n = 0; $n < $cnt; $n++) {
+ my $rl = raw_line($linenr, $n);
+ $herectx .= $rl . "\n";
+ $ok = 1 if ($rl =~ /^[ \+]\{/);
+ $ok = 1 if ($rl =~ /\{/ && $n == 0);
+ last if $rl =~ /^[ \+].*\{/;
+ }
+ if (!$ok) {
+ ERROR("OPEN_BRACE",
+ "open brace '{' following function definitions go on the next line\n" . $herectx);
+ }
+ }
+
# checks for new __setup's
if ($rawline =~ /\b__setup\("([^"]*)"/) {
my $name = $1;
--
2.10.0.rc2.1.g053435c

2017-06-07 15:49:25

by Kershner, David A

Subject: RE: [PATCH] checkpatch: Improve tests for multiple line function definitions

> -----Original Message-----
> From: Joe Perches [mailto:[email protected]]
> Sent: Wednesday, June 7, 2017 7:36 AM
> To: Andrew Morton <[email protected]>; Andy Whitcroft
> <[email protected]>
> Cc: Greg KH <[email protected]>; Kershner, David A
> <[email protected]>; [email protected]
> Subject: [PATCH] checkpatch: Improve tests for multiple line function
> definitions
>
> Add a block that identifies multiple line function definitions.
>
> Save the function name into $context_function to improve the embedded
> function name test.
>
> Look for misplaced open brace on the function definition.
> Emit an OPEN_BRACE error when the function definition is similar to
>
> void foo(int arg1,
> int arg2) {
>
> Miscellanea:
>
> o Remove the $realfile test in function declaration w/o named arguments
> test
> o Comment the function declaration w/o named arguments test
>
> Signed-off-by: Joe Perches <[email protected]>

Thanks for the quick turnaround! I tested it on our drivers and it showed the
errors.

Tested-by: David Kershner <[email protected]>

David Kershner


> ---
> scripts/checkpatch.pl | 26 +++++++++++++++++++++++++-
> 1 file changed, 25 insertions(+), 1 deletion(-)
>
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 7fcaf5ca997b..3643d390eb1a 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -5897,7 +5897,8 @@ sub process {
> "externs should be avoided in .c files\n" .
> $herecurr);
> }
>
> - if ($realfile =~ /\.[ch]$/ && defined $stat &&
> +# check for function declarations that have arguments without identifier
> names
> + if (defined $stat &&
> $stat =~
> /^.\s*(?:extern\s+)?$Type\s*$Ident\s*\(\s*([^{]+)\s*\)\s*;/s &&
> $1 ne "void") {
> my $args = trim($1);
> @@ -5910,6 +5911,29 @@ sub process {
> }
> }
>
> +# check for function definitions
> + if ($^V && $^V ge 5.10.0 &&
> + defined $stat &&
> + $stat =~
> /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
> + $context_function = $1;
> +
> +# check for multiline function definition with misplaced open brace
> + my $ok = 0;
> + my $cnt = statement_rawlines($stat);
> + my $herectx = $here . "\n";
> + for (my $n = 0; $n < $cnt; $n++) {
> + my $rl = raw_line($linenr, $n);
> + $herectx .= $rl . "\n";
> + $ok = 1 if ($rl =~ /^[ \+]\{/);
> + $ok = 1 if ($rl =~ /\{/ && $n == 0);
> + last if $rl =~ /^[ \+].*\{/;
> + }
> + if (!$ok) {
> + ERROR("OPEN_BRACE",
> + "open brace '{' following function
> definitions go on the next line\n" . $herectx);
> + }
> + }
> +
> # checks for new __setup's
> if ($rawline =~ /\b__setup\("([^"]*)"/) {
> my $name = $1;
> --
> 2.10.0.rc2.1.g053435c