afw_function_template.c

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * afw_function_execute_* functions for template
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#include "afw.h"
 
 
 
/*
 * Adaptive function: compile<template>
 *
 * afw_function_execute_compile_template
 *
 * See afw_function_bindings.h for more information.
 *
 * 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)
 */
const afw_value_t *
afw_function_execute_compile_template(
    afw_function_execute_t *x)
{
    const afw_value_string_t *template;
    const afw_value_t *result;
    const afw_utf8_t *listing;
 
    AFW_FUNCTION_EVALUATE_REQUIRED_DATA_TYPE_PARAMETER(template, 1, string);
 
    result = afw_compile_to_value(
        &template->internal, AFW_FUNCTION_SOURCE_LOCATION,
        afw_compile_type_template,
        NULL, NULL, x->p, x->xctx);
 
    if (AFW_FUNCTION_PARAMETER_IS_PRESENT(2)) {
        listing = afw_function_evaluate_whitespace_parameter(x, 2);
        result = afw_value_create_string(
            afw_value_compiler_listing_to_string(result, listing,
                x->p, x->xctx),
            x->p, x->xctx);
    }
 
    return result;
}
 
 
 
/*
 * Adaptive function: evaluate<template>
 *
 * afw_function_execute_evaluate_template
 *
 * See afw_function_bindings.h for more information.
 *
 * 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)
 */
const afw_value_t *
afw_function_execute_evaluate_template(
    afw_function_execute_t *x)
{
    const afw_value_string_t *template;
    const afw_value_t *compiled;
    const afw_value_t *value;
 
    AFW_FUNCTION_EVALUATE_REQUIRED_DATA_TYPE_PARAMETER(template, 1, string);
 
    compiled = afw_compile_to_value(
        &template->internal, AFW_FUNCTION_SOURCE_LOCATION,
        afw_compile_type_template,
        NULL, NULL, x->p, x->xctx);
 
    if (AFW_FUNCTION_PARAMETER_IS_PRESENT(2)) {
        value = afw_value_evaluate_with_additional_untrusted_qualified_variables(
            compiled, x->argv[2], x->p, x->xctx);
    }
    else {
        value = afw_value_evaluate(compiled, x->p, x->xctx);
    }
 
    return value;
}