nsz Git - cparser/blob - warning.h

   1 /*
   2  * This file is part of cparser.
   3  * Copyright (C) 2007-2009 Matthias Braun <matze@braunis.de>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  18  * 02111-1307, USA.
  19  */
  20 #ifndef WARNING_H
  21 #define WARNING_H
  22
  23 #include <stdbool.h>
  24
  25 void set_warning_opt(const char *opt);
  26
  27 void disable_all_warnings(void);
  28
  29 void print_warning_opt_help(void);
  30
  31 typedef enum warning_t {
  32         WARN_ADDRESS,                       /**< Warn about suspicious uses of memory addresses */
  33         WARN_AGGREGATE_RETURN,              /**< Warn if any functions that return structures or unions are defined or called */
  34         WARN_ATTRIBUTE,                     /**< Warn if an unexpected `__attribute__' is used or function attributes applied to variables, etc. */
  35 #if 0 // TODO
  36         WARN_BAD_FUNCTION_CAST,             /**< Warn whenever a function call is cast to a non-matching type */
  37         WARN_CAST_ALIGN,                    /**< Warn whenever a pointer is cast such that the required alignment of the target is increased */
  38 #endif
  39         WARN_CAST_QUAL,                     /**< Warn whenever a pointer is cast so as to remove a type qualifier from the target type */
  40         WARN_CHAR_SUBSCRIPTS,               /**< Warn if an array subscript has the type 'char' */
  41         WARN_COMMENT,                       /**< Warn whenever a comment-start sequence appears in a comment, or whenever a Backslash-Newline appears in a '//' comment. */
  42         WARN_CONVERSION,                    /**< Warn if a prototype causes a type conversion that is different from what would happen to the same argument in the absence of a prototype */
  43 #if 0 // TODO
  44         WARN_CPP_COMPAT,                    /**< Warn about ISO C constructs that are outside of the common subset of ISO C and ISO C++. */
  45 #endif
  46         WARN_DECLARATION_AFTER_STATEMENT,   /**< Warn when a declaration is found after a statement in a block */
  47         WARN_DEPRECATED_DECLARATIONS,       /* TODO implement for types */ /**< Warn about uses of functions, variables and types marked as deprecated by using the 'deprecated' attribute */
  48         WARN_DIV_BY_ZERO,                   /**< Warn about compile-time integer division by zero */
  49         WARN_EMPTY_BODY,                    /**< Warn about an empty body of an if or else statement */
  50         WARN_EMPTY_STATEMENT,               /**< Warn about empty statements, i.e. lone ';'  */
  51 #if 0 // TODO
  52         WARN_ENDIF_LABELS,                  /**< Warn whenever an '#else' or an '#endif' are followed by text */
  53 #endif
  54         WARN_ERROR,                         /**< Treat warnings as errors */
  55         WARN_FATAL_ERRORS,                  /**< First error stops the compilation */
  56         WARN_FLOAT_EQUAL,                   /**< Warn if floating point values are used in equality comparisons */
  57         WARN_FORMAT,                        /**< Check printf-style format strings */
  58         WARN_IGNORED_QUALIFIERS,            /**< Warn when type qualifiers are meaningless */
  59         WARN_IMPLICIT_FUNCTION_DECLARATION, /**< Warn whenever a function is used before being declared */
  60         WARN_IMPLICIT_INT,                  /**< Warn when a declaration does not specify a type */
  61 #if 0 // TODO
  62         WARN_INLINE,                        /**< Warn if a function can not be inlined and it was declared as inline */
  63         WARN_INT_TO_POINTER_CAST,           /**< Warn if cast from integer to pointer of different size. */
  64 #endif
  65         WARN_LONG_LONG,                     /**< Warn if 'long long' type is used */
  66         WARN_MAIN,                          /**< Warn if the type of 'main' is suspicious */
  67 #if 0 // TODO
  68         WARN_MISSING_BRACES,                /**< Warn if an aggregate or union initializer is not fully bracketed */
  69 #endif
  70         WARN_MISSING_DECLARATIONS,          /**< Warn if a global function is defined without a previous declaration */
  71 #if 0 // TODO
  72         WARN_MISSING_FIELD_INITIALIZERS,    /**< Warn if a structure's initializer has some fields missing. */
  73         WARN_MISSING_FORMAT_ATTRIBUTE,      /**< If '-Wformat' is enabled, also warn about functions which might be candidates for 'format' attributes */
  74 #endif
  75         WARN_MISSING_NORETURN,              /**< Warn about functions which might be candidates for attribute 'noreturn' */
  76         WARN_MISSING_PROTOTYPES,            /**< Warn if a global function is defined without a previous prototype declaration */
  77         WARN_MULTICHAR,                     /**< Warn if a multicharacter constant ('FOOF') is used. */
  78         WARN_NESTED_EXTERNS,                /**< Warn if an 'extern' declaration is encountered within a function. */
  79         WARN_NONNULL,                       /**< Warn about passing a null pointer for arguments marked nonnull. */
  80         WARN_OLD_STYLE_DEFINITION,          /**< Warn if an old-style function definition is used. */
  81         WARN_OTHER,                         /**< Warnings not covered by any other option */
  82         WARN_PACKED,                        /**< Warn if a structure is given the packed attribute, but the packed attribute has no effect on the layout or size of the structure */
  83         WARN_PADDED,                        /**< Warn if padding is included in a structure, either to align an element of the structure or to align the whole structure */
  84         WARN_PARENTHESES,                   /**< Warn if parentheses are omitted in certain contexts (assignment where truth value is expected, if-else-braces) */
  85         WARN_POINTER_ARITH,                 /**< Warn about anything that depends on the "size of" a function type or of 'void' */
  86 #if 0 // TODO
  87         WARN_POINTER_TO_INT_CAST,           /**< Warn if cast from pointer to integer of different size. */
  88 #endif
  89         WARN_REDUNDANT_DECLS,               /**< Warn about redundant declarations */
  90         WARN_RETURN_TYPE,                   /* TODO not fully implemented */ /**< Warn about function definitions with a return-type that defaults to 'int'.  Also warn about any 'return' statement with no return-value in a function whose return-type is not 'void'. */
  91 #if 0 // TODO
  92         WARN_SEQUENCE_POINT,                /**< Warn about code that may have undefined semantics because of violations of sequence point rules */
  93 #endif
  94         WARN_SHADOW,                        /**< Warn whenever a local variable shadows another local variable, parameter or global variable or whenever a built-in function is shadowed */
  95         WARN_SHADOW_LOCAL,
  96         WARN_SIGN_COMPARE,                  /**< Warn when a comparison between signed and unsigned values could produce an incorrect result when the signed value is converted to unsigned */
  97         WARN_STRAY_SEMICOLON,               /**< Warn about stray semicolons outside of functions */
  98 #if 0 // TODO
  99         WARN_STRICT_ALIASING,               /**< Warn about code which might break the strict aliasing rules that the compiler is using for optimization. */
 100 #endif
 101         WARN_STRICT_PROTOTYPES,             /**< Warn if a function declaration has an unspecified parameter list */
 102         WARN_SWITCH_DEFAULT,                /**< Warn whenever a 'switch' statement does not have a 'default' case */
 103         WARN_SWITCH_ENUM,                   /**< Warn about 'switch' statements with an enum as index type and missing case labels or case labels outside the enum range TODO has an alias -Wswitch? */
 104         WARN_TRADITIONAL,                   /**< Warn about certain constructs that behave differently in traditional and ISO C */
 105 #if 0 // TODO
 106         WARN_UNDEF,                         /**< Warn if an undefined identifier is evaluated in an '#if' directive */
 107 #endif
 108         WARN_UNINITIALIZED,                 /**< Warn if an automatic variable is used without being initialized or if a variable may be clobbered by a 'setjmp' call. */
 109         WARN_UNKNOWN_PRAGMAS,               /**< Warn when a #pragma directive is encountered which is not understood */
 110         WARN_UNREACHABLE_CODE,              /**< Warn if the compiler detects that code will never be executed */
 111         WARN_UNUSED_FUNCTION,               /**< Warn whenever a static function is declared but not defined or a non-inline static function is unused */
 112         WARN_UNUSED_LABEL,                  /**< Warn whenever a label is declared but not used */
 113         WARN_UNUSED_PARAMETER,              /**< Warn whenever a function parameter is unused aside from its declaration */
 114         WARN_UNUSED_VALUE,                  /**< Warn whenever a statement computes a result that is explicitly not used */
 115         WARN_UNUSED_VARIABLE,               /**< Warn whenever a local variable or non-constant static variable is unused aside from its declaration */
 116         WARN_WRITE_STRINGS,                 /**< Give string constants the type 'const char[LENGTH]' so that copying the address of one into a 'char *' pointer will get a warning */
 117 } warning_t;
 118
 119 typedef enum warn_state_t {
 120         WARN_STATE_NONE     = 0,
 121         WARN_STATE_ON       = 1U << 0,
 122         WARN_STATE_ERROR    = 1U << 1,
 123         WARN_STATE_NO_ERROR = 1U << 2
 124 } warn_state_t;
 125
 126 typedef struct warning_switch_t {
 127         warn_state_t      state;
 128         char const* const name;
 129 } warning_switch_t;
 130
 131 warning_switch_t const *get_warn_switch(warning_t);
 132
 133 static inline bool is_warn_on(warning_t const warn)
 134 {
 135         return get_warn_switch(warn)->state & WARN_STATE_ON;
 136 }
 137
 138 #endif