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 cNedValue (*NedFunction)(cComponent *context, cNedValue argv[], int argc);

// NEDFunction was renamed NedFunction in OMNeT++ 5.3; typedef added for compatibility
typedef NedFunction NEDFunction;



class SIM_API cNedFunction : public cNoncopyableOwnedObject
{
  private:
    std::string signature; // function signature, as passed to the ctor
    std::string argTypes;  // sequence of B,L,T,D,Q,S,X,*
    bool hasVarargs_;      // if true, signature contains "..." after the last typed arg
    char returnType;       // one of B,L,T,D,Q,S,X,*
    int minArgc, maxArgc;  // minimum and maximum argument count
    NedFunction f;         // function ptr
    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(cNedValue argv[], int argc);

  public:
    cNedFunction(NedFunction f, const char *signature, const char *category=nullptr, const char *description=nullptr);

    virtual ~cNedFunction() {}

    virtual std::string str() const override;

    cNedValue invoke(cComponent *context, cNedValue argv[], int argc);

    NedFunction getFunctionPointer() const  {return f;}

    const char *getSignature() const {return signature.c_str();}

    char getReturnType() const  {return returnType;}

    char getArgType(int k) const  {return argTypes[k];}

    int getMinArgs() const  {return minArgc;}

    int getMaxArgs() const  {return maxArgc;}

    bool hasVarArgs() const  {return hasVarargs_;}

    const char *getCategory() const  {return category.c_str();}

    const char *getDescription() const  {return description.c_str();}

    static cNedFunction *find(const char *name);

    static cNedFunction *get(const char *name);

    static cNedFunction *findByPointer(NedFunction f);
};

// cNEDFunction was renamed cNedFunction in OMNeT++ 5.3; typedef added for compatibility
typedef cNedFunction cNEDFunction;

}  // namespace omnetpp


#endif