Simple Virtual Machine
A simple but flexible virtual machine
SVM plugin entry point values

This module contains API functions to handle SVM plugin entry point values. More...

Functions

SVM_FUNCTION SVM_Value_PluginEntryPoint svm_value_pluginentrypoint_new (const void *svm, const SVM_Value_String plugin_name, const SVM_Value_String entry_name)
 This function creates a plugin entry point value the SVM can store in its memories from two string values. More...
 
SVM_FUNCTION SVM_Value_PluginEntryPoint svm_value_pluginentrypoint_new__string (const void *svm, const SVM_String plugin_name, const SVM_String entry_name)
 This function creates a plugin entry point value the SVM can store in its memories from two SVM_String. More...
 
SVM_FUNCTION SVM_Value_PluginEntryPoint svm_value_pluginentrypoint_new__raw (const void *svm, const char *plugin_name, const char *entry_name)
 This function creates a plugin entry point value the SVM can store in its memories from two C nul-terminated strings. More...
 
SVM_FUNCTION SVM_Value_PluginEntryPoint svm_value_pluginentrypoint_new_prefix (const void *svm, const SVM_Value_PluginEntryPoint pep, const char *prefix)
 This function creates a plugin entry point value the SVM can store in its memories from a plugin entry point and a C nul-terminated string. More...
 
SVM_FUNCTION SVM_Value_PluginEntryPoint svm_value_pluginentrypoint_new_null (const void *svm)
 This function creates a plugin entry point value the SVM can store in its memories without a value. More...
 
SVM_FUNCTION SVM_Boolean svm_value_type_is_pluginentrypoint (const void *svm, const SVM_Value value)
 This function checks whether a value contains a plugin entry point. More...
 
SVM_FUNCTION SVM_String svm_value_pluginentrypoint_get_plugin (const void *svm, const SVM_Value_PluginEntryPoint pep)
 This function extracts the plugin name contained in a plugin entry point value. More...
 
SVM_FUNCTION SVM_String svm_value_pluginentrypoint_get_entry (const void *svm, const SVM_Value_PluginEntryPoint pep)
 This function extracts the entry name contained in a plugin entry point value. More...
 
SVM_FUNCTION void svm_value_pluginentrypoint_set (const void *svm, SVM_Value_PluginEntryPoint value, const SVM_Value_PluginEntryPoint pluginentrypoint)
 This function replaces the pluginentrypoint value by another pluginentrypoint value. More...
 
SVM_FUNCTION void svm_value_pluginentrypoint_set_plugin (const void *svm, SVM_Value_PluginEntryPoint value, const SVM_Value_String plugin_name)
 This function replaces the plugin name contained in a plugin entry point value from a string value. More...
 
SVM_FUNCTION void svm_value_pluginentrypoint_set_plugin__string (const void *svm, SVM_Value_PluginEntryPoint value, const SVM_String plugin_name)
 This function replaces the plugin name contained in a plugin entry point value from a SVM_String. More...
 
SVM_FUNCTION void svm_value_pluginentrypoint_set_plugin__raw (const void *svm, SVM_Value_PluginEntryPoint value, const char *plugin_name)
 This function replaces the plugin name contained in a plugin entry point value from a C nul-terminated string. More...
 
SVM_FUNCTION void svm_value_pluginentrypoint_set_entry (const void *svm, SVM_Value_PluginEntryPoint value, const SVM_Value_String entry_name, const char *prefix)
 This function replaces the entry name contained in a plugin entry point value from a string value and an optional C nul-terminated string prefix. More...
 
SVM_FUNCTION void svm_value_pluginentrypoint_set_entry__string (const void *svm, SVM_Value_PluginEntryPoint value, const SVM_String entry_name, const char *prefix)
 This function replaces the entry name contained in a plugin entry point value from a SVM_String and an optional C nul-terminated string prefix. More...
 
SVM_FUNCTION void svm_value_pluginentrypoint_set_entry__raw (const void *svm, SVM_Value_PluginEntryPoint value, const char *entry_name, const char *prefix)
 This function replaces the entry name contained in a plugin entry point value from two C nul-terminated strings. More...
 
SVM_FUNCTION void svm_value_pluginentrypoint_set_pluginentry (const void *svm, SVM_Value_PluginEntryPoint value, const SVM_Value_String plugin_name, const SVM_Value_String entry_name, const char *prefix)
 This function replaces the plugin name and the entry name contained in a plugin entry point value from two string values and an optional C nul-terminated string prefix. More...
 
SVM_FUNCTION void svm_value_pluginentrypoint_set_pluginentry__string (const void *svm, SVM_Value_PluginEntryPoint value, const SVM_String plugin_name, const SVM_String entry_name, const char *prefix)
 This function replaces the plugin name and the entry name contained in a plugin entry point value from two SVM_String and an optional C nul-terminated string prefix. More...
 
SVM_FUNCTION void svm_value_pluginentrypoint_set_pluginentry__raw (const void *svm, SVM_Value_PluginEntryPoint value, const char *plugin_name, const char *entry_name, const char *prefix)
 This function replaces the plugin name and the entry name contained in a plugin entry point value from three C nul-terminated strings. More...
 

Detailed Description

This module contains API functions to handle SVM plugin entry point values.

Function Documentation

◆ svm_value_pluginentrypoint_get_entry()

SVM_FUNCTION SVM_String svm_value_pluginentrypoint_get_entry ( const void *  svm,
const SVM_Value_PluginEntryPoint  pep 
)

This function extracts the entry name contained in a plugin entry point value.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]pepThe plugin entry point value to extract from.
Returns
The entry name contained in the value.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the pep parameter does not contain a plugin entry point.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_pluginentrypoint_get_plugin()

SVM_FUNCTION SVM_String svm_value_pluginentrypoint_get_plugin ( const void *  svm,
const SVM_Value_PluginEntryPoint  pep 
)

This function extracts the plugin name contained in a plugin entry point value.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]pepThe plugin entry point value to extract from.
Returns
The plugin name contained in the value.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the pep parameter does not contain a plugin entry point.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_pluginentrypoint_new()

SVM_FUNCTION SVM_Value_PluginEntryPoint svm_value_pluginentrypoint_new ( const void *  svm,
const SVM_Value_String  plugin_name,
const SVM_Value_String  entry_name 
)

This function creates a plugin entry point value the SVM can store in its memories from two string values.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]plugin_nameThe name of the plugin containing the plugin object.
[in]entry_nameThe name of the plugin object within the plugin.
Returns
The plugin entry point value.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_value_pluginentrypoint_new__raw()

SVM_FUNCTION SVM_Value_PluginEntryPoint svm_value_pluginentrypoint_new__raw ( const void *  svm,
const char *  plugin_name,
const char *  entry_name 
)

This function creates a plugin entry point value the SVM can store in its memories from two C nul-terminated strings.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]plugin_nameThe name of the plugin containing the plugin object.
[in]entry_nameThe name of the plugin object within the plugin.
Returns
The plugin entry point value.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_value_pluginentrypoint_new__string()

SVM_FUNCTION SVM_Value_PluginEntryPoint svm_value_pluginentrypoint_new__string ( const void *  svm,
const SVM_String  plugin_name,
const SVM_String  entry_name 
)

This function creates a plugin entry point value the SVM can store in its memories from two SVM_String.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]plugin_nameThe name of the plugin containing the plugin object.
[in]entry_nameThe name of the plugin object within the plugin.
Returns
The plugin entry point value.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_value_pluginentrypoint_new_null()

SVM_FUNCTION SVM_Value_PluginEntryPoint svm_value_pluginentrypoint_new_null ( const void *  svm)

This function creates a plugin entry point value the SVM can store in its memories without a value.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
Returns
A non initialised plugin entry point value.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_value_pluginentrypoint_new_prefix()

SVM_FUNCTION SVM_Value_PluginEntryPoint svm_value_pluginentrypoint_new_prefix ( const void *  svm,
const SVM_Value_PluginEntryPoint  pep,
const char *  prefix 
)

This function creates a plugin entry point value the SVM can store in its memories from a plugin entry point and a C nul-terminated string.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]pepThe plugin entry point to prefix.
[in]prefixThe prefix to add to the entry name.

The plugin entry point "<plugin name>.<entry name>" is transformed into "<plugin name>.<prefix>_<entry name>".

Returns
The plugin entry point value having a prefix.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_value_pluginentrypoint_set()

SVM_FUNCTION void svm_value_pluginentrypoint_set ( const void *  svm,
SVM_Value_PluginEntryPoint  value,
const SVM_Value_PluginEntryPoint  pluginentrypoint 
)

This function replaces the pluginentrypoint value by another pluginentrypoint value.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in,out]valueThe plugin entry point value to update.
[in]pluginentrypointThe plugin entry point to use for update.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the value parameter does not contain an plugin entry point.
FAILUREinterruption when the pluginentrypoint parameter does not contain an plugin entry point.
FAILUREinterruption when the value is a constant.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_pluginentrypoint_set_entry()

SVM_FUNCTION void svm_value_pluginentrypoint_set_entry ( const void *  svm,
SVM_Value_PluginEntryPoint  value,
const SVM_Value_String  entry_name,
const char *  prefix 
)

This function replaces the entry name contained in a plugin entry point value from a string value and an optional C nul-terminated string prefix.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in,out]valueThe plugin entry point value to update.
[in]entry_nameThe new entry name.
[in]prefixAn optional prefix. The prefix is ignored when it is a null pointer.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the value parameter does not contain a plugin entry point.
FAILUREinterruption when the value is a constant.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_pluginentrypoint_set_entry__raw()

SVM_FUNCTION void svm_value_pluginentrypoint_set_entry__raw ( const void *  svm,
SVM_Value_PluginEntryPoint  value,
const char *  entry_name,
const char *  prefix 
)

This function replaces the entry name contained in a plugin entry point value from two C nul-terminated strings.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in,out]valueThe plugin entry point value to update.
[in]entry_nameThe new entry name.
[in]prefixAn optional prefix. The prefix is ignored when it is a null pointer.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the value parameter does not contain a plugin entry point.
FAILUREinterruption when the value is a constant.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_pluginentrypoint_set_entry__string()

SVM_FUNCTION void svm_value_pluginentrypoint_set_entry__string ( const void *  svm,
SVM_Value_PluginEntryPoint  value,
const SVM_String  entry_name,
const char *  prefix 
)

This function replaces the entry name contained in a plugin entry point value from a SVM_String and an optional C nul-terminated string prefix.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in,out]valueThe plugin entry point value to update.
[in]entry_nameThe new entry name.
[in]prefixAn optional prefix. The prefix is ignored when it is a null pointer.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the value parameter does not contain a plugin entry point.
FAILUREinterruption when the value is a constant.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_pluginentrypoint_set_plugin()

SVM_FUNCTION void svm_value_pluginentrypoint_set_plugin ( const void *  svm,
SVM_Value_PluginEntryPoint  value,
const SVM_Value_String  plugin_name 
)

This function replaces the plugin name contained in a plugin entry point value from a string value.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in,out]valueThe plugin entry point value to update.
[in]plugin_nameThe new plugin name.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the value parameter does not contain a plugin entry point.
FAILUREinterruption when the value is a constant.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_pluginentrypoint_set_plugin__raw()

SVM_FUNCTION void svm_value_pluginentrypoint_set_plugin__raw ( const void *  svm,
SVM_Value_PluginEntryPoint  value,
const char *  plugin_name 
)

This function replaces the plugin name contained in a plugin entry point value from a C nul-terminated string.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in,out]valueThe plugin entry point value to update.
[in]plugin_nameThe new plugin name.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the value parameter does not contain a plugin entry point.
FAILUREinterruption when the value is a constant.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_pluginentrypoint_set_plugin__string()

SVM_FUNCTION void svm_value_pluginentrypoint_set_plugin__string ( const void *  svm,
SVM_Value_PluginEntryPoint  value,
const SVM_String  plugin_name 
)

This function replaces the plugin name contained in a plugin entry point value from a SVM_String.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in,out]valueThe plugin entry point value to update.
[in]plugin_nameThe new plugin name.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the value parameter does not contain a plugin entry point.
FAILUREinterruption when the value is a constant.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_pluginentrypoint_set_pluginentry()

SVM_FUNCTION void svm_value_pluginentrypoint_set_pluginentry ( const void *  svm,
SVM_Value_PluginEntryPoint  value,
const SVM_Value_String  plugin_name,
const SVM_Value_String  entry_name,
const char *  prefix 
)

This function replaces the plugin name and the entry name contained in a plugin entry point value from two string values and an optional C nul-terminated string prefix.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in,out]valueThe plugin entry point value to update.
[in]plugin_nameThe new plugin name.
[in]entry_nameThe new entry name.
[in]prefixAn optional prefix. The prefix is ignored when it is a null pointer.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the value parameter does not contain a plugin entry point.
FAILUREinterruption when the value is a constant.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_pluginentrypoint_set_pluginentry__raw()

SVM_FUNCTION void svm_value_pluginentrypoint_set_pluginentry__raw ( const void *  svm,
SVM_Value_PluginEntryPoint  value,
const char *  plugin_name,
const char *  entry_name,
const char *  prefix 
)

This function replaces the plugin name and the entry name contained in a plugin entry point value from three C nul-terminated strings.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in,out]valueThe plugin entry point value to update.
[in]plugin_nameThe new plugin name.
[in]entry_nameThe new entry name.
[in]prefixAn optional prefix. The prefix is ignored when it is a null pointer.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the value parameter does not contain a plugin entry point.
FAILUREinterruption when the value is a constant.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_pluginentrypoint_set_pluginentry__string()

SVM_FUNCTION void svm_value_pluginentrypoint_set_pluginentry__string ( const void *  svm,
SVM_Value_PluginEntryPoint  value,
const SVM_String  plugin_name,
const SVM_String  entry_name,
const char *  prefix 
)

This function replaces the plugin name and the entry name contained in a plugin entry point value from two SVM_String and an optional C nul-terminated string prefix.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in,out]valueThe plugin entry point value to update.
[in]plugin_nameThe new plugin name.
[in]entry_nameThe new entry name.
[in]prefixAn optional prefix. The prefix is ignored when it is a null pointer.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the value parameter does not contain a plugin entry point.
FAILUREinterruption when the value is a constant.
See also
svm_value_type_is_pluginentrypoint
svm_value_type_get

◆ svm_value_type_is_pluginentrypoint()

SVM_FUNCTION SVM_Boolean svm_value_type_is_pluginentrypoint ( const void *  svm,
const SVM_Value  value 
)

This function checks whether a value contains a plugin entry point.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]valueThe value to be diagnosed.
Returns
TRUE if the value contains a plugin entry point, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)