afw_context.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Context
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_CONTEXT_H__
#define __AFW_CONTEXT_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
struct afw_context_cb_variable_meta_s {
    const afw_utf8_t *name;
    const afw_value_inf_t *value_inf;
    const afw_data_type_t *data_type;
    const afw_utf8_z_t *label_z;
    const afw_utf8_z_t *data_type_parameter_z;
    const afw_utf8_z_t *data_type_parameter_formatted_z;
};
 
 
 
struct afw_context_cb_variable_s {
    const afw_context_cb_variable_meta_t *meta;
    const afw_utf8_z_t *description_z;
    afw_xctx_get_variable_t get_cb;
    int include_mask;
};
 
 
 
AFW_DECLARE(void)
afw_context_push_cb_variables(
    const afw_utf8_t *qualifier_id,
    const afw_context_cb_variable_t *const *variables,
    void *data,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_object_t *)
afw_context_type_create(
    const afw_utf8_t *context_type_id,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
    
AFW_DECLARE(const afw_object_t *)
afw_context_type_insure_qualifier_definitions_object_exists(
    const afw_object_t *context_type_object,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_object_t *)
afw_context_type_insure_variable_definitions_object_exists(
    const afw_object_t *context_type_object,
    const afw_utf8_t *qualifier_id,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_context_qualifier_definitions_merge(
    const afw_object_t *qualifier_definitions,
    const afw_object_t *definitions_to_add,
    afw_boolean_t replace_duplicates,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_context_type_register_cb_variables(
    const afw_utf8_t *context_type_id,
    const afw_utf8_t *qualifier_id,
    const afw_utf8_octet_t *description_z,
    const afw_context_cb_variable_t *const *variables,
    int include_mask,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_context_variable_definition_add_z(
    const afw_object_t *variable_definitions,
    const afw_utf8_t *variable_name,
    const afw_utf8_t *source,
    const afw_value_inf_t *value_inf,
    const afw_utf8_z_t *label_z,
    const afw_utf8_z_t *description_z,
    const afw_utf8_z_t *data_type_parameter_z,
    const afw_utf8_z_t *data_type_parameter_formatted_z,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_context_variable_definitions_add(
    const afw_object_t *variable_definitions,
    const afw_object_t *definitions_to_add,
    afw_boolean_t replace_duplicates,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_context_variable_definitions_add_based_on_object(
    const afw_object_t *variable_definitions,
    const afw_object_t *object,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_context_variable_definitions_add_based_on_object_type_id(
    const afw_object_t *variable_definitions,
    const afw_utf8_t *object_type_id,
    afw_boolean_t include_evaluated,
    afw_xctx_t *xctx);
    
 
 
AFW_DECLARE(void)
afw_context_variable_definitions_compile_and_add_based_on_object(
    const afw_object_t *context_type_object,
    const afw_object_t *object,
    const afw_utf8_t *qualifier_id,
    const afw_utf8_t *source_location,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_context_variable_definitions_compile_and_add_based_on_qualifiers_object(
    const afw_object_t *context_type_object,
    const afw_object_t *objects,
    const afw_utf8_t *source_location,
    afw_xctx_t *xctx);
 
 
 
 
AFW_END_DECLARES
 
#endif /* __AFW_CONTEXT_H__ */