cnedfunction.h

//==========================================================================
//  CNEDFUNCTION.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//==========================================================================
 
/*--------------------------------------------------------------*
  Copyright (C) 1992-2017 Andras Varga
  Copyright (C) 2006-2017 OpenSim Ltd.
 
  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/
 
#ifndef __OMNETPP_CNEDFUNCTION_H
#define __OMNETPP_CNEDFUNCTION_H
 
#include <cstdarg>
#include "simkerneldefs.h"
#include "globals.h"
#include "cownedobject.h"
#include "cdynamicexpression.h"
 
namespace omnetpp {
 
 
typedef cValue (*NedFunction)(cComponent *context, cValue argv[], int argc);
 
typedef cValue (*NedFunctionExt)(cExpression::Context *context, cValue argv[], int argc);
 
// NEDFunction was renamed NedFunction in OMNeT++ 5.3; typedef added for compatibility
typedef NedFunction NEDFunction;
 
 
 
class SIM_API cNedFunction : public cNoncopyableOwnedObject
{
  public:
    enum Type { UNDEF=0, BOOL, INT, INTQ, DOUBLE, DOUBLEQ, STRING, OBJECT, XML, ANY };
 
  private:
    std::string signature; // function signature, as passed to the ctor
    std::vector<Type> argTypes;  // argument types
    bool hasVarargs_;      // if true, signature contains "..." after the last typed arg
    Type returnType;       // return type
    int minArgc, maxArgc;  // minimum and maximum argument count
    NedFunction f = nullptr; // implementation function
    NedFunctionExt fext = nullptr; // alternative function that takes cExpression::Context as arg
    std::string category;  // category string; only used when listing all functions
    std::string description;  // optional documentation string
 
  protected:
    void parseSignature(const char *signature);
    void checkArgs(cValue argv[], int argc);
 
  public:
    cNedFunction(NedFunction f, const char *signature, const char *category=nullptr, const char *description=nullptr);
 
    cNedFunction(NedFunctionExt f, const char *signature, const char *category=nullptr, const char *description=nullptr);
 
    virtual ~cNedFunction() {}
 
    virtual std::string str() const override;
 
    cValue invoke(cExpression::Context *context, cValue argv[], int argc);
 
    NedFunction getFunctionPointer() const  {return f;}
 
    const char *getSignature() const {return signature.c_str();}
 
    Type getReturnType() const  {return returnType;}
 
    Type getArgType(int k) const  {return argTypes[k];}
 
    int getMinArgs() const  {return minArgc;}
 
    int getMaxArgs() const  {return maxArgc;}
 
    bool hasVarArgs() const  {return hasVarargs_;}
 
    bool acceptsArgCount(int argCount) {return argCount >= minArgc && (hasVarargs_ || argCount <= maxArgc);}
 
    const char *getCategory() const  {return category.c_str();}
 
    const char *getDescription() const  {return description.c_str();}
 
    static cNedFunction *find(const char *name);
 
    static cNedFunction *find(const char *name, int argCount);
 
    static cNedFunction *get(const char *name);
 
    static cNedFunction *get(const char *name, int argCount);
 
    static cNedFunction *findByPointer(NedFunction f);
};
 
// cNEDFunction was renamed cNedFunction in OMNeT++ 5.3; typedef added for compatibility
typedef cNedFunction cNEDFunction;
 
}  // namespace omnetpp
 
 
#endif