test/hook_8hpp_source.html

// SPDX-FileCopyrightText: 2026 Klaus Reimer <k@ailis.de>

// SPDX-License-Identifier: MIT


#pragma once


#include <source_location>

#include <string>

#include <string_view>


#include <kaycxx/test/callback.hpp>

#include <kaycxx/test/run_options.hpp>


namespace kaycxx::test {


class hook {

public:

    explicit hook(std::string_view name, callback body, std::source_location location = std::source_location::current());


    void run(run_options const& options = run_options());


private:

    callback body_;


    std::string name_;


    std::source_location location_;

};


} // namespace kaycxx::test

callback.hpp
Defines the callback type used by the test framework.

kaycxx::test::hook
Registered setup or teardown hook.
Definition hook.hpp:25

kaycxx::test::hook::hook
hook(std::string_view name, callback body, std::source_location location=std::source_location::current())
Creates a hook.

kaycxx::test::hook::run
void run(run_options const &options=run_options())
Runs the hook and wraps thrown exceptions in a hook error with source location information.

kaycxx::test
Unit test framework functions and types.
Definition test.hpp:15

kaycxx::test::callback
std::move_only_function< void()> callback
Callable block used by tests, suites, and hooks.
Definition callback.hpp:20

run_options.hpp
Defines test execution options.

kaycxx::test::run_options
Configures the execution of registered tests.
Definition run_options.hpp:14