afw_adaptor_modify.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Adaptor Modify Object
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_ADAPTOR_MODIFY_H__
#define __AFW_ADAPTOR_MODIFY_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
#define AFW_ADAPTOR_MODIFY_ENTRY_TYPE_MAP(XX)                                  \
    XX(add_value,           true)                                              \
    XX(remove_property,     false)                                             \
    XX(remove_value,        true)                                              \
    XX(set_property,        true)                                              \
 
 
typedef enum afw_adaptor_modify_entry_type_e {
#define XX(id, _) afw_adaptor_modify_entry_type_ ## id,
    AFW_ADAPTOR_MODIFY_ENTRY_TYPE_MAP(XX)
#undef XX
    afw_adaptor_modify_entry_type_invalid
} afw_adaptor_modify_entry_type_t;
 
 
 
struct afw_adaptor_modify_entry_s {
 
    afw_adaptor_modify_entry_type_t type;
 
    const afw_object_path_property_name_entry_t *first_property_name_entry;
 
    const afw_value_t *value;
};
 
 
 
AFW_DECLARE(void)
afw_adaptor_modify_object(
    const afw_utf8_t *adaptor_id,
    const afw_utf8_t *object_type_id,
    const afw_utf8_t *object_id,
    const afw_list_t *entries,
    const afw_object_t *journal_entry,
    const afw_object_t *adaptor_type_specific,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_adaptor_modify_using_update_object(
    const afw_utf8_t *adaptor_id,
    const afw_utf8_t *object_type_id,
    const afw_utf8_t *object_id,
    const afw_object_t *update_object,
    const afw_object_t *journal_entry,
    const afw_object_t *adaptor_type_specific,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(afw_adaptor_modify_entry_type_t)
afw_adaptor_modify_entry_type(const afw_utf8_t *mnemonic);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_adaptor_modify_entry_type_mnemonic(afw_adaptor_modify_entry_type_t type);
 
 
AFW_DECLARE(const afw_value_t *)
afw_adaptor_modify_entry_type_value(afw_adaptor_modify_entry_type_t type);
 
 
AFW_DECLARE(const afw_adaptor_modify_entry_t * const *)
afw_adaptor_modify_entries_from_list(
    const afw_list_t *list, const afw_pool_t *p, afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_list_t *)
afw_adaptor_modify_entries_to_list(
    const afw_adaptor_modify_entry_t * const *entries,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_adaptor_modify_entries_apply_to_unnormalized_object(
    const afw_adaptor_modify_entry_t * const *entries,
    const afw_object_t *object,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_adaptor_modify_needed_to_reconcile(
    const afw_utf8_t * *adaptor_id,
    const afw_utf8_t * *object_type_id,
    const afw_utf8_t * *object_id,
    const afw_list_t * *entries,
    const afw_object_t *original,
    const afw_object_t *modified,
    const afw_object_t *journal_entry,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
AFW_END_DECLARES
 
#endif /* __AFW_ADAPTOR_MODIFY_H__ */