1 /* 2 * Copyright 2007-2022 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 leading '*' in comment lines are used for self-tests: 19 * they mark lines containing a single issue that should be reported. 20 * Normally it should be reported while handling the given line, 21 * but in case of delayed checks there is a following digit 22 * indicating the number of reports expected for this line. 23 */ 24 25 /* this line is between 81 and 100 chars long, to be reported with -strict-len */ 26 27 /* For each of the following set of lines the tool should complain once */ 28 /*@ tab character: */ 29 /*@ intra-line carriage return character: 29 */ 30 /*@ non-printable ASCII character: */ 31 /*@ non-ASCII character: ä */ 32 /*@ whitespace at EOL: */ 33 // /*@ end-of-line comment style not allowed (for C90 compatibility) */ 34 /*@0 intra-line comment indent off by 1, reported unless sloppy-cmt */ 35 /*X */ /*@2 missing spc or '*' after comment start reported unless sloppy-spc */ 36 /* X*/ /*@ missing space before comment end , reported unless sloppy-spc */ 37 /*@ comment starting delimiter: /* inside intra-line comment */ 38 /*@0 39 *@ above multi-line comment start indent off by 1, reported unless sloppy-cmt; this comment line is too long 40 *@ multi-line comment indent further off by 1 relative to comment start 41 *@ multi-line comment ending with text on last line */ 42 /*@2 multi-line comment starting with text on first line 43 *@ comment starting delimiter: /* inside multi-line comment 44 *@ multi-line comment indent off by -1 45 *X*@ no spc after leading '*' in multi-line comment, reported unless sloppy-spc 46 *@0 more than two spaces after . in comment, no more reported 47 *@0 more than two spaces after ? in comment, no more reported 48 *@0 more than two spaces after ! in comment, no more reported 49 */ /*@ multi-line comment end indent off by -1 (relative to comment start) */ 50 */ /*@ unexpected comment ending delimiter outside comment */ 51 /*- '-' for formatted comment not allowed in intra-line comment */ 52 /*@ comment line is toooooooooooo wide by 1 char, or by 21 chars in case strict-len option is used */ 53 #if ~0 /*@ '#if' with constant condition */ 54 #endif /*@ indent of preproc. directive off by 1 (must be 0) */ 55 #define X (1 + 1) /*@0 extra space in body, reported unless sloppy-spc */ 56 #define Y 1 /*@ extra space before body, reported unless sloppy-spc */ \ 57 #define Z /*@2 preprocessor directive within multi-line directive */ 58 typedef struct { /*@0 extra space in code, reported unless sloppy-spc */ 59 enum { /*@1 extra space in intra-line comment, no more reported */ 60 w = 0 /*@ hanging expr indent off by 1, or 3 for lines after '{' */ 61 && 1, /*@ hanging expr indent off by 3, or -1 for leading '&&' */ 62 x = 1, /*@ hanging expr indent off by -1 */ 63 y,z /*@ no space after ',', reported unless sloppy-spc */ 64 } e_member ; /*@ space before ';', reported unless sloppy-spc */ 65 int v[1; /*@ unclosed bracket in type declaration */ 66 union { /*@ statement/type declaration indent off by -1 */ 67 struct{} s; /*@ no space before '{', reported unless sloppy-spc */ 68 }u_member; /*@ no space after '}', reported unless sloppy-spc */ 69 } s_type; /*@ statement/type declaration indent off by 4 */ 70 int* somefunc(); /*@ no space before '*' in type decl, r unless sloppy-spc */ 71 void main(int n) { /*@ opening brace at end of function definition header */ 72 for (; ; ) ; /*@ space before ')', reported unless sloppy-spc */ 73 for ( ; x; y) ; /*@2 space after '(' and before ';', unless sloppy-spc */ 74 for (;;n++) { /*@ missing space after ';', reported unless sloppy-spc */ 75 return; /*@0 (1-line) single statement in braces */ 76 }} /*@2 code after '}' outside expr */ 77 } /*@ unexpected closing brace (too many '}') outside expr */ 78 ) /*@ unexpected closing paren outside expr */ 79 #endif /*@ unexpected #endif */ 80 int f (int a, /*@ space after fn before '(', reported unless sloppy-spc */ 81 int b, /*@ hanging expr indent off by -1 */ 82 long I) /*@ single-letter name 'I' */ 83 { int x; /*@ code after '{' opening a block */ 84 int xx = 1) + /*@ unexpected closing parenthesis */ 85 0L < /*@ constant on LHS of comparison operator */ 86 a] - /*@ unexpected closing bracket */ 87 3: * /*@ unexpected ':' (without preceding '?') within expr */ 88 4}; /*@ unexpected closing brace within expression */ 89 char y[] = { /*@0 unclosed brace within initializer/enum expression */ 90 1* 1, /*@ no space etc. before '*', reported unless sloppy-spc */ 91 2, /*@ hanging expr indent (for lines after '{') off by 1 */ 92 (xx /*@0 unclosed parenthesis in expression */ 93 ? y /*@0 unclosed '? (conditional expression) */ 94 [0; /*@4 unclosed bracket in expression */ 95 /*@ blank line within local decls */ 96 s_type s; /*@2 local variable declaration indent off by -1 */ 97 t_type t; /*@ local variable declaration indent again off by -1 */ 98 /* */ /*@0 missing blank line after local decls */ 99 somefunc(a, /*@2 statement indent off by -1 */ 100 "aligned" /*@ expr indent off by -2 accepted if sloppy-hang */ "right" 101 , b, /*@ expr indent off by -1 */ 102 b, /*@ expr indent as on line above, accepted if sloppy-hang */ 103 b, /*@ expr indent off -8 but @ extra indent accepted if sloppy-hang */ 104 "again aligned" /*@ expr indent off by -9 (left of stmt indent, */ "right", 105 abc == /*@ .. so reported also with sloppy-hang; this line is too long by 6 or 26 chars */ 456 106 # define MAC(A) (A) /*@ nesting indent of preprocessor directive off by 1 */ 107 ? 1 /*@ hanging expr indent off by 1 */ 108 : 2); /*@ hanging expr indent off by 2, or 1 for leading ':' */ 109 if(a /*@ missing space after 'if', reported unless sloppy-spc */ 110 /*@0 intra-line comment indent off by -1 (not: by 3 due to '&&') */ 111 && ! 0 /*@2 space after '!', reported unless sloppy-spc */ 112 || b == /*@ hanging expr indent off by 2, or -2 for leading '||' */ 113 (x<<= 1) + /*@ missing space before '<<=' reported unless sloppy-spc */ 114 (xx+= 2) + /*@ missing space before '+=', reported unless sloppy-spc */ 115 (a^ 1) + /*@ missing space before '^', reported unless sloppy-spc */ 116 (y *=z) + /*@ missing space after '*=' reported unless sloppy-spc */ 117 a %2 / /*@ missing space after '%', reported unless sloppy-spc */ 118 1 +/* */ /*@ no space before comment, reported unless sloppy-spc */ 119 /* */+ /*@ no space after comment, reported unless sloppy-spc */ 120 s. e_member) /*@ space after '.', reported unless sloppy-spc */ 121 xx = a + b /*@ extra single-statement indent off by 1 */ 122 + 0; /*@ two times extra single-statement indent off by 3 */ 123 if (a ++) /*@ space before postfix '++', reported unless sloppy-spc */ 124 { /*@ {' not on same line as preceding 'if' */ 125 c; /*@0 single stmt in braces, reported on 1-stmt */ 126 } else /*@ missing '{' on same line after '} else' */ 127 { /*@ statement indent off by 2 */ 128 d; /*@0 single stmt in braces, reported on 1-stmt */ 129 } /*@ statement indent off by 6 */ 130 if (1) f(a, /*@ (non-brace) code after end of 'if' condition */ 131 b); else /*@ (non-brace) code before 'else' */ 132 do f(c, c); /*@ (non-brace) code after 'do' */ 133 while ( 2); /*@ space after '(', reported unless sloppy-spc */ 134 b; c; /*@ more than one statement per line */ 135 outer: /*@ outer label special indent off by 1 */ 136 do{ /*@ missing space before '{', reported unless sloppy-spc */ 137 inner: /*@ inner label normal indent off by 1 */ 138 f (3, /*@ space after fn before '(', reported unless sloppy-spc */ 139 4); /*@0 false negative: should report single stmt in braces */ 140 } /*@0 'while' not on same line as preceding '}' */ 141 while (a+ 0); /*@2 missing space before '+', reported unless sloppy-spc */ 142 switch (b ) { /*@ space before ')', reported unless sloppy-spc */ 143 case 1: /*@ 'case' special statement indent off by -1 */ 144 case(2): /*@ missing space after 'case', reported unless sloppy-spc */ 145 default: ; /*@ code after 'default:' */ 146 } /*@ statement indent off by -4 */ 147 return( /*@ missing space after 'return', reported unless sloppy-spc */ 148 x); } /*@ code before block-level '}' */ 149 /* Here the tool should stop complaining apart from the below issues at EOF */ 150 151 void f_looong_body() 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 353 ; /*@ 2 essentially blank lines before, if !sloppy-spc */ 354 } /*@ function body length > 200 lines */ 355 #if X /*@0 unclosed #if */ 356 struct t { /*@0 unclosed brace at decl/block level */ 357 enum { /*@0 unclosed brace at enum/expression level */ 358 v = (1 /*@0 unclosed parenthesis */ 359 etyp /*@0 blank line follows just before EOF, if !sloppy-spc: */ 360 361