mirror of https://github.com/Icinga/icinga2.git
134 lines
5.3 KiB
C++
134 lines
5.3 KiB
C++
/******************************************************************************
|
|
* Icinga 2 *
|
|
* Copyright (C) 2012-2016 Icinga Development Team (https://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 SCRIPTFUNCTION_H
|
|
#define SCRIPTFUNCTION_H
|
|
|
|
#include "base/i2-base.hpp"
|
|
#include "base/function.thpp"
|
|
#include "base/value.hpp"
|
|
#include "base/functionwrapper.hpp"
|
|
#include "base/scriptglobal.hpp"
|
|
#include <vector>
|
|
#include <boost/function.hpp>
|
|
|
|
namespace icinga
|
|
{
|
|
|
|
/**
|
|
* A script function that can be used to execute a script task.
|
|
*
|
|
* @ingroup base
|
|
*/
|
|
class I2_BASE_API Function : public ObjectImpl<Function>
|
|
{
|
|
public:
|
|
DECLARE_OBJECT(Function);
|
|
|
|
typedef boost::function<Value (const std::vector<Value>& arguments)> Callback;
|
|
|
|
Function(const String& name, const Callback& function, bool side_effect_free = false, bool deprecated = false);
|
|
|
|
Value Invoke(const std::vector<Value>& arguments = std::vector<Value>());
|
|
Value Invoke(const Value& otherThis, const std::vector<Value>& arguments = std::vector<Value>());
|
|
|
|
inline bool IsSideEffectFree(void) const
|
|
{
|
|
return GetSideEffectFree();
|
|
}
|
|
|
|
inline bool IsDeprecated(void) const
|
|
{
|
|
return GetDeprecated();
|
|
}
|
|
|
|
static Object::Ptr GetPrototype(void);
|
|
|
|
virtual Object::Ptr Clone(void) const override;
|
|
|
|
private:
|
|
Callback m_Callback;
|
|
};
|
|
|
|
#define REGISTER_SCRIPTFUNCTION_NS(ns, name, callback) \
|
|
namespace { namespace UNIQUE_NAME(sf) { namespace sf ## ns ## name { \
|
|
void RegisterFunction(void) { \
|
|
Function::Ptr sf = new icinga::Function(#ns "#" #name, WrapFunction(callback), false); \
|
|
ScriptGlobal::Set(#ns "." #name, sf); \
|
|
} \
|
|
INITIALIZE_ONCE_WITH_PRIORITY(RegisterFunction, 10); \
|
|
} } }
|
|
|
|
#define REGISTER_SCRIPTFUNCTION_NS_PREFIX(ns, name, callback) \
|
|
namespace { namespace UNIQUE_NAME(sf) { namespace sf ## ns ## name { \
|
|
void RegisterFunction(void) { \
|
|
Function::Ptr sf = new icinga::Function(#ns "#" #name, WrapFunction(callback), false); \
|
|
ScriptGlobal::Set(#ns "." #name, sf); \
|
|
Function::Ptr dsf = new icinga::Function("__" #name " (deprecated)", WrapFunction(callback), false, true); \
|
|
ScriptGlobal::Set("System.__" #name, dsf); \
|
|
} \
|
|
INITIALIZE_ONCE_WITH_PRIORITY(RegisterFunction, 10); \
|
|
} } }
|
|
|
|
#define REGISTER_SCRIPTFUNCTION_NS_DEPRECATED(ns, name, callback) \
|
|
namespace { namespace UNIQUE_NAME(sf) { namespace sf ## ns ## name { \
|
|
void RegisterFunction(void) { \
|
|
Function::Ptr sf = new icinga::Function(#ns "#" #name, WrapFunction(callback), false); \
|
|
ScriptGlobal::Set(#ns "." #name, sf); \
|
|
Function::Ptr dsf = new icinga::Function(#name " (deprecated)", WrapFunction(callback), false, true); \
|
|
ScriptGlobal::Set(#name, dsf); \
|
|
} \
|
|
INITIALIZE_ONCE_WITH_PRIORITY(RegisterFunction, 10); \
|
|
} } }
|
|
|
|
#define REGISTER_SAFE_SCRIPTFUNCTION_NS(ns, name, callback) \
|
|
namespace { namespace UNIQUE_NAME(sf) { namespace sf ## ns ## name { \
|
|
void RegisterFunction(void) { \
|
|
Function::Ptr sf = new icinga::Function(#ns "#" #name, WrapFunction(callback), true); \
|
|
ScriptGlobal::Set(#ns "." #name, sf); \
|
|
} \
|
|
INITIALIZE_ONCE_WITH_PRIORITY(RegisterFunction, 10); \
|
|
} } }
|
|
|
|
#define REGISTER_SAFE_SCRIPTFUNCTION_NS_PREFIX(ns, name, callback) \
|
|
namespace { namespace UNIQUE_NAME(sf) { namespace sf ## ns ## name { \
|
|
void RegisterFunction(void) { \
|
|
Function::Ptr sf = new icinga::Function(#ns "#" #name, WrapFunction(callback), true); \
|
|
ScriptGlobal::Set(#ns "." #name, sf); \
|
|
Function::Ptr dsf = new icinga::Function("__" #name " (deprecated)", WrapFunction(callback), true, true); \
|
|
ScriptGlobal::Set("System.__" #name, dsf); \
|
|
} \
|
|
INITIALIZE_ONCE_WITH_PRIORITY(RegisterFunction, 10); \
|
|
} } }
|
|
|
|
#define REGISTER_SAFE_SCRIPTFUNCTION_NS_DEPRECATED(ns, name, callback) \
|
|
namespace { namespace UNIQUE_NAME(sf) { namespace sf ## ns ## name { \
|
|
void RegisterFunction(void) { \
|
|
Function::Ptr sf = new icinga::Function(#ns "#" #name, WrapFunction(callback), true); \
|
|
ScriptGlobal::Set(#ns "." #name, sf); \
|
|
Function::Ptr dsf = new icinga::Function(#name " (deprecated)", WrapFunction(callback), true, true); \
|
|
ScriptGlobal::Set(#name, dsf); \
|
|
} \
|
|
INITIALIZE_ONCE_WITH_PRIORITY(RegisterFunction, 10); \
|
|
} } }
|
|
|
|
}
|
|
|
|
#endif /* SCRIPTFUNCTION_H */
|