GDB (xrefs)
Loading...
Searching...
No Matches
complaints.h
Go to the documentation of this file.
1/* Definitions for complaint handling during symbol reading in GDB.
2
3 Copyright (C) 1990-2023 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19
20
21#if !defined (COMPLAINTS_H)
22#define COMPLAINTS_H
23
24#include <unordered_set>
25
26/* Helper for complaint. */
27extern void complaint_internal (const char *fmt, ...)
28 ATTRIBUTE_PRINTF (1, 2);
29
30/* This controls whether complaints are emitted. */
31
32extern int stop_whining;
33
34/* Return true if complaints are enabled. This can be used to guard code
35 that is used only to decide whether to issue a complaint. */
36
37static inline bool
39{
40 return stop_whining > 0;
41}
42
43/* Register a complaint. This is a macro around complaint_internal to
44 avoid computing complaint's arguments when complaints are disabled.
45 Running FMT via gettext [i.e., _(FMT)] can be quite expensive, for
46 example. */
47#define complaint(FMT, ...) \
48 do \
49 { \
50 if (have_complaint ()) \
51 complaint_internal (FMT, ##__VA_ARGS__); \
52 } \
53 while (0)
54
55/* Clear out / initialize all complaint counters that have ever been
56 incremented. */
57
58extern void clear_complaints ();
59
60/* A class that can handle calls to complaint from multiple threads.
61 When this is instantiated, it hooks into the complaint mechanism,
62 so the 'complaint' macro can continue to be used. When it is
63 destroyed, it issues all the complaints that have been stored. It
64 should only be instantiated in the main thread. */
65
67{
68public:
69
72
74
75private:
76
77 /* The issued complaints. */
78 std::unordered_set<std::string> m_complaints;
79
80 /* The saved value of deprecated_warning_hook. */
81 void (*m_saved_warning_hook) (const char *, va_list)
82 ATTRIBUTE_FPTR_PRINTF (1,0);
83
84 /* A helper function that is used by the 'complaint' implementation
85 to issue a complaint. */
86 static void issue_complaint (const char *, va_list)
87 ATTRIBUTE_PRINTF (1, 0);
88
89 /* This object. Used by the static callback function. */
91};
92
93#endif /* !defined (COMPLAINTS_H) */
void static void static complaint_interceptor * g_complaint_interceptor
Definition complaints.h:90
std::unordered_set< std::string > m_complaints
Definition complaints.h:78
void static void issue_complaint(const char *, va_list) ATTRIBUTE_PRINTF(1
Definition complaints.c:125
DISABLE_COPY_AND_ASSIGN(complaint_interceptor)
void(* m_saved_warning_hook)(const char *, va_list) ATTRIBUTE_FPTR_PRINTF(1
Definition complaints.h:81
static bool have_complaint()
Definition complaints.h:38
void complaint_internal(const char *fmt,...) ATTRIBUTE_PRINTF(1
void int stop_whining
Definition complaints.c:36
void clear_complaints()
Definition complaints.c:74
static void ATTRIBUTE_PRINTF(1, 0)
Definition gdb_bfd.c:1154