/* Various declarations for language-independent diagnostics subroutines.
|
/* Various declarations for language-independent diagnostics subroutines.
|
Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
|
Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
|
2010, Free Software Foundation, Inc.
|
2010, Free Software Foundation, Inc.
|
Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
|
Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
|
|
|
This file is part of GCC.
|
This file is part of GCC.
|
|
|
GCC is free software; you can redistribute it and/or modify it under
|
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
|
the terms of the GNU General Public License as published by the Free
|
Software Foundation; either version 3, or (at your option) any later
|
Software Foundation; either version 3, or (at your option) any later
|
version.
|
version.
|
|
|
GCC is distributed in the hope that it will be useful, but WITHOUT ANY
|
GCC is distributed in the hope that it will be useful, but WITHOUT ANY
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
for more details.
|
for more details.
|
|
|
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
along with GCC; see the file COPYING3. If not see
|
along with GCC; see the file COPYING3. If not see
|
<http://www.gnu.org/licenses/>. */
|
<http://www.gnu.org/licenses/>. */
|
|
|
#ifndef GCC_DIAGNOSTIC_H
|
#ifndef GCC_DIAGNOSTIC_H
|
#define GCC_DIAGNOSTIC_H
|
#define GCC_DIAGNOSTIC_H
|
|
|
#include "pretty-print.h"
|
#include "pretty-print.h"
|
#include "options.h"
|
#include "options.h"
|
|
|
/* Constants used to discriminate diagnostics. */
|
/* Constants used to discriminate diagnostics. */
|
typedef enum
|
typedef enum
|
{
|
{
|
#define DEFINE_DIAGNOSTIC_KIND(K, msgid) K,
|
#define DEFINE_DIAGNOSTIC_KIND(K, msgid) K,
|
#include "diagnostic.def"
|
#include "diagnostic.def"
|
#undef DEFINE_DIAGNOSTIC_KIND
|
#undef DEFINE_DIAGNOSTIC_KIND
|
DK_LAST_DIAGNOSTIC_KIND
|
DK_LAST_DIAGNOSTIC_KIND
|
} diagnostic_t;
|
} diagnostic_t;
|
|
|
/* A diagnostic is described by the MESSAGE to send, the FILE and LINE of
|
/* 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
|
its context and its KIND (ice, error, warning, note, ...) See complete
|
list in diagnostic.def. */
|
list in diagnostic.def. */
|
typedef struct diagnostic_info
|
typedef struct diagnostic_info
|
{
|
{
|
text_info message;
|
text_info message;
|
location_t location;
|
location_t location;
|
unsigned int override_column;
|
unsigned int override_column;
|
/* TREE_BLOCK if the diagnostic is to be reported in some inline
|
/* TREE_BLOCK if the diagnostic is to be reported in some inline
|
function inlined into other function, otherwise NULL. */
|
function inlined into other function, otherwise NULL. */
|
tree abstract_origin;
|
tree abstract_origin;
|
/* The kind of diagnostic it is about. */
|
/* The kind of diagnostic it is about. */
|
diagnostic_t kind;
|
diagnostic_t kind;
|
/* Which OPT_* directly controls this diagnostic. */
|
/* Which OPT_* directly controls this diagnostic. */
|
int option_index;
|
int option_index;
|
} diagnostic_info;
|
} diagnostic_info;
|
|
|
/* Forward declarations. */
|
/* Forward declarations. */
|
typedef struct diagnostic_context diagnostic_context;
|
typedef struct diagnostic_context diagnostic_context;
|
typedef void (*diagnostic_starter_fn) (diagnostic_context *,
|
typedef void (*diagnostic_starter_fn) (diagnostic_context *,
|
diagnostic_info *);
|
diagnostic_info *);
|
typedef diagnostic_starter_fn diagnostic_finalizer_fn;
|
typedef diagnostic_starter_fn diagnostic_finalizer_fn;
|
|
|
/* This data structure bundles altogether any information relevant to
|
/* This data structure bundles altogether any information relevant to
|
the context of a diagnostic message. */
|
the context of a diagnostic message. */
|
struct diagnostic_context
|
struct diagnostic_context
|
{
|
{
|
/* Where most of the diagnostic formatting work is done. */
|
/* Where most of the diagnostic formatting work is done. */
|
pretty_printer *printer;
|
pretty_printer *printer;
|
|
|
/* The number of times we have issued diagnostics. */
|
/* The number of times we have issued diagnostics. */
|
int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
|
int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
|
|
|
/* True if we should display the "warnings are being tread as error"
|
/* True if we should display the "warnings are being tread as error"
|
message, usually displayed once per compiler run. */
|
message, usually displayed once per compiler run. */
|
bool issue_warnings_are_errors_message;
|
bool issue_warnings_are_errors_message;
|
|
|
/* True if it has been requested that warnings be treated as errors. */
|
/* True if it has been requested that warnings be treated as errors. */
|
bool warning_as_error_requested;
|
bool warning_as_error_requested;
|
|
|
/* For each option index that can be passed to warning() et all
|
/* For each option index that can be passed to warning() et all
|
(OPT_* from options.h), this array may contain a new kind that
|
(OPT_* from options.h), this array may contain a new kind that
|
the diagnostic should be changed to before reporting, or
|
the diagnostic should be changed to before reporting, or
|
DK_UNSPECIFIED to leave it as the reported kind, or DK_IGNORED to
|
DK_UNSPECIFIED to leave it as the reported kind, or DK_IGNORED to
|
not report it at all. N_OPTS is from <options.h>. */
|
not report it at all. N_OPTS is from <options.h>. */
|
diagnostic_t classify_diagnostic[N_OPTS];
|
diagnostic_t classify_diagnostic[N_OPTS];
|
|
|
/* True if we should print the command line option which controls
|
/* True if we should print the command line option which controls
|
each diagnostic, if known. */
|
each diagnostic, if known. */
|
bool show_option_requested;
|
bool show_option_requested;
|
|
|
/* True if we should raise a SIGABRT on errors. */
|
/* True if we should raise a SIGABRT on errors. */
|
bool abort_on_error;
|
bool abort_on_error;
|
|
|
/* This function is called before any message is printed out. It is
|
/* This function is called before any message is printed out. It is
|
responsible for preparing message prefix and such. For example, it
|
responsible for preparing message prefix and such. For example, it
|
might say:
|
might say:
|
In file included from "/usr/local/include/curses.h:5:
|
In file included from "/usr/local/include/curses.h:5:
|
from "/home/gdr/src/nifty_printer.h:56:
|
from "/home/gdr/src/nifty_printer.h:56:
|
...
|
...
|
*/
|
*/
|
diagnostic_starter_fn begin_diagnostic;
|
diagnostic_starter_fn begin_diagnostic;
|
|
|
/* This function is called after the diagnostic message is printed. */
|
/* This function is called after the diagnostic message is printed. */
|
diagnostic_finalizer_fn end_diagnostic;
|
diagnostic_finalizer_fn end_diagnostic;
|
|
|
/* Client hook to report an internal error. */
|
/* Client hook to report an internal error. */
|
void (*internal_error) (const char *, va_list *);
|
void (*internal_error) (const char *, va_list *);
|
|
|
/* Function of last diagnostic message; more generally, function such that
|
/* 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
|
if next diagnostic message is in it then we don't have to mention the
|
function name. */
|
function name. */
|
tree last_function;
|
tree last_function;
|
|
|
/* Used to detect when the input file stack has changed since last
|
/* Used to detect when the input file stack has changed since last
|
described. */
|
described. */
|
const struct line_map *last_module;
|
const struct line_map *last_module;
|
|
|
int lock;
|
int lock;
|
|
|
bool inhibit_notes_p;
|
bool inhibit_notes_p;
|
};
|
};
|
|
|
static inline void
|
static inline void
|
diagnostic_inhibit_notes (diagnostic_context * context)
|
diagnostic_inhibit_notes (diagnostic_context * context)
|
{
|
{
|
context->inhibit_notes_p = true;
|
context->inhibit_notes_p = true;
|
}
|
}
|
|
|
|
|
/* Client supplied function to announce a diagnostic. */
|
/* Client supplied function to announce a diagnostic. */
|
#define diagnostic_starter(DC) (DC)->begin_diagnostic
|
#define diagnostic_starter(DC) (DC)->begin_diagnostic
|
|
|
/* Client supplied function called after a diagnostic message is
|
/* Client supplied function called after a diagnostic message is
|
displayed. */
|
displayed. */
|
#define diagnostic_finalizer(DC) (DC)->end_diagnostic
|
#define diagnostic_finalizer(DC) (DC)->end_diagnostic
|
|
|
/* Extension hook for client. */
|
/* Extension hook for client. */
|
#define diagnostic_auxiliary_data(DC) (DC)->x_data
|
#define diagnostic_auxiliary_data(DC) (DC)->x_data
|
|
|
/* Same as pp_format_decoder. Works on 'diagnostic_context *'. */
|
/* Same as pp_format_decoder. Works on 'diagnostic_context *'. */
|
#define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder)
|
#define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder)
|
|
|
/* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */
|
/* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */
|
#define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule)
|
#define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule)
|
|
|
/* Maximum characters per line in automatic line wrapping mode.
|
/* Maximum characters per line in automatic line wrapping mode.
|
Zero means don't wrap lines. */
|
Zero means don't wrap lines. */
|
#define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
|
#define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff)
|
|
|
#define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer)
|
#define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer)
|
|
|
/* True if the last function in which a diagnostic was reported is
|
/* True if the last function in which a diagnostic was reported is
|
different from the current one. */
|
different from the current one. */
|
#define diagnostic_last_function_changed(DC, DI) \
|
#define diagnostic_last_function_changed(DC, DI) \
|
((DC)->last_function != ((DI)->abstract_origin \
|
((DC)->last_function != ((DI)->abstract_origin \
|
? (DI)->abstract_origin : current_function_decl))
|
? (DI)->abstract_origin : current_function_decl))
|
|
|
/* Remember the current function as being the last one in which we report
|
/* Remember the current function as being the last one in which we report
|
a diagnostic. */
|
a diagnostic. */
|
#define diagnostic_set_last_function(DC, DI) \
|
#define diagnostic_set_last_function(DC, DI) \
|
(DC)->last_function = (((DI) && (DI)->abstract_origin) \
|
(DC)->last_function = (((DI) && (DI)->abstract_origin) \
|
? (DI)->abstract_origin : current_function_decl)
|
? (DI)->abstract_origin : current_function_decl)
|
|
|
/* True if the last module or file in which a diagnostic was reported is
|
/* True if the last module or file in which a diagnostic was reported is
|
different from the current one. */
|
different from the current one. */
|
#define diagnostic_last_module_changed(DC, MAP) \
|
#define diagnostic_last_module_changed(DC, MAP) \
|
((DC)->last_module != MAP)
|
((DC)->last_module != MAP)
|
|
|
/* Remember the current module or file as being the last one in which we
|
/* Remember the current module or file as being the last one in which we
|
report a diagnostic. */
|
report a diagnostic. */
|
#define diagnostic_set_last_module(DC, MAP) \
|
#define diagnostic_set_last_module(DC, MAP) \
|
(DC)->last_module = MAP
|
(DC)->last_module = MAP
|
|
|
/* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher. */
|
/* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher. */
|
#define diagnostic_abort_on_error(DC) \
|
#define diagnostic_abort_on_error(DC) \
|
(DC)->abort_on_error = true
|
(DC)->abort_on_error = true
|
|
|
/* This diagnostic_context 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',
|
diagnostic messages without going through `error', `warning',
|
and similar functions. */
|
and similar functions. */
|
extern diagnostic_context *global_dc;
|
extern diagnostic_context *global_dc;
|
|
|
/* The total count of a KIND of diagnostics emitted so far. */
|
/* The total count of a KIND of diagnostics emitted so far. */
|
#define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
|
#define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)]
|
|
|
/* The number of errors that have been issued so far. Ideally, these
|
/* The number of errors that have been issued so far. Ideally, these
|
would take a diagnostic_context as an argument. */
|
would take a diagnostic_context as an argument. */
|
#define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
|
#define errorcount diagnostic_kind_count (global_dc, DK_ERROR)
|
/* Similarly, but for warnings. */
|
/* Similarly, but for warnings. */
|
#define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
|
#define warningcount diagnostic_kind_count (global_dc, DK_WARNING)
|
/* Similarly, but for sorrys. */
|
/* Similarly, but for sorrys. */
|
#define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
|
#define sorrycount diagnostic_kind_count (global_dc, DK_SORRY)
|
|
|
/* Returns nonzero if warnings should be emitted. */
|
/* Returns nonzero if warnings should be emitted. */
|
#define diagnostic_report_warnings_p(LOC) \
|
#define diagnostic_report_warnings_p(LOC) \
|
(!inhibit_warnings \
|
(!inhibit_warnings \
|
&& !(in_system_header_at (LOC) && !warn_system_headers))
|
&& !(in_system_header_at (LOC) && !warn_system_headers))
|
|
|
#define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
|
#define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D)
|
|
|
/* Override the column number to be used for reporting a
|
/* Override the column number to be used for reporting a
|
diagnostic. */
|
diagnostic. */
|
#define diagnostic_override_column(DI, COL) (DI)->override_column = (COL)
|
#define diagnostic_override_column(DI, COL) (DI)->override_column = (COL)
|
|
|
/* Diagnostic related functions. */
|
/* Diagnostic related functions. */
|
extern void diagnostic_initialize (diagnostic_context *);
|
extern void diagnostic_initialize (diagnostic_context *);
|
extern void diagnostic_report_current_module (diagnostic_context *);
|
extern void diagnostic_report_current_module (diagnostic_context *);
|
extern void diagnostic_report_current_function (diagnostic_context *,
|
extern void diagnostic_report_current_function (diagnostic_context *,
|
diagnostic_info *);
|
diagnostic_info *);
|
|
|
/* Force diagnostics controlled by OPTIDX to be kind KIND. */
|
/* Force diagnostics controlled by OPTIDX to be kind KIND. */
|
extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *,
|
extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *,
|
int /* optidx */,
|
int /* optidx */,
|
diagnostic_t /* kind */);
|
diagnostic_t /* kind */);
|
extern bool diagnostic_report_diagnostic (diagnostic_context *,
|
extern bool diagnostic_report_diagnostic (diagnostic_context *,
|
diagnostic_info *);
|
diagnostic_info *);
|
#ifdef ATTRIBUTE_GCC_DIAG
|
#ifdef ATTRIBUTE_GCC_DIAG
|
extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *,
|
extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *,
|
location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0);
|
location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0);
|
extern void diagnostic_set_info_translated (diagnostic_info *, const char *,
|
extern void diagnostic_set_info_translated (diagnostic_info *, const char *,
|
va_list *, location_t,
|
va_list *, location_t,
|
diagnostic_t)
|
diagnostic_t)
|
ATTRIBUTE_GCC_DIAG(2,0);
|
ATTRIBUTE_GCC_DIAG(2,0);
|
extern bool emit_diagnostic (diagnostic_t, location_t, int,
|
extern bool emit_diagnostic (diagnostic_t, location_t, int,
|
const char *, ...) ATTRIBUTE_GCC_DIAG(4,5);
|
const char *, ...) ATTRIBUTE_GCC_DIAG(4,5);
|
#endif
|
#endif
|
extern char *diagnostic_build_prefix (diagnostic_info *);
|
extern char *diagnostic_build_prefix (diagnostic_info *);
|
void default_diagnostic_starter (diagnostic_context *, diagnostic_info *);
|
void default_diagnostic_starter (diagnostic_context *, diagnostic_info *);
|
void default_diagnostic_finalizer (diagnostic_context *, diagnostic_info *);
|
void default_diagnostic_finalizer (diagnostic_context *, diagnostic_info *);
|
|
|
/* Pure text formatting support functions. */
|
/* Pure text formatting support functions. */
|
extern char *file_name_as_prefix (const char *);
|
extern char *file_name_as_prefix (const char *);
|
|
|
/* In tree-pretty-print.c */
|
/* In tree-pretty-print.c */
|
extern void print_declaration (pretty_printer *, tree, int, int);
|
extern void print_declaration (pretty_printer *, tree, int, int);
|
extern int dump_generic_node (pretty_printer *, tree, int, int, bool);
|
extern int dump_generic_node (pretty_printer *, tree, int, int, bool);
|
extern void print_generic_stmt (FILE *, tree, int);
|
extern void print_generic_stmt (FILE *, tree, int);
|
extern void print_generic_stmt_indented (FILE *, tree, int, int);
|
extern void print_generic_stmt_indented (FILE *, tree, int, int);
|
extern void print_generic_expr (FILE *, tree, int);
|
extern void print_generic_expr (FILE *, tree, int);
|
extern void print_generic_decl (FILE *, tree, int);
|
extern void print_generic_decl (FILE *, tree, int);
|
extern void debug_c_tree (tree);
|
extern void debug_c_tree (tree);
|
extern void dump_omp_clauses (pretty_printer *, tree, int, int);
|
extern void dump_omp_clauses (pretty_printer *, tree, int, int);
|
extern void print_call_name (pretty_printer *, tree, int);
|
extern void print_call_name (pretty_printer *, tree, int);
|
|
|
/* In gimple-pretty-print.c */
|
/* In gimple-pretty-print.c */
|
extern void debug_generic_expr (tree);
|
extern void debug_generic_expr (tree);
|
extern void debug_generic_stmt (tree);
|
extern void debug_generic_stmt (tree);
|
extern void debug_tree_chain (tree);
|
extern void debug_tree_chain (tree);
|
extern void debug_gimple_stmt (gimple);
|
extern void debug_gimple_stmt (gimple);
|
extern void debug_gimple_seq (gimple_seq);
|
extern void debug_gimple_seq (gimple_seq);
|
extern void print_gimple_seq (FILE *, gimple_seq, int, int);
|
extern void print_gimple_seq (FILE *, gimple_seq, int, int);
|
extern void print_gimple_stmt (FILE *, gimple, int, int);
|
extern void print_gimple_stmt (FILE *, gimple, int, int);
|
extern void print_gimple_expr (FILE *, gimple, int, int);
|
extern void print_gimple_expr (FILE *, gimple, int, int);
|
extern void dump_gimple_stmt (pretty_printer *, gimple, int, int);
|
extern void dump_gimple_stmt (pretty_printer *, gimple, int, int);
|
|
|
/* In toplev.c */
|
/* In toplev.c */
|
extern bool default_tree_printer (pretty_printer *, text_info *, const char *,
|
extern bool default_tree_printer (pretty_printer *, text_info *, const char *,
|
int, bool, bool, bool);
|
int, bool, bool, bool);
|
|
|
#endif /* ! GCC_DIAGNOSTIC_H */
|
#endif /* ! GCC_DIAGNOSTIC_H */
|
|
|
