afw_object_type.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Object Type
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_OBJECT_TYPE_H
#define __AFW_OBJECT_TYPE_H
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
struct afw_object_type_s {
    const afw_object_type_t *next;
    const afw_utf8_t *adaptor_id;
    const afw_utf8_t *object_type_id;
    const afw_object_t *object_type_object;
    const afw_object_t *property_types_object;
    const afw_object_t *other_properties_object;
    const afw_object_type_property_type_t *first_property_type;
    const afw_object_type_property_type_t *other_properties;
};
 
typedef struct afw_object_type_extended_data_type_s
afw_object_type_extended_data_type_t;
 
 
struct afw_object_type_extended_data_type_s {
    /* "dataType" or "objectType". */
    const afw_utf8_t *data_type_parameter_type;
    union {
        const afw_object_type_t *object_type;
        const afw_data_type_t *data_type;
    };
};
 
struct afw_object_type_property_type_s {
    const afw_object_type_property_type_t *next;
    const afw_object_t *property_type_object;
    const afw_utf8_t *property_name;
 
    const afw_utf8_t *context_type_id;
    const afw_data_type_t *data_type;
    const afw_utf8_t *data_type_parameter;
 
    const afw_value_t *default_value;
 
    afw_boolean_t allow_write;
    afw_boolean_t allow_query;
    afw_boolean_t required;
};
 
 
const afw_object_type_t *
afw_object_type_internal_create(
    const afw_adaptor_t *adaptor,
    const afw_object_t *object_type_object,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
#define afw_object_type_get_property(object_type, property_name, xctx) \
    afw_object_get_property((object_type)->object_type_object, \
        property_name, xctx)
 
 
 
#define afw_object_type_get_property_as_utf8(object_type_object, \
    property_name, xctx) \
    afw_object_old_get_property_as_utf8((object_type)->object_type_object, \
        property_name, xctx)
 
 
AFW_DECLARE(const afw_object_type_property_type_t *)
afw_object_type_property_type_get(
    const afw_object_type_t *object_type,
    const afw_utf8_t *property_name,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_object_type_property_type_t *)
afw_object_type_property_type_get_next(
    const afw_object_type_t *object_type,
    const afw_iterator_t * *iterator,
    const afw_utf8_t * *property_name,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_value_t *)
afw_object_type_property_type_normalize(
    const afw_object_type_property_type_t *pt,
    const afw_value_t *value,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_value_t *)
afw_object_type_property_normalize(
    const afw_object_type_t *object_type,
    const afw_utf8_t *property_name,
    const afw_value_t *value,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_END_DECLARES
 
#endif /* __AFW_OBJECT_TYPE_H */