]>
Commit | Line | Data |
---|---|---|
993ca5a5 | 1 | /* Various declarations for language-independent diagnostics subroutines. |
8e8f6434 | 2 | Copyright (C) 2000-2018 Free Software Foundation, Inc. |
993ca5a5 | 3 | Contributed by Gabriel Dos Reis <gdr@codesourcery.com> |
4 | ||
f12b58b3 | 5 | This file is part of GCC. |
993ca5a5 | 6 | |
f12b58b3 | 7 | GCC is free software; you can redistribute it and/or modify it under |
8 | the terms of the GNU General Public License as published by the Free | |
8c4c00c1 | 9 | Software Foundation; either version 3, or (at your option) any later |
f12b58b3 | 10 | version. |
993ca5a5 | 11 | |
f12b58b3 | 12 | GCC is distributed in the hope that it will be useful, but WITHOUT ANY |
13 | WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 | for more details. | |
993ca5a5 | 16 | |
17 | You should have received a copy of the GNU General Public License | |
8c4c00c1 | 18 | along with GCC; see the file COPYING3. If not see |
19 | <http://www.gnu.org/licenses/>. */ | |
993ca5a5 | 20 | |
2a281353 | 21 | #ifndef GCC_DIAGNOSTIC_H |
22 | #define GCC_DIAGNOSTIC_H | |
993ca5a5 | 23 | |
aa6db498 | 24 | #include "pretty-print.h" |
852f689e | 25 | #include "diagnostic-core.h" |
79bef68a | 26 | |
1bcc5c64 | 27 | /* Enum for overriding the standard output format. */ |
28 | ||
29 | enum diagnostics_output_format | |
30 | { | |
31 | /* The default: textual output. */ | |
32 | DIAGNOSTICS_OUTPUT_FORMAT_TEXT, | |
33 | ||
34 | /* JSON-based output. */ | |
35 | DIAGNOSTICS_OUTPUT_FORMAT_JSON | |
36 | }; | |
37 | ||
25e2ffe1 | 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. */ | |
b3e7c666 | 41 | struct diagnostic_info |
25e2ffe1 | 42 | { |
f0479000 | 43 | /* Text to be formatted. */ |
25e2ffe1 | 44 | text_info message; |
f0479000 | 45 | |
46 | /* The location at which the diagnostic is to be reported. */ | |
47 | rich_location *richloc; | |
48 | ||
ce084dfc | 49 | /* Auxiliary data for client. */ |
50 | void *x_data; | |
25e2ffe1 | 51 | /* The kind of diagnostic it is about. */ |
52 | diagnostic_t kind; | |
efb9d9ee | 53 | /* Which OPT_* directly controls this diagnostic. */ |
54 | int option_index; | |
b3e7c666 | 55 | }; |
25e2ffe1 | 56 | |
0955be65 | 57 | /* Each time a diagnostic's classification is changed with a pragma, |
58 | we record the change and the location of the change in an array of | |
59 | these structs. */ | |
b3e7c666 | 60 | struct diagnostic_classification_change_t |
0955be65 | 61 | { |
62 | location_t location; | |
63 | int option; | |
64 | diagnostic_t kind; | |
b3e7c666 | 65 | }; |
0955be65 | 66 | |
25e2ffe1 | 67 | /* Forward declarations. */ |
d598ad0d | 68 | typedef void (*diagnostic_starter_fn) (diagnostic_context *, |
69 | diagnostic_info *); | |
aec1f4bd | 70 | |
71 | typedef void (*diagnostic_start_span_fn) (diagnostic_context *, | |
72 | expanded_location); | |
73 | ||
1bcc5c64 | 74 | typedef void (*diagnostic_finalizer_fn) (diagnostic_context *, |
75 | diagnostic_info *, | |
76 | diagnostic_t); | |
25e2ffe1 | 77 | |
40a431fa | 78 | class edit_context; |
79 | ||
b52baaa6 | 80 | /* This data structure bundles altogether any information relevant to |
92d99247 | 81 | the context of a diagnostic message. */ |
82 | struct diagnostic_context | |
83 | { | |
ca1fae79 | 84 | /* Where most of the diagnostic formatting work is done. */ |
aa6db498 | 85 | pretty_printer *printer; |
ce601f29 | 86 | |
5397e5a3 | 87 | /* The number of times we have issued diagnostics. */ |
88 | int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND]; | |
89 | ||
096f40ca | 90 | /* True if it has been requested that warnings be treated as errors. */ |
91 | bool warning_as_error_requested; | |
a787dd05 | 92 | |
3c6a9715 | 93 | /* The number of option indexes that can be passed to warning() et |
94 | al. */ | |
95 | int n_opts; | |
96 | ||
97 | /* For each option index that can be passed to warning() et al | |
98 | (OPT_* from options.h when using this code with the core GCC | |
99 | options), this array may contain a new kind that the diagnostic | |
100 | should be changed to before reporting, or DK_UNSPECIFIED to leave | |
101 | it as the reported kind, or DK_IGNORED to not report it at | |
102 | all. */ | |
103 | diagnostic_t *classify_diagnostic; | |
76f02516 | 104 | |
0955be65 | 105 | /* History of all changes to the classifications above. This list |
106 | is stored in location-order, so we can search it, either | |
107 | binary-wise or end-to-front, to find the most recent | |
108 | classification for a given diagnostic, given the location of the | |
109 | diagnostic. */ | |
110 | diagnostic_classification_change_t *classification_history; | |
111 | ||
112 | /* The size of the above array. */ | |
113 | int n_classification_history; | |
114 | ||
115 | /* For pragma push/pop. */ | |
116 | int *push_list; | |
117 | int n_push; | |
118 | ||
5a983084 | 119 | /* True if we should print the source line with a caret indicating |
120 | the location. */ | |
121 | bool show_caret; | |
122 | ||
123 | /* Maximum width of the source line printed. */ | |
124 | int caret_max_width; | |
125 | ||
f0479000 | 126 | /* Character used for caret diagnostics. */ |
d6dd1b60 | 127 | char caret_chars[rich_location::STATICALLY_ALLOCATED_RANGES]; |
d19fa562 | 128 | |
b0932b2f | 129 | /* True if we should print the command line option which controls |
130 | each diagnostic, if known. */ | |
131 | bool show_option_requested; | |
132 | ||
5f07bab0 | 133 | /* True if we should raise a SIGABRT on errors. */ |
134 | bool abort_on_error; | |
135 | ||
2c2efebb | 136 | /* True if we should show the column number on diagnostics. */ |
137 | bool show_column; | |
138 | ||
139 | /* True if pedwarns are errors. */ | |
140 | bool pedantic_errors; | |
141 | ||
142 | /* True if permerrors are warnings. */ | |
143 | bool permissive; | |
144 | ||
3c6a9715 | 145 | /* The index of the option to associate with turning permerrors into |
146 | warnings. */ | |
147 | int opt_permissive; | |
148 | ||
2c2efebb | 149 | /* True if errors are fatal. */ |
150 | bool fatal_errors; | |
151 | ||
3c6a9715 | 152 | /* True if all warnings should be disabled. */ |
5ae82d58 | 153 | bool dc_inhibit_warnings; |
3c6a9715 | 154 | |
155 | /* True if warnings should be given in system headers. */ | |
5ae82d58 | 156 | bool dc_warn_system_headers; |
3c6a9715 | 157 | |
566d7c74 | 158 | /* Maximum number of errors to report. */ |
bd257a76 | 159 | int max_errors; |
566d7c74 | 160 | |
92d99247 | 161 | /* This function is called before any message is printed out. It is |
b52baaa6 | 162 | responsible for preparing message prefix and such. For example, it |
92d99247 | 163 | might say: |
164 | In file included from "/usr/local/include/curses.h:5: | |
165 | from "/home/gdr/src/nifty_printer.h:56: | |
166 | ... | |
167 | */ | |
25e2ffe1 | 168 | diagnostic_starter_fn begin_diagnostic; |
92d99247 | 169 | |
aec1f4bd | 170 | /* This function is called by diagnostic_show_locus in between |
171 | disjoint spans of source code, so that the context can print | |
172 | something to indicate that a new span of source code has begun. */ | |
173 | diagnostic_start_span_fn start_span; | |
174 | ||
a7dce381 | 175 | /* This function is called after the diagnostic message is printed. */ |
25e2ffe1 | 176 | diagnostic_finalizer_fn end_diagnostic; |
92d99247 | 177 | |
c003992a | 178 | /* Client hook to report an internal error. */ |
1f63d337 | 179 | void (*internal_error) (diagnostic_context *, const char *, va_list *); |
c003992a | 180 | |
3c6a9715 | 181 | /* Client hook to say whether the option controlling a diagnostic is |
182 | enabled. Returns nonzero if enabled, zero if disabled. */ | |
2c5d2e39 | 183 | int (*option_enabled) (int, void *); |
184 | ||
185 | /* Client information to pass as second argument to | |
186 | option_enabled. */ | |
187 | void *option_state; | |
3c6a9715 | 188 | |
189 | /* Client hook to return the name of an option that controls a | |
190 | diagnostic. Returns malloced memory. The first diagnostic_t | |
191 | argument is the kind of diagnostic before any reclassification | |
192 | (of warnings as errors, etc.); the second is the kind after any | |
193 | reclassification. May return NULL if no name is to be printed. | |
194 | May be passed 0 as well as the index of a particular option. */ | |
195 | char *(*option_name) (diagnostic_context *, int, diagnostic_t, diagnostic_t); | |
196 | ||
ce084dfc | 197 | /* Auxiliary data for client. */ |
198 | void *x_data; | |
25e2ffe1 | 199 | |
d834564a | 200 | /* Used to detect that the last caret was printed at the same location. */ |
201 | location_t last_location; | |
202 | ||
26cb3d1c | 203 | /* Used to detect when the input file stack has changed since last |
204 | described. */ | |
29c64b33 | 205 | const line_map_ordinary *last_module; |
25e2ffe1 | 206 | |
207 | int lock; | |
16b4d5bb | 208 | |
209 | bool inhibit_notes_p; | |
f0479000 | 210 | |
211 | /* When printing source code, should the characters at carets and ranges | |
212 | be colorized? (assuming colorization is on at all). | |
213 | This should be true for frontends that generate range information | |
214 | (so that the ranges of code are colorized), | |
215 | and false for frontends that merely specify points within the | |
216 | source code (to avoid e.g. colorizing just the first character in | |
217 | a token, which would look strange). */ | |
218 | bool colorize_source_p; | |
abf93a25 | 219 | |
b7bb5264 | 220 | /* When printing source code, should labelled ranges be printed? */ |
221 | bool show_labels_p; | |
222 | ||
ff7410b8 | 223 | /* When printing source code, should there be a left-hand margin |
224 | showing line numbers? */ | |
225 | bool show_line_numbers_p; | |
226 | ||
31087b7e | 227 | /* If printing source code, what should the minimum width of the margin |
228 | be? Line numbers will be right-aligned, and padded to this width. */ | |
229 | int min_margin_width; | |
230 | ||
abf93a25 | 231 | /* Usable by plugins; if true, print a debugging ruler above the |
232 | source output. */ | |
233 | bool show_ruler_p; | |
6628b04d | 234 | |
235 | /* If true, print fixits in machine-parseable form after the | |
236 | rest of the diagnostic. */ | |
237 | bool parseable_fixits_p; | |
40a431fa | 238 | |
239 | /* If non-NULL, an edit_context to which fix-it hints should be | |
240 | applied, for generating patches. */ | |
241 | edit_context *edit_context_ptr; | |
bc35ef65 | 242 | |
243 | /* How many diagnostic_group instances are currently alive. */ | |
244 | int diagnostic_group_nesting_depth; | |
245 | ||
246 | /* How many diagnostics have been emitted since the bottommost | |
247 | diagnostic_group was pushed. */ | |
248 | int diagnostic_group_emission_count; | |
249 | ||
250 | /* Optional callbacks for handling diagnostic groups. */ | |
251 | ||
252 | /* If non-NULL, this will be called immediately before the first | |
253 | time a diagnostic is emitted within a stack of groups. */ | |
254 | void (*begin_group_cb) (diagnostic_context * context); | |
255 | ||
256 | /* If non-NULL, this will be called when a stack of groups is | |
257 | popped if any diagnostics were emitted within that group. */ | |
258 | void (*end_group_cb) (diagnostic_context * context); | |
1bcc5c64 | 259 | |
260 | /* Callback for final cleanup. */ | |
261 | void (*final_cb) (diagnostic_context *context); | |
92d99247 | 262 | }; |
263 | ||
16b4d5bb | 264 | static inline void |
265 | diagnostic_inhibit_notes (diagnostic_context * context) | |
266 | { | |
267 | context->inhibit_notes_p = true; | |
268 | } | |
269 | ||
270 | ||
910f6d8f | 271 | /* Client supplied function to announce a diagnostic. */ |
92d99247 | 272 | #define diagnostic_starter(DC) (DC)->begin_diagnostic |
910f6d8f | 273 | |
274 | /* Client supplied function called after a diagnostic message is | |
275 | displayed. */ | |
92d99247 | 276 | #define diagnostic_finalizer(DC) (DC)->end_diagnostic |
910f6d8f | 277 | |
ce084dfc | 278 | /* Extension hooks for client. */ |
279 | #define diagnostic_context_auxiliary_data(DC) (DC)->x_data | |
280 | #define diagnostic_info_auxiliary_data(DI) (DI)->x_data | |
910f6d8f | 281 | |
aa6db498 | 282 | /* Same as pp_format_decoder. Works on 'diagnostic_context *'. */ |
0de2b732 | 283 | #define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder) |
910f6d8f | 284 | |
06c7407c | 285 | /* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */ |
c907c5b1 | 286 | #define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule) |
92d99247 | 287 | |
5f07bab0 | 288 | /* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher. */ |
289 | #define diagnostic_abort_on_error(DC) \ | |
290 | (DC)->abort_on_error = true | |
291 | ||
5397e5a3 | 292 | /* This diagnostic_context is used by front-ends that directly output |
990339dd | 293 | diagnostic messages without going through `error', `warning', |
910f6d8f | 294 | and similar functions. */ |
ce601f29 | 295 | extern diagnostic_context *global_dc; |
990339dd | 296 | |
03aa8ad7 | 297 | /* Returns whether the diagnostic framework has been intialized already and is |
298 | ready for use. */ | |
299 | #define diagnostic_ready_p() (global_dc->printer != NULL) | |
300 | ||
5f07bab0 | 301 | /* The total count of a KIND of diagnostics emitted so far. */ |
5397e5a3 | 302 | #define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)] |
a587b03b | 303 | |
304 | /* The number of errors that have been issued so far. Ideally, these | |
5397e5a3 | 305 | would take a diagnostic_context as an argument. */ |
910f6d8f | 306 | #define errorcount diagnostic_kind_count (global_dc, DK_ERROR) |
a587b03b | 307 | /* Similarly, but for warnings. */ |
910f6d8f | 308 | #define warningcount diagnostic_kind_count (global_dc, DK_WARNING) |
d9d1b0a4 | 309 | /* Similarly, but for warnings promoted to errors. */ |
310 | #define werrorcount diagnostic_kind_count (global_dc, DK_WERROR) | |
a587b03b | 311 | /* Similarly, but for sorrys. */ |
910f6d8f | 312 | #define sorrycount diagnostic_kind_count (global_dc, DK_SORRY) |
a587b03b | 313 | |
6ef828f9 | 314 | /* Returns nonzero if warnings should be emitted. */ |
3c6a9715 | 315 | #define diagnostic_report_warnings_p(DC, LOC) \ |
5ae82d58 | 316 | (!(DC)->dc_inhibit_warnings \ |
317 | && !(in_system_header_at (LOC) && !(DC)->dc_warn_system_headers)) | |
a587b03b | 318 | |
3a79f5da | 319 | /* Override the option index to be used for reporting a |
320 | diagnostic. */ | |
973683cc | 321 | |
322 | static inline void | |
323 | diagnostic_override_option_index (diagnostic_info *info, int optidx) | |
324 | { | |
325 | info->option_index = optidx; | |
326 | } | |
3a79f5da | 327 | |
d716ce75 | 328 | /* Diagnostic related functions. */ |
3c6a9715 | 329 | extern void diagnostic_initialize (diagnostic_context *, int); |
9b11544d | 330 | extern void diagnostic_color_init (diagnostic_context *, int value = -1); |
543725f3 | 331 | extern void diagnostic_finish (diagnostic_context *); |
3de02a0f | 332 | extern void diagnostic_report_current_module (diagnostic_context *, location_t); |
48a7392b | 333 | extern void diagnostic_show_locus (diagnostic_context *, |
334 | rich_location *richloc, | |
335 | diagnostic_t diagnostic_kind); | |
76f02516 | 336 | |
337 | /* Force diagnostics controlled by OPTIDX to be kind KIND. */ | |
338 | extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *, | |
339 | int /* optidx */, | |
0955be65 | 340 | diagnostic_t /* kind */, |
341 | location_t); | |
342 | extern void diagnostic_push_diagnostics (diagnostic_context *, location_t); | |
343 | extern void diagnostic_pop_diagnostics (diagnostic_context *, location_t); | |
a52d5726 | 344 | extern bool diagnostic_report_diagnostic (diagnostic_context *, |
d598ad0d | 345 | diagnostic_info *); |
58ec857b | 346 | #ifdef ATTRIBUTE_GCC_DIAG |
d598ad0d | 347 | extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *, |
f0479000 | 348 | rich_location *, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0); |
eb0d20b7 | 349 | extern void diagnostic_set_info_translated (diagnostic_info *, const char *, |
f0479000 | 350 | va_list *, rich_location *, |
eb0d20b7 | 351 | diagnostic_t) |
352 | ATTRIBUTE_GCC_DIAG(2,0); | |
ff213692 | 353 | extern void diagnostic_append_note (diagnostic_context *, location_t, |
354 | const char *, ...) ATTRIBUTE_GCC_DIAG(3,4); | |
58ec857b | 355 | #endif |
ff213692 | 356 | extern char *diagnostic_build_prefix (diagnostic_context *, const diagnostic_info *); |
34e5cced | 357 | void default_diagnostic_starter (diagnostic_context *, diagnostic_info *); |
aec1f4bd | 358 | void default_diagnostic_start_span_fn (diagnostic_context *, |
359 | expanded_location); | |
1bcc5c64 | 360 | void default_diagnostic_finalizer (diagnostic_context *, diagnostic_info *, |
361 | diagnostic_t); | |
5a983084 | 362 | void diagnostic_set_caret_max_width (diagnostic_context *context, int value); |
716da296 | 363 | void diagnostic_action_after_output (diagnostic_context *, diagnostic_t); |
bd257a76 | 364 | void diagnostic_check_max_errors (diagnostic_context *, bool flush = false); |
5a983084 | 365 | |
ffc2c526 | 366 | void diagnostic_file_cache_fini (void); |
25e2ffe1 | 367 | |
de96a063 | 368 | int get_terminal_width (void); |
369 | ||
389a9009 | 370 | /* Return the location associated to this diagnostic. Parameter WHICH |
371 | specifies which location. By default, expand the first one. */ | |
372 | ||
373 | static inline location_t | |
374 | diagnostic_location (const diagnostic_info * diagnostic, int which = 0) | |
375 | { | |
376 | return diagnostic->message.get_location (which); | |
377 | } | |
378 | ||
f0479000 | 379 | /* Return the number of locations to be printed in DIAGNOSTIC. */ |
380 | ||
381 | static inline unsigned int | |
382 | diagnostic_num_locations (const diagnostic_info * diagnostic) | |
383 | { | |
384 | return diagnostic->message.m_richloc->get_num_locations (); | |
385 | } | |
386 | ||
389a9009 | 387 | /* Expand the location of this diagnostic. Use this function for |
388 | consistency. Parameter WHICH specifies which location. By default, | |
389 | expand the first one. */ | |
aa47f95a | 390 | |
391 | static inline expanded_location | |
389a9009 | 392 | diagnostic_expand_location (const diagnostic_info * diagnostic, int which = 0) |
aa47f95a | 393 | { |
83108969 | 394 | return diagnostic->richloc->get_expanded_location (which); |
aa47f95a | 395 | } |
396 | ||
389a9009 | 397 | /* This is somehow the right-side margin of a caret line, that is, we |
398 | print at least these many characters after the position pointed at | |
399 | by the caret. */ | |
bb924c86 | 400 | const int CARET_LINE_MARGIN = 10; |
389a9009 | 401 | |
402 | /* Return true if the two locations can be represented within the same | |
403 | caret line. This is used to build a prefix and also to determine | |
404 | whether to print one or two caret lines. */ | |
405 | ||
406 | static inline bool | |
407 | diagnostic_same_line (const diagnostic_context *context, | |
408 | expanded_location s1, expanded_location s2) | |
409 | { | |
410 | return s2.column && s1.line == s2.line | |
411 | && context->caret_max_width - CARET_LINE_MARGIN > abs (s1.column - s2.column); | |
412 | } | |
413 | ||
f0479000 | 414 | extern const char *diagnostic_get_color_for_kind (diagnostic_t kind); |
389a9009 | 415 | |
25e2ffe1 | 416 | /* Pure text formatting support functions. */ |
2cafe211 | 417 | extern char *file_name_as_prefix (diagnostic_context *, const char *); |
993ca5a5 | 418 | |
dc8078a3 | 419 | extern char *build_message_string (const char *, ...) ATTRIBUTE_PRINTF_1; |
420 | ||
1bcc5c64 | 421 | extern void diagnostic_output_format_init (diagnostic_context *, |
422 | enum diagnostics_output_format); | |
dc8078a3 | 423 | |
934182c6 | 424 | /* Compute the number of digits in the decimal representation of an integer. */ |
425 | extern int num_digits (int); | |
426 | ||
2a281353 | 427 | #endif /* ! GCC_DIAGNOSTIC_H */ |