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 "options.h"
  27
  28 /* Constants used to discriminate diagnostics.  */
  29 typedef enum
  30 {
  31 #define DEFINE_DIAGNOSTIC_KIND(K, msgid) K,
  32 #include "diagnostic.def"
  33 #undef DEFINE_DIAGNOSTIC_KIND
  34   DK_LAST_DIAGNOSTIC_KIND
  35 } diagnostic_t;
  36
  37 /* A diagnostic is described by the MESSAGE to send, the FILE and LINE of
  38    its context and its KIND (ice, error, warning, note, ...)  See complete
  39    list in diagnostic.def.  */
  40 typedef struct diagnostic_info
  41 {
  42   text_info message;
  43   location_t location;
  44   unsigned int override_column;
  45   /* Auxiliary data for client.  */
  46   void *x_data;
  47   /* The kind of diagnostic it is about.  */
  48   diagnostic_t kind;
  49   /* Which OPT_* directly controls this diagnostic.  */
  50   int option_index;
  51 } diagnostic_info;
  52
  53 /*  Forward declarations.  */
  54 typedef struct diagnostic_context diagnostic_context;
  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   /* For each option index that can be passed to warning() et all
  77      (OPT_* from options.h), this array may contain a new kind that
  78      the diagnostic should be changed to before reporting, or
  79      DK_UNSPECIFIED to leave it as the reported kind, or DK_IGNORED to
  80      not report it at all.  N_OPTS is from <options.h>.  */
  81   diagnostic_t classify_diagnostic[N_OPTS];
  82
  83   /* True if we should print the command line option which controls
  84      each diagnostic, if known.  */
  85   bool show_option_requested;
  86
  87   /* True if we should raise a SIGABRT on errors.  */
  88   bool abort_on_error;
  89
  90   /* This function is called before any message is printed out.  It is
  91      responsible for preparing message prefix and such.  For example, it
  92      might say:
  93      In file included from "/usr/local/include/curses.h:5:
  94                       from "/home/gdr/src/nifty_printer.h:56:
  95                       ...
  96   */
  97   diagnostic_starter_fn begin_diagnostic;
  98
  99   /* This function is called after the diagnostic message is printed.  */
 100   diagnostic_finalizer_fn end_diagnostic;
 101
 102   /* Client hook to report an internal error.  */
 103   void (*internal_error) (const char *, va_list *);
 104
 105   /* Auxiliary data for client.  */
 106   void *x_data;
 107
 108   /* Used to detect when the input file stack has changed since last
 109      described.  */
 110   const struct line_map *last_module;
 111
 112   int lock;
 113
 114   bool inhibit_notes_p;
 115 };
 116
 117 static inline void
 118 diagnostic_inhibit_notes (diagnostic_context * context)
 119 {
 120   context->inhibit_notes_p = true;
 121 }
 122
 123
 124 /* Client supplied function to announce a diagnostic.  */
 125 #define diagnostic_starter(DC) (DC)->begin_diagnostic
 126
 127 /* Client supplied function called after a diagnostic message is
 128    displayed.  */
 129 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
 130
 131 /* Extension hooks for client.  */
 132 #define diagnostic_context_auxiliary_data(DC) (DC)->x_data
 133 #define diagnostic_info_auxiliary_data(DI) (DI)->x_data
 134
 135 /* Same as pp_format_decoder.  Works on 'diagnostic_context *'.  */
 136 #define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder)
 137
 138 /* Same as output_prefixing_rule.  Works on 'diagnostic_context *'.  */
 139 #define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule)
 140
 141 /* Maximum characters per line in automatic line wrapping mode.
 142    Zero means don't wrap lines.  */
 143 #define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
 144
 145 #define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer)
 146
 147 /* True if the last module or file in which a diagnostic was reported is
 148    different from the current one.  */
 149 #define diagnostic_last_module_changed(DC, MAP) \
 150   ((DC)->last_module != MAP)
 151
 152 /* Remember the current module or file as being the last one in which we
 153    report a diagnostic.  */
 154 #define diagnostic_set_last_module(DC, MAP)     \
 155   (DC)->last_module = MAP
 156
 157 /* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher.  */
 158 #define diagnostic_abort_on_error(DC) \
 159   (DC)->abort_on_error = true
 160
 161 /* This diagnostic_context is used by front-ends that directly output
 162    diagnostic messages without going through `error', `warning',
 163    and similar functions.  */
 164 extern diagnostic_context *global_dc;
 165
 166 /* The total count of a KIND of diagnostics emitted so far.  */
 167 #define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
 168
 169 /* The number of errors that have been issued so far.  Ideally, these
 170    would take a diagnostic_context as an argument.  */
 171 #define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
 172 /* Similarly, but for warnings.  */
 173 #define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
 174 /* Similarly, but for sorrys.  */
 175 #define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
 176
 177 /* Returns nonzero if warnings should be emitted.  */
 178 #define diagnostic_report_warnings_p(LOC)                       \
 179   (!inhibit_warnings                                    \
 180    && !(in_system_header_at (LOC) && !warn_system_headers))
 181
 182 #define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
 183
 184 /* Override the column number to be used for reporting a
 185    diagnostic.  */
 186 #define diagnostic_override_column(DI, COL) (DI)->override_column = (COL)
 187
 188 /* Override the option index to be used for reporting a
 189    diagnostic.  */
 190 #define diagnostic_override_option_index(DI, OPTIDX) \
 191     ((DI)->option_index = (OPTIDX))
 192
 193 /* Diagnostic related functions.  */
 194 extern void diagnostic_initialize (diagnostic_context *);
 195 extern void diagnostic_finish (diagnostic_context *);
 196 extern void diagnostic_report_current_module (diagnostic_context *);
 197
 198 /* Force diagnostics controlled by OPTIDX to be kind KIND.  */
 199 extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *,
 200                                                     int /* optidx */,
 201                                                     diagnostic_t /* kind */);
 202 extern bool diagnostic_report_diagnostic (diagnostic_context *,
 203                                           diagnostic_info *);
 204 #ifdef ATTRIBUTE_GCC_DIAG
 205 extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *,
 206                                  location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0);
 207 extern void diagnostic_set_info_translated (diagnostic_info *, const char *,
 208                                             va_list *, location_t,
 209                                             diagnostic_t)
 210      ATTRIBUTE_GCC_DIAG(2,0);
 211 extern bool emit_diagnostic (diagnostic_t, location_t, int,
 212                              const char *, ...) ATTRIBUTE_GCC_DIAG(4,5);
 213 #endif
 214 extern char *diagnostic_build_prefix (diagnostic_info *);
 215 void default_diagnostic_starter (diagnostic_context *, diagnostic_info *);
 216 void default_diagnostic_finalizer (diagnostic_context *, diagnostic_info *);
 217
 218 /* Pure text formatting support functions.  */
 219 extern char *file_name_as_prefix (const char *);
 220
 221 #endif /* ! GCC_DIAGNOSTIC_H */