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