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
;
30 #define DIAGNOSTICS_SHOW_PREFIX_ONCE 0x0
31 #define DIAGNOSTICS_SHOW_PREFIX_NEVER 0x1
32 #define DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE 0x2
34 /* The type of front-end specific hook that formats trees into an
36 typedef void (*printer_fn
) PARAMS ((output_buffer
*));
38 /* The output buffer datatype. This is best seen as an abstract datatype. */
41 /* Internal data. These fields should not be accessed directly by
44 /* The obstack where the text is built up. */
45 struct obstack obstack
;
46 /* The prefix for each new line. */
48 /* The amount of characters output so far. */
50 /* The real upper bound of number of characters per line, taking into
51 accompt the case of a very very looong prefix. */
53 /* The ideal upper bound of number of characters per line, as suggested
55 int ideal_maximum_length
;
56 /* Nonzero if current PREFIX was emitted at least once. */
58 /* Tells how often current PREFIX should be emitted:
59 o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
60 o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit current PREFIX only once;
61 o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit current PREFIX each time
62 a physical line is started. */
65 /* Public fields. These are used by front-ends to extract formats and
66 arguments from the variable argument-list passed to output_format. */
68 /* The current char to output. Updated by front-end (*format_map) when
69 it is called to report front-end printer for a specified format. */
71 /* Variable argument-list for formatting. */
75 /* If non-NULL, this function formats data in the BUFFER.
76 BUFFER->CURSOR points to a format code. LANG_PRINTER should
77 call output_add_string (and related functions) to add data to
78 the BUFFER. LANG_PRINTER can read arguments from
79 BUFFER->FORMAT_ARGS using VA_ARG. If the BUFFER needs
80 additional characters from the format string, it should advance
81 the BUFFER->CURSOR as it goes. When LANG_PRINTER returns,
82 BUFFER->CURSOR should point to the last character processed. */
84 extern printer_fn lang_printer
;
86 extern int diagnostic_message_length_per_line
;
88 /* This output buffer is used by front-ends that directly output
89 diagnostic messages without going through `error', `warning',
90 and simillar functions. In general, such usage should be
91 avoided. This global buffer will go away, once all such usage
93 extern output_buffer
*diagnostic_buffer
;
96 void initialize_diagnostics
PARAMS ((void));
97 void reshape_diagnostic_buffer
PARAMS ((void));
98 void default_initialize_buffer
PARAMS ((output_buffer
*));
99 void init_output_buffer
PARAMS ((output_buffer
*, const char *, int));
100 void output_clear
PARAMS ((output_buffer
*));
101 const char *output_get_prefix
PARAMS ((const output_buffer
*));
102 void output_set_prefix
PARAMS ((output_buffer
*, const char *));
103 void output_destroy_prefix
PARAMS ((output_buffer
*));
104 void output_set_maximum_length
PARAMS ((output_buffer
*, int));
105 void output_emit_prefix
PARAMS ((output_buffer
*));
106 void output_add_newline
PARAMS ((output_buffer
*));
107 void output_add_space
PARAMS ((output_buffer
*));
108 int output_space_left
PARAMS ((const output_buffer
*));
109 void output_append
PARAMS ((output_buffer
*, const char *,
111 void output_add_character
PARAMS ((output_buffer
*, int));
112 void output_add_integer
PARAMS ((output_buffer
*, HOST_WIDE_INT
));
113 void output_add_string
PARAMS ((output_buffer
*, const char *));
114 const char *output_finish
PARAMS ((output_buffer
*));
115 void output_flush_on
PARAMS ((output_buffer
*, FILE *));
116 void output_printf
PARAMS ((output_buffer
*, const char *,
117 ...)) ATTRIBUTE_PRINTF_2
;
118 void output_format
PARAMS ((output_buffer
*, const char *));
119 int output_is_line_wrapping
PARAMS ((output_buffer
*));
120 void set_message_prefixing_rule
PARAMS ((int));
122 #endif /* __GCC_DIAGNOSTIC_H__ */