example.cpp

/**
 *  @file example.cpp
 *  @brief Example coding demonstrating the usage of EasyDelegate.
 *  @date 7/11/2015
 *  @author <a href="https://dx.no-ip.org">Robert MacGregor</a>
 *
 *  @copyright This software is licensed under the MIT license. Please refer to LICENSE.txt for more
 *  information.
 */

#define EASYDELEGATE_FORCE_INLINE

#include <set>              // std::set
#include <unordered_set>    // std::unordered_set
#include <iostream>         // std::cout, std::endl

#include <easydelegate/easydelegate.hpp>

using namespace std;

unsigned int myStaticIntMethod(const char* str, const float& flt, const double& dbl)
{
    cout << "myStaticIntMethod: " << str << "," << flt << "," << dbl << endl;
    return 5;
}

void myStaticVoidMethod(const float& flt, const char* str, const double& dbl)
{
    cout << "myStaticVoidMethod: " << flt << "," << str << "," << dbl << endl;
}

class MyCustomClass
{
    public:
        unsigned int myMemberMethod(const char* str, const float& flt, const double &dbl)
        {
            cout << "MyCustomClass::myMemberMethod: " << str << "," << flt << "," << dbl << endl;
            return 2;
        }
};

int main(int argc, char *argv[])
{
    // You can typedef the actual delegate type to some type that's specific to your project
    typedef EasyDelegate::DelegateSet<unsigned int, const char*, const float&, const double&> MyEventType;
    typedef EasyDelegate::DelegateSet<void, const float&, const char*, const double&> VoidEventType;

    MyEventType myDelegateSet;
    MyCustomClass *myCustomClassInstance = new MyCustomClass();

    // Register both our static function and our member function
    myDelegateSet.push_back(new MyEventType::StaticDelegateType(myStaticIntMethod));
    myDelegateSet.push_back(new MyEventType::MemberDelegateType<MyCustomClass>(&MyCustomClass::myMemberMethod, myCustomClassInstance));
    myDelegateSet.push_back(new MyEventType::FunctionDelegateType([](const char* str, const float& flt, const double& dbl)->unsigned int
    {
        cout << "A lambda call: " << str << ", " << flt << ", " << dbl << endl;
        return 25;
    }));

    // This form works too.
    myDelegateSet += new MyEventType::StaticDelegateType(myStaticIntMethod);

    // Call the set via .invoke(), ignoring return values
    cout << "------------- CALLING VIA .invoke() ---------------" << endl;
    myDelegateSet.invoke("Foo", 3.14, 3.14159);

    // Call the set via .invoke(), collecting returns into an std::set
    cout << "------------- CALLING VIA .invoke(), Getting Returns ---------------" << endl;
    MyEventType::ReturnSetType myReturnValues;
    myDelegateSet.invoke(myReturnValues, "Foo", 3.14, 3.14159);

    for (auto it = myReturnValues.begin(); it != myReturnValues.end(); it++)
        cout << *it << endl;

    // Iterate on our own, calling invoke() for each delegate
    cout << "------- CUSTOM ITERATION --------" << endl;
    for (auto it = myDelegateSet.begin(); it != myDelegateSet.end(); it++)
        cout << (*it)->invoke("Foo", 3.14, 3.14159) << endl;

    // Remove a static listener function by address
    cout << "-------------- REMOVING STATIC LISTENERS -----------------" << endl;
    myDelegateSet.removeDelegateByMethod(myStaticIntMethod);
    myDelegateSet.invoke("Foo", 3.14, 3.14159);

    // Remove a member listener function by address
    cout << "-------------- REMOVING MEMBER LISTENERS -----------------" << endl;
    myDelegateSet.push_back(new MyEventType::StaticDelegateType(myStaticIntMethod));
    myDelegateSet.removeDelegateByMethod(&MyCustomClass::myMemberMethod);

    myDelegateSet.invoke("Foo", 3.14, 3.14159);

    // Remove a member listener function by this pointer
    cout << "-------------- REMOVING MEMBER LISTENERS VIA THIS -----------------" << endl;
    myDelegateSet.push_back(new MyEventType::MemberDelegateType<MyCustomClass>(&MyCustomClass::myMemberMethod, myCustomClassInstance));
    myDelegateSet.removeDelegateByThisPointer(myCustomClassInstance);

    myDelegateSet.invoke("Foo", 3.14, 3.14159);

    // Remove a delegate by it's address
    cout << "-------------- REMOVING DELEGATE VIA ADDRESS -----------------" << endl;
    MyEventType::MemberDelegateType<MyCustomClass> *delegateToRemove = new MyEventType::MemberDelegateType<MyCustomClass>(&MyCustomClass::myMemberMethod, myCustomClassInstance);
    myDelegateSet.push_back(delegateToRemove);

    myDelegateSet.removeDelegate(delegateToRemove, false);
    myDelegateSet.invoke("Foo", 3.14, 3.14159);

    // delegateToRemove Still Exists
    cout << "---------- Removed Delegate is still usable ------------" << endl;
    delegateToRemove->invoke("Foo", 3.14, 3.14159);

    // Create a cached delegate with the removed member delegate above
    #ifndef EASYDELEGATE_NO_DEFERRED_CALLING
        cout << "---------- DEFERRED CALLERS ---------------" << endl;
        typedef EasyDelegate::DeferredMemberCaller<MyCustomClass, unsigned int, const char*, const float&, const double&> MyCachedIntMemberDelegateType;
        typedef EasyDelegate::DeferredStaticCaller<void, const float&, const char*, const double&> MyCachedVoidStaticDelegateType;

        // Allocate our delegate types
        MyCachedIntMemberDelegateType* cachedMemberDelegate = new MyCachedIntMemberDelegateType(&MyCustomClass::myMemberMethod, myCustomClassInstance, "Cached", 3.14, 3.14159);
        MyCachedVoidStaticDelegateType* cachedStaticDelegate = new MyCachedVoidStaticDelegateType(myStaticVoidMethod, 8.15f, "Cached", 3.14f);

        // Now store these in a set
        vector<EasyDelegate::IDeferredCaller *> delegates;

        delegates.push_back(cachedMemberDelegate);
        delegates.push_back(cachedStaticDelegate);

        // Iterate
        for (auto it = delegates.begin(); it != delegates.end(); ++it)
        {
            cout << "Invoking Delegate " << endl;
            (*it)->genericDispatch();
        }
    #endif

    // Comparisons
    MyEventType::StaticDelegateType staticDelegateReference(myStaticIntMethod);
    VoidEventType::StaticDelegateType staticVoidDelegateReference(myStaticVoidMethod);
    MyEventType::MemberDelegateType<MyCustomClass> memberDelegateReference(&MyCustomClass::myMemberMethod, myCustomClassInstance);

    cout << (staticDelegateReference.hasSameMethodAs(&staticDelegateReference)) << endl;
    cout << (staticDelegateReference.hasSameMethodAs(&memberDelegateReference)) << endl;
    cout << (memberDelegateReference.hasSameMethodAs(&memberDelegateReference)) << endl;
    cout << (memberDelegateReference.hasSameMethodAs(&staticDelegateReference)) << endl;

    // Unlike comparisons
    cout << (staticDelegateReference.hasSameMethodAs(&staticVoidDelegateReference)) << endl;
    cout << (memberDelegateReference.hasSameMethodAs(&staticVoidDelegateReference)) << endl;

    // Cleanup
    #ifndef EASYDELEGATE_NO_DEFERRED_CALLING
        delete cachedMemberDelegate;
        delete cachedStaticDelegate;
    #endif

    delete myCustomClassInstance;

    return 0;
}