SML::FUNCDEF Class Reference

Structure for defining SML functions. More...

#include <sml/function.h>

Inheritance diagram for SML::FUNCDEF:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FUNCDEF (const char *p_name, STYPE p_type, PARM *p_parms, const char *p_classname, int p_createdate, int p_modifydate=0, const char *p_description=0, bool bInWin32Native=false)
 FUNCDEF (const char *p_name, SMLFUNCSIG p_signature, PARM *p_parms, int p_createdate, int p_modifydate=0, const char *p_ClassName=0)
 FUNCDEF (const char *p_name, METHODPTR p_method, SMLFUNCSIG p_signature, PARM *p_parms, int p_createdate, int p_modifydate=0, const char *p_ClassName=0, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, VOIDFUNC p_func, SMLFUNCSIG p_signature, PARM *p_parms, const char *p_ClassName=0, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, VOIDFUNC p_func, SMLFUNCSIG p_signature, PARM *p_parms, int p_createdate, int p_modifydate=0, const char *p_ClassName=0, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, void *(*p_func)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context), STYPE p_type, PARM *p_parms, const char *p_classname, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, void *(*p_func)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context), STYPE p_type, PARM *p_parms, const char *p_classname, int p_createdate, int p_modifydate=0, const char *p_description=0, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, CLASSHASH *(*p_func)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context), STYPE p_type, PARM *p_parms, const char *p_classname, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, CLASSHASH *(*p_func)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context), STYPE p_type, PARM *p_parms, const char *p_classname, int p_createdate, int p_modifydate=0, const char *p_description=0, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, STRING *(*p_func)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context), PARM *p_parms, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, STRING *(*p_func)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context), PARM *p_parms, int p_createdate, int p_modifydate=0, const char *p_description=0, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, double(*p_func)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context), PARM *p_parms, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, double(*p_func)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context), PARM *p_parms, int p_createdate, int p_modifydate=0, const char *p_description=0, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, void(*p_func)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context), PARM *p_parms, bool p_bInWin32=true)
 FUNCDEF (const char *p_name, void(*p_func)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context), PARM *p_parms, int p_createdate, int p_modifydate=0, const char *p_description=0, bool p_bInWin32=true)

Detailed Description

Structure for defining SML functions.

Constructors in this class fill in the SMLFUNC members for you

Constructor & Destructor Documentation

SML::FUNCDEF::FUNCDEF ( const char *  p_name,
void(*)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context)  p_func,
PARM *  p_parms,
int  p_createdate,
int  p_modifydate = 0,
const char *  p_description = 0,
bool  p_bInWin32 = true 
) [inline]

Construct an SMLFUNCDEF for a void function.

Deprecated:
Use the version that doesn't take createdate, modifydate or description parameters
Parameters:
p_name Function name
p_func Actual function
p_parms Parameter list (null if none needed)
p_bInWin32 pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
void(*)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context)  p_func,
PARM *  p_parms,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for a void function.

Parameters:
p_name Function name
p_func Actual function
p_parms Parameter list (null if none needed)
p_bInWin32 pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
double(*)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context)  p_func,
PARM *  p_parms,
int  p_createdate,
int  p_modifydate = 0,
const char *  p_description = 0,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for a function returning double.

Deprecated:
Use the version that doesn't take createdate, modifydate or description parameters
Parameters:
p_name Function name
p_func Actual function
p_parms Parameter list (null if none needed)
p_bInWin32 pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
double(*)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context)  p_func,
PARM *  p_parms,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for a function returning double.

Parameters:
p_name Function name
p_func Actual function
p_parms Parameter list (null if none needed)
p_bInWin32 pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
STRING *(*)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context)  p_func,
PARM *  p_parms,
int  p_createdate,
int  p_modifydate = 0,
const char *  p_description = 0,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for a function returning an SML::STRING, The string returned should be allocated by SML::CONTEXT::StringAlloc().

Deprecated:
Use the version that doesn't take createdate, modifydate or description parameters
Parameters:
p_name Function name
p_func Actual function
p_parms Parameter list (null if none needed)
p_bInWin32 pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
STRING *(*)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context)  p_func,
PARM *  p_parms,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for a function returning an SML::STRING.

The string returned should be allocated by SML::CONTEXT::StringAlloc()

Parameters:
p_name Function name
p_func Actual function
p_parms Parameter list (null if none needed)
p_bInWin32 pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
CLASSHASH *(*)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context)  p_func,
STYPE  p_type,
PARM *  p_parms,
const char *  p_classname,
int  p_createdate,
int  p_modifydate = 0,
const char *  p_description = 0,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for a function returning an SML::CLASSHASH.

Deprecated:
Use the version that doesn't take createdate, modifydate or description parameters
Parameters:
p_name Function name
p_func Actual function
p_type STYPE_ClassHashFunc or STYPE_NumHashFunc
p_parms Parameter list (null if none needed)
p_classname Name of class held in hash (NULL if STYPE_NumHashFunc)
p_bInWin32 Pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
CLASSHASH *(*)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context)  p_func,
STYPE  p_type,
PARM *  p_parms,
const char *  p_classname,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for a function returning an SML::CLASSHASH.

Parameters:
p_name Function name
p_func Actual function
p_type STYPE_ClassHashFunc or STYPE_NumHashFunc
p_parms Parameter list (null if none needed)
p_classname Name of class held in hash (NULL if STYPE_NumHashFunc)
p_bInWin32 Pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
void *(*)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context)  p_func,
STYPE  p_type,
PARM *  p_parms,
const char *  p_classname,
int  p_createdate,
int  p_modifydate = 0,
const char *  p_description = 0,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for a function returning a class.

Deprecated:
Use the version that doesn't take createdate, modifydate or description parameters
Parameters:
p_name Function name
p_func Actual function
p_type STYPE_ClassCopyFunc if return value should be freed by SML when it's done with it. STYPE_ClassRefFunc if return value should not be freed.
p_parms Parameter list (null if none needed)
p_classname Name of class returned. Use SMLCLASSNAME macros from sml.h if possible (or define them if they're not there)
p_bInWin32 pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
void *(*)(int numargs, ARG *args, UINT8 *argtypes, CONTEXT *context)  p_func,
STYPE  p_type,
PARM *  p_parms,
const char *  p_classname,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for a function returning a class.

Parameters:
p_name Function name
p_func Actual function
p_type STYPE_ClassCopyFunc if return value should be freed by SML when it's done with it. STYPE_ClassRefFunc if return value should not be freed.
p_parms Parameter list (null if none needed)
p_classname Name of class returned. Use SMLCLASSNAME macros from sml.h if possible (or define them if they're not there)
p_bInWin32 Pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
VOIDFUNC  p_func,
SMLFUNCSIG  p_signature,
PARM *  p_parms,
int  p_createdate,
int  p_modifydate = 0,
const char *  p_ClassName = 0,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for an arbitrary C or C++ function See the documentation of SML::AUTOCLASS_NOALLOC_T::AddMethod for details.

Deprecated:
Use the version that doesn't take createdate or modifydate parameters
Parameters:
p_name Function name
p_func Function to call. Actual function should match the signature specified by the p_signature parameter, but must be cast to (VOIDFUNC). SML Runtime will take care of the magic.
p_signature function signature (see SMLFUNCSIG)
p_parms Parameters (NULL if none needed)
p_bInWin32 pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
VOIDFUNC  p_func,
SMLFUNCSIG  p_signature,
PARM *  p_parms,
const char *  p_ClassName = 0,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for an arbitrary C or C++ function See the documentation of SML::AUTOCLASS_NOALLOC_T::AddMethod for details.

Parameters:
p_name Function name
p_func Function to call. Actual function should match the signature specified by the p_signature parameter, but must be cast to (VOIDFUNC). SML Runtime will take care of the magic.
p_signature function signature (see SMLFUNCSIG)
p_parms Parameters (NULL if none needed)
p_bInWin32 pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
METHODPTR  p_method,
SMLFUNCSIG  p_signature,
PARM *  p_parms,
int  p_createdate,
int  p_modifydate = 0,
const char *  p_ClassName = 0,
bool  p_bInWin32 = true 
) [inline]

Construct an SML::FUNCDEF for an arbitrary C or C++ function See the documentation of SML::AUTOCLASS_NOALLOC_T::AddMethod for details.

Deprecated:
Use SML::AUTOCLASS templates instead
Parameters:
p_name Function name
p_bInWin32 pass false if function not available in WIN32_NATIVE builds
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
SMLFUNCSIG  p_signature,
PARM *  p_parms,
int  p_createdate,
int  p_modifydate = 0,
const char *  p_ClassName = 0 
) [inline]

Use this one in an #ifdef for things which cannot be installed in the current compile environment (like WIN32_NATIVE).

Deprecated:
Use SML::AUTOCLASS templates instead
Parameters:
p_name Function name
SML::FUNCDEF::FUNCDEF ( const char *  p_name,
STYPE  p_type,
PARM *  p_parms,
const char *  p_classname,
int  p_createdate,
int  p_modifydate = 0,
const char *  p_description = 0,
bool  bInWin32Native = false 
) [inline]

Use this one in an #ifdef for things which cannot be installed in the current compile environment (like WIN32_NATIVE).

Deprecated:
Use SML::AUTOCLASS templates instead
The documentation for this class was generated from the following file:
Generated on Sun Oct 7 21:39:12 2012 for TNTsdk 2012 by  doxygen 1.6.1