Simple Virtual Machine
A simple but flexible virtual machine
SVM variables detection

This module contains API functions to detect variable types. More...

Functions

SVM_FUNCTION SVM_Boolean svm_variable_is_valid (const void *svm, const SVM_Variable variable)
 This function checks whether a variable is valid. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_value (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a value. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_structure (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a structure. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_parameter (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a parameter. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_accesscontrol (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains an access control. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_memoryzone (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a memory zone. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_code (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a SVM code. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_kernel (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a kernel. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_process (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a process. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_processlock (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a process lock. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_scheduler (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a scheduler. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_lock (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a lock. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_lockguardread (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a lock guard in read mode. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_lockguardwrite (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains a lock guard in write mode. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_eventqueue (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains an event queue. More...
 
SVM_FUNCTION SVM_Boolean svm_variable_type_is_eventqueueaddress (const void *svm, const SVM_Variable variable)
 This function checks whether a variable contains an event queue address. More...
 

Detailed Description

This module contains API functions to detect variable types.

Function Documentation

◆ svm_variable_is_valid()

SVM_FUNCTION SVM_Boolean svm_variable_is_valid ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable is valid.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable is known by the Virtual Machine, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_accesscontrol()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_accesscontrol ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains an access control.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_AccessControl, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_code()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_code ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a SVM code.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Code, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_eventqueue()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_eventqueue ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains an event queue.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Event_Queue, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_eventqueueaddress()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_eventqueueaddress ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains an event queue address.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Event_Queue_Address, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_kernel()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_kernel ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a kernel.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Kernel, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_lock()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_lock ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a lock.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Lock, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_lockguardread()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_lockguardread ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a lock guard in read mode.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_LockGuard_Read, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_lockguardwrite()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_lockguardwrite ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a lock guard in write mode.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_LockGuard_Write, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_memoryzone()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_memoryzone ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a memory zone.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Memory_Zone, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_parameter()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_parameter ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a parameter.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Parameter, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_process()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_process ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a process.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Process, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_processlock()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_processlock ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a process lock.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Process_Lock, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_scheduler()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_scheduler ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a scheduler.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Scheduler, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_structure()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_structure ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a structure.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Structure, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_variable_type_is_value()

SVM_FUNCTION SVM_Boolean svm_variable_type_is_value ( const void *  svm,
const SVM_Variable  variable 
)

This function checks whether a variable contains a value.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to diagnose.
Returns
TRUE if the variable can be used as a SVM_Value, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)