3 # Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
4 # Copyright Siemens AG 2019-2020
6 # Licensed under the Apache License 2.0 (the "License").
7 # You may not use this file except in compliance with the License.
8 # You can obtain a copy in the file LICENSE in the source distribution
9 # or at https://www.openssl.org/source/license.html
12 # - check formatting of C source according to OpenSSL coding style
15 # check-format.pl [-l|--sloppy-len] [-l|--sloppy-bodylen]
16 # [-s|--sloppy-spc] [-c|--sloppy-cmt]
17 # [-m|--sloppy-macro] [-h|--sloppy-hang]
18 # [-e|--extra-spc] [-1|--1-stmt]
22 # util/check-format.pl util/check-format-test-positives.c
23 # util/check-format.pl util/check-format-test-negatives.c
25 # checks adherence to the formatting rules of the OpenSSL coding guidelines
26 # assuming that the input files contain syntactically correct C code.
27 # This pragmatic tool is incomplete and yields some false positives.
28 # Still it should be useful for detecting most typical glitches.
31 # -l | --sloppy-len increase accepted max line length from 80 to 84
32 # -l | --sloppy-bodylen do not report function body length > 200
33 # -s | --sloppy-spc do not report whitespace nits
34 # -c | --sloppy-cmt do not report indentation of comments
35 # Otherwise for each multi-line comment the indentation of
36 # its lines is checked for consistency. For each comment
37 # that does not begin to the right of normal code its
38 # indentation must be as for normal code, while in case it
39 # also has no normal code to its right it is considered to
40 # refer to the following line and may be indented equally.
41 # -m | --sloppy-macro allow missing extra indentation of macro bodies
42 # -h | --sloppy-hang when checking hanging indentation, do not report
43 # * same indentation as on line before
44 # * same indentation as non-hanging indent level
45 # * indentation moved left (not beyond non-hanging indent)
46 # just to fit contents within the line length limit
47 # -e | --extra-spc report needless intermediate multiple consecutive spaces
48 # -1 | --1-stmt do more aggressive checks for { 1 stmt } - see below
50 # There are non-trivial false positives and negatives such as the following.
52 # * When a line contains several issues of the same kind only one is reported.
54 # * When a line contains more than one statement this is (correctly) reported
55 # but in some situations the indentation checks for subsequent lines go wrong.
57 # * There is the special OpenSSL rule not to unnecessarily use braces around
62 # except within if ... else constructs where some branch contains more than one
63 # statement. Since the exception is hard to recognize when such branches occur
64 # after the current position (such that false positives would be reported)
65 # the tool by checks for this rule by defaul only for do/while/for bodies.
66 # Yet with the --1-stmt option false positives are preferred over negatives.
67 # False negatives occur if the braces are more than two non-empty lines apart.
69 # * When the -e or --extra-spc option if given, the presence of
70 # multiple consecutive spaces is regarded a coding style nit
71 # except when done in order to align certain columns over multiple lines, e.g.:
75 # This pattern is recognized - and consequently extra space not reported -
76 # for a given line if in the nonempty line before or after (if existing)
77 # for each occurrence of " \S" (where \S means non-space) in the given line
78 # there is " \S" in the other line in the respective column position.
79 # This may lead to both false negatives (in case of coincidental " \S")
80 # and false positives (in case of more complex multi-column alignment).
82 # * When just part of control structures depend on #if(n)(def), which can be
83 # considered bad programming style, indentation false positives occur, e.g.:
85 # if (1) /* bad style */
87 # if (2) /* bad style resulting in false positive */
89 # c; /* resulting further false positive */
92 # use List::Util qw[min max];
95 use constant INDENT_LEVEL => 4;
96 use constant MAX_LINE_LENGTH => 80;
97 use constant MAX_BODY_LENGTH => 200;
99 # global variables @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
101 # command-line options
102 my $max_length = MAX_LINE_LENGTH;
103 my $sloppy_bodylen = 0;
107 my $sloppy_macro = 0;
109 my $extended_1_stmt = 0;
111 while ($ARGV[0] =~ m/^-(\w|-[\w\-]+)$/) {
113 if ($arg =~ m/^(l|-sloppy-len)$/) {
114 $max_length += INDENT_LEVEL;
115 } elsif ($arg =~ m/^(b|-sloppy-bodylen)$/) {
117 } elsif ($arg =~ m/^(s|-sloppy-spc)$/) {
119 } elsif ($arg =~ m/^(c|-sloppy-cmt)$/) {
121 } elsif ($arg =~ m/^(m|-sloppy-macro)$/) {
123 } elsif ($arg =~ m/^(h|-sloppy-hang)$/) {
125 } elsif ($arg =~ m/^(e|-extra-spc)$/) {
127 } elsif ($arg =~ m/^(1|-1-stmt)$/) {
128 $extended_1_stmt = 1;
130 die("unknown option: -$arg");
135 my $self_test; # whether the current input file is regarded to contain (positive/negative) self-tests
136 my $line; # current line number
137 my $line_before; # number of previous not essentially empty line (containing at most whitespace and '\')
138 my $line_before2; # number of not essentially empty line before previous not essentially empty line
139 my $contents; # contents of current line
140 my $contents_before; # contents of $line_before, if $line_before > 0
141 my $contents_before_; # contents of $line_before after blinding comments etc., if $line_before > 0
142 my $contents_before2; # contents of $line_before2, if $line_before2 > 0
143 my $contents_before_2; # contents of $line_before2 after blinding comments etc., if $line_before2 > 0
144 my $in_multiline_string; # line starts within multi-line string literal
145 my $count; # -1 or number of leading whitespace characters (except newline) in current line,
146 # which should be $block_indent + $hanging_offset + $local_offset or $expr_indent
147 my $count_before; # number of leading whitespace characters (except line ending chars) in $contents_before
148 my $has_label; # current line contains label
149 my $local_offset; # current extra indent due to label, switch case/default, or leading closing brace(s)
150 my $line_body_start; # number of line where last function body started, or 0
151 my $line_function_start; # number of line where last function definition started, used if $line_body_start != 0
152 my $last_function_header; # header containing name of last function defined, used if $line_function_start != 0
153 my $line_opening_brace; # number of previous line with opening brace after do/while/for, optionally for if/else
155 my $keyword_opening_brace; # name of previous keyword, used if $line_opening_brace != 0
156 my $ifdef__cplusplus; # line before contained '#ifdef __cplusplus' (used in header files)
157 my $block_indent; # currently required normal indentation at block/statement level
158 my $hanging_offset; # extra indent, which may be nested, for just one hanging statement or expr or typedef
159 my @in_do_hanging_offsets; # stack of hanging offsets for nested 'do' ... 'while'
160 my @in_if_hanging_offsets; # stack of hanging offsets for nested 'if' (but not its potential 'else' branch)
161 my $if_maybe_terminated; # 'if' ends and $hanging_offset should be reset unless the next line starts with 'else'
162 my @nested_block_indents; # stack of indentations at block/statement level, needed due to hanging statements
163 my @nested_hanging_offsets;# stack of nested $hanging_offset values, in parallel to @nested_block_indents
164 my @nested_in_typedecl; # stack of nested $in_typedecl values, partly in parallel to @nested_block_indents
165 my @nested_indents; # stack of hanging indents due to parentheses, braces, brackets, or conditionals
166 my @nested_symbols; # stack of hanging symbols '(', '{', '[', or '?', in parallel to @nested_indents
167 my @nested_conds_indents; # stack of hanging indents due to conditionals ('?' ... ':')
168 my $expr_indent; # resulting hanging indent within (multi-line) expressions including type exprs, else 0
169 my $hanging_symbol; # character ('(', '{', '[', not: '?') responsible for $expr_indent, if $expr_indent != 0
170 my $in_expr; # in expression after if/while/for/switch/return/enum/LHS of assignment
171 my $in_paren_expr; # in parenthesized if/while/for condition and switch expression, if $expr_indent != 0
172 my $in_typedecl; # nesting level of typedef/struct/union/enum
173 my $in_directive; # number of lines so far within preprocessor directive, e.g., macro definition
174 my $directive_nesting; # currently required indentation of preprocessor directive according to #if(n)(def)
175 my $directive_offset; # indent offset within multi-line preprocessor directive, if $in_directive > 0
176 my $in_macro_header; # number of open parentheses + 1 in (multi-line) header of #define, if $in_directive > 0
177 my $in_comment; # number of lines so far within multi-line comment, or < 0 when end is on current line
178 my $leading_comment; # multi-line comment has no code before its beginning delimiter
179 my $formatted_comment; # multi-line comment beginning with "/*-", which indicates/allows special formatting
180 my $comment_indent; # comment indent, if $in_comment != 0
181 my $num_reports_line = 0; # number of issues found on current line
182 my $num_reports = 0; # total number of issues found
183 my $num_indent_reports = 0;# total number of indentation issues found
184 my $num_nesting_issues = 0;# total number of directive nesting issues found
185 my $num_syntax_issues = 0; # total number of syntax issues found during sanity checks
186 my $num_SPC_reports = 0; # total number of whitespace issues found
187 my $num_length_reports = 0;# total number of line length issues found
189 sub reset_file_state {
193 @nested_block_indents = ();
194 @nested_hanging_offsets = ();
195 @nested_in_typedecl = ();
196 @nested_symbols = ();
197 @nested_indents = ();
198 @nested_conds_indents = ();
203 @in_do_hanging_offsets = ();
204 @in_if_hanging_offsets = ();
205 $if_maybe_terminated = 0;
207 $ifdef__cplusplus = 0;
208 $in_multiline_string = 0;
209 $line_body_start = 0;
210 $line_opening_brace = 0;
213 $directive_nesting = 0;
217 # auxiliary submodules @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
219 sub report_flexibly {
222 my $contents = shift;
223 my $report_SPC = $msg =~ /SPC/;
224 return if $report_SPC && $sloppy_SPC;
226 print "$ARGV:$line:$msg:$contents" unless $self_test;
229 $num_indent_reports++ if $msg =~ m/indent/;
230 $num_nesting_issues++ if $msg =~ m/directive nesting/;
231 $num_syntax_issues++ if $msg =~ m/unclosed|unexpected/;
232 $num_SPC_reports++ if $report_SPC;
233 $num_length_reports++ if $msg =~ m/length/;
238 report_flexibly($line, $msg, $contents);
241 sub parens_balance { # count balance of opening parentheses - closing parentheses
243 return $str =~ tr/\(// - $str =~ tr/\)//;
246 sub blind_nonspace { # blind non-space text of comment as @, preserving length and spaces
247 # the @ character is used because it cannot occur in normal program code so there is no confusion
248 # comment text is not blinded to whitespace in order to be able to check extra SPC also in comments
249 my $comment_text = shift;
250 $comment_text =~ s/([\.\?\!])\s\s/$1. /g; # in extra SPC checks allow one extra SPC after period '.', '?', or '!' in comments
251 return $comment_text =~ tr/ /@/cr;
254 # submodule for indentation checking/reporting @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
256 sub check_indent { # used for lines outside multi-line string literals
257 my $stmt_indent = $block_indent + $hanging_offset + $local_offset;
258 $stmt_indent = 0 if $stmt_indent < 0; # TODO maybe give warning/error
259 my $stmt_desc = $contents =~
260 m/^\s*\/\*/ ? "intra-line comment" :
261 $has_label ? "label" :
262 ($hanging_offset != 0 ? "hanging " : "").
263 ($hanging_offset != 0 ? "stmt/expr" : "stmt/decl"); # $in_typedecl is not fully to the point here
264 my ($ref_desc, $ref_indent) = $expr_indent == 0 ? ($stmt_desc, $stmt_indent)
265 : ("hanging '$hanging_symbol'", $expr_indent);
266 my ($alt_desc, $alt_indent) = ("", $ref_indent);
268 # allow indent 1 for labels - this cannot happen for leading ':'
269 ($alt_desc, $alt_indent) = ("outermost position", 1) if $expr_indent == 0 && $has_label;
271 if (@nested_conds_indents != 0 && substr($_, $count, 1) eq ":") {
272 # leading ':' within stmt/expr/decl - this cannot happen for labels, leading '&&', or leading '||'
273 # allow special indent at level of corresponding "?"
274 ($alt_desc, $alt_indent) = ("leading ':'", @nested_conds_indents[-1]);
276 # allow extra indent offset leading '&&' or '||' - this cannot happen for leading ":"
277 ($alt_desc, $alt_indent) = ("leading '$1'", $ref_indent + INDENT_LEVEL) if $contents =~ m/^[\s@]*(\&\&|\|\|)/;
279 if ($expr_indent < 0) { # implies @nested_symbols != 0 && @nested_symbols[0] eq "{" && @nested_indents[-1] < 0
280 # allow normal stmt indentation level for hanging initializer/enum expressions after trailing '{'
281 # this cannot happen for labels and overrides special treatment of ':', '&&' and '||' for this line
282 ($alt_desc, $alt_indent) = ("lines after '{'", $stmt_indent);
283 # decide depending on current actual indentation, preventing forth and back
284 @nested_indents[-1] = $count == $stmt_indent ? $stmt_indent : -@nested_indents[-1]; # allow $stmt_indent
285 $ref_indent = $expr_indent = @nested_indents[-1];
288 # check consistency of indentation within multi-line comment (i.e., between its first, inner, and last lines)
289 if ($in_comment != 0 && $in_comment != 1) { # in multi-line comment but not on its first line
291 if ($in_comment > 0) { # not at its end
292 report("indent = $count != $comment_indent within multi-line comment")
293 if $count != $comment_indent;
295 my $tweak = $in_comment == -2 ? 1 : 0;
296 report("indent = ".($count + $tweak)." != $comment_indent at end of multi-line comment")
297 if $count + $tweak != $comment_indent;
300 # do not check indentation of last line of non-leading multi-line comment
301 if ($in_comment < 0 && !$leading_comment) {
302 s/^(\s*)@/$1*/; # blind first '@' as '*' to prevent below delayed check for the line before
305 return if $in_comment > 0; # not on its last line
306 # $comment_indent will be checked by the below checks for end of multi-line comment
309 # else check indentation of entire-line comment or entire-line end of multi-line comment
310 # ... w.r.t. indent of the following line by delayed check for the line before
311 if (($in_comment == 0 || $in_comment == 1) # no comment, intra-line comment, or begin of multi-line comment
312 && $line_before > 0 # there is a line before
313 && $contents_before_ =~ m/^(\s*)@[\s@]*$/) { # line before begins with '@', no code follows (except '\')
314 report_flexibly($line_before, "entire-line comment indent = $count_before != $count (of following line)",
315 $contents_before) if !$sloppy_cmt && $count_before != $count;
317 # ... but allow normal indentation for the current line, else above check will be done for the line before
318 if (($in_comment == 0 || $in_comment < 0) # (no commment,) intra-line comment or end of multi-line comment
319 && m/^(\s*)@[\s@]*$/) { # line begins with '@', no code follows (except '\')
320 if ($count == $ref_indent) { # indentation is like for (normal) code in this line
321 s/^(\s*)@/$1*/; # blind first '@' as '*' to prevent above delayed check for the line before
324 return if !eof; # defer check of entire-line comment to next line
327 # else check indentation of leading intra-line comment or end of multi-line comment
328 if (m/^(\s*)@/) { # line begins with '@', i.e., any (remaining type of) comment
329 if (!$sloppy_cmt && $count != $ref_indent) {
330 report("intra-line comment indent = $count != $ref_indent") if $in_comment == 0;
331 report("multi-line comment indent = $count != $ref_indent") if $in_comment < 0;
336 if ($sloppy_hang && ($hanging_offset != 0 || $expr_indent != 0)) {
337 # do not report same indentation as on the line before (potentially due to same violations)
338 return if $line_before > 0 && $count == $count_before;
340 # do not report indentation at normal indentation level while hanging expression indent would be required
341 return if $expr_indent != 0 && $count == $stmt_indent;
343 # do not report if contents have been shifted left of nested expr indent (but not as far as stmt indent)
344 # apparently aligned to the right in order to fit within line length limit
345 return if $stmt_indent < $count && $count < $expr_indent &&
346 length($contents) == MAX_LINE_LENGTH + length("\n");
349 report("indent = $count != $ref_indent for $ref_desc".
351 || $alt_indent == $ref_indent # prevent showing alternative that happens to have equal value
352 ? "" : " or $alt_indent for $alt_desc"))
353 if $count != $ref_indent && $count != $alt_indent;
356 # submodules handling indentation within expressions @@@@@@@@@@@@@@@@@@@@@@@@@@@
358 sub update_nested_indents { # may reset $in_paren_expr and in this case also resets $in_expr
360 my $start = shift; # defaults to 0
361 my $terminator_position = -1;
362 for (my $i = $start; $i < length($str); $i++) {
364 my $curr = substr($str, $i);
365 if ($curr =~ m/^(.*?)([{}()?:;\[\]])(.*)$/) { # match from position $i the first {}()?:;[]
370 my ($head, $tail) = (substr($str, 0, $i).$1, $3);
371 $i += length($1) + length($2) - 1;
373 # stop at terminator outside 'for(..;..;..)', assuming that 'for' is followed by '('
374 return $i if $c eq ";" && (!$in_paren_expr || @nested_indents == 0);
376 my $in_stmt = $in_expr || @nested_symbols != 0; # not: || $in_typedecl != 0
377 if ($c =~ m/[{([?]/) { # $c is '{', '(', '[', or '?'
378 if ($c eq "{") { # '{' in any context
379 # cancel newly hanging_offset if opening brace '{' is after non-whitespace non-comment:
380 $hanging_offset -= INDENT_LEVEL if $hanging_offset > 0 && $head =~ m/[^\s\@]/;
381 push @nested_block_indents, $block_indent;
382 push @nested_hanging_offsets, $in_expr ? $hanging_offset : 0;
383 push @nested_in_typedecl, $in_typedecl if $in_typedecl != 0;
384 $block_indent += INDENT_LEVEL + $hanging_offset;
387 if ($c ne "{" || $in_stmt) { # for '{' inside stmt/expr (not: decl), for '(', '[', or '?' anywhere
388 $tail =~ m/^([\s@]*)([^\s\@])/;
389 push @nested_indents, defined $2
390 ? $i + 1 + length($1) # actual indentation of following non-space non-comment
391 : $c ne "{" ? +($i + 1) # just after '(' or '[' if only whitespace thereafter
392 : -($i + 1); # allow also $stmt_indent if '{' with only whitespace thereafter
393 push @nested_symbols, $c; # done also for '?' to be able to check correct nesting
394 push @nested_conds_indents, $i if $c eq "?"; # remember special alternative indent for ':'
396 } elsif ($c =~ m/[})\]:]/) { # $c is '}', ')', ']', or ':'
397 my $opening_c = ($c =~ tr/})]:/{([/r);
398 if (($c ne ":" || $in_stmt # ignore ':' outside stmt/expr/decl
399 # in the presence of ':', one could add this sanity check:
400 # && !(# ':' after initial label/case/default
401 # $head =~ m/^([\s@]*)(case\W.*$|\w+$)/ || # this matching would not work for
402 # # multi-line expr after 'case'
403 # # bitfield length within unsigned type decl
404 # $tail =~ m/^[\s@]*\d+/ # this matching would need improvement
407 if ($c ne "}" || $in_stmt) { # for '}' inside stmt/expr/decl, ')', ']', or ':'
408 if (@nested_symbols != 0 &&
409 @nested_symbols[-1] == $opening_c) { # for $c there was a corresponding $opening_c
412 pop @nested_conds_indents if $opening_c eq "?";
414 report("unexpected '$c' @ ".($in_paren_expr ? "(expr)" : "expr"));
418 if ($c eq "}") { # '}' at block level but also inside stmt/expr/decl
419 if (@nested_block_indents == 0) {
420 report("unexpected '}'");
422 $block_indent = pop @nested_block_indents;
423 $hanging_offset = pop @nested_hanging_offsets;
424 $in_typedecl = pop @nested_in_typedecl if @nested_in_typedecl != 0;
427 if ($in_paren_expr && !grep(/\(/, @nested_symbols)) { # end of (expr)
428 check_nested_nonblock_indents("(expr)");
429 $in_paren_expr = $in_expr = 0;
430 report("code after (expr)")
431 if $tail =~ m/^([^{]*)/ && $1 =~ m/[^\s\@;]/; # non-space non-';' before any '{'
439 sub check_nested_nonblock_indents {
440 my $position = shift;
441 while (@nested_symbols != 0) {
442 my $symbol = pop @nested_symbols;
443 report("unclosed '$symbol' in $position");
444 if ($symbol eq "{") { # repair stack of blocks
445 $block_indent = pop @nested_block_indents;
446 $hanging_offset = pop @nested_hanging_offsets;
447 $in_typedecl = pop @nested_in_typedecl if @nested_in_typedecl != 0;
450 @nested_indents = ();
451 @nested_conds_indents = ();
454 # start of main program @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
458 while (<>) { # loop over all lines of all input files
459 $self_test = $ARGV =~ m/check-format-test/;
461 s/\r$//; # strip any trailing CR '\r' (which are typical on Windows systems)
464 # check for illegal characters
465 if (m/(.*?)([\x00-\x09\x0B-\x1F\x7F-\xFF])/) {
466 my $col = length($1);
467 report(($2 eq "\x09" ? "TAB" : $2 eq "\x0D" ? "CR " : $2 =~ m/[\x00-\x1F]/ ? "non-printable"
468 : "non-7bit char") . " at column $col") ;
471 # check for whitespace at EOL
472 report("trailing whitespace at EOL") if m/\s\n$/;
474 # assign to $count the actual indentation level of the current line
475 chomp; # remove trailing NL '\n'
477 $count = length($1); # actual indentation
481 # character/string literals @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
483 s/\\["']/@@/g; # blind all '"' and "'" escaped by '\' (typically within character literals or string literals)
485 # handle multi-line string literals to avoid confusion on starting/ending '"' and trailing '\'
486 if ($in_multiline_string) {
487 if (s#^([^"]*)"#($1 =~ tr/"/@/cr).'@'#e) { # string literal terminated by '"'
488 # string contents and its terminating '"' have been blinded as '@'
489 $count = -1; # do not check indentation
491 report("multi-line string literal not terminated by '\"' and trailing '\' is missing")
492 unless s#^([^\\]*)\s*\\\s*$#$1#; # strip trailing '\' plus any whitespace around
497 # blind contents of character and string literals as @, preserving length (but not spaces)
498 # this prevents confusing any of the matching below, e.g., of whitespace and comment delimiters
499 s#('[^']*')#$1 =~ tr/'/@/cr#eg; # handle all intra-line character literals
500 s#("[^"]*")#$1 =~ tr/"/@/cr#eg; # handle all intra-line string literals
501 $in_multiline_string = # handle trailing string literal terminated by '\'
502 s#^(([^"]*"[^"]*")*[^"]*)("[^"]*)\\(\s*)$#$1.($3 =~ tr/"/@/cr).'"'.$4#e;
503 # its contents have been blinded and the trailing '\' replaced by '"'
505 # strip any other trailing '\' along with any whitespace around it such that it does not interfere with various
506 # matching below; the later handling of multi-line macro definitions uses $contents where it is not stripped
507 s#^(.*?)\s*\\\s*$#$1#; # trailing '\' possibly preceded and/or followed by whitespace
509 # comments @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
511 # do/prepare checks within multi-line comments
512 my $self_test_exception = $self_test ? "@" : "";
513 if ($in_comment > 0) { # this still includes the last line of multi-line commment
514 my ($head, $any_symbol, $cmt_text) = m/^(\s*)(.?)(.*)$/;
515 if ($any_symbol eq "*") {
516 report("no SPC after leading '*' in multi-line comment") if $cmt_text =~ m|^[^/\s$self_test_exception]|;
518 report("no leading '*' in multi-line comment");
523 # detect end of comment, must be within multi-line comment, check if it is preceded by non-whitespace text
524 if ((my ($head, $tail) = m|^(.*?)\*/(.*)$|) && $1 ne '/') { # ending comment: '*/'
525 report("neither SPC nor '*' before '*/'") if $head =~ m/[^*\s]$/;
526 report("no SPC after '*/'") if $tail =~ m/^[^\s,;)}\]]/; # no space or ,;)}] after '*/'
527 if (!($head =~ m|/\*|)) { # not begin of comment '/*', which is is handled below
528 if ($in_comment == 0) {
529 report("unexpected '*/' outside comment");
530 $_ = "$head@@".$tail; # blind the "*/"
532 report("text before '*/' in multi-line comment") if ($head =~ m/\S/); # non-SPC before '*/'
533 $in_comment = -1; # indicate that multi-line comment ends on current line
535 # make indentation of end of multi-line comment appear like of leading intra-line comment
536 $head =~ s/^(\s*)\s/$1@/; # replace the last leading space by '@'
538 $in_comment = -2; # indicate that multi-line comment ends on current line, with tweak
540 my $cmt_text = $head;
541 $_ = blind_nonspace($cmt_text)."@@".$tail;
546 # detect begin of comment, check if it is followed by non-space text
548 if (my ($head, $opt_minus, $tail) = m|^(.*?)/\*(-?)(.*)$|) { # begin of comment: '/*'
549 report("no SPC before '/*'")
550 if $head =~ m/[^\s(\*]$/; # not space, '(', or or '*' (needed to allow '*/') before comment delimiter
551 report("neither SPC nor '*' after '/*' or '/*-'") if $tail =~ m/^[^\s*$self_test_exception]/;
552 my $cmt_text = $opt_minus.$tail; # preliminary
553 if ($in_comment > 0) {
554 report("unexpected '/*' inside multi-line comment");
555 } elsif ($tail =~ m|^(.*?)\*/(.*)$|) { # comment end: */ on same line
556 report("unexpected '/*' inside intra-line comment") if $1 =~ /\/\*/;
557 # blind comment text, preserving length and spaces
558 ($cmt_text, my $rest) = ($opt_minus.$1, $2);
559 $_ = "$head@@".blind_nonspace($cmt_text)."@@".$rest;
561 } else { # begin of multi-line comment
562 my $self_test_exception = $self_test ? "(@\d?)?" : "";
563 report("text after '/*' in multi-line comment")
564 unless $tail =~ m/^$self_test_exception.?\s*$/;
565 # tail not essentially empty, first char already checked
566 # adapt to actual indentation of first line
567 $comment_indent = length($head) + 1;
568 $_ = "$head@@".blind_nonspace($cmt_text);
570 $leading_comment = $head =~ m/^\s*$/; # there is code before beginning delimiter
571 $formatted_comment = $opt_minus eq "-";
575 if ($in_comment > 1) { # still inside multi-line comment (not at its begin or end)
576 m/^(\s*)\*?(\s*)(.*)$/;
577 $_ = $1."@".$2.blind_nonspace($3);
580 # handle special case of line after '#ifdef __cplusplus' (which typically appears in header files)
581 if ($ifdef__cplusplus) {
582 $ifdef__cplusplus = 0;
583 $_ = "$1 $2" if $contents =~ m/^(\s*extern\s*"C"\s*)\{(\s*)$/; # ignore opening brace in 'extern "C" {'
584 goto LINE_FINISHED if m/^\s*\}\s*$/; # ignore closing brace '}'
587 # check for over-long lines,
588 # while allowing trailing (also multi-line) string literals to go past $max_length
589 my $len = length; # total line length (without trailing '\n')
590 if ($len > $max_length &&
591 !(m/^(.*)"[^"]*"\s*[\)\}\]]*[,;]?\s*$/ # string literal terminated by '"' (or '\'), then maybe )}],;
592 && length($1) < $max_length)
593 # this allows over-long trailing string literals with beginning col before $max_length
595 report("line length = $len > ".MAX_LINE_LENGTH);
598 # handle C++ / C99 - style end-of-line comments
599 if (my ($head, $cmt_text) = m|^(.*?)//(.*$)|) {
600 report("'//' end-of-line comment"); # the '//' comment style is not allowed for C90
601 # blind comment text, preserving length and spaces
602 $_ = "$head@@".blind_nonspace($cmt_text);
605 # at this point all non-space portions of any types of comments have been blinded as @
607 goto LINE_FINISHED if m/^\s*$/; # essentially empty line: just whitespace (and maybe a trailing '\')
609 # intra-line whitespace nits @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
611 my $in_multiline_comment = ($in_comment > 1 || $in_comment < 0); # $in_multiline_comment refers to line before
612 if (!$sloppy_SPC && !($in_multiline_comment && $formatted_comment)) {
614 my $intra_line = shift;
615 return "extra SPC".($intra_line =~ m/@\s\s/ ?
616 $in_comment != 0 ? " in multi-line comment"
617 : " in intra-line comment" : "");
619 sub split_line_head {
621 $in_comment != 0 ? "@" : ""; # '@' will match the blinded leading '*' in multi-line comment
622 # $in_comment may pertain to the following line due to delayed check
623 # do not check for extra SPC in leading spaces including any '#' (or '*' within multi-line comment)
624 shift =~ m/^(\s*([#$comment_symbol]\s*)?)(.*?)\s*$/;
627 my ($head , $intra_line ) = split_line_head($_);
628 my ($head1, $intra_line1) = split_line_head($contents_before_ ) if $line_before > 0;
629 my ($head2, $intra_line2) = split_line_head($contents_before_2) if $line_before2 > 0;
630 if ($extra_spc && $line_before > 0) { # check with one line delay, such that at least $contents_before is available
631 sub column_alignments_only {
634 my $contents = shift;
635 # check if all extra SPC in $intra is used only for multi-line column alignment with $contents
636 my $offset = length($head);
637 for (my $col = 0; $col < length($intra) - 2; $col++) {
638 return 0 if substr($intra , $col, 3) =~ m/\s\s\S/ # extra SPC (after leading space)
639 && !(substr($contents, $col + $offset + 1, 2) =~ m/\s\S/)
643 report_flexibly($line_before, extra_SPC($intra_line1), $contents_before) if $intra_line1 =~ m/\s\s\S/ &&
644 !( column_alignments_only($head1, $intra_line1, $_ ) # compare with $line
645 || ($line_before2 > 0 &&
646 column_alignments_only($head1, $intra_line1, $contents_before_2))); # compare w/ $line_before2
647 report(extra_SPC($intra_line)) if $intra_line =~ m/\s\s\S/ && eof
648 && ! column_alignments_only($head , $intra_line , $contents_before_ ) ; # compare w/ $line_before
649 } elsif (eof) { # special case: just one line exists
650 report(extra_SPC($intra_line)) if $intra_line =~ m/\s\s\S/;
652 # ignore paths in #include
653 $intra_line =~ s/^(include\s*)(".*?"|<.*?>)/$1/e if $head =~ m/#/;
654 # treat op= and comparison operators as simple '=', simplifying matching below
655 $intra_line =~ s/([\+\-\*\/\/%\&\|\^\!<>=]|<<|>>)=/=/g;
656 # treat (type) variables within macro, indicated by trailing '\', as 'int' simplifying matching below
657 $intra_line =~ s/[A-Z_]+/int/g if $contents =~ m/^(.*?)\s*\\\s*$/;
658 # treat double &&, ||, <<, and >> as single ones, simplifying matching below
659 $intra_line =~ s/(&&|\|\||<<|>>)/substr($1, 0, 1)/eg;
660 # remove blinded comments etc. directly after [{(
661 while ($intra_line =~ s/([\[\{\(])@+\s?/$1/e) {} # /g does not work here
662 # remove blinded comments etc. directly before ,;)}]
663 while ($intra_line =~ s/\s?@+([,;\)\}\]])/$1/e) {} # /g does not work here
664 # treat remaining blinded comments and string literal contents as (single) space during matching below
665 $intra_line =~ s/@+/ /g; # note that extra SPC has already been handled above
666 $intra_line =~ s/\s+$//; # strip any (resulting) space at EOL
667 $intra_line =~ s/(for\s*\([^;]*);;(\))/"$1$2"/eg; # strip trailing ';;' in for (;;)
668 $intra_line =~ s/(for\s*\([^;]+;[^;]+);(\))/"$1$2"/eg; # strip trailing ';' in for (;;)
669 $intra_line =~ s/(=\s*)\{ /"$1@ "/eg; # do not report {SPC in initializers such as ' = { 0, };'
670 $intra_line =~ s/, \};/, @;/g; # do not report SPC} in initializers such as ' = { 0, };'
671 report("SPC before '$1'") if $intra_line =~ m/[\w)\]]\s+(\+\+|--)/; # postfix ++/-- with preceding space
672 report("SPC after '$1'") if $intra_line =~ m/(\+\+|--)\s+[a-zA-Z_(]/; # prefix ++/-- with following space
673 $intra_line =~ s/\.\.\./@/g; # blind '...'
674 report("SPC before '$1'") if $intra_line =~ m/\s(\.|->)/; # '.' or '->' with preceding space
675 report("SPC after '$1'") if $intra_line =~ m/(\.|->)\s/; # '.' or '->' with following space
676 $intra_line =~ s/\-\>|\+\+|\-\-/@/g; # blind '->,', '++', and '--'
677 report("SPC before '$2'") if $intra_line =~ m/[^:]\s+(;)/; # space before ';' but not after ':'
678 report("SPC before '$1'") if $intra_line =~ m/\s([,)\]])/; # space before ,)]
679 report("SPC after '$1'") if $intra_line =~ m/([(\[~!])\s/; # space after ([~!
680 report("SPC after '$1'") if $intra_line =~ m/(defined)\s/; # space after 'defined'
681 report("no SPC before '=' or '<op>='") if $intra_line =~ m/\S(=)/; # '=' etc. without preceding space
682 report("no SPC before '$1'") if $intra_line =~ m/\S([|\/%<>^\?])/; # |/%<>^? without preceding space
683 # TODO ternary ':' without preceding SPC, while allowing no SPC before ':' after 'case'
684 report("no SPC before binary '$1'") if $intra_line =~ m/[^\s{()\[]([+\-])/;# +/- without preceding space or {()[
685 # or ')' (which is used f type casts)
686 report("no SPC before binary '$1'") if $intra_line =~ m/[^\s{()\[*!]([*])/; # '*' without preceding space or {()[*!
687 report("no SPC before binary '$1'") if $intra_line =~ m/[^\s{()\[]([&])/; # '&' without preceding space or {()[
688 report("no SPC after ternary '$1'") if $intra_line =~ m/(:)[^\s\d]/; # ':' without following space or digit
689 report("no SPC after '$1'") if $intra_line =~ m/([,;=|\/%<>^\?])\S/; # ,;=|/%<>^? without following space
690 report("no SPC after binary '$1'") if $intra_line=~m/[^{(\[]([*])[^\sa-zA-Z_(),*]/;# '*' w/o space or \w(),* after
691 # TODO unary '*' must not be followed by SPC
692 report("no SPC after binary '$1'") if $intra_line=~m/([&])[^\sa-zA-Z_(]/; # '&' w/o following space or \w(
693 # TODO unary '&' must not be followed by SPC
694 report("no SPC after binary '$1'") if $intra_line=~m/[^{(\[]([+\-])[^\s\d(]/; # +/- w/o following space or \d(
695 # TODO unary '+' and '-' must not be followed by SPC
696 report("no SPC after '$2'") if $intra_line =~ m/(^|\W)(if|while|for|switch|case)[^\w\s]/; # kw w/o SPC
697 report("no SPC after '$2'") if $intra_line =~ m/(^|\W)(return)[^\w\s;]/; # return w/o SPC or ';'
698 report("SPC after function/macro name")
699 if $intra_line =~ m/(\w+)\s+\(/ # fn/macro name with space before '('
700 && !($1 =~ m/^(if|while|for|switch|return|typedef|void|char|unsigned|int|long|float|double)$/) # not keyword
701 && !(m/^\s*#\s*define\s/); # we skip macro definitions here because macros
702 # without parameters but with body beginning with '(', e.g., '#define X (1)',
703 # would lead to false positives - TODO also check for macros with parameters
704 report("no SPC before '{'") if $intra_line =~ m/[^\s{(\[]\{/; # '{' without preceding space or {([
705 report("no SPC after '}'") if $intra_line =~ m/\}[^\s,;\])}]/; # '}' without following space or ,;])}
708 # preprocessor directives @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
710 # handle preprocessor directives
711 if (m/^\s*#(\s*)(\w+)/) { # line beginning with '#'
712 my $space_count = length($1); # maybe could also use indentation before '#'
714 report("indent = $count != 0 for '#'") if $count != 0;
715 $directive_nesting-- if $directive =~ m/^(else|elif|endif)$/;
716 if ($directive_nesting < 0) {
717 $directive_nesting = 0;
718 report("unexpected '#$directive'");
720 report("'#' directive nesting = $space_count != $directive_nesting") if $space_count != $directive_nesting;
721 $directive_nesting++ if $directive =~ m/^if|ifdef|ifndef|else|elif$/;
722 $ifdef__cplusplus = m/^\s*#\s*ifdef\s+__cplusplus\s*$/;
723 goto POSTPROCESS_DIRECTIVE unless $directive =~ m/^define$/; # skip normal code handling except for #define
724 # TODO improve handling of indents of preprocessor directives ('\', $in_directive != 0) vs. normal C code
725 $count = -1; # do not check indentation of #define
728 # adapt required indentation @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
730 s/(\w*ASN1_[A-Z_]+END\w*([^(]|\(.*?\)|$))/$1;/g; # treat *ASN1_*END*(..) macro calls as if followed by ';'
732 my $nested_indents_position = 0;
734 # update indents according to leading closing brace(s) '}' or label or switch case
735 my $in_stmt = $in_expr || @nested_symbols != 0 || $in_typedecl != 0;
736 if ($in_stmt) { # expr/stmt/type decl/var def/fn hdr, i.e., not at block level
737 if (m/^([\s@]*\})/) { # leading '}', any preceding blinded comment must not be matched
739 update_nested_indents($head);
740 $nested_indents_position = length($head);
741 if (@nested_symbols >= 1) {
742 $hanging_symbol = @nested_symbols[-1];
743 $expr_indent = @nested_indents[-1];
744 } else { # typically end of initialiizer expr or enum
747 } elsif (m/^([\s@]*)(static_)?ASN1_ITEM_TEMPLATE_END(\W|$)/) { # workaround for ASN1 macro indented as '}'
748 $local_offset = -INDENT_LEVEL;
750 } elsif (m/;.*?\}/) { # expr ends with ';' before '}'
751 report("code before '}'");
754 if (@in_do_hanging_offsets != 0 && # note there is nothing like "unexpected 'while'"
755 m/^[\s@]*while(\W|$)/) { # leading 'while'
756 $hanging_offset = pop @in_do_hanging_offsets;
758 if ($if_maybe_terminated) {
759 if (m/(^|\W)else(\W|$)/) { # (not necessarily leading) 'else'
760 if (@in_if_hanging_offsets == 0) {
761 report("unexpected 'else'");
763 $hanging_offset = pop @in_if_hanging_offsets;
766 @in_if_hanging_offsets = (); # note there is nothing like "unclosed 'if'"
770 if (!$in_stmt) { # at block level, i.e., outside expr/stmt/type decl/var def/fn hdr
771 $if_maybe_terminated = 0;
772 if (my ($head, $before, $tail) = m/^([\s@]*([^{}]*)\})[\s@]*(.*)$/) { # leading closing '}', but possibly
773 # with non-whitespace non-'{' before
774 report("code after '}'") unless $tail eq "" || $tail =~ m/(else|while|OSSL_TRACE_END)(\W|$)/;
775 my $outermost_level = @nested_block_indents == 1 && @nested_block_indents[0] == 0;
776 if (!$sloppy_bodylen && $outermost_level && $line_body_start != 0) {
777 my $body_len = $line - $line_body_start - 1;
778 report_flexibly($line_function_start, "function body length = $body_len > ".MAX_BODY_LENGTH." lines",
779 $last_function_header) if $body_len > MAX_BODY_LENGTH;
780 $line_body_start = 0;
782 if ($before ne "") { # non-whitespace non-'{' before '}'
783 report("code before '}'");
784 } else { # leading '}', any preceding blinded comment must not be matched
785 $local_offset = $block_indent + $hanging_offset - INDENT_LEVEL;
786 update_nested_indents($head);
787 $nested_indents_position = length($head);
788 $local_offset -= ($block_indent + $hanging_offset);
789 # in effect $local_offset = -INDENT_LEVEL relative to $block_indent + $hanging_offset values before
793 # handle opening brace '{' after if/else/while/for/switch/do on line before
794 if ($hanging_offset > 0 && m/^[\s@]*{/ && # leading opening '{'
796 $contents_before_ =~ m/(^|^.*\W)(if|else|while|for|switch|do)(\W.*$|$)/) {
797 $keyword_opening_brace = $1;
798 $hanging_offset -= INDENT_LEVEL; # cancel newly hanging_offset
801 if (m/^[\s@]*(case|default)(\W.*$|$)/) { # leading 'case' or 'default'
803 report("code after $keyword: ") if $2 =~ /:.*[^\s@].*$/;
804 $local_offset = -INDENT_LEVEL;
806 if (m/^([\s@]*)(\w+):/) { # (leading) label, cannot be "default"
807 $local_offset = -INDENT_LEVEL;
813 # potential adaptations of indent in first line of macro body in multi-line macro definition
814 if ($in_directive > 0 && $in_macro_header > 0) {
815 if ($in_macro_header > 1) { # still in macro definition header
816 $in_macro_header += parens_balance($_);
817 } else { # begin of macro body
818 $in_macro_header = 0;
819 if ($count == $block_indent - $directive_offset # body began with same indentation as preceding code
820 && $sloppy_macro) { # workaround for this situation is enabled
821 $block_indent -= $directive_offset;
822 $directive_offset = 0;
827 # check required indentation @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
829 check_indent() if $count >= 0; # not for #define and not if multi-line string literal is continued
831 $in_comment = 0 if $in_comment < 0; # multi-line comment has ended
833 # do some further checks @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
835 my $outermost_level = $block_indent == 0 + ($in_directive > 0 ? $directive_offset : 0);
837 report("more than one stmt") if !m/(^|\W)for(\W.*|$)/ && # no 'for' - TODO improve matching
838 m/;.*;/; # two or more terminators ';', so more than one statement
840 # check for code block containing a single line/statement
841 if ($line_before2 > 0 && !$outermost_level && # within function body
842 $in_typedecl == 0 && @nested_indents == 0 && # neither within type declaration nor inside stmt/expr
843 m/^[\s@]*\}/) { # leading closing brace '}', any preceding blinded comment must not be matched
844 # TODO extend detection from single-line to potentially multi-line statement
845 if ($line_opening_brace > 0 &&
846 ($line_opening_brace == $line_before2 ||
847 $line_opening_brace == $line_before)
848 && $contents_before =~ m/;/) { # there is at least one terminator ';', so there is some stmt
849 # TODO do not report cases where a further else branch
850 # follows with a block containg more than one line/statement
851 report_flexibly($line_before, "'$keyword_opening_brace' { 1 stmt }", $contents_before);
855 report("single-letter name '$2'") if (m/(^|.*\W)([IO])(\W.*|$)/); # single-letter name 'I' or 'O' # maybe re-add 'l'?
856 # constant on LHS of comparison or assignment, e.g., NULL != x or 'a' < c, but not a + 1 == b
857 report("constant on LHS of '$2'")
858 if (m/(['"]|([\+\-\*\/\/%\&\|\^<>]\s*)?\W[0-9]+L?|NULL)\s*([\!<>=]=|[<=>][^<>])/ && $2 eq "");
860 # TODO report #if 0 and #if 1
862 # TODO report empty line within local variable definitions
864 # TODO report missing empty line after local variable definitions
866 # TODO report needless use of parentheses, while
867 # macro parameters should always be in parens (except when passed on), e.g., '#define ID(x) (x)'
869 # adapt required indentation for following lines @@@@@@@@@@@@@@@@@@@@@@@@@@@
871 # set $in_expr, $in_paren_expr, and $hanging_offset for if/while/for/switch, return/enum, and assignment RHS
872 my $paren_expr_start = 0;
873 my $return_enum_start = 0;
874 my $assignment_start = 0;
876 $tmp =~ s/[\!<>=]=/@@/g; # blind (in-)equality symbols like '<=' as '@@' to prevent matching them as '=' below
877 if (m/^((^|.*\W)(if|while|for|switch))(\W.*|$)$/) { # (last) if/for/while/switch
878 $paren_expr_start = 1;
879 } elsif (m/^((^|.*\W)(return|enum))(\W.*|$)/ # (last) return/enum
880 && !$in_expr && @nested_indents == 0 && parens_balance($1) == 0) { # not nested enum
881 $return_enum_start = 1;
882 } elsif ($tmp =~ m/^(([^=]*)(=))(.*)$/ # (last) '=', i.e., assignment
883 && !$in_expr && @nested_indents == 0 && parens_balance($1) == 0) { # not nested assignment
884 $assignment_start = 1;
886 if ($paren_expr_start || $return_enum_start || $assignment_start)
888 my ($head, $mid, $tail) = ($1, $3, $4);
889 $keyword_opening_brace = $mid if $mid ne "=";
890 # to cope with multi-line expressions, do this also if !($tail =~ m/\{/)
891 push @in_if_hanging_offsets, $hanging_offset if $mid eq "if";
893 # already handle $head, i.e., anything before expression
894 update_nested_indents($head, $nested_indents_position);
895 $nested_indents_position = length($head);
896 # now can set $in_expr and $in_paren_expr
898 $in_paren_expr = 1 if $paren_expr_start;
899 if ($mid eq "while" && @in_do_hanging_offsets != 0) {
900 $hanging_offset = pop @in_do_hanging_offsets;
902 $hanging_offset += INDENT_LEVEL; # tentatively set hanging_offset, may be canceled by following '{'
906 # set $hanging_offset and $keyword_opening_brace for do/else
907 if (my ($head, $mid, $tail) = m/(^|^.*\W)(else|do)(\W.*|$)$/) { # last else/do, where 'do' is preferred
908 my $code_before = $head =~ m/[^\s\@}]/; # leading non-whitespace non-comment non-'}'
909 report("code before '$mid'") if $code_before;
910 report("code after '$mid'" ) if $tail =~ m/[^\s\@{]/# trailing non-whitespace non-comment non-'{' (non-'\')
911 && !($mid eq "else" && $tail =~ m/[\s@]*if(\W|$)/);
912 if ($mid eq "do") { # workarounds for code before 'do'
913 if ($head =~ m/(^|^.*\W)(else)(\W.*$|$)/) { # 'else' ... 'do'
914 $hanging_offset += INDENT_LEVEL; # tentatively set hanging_offset, may be canceled by following '{'
916 if ($head =~ m/;/) { # terminator ';' ... 'do'
917 @in_if_hanging_offsets = (); # note there is nothing like "unclosed 'if'"
921 push @in_do_hanging_offsets, $hanging_offset if $mid eq "do";
922 if ($code_before && $mid eq "do") {
923 $hanging_offset = length($head) - $block_indent;
925 if (!$in_paren_expr) {
926 $keyword_opening_brace = $mid if $tail =~ m/\{/;
927 $hanging_offset += INDENT_LEVEL;
931 # set $in_typedecl and potentially $hanging_offset for type declaration
932 if (!$in_expr && @nested_indents == 0 && # not in expression
933 m/(^|^.*\W)(typedef|struct|union|enum)(\W.*|$)$/ &&
934 parens_balance($1) == 0) { # not in newly started expression
935 # not needed: $keyword_opening_brace = $2 if $3 =~ m/\{/;
937 $hanging_offset += INDENT_LEVEL if m/\*.*\(/; # '*' followed by '(' - seems consistent with Emacs C mode
940 my $bak_in_expr = $in_expr;
941 my $terminator_position = update_nested_indents($_, $nested_indents_position);
944 # on end of non-if/while/for/switch (multi-line) expression (i.e., return/enum/assignment) and
945 # on end of statement/type declaration/variable definition/function header
946 if ($terminator_position >= 0 && ($in_typedecl == 0 || @nested_indents == 0)) {
947 check_nested_nonblock_indents("expr");
951 check_nested_nonblock_indents($in_typedecl == 0 ? "stmt" : "decl") if $terminator_position >= 0;
954 # on ';', which terminates the current statement/type declaration/variable definition/function declaration
955 if ($terminator_position >= 0) {
956 my $tail = substr($_, $terminator_position + 1);
957 if (@in_if_hanging_offsets != 0) {
958 if ($tail =~ m/\s*else(\W|$)/) {
959 pop @in_if_hanging_offsets;
960 $hanging_offset -= INDENT_LEVEL;
961 } elsif ($tail =~ m/[^\s@]/) { # code (not just comment) follows
962 @in_if_hanging_offsets = (); # note there is nothing like "unclosed 'if'"
965 $if_maybe_terminated = 1;
967 } elsif ($tail =~ m/^[\s@]*$/) { # ';' has been trailing, i.e. there is nothing but whitespace and comments
968 $hanging_offset = 0; # reset in case of terminated assignment ('=') etc.
970 $in_typedecl-- if $in_typedecl != 0 && @nested_in_typedecl == 0; # TODO handle multiple type decls per line
971 m/(;[^;]*)$/; # match last ';'
972 $terminator_position = length($_) - length($1) if $1;
973 # new $terminator_position value may be after the earlier one in case multiple terminators on current line
974 # TODO check treatment in case of multiple terminators on current line
975 update_nested_indents($_, $terminator_position + 1);
978 # set hanging expression indent according to nested indents - TODO maybe do better in update_nested_indents()
979 # also if $in_expr is 0: in statement/type declaration/variable definition/function header
981 for (my $i = -1; $i >= -@nested_symbols; $i--) {
982 if (@nested_symbols[$i] ne "?") { # conditionals '?' ... ':' are treated specially in check_indent()
983 $hanging_symbol = @nested_symbols[$i];
984 $expr_indent = $nested_indents[$i];
985 # $expr_indent is guaranteed to be != 0 unless @nested_indents contains just outer conditionals
990 # remember line number and header containing name of last function defined for reports w.r.t. MAX_BODY_LENGTH
991 if ($outermost_level && m/(\w+)\s*\(/ && $1 ne "STACK_OF") {
992 $line_function_start = $line;
993 $last_function_header = $contents;
996 # special checks for last, typically trailing opening brace '{' in line
997 if (my ($head, $tail) = m/^(.*)\{(.*)$/) { # match last ... '{'
998 if ($in_directive == 0 && !$in_expr && $in_typedecl == 0) {
999 if ($outermost_level) {
1000 if (!$assignment_start && !$bak_in_expr) {
1001 # at end of function definition header (or stmt or var definition)
1002 report("'{' not at beginning") if $head ne "";
1003 $line_body_start = $contents =~ m/LONG BODY/ ? 0 : $line;
1006 $line_opening_brace = $line if $keyword_opening_brace =~ m/do|while|for/;
1007 # using, not assigning, $keyword_opening_brace here because it could be on an earlier line
1008 $line_opening_brace = $line if $keyword_opening_brace =~ m/if|else/ && $extended_1_stmt &&
1009 # TODO prevent false positives for if/else where braces around single-statement branches
1010 # should be avoided but only if all branches have just single statements
1011 # The following helps detecting the exception when handling multiple 'if ... else' branches:
1012 !($keyword_opening_brace eq "else" && $line_opening_brace < $line_before2);
1014 report("code after '{'") if $tail=~ m/[^\s\@]/ && # trailing non-whitespace non-comment (non-'\')
1015 !($tail=~ m/\}/); # no '}' after last '{'
1019 # check for opening brace after if/while/for/switch/do not on same line
1020 # note that "no '{' on same line after '} else'" is handled further below
1021 if (/^[\s@]*{/ && # leading '{'
1022 $line_before > 0 && !($contents_before_ =~ m/^\s*#/) && # not preprocessor directive '#if
1023 (my ($head, $mid, $tail) = ($contents_before_ =~ m/(^|^.*\W)(if|while|for|switch|do)(\W.*$|$)/))) {
1024 my $brace_after = $tail =~ /^[\s@]*{/; # any whitespace or comments then '{'
1025 report("'{' not on same line as preceding '$mid'") if !$brace_after;
1027 # check for closing brace on line before 'else' not followed by leading '{'
1028 elsif (my ($head, $tail) = m/(^|^.*\W)else(\W.*$|$)/) {
1029 if (parens_balance($tail) == 0 && # avoid false positive due to unfinished expr on current line
1030 !($tail =~ m/{/) && # after 'else' no '{' on same line
1031 !($head =~ m/}[\s@]*$/) && # not: '}' then any whitespace or comments before 'else'
1032 $line_before > 0 && $contents_before_ =~ /}[\s@]*$/) { # trailing '}' on line before
1033 report("no '{' after '} else'");
1037 # check for closing brace before 'while' not on same line
1038 if (my ($head, $tail) = m/(^|^.*\W)while(\W.*$|$)/) {
1039 my $brace_before = $head =~ m/}[\s@]*$/; # '}' then any whitespace or comments
1040 # possibly 'if (...)' (with potentially inner '(' and ')') then any whitespace or comments then '{'
1041 if (!$brace_before &&
1042 # does not work here: @in_do_hanging_offsets != 0 && #'while' terminates loop
1043 parens_balance($tail) == 0 && # avoid false positive due to unfinished expr on current line
1044 $tail =~ /;/ && # 'while' terminates loop (by ';')
1046 $contents_before_ =~ /}[\s@]*$/) { # on line before: '}' then any whitespace or comments
1047 report("'while' not on same line as preceding '}'");
1051 # check for missing brace on same line before or after 'else'
1052 if (my ($head, $tail) = m/(^|^.*\W)else(\W.*$|$)/) {
1053 my $brace_before = $head =~ /}[\s@]*$/; # '}' then any whitespace or comments
1054 my $brace_after = $tail =~ /^[\s@]*if[\s@]*\(.*\)[\s@]*{|[\s@]*{/;
1055 # possibly 'if (...)' (with potentially inner '(' and ')') then any whitespace or comments then '{'
1056 if (!$brace_before) {
1057 if ($line_before > 0 && $contents_before_ =~ /}[\s@]*$/) {
1058 report("'else' not on same line as preceding '}'");
1059 } elsif (parens_balance($tail) == 0) { # avoid false positive due to unfinished expr on current line
1060 report("no '}' on same line before 'else ... {'") if $brace_after;
1062 } elsif (parens_balance($tail) == 0) { # avoid false positive due to unfinished expr on current line
1063 report("no '{' on same line after '} else'") if $brace_before && !$brace_after;
1067 POSTPROCESS_DIRECTIVE:
1068 # on begin of multi-line preprocessor directive, adapt indent
1069 # need to use original line contents because trailing '\' may have been stripped above
1070 if ($contents =~ m/^(.*?)[\s@]*\\[\s@]*$/) { # trailing '\' (which is not stripped from $contents),
1071 # typically used in macro definitions (or other preprocessor directives)
1072 if ($in_directive == 0) {
1073 $in_macro_header = m/^\s*#\s*define(\W|$)?(.*)/ ? 1 + parens_balance($2) : 0; # '#define' is beginning
1074 $directive_offset = INDENT_LEVEL;
1075 $block_indent += $directive_offset;
1080 # post-processing at end of line @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
1083 # on end of multi-line preprocessor directive, adapt indent
1084 if ($in_directive > 0 &&
1085 # need to use original line contents because trailing \ may have been stripped
1086 !($contents =~ m/^(.*?)[\s@]*\\[\s@]*$/)) { # no trailing '\'
1087 $block_indent -= $directive_offset;
1089 # macro body typically does not include terminating ';'
1090 $hanging_offset = 0; # compensate for this in case macro ends, e.g., as 'while (0)'
1093 if (m/^\s*$/) { # at begin of file essentially empty line: just whitespace (and maybe a '\')
1094 report("leading ".($1 eq "" ? "empty" :"whitespace")." line") if $line == 1 && !$sloppy_SPC;
1096 if ($line_before > 0) {
1097 my $linediff = $line - $line_before - 1;
1098 report("$linediff empty lines before") if $linediff > 1 && !$sloppy_SPC;
1100 $line_before2 = $line_before;
1101 $contents_before2 = $contents_before;
1102 $contents_before_2 = $contents_before_;
1103 $line_before = $line;
1104 $contents_before = $contents;
1105 $contents_before_ = $_;
1106 $count_before = $count;
1109 if ($self_test) { # debugging
1110 my $should_report = $contents =~ m/\*@(\d)?/ ? 1 : 0;
1111 $should_report = +$1 if $should_report != 0 && defined $1;
1112 print("$ARGV:$line:$num_reports_line reports on:$contents")
1113 if $num_reports_line != $should_report;
1115 $num_reports_line = 0;
1117 # post-processing at end of file @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
1120 # check for essentially empty line (which may include a '\') just before EOF
1121 report(($1 eq "\n" ? "empty line" : $2 ne "" ? "'\\'" : "whitespace")." at EOF")
1122 if $contents =~ m/^(\s*(\\?)\s*)$/ && !$sloppy_SPC;
1124 # report unclosed expression-level nesting
1125 check_nested_nonblock_indents("expr at EOF"); # also adapts @nested_block_indents
1127 # sanity-check balance of block-level { ... } via final $block_indent at end of file
1128 report_flexibly($line, +@nested_block_indents." unclosed '{'", "(EOF)\n") if @nested_block_indents != 0;
1130 # sanity-check balance of #if ... #endif via final preprocessor directive indent at end of file
1131 report_flexibly($line, "$directive_nesting unclosed '#if'", "(EOF)\n") if $directive_nesting != 0;
1137 # final summary report @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
1139 my $num_other_reports = $num_reports - $num_indent_reports - $num_nesting_issues
1140 - $num_syntax_issues - $num_SPC_reports - $num_length_reports;
1141 print "$num_reports ($num_indent_reports indentation, $num_nesting_issues directive nesting, ".
1142 "$num_syntax_issues syntax, $num_SPC_reports whitespace, $num_length_reports length, $num_other_reports other)".
1143 " issues have been found by $0\n" if $num_reports != 0 && !$self_test;