/* Definitions for complaint handling during symbol reading in GDB.
- Copyright 1990, 1991, 1992, 1995, 1998, 2000, 2002 Free Software
- Foundation, Inc.
+ Copyright (C) 1990-2022 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA. */
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
#if !defined (COMPLAINTS_H)
#define COMPLAINTS_H
-/* Opaque object used to track the number of complaints of a
- particular category. */
-struct complaints;
+#include <unordered_set>
-/* Predefined categories. */
-extern struct complaints *symfile_complaints;
+/* Helper for complaint. */
+extern void complaint_internal (const char *fmt, ...)
+ ATTRIBUTE_PRINTF (1, 2);
-/* Register a complaint. */
-extern void complaint (struct complaints **complaints, const char *fmt,
- ...) ATTR_FORMAT (printf, 2, 3);
-extern void internal_complaint (struct complaints **complaints,
- const char *file, int line, const char *fmt,
- ...) ATTR_FORMAT (printf, 4, 5);
+/* This controls whether complaints are emitted. */
-/* Clear out / initialize all complaint counters that have ever been
- incremented. If LESS_VERBOSE is 1, be less verbose about
- successive complaints, since the messages are appearing all
- together during a command that is reporting a contiguous block of
- complaints (rather than being interleaved with other messages). If
- noisy is 1, we are in a noisy command, and our caller will print
- enough context for the user to figure it out. */
+extern int stop_whining;
-extern void clear_complaints (struct complaints **complaints,
- int less_verbose, int noisy);
+/* Return true if complaints are enabled. This can be used to guard code
+ that is used only to decide whether to issue a complaint. */
+static inline bool
+have_complaint ()
+{
+ return stop_whining > 0;
+}
+
+/* Register a complaint. This is a macro around complaint_internal to
+ avoid computing complaint's arguments when complaints are disabled.
+ Running FMT via gettext [i.e., _(FMT)] can be quite expensive, for
+ example. */
+#define complaint(FMT, ...) \
+ do \
+ { \
+ if (have_complaint ()) \
+ complaint_internal (FMT, ##__VA_ARGS__); \
+ } \
+ while (0)
-/* Deprecated interfaces to keep the old code working (until it is all
- converted to the above). Existing code such as:
+/* Clear out / initialize all complaint counters that have ever been
+ incremented. */
- struct deprecated_complaint msg = { "msg 0x%08x[sic]", 0, 0 };
- deprecated_complain (&msg, addr);
+extern void clear_complaints ();
- should be replaced by either the new call (for the singular case):
+/* A class that can handle calls to complaint from multiple threads.
+ When this is instantiated, it hooks into the complaint mechanism,
+ so the 'complaint' macro can continue to be used. When it is
+ destroyed, it issues all the complaints that have been stored. It
+ should only be instantiated in the main thread. */
- complaint (&symtab_complaints, "msg 0x%s", paddr (addr));
+class complaint_interceptor
+{
+public:
- or with a wrapper function (for the many-of case):
+ complaint_interceptor ();
+ ~complaint_interceptor ();
- msg_complaint (CORE_ADDR addr)
- { complaint (&symtab_complaints, "msg 0x%s", paddr (addr)); }
- ...
- msg_complaint (addr);
+ DISABLE_COPY_AND_ASSIGN (complaint_interceptor);
- Yes, the typo is intentional. The motivation behind this interface
- change is to eliminate all possibility of this problem re-occurring
- (it has occurred in the past and no one is sure that it isn't
- present now).
+private:
- Support for complaining about things in the symbol file that aren't
- catastrophic.
+ /* The issued complaints. */
+ std::unordered_set<std::string> m_complaints;
- Each such thing gets a counter. The first time we have the problem,
- during a symbol read, we report it. At the end of symbol reading,
- if verbose, we report how many of each problem we had. */
+ /* The saved value of deprecated_warning_hook. */
+ void (*m_saved_warning_hook) (const char *, va_list)
+ ATTRIBUTE_FPTR_PRINTF (1,0);
-struct deprecated_complaint
-{
- const char *message;
- unsigned counter_ignored;
- struct deprecated_complaint *next_ignored;
-};
+ /* A helper function that is used by the 'complaint' implementation
+ to issue a complaint. */
+ static void issue_complaint (const char *, va_list)
+ ATTRIBUTE_PRINTF (1, 0);
-extern void complain (struct deprecated_complaint *, ...);
+ /* This object. Used by the static callback function. */
+ static complaint_interceptor *g_complaint_interceptor;
+};
#endif /* !defined (COMPLAINTS_H) */
projects / binutils-gdb.git / blobdiff