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 #include "diagnostic-core.h"
  27
  28 /* A diagnostic is described by the MESSAGE to send, the FILE and LINE of
  29    its context and its KIND (ice, error, warning, note, ...)  See complete
  30    list in diagnostic.def.  */
  31 typedef struct diagnostic_info
  32 {
  33   text_info message;
  34   location_t location;
  35   unsigned int override_column;
  36   /* Auxiliary data for client.  */
  37   void *x_data;
  38   /* The kind of diagnostic it is about.  */
  39   diagnostic_t kind;
  40   /* Which OPT_* directly controls this diagnostic.  */
  41   int option_index;
  42 } diagnostic_info;
  43
  44 /* Each time a diagnostic's classification is changed with a pragma,
  45    we record the change and the location of the change in an array of
  46    these structs.  */
  47 typedef struct diagnostic_classification_change_t
  48 {
  49   location_t location;
  50   int option;
  51   diagnostic_t kind;
  52 } diagnostic_classification_change_t;
  53
  54 /*  Forward declarations.  */
  55 typedef void (*diagnostic_starter_fn) (diagnostic_context *,
  56                                        diagnostic_info *);
  57 typedef diagnostic_starter_fn diagnostic_finalizer_fn;
  58
  59 /* This data structure bundles altogether any information relevant to
  60    the context of a diagnostic message.  */
  61 struct diagnostic_context
  62 {
  63   /* Where most of the diagnostic formatting work is done.  */
  64   pretty_printer *printer;
  65
  66   /* The number of times we have issued diagnostics.  */
  67   int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
  68
  69   /* True if we should display the "warnings are being tread as error"
  70      message, usually displayed once per compiler run.  */
  71   bool some_warnings_are_errors;
  72
  73   /* True if it has been requested that warnings be treated as errors.  */
  74   bool warning_as_error_requested;
  75
  76   /* The number of option indexes that can be passed to warning() et
  77      al.  */
  78   int n_opts;
  79
  80   /* For each option index that can be passed to warning() et al
  81      (OPT_* from options.h when using this code with the core GCC
  82      options), this array may contain a new kind that the diagnostic
  83      should be changed to before reporting, or DK_UNSPECIFIED to leave
  84      it as the reported kind, or DK_IGNORED to not report it at
  85      all.  */
  86   diagnostic_t *classify_diagnostic;
  87
  88   /* History of all changes to the classifications above.  This list
  89      is stored in location-order, so we can search it, either
  90      binary-wise or end-to-front, to find the most recent
  91      classification for a given diagnostic, given the location of the
  92      diagnostic.  */
  93   diagnostic_classification_change_t *classification_history;
  94
  95   /* The size of the above array.  */
  96   int n_classification_history;
  97
  98   /* For pragma push/pop.  */
  99   int *push_list;
 100   int n_push;
 101
 102   /* True if we should print the source line with a caret indicating
 103      the location.  */
 104   bool show_caret;
 105
 106   /* Maximum width of the source line printed.  */
 107   int caret_max_width;
 108
 109   /* True if we should print the command line option which controls
 110      each diagnostic, if known.  */
 111   bool show_option_requested;
 112
 113   /* True if we should raise a SIGABRT on errors.  */
 114   bool abort_on_error;
 115
 116   /* True if we should show the column number on diagnostics.  */
 117   bool show_column;
 118
 119   /* True if pedwarns are errors.  */
 120   bool pedantic_errors;
 121
 122   /* True if permerrors are warnings.  */
 123   bool permissive;
 124
 125   /* The index of the option to associate with turning permerrors into
 126      warnings.  */
 127   int opt_permissive;
 128
 129   /* True if errors are fatal.  */
 130   bool fatal_errors;
 131
 132   /* True if all warnings should be disabled.  */
 133   bool dc_inhibit_warnings;
 134
 135   /* True if warnings should be given in system headers.  */
 136   bool dc_warn_system_headers;
 137
 138   /* Maximum number of errors to report.  */
 139   unsigned int max_errors;
 140
 141   /* This function is called before any message is printed out.  It is
 142      responsible for preparing message prefix and such.  For example, it
 143      might say:
 144      In file included from "/usr/local/include/curses.h:5:
 145                       from "/home/gdr/src/nifty_printer.h:56:
 146                       ...
 147   */
 148   diagnostic_starter_fn begin_diagnostic;
 149
 150   /* This function is called after the diagnostic message is printed.  */
 151   diagnostic_finalizer_fn end_diagnostic;
 152
 153   /* Client hook to report an internal error.  */
 154   void (*internal_error) (diagnostic_context *, const char *, va_list *);
 155
 156   /* Client hook to say whether the option controlling a diagnostic is
 157      enabled.  Returns nonzero if enabled, zero if disabled.  */
 158   int (*option_enabled) (int, void *);
 159
 160   /* Client information to pass as second argument to
 161      option_enabled.  */
 162   void *option_state;
 163
 164   /* Client hook to return the name of an option that controls a
 165      diagnostic.  Returns malloced memory.  The first diagnostic_t
 166      argument is the kind of diagnostic before any reclassification
 167      (of warnings as errors, etc.); the second is the kind after any
 168      reclassification.  May return NULL if no name is to be printed.
 169      May be passed 0 as well as the index of a particular option.  */
 170   char *(*option_name) (diagnostic_context *, int, diagnostic_t, diagnostic_t);
 171
 172   /* Auxiliary data for client.  */
 173   void *x_data;
 174
 175   /* Used to detect that the last caret was printed at the same location.  */
 176   location_t last_location;
 177
 178   /* Used to detect when the input file stack has changed since last
 179      described.  */
 180   const struct line_map *last_module;
 181
 182   int lock;
 183
 184   bool inhibit_notes_p;
 185 };
 186
 187 static inline void
 188 diagnostic_inhibit_notes (diagnostic_context * context)
 189 {
 190   context->inhibit_notes_p = true;
 191 }
 192
 193
 194 /* Client supplied function to announce a diagnostic.  */
 195 #define diagnostic_starter(DC) (DC)->begin_diagnostic
 196
 197 /* Client supplied function called after a diagnostic message is
 198    displayed.  */
 199 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
 200
 201 /* Extension hooks for client.  */
 202 #define diagnostic_context_auxiliary_data(DC) (DC)->x_data
 203 #define diagnostic_info_auxiliary_data(DI) (DI)->x_data
 204
 205 /* Same as pp_format_decoder.  Works on 'diagnostic_context *'.  */
 206 #define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder)
 207
 208 /* Same as output_prefixing_rule.  Works on 'diagnostic_context *'.  */
 209 #define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule)
 210
 211 /* Maximum characters per line in automatic line wrapping mode.
 212    Zero means don't wrap lines.  */
 213 #define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
 214
 215 #define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer)
 216
 217 /* True if the last module or file in which a diagnostic was reported is
 218    different from the current one.  */
 219 #define diagnostic_last_module_changed(DC, MAP) \
 220   ((DC)->last_module != MAP)
 221
 222 /* Remember the current module or file as being the last one in which we
 223    report a diagnostic.  */
 224 #define diagnostic_set_last_module(DC, MAP)     \
 225   (DC)->last_module = MAP
 226
 227 /* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher.  */
 228 #define diagnostic_abort_on_error(DC) \
 229   (DC)->abort_on_error = true
 230
 231 /* This diagnostic_context is used by front-ends that directly output
 232    diagnostic messages without going through `error', `warning',
 233    and similar functions.  */
 234 extern diagnostic_context *global_dc;
 235
 236 /* The total count of a KIND of diagnostics emitted so far.  */
 237 #define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
 238
 239 /* The number of errors that have been issued so far.  Ideally, these
 240    would take a diagnostic_context as an argument.  */
 241 #define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
 242 /* Similarly, but for warnings.  */
 243 #define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
 244 /* Similarly, but for sorrys.  */
 245 #define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
 246
 247 /* Returns nonzero if warnings should be emitted.  */
 248 #define diagnostic_report_warnings_p(DC, LOC)                           \
 249   (!(DC)->dc_inhibit_warnings                                           \
 250    && !(in_system_header_at (LOC) && !(DC)->dc_warn_system_headers))
 251
 252 #define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
 253
 254 /* Override the column number to be used for reporting a
 255    diagnostic.  */
 256 #define diagnostic_override_column(DI, COL) (DI)->override_column = (COL)
 257
 258 /* Override the option index to be used for reporting a
 259    diagnostic.  */
 260 #define diagnostic_override_option_index(DI, OPTIDX) \
 261     ((DI)->option_index = (OPTIDX))
 262
 263 /* Diagnostic related functions.  */
 264 extern void diagnostic_initialize (diagnostic_context *, int);
 265 extern void diagnostic_finish (diagnostic_context *);
 266 extern void diagnostic_report_current_module (diagnostic_context *, location_t);
 267 extern void diagnostic_show_locus (diagnostic_context *, const diagnostic_info *);
 268
 269 /* Force diagnostics controlled by OPTIDX to be kind KIND.  */
 270 extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *,
 271                                                     int /* optidx */,
 272                                                     diagnostic_t /* kind */,
 273                                                     location_t);
 274 extern void diagnostic_push_diagnostics (diagnostic_context *, location_t);
 275 extern void diagnostic_pop_diagnostics (diagnostic_context *, location_t);
 276 extern bool diagnostic_report_diagnostic (diagnostic_context *,
 277                                           diagnostic_info *);
 278 #ifdef ATTRIBUTE_GCC_DIAG
 279 extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *,
 280                                  location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0);
 281 extern void diagnostic_set_info_translated (diagnostic_info *, const char *,
 282                                             va_list *, location_t,
 283                                             diagnostic_t)
 284      ATTRIBUTE_GCC_DIAG(2,0);
 285 extern void diagnostic_append_note (diagnostic_context *, location_t,
 286                                     const char *, ...) ATTRIBUTE_GCC_DIAG(3,4);
 287 #endif
 288 extern char *diagnostic_build_prefix (diagnostic_context *, const diagnostic_info *);
 289 void default_diagnostic_starter (diagnostic_context *, diagnostic_info *);
 290 void default_diagnostic_finalizer (diagnostic_context *, diagnostic_info *);
 291 void diagnostic_set_caret_max_width (diagnostic_context *context, int value);
 292
 293
 294 /* Pure text formatting support functions.  */
 295 extern char *file_name_as_prefix (const char *);
 296
 297 #endif /* ! GCC_DIAGNOSTIC_H */