1 /* Various declarations for language-independent diagnostics subroutines.
2 Copyright (C) 2000, 2001, 2002 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 2, 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 COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
22 #ifndef GCC_DIAGNOSTIC_H
23 #define GCC_DIAGNOSTIC_H
28 /* The type of a text to be formatted according a format specification
29 along with a list of things. */
32 const char *format_spec;
36 /* Contants used to discreminate diagnostics. */
39 #define DEFINE_DIAGNOSTIC_KIND(K, M) K,
40 #include "diagnostic.def"
41 #undef DEFINE_DIAGNOSTIC_KIND
42 DK_LAST_DIAGNOSTIC_KIND
45 /* A diagnostic is described by the MESSAGE to send, the FILE and LINE of
46 its context and its KIND (ice, error, warning, note, ...) See complete
47 list in diagnostic.def. */
52 /* The kind of diagnostic it is about. */
56 #define pedantic_error_kind() (flag_pedantic_errors ? DK_ERROR : DK_WARNING)
58 /* How often diagnostics are prefixed by their locations:
59 o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
60 o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit only once;
61 o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit each time a physical
65 DIAGNOSTICS_SHOW_PREFIX_ONCE = 0x0,
66 DIAGNOSTICS_SHOW_PREFIX_NEVER = 0x1,
67 DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE = 0x2
68 } diagnostic_prefixing_rule_t;
70 /* This data structure encapsulates an output_buffer's state. */
73 /* The prefix for each new line. */
76 /* The real upper bound of number of characters per line, taking into
77 account the case of a very very looong prefix. */
80 /* The ideal upper bound of number of characters per line, as suggested
82 int ideal_maximum_length;
84 /* Indentation count. */
87 /* Nonzero if current PREFIX was emitted at least once. */
88 bool emitted_prefix_p;
90 /* Nonzero means one should emit a newline before outputing anything. */
93 /* Current prefixing rule. */
94 diagnostic_prefixing_rule_t prefixing_rule;
97 /* The type of a hook that formats client-specific data (trees mostly) into
98 an output_buffer. A client-supplied formatter returns true if everything
100 typedef struct output_buffer output_buffer;
101 typedef bool (*printer_fn) PARAMS ((output_buffer *, text_info *));
103 /* The output buffer datatype. This is best seen as an abstract datatype
104 whose fields should not be accessed directly by clients. */
107 /* The current state of the buffer. */
110 /* Where to output formatted text. */
113 /* The obstack where the text is built up. */
114 struct obstack obstack;
116 /* The amount of characters output so far. */
119 /* This must be large enough to hold any printed integer or
120 floating-point value. */
121 char digit_buffer[128];
123 /* If non-NULL, this function formats a TEXT into the BUFFER. When called,
124 TEXT->format_spec points to a format code. FORMAT_DECODER should call
125 output_add_string (and related functions) to add data to the BUFFER.
126 FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG.
127 If the BUFFER needs additional characters from the format string, it
128 should advance the TEXT->format_spec as it goes. When FORMAT_DECODER
129 returns, TEXT->format_spec should point to the last character processed.
131 printer_fn format_decoder;
134 #define output_prefix(BUFFER) (BUFFER)->state.prefix
136 /* The stream attached to the output_buffer, where the formatted
137 diagnostics will ultimately go. Works only on `output_buffer *'. */
138 #define output_buffer_attached_stream(BUFFER) (BUFFER)->stream
140 /* In line-wrapping mode, whether we should start a new line. */
141 #define output_needs_newline(BUFFER) (BUFFER)->state.need_newline_p
143 /* The amount of whitespace to be emitted when starting a new line. */
144 #define output_indentation(BUFFER) (BUFFER)->state.indent_skip
146 /* A pointer to the formatted diagnostic message. */
147 #define output_message_text(BUFFER) \
148 ((const char *) obstack_base (&(BUFFER)->obstack))
150 /* Client supplied function used to decode formats. */
151 #define output_format_decoder(BUFFER) (BUFFER)->format_decoder
153 /* Prefixing rule used in formatting a diagnostic message. */
154 #define output_prefixing_rule(BUFFER) (BUFFER)->state.prefixing_rule
156 /* Maximum characters per line in automatic line wrapping mode.
157 Zero means don't wrap lines. */
158 #define output_line_cutoff(BUFFER) (BUFFER)->state.ideal_maximum_length
160 /* True if BUFFER is in line-wrapping mode. */
161 #define output_is_line_wrapping(BUFFER) (output_line_cutoff (BUFFER) > 0)
163 #define output_formatted_scalar(BUFFER, FORMAT, INTEGER) \
166 sprintf ((BUFFER)->digit_buffer, FORMAT, INTEGER); \
167 output_add_string (BUFFER, (BUFFER)->digit_buffer); \
171 /* Forward declarations. */
172 typedef struct diagnostic_context diagnostic_context;
173 typedef void (*diagnostic_starter_fn) PARAMS ((diagnostic_context *,
175 typedef diagnostic_starter_fn diagnostic_finalizer_fn;
177 /* This data structure bundles altogether any information relevant to
178 the context of a diagnostic message. */
179 struct diagnostic_context
181 /* Where most of the diagnostic formatting work is done. In Object
182 Oriented terms, we'll say that diagnostic_context is a sub-class of
184 output_buffer buffer;
186 /* The number of times we have issued diagnostics. */
187 int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
189 /* True if we should display the "warnings are being tread as error"
190 message, usually displayed once per compiler run. */
191 bool warnings_are_errors_message;
193 /* This function is called before any message is printed out. It is
194 responsible for preparing message prefix and such. For example, it
196 In file included from "/usr/local/include/curses.h:5:
197 from "/home/gdr/src/nifty_printer.h:56:
200 diagnostic_starter_fn begin_diagnostic;
202 /* This function is called after the diagnostic message is printed. */
203 diagnostic_finalizer_fn end_diagnostic;
205 /* Client hook to report an internal error. */
206 void (*internal_error) PARAMS ((const char *, va_list *));
208 /* Function of last diagnostic message; more generally, function such that
209 if next diagnostic message is in it then we don't have to mention the
213 /* Used to detect when input_file_stack has changed since last described. */
218 /* Hook for front-end extensions. */
222 /* Client supplied function to announce a diagnostic. */
223 #define diagnostic_starter(DC) (DC)->begin_diagnostic
225 /* Client supplied function called after a diagnostic message is
227 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
229 /* Extension hook for client. */
230 #define diagnostic_auxiliary_data(DC) (DC)->x_data
232 /* Same as output_format_decoder. Works on 'diagnostic_context *'. */
233 #define diagnostic_format_decoder(DC) output_format_decoder (&(DC)->buffer)
235 /* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */
236 #define diagnostic_prefixing_rule(DC) output_prefixing_rule (&(DC)->buffer)
238 /* Maximum characters per line in automatic line wrapping mode.
239 Zero means don't wrap lines. */
240 #define diagnostic_line_cutoff(DC) output_line_cutoff (&(DC)->buffer)
242 /* True if the last function in which a diagnostic was reported is
243 different from the current one. */
244 #define diagnostic_last_function_changed(DC) \
245 ((DC)->last_function != current_function_decl)
247 /* Remember the current function as being the last one in which we report
249 #define diagnostic_set_last_function(DC) \
250 (DC)->last_function = current_function_decl
252 /* True if the last module or file in which a diagnostic was reported is
253 different from the current one. */
254 #define diagnostic_last_module_changed(DC) \
255 ((DC)->last_module != input_file_stack_tick)
257 /* Remember the current module or file as being the last one in which we
258 report a diagnostic. */
259 #define diagnostic_set_last_module(DC) \
260 (DC)->last_module = input_file_stack_tick
262 /* This diagnostic_context is used by front-ends that directly output
263 diagnostic messages without going through `error', `warning',
264 and similar functions. */
265 extern diagnostic_context *global_dc;
267 /* The total count of a KIND of diagnostics meitted so far. */
268 #define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
270 /* The number of errors that have been issued so far. Ideally, these
271 would take a diagnostic_context as an argument. */
272 #define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
273 /* Similarly, but for warnings. */
274 #define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
275 /* Similarly, but for sorrys. */
276 #define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
278 /* Returns nonzero if warnings should be emitted. */
279 #define diagnostic_report_warnings_p() \
281 && !(in_system_header && !warn_system_headers))
283 #define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
285 /* Dignostic related functions. */
286 extern void diagnostic_initialize PARAMS ((diagnostic_context *));
287 extern void diagnostic_report_current_module PARAMS ((diagnostic_context *));
288 extern void diagnostic_report_current_function PARAMS ((diagnostic_context *));
289 extern void diagnostic_flush_buffer PARAMS ((diagnostic_context *));
290 extern bool diagnostic_count_diagnostic PARAMS ((diagnostic_context *,
292 extern void diagnostic_report_diagnostic PARAMS ((diagnostic_context *,
294 extern void diagnostic_set_info PARAMS ((diagnostic_info *,
295 const char *, va_list *,
298 extern char *diagnostic_build_prefix PARAMS ((diagnostic_info *));
300 /* Pure text formatting support functions. */
301 extern void init_output_buffer PARAMS ((output_buffer *,
303 extern void output_clear PARAMS ((output_buffer *));
304 extern const char *output_last_position PARAMS ((const output_buffer *));
305 extern void output_set_prefix PARAMS ((output_buffer *,
307 extern void output_destroy_prefix PARAMS ((output_buffer *));
308 extern void output_set_maximum_length PARAMS ((output_buffer *, int));
309 extern void output_emit_prefix PARAMS ((output_buffer *));
310 extern void output_add_newline PARAMS ((output_buffer *));
311 extern void output_add_space PARAMS ((output_buffer *));
312 extern int output_space_left PARAMS ((const output_buffer *));
313 extern void output_append PARAMS ((output_buffer *, const char *,
315 extern void output_add_character PARAMS ((output_buffer *, int));
316 extern void output_decimal PARAMS ((output_buffer *, int));
317 extern void output_add_string PARAMS ((output_buffer *,
319 extern void output_add_identifier PARAMS ((output_buffer *, tree));
320 extern const char *output_finalize_message PARAMS ((output_buffer *));
321 extern void output_clear_message_text PARAMS ((output_buffer *));
322 extern void output_printf PARAMS ((output_buffer *, const char *,
323 ...)) ATTRIBUTE_PRINTF_2;
324 extern void output_verbatim PARAMS ((output_buffer *, const char *,
326 extern void verbatim PARAMS ((const char *, ...));
327 extern char *file_name_as_prefix PARAMS ((const char *));
328 extern void inform PARAMS ((const char *, ...));
330 #endif /* ! GCC_DIAGNOSTIC_H */