1 /* Various declarations for language-independent diagnostics subroutines.
2 Copyright (C) 2000, 2001 Free Software Foundation, Inc.
3 Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
5 This file is part of GNU CC.
7 GNU CC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU CC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU CC; see the file COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #ifndef __GCC_DIAGNOSTIC_H__
23 #define __GCC_DIAGNOSTIC_H__
27 /* Forward declarations. */
28 typedef struct output_buffer output_buffer
;
29 typedef struct diagnostic_context diagnostic_context
;
30 typedef void (*diagnostic_starter_fn
) PARAMS ((output_buffer
*,
31 diagnostic_context
*));
32 typedef diagnostic_starter_fn diagnostic_finalizer_fn
;
34 #define DIAGNOSTICS_SHOW_PREFIX_ONCE 0x0
35 #define DIAGNOSTICS_SHOW_PREFIX_NEVER 0x1
36 #define DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE 0x2
38 /* The type of front-end specific hook that formats trees into an
39 output_buffer. A language specific printer returns a truth value if
40 everything goes well. */
41 typedef int (*printer_fn
) PARAMS ((output_buffer
*));
43 /* This data structure encapsulates an output_buffer's state. */
46 /* The prefix for each new line. */
48 /* The real upper bound of number of characters per line, taking into
49 account the case of a very very looong prefix. */
51 /* The ideal upper bound of number of characters per line, as suggested
53 int ideal_maximum_length
;
55 /* Indentation count. */
58 /* Nonzero if current PREFIX was emitted at least once. */
61 /* Nonzero means one should emit a newline before outputing anything. */
64 /* Tells how often current PREFIX should be emitted:
65 o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
66 o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit current PREFIX only once;
67 o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit current PREFIX each time
68 a physical line is started. */
70 /* The current char to output. Updated by front-end (*format_map) when
71 it is called to report front-end printer for a specified format. */
73 /* A pointer to the variable argument-list for formatting. */
77 /* The output buffer datatype. This is best seen as an abstract datatype. */
80 /* Internal data. These fields should not be accessed directly by
83 /* Where to output formatted text. */
85 /* The obstack where the text is built up. */
86 struct obstack obstack
;
87 /* The amount of characters output so far. */
89 /* The current state of the buffer. */
93 #define output_buffer_attached_stream(BUFFER) (BUFFER)->stream
94 #define output_buffer_text_cursor(BUFFER) (BUFFER)->state.cursor
95 #define output_buffer_format_args(BUFFER) *((BUFFER)->state.format_args)
96 #define output_needs_newline(BUFFER) (BUFFER)->state.need_newline_p
97 #define output_buffer_state(BUFFER) (BUFFER)->state
98 #define output_indentation(BUFFER) (BUFFER)->state.indent_skip
99 #define output_message_text(BUFFER) \
100 ((const char *) obstack_base (&(BUFFER)->obstack))
102 /* This data structure bundles altogether any information relevant to
103 the context of a diagnostic message. */
104 struct diagnostic_context
106 /* The diagnostic message to output. */
109 /* A pointer to a variable list of the arguments necessary for the
110 purpose of message formatting. */
113 /* The name of the source file involved in the diiagnostic. */
116 /* The line-location in the source file. */
119 /* Is this message a warning? */
122 /* This function is called before any message is printed out. It is
123 responsible for preparing message prefix and such. For example, it
125 In file included from "/usr/local/include/curses.h:5:
126 from "/home/gdr/src/nifty_printer.h:56:
129 void (*begin_diagnostic
) PARAMS ((output_buffer
*, diagnostic_context
*));
131 /* This function is called after the diagnostic message is printed. */
132 void (*end_diagnostic
) PARAMS ((output_buffer
*, diagnostic_context
*));
134 /* Hook for front-end extensions. */
138 #define diagnostic_message(DC) (DC)->message
139 #define diagnostic_argument_list(DC) (DC)->args_ptr
140 #define diagnostic_file_location(DC) (DC)->file
141 #define diagnostic_line_location(DC) (DC)->line
142 #define diagnostic_is_warning(DC) (DC)->warn
143 #define diagnostic_starter(DC) (DC)->begin_diagnostic
144 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
145 #define diagnostic_auxiliary_data(DC) (DC)->x_data
147 /* If non-NULL, this function formats data in the BUFFER. When called,
148 output_buffer_text_cursor (BUFFER) points to a format code. LANG_PRINTER
149 should call output_add_string (and related functions) to add data to
150 the BUFFER. LANG_PRINTER can read arguments from
151 output_buffer_format_args (BUFFER) using VA_ARG. If the BUFFER needs
152 additional characters from the format string, it should advance
153 the output_buffer_text_cursor (BUFFER) as it goes. When LANG_PRINTER
154 returns, output_buffer_text_cursor (BUFFER) should point to the last
155 character processed. */
157 extern printer_fn lang_printer
;
159 extern diagnostic_starter_fn lang_diagnostic_starter
;
160 extern diagnostic_finalizer_fn lang_diagnostic_finalizer
;
162 extern int diagnostic_message_length_per_line
;
164 /* This output buffer is used by front-ends that directly output
165 diagnostic messages without going through `error', `warning',
166 and similar functions. In general, such usage should be
167 avoided. This global buffer will go away, once all such usage
169 extern output_buffer
*diagnostic_buffer
;
172 extern void set_diagnostic_context
PARAMS ((diagnostic_context
*,
173 const char *, va_list *,
174 const char *, int, int));
175 extern void set_internal_error_function
PARAMS ((void (*)
176 PARAMS ((const char *,
178 extern void report_diagnostic
PARAMS ((diagnostic_context
*));
179 extern void initialize_diagnostics
PARAMS ((void));
180 extern void reshape_diagnostic_buffer
PARAMS ((void));
181 extern void default_initialize_buffer
PARAMS ((output_buffer
*));
182 extern void init_output_buffer
PARAMS ((output_buffer
*,
184 extern void flush_diagnostic_buffer
PARAMS ((void));
185 extern void output_clear
PARAMS ((output_buffer
*));
186 extern const char *output_get_prefix
PARAMS ((const output_buffer
*));
187 extern const char *output_last_position
PARAMS ((const output_buffer
*));
188 extern void output_set_prefix
PARAMS ((output_buffer
*,
190 extern void output_destroy_prefix
PARAMS ((output_buffer
*));
191 extern void output_set_maximum_length
PARAMS ((output_buffer
*, int));
192 extern void output_emit_prefix
PARAMS ((output_buffer
*));
193 extern void output_add_newline
PARAMS ((output_buffer
*));
194 extern void output_add_space
PARAMS ((output_buffer
*));
195 extern int output_space_left
PARAMS ((const output_buffer
*));
196 extern void output_append
PARAMS ((output_buffer
*, const char *,
198 extern void output_add_character
PARAMS ((output_buffer
*, int));
199 extern void output_decimal
PARAMS ((output_buffer
*, int));
200 extern void output_add_string
PARAMS ((output_buffer
*,
202 extern const char *output_finalize_message
PARAMS ((output_buffer
*));
203 extern void output_clear_message_text
PARAMS ((output_buffer
*));
204 extern void output_printf
PARAMS ((output_buffer
*, const char *,
205 ...)) ATTRIBUTE_PRINTF_2
;
206 extern int output_is_line_wrapping
PARAMS ((output_buffer
*));
207 extern void set_message_prefixing_rule
PARAMS ((int));
208 extern void output_verbatim
PARAMS ((output_buffer
*, const char *,
209 ...)) ATTRIBUTE_PRINTF_2
;
210 extern void verbatim
PARAMS ((const char *, ...))
212 extern char *context_as_prefix
PARAMS ((const char *, int, int));
213 extern char *file_name_as_prefix
PARAMS ((const char *));
214 extern int error_module_changed
PARAMS ((void));
215 extern void record_last_error_module
PARAMS ((void));
216 extern int error_function_changed
PARAMS ((void));
217 extern void record_last_error_function
PARAMS ((void));
218 extern void report_problematic_module
PARAMS ((output_buffer
*));
220 #endif /* __GCC_DIAGNOSTIC_H__ */