| 1 | /*
|
|---|
| 2 | * Copyright 2007-2023 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 3 | * Copyright Siemens AG 2015-2022
|
|---|
| 4 | *
|
|---|
| 5 | * Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 6 | * this file except in compliance with the License. You can obtain a copy
|
|---|
| 7 | * in the file LICENSE in the source distribution or at
|
|---|
| 8 | * https://www.openssl.org/source/license.html
|
|---|
| 9 | */
|
|---|
| 10 |
|
|---|
| 11 | /*
|
|---|
| 12 | * This demonstrates/tests cases where check-format.pl should report issues.
|
|---|
| 13 | * Some of the reports are due to sanity checks for proper nesting of comment
|
|---|
| 14 | * delimiters and parenthesis-like symbols, e.g., on unexpected/unclosed braces.
|
|---|
| 15 | */
|
|---|
| 16 |
|
|---|
| 17 | /*
|
|---|
| 18 | * The '@'s after '*' are used for self-tests: they mark lines containing
|
|---|
| 19 | * a single flaw that should be reported. Normally it should be reported
|
|---|
| 20 | * while handling the given line, but in case of delayed checks there is a
|
|---|
| 21 | * following digit indicating the number of reports expected for this line.
|
|---|
| 22 | */
|
|---|
| 23 |
|
|---|
| 24 | /* For each of the following set of lines the tool should complain once */
|
|---|
| 25 | /*@ tab character: */
|
|---|
| 26 | /*@ intra-line carriage return character:
|
|---|
| 27 | */
|
|---|
| 28 | /*@ non-printable ASCII character: */
|
|---|
| 29 | /*@ non-ASCII character: ä */
|
|---|
| 30 | /*@ whitespace at EOL: */
|
|---|
| 31 | // /*@ end-of-line comment style not allowed (for C90 compatibility) */
|
|---|
| 32 | /*@0 intra-line comment indent off by 1, reported unless sloppy-cmt */
|
|---|
| 33 | /*X */ /*@2 missing spc or '*' after comment start reported unless sloppy-spc */
|
|---|
| 34 | /* X*/ /*@ missing space before comment end , reported unless sloppy-spc */
|
|---|
| 35 | /*@ comment starting delimiter: /* inside intra-line comment */
|
|---|
| 36 | /*@0
|
|---|
| 37 | *@ above multi-line comment start indent off by 1, reported unless sloppy-cmt; this comment line is too long
|
|---|
| 38 | *@ multi-line comment indent further off by 1 relative to comment start
|
|---|
| 39 | *@ multi-line comment ending with text on last line */
|
|---|
| 40 | /*@2 multi-line comment starting with text on first line
|
|---|
| 41 | *@ comment starting delimiter: /* inside multi-line comment
|
|---|
| 42 | *@ multi-line comment indent off by -1
|
|---|
| 43 | *X*@ no spc after leading '*' in multi-line comment, reported unless sloppy-spc
|
|---|
| 44 | *@0 more than two spaces after . in comment, no more reported
|
|---|
| 45 | *@0 more than two spaces after ? in comment, no more reported
|
|---|
| 46 | *@0 more than two spaces after ! in comment, no more reported
|
|---|
| 47 | */ /*@ multi-line comment end indent off by -1 (relative to comment start) */
|
|---|
| 48 | */ /*@ unexpected comment ending delimiter outside comment */
|
|---|
| 49 | /*- '-' for formatted comment not allowed in intra-line comment */
|
|---|
| 50 | /*@ comment line is 4 columns tooooooooooooooooo wide, reported unless sloppy-len */
|
|---|
| 51 | /*@ comment line is 5 columns toooooooooooooooooooooooooooooooooooooooooooooo wide */
|
|---|
| 52 | #if ~0 /*@ '#if' with constant condition */
|
|---|
| 53 | #endif /*@ indent of preproc. directive off by 1 (must be 0) */
|
|---|
| 54 | #define X (1 + 1) /*@0 extra space in body, reported unless sloppy-spc */
|
|---|
| 55 | #define Y 1 /*@ extra space before body, reported unless sloppy-spc */ \
|
|---|
| 56 | #define Z /*@2 preprocessor directive within multi-line directive */
|
|---|
| 57 | typedef struct { /*@0 extra space in code, reported unless sloppy-spc */
|
|---|
| 58 | enum { /*@1 extra space in intra-line comment, no more reported */
|
|---|
| 59 | w = 0 /*@ hanging expr indent off by 1, or 3 for lines after '{' */
|
|---|
| 60 | && 1, /*@ hanging expr indent off by 3, or -1 for leading '&&' */
|
|---|
| 61 | x = 1, /*@ hanging expr indent off by -1 */
|
|---|
| 62 | y,z /*@ no space after ',', reported unless sloppy-spc */
|
|---|
| 63 | } e_member ; /*@ space before ';', reported unless sloppy-spc */
|
|---|
| 64 | int v[1; /*@ unclosed bracket in type declaration */
|
|---|
| 65 | union { /*@ statement/type declaration indent off by -1 */
|
|---|
| 66 | struct{} s; /*@ no space before '{', reported unless sloppy-spc */
|
|---|
| 67 | }u_member; /*@ no space after '}', reported unless sloppy-spc */
|
|---|
| 68 | } s_type; /*@ statement/type declaration indent off by 4 */
|
|---|
| 69 | int* somefunc(); /*@ no space before '*' in type decl, r unless sloppy-spc */
|
|---|
| 70 | void main(int n) { /*@ opening brace at end of function definition header */
|
|---|
| 71 | for (; ; ) ; /*@ space before ')', reported unless sloppy-spc */
|
|---|
| 72 | for ( ; x; y) ; /*@2 space after '(' and before ';', unless sloppy-spc */
|
|---|
| 73 | for (;;n++) { /*@ missing space after ';', reported unless sloppy-spc */
|
|---|
| 74 | return; /*@0 (1-line) single statement in braces */
|
|---|
| 75 | }} /*@2 code after '}' outside expr */
|
|---|
| 76 | } /*@ unexpected closing brace (too many '}') outside expr */
|
|---|
| 77 | ) /*@ unexpected closing paren outside expr */
|
|---|
| 78 | #endif /*@ unexpected #endif */
|
|---|
| 79 | int f (int a, /*@ space after fn before '(', reported unless sloppy-spc */
|
|---|
| 80 | int b, /*@ hanging expr indent off by -1 */
|
|---|
| 81 | long I) /*@ single-letter name 'I' */
|
|---|
| 82 | { int x; /*@ code after '{' opening a block */
|
|---|
| 83 | int xx = 1) + /*@ unexpected closing parenthesis */
|
|---|
| 84 | 0L < /*@ constant on LHS of comparison operator */
|
|---|
| 85 | a] - /*@ unexpected closing bracket */
|
|---|
| 86 | 3: * /*@ unexpected ':' (without preceding '?') within expr */
|
|---|
| 87 | 4}; /*@ unexpected closing brace within expression */
|
|---|
| 88 | char y[] = { /*@0 unclosed brace within initializer/enum expression */
|
|---|
| 89 | 1* 1, /*@ no space etc. before '*', reported unless sloppy-spc */
|
|---|
| 90 | 2, /*@ hanging expr indent (for lines after '{') off by 1 */
|
|---|
| 91 | (xx /*@0 unclosed parenthesis in expression */
|
|---|
| 92 | ? y /*@0 unclosed '? (conditional expression) */
|
|---|
| 93 | [0; /*@4 unclosed bracket in expression */
|
|---|
| 94 | /*@ blank line within local decls */
|
|---|
| 95 | s_type s; /*@2 local variable declaration indent off by -1 */
|
|---|
| 96 | t_type t; /*@ local variable declaration indent again off by -1 */
|
|---|
| 97 | /* */ /*@0 missing blank line after local decls */
|
|---|
| 98 | somefunc(a, /*@2 statement indent off by -1 */
|
|---|
| 99 | "aligned" /*@ expr indent off by -2 accepted if sloppy-hang */ "right"
|
|---|
| 100 | , b, /*@ expr indent off by -1 */
|
|---|
| 101 | b, /*@ expr indent as on line above, accepted if sloppy-hang */
|
|---|
| 102 | b, /*@ expr indent off -8 but @ extra indent accepted if sloppy-hang */
|
|---|
| 103 | "again aligned" /*@ expr indent off by -9 (left of stmt indent, */ "right",
|
|---|
| 104 | abc == /*@ .. so reported also with sloppy-hang; this line is too long */ 456
|
|---|
| 105 | # define MAC(A) (A) /*@ nesting indent of preprocessor directive off by 1 */
|
|---|
| 106 | ? 1 /*@ hanging expr indent off by 1 */
|
|---|
| 107 | : 2); /*@ hanging expr indent off by 2, or 1 for leading ':' */
|
|---|
| 108 | if(a /*@ missing space after 'if', reported unless sloppy-spc */
|
|---|
| 109 | /*@0 intra-line comment indent off by -1 (not: by 3 due to '&&') */
|
|---|
| 110 | && ! 0 /*@2 space after '!', reported unless sloppy-spc */
|
|---|
| 111 | || b == /*@ hanging expr indent off by 2, or -2 for leading '||' */
|
|---|
| 112 | (x<<= 1) + /*@ missing space before '<<=' reported unless sloppy-spc */
|
|---|
| 113 | (xx+= 2) + /*@ missing space before '+=', reported unless sloppy-spc */
|
|---|
| 114 | (a^ 1) + /*@ missing space before '^', reported unless sloppy-spc */
|
|---|
| 115 | (y *=z) + /*@ missing space after '*=' reported unless sloppy-spc */
|
|---|
| 116 | a %2 / /*@ missing space after '%', reported unless sloppy-spc */
|
|---|
| 117 | 1 +/* */ /*@ no space before comment, reported unless sloppy-spc */
|
|---|
| 118 | /* */+ /*@ no space after comment, reported unless sloppy-spc */
|
|---|
| 119 | s. e_member) /*@ space after '.', reported unless sloppy-spc */
|
|---|
| 120 | xx = a + b /*@ extra single-statement indent off by 1 */
|
|---|
| 121 | + 0; /*@ two times extra single-statement indent off by 3 */
|
|---|
| 122 | if (a ++) /*@ space before postfix '++', reported unless sloppy-spc */
|
|---|
| 123 | { /*@ {' not on same line as preceding 'if' */
|
|---|
| 124 | c; /*@0 single stmt in braces, reported on 1-stmt */
|
|---|
| 125 | } else /*@ missing '{' on same line after '} else' */
|
|---|
| 126 | { /*@ statement indent off by 2 */
|
|---|
| 127 | d; /*@0 single stmt in braces, reported on 1-stmt */
|
|---|
| 128 | } /*@ statement indent off by 6 */
|
|---|
| 129 | if (1) f(a, /*@ (non-brace) code after end of 'if' condition */
|
|---|
| 130 | b); else /*@ (non-brace) code before 'else' */
|
|---|
| 131 | do f(c, c); /*@ (non-brace) code after 'do' */
|
|---|
| 132 | while ( 2); /*@ space after '(', reported unless sloppy-spc */
|
|---|
| 133 | b; c; /*@ more than one statement per line */
|
|---|
| 134 | outer: /*@ outer label special indent off by 1 */
|
|---|
| 135 | do{ /*@ missing space before '{', reported unless sloppy-spc */
|
|---|
| 136 | inner: /*@ inner label normal indent off by 1 */
|
|---|
| 137 | f (3, /*@ space after fn before '(', reported unless sloppy-spc */
|
|---|
| 138 | 4); /*@0 false negative: should report single stmt in braces */
|
|---|
| 139 | } /*@0 'while' not on same line as preceding '}' */
|
|---|
| 140 | while (a+ 0); /*@2 missing space before '+', reported unless sloppy-spc */
|
|---|
| 141 | switch (b ) { /*@ space before ')', reported unless sloppy-spc */
|
|---|
| 142 | case 1: /*@ 'case' special statement indent off by -1 */
|
|---|
| 143 | case(2): /*@ missing space after 'case', reported unless sloppy-spc */
|
|---|
| 144 | default: ; /*@ code after 'default:' */
|
|---|
| 145 | } /*@ statement indent off by -4 */
|
|---|
| 146 | return( /*@ missing space after 'return', reported unless sloppy-spc */
|
|---|
| 147 | x); } /*@ code before block-level '}' */
|
|---|
| 148 | /* Here the tool should stop complaining apart from the below issues at EOF */
|
|---|
| 149 |
|
|---|
| 150 | void f_looong_body()
|
|---|
| 151 | {
|
|---|
| 152 | ;
|
|---|
| 153 | ;
|
|---|
| 154 | ;
|
|---|
| 155 | ;
|
|---|
| 156 | ;
|
|---|
| 157 | ;
|
|---|
| 158 | ;
|
|---|
| 159 | ;
|
|---|
| 160 | ;
|
|---|
| 161 | ;
|
|---|
| 162 | ;
|
|---|
| 163 | ;
|
|---|
| 164 | ;
|
|---|
| 165 | ;
|
|---|
| 166 | ;
|
|---|
| 167 | ;
|
|---|
| 168 | ;
|
|---|
| 169 | ;
|
|---|
| 170 | ;
|
|---|
| 171 | ;
|
|---|
| 172 | ;
|
|---|
| 173 | ;
|
|---|
| 174 | ;
|
|---|
| 175 | ;
|
|---|
| 176 | ;
|
|---|
| 177 | ;
|
|---|
| 178 | ;
|
|---|
| 179 | ;
|
|---|
| 180 | ;
|
|---|
| 181 | ;
|
|---|
| 182 | ;
|
|---|
| 183 | ;
|
|---|
| 184 | ;
|
|---|
| 185 | ;
|
|---|
| 186 | ;
|
|---|
| 187 | ;
|
|---|
| 188 | ;
|
|---|
| 189 | ;
|
|---|
| 190 | ;
|
|---|
| 191 | ;
|
|---|
| 192 | ;
|
|---|
| 193 | ;
|
|---|
| 194 | ;
|
|---|
| 195 | ;
|
|---|
| 196 | ;
|
|---|
| 197 | ;
|
|---|
| 198 | ;
|
|---|
| 199 | ;
|
|---|
| 200 | ;
|
|---|
| 201 | ;
|
|---|
| 202 | ;
|
|---|
| 203 | ;
|
|---|
| 204 | ;
|
|---|
| 205 | ;
|
|---|
| 206 | ;
|
|---|
| 207 | ;
|
|---|
| 208 | ;
|
|---|
| 209 | ;
|
|---|
| 210 | ;
|
|---|
| 211 | ;
|
|---|
| 212 | ;
|
|---|
| 213 | ;
|
|---|
| 214 | ;
|
|---|
| 215 | ;
|
|---|
| 216 | ;
|
|---|
| 217 | ;
|
|---|
| 218 | ;
|
|---|
| 219 | ;
|
|---|
| 220 | ;
|
|---|
| 221 | ;
|
|---|
| 222 | ;
|
|---|
| 223 | ;
|
|---|
| 224 | ;
|
|---|
| 225 | ;
|
|---|
| 226 | ;
|
|---|
| 227 | ;
|
|---|
| 228 | ;
|
|---|
| 229 | ;
|
|---|
| 230 | ;
|
|---|
| 231 | ;
|
|---|
| 232 | ;
|
|---|
| 233 | ;
|
|---|
| 234 | ;
|
|---|
| 235 | ;
|
|---|
| 236 | ;
|
|---|
| 237 | ;
|
|---|
| 238 | ;
|
|---|
| 239 | ;
|
|---|
| 240 | ;
|
|---|
| 241 | ;
|
|---|
| 242 | ;
|
|---|
| 243 | ;
|
|---|
| 244 | ;
|
|---|
| 245 | ;
|
|---|
| 246 | ;
|
|---|
| 247 | ;
|
|---|
| 248 | ;
|
|---|
| 249 | ;
|
|---|
| 250 | ;
|
|---|
| 251 | ;
|
|---|
| 252 | ;
|
|---|
| 253 | ;
|
|---|
| 254 | ;
|
|---|
| 255 | ;
|
|---|
| 256 | ;
|
|---|
| 257 | ;
|
|---|
| 258 | ;
|
|---|
| 259 | ;
|
|---|
| 260 | ;
|
|---|
| 261 | ;
|
|---|
| 262 | ;
|
|---|
| 263 | ;
|
|---|
| 264 | ;
|
|---|
| 265 | ;
|
|---|
| 266 | ;
|
|---|
| 267 | ;
|
|---|
| 268 | ;
|
|---|
| 269 | ;
|
|---|
| 270 | ;
|
|---|
| 271 | ;
|
|---|
| 272 | ;
|
|---|
| 273 | ;
|
|---|
| 274 | ;
|
|---|
| 275 | ;
|
|---|
| 276 | ;
|
|---|
| 277 | ;
|
|---|
| 278 | ;
|
|---|
| 279 | ;
|
|---|
| 280 | ;
|
|---|
| 281 | ;
|
|---|
| 282 | ;
|
|---|
| 283 | ;
|
|---|
| 284 | ;
|
|---|
| 285 | ;
|
|---|
| 286 | ;
|
|---|
| 287 | ;
|
|---|
| 288 | ;
|
|---|
| 289 | ;
|
|---|
| 290 | ;
|
|---|
| 291 | ;
|
|---|
| 292 | ;
|
|---|
| 293 | ;
|
|---|
| 294 | ;
|
|---|
| 295 | ;
|
|---|
| 296 | ;
|
|---|
| 297 | ;
|
|---|
| 298 | ;
|
|---|
| 299 | ;
|
|---|
| 300 | ;
|
|---|
| 301 | ;
|
|---|
| 302 | ;
|
|---|
| 303 | ;
|
|---|
| 304 | ;
|
|---|
| 305 | ;
|
|---|
| 306 | ;
|
|---|
| 307 | ;
|
|---|
| 308 | ;
|
|---|
| 309 | ;
|
|---|
| 310 | ;
|
|---|
| 311 | ;
|
|---|
| 312 | ;
|
|---|
| 313 | ;
|
|---|
| 314 | ;
|
|---|
| 315 | ;
|
|---|
| 316 | ;
|
|---|
| 317 | ;
|
|---|
| 318 | ;
|
|---|
| 319 | ;
|
|---|
| 320 | ;
|
|---|
| 321 | ;
|
|---|
| 322 | ;
|
|---|
| 323 | ;
|
|---|
| 324 | ;
|
|---|
| 325 | ;
|
|---|
| 326 | ;
|
|---|
| 327 | ;
|
|---|
| 328 | ;
|
|---|
| 329 | ;
|
|---|
| 330 | ;
|
|---|
| 331 | ;
|
|---|
| 332 | ;
|
|---|
| 333 | ;
|
|---|
| 334 | ;
|
|---|
| 335 | ;
|
|---|
| 336 | ;
|
|---|
| 337 | ;
|
|---|
| 338 | ;
|
|---|
| 339 | ;
|
|---|
| 340 | ;
|
|---|
| 341 | ;
|
|---|
| 342 | ;
|
|---|
| 343 | ;
|
|---|
| 344 | ;
|
|---|
| 345 | ;
|
|---|
| 346 | ;
|
|---|
| 347 | ;
|
|---|
| 348 | ;
|
|---|
| 349 | ;
|
|---|
| 350 |
|
|---|
| 351 |
|
|---|
| 352 | ; /*@ 2 essentially blank lines before, if !sloppy-spc */
|
|---|
| 353 | } /*@ function body length > 200 lines */
|
|---|
| 354 | #if X /*@0 unclosed #if */
|
|---|
| 355 | struct t { /*@0 unclosed brace at decl/block level */
|
|---|
| 356 | enum { /*@0 unclosed brace at enum/expression level */
|
|---|
| 357 | v = (1 /*@0 unclosed parenthesis */
|
|---|
| 358 | etyp /*@0 blank line follows just before EOF, if !sloppy-spc: */
|
|---|
| 359 |
|
|---|
