Partially implement -Wdeprecated-declarations.
[cparser] / format_check.c
index d0b7d7a..f572d14 100644 (file)
@@ -27,7 +27,7 @@
 #include "types.h"
 #include "type_t.h"
 #include "warning.h"
-
+#include "lang_features.h"
 
 typedef enum format_flag_t {
        FMT_FLAG_NONE  = 0,
@@ -51,7 +51,12 @@ typedef enum format_length_modifier_t {
        FMT_MOD_j,
        FMT_MOD_t,
        FMT_MOD_z,
-       FMT_MOD_q
+       FMT_MOD_q,
+       /* only in microsoft mode */
+       FMT_MOD_w,
+       FMT_MOD_I,
+       FMT_MOD_I32,
+       FMT_MOD_I64
 } format_length_modifier_t;
 
 static const char* get_length_modifier_name(const format_length_modifier_t mod)
@@ -66,13 +71,18 @@ static const char* get_length_modifier_name(const format_length_modifier_t mod)
                [FMT_MOD_j]    = "j",
                [FMT_MOD_t]    = "t",
                [FMT_MOD_z]    = "z",
-               [FMT_MOD_q]    = "q"
+               [FMT_MOD_q]    = "q",
+               /* only in microsoft mode */
+               [FMT_MOD_w]    = "w",
+               [FMT_MOD_I]    = "I",
+               [FMT_MOD_I32]  = "I32",
+               [FMT_MOD_I64]  = "I64"
        };
        assert(mod < sizeof(names) / sizeof(*names));
        return names[mod];
 }
 
-static void warn_invalid_length_modifier(const source_position_t pos,
+static void warn_invalid_length_modifier(const source_position_t *pos,
                                          const format_length_modifier_t mod,
                                          const wchar_rep_t conversion)
 {
@@ -85,11 +95,14 @@ static void warn_invalid_length_modifier(const source_position_t pos,
 typedef struct vchar_t vchar_t;
 struct vchar_t {
        const void *string;   /**< the string */
-       size_t     position;
-       size_t     size;
+       size_t     position;  /**< current position */
+       size_t     size;      /**< size of the string */
 
+       /** return the first character of the string and setthe position to 0. */
        unsigned (*first)(vchar_t *self);
+       /** return the next character of the string */
        unsigned (*next)(vchar_t *self);
+       /** return non_zero if the given character is a digit */
        int (*is_digit)(unsigned vchar);
 };
 
@@ -129,8 +142,20 @@ static bool atend(vchar_t *self) {
        return self->position + 1 == self->size;
 }
 
-static void check_format_arguments(const call_argument_t *const fmt_arg, const call_argument_t* arg)
+/**
+ * Check printf-style format.
+ */
+static void check_format_arguments(const call_argument_t *arg, unsigned idx_fmt,
+               unsigned idx_param)
 {
+       const call_argument_t *fmt_arg;
+       unsigned idx = 0;
+
+       /* find format arg */
+       for(idx = 0; idx < idx_fmt; ++idx)
+               arg = arg->next;
+       fmt_arg = arg;
+
        const expression_t *fmt_expr = fmt_arg->expression;
        if (fmt_expr->kind == EXPR_UNARY_CAST_IMPLICIT) {
                fmt_expr = fmt_expr->unary.value;
@@ -152,7 +177,11 @@ static void check_format_arguments(const call_argument_t *const fmt_arg, const c
        } else {
                return;
        }
-       const source_position_t    pos     = fmt_expr->base.source_position;
+       /* find the real args */
+       for(; idx < idx_param; ++idx)
+               arg = arg->next;
+
+       const source_position_t *pos = &fmt_expr->base.source_position;
        unsigned fmt = vchar.first(&vchar);
        for (; fmt != '\0'; fmt = vchar.next(&vchar)) {
                if (fmt != '%')
@@ -283,7 +312,43 @@ break_fmt_flags:
                        case 't': fmt = vchar.next(&vchar); fmt_mod = FMT_MOD_t;    break;
                        case 'z': fmt = vchar.next(&vchar); fmt_mod = FMT_MOD_z;    break;
                        case 'q': fmt = vchar.next(&vchar); fmt_mod = FMT_MOD_q;    break;
-                       default:                            fmt_mod = FMT_MOD_NONE; break;
+                       /* microsoft mode */
+                       case 'w':
+                               if (c_mode & _MS) {
+                                       fmt = vchar.next(&vchar); fmt_mod = FMT_MOD_w;
+                               } else {
+                                       fmt_mod = FMT_MOD_NONE;
+                               }
+                               break;
+                       case 'I':
+                               if (c_mode & _MS) {
+                                       fmt = vchar.next(&vchar); fmt_mod = FMT_MOD_I;
+                                       if (fmt == '3') {
+                                               fmt = vchar.next(&vchar);
+                                               if (fmt == '2') {
+                                                       fmt = vchar.next(&vchar);
+                                                       fmt_mod = FMT_MOD_I32;
+                                               } else {
+                                                       /* rewind */
+                                                       --vchar.position;
+                                               }
+                                       } else if (fmt == '6') {
+                                               fmt = vchar.next(&vchar);
+                                               if (fmt == '4') {
+                                                       fmt = vchar.next(&vchar);
+                                                       fmt_mod = FMT_MOD_I64;
+                                               } else {
+                                                       /* rewind */
+                                                       --vchar.position;
+                                               }
+                                       }
+                               } else {
+                                       fmt_mod = FMT_MOD_NONE;
+                               }
+                               break;
+                       default:
+                               fmt_mod = FMT_MOD_NONE;
+                               break;
                }
 
                if (fmt == '\0') {
@@ -291,7 +356,7 @@ break_fmt_flags:
                        break;
                }
 
-               const type_t      *expected_type;
+               type_t            *expected_type;
                type_qualifiers_t  expected_qual = TYPE_QUALIFIER_NONE;
                format_flags_t     allowed_flags;
                switch (fmt) {
@@ -306,6 +371,9 @@ break_fmt_flags:
                                        case FMT_MOD_j:    expected_type = type_intmax_t;  break;
                                        case FMT_MOD_z:    expected_type = type_ssize_t;   break;
                                        case FMT_MOD_t:    expected_type = type_ptrdiff_t; break;
+                                       case FMT_MOD_I:    expected_type = type_ptrdiff_t; break;
+                                       case FMT_MOD_I32:  expected_type = type_int32;     break;
+                                       case FMT_MOD_I64:  expected_type = type_int64;     break;
 
                                        default:
                                                warn_invalid_length_modifier(pos, fmt_mod, fmt);
@@ -333,6 +401,9 @@ eval_fmt_mod_unsigned:
                                        case FMT_MOD_j:    expected_type = type_uintmax_t;          break;
                                        case FMT_MOD_z:    expected_type = type_size_t;             break;
                                        case FMT_MOD_t:    expected_type = type_uptrdiff_t;         break;
+                                       case FMT_MOD_I:    expected_type = type_size_t;             break;
+                                       case FMT_MOD_I32:  expected_type = type_unsigned_int32;     break;
+                                       case FMT_MOD_I64:  expected_type = type_unsigned_int64;     break;
 
                                        default:
                                                warn_invalid_length_modifier(pos, fmt_mod, fmt);
@@ -372,8 +443,9 @@ eval_fmt_mod_unsigned:
                        case 'c':
                                expected_type = type_int;
                                switch (fmt_mod) {
-                                       case FMT_MOD_NONE: expected_type = type_int;    break; /* TODO promoted char */
-                                       case FMT_MOD_l:    expected_type = type_wint_t; break;
+                                       case FMT_MOD_NONE: expected_type = type_int;     break; /* TODO promoted char */
+                                       case FMT_MOD_l:    expected_type = type_wint_t;  break;
+                                       case FMT_MOD_w:    expected_type = type_wchar_t; break;
 
                                        default:
                                                warn_invalid_length_modifier(pos, fmt_mod, fmt);
@@ -396,6 +468,7 @@ eval_fmt_mod_unsigned:
                                switch (fmt_mod) {
                                        case FMT_MOD_NONE: expected_type = type_char_ptr;    break;
                                        case FMT_MOD_l:    expected_type = type_wchar_t_ptr; break;
+                                       case FMT_MOD_w:    expected_type = type_wchar_t_ptr; break;
 
                                        default:
                                                warn_invalid_length_modifier(pos, fmt_mod, fmt);
@@ -448,11 +521,12 @@ eval_fmt_mod_unsigned:
                }
 
                {       /* create a scope here to prevent warning about the jump to next_arg */
-                       type_t *const arg_type = arg->expression->base.type;
-                       if (is_type_pointer(expected_type)) {
+                       type_t *const arg_type           = arg->expression->base.type;
+                       type_t *const expected_type_skip = skip_typeref(expected_type);
+                       if (is_type_pointer(expected_type_skip)) {
                                type_t *const arg_skip = skip_typeref(arg_type);
                                if (is_type_pointer(arg_skip)) {
-                                       type_t *const exp_to = skip_typeref(expected_type->pointer.points_to);
+                                       type_t *const exp_to = skip_typeref(expected_type_skip->pointer.points_to);
                                        type_t *const arg_to = skip_typeref(arg_skip->pointer.points_to);
                                        if ((arg_to->base.qualifiers & ~expected_qual) == 0 &&
                                                get_unqualified_type(arg_to) == exp_to) {
@@ -460,7 +534,7 @@ eval_fmt_mod_unsigned:
                                        }
                                }
                        } else {
-                               if (get_unqualified_type(skip_typeref(arg_type)) == expected_type) {
+                               if (get_unqualified_type(skip_typeref(arg_type)) == expected_type_skip) {
                                        goto next_arg;
                                }
                        }
@@ -481,26 +555,89 @@ next_arg:
        }
 }
 
+static const struct {
+       const char    *name;
+       format_kind_t  fmt_kind;
+       unsigned       fmt_idx;
+       unsigned       arg_idx;
+} builtin_table[] = {
+       { "printf",        FORMAT_PRINTF,   0, 1 },
+       { "wprintf",       FORMAT_PRINTF,   0, 1 },
+       { "sprintf",       FORMAT_PRINTF,   1, 2 },
+       { "swprintf",      FORMAT_PRINTF,   1, 2 },
+       { "snprintf",      FORMAT_PRINTF,   2, 3 },
+       { "snwprintf",     FORMAT_PRINTF,   2, 3 },
+       { "fprintf",       FORMAT_PRINTF,   1, 2 },
+       { "fwprintf",      FORMAT_PRINTF,   1, 2 },
+       { "snwprintf",     FORMAT_PRINTF,   2, 3 },
+       { "snwprintf",     FORMAT_PRINTF,   2, 3 },
+
+       { "scanf",         FORMAT_SCANF,    0, 1 },
+       { "wscanf",        FORMAT_SCANF,    0, 1 },
+       { "sscanf",        FORMAT_SCANF,    1, 2 },
+       { "swscanf",       FORMAT_SCANF,    1, 2 },
+       { "fscanf",        FORMAT_SCANF,    1, 2 },
+       { "fwscanf",       FORMAT_SCANF,    1, 2 },
+
+       { "strftime",      FORMAT_STRFTIME, 3, 4 },
+       { "wcstrftime",    FORMAT_STRFTIME, 3, 4 },
+
+       { "strfmon",       FORMAT_STRFMON,  3, 4 },
+
+       /* MS extensions */
+       { "_snprintf",     FORMAT_PRINTF,   2, 3 },
+       { "_snwprintf",    FORMAT_PRINTF,   2, 3 },
+       { "_scrintf",      FORMAT_PRINTF,   0, 1 },
+       { "_scwprintf",    FORMAT_PRINTF,   0, 1 },
+       { "printf_s",      FORMAT_PRINTF,   0, 1 },
+       { "wprintf_s",     FORMAT_PRINTF,   0, 1 },
+       { "sprintf_s",     FORMAT_PRINTF,   3, 4 },
+       { "swprintf_s",    FORMAT_PRINTF,   3, 4 },
+       { "fprintf_s",     FORMAT_PRINTF,   1, 2 },
+       { "fwprintf_s",    FORMAT_PRINTF,   1, 2 },
+       { "_sprintf_l",    FORMAT_PRINTF,   1, 3 },
+       { "_swprintf_l",   FORMAT_PRINTF,   1, 3 },
+       { "_printf_l",     FORMAT_PRINTF,   0, 2 },
+       { "_wprintf_l",    FORMAT_PRINTF,   0, 2 },
+       { "_fprintf_l",    FORMAT_PRINTF,   1, 3 },
+       { "_fwprintf_l",   FORMAT_PRINTF,   1, 3 },
+       { "_printf_s_l",   FORMAT_PRINTF,   0, 2 },
+       { "_wprintf_s_l",  FORMAT_PRINTF,   0, 2 },
+       { "_sprintf_s_l",  FORMAT_PRINTF,   3, 5 },
+       { "_swprintf_s_l", FORMAT_PRINTF,   3, 5 },
+       { "_fprintf_s_l",  FORMAT_PRINTF,   1, 3 },
+       { "_fwprintf_s_l", FORMAT_PRINTF,   1, 3 },
+};
+
 void check_format(const call_expression_t *const call)
 {
-       if (!warning.check_format)
+       if (!warning.format)
                return;
 
        const expression_t *const func_expr = call->function;
        if (func_expr->kind != EXPR_REFERENCE)
                return;
 
-       const char            *const name = func_expr->reference.symbol->string;
+       const declaration_t   *const decl = func_expr->reference.declaration;
        const call_argument_t *      arg  = call->arguments;
-       if (strcmp(name, "wprintf") == 0) { /* TODO gammlig */
-               check_format_arguments(arg, arg->next);
-       } else if (strcmp(name, "printf") == 0) {
-               check_format_arguments(arg, arg->next);
-       } else if (strcmp(name, "swprintf") == 0) {
-               arg = arg->next->next; /* skip destination buffer and size */
-               check_format_arguments(arg, arg->next);
-       } else if (strcmp(name, "sprintf") == 0) {
-               arg = arg->next->next; /* skip destination buffer and size */
-               check_format_arguments(arg, arg->next);
+
+       if(false) {
+               /* the declaration has a GNU format attribute, check it */
+       } else {
+               /*
+                * For some functions we always check the format, even if it was not specified.
+                * This allows to check format even in MS mode or without header included.
+                */
+               const char            *const name = decl->symbol->string;
+               for(size_t i = 0; i < sizeof(builtin_table) / sizeof(builtin_table[0]); ++i) {
+                       if(strcmp(name, builtin_table[i].name) == 0) {
+                               if(builtin_table[i].fmt_kind == FORMAT_PRINTF) {
+                                       check_format_arguments(arg,
+                                                              builtin_table[i].fmt_idx,
+                                                              builtin_table[i].arg_idx);
+                               }
+                               break;
+                       }
+               }
        }
 }