IReporter.hpp

Go to the documentation of this file.

//          Copyright Dominic (DNKpp) Koepke 2024 - 2025.
// Distributed under the Boost Software License, Version 1.0.
//    (See accompanying file LICENSE_1_0.txt or copy at
//          https://www.boost.org/LICENSE_1_0.txt)
 
#ifndef MIMICPP_REPORTING_IREPORTER_HPP
#define MIMICPP_REPORTING_IREPORTER_HPP
 
#pragma once
 
#include "mimic++/Fwd.hpp"
#include "mimic++/config/Config.hpp"
#include "mimic++/reporting/Fwd.hpp"
 
#ifndef MIMICPP_DETAIL_IS_MODULE
    #include <exception>
    #include <vector>
#endif
 
MIMICPP_DETAIL_MODULE_EXPORT namespace mimicpp::reporting
{

    class IReporter
    {
    public:
        virtual ~IReporter() = default;

        [[noreturn]]
        virtual void report_no_matches(
            CallReport call,
            std::vector<NoMatchReport> noMatchReports) = 0;

        [[noreturn]]
        virtual void report_inapplicable_matches(
            CallReport call,
            std::vector<ExpectationReport> expectationReports) = 0;

        virtual void report_full_match(
            CallReport call,
            ExpectationReport expectationReport) noexcept = 0;

        virtual void report_unfulfilled_expectation(
            ExpectationReport expectationReport) = 0;

        virtual void report_error(StringT message) = 0;

        virtual void report_unhandled_exception(
            CallReport call,
            ExpectationReport expectationReport,
            std::exception_ptr exception) = 0;
 
    protected:
        [[nodiscard]]
        IReporter() = default;
 
        IReporter(const IReporter&) = default;
        IReporter& operator=(const IReporter&) = default;
        IReporter(IReporter&&) = default;
        IReporter& operator=(IReporter&&) = default;
    };


}
 
#endif