icinga2/lib/base/scriptfunction.h

82 lines
2.7 KiB
C
Raw Normal View History

2012-07-14 15:59:59 +02:00
/******************************************************************************
* Icinga 2 *
* Copyright (C) 2012-2014 Icinga Development Team (http://www.icinga.org) *
2012-07-14 15:59:59 +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 SCRIPTFUNCTION_H
#define SCRIPTFUNCTION_H
2013-03-16 21:18:53 +01:00
#include "base/i2-base.h"
#include "base/registry.h"
#include "base/singleton.h"
2013-03-16 21:18:53 +01:00
#include "base/value.h"
2013-03-25 20:47:02 +01:00
#include "base/scriptfunctionwrapper.h"
2013-03-16 21:18:53 +01:00
#include <vector>
2013-03-15 18:21:29 +01:00
#include <boost/function.hpp>
2012-07-14 15:59:59 +02:00
namespace icinga
{
2012-09-17 13:35:55 +02:00
/**
* A script function that can be used to execute a script task.
*
* @ingroup base
*/
2012-07-14 15:59:59 +02:00
class I2_BASE_API ScriptFunction : public Object
{
public:
DECLARE_PTR_TYPEDEFS(ScriptFunction);
2012-07-14 15:59:59 +02:00
2013-03-25 18:36:15 +01:00
typedef boost::function<Value (const std::vector<Value>& arguments)> Callback;
2012-07-14 15:59:59 +02:00
ScriptFunction(const Callback& function);
2012-07-14 15:59:59 +02:00
2013-03-25 18:36:15 +01:00
Value Invoke(const std::vector<Value>& arguments);
2012-07-14 15:59:59 +02:00
private:
Callback m_Callback;
};
2013-03-15 11:19:52 +01:00
/**
* A registry for script functions.
*
* @ingroup base
*/
2013-10-10 23:07:05 +02:00
class I2_BASE_API ScriptFunctionRegistry : public Registry<ScriptFunctionRegistry, ScriptFunction::Ptr>
{
public:
static ScriptFunctionRegistry *GetInstance(void);
};
2013-03-15 11:19:52 +01:00
/**
* Helper class for registering ScriptFunction implementation classes.
*
* @ingroup base
*/
2013-03-16 21:18:53 +01:00
class I2_BASE_API RegisterFunctionHelper
{
public:
2013-03-16 21:18:53 +01:00
RegisterFunctionHelper(const String& name, const ScriptFunction::Callback& function);
};
#define REGISTER_SCRIPTFUNCTION(name, callback) \
2013-03-25 20:47:02 +01:00
I2_EXPORT icinga::RegisterFunctionHelper g_RegisterSF_ ## name(#name, WrapScriptFunction(callback))
2012-07-14 15:59:59 +02:00
}
2012-08-13 12:39:37 +02:00
#endif /* SCRIPTFUNCTION_H */