gcc/diagnostic.h

   1 /* Various declarations for language-independent diagnostics subroutines.
   2    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
   3    2010, Free Software Foundation, Inc.
   4    Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 3, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef GCC_DIAGNOSTIC_H
  23 #define GCC_DIAGNOSTIC_H
  24
  25 #include "pretty-print.h"
  26
  27 /* Constants used to discriminate diagnostics.  */
  28 typedef enum
  29 {
  30 #define DEFINE_DIAGNOSTIC_KIND(K, msgid) K,
  31 #include "diagnostic.def"
  32 #undef DEFINE_DIAGNOSTIC_KIND
  33   DK_LAST_DIAGNOSTIC_KIND
  34 } diagnostic_t;
  35
  36 /* A diagnostic is described by the MESSAGE to send, the FILE and LINE of
  37    its context and its KIND (ice, error, warning, note, ...)  See complete
  38    list in diagnostic.def.  */
  39 typedef struct diagnostic_info
  40 {
  41   text_info message;
  42   location_t location;
  43   unsigned int override_column;
  44   /* Auxiliary data for client.  */
  45   void *x_data;
  46   /* The kind of diagnostic it is about.  */
  47   diagnostic_t kind;
  48   /* Which OPT_* directly controls this diagnostic.  */
  49   int option_index;
  50 } diagnostic_info;
  51
  52 /*  Forward declarations.  */
  53 typedef struct diagnostic_context diagnostic_context;
  54 typedef void (*diagnostic_starter_fn) (diagnostic_context *,
  55                                        diagnostic_info *);
  56 typedef diagnostic_starter_fn diagnostic_finalizer_fn;
  57
  58 /* This data structure bundles altogether any information relevant to
  59    the context of a diagnostic message.  */
  60 struct diagnostic_context
  61 {
  62   /* Where most of the diagnostic formatting work is done.  */
  63   pretty_printer *printer;
  64
  65   /* The number of times we have issued diagnostics.  */
  66   int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
  67
  68   /* True if we should display the "warnings are being tread as error"
  69      message, usually displayed once per compiler run.  */
  70   bool some_warnings_are_errors;
  71
  72   /* True if it has been requested that warnings be treated as errors.  */
  73   bool warning_as_error_requested;
  74
  75   /* The number of option indexes that can be passed to warning() et
  76      al.  */
  77   int n_opts;
  78
  79   /* For each option index that can be passed to warning() et al
  80      (OPT_* from options.h when using this code with the core GCC
  81      options), this array may contain a new kind that the diagnostic
  82      should be changed to before reporting, or DK_UNSPECIFIED to leave
  83      it as the reported kind, or DK_IGNORED to not report it at
  84      all.  */
  85   diagnostic_t *classify_diagnostic;
  86
  87   /* True if we should print the command line option which controls
  88      each diagnostic, if known.  */
  89   bool show_option_requested;
  90
  91   /* True if we should raise a SIGABRT on errors.  */
  92   bool abort_on_error;
  93
  94   /* True if we should show the column number on diagnostics.  */
  95   bool show_column;
  96
  97   /* True if pedwarns are errors.  */
  98   bool pedantic_errors;
  99
 100   /* True if permerrors are warnings.  */
 101   bool permissive;
 102
 103   /* The index of the option to associate with turning permerrors into
 104      warnings.  */
 105   int opt_permissive;
 106
 107   /* True if errors are fatal.  */
 108   bool fatal_errors;
 109
 110   /* True if all warnings should be disabled.  */
 111   bool inhibit_warnings;
 112
 113   /* True if warnings should be given in system headers.  */
 114   bool warn_system_headers;
 115
 116   /* This function is called before any message is printed out.  It is
 117      responsible for preparing message prefix and such.  For example, it
 118      might say:
 119      In file included from "/usr/local/include/curses.h:5:
 120                       from "/home/gdr/src/nifty_printer.h:56:
 121                       ...
 122   */
 123   diagnostic_starter_fn begin_diagnostic;
 124
 125   /* This function is called after the diagnostic message is printed.  */
 126   diagnostic_finalizer_fn end_diagnostic;
 127
 128   /* Client hook to report an internal error.  */
 129   void (*internal_error) (diagnostic_context *, const char *, va_list *);
 130
 131   /* Client hook to say whether the option controlling a diagnostic is
 132      enabled.  Returns nonzero if enabled, zero if disabled.  */
 133   int (*option_enabled) (int);
 134
 135   /* Client hook to return the name of an option that controls a
 136      diagnostic.  Returns malloced memory.  The first diagnostic_t
 137      argument is the kind of diagnostic before any reclassification
 138      (of warnings as errors, etc.); the second is the kind after any
 139      reclassification.  May return NULL if no name is to be printed.
 140      May be passed 0 as well as the index of a particular option.  */
 141   char *(*option_name) (diagnostic_context *, int, diagnostic_t, diagnostic_t);
 142
 143   /* Auxiliary data for client.  */
 144   void *x_data;
 145
 146   /* Used to detect when the input file stack has changed since last
 147      described.  */
 148   const struct line_map *last_module;
 149
 150   int lock;
 151
 152   bool inhibit_notes_p;
 153 };
 154
 155 static inline void
 156 diagnostic_inhibit_notes (diagnostic_context * context)
 157 {
 158   context->inhibit_notes_p = true;
 159 }
 160
 161
 162 /* Client supplied function to announce a diagnostic.  */
 163 #define diagnostic_starter(DC) (DC)->begin_diagnostic
 164
 165 /* Client supplied function called after a diagnostic message is
 166    displayed.  */
 167 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
 168
 169 /* Extension hooks for client.  */
 170 #define diagnostic_context_auxiliary_data(DC) (DC)->x_data
 171 #define diagnostic_info_auxiliary_data(DI) (DI)->x_data
 172
 173 /* Same as pp_format_decoder.  Works on 'diagnostic_context *'.  */
 174 #define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder)
 175
 176 /* Same as output_prefixing_rule.  Works on 'diagnostic_context *'.  */
 177 #define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule)
 178
 179 /* Maximum characters per line in automatic line wrapping mode.
 180    Zero means don't wrap lines.  */
 181 #define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
 182
 183 #define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer)
 184
 185 /* True if the last module or file in which a diagnostic was reported is
 186    different from the current one.  */
 187 #define diagnostic_last_module_changed(DC, MAP) \
 188   ((DC)->last_module != MAP)
 189
 190 /* Remember the current module or file as being the last one in which we
 191    report a diagnostic.  */
 192 #define diagnostic_set_last_module(DC, MAP)     \
 193   (DC)->last_module = MAP
 194
 195 /* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher.  */
 196 #define diagnostic_abort_on_error(DC) \
 197   (DC)->abort_on_error = true
 198
 199 /* This diagnostic_context is used by front-ends that directly output
 200    diagnostic messages without going through `error', `warning',
 201    and similar functions.  */
 202 extern diagnostic_context *global_dc;
 203
 204 /* The total count of a KIND of diagnostics emitted so far.  */
 205 #define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
 206
 207 /* The number of errors that have been issued so far.  Ideally, these
 208    would take a diagnostic_context as an argument.  */
 209 #define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
 210 /* Similarly, but for warnings.  */
 211 #define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
 212 /* Similarly, but for sorrys.  */
 213 #define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
 214
 215 /* Returns nonzero if warnings should be emitted.  */
 216 #define diagnostic_report_warnings_p(DC, LOC)                           \
 217   (!(DC)->inhibit_warnings                                              \
 218    && !(in_system_header_at (LOC) && !(DC)->warn_system_headers))
 219
 220 #define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
 221
 222 /* Override the column number to be used for reporting a
 223    diagnostic.  */
 224 #define diagnostic_override_column(DI, COL) (DI)->override_column = (COL)
 225
 226 /* Override the option index to be used for reporting a
 227    diagnostic.  */
 228 #define diagnostic_override_option_index(DI, OPTIDX) \
 229     ((DI)->option_index = (OPTIDX))
 230
 231 /* Diagnostic related functions.  */
 232 extern void diagnostic_initialize (diagnostic_context *, int);
 233 extern void diagnostic_finish (diagnostic_context *);
 234 extern void diagnostic_report_current_module (diagnostic_context *);
 235
 236 /* Force diagnostics controlled by OPTIDX to be kind KIND.  */
 237 extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *,
 238                                                     int /* optidx */,
 239                                                     diagnostic_t /* kind */);
 240 extern bool diagnostic_report_diagnostic (diagnostic_context *,
 241                                           diagnostic_info *);
 242 #ifdef ATTRIBUTE_GCC_DIAG
 243 extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *,
 244                                  location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0);
 245 extern void diagnostic_set_info_translated (diagnostic_info *, const char *,
 246                                             va_list *, location_t,
 247                                             diagnostic_t)
 248      ATTRIBUTE_GCC_DIAG(2,0);
 249 extern bool emit_diagnostic (diagnostic_t, location_t, int,
 250                              const char *, ...) ATTRIBUTE_GCC_DIAG(4,5);
 251 #endif
 252 extern char *diagnostic_build_prefix (diagnostic_context *, diagnostic_info *);
 253 void default_diagnostic_starter (diagnostic_context *, diagnostic_info *);
 254 void default_diagnostic_finalizer (diagnostic_context *, diagnostic_info *);
 255
 256 /* Pure text formatting support functions.  */
 257 extern char *file_name_as_prefix (const char *);
 258
 259 #endif /* ! GCC_DIAGNOSTIC_H */