2
0

check-format.pl 68 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272
  1. #! /usr/bin/env perl
  2. #
  3. # Copyright 2020-2023 The OpenSSL Project Authors. All Rights Reserved.
  4. # Copyright Siemens AG 2019-2022
  5. #
  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
  10. #
  11. # check-format.pl
  12. # - check formatting of C source according to OpenSSL coding style
  13. #
  14. # usage:
  15. # check-format.pl [-l|--sloppy-len] [-l|--sloppy-bodylen]
  16. # [-s|--sloppy-space] [-c|--sloppy-comment]
  17. # [-m|--sloppy-macro] [-h|--sloppy-hang]
  18. # [-e|--eol-comment] [-1|--1-stmt]
  19. # <files>
  20. #
  21. # run self-tests:
  22. # util/check-format.pl util/check-format-test-positives.c
  23. # util/check-format.pl util/check-format-test-negatives.c
  24. #
  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.
  29. #
  30. # options:
  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-space do not report whitespace nits
  34. # -c | --sloppy-comment 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 | --eol-comment report needless intermediate multiple consecutive spaces also before end-of-line comments
  48. # -1 | --1-stmt do more aggressive checks for { 1 stmt } - see below
  49. #
  50. # There are non-trivial false positives and negatives such as the following.
  51. #
  52. # * When a line contains several issues of the same kind only one is reported.
  53. #
  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.
  56. #
  57. # * There is the special OpenSSL rule not to unnecessarily use braces around
  58. # single statements:
  59. # {
  60. # stmt;
  61. # }
  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 default 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-blank lines apart.
  68. #
  69. # * The presence of multiple consecutive spaces is regarded a coding style nit
  70. # except when this is before end-of-line comments (unless the --eol-comment is given) and
  71. # except when done in order to align certain columns over multiple lines, e.g.:
  72. # # define AB 1
  73. # # define CDE 22
  74. # # define F 3333
  75. # This pattern is recognized - and consequently extra space not reported -
  76. # for a given line if in the non-blank 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).
  81. #
  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.:
  84. # #if X
  85. # if (1) /* bad style */
  86. # #else
  87. # if (2) /* bad style resulting in false positive */
  88. # #endif
  89. # c; /* resulting further false positive */
  90. use strict;
  91. # use List::Util qw[min max];
  92. use POSIX;
  93. use constant INDENT_LEVEL => 4;
  94. use constant MAX_LINE_LENGTH => 80;
  95. use constant MAX_BODY_LENGTH => 200;
  96. # global variables @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  97. # command-line options
  98. my $max_length = MAX_LINE_LENGTH;
  99. my $sloppy_bodylen = 0;
  100. my $sloppy_SPC = 0;
  101. my $sloppy_hang = 0;
  102. my $sloppy_cmt = 0;
  103. my $sloppy_macro = 0;
  104. my $eol_cmt = 0;
  105. my $extended_1_stmt = 0;
  106. while ($ARGV[0] =~ m/^-(\w|-[\w\-]+)$/) {
  107. my $arg = $1; shift;
  108. if ($arg =~ m/^(l|-sloppy-len)$/) {
  109. $max_length += INDENT_LEVEL;
  110. } elsif ($arg =~ m/^(b|-sloppy-bodylen)$/) {
  111. $sloppy_bodylen = 1;
  112. } elsif ($arg =~ m/^(s|-sloppy-space)$/) {
  113. $sloppy_SPC= 1;
  114. } elsif ($arg =~ m/^(c|-sloppy-comment)$/) {
  115. $sloppy_cmt = 1;
  116. } elsif ($arg =~ m/^(m|-sloppy-macro)$/) {
  117. $sloppy_macro = 1;
  118. } elsif ($arg =~ m/^(h|-sloppy-hang)$/) {
  119. $sloppy_hang = 1;
  120. } elsif ($arg =~ m/^(e|-eol-comment)$/) {
  121. $eol_cmt = 1;
  122. } elsif ($arg =~ m/^(1|-1-stmt)$/) {
  123. $extended_1_stmt = 1;
  124. } else {
  125. die("unknown option: -$arg");
  126. }
  127. }
  128. # state variables
  129. my $self_test; # whether the current input file is regarded to contain (positive/negative) self-tests
  130. my $in_comment; # number of lines so far within multi-line comment, 0 if no comment, < 0 when end is on current line
  131. my $leading_comment; # multi-line comment has no code before its beginning delimiter, if $in_comment != 0
  132. my $formatted_comment; # multi-line comment beginning with "/*-", which indicates/allows special formatting, if $in_comment != 0
  133. my $comment_indent; # comment indent, if $in_comment != 0
  134. my $ifdef__cplusplus; # line before contained '#ifdef __cplusplus' (used in header files)
  135. my $preproc_if_nesting; # currently required indentation of preprocessor directive according to #if(n)(def)
  136. my $in_preproc; # 0 or number of lines so far within preprocessor directive, e.g., macro definition
  137. my $preproc_directive; # name of current preprocessor directive, if $in_preproc != 0
  138. my $preproc_offset; # offset to $block_indent within multi-line preprocessor directive, else 0
  139. my $in_macro_header; # number of open parentheses + 1 in (multi-line) header of #define, if $in_preproc != 0
  140. my $line; # current line number
  141. my $line_before; # number of previous not essentially blank line (containing at most whitespace and '\')
  142. my $line_before2; # number of not essentially blank line before previous not essentially blank line
  143. # indentation state
  144. my $contents; # contents of current line (without blinding)
  145. # $_ # current line, where comments etc. get blinded
  146. my $code_contents_before; # contents of previous non-comment non-preprocessor-directive line (without blinding), initially ""
  147. my $contents_before; # contents of $line_before (without blinding), if $line_before > 0
  148. my $contents_before_; # contents of $line_before after blinding comments etc., if $line_before > 0
  149. my $contents_before2; # contents of $line_before2 (without blinding), if $line_before2 > 0
  150. my $contents_before_2; # contents of $line_before2 after blinding comments etc., if $line_before2 > 0
  151. my $in_multiline_string; # line starts within multi-line string literal
  152. my $count; # -1 or number of leading whitespace characters (except newline) in current line,
  153. # which should be $block_indent + $hanging_offset + $local_offset or $expr_indent
  154. my $count_before; # number of leading whitespace characters (except line ending chars) in $contents_before
  155. my $has_label; # current line contains label
  156. my $local_offset; # current extra indent due to label, switch case/default, or leading closing brace(s)
  157. my $line_body_start; # number of line where last function body started, or 0
  158. my $line_function_start; # number of line where last function definition started, used for $line_body_start
  159. my $last_function_header; # header containing name of last function defined, used if $line_body_start != 0
  160. my $line_opening_brace; # number of previous line with opening brace after do/while/for, optionally for if/else
  161. my $keyword_opening_brace; # name of previous keyword, used if $line_opening_brace != 0
  162. my $block_indent; # currently required normal indentation at block/statement level
  163. my $hanging_offset; # extra indent, which may be nested, for just one hanging statement or expr or typedef
  164. my @in_do_hanging_offsets; # stack of hanging offsets for nested 'do' ... 'while'
  165. my @in_if_hanging_offsets; # stack of hanging offsets for nested 'if' (but not its potential 'else' branch)
  166. my $if_maybe_terminated; # 'if' ends and $hanging_offset should be reset unless the next line starts with 'else'
  167. my @nested_block_indents; # stack of indentations at block/statement level, needed due to hanging statements
  168. my @nested_hanging_offsets;# stack of nested $hanging_offset values, in parallel to @nested_block_indents
  169. my @nested_in_typedecl; # stack of nested $in_typedecl values, partly in parallel to @nested_block_indents
  170. my @nested_indents; # stack of hanging indents due to parentheses, braces, brackets, or conditionals
  171. my @nested_symbols; # stack of hanging symbols '(', '{', '[', or '?', in parallel to @nested_indents
  172. my @nested_conds_indents; # stack of hanging indents due to conditionals ('?' ... ':')
  173. my $expr_indent; # resulting hanging indent within (multi-line) expressions including type exprs, else 0
  174. my $hanging_symbol; # character ('(', '{', '[', not: '?') responsible for $expr_indent, if $expr_indent != 0
  175. my $in_block_decls; # number of local declaration lines after block opening before normal statements, or -1 if no block opening
  176. my $in_expr; # in expression after if/while/for/switch/return/enum/LHS of assignment
  177. my $in_paren_expr; # in parenthesized if/while/for condition and switch expression, if $expr_indent != 0
  178. my $in_typedecl; # nesting level of typedef/struct/union/enum
  179. my $num_reports_line = 0; # number of issues found on current line
  180. my $num_reports = 0; # total number of issues found
  181. my $num_indent_reports = 0;# total number of indentation issues found
  182. my $num_nesting_issues = 0;# total number of preprocessor #if nesting issues found
  183. my $num_syntax_issues = 0; # total number of syntax issues found during sanity checks
  184. my $num_SPC_reports = 0; # total number of whitespace issues found
  185. my $num_length_reports = 0;# total number of line length issues found
  186. sub reset_file_state {
  187. $in_comment = 0;
  188. $ifdef__cplusplus = 0;
  189. $preproc_if_nesting = 0;
  190. $in_preproc = 0;
  191. $line = 0;
  192. $line_before = 0;
  193. $line_before2 = 0;
  194. reset_indentation_state();
  195. }
  196. sub reset_indentation_state {
  197. $code_contents_before = "";
  198. @nested_block_indents = ();
  199. @nested_hanging_offsets = ();
  200. @nested_in_typedecl = ();
  201. @nested_symbols = ();
  202. @nested_indents = ();
  203. @nested_conds_indents = ();
  204. $expr_indent = 0;
  205. $in_block_decls = -1;
  206. $in_expr = 0;
  207. $in_paren_expr = 0;
  208. $hanging_offset = 0;
  209. @in_do_hanging_offsets = ();
  210. @in_if_hanging_offsets = ();
  211. $if_maybe_terminated = 0;
  212. $block_indent = 0;
  213. $in_multiline_string = 0;
  214. $line_body_start = 0;
  215. $line_opening_brace = 0;
  216. $in_typedecl = 0;
  217. }
  218. my $bak_line_before;
  219. my $bak_line_before2;
  220. my $bak_code_contents_before;
  221. my @bak_nested_block_indents;
  222. my @bak_nested_hanging_offsets;
  223. my @bak_nested_in_typedecl;
  224. my @bak_nested_symbols;
  225. my @bak_nested_indents;
  226. my @bak_nested_conds_indents;
  227. my $bak_expr_indent;
  228. my $bak_in_block_decls;
  229. my $bak_in_expr;
  230. my $bak_in_paren_expr;
  231. my $bak_hanging_offset;
  232. my @bak_in_do_hanging_offsets;
  233. my @bak_in_if_hanging_offsets;
  234. my $bak_if_maybe_terminated;
  235. my $bak_block_indent;
  236. my $bak_in_multiline_string;
  237. my $bak_line_body_start;
  238. my $bak_line_opening_brace;
  239. my $bak_in_typedecl;
  240. sub backup_indentation_state {
  241. $bak_code_contents_before = $code_contents_before;
  242. @bak_nested_block_indents = @nested_block_indents;
  243. @bak_nested_hanging_offsets = @nested_hanging_offsets;
  244. @bak_nested_in_typedecl = @nested_in_typedecl;
  245. @bak_nested_symbols = @nested_symbols;
  246. @bak_nested_indents = @nested_indents;
  247. @bak_nested_conds_indents = @nested_conds_indents;
  248. $bak_expr_indent = $expr_indent;
  249. $bak_in_block_decls = $in_block_decls;
  250. $bak_in_expr = $in_expr;
  251. $bak_in_paren_expr = $in_paren_expr;
  252. $bak_hanging_offset = $hanging_offset;
  253. @bak_in_do_hanging_offsets = @in_do_hanging_offsets;
  254. @bak_in_if_hanging_offsets = @in_if_hanging_offsets;
  255. $bak_if_maybe_terminated = $if_maybe_terminated;
  256. $bak_block_indent = $block_indent;
  257. $bak_in_multiline_string = $in_multiline_string;
  258. $bak_line_body_start = $line_body_start;
  259. $bak_line_opening_brace = $line_opening_brace;
  260. $bak_in_typedecl = $in_typedecl;
  261. }
  262. sub restore_indentation_state {
  263. $code_contents_before = $bak_code_contents_before;
  264. @nested_block_indents = @bak_nested_block_indents;
  265. @nested_hanging_offsets = @bak_nested_hanging_offsets;
  266. @nested_in_typedecl = @bak_nested_in_typedecl;
  267. @nested_symbols = @bak_nested_symbols;
  268. @nested_indents = @bak_nested_indents;
  269. @nested_conds_indents = @bak_nested_conds_indents;
  270. $expr_indent = $bak_expr_indent;
  271. $in_block_decls = $bak_in_block_decls;
  272. $in_expr = $bak_in_expr;
  273. $in_paren_expr = $bak_in_paren_expr;
  274. $hanging_offset = $bak_hanging_offset;
  275. @in_do_hanging_offsets = @bak_in_do_hanging_offsets;
  276. @in_if_hanging_offsets = @bak_in_if_hanging_offsets;
  277. $if_maybe_terminated = $bak_if_maybe_terminated;
  278. $block_indent = $bak_block_indent;
  279. $in_multiline_string = $bak_in_multiline_string;
  280. $line_body_start = $bak_line_body_start;
  281. $line_opening_brace = $bak_line_opening_brace;
  282. $in_typedecl = $bak_in_typedecl;
  283. }
  284. # auxiliary submodules @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  285. sub report_flexibly {
  286. my $line = shift;
  287. my $msg = shift;
  288. my $contents = shift;
  289. my $report_SPC = $msg =~ /space|blank/;
  290. return if $report_SPC && $sloppy_SPC;
  291. print "$ARGV:$line:$msg:$contents" unless $self_test;
  292. $num_reports_line++;
  293. $num_reports++;
  294. $num_indent_reports++ if $msg =~ m/:indent /;
  295. $num_nesting_issues++ if $msg =~ m/ nesting indent /;
  296. $num_syntax_issues++ if $msg =~ m/unclosed|unexpected/;
  297. $num_SPC_reports++ if $report_SPC;
  298. $num_length_reports++ if $msg =~ m/length/;
  299. }
  300. sub report {
  301. my $msg = shift;
  302. report_flexibly($line, $msg, $contents);
  303. }
  304. sub parens_balance { # count balance of opening parentheses - closing parentheses
  305. my $str = shift;
  306. return $str =~ tr/\(// - $str =~ tr/\)//;
  307. }
  308. sub blind_nonspace { # blind non-space text of comment as @, preserving length and spaces
  309. # the @ character is used because it cannot occur in normal program code so there is no confusion
  310. # comment text is not blinded to whitespace in order to be able to check extra SPC also in comments
  311. my $comment_text = shift;
  312. $comment_text =~ s/([\.\?\!])\s\s/$1. /g; # in extra SPC checks allow one extra SPC after period '.', '?', or '!' in comments
  313. return $comment_text =~ tr/ /@/cr;
  314. }
  315. # submodule for indentation checking/reporting @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  316. sub check_indent { # used for lines outside multi-line string literals
  317. my $stmt_indent = $block_indent + $hanging_offset + $local_offset;
  318. # print "DEBUG: expr_indent $expr_indent; stmt_indent $stmt_indent = block_indent $block_indent + hanging_offset $hanging_offset + local_offset $local_offset\n";
  319. $stmt_indent = 0 if $stmt_indent < 0; # TODO maybe give warning/error
  320. my $stmt_desc = $contents =~
  321. m/^\s*\/\*/ ? "intra-line comment" :
  322. $has_label ? "label" :
  323. ($hanging_offset != 0 ? "hanging " : "").
  324. ($hanging_offset != 0 ? "stmt/expr" : "stmt/decl"); # $in_typedecl is not fully to the point here
  325. my ($ref_desc, $ref_indent) = $expr_indent == 0 ? ($stmt_desc, $stmt_indent)
  326. : ("hanging '$hanging_symbol'", $expr_indent);
  327. my ($alt_desc, $alt_indent) = ("", $ref_indent);
  328. # allow indent 1 for labels - this cannot happen for leading ':'
  329. ($alt_desc, $alt_indent) = ("outermost position", 1) if $expr_indent == 0 && $has_label;
  330. if (@nested_conds_indents != 0 && substr($_, $count, 1) eq ":") {
  331. # leading ':' within stmt/expr/decl - this cannot happen for labels, leading '&&', or leading '||'
  332. # allow special indent at level of corresponding "?"
  333. ($alt_desc, $alt_indent) = ("leading ':'", @nested_conds_indents[-1]);
  334. }
  335. # allow extra indent offset leading '&&' or '||' - this cannot happen for leading ":"
  336. ($alt_desc, $alt_indent) = ("leading '$1'", $ref_indent + INDENT_LEVEL) if $contents =~ m/^[\s@]*(\&\&|\|\|)/;
  337. if ($expr_indent < 0) { # implies @nested_symbols != 0 && @nested_symbols[0] eq "{" && @nested_indents[-1] < 0
  338. # allow normal stmt indentation level for hanging initializer/enum expressions after trailing '{'
  339. # this cannot happen for labels and overrides special treatment of ':', '&&' and '||' for this line
  340. ($alt_desc, $alt_indent) = ("lines after '{'", $stmt_indent);
  341. # decide depending on current actual indentation, preventing forth and back
  342. @nested_indents[-1] = $count == $stmt_indent ? $stmt_indent : -@nested_indents[-1]; # allow $stmt_indent
  343. $ref_indent = $expr_indent = @nested_indents[-1];
  344. }
  345. # check consistency of indentation within multi-line comment (i.e., between its first, inner, and last lines)
  346. if ($in_comment != 0 && $in_comment != 1) { # in multi-line comment but not on its first line
  347. if (!$sloppy_cmt) {
  348. if ($in_comment > 0) { # not at its end
  349. report("indent = $count != $comment_indent within multi-line comment")
  350. if $count != $comment_indent;
  351. } else {
  352. my $tweak = $in_comment == -2 ? 1 : 0;
  353. report("indent = ".($count + $tweak)." != $comment_indent at end of multi-line comment")
  354. if $count + $tweak != $comment_indent;
  355. }
  356. }
  357. # do not check indentation of last line of non-leading multi-line comment
  358. if ($in_comment < 0 && !$leading_comment) {
  359. s/^(\s*)@/$1*/; # blind first '@' as '*' to prevent below delayed check for the line before
  360. return;
  361. }
  362. return if $in_comment > 0; # not on its last line
  363. # $comment_indent will be checked by the below checks for end of multi-line comment
  364. }
  365. # else check indentation of entire-line comment or entire-line end of multi-line comment
  366. # ... w.r.t. indent of the following line by delayed check for the line before
  367. if (($in_comment == 0 || $in_comment == 1) # no comment, intra-line comment, or begin of multi-line comment
  368. && $line_before > 0 # there is a line before
  369. && $contents_before_ =~ m/^(\s*)@[\s@]*$/) { # line before begins with '@', no code follows (except '\')
  370. report_flexibly($line_before, "entire-line comment indent = $count_before != $count (of following line)",
  371. $contents_before) if !$sloppy_cmt && $count_before != -1 && $count_before != $count;
  372. }
  373. # ... but allow normal indentation for the current line, else above check will be done for the line before
  374. if (($in_comment == 0 || $in_comment < 0) # (no comment,) intra-line comment or end of multi-line comment
  375. && m/^(\s*)@[\s@]*$/) { # line begins with '@', no code follows (except '\')
  376. if ($count == $ref_indent) { # indentation is like for (normal) code in this line
  377. s/^(\s*)@/$1*/; # blind first '@' as '*' to prevent above delayed check for the line before
  378. return;
  379. }
  380. return if !eof; # defer check of entire-line comment to next line
  381. }
  382. # else check indentation of leading intra-line comment or end of multi-line comment
  383. if (m/^(\s*)@/) { # line begins with '@', i.e., any (remaining type of) comment
  384. if (!$sloppy_cmt && $count != $ref_indent) {
  385. report("intra-line comment indent = $count != $ref_indent") if $in_comment == 0;
  386. report("multi-line comment indent = $count != $ref_indent") if $in_comment < 0;
  387. }
  388. return;
  389. }
  390. if ($sloppy_hang && ($hanging_offset != 0 || $expr_indent != 0)) {
  391. # do not report same indentation as on the line before (potentially due to same violations)
  392. return if $line_before > 0 && $count == $count_before;
  393. # do not report indentation at normal indentation level while hanging expression indent would be required
  394. return if $expr_indent != 0 && $count == $stmt_indent;
  395. # do not report if contents have been shifted left of nested expr indent (but not as far as stmt indent)
  396. # apparently aligned to the right in order to fit within line length limit
  397. return if $stmt_indent < $count && $count < $expr_indent &&
  398. length($contents) == MAX_LINE_LENGTH + length("\n");
  399. }
  400. report("indent = $count != $ref_indent for $ref_desc".
  401. ($alt_desc eq ""
  402. || $alt_indent == $ref_indent # prevent showing alternative that happens to have equal value
  403. ? "" : " or $alt_indent for $alt_desc"))
  404. if $count != $ref_indent && $count != $alt_indent;
  405. }
  406. # submodules handling indentation within expressions @@@@@@@@@@@@@@@@@@@@@@@@@@@
  407. sub update_nested_indents { # may reset $in_paren_expr and in this case also resets $in_expr
  408. my $str = shift;
  409. my $start = shift; # defaults to 0
  410. my $terminator_position = -1;
  411. for (my $i = $start; $i < length($str); $i++) {
  412. my $c;
  413. my $curr = substr($str, $i);
  414. if ($curr =~ m/^(.*?)([{}()?:;\[\]])(.*)$/) { # match from position $i the first {}()?:;[]
  415. $c = $2;
  416. } else {
  417. last;
  418. }
  419. my ($head, $tail) = (substr($str, 0, $i).$1, $3);
  420. $i += length($1) + length($2) - 1;
  421. # stop at terminator outside 'for (..;..;..)', assuming that 'for' is followed by '('
  422. return $i if $c eq ";" && (!$in_paren_expr || @nested_indents == 0);
  423. my $in_stmt = $in_expr || @nested_symbols != 0; # not: || $in_typedecl != 0
  424. if ($c =~ m/[{([?]/) { # $c is '{', '(', '[', or '?'
  425. if ($c eq "{") { # '{' in any context
  426. $in_block_decls = 0 if !$in_expr && $in_typedecl == 0;
  427. # cancel newly hanging_offset if opening brace '{' is after non-whitespace non-comment:
  428. $hanging_offset -= INDENT_LEVEL if $hanging_offset > 0 && $head =~ m/[^\s\@]/;
  429. push @nested_block_indents, $block_indent;
  430. push @nested_hanging_offsets, $in_expr ? $hanging_offset : 0;
  431. push @nested_in_typedecl, $in_typedecl if $in_typedecl != 0;
  432. $block_indent += INDENT_LEVEL + $hanging_offset;
  433. $hanging_offset = 0;
  434. }
  435. if ($c ne "{" || $in_stmt) { # for '{' inside stmt/expr (not: decl), for '(', '[', or '?' anywhere
  436. $tail =~ m/^([\s@]*)([^\s\@])/;
  437. push @nested_indents, defined $2
  438. ? $i + 1 + length($1) # actual indentation of following non-space non-comment
  439. : $c ne "{" ? +($i + 1) # just after '(' or '[' if only whitespace thereafter
  440. : -($i + 1); # allow also $stmt_indent if '{' with only whitespace thereafter
  441. push @nested_symbols, $c; # done also for '?' to be able to check correct nesting
  442. push @nested_conds_indents, $i if $c eq "?"; # remember special alternative indent for ':'
  443. }
  444. } elsif ($c =~ m/[})\]:]/) { # $c is '}', ')', ']', or ':'
  445. my $opening_c = ($c =~ tr/})]:/{([/r);
  446. if (($c ne ":" || $in_stmt # ignore ':' outside stmt/expr/decl
  447. # in the presence of ':', one could add this sanity check:
  448. # && !(# ':' after initial label/case/default
  449. # $head =~ m/^([\s@]*)(case\W.*$|\w+$)/ || # this matching would not work for
  450. # # multi-line expr after 'case'
  451. # # bitfield length within unsigned type decl
  452. # $tail =~ m/^[\s@]*\d+/ # this matching would need improvement
  453. # )
  454. )) {
  455. if ($c ne "}" || $in_stmt) { # for '}' inside stmt/expr/decl, ')', ']', or ':'
  456. if (@nested_symbols != 0 &&
  457. @nested_symbols[-1] == $opening_c) { # for $c there was a corresponding $opening_c
  458. pop @nested_indents;
  459. pop @nested_symbols;
  460. pop @nested_conds_indents if $opening_c eq "?";
  461. } else {
  462. report("unexpected '$c' @ ".($in_paren_expr ? "(expr)" : "expr"));
  463. next;
  464. }
  465. }
  466. if ($c eq "}") { # '}' at block level but also inside stmt/expr/decl
  467. if (@nested_block_indents == 0) {
  468. report("unexpected '}'");
  469. } else {
  470. $block_indent = pop @nested_block_indents;
  471. $hanging_offset = pop @nested_hanging_offsets;
  472. $in_typedecl = pop @nested_in_typedecl if @nested_in_typedecl != 0;
  473. }
  474. }
  475. if ($in_paren_expr && !grep(/\(/, @nested_symbols)) { # end of (expr)
  476. check_nested_nonblock_indents("(expr)");
  477. $in_paren_expr = $in_expr = 0;
  478. report("code after (expr)")
  479. if $tail =~ m/^([^{]*)/ && $1 =~ m/[^\s\@;]/; # non-space non-';' before any '{'
  480. }
  481. }
  482. }
  483. }
  484. return -1;
  485. }
  486. sub check_nested_nonblock_indents {
  487. my $position = shift;
  488. while (@nested_symbols != 0) {
  489. my $symbol = pop @nested_symbols;
  490. report("unclosed '$symbol' in $position");
  491. if ($symbol eq "{") { # repair stack of blocks
  492. $block_indent = pop @nested_block_indents;
  493. $hanging_offset = pop @nested_hanging_offsets;
  494. $in_typedecl = pop @nested_in_typedecl if @nested_in_typedecl != 0;
  495. }
  496. }
  497. @nested_indents = ();
  498. @nested_conds_indents = ();
  499. }
  500. # start of main program @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  501. reset_file_state();
  502. while (<>) { # loop over all lines of all input files
  503. $self_test = $ARGV =~ m/check-format-test/;
  504. $_ = "" if $self_test && m/ blank line within local decls /;
  505. $line++;
  506. s/\r$//; # strip any trailing CR '\r' (which are typical on Windows systems)
  507. $contents = $_;
  508. # check for illegal characters
  509. if (m/(.*?)([\x00-\x09\x0B-\x1F\x7F-\xFF])/) {
  510. my $col = length($1);
  511. report(($2 eq "\x09" ? "TAB" : $2 eq "\x0D" ? "CR " : $2 =~ m/[\x00-\x1F]/ ? "non-printable"
  512. : "non-7bit char") . " at column $col") ;
  513. }
  514. # check for whitespace at EOL
  515. report("trailing whitespace at EOL") if m/\s\n$/;
  516. # assign to $count the actual indentation level of the current line
  517. chomp; # remove trailing NL '\n'
  518. m/^(\s*)/;
  519. $count = length($1); # actual indentation
  520. $has_label = 0;
  521. $local_offset = 0;
  522. # character/string literals @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  523. s/\\["']/@@/g; # blind all '"' and "'" escaped by '\' (typically within character literals or string literals)
  524. # handle multi-line string literals to avoid confusion on starting/ending '"' and trailing '\'
  525. if ($in_multiline_string) {
  526. if (s#^([^"]*)"#($1 =~ tr/"/@/cr).'@'#e) { # string literal terminated by '"'
  527. # string contents and its terminating '"' have been blinded as '@'
  528. $count = -1; # do not check indentation
  529. } else {
  530. report("multi-line string literal not terminated by '\"' and trailing '\' is missing")
  531. unless s#^([^\\]*)\s*\\\s*$#$1#; # strip trailing '\' plus any whitespace around
  532. goto LINE_FINISHED;
  533. }
  534. }
  535. # blind contents of character and string literals as @, preserving length (but not spaces)
  536. # this prevents confusing any of the matching below, e.g., of whitespace and comment delimiters
  537. s#('[^']*')#$1 =~ tr/'/@/cr#eg; # handle all intra-line character literals
  538. s#("[^"]*")#$1 =~ tr/"/@/cr#eg; # handle all intra-line string literals
  539. $in_multiline_string = # handle trailing string literal terminated by '\'
  540. s#^(([^"]*"[^"]*")*[^"]*)("[^"]*)\\(\s*)$#$1.($3 =~ tr/"/@/cr).'"'.$4#e;
  541. # its contents have been blinded and the trailing '\' replaced by '"'
  542. # strip any other trailing '\' along with any whitespace around it such that it does not interfere with various matching below
  543. my $trailing_backslash = s#^(.*?)\s*\\\s*$#$1#; # trailing '\' possibly preceded or followed by whitespace
  544. my $essentially_blank_line = m/^\s*$/; # just whitespace and maybe a '\'
  545. # comments @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  546. # do/prepare checks within multi-line comments
  547. my $self_test_exception = $self_test ? "@" : "";
  548. if ($in_comment > 0) { # this still includes the last line of multi-line comment
  549. my ($head, $any_symbol, $cmt_text) = m/^(\s*)(.?)(.*)$/;
  550. if ($any_symbol eq "*") {
  551. report("missing space or '*' after leading '*' in multi-line comment") if $cmt_text =~ m|^[^*\s/$self_test_exception]|;
  552. } else {
  553. report("missing leading '*' in multi-line comment");
  554. }
  555. $in_comment++;
  556. }
  557. # detect end of comment, must be within multi-line comment, check if it is preceded by non-whitespace text
  558. if ((my ($head, $tail) = m|^(.*?)\*/(.*)$|) && $1 ne '/') { # ending comment: '*/'
  559. report("missing space or '*' before '*/'") if $head =~ m/[^*\s]$/;
  560. report("missing space (or ',', ';', ')', '}', ']') after '*/'") if $tail =~ m/^[^\s,;)}\]]/; # no space or ,;)}] after '*/'
  561. if (!($head =~ m|/\*|)) { # not begin of comment '/*', which is is handled below
  562. if ($in_comment == 0) {
  563. report("unexpected '*/' outside comment");
  564. $_ = "$head@@".$tail; # blind the "*/"
  565. } else {
  566. report("text before '*/' in multi-line comment") if ($head =~ m/[^*\s]/); # non-SPC before '*/'
  567. $in_comment = -1; # indicate that multi-line comment ends on current line
  568. if ($count > 0) {
  569. # make indentation of end of multi-line comment appear like of leading intra-line comment
  570. $head =~ s/^(\s*)\s/$1@/; # replace the last leading space by '@'
  571. $count--;
  572. $in_comment = -2; # indicate that multi-line comment ends on current line, with tweak
  573. }
  574. my $cmt_text = $head;
  575. $_ = blind_nonspace($cmt_text)."@@".$tail;
  576. }
  577. }
  578. }
  579. # detect begin of comment, check if it is followed by non-space text
  580. MATCH_COMMENT:
  581. if (my ($head, $opt_minus, $tail) = m|^(.*?)/\*(-?)(.*)$|) { # begin of comment: '/*'
  582. report("missing space before '/*'")
  583. if $head =~ m/[^\s(\*]$/; # not space, '(', or or '*' (needed to allow '*/') before comment delimiter
  584. report("missing space, '*', or '!' after '/*$opt_minus'") if $tail =~ m/^[^\s*!$self_test_exception]/;
  585. my $cmt_text = $opt_minus.$tail; # preliminary
  586. if ($in_comment > 0) {
  587. report("unexpected '/*' inside multi-line comment");
  588. } elsif ($tail =~ m|^(.*?)\*/(.*)$|) { # comment end: */ on same line
  589. report("unexpected '/*' inside intra-line comment") if $1 =~ /\/\*/;
  590. # blind comment text, preserving length and spaces
  591. ($cmt_text, my $rest) = ($opt_minus.$1, $2);
  592. $_ = "$head@@".blind_nonspace($cmt_text)."@@".$rest;
  593. goto MATCH_COMMENT;
  594. } else { # begin of multi-line comment
  595. my $self_test_exception = $self_test ? "(@\d?)?" : "";
  596. report("text after '/*' in multi-line comment")
  597. unless $tail =~ m/^$self_test_exception.?[*\s]*$/;
  598. # tail not essentially blank, first char already checked
  599. # adapt to actual indentation of first line
  600. $comment_indent = length($head) + 1;
  601. $_ = "$head@@".blind_nonspace($cmt_text);
  602. $in_comment = 1;
  603. $leading_comment = $head =~ m/^\s*$/; # there is code before beginning delimiter
  604. $formatted_comment = $opt_minus eq "-";
  605. }
  606. } elsif (($head, $tail) = m|^\{-(.*)$|) { # begin of Perl pragma: '{-'
  607. }
  608. if ($in_comment > 1) { # still inside multi-line comment (not at its begin or end)
  609. m/^(\s*)\*?(\s*)(.*)$/;
  610. $_ = $1."@".$2.blind_nonspace($3);
  611. }
  612. # handle special case of line after '#ifdef __cplusplus' (which typically appears in header files)
  613. if ($ifdef__cplusplus) {
  614. $ifdef__cplusplus = 0;
  615. $_ = "$1 $2" if $contents =~ m/^(\s*extern\s*"C"\s*)\{(\s*)$/; # ignore opening brace in 'extern "C" {'
  616. goto LINE_FINISHED if m/^\s*\}\s*$/; # ignore closing brace '}'
  617. }
  618. # check for over-long lines,
  619. # while allowing trailing (also multi-line) string literals to go past $max_length
  620. my $len = length; # total line length (without trailing '\n')
  621. if ($len > $max_length &&
  622. !(m/^(.*)"[^"]*"\s*[\)\}\]]*[,;]?\s*$/ # string literal terminated by '"' (or '\'), then maybe )}],;
  623. && length($1) < $max_length)
  624. # this allows over-long trailing string literals with beginning col before $max_length
  625. ) {
  626. report("line length = $len > ".MAX_LINE_LENGTH);
  627. }
  628. # handle C++ / C99 - style end-of-line comments
  629. if (my ($head, $cmt_text) = m|^(.*?)//(.*$)|) {
  630. report("'//' end-of-line comment"); # the '//' comment style is not allowed for C90
  631. # blind comment text, preserving length and spaces
  632. $_ = "$head@@".blind_nonspace($cmt_text);
  633. }
  634. # at this point all non-space portions of any types of comments have been blinded as @
  635. goto LINE_FINISHED if $essentially_blank_line;
  636. # handle preprocessor directives @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  637. if (s/^(\s*#)(\s*)(\w+)//) { # line beginning with '#' and directive name;
  638. # blank these portions to prevent confusion with C-level 'if', 'else', etc.
  639. my ($lead, $space) = ($1, $2);
  640. $preproc_directive = $3;
  641. $_ = "$lead$space$preproc_directive$_" if $preproc_directive =~ m/^(define|include)$/; # yet do not blank #define or #include to prevent confusing the indentation or whitespace checks, resp.
  642. $_ = blind_nonspace($_) if $preproc_directive eq "error"; # blind error message
  643. if ($in_preproc != 0) {
  644. report("preprocessor directive within multi-line directive");
  645. reset_indentation_state();
  646. }
  647. $in_preproc++;
  648. report("indent = $count != 0 for '#'") if $count != 0;
  649. report("'#$preproc_directive' with constant condition")
  650. if $preproc_directive =~ m/^(if|elif)$/ && m/^[\W0-9]+$/ && !$trailing_backslash;
  651. $preproc_if_nesting-- if $preproc_directive =~ m/^(else|elif|endif)$/;
  652. if ($preproc_if_nesting < 0) {
  653. $preproc_if_nesting = 0;
  654. report("unexpected '#$preproc_directive' according to '#if' nesting");
  655. }
  656. my $space_count = length($space); # maybe could also use indentation before '#'
  657. report("'#if' nesting indent = $space_count != $preproc_if_nesting") if $space_count != $preproc_if_nesting;
  658. $preproc_if_nesting++ if $preproc_directive =~ m/^(if|ifdef|ifndef|else|elif)$/;
  659. $ifdef__cplusplus = $preproc_directive eq "ifdef" && m/\s+__cplusplus\s*$/;
  660. # handle indentation of preprocessor directive independently of surrounding normal code
  661. $count = -1; # do not check indentation of first line of preprocessor directive
  662. backup_indentation_state();
  663. reset_indentation_state();
  664. }
  665. # intra-line whitespace nits @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  666. my $in_multiline_comment = ($in_comment > 1 || $in_comment < 0); # $in_multiline_comment refers to line before
  667. if (!$sloppy_SPC && !($in_multiline_comment && $formatted_comment)) {
  668. sub extra_SPC {
  669. my $intra_line = shift;
  670. return "extra space".($intra_line =~ m/@\s\s/ ?
  671. $in_comment != 0 ? " in multi-line comment"
  672. : " in intra-line comment" : "");
  673. }
  674. sub split_line_head { # split line contents into header containing leading spaces and the first non-space char, and the rest of the line
  675. my $comment_symbol =
  676. $in_comment != 0 ? "@" : ""; # '@' will match the blinded leading '*' in multi-line comment
  677. # $in_comment may pertain to the following line due to delayed check
  678. # do not check for extra SPC in leading spaces including any '#' (or '*' within multi-line comment)
  679. shift =~ m/^(\s*([#$comment_symbol]\s*)?)(.*?)\s*$/;
  680. return ($1, $3);
  681. }
  682. my ($head , $intra_line ) = split_line_head($_);
  683. my ($head1, $intra_line1) = split_line_head($contents_before_ ) if $line_before > 0;
  684. my ($head2, $intra_line2) = split_line_head($contents_before_2) if $line_before2 > 0;
  685. if ($line_before > 0) { # check with one line delay, such that at least $contents_before is available
  686. sub column_alignments_only { # return 1 if the given line has multiple consecutive spaces only at columns that match the reference line
  687. # all parameter strings are assumed to contain contents after blinding comments etc.
  688. my $head = shift; # leading spaces and the first non-space char
  689. my $intra = shift; # the rest of the line contents
  690. my $contents = shift; # reference line
  691. # check if all extra SPC in $intra is used only for multi-line column alignment with $contents
  692. my $offset = length($head);
  693. for (my $col = 0; $col < length($intra) - 2; $col++) {
  694. my $substr = substr($intra, $col);
  695. next unless $substr =~ m/^\s\s\S/; # extra SPC (but not in leading spaces of the line)
  696. next if !$eol_cmt && $substr =~ m/^[@\s]+$/; # end-of-line comment
  697. return 0 unless substr($contents, $col + $offset + 1, 2) =~ m/\s\S/; # reference line contents do not match
  698. }
  699. return 1;
  700. }
  701. report_flexibly($line_before, extra_SPC($intra_line1), $contents_before) if $intra_line1 =~ m/\s\s\S/ &&
  702. !( column_alignments_only($head1, $intra_line1, $_ ) # compare with $line
  703. || ($line_before2 > 0 &&
  704. column_alignments_only($head1, $intra_line1, $contents_before_2))); # compare w/ $line_before2
  705. report(extra_SPC($intra_line)) if $intra_line =~ m/\s\s\S/ && eof
  706. && ! column_alignments_only($head , $intra_line , $contents_before_ ) ; # compare w/ $line_before
  707. } elsif (eof) { # special case: just one line exists
  708. report(extra_SPC($intra_line)) if $intra_line =~ m/\s\s\S/;
  709. }
  710. # ignore paths in #include
  711. $intra_line =~ s/^(include\s*)(".*?"|<.*?>)/$1/e if $head =~ m/#/;
  712. report("missing space before '$2'")
  713. if $intra_line =~ m/(\S)((<<|>>)=)/ # '<<=' or >>=' without preceding space
  714. || ($intra_line =~ m/(\S)([\+\-\*\/\/%\&\|\^\!<>=]=)/
  715. && "$1$2" ne "<<=" && "$1$2" ne ">>=") # other <op>= or (in)equality without preceding space
  716. || ($intra_line =~ m/(\S)=/
  717. && !($1 =~ m/[\+\-\*\/\/%\&\|\^\!<>=]/)
  718. && $intra_line =~ m/(\S)(=)/); # otherwise, '=' without preceding space
  719. # treat op= and comparison operators as simple '=', simplifying matching below
  720. $intra_line =~ s/(<<|>>|[\+\-\*\/\/%\&\|\^\!<>=])=/=/g;
  721. # treat (type) variables within macro, indicated by trailing '\', as 'int' simplifying matching below
  722. $intra_line =~ s/[A-Z_]+/int/g if $trailing_backslash;
  723. # treat double &&, ||, <<, and >> as single ones, simplifying matching below
  724. $intra_line =~ s/(&&|\|\||<<|>>)/substr($1, 0, 1)/eg;
  725. # remove blinded comments etc. directly after [{(
  726. while ($intra_line =~ s/([\[\{\(])@+\s?/$1/e) {} # /g does not work here
  727. # remove blinded comments etc. directly before ,;)}]
  728. while ($intra_line =~ s/\s?@+([,;\)\}\]])/$1/e) {} # /g does not work here
  729. # treat remaining blinded comments and string literal contents as (single) space during matching below
  730. $intra_line =~ s/@+/ /g; # note that extra SPC has already been handled above
  731. $intra_line =~ s/\s+$//; # strip any (resulting) space at EOL
  732. # replace ';;' or '; ;' by ';' in "for(;;)" and in "for (...)" unless "..." contains just SPC and ';' characters:
  733. $intra_line =~ s/((^|\W)for\s*\()([^;]*?)(\s*)(;\s?);(\s*)([^;]*)(\))/
  734. "$1$3$4".("$3$4$5$6$7" eq ";" || $3 ne "" || $7 ne "" ? "" : $5).";$6$7$8"/eg;
  735. # strip trailing ';' or '; ' in "for (...)" except in "for (;;)" or "for (;; )":
  736. $intra_line =~ s/((^|\W)for\s*\()([^;]*(;[^;]*)?)(;\s?)(\))/
  737. "$1$3".($3 eq ";" ? $5 : "")."$6"/eg;
  738. $intra_line =~ s/(=\s*)\{ /"$1@ "/eg; # do not report {SPC in initializers such as ' = { 0, };'
  739. $intra_line =~ s/, \};/, @;/g; # do not report SPC} in initializers such as ' = { 0, };'
  740. report("space before '$1'") if $intra_line =~ m/[\w)\]]\s+(\+\+|--)/; # postfix ++/-- with preceding space
  741. report("space after '$1'") if $intra_line =~ m/(\+\+|--)\s+[a-zA-Z_(]/; # prefix ++/-- with following space
  742. $intra_line =~ s/\.\.\./@/g; # blind '...'
  743. report("space before '$1'") if $intra_line =~ m/\s(\.|->)/; # '.' or '->' with preceding space
  744. report("space after '$1'") if $intra_line =~ m/(\.|->)\s/; # '.' or '->' with following space
  745. $intra_line =~ s/\-\>|\+\+|\-\-/@/g; # blind '->,', '++', and '--'
  746. report("space before '$1'") if $intra_line =~ m/[^:)]\s+(;)/; # space before ';' but not after ':' or ')' # note that
  747. # exceptions for "for (;; )" are handled above
  748. report("space before '$1'") if $intra_line =~ m/\s([,)\]])/; # space before ,)]
  749. report("space after '$1'") if $intra_line =~ m/([(\[~!])\s/; # space after ([~!
  750. report("space after '$1'") if $intra_line =~ m/(defined)\s/; # space after 'defined'
  751. report("missing space before '$1'") if $intra_line =~ m/\S([|\/%<>^\?])/; # |/%<>^? without preceding space
  752. # TODO ternary ':' without preceding SPC, while allowing no SPC before ':' after 'case'
  753. report("missing space before binary '$2'") if $intra_line =~ m/([^\s{()\[e])([+\-])/; # '+'/'-' without preceding space or {()[e
  754. # ')' may be used for type casts or before "->", 'e' may be used for numerical literals such as "1e-6"
  755. report("missing space before binary '$1'") if $intra_line =~ m/[^\s{()\[*!]([*])/; # '*' without preceding space or {()[*!
  756. report("missing space before binary '$1'") if $intra_line =~ m/[^\s{()\[]([&])/; # '&' without preceding space or {()[
  757. report("missing space after ternary '$1'") if $intra_line =~ m/(:)[^\s\d]/; # ':' without following space or digit
  758. report("missing space after '$1'") if $intra_line =~ m/([,;=|\/%<>^\?])\S/; # ,;=|/%<>^? without following space
  759. report("missing space after binary '$1'") if $intra_line=~m/[^{(\[]([*])[^\sa-zA-Z_(),*]/;# '*' w/o space or \w(),* after
  760. # TODO unary '*' must not be followed by SPC
  761. report("missing space after binary '$1'") if $intra_line=~m/([&])[^\sa-zA-Z_(]/; # '&' w/o following space or \w(
  762. # TODO unary '&' must not be followed by SPC
  763. report("missing space after binary '$1'") if $intra_line=~m/[^{(\[]([+\-])[^\s\d(]/; # +/- w/o following space or \d(
  764. # TODO unary '+' and '-' must not be followed by SPC
  765. report("missing space after '$2'") if $intra_line =~ m/(^|\W)(if|while|for|switch|case)[^\w\s]/; # kw w/o SPC
  766. report("missing space after '$2'") if $intra_line =~ m/(^|\W)(return)[^\w\s;]/; # return w/o SPC or ';'
  767. report("space after function/macro name")
  768. if $intra_line =~ m/(\w+)\s+\(/ # fn/macro name with space before '('
  769. && !($1 =~ m/^(sizeof|if|else|while|do|for|switch|case|default|break|continue|goto|return|void|char|signed|unsigned|int|short|long|float|double|typedef|enum|struct|union|auto|extern|static|const|volatile|register)$/) # not keyword
  770. && !(m/^\s*#\s*define\s+\w+\s+\(/); # not a macro without parameters having a body that starts with '('
  771. report("missing space before '{'") if $intra_line =~ m/[^\s{(\[]\{/; # '{' without preceding space or {([
  772. report("missing space after '}'") if $intra_line =~ m/\}[^\s,;\])}]/; # '}' without following space or ,;])}
  773. }
  774. # adapt required indentation @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  775. s/(\w*ASN1_[A-Z_]+END\w*([^(]|\(.*?\)|$))/$1;/g; # treat *ASN1_*END*(..) macro calls as if followed by ';'
  776. my $nested_indents_position = 0;
  777. # update indents according to leading closing brace(s) '}' or label or switch case
  778. my $in_stmt = $in_expr || @nested_symbols != 0 || $in_typedecl != 0;
  779. if ($in_stmt) { # expr/stmt/type decl/var def/fn hdr, i.e., not at block level
  780. if (m/^([\s@]*\})/) { # leading '}' within stmt, any preceding blinded comment must not be matched
  781. $in_block_decls = -1;
  782. my $head = $1;
  783. update_nested_indents($head);
  784. $nested_indents_position = length($head);
  785. if (@nested_symbols >= 1) {
  786. $hanging_symbol = @nested_symbols[-1];
  787. $expr_indent = @nested_indents[-1];
  788. } else { # typically end of initialiizer expr or enum
  789. $expr_indent = 0;
  790. }
  791. } elsif (m/^([\s@]*)(static_)?ASN1_ITEM_TEMPLATE_END(\W|$)/) { # workaround for ASN1 macro indented as '}'
  792. $local_offset = -INDENT_LEVEL;
  793. $expr_indent = 0;
  794. } elsif (m/;.*?\}/) { # expr ends with ';' before '}'
  795. report("code before '}'");
  796. }
  797. }
  798. if (@in_do_hanging_offsets != 0 && # note there is nothing like "unexpected 'while'"
  799. m/^[\s@]*while(\W|$)/) { # leading 'while'
  800. $hanging_offset = pop @in_do_hanging_offsets;
  801. }
  802. if ($if_maybe_terminated) {
  803. if (m/(^|\W)else(\W|$)/) { # (not necessarily leading) 'else'
  804. if (@in_if_hanging_offsets == 0) {
  805. report("unexpected 'else'");
  806. } else {
  807. $hanging_offset = pop @in_if_hanging_offsets;
  808. }
  809. } else {
  810. @in_if_hanging_offsets = (); # note there is nothing like "unclosed 'if'"
  811. $hanging_offset = 0;
  812. }
  813. }
  814. if (!$in_stmt) { # at block level, i.e., outside expr/stmt/type decl/var def/fn hdr
  815. $if_maybe_terminated = 0;
  816. if (my ($head, $before, $tail) = m/^([\s@]*([^{}]*)\})[\s@]*(.*)$/) { # leading closing '}', but possibly
  817. # with non-whitespace non-'{' before
  818. report("code after '}'") unless $tail eq "" || $tail =~ m/(else|while|OSSL_TRACE_END)(\W|$)/;
  819. my $outermost_level = @nested_block_indents == 1 && @nested_block_indents[0] == 0;
  820. if (!$sloppy_bodylen && $outermost_level && $line_body_start != 0) {
  821. my $body_len = $line - $line_body_start - 1;
  822. report_flexibly($line_function_start, "function body length = $body_len > ".MAX_BODY_LENGTH." lines",
  823. $last_function_header) if $body_len > MAX_BODY_LENGTH;
  824. $line_body_start = 0;
  825. }
  826. if ($before ne "") { # non-whitespace non-'{' before '}'
  827. report("code before '}'");
  828. } else { # leading '}' outside stmt, any preceding blinded comment must not be matched
  829. $in_block_decls = -1;
  830. $local_offset = $block_indent + $hanging_offset - INDENT_LEVEL;
  831. update_nested_indents($head);
  832. $nested_indents_position = length($head);
  833. $local_offset -= ($block_indent + $hanging_offset);
  834. # in effect $local_offset = -INDENT_LEVEL relative to $block_indent + $hanging_offset values before
  835. }
  836. }
  837. # handle opening brace '{' after if/else/while/for/switch/do on line before
  838. if ($hanging_offset > 0 && m/^[\s@]*{/ && # leading opening '{'
  839. $line_before > 0 &&
  840. $contents_before_ =~ m/(^|^.*\W)(if|else|while|for|switch|do)(\W.*$|$)/) {
  841. $keyword_opening_brace = $1;
  842. $hanging_offset -= INDENT_LEVEL; # cancel newly hanging_offset
  843. }
  844. if (m/^[\s@]*(case|default)(\W.*$|$)/) { # leading 'case' or 'default'
  845. my $keyword = $1;
  846. report("code after $keyword: ") if $2 =~ /:.*[^\s@].*$/;
  847. $local_offset = -INDENT_LEVEL;
  848. } else {
  849. if (m/^([\s@]*)(\w+):/) { # (leading) label, cannot be "default"
  850. $local_offset = -INDENT_LEVEL;
  851. $has_label = 1;
  852. }
  853. }
  854. }
  855. # potential adaptations of indent in first line of macro body in multi-line macro definition
  856. if ($in_preproc != 0 && $in_macro_header > 0) {
  857. if ($in_macro_header > 1) { # still in macro definition header
  858. $in_macro_header += parens_balance($_);
  859. } else { # begin of macro body
  860. $in_macro_header = 0;
  861. if ($count == $block_indent - $preproc_offset # body began with same indentation as preceding code
  862. && $sloppy_macro) { # workaround for this situation is enabled
  863. $block_indent -= $preproc_offset;
  864. $preproc_offset = 0;
  865. }
  866. }
  867. }
  868. # check required indentation @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  869. check_indent() if $count >= 0; # not for start of preprocessor directive and not if multi-line string literal is continued
  870. # check for blank lines within/after local decls @@@@@@@@@@@@@@@@@@@@@@@@@@@
  871. if ($in_block_decls >= 0 &&
  872. $in_comment == 0 && !m/^\s*\*?@/ && # not in a multi-line or intra-line comment
  873. !$in_expr && $expr_indent == 0 && $in_typedecl == 0) {
  874. my $blank_line_before = $line > 1 && $code_contents_before =~ m/^\s*(\\\s*)?$/;
  875. # essentially blank line before: just whitespace and maybe a '\'
  876. if (m/^[\s(]*(char|signed|unsigned|int|short|long|float|double|enum|struct|union|auto|extern|static|const|volatile|register)(\W|$)/ # clear start of local decl
  877. || (m/^(\s*(\w+|\[\]|[\*()]))+?\s+[\*\(]*\w+(\s*(\)|\[[^\]]*\]))*\s*[;,=]/ # weak check for decl involving user-defined type
  878. && !m/^\s*(\}|sizeof|if|else|while|do|for|switch|case|default|break|continue|goto|return)(\W|$)/)) {
  879. $in_block_decls++;
  880. report_flexibly($line - 1, "blank line within local decls, before", $contents) if $blank_line_before;
  881. } else {
  882. report_flexibly($line, "missing blank line after local decls", "\n$contents_before$contents")
  883. if $in_block_decls > 0 && !$blank_line_before;
  884. $in_block_decls = -1 unless
  885. m/^\s*(\\\s*)?$/ # essentially blank line: just whitespace (and maybe a trailing '\')
  886. || $in_comment != 0 || m/^\s*\*?@/; # in multi-line comment or an intra-line comment
  887. }
  888. }
  889. $in_comment = 0 if $in_comment < 0; # multi-line comment has ended
  890. # do some further checks @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  891. my $outermost_level = $block_indent - $preproc_offset == 0;
  892. report("more than one stmt") if !m/(^|\W)for(\W.*|$)/ && # no 'for' - TODO improve matching
  893. m/;.*;/; # two or more terminators ';', so more than one statement
  894. # check for code block containing a single line/statement
  895. if ($line_before2 > 0 && !$outermost_level && # within function body
  896. $in_typedecl == 0 && @nested_indents == 0 && # neither within type declaration nor inside stmt/expr
  897. m/^[\s@]*\}/) { # leading closing brace '}', any preceding blinded comment must not be matched
  898. # TODO extend detection from single-line to potentially multi-line statement
  899. if ($line_opening_brace > 0 &&
  900. ($line_opening_brace == $line_before2 ||
  901. $line_opening_brace == $line_before)
  902. && $contents_before =~ m/;/) { # there is at least one terminator ';', so there is some stmt
  903. # TODO do not report cases where a further else branch
  904. # follows with a block containing more than one line/statement
  905. report_flexibly($line_before, "'$keyword_opening_brace' { 1 stmt }", $contents_before);
  906. }
  907. }
  908. report("single-letter name '$2'") if (m/(^|.*\W)([IO])(\W.*|$)/); # single-letter name 'I' or 'O' # maybe re-add 'l'?
  909. # constant on LHS of comparison or assignment, e.g., NULL != x or 'a' < c, but not a + 1 == b
  910. report("constant on LHS of '$3'")
  911. if (m/(['"]|([\+\-\*\/\/%\&\|\^<>]\s*)?\W[0-9]+L?|\WNULL)\s*([\!<>=]=|[<=>])([<>]?)/ &&
  912. $2 eq "" && (($3 ne "<" && $3 ne "='" && $3 ne ">") || $4 eq ""));
  913. # TODO report needless use of parentheses, while
  914. # macro parameters should always be in parens (except when passed on), e.g., '#define ID(x) (x)'
  915. # adapt required indentation for following lines @@@@@@@@@@@@@@@@@@@@@@@@@@@
  916. # set $in_expr, $in_paren_expr, and $hanging_offset for if/while/for/switch, return/enum, and assignment RHS
  917. my $paren_expr_start = 0;
  918. my $return_enum_start = 0;
  919. my $assignment_start = 0;
  920. my $tmp = $_;
  921. $tmp =~ s/[\!<>=]=/@@/g; # blind (in-)equality symbols like '<=' as '@@' to prevent matching them as '=' below
  922. if (m/^((^|.*\W)(if|while|for|switch))(\W.*|$)$/) { # (last) if/for/while/switch
  923. $paren_expr_start = 1;
  924. } elsif (m/^((^|.*\W)(return|enum))(\W.*|$)/ # (last) return/enum
  925. && !$in_expr && @nested_indents == 0 && parens_balance($1) == 0) { # not nested enum
  926. $return_enum_start = 1;
  927. } elsif ($tmp =~ m/^(([^=]*)(=))(.*)$/ # (last) '=', i.e., assignment
  928. && !$in_expr && @nested_indents == 0 && parens_balance($1) == 0) { # not nested assignment
  929. $assignment_start = 1;
  930. }
  931. if ($paren_expr_start || $return_enum_start || $assignment_start)
  932. {
  933. my ($head, $mid, $tail) = ($1, $3, $4);
  934. $keyword_opening_brace = $mid if $mid ne "=";
  935. # to cope with multi-line expressions, do this also if !($tail =~ m/\{/)
  936. push @in_if_hanging_offsets, $hanging_offset if $mid eq "if";
  937. # already handle $head, i.e., anything before expression
  938. update_nested_indents($head, $nested_indents_position);
  939. $nested_indents_position = length($head);
  940. # now can set $in_expr and $in_paren_expr
  941. $in_expr = 1;
  942. $in_paren_expr = 1 if $paren_expr_start;
  943. if ($mid eq "while" && @in_do_hanging_offsets != 0) {
  944. $hanging_offset = pop @in_do_hanging_offsets;
  945. } else {
  946. $hanging_offset += INDENT_LEVEL; # tentatively set hanging_offset, may be canceled by following '{'
  947. }
  948. }
  949. # set $hanging_offset and $keyword_opening_brace for do/else
  950. if (my ($head, $mid, $tail) = m/(^|^.*\W)(else|do)(\W.*|$)$/) { # last else/do, where 'do' is preferred, but not #else
  951. my $code_before = $head =~ m/[^\s\@}]/; # leading non-whitespace non-comment non-'}'
  952. report("code before '$mid'") if $code_before;
  953. report("code after '$mid'" ) if $tail =~ m/[^\s\@{]/# trailing non-whitespace non-comment non-'{' (non-'\')
  954. && !($mid eq "else" && $tail =~ m/[\s@]*if(\W|$)/);
  955. if ($mid eq "do") { # workarounds for code before 'do'
  956. if ($head =~ m/(^|^.*\W)(else)(\W.*$|$)/) { # 'else' ... 'do'
  957. $hanging_offset += INDENT_LEVEL; # tentatively set hanging_offset, may be canceled by following '{'
  958. }
  959. if ($head =~ m/;/) { # terminator ';' ... 'do'
  960. @in_if_hanging_offsets = (); # note there is nothing like "unclosed 'if'"
  961. $hanging_offset = 0;
  962. }
  963. }
  964. push @in_do_hanging_offsets, $hanging_offset if $mid eq "do";
  965. if ($code_before && $mid eq "do") {
  966. $hanging_offset = length($head) - $block_indent;
  967. }
  968. if (!$in_paren_expr) {
  969. $keyword_opening_brace = $mid if $tail =~ m/\{/;
  970. $hanging_offset += INDENT_LEVEL;
  971. }
  972. }
  973. # set $in_typedecl and potentially $hanging_offset for type declaration
  974. if (!$in_expr && @nested_indents == 0 # not in expression
  975. && m/(^|^.*\W)(typedef|enum|struct|union)(\W.*|$)$/
  976. && parens_balance($1) == 0 # not in newly started expression or function arg list
  977. && ($2 eq "typedef" || !($3 =~ m/\s*\w++\s*(.)/ && $1 ne "{")) # 'struct'/'union'/'enum' <name> not followed by '{'
  978. # not needed: && $keyword_opening_brace = $2 if $3 =~ m/\{/;
  979. ) {
  980. $in_typedecl++;
  981. $hanging_offset += INDENT_LEVEL if m/\*.*\(/; # '*' followed by '(' - seems consistent with Emacs C mode
  982. }
  983. my $local_in_expr = $in_expr;
  984. my $terminator_position = update_nested_indents($_, $nested_indents_position);
  985. if ($local_in_expr) {
  986. # on end of non-if/while/for/switch (multi-line) expression (i.e., return/enum/assignment) and
  987. # on end of statement/type declaration/variable definition/function header
  988. if ($terminator_position >= 0 && ($in_typedecl == 0 || @nested_indents == 0)) {
  989. check_nested_nonblock_indents("expr");
  990. $in_expr = 0;
  991. }
  992. } else {
  993. check_nested_nonblock_indents($in_typedecl == 0 ? "stmt" : "decl") if $terminator_position >= 0;
  994. }
  995. # on ';', which terminates the current statement/type declaration/variable definition/function declaration
  996. if ($terminator_position >= 0) {
  997. my $tail = substr($_, $terminator_position + 1);
  998. if (@in_if_hanging_offsets != 0) {
  999. if ($tail =~ m/\s*else(\W|$)/) {
  1000. pop @in_if_hanging_offsets;
  1001. $hanging_offset -= INDENT_LEVEL;
  1002. } elsif ($tail =~ m/[^\s@]/) { # code (not just comment) follows
  1003. @in_if_hanging_offsets = (); # note there is nothing like "unclosed 'if'"
  1004. $hanging_offset = 0;
  1005. } else {
  1006. $if_maybe_terminated = 1;
  1007. }
  1008. } elsif ($tail =~ m/^[\s@]*$/) { # ';' has been trailing, i.e. there is nothing but whitespace and comments
  1009. $hanging_offset = 0; # reset in case of terminated assignment ('=') etc.
  1010. }
  1011. $in_typedecl-- if $in_typedecl != 0 && @nested_in_typedecl == 0; # TODO handle multiple type decls per line
  1012. m/(;[^;]*)$/; # match last ';'
  1013. $terminator_position = length($_) - length($1) if $1;
  1014. # new $terminator_position value may be after the earlier one in case multiple terminators on current line
  1015. # TODO check treatment in case of multiple terminators on current line
  1016. update_nested_indents($_, $terminator_position + 1);
  1017. }
  1018. # set hanging expression indent according to nested indents - TODO maybe do better in update_nested_indents()
  1019. # also if $in_expr is 0: in statement/type declaration/variable definition/function header
  1020. $expr_indent = 0;
  1021. for (my $i = -1; $i >= -@nested_symbols; $i--) {
  1022. if (@nested_symbols[$i] ne "?") { # conditionals '?' ... ':' are treated specially in check_indent()
  1023. $hanging_symbol = @nested_symbols[$i];
  1024. $expr_indent = $nested_indents[$i];
  1025. # $expr_indent is guaranteed to be != 0 unless @nested_indents contains just outer conditionals
  1026. last;
  1027. }
  1028. }
  1029. # remember line number and header containing name of last function defined for reports w.r.t. MAX_BODY_LENGTH
  1030. if ($in_preproc == 0 && $outermost_level && m/(\w+)\s*\(/ && $1 ne "STACK_OF") {
  1031. $line_function_start = $line;
  1032. $last_function_header = $contents;
  1033. }
  1034. # special checks for last, typically trailing opening brace '{' in line
  1035. if (my ($head, $tail) = m/^(.*)\{(.*)$/) { # match last ... '{'
  1036. if (!$in_expr && $in_typedecl == 0) {
  1037. if ($outermost_level) {
  1038. if (!$assignment_start && !$local_in_expr) {
  1039. # at end of function definition header (or stmt or var definition)
  1040. report("'{' not at line start") if length($head) != $preproc_offset && $head =~ m/\)\s*/; # at end of function definition header
  1041. $line_body_start = $contents =~ m/LONG BODY/ ? 0 : $line if $line_function_start != 0;
  1042. }
  1043. } else {
  1044. $line_opening_brace = $line if $keyword_opening_brace =~ m/do|while|for/;
  1045. # using, not assigning, $keyword_opening_brace here because it could be on an earlier line
  1046. $line_opening_brace = $line if $keyword_opening_brace =~ m/if|else/ && $extended_1_stmt &&
  1047. # TODO prevent false positives for if/else where braces around single-statement branches
  1048. # should be avoided but only if all branches have just single statements
  1049. # The following helps detecting the exception when handling multiple 'if ... else' branches:
  1050. !($keyword_opening_brace eq "else" && $line_opening_brace < $line_before2);
  1051. }
  1052. report("code after '{'") if $tail=~ m/[^\s\@]/ && # trailing non-whitespace non-comment (non-'\')
  1053. !($tail=~ m/\}/); # missing '}' after last '{'
  1054. }
  1055. }
  1056. # check for opening brace after if/while/for/switch/do not on same line
  1057. # note that "missing '{' on same line after '} else'" is handled further below
  1058. if (/^[\s@]*{/ && # leading '{'
  1059. $line_before > 0 && !($contents_before_ =~ m/^\s*#/) && # not preprocessor directive '#if
  1060. (my ($head, $mid, $tail) = ($contents_before_ =~ m/(^|^.*\W)(if|while|for|switch|do)(\W.*$|$)/))) {
  1061. my $brace_after = $tail =~ /^[\s@]*{/; # any whitespace or comments then '{'
  1062. report("'{' not on same line as preceding '$mid'") if !$brace_after;
  1063. }
  1064. # check for closing brace on line before 'else' not followed by leading '{'
  1065. elsif (my ($head, $tail) = m/(^|^.*\W)else(\W.*$|$)/) {
  1066. if (parens_balance($tail) == 0 && # avoid false positive due to unfinished expr on current line
  1067. !($tail =~ m/{/) && # after 'else' missing '{' on same line
  1068. !($head =~ m/}[\s@]*$/) && # not: '}' then any whitespace or comments before 'else'
  1069. $line_before > 0 && $contents_before_ =~ /}[\s@]*$/) { # trailing '}' on line before
  1070. report("missing '{' on same line after '} else'");
  1071. }
  1072. }
  1073. # check for closing brace before 'while' not on same line
  1074. if (my ($head, $tail) = m/(^|^.*\W)while(\W.*$|$)/) {
  1075. my $brace_before = $head =~ m/}[\s@]*$/; # '}' then any whitespace or comments
  1076. # possibly 'if (...)' (with potentially inner '(' and ')') then any whitespace or comments then '{'
  1077. if (!$brace_before &&
  1078. # does not work here: @in_do_hanging_offsets != 0 && #'while' terminates loop
  1079. parens_balance($tail) == 0 && # avoid false positive due to unfinished expr on current line
  1080. $tail =~ /;/ && # 'while' terminates loop (by ';')
  1081. $line_before > 0 &&
  1082. $contents_before_ =~ /}[\s@]*$/) { # on line before: '}' then any whitespace or comments
  1083. report("'while' not on same line as preceding '}'");
  1084. }
  1085. }
  1086. # check for missing brace on same line before or after 'else'
  1087. if (my ($head, $tail) = m/(^|^.*\W)else(\W.*$|$)/) {
  1088. my $brace_before = $head =~ /}[\s@]*$/; # '}' then any whitespace or comments
  1089. my $brace_after = $tail =~ /^[\s@]*if[\s@]*\(.*\)[\s@]*{|[\s@]*{/;
  1090. # possibly 'if (...)' (with potentially inner '(' and ')') then any whitespace or comments then '{'
  1091. if (!$brace_before) {
  1092. if ($line_before > 0 && $contents_before_ =~ /}[\s@]*$/) {
  1093. report("'else' not on same line as preceding '}'");
  1094. } elsif (parens_balance($tail) == 0) { # avoid false positive due to unfinished expr on current line
  1095. report("missing '}' on same line before 'else ... {'") if $brace_after;
  1096. }
  1097. } elsif (parens_balance($tail) == 0) { # avoid false positive due to unfinished expr on current line
  1098. report("missing '{' on same line after '} else'") if $brace_before && !$brace_after;
  1099. }
  1100. }
  1101. # on begin of multi-line preprocessor directive, adapt indent
  1102. if ($in_comment == 0 && $trailing_backslash) {
  1103. # trailing '\'typically used in preprocessor directive like '#define'
  1104. if ($in_preproc == 1) { # start of multi-line preprocessor directive
  1105. # note that backup+reset_indentation_state() has already been called
  1106. $in_macro_header = m/^\s*#\s*define(\W|$)?(.*)/ ? 1 + parens_balance($2) : 0; # '#define' is beginning
  1107. $preproc_offset = INDENT_LEVEL;
  1108. $block_indent = $preproc_offset;
  1109. }
  1110. $in_preproc += 1;
  1111. }
  1112. # post-processing at end of line @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  1113. LINE_FINISHED:
  1114. $code_contents_before = $contents if
  1115. !m/^\s*#(\s*)(\w+)/ && # not single-line preprocessor directive
  1116. $in_comment == 0 && !m/^\s*\*?@/; # not in a multi-line comment nor in an intra-line comment
  1117. # on end of (possibly multi-line) preprocessor directive, adapt indent
  1118. if ($in_preproc != 0 && !$trailing_backslash) { # no trailing '\'
  1119. $in_preproc = 0;
  1120. $preproc_offset = 0;
  1121. restore_indentation_state();
  1122. }
  1123. if ($essentially_blank_line) {
  1124. report("leading ".($1 eq "" ? "blank" :"whitespace")." line") if $line == 1 && !$sloppy_SPC;
  1125. } else {
  1126. if ($line_before > 0) {
  1127. my $linediff = $line - $line_before - 1;
  1128. report("$linediff blank lines before") if $linediff > 1 && !$sloppy_SPC;
  1129. }
  1130. $line_before2 = $line_before;
  1131. $contents_before2 = $contents_before;
  1132. $contents_before_2 = $contents_before_;
  1133. $line_before = $line;
  1134. $contents_before = $contents;
  1135. $contents_before_ = $_;
  1136. $count_before = $count;
  1137. }
  1138. if ($self_test) { # debugging
  1139. my $should_report = $contents =~ m/\*@(\d)?/ ? 1 : 0;
  1140. $should_report = +$1 if $should_report != 0 && defined $1;
  1141. print("$ARGV:$line:$num_reports_line reports on:$contents")
  1142. if $num_reports_line != $should_report;
  1143. }
  1144. $num_reports_line = 0;
  1145. # post-processing at end of file @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  1146. if (eof) {
  1147. # check for essentially blank line (which may include a '\') just before EOF
  1148. report(($1 eq "\n" ? "blank line" : $2 ne "" ? "'\\'" : "whitespace")." at EOF")
  1149. if $contents =~ m/^(\s*(\\?)\s*)$/ && !$sloppy_SPC;
  1150. # report unclosed expression-level nesting
  1151. check_nested_nonblock_indents("expr at EOF"); # also adapts @nested_block_indents
  1152. # sanity-check balance of block-level { ... } via final $block_indent at end of file
  1153. report_flexibly($line, +@nested_block_indents." unclosed '{'", "(EOF)\n") if @nested_block_indents != 0;
  1154. # sanity-check balance of #if ... #endif via final preprocessor directive indent at end of file
  1155. report_flexibly($line, "$preproc_if_nesting unclosed '#if'", "(EOF)\n") if $preproc_if_nesting != 0;
  1156. reset_file_state();
  1157. }
  1158. }
  1159. # final summary report @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  1160. my $num_other_reports = $num_reports - $num_indent_reports - $num_nesting_issues
  1161. - $num_syntax_issues - $num_SPC_reports - $num_length_reports;
  1162. print "$num_reports ($num_indent_reports indentation, $num_nesting_issues '#if' nesting indent, ".
  1163. "$num_syntax_issues syntax, $num_SPC_reports whitespace, $num_length_reports length, $num_other_reports other)".
  1164. " issues have been found by $0\n" if $num_reports != 0 && !$self_test;