afw_runtime.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Runtime Header
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_RUNTIME_H__
#define __AFW_RUNTIME_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
AFW_DECLARE_CONST_DATA(afw_object_inf_t)
afw_runtime_inf_const_embedded_untyped_object;
 
AFW_DECLARE_CONST_DATA(afw_object_inf_t)
afw_runtime_inf_const_meta_object_inf;
 
/*
 * @brief Custom handling information for a runtime object type.
 * 
 * This is registered using afw_environment_register_runtime_custom() and
 * retrieved using afw_environment_get_runtime_custom().
 */
struct afw_runtime_custom_s {
 
    afw_adaptor_session_retrieve_objects_t retrieve_objects;
 
    afw_adaptor_session_get_object_t get_object;
 
};
 
 
struct afw_runtime_object_type_meta_s {
 
    const afw_utf8_t *object_type_id;
 
    const afw_runtime_object_map_t *property_map;
 
    size_t properties_offset;
 
    afw_boolean_t indirect;
};
 
 
struct afw_runtime_object_map_property_s {
 
    const afw_utf8_t *name;
 
    afw_size_t offset;
 
    afw_size_t count_offset;
 
    union {
        const afw_data_type_t *data_type;
        const afw_utf8_t *unresolved_data_type_id;
    };
 
    afw_utf8_t data_type_parameter;
 
    union {
        const afw_data_type_t *data_type_parameter_data_type;
        const afw_utf8_t *unresolved_data_type_parameter_data_type_id;
    };
 
    const afw_utf8_t *accessor_name;
 
    afw_runtime_value_accessor_t accessor;
 
};
 
 
 
struct afw_runtime_object_map_s  {
    const afw_utf8_t *object_type_id;
    afw_size_t property_count;
    const afw_runtime_object_map_property_t *properties;
};
 
 
struct afw_runtime_object_indirect_s {
    afw_object_t pub;
 
    void * internal;
};
 
 
struct afw_runtime_const_object_instance_s {
 
    afw_object_t pub;
 
    const afw_runtime_property_t *const * properties;
 
};
 
 
struct afw_runtime_const_object_meta_object_s {
 
    afw_object_t pub;
 
    const afw_runtime_const_object_instance_t *object;
 
    const afw_value_list_t *parent_paths;
};
 
 
 
struct afw_runtime_property_s {
    const afw_utf8_t *name;
    const afw_value_t *value;
};
 
 
 
struct afw_runtime_unresolved_const_list_s {
 
    afw_utf8_t data_type_id;
 
    afw_size_t count;
 
    const void *array;
};
 
 
 
struct afw_runtime_unresolved_const_object_s {
 
    const afw_utf8_t *object_type_id;
 
    const afw_utf8_t *object_id;
 
    const afw_utf8_t *path;
 
    const afw_runtime_unresolved_property_t * const * properties;
 
    afw_utf8_t parent_path;
 
};
 
 
 
struct afw_runtime_unresolved_const_embedded_untyped_object_s {
 
    const afw_runtime_unresolved_property_t * (*properties);
 
    afw_size_t parent_paths_count;
 
    const afw_utf8_t *parent_paths;
};
 
 
 
typedef enum afw_runtime_unresolved_primitive_type_e {
 
    afw_runtime_unresolved_primitive_type_boolean,
 
    afw_runtime_unresolved_primitive_type_number,
 
    afw_runtime_unresolved_primitive_type_integer,
 
    afw_runtime_unresolved_primitive_type_list,
 
    afw_runtime_unresolved_primitive_type_object,
 
    afw_runtime_unresolved_primitive_type_string
 
} afw_runtime_unresolved_primitive_type_t;
 
 
 
struct afw_runtime_unresolved_value_s{
 
    afw_runtime_unresolved_primitive_type_t type;
 
    const union {
        afw_boolean_t boolean;
        afw_double_t number;
        afw_integer_t integer;
        const afw_runtime_unresolved_const_list_t *list;
        const afw_runtime_unresolved_const_embedded_untyped_object_t *object;
        const afw_utf8_z_t *string;
    };
};
 
 
 
struct afw_runtime_unresolved_property_s {
 
    const afw_utf8_z_t *name;
 
    afw_runtime_unresolved_value_t value;
 
};
 
 
 
AFW_DECLARE(const afw_object_t *)
afw_runtime_object_create_indirect_using_inf(
    const afw_object_inf_t *inf,
    const afw_utf8_t *object_id,
    void * internal,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_runtime_env_set_object(
    const afw_object_t *object, afw_boolean_t overwrite,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_runtime_env_set_objects(
    const afw_object_t * const * objects, afw_boolean_t overwrite,
    afw_xctx_t *xctx);
 
 
typedef const afw_object_t *
(*afw_runtime_object_wrapper_p_cb_t)(
    void *data,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_runtime_env_set_object_cb_wrapper(
    const afw_utf8_t *object_type_id,
    const afw_utf8_t *object_id,
    afw_runtime_object_wrapper_p_cb_t callback,
    void *data,
    afw_boolean_t overwrite,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_runtime_env_create_and_set_indirect_object(
    const afw_utf8_t *object_type_id,
    const afw_utf8_t *object_id,
    void *internal,
    afw_boolean_t overwrite,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_runtime_env_create_and_set_indirect_object_using_inf(
    const afw_object_inf_t *inf,
    const afw_utf8_t *object_id,
    void * internal,
    afw_boolean_t overwrite,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_runtime_env_resolve_and_set_const_objects(
    const afw_runtime_unresolved_const_object_t * const * unresolved,
    afw_boolean_t overwrite, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_runtime_foreach(
    const afw_utf8_t *object_type_id,
    void *context, afw_object_cb_t callback,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_adaptor_factory_t *)
afw_runtime_get_adaptor_factory();
 
 
 
AFW_DECLARE(const afw_adaptor_session_t *)
afw_runtime_get_internal_session(
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_object_t *)
afw_runtime_get_object(
    const afw_utf8_t *object_type_id, const afw_utf8_t *object_id,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_object_t *)
afw_runtime_object_create_indirect(
    const afw_utf8_t *object_type_id,
    const afw_utf8_t *object_id,
    void * internal,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_runtime_remove_object(
    const afw_utf8_t *object_type_id,
    const afw_utf8_t *object_id,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_runtime_xctx_set_object(
    const afw_object_t *object, afw_boolean_t overwrite,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_runtime_xctx_set_objects(
    const afw_object_t * const * objects, afw_boolean_t overwrite,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_runtime_register_object_map_infs(
    const afw_object_inf_t * const * inf,
    afw_xctx_t *xctx
);
 
 
 
AFW_DECLARE(void)
afw_runtime_resolve_and_register_object_map_infs(
    const afw_interface_implementation_rti_t * const * rti,
    afw_xctx_t *xctx
);
 
 
 
AFW_DECLARE(const afw_object_t *)
afw_runtime_resolve_const_object(
    const afw_runtime_unresolved_const_object_t *unresolved,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
#define AFW_RUNTIME_OBJECT_RTI(label_, meta_)                                   \
                                                                                \
static const afw_interface_implementation_rti_t                                 \
label_ = {                                                                      \
    AFW_UTF8_LITERAL("afw_object"),                                             \
    AFW_UTF8_LITERAL(__FILE__),                                                 \
    AFW_UTF8_LITERAL("afw_runtime"),                                            \
    &meta_                                                                      \
};                                                                              \
           
 
#define AFW_RUNTIME_OBJECT_INF(inf_, meta_)                                     \
                                                                                \
AFW_DEFINE_CONST_DATA(afw_object_inf_t)                                         \
inf_ = {                                                                        \
    {                                                                           \
        AFW_UTF8_LITERAL("afw_object"),                                         \
        AFW_UTF8_LITERAL(__FILE__),                                             \
        AFW_UTF8_LITERAL("afw_runtime"),                                        \
        &meta_                                                                  \
    },                                                                          \
    afw_runtime_object_release,                                                 \
    afw_runtime_object_add_reference,                                           \
    afw_runtime_object_get_count,                                           \
    afw_runtime_object_get_meta,                                                \
    afw_runtime_object_get_property,                                            \
    afw_runtime_object_get_property_meta,                                       \
    afw_runtime_object_get_next_own_property,                                   \
    afw_runtime_object_get_next_property_meta,                                  \
    afw_runtime_object_has_property,                                            \
    afw_runtime_object_get_setter                                               \
}                                                                               \
 
 
void
afw_runtime_object_release(
    const afw_object_t * instance,
    afw_xctx_t *xctx);
 
 
 
void
afw_runtime_object_add_reference(
    const afw_object_t * instance,
    afw_xctx_t *xctx);
 
 
 
afw_size_t
afw_runtime_object_get_count(
    const afw_object_t * instance,
    afw_xctx_t * xctx);
 
 
 
const afw_utf8_t *
afw_runtime_object_get_object_type_id(
    const afw_object_t * instance,
    afw_xctx_t *xctx);
 
 
 
const afw_value_t *
afw_runtime_object_get_meta(
    const afw_object_t *instance,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
const afw_value_t *
afw_runtime_object_get_property(
    const afw_object_t *instance,
    const afw_utf8_t *property_name,
    afw_xctx_t *xctx);
 
 
 
const afw_value_t *
afw_runtime_object_get_property_meta(
    const afw_object_t *instance,
    const afw_utf8_t *property_name,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
const afw_value_t *
afw_runtime_object_get_next_own_property(
    const afw_object_t * instance,
    const afw_iterator_t * * iterator,
    const afw_utf8_t * * property_name,
    afw_xctx_t *xctx);
 
 
 
const afw_value_t *
afw_runtime_object_get_next_property_meta(
    const afw_object_t *instance,
    const afw_iterator_t **iterator,
    const afw_utf8_t **property_name,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
afw_boolean_t
afw_runtime_object_has_property(
    const afw_object_t * instance,
    const afw_utf8_t * property_name,
    afw_xctx_t *xctx);
 
 
 
const afw_object_setter_t *
afw_runtime_object_get_setter(
    const afw_object_t * instance,
    afw_xctx_t *xctx);
 
 
AFW_END_DECLARES
 
#endif /* __AFW_RUNTIME_H__ */