icinga2/lib/base/dynamictype.h

/******************************************************************************
 * Icinga 2                                                                   *
 * Copyright (C) 2012-2013 Icinga Development Team (http://www.icinga.org/)   *
 *                                                                            *
 * This program is free software; you can redistribute it and/or              *
 * modify it under the terms of the GNU General Public License                *
 * as published by the Free Software Foundation; either version 2             *
 * of the License, or (at your option) any later version.                     *
 *                                                                            *
 * This program is distributed in the hope that it will be useful,            *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
 * GNU General Public License for more details.                               *
 *                                                                            *
 * You should have received a copy of the GNU General Public License          *
 * along with this program; if not, write to the Free Software Foundation     *
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
 ******************************************************************************/

#ifndef DYNAMICTYPE_H
#define DYNAMICTYPE_H

#include "base/i2-base.h"
#include "base/registry.h"
#include "base/dynamicobject.h"
#include "base/debug.h"
#include <map>
#include <set>
#include <boost/function.hpp>
#include <boost/smart_ptr/make_shared.hpp>

namespace icinga
{

class I2_BASE_API DynamicType : public Object
{
public:
	DECLARE_PTR_TYPEDEFS(DynamicType);

	typedef boost::function<DynamicObject::Ptr (void)> ObjectFactory;

	DynamicType(const String& name, const ObjectFactory& factory);

	String GetName(void) const;

	static DynamicType::Ptr GetByName(const String& name);

	static void RegisterType(const DynamicType::Ptr& type);

	DynamicObject::Ptr CreateObject(const Dictionary::Ptr& serializedUpdate);
	DynamicObject::Ptr GetObject(const String& name) const;

	void RegisterObject(const DynamicObject::Ptr& object);

	static std::vector<DynamicType::Ptr> GetTypes(void);
	std::vector<DynamicObject::Ptr> GetObjects(void) const;

	template<typename T>
	static std::vector<shared_ptr<T> > GetObjects(void)
	{
		std::vector<shared_ptr<T> > objects;

		BOOST_FOREACH(const DynamicObject::Ptr& object, GetObjects(T::GetTypeName())) {
			shared_ptr<T> tobject = dynamic_pointer_cast<T>(object);

			ASSERT(tobject);

			objects.push_back(tobject);
		}

		return objects;
	}

private:
	String m_Name;
	ObjectFactory m_ObjectFactory;

	typedef std::map<String, DynamicObject::Ptr, string_iless> ObjectMap;
	typedef std::vector<DynamicObject::Ptr> ObjectVector;

	ObjectMap m_ObjectMap;
	ObjectVector m_ObjectVector;

	typedef std::map<String, DynamicType::Ptr, string_iless> TypeMap;
	typedef std::vector<DynamicType::Ptr> TypeVector;

	static TypeMap& InternalGetTypeMap(void);
	static TypeVector& InternalGetTypeVector(void);
	static boost::mutex& GetStaticMutex(void);

	static std::vector<DynamicObject::Ptr> GetObjects(const String& type);
};

/**
 * A registry for DynamicType objects.
 *
 * @ingroup base
 */
class DynamicTypeRegistry : public Registry<DynamicTypeRegistry, DynamicType::Ptr>
{ };

/**
 * Helper class for registering DynamicObject implementation classes.
 *
 * @ingroup base
 */
class RegisterTypeHelper
{
public:
	RegisterTypeHelper(const String& name, const DynamicType::ObjectFactory& factory)
	{
		DynamicType::Ptr type = boost::make_shared<DynamicType>(name, factory);
		DynamicType::RegisterType(type);
	}
};

/**
 * Factory function for DynamicObject-based classes.
 *
 * @ingroup base
 */
template<typename T>
shared_ptr<T> DynamicObjectFactory(void)
{
	return boost::make_shared<T>();
}

#define REGISTER_TYPE_ALIAS(type, alias) \
	I2_EXPORT icinga::RegisterTypeHelper g_RegisterDT_ ## type(alias, DynamicObjectFactory<type>);

#define REGISTER_TYPE(type) \
	REGISTER_TYPE_ALIAS(type, #type)

}

#endif /* DYNAMICTYPE_H */