xref: /qemu/scripts/checkpatch.pl (revision 3e5385fc)
11ec3f6f9SBlue Swirl#!/usr/bin/perl -w
21ec3f6f9SBlue Swirl# (c) 2001, Dave Jones. (the file handling bit)
31ec3f6f9SBlue Swirl# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
41ec3f6f9SBlue Swirl# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
51ec3f6f9SBlue Swirl# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
61ec3f6f9SBlue Swirl# Licensed under the terms of the GNU GPL License version 2
71ec3f6f9SBlue Swirl
81ec3f6f9SBlue Swirluse strict;
91ec3f6f9SBlue Swirl
101ec3f6f9SBlue Swirlmy $P = $0;
111ec3f6f9SBlue Swirl$P =~ s@.*/@@g;
121ec3f6f9SBlue Swirl
131ec3f6f9SBlue Swirlmy $V = '0.31';
141ec3f6f9SBlue Swirl
151ec3f6f9SBlue Swirluse Getopt::Long qw(:config no_auto_abbrev);
161ec3f6f9SBlue Swirl
171ec3f6f9SBlue Swirlmy $quiet = 0;
181ec3f6f9SBlue Swirlmy $tree = 1;
191ec3f6f9SBlue Swirlmy $chk_signoff = 1;
201ec3f6f9SBlue Swirlmy $chk_patch = 1;
211ec3f6f9SBlue Swirlmy $tst_only;
221ec3f6f9SBlue Swirlmy $emacs = 0;
231ec3f6f9SBlue Swirlmy $terse = 0;
241ec3f6f9SBlue Swirlmy $file = 0;
251ec3f6f9SBlue Swirlmy $check = 0;
261ec3f6f9SBlue Swirlmy $summary = 1;
271ec3f6f9SBlue Swirlmy $mailback = 0;
281ec3f6f9SBlue Swirlmy $summary_file = 0;
291ec3f6f9SBlue Swirlmy $root;
301ec3f6f9SBlue Swirlmy %debug;
311ec3f6f9SBlue Swirlmy $help = 0;
321ec3f6f9SBlue Swirl
331ec3f6f9SBlue Swirlsub help {
341ec3f6f9SBlue Swirl	my ($exitcode) = @_;
351ec3f6f9SBlue Swirl
361ec3f6f9SBlue Swirl	print << "EOM";
371ec3f6f9SBlue SwirlUsage: $P [OPTION]... [FILE]...
381ec3f6f9SBlue SwirlVersion: $V
391ec3f6f9SBlue Swirl
401ec3f6f9SBlue SwirlOptions:
411ec3f6f9SBlue Swirl  -q, --quiet                quiet
421ec3f6f9SBlue Swirl  --no-tree                  run without a kernel tree
431ec3f6f9SBlue Swirl  --no-signoff               do not check for 'Signed-off-by' line
441ec3f6f9SBlue Swirl  --patch                    treat FILE as patchfile (default)
451ec3f6f9SBlue Swirl  --emacs                    emacs compile window format
461ec3f6f9SBlue Swirl  --terse                    one line per report
471ec3f6f9SBlue Swirl  -f, --file                 treat FILE as regular source file
481ec3f6f9SBlue Swirl  --subjective, --strict     enable more subjective tests
491ec3f6f9SBlue Swirl  --root=PATH                PATH to the kernel tree root
501ec3f6f9SBlue Swirl  --no-summary               suppress the per-file summary
511ec3f6f9SBlue Swirl  --mailback                 only produce a report in case of warnings/errors
521ec3f6f9SBlue Swirl  --summary-file             include the filename in summary
531ec3f6f9SBlue Swirl  --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
541ec3f6f9SBlue Swirl                             'values', 'possible', 'type', and 'attr' (default
551ec3f6f9SBlue Swirl                             is all off)
561ec3f6f9SBlue Swirl  --test-only=WORD           report only warnings/errors containing WORD
571ec3f6f9SBlue Swirl                             literally
581ec3f6f9SBlue Swirl  -h, --help, --version      display this help and exit
591ec3f6f9SBlue Swirl
601ec3f6f9SBlue SwirlWhen FILE is - read standard input.
611ec3f6f9SBlue SwirlEOM
621ec3f6f9SBlue Swirl
631ec3f6f9SBlue Swirl	exit($exitcode);
641ec3f6f9SBlue Swirl}
651ec3f6f9SBlue Swirl
661ec3f6f9SBlue SwirlGetOptions(
671ec3f6f9SBlue Swirl	'q|quiet+'	=> \$quiet,
681ec3f6f9SBlue Swirl	'tree!'		=> \$tree,
691ec3f6f9SBlue Swirl	'signoff!'	=> \$chk_signoff,
701ec3f6f9SBlue Swirl	'patch!'	=> \$chk_patch,
711ec3f6f9SBlue Swirl	'emacs!'	=> \$emacs,
721ec3f6f9SBlue Swirl	'terse!'	=> \$terse,
731ec3f6f9SBlue Swirl	'f|file!'	=> \$file,
741ec3f6f9SBlue Swirl	'subjective!'	=> \$check,
751ec3f6f9SBlue Swirl	'strict!'	=> \$check,
761ec3f6f9SBlue Swirl	'root=s'	=> \$root,
771ec3f6f9SBlue Swirl	'summary!'	=> \$summary,
781ec3f6f9SBlue Swirl	'mailback!'	=> \$mailback,
791ec3f6f9SBlue Swirl	'summary-file!'	=> \$summary_file,
801ec3f6f9SBlue Swirl
811ec3f6f9SBlue Swirl	'debug=s'	=> \%debug,
821ec3f6f9SBlue Swirl	'test-only=s'	=> \$tst_only,
831ec3f6f9SBlue Swirl	'h|help'	=> \$help,
841ec3f6f9SBlue Swirl	'version'	=> \$help
851ec3f6f9SBlue Swirl) or help(1);
861ec3f6f9SBlue Swirl
871ec3f6f9SBlue Swirlhelp(0) if ($help);
881ec3f6f9SBlue Swirl
891ec3f6f9SBlue Swirlmy $exit = 0;
901ec3f6f9SBlue Swirl
911ec3f6f9SBlue Swirlif ($#ARGV < 0) {
921ec3f6f9SBlue Swirl	print "$P: no input files\n";
931ec3f6f9SBlue Swirl	exit(1);
941ec3f6f9SBlue Swirl}
951ec3f6f9SBlue Swirl
961ec3f6f9SBlue Swirlmy $dbg_values = 0;
971ec3f6f9SBlue Swirlmy $dbg_possible = 0;
981ec3f6f9SBlue Swirlmy $dbg_type = 0;
991ec3f6f9SBlue Swirlmy $dbg_attr = 0;
100a99ac041SDon Slutzmy $dbg_adv_dcs = 0;
1015424302eSDon Slutzmy $dbg_adv_checking = 0;
10269402a69SDon Slutzmy $dbg_adv_apw = 0;
1031ec3f6f9SBlue Swirlfor my $key (keys %debug) {
1041ec3f6f9SBlue Swirl	## no critic
1051ec3f6f9SBlue Swirl	eval "\${dbg_$key} = '$debug{$key}';";
1061ec3f6f9SBlue Swirl	die "$@" if ($@);
1071ec3f6f9SBlue Swirl}
1081ec3f6f9SBlue Swirl
1091ec3f6f9SBlue Swirlmy $rpt_cleaners = 0;
1101ec3f6f9SBlue Swirl
1111ec3f6f9SBlue Swirlif ($terse) {
1121ec3f6f9SBlue Swirl	$emacs = 1;
1131ec3f6f9SBlue Swirl	$quiet++;
1141ec3f6f9SBlue Swirl}
1151ec3f6f9SBlue Swirl
1161ec3f6f9SBlue Swirlif ($tree) {
1171ec3f6f9SBlue Swirl	if (defined $root) {
1181ec3f6f9SBlue Swirl		if (!top_of_kernel_tree($root)) {
1191ec3f6f9SBlue Swirl			die "$P: $root: --root does not point at a valid tree\n";
1201ec3f6f9SBlue Swirl		}
1211ec3f6f9SBlue Swirl	} else {
1221ec3f6f9SBlue Swirl		if (top_of_kernel_tree('.')) {
1231ec3f6f9SBlue Swirl			$root = '.';
1241ec3f6f9SBlue Swirl		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
1251ec3f6f9SBlue Swirl						top_of_kernel_tree($1)) {
1261ec3f6f9SBlue Swirl			$root = $1;
1271ec3f6f9SBlue Swirl		}
1281ec3f6f9SBlue Swirl	}
1291ec3f6f9SBlue Swirl
1301ec3f6f9SBlue Swirl	if (!defined $root) {
1311ec3f6f9SBlue Swirl		print "Must be run from the top-level dir. of a kernel tree\n";
1321ec3f6f9SBlue Swirl		exit(2);
1331ec3f6f9SBlue Swirl	}
1341ec3f6f9SBlue Swirl}
1351ec3f6f9SBlue Swirl
1361ec3f6f9SBlue Swirlmy $emitted_corrupt = 0;
1371ec3f6f9SBlue Swirl
1381ec3f6f9SBlue Swirlour $Ident	= qr{
1391ec3f6f9SBlue Swirl			[A-Za-z_][A-Za-z\d_]*
1401ec3f6f9SBlue Swirl			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
1411ec3f6f9SBlue Swirl		}x;
1421ec3f6f9SBlue Swirlour $Storage	= qr{extern|static|asmlinkage};
1431ec3f6f9SBlue Swirlour $Sparse	= qr{
144f1e155bbSPaolo Bonzini			__force
1451ec3f6f9SBlue Swirl		}x;
1461ec3f6f9SBlue Swirl
1471ec3f6f9SBlue Swirl# Notes to $Attribute:
1481ec3f6f9SBlue Swirlour $Attribute	= qr{
1491ec3f6f9SBlue Swirl			const|
15071c47b01SPaolo Bonzini			volatile|
15171c47b01SPaolo Bonzini			QEMU_NORETURN|
15271c47b01SPaolo Bonzini			QEMU_WARN_UNUSED_RESULT|
15371c47b01SPaolo Bonzini			QEMU_SENTINEL|
15471c47b01SPaolo Bonzini			QEMU_ARTIFICIAL|
15571c47b01SPaolo Bonzini			QEMU_PACKED|
15671c47b01SPaolo Bonzini			GCC_FMT_ATTR
1571ec3f6f9SBlue Swirl		  }x;
1581ec3f6f9SBlue Swirlour $Modifier;
15971c47b01SPaolo Bonziniour $Inline	= qr{inline};
1601ec3f6f9SBlue Swirlour $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
1611ec3f6f9SBlue Swirlour $Lval	= qr{$Ident(?:$Member)*};
1621ec3f6f9SBlue Swirl
1631ec3f6f9SBlue Swirlour $Constant	= qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
1641ec3f6f9SBlue Swirlour $Assignment	= qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
1651ec3f6f9SBlue Swirlour $Compare    = qr{<=|>=|==|!=|<|>};
1661ec3f6f9SBlue Swirlour $Operators	= qr{
1671ec3f6f9SBlue Swirl			<=|>=|==|!=|
1681ec3f6f9SBlue Swirl			=>|->|<<|>>|<|>|!|~|
1691ec3f6f9SBlue Swirl			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
1701ec3f6f9SBlue Swirl		  }x;
1711ec3f6f9SBlue Swirl
1721ec3f6f9SBlue Swirlour $NonptrType;
1731ec3f6f9SBlue Swirlour $Type;
1741ec3f6f9SBlue Swirlour $Declare;
1751ec3f6f9SBlue Swirl
1761ec3f6f9SBlue Swirlour $UTF8	= qr {
1771ec3f6f9SBlue Swirl	[\x09\x0A\x0D\x20-\x7E]              # ASCII
1781ec3f6f9SBlue Swirl	| [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
1791ec3f6f9SBlue Swirl	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
1801ec3f6f9SBlue Swirl	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
1811ec3f6f9SBlue Swirl	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
1821ec3f6f9SBlue Swirl	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
1831ec3f6f9SBlue Swirl	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
1841ec3f6f9SBlue Swirl	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
1851ec3f6f9SBlue Swirl}x;
1861ec3f6f9SBlue Swirl
187a6859debSPaolo Bonzini# There are still some false positives, but this catches most
188a6859debSPaolo Bonzini# common cases.
1891ec3f6f9SBlue Swirlour $typeTypedefs = qr{(?x:
190a6859debSPaolo Bonzini        [A-Z][A-Z\d_]*[a-z][A-Za-z\d_]*     # camelcase
191a6859debSPaolo Bonzini        | [A-Z][A-Z\d_]*AIOCB               # all uppercase
192a6859debSPaolo Bonzini        | [A-Z][A-Z\d_]*CPU                 # all uppercase
193a6859debSPaolo Bonzini        | QEMUBH                            # all uppercase
1941ec3f6f9SBlue Swirl)};
1951ec3f6f9SBlue Swirl
1961ec3f6f9SBlue Swirlour @typeList = (
1971ec3f6f9SBlue Swirl	qr{void},
1981ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?char},
1991ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?short},
2001ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?int},
2011ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?long},
2021ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?long\s+int},
2031ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?long\s+long},
2041ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?long\s+long\s+int},
2051ec3f6f9SBlue Swirl	qr{unsigned},
2061ec3f6f9SBlue Swirl	qr{float},
2071ec3f6f9SBlue Swirl	qr{double},
2081ec3f6f9SBlue Swirl	qr{bool},
2091ec3f6f9SBlue Swirl	qr{struct\s+$Ident},
2101ec3f6f9SBlue Swirl	qr{union\s+$Ident},
2111ec3f6f9SBlue Swirl	qr{enum\s+$Ident},
2121ec3f6f9SBlue Swirl	qr{${Ident}_t},
2131ec3f6f9SBlue Swirl	qr{${Ident}_handler},
2141ec3f6f9SBlue Swirl	qr{${Ident}_handler_fn},
2151ec3f6f9SBlue Swirl);
216f1e155bbSPaolo Bonzini
217f1e155bbSPaolo Bonzini# This can be modified by sub possible.  Since it can be empty, be careful
218f1e155bbSPaolo Bonzini# about regexes that always match, because they can cause infinite loops.
2191ec3f6f9SBlue Swirlour @modifierList = (
2201ec3f6f9SBlue Swirl);
2211ec3f6f9SBlue Swirl
2221ec3f6f9SBlue Swirlsub build_types {
2231ec3f6f9SBlue Swirl	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
224f1e155bbSPaolo Bonzini	if (@modifierList > 0) {
225f1e155bbSPaolo Bonzini		my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
2261ec3f6f9SBlue Swirl		$Modifier = qr{(?:$Attribute|$Sparse|$mods)};
227f1e155bbSPaolo Bonzini	} else {
228f1e155bbSPaolo Bonzini		$Modifier = qr{(?:$Attribute|$Sparse)};
229f1e155bbSPaolo Bonzini	}
2301ec3f6f9SBlue Swirl	$NonptrType	= qr{
2311ec3f6f9SBlue Swirl			(?:$Modifier\s+|const\s+)*
2321ec3f6f9SBlue Swirl			(?:
2331ec3f6f9SBlue Swirl				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
2341ec3f6f9SBlue Swirl				(?:$typeTypedefs\b)|
2351ec3f6f9SBlue Swirl				(?:${all}\b)
2361ec3f6f9SBlue Swirl			)
2371ec3f6f9SBlue Swirl			(?:\s+$Modifier|\s+const)*
2381ec3f6f9SBlue Swirl		  }x;
2391ec3f6f9SBlue Swirl	$Type	= qr{
2401ec3f6f9SBlue Swirl			$NonptrType
2411ec3f6f9SBlue Swirl			(?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
2421ec3f6f9SBlue Swirl			(?:\s+$Inline|\s+$Modifier)*
2431ec3f6f9SBlue Swirl		  }x;
2441ec3f6f9SBlue Swirl	$Declare	= qr{(?:$Storage\s+)?$Type};
2451ec3f6f9SBlue Swirl}
2461ec3f6f9SBlue Swirlbuild_types();
2471ec3f6f9SBlue Swirl
2481ec3f6f9SBlue Swirl$chk_signoff = 0 if ($file);
2491ec3f6f9SBlue Swirl
2501ec3f6f9SBlue Swirlmy @rawlines = ();
2511ec3f6f9SBlue Swirlmy @lines = ();
2521ec3f6f9SBlue Swirlmy $vname;
2531ec3f6f9SBlue Swirlfor my $filename (@ARGV) {
2541ec3f6f9SBlue Swirl	my $FILE;
2551ec3f6f9SBlue Swirl	if ($file) {
2561ec3f6f9SBlue Swirl		open($FILE, '-|', "diff -u /dev/null $filename") ||
2571ec3f6f9SBlue Swirl			die "$P: $filename: diff failed - $!\n";
2581ec3f6f9SBlue Swirl	} elsif ($filename eq '-') {
2591ec3f6f9SBlue Swirl		open($FILE, '<&STDIN');
2601ec3f6f9SBlue Swirl	} else {
2611ec3f6f9SBlue Swirl		open($FILE, '<', "$filename") ||
2621ec3f6f9SBlue Swirl			die "$P: $filename: open failed - $!\n";
2631ec3f6f9SBlue Swirl	}
2641ec3f6f9SBlue Swirl	if ($filename eq '-') {
2651ec3f6f9SBlue Swirl		$vname = 'Your patch';
2661ec3f6f9SBlue Swirl	} else {
2671ec3f6f9SBlue Swirl		$vname = $filename;
2681ec3f6f9SBlue Swirl	}
2691ec3f6f9SBlue Swirl	while (<$FILE>) {
2701ec3f6f9SBlue Swirl		chomp;
2711ec3f6f9SBlue Swirl		push(@rawlines, $_);
2721ec3f6f9SBlue Swirl	}
2731ec3f6f9SBlue Swirl	close($FILE);
2741ec3f6f9SBlue Swirl	if (!process($filename)) {
2751ec3f6f9SBlue Swirl		$exit = 1;
2761ec3f6f9SBlue Swirl	}
2771ec3f6f9SBlue Swirl	@rawlines = ();
2781ec3f6f9SBlue Swirl	@lines = ();
2791ec3f6f9SBlue Swirl}
2801ec3f6f9SBlue Swirl
2811ec3f6f9SBlue Swirlexit($exit);
2821ec3f6f9SBlue Swirl
2831ec3f6f9SBlue Swirlsub top_of_kernel_tree {
2841ec3f6f9SBlue Swirl	my ($root) = @_;
2851ec3f6f9SBlue Swirl
2861ec3f6f9SBlue Swirl	my @tree_check = (
287b6469683SBlue Swirl		"COPYING", "MAINTAINERS", "Makefile",
288b6469683SBlue Swirl		"README", "docs", "VERSION",
289b6469683SBlue Swirl		"vl.c"
2901ec3f6f9SBlue Swirl	);
2911ec3f6f9SBlue Swirl
2921ec3f6f9SBlue Swirl	foreach my $check (@tree_check) {
2931ec3f6f9SBlue Swirl		if (! -e $root . '/' . $check) {
2941ec3f6f9SBlue Swirl			return 0;
2951ec3f6f9SBlue Swirl		}
2961ec3f6f9SBlue Swirl	}
2971ec3f6f9SBlue Swirl	return 1;
2981ec3f6f9SBlue Swirl}
2991ec3f6f9SBlue Swirl
3001ec3f6f9SBlue Swirlsub expand_tabs {
3011ec3f6f9SBlue Swirl	my ($str) = @_;
3021ec3f6f9SBlue Swirl
3031ec3f6f9SBlue Swirl	my $res = '';
3041ec3f6f9SBlue Swirl	my $n = 0;
3051ec3f6f9SBlue Swirl	for my $c (split(//, $str)) {
3061ec3f6f9SBlue Swirl		if ($c eq "\t") {
3071ec3f6f9SBlue Swirl			$res .= ' ';
3081ec3f6f9SBlue Swirl			$n++;
3091ec3f6f9SBlue Swirl			for (; ($n % 8) != 0; $n++) {
3101ec3f6f9SBlue Swirl				$res .= ' ';
3111ec3f6f9SBlue Swirl			}
3121ec3f6f9SBlue Swirl			next;
3131ec3f6f9SBlue Swirl		}
3141ec3f6f9SBlue Swirl		$res .= $c;
3151ec3f6f9SBlue Swirl		$n++;
3161ec3f6f9SBlue Swirl	}
3171ec3f6f9SBlue Swirl
3181ec3f6f9SBlue Swirl	return $res;
3191ec3f6f9SBlue Swirl}
3201ec3f6f9SBlue Swirlsub copy_spacing {
3211ec3f6f9SBlue Swirl	(my $res = shift) =~ tr/\t/ /c;
3221ec3f6f9SBlue Swirl	return $res;
3231ec3f6f9SBlue Swirl}
3241ec3f6f9SBlue Swirl
3251ec3f6f9SBlue Swirlsub line_stats {
3261ec3f6f9SBlue Swirl	my ($line) = @_;
3271ec3f6f9SBlue Swirl
3281ec3f6f9SBlue Swirl	# Drop the diff line leader and expand tabs
3291ec3f6f9SBlue Swirl	$line =~ s/^.//;
3301ec3f6f9SBlue Swirl	$line = expand_tabs($line);
3311ec3f6f9SBlue Swirl
3321ec3f6f9SBlue Swirl	# Pick the indent from the front of the line.
3331ec3f6f9SBlue Swirl	my ($white) = ($line =~ /^(\s*)/);
3341ec3f6f9SBlue Swirl
3351ec3f6f9SBlue Swirl	return (length($line), length($white));
3361ec3f6f9SBlue Swirl}
3371ec3f6f9SBlue Swirl
3381ec3f6f9SBlue Swirlmy $sanitise_quote = '';
3391ec3f6f9SBlue Swirl
3401ec3f6f9SBlue Swirlsub sanitise_line_reset {
3411ec3f6f9SBlue Swirl	my ($in_comment) = @_;
3421ec3f6f9SBlue Swirl
3431ec3f6f9SBlue Swirl	if ($in_comment) {
3441ec3f6f9SBlue Swirl		$sanitise_quote = '*/';
3451ec3f6f9SBlue Swirl	} else {
3461ec3f6f9SBlue Swirl		$sanitise_quote = '';
3471ec3f6f9SBlue Swirl	}
3481ec3f6f9SBlue Swirl}
3491ec3f6f9SBlue Swirlsub sanitise_line {
3501ec3f6f9SBlue Swirl	my ($line) = @_;
3511ec3f6f9SBlue Swirl
3521ec3f6f9SBlue Swirl	my $res = '';
3531ec3f6f9SBlue Swirl	my $l = '';
3541ec3f6f9SBlue Swirl
3551ec3f6f9SBlue Swirl	my $qlen = 0;
3561ec3f6f9SBlue Swirl	my $off = 0;
3571ec3f6f9SBlue Swirl	my $c;
3581ec3f6f9SBlue Swirl
3591ec3f6f9SBlue Swirl	# Always copy over the diff marker.
3601ec3f6f9SBlue Swirl	$res = substr($line, 0, 1);
3611ec3f6f9SBlue Swirl
3621ec3f6f9SBlue Swirl	for ($off = 1; $off < length($line); $off++) {
3631ec3f6f9SBlue Swirl		$c = substr($line, $off, 1);
3641ec3f6f9SBlue Swirl
3651ec3f6f9SBlue Swirl		# Comments we are wacking completly including the begin
3661ec3f6f9SBlue Swirl		# and end, all to $;.
3671ec3f6f9SBlue Swirl		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
3681ec3f6f9SBlue Swirl			$sanitise_quote = '*/';
3691ec3f6f9SBlue Swirl
3701ec3f6f9SBlue Swirl			substr($res, $off, 2, "$;$;");
3711ec3f6f9SBlue Swirl			$off++;
3721ec3f6f9SBlue Swirl			next;
3731ec3f6f9SBlue Swirl		}
3741ec3f6f9SBlue Swirl		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
3751ec3f6f9SBlue Swirl			$sanitise_quote = '';
3761ec3f6f9SBlue Swirl			substr($res, $off, 2, "$;$;");
3771ec3f6f9SBlue Swirl			$off++;
3781ec3f6f9SBlue Swirl			next;
3791ec3f6f9SBlue Swirl		}
3801ec3f6f9SBlue Swirl		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
3811ec3f6f9SBlue Swirl			$sanitise_quote = '//';
3821ec3f6f9SBlue Swirl
3831ec3f6f9SBlue Swirl			substr($res, $off, 2, $sanitise_quote);
3841ec3f6f9SBlue Swirl			$off++;
3851ec3f6f9SBlue Swirl			next;
3861ec3f6f9SBlue Swirl		}
3871ec3f6f9SBlue Swirl
3881ec3f6f9SBlue Swirl		# A \ in a string means ignore the next character.
3891ec3f6f9SBlue Swirl		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
3901ec3f6f9SBlue Swirl		    $c eq "\\") {
3911ec3f6f9SBlue Swirl			substr($res, $off, 2, 'XX');
3921ec3f6f9SBlue Swirl			$off++;
3931ec3f6f9SBlue Swirl			next;
3941ec3f6f9SBlue Swirl		}
3951ec3f6f9SBlue Swirl		# Regular quotes.
3961ec3f6f9SBlue Swirl		if ($c eq "'" || $c eq '"') {
3971ec3f6f9SBlue Swirl			if ($sanitise_quote eq '') {
3981ec3f6f9SBlue Swirl				$sanitise_quote = $c;
3991ec3f6f9SBlue Swirl
4001ec3f6f9SBlue Swirl				substr($res, $off, 1, $c);
4011ec3f6f9SBlue Swirl				next;
4021ec3f6f9SBlue Swirl			} elsif ($sanitise_quote eq $c) {
4031ec3f6f9SBlue Swirl				$sanitise_quote = '';
4041ec3f6f9SBlue Swirl			}
4051ec3f6f9SBlue Swirl		}
4061ec3f6f9SBlue Swirl
4071ec3f6f9SBlue Swirl		#print "c<$c> SQ<$sanitise_quote>\n";
4081ec3f6f9SBlue Swirl		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
4091ec3f6f9SBlue Swirl			substr($res, $off, 1, $;);
4101ec3f6f9SBlue Swirl		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
4111ec3f6f9SBlue Swirl			substr($res, $off, 1, $;);
4121ec3f6f9SBlue Swirl		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
4131ec3f6f9SBlue Swirl			substr($res, $off, 1, 'X');
4141ec3f6f9SBlue Swirl		} else {
4151ec3f6f9SBlue Swirl			substr($res, $off, 1, $c);
4161ec3f6f9SBlue Swirl		}
4171ec3f6f9SBlue Swirl	}
4181ec3f6f9SBlue Swirl
4191ec3f6f9SBlue Swirl	if ($sanitise_quote eq '//') {
4201ec3f6f9SBlue Swirl		$sanitise_quote = '';
4211ec3f6f9SBlue Swirl	}
4221ec3f6f9SBlue Swirl
4231ec3f6f9SBlue Swirl	# The pathname on a #include may be surrounded by '<' and '>'.
4241ec3f6f9SBlue Swirl	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
4251ec3f6f9SBlue Swirl		my $clean = 'X' x length($1);
4261ec3f6f9SBlue Swirl		$res =~ s@\<.*\>@<$clean>@;
4271ec3f6f9SBlue Swirl
4281ec3f6f9SBlue Swirl	# The whole of a #error is a string.
4291ec3f6f9SBlue Swirl	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
4301ec3f6f9SBlue Swirl		my $clean = 'X' x length($1);
4311ec3f6f9SBlue Swirl		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
4321ec3f6f9SBlue Swirl	}
4331ec3f6f9SBlue Swirl
4341ec3f6f9SBlue Swirl	return $res;
4351ec3f6f9SBlue Swirl}
4361ec3f6f9SBlue Swirl
4371ec3f6f9SBlue Swirlsub ctx_statement_block {
4381ec3f6f9SBlue Swirl	my ($linenr, $remain, $off) = @_;
4391ec3f6f9SBlue Swirl	my $line = $linenr - 1;
4401ec3f6f9SBlue Swirl	my $blk = '';
4411ec3f6f9SBlue Swirl	my $soff = $off;
4421ec3f6f9SBlue Swirl	my $coff = $off - 1;
4431ec3f6f9SBlue Swirl	my $coff_set = 0;
4441ec3f6f9SBlue Swirl
4451ec3f6f9SBlue Swirl	my $loff = 0;
4461ec3f6f9SBlue Swirl
4471ec3f6f9SBlue Swirl	my $type = '';
4481ec3f6f9SBlue Swirl	my $level = 0;
4491ec3f6f9SBlue Swirl	my @stack = ();
4501ec3f6f9SBlue Swirl	my $p;
4511ec3f6f9SBlue Swirl	my $c;
4521ec3f6f9SBlue Swirl	my $len = 0;
4531ec3f6f9SBlue Swirl
4541ec3f6f9SBlue Swirl	my $remainder;
4551ec3f6f9SBlue Swirl	while (1) {
4561ec3f6f9SBlue Swirl		@stack = (['', 0]) if ($#stack == -1);
4571ec3f6f9SBlue Swirl
4581ec3f6f9SBlue Swirl		#warn "CSB: blk<$blk> remain<$remain>\n";
4591ec3f6f9SBlue Swirl		# If we are about to drop off the end, pull in more
4601ec3f6f9SBlue Swirl		# context.
4611ec3f6f9SBlue Swirl		if ($off >= $len) {
4621ec3f6f9SBlue Swirl			for (; $remain > 0; $line++) {
4631ec3f6f9SBlue Swirl				last if (!defined $lines[$line]);
4641ec3f6f9SBlue Swirl				next if ($lines[$line] =~ /^-/);
4651ec3f6f9SBlue Swirl				$remain--;
4661ec3f6f9SBlue Swirl				$loff = $len;
4671ec3f6f9SBlue Swirl				$blk .= $lines[$line] . "\n";
4681ec3f6f9SBlue Swirl				$len = length($blk);
4691ec3f6f9SBlue Swirl				$line++;
4701ec3f6f9SBlue Swirl				last;
4711ec3f6f9SBlue Swirl			}
4721ec3f6f9SBlue Swirl			# Bail if there is no further context.
4731ec3f6f9SBlue Swirl			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
4741ec3f6f9SBlue Swirl			if ($off >= $len) {
4751ec3f6f9SBlue Swirl				last;
4761ec3f6f9SBlue Swirl			}
4771ec3f6f9SBlue Swirl		}
4781ec3f6f9SBlue Swirl		$p = $c;
4791ec3f6f9SBlue Swirl		$c = substr($blk, $off, 1);
4801ec3f6f9SBlue Swirl		$remainder = substr($blk, $off);
4811ec3f6f9SBlue Swirl
4821ec3f6f9SBlue Swirl		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
4831ec3f6f9SBlue Swirl
4841ec3f6f9SBlue Swirl		# Handle nested #if/#else.
4851ec3f6f9SBlue Swirl		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
4861ec3f6f9SBlue Swirl			push(@stack, [ $type, $level ]);
4871ec3f6f9SBlue Swirl		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
4881ec3f6f9SBlue Swirl			($type, $level) = @{$stack[$#stack - 1]};
4891ec3f6f9SBlue Swirl		} elsif ($remainder =~ /^#\s*endif\b/) {
4901ec3f6f9SBlue Swirl			($type, $level) = @{pop(@stack)};
4911ec3f6f9SBlue Swirl		}
4921ec3f6f9SBlue Swirl
4931ec3f6f9SBlue Swirl		# Statement ends at the ';' or a close '}' at the
4941ec3f6f9SBlue Swirl		# outermost level.
4951ec3f6f9SBlue Swirl		if ($level == 0 && $c eq ';') {
4961ec3f6f9SBlue Swirl			last;
4971ec3f6f9SBlue Swirl		}
4981ec3f6f9SBlue Swirl
4991ec3f6f9SBlue Swirl		# An else is really a conditional as long as its not else if
5001ec3f6f9SBlue Swirl		if ($level == 0 && $coff_set == 0 &&
5011ec3f6f9SBlue Swirl				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
5021ec3f6f9SBlue Swirl				$remainder =~ /^(else)(?:\s|{)/ &&
5031ec3f6f9SBlue Swirl				$remainder !~ /^else\s+if\b/) {
5041ec3f6f9SBlue Swirl			$coff = $off + length($1) - 1;
5051ec3f6f9SBlue Swirl			$coff_set = 1;
5061ec3f6f9SBlue Swirl			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
5071ec3f6f9SBlue Swirl			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
5081ec3f6f9SBlue Swirl		}
5091ec3f6f9SBlue Swirl
5101ec3f6f9SBlue Swirl		if (($type eq '' || $type eq '(') && $c eq '(') {
5111ec3f6f9SBlue Swirl			$level++;
5121ec3f6f9SBlue Swirl			$type = '(';
5131ec3f6f9SBlue Swirl		}
5141ec3f6f9SBlue Swirl		if ($type eq '(' && $c eq ')') {
5151ec3f6f9SBlue Swirl			$level--;
5161ec3f6f9SBlue Swirl			$type = ($level != 0)? '(' : '';
5171ec3f6f9SBlue Swirl
5181ec3f6f9SBlue Swirl			if ($level == 0 && $coff < $soff) {
5191ec3f6f9SBlue Swirl				$coff = $off;
5201ec3f6f9SBlue Swirl				$coff_set = 1;
5211ec3f6f9SBlue Swirl				#warn "CSB: mark coff<$coff>\n";
5221ec3f6f9SBlue Swirl			}
5231ec3f6f9SBlue Swirl		}
5241ec3f6f9SBlue Swirl		if (($type eq '' || $type eq '{') && $c eq '{') {
5251ec3f6f9SBlue Swirl			$level++;
5261ec3f6f9SBlue Swirl			$type = '{';
5271ec3f6f9SBlue Swirl		}
5281ec3f6f9SBlue Swirl		if ($type eq '{' && $c eq '}') {
5291ec3f6f9SBlue Swirl			$level--;
5301ec3f6f9SBlue Swirl			$type = ($level != 0)? '{' : '';
5311ec3f6f9SBlue Swirl
5321ec3f6f9SBlue Swirl			if ($level == 0) {
5331ec3f6f9SBlue Swirl				if (substr($blk, $off + 1, 1) eq ';') {
5341ec3f6f9SBlue Swirl					$off++;
5351ec3f6f9SBlue Swirl				}
5361ec3f6f9SBlue Swirl				last;
5371ec3f6f9SBlue Swirl			}
5381ec3f6f9SBlue Swirl		}
5391ec3f6f9SBlue Swirl		$off++;
5401ec3f6f9SBlue Swirl	}
5411ec3f6f9SBlue Swirl	# We are truly at the end, so shuffle to the next line.
5421ec3f6f9SBlue Swirl	if ($off == $len) {
5431ec3f6f9SBlue Swirl		$loff = $len + 1;
5441ec3f6f9SBlue Swirl		$line++;
5451ec3f6f9SBlue Swirl		$remain--;
5461ec3f6f9SBlue Swirl	}
5471ec3f6f9SBlue Swirl
5481ec3f6f9SBlue Swirl	my $statement = substr($blk, $soff, $off - $soff + 1);
5491ec3f6f9SBlue Swirl	my $condition = substr($blk, $soff, $coff - $soff + 1);
5501ec3f6f9SBlue Swirl
5511ec3f6f9SBlue Swirl	#warn "STATEMENT<$statement>\n";
5521ec3f6f9SBlue Swirl	#warn "CONDITION<$condition>\n";
5531ec3f6f9SBlue Swirl
5541ec3f6f9SBlue Swirl	#print "coff<$coff> soff<$off> loff<$loff>\n";
5551ec3f6f9SBlue Swirl
5561ec3f6f9SBlue Swirl	return ($statement, $condition,
5571ec3f6f9SBlue Swirl			$line, $remain + 1, $off - $loff + 1, $level);
5581ec3f6f9SBlue Swirl}
5591ec3f6f9SBlue Swirl
5601ec3f6f9SBlue Swirlsub statement_lines {
5611ec3f6f9SBlue Swirl	my ($stmt) = @_;
5621ec3f6f9SBlue Swirl
5631ec3f6f9SBlue Swirl	# Strip the diff line prefixes and rip blank lines at start and end.
5641ec3f6f9SBlue Swirl	$stmt =~ s/(^|\n)./$1/g;
5651ec3f6f9SBlue Swirl	$stmt =~ s/^\s*//;
5661ec3f6f9SBlue Swirl	$stmt =~ s/\s*$//;
5671ec3f6f9SBlue Swirl
5681ec3f6f9SBlue Swirl	my @stmt_lines = ($stmt =~ /\n/g);
5691ec3f6f9SBlue Swirl
5701ec3f6f9SBlue Swirl	return $#stmt_lines + 2;
5711ec3f6f9SBlue Swirl}
5721ec3f6f9SBlue Swirl
5731ec3f6f9SBlue Swirlsub statement_rawlines {
5741ec3f6f9SBlue Swirl	my ($stmt) = @_;
5751ec3f6f9SBlue Swirl
5761ec3f6f9SBlue Swirl	my @stmt_lines = ($stmt =~ /\n/g);
5771ec3f6f9SBlue Swirl
5781ec3f6f9SBlue Swirl	return $#stmt_lines + 2;
5791ec3f6f9SBlue Swirl}
5801ec3f6f9SBlue Swirl
5811ec3f6f9SBlue Swirlsub statement_block_size {
5821ec3f6f9SBlue Swirl	my ($stmt) = @_;
5831ec3f6f9SBlue Swirl
5841ec3f6f9SBlue Swirl	$stmt =~ s/(^|\n)./$1/g;
58504f2562fSFam Zheng	$stmt =~ s/^\s*\{//;
5861ec3f6f9SBlue Swirl	$stmt =~ s/}\s*$//;
5871ec3f6f9SBlue Swirl	$stmt =~ s/^\s*//;
5881ec3f6f9SBlue Swirl	$stmt =~ s/\s*$//;
5891ec3f6f9SBlue Swirl
5901ec3f6f9SBlue Swirl	my @stmt_lines = ($stmt =~ /\n/g);
5911ec3f6f9SBlue Swirl	my @stmt_statements = ($stmt =~ /;/g);
5921ec3f6f9SBlue Swirl
5931ec3f6f9SBlue Swirl	my $stmt_lines = $#stmt_lines + 2;
5941ec3f6f9SBlue Swirl	my $stmt_statements = $#stmt_statements + 1;
5951ec3f6f9SBlue Swirl
5961ec3f6f9SBlue Swirl	if ($stmt_lines > $stmt_statements) {
5971ec3f6f9SBlue Swirl		return $stmt_lines;
5981ec3f6f9SBlue Swirl	} else {
5991ec3f6f9SBlue Swirl		return $stmt_statements;
6001ec3f6f9SBlue Swirl	}
6011ec3f6f9SBlue Swirl}
6021ec3f6f9SBlue Swirl
6031ec3f6f9SBlue Swirlsub ctx_statement_full {
6041ec3f6f9SBlue Swirl	my ($linenr, $remain, $off) = @_;
6051ec3f6f9SBlue Swirl	my ($statement, $condition, $level);
6061ec3f6f9SBlue Swirl
6071ec3f6f9SBlue Swirl	my (@chunks);
6081ec3f6f9SBlue Swirl
6091ec3f6f9SBlue Swirl	# Grab the first conditional/block pair.
6101ec3f6f9SBlue Swirl	($statement, $condition, $linenr, $remain, $off, $level) =
6111ec3f6f9SBlue Swirl				ctx_statement_block($linenr, $remain, $off);
6121ec3f6f9SBlue Swirl	#print "F: c<$condition> s<$statement> remain<$remain>\n";
6131ec3f6f9SBlue Swirl	push(@chunks, [ $condition, $statement ]);
6141ec3f6f9SBlue Swirl	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
6151ec3f6f9SBlue Swirl		return ($level, $linenr, @chunks);
6161ec3f6f9SBlue Swirl	}
6171ec3f6f9SBlue Swirl
6181ec3f6f9SBlue Swirl	# Pull in the following conditional/block pairs and see if they
6191ec3f6f9SBlue Swirl	# could continue the statement.
6201ec3f6f9SBlue Swirl	for (;;) {
6211ec3f6f9SBlue Swirl		($statement, $condition, $linenr, $remain, $off, $level) =
6221ec3f6f9SBlue Swirl				ctx_statement_block($linenr, $remain, $off);
6231ec3f6f9SBlue Swirl		#print "C: c<$condition> s<$statement> remain<$remain>\n";
6241ec3f6f9SBlue Swirl		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
6251ec3f6f9SBlue Swirl		#print "C: push\n";
6261ec3f6f9SBlue Swirl		push(@chunks, [ $condition, $statement ]);
6271ec3f6f9SBlue Swirl	}
6281ec3f6f9SBlue Swirl
6291ec3f6f9SBlue Swirl	return ($level, $linenr, @chunks);
6301ec3f6f9SBlue Swirl}
6311ec3f6f9SBlue Swirl
6321ec3f6f9SBlue Swirlsub ctx_block_get {
6331ec3f6f9SBlue Swirl	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
6341ec3f6f9SBlue Swirl	my $line;
6351ec3f6f9SBlue Swirl	my $start = $linenr - 1;
6361ec3f6f9SBlue Swirl	my $blk = '';
6371ec3f6f9SBlue Swirl	my @o;
6381ec3f6f9SBlue Swirl	my @c;
6391ec3f6f9SBlue Swirl	my @res = ();
6401ec3f6f9SBlue Swirl
6411ec3f6f9SBlue Swirl	my $level = 0;
6421ec3f6f9SBlue Swirl	my @stack = ($level);
6431ec3f6f9SBlue Swirl	for ($line = $start; $remain > 0; $line++) {
6441ec3f6f9SBlue Swirl		next if ($rawlines[$line] =~ /^-/);
6451ec3f6f9SBlue Swirl		$remain--;
6461ec3f6f9SBlue Swirl
6471ec3f6f9SBlue Swirl		$blk .= $rawlines[$line];
6481ec3f6f9SBlue Swirl
6491ec3f6f9SBlue Swirl		# Handle nested #if/#else.
6501ec3f6f9SBlue Swirl		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
6511ec3f6f9SBlue Swirl			push(@stack, $level);
6521ec3f6f9SBlue Swirl		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
6531ec3f6f9SBlue Swirl			$level = $stack[$#stack - 1];
6541ec3f6f9SBlue Swirl		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
6551ec3f6f9SBlue Swirl			$level = pop(@stack);
6561ec3f6f9SBlue Swirl		}
6571ec3f6f9SBlue Swirl
6581ec3f6f9SBlue Swirl		foreach my $c (split(//, $lines[$line])) {
6591ec3f6f9SBlue Swirl			##print "C<$c>L<$level><$open$close>O<$off>\n";
6601ec3f6f9SBlue Swirl			if ($off > 0) {
6611ec3f6f9SBlue Swirl				$off--;
6621ec3f6f9SBlue Swirl				next;
6631ec3f6f9SBlue Swirl			}
6641ec3f6f9SBlue Swirl
6651ec3f6f9SBlue Swirl			if ($c eq $close && $level > 0) {
6661ec3f6f9SBlue Swirl				$level--;
6671ec3f6f9SBlue Swirl				last if ($level == 0);
6681ec3f6f9SBlue Swirl			} elsif ($c eq $open) {
6691ec3f6f9SBlue Swirl				$level++;
6701ec3f6f9SBlue Swirl			}
6711ec3f6f9SBlue Swirl		}
6721ec3f6f9SBlue Swirl
6731ec3f6f9SBlue Swirl		if (!$outer || $level <= 1) {
6741ec3f6f9SBlue Swirl			push(@res, $rawlines[$line]);
6751ec3f6f9SBlue Swirl		}
6761ec3f6f9SBlue Swirl
6771ec3f6f9SBlue Swirl		last if ($level == 0);
6781ec3f6f9SBlue Swirl	}
6791ec3f6f9SBlue Swirl
6801ec3f6f9SBlue Swirl	return ($level, @res);
6811ec3f6f9SBlue Swirl}
6821ec3f6f9SBlue Swirlsub ctx_block_outer {
6831ec3f6f9SBlue Swirl	my ($linenr, $remain) = @_;
6841ec3f6f9SBlue Swirl
6851ec3f6f9SBlue Swirl	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
6861ec3f6f9SBlue Swirl	return @r;
6871ec3f6f9SBlue Swirl}
6881ec3f6f9SBlue Swirlsub ctx_block {
6891ec3f6f9SBlue Swirl	my ($linenr, $remain) = @_;
6901ec3f6f9SBlue Swirl
6911ec3f6f9SBlue Swirl	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
6921ec3f6f9SBlue Swirl	return @r;
6931ec3f6f9SBlue Swirl}
6941ec3f6f9SBlue Swirlsub ctx_statement {
6951ec3f6f9SBlue Swirl	my ($linenr, $remain, $off) = @_;
6961ec3f6f9SBlue Swirl
6971ec3f6f9SBlue Swirl	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
6981ec3f6f9SBlue Swirl	return @r;
6991ec3f6f9SBlue Swirl}
7001ec3f6f9SBlue Swirlsub ctx_block_level {
7011ec3f6f9SBlue Swirl	my ($linenr, $remain) = @_;
7021ec3f6f9SBlue Swirl
7031ec3f6f9SBlue Swirl	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
7041ec3f6f9SBlue Swirl}
7051ec3f6f9SBlue Swirlsub ctx_statement_level {
7061ec3f6f9SBlue Swirl	my ($linenr, $remain, $off) = @_;
7071ec3f6f9SBlue Swirl
7081ec3f6f9SBlue Swirl	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
7091ec3f6f9SBlue Swirl}
7101ec3f6f9SBlue Swirl
7111ec3f6f9SBlue Swirlsub ctx_locate_comment {
7121ec3f6f9SBlue Swirl	my ($first_line, $end_line) = @_;
7131ec3f6f9SBlue Swirl
7141ec3f6f9SBlue Swirl	# Catch a comment on the end of the line itself.
7151ec3f6f9SBlue Swirl	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
7161ec3f6f9SBlue Swirl	return $current_comment if (defined $current_comment);
7171ec3f6f9SBlue Swirl
7181ec3f6f9SBlue Swirl	# Look through the context and try and figure out if there is a
7191ec3f6f9SBlue Swirl	# comment.
7201ec3f6f9SBlue Swirl	my $in_comment = 0;
7211ec3f6f9SBlue Swirl	$current_comment = '';
7221ec3f6f9SBlue Swirl	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
7231ec3f6f9SBlue Swirl		my $line = $rawlines[$linenr - 1];
7241ec3f6f9SBlue Swirl		#warn "           $line\n";
7251ec3f6f9SBlue Swirl		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
7261ec3f6f9SBlue Swirl			$in_comment = 1;
7271ec3f6f9SBlue Swirl		}
7281ec3f6f9SBlue Swirl		if ($line =~ m@/\*@) {
7291ec3f6f9SBlue Swirl			$in_comment = 1;
7301ec3f6f9SBlue Swirl		}
7311ec3f6f9SBlue Swirl		if (!$in_comment && $current_comment ne '') {
7321ec3f6f9SBlue Swirl			$current_comment = '';
7331ec3f6f9SBlue Swirl		}
7341ec3f6f9SBlue Swirl		$current_comment .= $line . "\n" if ($in_comment);
7351ec3f6f9SBlue Swirl		if ($line =~ m@\*/@) {
7361ec3f6f9SBlue Swirl			$in_comment = 0;
7371ec3f6f9SBlue Swirl		}
7381ec3f6f9SBlue Swirl	}
7391ec3f6f9SBlue Swirl
7401ec3f6f9SBlue Swirl	chomp($current_comment);
7411ec3f6f9SBlue Swirl	return($current_comment);
7421ec3f6f9SBlue Swirl}
7431ec3f6f9SBlue Swirlsub ctx_has_comment {
7441ec3f6f9SBlue Swirl	my ($first_line, $end_line) = @_;
7451ec3f6f9SBlue Swirl	my $cmt = ctx_locate_comment($first_line, $end_line);
7461ec3f6f9SBlue Swirl
7471ec3f6f9SBlue Swirl	##print "LINE: $rawlines[$end_line - 1 ]\n";
7481ec3f6f9SBlue Swirl	##print "CMMT: $cmt\n";
7491ec3f6f9SBlue Swirl
7501ec3f6f9SBlue Swirl	return ($cmt ne '');
7511ec3f6f9SBlue Swirl}
7521ec3f6f9SBlue Swirl
7531ec3f6f9SBlue Swirlsub raw_line {
7541ec3f6f9SBlue Swirl	my ($linenr, $cnt) = @_;
7551ec3f6f9SBlue Swirl
7561ec3f6f9SBlue Swirl	my $offset = $linenr - 1;
7571ec3f6f9SBlue Swirl	$cnt++;
7581ec3f6f9SBlue Swirl
7591ec3f6f9SBlue Swirl	my $line;
7601ec3f6f9SBlue Swirl	while ($cnt) {
7611ec3f6f9SBlue Swirl		$line = $rawlines[$offset++];
7621ec3f6f9SBlue Swirl		next if (defined($line) && $line =~ /^-/);
7631ec3f6f9SBlue Swirl		$cnt--;
7641ec3f6f9SBlue Swirl	}
7651ec3f6f9SBlue Swirl
7661ec3f6f9SBlue Swirl	return $line;
7671ec3f6f9SBlue Swirl}
7681ec3f6f9SBlue Swirl
7691ec3f6f9SBlue Swirlsub cat_vet {
7701ec3f6f9SBlue Swirl	my ($vet) = @_;
7711ec3f6f9SBlue Swirl	my ($res, $coded);
7721ec3f6f9SBlue Swirl
7731ec3f6f9SBlue Swirl	$res = '';
7741ec3f6f9SBlue Swirl	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
7751ec3f6f9SBlue Swirl		$res .= $1;
7761ec3f6f9SBlue Swirl		if ($2 ne '') {
7771ec3f6f9SBlue Swirl			$coded = sprintf("^%c", unpack('C', $2) + 64);
7781ec3f6f9SBlue Swirl			$res .= $coded;
7791ec3f6f9SBlue Swirl		}
7801ec3f6f9SBlue Swirl	}
7811ec3f6f9SBlue Swirl	$res =~ s/$/\$/;
7821ec3f6f9SBlue Swirl
7831ec3f6f9SBlue Swirl	return $res;
7841ec3f6f9SBlue Swirl}
7851ec3f6f9SBlue Swirl
7861ec3f6f9SBlue Swirlmy $av_preprocessor = 0;
7871ec3f6f9SBlue Swirlmy $av_pending;
7881ec3f6f9SBlue Swirlmy @av_paren_type;
7891ec3f6f9SBlue Swirlmy $av_pend_colon;
7901ec3f6f9SBlue Swirl
7911ec3f6f9SBlue Swirlsub annotate_reset {
7921ec3f6f9SBlue Swirl	$av_preprocessor = 0;
7931ec3f6f9SBlue Swirl	$av_pending = '_';
7941ec3f6f9SBlue Swirl	@av_paren_type = ('E');
7951ec3f6f9SBlue Swirl	$av_pend_colon = 'O';
7961ec3f6f9SBlue Swirl}
7971ec3f6f9SBlue Swirl
7981ec3f6f9SBlue Swirlsub annotate_values {
7991ec3f6f9SBlue Swirl	my ($stream, $type) = @_;
8001ec3f6f9SBlue Swirl
8011ec3f6f9SBlue Swirl	my $res;
8021ec3f6f9SBlue Swirl	my $var = '_' x length($stream);
8031ec3f6f9SBlue Swirl	my $cur = $stream;
8041ec3f6f9SBlue Swirl
8051ec3f6f9SBlue Swirl	print "$stream\n" if ($dbg_values > 1);
8061ec3f6f9SBlue Swirl
8071ec3f6f9SBlue Swirl	while (length($cur)) {
8081ec3f6f9SBlue Swirl		@av_paren_type = ('E') if ($#av_paren_type < 0);
8091ec3f6f9SBlue Swirl		print " <" . join('', @av_paren_type) .
8101ec3f6f9SBlue Swirl				"> <$type> <$av_pending>" if ($dbg_values > 1);
8111ec3f6f9SBlue Swirl		if ($cur =~ /^(\s+)/o) {
8121ec3f6f9SBlue Swirl			print "WS($1)\n" if ($dbg_values > 1);
8131ec3f6f9SBlue Swirl			if ($1 =~ /\n/ && $av_preprocessor) {
8141ec3f6f9SBlue Swirl				$type = pop(@av_paren_type);
8151ec3f6f9SBlue Swirl				$av_preprocessor = 0;
8161ec3f6f9SBlue Swirl			}
8171ec3f6f9SBlue Swirl
81861669f9aSFlorian Mickler		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
8191ec3f6f9SBlue Swirl			print "CAST($1)\n" if ($dbg_values > 1);
8201ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
8211ec3f6f9SBlue Swirl			$type = 'C';
8221ec3f6f9SBlue Swirl
8231ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
8241ec3f6f9SBlue Swirl			print "DECLARE($1)\n" if ($dbg_values > 1);
8251ec3f6f9SBlue Swirl			$type = 'T';
8261ec3f6f9SBlue Swirl
8271ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Modifier)\s*/) {
8281ec3f6f9SBlue Swirl			print "MODIFIER($1)\n" if ($dbg_values > 1);
8291ec3f6f9SBlue Swirl			$type = 'T';
8301ec3f6f9SBlue Swirl
8311ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
8321ec3f6f9SBlue Swirl			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
8331ec3f6f9SBlue Swirl			$av_preprocessor = 1;
8341ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
8351ec3f6f9SBlue Swirl			if ($2 ne '') {
8361ec3f6f9SBlue Swirl				$av_pending = 'N';
8371ec3f6f9SBlue Swirl			}
8381ec3f6f9SBlue Swirl			$type = 'E';
8391ec3f6f9SBlue Swirl
8401ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
8411ec3f6f9SBlue Swirl			print "UNDEF($1)\n" if ($dbg_values > 1);
8421ec3f6f9SBlue Swirl			$av_preprocessor = 1;
8431ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
8441ec3f6f9SBlue Swirl
8451ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
8461ec3f6f9SBlue Swirl			print "PRE_START($1)\n" if ($dbg_values > 1);
8471ec3f6f9SBlue Swirl			$av_preprocessor = 1;
8481ec3f6f9SBlue Swirl
8491ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
8501ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
8511ec3f6f9SBlue Swirl			$type = 'E';
8521ec3f6f9SBlue Swirl
8531ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
8541ec3f6f9SBlue Swirl			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
8551ec3f6f9SBlue Swirl			$av_preprocessor = 1;
8561ec3f6f9SBlue Swirl
8571ec3f6f9SBlue Swirl			push(@av_paren_type, $av_paren_type[$#av_paren_type]);
8581ec3f6f9SBlue Swirl
8591ec3f6f9SBlue Swirl			$type = 'E';
8601ec3f6f9SBlue Swirl
8611ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
8621ec3f6f9SBlue Swirl			print "PRE_END($1)\n" if ($dbg_values > 1);
8631ec3f6f9SBlue Swirl
8641ec3f6f9SBlue Swirl			$av_preprocessor = 1;
8651ec3f6f9SBlue Swirl
8661ec3f6f9SBlue Swirl			# Assume all arms of the conditional end as this
8671ec3f6f9SBlue Swirl			# one does, and continue as if the #endif was not here.
8681ec3f6f9SBlue Swirl			pop(@av_paren_type);
8691ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
8701ec3f6f9SBlue Swirl			$type = 'E';
8711ec3f6f9SBlue Swirl
8721ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\\\n)/o) {
8731ec3f6f9SBlue Swirl			print "PRECONT($1)\n" if ($dbg_values > 1);
8741ec3f6f9SBlue Swirl
8751ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
8761ec3f6f9SBlue Swirl			print "ATTR($1)\n" if ($dbg_values > 1);
8771ec3f6f9SBlue Swirl			$av_pending = $type;
8781ec3f6f9SBlue Swirl			$type = 'N';
8791ec3f6f9SBlue Swirl
8801ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
8811ec3f6f9SBlue Swirl			print "SIZEOF($1)\n" if ($dbg_values > 1);
8821ec3f6f9SBlue Swirl			if (defined $2) {
8831ec3f6f9SBlue Swirl				$av_pending = 'V';
8841ec3f6f9SBlue Swirl			}
8851ec3f6f9SBlue Swirl			$type = 'N';
8861ec3f6f9SBlue Swirl
8871ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(if|while|for)\b/o) {
8881ec3f6f9SBlue Swirl			print "COND($1)\n" if ($dbg_values > 1);
8891ec3f6f9SBlue Swirl			$av_pending = 'E';
8901ec3f6f9SBlue Swirl			$type = 'N';
8911ec3f6f9SBlue Swirl
8921ec3f6f9SBlue Swirl		} elsif ($cur =~/^(case)/o) {
8931ec3f6f9SBlue Swirl			print "CASE($1)\n" if ($dbg_values > 1);
8941ec3f6f9SBlue Swirl			$av_pend_colon = 'C';
8951ec3f6f9SBlue Swirl			$type = 'N';
8961ec3f6f9SBlue Swirl
8971ec3f6f9SBlue Swirl		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
8981ec3f6f9SBlue Swirl			print "KEYWORD($1)\n" if ($dbg_values > 1);
8991ec3f6f9SBlue Swirl			$type = 'N';
9001ec3f6f9SBlue Swirl
9011ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\()/o) {
9021ec3f6f9SBlue Swirl			print "PAREN('$1')\n" if ($dbg_values > 1);
9031ec3f6f9SBlue Swirl			push(@av_paren_type, $av_pending);
9041ec3f6f9SBlue Swirl			$av_pending = '_';
9051ec3f6f9SBlue Swirl			$type = 'N';
9061ec3f6f9SBlue Swirl
9071ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\))/o) {
9081ec3f6f9SBlue Swirl			my $new_type = pop(@av_paren_type);
9091ec3f6f9SBlue Swirl			if ($new_type ne '_') {
9101ec3f6f9SBlue Swirl				$type = $new_type;
9111ec3f6f9SBlue Swirl				print "PAREN('$1') -> $type\n"
9121ec3f6f9SBlue Swirl							if ($dbg_values > 1);
9131ec3f6f9SBlue Swirl			} else {
9141ec3f6f9SBlue Swirl				print "PAREN('$1')\n" if ($dbg_values > 1);
9151ec3f6f9SBlue Swirl			}
9161ec3f6f9SBlue Swirl
9171ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Ident)\s*\(/o) {
9181ec3f6f9SBlue Swirl			print "FUNC($1)\n" if ($dbg_values > 1);
9191ec3f6f9SBlue Swirl			$type = 'V';
9201ec3f6f9SBlue Swirl			$av_pending = 'V';
9211ec3f6f9SBlue Swirl
9221ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
9231ec3f6f9SBlue Swirl			if (defined $2 && $type eq 'C' || $type eq 'T') {
9241ec3f6f9SBlue Swirl				$av_pend_colon = 'B';
9251ec3f6f9SBlue Swirl			} elsif ($type eq 'E') {
9261ec3f6f9SBlue Swirl				$av_pend_colon = 'L';
9271ec3f6f9SBlue Swirl			}
9281ec3f6f9SBlue Swirl			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
9291ec3f6f9SBlue Swirl			$type = 'V';
9301ec3f6f9SBlue Swirl
9311ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Ident|$Constant)/o) {
9321ec3f6f9SBlue Swirl			print "IDENT($1)\n" if ($dbg_values > 1);
9331ec3f6f9SBlue Swirl			$type = 'V';
9341ec3f6f9SBlue Swirl
9351ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Assignment)/o) {
9361ec3f6f9SBlue Swirl			print "ASSIGN($1)\n" if ($dbg_values > 1);
9371ec3f6f9SBlue Swirl			$type = 'N';
9381ec3f6f9SBlue Swirl
9391ec3f6f9SBlue Swirl		} elsif ($cur =~/^(;|{|})/) {
9401ec3f6f9SBlue Swirl			print "END($1)\n" if ($dbg_values > 1);
9411ec3f6f9SBlue Swirl			$type = 'E';
9421ec3f6f9SBlue Swirl			$av_pend_colon = 'O';
9431ec3f6f9SBlue Swirl
9441ec3f6f9SBlue Swirl		} elsif ($cur =~/^(,)/) {
9451ec3f6f9SBlue Swirl			print "COMMA($1)\n" if ($dbg_values > 1);
9461ec3f6f9SBlue Swirl			$type = 'C';
9471ec3f6f9SBlue Swirl
9481ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\?)/o) {
9491ec3f6f9SBlue Swirl			print "QUESTION($1)\n" if ($dbg_values > 1);
9501ec3f6f9SBlue Swirl			$type = 'N';
9511ec3f6f9SBlue Swirl
9521ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(:)/o) {
9531ec3f6f9SBlue Swirl			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
9541ec3f6f9SBlue Swirl
9551ec3f6f9SBlue Swirl			substr($var, length($res), 1, $av_pend_colon);
9561ec3f6f9SBlue Swirl			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
9571ec3f6f9SBlue Swirl				$type = 'E';
9581ec3f6f9SBlue Swirl			} else {
9591ec3f6f9SBlue Swirl				$type = 'N';
9601ec3f6f9SBlue Swirl			}
9611ec3f6f9SBlue Swirl			$av_pend_colon = 'O';
9621ec3f6f9SBlue Swirl
9631ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\[)/o) {
9641ec3f6f9SBlue Swirl			print "CLOSE($1)\n" if ($dbg_values > 1);
9651ec3f6f9SBlue Swirl			$type = 'N';
9661ec3f6f9SBlue Swirl
9671ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
9681ec3f6f9SBlue Swirl			my $variant;
9691ec3f6f9SBlue Swirl
9701ec3f6f9SBlue Swirl			print "OPV($1)\n" if ($dbg_values > 1);
9711ec3f6f9SBlue Swirl			if ($type eq 'V') {
9721ec3f6f9SBlue Swirl				$variant = 'B';
9731ec3f6f9SBlue Swirl			} else {
9741ec3f6f9SBlue Swirl				$variant = 'U';
9751ec3f6f9SBlue Swirl			}
9761ec3f6f9SBlue Swirl
9771ec3f6f9SBlue Swirl			substr($var, length($res), 1, $variant);
9781ec3f6f9SBlue Swirl			$type = 'N';
9791ec3f6f9SBlue Swirl
9801ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Operators)/o) {
9811ec3f6f9SBlue Swirl			print "OP($1)\n" if ($dbg_values > 1);
9821ec3f6f9SBlue Swirl			if ($1 ne '++' && $1 ne '--') {
9831ec3f6f9SBlue Swirl				$type = 'N';
9841ec3f6f9SBlue Swirl			}
9851ec3f6f9SBlue Swirl
9861ec3f6f9SBlue Swirl		} elsif ($cur =~ /(^.)/o) {
9871ec3f6f9SBlue Swirl			print "C($1)\n" if ($dbg_values > 1);
9881ec3f6f9SBlue Swirl		}
9891ec3f6f9SBlue Swirl		if (defined $1) {
9901ec3f6f9SBlue Swirl			$cur = substr($cur, length($1));
9911ec3f6f9SBlue Swirl			$res .= $type x length($1);
9921ec3f6f9SBlue Swirl		}
9931ec3f6f9SBlue Swirl	}
9941ec3f6f9SBlue Swirl
9951ec3f6f9SBlue Swirl	return ($res, $var);
9961ec3f6f9SBlue Swirl}
9971ec3f6f9SBlue Swirl
9981ec3f6f9SBlue Swirlsub possible {
9991ec3f6f9SBlue Swirl	my ($possible, $line) = @_;
10001ec3f6f9SBlue Swirl	my $notPermitted = qr{(?:
10011ec3f6f9SBlue Swirl		^(?:
10021ec3f6f9SBlue Swirl			$Modifier|
10031ec3f6f9SBlue Swirl			$Storage|
10041ec3f6f9SBlue Swirl			$Type|
10051ec3f6f9SBlue Swirl			DEFINE_\S+
10061ec3f6f9SBlue Swirl		)$|
10071ec3f6f9SBlue Swirl		^(?:
10081ec3f6f9SBlue Swirl			goto|
10091ec3f6f9SBlue Swirl			return|
10101ec3f6f9SBlue Swirl			case|
10111ec3f6f9SBlue Swirl			else|
10121ec3f6f9SBlue Swirl			asm|__asm__|
1013*3e5385fcSAndy Whitcroft			do|
1014*3e5385fcSAndy Whitcroft			\#|
1015*3e5385fcSAndy Whitcroft			\#\#
10161ec3f6f9SBlue Swirl		)(?:\s|$)|
10171ec3f6f9SBlue Swirl		^(?:typedef|struct|enum)\b
10181ec3f6f9SBlue Swirl	    )}x;
10191ec3f6f9SBlue Swirl	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
10201ec3f6f9SBlue Swirl	if ($possible !~ $notPermitted) {
10211ec3f6f9SBlue Swirl		# Check for modifiers.
10221ec3f6f9SBlue Swirl		$possible =~ s/\s*$Storage\s*//g;
10231ec3f6f9SBlue Swirl		$possible =~ s/\s*$Sparse\s*//g;
10241ec3f6f9SBlue Swirl		if ($possible =~ /^\s*$/) {
10251ec3f6f9SBlue Swirl
10261ec3f6f9SBlue Swirl		} elsif ($possible =~ /\s/) {
10271ec3f6f9SBlue Swirl			$possible =~ s/\s*$Type\s*//g;
10281ec3f6f9SBlue Swirl			for my $modifier (split(' ', $possible)) {
10291ec3f6f9SBlue Swirl				if ($modifier !~ $notPermitted) {
10301ec3f6f9SBlue Swirl					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
10311ec3f6f9SBlue Swirl					push(@modifierList, $modifier);
10321ec3f6f9SBlue Swirl				}
10331ec3f6f9SBlue Swirl			}
10341ec3f6f9SBlue Swirl
10351ec3f6f9SBlue Swirl		} else {
10361ec3f6f9SBlue Swirl			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
10371ec3f6f9SBlue Swirl			push(@typeList, $possible);
10381ec3f6f9SBlue Swirl		}
10391ec3f6f9SBlue Swirl		build_types();
10401ec3f6f9SBlue Swirl	} else {
10411ec3f6f9SBlue Swirl		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
10421ec3f6f9SBlue Swirl	}
10431ec3f6f9SBlue Swirl}
10441ec3f6f9SBlue Swirl
10451ec3f6f9SBlue Swirlmy $prefix = '';
10461ec3f6f9SBlue Swirl
10471ec3f6f9SBlue Swirlsub report {
10481ec3f6f9SBlue Swirl	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
10491ec3f6f9SBlue Swirl		return 0;
10501ec3f6f9SBlue Swirl	}
10511ec3f6f9SBlue Swirl	my $line = $prefix . $_[0];
10521ec3f6f9SBlue Swirl
10531ec3f6f9SBlue Swirl	$line = (split('\n', $line))[0] . "\n" if ($terse);
10541ec3f6f9SBlue Swirl
10551ec3f6f9SBlue Swirl	push(our @report, $line);
10561ec3f6f9SBlue Swirl
10571ec3f6f9SBlue Swirl	return 1;
10581ec3f6f9SBlue Swirl}
10591ec3f6f9SBlue Swirlsub report_dump {
10601ec3f6f9SBlue Swirl	our @report;
10611ec3f6f9SBlue Swirl}
10621ec3f6f9SBlue Swirlsub ERROR {
10631ec3f6f9SBlue Swirl	if (report("ERROR: $_[0]\n")) {
10641ec3f6f9SBlue Swirl		our $clean = 0;
10651ec3f6f9SBlue Swirl		our $cnt_error++;
10661ec3f6f9SBlue Swirl	}
10671ec3f6f9SBlue Swirl}
10681ec3f6f9SBlue Swirlsub WARN {
10691ec3f6f9SBlue Swirl	if (report("WARNING: $_[0]\n")) {
10701ec3f6f9SBlue Swirl		our $clean = 0;
10711ec3f6f9SBlue Swirl		our $cnt_warn++;
10721ec3f6f9SBlue Swirl	}
10731ec3f6f9SBlue Swirl}
10741ec3f6f9SBlue Swirlsub CHK {
10751ec3f6f9SBlue Swirl	if ($check && report("CHECK: $_[0]\n")) {
10761ec3f6f9SBlue Swirl		our $clean = 0;
10771ec3f6f9SBlue Swirl		our $cnt_chk++;
10781ec3f6f9SBlue Swirl	}
10791ec3f6f9SBlue Swirl}
10801ec3f6f9SBlue Swirl
10811ec3f6f9SBlue Swirlsub process {
10821ec3f6f9SBlue Swirl	my $filename = shift;
10831ec3f6f9SBlue Swirl
10841ec3f6f9SBlue Swirl	my $linenr=0;
10851ec3f6f9SBlue Swirl	my $prevline="";
10861ec3f6f9SBlue Swirl	my $prevrawline="";
10871ec3f6f9SBlue Swirl	my $stashline="";
10881ec3f6f9SBlue Swirl	my $stashrawline="";
10891ec3f6f9SBlue Swirl
10901ec3f6f9SBlue Swirl	my $length;
10911ec3f6f9SBlue Swirl	my $indent;
10921ec3f6f9SBlue Swirl	my $previndent=0;
10931ec3f6f9SBlue Swirl	my $stashindent=0;
10941ec3f6f9SBlue Swirl
10951ec3f6f9SBlue Swirl	our $clean = 1;
10961ec3f6f9SBlue Swirl	my $signoff = 0;
10971ec3f6f9SBlue Swirl	my $is_patch = 0;
10981ec3f6f9SBlue Swirl
10991ec3f6f9SBlue Swirl	our @report = ();
11001ec3f6f9SBlue Swirl	our $cnt_lines = 0;
11011ec3f6f9SBlue Swirl	our $cnt_error = 0;
11021ec3f6f9SBlue Swirl	our $cnt_warn = 0;
11031ec3f6f9SBlue Swirl	our $cnt_chk = 0;
11041ec3f6f9SBlue Swirl
11051ec3f6f9SBlue Swirl	# Trace the real file/line as we go.
11061ec3f6f9SBlue Swirl	my $realfile = '';
11071ec3f6f9SBlue Swirl	my $realline = 0;
11081ec3f6f9SBlue Swirl	my $realcnt = 0;
11091ec3f6f9SBlue Swirl	my $here = '';
11101ec3f6f9SBlue Swirl	my $in_comment = 0;
11111ec3f6f9SBlue Swirl	my $comment_edge = 0;
11121ec3f6f9SBlue Swirl	my $first_line = 0;
11131ec3f6f9SBlue Swirl	my $p1_prefix = '';
11141ec3f6f9SBlue Swirl
11151ec3f6f9SBlue Swirl	my $prev_values = 'E';
11161ec3f6f9SBlue Swirl
11171ec3f6f9SBlue Swirl	# suppression flags
11181ec3f6f9SBlue Swirl	my %suppress_ifbraces;
11191ec3f6f9SBlue Swirl	my %suppress_whiletrailers;
11201ec3f6f9SBlue Swirl	my %suppress_export;
11211ec3f6f9SBlue Swirl
11221ec3f6f9SBlue Swirl	# Pre-scan the patch sanitizing the lines.
11231ec3f6f9SBlue Swirl
11241ec3f6f9SBlue Swirl	sanitise_line_reset();
11251ec3f6f9SBlue Swirl	my $line;
11261ec3f6f9SBlue Swirl	foreach my $rawline (@rawlines) {
11271ec3f6f9SBlue Swirl		$linenr++;
11281ec3f6f9SBlue Swirl		$line = $rawline;
11291ec3f6f9SBlue Swirl
11301ec3f6f9SBlue Swirl		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
11311ec3f6f9SBlue Swirl			$realline=$1-1;
11321ec3f6f9SBlue Swirl			if (defined $2) {
11331ec3f6f9SBlue Swirl				$realcnt=$3+1;
11341ec3f6f9SBlue Swirl			} else {
11351ec3f6f9SBlue Swirl				$realcnt=1+1;
11361ec3f6f9SBlue Swirl			}
11371ec3f6f9SBlue Swirl			$in_comment = 0;
11381ec3f6f9SBlue Swirl
11391ec3f6f9SBlue Swirl			# Guestimate if this is a continuing comment.  Run
11401ec3f6f9SBlue Swirl			# the context looking for a comment "edge".  If this
11411ec3f6f9SBlue Swirl			# edge is a close comment then we must be in a comment
11421ec3f6f9SBlue Swirl			# at context start.
11431ec3f6f9SBlue Swirl			my $edge;
11441ec3f6f9SBlue Swirl			my $cnt = $realcnt;
11451ec3f6f9SBlue Swirl			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
11461ec3f6f9SBlue Swirl				next if (defined $rawlines[$ln - 1] &&
11471ec3f6f9SBlue Swirl					 $rawlines[$ln - 1] =~ /^-/);
11481ec3f6f9SBlue Swirl				$cnt--;
11491ec3f6f9SBlue Swirl				#print "RAW<$rawlines[$ln - 1]>\n";
11501ec3f6f9SBlue Swirl				last if (!defined $rawlines[$ln - 1]);
11511ec3f6f9SBlue Swirl				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
11521ec3f6f9SBlue Swirl				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
11531ec3f6f9SBlue Swirl					($edge) = $1;
11541ec3f6f9SBlue Swirl					last;
11551ec3f6f9SBlue Swirl				}
11561ec3f6f9SBlue Swirl			}
11571ec3f6f9SBlue Swirl			if (defined $edge && $edge eq '*/') {
11581ec3f6f9SBlue Swirl				$in_comment = 1;
11591ec3f6f9SBlue Swirl			}
11601ec3f6f9SBlue Swirl
11611ec3f6f9SBlue Swirl			# Guestimate if this is a continuing comment.  If this
11621ec3f6f9SBlue Swirl			# is the start of a diff block and this line starts
11631ec3f6f9SBlue Swirl			# ' *' then it is very likely a comment.
11641ec3f6f9SBlue Swirl			if (!defined $edge &&
11651ec3f6f9SBlue Swirl			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
11661ec3f6f9SBlue Swirl			{
11671ec3f6f9SBlue Swirl				$in_comment = 1;
11681ec3f6f9SBlue Swirl			}
11691ec3f6f9SBlue Swirl
11701ec3f6f9SBlue Swirl			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
11711ec3f6f9SBlue Swirl			sanitise_line_reset($in_comment);
11721ec3f6f9SBlue Swirl
11731ec3f6f9SBlue Swirl		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
11741ec3f6f9SBlue Swirl			# Standardise the strings and chars within the input to
11751ec3f6f9SBlue Swirl			# simplify matching -- only bother with positive lines.
11761ec3f6f9SBlue Swirl			$line = sanitise_line($rawline);
11771ec3f6f9SBlue Swirl		}
11781ec3f6f9SBlue Swirl		push(@lines, $line);
11791ec3f6f9SBlue Swirl
11801ec3f6f9SBlue Swirl		if ($realcnt > 1) {
11811ec3f6f9SBlue Swirl			$realcnt-- if ($line =~ /^(?:\+| |$)/);
11821ec3f6f9SBlue Swirl		} else {
11831ec3f6f9SBlue Swirl			$realcnt = 0;
11841ec3f6f9SBlue Swirl		}
11851ec3f6f9SBlue Swirl
11861ec3f6f9SBlue Swirl		#print "==>$rawline\n";
11871ec3f6f9SBlue Swirl		#print "-->$line\n";
11881ec3f6f9SBlue Swirl	}
11891ec3f6f9SBlue Swirl
11901ec3f6f9SBlue Swirl	$prefix = '';
11911ec3f6f9SBlue Swirl
11921ec3f6f9SBlue Swirl	$realcnt = 0;
11931ec3f6f9SBlue Swirl	$linenr = 0;
11941ec3f6f9SBlue Swirl	foreach my $line (@lines) {
11951ec3f6f9SBlue Swirl		$linenr++;
11961ec3f6f9SBlue Swirl
11971ec3f6f9SBlue Swirl		my $rawline = $rawlines[$linenr - 1];
11981ec3f6f9SBlue Swirl
11991ec3f6f9SBlue Swirl#extract the line range in the file after the patch is applied
12001ec3f6f9SBlue Swirl		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
12011ec3f6f9SBlue Swirl			$is_patch = 1;
12021ec3f6f9SBlue Swirl			$first_line = $linenr + 1;
12031ec3f6f9SBlue Swirl			$realline=$1-1;
12041ec3f6f9SBlue Swirl			if (defined $2) {
12051ec3f6f9SBlue Swirl				$realcnt=$3+1;
12061ec3f6f9SBlue Swirl			} else {
12071ec3f6f9SBlue Swirl				$realcnt=1+1;
12081ec3f6f9SBlue Swirl			}
12091ec3f6f9SBlue Swirl			annotate_reset();
12101ec3f6f9SBlue Swirl			$prev_values = 'E';
12111ec3f6f9SBlue Swirl
12121ec3f6f9SBlue Swirl			%suppress_ifbraces = ();
12131ec3f6f9SBlue Swirl			%suppress_whiletrailers = ();
12141ec3f6f9SBlue Swirl			%suppress_export = ();
12151ec3f6f9SBlue Swirl			next;
12161ec3f6f9SBlue Swirl
12171ec3f6f9SBlue Swirl# track the line number as we move through the hunk, note that
12181ec3f6f9SBlue Swirl# new versions of GNU diff omit the leading space on completely
12191ec3f6f9SBlue Swirl# blank context lines so we need to count that too.
12201ec3f6f9SBlue Swirl		} elsif ($line =~ /^( |\+|$)/) {
12211ec3f6f9SBlue Swirl			$realline++;
12221ec3f6f9SBlue Swirl			$realcnt-- if ($realcnt != 0);
12231ec3f6f9SBlue Swirl
12241ec3f6f9SBlue Swirl			# Measure the line length and indent.
12251ec3f6f9SBlue Swirl			($length, $indent) = line_stats($rawline);
12261ec3f6f9SBlue Swirl
12271ec3f6f9SBlue Swirl			# Track the previous line.
12281ec3f6f9SBlue Swirl			($prevline, $stashline) = ($stashline, $line);
12291ec3f6f9SBlue Swirl			($previndent, $stashindent) = ($stashindent, $indent);
12301ec3f6f9SBlue Swirl			($prevrawline, $stashrawline) = ($stashrawline, $rawline);
12311ec3f6f9SBlue Swirl
12321ec3f6f9SBlue Swirl			#warn "line<$line>\n";
12331ec3f6f9SBlue Swirl
12341ec3f6f9SBlue Swirl		} elsif ($realcnt == 1) {
12351ec3f6f9SBlue Swirl			$realcnt--;
12361ec3f6f9SBlue Swirl		}
12371ec3f6f9SBlue Swirl
12381ec3f6f9SBlue Swirl		my $hunk_line = ($realcnt != 0);
12391ec3f6f9SBlue Swirl
12401ec3f6f9SBlue Swirl#make up the handle for any error we report on this line
12411ec3f6f9SBlue Swirl		$prefix = "$filename:$realline: " if ($emacs && $file);
12421ec3f6f9SBlue Swirl		$prefix = "$filename:$linenr: " if ($emacs && !$file);
12431ec3f6f9SBlue Swirl
12441ec3f6f9SBlue Swirl		$here = "#$linenr: " if (!$file);
12451ec3f6f9SBlue Swirl		$here = "#$realline: " if ($file);
12461ec3f6f9SBlue Swirl
12471ec3f6f9SBlue Swirl		# extract the filename as it passes
12481ec3f6f9SBlue Swirl		if ($line =~ /^diff --git.*?(\S+)$/) {
12491ec3f6f9SBlue Swirl			$realfile = $1;
12501ec3f6f9SBlue Swirl			$realfile =~ s@^([^/]*)/@@;
12511ec3f6f9SBlue Swirl
12521ec3f6f9SBlue Swirl		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
12531ec3f6f9SBlue Swirl			$realfile = $1;
12541ec3f6f9SBlue Swirl			$realfile =~ s@^([^/]*)/@@;
12551ec3f6f9SBlue Swirl
12561ec3f6f9SBlue Swirl			$p1_prefix = $1;
12571ec3f6f9SBlue Swirl			if (!$file && $tree && $p1_prefix ne '' &&
12581ec3f6f9SBlue Swirl			    -e "$root/$p1_prefix") {
12591ec3f6f9SBlue Swirl				WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
12601ec3f6f9SBlue Swirl			}
12611ec3f6f9SBlue Swirl
12621ec3f6f9SBlue Swirl			next;
12631ec3f6f9SBlue Swirl		}
12641ec3f6f9SBlue Swirl
12651ec3f6f9SBlue Swirl		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
12661ec3f6f9SBlue Swirl
12671ec3f6f9SBlue Swirl		my $hereline = "$here\n$rawline\n";
12681ec3f6f9SBlue Swirl		my $herecurr = "$here\n$rawline\n";
12691ec3f6f9SBlue Swirl		my $hereprev = "$here\n$prevrawline\n$rawline\n";
12701ec3f6f9SBlue Swirl
12711ec3f6f9SBlue Swirl		$cnt_lines++ if ($realcnt != 0);
12721ec3f6f9SBlue Swirl
12731ec3f6f9SBlue Swirl# Check for incorrect file permissions
12741ec3f6f9SBlue Swirl		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
12751ec3f6f9SBlue Swirl			my $permhere = $here . "FILE: $realfile\n";
127671c47b01SPaolo Bonzini			if ($realfile =~ /(\bMakefile(?:\.objs)?|\.c|\.cc|\.cpp|\.h|\.mak|\.[sS])$/) {
12771ec3f6f9SBlue Swirl				ERROR("do not set execute permissions for source files\n" . $permhere);
12781ec3f6f9SBlue Swirl			}
12791ec3f6f9SBlue Swirl		}
12801ec3f6f9SBlue Swirl
12811ec3f6f9SBlue Swirl#check the patch for a signoff:
12821ec3f6f9SBlue Swirl		if ($line =~ /^\s*signed-off-by:/i) {
12831ec3f6f9SBlue Swirl			# This is a signoff, if ugly, so do not double report.
12841ec3f6f9SBlue Swirl			$signoff++;
12851ec3f6f9SBlue Swirl			if (!($line =~ /^\s*Signed-off-by:/)) {
12861ec3f6f9SBlue Swirl				WARN("Signed-off-by: is the preferred form\n" .
12871ec3f6f9SBlue Swirl					$herecurr);
12881ec3f6f9SBlue Swirl			}
12891ec3f6f9SBlue Swirl			if ($line =~ /^\s*signed-off-by:\S/i) {
12901ec3f6f9SBlue Swirl				WARN("space required after Signed-off-by:\n" .
12911ec3f6f9SBlue Swirl					$herecurr);
12921ec3f6f9SBlue Swirl			}
12931ec3f6f9SBlue Swirl		}
12941ec3f6f9SBlue Swirl
12951ec3f6f9SBlue Swirl# Check for wrappage within a valid hunk of the file
12961ec3f6f9SBlue Swirl		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
12971ec3f6f9SBlue Swirl			ERROR("patch seems to be corrupt (line wrapped?)\n" .
12981ec3f6f9SBlue Swirl				$herecurr) if (!$emitted_corrupt++);
12991ec3f6f9SBlue Swirl		}
13001ec3f6f9SBlue Swirl
13011ec3f6f9SBlue Swirl# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
13021ec3f6f9SBlue Swirl		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
13031ec3f6f9SBlue Swirl		    $rawline !~ m/^$UTF8*$/) {
13041ec3f6f9SBlue Swirl			my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
13051ec3f6f9SBlue Swirl
13061ec3f6f9SBlue Swirl			my $blank = copy_spacing($rawline);
13071ec3f6f9SBlue Swirl			my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
13081ec3f6f9SBlue Swirl			my $hereptr = "$hereline$ptr\n";
13091ec3f6f9SBlue Swirl
13101ec3f6f9SBlue Swirl			ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
13111ec3f6f9SBlue Swirl		}
13121ec3f6f9SBlue Swirl
13131ec3f6f9SBlue Swirl# ignore non-hunk lines and lines being removed
13141ec3f6f9SBlue Swirl		next if (!$hunk_line || $line =~ /^-/);
13151ec3f6f9SBlue Swirl
13161ec3f6f9SBlue Swirl#trailing whitespace
13171ec3f6f9SBlue Swirl		if ($line =~ /^\+.*\015/) {
13181ec3f6f9SBlue Swirl			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
13191ec3f6f9SBlue Swirl			ERROR("DOS line endings\n" . $herevet);
13201ec3f6f9SBlue Swirl
13211ec3f6f9SBlue Swirl		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
13221ec3f6f9SBlue Swirl			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
13231ec3f6f9SBlue Swirl			ERROR("trailing whitespace\n" . $herevet);
13241ec3f6f9SBlue Swirl			$rpt_cleaners = 1;
13251ec3f6f9SBlue Swirl		}
13261ec3f6f9SBlue Swirl
13271ec3f6f9SBlue Swirl# check we are in a valid source file if not then ignore this hunk
132869d5d21fSTomoki Sekiyama		next if ($realfile !~ /\.(h|c|cpp|s|S|pl|sh)$/);
13291ec3f6f9SBlue Swirl
13301ec3f6f9SBlue Swirl#80 column limit
1331f1e155bbSPaolo Bonzini		if ($line =~ /^\+/ &&
1332f1e155bbSPaolo Bonzini		    !($line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
13331ec3f6f9SBlue Swirl		    $length > 80)
13341ec3f6f9SBlue Swirl		{
13351ec3f6f9SBlue Swirl			WARN("line over 80 characters\n" . $herecurr);
13361ec3f6f9SBlue Swirl		}
13371ec3f6f9SBlue Swirl
13381ec3f6f9SBlue Swirl# check for spaces before a quoted newline
13391ec3f6f9SBlue Swirl		if ($rawline =~ /^.*\".*\s\\n/) {
13401ec3f6f9SBlue Swirl			WARN("unnecessary whitespace before a quoted newline\n" . $herecurr);
13411ec3f6f9SBlue Swirl		}
13421ec3f6f9SBlue Swirl
13431ec3f6f9SBlue Swirl# check for adding lines without a newline.
13441ec3f6f9SBlue Swirl		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
13451ec3f6f9SBlue Swirl			WARN("adding a line without newline at end of file\n" . $herecurr);
13461ec3f6f9SBlue Swirl		}
13471ec3f6f9SBlue Swirl
13481ec3f6f9SBlue Swirl# check we are in a valid source file C or perl if not then ignore this hunk
134969d5d21fSTomoki Sekiyama		next if ($realfile !~ /\.(h|c|cpp|pl)$/);
13501ec3f6f9SBlue Swirl
1351b6469683SBlue Swirl# in QEMU, no tabs are allowed
1352ad36ce8bSBlue Swirl		if ($rawline =~ /^\+.*\t/) {
13531ec3f6f9SBlue Swirl			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1354b6469683SBlue Swirl			ERROR("code indent should never use tabs\n" . $herevet);
13551ec3f6f9SBlue Swirl			$rpt_cleaners = 1;
13561ec3f6f9SBlue Swirl		}
13571ec3f6f9SBlue Swirl
13581ec3f6f9SBlue Swirl# check we are in a valid C source file if not then ignore this hunk
135969d5d21fSTomoki Sekiyama		next if ($realfile !~ /\.(h|c|cpp)$/);
13601ec3f6f9SBlue Swirl
13611ec3f6f9SBlue Swirl# check for RCS/CVS revision markers
13621ec3f6f9SBlue Swirl		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
13631ec3f6f9SBlue Swirl			WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
13641ec3f6f9SBlue Swirl		}
13651ec3f6f9SBlue Swirl
13661ec3f6f9SBlue Swirl# Check for potential 'bare' types
13671ec3f6f9SBlue Swirl		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
13681ec3f6f9SBlue Swirl		    $realline_next);
13691ec3f6f9SBlue Swirl		if ($realcnt && $line =~ /.\s*\S/) {
13701ec3f6f9SBlue Swirl			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
13711ec3f6f9SBlue Swirl				ctx_statement_block($linenr, $realcnt, 0);
13721ec3f6f9SBlue Swirl			$stat =~ s/\n./\n /g;
13731ec3f6f9SBlue Swirl			$cond =~ s/\n./\n /g;
13741ec3f6f9SBlue Swirl
13751ec3f6f9SBlue Swirl			# Find the real next line.
13761ec3f6f9SBlue Swirl			$realline_next = $line_nr_next;
13771ec3f6f9SBlue Swirl			if (defined $realline_next &&
13781ec3f6f9SBlue Swirl			    (!defined $lines[$realline_next - 1] ||
13791ec3f6f9SBlue Swirl			     substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
13801ec3f6f9SBlue Swirl				$realline_next++;
13811ec3f6f9SBlue Swirl			}
13821ec3f6f9SBlue Swirl
13831ec3f6f9SBlue Swirl			my $s = $stat;
13841ec3f6f9SBlue Swirl			$s =~ s/{.*$//s;
13851ec3f6f9SBlue Swirl
13861ec3f6f9SBlue Swirl			# Ignore goto labels.
13871ec3f6f9SBlue Swirl			if ($s =~ /$Ident:\*$/s) {
13881ec3f6f9SBlue Swirl
13891ec3f6f9SBlue Swirl			# Ignore functions being called
13901ec3f6f9SBlue Swirl			} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
13911ec3f6f9SBlue Swirl
13921ec3f6f9SBlue Swirl			} elsif ($s =~ /^.\s*else\b/s) {
13931ec3f6f9SBlue Swirl
13941ec3f6f9SBlue Swirl			# declarations always start with types
13951ec3f6f9SBlue Swirl			} elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+?)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))(?:\s*$Modifier)?\s*(?:;|=|,|\()/s) {
13961ec3f6f9SBlue Swirl				my $type = $1;
13971ec3f6f9SBlue Swirl				$type =~ s/\s+/ /g;
13981ec3f6f9SBlue Swirl				possible($type, "A:" . $s);
13991ec3f6f9SBlue Swirl
14001ec3f6f9SBlue Swirl			# definitions in global scope can only start with types
14011ec3f6f9SBlue Swirl			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
14021ec3f6f9SBlue Swirl				possible($1, "B:" . $s);
14031ec3f6f9SBlue Swirl			}
14041ec3f6f9SBlue Swirl
14051ec3f6f9SBlue Swirl			# any (foo ... *) is a pointer cast, and foo is a type
14061ec3f6f9SBlue Swirl			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
14071ec3f6f9SBlue Swirl				possible($1, "C:" . $s);
14081ec3f6f9SBlue Swirl			}
14091ec3f6f9SBlue Swirl
14101ec3f6f9SBlue Swirl			# Check for any sort of function declaration.
14111ec3f6f9SBlue Swirl			# int foo(something bar, other baz);
14121ec3f6f9SBlue Swirl			# void (*store_gdt)(x86_descr_ptr *);
14131ec3f6f9SBlue Swirl			if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
14141ec3f6f9SBlue Swirl				my ($name_len) = length($1);
14151ec3f6f9SBlue Swirl
14161ec3f6f9SBlue Swirl				my $ctx = $s;
14171ec3f6f9SBlue Swirl				substr($ctx, 0, $name_len + 1, '');
14181ec3f6f9SBlue Swirl				$ctx =~ s/\)[^\)]*$//;
14191ec3f6f9SBlue Swirl
14201ec3f6f9SBlue Swirl				for my $arg (split(/\s*,\s*/, $ctx)) {
14211ec3f6f9SBlue Swirl					if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
14221ec3f6f9SBlue Swirl
14231ec3f6f9SBlue Swirl						possible($1, "D:" . $s);
14241ec3f6f9SBlue Swirl					}
14251ec3f6f9SBlue Swirl				}
14261ec3f6f9SBlue Swirl			}
14271ec3f6f9SBlue Swirl
14281ec3f6f9SBlue Swirl		}
14291ec3f6f9SBlue Swirl
14301ec3f6f9SBlue Swirl#
14311ec3f6f9SBlue Swirl# Checks which may be anchored in the context.
14321ec3f6f9SBlue Swirl#
14331ec3f6f9SBlue Swirl
14341ec3f6f9SBlue Swirl# Check for switch () and associated case and default
14351ec3f6f9SBlue Swirl# statements should be at the same indent.
14361ec3f6f9SBlue Swirl		if ($line=~/\bswitch\s*\(.*\)/) {
14371ec3f6f9SBlue Swirl			my $err = '';
14381ec3f6f9SBlue Swirl			my $sep = '';
14391ec3f6f9SBlue Swirl			my @ctx = ctx_block_outer($linenr, $realcnt);
14401ec3f6f9SBlue Swirl			shift(@ctx);
14411ec3f6f9SBlue Swirl			for my $ctx (@ctx) {
14421ec3f6f9SBlue Swirl				my ($clen, $cindent) = line_stats($ctx);
14431ec3f6f9SBlue Swirl				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
14441ec3f6f9SBlue Swirl							$indent != $cindent) {
14451ec3f6f9SBlue Swirl					$err .= "$sep$ctx\n";
14461ec3f6f9SBlue Swirl					$sep = '';
14471ec3f6f9SBlue Swirl				} else {
14481ec3f6f9SBlue Swirl					$sep = "[...]\n";
14491ec3f6f9SBlue Swirl				}
14501ec3f6f9SBlue Swirl			}
14511ec3f6f9SBlue Swirl			if ($err ne '') {
14521ec3f6f9SBlue Swirl				ERROR("switch and case should be at the same indent\n$hereline$err");
14531ec3f6f9SBlue Swirl			}
14541ec3f6f9SBlue Swirl		}
14551ec3f6f9SBlue Swirl
14561ec3f6f9SBlue Swirl# if/while/etc brace do not go on next line, unless defining a do while loop,
14571ec3f6f9SBlue Swirl# or if that brace on the next line is for something else
14581ec3f6f9SBlue Swirl		if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
14591ec3f6f9SBlue Swirl			my $pre_ctx = "$1$2";
14601ec3f6f9SBlue Swirl
14611ec3f6f9SBlue Swirl			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
14621ec3f6f9SBlue Swirl			my $ctx_cnt = $realcnt - $#ctx - 1;
14631ec3f6f9SBlue Swirl			my $ctx = join("\n", @ctx);
14641ec3f6f9SBlue Swirl
14651ec3f6f9SBlue Swirl			my $ctx_ln = $linenr;
14661ec3f6f9SBlue Swirl			my $ctx_skip = $realcnt;
14671ec3f6f9SBlue Swirl
14681ec3f6f9SBlue Swirl			while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
14691ec3f6f9SBlue Swirl					defined $lines[$ctx_ln - 1] &&
14701ec3f6f9SBlue Swirl					$lines[$ctx_ln - 1] =~ /^-/)) {
14711ec3f6f9SBlue Swirl				##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
14721ec3f6f9SBlue Swirl				$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
14731ec3f6f9SBlue Swirl				$ctx_ln++;
14741ec3f6f9SBlue Swirl			}
14751ec3f6f9SBlue Swirl
14761ec3f6f9SBlue Swirl			#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
14771ec3f6f9SBlue Swirl			#print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
14781ec3f6f9SBlue Swirl
1479a97ceca5SMax Reitz			# The length of the "previous line" is checked against 80 because it
1480a97ceca5SMax Reitz			# includes the + at the beginning of the line (if the actual line has
1481a97ceca5SMax Reitz			# 79 or 80 characters, it is no longer possible to add a space and an
1482a97ceca5SMax Reitz			# opening brace there)
1483a97ceca5SMax Reitz			if ($#ctx == 0 && $ctx !~ /{\s*/ &&
148404f2562fSFam Zheng			    defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*\{/ &&
1485a97ceca5SMax Reitz			    defined($lines[$ctx_ln - 2]) && length($lines[$ctx_ln - 2]) < 80) {
14861ec3f6f9SBlue Swirl				ERROR("that open brace { should be on the previous line\n" .
14871ec3f6f9SBlue Swirl					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
14881ec3f6f9SBlue Swirl			}
14891ec3f6f9SBlue Swirl			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
14901ec3f6f9SBlue Swirl			    $ctx =~ /\)\s*\;\s*$/ &&
14911ec3f6f9SBlue Swirl			    defined $lines[$ctx_ln - 1])
14921ec3f6f9SBlue Swirl			{
14931ec3f6f9SBlue Swirl				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
14941ec3f6f9SBlue Swirl				if ($nindent > $indent) {
14951ec3f6f9SBlue Swirl					WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
14961ec3f6f9SBlue Swirl						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
14971ec3f6f9SBlue Swirl				}
14981ec3f6f9SBlue Swirl			}
14991ec3f6f9SBlue Swirl		}
15001ec3f6f9SBlue Swirl
15011ec3f6f9SBlue Swirl# Check relative indent for conditionals and blocks.
15021ec3f6f9SBlue Swirl		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
15031ec3f6f9SBlue Swirl			my ($s, $c) = ($stat, $cond);
15041ec3f6f9SBlue Swirl
15051ec3f6f9SBlue Swirl			substr($s, 0, length($c), '');
15061ec3f6f9SBlue Swirl
15071ec3f6f9SBlue Swirl			# Make sure we remove the line prefixes as we have
15081ec3f6f9SBlue Swirl			# none on the first line, and are going to readd them
15091ec3f6f9SBlue Swirl			# where necessary.
15101ec3f6f9SBlue Swirl			$s =~ s/\n./\n/gs;
15111ec3f6f9SBlue Swirl
15121ec3f6f9SBlue Swirl			# Find out how long the conditional actually is.
15131ec3f6f9SBlue Swirl			my @newlines = ($c =~ /\n/gs);
15141ec3f6f9SBlue Swirl			my $cond_lines = 1 + $#newlines;
15151ec3f6f9SBlue Swirl
15161ec3f6f9SBlue Swirl			# We want to check the first line inside the block
15171ec3f6f9SBlue Swirl			# starting at the end of the conditional, so remove:
15181ec3f6f9SBlue Swirl			#  1) any blank line termination
15191ec3f6f9SBlue Swirl			#  2) any opening brace { on end of the line
15201ec3f6f9SBlue Swirl			#  3) any do (...) {
15211ec3f6f9SBlue Swirl			my $continuation = 0;
15221ec3f6f9SBlue Swirl			my $check = 0;
15231ec3f6f9SBlue Swirl			$s =~ s/^.*\bdo\b//;
152404f2562fSFam Zheng			$s =~ s/^\s*\{//;
15251ec3f6f9SBlue Swirl			if ($s =~ s/^\s*\\//) {
15261ec3f6f9SBlue Swirl				$continuation = 1;
15271ec3f6f9SBlue Swirl			}
15281ec3f6f9SBlue Swirl			if ($s =~ s/^\s*?\n//) {
15291ec3f6f9SBlue Swirl				$check = 1;
15301ec3f6f9SBlue Swirl				$cond_lines++;
15311ec3f6f9SBlue Swirl			}
15321ec3f6f9SBlue Swirl
15331ec3f6f9SBlue Swirl			# Also ignore a loop construct at the end of a
15341ec3f6f9SBlue Swirl			# preprocessor statement.
15351ec3f6f9SBlue Swirl			if (($prevline =~ /^.\s*#\s*define\s/ ||
15361ec3f6f9SBlue Swirl			    $prevline =~ /\\\s*$/) && $continuation == 0) {
15371ec3f6f9SBlue Swirl				$check = 0;
15381ec3f6f9SBlue Swirl			}
15391ec3f6f9SBlue Swirl
15401ec3f6f9SBlue Swirl			my $cond_ptr = -1;
15411ec3f6f9SBlue Swirl			$continuation = 0;
15421ec3f6f9SBlue Swirl			while ($cond_ptr != $cond_lines) {
15431ec3f6f9SBlue Swirl				$cond_ptr = $cond_lines;
15441ec3f6f9SBlue Swirl
15451ec3f6f9SBlue Swirl				# If we see an #else/#elif then the code
15461ec3f6f9SBlue Swirl				# is not linear.
15471ec3f6f9SBlue Swirl				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
15481ec3f6f9SBlue Swirl					$check = 0;
15491ec3f6f9SBlue Swirl				}
15501ec3f6f9SBlue Swirl
15511ec3f6f9SBlue Swirl				# Ignore:
15521ec3f6f9SBlue Swirl				#  1) blank lines, they should be at 0,
15531ec3f6f9SBlue Swirl				#  2) preprocessor lines, and
15541ec3f6f9SBlue Swirl				#  3) labels.
15551ec3f6f9SBlue Swirl				if ($continuation ||
15561ec3f6f9SBlue Swirl				    $s =~ /^\s*?\n/ ||
15571ec3f6f9SBlue Swirl				    $s =~ /^\s*#\s*?/ ||
15581ec3f6f9SBlue Swirl				    $s =~ /^\s*$Ident\s*:/) {
15591ec3f6f9SBlue Swirl					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
15601ec3f6f9SBlue Swirl					if ($s =~ s/^.*?\n//) {
15611ec3f6f9SBlue Swirl						$cond_lines++;
15621ec3f6f9SBlue Swirl					}
15631ec3f6f9SBlue Swirl				}
15641ec3f6f9SBlue Swirl			}
15651ec3f6f9SBlue Swirl
15661ec3f6f9SBlue Swirl			my (undef, $sindent) = line_stats("+" . $s);
15671ec3f6f9SBlue Swirl			my $stat_real = raw_line($linenr, $cond_lines);
15681ec3f6f9SBlue Swirl
15691ec3f6f9SBlue Swirl			# Check if either of these lines are modified, else
15701ec3f6f9SBlue Swirl			# this is not this patch's fault.
15711ec3f6f9SBlue Swirl			if (!defined($stat_real) ||
15721ec3f6f9SBlue Swirl			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
15731ec3f6f9SBlue Swirl				$check = 0;
15741ec3f6f9SBlue Swirl			}
15751ec3f6f9SBlue Swirl			if (defined($stat_real) && $cond_lines > 1) {
15761ec3f6f9SBlue Swirl				$stat_real = "[...]\n$stat_real";
15771ec3f6f9SBlue Swirl			}
15781ec3f6f9SBlue Swirl
15791ec3f6f9SBlue Swirl			#print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n";
15801ec3f6f9SBlue Swirl
1581b6469683SBlue Swirl			if ($check && (($sindent % 4) != 0 ||
15821ec3f6f9SBlue Swirl			    ($sindent <= $indent && $s ne ''))) {
15831ec3f6f9SBlue Swirl				WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
15841ec3f6f9SBlue Swirl			}
15851ec3f6f9SBlue Swirl		}
15861ec3f6f9SBlue Swirl
15871ec3f6f9SBlue Swirl		# Track the 'values' across context and added lines.
15881ec3f6f9SBlue Swirl		my $opline = $line; $opline =~ s/^./ /;
15891ec3f6f9SBlue Swirl		my ($curr_values, $curr_vars) =
15901ec3f6f9SBlue Swirl				annotate_values($opline . "\n", $prev_values);
15911ec3f6f9SBlue Swirl		$curr_values = $prev_values . $curr_values;
15921ec3f6f9SBlue Swirl		if ($dbg_values) {
15931ec3f6f9SBlue Swirl			my $outline = $opline; $outline =~ s/\t/ /g;
15941ec3f6f9SBlue Swirl			print "$linenr > .$outline\n";
15951ec3f6f9SBlue Swirl			print "$linenr > $curr_values\n";
15961ec3f6f9SBlue Swirl			print "$linenr >  $curr_vars\n";
15971ec3f6f9SBlue Swirl		}
15981ec3f6f9SBlue Swirl		$prev_values = substr($curr_values, -1);
15991ec3f6f9SBlue Swirl
16001ec3f6f9SBlue Swirl#ignore lines not being added
16011ec3f6f9SBlue Swirl		if ($line=~/^[^\+]/) {next;}
16021ec3f6f9SBlue Swirl
16031ec3f6f9SBlue Swirl# TEST: allow direct testing of the type matcher.
16041ec3f6f9SBlue Swirl		if ($dbg_type) {
16051ec3f6f9SBlue Swirl			if ($line =~ /^.\s*$Declare\s*$/) {
16061ec3f6f9SBlue Swirl				ERROR("TEST: is type\n" . $herecurr);
16071ec3f6f9SBlue Swirl			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
16081ec3f6f9SBlue Swirl				ERROR("TEST: is not type ($1 is)\n". $herecurr);
16091ec3f6f9SBlue Swirl			}
16101ec3f6f9SBlue Swirl			next;
16111ec3f6f9SBlue Swirl		}
16121ec3f6f9SBlue Swirl# TEST: allow direct testing of the attribute matcher.
16131ec3f6f9SBlue Swirl		if ($dbg_attr) {
16141ec3f6f9SBlue Swirl			if ($line =~ /^.\s*$Modifier\s*$/) {
16151ec3f6f9SBlue Swirl				ERROR("TEST: is attr\n" . $herecurr);
16161ec3f6f9SBlue Swirl			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
16171ec3f6f9SBlue Swirl				ERROR("TEST: is not attr ($1 is)\n". $herecurr);
16181ec3f6f9SBlue Swirl			}
16191ec3f6f9SBlue Swirl			next;
16201ec3f6f9SBlue Swirl		}
16211ec3f6f9SBlue Swirl
16221ec3f6f9SBlue Swirl# check for initialisation to aggregates open brace on the next line
162304f2562fSFam Zheng		if ($line =~ /^.\s*\{/ &&
16241ec3f6f9SBlue Swirl		    $prevline =~ /(?:^|[^=])=\s*$/) {
16251ec3f6f9SBlue Swirl			ERROR("that open brace { should be on the previous line\n" . $hereprev);
16261ec3f6f9SBlue Swirl		}
16271ec3f6f9SBlue Swirl
16281ec3f6f9SBlue Swirl#
16291ec3f6f9SBlue Swirl# Checks which are anchored on the added line.
16301ec3f6f9SBlue Swirl#
16311ec3f6f9SBlue Swirl
16321ec3f6f9SBlue Swirl# check for malformed paths in #include statements (uses RAW line)
16331ec3f6f9SBlue Swirl		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
16341ec3f6f9SBlue Swirl			my $path = $1;
16351ec3f6f9SBlue Swirl			if ($path =~ m{//}) {
16361ec3f6f9SBlue Swirl				ERROR("malformed #include filename\n" .
16371ec3f6f9SBlue Swirl					$herecurr);
16381ec3f6f9SBlue Swirl			}
16391ec3f6f9SBlue Swirl		}
16401ec3f6f9SBlue Swirl
16411ec3f6f9SBlue Swirl# no C99 // comments
16421ec3f6f9SBlue Swirl		if ($line =~ m{//}) {
16431ec3f6f9SBlue Swirl			ERROR("do not use C99 // comments\n" . $herecurr);
16441ec3f6f9SBlue Swirl		}
16451ec3f6f9SBlue Swirl		# Remove C99 comments.
16461ec3f6f9SBlue Swirl		$line =~ s@//.*@@;
16471ec3f6f9SBlue Swirl		$opline =~ s@//.*@@;
16481ec3f6f9SBlue Swirl
16491ec3f6f9SBlue Swirl# check for global initialisers.
16501ec3f6f9SBlue Swirl		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
16511ec3f6f9SBlue Swirl			ERROR("do not initialise globals to 0 or NULL\n" .
16521ec3f6f9SBlue Swirl				$herecurr);
16531ec3f6f9SBlue Swirl		}
16541ec3f6f9SBlue Swirl# check for static initialisers.
16551ec3f6f9SBlue Swirl		if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
16561ec3f6f9SBlue Swirl			ERROR("do not initialise statics to 0 or NULL\n" .
16571ec3f6f9SBlue Swirl				$herecurr);
16581ec3f6f9SBlue Swirl		}
16591ec3f6f9SBlue Swirl
16601ec3f6f9SBlue Swirl# * goes on variable not on type
16611ec3f6f9SBlue Swirl		# (char*[ const])
16621ec3f6f9SBlue Swirl		if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
16631ec3f6f9SBlue Swirl			my ($from, $to) = ($1, $1);
16641ec3f6f9SBlue Swirl
16651ec3f6f9SBlue Swirl			# Should start with a space.
16661ec3f6f9SBlue Swirl			$to =~ s/^(\S)/ $1/;
16671ec3f6f9SBlue Swirl			# Should not end with a space.
16681ec3f6f9SBlue Swirl			$to =~ s/\s+$//;
16691ec3f6f9SBlue Swirl			# '*'s should not have spaces between.
16701ec3f6f9SBlue Swirl			while ($to =~ s/\*\s+\*/\*\*/) {
16711ec3f6f9SBlue Swirl			}
16721ec3f6f9SBlue Swirl
16731ec3f6f9SBlue Swirl			#print "from<$from> to<$to>\n";
16741ec3f6f9SBlue Swirl			if ($from ne $to) {
16751ec3f6f9SBlue Swirl				ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
16761ec3f6f9SBlue Swirl			}
16771ec3f6f9SBlue Swirl		} elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
16781ec3f6f9SBlue Swirl			my ($from, $to, $ident) = ($1, $1, $2);
16791ec3f6f9SBlue Swirl
16801ec3f6f9SBlue Swirl			# Should start with a space.
16811ec3f6f9SBlue Swirl			$to =~ s/^(\S)/ $1/;
16821ec3f6f9SBlue Swirl			# Should not end with a space.
16831ec3f6f9SBlue Swirl			$to =~ s/\s+$//;
16841ec3f6f9SBlue Swirl			# '*'s should not have spaces between.
16851ec3f6f9SBlue Swirl			while ($to =~ s/\*\s+\*/\*\*/) {
16861ec3f6f9SBlue Swirl			}
16871ec3f6f9SBlue Swirl			# Modifiers should have spaces.
16881ec3f6f9SBlue Swirl			$to =~ s/(\b$Modifier$)/$1 /;
16891ec3f6f9SBlue Swirl
16901ec3f6f9SBlue Swirl			#print "from<$from> to<$to> ident<$ident>\n";
16911ec3f6f9SBlue Swirl			if ($from ne $to && $ident !~ /^$Modifier$/) {
16921ec3f6f9SBlue Swirl				ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
16931ec3f6f9SBlue Swirl			}
16941ec3f6f9SBlue Swirl		}
16951ec3f6f9SBlue Swirl
16961ec3f6f9SBlue Swirl# function brace can't be on same line, except for #defines of do while,
16971ec3f6f9SBlue Swirl# or if closed on same line
169804f2562fSFam Zheng		if (($line=~/$Type\s*$Ident\(.*\).*\s\{/) and
169904f2562fSFam Zheng		    !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
17001ec3f6f9SBlue Swirl			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
17011ec3f6f9SBlue Swirl		}
17021ec3f6f9SBlue Swirl
17031ec3f6f9SBlue Swirl# open braces for enum, union and struct go on the same line.
170404f2562fSFam Zheng		if ($line =~ /^.\s*\{/ &&
17051ec3f6f9SBlue Swirl		    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
17061ec3f6f9SBlue Swirl			ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
17071ec3f6f9SBlue Swirl		}
17081ec3f6f9SBlue Swirl
17091ec3f6f9SBlue Swirl# missing space after union, struct or enum definition
17101ec3f6f9SBlue Swirl		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
171171c47b01SPaolo Bonzini		    ERROR("missing space after $1 definition\n" . $herecurr);
17121ec3f6f9SBlue Swirl		}
17131ec3f6f9SBlue Swirl
17141ec3f6f9SBlue Swirl# check for spacing round square brackets; allowed:
17151ec3f6f9SBlue Swirl#  1. with a type on the left -- int [] a;
17161ec3f6f9SBlue Swirl#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
17171ec3f6f9SBlue Swirl#  3. inside a curly brace -- = { [0...10] = 5 }
17181ec3f6f9SBlue Swirl		while ($line =~ /(.*?\s)\[/g) {
17191ec3f6f9SBlue Swirl			my ($where, $prefix) = ($-[1], $1);
17201ec3f6f9SBlue Swirl			if ($prefix !~ /$Type\s+$/ &&
17211ec3f6f9SBlue Swirl			    ($where != 0 || $prefix !~ /^.\s+$/) &&
17221ec3f6f9SBlue Swirl			    $prefix !~ /{\s+$/) {
17231ec3f6f9SBlue Swirl				ERROR("space prohibited before open square bracket '['\n" . $herecurr);
17241ec3f6f9SBlue Swirl			}
17251ec3f6f9SBlue Swirl		}
17261ec3f6f9SBlue Swirl
17271ec3f6f9SBlue Swirl# check for spaces between functions and their parentheses.
17281ec3f6f9SBlue Swirl		while ($line =~ /($Ident)\s+\(/g) {
17291ec3f6f9SBlue Swirl			my $name = $1;
17301ec3f6f9SBlue Swirl			my $ctx_before = substr($line, 0, $-[1]);
17311ec3f6f9SBlue Swirl			my $ctx = "$ctx_before$name";
17321ec3f6f9SBlue Swirl
17331ec3f6f9SBlue Swirl			# Ignore those directives where spaces _are_ permitted.
17341ec3f6f9SBlue Swirl			if ($name =~ /^(?:
17351ec3f6f9SBlue Swirl				if|for|while|switch|return|case|
17361ec3f6f9SBlue Swirl				volatile|__volatile__|
17371ec3f6f9SBlue Swirl				__attribute__|format|__extension__|
17381ec3f6f9SBlue Swirl				asm|__asm__)$/x)
17391ec3f6f9SBlue Swirl			{
17401ec3f6f9SBlue Swirl
174169d5d21fSTomoki Sekiyama			# Ignore 'catch (...)' in C++
174269d5d21fSTomoki Sekiyama			} elsif ($name =~ /^catch$/ && $realfile =~ /(\.cpp|\.h)$/) {
174369d5d21fSTomoki Sekiyama
17441ec3f6f9SBlue Swirl			# cpp #define statements have non-optional spaces, ie
17451ec3f6f9SBlue Swirl			# if there is a space between the name and the open
17461ec3f6f9SBlue Swirl			# parenthesis it is simply not a parameter group.
17471ec3f6f9SBlue Swirl			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
17481ec3f6f9SBlue Swirl
17491ec3f6f9SBlue Swirl			# cpp #elif statement condition may start with a (
17501ec3f6f9SBlue Swirl			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
17511ec3f6f9SBlue Swirl
17521ec3f6f9SBlue Swirl			# If this whole things ends with a type its most
17531ec3f6f9SBlue Swirl			# likely a typedef for a function.
17541ec3f6f9SBlue Swirl			} elsif ($ctx =~ /$Type$/) {
17551ec3f6f9SBlue Swirl
17561ec3f6f9SBlue Swirl			} else {
17571ec3f6f9SBlue Swirl				WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
17581ec3f6f9SBlue Swirl			}
17591ec3f6f9SBlue Swirl		}
17601ec3f6f9SBlue Swirl# Check operator spacing.
17611ec3f6f9SBlue Swirl		if (!($line=~/\#\s*include/)) {
17621ec3f6f9SBlue Swirl			my $ops = qr{
17631ec3f6f9SBlue Swirl				<<=|>>=|<=|>=|==|!=|
17641ec3f6f9SBlue Swirl				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
17651ec3f6f9SBlue Swirl				=>|->|<<|>>|<|>|=|!|~|
17661ec3f6f9SBlue Swirl				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
176769d5d21fSTomoki Sekiyama				\?|::|:
17681ec3f6f9SBlue Swirl			}x;
17691ec3f6f9SBlue Swirl			my @elements = split(/($ops|;)/, $opline);
17701ec3f6f9SBlue Swirl			my $off = 0;
17711ec3f6f9SBlue Swirl
17721ec3f6f9SBlue Swirl			my $blank = copy_spacing($opline);
17731ec3f6f9SBlue Swirl
17741ec3f6f9SBlue Swirl			for (my $n = 0; $n < $#elements; $n += 2) {
17751ec3f6f9SBlue Swirl				$off += length($elements[$n]);
17761ec3f6f9SBlue Swirl
1777e7d81004SStefan Weil				# Pick up the preceding and succeeding characters.
17781ec3f6f9SBlue Swirl				my $ca = substr($opline, 0, $off);
17791ec3f6f9SBlue Swirl				my $cc = '';
17801ec3f6f9SBlue Swirl				if (length($opline) >= ($off + length($elements[$n + 1]))) {
17811ec3f6f9SBlue Swirl					$cc = substr($opline, $off + length($elements[$n + 1]));
17821ec3f6f9SBlue Swirl				}
17831ec3f6f9SBlue Swirl				my $cb = "$ca$;$cc";
17841ec3f6f9SBlue Swirl
17851ec3f6f9SBlue Swirl				my $a = '';
17861ec3f6f9SBlue Swirl				$a = 'V' if ($elements[$n] ne '');
17871ec3f6f9SBlue Swirl				$a = 'W' if ($elements[$n] =~ /\s$/);
17881ec3f6f9SBlue Swirl				$a = 'C' if ($elements[$n] =~ /$;$/);
17891ec3f6f9SBlue Swirl				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
17901ec3f6f9SBlue Swirl				$a = 'O' if ($elements[$n] eq '');
17911ec3f6f9SBlue Swirl				$a = 'E' if ($ca =~ /^\s*$/);
17921ec3f6f9SBlue Swirl
17931ec3f6f9SBlue Swirl				my $op = $elements[$n + 1];
17941ec3f6f9SBlue Swirl
17951ec3f6f9SBlue Swirl				my $c = '';
17961ec3f6f9SBlue Swirl				if (defined $elements[$n + 2]) {
17971ec3f6f9SBlue Swirl					$c = 'V' if ($elements[$n + 2] ne '');
17981ec3f6f9SBlue Swirl					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
17991ec3f6f9SBlue Swirl					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
18001ec3f6f9SBlue Swirl					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
18011ec3f6f9SBlue Swirl					$c = 'O' if ($elements[$n + 2] eq '');
18021ec3f6f9SBlue Swirl					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
18031ec3f6f9SBlue Swirl				} else {
18041ec3f6f9SBlue Swirl					$c = 'E';
18051ec3f6f9SBlue Swirl				}
18061ec3f6f9SBlue Swirl
18071ec3f6f9SBlue Swirl				my $ctx = "${a}x${c}";
18081ec3f6f9SBlue Swirl
18091ec3f6f9SBlue Swirl				my $at = "(ctx:$ctx)";
18101ec3f6f9SBlue Swirl
18111ec3f6f9SBlue Swirl				my $ptr = substr($blank, 0, $off) . "^";
18121ec3f6f9SBlue Swirl				my $hereptr = "$hereline$ptr\n";
18131ec3f6f9SBlue Swirl
18141ec3f6f9SBlue Swirl				# Pull out the value of this operator.
18151ec3f6f9SBlue Swirl				my $op_type = substr($curr_values, $off + 1, 1);
18161ec3f6f9SBlue Swirl
18171ec3f6f9SBlue Swirl				# Get the full operator variant.
18181ec3f6f9SBlue Swirl				my $opv = $op . substr($curr_vars, $off, 1);
18191ec3f6f9SBlue Swirl
18201ec3f6f9SBlue Swirl				# Ignore operators passed as parameters.
18211ec3f6f9SBlue Swirl				if ($op_type ne 'V' &&
18221ec3f6f9SBlue Swirl				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {
18231ec3f6f9SBlue Swirl
18241ec3f6f9SBlue Swirl#				# Ignore comments
18251ec3f6f9SBlue Swirl#				} elsif ($op =~ /^$;+$/) {
18261ec3f6f9SBlue Swirl
18271ec3f6f9SBlue Swirl				# ; should have either the end of line or a space or \ after it
18281ec3f6f9SBlue Swirl				} elsif ($op eq ';') {
18291ec3f6f9SBlue Swirl					if ($ctx !~ /.x[WEBC]/ &&
18301ec3f6f9SBlue Swirl					    $cc !~ /^\\/ && $cc !~ /^;/) {
18311ec3f6f9SBlue Swirl						ERROR("space required after that '$op' $at\n" . $hereptr);
18321ec3f6f9SBlue Swirl					}
18331ec3f6f9SBlue Swirl
18341ec3f6f9SBlue Swirl				# // is a comment
18351ec3f6f9SBlue Swirl				} elsif ($op eq '//') {
18361ec3f6f9SBlue Swirl
183769d5d21fSTomoki Sekiyama				# Ignore : used in class declaration in C++
183869d5d21fSTomoki Sekiyama				} elsif ($opv eq ':B' && $ctx =~ /Wx[WE]/ &&
183969d5d21fSTomoki Sekiyama						 $line =~ /class/ && $realfile =~ /(\.cpp|\.h)$/) {
184069d5d21fSTomoki Sekiyama
18411ec3f6f9SBlue Swirl				# No spaces for:
18421ec3f6f9SBlue Swirl				#   ->
18431ec3f6f9SBlue Swirl				#   :   when part of a bitfield
18441ec3f6f9SBlue Swirl				} elsif ($op eq '->' || $opv eq ':B') {
18451ec3f6f9SBlue Swirl					if ($ctx =~ /Wx.|.xW/) {
18461ec3f6f9SBlue Swirl						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
18471ec3f6f9SBlue Swirl					}
18481ec3f6f9SBlue Swirl
18491ec3f6f9SBlue Swirl				# , must have a space on the right.
18509fbe4784SAlexander Graf                                # not required when having a single },{ on one line
18511ec3f6f9SBlue Swirl				} elsif ($op eq ',') {
18529fbe4784SAlexander Graf					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/ &&
185304f2562fSFam Zheng                                            ($elements[$n] . $elements[$n + 2]) !~ " *}\\{") {
18541ec3f6f9SBlue Swirl						ERROR("space required after that '$op' $at\n" . $hereptr);
18551ec3f6f9SBlue Swirl					}
18561ec3f6f9SBlue Swirl
18571ec3f6f9SBlue Swirl				# '*' as part of a type definition -- reported already.
18581ec3f6f9SBlue Swirl				} elsif ($opv eq '*_') {
18591ec3f6f9SBlue Swirl					#warn "'*' is part of type\n";
18601ec3f6f9SBlue Swirl
18611ec3f6f9SBlue Swirl				# unary operators should have a space before and
18621ec3f6f9SBlue Swirl				# none after.  May be left adjacent to another
18631ec3f6f9SBlue Swirl				# unary operator, or a cast
18641ec3f6f9SBlue Swirl				} elsif ($op eq '!' || $op eq '~' ||
18651ec3f6f9SBlue Swirl					 $opv eq '*U' || $opv eq '-U' ||
18661ec3f6f9SBlue Swirl					 $opv eq '&U' || $opv eq '&&U') {
186769d5d21fSTomoki Sekiyama					if ($op eq '~' && $ca =~ /::$/ && $realfile =~ /(\.cpp|\.h)$/) {
186869d5d21fSTomoki Sekiyama						# '~' used as a name of Destructor
186969d5d21fSTomoki Sekiyama
187069d5d21fSTomoki Sekiyama					} elsif ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
18711ec3f6f9SBlue Swirl						ERROR("space required before that '$op' $at\n" . $hereptr);
18721ec3f6f9SBlue Swirl					}
18731ec3f6f9SBlue Swirl					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
18741ec3f6f9SBlue Swirl						# A unary '*' may be const
18751ec3f6f9SBlue Swirl
18761ec3f6f9SBlue Swirl					} elsif ($ctx =~ /.xW/) {
18771ec3f6f9SBlue Swirl						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
18781ec3f6f9SBlue Swirl					}
18791ec3f6f9SBlue Swirl
18801ec3f6f9SBlue Swirl				# unary ++ and unary -- are allowed no space on one side.
18811ec3f6f9SBlue Swirl				} elsif ($op eq '++' or $op eq '--') {
18821ec3f6f9SBlue Swirl					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
18831ec3f6f9SBlue Swirl						ERROR("space required one side of that '$op' $at\n" . $hereptr);
18841ec3f6f9SBlue Swirl					}
18851ec3f6f9SBlue Swirl					if ($ctx =~ /Wx[BE]/ ||
18861ec3f6f9SBlue Swirl					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
18871ec3f6f9SBlue Swirl						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
18881ec3f6f9SBlue Swirl					}
18891ec3f6f9SBlue Swirl					if ($ctx =~ /ExW/) {
18901ec3f6f9SBlue Swirl						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
18911ec3f6f9SBlue Swirl					}
18921ec3f6f9SBlue Swirl
18931ec3f6f9SBlue Swirl
18941ec3f6f9SBlue Swirl				# << and >> may either have or not have spaces both sides
18951ec3f6f9SBlue Swirl				} elsif ($op eq '<<' or $op eq '>>' or
18961ec3f6f9SBlue Swirl					 $op eq '&' or $op eq '^' or $op eq '|' or
18971ec3f6f9SBlue Swirl					 $op eq '+' or $op eq '-' or
18981ec3f6f9SBlue Swirl					 $op eq '*' or $op eq '/' or
18991ec3f6f9SBlue Swirl					 $op eq '%')
19001ec3f6f9SBlue Swirl				{
19011ec3f6f9SBlue Swirl					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
19021ec3f6f9SBlue Swirl						ERROR("need consistent spacing around '$op' $at\n" .
19031ec3f6f9SBlue Swirl							$hereptr);
19041ec3f6f9SBlue Swirl					}
19051ec3f6f9SBlue Swirl
19061ec3f6f9SBlue Swirl				# A colon needs no spaces before when it is
19071ec3f6f9SBlue Swirl				# terminating a case value or a label.
19081ec3f6f9SBlue Swirl				} elsif ($opv eq ':C' || $opv eq ':L') {
19091ec3f6f9SBlue Swirl					if ($ctx =~ /Wx./) {
19101ec3f6f9SBlue Swirl						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
19111ec3f6f9SBlue Swirl					}
19121ec3f6f9SBlue Swirl
19131ec3f6f9SBlue Swirl				# All the others need spaces both sides.
19141ec3f6f9SBlue Swirl				} elsif ($ctx !~ /[EWC]x[CWE]/) {
19151ec3f6f9SBlue Swirl					my $ok = 0;
19161ec3f6f9SBlue Swirl
191769d5d21fSTomoki Sekiyama					if ($realfile =~ /\.cpp|\.h$/) {
191869d5d21fSTomoki Sekiyama						# Ignore template arguments <...> in C++
191969d5d21fSTomoki Sekiyama						if (($op eq '<' || $op eq '>') && $line =~ /<.*>/) {
192069d5d21fSTomoki Sekiyama							$ok = 1;
192169d5d21fSTomoki Sekiyama						}
192269d5d21fSTomoki Sekiyama
192369d5d21fSTomoki Sekiyama						# Ignore :: in C++
192469d5d21fSTomoki Sekiyama						if ($op eq '::') {
192569d5d21fSTomoki Sekiyama							$ok = 1;
192669d5d21fSTomoki Sekiyama						}
192769d5d21fSTomoki Sekiyama					}
192869d5d21fSTomoki Sekiyama
19291ec3f6f9SBlue Swirl					# Ignore email addresses <foo@bar>
19301ec3f6f9SBlue Swirl					if (($op eq '<' &&
19311ec3f6f9SBlue Swirl					     $cc =~ /^\S+\@\S+>/) ||
19321ec3f6f9SBlue Swirl					    ($op eq '>' &&
19331ec3f6f9SBlue Swirl					     $ca =~ /<\S+\@\S+$/))
19341ec3f6f9SBlue Swirl					{
19351ec3f6f9SBlue Swirl						$ok = 1;
19361ec3f6f9SBlue Swirl					}
19371ec3f6f9SBlue Swirl
19381ec3f6f9SBlue Swirl					# Ignore ?:
19391ec3f6f9SBlue Swirl					if (($opv eq ':O' && $ca =~ /\?$/) ||
19401ec3f6f9SBlue Swirl					    ($op eq '?' && $cc =~ /^:/)) {
19411ec3f6f9SBlue Swirl						$ok = 1;
19421ec3f6f9SBlue Swirl					}
19431ec3f6f9SBlue Swirl
19441ec3f6f9SBlue Swirl					if ($ok == 0) {
19451ec3f6f9SBlue Swirl						ERROR("spaces required around that '$op' $at\n" . $hereptr);
19461ec3f6f9SBlue Swirl					}
19471ec3f6f9SBlue Swirl				}
19481ec3f6f9SBlue Swirl				$off += length($elements[$n + 1]);
19491ec3f6f9SBlue Swirl			}
19501ec3f6f9SBlue Swirl		}
19511ec3f6f9SBlue Swirl
19521ec3f6f9SBlue Swirl#need space before brace following if, while, etc
195304f2562fSFam Zheng		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
195404f2562fSFam Zheng		    $line =~ /do\{/) {
19551ec3f6f9SBlue Swirl			ERROR("space required before the open brace '{'\n" . $herecurr);
19561ec3f6f9SBlue Swirl		}
19571ec3f6f9SBlue Swirl
19581ec3f6f9SBlue Swirl# closing brace should have a space following it when it has anything
19591ec3f6f9SBlue Swirl# on the line
19601ec3f6f9SBlue Swirl		if ($line =~ /}(?!(?:,|;|\)))\S/) {
19611ec3f6f9SBlue Swirl			ERROR("space required after that close brace '}'\n" . $herecurr);
19621ec3f6f9SBlue Swirl		}
19631ec3f6f9SBlue Swirl
19641ec3f6f9SBlue Swirl# check spacing on square brackets
19651ec3f6f9SBlue Swirl		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
19661ec3f6f9SBlue Swirl			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
19671ec3f6f9SBlue Swirl		}
19681ec3f6f9SBlue Swirl		if ($line =~ /\s\]/) {
19691ec3f6f9SBlue Swirl			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
19701ec3f6f9SBlue Swirl		}
19711ec3f6f9SBlue Swirl
19721ec3f6f9SBlue Swirl# check spacing on parentheses
19731ec3f6f9SBlue Swirl		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
19741ec3f6f9SBlue Swirl		    $line !~ /for\s*\(\s+;/) {
19751ec3f6f9SBlue Swirl			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
19761ec3f6f9SBlue Swirl		}
19771ec3f6f9SBlue Swirl		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
19781ec3f6f9SBlue Swirl		    $line !~ /for\s*\(.*;\s+\)/ &&
19791ec3f6f9SBlue Swirl		    $line !~ /:\s+\)/) {
19801ec3f6f9SBlue Swirl			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
19811ec3f6f9SBlue Swirl		}
19821ec3f6f9SBlue Swirl
19831ec3f6f9SBlue Swirl# Return is not a function.
19841ec3f6f9SBlue Swirl		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
19851ec3f6f9SBlue Swirl			my $spacing = $1;
19861ec3f6f9SBlue Swirl			my $value = $2;
19871ec3f6f9SBlue Swirl
19881ec3f6f9SBlue Swirl			# Flatten any parentheses
19891ec3f6f9SBlue Swirl			$value =~ s/\(/ \(/g;
19901ec3f6f9SBlue Swirl			$value =~ s/\)/\) /g;
19911ec3f6f9SBlue Swirl			while ($value =~ s/\[[^\{\}]*\]/1/ ||
19921ec3f6f9SBlue Swirl			       $value !~ /(?:$Ident|-?$Constant)\s*
19931ec3f6f9SBlue Swirl					     $Compare\s*
19941ec3f6f9SBlue Swirl					     (?:$Ident|-?$Constant)/x &&
19951ec3f6f9SBlue Swirl			       $value =~ s/\([^\(\)]*\)/1/) {
19961ec3f6f9SBlue Swirl			}
19971ec3f6f9SBlue Swirl#print "value<$value>\n";
19981ec3f6f9SBlue Swirl			if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
19991ec3f6f9SBlue Swirl				ERROR("return is not a function, parentheses are not required\n" . $herecurr);
20001ec3f6f9SBlue Swirl
20011ec3f6f9SBlue Swirl			} elsif ($spacing !~ /\s+/) {
20021ec3f6f9SBlue Swirl				ERROR("space required before the open parenthesis '('\n" . $herecurr);
20031ec3f6f9SBlue Swirl			}
20041ec3f6f9SBlue Swirl		}
20051ec3f6f9SBlue Swirl# Return of what appears to be an errno should normally be -'ve
20061ec3f6f9SBlue Swirl		if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
20071ec3f6f9SBlue Swirl			my $name = $1;
20081ec3f6f9SBlue Swirl			if ($name ne 'EOF' && $name ne 'ERROR') {
200971c47b01SPaolo Bonzini				WARN("return of an errno should typically be -ve (return -$1)\n" . $herecurr);
20101ec3f6f9SBlue Swirl			}
20111ec3f6f9SBlue Swirl		}
20121ec3f6f9SBlue Swirl
20131ec3f6f9SBlue Swirl# Need a space before open parenthesis after if, while etc
20141ec3f6f9SBlue Swirl		if ($line=~/\b(if|while|for|switch)\(/) {
20151ec3f6f9SBlue Swirl			ERROR("space required before the open parenthesis '('\n" . $herecurr);
20161ec3f6f9SBlue Swirl		}
20171ec3f6f9SBlue Swirl
20181ec3f6f9SBlue Swirl# Check for illegal assignment in if conditional -- and check for trailing
20191ec3f6f9SBlue Swirl# statements after the conditional.
20201ec3f6f9SBlue Swirl		if ($line =~ /do\s*(?!{)/) {
20211ec3f6f9SBlue Swirl			my ($stat_next) = ctx_statement_block($line_nr_next,
20221ec3f6f9SBlue Swirl						$remain_next, $off_next);
20231ec3f6f9SBlue Swirl			$stat_next =~ s/\n./\n /g;
20241ec3f6f9SBlue Swirl			##print "stat<$stat> stat_next<$stat_next>\n";
20251ec3f6f9SBlue Swirl
20261ec3f6f9SBlue Swirl			if ($stat_next =~ /^\s*while\b/) {
20271ec3f6f9SBlue Swirl				# If the statement carries leading newlines,
20281ec3f6f9SBlue Swirl				# then count those as offsets.
20291ec3f6f9SBlue Swirl				my ($whitespace) =
20301ec3f6f9SBlue Swirl					($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
20311ec3f6f9SBlue Swirl				my $offset =
20321ec3f6f9SBlue Swirl					statement_rawlines($whitespace) - 1;
20331ec3f6f9SBlue Swirl
20341ec3f6f9SBlue Swirl				$suppress_whiletrailers{$line_nr_next +
20351ec3f6f9SBlue Swirl								$offset} = 1;
20361ec3f6f9SBlue Swirl			}
20371ec3f6f9SBlue Swirl		}
20381ec3f6f9SBlue Swirl		if (!defined $suppress_whiletrailers{$linenr} &&
20391ec3f6f9SBlue Swirl		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
20401ec3f6f9SBlue Swirl			my ($s, $c) = ($stat, $cond);
20411ec3f6f9SBlue Swirl
20421ec3f6f9SBlue Swirl			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
20431ec3f6f9SBlue Swirl				ERROR("do not use assignment in if condition\n" . $herecurr);
20441ec3f6f9SBlue Swirl			}
20451ec3f6f9SBlue Swirl
20461ec3f6f9SBlue Swirl			# Find out what is on the end of the line after the
20471ec3f6f9SBlue Swirl			# conditional.
20481ec3f6f9SBlue Swirl			substr($s, 0, length($c), '');
20491ec3f6f9SBlue Swirl			$s =~ s/\n.*//g;
20501ec3f6f9SBlue Swirl			$s =~ s/$;//g; 	# Remove any comments
20511ec3f6f9SBlue Swirl			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
20521ec3f6f9SBlue Swirl			    $c !~ /}\s*while\s*/)
20531ec3f6f9SBlue Swirl			{
20541ec3f6f9SBlue Swirl				# Find out how long the conditional actually is.
20551ec3f6f9SBlue Swirl				my @newlines = ($c =~ /\n/gs);
20561ec3f6f9SBlue Swirl				my $cond_lines = 1 + $#newlines;
20571ec3f6f9SBlue Swirl				my $stat_real = '';
20581ec3f6f9SBlue Swirl
20591ec3f6f9SBlue Swirl				$stat_real = raw_line($linenr, $cond_lines)
20601ec3f6f9SBlue Swirl							. "\n" if ($cond_lines);
20611ec3f6f9SBlue Swirl				if (defined($stat_real) && $cond_lines > 1) {
20621ec3f6f9SBlue Swirl					$stat_real = "[...]\n$stat_real";
20631ec3f6f9SBlue Swirl				}
20641ec3f6f9SBlue Swirl
20651ec3f6f9SBlue Swirl				ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
20661ec3f6f9SBlue Swirl			}
20671ec3f6f9SBlue Swirl		}
20681ec3f6f9SBlue Swirl
20691ec3f6f9SBlue Swirl# Check for bitwise tests written as boolean
20701ec3f6f9SBlue Swirl		if ($line =~ /
20711ec3f6f9SBlue Swirl			(?:
20721ec3f6f9SBlue Swirl				(?:\[|\(|\&\&|\|\|)
20731ec3f6f9SBlue Swirl				\s*0[xX][0-9]+\s*
20741ec3f6f9SBlue Swirl				(?:\&\&|\|\|)
20751ec3f6f9SBlue Swirl			|
20761ec3f6f9SBlue Swirl				(?:\&\&|\|\|)
20771ec3f6f9SBlue Swirl				\s*0[xX][0-9]+\s*
20781ec3f6f9SBlue Swirl				(?:\&\&|\|\||\)|\])
20791ec3f6f9SBlue Swirl			)/x)
20801ec3f6f9SBlue Swirl		{
20811ec3f6f9SBlue Swirl			WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
20821ec3f6f9SBlue Swirl		}
20831ec3f6f9SBlue Swirl
20841ec3f6f9SBlue Swirl# if and else should not have general statements after it
20851ec3f6f9SBlue Swirl		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
20861ec3f6f9SBlue Swirl			my $s = $1;
20871ec3f6f9SBlue Swirl			$s =~ s/$;//g; 	# Remove any comments
20881ec3f6f9SBlue Swirl			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
20891ec3f6f9SBlue Swirl				ERROR("trailing statements should be on next line\n" . $herecurr);
20901ec3f6f9SBlue Swirl			}
20911ec3f6f9SBlue Swirl		}
20921ec3f6f9SBlue Swirl# if should not continue a brace
20931ec3f6f9SBlue Swirl		if ($line =~ /}\s*if\b/) {
20941ec3f6f9SBlue Swirl			ERROR("trailing statements should be on next line\n" .
20951ec3f6f9SBlue Swirl				$herecurr);
20961ec3f6f9SBlue Swirl		}
20971ec3f6f9SBlue Swirl# case and default should not have general statements after them
20981ec3f6f9SBlue Swirl		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
20991ec3f6f9SBlue Swirl		    $line !~ /\G(?:
21001ec3f6f9SBlue Swirl			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
21011ec3f6f9SBlue Swirl			\s*return\s+
21021ec3f6f9SBlue Swirl		    )/xg)
21031ec3f6f9SBlue Swirl		{
21041ec3f6f9SBlue Swirl			ERROR("trailing statements should be on next line\n" . $herecurr);
21051ec3f6f9SBlue Swirl		}
21061ec3f6f9SBlue Swirl
21071ec3f6f9SBlue Swirl		# Check for }<nl>else {, these must be at the same
21081ec3f6f9SBlue Swirl		# indent level to be relevant to each other.
21091ec3f6f9SBlue Swirl		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
21101ec3f6f9SBlue Swirl						$previndent == $indent) {
21111ec3f6f9SBlue Swirl			ERROR("else should follow close brace '}'\n" . $hereprev);
21121ec3f6f9SBlue Swirl		}
21131ec3f6f9SBlue Swirl
21141ec3f6f9SBlue Swirl		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
21151ec3f6f9SBlue Swirl						$previndent == $indent) {
21161ec3f6f9SBlue Swirl			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
21171ec3f6f9SBlue Swirl
21181ec3f6f9SBlue Swirl			# Find out what is on the end of the line after the
21191ec3f6f9SBlue Swirl			# conditional.
21201ec3f6f9SBlue Swirl			substr($s, 0, length($c), '');
21211ec3f6f9SBlue Swirl			$s =~ s/\n.*//g;
21221ec3f6f9SBlue Swirl
21231ec3f6f9SBlue Swirl			if ($s =~ /^\s*;/) {
21241ec3f6f9SBlue Swirl				ERROR("while should follow close brace '}'\n" . $hereprev);
21251ec3f6f9SBlue Swirl			}
21261ec3f6f9SBlue Swirl		}
21271ec3f6f9SBlue Swirl
21281ec3f6f9SBlue Swirl#studly caps, commented out until figure out how to distinguish between use of existing and adding new
21291ec3f6f9SBlue Swirl#		if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
21301ec3f6f9SBlue Swirl#		    print "No studly caps, use _\n";
21311ec3f6f9SBlue Swirl#		    print "$herecurr";
21321ec3f6f9SBlue Swirl#		    $clean = 0;
21331ec3f6f9SBlue Swirl#		}
21341ec3f6f9SBlue Swirl
21351ec3f6f9SBlue Swirl#no spaces allowed after \ in define
21361ec3f6f9SBlue Swirl		if ($line=~/\#\s*define.*\\\s$/) {
21371ec3f6f9SBlue Swirl			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
21381ec3f6f9SBlue Swirl		}
21391ec3f6f9SBlue Swirl
21401ec3f6f9SBlue Swirl# multi-statement macros should be enclosed in a do while loop, grab the
21411ec3f6f9SBlue Swirl# first statement and ensure its the whole macro if its not enclosed
21421ec3f6f9SBlue Swirl# in a known good container
21431ec3f6f9SBlue Swirl		if ($realfile !~ m@/vmlinux.lds.h$@ &&
21441ec3f6f9SBlue Swirl		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
21451ec3f6f9SBlue Swirl			my $ln = $linenr;
21461ec3f6f9SBlue Swirl			my $cnt = $realcnt;
21471ec3f6f9SBlue Swirl			my ($off, $dstat, $dcond, $rest);
21481ec3f6f9SBlue Swirl			my $ctx = '';
21491ec3f6f9SBlue Swirl
21501ec3f6f9SBlue Swirl			my $args = defined($1);
21511ec3f6f9SBlue Swirl
21521ec3f6f9SBlue Swirl			# Find the end of the macro and limit our statement
21531ec3f6f9SBlue Swirl			# search to that.
21541ec3f6f9SBlue Swirl			while ($cnt > 0 && defined $lines[$ln - 1] &&
21551ec3f6f9SBlue Swirl				$lines[$ln - 1] =~ /^(?:-|..*\\$)/)
21561ec3f6f9SBlue Swirl			{
21571ec3f6f9SBlue Swirl				$ctx .= $rawlines[$ln - 1] . "\n";
21581ec3f6f9SBlue Swirl				$cnt-- if ($lines[$ln - 1] !~ /^-/);
21591ec3f6f9SBlue Swirl				$ln++;
21601ec3f6f9SBlue Swirl			}
21611ec3f6f9SBlue Swirl			$ctx .= $rawlines[$ln - 1];
21621ec3f6f9SBlue Swirl
21631ec3f6f9SBlue Swirl			($dstat, $dcond, $ln, $cnt, $off) =
21641ec3f6f9SBlue Swirl				ctx_statement_block($linenr, $ln - $linenr + 1, 0);
21651ec3f6f9SBlue Swirl			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
21661ec3f6f9SBlue Swirl			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
21671ec3f6f9SBlue Swirl
21681ec3f6f9SBlue Swirl			# Extract the remainder of the define (if any) and
21691ec3f6f9SBlue Swirl			# rip off surrounding spaces, and trailing \'s.
21701ec3f6f9SBlue Swirl			$rest = '';
21711ec3f6f9SBlue Swirl			while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
21721ec3f6f9SBlue Swirl				#print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
21731ec3f6f9SBlue Swirl				if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
21741ec3f6f9SBlue Swirl					$rest .= substr($lines[$ln - 1], $off) . "\n";
21751ec3f6f9SBlue Swirl					$cnt--;
21761ec3f6f9SBlue Swirl				}
21771ec3f6f9SBlue Swirl				$ln++;
21781ec3f6f9SBlue Swirl				$off = 0;
21791ec3f6f9SBlue Swirl			}
21801ec3f6f9SBlue Swirl			$rest =~ s/\\\n.//g;
21811ec3f6f9SBlue Swirl			$rest =~ s/^\s*//s;
21821ec3f6f9SBlue Swirl			$rest =~ s/\s*$//s;
21831ec3f6f9SBlue Swirl
21841ec3f6f9SBlue Swirl			# Clean up the original statement.
21851ec3f6f9SBlue Swirl			if ($args) {
21861ec3f6f9SBlue Swirl				substr($dstat, 0, length($dcond), '');
21871ec3f6f9SBlue Swirl			} else {
21881ec3f6f9SBlue Swirl				$dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
21891ec3f6f9SBlue Swirl			}
21901ec3f6f9SBlue Swirl			$dstat =~ s/$;//g;
21911ec3f6f9SBlue Swirl			$dstat =~ s/\\\n.//g;
21921ec3f6f9SBlue Swirl			$dstat =~ s/^\s*//s;
21931ec3f6f9SBlue Swirl			$dstat =~ s/\s*$//s;
21941ec3f6f9SBlue Swirl
21951ec3f6f9SBlue Swirl			# Flatten any parentheses and braces
21961ec3f6f9SBlue Swirl			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
21971ec3f6f9SBlue Swirl			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
21981ec3f6f9SBlue Swirl			       $dstat =~ s/\[[^\{\}]*\]/1/)
21991ec3f6f9SBlue Swirl			{
22001ec3f6f9SBlue Swirl			}
22011ec3f6f9SBlue Swirl
22021ec3f6f9SBlue Swirl			my $exceptions = qr{
22031ec3f6f9SBlue Swirl				$Declare|
22041ec3f6f9SBlue Swirl				module_param_named|
22051ec3f6f9SBlue Swirl				MODULE_PARAM_DESC|
22061ec3f6f9SBlue Swirl				DECLARE_PER_CPU|
22071ec3f6f9SBlue Swirl				DEFINE_PER_CPU|
22081ec3f6f9SBlue Swirl				__typeof__\(|
22091ec3f6f9SBlue Swirl				union|
22101ec3f6f9SBlue Swirl				struct|
22111ec3f6f9SBlue Swirl				\.$Ident\s*=\s*|
22121ec3f6f9SBlue Swirl				^\"|\"$
22131ec3f6f9SBlue Swirl			}x;
22141ec3f6f9SBlue Swirl			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
22151ec3f6f9SBlue Swirl			if ($rest ne '' && $rest ne ',') {
22161ec3f6f9SBlue Swirl				if ($rest !~ /while\s*\(/ &&
22171ec3f6f9SBlue Swirl				    $dstat !~ /$exceptions/)
22181ec3f6f9SBlue Swirl				{
22191ec3f6f9SBlue Swirl					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
22201ec3f6f9SBlue Swirl				}
22211ec3f6f9SBlue Swirl
22221ec3f6f9SBlue Swirl			} elsif ($ctx !~ /;/) {
22231ec3f6f9SBlue Swirl				if ($dstat ne '' &&
22241ec3f6f9SBlue Swirl				    $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
22251ec3f6f9SBlue Swirl				    $dstat !~ /$exceptions/ &&
22261ec3f6f9SBlue Swirl				    $dstat !~ /^\.$Ident\s*=/ &&
22271ec3f6f9SBlue Swirl				    $dstat =~ /$Operators/)
22281ec3f6f9SBlue Swirl				{
22291ec3f6f9SBlue Swirl					ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
22301ec3f6f9SBlue Swirl				}
22311ec3f6f9SBlue Swirl			}
22321ec3f6f9SBlue Swirl		}
22331ec3f6f9SBlue Swirl
2234b6469683SBlue Swirl# check for missing bracing round if etc
2235b6469683SBlue Swirl		if ($line =~ /(^.*)\bif\b/ && $line !~ /\#\s*if/) {
22361ec3f6f9SBlue Swirl			my ($level, $endln, @chunks) =
22371ec3f6f9SBlue Swirl				ctx_statement_full($linenr, $realcnt, 1);
223869402a69SDon Slutz                        if ($dbg_adv_apw) {
223969402a69SDon Slutz                            print "APW: chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
224069402a69SDon Slutz                            print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"
224169402a69SDon Slutz                                if $#chunks >= 1;
224269402a69SDon Slutz                        }
2243b6469683SBlue Swirl			if ($#chunks >= 0 && $level == 0) {
22441ec3f6f9SBlue Swirl				my $allowed = 0;
22451ec3f6f9SBlue Swirl				my $seen = 0;
22461ec3f6f9SBlue Swirl				my $herectx = $here . "\n";
22471ec3f6f9SBlue Swirl				my $ln = $linenr - 1;
22481ec3f6f9SBlue Swirl				for my $chunk (@chunks) {
22491ec3f6f9SBlue Swirl					my ($cond, $block) = @{$chunk};
22501ec3f6f9SBlue Swirl
22511ec3f6f9SBlue Swirl					# If the condition carries leading newlines, then count those as offsets.
22521ec3f6f9SBlue Swirl					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
22531ec3f6f9SBlue Swirl					my $offset = statement_rawlines($whitespace) - 1;
22541ec3f6f9SBlue Swirl
22551ec3f6f9SBlue Swirl					#print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
22561ec3f6f9SBlue Swirl
22571ec3f6f9SBlue Swirl					# We have looked at and allowed this specific line.
22581ec3f6f9SBlue Swirl					$suppress_ifbraces{$ln + $offset} = 1;
22591ec3f6f9SBlue Swirl
22601ec3f6f9SBlue Swirl					$herectx .= "$rawlines[$ln + $offset]\n[...]\n";
22611ec3f6f9SBlue Swirl					$ln += statement_rawlines($block) - 1;
22621ec3f6f9SBlue Swirl
22631ec3f6f9SBlue Swirl					substr($block, 0, length($cond), '');
22641ec3f6f9SBlue Swirl
2265a97ceca5SMax Reitz					my $spaced_block = $block;
2266a97ceca5SMax Reitz					$spaced_block =~ s/\n\+/ /g;
2267a97ceca5SMax Reitz
226804f2562fSFam Zheng					$seen++ if ($spaced_block =~ /^\s*\{/);
22691ec3f6f9SBlue Swirl
227069402a69SDon Slutz                                        print "APW: cond<$cond> block<$block> allowed<$allowed>\n"
227169402a69SDon Slutz                                            if $dbg_adv_apw;
22721ec3f6f9SBlue Swirl					if (statement_lines($cond) > 1) {
227369402a69SDon Slutz                                            print "APW: ALLOWED: cond<$cond>\n"
227469402a69SDon Slutz                                                if $dbg_adv_apw;
22751ec3f6f9SBlue Swirl                                            $allowed = 1;
22761ec3f6f9SBlue Swirl					}
22771ec3f6f9SBlue Swirl					if ($block =~/\b(?:if|for|while)\b/) {
227869402a69SDon Slutz                                            print "APW: ALLOWED: block<$block>\n"
227969402a69SDon Slutz                                                if $dbg_adv_apw;
22801ec3f6f9SBlue Swirl                                            $allowed = 1;
22811ec3f6f9SBlue Swirl					}
22821ec3f6f9SBlue Swirl					if (statement_block_size($block) > 1) {
228369402a69SDon Slutz                                            print "APW: ALLOWED: lines block<$block>\n"
228469402a69SDon Slutz                                                if $dbg_adv_apw;
22851ec3f6f9SBlue Swirl                                            $allowed = 1;
22861ec3f6f9SBlue Swirl					}
22871ec3f6f9SBlue Swirl				}
228801c4330bSPavel Borzenkov				if ($seen != ($#chunks + 1)) {
2289b6469683SBlue Swirl					WARN("braces {} are necessary for all arms of this statement\n" . $herectx);
22901ec3f6f9SBlue Swirl				}
22911ec3f6f9SBlue Swirl			}
22921ec3f6f9SBlue Swirl		}
22931ec3f6f9SBlue Swirl		if (!defined $suppress_ifbraces{$linenr - 1} &&
2294789f88d0SJan Kiszka					$line =~ /\b(if|while|for|else)\b/ &&
2295d0510af2SBlue Swirl					$line !~ /\#\s*if/ &&
2296789f88d0SJan Kiszka					$line !~ /\#\s*else/) {
22971ec3f6f9SBlue Swirl			my $allowed = 0;
22981ec3f6f9SBlue Swirl
22991ec3f6f9SBlue Swirl                        # Check the pre-context.
23001ec3f6f9SBlue Swirl                        if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2301dfe7053aSDon Slutz                            my $pre = $1;
2302dfe7053aSDon Slutz
2303dfe7053aSDon Slutz                            if ($line !~ /else/) {
230469402a69SDon Slutz                                print "APW: ALLOWED: pre<$pre> line<$line>\n"
230569402a69SDon Slutz                                    if $dbg_adv_apw;
23061ec3f6f9SBlue Swirl                                $allowed = 1;
23071ec3f6f9SBlue Swirl                            }
2308dfe7053aSDon Slutz                        }
23091ec3f6f9SBlue Swirl
23101ec3f6f9SBlue Swirl			my ($level, $endln, @chunks) =
23111ec3f6f9SBlue Swirl				ctx_statement_full($linenr, $realcnt, $-[0]);
23121ec3f6f9SBlue Swirl
23131ec3f6f9SBlue Swirl			# Check the condition.
23141ec3f6f9SBlue Swirl			my ($cond, $block) = @{$chunks[0]};
23155424302eSDon Slutz                        print "CHECKING<$linenr> cond<$cond> block<$block>\n"
23165424302eSDon Slutz                            if $dbg_adv_checking;
23171ec3f6f9SBlue Swirl			if (defined $cond) {
23181ec3f6f9SBlue Swirl				substr($block, 0, length($cond), '');
23191ec3f6f9SBlue Swirl			}
23201ec3f6f9SBlue Swirl			if (statement_lines($cond) > 1) {
232169402a69SDon Slutz                            print "APW: ALLOWED: cond<$cond>\n"
232269402a69SDon Slutz                                if $dbg_adv_apw;
23231ec3f6f9SBlue Swirl                            $allowed = 1;
23241ec3f6f9SBlue Swirl			}
23251ec3f6f9SBlue Swirl			if ($block =~/\b(?:if|for|while)\b/) {
232669402a69SDon Slutz                            print "APW: ALLOWED: block<$block>\n"
232769402a69SDon Slutz                                if $dbg_adv_apw;
23281ec3f6f9SBlue Swirl                            $allowed = 1;
23291ec3f6f9SBlue Swirl			}
23301ec3f6f9SBlue Swirl			if (statement_block_size($block) > 1) {
233169402a69SDon Slutz                            print "APW: ALLOWED: lines block<$block>\n"
233269402a69SDon Slutz                                if $dbg_adv_apw;
23331ec3f6f9SBlue Swirl                            $allowed = 1;
23341ec3f6f9SBlue Swirl			}
23351ec3f6f9SBlue Swirl			# Check the post-context.
23361ec3f6f9SBlue Swirl			if (defined $chunks[1]) {
23371ec3f6f9SBlue Swirl				my ($cond, $block) = @{$chunks[1]};
23381ec3f6f9SBlue Swirl				if (defined $cond) {
23391ec3f6f9SBlue Swirl					substr($block, 0, length($cond), '');
23401ec3f6f9SBlue Swirl				}
23411ec3f6f9SBlue Swirl				if ($block =~ /^\s*\{/) {
234269402a69SDon Slutz                                    print "APW: ALLOWED: chunk-1 block<$block>\n"
234369402a69SDon Slutz                                        if $dbg_adv_apw;
23441ec3f6f9SBlue Swirl                                    $allowed = 1;
23451ec3f6f9SBlue Swirl				}
23461ec3f6f9SBlue Swirl			}
2347a99ac041SDon Slutz                        print "DCS: level=$level block<$block> allowed=$allowed\n"
2348a99ac041SDon Slutz                            if $dbg_adv_dcs;
2349b6469683SBlue Swirl			if ($level == 0 && $block !~ /^\s*\{/ && !$allowed) {
23501ec3f6f9SBlue Swirl				my $herectx = $here . "\n";;
23511ec3f6f9SBlue Swirl				my $cnt = statement_rawlines($block);
23521ec3f6f9SBlue Swirl
23531ec3f6f9SBlue Swirl				for (my $n = 0; $n < $cnt; $n++) {
23541ec3f6f9SBlue Swirl					$herectx .= raw_line($linenr, $n) . "\n";;
23551ec3f6f9SBlue Swirl				}
23561ec3f6f9SBlue Swirl
2357b6469683SBlue Swirl				WARN("braces {} are necessary even for single statement blocks\n" . $herectx);
23581ec3f6f9SBlue Swirl			}
23591ec3f6f9SBlue Swirl		}
23601ec3f6f9SBlue Swirl
23611ec3f6f9SBlue Swirl# no volatiles please
23621ec3f6f9SBlue Swirl		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
23631ec3f6f9SBlue Swirl		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
23641ec3f6f9SBlue Swirl			WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
23651ec3f6f9SBlue Swirl		}
23661ec3f6f9SBlue Swirl
23671ec3f6f9SBlue Swirl# warn about #if 0
23681ec3f6f9SBlue Swirl		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
236971c47b01SPaolo Bonzini			WARN("if this code is redundant consider removing it\n" .
23701ec3f6f9SBlue Swirl				$herecurr);
23711ec3f6f9SBlue Swirl		}
23721ec3f6f9SBlue Swirl
237371c47b01SPaolo Bonzini# check for needless g_free() checks
23741ec3f6f9SBlue Swirl		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
23751ec3f6f9SBlue Swirl			my $expr = $1;
237671c47b01SPaolo Bonzini			if ($line =~ /\bg_free\(\Q$expr\E\);/) {
237771c47b01SPaolo Bonzini				WARN("g_free(NULL) is safe this check is probably not required\n" . $hereprev);
23781ec3f6f9SBlue Swirl			}
23791ec3f6f9SBlue Swirl		}
23801ec3f6f9SBlue Swirl
23811ec3f6f9SBlue Swirl# warn about #ifdefs in C files
23821ec3f6f9SBlue Swirl#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
23831ec3f6f9SBlue Swirl#			print "#ifdef in C files should be avoided\n";
23841ec3f6f9SBlue Swirl#			print "$herecurr";
23851ec3f6f9SBlue Swirl#			$clean = 0;
23861ec3f6f9SBlue Swirl#		}
23871ec3f6f9SBlue Swirl
23881ec3f6f9SBlue Swirl# warn about spacing in #ifdefs
23891ec3f6f9SBlue Swirl		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
23901ec3f6f9SBlue Swirl			ERROR("exactly one space required after that #$1\n" . $herecurr);
23911ec3f6f9SBlue Swirl		}
23921ec3f6f9SBlue Swirl# check for memory barriers without a comment.
239371c47b01SPaolo Bonzini		if ($line =~ /\b(smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
23941ec3f6f9SBlue Swirl			if (!ctx_has_comment($first_line, $linenr)) {
239571c47b01SPaolo Bonzini				WARN("memory barrier without comment\n" . $herecurr);
23961ec3f6f9SBlue Swirl			}
23971ec3f6f9SBlue Swirl		}
23981ec3f6f9SBlue Swirl# check of hardware specific defines
239971c47b01SPaolo Bonzini# we have e.g. CONFIG_LINUX and CONFIG_WIN32 for common cases
240071c47b01SPaolo Bonzini# where they might be necessary.
240171c47b01SPaolo Bonzini		if ($line =~ m@^.\s*\#\s*if.*\b__@) {
240271c47b01SPaolo Bonzini			WARN("architecture specific defines should be avoided\n" .  $herecurr);
24031ec3f6f9SBlue Swirl		}
24041ec3f6f9SBlue Swirl
24051ec3f6f9SBlue Swirl# Check that the storage class is at the beginning of a declaration
24061ec3f6f9SBlue Swirl		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
24071ec3f6f9SBlue Swirl			WARN("storage class should be at the beginning of the declaration\n" . $herecurr)
24081ec3f6f9SBlue Swirl		}
24091ec3f6f9SBlue Swirl
24101ec3f6f9SBlue Swirl# check the location of the inline attribute, that it is between
24111ec3f6f9SBlue Swirl# storage class and type.
24121ec3f6f9SBlue Swirl		if ($line =~ /\b$Type\s+$Inline\b/ ||
24131ec3f6f9SBlue Swirl		    $line =~ /\b$Inline\s+$Storage\b/) {
24141ec3f6f9SBlue Swirl			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
24151ec3f6f9SBlue Swirl		}
24161ec3f6f9SBlue Swirl
24171ec3f6f9SBlue Swirl# check for sizeof(&)
24181ec3f6f9SBlue Swirl		if ($line =~ /\bsizeof\s*\(\s*\&/) {
24191ec3f6f9SBlue Swirl			WARN("sizeof(& should be avoided\n" . $herecurr);
24201ec3f6f9SBlue Swirl		}
24211ec3f6f9SBlue Swirl
24221ec3f6f9SBlue Swirl# check for new externs in .c files.
24231ec3f6f9SBlue Swirl		if ($realfile =~ /\.c$/ && defined $stat &&
24241ec3f6f9SBlue Swirl		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
24251ec3f6f9SBlue Swirl		{
24261ec3f6f9SBlue Swirl			my $function_name = $1;
24271ec3f6f9SBlue Swirl			my $paren_space = $2;
24281ec3f6f9SBlue Swirl
24291ec3f6f9SBlue Swirl			my $s = $stat;
24301ec3f6f9SBlue Swirl			if (defined $cond) {
24311ec3f6f9SBlue Swirl				substr($s, 0, length($cond), '');
24321ec3f6f9SBlue Swirl			}
24331ec3f6f9SBlue Swirl			if ($s =~ /^\s*;/ &&
24341ec3f6f9SBlue Swirl			    $function_name ne 'uninitialized_var')
24351ec3f6f9SBlue Swirl			{
24361ec3f6f9SBlue Swirl				WARN("externs should be avoided in .c files\n" .  $herecurr);
24371ec3f6f9SBlue Swirl			}
24381ec3f6f9SBlue Swirl
24391ec3f6f9SBlue Swirl			if ($paren_space =~ /\n/) {
24401ec3f6f9SBlue Swirl				WARN("arguments for function declarations should follow identifier\n" . $herecurr);
24411ec3f6f9SBlue Swirl			}
24421ec3f6f9SBlue Swirl
24431ec3f6f9SBlue Swirl		} elsif ($realfile =~ /\.c$/ && defined $stat &&
24441ec3f6f9SBlue Swirl		    $stat =~ /^.\s*extern\s+/)
24451ec3f6f9SBlue Swirl		{
24461ec3f6f9SBlue Swirl			WARN("externs should be avoided in .c files\n" .  $herecurr);
24471ec3f6f9SBlue Swirl		}
24481ec3f6f9SBlue Swirl
244971c47b01SPaolo Bonzini# check for pointless casting of g_malloc return
245071c47b01SPaolo Bonzini		if ($line =~ /\*\s*\)\s*g_(try)?(m|re)alloc(0?)(_n)?\b/) {
245171c47b01SPaolo Bonzini			if ($2 == 'm') {
245271c47b01SPaolo Bonzini				WARN("unnecessary cast may hide bugs, use g_$1new$3 instead\n" . $herecurr);
245371c47b01SPaolo Bonzini			} else {
245471c47b01SPaolo Bonzini				WARN("unnecessary cast may hide bugs, use g_$1renew$3 instead\n" . $herecurr);
245571c47b01SPaolo Bonzini			}
24561ec3f6f9SBlue Swirl		}
24571ec3f6f9SBlue Swirl
24581ec3f6f9SBlue Swirl# check for gcc specific __FUNCTION__
24591ec3f6f9SBlue Swirl		if ($line =~ /__FUNCTION__/) {
24601ec3f6f9SBlue Swirl			WARN("__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
24611ec3f6f9SBlue Swirl		}
24621ec3f6f9SBlue Swirl
24635e43efb2SPaolo Bonzini# recommend qemu_strto* over strto* for numeric conversions
24645e43efb2SPaolo Bonzini		if ($line =~ /\b(strto[^k].*?)\s*\(/) {
246571c47b01SPaolo Bonzini			WARN("consider using qemu_$1 in preference to $1\n" . $herecurr);
24661ec3f6f9SBlue Swirl		}
246771c47b01SPaolo Bonzini# check for module_init(), use category-specific init macros explicitly please
246871c47b01SPaolo Bonzini		if ($line =~ /^module_init\s*\(/) {
246971c47b01SPaolo Bonzini			WARN("please use block_init(), type_init() etc. instead of module_init()\n" . $herecurr);
24701ec3f6f9SBlue Swirl		}
24711ec3f6f9SBlue Swirl# check for various ops structs, ensure they are const.
247271c47b01SPaolo Bonzini		my $struct_ops = qr{AIOCBInfo|
247371c47b01SPaolo Bonzini				BdrvActionOps|
247471c47b01SPaolo Bonzini				BlockDevOps|
247571c47b01SPaolo Bonzini				BlockJobDriver|
247671c47b01SPaolo Bonzini				DisplayChangeListenerOps|
247771c47b01SPaolo Bonzini				GraphicHwOps|
247871c47b01SPaolo Bonzini				IDEDMAOps|
247971c47b01SPaolo Bonzini				KVMCapabilityInfo|
248071c47b01SPaolo Bonzini				MemoryRegionIOMMUOps|
248171c47b01SPaolo Bonzini				MemoryRegionOps|
248271c47b01SPaolo Bonzini				MemoryRegionPortio|
248371c47b01SPaolo Bonzini				QEMUFileOps|
248471c47b01SPaolo Bonzini				SCSIBusInfo|
248571c47b01SPaolo Bonzini				SCSIReqOps|
248671c47b01SPaolo Bonzini				Spice[A-Z][a-zA-Z0-9]*Interface|
248771c47b01SPaolo Bonzini				TPMDriverOps|
248871c47b01SPaolo Bonzini				USBDesc[A-Z][a-zA-Z0-9]*|
248971c47b01SPaolo Bonzini				VhostOps|
249071c47b01SPaolo Bonzini				VMStateDescription|
249171c47b01SPaolo Bonzini				VMStateInfo}x;
24921ec3f6f9SBlue Swirl		if ($line !~ /\bconst\b/ &&
249371c47b01SPaolo Bonzini		    $line =~ /\b($struct_ops)\b/) {
24941ec3f6f9SBlue Swirl			WARN("struct $1 should normally be const\n" .
24951ec3f6f9SBlue Swirl				$herecurr);
24961ec3f6f9SBlue Swirl		}
24971ec3f6f9SBlue Swirl
24981ec3f6f9SBlue Swirl# check for %L{u,d,i} in strings
24991ec3f6f9SBlue Swirl		my $string;
25001ec3f6f9SBlue Swirl		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
25011ec3f6f9SBlue Swirl			$string = substr($rawline, $-[1], $+[1] - $-[1]);
25021ec3f6f9SBlue Swirl			$string =~ s/%%/__/g;
25031ec3f6f9SBlue Swirl			if ($string =~ /(?<!%)%L[udi]/) {
25041ec3f6f9SBlue Swirl				WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
25051ec3f6f9SBlue Swirl				last;
25061ec3f6f9SBlue Swirl			}
25071ec3f6f9SBlue Swirl		}
25081ec3f6f9SBlue Swirl
25099964d8f9SStefan Weil# QEMU specific tests
25109964d8f9SStefan Weil		if ($rawline =~ /\b(?:Qemu|QEmu)\b/) {
25119964d8f9SStefan Weil			WARN("use QEMU instead of Qemu or QEmu\n" . $herecurr);
25129964d8f9SStefan Weil		}
25138b6ee9aeSStefan Hajnoczi
25148b6ee9aeSStefan Hajnoczi# check for non-portable ffs() calls that have portable alternatives in QEMU
25158b6ee9aeSStefan Hajnoczi		if ($line =~ /\bffs\(/) {
25168b6ee9aeSStefan Hajnoczi			ERROR("use ctz32() instead of ffs()\n" . $herecurr);
25178b6ee9aeSStefan Hajnoczi		}
25188b6ee9aeSStefan Hajnoczi		if ($line =~ /\bffsl\(/) {
25198b6ee9aeSStefan Hajnoczi			ERROR("use ctz32() or ctz64() instead of ffsl()\n" . $herecurr);
25208b6ee9aeSStefan Hajnoczi		}
25218b6ee9aeSStefan Hajnoczi		if ($line =~ /\bffsll\(/) {
25228b6ee9aeSStefan Hajnoczi			ERROR("use ctz64() instead of ffsll()\n" . $herecurr);
25238b6ee9aeSStefan Hajnoczi		}
25241ec3f6f9SBlue Swirl	}
25251ec3f6f9SBlue Swirl
25261ec3f6f9SBlue Swirl	# If we have no input at all, then there is nothing to report on
25271ec3f6f9SBlue Swirl	# so just keep quiet.
25281ec3f6f9SBlue Swirl	if ($#rawlines == -1) {
25291ec3f6f9SBlue Swirl		exit(0);
25301ec3f6f9SBlue Swirl	}
25311ec3f6f9SBlue Swirl
25321ec3f6f9SBlue Swirl	# In mailback mode only produce a report in the negative, for
25331ec3f6f9SBlue Swirl	# things that appear to be patches.
25341ec3f6f9SBlue Swirl	if ($mailback && ($clean == 1 || !$is_patch)) {
25351ec3f6f9SBlue Swirl		exit(0);
25361ec3f6f9SBlue Swirl	}
25371ec3f6f9SBlue Swirl
25381ec3f6f9SBlue Swirl	# This is not a patch, and we are are in 'no-patch' mode so
25391ec3f6f9SBlue Swirl	# just keep quiet.
25401ec3f6f9SBlue Swirl	if (!$chk_patch && !$is_patch) {
25411ec3f6f9SBlue Swirl		exit(0);
25421ec3f6f9SBlue Swirl	}
25431ec3f6f9SBlue Swirl
25441ec3f6f9SBlue Swirl	if (!$is_patch) {
25451ec3f6f9SBlue Swirl		ERROR("Does not appear to be a unified-diff format patch\n");
25461ec3f6f9SBlue Swirl	}
25471ec3f6f9SBlue Swirl	if ($is_patch && $chk_signoff && $signoff == 0) {
25481ec3f6f9SBlue Swirl		ERROR("Missing Signed-off-by: line(s)\n");
25491ec3f6f9SBlue Swirl	}
25501ec3f6f9SBlue Swirl
25511ec3f6f9SBlue Swirl	print report_dump();
25521ec3f6f9SBlue Swirl	if ($summary && !($clean == 1 && $quiet == 1)) {
25531ec3f6f9SBlue Swirl		print "$filename " if ($summary_file);
25541ec3f6f9SBlue Swirl		print "total: $cnt_error errors, $cnt_warn warnings, " .
25551ec3f6f9SBlue Swirl			(($check)? "$cnt_chk checks, " : "") .
25561ec3f6f9SBlue Swirl			"$cnt_lines lines checked\n";
25571ec3f6f9SBlue Swirl		print "\n" if ($quiet == 0);
25581ec3f6f9SBlue Swirl	}
25591ec3f6f9SBlue Swirl
25601ec3f6f9SBlue Swirl	if ($quiet == 0) {
25611ec3f6f9SBlue Swirl		# If there were whitespace errors which cleanpatch can fix
25621ec3f6f9SBlue Swirl		# then suggest that.
2563b6469683SBlue Swirl#		if ($rpt_cleaners) {
2564b6469683SBlue Swirl#			print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
2565b6469683SBlue Swirl#			print "      scripts/cleanfile\n\n";
2566b6469683SBlue Swirl#		}
25671ec3f6f9SBlue Swirl	}
25681ec3f6f9SBlue Swirl
25691ec3f6f9SBlue Swirl	if ($clean == 1 && $quiet == 0) {
25701ec3f6f9SBlue Swirl		print "$vname has no obvious style problems and is ready for submission.\n"
25711ec3f6f9SBlue Swirl	}
25721ec3f6f9SBlue Swirl	if ($clean == 0 && $quiet == 0) {
25731ec3f6f9SBlue Swirl		print "$vname has style problems, please review.  If any of these errors\n";
25741ec3f6f9SBlue Swirl		print "are false positives report them to the maintainer, see\n";
25751ec3f6f9SBlue Swirl		print "CHECKPATCH in MAINTAINERS.\n";
25761ec3f6f9SBlue Swirl	}
25771ec3f6f9SBlue Swirl
25781ec3f6f9SBlue Swirl	return $clean;
25791ec3f6f9SBlue Swirl}
2580