base_event.hh

Go to the documentation of this file.

/*
 * LEGAL:   COPYRIGHT (C) 2005 JIM E. BROOKS
 *          THIS SOURCE CODE IS RELEASED UNDER THE TERMS
 *          OF THE GNU GENERAL PUBLIC LICENSE VERSION 2 (GPL 2).
 *****************************************************************************/

#ifndef BASE_EVENT_HH
#define BASE_EVENT_HH 1

#include "base_common.hh"

namespace base {

template<typename EVENT=Void>  // Void, not void
class Event : public Threadable
{
public:
    class ListenerFunctor : public Shared
    {
    public:
                        ListenerFunctor( void ) { }
        virtual         ~ListenerFunctor() { }
        virtual void    operator()( EVENT event ) { }
    };

private:
    typedef FastLock Lock;

#if ! DOXYGEN
// For all methods except for ctor.
#define EVENT_PROLOGUE()                                    \
{                                                           \
    /* In case Event object is persistent. */               \
    if ( UX(base::global.mExiting) ) return;                \
    THREAD_CODE( Lock::Auto autolock( mInstanceLock ); )    \
}
#endif

public:

    Event( void )
    {
    //EVENT_PROLOGUE();

        // Ensure lock is on heap, not stack.
        THREAD_CODE( mInstanceLock = new Lock; )
    }

    ~Event()
    {
    EVENT_PROLOGUE();

        THREAD_CODE( delete mInstanceLock; )
    }

    void Listen( SharedPtr<ListenerFunctor> listener )
    {
    EVENT_PROLOGUE();

        mListeners.push_front( listener );
    }

    void Unlisten( SharedPtr<ListenerFunctor> listener )
    {
    EVENT_PROLOGUE();

        typename Listeners::iterator iter;
        iter = std::find( mListeners.begin(), mListeners.end(), listener );
        if ( iter != mListeners.end() )
        {
            mListeners.erase( iter );
        }
    }

    void Broadcast( EVENT event )
    {
    EVENT_PROLOGUE();

        // Call every listener.
        typename Listeners::iterator iter;
        for ( iter = mListeners.begin(); iter != mListeners.end(); ++iter )
        {
            ListenerFunctor& functor = (*iter).REF();
            functor( event );
        }
    }

private:
    // Contain the actual functors, not copies.
    typedef std::list< SharedPtr<ListenerFunctor> > Listeners;
    Listeners   mListeners;
    THREAD_CODE( mutable Lock* mInstanceLock; )

#undef EVENT_PROLOGUE
};

} // namespace base

#endif // BASE_EVENT_HH

Palomino 3D Engine documents generated by doxygen 1.5.3 on Fri Nov 23 11:26:06 2007