OSDN Git Service

* c-decl.c (store_parm_decls_oldstyle): Let diagnostic machinery
[pf3gnuchains/gcc-fork.git] / gcc / diagnostic.h
1 /* Various declarations for language-independent diagnostics subroutines.
2    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005
3    Free Software Foundation, Inc.
4    Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
5
6 This file is part of GCC.
7
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 2, or (at your option) any later
11 version.
12
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.
17
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING.  If not, write to the Free
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
21 02111-1307, USA.  */
22
23 #ifndef GCC_DIAGNOSTIC_H
24 #define GCC_DIAGNOSTIC_H
25
26 #include "pretty-print.h"
27
28 /* Constants used to discriminate diagnostics.  */
29 typedef enum
30 {
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;
36
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
41 {
42   text_info message;
43   location_t location;
44   /* The kind of diagnostic it is about.  */
45   diagnostic_t kind;
46   /* Which OPT_* directly controls this diagnostic.  */
47   int option_index;
48 } diagnostic_info;
49
50 #define pedantic_error_kind() (flag_pedantic_errors ? DK_ERROR : DK_WARNING)
51
52
53 /*  Forward declarations.  */
54 typedef struct diagnostic_context diagnostic_context;
55 typedef void (*diagnostic_starter_fn) (diagnostic_context *,
56                                        diagnostic_info *);
57 typedef diagnostic_starter_fn diagnostic_finalizer_fn;
58
59 /* This data structure bundles altogether any information relevant to
60    the context of a diagnostic message.  */
61 struct diagnostic_context
62 {
63   /* Where most of the diagnostic formatting work is done.  */
64   pretty_printer *printer;
65
66   /* The number of times we have issued diagnostics.  */
67   int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
68
69   /* True if we should display the "warnings are being tread as error"
70      message, usually displayed once per compiler run.  */
71   bool issue_warnings_are_errors_message;
72   
73   /* True if it has been requested that warnings be treated as errors.  */
74   bool warning_as_error_requested;
75
76   /* True if we should raise a SIGABRT on errors.  */
77   bool abort_on_error;
78
79   /* This function is called before any message is printed out.  It is
80      responsible for preparing message prefix and such.  For example, it
81      might say:
82      In file included from "/usr/local/include/curses.h:5:
83                       from "/home/gdr/src/nifty_printer.h:56:
84                       ...
85   */
86   diagnostic_starter_fn begin_diagnostic;
87
88   /* This function is called after the diagnostic message is printed.  */
89   diagnostic_finalizer_fn end_diagnostic;
90
91   /* Client hook to report an internal error.  */
92   void (*internal_error) (const char *, va_list *);
93
94   /* Function of last diagnostic message; more generally, function such that
95      if next diagnostic message is in it then we don't have to mention the
96      function name.  */
97   tree last_function;
98
99   /* Used to detect when input_file_stack has changed since last described.  */
100   int last_module;
101
102   int lock;
103 };
104
105 /* Client supplied function to announce a diagnostic.  */
106 #define diagnostic_starter(DC) (DC)->begin_diagnostic
107
108 /* Client supplied function called after a diagnostic message is
109    displayed.  */
110 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
111
112 /* Extension hook for client.  */
113 #define diagnostic_auxiliary_data(DC) (DC)->x_data
114
115 /* Same as pp_format_decoder.  Works on 'diagnostic_context *'.  */
116 #define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder)
117
118 /* Same as output_prefixing_rule.  Works on 'diagnostic_context *'.  */
119 #define diagnostic_prefixing_rule(DC) ((DC)->printer->prefixing_rule)
120
121 /* Maximum characters per line in automatic line wrapping mode.
122    Zero means don't wrap lines.  */
123 #define diagnostic_line_cutoff(DC) ((DC)->printer->ideal_maximum_length)
124
125 #define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer)
126
127 /* True if the last function in which a diagnostic was reported is
128    different from the current one.  */
129 #define diagnostic_last_function_changed(DC) \
130   ((DC)->last_function != current_function_decl)
131
132 /* Remember the current function as being the last one in which we report
133    a diagnostic.  */
134 #define diagnostic_set_last_function(DC) \
135   (DC)->last_function = current_function_decl
136
137 /* True if the last module or file in which a diagnostic was reported is
138    different from the current one.  */
139 #define diagnostic_last_module_changed(DC) \
140   ((DC)->last_module != input_file_stack_tick)
141
142 /* Remember the current module or file as being the last one in which we
143    report a diagnostic.  */
144 #define diagnostic_set_last_module(DC) \
145   (DC)->last_module = input_file_stack_tick
146
147 /* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher.  */
148 #define diagnostic_abort_on_error(DC) \
149   (DC)->abort_on_error = true
150
151 /* This diagnostic_context is used by front-ends that directly output
152    diagnostic messages without going through `error', `warning',
153    and similar functions.  */
154 extern diagnostic_context *global_dc;
155
156 /* The total count of a KIND of diagnostics emitted so far.  */
157 #define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
158
159 /* The number of errors that have been issued so far.  Ideally, these
160    would take a diagnostic_context as an argument.  */
161 #define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
162 /* Similarly, but for warnings.  */
163 #define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
164 /* Similarly, but for sorrys.  */
165 #define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
166
167 /* Returns nonzero if warnings should be emitted.  */
168 #define diagnostic_report_warnings_p()                  \
169   (!inhibit_warnings                                    \
170    && !(in_system_header && !warn_system_headers))
171
172 #define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
173
174 /* Diagnostic related functions.  */
175 extern void diagnostic_initialize (diagnostic_context *);
176 extern void diagnostic_report_current_module (diagnostic_context *);
177 extern void diagnostic_report_current_function (diagnostic_context *);
178 extern void diagnostic_report_diagnostic (diagnostic_context *,
179                                           diagnostic_info *);
180 extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *,
181                                  location_t, diagnostic_t);
182 extern char *diagnostic_build_prefix (diagnostic_info *);
183
184 /* Pure text formatting support functions.  */
185 extern void verbatim (const char *, ...);
186 extern char *file_name_as_prefix (const char *);
187
188 /* In tree-pretty-print.c  */
189 extern int dump_generic_node (pretty_printer *, tree, int, int, bool);
190 extern void print_generic_stmt (FILE *, tree, int);
191 extern void print_generic_stmt_indented (FILE *, tree, int, int);
192 extern void print_generic_expr (FILE *, tree, int);
193 extern void print_generic_decl (FILE *, tree, int);
194
195 extern void debug_generic_expr (tree);
196 extern void debug_generic_stmt (tree);
197 extern void debug_c_tree (tree);
198 #endif /* ! GCC_DIAGNOSTIC_H */