summaryrefslogtreecommitdiff
path: root/gdbsupport/selftest.h
diff options
context:
space:
mode:
Diffstat (limited to 'gdbsupport/selftest.h')
-rw-r--r--gdbsupport/selftest.h73
1 files changed, 73 insertions, 0 deletions
diff --git a/gdbsupport/selftest.h b/gdbsupport/selftest.h
new file mode 100644
index 00000000000..1c47fe1448b
--- /dev/null
+++ b/gdbsupport/selftest.h
@@ -0,0 +1,73 @@
+/* GDB self-testing.
+ Copyright (C) 2016-2020 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 3 of the License, or
+ (at your option) any later version.
+
+ 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/>. */
+
+#ifndef COMMON_SELFTEST_H
+#define COMMON_SELFTEST_H
+
+/* A test is just a function that does some checks and throws an
+ exception if something has gone wrong. */
+
+typedef void self_test_function (void);
+
+namespace selftests
+{
+
+/* Interface for the various kinds of selftests. */
+
+struct selftest
+{
+ virtual ~selftest () = default;
+ virtual void operator() () const = 0;
+};
+
+/* Register a new self-test. */
+
+extern void register_test (const std::string &name, selftest *test);
+
+/* Register a new self-test. */
+
+extern void register_test (const std::string &name,
+ self_test_function *function);
+
+/* Run all the self tests. This print a message describing the number
+ of test and the number of failures.
+
+ If FILTER is not NULL and not empty, only tests with names containing FILTER
+ will be ran. */
+
+extern void run_tests (const char *filter);
+
+/* Reset GDB or GDBserver's internal state. */
+extern void reset ();
+
+typedef void for_each_selftest_ftype (const std::string &name);
+
+/* Call FUNC for each registered selftest. */
+
+extern void for_each_selftest (for_each_selftest_ftype func);
+}
+
+/* Check that VALUE is true, and, if not, throw an exception. */
+
+#define SELF_CHECK(VALUE) \
+ do { \
+ if (!(VALUE)) \
+ error (_("self-test failed at %s:%d"), __FILE__, __LINE__); \
+ } while (0)
+
+#endif /* COMMON_SELFTEST_H */