1 /* Various declarations for language-independent diagnostics subroutines.
2 Copyright (C) 2000 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 encapulates 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 accompt 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
;
54 /* Nonzero if current PREFIX was emitted at least once. */
57 /* Nonzero means one should emit a newline before outputing anything. */
60 /* Tells how often current PREFIX should be emitted:
61 o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
62 o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit current PREFIX only once;
63 o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit current PREFIX each time
64 a physical line is started. */
66 /* The current char to output. Updated by front-end (*format_map) when
67 it is called to report front-end printer for a specified format. */
69 /* A pointer to the variable argument-list for formatting. */
73 /* The output buffer datatype. This is best seen as an abstract datatype. */
76 /* Internal data. These fields should not be accessed directly by
79 /* The obstack where the text is built up. */
80 struct obstack obstack
;
81 /* The amount of characters output so far. */
83 /* The current state of the buffer. */
87 #define output_buffer_text_cursor(BUFFER) (BUFFER)->state.cursor
88 #define output_buffer_format_args(BUFFER) *((BUFFER)->state.format_args)
89 #define output_needs_newline(BUFFER) (BUFFER)->state.need_newline_p
91 /* This data structure bundles altogether any information relevent to
92 the context of a diagnostic message. */
93 struct diagnostic_context
95 /* The diagnostic message to output. */
98 /* A pointer to a variable list of the arguments necessary for the
99 purpose of message formatting. */
102 /* The name of the source file involved in the diiagnostic. */
105 /* The line-location in the source file. */
108 /* Is it message a warning? */
111 /* This function is called before any message is printed out. It is
112 respondible for preparing message prefix and such. For example, it
114 In file included from "/usr/local/include/curses.h:5:
115 from "/home/gdr/src/nifty_printer.h:56:
118 void (*begin_diagnostic
) PARAMS ((output_buffer
*, diagnostic_context
*));
120 /* This function is called after the diagnostic message is printed. */
121 void (*end_diagnostic
) PARAMS ((output_buffer
*, diagnostic_context
*));
123 /* Hook for front-end extensions. */
127 #define diagnostic_message(DC) (DC)->message
128 #define diagnostic_argument_list(DC) (DC)->args_ptr
129 #define diagnostic_file_location(DC) (DC)->file
130 #define diagnostic_line_location(DC) (DC)->line
131 #define diagnostic_is_warning(DC) (DC)->warn
132 #define diagnostic_starter(DC) (DC)->begin_diagnostic
133 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
134 #define diagnostic_auxiliary_data(DC) (DC)->x_data
136 /* If non-NULL, this function formats data in the BUFFER. When called,
137 output_buffer_text_cursor (BUFFER) points to a format code. LANG_PRINTER
138 should call output_add_string (and related functions) to add data to
139 the BUFFER. LANG_PRINTER can read arguments from
140 output_buffer_format_args (BUFFER) using VA_ARG. If the BUFFER needs
141 additional characters from the format string, it should advance
142 the output_buffer_text_cursor (BUFFER) as it goes. When LANG_PRINTER
143 returns, output_buffer_text_cursor (BUFFER) should point to the last
144 character processed. */
146 extern printer_fn lang_printer
;
148 extern diagnostic_starter_fn lang_diagnostic_starter
;
149 extern diagnostic_finalizer_fn lang_diagnostic_finalizer
;
151 extern int diagnostic_message_length_per_line
;
153 /* This output buffer is used by front-ends that directly output
154 diagnostic messages without going through `error', `warning',
155 and simillar functions. In general, such usage should be
156 avoided. This global buffer will go away, once all such usage
158 extern output_buffer
*diagnostic_buffer
;
161 void set_diagnostic_context
PARAMS ((diagnostic_context
*, const char *,
162 va_list *, const char *, int, int));
163 void set_fatal_function
PARAMS ((void (*) PARAMS ((const char *,
165 void report_diagnostic
PARAMS ((diagnostic_context
*));
166 void initialize_diagnostics
PARAMS ((void));
167 void reshape_diagnostic_buffer
PARAMS ((void));
168 void default_initialize_buffer
PARAMS ((output_buffer
*));
169 void init_output_buffer
PARAMS ((output_buffer
*, const char *, int));
170 void output_clear
PARAMS ((output_buffer
*));
171 const char *output_get_prefix
PARAMS ((const output_buffer
*));
172 void output_set_prefix
PARAMS ((output_buffer
*, const char *));
173 void output_destroy_prefix
PARAMS ((output_buffer
*));
174 void output_set_maximum_length
PARAMS ((output_buffer
*, int));
175 void output_emit_prefix
PARAMS ((output_buffer
*));
176 void output_add_newline
PARAMS ((output_buffer
*));
177 void output_add_space
PARAMS ((output_buffer
*));
178 int output_space_left
PARAMS ((const output_buffer
*));
179 void output_append
PARAMS ((output_buffer
*, const char *,
181 void output_add_character
PARAMS ((output_buffer
*, int));
182 void output_decimal
PARAMS ((output_buffer
*, int));
183 void output_add_string
PARAMS ((output_buffer
*, const char *));
184 const char *output_finish
PARAMS ((output_buffer
*));
185 void output_printf
PARAMS ((output_buffer
*, const char *,
186 ...)) ATTRIBUTE_PRINTF_2
;
187 int output_is_line_wrapping
PARAMS ((output_buffer
*));
188 void set_message_prefixing_rule
PARAMS ((int));
189 void output_verbatim
PARAMS ((output_buffer
*, const char *, ...))
191 void verbatim
PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1
;
192 char *context_as_prefix
PARAMS ((const char *, int, int));
193 char *file_name_as_prefix
PARAMS ((const char *));
194 int error_module_changed
PARAMS ((void));
195 void record_last_error_module
PARAMS ((void));
196 int error_function_changed
PARAMS ((void));
197 void record_last_error_function
PARAMS ((void));
200 #endif /* __GCC_DIAGNOSTIC_H__ */