1/* Various declarations for language-independent diagnostics subroutines. 2 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005 3 Free Software Foundation, Inc. 4 Contributed by Gabriel Dos Reis <gdr@codesourcery.com> 5 6This file is part of GCC. 7 8GCC is free software; you can redistribute it and/or modify it under 9the terms of the GNU General Public License as published by the Free 10Software Foundation; either version 2, or (at your option) any later 11version. 12 13GCC is distributed in the hope that it will be useful, but WITHOUT ANY 14WARRANTY; without even the implied warranty of MERCHANTABILITY or 15FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 16for more details. 17 18You should have received a copy of the GNU General Public License 19along with GCC; see the file COPYING. If not, write to the Free 20Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 2102110-1301, USA. */ 22 23#ifndef GCC_DIAGNOSTIC_H 24#define GCC_DIAGNOSTIC_H 25 26#include "pretty-print.h" 27 28/* Constants used to discriminate diagnostics. */ 29typedef enum 30{ 31#define DEFINE_DIAGNOSTIC_KIND(K, msgid) K, 32#include "diagnostic.def" 33#undef DEFINE_DIAGNOSTIC_KIND 34 DK_LAST_DIAGNOSTIC_KIND 35} diagnostic_t; 36 37/* A diagnostic is described by the MESSAGE to send, the FILE and LINE of 38 its context and its KIND (ice, error, warning, note, ...) See complete 39 list in diagnostic.def. */ 40typedef struct 41{ 42 text_info message; 43 location_t location; 44 /* The kind of diagnostic it is about. */ 45 diagnostic_t kind; 46 /* Which OPT_* directly controls this diagnostic. */ 47 int option_index; 48} diagnostic_info; 49 50#define pedantic_error_kind() (flag_pedantic_errors ? DK_ERROR : DK_WARNING) 51 52 53/* Forward declarations. */ 54typedef struct diagnostic_context diagnostic_context; 55typedef void (*diagnostic_starter_fn) (diagnostic_context *, 56 diagnostic_info *); 57typedef diagnostic_starter_fn diagnostic_finalizer_fn; 58 59/* This data structure bundles altogether any information relevant to 60 the context of a diagnostic message. */ 61struct diagnostic_context 62{ 63 /* Where most of the diagnostic formatting work is done. */ 64 pretty_printer *printer; 65 66 /* The number of times we have issued diagnostics. */ 67 int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND]; 68 69 /* True if we should display the "warnings are being tread as error" 70 message, usually displayed once per compiler run. */ 71 bool issue_warnings_are_errors_message; 72 73 /* True if it has been requested that warnings be treated as errors. */ 74 bool warning_as_error_requested; 75 76 /* True if we should print the command line option which controls 77 each diagnostic, if known. */ 78 bool show_option_requested; 79 80 /* True if we should raise a SIGABRT on errors. */ 81 bool abort_on_error; 82 83 /* This function is called before any message is printed out. It is 84 responsible for preparing message prefix and such. For example, it 85 might say: 86 In file included from "/usr/local/include/curses.h:5: 87 from "/home/gdr/src/nifty_printer.h:56: 88 ... 89 */ 90 diagnostic_starter_fn begin_diagnostic; 91 92 /* This function is called after the diagnostic message is printed. */ 93 diagnostic_finalizer_fn end_diagnostic; 94 95 /* Client hook to report an internal error. */ 96 void (*internal_error) (const char *, va_list *); 97 98 /* Function of last diagnostic message; more generally, function such that 99 if next diagnostic message is in it then we don't have to mention the 100 function name. */ 101 tree last_function; 102 103 /* Used to detect when input_file_stack has changed since last described. */ 104 int last_module; 105 106 int lock; 107}; 108 109/* Client supplied function to announce a diagnostic. */ 110#define diagnostic_starter(DC) (DC)->begin_diagnostic 111 112/* Client supplied function called after a diagnostic message is 113 displayed. */ 114#define diagnostic_finalizer(DC) (DC)->end_diagnostic 115 116/* Extension hook for client. */ 117#define diagnostic_auxiliary_data(DC) (DC)->x_data 118 119/* Same as pp_format_decoder. Works on 'diagnostic_context *'. */ 120#define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder) 121 122/* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */ 123#define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule) 124 125/* Maximum characters per line in automatic line wrapping mode. 126 Zero means don't wrap lines. */ 127#define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff) 128 129#define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer) 130 131/* True if the last function in which a diagnostic was reported is 132 different from the current one. */ 133#define diagnostic_last_function_changed(DC) \ 134 ((DC)->last_function != current_function_decl) 135 136/* Remember the current function as being the last one in which we report 137 a diagnostic. */ 138#define diagnostic_set_last_function(DC) \ 139 (DC)->last_function = current_function_decl 140 141/* True if the last module or file in which a diagnostic was reported is 142 different from the current one. */ 143#define diagnostic_last_module_changed(DC) \ 144 ((DC)->last_module != input_file_stack_tick) 145 146/* Remember the current module or file as being the last one in which we 147 report a diagnostic. */ 148#define diagnostic_set_last_module(DC) \ 149 (DC)->last_module = input_file_stack_tick 150 151/* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher. */ 152#define diagnostic_abort_on_error(DC) \ 153 (DC)->abort_on_error = true 154 155/* This diagnostic_context is used by front-ends that directly output 156 diagnostic messages without going through `error', `warning', 157 and similar functions. */ 158extern diagnostic_context *global_dc; 159 160/* The total count of a KIND of diagnostics emitted so far. */ 161#define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)] 162 163/* The number of errors that have been issued so far. Ideally, these 164 would take a diagnostic_context as an argument. */ 165#define errorcount diagnostic_kind_count (global_dc, DK_ERROR) 166/* Similarly, but for warnings. */ 167#define warningcount diagnostic_kind_count (global_dc, DK_WARNING) 168/* Similarly, but for sorrys. */ 169#define sorrycount diagnostic_kind_count (global_dc, DK_SORRY) 170 171/* Returns nonzero if warnings should be emitted. */ 172#define diagnostic_report_warnings_p() \ 173 (!inhibit_warnings \ 174 && !(in_system_header && !warn_system_headers)) 175 176#define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D) 177 178/* Diagnostic related functions. */ 179extern void diagnostic_initialize (diagnostic_context *); 180extern void diagnostic_report_current_module (diagnostic_context *); 181extern void diagnostic_report_current_function (diagnostic_context *); 182extern void diagnostic_report_diagnostic (diagnostic_context *, 183 diagnostic_info *); 184#ifdef ATTRIBUTE_GCC_DIAG 185extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *, 186 location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0); 187extern void diagnostic_set_info_translated (diagnostic_info *, const char *, 188 va_list *, location_t, 189 diagnostic_t) 190 ATTRIBUTE_GCC_DIAG(2,0); 191#endif 192extern char *diagnostic_build_prefix (diagnostic_info *); 193 194/* Pure text formatting support functions. */ 195extern char *file_name_as_prefix (const char *); 196 197/* In tree-pretty-print.c */ 198extern int dump_generic_node (pretty_printer *, tree, int, int, bool); 199extern void print_generic_stmt (FILE *, tree, int); 200extern void print_generic_stmt_indented (FILE *, tree, int, int); 201extern void print_generic_expr (FILE *, tree, int); 202extern void print_generic_decl (FILE *, tree, int); 203 204extern void debug_generic_expr (tree); 205extern void debug_generic_stmt (tree); 206extern void debug_c_tree (tree); 207#endif /* ! GCC_DIAGNOSTIC_H */ 208