Daily bump.
[official-gcc.git] / gcc / diagnostic.h
blob02e43bd0f8e41fd70ce87b79f931e8b7ef1f3622
1 /* Various declarations for language-independent diagnostics subroutines.
2 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
3 Free Software Foundation, Inc.
4 Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
11 version.
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
22 #ifndef GCC_DIAGNOSTIC_H
23 #define GCC_DIAGNOSTIC_H
25 #include "pretty-print.h"
26 #include "options.h"
28 /* Constants used to discriminate diagnostics. */
29 typedef enum
31 #define DEFINE_DIAGNOSTIC_KIND(K, msgid) K,
32 #include "diagnostic.def"
33 #undef DEFINE_DIAGNOSTIC_KIND
34 DK_LAST_DIAGNOSTIC_KIND
35 } diagnostic_t;
37 /* A diagnostic is described by the MESSAGE to send, the FILE and LINE of
38 its context and its KIND (ice, error, warning, note, ...) See complete
39 list in diagnostic.def. */
40 typedef struct diagnostic_info
42 text_info message;
43 location_t location;
44 /* TREE_BLOCK if the diagnostic is to be reported in some inline
45 function inlined into other function, otherwise NULL. */
46 tree abstract_origin;
47 /* The kind of diagnostic it is about. */
48 diagnostic_t kind;
49 /* Which OPT_* directly controls this diagnostic. */
50 int option_index;
51 } diagnostic_info;
53 #define pedantic_error_kind() (flag_pedantic_errors ? DK_ERROR : DK_WARNING)
56 /* Forward declarations. */
57 typedef struct diagnostic_context diagnostic_context;
58 typedef void (*diagnostic_starter_fn) (diagnostic_context *,
59 diagnostic_info *);
60 typedef diagnostic_starter_fn diagnostic_finalizer_fn;
62 /* This data structure bundles altogether any information relevant to
63 the context of a diagnostic message. */
64 struct diagnostic_context
66 /* Where most of the diagnostic formatting work is done. */
67 pretty_printer *printer;
69 /* The number of times we have issued diagnostics. */
70 int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
72 /* True if we should display the "warnings are being tread as error"
73 message, usually displayed once per compiler run. */
74 bool issue_warnings_are_errors_message;
76 /* True if it has been requested that warnings be treated as errors. */
77 bool warning_as_error_requested;
79 /* For each option index that can be passed to warning() et all
80 (OPT_* from options.h), this array may contain a new kind that
81 the diagnostic should be changed to before reporting, or
82 DK_UNSPECIFIED to leave it as the reported kind, or DK_IGNORED to
83 not report it at all. N_OPTS is from <options.h>. */
84 char classify_diagnostic[N_OPTS];
86 /* True if we should print the command line option which controls
87 each diagnostic, if known. */
88 bool show_option_requested;
90 /* True if we should raise a SIGABRT on errors. */
91 bool abort_on_error;
93 /* This function is called before any message is printed out. It is
94 responsible for preparing message prefix and such. For example, it
95 might say:
96 In file included from "/usr/local/include/curses.h:5:
97 from "/home/gdr/src/nifty_printer.h:56:
98 ...
100 diagnostic_starter_fn begin_diagnostic;
102 /* This function is called after the diagnostic message is printed. */
103 diagnostic_finalizer_fn end_diagnostic;
105 /* Client hook to report an internal error. */
106 void (*internal_error) (const char *, va_list *);
108 /* Function of last diagnostic message; more generally, function such that
109 if next diagnostic message is in it then we don't have to mention the
110 function name. */
111 tree last_function;
113 /* Used to detect when input_file_stack has changed since last described. */
114 int last_module;
116 int lock;
119 /* Client supplied function to announce a diagnostic. */
120 #define diagnostic_starter(DC) (DC)->begin_diagnostic
122 /* Client supplied function called after a diagnostic message is
123 displayed. */
124 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
126 /* Extension hook for client. */
127 #define diagnostic_auxiliary_data(DC) (DC)->x_data
129 /* Same as pp_format_decoder. Works on 'diagnostic_context *'. */
130 #define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder)
132 /* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */
133 #define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule)
135 /* Maximum characters per line in automatic line wrapping mode.
136 Zero means don't wrap lines. */
137 #define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
139 #define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer)
141 /* True if the last function in which a diagnostic was reported is
142 different from the current one. */
143 #define diagnostic_last_function_changed(DC, DI) \
144 ((DC)->last_function != ((DI)->abstract_origin \
145 ? (DI)->abstract_origin : current_function_decl))
147 /* Remember the current function as being the last one in which we report
148 a diagnostic. */
149 #define diagnostic_set_last_function(DC, DI) \
150 (DC)->last_function = (((DI) && (DI)->abstract_origin) \
151 ? (DI)->abstract_origin : current_function_decl)
153 /* True if the last module or file in which a diagnostic was reported is
154 different from the current one. */
155 #define diagnostic_last_module_changed(DC) \
156 ((DC)->last_module != input_file_stack_tick)
158 /* Remember the current module or file as being the last one in which we
159 report a diagnostic. */
160 #define diagnostic_set_last_module(DC) \
161 (DC)->last_module = input_file_stack_tick
163 /* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher. */
164 #define diagnostic_abort_on_error(DC) \
165 (DC)->abort_on_error = true
167 /* This diagnostic_context is used by front-ends that directly output
168 diagnostic messages without going through `error', `warning',
169 and similar functions. */
170 extern diagnostic_context *global_dc;
172 /* The total count of a KIND of diagnostics emitted so far. */
173 #define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
175 /* The number of errors that have been issued so far. Ideally, these
176 would take a diagnostic_context as an argument. */
177 #define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
178 /* Similarly, but for warnings. */
179 #define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
180 /* Similarly, but for sorrys. */
181 #define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
183 /* Returns nonzero if warnings should be emitted. */
184 #define diagnostic_report_warnings_p() \
185 (!inhibit_warnings \
186 && !(in_system_header && !warn_system_headers))
188 #define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
190 /* Diagnostic related functions. */
191 extern void diagnostic_initialize (diagnostic_context *);
192 extern void diagnostic_report_current_module (diagnostic_context *);
193 extern void diagnostic_report_current_function (diagnostic_context *,
194 diagnostic_info *);
196 /* Force diagnostics controlled by OPTIDX to be kind KIND. */
197 extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *,
198 int /* optidx */,
199 diagnostic_t /* kind */);
200 extern void diagnostic_report_diagnostic (diagnostic_context *,
201 diagnostic_info *);
202 #ifdef ATTRIBUTE_GCC_DIAG
203 extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *,
204 location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0);
205 extern void diagnostic_set_info_translated (diagnostic_info *, const char *,
206 va_list *, location_t,
207 diagnostic_t)
208 ATTRIBUTE_GCC_DIAG(2,0);
209 #endif
210 extern char *diagnostic_build_prefix (diagnostic_info *);
212 /* Pure text formatting support functions. */
213 extern char *file_name_as_prefix (const char *);
215 /* In tree-pretty-print.c */
216 extern int dump_generic_node (pretty_printer *, tree, int, int, bool);
217 extern void print_generic_stmt (FILE *, tree, int);
218 extern void print_generic_stmt_indented (FILE *, tree, int, int);
219 extern void print_generic_expr (FILE *, tree, int);
220 extern void print_generic_decl (FILE *, tree, int);
222 extern void debug_generic_expr (tree);
223 extern void debug_generic_stmt (tree);
224 extern void debug_tree_chain (tree);
225 extern void debug_c_tree (tree);
226 #endif /* ! GCC_DIAGNOSTIC_H */