Leviathan::CallableObject Class Reference

#include <CallableObject.h>

Inheritance diagram for Leviathan::CallableObject:

Public Member Functions
DLLEXPORT	CallableObject ()
virtual DLLEXPORT	~CallableObject ()
virtual DLLEXPORT int	OnEvent (Event *event)=0
virtual DLLEXPORT int	OnGenericEvent (GenericEvent *event)=0

Static Public Member Functions
static DLLEXPORT EVENT_TYPE	ResolveStringToType (const std::string &type)
static DLLEXPORT EVENT_TYPE	GetCommonEventType (const std::string &type)
static DLLEXPORT std::string	GetListenerNameFromType (EVENT_TYPE type)

Protected Member Functions
void	UnRegisterAllEvents ()
void	UnRegister (EVENT_TYPE from, bool all=false)
void	UnRegister (const std::string &genericname, bool all=false)
void	RegisterForEvent (EVENT_TYPE toregister)
void	RegisterForEvent (const std::string &genericname)

Detailed Description

Todo:

Rewrite this to be cleaner with the event return codes

Definition at line 11 of file CallableObject.h.

Constructor & Destructor Documentation

CallableObject()

CallableObject::CallableObject

(

)

Definition at line 9 of file CallableObject.cpp.

{}

~CallableObject()

CallableObject::~CallableObject ( )

virtual

Definition at line 10 of file CallableObject.cpp.

{

    if(HasRegisteredForSomeEvent) {

        // For easier debugging this
        // DEBUG_BREAK;
        LOG_FATAL("Callable object derived class hasn't called UnRegisterAllEvents");
    }
}

Member Function Documentation

GetCommonEventType()

DLLEXPORT EVENT_TYPE CallableObject::GetCommonEventType ( const std::string &  type )

static

Returns

event type from string if it is one of the common events that different objects handle themselves

not a global event like in ResolveStringToType

Definition at line 64 of file CallableObject.cpp.

{
    // lookup map and return //
    auto iter = EventListenerCommonNameToEventMap.find(type);

    if(iter != EventListenerCommonNameToEventMap.end()) {

        return iter->second;
    }

    return EVENT_TYPE_ERROR;
}

GetListenerNameFromType()

DLLEXPORT std::string CallableObject::GetListenerNameFromType ( EVENT_TYPE  type )

static

reverse of above and returns for example from EVENT_TYPE_SHOW "OnShow"

Todo:

Have a bi-directional map to speed up lookups

Definition at line 77 of file CallableObject.cpp.

{
    for(auto iter = EventListenerNameToEventMap.begin();
        iter != EventListenerNameToEventMap.end(); ++iter) {
        // when the type matches return the string associated with that value//
        if(iter->second == type)
            return iter->first;
    }

    // Also common //
    for(auto iter = EventListenerCommonNameToEventMap.begin();
        iter != EventListenerCommonNameToEventMap.end(); ++iter) {
        // when the type matches return the string associated with that value//
        if(iter->second == type)
            return iter->first;
    }

    return "";
}

OnEvent()

virtual DLLEXPORT int Leviathan::CallableObject::OnEvent ( Event *  event )

pure virtual

Implemented in Leviathan::GUI::VideoPlayer, Leviathan::GUI::View, and Leviathan::Script::EventListener.

OnGenericEvent()

virtual DLLEXPORT int Leviathan::CallableObject::OnGenericEvent ( GenericEvent *  event )

pure virtual

Implemented in Leviathan::GUI::VideoPlayer, Leviathan::GUI::View, and Leviathan::Script::EventListener.

RegisterForEvent() [1/2]

void CallableObject::RegisterForEvent ( EVENT_TYPE  toregister )

protected

Definition at line 31 of file CallableObject.cpp.

{
    Engine::Get()->GetEventHandler()->RegisterForEvent(this, toregister);
    HasRegisteredForSomeEvent = true;
}

RegisterForEvent() [2/2]

void CallableObject::RegisterForEvent ( const std::string &  genericname )

protected

Definition at line 37 of file CallableObject.cpp.

{
    Engine::Get()->GetEventHandler()->RegisterForEvent(this, genericname);
    HasRegisteredForSomeEvent = true;
}

ResolveStringToType()

DLLEXPORT EVENT_TYPE CallableObject::ResolveStringToType ( const std::string &  type )

static

Returns

event type from wstring (invalid event type is returned if matches none)

Note

if invalid type is returned type should be registered as generic event

Definition at line 51 of file CallableObject.cpp.

{
    // lookup map and return //
    auto iter = EventListenerNameToEventMap.find(type);

    if(iter != EventListenerNameToEventMap.end()) {

        return iter->second;
    }

    return EVENT_TYPE_ERROR;
}

UnRegister() [1/2]

void CallableObject::UnRegister ( EVENT_TYPE  from, bool  all = false  )

protected

Definition at line 21 of file CallableObject.cpp.

{
    Engine::Get()->GetEventHandler()->Unregister(this, from, all);
}

UnRegister() [2/2]

void CallableObject::UnRegister ( const std::string &  genericname, bool  all = false  )

protected

Definition at line 26 of file CallableObject.cpp.

{
    Engine::Get()->GetEventHandler()->Unregister(this, genericname, all);
}

UnRegisterAllEvents()

void CallableObject::UnRegisterAllEvents ( )

protected

Warning

Unregister all has to be called the first thing in any derived class constructor otherwise this class' destructor will assert

Note

This object shouldn't be locked while calling this to avoid deadlocking when unregistering while an event is being processed

Definition at line 43 of file CallableObject.cpp.

{
    Engine::Get()->GetEventHandler()->Unregister(this, EVENT_TYPE_ALL, true);
    Engine::Get()->GetEventHandler()->Unregister(this, "", true);

    HasRegisteredForSomeEvent = false;
}

---

The documentation for this class was generated from the following files:

• CallableObject.h
• CallableObject.cpp