plugin_helpers.hpp

// This file is part of KaMPIng.
//
// Copyright 2022 The KaMPIng Authors
//
// KaMPIng is free software : you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
// version. KaMPIng 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 Lesser General Public License
// for more details.
//
// You should have received a copy of the GNU Lesser General Public License along with KaMPIng.  If not, see
// <https://www.gnu.org/licenses/>.
#pragma once
 
#include <kamping/named_parameter_filtering.hpp>
 
namespace kamping::plugin {
 
/// @brief Helper class for using CRTP for mixins. Which are used to implement kamping plugins.
///
/// Taken from https://www.fluentcpp.com/2017/05/19/crtp-helper/
/// @tparam CommunicatorClass Type of the class we want to add functionality to, i.e. `kamping::Communicator`.
/// @tparam DefaultContainerType Default container type of Communicator class
/// @tparam PluginClass Type of the plugin class template which inherits from \c PluginBase and adds functionality to \c
/// CommunicatorClass.
template <
    typename CommunicatorClass,
    template <typename...>
    typename DefaultContainerType,
    template <typename, template <typename...> typename>
    typename PluginClass>
struct PluginBase {
private:
    /// @return Reference to the underlying Communicator class.
    CommunicatorClass& to_communicator() {
        return static_cast<CommunicatorClass&>(*this);
    }
 
    /// @return const-reference to the underlying Communicator class.
    CommunicatorClass const& to_communicator() const {
        return static_cast<CommunicatorClass const&>(*this);
    }
 
    PluginBase() {}                                              ///< private constructor
    friend PluginClass<CommunicatorClass, DefaultContainerType>; // this allows only the class inheriting from \c
                                                                 // PluginBase to access the functions of this class.
};
 
/// @brief Filter the arguments \tparam Args for which the static member function `discard()` of \tparam Predicate
/// returns true and pack (move) remaining arguments into a tuple.
template <typename Predicate, typename... Args>
auto filter_args_into_tuple(Args&&... args) {
    using namespace kamping::internal;
    using ArgsToKeep = typename FilterOut<Predicate, std::tuple<Args...>>::type;
    return construct_buffer_tuple<ArgsToKeep>(args...);
}
 
} // namespace kamping::plugin