MultiConnectorMixin.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_PPI_MultiConnectorMixin_
#define HH_SENF_PPI_MultiConnectorMixin_ 1

// Custom includes
#include <senf/config.hh>
#include <boost/ptr_container/ptr_map.hpp>
#include <boost/ptr_container/ptr_vector.hpp>
#include <boost/mpl/if.hpp>

#include "MultiConnectorMixin.mpp"
#include "MultiConnectorMixin.ih"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace ppi {

#ifdef DOXYGEN

    // For exposition only.
    // Other implementations with 0..SENF_MULTI_CONNECTOR_MAX_ARGS arguments accordingly
    // The real implementation includes a boost::enable_if condition in the return value, which is
    // used to only enable the correct overload: The first overload, if the MultiConnector is an
    // output, otherwise the second overload.

    template <class MultiConnectorSource, class Target, class A1>
    MultiConnectorSource::ConnectorType & connect(
        MultiConnectorSource & source, A1 const & a1, Target & target);

    template <class Source, class MultiConnectorTarget, class A1>
    MultiConnectorTarget::ConnectorType & connect(
        Source & source, MultiConnectorTarget & target, A1 const & a1);

    template <class MultiConnectorSource, class MultiConnectorTarget, class A1, class A2>
    std::pair<MultiConnectorSource::ConnectorType &, MultiConnectorTarget::ConnectorType &>
    connect(
        MultiConnectorSource & source, MultiConnectorTarget & target, A1 const & a1, A2 const & a2);

#else

    // Include 'senf::ppi namespace member declarations' from MultiConnectorMixin.mpp
#   define BOOST_PP_ITERATION_PARAMS_1 (4, ( \
            0, \
            SENF_MULTI_CONNECTOR_MAX_ARGS, \
            SENF_ABSOLUTE_INCLUDE_PATH(PPI/MultiConnectorMixin.mpp), \
            2 ))
#   include BOOST_PP_ITERATE()

#endif

namespace module {

    namespace detail { struct MultiConnectorMixinAccess; }

    template <class Self_,
              class ConnectorType_,
              class KeyType_ = void,
              class ContainerType_ = typename detail::MultiConnectorDefaultContainer<KeyType_, ConnectorType_>::type>
    class MultiConnectorMixin
        : private detail::MultiConnectorSelectBase<ConnectorType_>::type
    {
    public:
        typedef ConnectorType_ ConnectorType; 

    protected:
        typedef ContainerType_ ContainerType; 

        ContainerType_ & connectors();        
        ContainerType_ const & connectors() const; 

        void connectorDestroy(ConnectorType const &);

    private:

#ifndef DOXYGEN

        // Include 'MultiConnectorMixin member declaration' from MultiConnectorMixin.mpp
#       define BOOST_PP_ITERATION_PARAMS_1 (4, ( \
            0, \
            SENF_MULTI_CONNECTOR_MAX_ARGS, \
            SENF_ABSOLUTE_INCLUDE_PATH(PPI/MultiConnectorMixin.mpp), \
            1 ))
#       include BOOST_PP_ITERATE()

#endif

        void disconnected(ConnectorType_ const & c);

        friend struct detail::MultiConnectorMixinAccess;
        friend class detail::MultiConnectorWrapper<Self_,ConnectorType_>;

        ContainerType_ connectors_;
    };

#ifndef DOXYGEN

    template <class Self_,
              class ConnectorType_,
              class ContainerType_>
    class MultiConnectorMixin<Self_,ConnectorType_,void,ContainerType_>
        : private detail::MultiConnectorSelectBase<ConnectorType_>::type
    {
    public:
        typedef ConnectorType_ ConnectorType;

    protected:
        typedef ContainerType_ ContainerType;

        ContainerType_ & connectors();
        ContainerType_ const & connectors() const;

        void connectorDestroy(ConnectorType const &);

    private:

        // Include 'MultiConnectorMixin member declaration' from MultiConnectorMixin.mpp
#       define BOOST_PP_ITERATION_PARAMS_1 (4, ( \
            0, \
            SENF_MULTI_CONNECTOR_MAX_ARGS, \
            SENF_ABSOLUTE_INCLUDE_PATH(PPI/MultiConnectorMixin.mpp), \
            1 ))
#       include BOOST_PP_ITERATE()

        void disconnected(ConnectorType_ const & c);

        friend struct detail::MultiConnectorMixinAccess;
        friend class detail::MultiConnectorWrapper<Self_,ConnectorType_>;

        ContainerType_ connectors_;
    };

    template <class Self_,
              class ConnectorType_>
    class MultiConnectorMixin<Self_,ConnectorType_,void,void>
        : private detail::MultiConnectorSelectBase<ConnectorType_>::type
    {
    public:
        typedef ConnectorType_ ConnectorType;

    private:

        // Include 'MultiConnectorMixin member declaration' from MultiConnectorMixin.mpp
#       define BOOST_PP_ITERATION_PARAMS_1 (4, ( \
            0, \
            SENF_MULTI_CONNECTOR_MAX_ARGS, \
            SENF_ABSOLUTE_INCLUDE_PATH(PPI/MultiConnectorMixin.mpp), \
            1 ))
#       include BOOST_PP_ITERATE()

        void disconnected(ConnectorType_ const & c);

        friend struct detail::MultiConnectorMixinAccess;
        friend class detail::MultiConnectorWrapper<Self_,ConnectorType_>;
    };

#endif

}}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
//#include "MultiConnectorMixin.cci"
#include "MultiConnectorMixin.ct"
#include "MultiConnectorMixin.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: