/* Various declarations for language-independent diagnostics subroutines.
- Copyright (C) 2000, 2001 Free Software Foundation, Inc.
+ Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
+ 2010, Free Software Foundation, Inc.
Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
This file is part of GCC.
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
+Software Foundation; either version 3, or (at your option) any later
version.
GCC is distributed in the hope that it will be useful, but WITHOUT ANY
for more details.
You should have received a copy of the GNU General Public License
-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. */
+along with GCC; see the file COPYING3. If not see
+<http://www.gnu.org/licenses/>. */
#ifndef GCC_DIAGNOSTIC_H
#define GCC_DIAGNOSTIC_H
-#include "obstack.h"
+#include "pretty-print.h"
+#include "diagnostic-core.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;
-
-typedef enum
+/* 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 diagnostic_info
{
-#define DEFINE_DIAGNOSTIC_KIND(K, M) K,
-#include "diagnostic.def"
-#undef DEFINE_DIAGNOSTIC_KIND
- DK_LAST_DIAGNOSTIC_KIND
-} diagnostic_t;
-
-#define pedantic_error_kind() (flag_pedantic_errors ? DK_ERROR : DK_WARNING)
-
-/* 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;
-
-/* 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 *));
-
-/* This data structure encapsulates an output_buffer's state. */
-typedef struct
+ text_info message;
+ location_t location;
+ unsigned int override_column;
+ /* Auxiliary data for client. */
+ void *x_data;
+ /* The kind of diagnostic it is about. */
+ diagnostic_t kind;
+ /* Which OPT_* directly controls this diagnostic. */
+ int option_index;
+} diagnostic_info;
+
+/* Each time a diagnostic's classification is changed with a pragma,
+ we record the change and the location of the change in an array of
+ these structs. */
+typedef struct diagnostic_classification_change_t
{
- /* 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. */
- int ideal_maximum_length;
-
- /* Indentation count. */
- int indent_skip;
-
- /* Nonzero if current PREFIX was emitted at least once. */
- bool emitted_prefix_p;
-
- /* Nonzero means one should emit a newline before outputing anything. */
- bool need_newline_p;
+ location_t location;
+ int option;
+ diagnostic_t kind;
+} diagnostic_classification_change_t;
- /* Current prefixing rule. */
- diagnostic_prefixing_rule_t 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;
+/* Forward declarations. */
+typedef void (*diagnostic_starter_fn) (diagnostic_context *,
+ diagnostic_info *);
+typedef diagnostic_starter_fn diagnostic_finalizer_fn;
- /* A pointer to the variable argument-list for formatting. */
- va_list *format_args;
+/* This data structure bundles altogether any information relevant to
+ the context of a diagnostic message. */
+struct diagnostic_context
+{
+ /* Where most of the diagnostic formatting work is done. */
+ pretty_printer *printer;
/* The number of times we have issued diagnostics. */
int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
-} output_state;
-/* The output buffer datatype. This is best seen as an abstract datatype. */
-struct output_buffer
-{
- /* Internal data. These fields should not be accessed directly by
- front-ends. */
+ /* True if we should display the "warnings are being tread as error"
+ message, usually displayed once per compiler run. */
+ bool some_warnings_are_errors;
- /* The current state of the buffer. */
- output_state state;
+ /* True if it has been requested that warnings be treated as errors. */
+ bool warning_as_error_requested;
- /* Where to output formatted text. */
- FILE* stream;
+ /* The number of option indexes that can be passed to warning() et
+ al. */
+ int n_opts;
- /* The obstack where the text is built up. */
- struct obstack obstack;
+ /* For each option index that can be passed to warning() et al
+ (OPT_* from options.h when using this code with the core GCC
+ options), this array may contain a new kind that the diagnostic
+ should be changed to before reporting, or DK_UNSPECIFIED to leave
+ it as the reported kind, or DK_IGNORED to not report it at
+ all. */
+ diagnostic_t *classify_diagnostic;
- /* The amount of characters output so far. */
- int line_length;
+ /* History of all changes to the classifications above. This list
+ is stored in location-order, so we can search it, either
+ binary-wise or end-to-front, to find the most recent
+ classification for a given diagnostic, given the location of the
+ diagnostic. */
+ diagnostic_classification_change_t *classification_history;
- /* This must be large enough to hold any printed integer or
- floating-point value. */
- char digit_buffer[128];
+ /* The size of the above array. */
+ int n_classification_history;
-/* If non-NULL, this function formats data in the BUFFER. When called,
- output_buffer_text_cursor (BUFFER) 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
- 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 FORMAT_DECODER
- returns, output_buffer_text_cursor (BUFFER) should point to the last
- character processed. */
+ /* For pragma push/pop. */
+ int *push_list;
+ int n_push;
- printer_fn format_decoder;
-};
+ /* True if we should print the command line option which controls
+ each diagnostic, if known. */
+ bool show_option_requested;
-/* 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
+ /* True if we should raise a SIGABRT on errors. */
+ bool abort_on_error;
-/* 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
+ /* True if we should show the column number on diagnostics. */
+ bool show_column;
-/* 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
+ /* True if pedwarns are errors. */
+ bool pedantic_errors;
-/* 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)
+ /* True if permerrors are warnings. */
+ bool permissive;
-/* In line-wrapping mode, whether we should start a new line. */
-#define output_needs_newline(BUFFER) (BUFFER)->state.need_newline_p
+ /* The index of the option to associate with turning permerrors into
+ warnings. */
+ int opt_permissive;
-/* The amount of whitespace to be emitted when starting a new line. */
-#define output_indentation(BUFFER) (BUFFER)->state.indent_skip
+ /* True if errors are fatal. */
+ bool fatal_errors;
-/* A pointer to the formatted diagonstic message. */
-#define output_message_text(BUFFER) \
- ((const char *) obstack_base (&(BUFFER)->obstack))
+ /* True if all warnings should be disabled. */
+ bool dc_inhibit_warnings;
-/* This data structure bundles altogether any information relevant to
- the context of a diagnostic message. */
-struct diagnostic_context
-{
- /* 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 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;
+ /* True if warnings should be given in system headers. */
+ bool dc_warn_system_headers;
- /* The name of the source file involved in the diiagnostic. */
- const char *file;
-
- /* The line-location in the source file. */
- int line;
-
- /* Is this message a warning? */
- int warn;
+ /* Maximum number of errors to report. */
+ unsigned int max_errors;
/* 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. */
- void (*end_diagnostic) PARAMS ((output_buffer *, diagnostic_context *));
+ diagnostic_finalizer_fn end_diagnostic;
+
+ /* Client hook to report an internal error. */
+ void (*internal_error) (diagnostic_context *, const char *, va_list *);
+
+ /* Client hook to say whether the option controlling a diagnostic is
+ enabled. Returns nonzero if enabled, zero if disabled. */
+ int (*option_enabled) (int, void *);
+
+ /* Client information to pass as second argument to
+ option_enabled. */
+ void *option_state;
- /* Hook for front-end extensions. */
+ /* Client hook to return the name of an option that controls a
+ diagnostic. Returns malloced memory. The first diagnostic_t
+ argument is the kind of diagnostic before any reclassification
+ (of warnings as errors, etc.); the second is the kind after any
+ reclassification. May return NULL if no name is to be printed.
+ May be passed 0 as well as the index of a particular option. */
+ char *(*option_name) (diagnostic_context *, int, diagnostic_t, diagnostic_t);
+
+ /* Auxiliary data for client. */
void *x_data;
-};
-/* The diagnostic message being formatted. */
-#define diagnostic_message(DC) (DC)->message
+ /* Used to detect when the input file stack has changed since last
+ described. */
+ const struct line_map *last_module;
-/* A pointer to the variable argument list used in a call
- to a diagonstic routine. */
-#define diagnostic_argument_list(DC) (DC)->args_ptr
+ int lock;
-/* The program file to which the diagnostic is referring to. */
-#define diagnostic_file_location(DC) (DC)->file
+ bool inhibit_notes_p;
+};
-/* The program source line referred to in the diagnostic message. */
-#define diagnostic_line_location(DC) (DC)->line
+static inline void
+diagnostic_inhibit_notes (diagnostic_context * context)
+{
+ context->inhibit_notes_p = true;
+}
-/* 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
displayed. */
#define diagnostic_finalizer(DC) (DC)->end_diagnostic
-/* Extension hook for client. */
-#define diagnostic_auxiliary_data(DC) (DC)->x_data
+/* Extension hooks for client. */
+#define diagnostic_context_auxiliary_data(DC) (DC)->x_data
+#define diagnostic_info_auxiliary_data(DI) (DI)->x_data
-/* 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
+/* Same as pp_format_decoder. Works on 'diagnostic_context *'. */
+#define diagnostic_format_decoder(DC) ((DC)->printer->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
+/* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */
+#define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule)
/* Maximum characters per line in automatic line wrapping mode.
Zero means don't wrap lines. */
-#define diagnostic_line_cutoff(DC) \
- ((output_buffer *)(DC))->state.ideal_maximum_length
+#define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
+
+#define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer)
-/* This diagnostic context is used by front-ends that directly output
+/* 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, MAP) \
+ ((DC)->last_module != MAP)
+
+/* Remember the current module or file as being the last one in which we
+ report a diagnostic. */
+#define diagnostic_set_last_module(DC, MAP) \
+ (DC)->last_module = MAP
+
+/* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher. */
+#define diagnostic_abort_on_error(DC) \
+ (DC)->abort_on_error = true
+
+/* This diagnostic_context is used by front-ends that directly output
diagnostic messages without going through `error', `warning',
and similar functions. */
extern diagnostic_context *global_dc;
-/* 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 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 an output_buffer as an argument. */
+ 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 non-zero if warnings should be emitted. */
-#define diagnostic_report_warnings_p() \
- (!inhibit_warnings \
- && !(in_system_header && !warn_system_headers))
-
-
-/* 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 diagnostic_initialize PARAMS ((diagnostic_context *));
-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_emit_prefix PARAMS ((output_buffer *));
-extern void output_add_newline PARAMS ((output_buffer *));
-extern void output_add_space PARAMS ((output_buffer *));
-extern int output_space_left PARAMS ((const output_buffer *));
-extern void output_append PARAMS ((output_buffer *, const char *,
- const char *));
-extern void output_add_character PARAMS ((output_buffer *, int));
-extern void output_decimal PARAMS ((output_buffer *, int));
-extern void output_add_string PARAMS ((output_buffer *,
- const char *));
-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 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 *));
-
-/* 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 *));
+/* Returns nonzero if warnings should be emitted. */
+#define diagnostic_report_warnings_p(DC, LOC) \
+ (!(DC)->dc_inhibit_warnings \
+ && !(in_system_header_at (LOC) && !(DC)->dc_warn_system_headers))
+
+#define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
+
+/* Override the column number to be used for reporting a
+ diagnostic. */
+#define diagnostic_override_column(DI, COL) (DI)->override_column = (COL)
+
+/* Override the option index to be used for reporting a
+ diagnostic. */
+#define diagnostic_override_option_index(DI, OPTIDX) \
+ ((DI)->option_index = (OPTIDX))
+
+/* Diagnostic related functions. */
+extern void diagnostic_initialize (diagnostic_context *, int);
+extern void diagnostic_finish (diagnostic_context *);
+extern void diagnostic_report_current_module (diagnostic_context *, location_t);
+
+/* Force diagnostics controlled by OPTIDX to be kind KIND. */
+extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *,
+ int /* optidx */,
+ diagnostic_t /* kind */,
+ location_t);
+extern void diagnostic_push_diagnostics (diagnostic_context *, location_t);
+extern void diagnostic_pop_diagnostics (diagnostic_context *, location_t);
+extern bool diagnostic_report_diagnostic (diagnostic_context *,
+ diagnostic_info *);
+#ifdef ATTRIBUTE_GCC_DIAG
+extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *,
+ location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0);
+extern void diagnostic_set_info_translated (diagnostic_info *, const char *,
+ va_list *, location_t,
+ diagnostic_t)
+ ATTRIBUTE_GCC_DIAG(2,0);
+#endif
+extern char *diagnostic_build_prefix (diagnostic_context *, diagnostic_info *);
+void default_diagnostic_starter (diagnostic_context *, diagnostic_info *);
+void default_diagnostic_finalizer (diagnostic_context *, diagnostic_info *);
+
+/* Pure text formatting support functions. */
+extern char *file_name_as_prefix (const char *);
#endif /* ! GCC_DIAGNOSTIC_H */
OSDN Git Service
