afw_object_path.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Adaptive Object Path
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_OBJECT_PATH_H
#define __AFW_OBJECT_PATH_H
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
struct afw_object_path_property_name_entry_s {
    const afw_object_path_property_name_entry_t *next;
    afw_utf8_t property_name;
};
 
 
struct afw_object_path_parsed_s {
 
    /* @brief Copy of path passed to afw_object_path_parse(). */
    afw_utf8_t original_path;
 
    /* @brief Normalized path. */
    afw_utf8_t normalized_path;
 
    /* @brief Entity part of normalized path. */
    afw_utf8_t entity_path;
 
    /* @brief `<adaptor_id>` */
    afw_utf8_t adaptor_id;
 
    /* @brief `<object_type_id>` */
    afw_utf8_t object_type_id;
 
    /* @brief `<object_id>` */
    afw_utf8_t entity_object_id;
 
    /* @brief `<object_id>` plus any dotted property names. NOT URI DECODED. */
    afw_utf8_t undecoded_object_id;
 
    /* @brief List of `<property_name>` if uri has dotted property names. */
    const afw_object_path_property_name_entry_t *first_property_name;
 
    /* @brief Options object or NULL. See afw_object_options.h. */
    const afw_object_t *options_object;
 
    /* @brief Options based on options_object or NULL. */
    const afw_object_options_t *options;
 
    /* @brief Current path was used for substitutions. */
    afw_boolean_t substitution_occurred;
 
    /* @brief Adaptor id was substituted from current path. */
    afw_boolean_t substituted_adaptor_id;
 
    /* @brief Object type id was substituted from current path. */
    afw_boolean_t substituted_object_type_id;
 
    /* @brief Entire object id was substituted from current path. */
    afw_boolean_t substituted_entire_object_id;
 
    /* @brief Entity object id was substituted from current path. */
    afw_boolean_t substituted_entity_object_id;
 
    /* @brief At least one property name was substituted from current path. */
    afw_boolean_t substituted_property_name;
 
    /* @brief At least one property name was substituted from current path. */
    afw_boolean_t contains_unresolved_substitutions;
};
 
 
AFW_DECLARE(const afw_value_t *)
afw_object_path_property_name_list_get_property(
    const afw_object_t *object,
    const afw_object_path_property_name_entry_t *first_property_name,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_object_path_make(
    const afw_utf8_t *adaptor_id,
    const afw_utf8_t *object_type_id,
    const afw_utf8_t *object_id,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_object_path_make_for_embedded(
    const afw_object_t *embedded_object,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_object_path_make_property_name_expression(
    const afw_object_path_property_name_entry_t *first,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_object_path_parsed_t *)
afw_object_path_parse(
    const afw_utf8_t *path,
    const afw_utf8_t *current_path,
    const afw_object_options_t *default_options,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_object_path_parse_simple(
    const afw_utf8_t *path,
    const afw_utf8_t * *adaptor_id,
    const afw_utf8_t * *object_type_id,
    const afw_utf8_t * *object_id,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_object_t *)
afw_object_path_parsed_to_object(
    const afw_object_path_parsed_t *parsed,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(afw_boolean_t)
afw_object_path_parsed_are_equivalent(
    const afw_object_path_parsed_t *parsed1,
    const afw_object_path_parsed_t *parsed2,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(afw_boolean_t)
afw_object_path_are_equivalent(
    const afw_utf8_t *path1,
    const afw_utf8_t *path2,
    const afw_utf8_t *current_path,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_END_DECLARES
 
#endif /* __AFW_OBJECT_PATH_H */