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