1 /* Various declarations for language-independent diagnostics subroutines.
2 Copyright (C) 2000-2014 Free Software Foundation, Inc.
3 Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
5 This file is part of GCC.
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
9 Software Foundation; either version 3, or (at your option) any later
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
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 #ifndef GCC_DIAGNOSTIC_H
22 #define GCC_DIAGNOSTIC_H
24 #include "pretty-print.h"
25 #include "diagnostic-core.h"
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. */
30 struct diagnostic_info
34 unsigned int override_column
;
35 /* Auxiliary data for client. */
37 /* The kind of diagnostic it is about. */
39 /* Which OPT_* directly controls this diagnostic. */
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
46 struct diagnostic_classification_change_t
53 /* Forward declarations. */
54 typedef void (*diagnostic_starter_fn
) (diagnostic_context
*,
56 typedef diagnostic_starter_fn diagnostic_finalizer_fn
;
58 /* This data structure bundles altogether any information relevant to
59 the context of a diagnostic message. */
60 struct diagnostic_context
62 /* Where most of the diagnostic formatting work is done. */
63 pretty_printer
*printer
;
65 /* The number of times we have issued diagnostics. */
66 int diagnostic_count
[DK_LAST_DIAGNOSTIC_KIND
];
68 /* True if we should display the "warnings are being tread as error"
69 message, usually displayed once per compiler run. */
70 bool some_warnings_are_errors
;
72 /* True if it has been requested that warnings be treated as errors. */
73 bool warning_as_error_requested
;
75 /* The number of option indexes that can be passed to warning() et
79 /* For each option index that can be passed to warning() et al
80 (OPT_* from options.h when using this code with the core GCC
81 options), this array may contain a new kind that the diagnostic
82 should be changed to before reporting, or DK_UNSPECIFIED to leave
83 it as the reported kind, or DK_IGNORED to not report it at
85 diagnostic_t
*classify_diagnostic
;
87 /* History of all changes to the classifications above. This list
88 is stored in location-order, so we can search it, either
89 binary-wise or end-to-front, to find the most recent
90 classification for a given diagnostic, given the location of the
92 diagnostic_classification_change_t
*classification_history
;
94 /* The size of the above array. */
95 int n_classification_history
;
97 /* For pragma push/pop. */
101 /* True if we should print the source line with a caret indicating
105 /* Maximum width of the source line printed. */
108 /* Character used for caret diagnostics. */
111 /* True if we should print the command line option which controls
112 each diagnostic, if known. */
113 bool show_option_requested
;
115 /* True if we should raise a SIGABRT on errors. */
118 /* True if we should show the column number on diagnostics. */
121 /* True if pedwarns are errors. */
122 bool pedantic_errors
;
124 /* True if permerrors are warnings. */
127 /* The index of the option to associate with turning permerrors into
131 /* True if errors are fatal. */
134 /* True if all warnings should be disabled. */
135 bool dc_inhibit_warnings
;
137 /* True if warnings should be given in system headers. */
138 bool dc_warn_system_headers
;
140 /* Maximum number of errors to report. */
141 unsigned int max_errors
;
143 /* This function is called before any message is printed out. It is
144 responsible for preparing message prefix and such. For example, it
146 In file included from "/usr/local/include/curses.h:5:
147 from "/home/gdr/src/nifty_printer.h:56:
150 diagnostic_starter_fn begin_diagnostic
;
152 /* This function is called after the diagnostic message is printed. */
153 diagnostic_finalizer_fn end_diagnostic
;
155 /* Client hook to report an internal error. */
156 void (*internal_error
) (diagnostic_context
*, const char *, va_list *);
158 /* Client hook to say whether the option controlling a diagnostic is
159 enabled. Returns nonzero if enabled, zero if disabled. */
160 int (*option_enabled
) (int, void *);
162 /* Client information to pass as second argument to
166 /* Client hook to return the name of an option that controls a
167 diagnostic. Returns malloced memory. The first diagnostic_t
168 argument is the kind of diagnostic before any reclassification
169 (of warnings as errors, etc.); the second is the kind after any
170 reclassification. May return NULL if no name is to be printed.
171 May be passed 0 as well as the index of a particular option. */
172 char *(*option_name
) (diagnostic_context
*, int, diagnostic_t
, diagnostic_t
);
174 /* Auxiliary data for client. */
177 /* Used to detect that the last caret was printed at the same location. */
178 location_t last_location
;
180 /* Used to detect when the input file stack has changed since last
182 const struct line_map
*last_module
;
186 bool inhibit_notes_p
;
190 diagnostic_inhibit_notes (diagnostic_context
* context
)
192 context
->inhibit_notes_p
= true;
196 /* Client supplied function to announce a diagnostic. */
197 #define diagnostic_starter(DC) (DC)->begin_diagnostic
199 /* Client supplied function called after a diagnostic message is
201 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
203 /* Extension hooks for client. */
204 #define diagnostic_context_auxiliary_data(DC) (DC)->x_data
205 #define diagnostic_info_auxiliary_data(DI) (DI)->x_data
207 /* Same as pp_format_decoder. Works on 'diagnostic_context *'. */
208 #define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder)
210 /* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */
211 #define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule)
213 /* Maximum characters per line in automatic line wrapping mode.
214 Zero means don't wrap lines. */
215 #define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
217 #define diagnostic_flush_buffer(DC) pp_flush ((DC)->printer)
219 /* True if the last module or file in which a diagnostic was reported is
220 different from the current one. */
221 #define diagnostic_last_module_changed(DC, MAP) \
222 ((DC)->last_module != MAP)
224 /* Remember the current module or file as being the last one in which we
225 report a diagnostic. */
226 #define diagnostic_set_last_module(DC, MAP) \
227 (DC)->last_module = MAP
229 /* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher. */
230 #define diagnostic_abort_on_error(DC) \
231 (DC)->abort_on_error = true
233 /* This diagnostic_context is used by front-ends that directly output
234 diagnostic messages without going through `error', `warning',
235 and similar functions. */
236 extern diagnostic_context
*global_dc
;
238 /* The total count of a KIND of diagnostics emitted so far. */
239 #define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
241 /* The number of errors that have been issued so far. Ideally, these
242 would take a diagnostic_context as an argument. */
243 #define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
244 /* Similarly, but for warnings. */
245 #define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
246 /* Similarly, but for warnings promoted to errors. */
247 #define werrorcount diagnostic_kind_count (global_dc, DK_WERROR)
248 /* Similarly, but for sorrys. */
249 #define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
251 /* Returns nonzero if warnings should be emitted. */
252 #define diagnostic_report_warnings_p(DC, LOC) \
253 (!(DC)->dc_inhibit_warnings \
254 && !(in_system_header_at (LOC) && !(DC)->dc_warn_system_headers))
256 #define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
258 /* Override the column number to be used for reporting a
260 #define diagnostic_override_column(DI, COL) (DI)->override_column = (COL)
262 /* Override the option index to be used for reporting a
264 #define diagnostic_override_option_index(DI, OPTIDX) \
265 ((DI)->option_index = (OPTIDX))
267 /* Diagnostic related functions. */
268 extern void diagnostic_initialize (diagnostic_context
*, int);
269 extern void diagnostic_color_init (diagnostic_context
*, int value
= -1);
270 extern void diagnostic_finish (diagnostic_context
*);
271 extern void diagnostic_report_current_module (diagnostic_context
*, location_t
);
272 extern void diagnostic_show_locus (diagnostic_context
*, const diagnostic_info
*);
274 /* Force diagnostics controlled by OPTIDX to be kind KIND. */
275 extern diagnostic_t
diagnostic_classify_diagnostic (diagnostic_context
*,
277 diagnostic_t
/* kind */,
279 extern void diagnostic_push_diagnostics (diagnostic_context
*, location_t
);
280 extern void diagnostic_pop_diagnostics (diagnostic_context
*, location_t
);
281 extern bool diagnostic_report_diagnostic (diagnostic_context
*,
283 #ifdef ATTRIBUTE_GCC_DIAG
284 extern void diagnostic_set_info (diagnostic_info
*, const char *, va_list *,
285 location_t
, diagnostic_t
) ATTRIBUTE_GCC_DIAG(2,0);
286 extern void diagnostic_set_info_translated (diagnostic_info
*, const char *,
287 va_list *, location_t
,
289 ATTRIBUTE_GCC_DIAG(2,0);
290 extern void diagnostic_append_note (diagnostic_context
*, location_t
,
291 const char *, ...) ATTRIBUTE_GCC_DIAG(3,4);
293 extern char *diagnostic_build_prefix (diagnostic_context
*, const diagnostic_info
*);
294 void default_diagnostic_starter (diagnostic_context
*, diagnostic_info
*);
295 void default_diagnostic_finalizer (diagnostic_context
*, diagnostic_info
*);
296 void diagnostic_set_caret_max_width (diagnostic_context
*context
, int value
);
297 void diagnostic_action_after_output (diagnostic_context
*, diagnostic_t
);
299 void diagnostic_file_cache_fini (void);
301 int get_terminal_width (void);
303 /* Expand the location of this diagnostic. Use this function for consistency. */
305 static inline expanded_location
306 diagnostic_expand_location (const diagnostic_info
* diagnostic
)
309 = expand_location_to_spelling_point (diagnostic
->location
);
310 if (diagnostic
->override_column
)
311 s
.column
= diagnostic
->override_column
;
315 /* Pure text formatting support functions. */
316 extern char *file_name_as_prefix (diagnostic_context
*, const char *);
318 extern char *build_message_string (const char *, ...) ATTRIBUTE_PRINTF_1
;
321 #endif /* ! GCC_DIAGNOSTIC_H */