diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 09:55:11 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 09:55:11 +0000 |
commit | cd07912073c951b4bbb871ed2653af1be2cfc714 (patch) | |
tree | 1073c2308492e6aea4c66cb7436ee92db2abfd42 /src/schema_compile_amend.h | |
parent | Initial commit. (diff) | |
download | libyang2-upstream/2.1.30.tar.xz libyang2-upstream/2.1.30.zip |
Adding upstream version 2.1.30.upstream/2.1.30upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/schema_compile_amend.h')
-rw-r--r-- | src/schema_compile_amend.h | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/src/schema_compile_amend.h b/src/schema_compile_amend.h new file mode 100644 index 0000000..344af65 --- /dev/null +++ b/src/schema_compile_amend.h @@ -0,0 +1,181 @@ +/** + * @file schema_compile_amend.h + * @author Radek Krejci <rkrejci@cesnet.cz> + * @author Michal Vasko <mvasko@cesnet.cz> + * @brief Header for schema compilation of augments, deviations, and refines. + * + * Copyright (c) 2015 - 2022 CESNET, z.s.p.o. + * + * This source code is licensed under BSD 3-Clause License (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/BSD-3-Clause + */ + +#ifndef LY_SCHEMA_COMPILE_AMEND_H_ +#define LY_SCHEMA_COMPILE_AMEND_H_ + +#include "log.h" + +struct ly_ctx; +struct lysp_qname; +struct lysp_node; +struct lysc_node; +struct lysc_ctx; +struct lysp_node_uses; +struct lys_glob_unres; +struct lys_module; + +/** + * @brief Compiled parsed augment structure. Just a temporary storage for applying the augment to data. + */ +struct lysc_augment { + struct lyxp_expr *nodeid; /**< augment target */ + const struct lysp_module *aug_pmod; /**< module where the augment is defined, for top-level augments + used to resolve prefixes, for uses augments used as the context pmod */ + const struct lysc_node *nodeid_ctx_node; /**< nodeid context node for relative targets */ + const struct lysp_ext_instance *ext; /**< parent extension instance, in case the augment is from one */ + + struct lysp_node_augment *aug_p; /**< pointer to the parsed augment to apply */ +}; + +/** + * @brief Compiled parsed deviation structure. Just a temporary storage for applying the deviation to data. + */ +struct lysc_deviation { + struct lyxp_expr *nodeid; /**< deviation target, taken from the first deviation in + ::lysc_deviation.dev_pmods array, this module is used for resolving + prefixes used in the nodeid. */ + + struct lysp_deviation **devs; /**< sized array of all the parsed deviations for one target node */ + const struct lysp_module **dev_pmods; /**< sized array of parsed modules of @p devs (where the specific deviations + are defined). */ + ly_bool not_supported; /**< whether this is a not-supported deviation */ +}; + +/** + * @brief Compiled parsed refine structure. Just a temporary storage for applying the refine to data. + */ +struct lysc_refine { + struct lyxp_expr *nodeid; /**< refine target */ + const struct lysp_module *nodeid_pmod; /**< module where the nodeid is defined, used to resolve prefixes */ + const struct lysc_node *nodeid_ctx_node; /**< nodeid context node */ + struct lysp_node_uses *uses_p; /**< parsed uses node of the refine, for tracking recursive refines */ + + struct lysp_refine **rfns; /**< sized array of parsed refines to apply */ +}; + +/** + * @brief Prepare any uses augments and refines in the context to be applied during uses descendant node compilation. + * + * @param[in] ctx Compile context. + * @param[in] uses_p Parsed uses structure with augments and refines. + * @param[in] ctx_node Context node of @p uses_p meaning its first data definition parent. + * @return LY_ERR value. + */ +LY_ERR lys_precompile_uses_augments_refines(struct lysc_ctx *ctx, struct lysp_node_uses *uses_p, + const struct lysc_node *ctx_node); + +/** + * @brief Duplicate qname structure. + * + * @param[in] ctx libyang context. + * @param[in] orig_qname Structure to read from. + * @param[in,out] qname Structure to fill. + * @return LY_ERR value. + */ +LY_ERR lysp_qname_dup(const struct ly_ctx *ctx, const struct lysp_qname *orig_qname, struct lysp_qname *qname); + +/** + * @brief Free a compiled augment temporary structure. + * + * @param[in] ctx libyang context. + * @param[in] aug Structure to free. + */ +void lysc_augment_free(const struct ly_ctx *ctx, struct lysc_augment *aug); + +/** + * @brief Free a compiled deviation temporary structure. + * + * @param[in] ctx libyang context. + * @param[in] dev Structure to free. + */ +void lysc_deviation_free(const struct ly_ctx *ctx, struct lysc_deviation *dev); + +/** + * @brief Free a compiled refine temporary structure. + * + * @param[in] ctx libyang context. + * @param[in] rfn Structure to free. + */ +void lysc_refine_free(const struct ly_ctx *ctx, struct lysc_refine *rfn); + +/** + * @brief Free a duplicate of parsed node. It is returned by ::lys_compile_node_deviations_refines(). + * + * @param[in] ctx libyang context. + * @param[in] dev_pnode Parsed node to free. + */ +void lysp_dev_node_free(struct lysc_ctx *cctx, struct lysp_node *dev_pnode); + +/** + * @brief Compile and apply any precompiled deviations and refines targeting a node. + * + * @param[in] ctx Compile context. + * @param[in] pnode Parsed node to consider. + * @param[in] parent First compiled parent of @p pnode. + * @param[out] dev_pnode Copy of parsed node @p pnode with deviations and refines, if any. NULL if there are none. + * @param[out] not_supported Whether a not-supported deviation is defined for the node. + * @return LY_ERR value. + */ +LY_ERR lys_compile_node_deviations_refines(struct lysc_ctx *ctx, const struct lysp_node *pnode, + const struct lysc_node *parent, struct lysp_node **dev_pnode, ly_bool *not_supported); + +/** + * @brief Compile and apply any precompiled top-level or uses augments targeting a node. + * + * @param[in] ctx Compile context. + * @param[in] node Compiled node to consider. + * @return LY_ERR value. + */ +LY_ERR lys_compile_node_augments(struct lysc_ctx *ctx, struct lysc_node *node); + +/** + * @brief Prepare all top-level augments for the current module to be applied during data nodes compilation. + * + * @param[in] ctx Compile context. + * @return LY_ERR value. + */ +LY_ERR lys_precompile_own_augments(struct lysc_ctx *ctx); + +/** + * @brief Prepare all deviations for the current module to be applied during data nodes compilation. + * + * @param[in] ctx Compile context. + * @return LY_ERR value. + */ +LY_ERR lys_precompile_own_deviations(struct lysc_ctx *ctx); + +/** + * @brief Add references to target modules of top-level augments and deviations in a module and all its submodules. + * Adds the module reference to the target modules and if not implemented, implement them (but not compile). + * + * @param[in] mod Module to process. + * @param[in,out] unres Global unres to use. + * @return LY_SUCCESS on success. + * @return LY_ERECOMPILE on required recompilation of the dep set. + * @return LY_ERR on error. + */ +LY_ERR lys_precompile_augments_deviations(struct lys_module *mod, struct lys_glob_unres *unres); + +/** + * @brief Revert precompilation of module augments and deviations. Meaning remove its reference from + * all the target modules. + * + * @param[in] ctx libyang context. + * @param[in] mod Mod whose precompilation to revert. + */ +void lys_precompile_augments_deviations_revert(struct ly_ctx *ctx, const struct lys_module *mod); + +#endif /* LY_SCHEMA_COMPILE_AMEND_H_ */ |