Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions | Variables

Adaptive Function url_encode<string> More...

Functions

const afw_value_tafw_function_execute_compile_template (afw_function_execute_t *x)
 Adaptive Function compile<template> More...
 
const afw_value_tafw_function_execute_evaluate_template (afw_function_execute_t *x)
 Adaptive Function evaluate<template> More...
 

Variables

 afw_function_definition_bag_size_template
 Function definition bag_size<template>
 
 afw_function_definition_bag_template
 Adaptive Function bag_size<template> More...
 
 afw_function_definition_compile_template
 Adaptive Function bag<template> More...
 
 afw_function_definition_eq_template
 Function definition eq<template>
 
 afw_function_definition_eqx_template
 Adaptive Function eq<template> More...
 
 afw_function_definition_evaluate_template
 Adaptive Function eqx<template> More...
 
 afw_function_definition_ge_template
 Function definition ge<template>
 
 afw_function_definition_gt_template
 Adaptive Function ge<template> More...
 
 afw_function_definition_is_template
 Adaptive Function gt<template> More...
 
 afw_function_definition_le_template
 Adaptive Function is<template> More...
 
 afw_function_definition_lt_template
 Adaptive Function le<template> More...
 
 afw_function_definition_ne_template
 Adaptive Function lt<template> More...
 
 afw_function_definition_nex_template
 Adaptive Function ne<template> More...
 
 afw_function_definition_template
 Adaptive Function nex<template> More...
 
 afw_function_definition_to_string_template
 Adaptive Function template More...
 

Detailed Description

Adaptive Function url_encode<string>

Parameters
xfunction execute parameter.

URL encode a value or bag of values.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function url_encode<string>(
unencoded: string
): string;

Parameters:

unencoded - (string) URL encode a single value. See the url_encode method for the data type of more details.

Returns:

(string) URI encoded string.

Implemented by afw_function_execute_url_encode()


template adaptive functions.

Function Documentation

◆ afw_function_execute_compile_template()

const afw_value_t* afw_function_execute_compile_template ( afw_function_execute_t x)

Adaptive Function compile<template>

Parameters
xfunction execute parameter.

Compile template value and return either an unevaluated adaptive value or a string containing the compiler listing.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function compile<template>(
source: template,
listing?: any
): unevaluated;

Parameters:

source - (template) template string to compile.

listing - (optional any dataType) If specified, a compiler listing is produced instead of an unevaluated expression value.

This parameter can be an integer between 0 and 10 of a string that is used for indentation. If 0 is specified, no whitespace is added to the resulting string. If 1 through 10 is specified, that number of spaces is used.

Returns:

(unevaluated)

Definition at line 57 of file afw_function_template.c.

◆ afw_function_execute_evaluate_template()

const afw_value_t* afw_function_execute_evaluate_template ( afw_function_execute_t x)

Adaptive Function evaluate<template>

Parameters
xfunction execute parameter.

Compile and evaluate template value.

This function is not pure, so it may return a different result given exactly the same parameters.

Declaration:

function evaluate<template>(
source: template,
additionalUntrustedQualifiedVariables?: (object _AdaptiveHybridPropertiesObjects_)
): unevaluated;

Parameters:

source - (template) template string to compile and evaluate.

additionalUntrustedQualifiedVariables - (optional object AdaptiveHybridPropertiesObjects) This parameter supplies additional qualified variables that can be accessed during evaluation. These variables will not be used by anything that needs to ensure its qualified variables must come from a trusted source, such as authorization. This parameter is intended to be used for testing only and should not be used for anything running in production.

Returns:

(unevaluated)

Definition at line 122 of file afw_function_template.c.

Variable Documentation

◆ afw_function_definition_bag_template

afw_function_definition_bag_template

Adaptive Function bag_size<template>

Parameters
xfunction execute parameter.

This returns the integer number of values in list.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function bag_size<template>(
value: (list template)
): integer;

Parameters:

value - (list template)

Returns:

(integer)

Implemented by afw_function_execute_bag_size()


Function definition bag<template>

Definition at line 28985 of file afw_function_bindings.h.

◆ afw_function_definition_compile_template

afw_function_definition_compile_template

Adaptive Function bag<template>

Parameters
xfunction execute parameter.

Takes any number of template values and returns a list of list.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function bag<template>(
...values: (list of (list template))
): (list template);

Parameters:

values - (0 or more list template)

Returns:

(list template)

Implemented by afw_function_execute_bag()


Function definition compile<template>

Definition at line 29019 of file afw_function_bindings.h.

◆ afw_function_definition_eqx_template

afw_function_definition_eqx_template

Adaptive Function eq<template>

Parameters
xfunction execute parameter.

Determine if template arg1 is equal to the value of arg2 converted to the data type of arg1 then return the boolean result. Use "eqx" ("===") instead if you want false to be returned if arg1 and arg2's data type don't match.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function eq<template>(
arg1: template,
arg2: any
): boolean;

Parameters:

arg1 - (template)

arg2 - (any dataType)

Returns:

(boolean)

Errors thrown:

conversion - arg2 cannot be converted to the data type of arg1.

Implemented by afw_function_execute_eq()


Function definition eqx<template>

Definition at line 29105 of file afw_function_bindings.h.

◆ afw_function_definition_evaluate_template

afw_function_definition_evaluate_template

Adaptive Function eqx<template>

Parameters
xfunction execute parameter.

Determine if for template arg1 is equal to the value and data type of arg2 then return the boolean result. Use "eq" ("==") instead if you want arg2 to be converted to the data type of arg1 before comparison.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function eqx<template>(
arg1: template,
arg2: any
): boolean;

Parameters:

arg1 - (template)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by afw_function_execute_eqx()


Function definition evaluate<template>

Definition at line 29144 of file afw_function_bindings.h.

◆ afw_function_definition_gt_template

afw_function_definition_gt_template

Adaptive Function ge<template>

Parameters
xfunction execute parameter.

Checks for template arg1 is greater than or equal to template arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function ge<template>(
arg1: template,
arg2: template
): boolean;

Parameters:

arg1 - (template)

arg2 - (template)

Returns:

(boolean)

Implemented by afw_function_execute_ge()


Function definition gt<template>

Definition at line 29224 of file afw_function_bindings.h.

◆ afw_function_definition_is_template

afw_function_definition_is_template

Adaptive Function gt<template>

Parameters
xfunction execute parameter.

Checks for template arg1 is greater than template arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function gt<template>(
arg1: template,
arg2: template
): boolean;

Parameters:

arg1 - (template)

arg2 - (template)

Returns:

(boolean)

Implemented by afw_function_execute_gt()


Function definition is<template>

Definition at line 29262 of file afw_function_bindings.h.

◆ afw_function_definition_le_template

afw_function_definition_le_template

Adaptive Function is<template>

Parameters
xfunction execute parameter.

Checks whether value is dataType template and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function is<template>(
value: any
): boolean;

Parameters:

value - (any dataType) Value to check.

Returns:

(boolean)

Implemented by afw_function_execute_is()


Function definition le<template>

Definition at line 29296 of file afw_function_bindings.h.

◆ afw_function_definition_lt_template

afw_function_definition_lt_template

Adaptive Function le<template>

Parameters
xfunction execute parameter.

Checks for template arg1 is less than or equal to template arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function le<template>(
arg1: template,
arg2: any
): boolean;

Parameters:

arg1 - (template)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by afw_function_execute_le()


Function definition lt<template>

Definition at line 29334 of file afw_function_bindings.h.

◆ afw_function_definition_ne_template

afw_function_definition_ne_template

Adaptive Function lt<template>

Parameters
xfunction execute parameter.

Checks for template arg1 is less that template arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function lt<template>(
arg1: template,
arg2: template
): boolean;

Parameters:

arg1 - (template)

arg2 - (template)

Returns:

(boolean)

Implemented by afw_function_execute_lt()


Function definition ne<template>

Definition at line 29372 of file afw_function_bindings.h.

◆ afw_function_definition_nex_template

afw_function_definition_nex_template

Adaptive Function ne<template>

Parameters
xfunction execute parameter.

Determine if template arg1 is not equal to the value of arg2 converted to the data type of arg1 then return the boolean result. Use "nex" ("!==") instead if you want true to be returned if arg1 and arg2's data type don't match.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function ne<template>(
arg1: template,
arg2: any
): boolean;

Parameters:

arg1 - (template)

arg2 - (any dataType)

Returns:

(boolean)

Errors thrown:

conversion - arg2 cannot be converted to the data type of arg1.

Implemented by afw_function_execute_ne()


Function definition nex<template>

Definition at line 29416 of file afw_function_bindings.h.

◆ afw_function_definition_template

afw_function_definition_template

Adaptive Function nex<template>

Parameters
xfunction execute parameter.

Determine if for template arg1 is not equal to the value or data type of arg2 then return the boolean result. Use "ne" ("!=") instead if you want arg2 to be converted to the data type of arg1 before comparison.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function nex<template>(
arg1: template,
arg2: any
): boolean;

Parameters:

arg1 - (template)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by afw_function_execute_nex()


Function definition template

Definition at line 29455 of file afw_function_bindings.h.

◆ afw_function_definition_to_string_template

afw_function_definition_to_string_template

Adaptive Function template

Parameters
xfunction execute parameter.

Converts value to data type template returning template result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function template(
value: any
): template;

Parameters:

value - (any dataType) Value to convert.

Returns:

(template) Converted value.

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_string<template>

Definition at line 29493 of file afw_function_bindings.h.