YiSignal.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2020. All rights reserved.
#ifndef _YI_SIGNAL_H_
#define _YI_SIGNAL_H_

#include "signal/YiSignalBase.h"

#include <functional>

template<typename... SignalTypes>
class CYISignal : public CYISignalBase
{
public:
    using CYISignalBase::Disconnect;
    using CYISignalBase::IsConnected;

    template<typename HandlerType, typename SlotReturnType, typename... SlotTypes>
    bool IsConnected(const HandlerType &rSignalHandler, SlotReturnType (HandlerType::*const pSlot)(SlotTypes...)) const;

    template<typename HandlerType, typename SlotReturnType, typename... SlotTypes>
    inline bool IsConnected(const HandlerType &rSignalHandler, SlotReturnType (HandlerType::*const pSlot)(SlotTypes...) const) const;

    template<typename SlotReturnType, typename... SlotTypes>
    bool IsConnected(SlotReturnType (*const pSlot)(SlotTypes...)) const;

    template<typename HandlerType, typename SlotHandlerType, typename SlotReturnType, typename... SlotTypes>
    CYISignalConnectionID Connect(HandlerType &rSignalHandler, SlotReturnType (SlotHandlerType::*const pSlot)(SlotTypes...), EYIConnectionType type = EYIConnectionType::Auto);

    template<typename HandlerType, typename SlotHandlerType, typename SlotReturnType, typename... SlotTypes>
    inline CYISignalConnectionID Connect(const HandlerType &rSignalHandler, SlotReturnType (SlotHandlerType::*const pSlot)(SlotTypes...) const, EYIConnectionType type = EYIConnectionType::Auto);

    template<typename SlotReturnType, typename... SlotTypes>
    CYISignalConnectionID Connect(SlotReturnType (*const pSlot)(SlotTypes...), EYIConnectionType type = EYIConnectionType::Auto, CYIThreadHandle threadAffinity = CYIThread::GetCurrentThreadId());

    template<typename HandlerType, typename SlotHandlerType, typename SlotReturnType, typename... SlotTypes>
    CYISignalConnectionID Connect(HandlerType &rSignalHandler, std::function<SlotReturnType(SlotHandlerType &, SlotTypes...)> slot, EYIConnectionType type = EYIConnectionType::Auto);

    template<typename CallableType>
    CYISignalConnectionID Connect(CallableType &&callable, EYIConnectionType type = EYIConnectionType::Auto, CYIThreadHandle threadAffinity = CYIThread::GetCurrentThreadId());

    template<typename CallableType>
    CYISignalConnectionID Connect(const CYISignalHandler &rSignalHandler, CallableType callable, EYIConnectionType type = EYIConnectionType::Auto);

    template<typename... OtherSignalTypes>
    CYISignalConnectionID Connect(CYISignal<OtherSignalTypes...> &slotSignal, EYIConnectionType type = EYIConnectionType::Auto);

    inline void operator()(const typename std::decay<SignalTypes>::type &... param) const;

    inline void Emit(const typename std::decay<SignalTypes>::type &... params) const;

    template<class SlotReturnType, typename SlotHandlerType, typename... SlotTypes>
    void Disconnect(CYISignalHandler &rSignalHandler, SlotReturnType (SlotHandlerType::*const pSlot)(SlotTypes...));

    template<class SlotReturnType, typename SlotHandlerType, typename... SlotTypes>
    inline void Disconnect(CYISignalHandler &rSignalHandler, SlotReturnType (SlotHandlerType::*const pSlot)(SlotTypes...) const);

    template<typename SlotReturnType, typename... SlotTypes>
    void Disconnect(SlotReturnType (*const pSlot)(SlotTypes...));

#ifndef DOXY
    // The following definitions exist only to generate more understandable compilation errors.
    template<typename HandlerType, typename SlotHandlerType, typename SlotReturnType, typename... SlotTypes>
    CYISignalConnectionID Connect(const HandlerType &rSignalHandler, SlotReturnType (SlotHandlerType::*const pSlot)(SlotTypes...), EYIConnectionType type = EYIConnectionType::Auto);

    template<typename SlotHandlerType, typename SlotReturnType, typename... SlotTypes>
    CYISignalConnectionID Connect(SlotReturnType (SlotHandlerType::*const pSlot)(SlotTypes...), EYIConnectionType type = EYIConnectionType::Auto);

    template<typename SlotHandlerType, typename SlotReturnType, typename... SlotTypes>
    CYISignalConnectionID Connect(SlotReturnType (SlotHandlerType::*const pSlot)(SlotTypes...) const, EYIConnectionType type = EYIConnectionType::Auto);
#endif

protected:
    void EmitForConnection(CYISignalConnectionWrapper &connection, const CYIThreadHandle &currentThreadID, EYIConnectionType connectionType, const typename std::decay<SignalTypes>::type &... params);

    virtual void Emitted();

    virtual void ConnectionAdded(CYISignalConnectionWrapper &connection);

private:
    template<typename SlotHandlerType, typename SlotReturnType, typename... SlotTypes>
    size_t FindConnectionIndex(const CYISignalHandler &rSignalHandler, SlotReturnType (SlotHandlerType::*const pSlot)(SlotTypes...)) const;

    template<typename SlotHandlerType, typename SlotReturnType, typename... SlotTypes>
    size_t FindConnectionIndex(const CYISignalHandler &rSignalHandler, SlotReturnType (SlotHandlerType::*const pSlot)(SlotTypes...) const) const;

    template<typename SlotReturnType, typename... SlotTypes>
    size_t FindConnectionIndex(SlotReturnType (*const pSlot)(SlotTypes...)) const;

    template<typename CallableType>
    typename std::enable_if<(sizeof(CallableType) <= CYISignalConnectionWrapper::s_smallLambdaStorageBytes), void>::type EmplaceConnection(SignalObjects *pSignalObjects, const CYISignalHandler *pSignalHandler, CYIThreadHandle threadAffinity, CallableType &&callable, EYIConnectionType type);

    template<typename CallableType>
    typename std::enable_if<(sizeof(CallableType) > CYISignalConnectionWrapper::s_smallLambdaStorageBytes), void>::type EmplaceConnection(SignalObjects *pSignalObjects, const CYISignalHandler *pSignalHandler, CYIThreadHandle threadAffinity, CallableType &&callable, EYIConnectionType type);

    void EmitInternal(const typename std::decay<SignalTypes>::type &... params);
};

#include "signal/internal/YiSignal.inl"

#endif /* _YI_SIGNAL_H_ */