gcc/diagnostic.h

   1 /* Various declarations for language-independent diagnostics subroutines.
   2    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006
   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 2, 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 COPYING.  If not, write to the Free
  20 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  21 02110-1301, USA.  */
  22
  23 #ifndef GCC_DIAGNOSTIC_H
  24 #define GCC_DIAGNOSTIC_H
  25
  26 #include "pretty-print.h"
  27 #include "options.h"
  28
  29 /* Constants used to discriminate diagnostics.  */
  30 typedef enum
  31 {
  32 #define DEFINE_DIAGNOSTIC_KIND(K, msgid) K,
  33 #include "diagnostic.def"
  34 #undef DEFINE_DIAGNOSTIC_KIND
  35   DK_LAST_DIAGNOSTIC_KIND
  36 } diagnostic_t;
  37
  38 /* A diagnostic is described by the MESSAGE to send, the FILE and LINE of
  39    its context and its KIND (ice, error, warning, note, ...)  See complete
  40    list in diagnostic.def.  */
  41 typedef struct
  42 {
  43   text_info message;
  44   location_t location;
  45   /* The kind of diagnostic it is about.  */
  46   diagnostic_t kind;
  47   /* Which OPT_* directly controls this diagnostic.  */
  48   int option_index;
  49 } diagnostic_info;
  50
  51 #define pedantic_error_kind() (flag_pedantic_errors ? DK_ERROR : DK_WARNING)
  52
  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   char 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 input_file_stack has changed since last described.  */
 112   int last_module;
 113
 114   int lock;
 115 };
 116
 117 /* Client supplied function to announce a diagnostic.  */
 118 #define diagnostic_starter(DC) (DC)->begin_diagnostic
 119
 120 /* Client supplied function called after a diagnostic message is
 121    displayed.  */
 122 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
 123
 124 /* Extension hook for client.  */
 125 #define diagnostic_auxiliary_data(DC) (DC)->x_data
 126
 127 /* Same as pp_format_decoder.  Works on 'diagnostic_context *'.  */
 128 #define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder)
 129
 130 /* Same as output_prefixing_rule.  Works on 'diagnostic_context *'.  */
 131 #define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule)
 132
 133 /* Maximum characters per line in automatic line wrapping mode.
 134    Zero means don't wrap lines.  */
 135 #define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
 136
 137 #define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer)
 138
 139 /* True if the last function in which a diagnostic was reported is
 140    different from the current one.  */
 141 #define diagnostic_last_function_changed(DC) \
 142   ((DC)->last_function != current_function_decl)
 143
 144 /* Remember the current function as being the last one in which we report
 145    a diagnostic.  */
 146 #define diagnostic_set_last_function(DC) \
 147   (DC)->last_function = current_function_decl
 148
 149 /* True if the last module or file in which a diagnostic was reported is
 150    different from the current one.  */
 151 #define diagnostic_last_module_changed(DC) \
 152   ((DC)->last_module != input_file_stack_tick)
 153
 154 /* Remember the current module or file as being the last one in which we
 155    report a diagnostic.  */
 156 #define diagnostic_set_last_module(DC) \
 157   (DC)->last_module = input_file_stack_tick
 158
 159 /* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher.  */
 160 #define diagnostic_abort_on_error(DC) \
 161   (DC)->abort_on_error = true
 162
 163 /* This diagnostic_context is used by front-ends that directly output
 164    diagnostic messages without going through `error', `warning',
 165    and similar functions.  */
 166 extern diagnostic_context *global_dc;
 167
 168 /* The total count of a KIND of diagnostics emitted so far.  */
 169 #define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
 170
 171 /* The number of errors that have been issued so far.  Ideally, these
 172    would take a diagnostic_context as an argument.  */
 173 #define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
 174 /* Similarly, but for warnings.  */
 175 #define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
 176 /* Similarly, but for sorrys.  */
 177 #define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
 178
 179 /* Returns nonzero if warnings should be emitted.  */
 180 #define diagnostic_report_warnings_p()                  \
 181   (!inhibit_warnings                                    \
 182    && !(in_system_header && !warn_system_headers))
 183
 184 #define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
 185
 186 /* Diagnostic related functions.  */
 187 extern void diagnostic_initialize (diagnostic_context *);
 188 extern void diagnostic_report_current_module (diagnostic_context *);
 189 extern void diagnostic_report_current_function (diagnostic_context *);
 190
 191 /* Force diagnostics controlled by OPTIDX to be kind KIND.  */
 192 extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *,
 193                                                     int /* optidx */,
 194                                                     diagnostic_t /* kind */);
 195 extern void diagnostic_report_diagnostic (diagnostic_context *,
 196                                           diagnostic_info *);
 197 #ifdef ATTRIBUTE_GCC_DIAG
 198 extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *,
 199                                  location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0);
 200 extern void diagnostic_set_info_translated (diagnostic_info *, const char *,
 201                                             va_list *, location_t,
 202                                             diagnostic_t)
 203      ATTRIBUTE_GCC_DIAG(2,0);
 204 #endif
 205 extern char *diagnostic_build_prefix (diagnostic_info *);
 206
 207 /* Pure text formatting support functions.  */
 208 extern char *file_name_as_prefix (const char *);
 209
 210 /* In tree-pretty-print.c  */
 211 extern int dump_generic_node (pretty_printer *, tree, int, int, bool);
 212 extern void print_generic_stmt (FILE *, tree, int);
 213 extern void print_generic_stmt_indented (FILE *, tree, int, int);
 214 extern void print_generic_expr (FILE *, tree, int);
 215 extern void print_generic_decl (FILE *, tree, int);
 216
 217 extern void debug_generic_expr (tree);
 218 extern void debug_generic_stmt (tree);
 219 extern void debug_tree_chain (tree);
 220 extern void debug_c_tree (tree);
 221 #endif /* ! GCC_DIAGNOSTIC_H */