Collector.hpp

Go to the documentation of this file.

//          Copyright Dominic (DNKpp) Koepke 2026.
// 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_EXPECTATION_COLLECTOR_HPP
#define MIMICPP_EXPECTATION_COLLECTOR_HPP
 
#pragma once
 
#include "mimic++/Fwd.hpp"
#include "mimic++/config/Config.hpp"
#include "mimic++/expectation/Owner.hpp"
 
#ifndef MIMICPP_DETAIL_IS_MODULE
    #include <deque>
    #include <utility>
#endif
 
MIMICPP_DETAIL_MODULE_EXPORT namespace mimicpp::expectation
{
    class Collector
    {
    public:
        Collector(Collector const&) = delete;

        Collector& operator=(Collector const&) = delete;

        ~Collector() noexcept(false)
        {
            auto expectations = std::exchange(m_Expectations, {});
            while (!expectations.empty())
            {
                // Prevent the `pop_front() noexcept` from raising an exception and thus terminating.
                auto const expectation = std::move(expectations.front());
                expectations.pop_front();
            }
        }

        [[nodiscard]]
        Collector() = default;

        [[nodiscard]]
        Collector(Collector&&) = default;

        Collector& operator=(Collector&&) = default;

        Collector& attach(ScopedExpectation&& builder) &
        {
            m_Expectations.emplace_back(std::move(builder));
 
            return *this;
        }

        Collector& operator+=(ScopedExpectation&& builder) &
        {
            return attach(std::move(builder));
        }

        [[nodiscard]]
        constexpr std::deque<ScopedExpectation> const& expectations() const noexcept
        {
            return m_Expectations;
        }
 
    private:
        std::deque<ScopedExpectation> m_Expectations{};
    };
}
 
#endif