anki-3d-engine/include/anki/util/Observer.h

#ifndef ANKI_UTIL_OBSERVER_H
#define ANKI_UTIL_OBSERVER_H

#include "anki/util/Vector.h"
#include "anki/util/Functions.h"

namespace anki {

/// The observer interface template
template<typename T>
struct Observer
{
	typedef T Value; ///< The type of the notification value

	virtual ~Observer()
	{}

	virtual void notify(Value notificationVal) = 0;
};

/// An over-qualified observer
template<typename ObservingType, typename Value,
	void (ObservingType::*method)(Value)>
struct SuperObserver: Observer<Value>
{
	ObservingType* reveiver;

	SuperObserver(ObservingType* reveiver_)
		: reveiver(reveiver_)
	{}

	void notify(Value x)
	{
		(reveiver->*method)(x);
	}
};

/// Basically a container of observers
template<typename T>
class Observable
{
public:
	typedef T Value;
	typedef Observer<Value> ObserverType;
	typedef PtrVector<ObserverType> Container;

	/// Add a new observer. The Observable takes ownership of the
	/// pointer and its responsible of cleaning
	void addNewObserver(ObserverType* x)
	{
		observers.push_back(x);
	}

	/// Notify all observers
	void notifyAll(Value x)
	{
		for(typename Container::iterator it = observers.begin();
			it != observers.end(); ++it)
		{
			(*it)->notify(x);
		}
	}

	/// Alias to notifyAll
	void operator()(Value x)
	{
		notifyAll(x);
	}

private:
	Container observers;
};

/// If a class has slots it should include this
/// @code
/// class Foo {
/// 	ANKI_HAS_SLOTS(Foo)
/// };
/// @endcode
#define ANKI_HAS_SLOTS(_class) \
	typedef _class ObservingType;

/// Define a slot. This should follow the method declaration
/// @code
/// class Foo {
/// 	ANKI_HAS_SLOTS(Foo)
///
/// 	void slot(const float&)
/// 	{...}
/// 	ANKI_SLOT(updateZFar, const float&)
/// };
/// @endcode
#define ANKI_SLOT(_name, _type) \
	typedef SuperObserver<ObservingType, _type, &ObservingType::_name> \
		Observing_##_name;

/// Define a signal
#define ANKI_SIGNAL(_type, _name) \
	Observable<_type> _name;

/// It doesn't do anything. Its purpose is to make the code more understandable
#define ANKI_EMIT this->

/// Connect a signal to a slot
/// @note Use RemovePointer so you can be able to use the macro outside of the
///       _receiver body
#define ANKI_CONNECT(_sender, _signal, _receiver, _slot) \
	(_sender)->_signal.addNewObserver( new \
		RemovePointer<decltype(_receiver)>::Type::Observing_##_slot(_receiver))

} // end namespace anki

#endif