1/* Declarations of core diagnostic functionality for code that does
2 not need to deal with diagnostic contexts or diagnostic info
3 structures.
4 Copyright (C) 1998-2023 Free Software Foundation, Inc.
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_CORE_H
23#define GCC_DIAGNOSTIC_CORE_H
24
25#include "bversion.h"
26
27/* Constants used to discriminate diagnostics. */
28typedef enum
29{
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. */
36 DK_POP
37} diagnostic_t;
38
39/* RAII-style class for grouping related diagnostics. */
40
41class auto_diagnostic_group
42{
43 public:
44 auto_diagnostic_group ();
45 ~auto_diagnostic_group ();
46};
47
48/* Forward decl. */
49class diagnostic_metadata; /* See diagnostic-metadata.h. */
50
51extern const char *progname;
52
53extern const char *trim_filename (const char *);
54
55/* If we haven't already defined a front-end-specific diagnostics
56 style, use the generic one. */
57#ifndef GCC_DIAG_STYLE
58#define GCC_DIAG_STYLE __gcc_tdiag__
59#endif
60/* None of these functions are suitable for ATTRIBUTE_PRINTF, because
61 each language front end can extend them with its own set of format
62 specifiers. We must use custom format checks. */
63#if (CHECKING_P && GCC_VERSION >= 4001) || GCC_VERSION == BUILDING_GCC_VERSION
64#define ATTRIBUTE_GCC_DIAG(m, n) __attribute__ ((__format__ (GCC_DIAG_STYLE, m, n))) ATTRIBUTE_NONNULL(m)
65#else
66#define ATTRIBUTE_GCC_DIAG(m, n) ATTRIBUTE_NONNULL(m)
67#endif
68extern void internal_error (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2)
69 ATTRIBUTE_NORETURN;
70extern void internal_error_no_backtrace (const char *, ...)
71 ATTRIBUTE_GCC_DIAG(1,2) ATTRIBUTE_NORETURN;
72/* Pass one of the OPT_W* from options.h as the first parameter. */
73extern bool warning (int, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
74extern bool warning_n (location_t, int, unsigned HOST_WIDE_INT,
75 const char *, const char *, ...)
76 ATTRIBUTE_GCC_DIAG(4,6) ATTRIBUTE_GCC_DIAG(5,6);
77extern bool warning_n (rich_location *, int, unsigned HOST_WIDE_INT,
78 const char *, const char *, ...)
79 ATTRIBUTE_GCC_DIAG(4, 6) ATTRIBUTE_GCC_DIAG(5, 6);
80extern bool warning_at (location_t, int, const char *, ...)
81 ATTRIBUTE_GCC_DIAG(3,4);
82extern bool warning_at (rich_location *, int, const char *, ...)
83 ATTRIBUTE_GCC_DIAG(3,4);
84extern bool warning_meta (rich_location *,
85 const diagnostic_metadata &, int,
86 const char *, ...)
87 ATTRIBUTE_GCC_DIAG(4,5);
88extern void error (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
89extern void error_n (location_t, unsigned HOST_WIDE_INT, const char *,
90 const char *, ...)
91 ATTRIBUTE_GCC_DIAG(3,5) ATTRIBUTE_GCC_DIAG(4,5);
92extern void error_at (location_t, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
93extern void error_at (rich_location *, const char *, ...)
94 ATTRIBUTE_GCC_DIAG(2,3);
95extern void error_meta (rich_location *, const diagnostic_metadata &,
96 const char *, ...)
97 ATTRIBUTE_GCC_DIAG(3,4);
98extern void fatal_error (location_t, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3)
99 ATTRIBUTE_NORETURN;
100/* Pass one of the OPT_W* from options.h as the second parameter. */
101extern bool pedwarn (location_t, int, const char *, ...)
102 ATTRIBUTE_GCC_DIAG(3,4);
103extern bool pedwarn (rich_location *, int, const char *, ...)
104 ATTRIBUTE_GCC_DIAG(3,4);
105extern bool permerror (location_t, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
106extern bool permerror (rich_location *, const char *,
107 ...) ATTRIBUTE_GCC_DIAG(2,3);
108extern bool permerror_opt (location_t, int, const char *, ...)
109 ATTRIBUTE_GCC_DIAG(3,4);
110extern bool permerror_opt (rich_location *, int, const char *,
111 ...) ATTRIBUTE_GCC_DIAG(3,4);
112extern void sorry (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
113extern void sorry_at (location_t, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
114extern void inform (location_t, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
115extern void inform (rich_location *, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
116extern void inform_n (location_t, unsigned HOST_WIDE_INT, const char *,
117 const char *, ...)
118 ATTRIBUTE_GCC_DIAG(3,5) ATTRIBUTE_GCC_DIAG(4,5);
119extern void verbatim (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
120extern bool emit_diagnostic (diagnostic_t, location_t, int,
121 const char *, ...) ATTRIBUTE_GCC_DIAG(4,5);
122extern bool emit_diagnostic (diagnostic_t, rich_location *, int,
123 const char *, ...) ATTRIBUTE_GCC_DIAG(4,5);
124extern bool emit_diagnostic_valist (diagnostic_t, location_t, int, const char *,
125 va_list *) ATTRIBUTE_GCC_DIAG (4,0);
126extern bool seen_error (void);
127
128#ifdef BUFSIZ
129 /* N.B. Unlike all the others, fnotice is just gettext+fprintf, and
130 therefore it can have ATTRIBUTE_PRINTF. */
131extern void fnotice (FILE *, const char *, ...)
132 ATTRIBUTE_PRINTF_2;
133#endif
134
135#endif /* ! GCC_DIAGNOSTIC_CORE_H */
136

source code of gcc/diagnostic-core.h