/* Various declarations for language-independent diagnostics subroutines.
- Copyright (C) 2000, 2001 Free Software Foundation, Inc.
+ Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc.
Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
-This file is part of GNU CC.
+This file is part of GCC.
-GNU CC is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2, or (at your option)
-any later version.
+GCC is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
-GNU CC is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
+GCC is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details.
You should have received a copy of the GNU General Public License
-along with GNU CC; see the file COPYING. If not, write to
-the Free Software Foundation, 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA. */
+along with GCC; see the file COPYING. If not, write to the Free
+Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA. */
#ifndef GCC_DIAGNOSTIC_H
#define GCC_DIAGNOSTIC_H
/* The type of front-end specific hook that formats trees into an
output_buffer. A language specific printer returns a truth value if
- everything goes well. */
+ everything goes well. */
typedef int (*printer_fn) PARAMS ((output_buffer *));
/* This data structure encapsulates an output_buffer's state. */
typedef struct
{
- /* The prefix for each new line. */
+ /* The prefix for each new line. */
const char *prefix;
/* The real upper bound of number of characters per line, taking into
int maximum_length;
/* The ideal upper bound of number of characters per line, as suggested
- by front-end. */
+ by front-end. */
int ideal_maximum_length;
/* Indentation count. */
int indent_skip;
/* Nonzero if current PREFIX was emitted at least once. */
- int emitted_prefix_p;
+ bool emitted_prefix_p;
/* Nonzero means one should emit a newline before outputing anything. */
- int need_newline_p;
+ bool need_newline_p;
/* Current prefixing rule. */
diagnostic_prefixing_rule_t prefixing_rule;
printer_fn format_decoder;
};
-#define output_buffer_state(BUFFER) (BUFFER)->state
+/* Current state of the diagnostic_context' output_buffer. This macro
+ accepts both `diagnostic_context *' and `output_buffer *'. */
+#define output_buffer_state(BUFFER) ((output_buffer *)(BUFFER))->state
+
+/* The stream attached to the output_buffer, where the formatted
+ diagnostics will ultimately go. Works only on `output_buffer *'. */
#define output_buffer_attached_stream(BUFFER) (BUFFER)->stream
+
+/* This points to the beginning of the rest of the diagnostic message
+ to be formatted. Accepts only `output_buffer *'s. */
#define output_buffer_text_cursor(BUFFER) (BUFFER)->state.cursor
-#define output_buffer_format_args(BUFFER) *((BUFFER)->state.format_args)
+
+/* The rest of the `variable argument list' not yet processed.
+ This macro works on both `output_state *' and `output_buffer *'. */
+#define output_buffer_format_args(BUFFER) \
+ *(((output_state *)(BUFFER))->format_args)
+
+/* In line-wrapping mode, whether we should start a new line. */
#define output_needs_newline(BUFFER) (BUFFER)->state.need_newline_p
-#define output_buffer_state(BUFFER) (BUFFER)->state
+
+/* The amount of whitespace to be emitted when starting a new line. */
#define output_indentation(BUFFER) (BUFFER)->state.indent_skip
+
+/* A pointer to the formatted diagonstic message. */
#define output_message_text(BUFFER) \
((const char *) obstack_base (&(BUFFER)->obstack))
*/
void (*begin_diagnostic) PARAMS ((output_buffer *, diagnostic_context *));
- /* This function is called after the diagnostic message is printed. */
+ /* This function is called after the diagnostic message is printed. */
void (*end_diagnostic) PARAMS ((output_buffer *, diagnostic_context *));
/* Hook for front-end extensions. */
void *x_data;
};
+/* The diagnostic message being formatted. */
#define diagnostic_message(DC) (DC)->message
+
+/* A pointer to the variable argument list used in a call
+ to a diagonstic routine. */
#define diagnostic_argument_list(DC) (DC)->args_ptr
+
+/* The program file to which the diagnostic is referring to. */
#define diagnostic_file_location(DC) (DC)->file
+
+/* The program source line referred to in the diagnostic message. */
#define diagnostic_line_location(DC) (DC)->line
+
+/* Tell whether the diagnostic message is to be treated as a warning. */
#define diagnostic_is_warning(DC) (DC)->warn
+
+/* Client supplied function to announce a diagnostic. */
#define diagnostic_starter(DC) (DC)->begin_diagnostic
+
+/* Client supplied function called after a diagnostic message is
+ displayed. */
#define diagnostic_finalizer(DC) (DC)->end_diagnostic
+
+/* Extension hook for client. */
#define diagnostic_auxiliary_data(DC) (DC)->x_data
-#define diagnostic_format_decoder(DC) (DC)->buffer.format_decoder
-#define diagnostic_prefixing_rule(DC) (DC)->buffer.state.prefixing_rule
+
+/* Client supplied function used to decode formats. Can operate on both
+ `output_buffer *' and `diagnostic_context *'. */
+#define diagnostic_format_decoder(DC) ((output_buffer *)(DC))->format_decoder
+
+/* Prefixing rule used in formatting a diagnostic message. Accepts both
+ `output_buffer *' and `diagnostic_context *'. */
+#define diagnostic_prefixing_rule(DC) \
+ ((output_buffer *)(DC))->state.prefixing_rule
/* Maximum characters per line in automatic line wrapping mode.
- Zero means don't wrap lines. */
-#define diagnostic_line_cutoff(DC) (DC)->buffer.state.ideal_maximum_length
+ Zero means don't wrap lines. */
+#define diagnostic_line_cutoff(DC) \
+ ((output_buffer *)(DC))->state.ideal_maximum_length
-/* This output buffer is used by front-ends that directly output
+/* This diagnostic context is used by front-ends that directly output
diagnostic messages without going through `error', `warning',
- and similar functions. In general, such usage should be
- avoided. This global buffer will go away, once all such usage
- has been removed. */
-extern output_buffer *diagnostic_buffer;
+ and similar functions. */
extern diagnostic_context *global_dc;
-#define diagnostic_kind_count(BUFFER, DK) \
- (BUFFER)->state.diagnostic_count[(int) DK]
+/* This will be removed shortly. */
+extern output_buffer *diagnostic_buffer;
+
+/* The total count of a KIND of diagnostics meitted so far. */
+#define diagnostic_kind_count(DC, DK) \
+ ((output_buffer *)(DC))->state.diagnostic_count[(int) (DK)]
/* The number of errors that have been issued so far. Ideally, these
would take an output_buffer as an argument. */
-#define errorcount diagnostic_kind_count (diagnostic_buffer, DK_ERROR)
+#define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
/* Similarly, but for warnings. */
-#define warningcount diagnostic_kind_count (diagnostic_buffer, DK_WARNING)
+#define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
/* Similarly, but for sorrys. */
-#define sorrycount diagnostic_kind_count (diagnostic_buffer, DK_SORRY)
+#define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
/* Returns non-zero if warnings should be emitted. */
#define diagnostic_report_warnings_p() \
extern void record_last_error_function PARAMS ((void));
extern void report_problematic_module PARAMS ((output_buffer *));
+/* Called by report_error_function to print out function name.
+ * Default may be overridden by language front-ends. */
+extern void (*print_error_function) PARAMS ((diagnostic_context *,
+ const char *));
+
+extern void default_print_error_function PARAMS ((diagnostic_context *,
+ const char *));
+
#endif /* ! GCC_DIAGNOSTIC_H */
projects / platform / upstream / gcc.git / blobdiff