Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Data Fields
afw_value_function_definition_s Struct Reference

Struct for function value. More...

#include <afw_value.h>

Data Fields

const afw_value_inf_tinf
 
const afw_object_tobject
 Object representing function.
 
afw_utf8_t category
 Category of function.
 
afw_utf8_t functionId
 Function id of function.
 
afw_utf8_t untypedFunctionId
 Function id without <dataType>. More...
 
afw_utf8_t functionLabel
 Label used internally for function.
 
afw_utf8_t camelCaseFunctionLabel
 functionLabel converted to camel case.
 
afw_utf8_t afwCamelCaseFunctionLabel
 functionLabel prefixed with "afw" and converted to camel case.
 
afw_utf8_t brief
 Brief description.
 
afw_utf8_t description
 Description of function.
 
afw_utf8_t functionSignature
 Function signature.
 
afw_utf8_t functionDeclaration
 Function declaration.
 
afw_utf8_t op
 Optional operator for function.
 
afw_function_execute_cb_t execute
 Function called to execute this Adaptive function.
 
afw_function_arg_check_t arg_check
 Optional function called to check args.
 
afw_integer_t numberOfRequiredParameters
 The number of required parameters.
 
afw_integer_t maximumNumberOfParameters
 The maximum number of required parameters or -1 is no max.
 
const afw_value_function_parameter_t *const * parameters
 Function parameters.
 
const afw_size_t parameters_count
 Parameters count.
 
const afw_value_function_parameter_treturns
 Function returns.
 
const afw_utf8_tpolymorphicDataTypes
 If this is polymorphic function, these are supported data types.
 
const afw_data_type_tdata_type
 If this is a data type method, this is the data type.
 
afw_utf8_t dataType
 If this is a data type method, this is the data type id.
 
const afw_utf8_z_t *const * errorsThrown
 Errors thrown or NULL. More...
 
const afw_utf8_tsideEffects
 Side effects or NULL.
 
afw_integer_t dataTypeMethodNumber
 Data type member number.
 
afw_octet_t scriptSupportNumber
 See AFW_VALUE_SCRIPT_SUPPORT_NUMBER_* #defines.
 
afw_boolean_t polymorphic
 True if this is a polymorphic function.
 
afw_boolean_t polymorphicExecuteFunctionEvaluatesFirstParameter
 True if polymorphic execute evaluates first parameter.
 
afw_boolean_t deprecated
 This function is deprecated.
 
afw_boolean_t pure
 Given the same exact parameter values, this function will always return the same result an not cause side effects.
 
afw_boolean_t signatureOnly
 This is only a signature with an unimplemented execute function.
 

Detailed Description

Struct for function value.

Definition at line 102 of file afw_value.h.

Field Documentation

◆ errorsThrown

const afw_utf8_z_t* const* errorsThrown

Errors thrown or NULL.

This is an array of afw_utf8_z_t * key, value pairs representing an array of objects. A NULL indicates the end of an object and and additional NULL represents the end of the list of objects.

This value accessor can be used: null_terminated_array_of_utf8_z_key_value_pair_objects

Definition at line 184 of file afw_value.h.

◆ untypedFunctionId

afw_utf8_t untypedFunctionId

Function id without <dataType>.

This is only different from functionId if polymorphic.

Definition at line 118 of file afw_value.h.


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