/* Various declarations for language-independent diagnostics subroutines.
- Copyright (C) 2000, 2001 Free Software Foundation, Inc.
+ Copyright (C) 2000, 2001, 2002, 2003 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
#include "obstack.h"
+#include "location.h"
-/* Forward declarations. */
-typedef struct output_buffer output_buffer;
-typedef struct diagnostic_context diagnostic_context;
-typedef void (*diagnostic_starter_fn) PARAMS ((output_buffer *,
- diagnostic_context *));
-typedef diagnostic_starter_fn diagnostic_finalizer_fn;
+/* The type of a text to be formatted according a format specification
+ along with a list of things. */
+typedef struct
+{
+ const char *format_spec;
+ va_list *args_ptr;
+} text_info;
+/* Contants used to discriminate diagnostics. */
typedef enum
{
#define DEFINE_DIAGNOSTIC_KIND(K, M) K,
DK_LAST_DIAGNOSTIC_KIND
} diagnostic_t;
-#define pedantic_error_kind() (flag_pedantic_errors ? DK_ERROR : DK_WARNING)
+/* A diagnostic is described by the MESSAGE to send, the FILE and LINE of
+ its context and its KIND (ice, error, warning, note, ...) See complete
+ list in diagnostic.def. */
+typedef struct
+{
+ text_info message;
+ location_t location;
+ /* The kind of diagnostic it is about. */
+ diagnostic_t kind;
+} diagnostic_info;
-#define DIAGNOSTICS_SHOW_PREFIX_ONCE 0x0
-#define DIAGNOSTICS_SHOW_PREFIX_NEVER 0x1
-#define DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE 0x2
+#define pedantic_error_kind() (flag_pedantic_errors ? DK_ERROR : DK_WARNING)
-/* 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. */
-typedef int (*printer_fn) PARAMS ((output_buffer *));
+/* How often diagnostics are prefixed by their locations:
+ o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
+ o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit only once;
+ o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit each time a physical
+ line is started. */
+typedef enum
+{
+ DIAGNOSTICS_SHOW_PREFIX_ONCE = 0x0,
+ DIAGNOSTICS_SHOW_PREFIX_NEVER = 0x1,
+ DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE = 0x2
+} diagnostic_prefixing_rule_t;
/* 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
account the case of a very very looong prefix. */
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;
-
- /* Tells how often current PREFIX should be emitted:
- o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
- o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit current PREFIX only once;
- o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit current PREFIX each time
- a physical line is started. */
- int prefixing_rule;
- /* The current char to output. Updated by front-end (*format_map) when
- it is called to report front-end printer for a specified format. */
- const char *cursor;
- /* A pointer to the variable argument-list for formatting. */
- va_list *format_args;
+ bool need_newline_p;
+
+ /* Current prefixing rule. */
+ diagnostic_prefixing_rule_t prefixing_rule;
} output_state;
-/* The output buffer datatype. This is best seen as an abstract datatype. */
+/* The type of a hook that formats client-specific data (trees mostly) into
+ an output_buffer. A client-supplied formatter returns true if everything
+ goes well. */
+typedef struct output_buffer output_buffer;
+typedef bool (*printer_fn) PARAMS ((output_buffer *, text_info *));
+
+/* The output buffer datatype. This is best seen as an abstract datatype
+ whose fields should not be accessed directly by clients. */
struct output_buffer
{
- /* Internal data. These fields should not be accessed directly by
- front-ends. */
+ /* The current state of the buffer. */
+ output_state state;
/* Where to output formatted text. */
FILE* stream;
+
/* The obstack where the text is built up. */
struct obstack obstack;
+
/* The amount of characters output so far. */
int line_length;
- /* The current state of the buffer. */
- output_state state;
-};
+ /* This must be large enough to hold any printed integer or
+ floating-point value. */
+ char digit_buffer[128];
+
+ /* If non-NULL, this function formats a TEXT into the BUFFER. When called,
+ TEXT->format_spec points to a format code. FORMAT_DECODER should call
+ output_add_string (and related functions) to add data to the BUFFER.
+ FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG.
+ If the BUFFER needs additional characters from the format string, it
+ should advance the TEXT->format_spec as it goes. When FORMAT_DECODER
+ returns, TEXT->format_spec should point to the last character processed.
+ */
+ printer_fn format_decoder;
+} ;
+
+#define output_prefix(BUFFER) (BUFFER)->state.prefix
+
+/* 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
-#define output_buffer_text_cursor(BUFFER) (BUFFER)->state.cursor
-#define output_buffer_format_args(BUFFER) *((BUFFER)->state.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 diagnostic message. */
#define output_message_text(BUFFER) \
((const char *) obstack_base (&(BUFFER)->obstack))
+/* Client supplied function used to decode formats. */
+#define output_format_decoder(BUFFER) (BUFFER)->format_decoder
+
+/* Prefixing rule used in formatting a diagnostic message. */
+#define output_prefixing_rule(BUFFER) (BUFFER)->state.prefixing_rule
+
+/* Maximum characters per line in automatic line wrapping mode.
+ Zero means don't wrap lines. */
+#define output_line_cutoff(BUFFER) (BUFFER)->state.ideal_maximum_length
+
+/* True if BUFFER is in line-wrapping mode. */
+#define output_is_line_wrapping(BUFFER) (output_line_cutoff (BUFFER) > 0)
+
+#define output_formatted_scalar(BUFFER, FORMAT, INTEGER) \
+ do \
+ { \
+ sprintf ((BUFFER)->digit_buffer, FORMAT, INTEGER); \
+ output_add_string (BUFFER, (BUFFER)->digit_buffer); \
+ } \
+ while (0)
+
+/* Forward declarations. */
+typedef struct diagnostic_context diagnostic_context;
+typedef void (*diagnostic_starter_fn) PARAMS ((diagnostic_context *,
+ diagnostic_info *));
+typedef diagnostic_starter_fn diagnostic_finalizer_fn;
+
/* This data structure bundles altogether any information relevant to
the context of a diagnostic message. */
struct diagnostic_context
{
- /* The diagnostic message to output. */
- const char *message;
-
- /* A pointer to a variable list of the arguments necessary for the
- purpose of message formatting. */
- va_list *args_ptr;
+ /* Where most of the diagnostic formatting work is done. In Object
+ Oriented terms, we'll say that diagnostic_context is a sub-class of
+ output_buffer. */
+ output_buffer buffer;
- /* The name of the source file involved in the diiagnostic. */
- const char *file;
+ /* The number of times we have issued diagnostics. */
+ int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
- /* The line-location in the source file. */
- int line;
+ /* True if we should display the "warnings are being tread as error"
+ message, usually displayed once per compiler run. */
+ bool warnings_are_errors_message;
- /* Is this message a warning? */
- int warn;
+ /* True if we should raise a SIGABRT on errors. */
+ bool abort_on_error;
/* This function is called before any message is printed out. It is
responsible for preparing message prefix and such. For example, it
from "/home/gdr/src/nifty_printer.h:56:
...
*/
- void (*begin_diagnostic) PARAMS ((output_buffer *, diagnostic_context *));
+ diagnostic_starter_fn begin_diagnostic;
+
+ /* This function is called after the diagnostic message is printed. */
+ diagnostic_finalizer_fn end_diagnostic;
+
+ /* Client hook to report an internal error. */
+ void (*internal_error) PARAMS ((const char *, va_list *));
+
+ /* Function of last diagnostic message; more generally, function such that
+ if next diagnostic message is in it then we don't have to mention the
+ function name. */
+ tree last_function;
- /* This function is called after the diagnostic message is printed. */
- void (*end_diagnostic) PARAMS ((output_buffer *, diagnostic_context *));
+ /* Used to detect when input_file_stack has changed since last described. */
+ int last_module;
+ int lock;
+
/* Hook for front-end extensions. */
void *x_data;
};
-#define diagnostic_message(DC) (DC)->message
-#define diagnostic_argument_list(DC) (DC)->args_ptr
-#define diagnostic_file_location(DC) (DC)->file
-#define diagnostic_line_location(DC) (DC)->line
-#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
-/* If non-NULL, this function formats data in the BUFFER. When called,
- output_buffer_text_cursor (BUFFER) points to a format code. LANG_PRINTER
- should call output_add_string (and related functions) to add data to
- the BUFFER. LANG_PRINTER can read arguments from
- output_buffer_format_args (BUFFER) using VA_ARG. If the BUFFER needs
- additional characters from the format string, it should advance
- the output_buffer_text_cursor (BUFFER) as it goes. When LANG_PRINTER
- returns, output_buffer_text_cursor (BUFFER) should point to the last
- character processed. */
+/* Same as output_format_decoder. Works on 'diagnostic_context *'. */
+#define diagnostic_format_decoder(DC) output_format_decoder (&(DC)->buffer)
+
+/* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */
+#define diagnostic_prefixing_rule(DC) output_prefixing_rule (&(DC)->buffer)
+
+/* Maximum characters per line in automatic line wrapping mode.
+ Zero means don't wrap lines. */
+#define diagnostic_line_cutoff(DC) output_line_cutoff (&(DC)->buffer)
+
+/* True if the last function in which a diagnostic was reported is
+ different from the current one. */
+#define diagnostic_last_function_changed(DC) \
+ ((DC)->last_function != current_function_decl)
+
+/* Remember the current function as being the last one in which we report
+ a diagnostic. */
+#define diagnostic_set_last_function(DC) \
+ (DC)->last_function = current_function_decl
-extern printer_fn lang_printer;
+/* True if the last module or file in which a diagnostic was reported is
+ different from the current one. */
+#define diagnostic_last_module_changed(DC) \
+ ((DC)->last_module != input_file_stack_tick)
-extern diagnostic_starter_fn lang_diagnostic_starter;
-extern diagnostic_finalizer_fn lang_diagnostic_finalizer;
+/* Remember the current module or file as being the last one in which we
+ report a diagnostic. */
+#define diagnostic_set_last_module(DC) \
+ (DC)->last_module = input_file_stack_tick
-extern int diagnostic_message_length_per_line;
+/* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher. */
+#define diagnostic_abort_on_error(DC) \
+ (DC)->abort_on_error = true
-/* 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;
-
-/* Prototypes */
-extern void set_diagnostic_context PARAMS ((diagnostic_context *,
- const char *, va_list *,
- const char *, int, int));
-extern void set_internal_error_function PARAMS ((void (*)
- PARAMS ((const char *,
- va_list *))));
-extern void report_diagnostic PARAMS ((diagnostic_context *));
-extern void initialize_diagnostics PARAMS ((void));
-extern void reshape_diagnostic_buffer PARAMS ((void));
-extern void default_initialize_buffer PARAMS ((output_buffer *));
+ and similar functions. */
+extern diagnostic_context *global_dc;
+
+/* The total count of a KIND of diagnostics emitted so far. */
+#define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
+
+/* The number of errors that have been issued so far. Ideally, these
+ would take a diagnostic_context as an argument. */
+#define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
+/* Similarly, but for warnings. */
+#define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
+/* Similarly, but for sorrys. */
+#define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
+
+/* Returns nonzero if warnings should be emitted. */
+#define diagnostic_report_warnings_p() \
+ (!inhibit_warnings \
+ && !(in_system_header && !warn_system_headers))
+
+#define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
+
+/* Diagnostic related functions. */
+extern void diagnostic_initialize PARAMS ((diagnostic_context *));
+extern void diagnostic_report_current_module PARAMS ((diagnostic_context *));
+extern void diagnostic_report_current_function PARAMS ((diagnostic_context *));
+extern void diagnostic_flush_buffer PARAMS ((diagnostic_context *));
+extern bool diagnostic_count_diagnostic PARAMS ((diagnostic_context *,
+ diagnostic_t));
+extern void diagnostic_report_diagnostic PARAMS ((diagnostic_context *,
+ diagnostic_info *));
+extern void diagnostic_set_info PARAMS ((diagnostic_info *,
+ const char *, va_list *,
+ const char *, int,
+ diagnostic_t));
+extern char *diagnostic_build_prefix PARAMS ((diagnostic_info *));
+
+/* Pure text formatting support functions. */
extern void init_output_buffer PARAMS ((output_buffer *,
const char *, int));
-extern void flush_diagnostic_buffer PARAMS ((void));
extern void output_clear PARAMS ((output_buffer *));
-extern const char *output_get_prefix PARAMS ((const output_buffer *));
extern const char *output_last_position PARAMS ((const output_buffer *));
extern void output_set_prefix PARAMS ((output_buffer *,
const char *));
extern void output_destroy_prefix PARAMS ((output_buffer *));
-extern void output_set_maximum_length PARAMS ((output_buffer *, int));
+extern void output_set_maximum_length PARAMS ((output_buffer *, int));
extern void output_emit_prefix PARAMS ((output_buffer *));
extern void output_add_newline PARAMS ((output_buffer *));
extern void output_add_space PARAMS ((output_buffer *));
extern void output_decimal PARAMS ((output_buffer *, int));
extern void output_add_string PARAMS ((output_buffer *,
const char *));
+extern void output_add_identifier PARAMS ((output_buffer *, tree));
extern const char *output_finalize_message PARAMS ((output_buffer *));
extern void output_clear_message_text PARAMS ((output_buffer *));
extern void output_printf PARAMS ((output_buffer *, const char *,
...)) ATTRIBUTE_PRINTF_2;
-extern int output_is_line_wrapping PARAMS ((output_buffer *));
-extern void set_message_prefixing_rule PARAMS ((int));
extern void output_verbatim PARAMS ((output_buffer *, const char *,
...)) ATTRIBUTE_PRINTF_2;
extern void verbatim PARAMS ((const char *, ...))
ATTRIBUTE_PRINTF_1;
-extern char *context_as_prefix PARAMS ((const char *, int, int));
extern char *file_name_as_prefix PARAMS ((const char *));
-extern int error_module_changed PARAMS ((void));
-extern void record_last_error_module PARAMS ((void));
-extern int error_function_changed PARAMS ((void));
-extern void record_last_error_function PARAMS ((void));
-extern void report_problematic_module PARAMS ((output_buffer *));
+extern void inform PARAMS ((const char *, ...));
#endif /* ! GCC_DIAGNOSTIC_H */
OSDN Git Service
