binutils-gdb/gdbsupport/selftest.h
Simon Marchi c0492bea7c gdb: add selftest name completion
After the previous commit, it is easy to add completion for selftest
names.  Again, this is not particularly high value, but I rarely touched
completion, so it served as a simple example to get some practice.

Change the for_each_selftest_ftype parameter to gdb::function_view, so
that we can pass a lambda that captures things.

Change-Id: I87cac299ddca9ca7eb0ffab78342e850a98d954c
2021-10-28 11:17:45 -04:00

69 lines
2.0 KiB
C++

/* GDB self-testing.
Copyright (C) 2016-2021 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
#include "gdbsupport/array-view.h"
#include "gdbsupport/function-view.h"
/* A test is just a function that does some checks and throws an
exception if something has gone wrong. */
namespace selftests
{
/* True if selftest should run verbosely. */
extern bool run_verbose ();
/* Register a new self-test. */
extern void register_test (const std::string &name,
std::function<void(void)> function);
/* Run all the self tests. This print a message describing the number
of test and the number of failures.
If FILTERS is not empty, only run tests with names containing one of the
element of FILTERS. */
extern void run_tests (gdb::array_view<const char *const> filters,
bool verbose = false);
/* Reset GDB or GDBserver's internal state. */
extern void reset ();
using for_each_selftest_ftype
= gdb::function_view<void(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 */