1/* Various declarations for language-independent diagnostics subroutines. 2 Copyright (C) 2000-2015 Free Software Foundation, Inc. 3 Contributed by Gabriel Dos Reis <gdr@codesourcery.com> 4 5This file is part of GCC. 6 7GCC is free software; you can redistribute it and/or modify it under 8the terms of the GNU General Public License as published by the Free 9Software Foundation; either version 3, or (at your option) any later 10version. 11 12GCC is distributed in the hope that it will be useful, but WITHOUT ANY 13WARRANTY; without even the implied warranty of MERCHANTABILITY or 14FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 15for more details. 16 17You should have received a copy of the GNU General Public License 18along with GCC; see the file COPYING3. If not see 19<http://www.gnu.org/licenses/>. */ 20 21#ifndef GCC_DIAGNOSTIC_H 22#define GCC_DIAGNOSTIC_H 23 24#include "pretty-print.h" 25#include "diagnostic-core.h" 26 27/* A diagnostic is described by the MESSAGE to send, the FILE and LINE of 28 its context and its KIND (ice, error, warning, note, ...) See complete 29 list in diagnostic.def. */ 30struct diagnostic_info 31{ 32 text_info message; 33 location_t location; 34 unsigned int override_column; 35 /* Auxiliary data for client. */ 36 void *x_data; 37 /* The kind of diagnostic it is about. */ 38 diagnostic_t kind; 39 /* Which OPT_* directly controls this diagnostic. */ 40 int option_index; 41}; 42 43/* Each time a diagnostic's classification is changed with a pragma, 44 we record the change and the location of the change in an array of 45 these structs. */ 46struct diagnostic_classification_change_t 47{ 48 location_t location; 49 int option; 50 diagnostic_t kind; 51}; 52 53/* Forward declarations. */ 54typedef void (*diagnostic_starter_fn) (diagnostic_context *, 55 diagnostic_info *); 56typedef diagnostic_starter_fn diagnostic_finalizer_fn; 57 58/* This data structure bundles altogether any information relevant to 59 the context of a diagnostic message. */ 60struct diagnostic_context 61{ 62 /* Where most of the diagnostic formatting work is done. */ 63 pretty_printer *printer; 64 65 /* The number of times we have issued diagnostics. */ 66 int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND]; 67 68 /* True if it has been requested that warnings be treated as errors. */ 69 bool warning_as_error_requested; 70 71 /* The number of option indexes that can be passed to warning() et 72 al. */ 73 int n_opts; 74 75 /* For each option index that can be passed to warning() et al 76 (OPT_* from options.h when using this code with the core GCC 77 options), this array may contain a new kind that the diagnostic 78 should be changed to before reporting, or DK_UNSPECIFIED to leave 79 it as the reported kind, or DK_IGNORED to not report it at 80 all. */ 81 diagnostic_t *classify_diagnostic; 82 83 /* History of all changes to the classifications above. This list 84 is stored in location-order, so we can search it, either 85 binary-wise or end-to-front, to find the most recent 86 classification for a given diagnostic, given the location of the 87 diagnostic. */ 88 diagnostic_classification_change_t *classification_history; 89 90 /* The size of the above array. */ 91 int n_classification_history; 92 93 /* For pragma push/pop. */ 94 int *push_list; 95 int n_push; 96 97 /* True if we should print the source line with a caret indicating 98 the location. */ 99 bool show_caret; 100 101 /* Maximum width of the source line printed. */ 102 int caret_max_width; 103 104 /* Character used for caret diagnostics. */ 105 char caret_char; 106 107 /* True if we should print the command line option which controls 108 each diagnostic, if known. */ 109 bool show_option_requested; 110 111 /* True if we should raise a SIGABRT on errors. */ 112 bool abort_on_error; 113 114 /* True if we should show the column number on diagnostics. */ 115 bool show_column; 116 117 /* True if pedwarns are errors. */ 118 bool pedantic_errors; 119 120 /* True if permerrors are warnings. */ 121 bool permissive; 122 123 /* The index of the option to associate with turning permerrors into 124 warnings. */ 125 int opt_permissive; 126 127 /* True if errors are fatal. */ 128 bool fatal_errors; 129 130 /* True if all warnings should be disabled. */ 131 bool dc_inhibit_warnings; 132 133 /* True if warnings should be given in system headers. */ 134 bool dc_warn_system_headers; 135 136 /* Maximum number of errors to report. */ 137 unsigned int max_errors; 138 139 /* This function is called before any message is printed out. It is 140 responsible for preparing message prefix and such. For example, it 141 might say: 142 In file included from "/usr/local/include/curses.h:5: 143 from "/home/gdr/src/nifty_printer.h:56: 144 ... 145 */ 146 diagnostic_starter_fn begin_diagnostic; 147 148 /* This function is called after the diagnostic message is printed. */ 149 diagnostic_finalizer_fn end_diagnostic; 150 151 /* Client hook to report an internal error. */ 152 void (*internal_error) (diagnostic_context *, const char *, va_list *); 153 154 /* Client hook to say whether the option controlling a diagnostic is 155 enabled. Returns nonzero if enabled, zero if disabled. */ 156 int (*option_enabled) (int, void *); 157 158 /* Client information to pass as second argument to 159 option_enabled. */ 160 void *option_state; 161 162 /* Client hook to return the name of an option that controls a 163 diagnostic. Returns malloced memory. The first diagnostic_t 164 argument is the kind of diagnostic before any reclassification 165 (of warnings as errors, etc.); the second is the kind after any 166 reclassification. May return NULL if no name is to be printed. 167 May be passed 0 as well as the index of a particular option. */ 168 char *(*option_name) (diagnostic_context *, int, diagnostic_t, diagnostic_t); 169 170 /* Auxiliary data for client. */ 171 void *x_data; 172 173 /* Used to detect that the last caret was printed at the same location. */ 174 location_t last_location; 175 176 /* Used to detect when the input file stack has changed since last 177 described. */ 178 const struct line_map *last_module; 179 180 int lock; 181 182 bool inhibit_notes_p; 183}; 184 185static inline void 186diagnostic_inhibit_notes (diagnostic_context * context) 187{ 188 context->inhibit_notes_p = true; 189} 190 191 192/* Client supplied function to announce a diagnostic. */ 193#define diagnostic_starter(DC) (DC)->begin_diagnostic 194 195/* Client supplied function called after a diagnostic message is 196 displayed. */ 197#define diagnostic_finalizer(DC) (DC)->end_diagnostic 198 199/* Extension hooks for client. */ 200#define diagnostic_context_auxiliary_data(DC) (DC)->x_data 201#define diagnostic_info_auxiliary_data(DI) (DI)->x_data 202 203/* Same as pp_format_decoder. Works on 'diagnostic_context *'. */ 204#define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder) 205 206/* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */ 207#define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule) 208 209/* Maximum characters per line in automatic line wrapping mode. 210 Zero means don't wrap lines. */ 211#define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff) 212 213#define diagnostic_flush_buffer(DC) pp_flush ((DC)->printer) 214 215/* True if the last module or file in which a diagnostic was reported is 216 different from the current one. */ 217#define diagnostic_last_module_changed(DC, MAP) \ 218 ((DC)->last_module != MAP) 219 220/* Remember the current module or file as being the last one in which we 221 report a diagnostic. */ 222#define diagnostic_set_last_module(DC, MAP) \ 223 (DC)->last_module = MAP 224 225/* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher. */ 226#define diagnostic_abort_on_error(DC) \ 227 (DC)->abort_on_error = true 228 229/* This diagnostic_context is used by front-ends that directly output 230 diagnostic messages without going through `error', `warning', 231 and similar functions. */ 232extern diagnostic_context *global_dc; 233 234/* The total count of a KIND of diagnostics emitted so far. */ 235#define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)] 236 237/* The number of errors that have been issued so far. Ideally, these 238 would take a diagnostic_context as an argument. */ 239#define errorcount diagnostic_kind_count (global_dc, DK_ERROR) 240/* Similarly, but for warnings. */ 241#define warningcount diagnostic_kind_count (global_dc, DK_WARNING) 242/* Similarly, but for warnings promoted to errors. */ 243#define werrorcount diagnostic_kind_count (global_dc, DK_WERROR) 244/* Similarly, but for sorrys. */ 245#define sorrycount diagnostic_kind_count (global_dc, DK_SORRY) 246 247/* Returns nonzero if warnings should be emitted. */ 248#define diagnostic_report_warnings_p(DC, LOC) \ 249 (!(DC)->dc_inhibit_warnings \ 250 && !(in_system_header_at (LOC) && !(DC)->dc_warn_system_headers)) 251 252#define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D) 253 254/* Override the column number to be used for reporting a 255 diagnostic. */ 256#define diagnostic_override_column(DI, COL) (DI)->override_column = (COL) 257 258/* Override the option index to be used for reporting a 259 diagnostic. */ 260#define diagnostic_override_option_index(DI, OPTIDX) \ 261 ((DI)->option_index = (OPTIDX)) 262 263/* Diagnostic related functions. */ 264extern void diagnostic_initialize (diagnostic_context *, int); 265extern void diagnostic_color_init (diagnostic_context *, int value = -1); 266extern void diagnostic_finish (diagnostic_context *); 267extern void diagnostic_report_current_module (diagnostic_context *, location_t); 268extern void diagnostic_show_locus (diagnostic_context *, const diagnostic_info *); 269 270/* Force diagnostics controlled by OPTIDX to be kind KIND. */ 271extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *, 272 int /* optidx */, 273 diagnostic_t /* kind */, 274 location_t); 275extern void diagnostic_push_diagnostics (diagnostic_context *, location_t); 276extern void diagnostic_pop_diagnostics (diagnostic_context *, location_t); 277extern bool diagnostic_report_diagnostic (diagnostic_context *, 278 diagnostic_info *); 279#ifdef ATTRIBUTE_GCC_DIAG 280extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *, 281 location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0); 282extern void diagnostic_set_info_translated (diagnostic_info *, const char *, 283 va_list *, location_t, 284 diagnostic_t) 285 ATTRIBUTE_GCC_DIAG(2,0); 286extern void diagnostic_append_note (diagnostic_context *, location_t, 287 const char *, ...) ATTRIBUTE_GCC_DIAG(3,4); 288#endif 289extern char *diagnostic_build_prefix (diagnostic_context *, const diagnostic_info *); 290void default_diagnostic_starter (diagnostic_context *, diagnostic_info *); 291void default_diagnostic_finalizer (diagnostic_context *, diagnostic_info *); 292void diagnostic_set_caret_max_width (diagnostic_context *context, int value); 293void diagnostic_action_after_output (diagnostic_context *, diagnostic_t); 294 295void diagnostic_file_cache_fini (void); 296 297int get_terminal_width (void); 298 299/* Expand the location of this diagnostic. Use this function for consistency. */ 300 301static inline expanded_location 302diagnostic_expand_location (const diagnostic_info * diagnostic) 303{ 304 expanded_location s 305 = expand_location_to_spelling_point (diagnostic->location); 306 if (diagnostic->override_column) 307 s.column = diagnostic->override_column; 308 return s; 309} 310 311/* Pure text formatting support functions. */ 312extern char *file_name_as_prefix (diagnostic_context *, const char *); 313 314extern char *build_message_string (const char *, ...) ATTRIBUTE_PRINTF_1; 315 316 317#endif /* ! GCC_DIAGNOSTIC_H */ 318