cnedfunction.h

//==========================================================================
//  CNEDFUNCTION.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//==========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 1992-2008 Andras Varga
  Copyright (C) 2006-2008 OpenSim Ltd.

  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/

#ifndef __CNEDFUNCTION_H
#define __CNEDFUNCTION_H

#include <stdarg.h>
#include "simkerneldefs.h"
#include "globals.h"
#include "cownedobject.h"
#include "cdynamicexpression.h"

NAMESPACE_BEGIN


typedef cNEDValue (*NEDFunction)(cComponent *context, cNEDValue argv[], int argc);


class SIM_API cNEDFunction : public cNoncopyableOwnedObject
{
  private:
    std::string sign;      // function signature, as passed to the ctor
    std::string argtypes;  // sequence of B,L,D,Q,S,X,*
    bool hasvarargs;       // if true, signature contains "..." after the last typed arg
    char rettype;          // one of B,L,D,Q,S,X,*
    int minargc, maxargc;  // minimum and maximum argument count
    NEDFunction f;         // function ptr
    std::string categ;     // category string; only used when listing all functions
    std::string desc;      // 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=NULL, const char *description=NULL);

    virtual ~cNEDFunction() {}

    virtual std::string info() const;

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

    NEDFunction getFunctionPointer() const  {return f;}

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

    char getReturnType() const  {return rettype;}

    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 categ.c_str();}

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

    static cNEDFunction *find(const char *name);

    static cNEDFunction *get(const char *name);

    static cNEDFunction *findByPointer(NEDFunction f);
};

NAMESPACE_END


#endif