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