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    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   /* TREE_BLOCK if the diagnostic is to be reported in some inline
  46      function inlined into other function, otherwise NULL.  */
  47   tree abstract_origin;
  48   /* The kind of diagnostic it is about.  */
  49   diagnostic_t kind;
  50   /* Which OPT_* directly controls this diagnostic.  */
  51   int option_index;
  52 } diagnostic_info;
  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 issue_warnings_are_errors_message;
  73
  74   /* True if it has been requested that warnings be treated as errors.  */
  75   bool warning_as_error_requested;
  76
  77   /* For each option index that can be passed to warning() et all
  78      (OPT_* from options.h), this array may contain a new kind that
  79      the diagnostic should be changed to before reporting, or
  80      DK_UNSPECIFIED to leave it as the reported kind, or DK_IGNORED to
  81      not report it at all.  N_OPTS is from <options.h>.  */
  82   diagnostic_t classify_diagnostic[N_OPTS];
  83
  84   /* True if we should print the command line option which controls
  85      each diagnostic, if known.  */
  86   bool show_option_requested;
  87
  88   /* True if we should raise a SIGABRT on errors.  */
  89   bool abort_on_error;
  90
  91   /* This function is called before any message is printed out.  It is
  92      responsible for preparing message prefix and such.  For example, it
  93      might say:
  94      In file included from "/usr/local/include/curses.h:5:
  95                       from "/home/gdr/src/nifty_printer.h:56:
  96                       ...
  97   */
  98   diagnostic_starter_fn begin_diagnostic;
  99
 100   /* This function is called after the diagnostic message is printed.  */
 101   diagnostic_finalizer_fn end_diagnostic;
 102
 103   /* Client hook to report an internal error.  */
 104   void (*internal_error) (const char *, va_list *);
 105
 106   /* Function of last diagnostic message; more generally, function such that
 107      if next diagnostic message is in it then we don't have to mention the
 108      function name.  */
 109   tree last_function;
 110
 111   /* Used to detect when the input file stack has changed since last
 112      described.  */
 113   const struct line_map *last_module;
 114
 115   int lock;
 116 };
 117
 118 /* Client supplied function to announce a diagnostic.  */
 119 #define diagnostic_starter(DC) (DC)->begin_diagnostic
 120
 121 /* Client supplied function called after a diagnostic message is
 122    displayed.  */
 123 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
 124
 125 /* Extension hook for client.  */
 126 #define diagnostic_auxiliary_data(DC) (DC)->x_data
 127
 128 /* Same as pp_format_decoder.  Works on 'diagnostic_context *'.  */
 129 #define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder)
 130
 131 /* Same as output_prefixing_rule.  Works on 'diagnostic_context *'.  */
 132 #define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule)
 133
 134 /* Maximum characters per line in automatic line wrapping mode.
 135    Zero means don't wrap lines.  */
 136 #define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
 137
 138 #define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer)
 139
 140 /* True if the last function in which a diagnostic was reported is
 141    different from the current one.  */
 142 #define diagnostic_last_function_changed(DC, DI) \
 143   ((DC)->last_function != ((DI)->abstract_origin \
 144                            ? (DI)->abstract_origin : current_function_decl))
 145
 146 /* Remember the current function as being the last one in which we report
 147    a diagnostic.  */
 148 #define diagnostic_set_last_function(DC, DI) \
 149   (DC)->last_function = (((DI) && (DI)->abstract_origin) \
 150                          ? (DI)->abstract_origin : current_function_decl)
 151
 152 /* True if the last module or file in which a diagnostic was reported is
 153    different from the current one.  */
 154 #define diagnostic_last_module_changed(DC, MAP) \
 155   ((DC)->last_module != MAP)
 156
 157 /* Remember the current module or file as being the last one in which we
 158    report a diagnostic.  */
 159 #define diagnostic_set_last_module(DC, MAP)     \
 160   (DC)->last_module = MAP
 161
 162 /* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher.  */
 163 #define diagnostic_abort_on_error(DC) \
 164   (DC)->abort_on_error = true
 165
 166 /* This diagnostic_context is used by front-ends that directly output
 167    diagnostic messages without going through `error', `warning',
 168    and similar functions.  */
 169 extern diagnostic_context *global_dc;
 170
 171 /* The total count of a KIND of diagnostics emitted so far.  */
 172 #define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
 173
 174 /* The number of errors that have been issued so far.  Ideally, these
 175    would take a diagnostic_context as an argument.  */
 176 #define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
 177 /* Similarly, but for warnings.  */
 178 #define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
 179 /* Similarly, but for sorrys.  */
 180 #define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
 181
 182 /* Returns nonzero if warnings should be emitted.  */
 183 #define diagnostic_report_warnings_p(LOC)                       \
 184   (!inhibit_warnings                                    \
 185    && !(in_system_header_at (LOC) && !warn_system_headers))
 186
 187 #define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
 188
 189 /* Override the column number to be used for reporting a
 190    diagnostic.  */
 191 #define diagnostic_override_column(DI, COL) (DI)->override_column = (COL)
 192
 193 /* Diagnostic related functions.  */
 194 extern void diagnostic_initialize (diagnostic_context *);
 195 extern void diagnostic_report_current_module (diagnostic_context *);
 196 extern void diagnostic_report_current_function (diagnostic_context *,
 197                                                 diagnostic_info *);
 198
 199 /* Force diagnostics controlled by OPTIDX to be kind KIND.  */
 200 extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *,
 201                                                     int /* optidx */,
 202                                                     diagnostic_t /* kind */);
 203 extern bool diagnostic_report_diagnostic (diagnostic_context *,
 204                                           diagnostic_info *);
 205 #ifdef ATTRIBUTE_GCC_DIAG
 206 extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *,
 207                                  location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0);
 208 extern void diagnostic_set_info_translated (diagnostic_info *, const char *,
 209                                             va_list *, location_t,
 210                                             diagnostic_t)
 211      ATTRIBUTE_GCC_DIAG(2,0);
 212 extern bool emit_diagnostic (diagnostic_t, location_t, int,
 213                              const char *, ...) ATTRIBUTE_GCC_DIAG(4,5);
 214 #endif
 215 extern char *diagnostic_build_prefix (diagnostic_info *);
 216
 217 /* Pure text formatting support functions.  */
 218 extern char *file_name_as_prefix (const char *);
 219
 220 /* In tree-pretty-print.c  */
 221 extern void print_declaration (pretty_printer *, tree, int, int);
 222 extern int dump_generic_node (pretty_printer *, tree, int, int, bool);
 223 extern void print_generic_stmt (FILE *, tree, int);
 224 extern void print_generic_stmt_indented (FILE *, tree, int, int);
 225 extern void print_generic_expr (FILE *, tree, int);
 226 extern void print_generic_decl (FILE *, tree, int);
 227 extern void debug_c_tree (tree);
 228 extern void dump_omp_clauses (pretty_printer *, tree, int, int);
 229 extern void print_call_name (pretty_printer *, tree, int);
 230
 231 /* In gimple-pretty-print.c  */
 232 extern void debug_generic_expr (tree);
 233 extern void debug_generic_stmt (tree);
 234 extern void debug_tree_chain (tree);
 235 extern void debug_gimple_stmt (gimple);
 236 extern void debug_gimple_seq (gimple_seq);
 237 extern void print_gimple_seq (FILE *, gimple_seq, int, int);
 238 extern void print_gimple_stmt (FILE *, gimple, int, int);
 239 extern void print_gimple_expr (FILE *, gimple, int, int);
 240 extern void dump_gimple_stmt (pretty_printer *, gimple, int, int);
 241
 242 #endif /* ! GCC_DIAGNOSTIC_H */