afw_compile.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework AFW Compile AFW expressions/json/templates
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_COMPILE_H__
#define __AFW_COMPILE_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
struct afw_compile_type_info_s {
    afw_compile_type_t compile_type;
    const afw_utf8_t *name;
    const afw_value_t *name_value;
    const afw_utf8_t *description;
    const afw_value_t *description_value;
    const afw_data_type_t *data_type;
    const afw_value_function_definition_t *compile_function;
};
 
 
typedef enum afw_compile_residual_check_e {
    afw_compile_residual_check_none,
    afw_compile_residual_check_to_newline,
    afw_compile_residual_check_to_full
} afw_compile_residual_check_t;
 
 
 
AFW_DECLARE(const afw_compile_type_info_t *)
afw_compile_type_get_info_by_pneumonic(
    const afw_utf8_t *pneumonic,
    const afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_compile_type_info_t *)
afw_compile_type_get_info(
    afw_compile_type_t compile_type,
    const afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_compile_shared_t *)
afw_compile_shared_create(
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_value_t *)
afw_compile_and_evaluate(
    const afw_utf8_t *string,
    const afw_utf8_t *source_location,
    afw_compile_type_t compile_type,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
#define afw_compile_and_evaluate_type( \
    compile_type, string, source_location, p, xctx) \
    afw_compile_and_evaluate(string, source_location, \
        afw_compile_type_ ## compile_type, p, xctx)
 
 
 
AFW_DECLARE(const afw_value_t *)
afw_compile_to_value_with_callback(
    const afw_utf8_t *string,
    afw_utf8_octet_get_cb_t callback,
    void *callback_data,
    const afw_utf8_t *source_location,
    afw_compile_type_t compile_type,
    afw_compile_residual_check_t residual_check,
    const afw_value_compiled_value_t *parent,
    const afw_compile_shared_t *shared,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
#define afw_compile_to_value(string, source_location, compile_type, \
    parent, shared, p, xctx) \
    afw_compile_to_value_with_callback(string, NULL, NULL, \
        source_location, compile_type, afw_compile_residual_check_to_full, \
        parent, shared, p, xctx)
 
 
 
#define afw_compile_expression(string, source_location, parent, shared, \
    p, xctx) \
    afw_compile_to_value_with_callback(string, NULL, NULL, \
        source_location, afw_compile_type_expression, \
        afw_compile_residual_check_to_full, \
        parent, shared, p, xctx)
 
 
 
AFW_DECLARE(const afw_value_t *)
afw_compile_hybrid(
    const afw_value_t *value,
    const afw_utf8_t *source_location,
    const afw_value_compiled_value_t *parent,
    const afw_compile_shared_t *shared,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
#define afw_compile_hybrid_source(string, source_location, parent, shared, \
    p, xctx) \
    afw_compile_to_value_with_callback(string, NULL, NULL, \
        source_location, afw_compile_type_hybrid, \
        afw_compile_residual_check_to_full, \
        parent, shared, p, xctx)
 
 
 
#define afw_compile_template(string, source_location, parent, shared, \
    p, xctx) \
    afw_compile_to_value_with_callback(string, NULL, NULL, \
        source_location, afw_compile_type_template, \
        afw_compile_residual_check_to_full, \
        parent, shared, p, xctx)
 
 
 
AFW_DECLARE(const afw_object_t *)
afw_compile_to_object(
    const afw_utf8_t *string,
    const afw_utf8_t *source_location,
    const afw_utf8_t * adaptor_id,
    const afw_utf8_t * object_type_id,
    const afw_utf8_t * object_id,
    afw_boolean_t cede_p,
    const afw_pool_t * p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_compile_expressions_templates_and_hybrids(
    const afw_object_t *object,
    const afw_utf8_t *source_location,
    afw_boolean_t recursive,
    const afw_compile_shared_t *shared,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_object_t *)
afw_compile_object_all_hybrid_properties(
    const afw_object_t *object,
    const afw_utf8_t *source_location,
    const afw_compile_shared_t *shared,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_compile_split_qualified_name(
    const afw_utf8_t *qualified_name,
    afw_utf8_t *qualifier,
    afw_utf8_t *name,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_compile_source_location_of_value(
    const afw_value_t *value,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_END_DECLARES
 
#endif /* __AFW_COMPILE_H__ */