OSDN Git Service

Backport from mainline
[pf3gnuchains/gcc-fork.git] / gcc / diagnostic.h
index 07beb4b..4b1265b 100644 (file)
 /* Various declarations for language-independent diagnostics subroutines.
-   Copyright (C) 2000 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 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 3, 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 COPYING3.  If not see
+<http://www.gnu.org/licenses/>.  */
 
-#ifndef __GCC_DIAGNOSTIC_H__
-#define __GCC_DIAGNOSTIC_H__
+#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;
-
-#define DIAGNOSTICS_SHOW_PREFIX_ONCE       0x0
-#define DIAGNOSTICS_SHOW_PREFIX_NEVER      0x1
-#define DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE 0x2
-
-/* 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 encapulates an output_buffer's state.  */
-typedef struct
+/* 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
 {
-  /* The prefix for each new line.   */
-  const char *prefix;
-  /* The real upper bound of number of characters per line, taking into
-     accompt 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;
-  /* Nonzero if current PREFIX was emitted at least once.  */
-  int emitted_prefix_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;
-} output_state;
-
-/* The output buffer datatype.  This is best seen as an abstract datatype.  */
-struct output_buffer
+  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
 {
-  /* Internal data.  These fields should not be accessed directly by
-     front-ends.  */
-
-  /* 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;
-};
+  location_t location;
+  int option;
+  diagnostic_t kind;
+} diagnostic_classification_change_t;
 
-#define output_buffer_text_cursor(BUFFER) (BUFFER)->state.cursor
-#define output_buffer_format_args(BUFFER) *((BUFFER)->state.format_args)
+/*  Forward declarations.  */
+typedef void (*diagnostic_starter_fn) (diagnostic_context *,
+                                      diagnostic_info *);
+typedef diagnostic_starter_fn diagnostic_finalizer_fn;
 
-/* This data structure bundles altogether any information relevent to
+/* 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;
+  /* 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];
+
+  /* True if we should display the "warnings are being tread as error"
+     message, usually displayed once per compiler run.  */
+  bool some_warnings_are_errors;
+
+  /* True if it has been requested that warnings be treated as errors.  */
+  bool warning_as_error_requested;
+
+  /* The number of option indexes that can be passed to warning() et
+     al.  */
+  int n_opts;
 
-  /* A pointer to a variable list of the arguments necessary for the
-     purpose of  message formatting.  */
-  va_list *args_ptr;
+  /* 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 name of the source file involved in the diiagnostic.  */     
-  const char *file;
+  /* 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 line-location in the source file.  */
-  int line;
+  /* The size of the above array.  */
+  int n_classification_history;
 
-  /* Is it message a warning?  */
-  int warn;
+  /* For pragma push/pop.  */
+  int *push_list;
+  int n_push;
+
+  /* True if we should print the command line option which controls
+     each diagnostic, if known.  */
+  bool show_option_requested;
+
+  /* True if we should raise a SIGABRT on errors.  */
+  bool abort_on_error;
+
+  /* True if we should show the column number on diagnostics.  */
+  bool show_column;
+
+  /* True if pedwarns are errors.  */
+  bool pedantic_errors;
+
+  /* True if permerrors are warnings.  */
+  bool permissive;
+
+  /* The index of the option to associate with turning permerrors into
+     warnings.  */
+  int opt_permissive;
+
+  /* True if errors are fatal.  */
+  bool fatal_errors;
+
+  /* True if all warnings should be disabled.  */
+  bool dc_inhibit_warnings;
+
+  /* True if warnings should be given in system headers.  */
+  bool dc_warn_system_headers;
+
+  /* Maximum number of errors to report.  */
+  unsigned int max_errors;
 
   /* This function is called before any message is printed out.  It is
-     respondible for preparing message prefix and such.  For example, it
+     responsible for preparing message prefix and such.  For example, it
      might say:
      In file included from "/usr/local/include/curses.h:5:
                       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) (diagnostic_context *, const char *, va_list *);
 
-  /* This function is called after the diagnostic message is printed.   */
-  void (*end_diagnostic) PARAMS ((output_buffer *, diagnostic_context *));
+  /* Client hook to say whether the option controlling a diagnostic is
+     enabled.  Returns nonzero if enabled, zero if disabled.  */
+  int (*option_enabled) (int, void *);
 
-  /* Hook for front-end extensions.  */
+  /* Client information to pass as second argument to
+     option_enabled.  */
+  void *option_state;
+
+  /* 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;
 };
 
-#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
+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
+
+/* Client supplied function called after a diagnostic message is
+   displayed.  */
 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
-#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.  */
+/* Extension hooks for client.  */
+#define diagnostic_context_auxiliary_data(DC) (DC)->x_data
+#define diagnostic_info_auxiliary_data(DI) (DI)->x_data
+
+/* 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) ((DC)->printer->wrapping.rule)
+
+/* Maximum characters per line in automatic line wrapping mode.
+   Zero means don't wrap lines.  */
+#define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
 
-extern printer_fn lang_printer;
+#define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer)
 
-extern int diagnostic_message_length_per_line;
+/* 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)
 
-/* This output buffer is used by front-ends that directly output
+/* 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 simillar 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 */
-void set_diagnostic_context     PARAMS ((diagnostic_context *, const char *,
-                                         va_list *, const char *, int, int));
-void set_fatal_function                PARAMS ((void (*) PARAMS ((const char *,
-                                                          va_list *))));
-void report_diagnostic          PARAMS ((diagnostic_context *));
-void initialize_diagnostics     PARAMS ((void));
-void reshape_diagnostic_buffer  PARAMS ((void));
-void default_initialize_buffer  PARAMS ((output_buffer *));
-void init_output_buffer                PARAMS ((output_buffer *, const char *, int));
-void output_clear              PARAMS ((output_buffer *));
-const char *output_get_prefix  PARAMS ((const output_buffer *));
-void output_set_prefix         PARAMS ((output_buffer *, const char *));
-void output_destroy_prefix      PARAMS ((output_buffer *));
-void output_set_maximum_length  PARAMS ((output_buffer *, int));
-void output_emit_prefix                PARAMS ((output_buffer *));
-void output_add_newline                PARAMS ((output_buffer *));
-void output_add_space          PARAMS ((output_buffer *));
-int output_space_left          PARAMS ((const output_buffer *));
-void output_append             PARAMS ((output_buffer *, const char *,
-                                         const char *));
-void output_add_character      PARAMS ((output_buffer *, int));
-void output_decimal            PARAMS ((output_buffer *, int));
-void output_add_string         PARAMS ((output_buffer *, const char *));
-const char *output_finish      PARAMS ((output_buffer *));
-void output_printf             PARAMS ((output_buffer *, const char *,
-                                         ...)) ATTRIBUTE_PRINTF_2;
-int output_is_line_wrapping    PARAMS ((output_buffer *));
-void set_message_prefixing_rule PARAMS ((int));
-void output_verbatim            PARAMS ((output_buffer *, const char *, ...))
-     ATTRIBUTE_PRINTF_2;
-void verbatim PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1;
-
-#endif /* __GCC_DIAGNOSTIC_H__ */
+   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(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 */