PDG_EventHandler.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * COMMENTS:
 */

#ifndef __PDG_EVENT_HANDLER_H__
#define __PDG_EVENT_HANDLER_H__

#include "PDG_API.h"
#include "PDG_Types.h"

#include <UT/UT_Set.h>
#include <UT/UT_TBBSpinLock.h>

class PDG_Event;
class PDG_EventEmitter;

class PDG_API PDG_EventHandler
{
public:
    using EmitterSet = UT_Set<PDG_EventEmitter*>;

public:
                            PDG_EventHandler(
                                PDG_BaseType::Language language=PDG_BaseType::eCpp,
                                bool user_handler=false);
    virtual                 ~PDG_EventHandler();

    virtual void            handlePDGEvent(const PDG_Event &) = 0;
    virtual void            eventEmitterNotAvailable(PDG_EventEmitter *emitter)
                                { };

    void                    removeFromAllEmitters();
    void                    emitters(EmitterSet& emitters) const;

    PDG_BaseType::Language  language() const
                                { return myLanguage; }
    bool                    isUserHandler() const
                                { return myIsUserHandler; }

private:
    friend class PDG_EventEmitter;

    void                    registerEventEmitter(PDG_EventEmitter *emitter);
    void                    unregisterEventEmitter(PDG_EventEmitter *emitter);

private:
    mutable UT_TBBSpinLock  myEmittersLock;
    EmitterSet              myEmitters;
    PDG_BaseType::Language  myLanguage;
    bool                    myIsUserHandler;
};

#endif