icinga2/lib/base/type.hpp

172 lines
5.0 KiB
C++
Raw Normal View History

2013-10-26 09:41:45 +02:00
/******************************************************************************
* Icinga 2 *
2015-01-22 12:00:23 +01:00
* Copyright (C) 2012-2015 Icinga Development Team (http://www.icinga.org) *
2013-10-26 09:41:45 +02:00
* *
* 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 TYPE_H
#define TYPE_H
2013-10-26 09:41:45 +02:00
2014-05-25 16:23:35 +02:00
#include "base/i2-base.hpp"
#include "base/string.hpp"
2014-05-25 16:23:35 +02:00
#include "base/object.hpp"
#include "base/initialize.hpp"
#include <boost/function.hpp>
2015-02-25 14:03:15 +01:00
#include <vector>
2013-10-26 09:41:45 +02:00
namespace icinga
{
/* keep this in sync with tools/mkclass/classcompiler.hpp */
2014-10-26 19:59:49 +01:00
enum FieldAttribute
{
FAEphemeral = 1,
FAConfig = 2,
FAState = 4,
FARequired = 256,
FANavigation = 512,
FANoUserModify = 1024,
FANoUserView = 2048
};
class Type;
struct Field
2013-10-26 09:41:45 +02:00
{
int ID;
const char *TypeName;
2013-12-03 09:59:21 +01:00
const char *Name;
const char *NavigationName;
const char *RefTypeName;
2013-10-26 09:41:45 +02:00
int Attributes;
int ArrayRank;
2013-10-26 09:41:45 +02:00
Field(int id, const char *type, const char *name, const char *navigationName, const char *reftype, int attributes, int arrayRank)
: ID(id), TypeName(type), Name(name), NavigationName(navigationName), RefTypeName(reftype), Attributes(attributes), ArrayRank(arrayRank)
2013-10-26 09:41:45 +02:00
{ }
};
enum TypeAttribute
{
TAAbstract = 1
};
class ValidationUtils
{
public:
virtual bool ValidateName(const String& type, const String& name) const = 0;
};
2014-11-03 00:44:04 +01:00
class I2_BASE_API Type : public Object
2013-10-26 09:41:45 +02:00
{
public:
DECLARE_OBJECT(Type);
2015-08-18 07:46:04 +02:00
virtual String ToString(void) const override;
virtual String GetName(void) const = 0;
2014-11-03 00:44:04 +01:00
virtual Type::Ptr GetBaseType(void) const = 0;
virtual int GetAttributes(void) const = 0;
2013-10-26 09:41:45 +02:00
virtual int GetFieldId(const String& name) const = 0;
virtual Field GetFieldInfo(int id) const = 0;
2013-10-26 09:41:45 +02:00
virtual int GetFieldCount(void) const = 0;
String GetPluralName(void) const;
Object::Ptr Instantiate(void) const;
2014-11-03 00:44:04 +01:00
bool IsAssignableFrom(const Type::Ptr& other) const;
bool IsAbstract(void) const;
Object::Ptr GetPrototype(void) const;
void SetPrototype(const Object::Ptr& object);
2014-11-03 00:44:04 +01:00
static void Register(const Type::Ptr& type);
static Type::Ptr GetByName(const String& name);
2015-08-18 07:46:04 +02:00
virtual void SetField(int id, const Value& value, bool suppress_events = false, const Value& cookie = Empty) override;
virtual Value GetField(int id) const override;
virtual std::vector<String> GetLoadDependencies(void) const;
typedef boost::function<void (const Object::Ptr&, const Value&)> AttributeHandler;
virtual void RegisterAttributeHandler(int fieldId, const AttributeHandler& callback);
2014-11-07 12:32:25 +01:00
protected:
virtual ObjectFactory GetFactory(void) const = 0;
private:
Object::Ptr m_Prototype;
};
class I2_BASE_API TypeType : public Type
{
public:
DECLARE_PTR_TYPEDEFS(Type);
virtual String GetName(void) const override;
virtual Type::Ptr GetBaseType(void) const override;
virtual int GetAttributes(void) const override;
virtual int GetFieldId(const String& name) const override;
virtual Field GetFieldInfo(int id) const override;
virtual int GetFieldCount(void) const override;
static Object::Ptr GetPrototype(void);
protected:
virtual ObjectFactory GetFactory(void) const override;
};
template<typename T>
class TypeImpl
{
};
#define REGISTER_TYPE(type) \
namespace { namespace UNIQUE_NAME(rt) { \
void RegisterType ## type(void) \
{ \
icinga::Type::Ptr t = new TypeImpl<type>(); \
2014-11-07 12:32:25 +01:00
type::TypeInstance = t; \
2013-11-08 21:37:21 +01:00
icinga::Type::Register(t); \
} \
\
INITIALIZE_ONCE_WITH_PRIORITY(RegisterType ## type, 10); \
2014-11-07 12:32:25 +01:00
} } \
DEFINE_TYPE_INSTANCE(type)
#define REGISTER_TYPE_WITH_PROTOTYPE(type, prototype) \
namespace { namespace UNIQUE_NAME(rt) { \
void RegisterType ## type(void) \
{ \
icinga::Type::Ptr t = new TypeImpl<type>(); \
t->SetPrototype(prototype); \
type::TypeInstance = t; \
icinga::Type::Register(t); \
} \
\
INITIALIZE_ONCE_WITH_PRIORITY(RegisterType ## type, 10); \
} } \
DEFINE_TYPE_INSTANCE(type)
2014-11-07 12:32:25 +01:00
#define DEFINE_TYPE_INSTANCE(type) \
Type::Ptr type::TypeInstance
2013-10-26 09:41:45 +02:00
}
#endif /* TYPE_H */