1/* Various declarations for language-independent diagnostics subroutines. 2 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 3 2010, 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 3, 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 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. */ 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 diagnostic_info 41{ 42 text_info message; 43 location_t location; 44 unsigned int override_column; 45 /* TREE_BLOCK if the diagnostic is to be reported in some inline 46 function inlined into other function, otherwise NULL. */ 47 tree abstract_origin; 48 /* The kind of diagnostic it is about. */ 49 diagnostic_t kind; 50 /* Which OPT_* directly controls this diagnostic. */ 51 int option_index; 52} diagnostic_info; 53 54/* Forward declarations. */ 55typedef struct diagnostic_context diagnostic_context; 56typedef void (*diagnostic_starter_fn) (diagnostic_context *, 57 diagnostic_info *); 58typedef diagnostic_starter_fn diagnostic_finalizer_fn; 59 60/* This data structure bundles altogether any information relevant to 61 the context of a diagnostic message. */ 62struct diagnostic_context 63{ 64 /* Where most of the diagnostic formatting work is done. */ 65 pretty_printer *printer; 66 67 /* The number of times we have issued diagnostics. */ 68 int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND]; 69 70 /* True if we should display the "warnings are being tread as error" 71 message, usually displayed once per compiler run. */ 72 bool issue_warnings_are_errors_message; 73 74 /* True if it has been requested that warnings be treated as errors. */ 75 bool warning_as_error_requested; 76 77 /* For each option index that can be passed to warning() et all 78 (OPT_* from options.h), this array may contain a new kind that 79 the diagnostic should be changed to before reporting, or 80 DK_UNSPECIFIED to leave it as the reported kind, or DK_IGNORED to 81 not report it at all. N_OPTS is from <options.h>. */ 82 diagnostic_t classify_diagnostic[N_OPTS]; 83 84 /* True if we should print the command line option which controls 85 each diagnostic, if known. */ 86 bool show_option_requested; 87 88 /* True if we should raise a SIGABRT on errors. */ 89 bool abort_on_error; 90 91 /* This function is called before any message is printed out. It is 92 responsible for preparing message prefix and such. For example, it 93 might say: 94 In file included from "/usr/local/include/curses.h:5: 95 from "/home/gdr/src/nifty_printer.h:56: 96 ... 97 */ 98 diagnostic_starter_fn begin_diagnostic; 99 100 /* This function is called after the diagnostic message is printed. */ 101 diagnostic_finalizer_fn end_diagnostic; 102 103 /* Client hook to report an internal error. */ 104 void (*internal_error) (const char *, va_list *); 105 106 /* Function of last diagnostic message; more generally, function such that 107 if next diagnostic message is in it then we don't have to mention the 108 function name. */ 109 tree last_function; 110 111 /* Used to detect when the input file stack has changed since last 112 described. */ 113 const struct line_map *last_module; 114 115 int lock; 116 117 bool inhibit_notes_p; 118}; 119 120static inline void 121diagnostic_inhibit_notes (diagnostic_context * context) 122{ 123 context->inhibit_notes_p = true; 124} 125 126 127/* Client supplied function to announce a diagnostic. */ 128#define diagnostic_starter(DC) (DC)->begin_diagnostic 129 130/* Client supplied function called after a diagnostic message is 131 displayed. */ 132#define diagnostic_finalizer(DC) (DC)->end_diagnostic 133 134/* Extension hook for client. */ 135#define diagnostic_auxiliary_data(DC) (DC)->x_data 136 137/* Same as pp_format_decoder. Works on 'diagnostic_context *'. */ 138#define diagnostic_format_decoder(DC) ((DC)->printer->format_decoder) 139 140/* Same as output_prefixing_rule. Works on 'diagnostic_context *'. */ 141#define diagnostic_prefixing_rule(DC) ((DC)->printer->wrapping.rule) 142 143/* Maximum characters per line in automatic line wrapping mode. 144 Zero means don't wrap lines. */ 145#define diagnostic_line_cutoff(DC) ((DC)->printer->wrapping.line_cutoff) 146 147#define diagnostic_flush_buffer(DC) pp_base_flush ((DC)->printer) 148 149/* True if the last function in which a diagnostic was reported is 150 different from the current one. */ 151#define diagnostic_last_function_changed(DC, DI) \ 152 ((DC)->last_function != ((DI)->abstract_origin \ 153 ? (DI)->abstract_origin : current_function_decl)) 154 155/* Remember the current function as being the last one in which we report 156 a diagnostic. */ 157#define diagnostic_set_last_function(DC, DI) \ 158 (DC)->last_function = (((DI) && (DI)->abstract_origin) \ 159 ? (DI)->abstract_origin : current_function_decl) 160 161/* True if the last module or file in which a diagnostic was reported is 162 different from the current one. */ 163#define diagnostic_last_module_changed(DC, MAP) \ 164 ((DC)->last_module != MAP) 165 166/* Remember the current module or file as being the last one in which we 167 report a diagnostic. */ 168#define diagnostic_set_last_module(DC, MAP) \ 169 (DC)->last_module = MAP 170 171/* Raise SIGABRT on any diagnostic of severity DK_ERROR or higher. */ 172#define diagnostic_abort_on_error(DC) \ 173 (DC)->abort_on_error = true 174 175/* This diagnostic_context is used by front-ends that directly output 176 diagnostic messages without going through `error', `warning', 177 and similar functions. */ 178extern diagnostic_context *global_dc; 179 180/* The total count of a KIND of diagnostics emitted so far. */ 181#define diagnostic_kind_count(DC, DK) (DC)->diagnostic_count[(int) (DK)] 182 183/* The number of errors that have been issued so far. Ideally, these 184 would take a diagnostic_context as an argument. */ 185#define errorcount diagnostic_kind_count (global_dc, DK_ERROR) 186/* Similarly, but for warnings. */ 187#define warningcount diagnostic_kind_count (global_dc, DK_WARNING) 188/* Similarly, but for sorrys. */ 189#define sorrycount diagnostic_kind_count (global_dc, DK_SORRY) 190 191/* Returns nonzero if warnings should be emitted. */ 192#define diagnostic_report_warnings_p(LOC) \ 193 (!inhibit_warnings \ 194 && !(in_system_header_at (LOC) && !warn_system_headers)) 195 196#define report_diagnostic(D) diagnostic_report_diagnostic (global_dc, D) 197 198/* Override the column number to be used for reporting a 199 diagnostic. */ 200#define diagnostic_override_column(DI, COL) (DI)->override_column = (COL) 201 202/* Diagnostic related functions. */ 203extern void diagnostic_initialize (diagnostic_context *); 204extern void diagnostic_report_current_module (diagnostic_context *); 205extern void diagnostic_report_current_function (diagnostic_context *, 206 diagnostic_info *); 207 208/* Force diagnostics controlled by OPTIDX to be kind KIND. */ 209extern diagnostic_t diagnostic_classify_diagnostic (diagnostic_context *, 210 int /* optidx */, 211 diagnostic_t /* kind */); 212extern bool diagnostic_report_diagnostic (diagnostic_context *, 213 diagnostic_info *); 214#ifdef ATTRIBUTE_GCC_DIAG 215extern void diagnostic_set_info (diagnostic_info *, const char *, va_list *, 216 location_t, diagnostic_t) ATTRIBUTE_GCC_DIAG(2,0); 217extern void diagnostic_set_info_translated (diagnostic_info *, const char *, 218 va_list *, location_t, 219 diagnostic_t) 220 ATTRIBUTE_GCC_DIAG(2,0); 221extern bool emit_diagnostic (diagnostic_t, location_t, int, 222 const char *, ...) ATTRIBUTE_GCC_DIAG(4,5); 223#endif 224extern char *diagnostic_build_prefix (diagnostic_info *); 225void default_diagnostic_starter (diagnostic_context *, diagnostic_info *); 226void default_diagnostic_finalizer (diagnostic_context *, diagnostic_info *); 227 228/* Pure text formatting support functions. */ 229extern char *file_name_as_prefix (const char *); 230 231/* In tree-pretty-print.c */ 232extern void print_declaration (pretty_printer *, tree, int, int); 233extern int dump_generic_node (pretty_printer *, tree, int, int, bool); 234extern void print_generic_stmt (FILE *, tree, int); 235extern void print_generic_stmt_indented (FILE *, tree, int, int); 236extern void print_generic_expr (FILE *, tree, int); 237extern void print_generic_decl (FILE *, tree, int); 238extern void debug_c_tree (tree); 239extern void dump_omp_clauses (pretty_printer *, tree, int, int); 240extern void print_call_name (pretty_printer *, tree, int); 241 242/* In gimple-pretty-print.c */ 243extern void debug_generic_expr (tree); 244extern void debug_generic_stmt (tree); 245extern void debug_tree_chain (tree); 246extern void debug_gimple_stmt (gimple); 247extern void debug_gimple_seq (gimple_seq); 248extern void print_gimple_seq (FILE *, gimple_seq, int, int); 249extern void print_gimple_stmt (FILE *, gimple, int, int); 250extern void print_gimple_expr (FILE *, gimple, int, int); 251extern void dump_gimple_stmt (pretty_printer *, gimple, int, int); 252 253/* In toplev.c */ 254extern bool default_tree_printer (pretty_printer *, text_info *, const char *, 255 int, bool, bool, bool); 256 257#endif /* ! GCC_DIAGNOSTIC_H */ 258