/* Support for complaint handling during symbol reading in GDB.
- Copyright (C) 1990, 1991, 1992 Free Software Foundation, Inc.
-This file is part of GDB.
+ Copyright (C) 1990-2022 Free Software Foundation, Inc.
-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
-(at your option) any later version.
+ This file is part of GDB.
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
+ 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 3 of the License, or
+ (at your option) any later version.
-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. */
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ 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, see <http://www.gnu.org/licenses/>. */
#include "defs.h"
#include "complaints.h"
+#include "command.h"
#include "gdbcmd.h"
+#include "gdbsupport/selftest.h"
+#include <unordered_map>
-extern void _initialize_complaints PARAMS ((void));
-
-/* Structure to manage complaints about symbol file contents. */
-
-struct complaint complaint_root[1] = {
- {
- (char *) NULL, /* Complaint message */
- 0, /* Complaint counter */
- complaint_root /* Next complaint. */
- }
-};
-
-/* How many complaints about a particular thing should be printed before
- we stop whining about it? Default is no whining at all, since so many
- systems have ill-constructed symbol files. */
-
-static unsigned int stop_whining = 0;
-
-/* Should each complaint be self explanatory, or should we assume that
- a series of complaints is being produced?
- case 0: self explanatory message.
- case 1: First message of a series that must start off with explanation.
- case 2: Subsequent message, when user already knows we are reading
- symbols and we can just state our piece. */
-
-static int complaint_series = 0;
+/* Map format strings to counters. */
-/* External variables and functions referenced. */
+static std::unordered_map<const char *, int> counters;
-extern int info_verbose;
+/* How many complaints about a particular thing should be printed
+ before we stop whining about it? Default is no whining at all,
+ since so many systems have ill-constructed symbol files. */
-\f
-/* Functions to handle complaints during symbol reading. */
+int stop_whining = 0;
-/* Print a complaint about the input symbols, and link the complaint block
- into a chain for later handling. */
+/* See complaints.h. */
-/* VARARGS */
void
-#ifdef ANSI_PROTOTYPES
-complain (struct complaint *complaint, ...)
-#else
-complain (va_alist)
- va_dcl
-#endif
+complaint_internal (const char *fmt, ...)
{
va_list args;
-#ifdef ANSI_PROTOTYPES
- va_start (args, complaint);
-#else
- struct complaint *complaint;
- va_start (args);
- complaint = va_arg (args, struct complaint *);
-#endif
+ if (++counters[fmt] > stop_whining)
+ return;
- complaint -> counter++;
- if (complaint -> next == NULL)
- {
- complaint -> next = complaint_root -> next;
- complaint_root -> next = complaint;
- }
- if (complaint -> counter > stop_whining)
- {
- return;
- }
- wrap_here ("");
+ va_start (args, fmt);
- switch (complaint_series + (info_verbose << 1))
+ if (deprecated_warning_hook)
+ (*deprecated_warning_hook) (fmt, args);
+ else
{
-
- /* Isolated messages, must be self-explanatory. */
- case 0:
- begin_line ();
- puts_filtered ("During symbol reading, ");
- wrap_here ("");
- vprintf_filtered (complaint -> message, args);
- puts_filtered (".\n");
- break;
-
- /* First of a series, without `set verbose'. */
- case 1:
- begin_line ();
- puts_filtered ("During symbol reading...");
- vprintf_filtered (complaint -> message, args);
- puts_filtered ("...");
- wrap_here ("");
- complaint_series++;
- break;
-
- /* Subsequent messages of a series, or messages under `set verbose'.
- (We'll already have produced a "Reading in symbols for XXX..."
- message and will clean up at the end with a newline.) */
- default:
- vprintf_filtered (complaint -> message, args);
- puts_filtered ("...");
- wrap_here ("");
+ fputs_filtered (_("During symbol reading: "), gdb_stderr);
+ vfprintf_filtered (gdb_stderr, fmt, args);
+ fputs_filtered ("\n", gdb_stderr);
}
- /* If GDB dumps core, we'd like to see the complaints first. Presumably
- GDB will not be sending so many complaints that this becomes a
- performance hog. */
- gdb_flush (gdb_stdout);
+
va_end (args);
}
-/* Clear out all complaint counters that have ever been incremented.
- If sym_reading is 1, be less verbose about successive complaints,
- since the messages are appearing all together during a command that
- reads symbols (rather than scattered around as psymtabs get fleshed
- out into symtabs at random times). If noisy is 1, we are in a
- noisy symbol reading command, and our caller will print enough
- context for the user to figure it out. */
+/* See complaints.h. */
void
-clear_complaints (sym_reading, noisy)
- int sym_reading;
- int noisy;
+clear_complaints ()
{
- struct complaint *p;
+ counters.clear ();
+}
- for (p = complaint_root -> next; p != complaint_root; p = p -> next)
- {
- p -> counter = 0;
- }
+static void
+complaints_show_value (struct ui_file *file, int from_tty,
+ struct cmd_list_element *cmd, const char *value)
+{
+ fprintf_filtered (file, _("Max number of complaints about incorrect"
+ " symbols is %s.\n"),
+ value);
+}
- if (!sym_reading && !noisy && complaint_series > 1)
- {
- /* Terminate previous series, since caller won't. */
- puts_filtered ("\n");
- }
+#if GDB_SELF_TEST
+namespace selftests {
+
+/* Entry point for complaints unit tests. */
- complaint_series = sym_reading ? 1 + noisy : 0;
+static void
+test_complaints ()
+{
+ std::unordered_map<const char *, int> tmp;
+ scoped_restore reset_counters = make_scoped_restore (&counters, tmp);
+ scoped_restore reset_stop_whining = make_scoped_restore (&stop_whining, 2);
+
+#define CHECK_COMPLAINT(STR, CNT) \
+ do \
+ { \
+ std::string output; \
+ execute_fn_to_string (output, []() { complaint (STR); }, false); \
+ std::string expected \
+ = _("During symbol reading: ") + std::string (STR "\n"); \
+ SELF_CHECK (output == expected); \
+ SELF_CHECK (counters[STR] == CNT); \
+ } while (0)
+
+#define CHECK_COMPLAINT_SILENT(STR, CNT) \
+ do \
+ { \
+ std::string output; \
+ execute_fn_to_string (output, []() { complaint (STR); }, false); \
+ SELF_CHECK (output.empty ()); \
+ SELF_CHECK (counters[STR] == CNT); \
+ } while (0)
+
+ CHECK_COMPLAINT ("maintenance complaint 0", 1);
+ CHECK_COMPLAINT ("maintenance complaint 0", 2);
+ CHECK_COMPLAINT_SILENT ("maintenance complaint 0", 3);
+ CHECK_COMPLAINT ("maintenance complaint 1", 1);
+ clear_complaints ();
+ CHECK_COMPLAINT ("maintenance complaint 0", 1);
+
+#undef CHECK_COMPLAINT
+#undef CHECK_COMPLAINT_SILENT
}
+
+} // namespace selftests
+#endif /* GDB_SELF_TEST */
+
+void _initialize_complaints ();
void
_initialize_complaints ()
{
- add_show_from_set
- (add_set_cmd ("complaints", class_support, var_zinteger,
- (char *) &stop_whining,
- "Set max number of complaints about incorrect symbols.",
- &setlist),
- &showlist);
-
+ add_setshow_zinteger_cmd ("complaints", class_support,
+ &stop_whining, _("\
+Set max number of complaints about incorrect symbols."), _("\
+Show max number of complaints about incorrect symbols."), NULL,
+ NULL, complaints_show_value,
+ &setlist, &showlist);
+
+#if GDB_SELF_TEST
+ selftests::register_test ("complaints", selftests::test_complaints);
+#endif /* GDB_SELF_TEST */
}
projects / binutils-gdb.git / blobdiff