1 /* Declarations of core diagnostic functionality for code that does
2 not need to deal with diagnostic contexts or diagnostic info
4 Copyright (C) 1998-2024 Free Software Foundation, Inc.
6 This file is part of GCC.
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
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
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/>. */
22 #ifndef GCC_DIAGNOSTIC_CORE_H
23 #define GCC_DIAGNOSTIC_CORE_H
27 /* Constants used to discriminate diagnostics. */
30 #define DEFINE_DIAGNOSTIC_KIND(K, msgid, C) K,
31 #include "diagnostic.def"
32 #undef DEFINE_DIAGNOSTIC_KIND
33 DK_LAST_DIAGNOSTIC_KIND
,
34 /* This is used for tagging pragma pops in the diagnostic
35 classification history chain. */
37 /* This is used internally to note that a diagnostic is enabled
38 without mandating any specific type. */
42 /* RAII-style class for grouping related diagnostics. */
44 class auto_diagnostic_group
47 auto_diagnostic_group ();
48 ~auto_diagnostic_group ();
52 class diagnostic_metadata
; /* See diagnostic-metadata.h. */
54 extern const char *progname
;
56 extern const char *trim_filename (const char *);
58 /* If we haven't already defined a front-end-specific diagnostics
59 style, use the generic one. */
60 #ifndef GCC_DIAG_STYLE
61 #define GCC_DIAG_STYLE __gcc_tdiag__
63 /* None of these functions are suitable for ATTRIBUTE_PRINTF, because
64 each language front end can extend them with its own set of format
65 specifiers. We must use custom format checks. */
66 #if (CHECKING_P && GCC_VERSION >= 4001) || GCC_VERSION == BUILDING_GCC_VERSION
67 #define ATTRIBUTE_GCC_DIAG(m, n) __attribute__ ((__format__ (GCC_DIAG_STYLE, m, n))) ATTRIBUTE_NONNULL(m)
69 #define ATTRIBUTE_GCC_DIAG(m, n) ATTRIBUTE_NONNULL(m)
71 extern void internal_error (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2)
73 extern void internal_error_no_backtrace (const char *, ...)
74 ATTRIBUTE_GCC_DIAG(1,2) ATTRIBUTE_NORETURN
;
75 /* Pass one of the OPT_W* from options.h as the first parameter. */
76 extern bool warning (int, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
77 extern bool warning_n (location_t
, int, unsigned HOST_WIDE_INT
,
78 const char *, const char *, ...)
79 ATTRIBUTE_GCC_DIAG(4,6) ATTRIBUTE_GCC_DIAG(5,6);
80 extern bool warning_n (rich_location
*, int, unsigned HOST_WIDE_INT
,
81 const char *, const char *, ...)
82 ATTRIBUTE_GCC_DIAG(4, 6) ATTRIBUTE_GCC_DIAG(5, 6);
83 extern bool warning_at (location_t
, int, const char *, ...)
84 ATTRIBUTE_GCC_DIAG(3,4);
85 extern bool warning_at (rich_location
*, int, const char *, ...)
86 ATTRIBUTE_GCC_DIAG(3,4);
87 extern bool warning_meta (rich_location
*,
88 const diagnostic_metadata
&, int,
90 ATTRIBUTE_GCC_DIAG(4,5);
91 extern void error (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
92 extern void error_n (location_t
, unsigned HOST_WIDE_INT
, const char *,
94 ATTRIBUTE_GCC_DIAG(3,5) ATTRIBUTE_GCC_DIAG(4,5);
95 extern void error_at (location_t
, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
96 extern void error_at (rich_location
*, const char *, ...)
97 ATTRIBUTE_GCC_DIAG(2,3);
98 extern void error_meta (rich_location
*, const diagnostic_metadata
&,
100 ATTRIBUTE_GCC_DIAG(3,4);
101 extern void fatal_error (location_t
, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3)
103 /* Pass one of the OPT_W* from options.h as the second parameter. */
104 extern bool pedwarn (location_t
, int, const char *, ...)
105 ATTRIBUTE_GCC_DIAG(3,4);
106 extern bool pedwarn (rich_location
*, int, const char *, ...)
107 ATTRIBUTE_GCC_DIAG(3,4);
108 extern bool permerror (location_t
, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
109 extern bool permerror (rich_location
*, const char *,
110 ...) ATTRIBUTE_GCC_DIAG(2,3);
111 extern bool permerror_opt (location_t
, int, const char *, ...)
112 ATTRIBUTE_GCC_DIAG(3,4);
113 extern bool permerror_opt (rich_location
*, int, const char *,
114 ...) ATTRIBUTE_GCC_DIAG(3,4);
115 extern void sorry (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
116 extern void sorry_at (location_t
, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
117 extern void inform (location_t
, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
118 extern void inform (rich_location
*, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
119 extern void inform_n (location_t
, unsigned HOST_WIDE_INT
, const char *,
121 ATTRIBUTE_GCC_DIAG(3,5) ATTRIBUTE_GCC_DIAG(4,5);
122 extern void verbatim (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
123 extern bool emit_diagnostic (diagnostic_t
, location_t
, int,
124 const char *, ...) ATTRIBUTE_GCC_DIAG(4,5);
125 extern bool emit_diagnostic (diagnostic_t
, rich_location
*, int,
126 const char *, ...) ATTRIBUTE_GCC_DIAG(4,5);
127 extern bool emit_diagnostic_valist (diagnostic_t
, location_t
, int, const char *,
128 va_list *) ATTRIBUTE_GCC_DIAG (4,0);
129 extern bool emit_diagnostic_valist_meta (diagnostic_t
,
131 const diagnostic_metadata
*,
134 va_list *) ATTRIBUTE_GCC_DIAG (5,0);
135 extern bool seen_error (void);
138 /* N.B. Unlike all the others, fnotice is just gettext+fprintf, and
139 therefore it can have ATTRIBUTE_PRINTF. */
140 extern void fnotice (FILE *, const char *, ...)
144 #endif /* ! GCC_DIAGNOSTIC_CORE_H */