afw_list.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework afw_list interface helper header
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_LIST_H__
#define __AFW_LIST_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
#define AFW_LIST_ERROR_OBJECT_IMMUTABLE \
AFW_THROW_ERROR_Z(read_only, "List immutable", xctx)
 
 
AFW_DECLARE(const afw_list_t *)
afw_list_create_with_options(
    int options,
    const afw_data_type_t *data_type,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
#define afw_list_of_create(data_type, p, xctx) \
    afw_list_create_with_options(0, data_type, p, xctx)
 
 
 
#define afw_list_create_generic(p, xctx) \
    afw_list_create_with_options(0, NULL, p, xctx)
 
 
 
AFW_DECLARE(const afw_list_t *)
afw_list_const_create_array_of_objects(
    const afw_object_t *const *objects,
    afw_size_t count,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_list_t *)
afw_list_const_create_array_of_values(
    const afw_value_t *const *values,
    afw_size_t count,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_list_t *)
afw_list_const_create_null_terminated_array_of_objects(
    const afw_object_t *const *objects,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_list_t *)
afw_list_const_create_null_terminated_array_of_values(
    const afw_value_t *const *values,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_list_t *)
afw_list_create_or_clone(
    const afw_list_t *list,
    const afw_data_type_t *data_type,
    afw_boolean_t clone_values,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_list_t *)
afw_list_of_create_from_value(
    const afw_data_type_t *data_type,
    const afw_value_t *value,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_list_t *)
afw_list_convert_to_list_of_strings(
    const afw_list_t *list,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DEFINE(const afw_list_t *)
afw_list_create_wrapper_for_array(
    const void *array,
    afw_boolean_t indirect,
    const afw_data_type_t *data_type,
    afw_size_t count,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
typedef struct afw_list_wrapper_for_array_self_s {
    const afw_list_inf_t *inf;
    const afw_data_type_t *data_type;
    afw_size_t count;
    const void *internal;
    const afw_pool_t *p;
    afw_boolean_t indirect;
} afw_list_wrapper_for_array_self_t;
 
 
 
AFW_DECLARE_CONST_DATA(afw_list_inf_t)
afw_list_wrapper_for_array_inf;
 
 
 
#define AFW_LIST_INITIALIZE_WRAPPER_FOR_ARRAY( \
instance, _internal, _indirect, _data_type, _count) \
    (instance)->inf = &afw_list_wrapper_for_array_inf; \
    (instance)->p = NULL; \
    (instance)->internal = _internal; \
    (instance)->indirect = _indirect; \
    (instance)->data_type = _data_type; \
    (instance)->count = _count
 
 
#define AFW_LIST_INITIALIZE_WRAPPER_FOR_ARRAY_P(instance, \
_internal, _indirect, _data_type, _count, _p) \
    (instance)->inf = &afw_list_wrapper_for_array_inf; \
    (instance)->p = _p; \
    (instance)->internal = _internal; \
    (instance)->indirect = _indirect; \
    (instance)->data_type = _data_type; \
    (instance)->count = _count
 
 
 
AFW_DEFINE(const afw_utf8_t *)
afw_list_of_utf8_get_next(
    const afw_list_t *instance,
    const afw_iterator_t * *iterator,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_list_set_immutable(
    const afw_list_t *instance,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_data_type_t *)
afw_list_determine_data_type_and_set_immutable(
    const afw_list_t *instance,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_list_add_internal(
    const afw_list_t *instance,
    const afw_data_type_t *data_type,
    const void *internal,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_list_add_value(
    const afw_list_t *instance,
    const afw_value_t *value,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_list_remove_all_values(
    const afw_list_t *instance,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_list_remove_internal(
    const afw_list_t *instance,
    const afw_data_type_t *data_type,
    const void *internal,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_list_remove_value(
    const afw_list_t *instance,
    const afw_value_t *value,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_list_set_value_by_index(
    const afw_list_t *instance,
    afw_size_t index,
    const afw_value_t *value,
    afw_xctx_t *xctx);
 
 
#define afw_list_is_immutable(list, xctx) \
(afw_list_get_setter(list, xctx) == NULL)
 
 
 
AFW_END_DECLARES
 
#endif /* __AFW_LIST_H__ */