OSDN Git Service

Backport from mainline
[pf3gnuchains/gcc-fork.git] / gcc / diagnostic.h
index 6e5d7fa..4b1265b 100644 (file)
@@ -1,12 +1,13 @@
 /* Various declarations for language-independent diagnostics subroutines.
-   Copyright (C) 2000, 2001, 2002, 2003 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
@@ -15,184 +16,120 @@ 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 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 "input.h"
-
-/* 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;
-  int err_no;  /* for %m */
-} text_info;
-
-/* Contants used to discriminate diagnostics.  */
-typedef enum
-{
-#define DEFINE_DIAGNOSTIC_KIND(K, M) K,  
-#include "diagnostic.def"
-#undef DEFINE_DIAGNOSTIC_KIND
-  DK_LAST_DIAGNOSTIC_KIND
-} diagnostic_t;
+#include "pretty-print.h"
+#include "diagnostic-core.h"
 
 /* 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
+typedef struct diagnostic_info
 {
   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;
 
-#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;
-
-/* This data structure encapsulates an output_buffer's state.  */
-typedef struct
+/* 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;
-
-  /* Current prefixing rule.  */
-  diagnostic_prefixing_rule_t prefixing_rule;
-} output_state;
+  location_t location;
+  int option;
+  diagnostic_t kind;
+} diagnostic_classification_change_t;
 
-/* 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) (output_buffer *, text_info *);
+/*  Forward declarations.  */
+typedef void (*diagnostic_starter_fn) (diagnostic_context *,
+                                      diagnostic_info *);
+typedef diagnostic_starter_fn diagnostic_finalizer_fn;
 
-/* The output buffer datatype.  This is best seen as an abstract datatype
-   whose fields should not be accessed directly by clients.  */
-struct output_buffer
+/* This data structure bundles altogether any information relevant to
+   the context of a diagnostic message.  */
+struct diagnostic_context
 {
-  /* The current state of the buffer.  */
-  output_state state;
-
-  /* Where to output formatted text.  */
-  FILE* stream;
+  /* Where most of the diagnostic formatting work is done.  */
+  pretty_printer *printer;
 
-  /* The obstack where the text is built up.  */  
-  struct obstack obstack;
-
-  /* The amount of characters output so far.  */  
-  int line_length;
+  /* The number of times we have issued diagnostics.  */
+  int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
 
-  /* This must be large enough to hold any printed integer or
-     floating-point value.  */
-  char digit_buffer[128];
+  /* True if we should display the "warnings are being tread as error"
+     message, usually displayed once per compiler run.  */
+  bool some_warnings_are_errors;
 
-  /* 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;
-} ;
+  /* True if it has been requested that warnings be treated as errors.  */
+  bool warning_as_error_requested;
 
-#define output_prefix(BUFFER) (BUFFER)->state.prefix
+  /* The number of option indexes that can be passed to warning() et
+     al.  */
+  int n_opts;
 
-/* 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
+  /* 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;
 
-/* In line-wrapping mode, whether we should start a new line.  */
-#define output_needs_newline(BUFFER) (BUFFER)->state.need_newline_p
+  /* 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;
 
-/* The amount of whitespace to be emitted when starting a new line.  */
-#define output_indentation(BUFFER) (BUFFER)->state.indent_skip
+  /* The size of the above array.  */
+  int n_classification_history;
 
-/* A pointer to the formatted diagnostic message.  */
-#define output_message_text(BUFFER) \
-   ((const char *) obstack_base (&(BUFFER)->obstack))
+  /* For pragma push/pop.  */
+  int *push_list;
+  int n_push;
 
-/* Client supplied function used to decode formats.  */
-#define output_format_decoder(BUFFER)     (BUFFER)->format_decoder
+  /* True if we should print the command line option which controls
+     each diagnostic, if known.  */
+  bool show_option_requested;
 
-/* Prefixing rule used in formatting a diagnostic message.  */
-#define output_prefixing_rule(BUFFER)  (BUFFER)->state.prefixing_rule
+  /* True if we should raise a SIGABRT on errors.  */
+  bool abort_on_error;
 
-/* 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 we should show the column number on diagnostics.  */
+  bool show_column;
 
-/* True if BUFFER is in line-wrapping mode.  */
-#define output_is_line_wrapping(BUFFER) (output_line_cutoff (BUFFER) > 0)
+  /* True if pedwarns are errors.  */
+  bool pedantic_errors;
 
-#define output_formatted_scalar(BUFFER, FORMAT, SCALAR)        \
-  do                                                           \
-    {                                                          \
-      sprintf ((BUFFER)->digit_buffer, FORMAT, SCALAR);        \
-      output_add_string (BUFFER, (BUFFER)->digit_buffer);      \
-    }                                                          \
-  while (0)
+  /* True if permerrors are warnings.  */
+  bool permissive;
 
-/*  Forward declarations.  */
-typedef struct diagnostic_context diagnostic_context;
-typedef void (*diagnostic_starter_fn) (diagnostic_context *,
-                                      diagnostic_info *);
-typedef diagnostic_starter_fn diagnostic_finalizer_fn;
+  /* The index of the option to associate with turning permerrors into
+     warnings.  */
+  int opt_permissive;
 
-/* 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;
+  /* True if errors are fatal.  */
+  bool fatal_errors;
 
-  /* The number of times we have issued diagnostics.  */
-  int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
+  /* True if all warnings should be disabled.  */
+  bool dc_inhibit_warnings;
 
-  /* True if we should display the "warnings are being tread as error"
-     message, usually displayed once per compiler run.  */
-  bool warnings_are_errors_message;
+  /* True if warnings should be given in system headers.  */
+  bool dc_warn_system_headers;
 
-  /* True if we should raise a SIGABRT on errors.  */
-  bool abort_on_error;
+  /* 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
@@ -207,22 +144,43 @@ struct diagnostic_context
   diagnostic_finalizer_fn end_diagnostic;
 
   /* Client hook to report an internal error.  */
-  void (*internal_error) (const char *, va_list *);
+  void (*internal_error) (diagnostic_context *, 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;
+  /* Client hook to say whether the option controlling a diagnostic is
+     enabled.  Returns nonzero if enabled, zero if disabled.  */
+  int (*option_enabled) (int, void *);
 
-  /* Used to detect when input_file_stack has changed since last described.  */
-  int last_module;
+  /* Client information to pass as second argument to
+     option_enabled.  */
+  void *option_state;
 
-  int lock;
-  
-  /* 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;
+
+  /* Used to detect when the input file stack has changed since last
+     described.  */
+  const struct line_map *last_module;
+
+  int lock;
+
+  bool inhibit_notes_p;
 };
 
+static inline void
+diagnostic_inhibit_notes (diagnostic_context * context)
+{
+  context->inhibit_notes_p = true;
+}
+
+
 /* Client supplied function to announce a diagnostic.  */
 #define diagnostic_starter(DC) (DC)->begin_diagnostic
 
@@ -230,38 +188,31 @@ struct diagnostic_context
    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
 
-/* Same as output_format_decoder.  Works on 'diagnostic_context *'.  */
-#define diagnostic_format_decoder(DC) output_format_decoder (&(DC)->buffer)
+/* Same as pp_format_decoder.  Works on 'diagnostic_context *'.  */
+#define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder)
 
 /* Same as output_prefixing_rule.  Works on 'diagnostic_context *'.  */
-#define diagnostic_prefixing_rule(DC) output_prefixing_rule (&(DC)->buffer)
+#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_line_cutoff (&(DC)->buffer)
+#define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
 
-/* 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
+#define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->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)
+#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) \
-  (DC)->last_module = input_file_stack_tick
+#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) \
@@ -284,46 +235,48 @@ extern diagnostic_context *global_dc;
 #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 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 *);
-extern void diagnostic_report_current_module (diagnostic_context *);
-extern void diagnostic_report_current_function (diagnostic_context *);
-extern void diagnostic_flush_buffer (diagnostic_context *);
-extern void diagnostic_report_diagnostic (diagnostic_context *,
+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 *,
-                                const char *, int, diagnostic_t);
-extern char *diagnostic_build_prefix (diagnostic_info *);
+                                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 void init_output_buffer (output_buffer *, const char *, int);
-extern void output_clear (output_buffer *);
-extern const char *output_last_position (const output_buffer *);
-extern void output_set_prefix (output_buffer *, const char *);
-extern void output_destroy_prefix (output_buffer *);
-extern void output_set_maximum_length (output_buffer *, int);
-extern void output_emit_prefix (output_buffer *);
-extern void output_add_newline (output_buffer *);
-extern void output_add_space (output_buffer *);
-extern int output_space_left (const output_buffer *);
-extern void output_append (output_buffer *, const char *, const char *);
-extern void output_add_character (output_buffer *, int);
-extern void output_decimal (output_buffer *, int);
-extern void output_add_string (output_buffer *, const char *);
-extern void output_add_identifier (output_buffer *, tree);
-extern const char *output_finalize_message (output_buffer *);
-extern void output_clear_message_text (output_buffer *);
-extern void output_printf (output_buffer *, const char *, ...)
-     ATTRIBUTE_PRINTF_2;
-extern void output_verbatim (output_buffer *, const char *, ...);
-extern void verbatim (const char *, ...);
 extern char *file_name_as_prefix (const char *);
-extern void inform (const char *, ...);
 
 #endif /* ! GCC_DIAGNOSTIC_H */