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/validation.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 '')
-rw-r--r-- | src/validation.h | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/src/validation.h b/src/validation.h new file mode 100644 index 0000000..c9f5da0 --- /dev/null +++ b/src/validation.h @@ -0,0 +1,107 @@ +/** + * @file validation.h + * @author Michal Vasko <mvasko@cesnet.cz> + * @brief Validation routines. + * + * Copyright (c) 2019 - 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_VALIDATION_H_ +#define LY_VALIDATION_H_ + +#include <stdint.h> + +#include "diff.h" +#include "log.h" +#include "parser_data.h" + +struct ly_ctx; +struct ly_set; +struct lyd_node; +struct lys_module; +struct lysc_node; + +/** + * @brief Add new changes into a diff. They are always merged. + * + * @param[in] node Node/subtree to add. + * @param[in] op Operation of the change. + * @param[in,out] diff Diff to update. + * @return LY_ERR value. + */ +LY_ERR lyd_val_diff_add(const struct lyd_node *node, enum lyd_diff_op op, struct lyd_node **diff); + +/** + * @brief Finish validation of nodes and attributes. Specifically, when (is processed first) and type validation. + * + * !! It is assumed autodeleted nodes cannot be in the unresolved node type set !! + * + * @param[in,out] tree Data tree, is updated if some nodes are autodeleted. + * @param[in] mod Module of the @p tree to take into consideration when deleting @p tree and moving it. + * If set, it is expected @p tree should point to the first node of @p mod. Otherwise it will simply be + * the first top-level sibling. + * @param[in] data_type Validate data type. + * @param[in] node_when Set with nodes with "when" conditions, can be NULL. + * @param[in] when_xp_opts Additional XPath options to use for evaluating "when". + * @param[in] node_types Set with nodes with unresolved types, can be NULL + * @param[in] meta_types Set with metadata with unresolved types, can be NULL. + * @param[in] ext_node Set with nodes with extensions to validate, can be NULL. + * @param[in] ext_val Set with extension data to validate, can be NULL. + * @param[in] val_opts Validation options, see @ref datavalidationoptions. + * @param[in,out] diff Validation diff. + * @return LY_ERR value. + */ +LY_ERR lyd_validate_unres(struct lyd_node **tree, const struct lys_module *mod, enum lyd_type data_type, + struct ly_set *node_when, uint32_t when_xp_opts, struct ly_set *node_types, struct ly_set *meta_types, + struct ly_set *ext_node, struct ly_set *ext_val, uint32_t val_opts, struct lyd_node **diff); + +/** + * @brief Validate new siblings. Specifically, check duplicated instances, autodelete default values and cases. + * + * !! It is assumed autodeleted nodes cannot yet be in the unresolved node type set !! + * + * @param[in,out] first First sibling. + * @param[in] sparent Schema parent of the siblings, NULL for top-level siblings. + * @param[in] mod Module of the siblings, NULL for nested siblings. + * @param[in,out] diff Validation diff. + * @return LY_ERR value. + */ +LY_ERR lyd_validate_new(struct lyd_node **first, const struct lysc_node *sparent, const struct lys_module *mod, + struct lyd_node **diff); + +/** + * @brief Validate data node with an extension instance, if any, by storing it in its unres set. + * + * @param[in] node Node to check for an extension instance with a node callback. + * @param[in,out] ext_node Set with data nodes to validate. + * @return LY_ERR value. + */ +LY_ERR lyd_validate_node_ext(struct lyd_node *node, struct ly_set *ext_node); + +/** + * @brief Validate a data tree. + * + * @param[in,out] tree Data tree to validate, nodes may be autodeleted. + * @param[in] module Module whose data (and schema restrictions) to validate, NULL for all modules. + * @param[in] ctx libyang context. + * @param[in] val_opts Validation options, see @ref datavalidationoptions. + * @param[in] validate_subtree Whether subtree was already validated (as part of data parsing) or not (separate validation). + * @param[in] node_when_p Set of nodes with when conditions, if NULL a local set is used. + * @param[in] node_types_p Set of unres node types, if NULL a local set is used. + * @param[in] meta_types_p Set of unres metadata types, if NULL a local set is used. + * @param[in] ext_node_p Set of unres nodes with extensions to validate, if NULL a local set is used. + * @param[in] ext_val_p Set of unres extension data to validate, if NULL a local set is used. + * @param[out] diff Generated validation diff, not generated if NULL. + * @return LY_ERR value. + */ +LY_ERR lyd_validate(struct lyd_node **tree, const struct lys_module *module, const struct ly_ctx *ctx, uint32_t val_opts, + ly_bool validate_subtree, struct ly_set *node_when_p, struct ly_set *node_types_p, struct ly_set *meta_types_p, + struct ly_set *ext_node_p, struct ly_set *ext_val_p, struct lyd_node **diff); + +#endif /* LY_VALIDATION_H_ */ |