2012-10-17 13:25:35 +04:00
#!/usr/bin/perl
#
# bracket-spacing.pl: Report any usage of 'function (..args..)'
2013-05-24 20:43:45 +04:00
# Also check for other syntax issues, such as correct use of ';'
2012-10-17 13:25:35 +04:00
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see
# <http://www.gnu.org/licenses/>.
#
# Authors:
# Daniel P. Berrange <berrange@redhat.com>
use strict ;
use warnings ;
my $ ret = 0 ;
my $ incomment = 0 ;
foreach my $ file ( @ ARGV ) {
2014-11-12 19:22:27 +03:00
# Per-file variables for multiline Curly Bracket (cb_) check
my $ cb_linenum = 0 ;
my $ cb_code = "" ;
my $ cb_scolon = 0 ;
2012-10-17 13:25:35 +04:00
open FILE , $ file ;
while ( defined ( my $ line = <FILE> ) ) {
my $ data = $ line ;
2014-11-13 17:04:52 +03:00
# For temporary modifications
my $ tmpdata ;
2012-10-17 13:25:35 +04:00
2014-08-12 03:04:19 +04:00
# Kill any quoted , ; = or "
$ data =~ s/'[";,=]'/'X'/g ;
2013-05-24 20:43:45 +04:00
2013-05-24 12:50:42 +04:00
# Kill any quoted strings
$ data =~ s , "([^\\\"]|\\.)*" , "XXX" , g ;
2012-10-17 13:25:35 +04:00
# Kill any C++ style comments
$ data =~ s , // . * $, // , ;
next if $ data =~ /^#/ ;
# Kill contents of multi-line comments
# and detect end of multi-line comments
if ( $ incomment ) {
if ( $ data =~ m , \ * / , ) {
$ incomment = 0 ;
$ data =~ s , ^ . * \ * /,*/ , ;
} else {
$ data = "" ;
}
}
# Kill single line comments, and detect
# start of multi-line comments
if ( $ data =~ m , /\*.*\*/ , ) {
$ data =~ s , /\*.*\*/ , /* */ , ;
} elsif ( $ data =~ m , / \ * , ) {
$ incomment = 1 ;
$ data =~ s , /\*.*,/ * , ;
}
# We need to match things like
#
# int foo (int bar, bool wizz);
# foo (bar, wizz);
#
# but not match things like:
#
# typedef int (*foo)(bar wizz)
#
# we can't do this (efficiently) without
# missing things like
#
# foo (*bar, wizz);
#
2014-11-13 17:04:52 +03:00
# We also don't want to spoil the $data so it can be used
# later on.
$ tmpdata = $ data ;
while ( $ tmpdata =~ /(\w+)\s\((?!\*)/ ) {
2012-10-17 13:25:35 +04:00
my $ kw = $ 1 ;
# Allow space after keywords only
if ( $ kw =~ /^(if|for|while|switch|return)$/ ) {
2014-11-13 17:04:52 +03:00
$ tmpdata =~ s/($kw\s\()/XXX(/ ;
2012-10-17 13:25:35 +04:00
} else {
2014-11-14 17:55:54 +03:00
print "Whitespace after non-keyword:\n" ;
2012-10-17 13:25:35 +04:00
print "$file:$.: $line" ;
$ ret = 1 ;
last ;
}
}
# Require whitespace immediately after keywords,
# but none after the opening bracket
2014-11-13 17:09:35 +03:00
if ( $ data =~ /\b(if|for|while|switch|return)\(/ ||
$ data =~ /\b(if|for|while|switch|return)\s+\(\s/ ) {
2014-11-14 17:55:54 +03:00
print "No whitespace after keyword:\n" ;
2012-10-17 13:25:35 +04:00
print "$file:$.: $line" ;
$ ret = 1 ;
}
# Forbid whitespace between )( of a function typedef
2014-11-13 17:09:35 +03:00
if ( $ data =~ /\(\*\w+\)\s+\(/ ) {
2014-11-14 17:55:54 +03:00
print "Whitespace between ')' and '(':\n" ;
2012-10-17 13:25:35 +04:00
print "$file:$.: $line" ;
$ ret = 1 ;
}
# Forbid whitespace following ( or prior to )
2014-11-13 17:09:35 +03:00
if ( $ data =~ /\S\s+\)/ ||
$ data =~ /\(\s+\S/ ) {
2014-11-14 17:55:54 +03:00
print "Whitespace after '(' or before ')':\n" ;
2012-10-17 13:25:35 +04:00
print "$file:$.: $line" ;
$ ret = 1 ;
}
2013-05-21 14:01:01 +04:00
2013-11-20 01:29:44 +04:00
# Forbid whitespace before ";" or ",". Things like below are allowed:
2013-05-21 14:01:01 +04:00
#
# 1) The expression is empty for "for" loop. E.g.
# for (i = 0; ; i++)
#
# 2) An empty statement. E.g.
# while (write(statuswrite, &status, 1) == -1 &&
# errno == EINTR)
# ;
#
2014-11-13 17:09:35 +03:00
if ( $ data =~ /[^;\s]\s+[;,]/ ) {
2014-11-14 17:55:54 +03:00
print "Whitespace before (semi)colon:\n" ;
2013-05-24 12:50:42 +04:00
print "$file:$.: $line" ;
$ ret = 1 ;
2013-05-21 14:01:01 +04:00
}
2013-05-24 20:43:45 +04:00
# Require EOL, macro line continuation, or whitespace after ";".
# Allow "for (;;)" as an exception.
2014-11-13 17:09:35 +03:00
if ( $ data =~ /;[^ \\\n;)]/ ) {
2014-11-14 17:55:54 +03:00
print "Invalid character after semicolon:\n" ;
2013-05-24 20:43:45 +04:00
print "$file:$.: $line" ;
$ ret = 1 ;
}
2013-11-20 01:29:44 +04:00
# Require EOL, space, or enum/struct end after comma.
2014-11-13 17:09:35 +03:00
if ( $ data =~ /,[^ \\\n)}]/ ) {
2014-11-14 17:55:54 +03:00
print "Invalid character after comma:\n" ;
2013-11-20 01:29:44 +04:00
print "$file:$.: $line" ;
$ ret = 1 ;
}
2014-01-20 15:27:28 +04:00
2014-03-17 13:38:38 +04:00
# Require spaces around assignment '=', compounds and '=='
# with the exception of virAssertCmpInt()
2014-11-13 17:04:52 +03:00
$ tmpdata = $ data ;
$ tmpdata =~ s/(virAssertCmpInt\(.* ).?=,/$1op,/ ;
2014-11-13 17:09:35 +03:00
if ( $ tmpdata =~ /[^ ]\b[!<>&|\-+*\/%\^=]?=[^=]/ ||
$ tmpdata =~ /=[^= \\\n]/ ) {
2014-11-14 17:55:54 +03:00
print "Spacing around '=' or '==':\n" ;
2014-01-20 15:27:28 +04:00
print "$file:$.: $line" ;
$ ret = 1 ;
}
2014-11-12 19:22:27 +03:00
# One line conditional statements with one line bodies should
# not use curly brackets.
if ( $ data =~ /^\s*(if|while|for)\b.*\{$/ ) {
$ cb_linenum = $. ;
$ cb_code = $ line ;
$ cb_scolon = 0 ;
}
# We need to check for exactly one semicolon inside the body,
# because empty statements (e.g. with comment only) are
# allowed
if ( $ cb_linenum == $. - 1 && $ data =~ /^[^;]*;[^;]*$/ ) {
$ cb_code . = $ line ;
$ cb_scolon = 1 ;
}
if ( $ data =~ /^\s*}\s*$/ &&
$ cb_linenum == $. - 2 &&
$ cb_scolon ) {
print "Curly brackets around single-line body:\n" ;
print "$file:$cb_linenum-$.:\n$cb_code$line" ;
$ ret = 1 ;
# There _should_ be no need to reset the values; but to
# keep my inner peace...
$ cb_linenum = 0 ;
$ cb_scolon = 0 ;
$ cb_code = "" ;
}
2012-10-17 13:25:35 +04:00
}
close FILE ;
}
exit $ ret ;