/usr/include/Analitza5/analitza/builtinmethods.h is in libanalitza-dev 4:16.08.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 | /*************************************************************************************
* Copyright (C) 2010 by Aleix Pol <aleixpol@kde.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 Street, Fifth Floor, Boston, MA 02110-1301, USA *
*************************************************************************************/
#ifndef BUILTINMETHODS_H
#define BUILTINMETHODS_H
#include <QVariant>
#include "analitzaexport.h"
#include "expressiontype.h"
#include <QStringList>
namespace Analitza
{
class Expression;
class ExpressionType;
class Object;
class FunctionDefinition
{
public:
virtual ~FunctionDefinition() {}
/**
* Lets the user specify a function to be injected. When called it should perform whatever
* the function is supposed to do.
*
* @param args: specifies the values passed as arguments.
* @returns the resulting expression.
*/
virtual Expression operator()(const QList<Expression>& args)=0;
};
class PointerFunctionDefinition : public FunctionDefinition
{
public:
typedef Expression (*func)(const QList<Expression>& args);
PointerFunctionDefinition(func call);
virtual Expression operator()(const QList<Expression>& args) override;
private:
func m_function;
};
/**
* \class BuiltinMethods
*
* \ingroup AnalitzaModule
*
* \brief Manage custom commands in analitza language.
*/
class ANALITZA_EXPORT BuiltinMethods
{
public:
~BuiltinMethods();
//TODO improve doc of variadic function ... and put some examples ...
//TODO unit test of variadic function with ExpressionType/Checker
/**
Adds a new function to the system identified @p id with @p type that can be called using @p f
For variadic function use ExpressionType::Any as first lambda parameter. Also, if you use ExpressionType::Any
with some type as contained, then it means the all arguments of variadic function must be of the same type, equals
to the contained type.
*/
void insertFunction(const QString& id, const ExpressionType& type, FunctionDefinition* f);
/** @returns whether it exists a builtin function named like @p id */
bool contains(const QString& id) const { return m_functions.contains(id); }
/** @returns a map that relates all functions with their specified type. */
QMap<QString, ExpressionType> varTypes() const { return m_types; }
/** @returns the builtin function identified by @p id to be called. */
FunctionDefinition* function(const QString& id) const { return m_functions.value(id); }
/** @returns a list with the name of all registered identifiers. */
QStringList identifiers() const { return m_functions.keys(); }
private:
QMap<QString, ExpressionType> m_types;
QHash<QString, FunctionDefinition*> m_functions;
};
}
#endif
|