Qore Programming Language  0.8.11.1
Static Public Member Functions | List of all members
BuiltinFunctionList Class Reference

the interface to the global list of all builtin functions in the library More...

#include <BuiltinFunctionList.h>

Static Public Member Functions

static DLLEXPORT void add (const char *name, q_func_t f, int functional_domain=QDOM_DEFAULT)
 adds a new builtin function variant to the "Qore" namespace More...
 
static DLLEXPORT void add2 (const char *name, q_func_t f, int64 code_flags=QC_NO_FLAGS, int64 functional_domain=QDOM_DEFAULT, const QoreTypeInfo *returnTypeInfo=0, unsigned num_params=0,...)
 adds a new builtin function variant to the "Qore" namespace and allows for the return type and parameter types to be set More...
 
static DLLEXPORT void add3 (const char *name, q_func_t f, int64 code_flags=QC_NO_FLAGS, int64 functional_domain=QDOM_DEFAULT, const QoreTypeInfo *returnTypeInfo=0, const type_vec_t &typeList=type_vec_t(), const arg_vec_t &defaultArgList=arg_vec_t())
 adds a new builtin function variant to the "Qore" and allows for the return type and parameter types to be set from lists More...
 
static DLLEXPORT const QoreFunction * find (const char *name)
 finds a function by its name in the current QoreProgram object; if there is none, then returns 0 More...
 
static DLLEXPORT int size ()
 always returns 0 More...
 

Detailed Description

the interface to the global list of all builtin functions in the library

The object is thread-safe; a hash or hash-map is used for lookups. There is only one of these, therefore we have static functions.

Member Function Documentation

static DLLEXPORT void BuiltinFunctionList::add ( const char *  name,
q_func_t  f,
int  functional_domain = QDOM_DEFAULT 
)
static

adds a new builtin function variant to the "Qore" namespace

Parameters
namethe name of the function
fa pointer to the actual C++ function to be executed when the function is called
functional_domaina capability mask of the function so that access to the function can be restricted if necessary; use QDOM_DEFAULT for none
Deprecated:
use QoreNamespace::addBuiltinVariant() instead
static DLLEXPORT void BuiltinFunctionList::add2 ( const char *  name,
q_func_t  f,
int64  code_flags = QC_NO_FLAGS,
int64  functional_domain = QDOM_DEFAULT,
const QoreTypeInfo *  returnTypeInfo = 0,
unsigned  num_params = 0,
  ... 
)
static

adds a new builtin function variant to the "Qore" namespace and allows for the return type and parameter types to be set

Parameters
namethe name of the function
fa pointer to the actual C++ function to be executed when the function is called
code_flagsflags for the function being added
functional_domaina capability mask of the function so that access to the function can be restricted if necessary; use QDOM_DEFAULT for none
returnTypeInfothe type information for the return value of this function
num_paramsthe number of parameters specified for the function, there must be 2 arguments for each parameter, first, a const QoreTypeInfo *, giving the type information for the parameter, and second a const AbstractQoreNode * giving the default value if no argument is supplied by the caller
Since
qore 0.8
Deprecated:
use QoreNamespace::addBuiltinVariant() instead
static DLLEXPORT void BuiltinFunctionList::add3 ( const char *  name,
q_func_t  f,
int64  code_flags = QC_NO_FLAGS,
int64  functional_domain = QDOM_DEFAULT,
const QoreTypeInfo *  returnTypeInfo = 0,
const type_vec_t typeList = type_vec_t(),
const arg_vec_t defaultArgList = arg_vec_t() 
)
static

adds a new builtin function variant to the "Qore" and allows for the return type and parameter types to be set from lists

Parameters
namethe name of the function
fa pointer to the actual C++ function to be executed when the function is called
code_flagsflags for the function being added
functional_domaina capability mask of the function so that access to the function can be restricted if necessary; use QDOM_DEFAULT for none
returnTypeInfothe type information for the return value of this function
typeLista list of types for each parameter; must have num_param entries
defaultArgLista list of default argument values for each parameter if no argument is supplied by the caller
Since
qore 0.8
Deprecated:
use QoreNamespace::addBuiltinVariant() instead
static DLLEXPORT const QoreFunction* BuiltinFunctionList::find ( const char *  name)
static

finds a function by its name in the current QoreProgram object; if there is none, then returns 0

Returns
a pointer to the function found or 0 if not found or no current QoreProgram object
Deprecated:
as of Qore 0.8.4
static DLLEXPORT int BuiltinFunctionList::size ( )
static

always returns 0

Returns
0

The documentation for this class was generated from the following file: