1 /* Various declarations for language-independent diagnostics subroutines. 2 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 3 Free Software Foundation, Inc. 4 Contributed by Gabriel Dos Reis <gdr (at) codesourcery.com> 5 6 This file is part of GCC. 7 8 GCC is free software; you can redistribute it and/or modify it under 9 the terms of the GNU General Public License as published by the Free 10 Software Foundation; either version 3, or (at your option) any later 11 version. 12 13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY 14 WARRANTY; without even the implied warranty of MERCHANTABILITY or 15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 16 for more details. 17 18 You should have received a copy of the GNU General Public License 19 along with GCC; see the file COPYING3. If not see 20 <http://www.gnu.org/licenses/>. */ 21 22 #ifndef GCC_DIAGNOSTIC_H 23 #define GCC_DIAGNOSTIC_H 24 25 #include "pretty-print.h" 26 #include "options.h" 27 28 /* Constants used to discriminate diagnostics. */ 29 typedef 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. */ 40 typedef struct diagnostic_info 41 { 42 text_info message; 43 location_t location; 44 /* TREE_BLOCK if the diagnostic is to be reported in some inline 45 function inlined into other function, otherwise NULL. */ 46 tree abstract_origin; 47 /* The kind of diagnostic it is about. */ 48 diagnostic_t kind; 49 /* Which OPT_* directly controls this diagnostic. */ 50 int option_index; 51 } diagnostic_info; 52 53 /* Forward declarations. */ 54 typedef struct diagnostic_context diagnostic_context; 55 typedef void (*diagnostic_starter_fn) (diagnostic_context *, 56 diagnostic_info *); 57 typedef diagnostic_starter_fn diagnostic_finalizer_fn; 58 59 /* This data structure bundles altogether any information relevant to 60 the context of a diagnostic message. */ 61 struct 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 /* For each option index that can be passed to warning() et all 77 (OPT_* from options.h), this array may contain a new kind that 78 the diagnostic should be changed to before reporting, or 79 DK_UNSPECIFIED to leave it as the reported kind, or DK_IGNORED to 80 not report it at all. N_OPTS is from <options.h>. */ 81 diagnostic_t classify_diagnostic[N_OPTS]; 82 83 /* True if we should print the command line option which controls 84 each diagnostic, if known. */ 85 bool show_option_requested; 86 87 /* True if we should raise a SIGABRT on errors. */ 88 bool abort_on_error; 89 90 /* This function is called before any message is printed out. It is 91 responsible for preparing message prefix and such. For example, it 92 might say: 93 In file included from "/usr/local/include/curses.h:5: 94 from "/home/gdr/src/nifty_printer.h:56: 95 ... 96 */ 97 diagnostic_starter_fn begin_diagnostic; 98 99 /* This function is called after the diagnostic message is printed. */ 100 diagnostic_finalizer_fn end_diagnostic; 101 102 /* Client hook to report an internal error. */ 103 void (*internal_error) (const char *, va_list *); 104 105 /* Function of last diagnostic message; more generally, function such that 106 if next diagnostic message is in it then we don't have to mention the 107 function name. */ 108 tree last_function; 109 110 /* Used to detect when the input file stack has changed since last 111 described. */ 112 const struct line_map *last_module; 113 114 int lock; 115 }; 116 117 /* Client supplied function to announce a diagnostic. */ 118 #define diagnostic_starter(DC) (DC)->begin_diagnostic 119 120 /* Client supplied function called after a diagnostic message is 121 displayed. */ 122 #define diagnostic_finalizer(DC) (DC)->end_diagnostic 123 124 /* Extension hook for client. */ 125 #define diagnostic_auxiliary_data(DC) (DC)->x_data 126 127 /* Same as pp_format_decoder. Works on 'diagnostic_context *'. */ 128 #define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder) 129 130 /* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */ 131 #define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule) 132 133 /* Maximum characters per line in automatic line wrapping mode. 134 Zero means don't wrap lines. */ 135 #define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff) 136 137 #define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer) 138 139 /* True if the last function in which a diagnostic was reported is 140 different from the current one. */ 141 #define diagnostic_last_function_changed(DC, DI) \ 142 ((DC)->last_function != ((DI)->abstract_origin \ 143 ? (DI)->abstract_origin : current_function_decl)) 144 145 /* Remember the current function as being the last one in which we report 146 a diagnostic. */ 147 #define diagnostic_set_last_function(DC, DI) \ 148 (DC)->last_function = (((DI) && (DI)->abstract_origin) \ 149 ? (DI)->abstract_origin : current_function_decl) 150 151 /* True if the last module or file in which a diagnostic was reported is 152 different from the current one. */ 153 #define diagnostic_last_module_changed(DC, MAP) \ 154 ((DC)->last_module != MAP) 155 156 /* Remember the current module or file as being the last one in which we 157 report a diagnostic. */ 158 #define diagnostic_set_last_module(DC, MAP) \ 159 (DC)->last_module = MAP 160 161 /* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher. */ 162 #define diagnostic_abort_on_error(DC) \ 163 (DC)->abort_on_error = true 164 165 /* This diagnostic_context is used by front-ends that directly output 166 diagnostic messages without going through `error', `warning', 167 and similar functions. */ 168 extern diagnostic_context *global_dc; 169 170 /* The total count of a KIND of diagnostics emitted so far. */ 171 #define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)] 172 173 /* The number of errors that have been issued so far. Ideally, these 174 would take a diagnostic_context as an argument. */ 175 #define errorcount diagnostic_kind_count (global_dc, DK_ERROR) 176 /* Similarly, but for warnings. */ 177 #define warningcount diagnostic_kind_count (global_dc, DK_WARNING) 178 /* Similarly, but for sorrys. */ 179 #define sorrycount diagnostic_kind_count (global_dc, DK_SORRY) 180 181 /* Returns nonzero if warnings should be emitted. */ 182 #define diagnostic_report_warnings_p(LOC) \ 183 (!inhibit_warnings \ 184 && !(in_system_header_at (LOC) && !warn_system_headers)) 185 186 #define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D) 187 188 /* Diagnostic related functions. */ 189 extern void diagnostic_initialize (diagnostic_context *); 190 extern void diagnostic_report_current_module (diagnostic_context *); 191 extern void diagnostic_report_current_function (diagnostic_context *, 192 diagnostic_info *); 193 194 /* Force diagnostics controlled by OPTIDX to be kind KIND. */ 195 extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *, 196 int /* optidx */, 197 diagnostic_t /* kind */); 198 extern bool diagnostic_report_diagnostic (diagnostic_context *, 199 diagnostic_info *); 200 #ifdef ATTRIBUTE_GCC_DIAG 201 extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *, 202 location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0); 203 extern void diagnostic_set_info_translated (diagnostic_info *, const char *, 204 va_list *, location_t, 205 diagnostic_t) 206 ATTRIBUTE_GCC_DIAG(2,0); 207 extern bool emit_diagnostic (diagnostic_t, location_t, int, 208 const char *, ...) ATTRIBUTE_GCC_DIAG(4,5); 209 #endif 210 extern char *diagnostic_build_prefix (diagnostic_info *); 211 212 /* Pure text formatting support functions. */ 213 extern char *file_name_as_prefix (const char *); 214 215 /* In tree-pretty-print.c */ 216 extern void print_declaration (pretty_printer *, tree, int, int); 217 extern int dump_generic_node (pretty_printer *, tree, int, int, bool); 218 extern void print_generic_stmt (FILE *, tree, int); 219 extern void print_generic_stmt_indented (FILE *, tree, int, int); 220 extern void print_generic_expr (FILE *, tree, int); 221 extern void print_generic_decl (FILE *, tree, int); 222 extern void debug_c_tree (tree); 223 extern void dump_omp_clauses (pretty_printer *, tree, int, int); 224 225 /* In gimple-pretty-print.c */ 226 extern void debug_generic_expr (tree); 227 extern void debug_generic_stmt (tree); 228 extern void debug_tree_chain (tree); 229 extern void debug_gimple_stmt (gimple); 230 extern void debug_gimple_seq (gimple_seq); 231 extern void print_gimple_seq (FILE *, gimple_seq, int, int); 232 extern void print_gimple_stmt (FILE *, gimple, int, int); 233 extern void print_gimple_expr (FILE *, gimple, int, int); 234 extern void dump_gimple_stmt (pretty_printer *, gimple, int, int); 235 236 #endif /* ! GCC_DIAGNOSTIC_H */ 237
