4 #include "diagnostic.h"
5 #include "format_check.h"
11 typedef enum format_flag_t {
13 FMT_FLAG_HASH = 1U << 0,
14 FMT_FLAG_ZERO = 1U << 1,
15 FMT_FLAG_MINUS = 1U << 2,
16 FMT_FLAG_SPACE = 1U << 3,
17 FMT_FLAG_PLUS = 1U << 4,
18 FMT_FLAG_TICK = 1U << 5
21 typedef unsigned format_flags_t;
23 typedef enum format_length_modifier_t {
34 } format_length_modifier_t;
36 static const char* get_length_modifier_name(const format_length_modifier_t mod)
38 static const char* const names[] = {
50 assert(mod < sizeof(names) / sizeof(*names));
54 static void warn_invalid_length_modifier(const source_position_t pos,
55 const format_length_modifier_t mod,
56 const wchar_rep_t conversion)
59 "invalid length modifier '%s' for conversion specifier '%%%c'",
60 get_length_modifier_name(mod), conversion
64 static void check_format_arguments(const call_argument_t *const fmt_arg, const call_argument_t* arg)
66 const expression_t *fmt_expr = fmt_arg->expression;
67 if (fmt_expr->kind == EXPR_UNARY_CAST_IMPLICIT) {
68 fmt_expr = fmt_expr->unary.value;
71 if (fmt_expr->kind != EXPR_WIDE_STRING_LITERAL)
74 const source_position_t pos = fmt_expr->base.source_position;
75 const wide_string_t *const wstring = &fmt_expr->wide_string.value;
76 const wchar_rep_t *fmt = wstring->begin;
77 for (; *fmt != '\0'; ++fmt) {
85 format_flags_t fmt_flags = FMT_FLAG_NONE;
88 fmt_flags |= FMT_FLAG_ZERO;
91 /* argument selector or minimum field width */
95 } while (iswdigit(*fmt));
97 /* digit string was ... */
99 /* ... argument selector */
100 fmt_flags = FMT_FLAG_NONE; /* reset possibly set 0-flag */
104 /* ... minimum field width */
110 case '#': flag = FMT_FLAG_HASH; break;
111 case '0': flag = FMT_FLAG_ZERO; break;
112 case '-': flag = FMT_FLAG_MINUS; break;
113 case '\'': flag = FMT_FLAG_TICK; break;
116 if (fmt_flags & FMT_FLAG_PLUS) {
117 warningf(pos, "' ' is overridden by prior '+' in conversion specification");
119 flag = FMT_FLAG_SPACE;
123 if (fmt_flags & FMT_FLAG_SPACE) {
124 warningf(pos, "'+' overrides prior ' ' in conversion specification");
126 flag = FMT_FLAG_PLUS;
129 default: goto break_fmt_flags;
131 if (fmt_flags & flag) {
132 warningf(pos, "repeated flag '%c' in conversion specification", (char)*fmt);
139 /* minimum field width */
142 warningf(pos, "missing argument for '*' field width in conversion specification");
145 const type_t *const arg_type = arg->expression->base.type;
146 if (arg_type != type_int) {
147 warningf(pos, "argument for '*' field width in conversion specification is not an 'int', but an '%T'", arg_type);
151 while (iswdigit(*fmt)) {
162 warningf(pos, "missing argument for '*' precision in conversion specification");
165 const type_t *const arg_type = arg->expression->base.type;
166 if (arg_type != type_int) {
167 warningf(pos, "argument for '*' precision in conversion specification is not an 'int', but an '%T'", arg_type);
171 /* digit string may be omitted */
172 while (iswdigit(*fmt)) {
178 /* length modifier */
179 format_length_modifier_t fmt_mod;
185 fmt_mod = FMT_MOD_hh;
195 fmt_mod = FMT_MOD_ll;
201 case 'L': ++fmt; fmt_mod = FMT_MOD_L; break;
202 case 'j': ++fmt; fmt_mod = FMT_MOD_j; break;
203 case 't': ++fmt; fmt_mod = FMT_MOD_t; break;
204 case 'z': ++fmt; fmt_mod = FMT_MOD_z; break;
205 case 'q': ++fmt; fmt_mod = FMT_MOD_q; break;
206 default: fmt_mod = FMT_MOD_NONE; break;
210 warningf(pos, "dangling %% in format string");
214 const type_t *expected_type;
215 type_qualifiers_t expected_qual = TYPE_QUALIFIER_NONE;
216 format_flags_t allowed_flags;
221 case FMT_MOD_NONE: expected_type = type_int; break;
222 case FMT_MOD_hh: expected_type = type_int; break; /* TODO promoted signed char */
223 case FMT_MOD_h: expected_type = type_int; break; /* TODO promoted short */
224 case FMT_MOD_l: expected_type = type_long; break;
225 case FMT_MOD_ll: expected_type = type_long_long; break;
226 case FMT_MOD_j: expected_type = type_intmax_t; break;
227 case FMT_MOD_z: expected_type = type_ssize_t; break;
228 case FMT_MOD_t: expected_type = type_ptrdiff_t; break;
231 warn_invalid_length_modifier(pos, fmt_mod, *fmt);
234 allowed_flags = FMT_FLAG_MINUS | FMT_FLAG_SPACE | FMT_FLAG_PLUS | FMT_FLAG_ZERO;
240 allowed_flags = FMT_FLAG_MINUS | FMT_FLAG_HASH | FMT_FLAG_ZERO;
241 goto eval_fmt_mod_unsigned;
245 allowed_flags = FMT_FLAG_MINUS | FMT_FLAG_ZERO;
246 eval_fmt_mod_unsigned:
248 case FMT_MOD_NONE: expected_type = type_unsigned_int; break;
249 case FMT_MOD_hh: expected_type = type_int; break; /* TODO promoted unsigned char */
250 case FMT_MOD_h: expected_type = type_int; break; /* TODO promoted unsigned short */
251 case FMT_MOD_l: expected_type = type_unsigned_long; break;
252 case FMT_MOD_ll: expected_type = type_unsigned_long_long; break;
253 case FMT_MOD_j: expected_type = type_uintmax_t; break;
254 case FMT_MOD_z: expected_type = type_size_t; break;
255 case FMT_MOD_t: expected_type = type_uptrdiff_t; break;
258 warn_invalid_length_modifier(pos, fmt_mod, *fmt);
272 case FMT_MOD_l: /* l modifier is ignored */
273 case FMT_MOD_NONE: expected_type = type_double; break;
274 case FMT_MOD_L: expected_type = type_long_double; break;
277 warn_invalid_length_modifier(pos, fmt_mod, *fmt);
280 allowed_flags = FMT_FLAG_MINUS | FMT_FLAG_SPACE | FMT_FLAG_PLUS | FMT_FLAG_HASH | FMT_FLAG_ZERO;
284 if (fmt_mod != FMT_MOD_NONE) {
285 warn_invalid_length_modifier(pos, fmt_mod, *fmt);
288 expected_type = type_wchar_t;
289 allowed_flags = FMT_FLAG_NONE;
293 expected_type = type_int;
295 case FMT_MOD_NONE: expected_type = type_int; break; /* TODO promoted char */
296 case FMT_MOD_l: expected_type = type_wint_t; break;
299 warn_invalid_length_modifier(pos, fmt_mod, *fmt);
302 allowed_flags = FMT_FLAG_NONE;
306 if (fmt_mod != FMT_MOD_NONE) {
307 warn_invalid_length_modifier(pos, fmt_mod, *fmt);
310 expected_type = type_wchar_t_ptr;
311 expected_qual = TYPE_QUALIFIER_CONST;
312 allowed_flags = FMT_FLAG_NONE;
317 case FMT_MOD_NONE: expected_type = type_char_ptr; break;
318 case FMT_MOD_l: expected_type = type_wchar_t_ptr; break;
321 warn_invalid_length_modifier(pos, fmt_mod, *fmt);
324 expected_qual = TYPE_QUALIFIER_CONST;
325 allowed_flags = FMT_FLAG_NONE;
329 if (fmt_mod != FMT_MOD_NONE) {
330 warn_invalid_length_modifier(pos, fmt_mod, *fmt);
333 expected_type = type_void_ptr;
334 allowed_flags = FMT_FLAG_NONE;
339 case FMT_MOD_NONE: expected_type = type_int_ptr; break;
340 case FMT_MOD_hh: expected_type = type_signed_char_ptr; break;
341 case FMT_MOD_h: expected_type = type_short_ptr; break;
342 case FMT_MOD_l: expected_type = type_long_ptr; break;
343 case FMT_MOD_ll: expected_type = type_long_long_ptr; break;
344 case FMT_MOD_j: expected_type = type_intmax_t_ptr; break;
345 case FMT_MOD_z: expected_type = type_ssize_t_ptr; break;
346 case FMT_MOD_t: expected_type = type_ptrdiff_t_ptr; break;
349 warn_invalid_length_modifier(pos, fmt_mod, *fmt);
352 allowed_flags = FMT_FLAG_NONE;
356 warningf(pos, "encountered unknown conversion specifier '%%%C'", (wint_t)*fmt);
360 if ((fmt_flags & ~allowed_flags) != 0) {
361 /* TODO better warning message text */
362 warningf(pos, "invalid format flags in conversion specification");
366 warningf(pos, "too few arguments for format string");
370 { /* create a scope here to prevent warning about the jump to next_arg */
371 type_t *const arg_type = arg->expression->base.type;
372 if (is_type_pointer(expected_type)) {
373 type_t *const arg_skip = skip_typeref(arg_type);
374 if (is_type_pointer(arg_skip)) {
375 type_t *const exp_to = skip_typeref(expected_type->pointer.points_to);
376 type_t *const arg_to = skip_typeref(arg_skip->pointer.points_to);
377 if ((arg_to->base.qualifiers & ~expected_qual) == 0 &&
378 get_unqualified_type(arg_to) == exp_to) {
383 if (get_unqualified_type(skip_typeref(arg_type)) == expected_type) {
387 if (is_type_valid(arg_type)) {
389 "argument type '%T' does not match conversion specifier '%%%s%c'",
390 arg_type, get_length_modifier_name(fmt_mod), (char)*fmt);
396 if (fmt + 1 != wstring->begin + wstring->size) {
397 warningf(pos, "format string contains NUL");
400 warningf(pos, "too many arguments for format string");
404 void check_format(const call_expression_t *const call)
406 if (!warning.check_format)
409 const expression_t *const func_expr = call->function;
410 if (func_expr->kind != EXPR_REFERENCE)
413 const char *const name = func_expr->reference.symbol->string;
414 const call_argument_t * arg = call->arguments;
415 if (strcmp(name, "wprintf") == 0) { /* TODO gammlig */
416 check_format_arguments(arg, arg->next);
417 } else if (strcmp(name, "swprintf") == 0) {
418 arg = arg->next->next; /* skip destination buffer and size */
419 check_format_arguments(arg, arg->next);