blob: c755a1309043389e7c388827ceccbc0ca8bc9036 [file] [log] [blame]
Michal Vaskocde73ac2019-11-14 16:10:27 +01001/**
2 * @file validation.h
3 * @author Michal Vasko <mvasko@cesnet.cz>
4 * @brief Validation routines.
5 *
6 * Copyright (c) 2019 CESNET, z.s.p.o.
7 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_VALIDATION_H_
16#define LY_VALIDATION_H_
17
18#include "log.h"
19#include "tree_data.h"
20
21/**
Michal Vaskob1b5c262020-03-05 14:29:47 +010022 * @brief Finish validation of nodes and attributes. Specifically, when (is processed first) and type validation.
Michal Vaskocde73ac2019-11-14 16:10:27 +010023 *
Michal Vaskob1b5c262020-03-05 14:29:47 +010024 * !! It is assumed autodeleted nodes cannot be in the unresolved node type set !!
25 *
26 * @param[in,out] tree Data tree, is updated if some nodes are autodeleted.
27 * @param[in] node_when Set with nodes with "when" conditions, can be NULL.
Michal Vaskocde73ac2019-11-14 16:10:27 +010028 * @param[in] node_types Set with nodes with unresolved types, can be NULL
29 * @param[in] attr_types Set with attributes with unresolved types, can be NULL.
Michal Vaskocde73ac2019-11-14 16:10:27 +010030 * @param[in] format Format of the unresolved data.
31 * @param[in] get_prefix_clb Format-specific getter to resolve prefixes.
32 * @param[in] parser_data Parser's data for @p get_prefix_clb.
Michal Vaskocde73ac2019-11-14 16:10:27 +010033 * @return LY_ERR value.
34 */
Michal Vaskob1b5c262020-03-05 14:29:47 +010035LY_ERR lyd_validate_unres(struct lyd_node **tree, struct ly_set *node_when, struct ly_set *node_types, struct ly_set *attr_types,
36 LYD_FORMAT format, ly_clb_resolve_prefix get_prefix_clb, void *parser_data);
Michal Vaskocde73ac2019-11-14 16:10:27 +010037
38/**
Michal Vaskob1b5c262020-03-05 14:29:47 +010039 * @brief Validate new siblings. Specifically, check duplicated instances, autodelete default values and cases.
Michal Vaskocde73ac2019-11-14 16:10:27 +010040 *
Michal Vaskob1b5c262020-03-05 14:29:47 +010041 * !! It is assumed autodeleted nodes cannot yet be in the unresolved node type set !!
42 *
43 * @param[in,out] first First sibling.
44 * @param[in] sparent Schema parent of the siblings, NULL for top-level siblings.
45 * @param[in] mod Module of the siblings, NULL for nested siblings.
46 * @return LY_ERR value.
47 */
48LY_ERR lyd_validate_new(struct lyd_node **first, const struct lysc_node *sparent, const struct lys_module *mod);
49
50/**
51 * @brief Perform all remaining validation tasks, the data tree must be final when calling this function.
52 *
53 * @param[in] first First sibling.
54 * @param[in] sparent Schema parent of the siblings, NULL for top-level siblings.
55 * @param[in] mod Module of the siblings, NULL for nested siblings.
Michal Vaskof03ed032020-03-04 13:31:44 +010056 * @param[in] val_opts Validation options (@ref datavalidationoptions).
Michal Vaskocde73ac2019-11-14 16:10:27 +010057 * @return LY_ERR value.
58 */
Michal Vaskob1b5c262020-03-05 14:29:47 +010059LY_ERR lyd_validate_siblings_r(struct lyd_node *first, const struct lysc_node *sparent, const struct lys_module *mod,
60 int val_opts);
Michal Vasko9b368d32020-02-14 13:53:31 +010061
62/**
63 * @brief Check the existence and create any non-existing default siblings, recursively for the created nodes.
64 *
Michal Vaskob1b5c262020-03-05 14:29:47 +010065 * @param[in] parent Parent of the potential default values, NULL for top-level siblings.
Michal Vasko9b368d32020-02-14 13:53:31 +010066 * @param[in,out] first First sibling.
Michal Vaskob1b5c262020-03-05 14:29:47 +010067 * @param[in] sparent Schema parent of the siblings, NULL if schema of @p parent can be used.
68 * @param[in] mod Module of the default values, NULL for nested siblings.
Michal Vasko9b368d32020-02-14 13:53:31 +010069 * @param[in] node_types Set to add nodes with unresolved types into.
70 * @param[in] node_when Set to add nodes with "when" conditions into.
71 * @return LY_ERR value.
72 */
Michal Vaskob1b5c262020-03-05 14:29:47 +010073LY_ERR lyd_validate_defaults_r(struct lyd_node_inner *parent, struct lyd_node **first, const struct lysc_node *sparent,
74 const struct lys_module *mod, struct ly_set *node_types, struct ly_set *node_when);
Michal Vaskocde73ac2019-11-14 16:10:27 +010075
76#endif /* LY_VALIDATION_H_ */