blob: 7a63e5f6efc0e3af2dcddfd6af6ced3a7bb73e98 [file] [log] [blame]
Radek Krejcie7b95092019-05-15 11:03:07 +02001/**
2 * @file tree_data_internal.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief internal functions for YANG schema trees.
5 *
Michal Vasko60ea6352020-06-29 13:39:39 +02006 * Copyright (c) 2015 - 2020 CESNET, z.s.p.o.
Radek Krejcie7b95092019-05-15 11:03:07 +02007 *
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_TREE_DATA_INTERNAL_H_
16#define LY_TREE_DATA_INTERNAL_H_
17
Radek Krejci857189e2020-09-01 13:26:36 +020018#include "log.h"
Radek Krejciaca74032019-06-04 08:53:06 +020019#include "plugins_types.h"
Michal Vasko60ea6352020-06-29 13:39:39 +020020#include "set.h"
21#include "tree_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020022
Michal Vasko52927e22020-03-16 17:26:14 +010023#include <stddef.h>
24
Michal Vasko004d3152020-06-11 19:59:22 +020025struct ly_path_predicate;
Michal Vaskoa6669ba2020-08-06 16:14:26 +020026struct lysc_module;
Michal Vasko004d3152020-06-11 19:59:22 +020027
Radek Krejcif13b87b2020-12-01 22:02:17 +010028#define LY_XML_SUFFIX ".xml"
29#define LY_XML_SUFFIX_LEN 4
30#define LY_JSON_SUFFIX ".json"
31#define LY_JSON_SUFFIX_LEN 5
32#define LY_LYB_SUFFIX ".lyb"
33#define LY_LYB_SUFFIX_LEN 4
34
Radek Krejcie7b95092019-05-15 11:03:07 +020035/**
Michal Vaskod7c048c2021-05-18 16:12:55 +020036 * @brief Internal structure for remembering "used" instances of lists with duplicate instances allowed.
37 */
38struct lyd_dup_inst {
39 struct ly_set *inst_set;
40 uint32_t used;
41};
42
43/**
44 * @brief Update a found inst using a duplicate instance cache. Needs to be called for every "used"
45 * (that should not be considered next time) instance.
46 *
47 * @param[in,out] inst Found instance, is updated so that the same instance is not returned twice.
48 * @param[in] siblings Siblings where @p inst was found.
49 * @param[in,out] dup_inst_cache Duplicate instance cache.
50 * @return LY_ERR value.
51 */
52LY_ERR lyd_dup_inst_next(struct lyd_node **inst, const struct lyd_node *siblings,
53 struct lyd_dup_inst **dup_inst_cache);
54
55/**
56 * @brief Free duplicate instance cache.
57 *
58 * @param[in] dup_inst Duplicate instance cache to free.
59 */
60void lyd_dup_inst_free(struct lyd_dup_inst *dup_inst);
61
62/**
Michal Vaskod3bb12f2020-12-04 14:33:09 +010063 * @brief Check whether a node to be deleted is the root node, move it if it is.
Michal Vaskob1b5c262020-03-05 14:29:47 +010064 *
Michal Vaskod3bb12f2020-12-04 14:33:09 +010065 * @param[in] root Root sibling.
Michal Vaskob1b5c262020-03-05 14:29:47 +010066 * @param[in] to_del Node to be deleted.
Michal Vaskod3bb12f2020-12-04 14:33:09 +010067 * @param[in] mod If set, it is expected @p tree should point to the first node of @p mod. Otherwise it will simply be
68 * the first top-level sibling.
Michal Vaskob1b5c262020-03-05 14:29:47 +010069 */
Michal Vaskod3bb12f2020-12-04 14:33:09 +010070void lyd_del_move_root(struct lyd_node **root, const struct lyd_node *to_del, const struct lys_module *mod);
Michal Vaskob1b5c262020-03-05 14:29:47 +010071
72/**
Radek Krejcie7b95092019-05-15 11:03:07 +020073 * @brief Get address of a node's child pointer if any.
74 *
Radek Krejcie7b95092019-05-15 11:03:07 +020075 * @param[in] node Node to check.
Michal Vasko9b368d32020-02-14 13:53:31 +010076 * @return Address of the node's child member,
77 * @return NULL if there is no child pointer.
Radek Krejcie7b95092019-05-15 11:03:07 +020078 */
Michal Vaskoe0665742021-02-11 11:08:44 +010079struct lyd_node **lyd_node_child_p(struct lyd_node *node);
Radek Krejcie7b95092019-05-15 11:03:07 +020080
81/**
Radek Krejci8678fa42020-08-18 16:07:28 +020082 * @brief Just like ::lys_getnext() but iterates over all data instances of the schema nodes.
Michal Vaskoa6669ba2020-08-06 16:14:26 +020083 *
84 * @param[in] last Last returned data node.
85 * @param[in] sibling Data node sibling to search in.
86 * @param[in,out] slast Schema last node, set to NULL for first call and do not change afterwards.
87 * May not be set if the function is used only for any suitable node existence check (such as the existence
88 * of any choice case data).
89 * @param[in] parent Schema parent of the iterated children nodes.
90 * @param[in] module Schema module of the iterated top-level nodes.
91 * @return Next matching data node,
92 * @return NULL if last data node was already returned.
93 */
94struct lyd_node *lys_getnext_data(const struct lyd_node *last, const struct lyd_node *sibling,
Radek Krejci0f969882020-08-21 16:56:47 +020095 const struct lysc_node **slast, const struct lysc_node *parent,
96 const struct lysc_module *module);
Michal Vaskoa6669ba2020-08-06 16:14:26 +020097
98/**
Michal Vasko9b368d32020-02-14 13:53:31 +010099 * @brief Create a term (leaf/leaf-list) node from a string value.
100 *
101 * Hash is calculated and new node flag is set.
Michal Vasko90932a92020-02-12 14:33:03 +0100102 *
103 * @param[in] schema Schema node of the new data node.
104 * @param[in] value String value to be parsed.
Michal Vaskof03ed032020-03-04 13:31:44 +0100105 * @param[in] value_len Length of @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100106 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
Michal Vasko90932a92020-02-12 14:33:03 +0100107 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200108 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200109 * @param[in] hints [Value hints](@ref lydvalhints) from the parser regarding the value type.
110 * @param[out] incomplete Whether the value needs to be resolved.
Michal Vasko90932a92020-02-12 14:33:03 +0100111 * @param[out] node Created node.
112 * @return LY_SUCCESS on success.
113 * @return LY_EINCOMPLETE in case data tree is needed to finish the validation.
114 * @return LY_ERR value if an error occurred.
115 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200116LY_ERR lyd_create_term(const struct lysc_node *schema, const char *value, size_t value_len, ly_bool *dynamic,
Radek Krejci8df109d2021-04-23 12:19:08 +0200117 LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints, ly_bool *incomplete, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100118
119/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100120 * @brief Create a term (leaf/leaf-list) node from a parsed value by duplicating it.
121 *
122 * Hash is calculated and new node flag is set.
123 *
124 * @param[in] schema Schema node of the new data node.
125 * @param[in] val Parsed value to use.
126 * @param[out] node Created node.
127 * @return LY_SUCCESS on success.
128 * @return LY_ERR value if an error occurred.
129 */
130LY_ERR lyd_create_term2(const struct lysc_node *schema, const struct lyd_value *val, struct lyd_node **node);
131
132/**
133 * @brief Create an inner (container/list/RPC/action/notification) node.
134 *
135 * Hash is calculated and new node flag is set except
136 * for list with keys, when the hash is not calculated!
137 * Also, non-presence container has its default flag set.
Michal Vasko90932a92020-02-12 14:33:03 +0100138 *
139 * @param[in] schema Schema node of the new data node.
140 * @param[out] node Created node.
141 * @return LY_SUCCESS on success.
142 * @return LY_ERR value if an error occurred.
143 */
144LY_ERR lyd_create_inner(const struct lysc_node *schema, struct lyd_node **node);
145
146/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100147 * @brief Create a list with all its keys (cannot be used for key-less list).
148 *
149 * Hash is calculated and new node flag is set.
Michal Vasko90932a92020-02-12 14:33:03 +0100150 *
151 * @param[in] schema Schema node of the new data node.
Michal Vasko004d3152020-06-11 19:59:22 +0200152 * @param[in] predicates Compiled key list predicates.
Michal Vasko90932a92020-02-12 14:33:03 +0100153 * @param[out] node Created node.
154 * @return LY_SUCCESS on success.
155 * @return LY_ERR value if an error occurred.
156 */
Michal Vasko004d3152020-06-11 19:59:22 +0200157LY_ERR lyd_create_list(const struct lysc_node *schema, const struct ly_path_predicate *predicates, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100158
159/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100160 * @brief Create an anyxml/anydata node.
161 *
162 * Hash is calculated and flags are properly set based on @p is_valid.
Michal Vasko90932a92020-02-12 14:33:03 +0100163 *
164 * @param[in] schema Schema node of the new data node.
Michal Vasko366a4a12020-12-04 16:23:57 +0100165 * @param[in] value Value of the any node.
Michal Vasko90932a92020-02-12 14:33:03 +0100166 * @param[in] value_type Value type of the value.
Michal Vasko366a4a12020-12-04 16:23:57 +0100167 * @param[in] use_value Whether to directly assign (eat) the value or duplicate it.
Michal Vasko90932a92020-02-12 14:33:03 +0100168 * @param[out] node Created node.
169 * @return LY_SUCCESS on success.
170 * @return LY_ERR value if an error occurred.
171 */
Michal Vasko9b368d32020-02-14 13:53:31 +0100172LY_ERR lyd_create_any(const struct lysc_node *schema, const void *value, LYD_ANYDATA_VALUETYPE value_type,
Michal Vasko366a4a12020-12-04 16:23:57 +0100173 ly_bool use_value, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100174
175/**
Michal Vasko52927e22020-03-16 17:26:14 +0100176 * @brief Create an opaque node.
177 *
178 * @param[in] ctx libyang context.
179 * @param[in] name Element name.
180 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko52927e22020-03-16 17:26:14 +0100181 * @param[in] prefix Element prefix.
182 * @param[in] pref_len Length of @p prefix, must be set correctly.
Radek Krejci1798aae2020-07-14 13:26:06 +0200183 * @param[in] module_key Mandatory key to reference module, can be namespace or name.
184 * @param[in] module_key_len Length of @p module_key, must be set correctly.
Michal Vasko501af032020-11-11 20:27:44 +0100185 * @param[in] value String value to be parsed.
186 * @param[in] value_len Length of @p value, must be set correctly.
187 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
188 * @param[in] format Input format of @p value and @p ns.
Radek Krejciec9ad602021-01-04 10:46:30 +0100189 * @param[in] val_prefix_data Format-specific prefix data, param is spent (even in case the function fails):
190 * LY_PREF_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
191 * LY_PREF_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
192 * LY_PREF_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
193 * LY_PREF_JSON - NULL
Michal Vasko501af032020-11-11 20:27:44 +0100194 * @param[in] hints [Hints](@ref lydhints) from the parser regarding the node/value type.
Michal Vasko52927e22020-03-16 17:26:14 +0100195 * @param[out] node Created node.
196 * @return LY_SUCCESS on success.
197 * @return LY_ERR value if an error occurred.
198 */
Michal Vasko501af032020-11-11 20:27:44 +0100199LY_ERR lyd_create_opaq(const struct ly_ctx *ctx, const char *name, size_t name_len, const char *prefix, size_t pref_len,
200 const char *module_key, size_t module_key_len, const char *value, size_t value_len, ly_bool *dynamic,
Radek Krejci8df109d2021-04-23 12:19:08 +0200201 LY_VALUE_FORMAT format, void *val_prefix_data, uint32_t hints, struct lyd_node **node);
Michal Vasko52927e22020-03-16 17:26:14 +0100202
203/**
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200204 * @brief Check the existence and create any non-existing implicit siblings, recursively for the created nodes.
205 *
206 * @param[in] parent Parent of the potential default values, NULL for top-level siblings.
207 * @param[in,out] first First sibling.
208 * @param[in] sparent Schema parent of the siblings, NULL if schema of @p parent can be used.
209 * @param[in] mod Module of the default values, NULL for nested siblings.
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200210 * @param[in] node_when Optional set to add nodes with "when" conditions into.
Radek Krejci4f2e3e52021-03-30 14:20:28 +0200211 * @param[in] node_exts Optional set to add nodes and extension instances having own validation plugin callback into it.
Michal Vaskoc43c8ab2021-03-05 13:32:44 +0100212 * @param[in] node_types Optional set to add nodes with unresolved types into.
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200213 * @param[in] impl_opts Implicit options (@ref implicitoptions).
214 * @param[in,out] diff Validation diff.
215 * @return LY_ERR value.
216 */
217LY_ERR lyd_new_implicit_r(struct lyd_node *parent, struct lyd_node **first, const struct lysc_node *sparent,
Radek Krejci4f2e3e52021-03-30 14:20:28 +0200218 const struct lys_module *mod, struct ly_set *node_when, struct ly_set *node_exts, struct ly_set *node_types,
Radek Krejci1deb5be2020-08-26 16:43:36 +0200219 uint32_t impl_opts, struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200220
221/**
Michal Vaskob104f112020-07-17 09:54:54 +0200222 * @brief Find the next node, before which to insert the new node.
Michal Vasko90932a92020-02-12 14:33:03 +0100223 *
Michal Vaskob104f112020-07-17 09:54:54 +0200224 * @param[in] first_sibling First sibling of the nodes to consider.
225 * @param[in] new_node Node that will be inserted.
226 * @return Node to insert after.
227 * @return NULL if the new node should be first.
Michal Vasko90932a92020-02-12 14:33:03 +0100228 */
Michal Vaskob104f112020-07-17 09:54:54 +0200229struct lyd_node *lyd_insert_get_next_anchor(const struct lyd_node *first_sibling, const struct lyd_node *new_node);
Michal Vasko90932a92020-02-12 14:33:03 +0100230
231/**
Michal Vaskob104f112020-07-17 09:54:54 +0200232 * @brief Insert a node into parent/siblings. Order and hashes are fully handled.
Michal Vasko90932a92020-02-12 14:33:03 +0100233 *
Michal Vasko9b368d32020-02-14 13:53:31 +0100234 * @param[in] parent Parent to insert into, NULL for top-level sibling.
235 * @param[in,out] first_sibling First sibling, NULL if no top-level sibling exist yet. Can be also NULL if @p parent is set.
Michal Vasko90932a92020-02-12 14:33:03 +0100236 * @param[in] node Individual node (without siblings) to insert.
237 */
Michal Vasko9b368d32020-02-14 13:53:31 +0100238void lyd_insert_node(struct lyd_node *parent, struct lyd_node **first_sibling, struct lyd_node *node);
Michal Vasko90932a92020-02-12 14:33:03 +0100239
240/**
Michal Vaskoa5da3292020-08-12 13:10:50 +0200241 * @brief Insert a metadata (last) into a parent
242 *
243 * @param[in] parent Parent of the metadata.
244 * @param[in] meta Metadata (list) to be added into the @p parent.
Michal Vasko871a0252020-11-11 18:35:24 +0100245 * @param[in] clear_dflt Whether to clear dflt flag starting from @p parent, recursively all NP containers.
Michal Vaskoa5da3292020-08-12 13:10:50 +0200246 */
Michal Vasko871a0252020-11-11 18:35:24 +0100247void lyd_insert_meta(struct lyd_node *parent, struct lyd_meta *meta, ly_bool clear_dflt);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200248
249/**
Michal Vasko52927e22020-03-16 17:26:14 +0100250 * @brief Create and insert a metadata (last) into a parent.
Michal Vasko90932a92020-02-12 14:33:03 +0100251 *
Michal Vasko52927e22020-03-16 17:26:14 +0100252 * @param[in] parent Parent of the metadata, can be NULL.
Michal Vasko9f96a052020-03-10 09:41:45 +0100253 * @param[in,out] meta Metadata list to add at its end if @p parent is NULL, returned created attribute.
254 * @param[in] mod Metadata module (with the annotation definition).
Michal Vasko90932a92020-02-12 14:33:03 +0100255 * @param[in] name Attribute name.
Michal Vaskof03ed032020-03-04 13:31:44 +0100256 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100257 * @param[in] value String value to be parsed.
Michal Vaskof03ed032020-03-04 13:31:44 +0100258 * @param[in] value_len Length of @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100259 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
Michal Vasko90932a92020-02-12 14:33:03 +0100260 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200261 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200262 * @param[in] hints [Value hints](@ref lydvalhints) from the parser regarding the value type.
Michal Vasko871a0252020-11-11 18:35:24 +0100263 * @param[in] clear_dflt Whether to clear dflt flag starting from @p parent, recursively all NP containers.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200264 * @param[out] incomplete Whether the value needs to be resolved.
Michal Vasko90932a92020-02-12 14:33:03 +0100265 * @return LY_SUCCESS on success.
266 * @return LY_EINCOMPLETE in case data tree is needed to finish the validation.
267 * @return LY_ERR value if an error occurred.
268 */
Michal Vasko9f96a052020-03-10 09:41:45 +0100269LY_ERR lyd_create_meta(struct lyd_node *parent, struct lyd_meta **meta, const struct lys_module *mod, const char *name,
Radek Krejci8df109d2021-04-23 12:19:08 +0200270 size_t name_len, const char *value, size_t value_len, ly_bool *dynamic, LY_VALUE_FORMAT format,
Radek Krejci84d7fd72021-07-14 18:32:21 +0200271 void *prefix_data, uint32_t hints, ly_bool clear_dflt, ly_bool *incomplete);
Radek Krejci1798aae2020-07-14 13:26:06 +0200272
273/**
Michal Vaskoa5da3292020-08-12 13:10:50 +0200274 * @brief Insert an attribute (last) into a parent
Radek Krejci1798aae2020-07-14 13:26:06 +0200275 *
Michal Vaskoa5da3292020-08-12 13:10:50 +0200276 * @param[in] parent Parent of the attributes.
277 * @param[in] attr Attribute (list) to be added into the @p parent.
Radek Krejci1798aae2020-07-14 13:26:06 +0200278 */
Michal Vaskoa5da3292020-08-12 13:10:50 +0200279void lyd_insert_attr(struct lyd_node *parent, struct lyd_attr *attr);
Michal Vasko90932a92020-02-12 14:33:03 +0100280
281/**
Michal Vasko52927e22020-03-16 17:26:14 +0100282 * @brief Create and insert a generic attribute (last) into a parent.
283 *
284 * @param[in] parent Parent of the attribute, can be NULL.
285 * @param[in,out] attr Attribute list to add at its end if @p parent is NULL, returned created attribute.
286 * @param[in] ctx libyang context.
287 * @param[in] name Attribute name.
288 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko52927e22020-03-16 17:26:14 +0100289 * @param[in] prefix Attribute prefix.
290 * @param[in] prefix_len Attribute prefix length.
Radek Krejci1798aae2020-07-14 13:26:06 +0200291 * @param[in] module_key Mandatory key to reference module, can be namespace or name.
292 * @param[in] module_key_len Length of @p module_key, must be set correctly.
Michal Vasko501af032020-11-11 20:27:44 +0100293 * @param[in] value String value to be parsed.
294 * @param[in] value_len Length of @p value, must be set correctly.
295 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
296 * @param[in] format Input format of @p value and @p ns.
297 * @param[in] val_prefix_data Format-specific prefix data, param is spent (even in case the function fails).
298 * @param[in] hints [Hints](@ref lydhints) from the parser regarding the node/value type.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200299 * @return LY_SUCCESS on success,
300 * @return LY_ERR value on error.
Michal Vasko52927e22020-03-16 17:26:14 +0100301 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200302LY_ERR lyd_create_attr(struct lyd_node *parent, struct lyd_attr **attr, const struct ly_ctx *ctx, const char *name,
Michal Vasko501af032020-11-11 20:27:44 +0100303 size_t name_len, const char *prefix, size_t prefix_len, const char *module_key, size_t module_key_len,
Radek Krejci8df109d2021-04-23 12:19:08 +0200304 const char *value, size_t value_len, ly_bool *dynamic, LY_VALUE_FORMAT format, void *val_prefix_data, uint32_t hints);
Radek Krejci1798aae2020-07-14 13:26:06 +0200305
306/**
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200307 * @brief Store and canonize the given @p value into @p val according to the schema node type rules.
Radek Krejci38d85362019-09-05 16:26:38 +0200308 *
Michal Vasko8d544252020-03-02 10:19:52 +0100309 * @param[in] ctx libyang context.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200310 * @param[in,out] val Storage for the value.
311 * @param[in] type Type of the value.
Radek Krejcif9943642021-04-26 10:18:21 +0200312 * @param[in] value Value to be parsed, must not be NULL.
Michal Vaskof03ed032020-03-04 13:31:44 +0100313 * @param[in] value_len Length of the give @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100314 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200315 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200316 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200317 * @param[in] hints [Value hints](@ref lydvalhints) from the parser.
318 * @param[in] ctx_node Context schema node.
319 * @param[out] incomplete Optional, set if the value also needs to be resolved.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200320 * @return LY_SUCCESS on success,
321 * @return LY_ERR value on error.
Radek Krejci38d85362019-09-05 16:26:38 +0200322 */
Radek Krejcif9943642021-04-26 10:18:21 +0200323LY_ERR lyd_value_store(const struct ly_ctx *ctx, struct lyd_value *val, const struct lysc_type *type, const void *value,
Radek Krejci8df109d2021-04-23 12:19:08 +0200324 size_t value_len, ly_bool *dynamic, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints,
Radek Krejci2efc45b2020-12-22 16:25:44 +0100325 const struct lysc_node *ctx_node, ly_bool *incomplete);
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200326
327/**
328 * @brief Validate previously incompletely stored value.
329 *
330 * @param[in] ctx libyang context.
331 * @param[in] type Schema type of the value (not the stored one, but the original one).
332 * @param[in,out] val Stored value to resolve.
333 * @param[in] ctx_node Context node for the resolution.
334 * @param[in] tree Data tree for the resolution.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200335 * @return LY_SUCCESS on success,
336 * @return LY_ERR value on error.
337 */
338LY_ERR lyd_value_validate_incomplete(const struct ly_ctx *ctx, const struct lysc_type *type, struct lyd_value *val,
Radek Krejci2efc45b2020-12-22 16:25:44 +0100339 const struct lyd_node *ctx_node, const struct lyd_node *tree);
Radek Krejci38d85362019-09-05 16:26:38 +0200340
Michal Vaskoaebbce02021-04-06 09:23:37 +0200341/**
342 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value coming
343 * from a schema.
344 *
345 * This function check just the type's restriction, if you want to check also the data tree context (e.g. in case of
346 * require-instance restriction), use ::lyd_value_validate().
347 *
348 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
349 * @param[in] node Schema node for the @p value.
350 * @param[in] value String value to be checked, expected to be in JSON format.
351 * @param[in] value_len Length of the given @p value (mandatory).
352 * @param[in] format Value prefix format.
353 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
354 * @return LY_SUCCESS on success
355 * @return LY_ERR value if an error occurred.
356 */
357LY_ERR lys_value_validate(const struct ly_ctx *ctx, const struct lysc_node *node, const char *value, size_t value_len,
Radek Krejci8df109d2021-04-23 12:19:08 +0200358 LY_VALUE_FORMAT format, void *prefix_data);
Michal Vaskof937cfe2020-08-03 16:07:12 +0200359
Radek Krejci38d85362019-09-05 16:26:38 +0200360/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200361 * @defgroup datahash Data nodes hash manipulation
362 * @ingroup datatree
Michal Vasko8081a812021-07-15 09:19:43 +0200363 * @{
Radek Krejcie7b95092019-05-15 11:03:07 +0200364 */
365
366/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200367 * @brief Generate hash for the node.
368 *
369 * @param[in] node Data node to (re)generate hash value.
370 * @return LY_ERR value.
371 */
372LY_ERR lyd_hash(struct lyd_node *node);
373
374/**
375 * @brief Insert hash of the node into the hash table of its parent.
376 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200377 * @param[in] node Data node which hash will be inserted into the ::lyd_node_inner.children_ht hash table of its parent.
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200378 * @return LY_ERR value.
379 */
380LY_ERR lyd_insert_hash(struct lyd_node *node);
381
382/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200383 * @brief Maintain node's parent's children hash table when unlinking the node.
384 *
385 * When completely freeing data tree, it is expected to free the parent's children hash table first, at once.
386 *
387 * @param[in] node The data node being unlinked from its parent.
388 */
389void lyd_unlink_hash(struct lyd_node *node);
390
391/** @} datahash */
392
Radek Krejci084289f2019-07-09 17:35:30 +0200393/**
Michal Vaskob1b5c262020-03-05 14:29:47 +0100394 * @brief Iterate over implemented modules for functions that accept specific modules or the whole context.
395 *
396 * @param[in] tree Data tree.
Michal Vasko26e80012020-07-08 10:55:46 +0200397 * @param[in] module Selected module, NULL for all.
Michal Vaskob1b5c262020-03-05 14:29:47 +0100398 * @param[in] ctx Context, NULL for selected modules.
399 * @param[in,out] i Iterator, set to 0 on first call.
400 * @param[out] first First sibling of the returned module.
401 * @return Next module.
402 * @return NULL if all modules were traversed.
403 */
Michal Vasko26e80012020-07-08 10:55:46 +0200404const struct lys_module *lyd_mod_next_module(struct lyd_node *tree, const struct lys_module *module,
Radek Krejci0f969882020-08-21 16:56:47 +0200405 const struct ly_ctx *ctx, uint32_t *i, struct lyd_node **first);
Michal Vaskob1b5c262020-03-05 14:29:47 +0100406
407/**
408 * @brief Iterate over modules for functions that want to traverse all the top-level data.
409 *
410 * @param[in,out] next Pointer to the next module data, set to first top-level sibling on first call.
411 * @param[out] first First sibling of the returned module.
412 * @return Next module.
413 * @return NULL if all modules were traversed.
414 */
415const struct lys_module *lyd_data_next_module(struct lyd_node **next, struct lyd_node **first);
416
Michal Vasko9f96a052020-03-10 09:41:45 +0100417/**
418 * @brief Check that a list has all its keys.
419 *
420 * @param[in] node List to check.
Michal Vasko44685da2020-03-17 15:38:06 +0100421 * @return LY_SUCCESS on success.
422 * @return LY_ENOT on a missing key.
Michal Vasko9f96a052020-03-10 09:41:45 +0100423 */
424LY_ERR lyd_parse_check_keys(struct lyd_node *node);
425
Michal Vasko60ea6352020-06-29 13:39:39 +0200426/**
427 * @brief Set data flags for a newly parsed node.
428 *
429 * @param[in] node Node to use.
Radek Krejci4f2e3e52021-03-30 14:20:28 +0200430 * @param[in,out] when_check Set of nodes with unresolved when.
431 * @param[in,out] exts_check Set of nodes and their extension instances if they have own validation callback.
Michal Vasko60ea6352020-06-29 13:39:39 +0200432 * @param[in,out] meta Node metadata, may be removed from.
433 * @param[in] options Parse options.
434 */
Radek Krejci4f2e3e52021-03-30 14:20:28 +0200435void lyd_parse_set_data_flags(struct lyd_node *node, struct ly_set *when_check, struct ly_set *exts_check,
436 struct lyd_meta **meta, uint32_t options);
Michal Vasko60ea6352020-06-29 13:39:39 +0200437
438/**
Michal Vaskod59035b2020-07-08 12:00:06 +0200439 * @brief Append all list key predicates to path.
440 *
441 * @param[in] node Node with keys to print.
442 * @param[in,out] buffer Buffer to print to.
443 * @param[in,out] buflen Current buffer length.
444 * @param[in,out] bufused Current number of characters used in @p buffer.
445 * @param[in] is_static Whether buffer is static or can be reallocated.
446 * @return LY_ERR
447 */
Radek Krejci857189e2020-09-01 13:26:36 +0200448LY_ERR lyd_path_list_predicate(const struct lyd_node *node, char **buffer, size_t *buflen, size_t *bufused, ly_bool is_static);
Michal Vaskod59035b2020-07-08 12:00:06 +0200449
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100450/**
451 * @brief Free stored prefix data.
452 *
453 * @param[in] format Format of the prefixes.
Radek Krejciec9ad602021-01-04 10:46:30 +0100454 * @param[in] prefix_data Format-specific data to free:
455 * LY_PREF_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
456 * LY_PREF_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
457 * LY_PREF_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
458 * LY_PREF_JSON - NULL
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100459 */
Radek Krejci8df109d2021-04-23 12:19:08 +0200460void ly_free_prefix_data(LY_VALUE_FORMAT format, void *prefix_data);
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100461
462/**
463 * @brief Duplicate prefix data.
464 *
465 * @param[in] ctx libyang context.
466 * @param[in] format Format of the prefixes in the value.
467 * @param[in] prefix_data Prefix data to duplicate.
468 * @param[out] prefix_data_p Duplicated prefix data.
469 * @return LY_ERR value.
470 */
Radek Krejci8df109d2021-04-23 12:19:08 +0200471LY_ERR ly_dup_prefix_data(const struct ly_ctx *ctx, LY_VALUE_FORMAT format, const void *prefix_data, void **prefix_data_p);
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100472
473/**
Michal Vaskofc2cd072021-02-24 13:17:17 +0100474 * @brief Store used prefixes in a string.
475 *
476 * If @p prefix_data_p are non-NULL, they are treated as valid according to the @p format_p and new possible
477 * prefixes are simply added. This way it is possible to store prefix data for several strings together.
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100478 *
479 * @param[in] ctx libyang context.
Radek Krejcif9943642021-04-26 10:18:21 +0200480 * @param[in] value Value to be parsed.
481 * @param[in] value_len Length of the @p value.
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100482 * @param[in] format Format of the prefixes in the value.
483 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofc2cd072021-02-24 13:17:17 +0100484 * @param[in,out] format_p Resulting format of the prefixes.
485 * @param[in,out] prefix_data_p Resulting prefix data for the value in format @p format_p.
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100486 * @return LY_ERR value.
487 */
Radek Krejcif9943642021-04-26 10:18:21 +0200488LY_ERR ly_store_prefix_data(const struct ly_ctx *ctx, const void *value, size_t value_len, LY_VALUE_FORMAT format,
Radek Krejci8df109d2021-04-23 12:19:08 +0200489 const void *prefix_data, LY_VALUE_FORMAT *format_p, void **prefix_data_p);
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100490
Michal Vasko7ed1fcb2020-12-03 14:15:22 +0100491/**
492 * @brief Get string name of the format.
493 *
494 * @param[in] format Format whose name to get.
495 * @return Format string name.
496 */
Radek Krejci8df109d2021-04-23 12:19:08 +0200497const char *ly_format2str(LY_VALUE_FORMAT format);
Michal Vasko7ed1fcb2020-12-03 14:15:22 +0100498
Radek Krejcie7b95092019-05-15 11:03:07 +0200499#endif /* LY_TREE_DATA_INTERNAL_H_ */