group Executor

Description

These functions allow for the execution of code. The main interface is ferite_script_execute(), but to execute individual functions there is ferite_call_function(). There are other convinience functions.

group contents Functions ferite_add_to_parameter_list(FeriteVariable,FeriteVariable) - Place a parameter within the next availible place within the parameter list ferite_call_function(FeriteScript,FeriteFunction,FeriteVariable) - This will call any function from it's function pointer and a parameter list ferite_clean_up_exec_rec(FeriteScript,FeriteExecuteRex) - Clean up and Execution Record ferite_create_parameter_list(int) - Create a parameter list, NULLify it and then return it ferite_create_parameter_list_from_data(script,format) - This function is used to make creating a parameter list very easy. ferite_delete_parameter_list(FeriteScript,FeriteVariable) - Delete a parameter list, and destroy any disposable variables ferite_is_executing(FeriteScript) - Return whether a script is executing ferite_script_execute(FeriteScript) - Run a script ferite_script_function_execute(FeriteScript,void,FeriteFunction,FeriteVariable) - Execute a function within a script ferite_script_real_function_execute(FeriteScript,void,FeriteFunction,FeriteNamespace,FeriteExecuteRec,FeriteVariable) - Execute a eval operator compiled script ferite_stop_execution(FeriteScript) - Stop the script executing

Functions

function ferite_add_to_parameter_list Place a parameter within the next availible place within the parameter list Declaration:     FeriteVariable **ferite_add_to_parameter_list( FeriteVariable **list, FeriteVariable *var ) Parameters:     Parameter #1: FeriteVariable **list - The list to place it in     Parameter #2: FeriteVariable *var - The variable to place within the list Returns:     The list passed to the function

function ferite_call_function This will call any function from it's function pointer and a parameter list Declaration:     FeriteVariable *ferite_call_function( FeriteScript *script, FeriteFunction *function, FeriteVariable **params ) Description: This function will work on either an internal or native function and will happily choose the correct function if it happens to be overloaded. Parameters:     Parameter #1: FeriteScript *script - The current script     Parameter #2: FeriteFunction *function - The function to be called     Parameter #3: FeriteVariable **params - The parameter list to be passed to the function

function ferite_clean_up_exec_rec Clean up and Execution Record Declaration:     void ferite_clean_up_exec_rec( FeriteScript *script, FeriteExecuteRec *exec ) Parameters:     Parameter #1: FeriteScript *script - The current script     Parameter #2: FeriteExecuteRex *exec - Pointer to the execution record

function ferite_create_parameter_list Create a parameter list, NULLify it and then return it Declaration:     FeriteVariable **ferite_create_parameter_list( int size ) Parameters:     Parameter #1: int size - The number of parameters to hold Returns:     The created list

function ferite_create_parameter_list_from_data This function is used to make creating a parameter list very easy. Declaration:     FeriteVariable **ferite_create_parameter_list_from_data( FeriteScript *script, char *format, ... ) Parameters:     Parameter #1: script The - current script     Parameter #2: format The - signiture for the parameters Returns:     The list that is created.

function ferite_delete_parameter_list Delete a parameter list, and destroy any disposable variables Declaration:     void ferite_delete_parameter_list( FeriteScript *script, FeriteVariable **list ) Parameters:     Parameter #1: FeriteScript *script - The current script     Parameter #2: FeriteVariable **list - The list to be deleted

function ferite_is_executing Return whether a script is executing Declaration:     int ferite_is_executing( FeriteScript *script ) Parameters:     Parameter #1: FeriteScript *script - The script to query Returns:     FE_TRUE if the script is executing, FE_FALSE otherwise

function ferite_script_execute Run a script Declaration:     int ferite_script_execute( FeriteScript *script ) Parameters:     Parameter #1: FeriteScript *script - The script to run Returns:     FE_TRUE on successfull execution, FE_FALSE otherwise

function ferite_script_function_execute Execute a function within a script Declaration:     int ferite_script_function_execute( FeriteScript *script, void *container, FeriteFunction *function, FeriteVariable **params ) Parameters:     Parameter #1: FeriteScript *script - The current script     Parameter #2: void *container - The container the function is running from namespace/class/object     Parameter #3: FeriteFunction *function - The function to execute     Parameter #4: FeriteVariable **params - The calling arguments Returns:     The variable returned from the function

function ferite_script_real_function_execute Execute a eval operator compiled script Declaration:     FeriteVariable *ferite_script_real_function_execute( FeriteScript *script, void *container, FeriteFunction *function, FeriteNamespace *ns, FeriteExecuteRec *exec, FeriteVariable **params ) Parameters:     Parameter #1: FeriteScript *script - The current script to run     Parameter #2: void *container - The container the function is running from namespace/class/object     Parameter #3: FeriteFunction *function - The function to execute     Parameter #4: FeriteNamespace *ns - The scripts main namespace     Parameter #5: FeriteExecuteRec *exec - The execute records for the current script     Parameter #6: FeriteVariable **params - The parameters passed to the function Returns:     The return value from the function on successfull execution, NULL otherwise

function ferite_stop_execution Stop the script executing Declaration:     void ferite_stop_execution( FeriteScript *script ) Parameters:     Parameter #1: FeriteScript *script - The script to stop

Automatically generated at 12:07PM, Wednesday 25 May 2005 by feritedoc.