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