blob: 3cf45c6b16eb31c12c4838563d5cc4b4e67b9fff [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 "tree_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020021
Michal Vasko52927e22020-03-16 17:26:14 +010022#include <stddef.h>
23
Michal Vasko004d3152020-06-11 19:59:22 +020024struct ly_path_predicate;
Michal Vaskoa6669ba2020-08-06 16:14:26 +020025struct lysc_module;
Michal Vasko004d3152020-06-11 19:59:22 +020026
Radek Krejcif13b87b2020-12-01 22:02:17 +010027#define LY_XML_SUFFIX ".xml"
28#define LY_XML_SUFFIX_LEN 4
29#define LY_JSON_SUFFIX ".json"
30#define LY_JSON_SUFFIX_LEN 5
31#define LY_LYB_SUFFIX ".lyb"
32#define LY_LYB_SUFFIX_LEN 4
33
Radek Krejcie7b95092019-05-15 11:03:07 +020034/**
Michal Vaskod7c048c2021-05-18 16:12:55 +020035 * @brief Internal structure for remembering "used" instances of lists with duplicate instances allowed.
36 */
37struct lyd_dup_inst {
38 struct ly_set *inst_set;
39 uint32_t used;
40};
41
42/**
43 * @brief Update a found inst using a duplicate instance cache. Needs to be called for every "used"
44 * (that should not be considered next time) instance.
45 *
46 * @param[in,out] inst Found instance, is updated so that the same instance is not returned twice.
47 * @param[in] siblings Siblings where @p inst was found.
48 * @param[in,out] dup_inst_cache Duplicate instance cache.
49 * @return LY_ERR value.
50 */
51LY_ERR lyd_dup_inst_next(struct lyd_node **inst, const struct lyd_node *siblings,
52 struct lyd_dup_inst **dup_inst_cache);
53
54/**
55 * @brief Free duplicate instance cache.
56 *
57 * @param[in] dup_inst Duplicate instance cache to free.
58 */
59void lyd_dup_inst_free(struct lyd_dup_inst *dup_inst);
60
61/**
Radek Krejci8678fa42020-08-18 16:07:28 +020062 * @brief Just like ::lys_getnext() but iterates over all data instances of the schema nodes.
Michal Vaskoa6669ba2020-08-06 16:14:26 +020063 *
64 * @param[in] last Last returned data node.
65 * @param[in] sibling Data node sibling to search in.
66 * @param[in,out] slast Schema last node, set to NULL for first call and do not change afterwards.
67 * May not be set if the function is used only for any suitable node existence check (such as the existence
68 * of any choice case data).
69 * @param[in] parent Schema parent of the iterated children nodes.
70 * @param[in] module Schema module of the iterated top-level nodes.
71 * @return Next matching data node,
72 * @return NULL if last data node was already returned.
73 */
74struct lyd_node *lys_getnext_data(const struct lyd_node *last, const struct lyd_node *sibling,
Michal Vasko106f0862021-11-02 11:49:27 +010075 const struct lysc_node **slast, const struct lysc_node *parent, const struct lysc_module *module);
76
77/**
78 * @brief Get address of a node's child pointer if any.
79 *
80 * @param[in] node Node to check.
81 * @return Address of the node's child member,
82 * @return NULL if there is no child pointer.
83 */
84struct lyd_node **lyd_node_child_p(struct lyd_node *node);
85
86/**
87 * @brief Update node pointer to point to the first data node of a module, leave unchanged if there is none.
88 *
89 * @param[in,out] node Node pointer, may be updated.
90 * @param[in] mod Module whose data to search for.
91 */
92void lyd_first_module_sibling(struct lyd_node **node, const struct lys_module *mod);
93
94/**
95 * @brief Iterate over implemented modules for functions that accept specific modules or the whole context.
96 *
97 * @param[in] tree Data tree.
98 * @param[in] module Selected module, NULL for all.
99 * @param[in] ctx Context, NULL for selected modules.
100 * @param[in,out] i Iterator, set to 0 on first call.
101 * @param[out] first First sibling of the returned module.
102 * @return Next module.
103 * @return NULL if all modules were traversed.
104 */
105const struct lys_module *lyd_mod_next_module(struct lyd_node *tree, const struct lys_module *module,
106 const struct ly_ctx *ctx, uint32_t *i, struct lyd_node **first);
107
108/**
109 * @brief Iterate over modules for functions that want to traverse all the top-level data.
110 *
111 * @param[in,out] next Pointer to the next module data, set to first top-level sibling on first call.
112 * @param[out] first First sibling of the returned module.
113 * @return Next module.
114 * @return NULL if all modules were traversed.
115 */
116const struct lys_module *lyd_data_next_module(struct lyd_node **next, struct lyd_node **first);
117
118/**
119 * @brief Check that a list has all its keys.
120 *
121 * @param[in] node List to check.
122 * @return LY_SUCCESS on success.
123 * @return LY_ENOT on a missing key.
124 */
125LY_ERR lyd_parse_check_keys(struct lyd_node *node);
126
127/**
128 * @brief Set data flags for a newly parsed node.
129 *
130 * @param[in] node Node to use.
131 * @param[in,out] node_when Set of nodes with unresolved when.
Michal Vasko106f0862021-11-02 11:49:27 +0100132 * @param[in,out] meta Node metadata, may be removed from.
133 * @param[in] parse_opts Parse options.
134 */
Michal Vaskoaac267d2022-01-17 13:34:48 +0100135void lyd_parse_set_data_flags(struct lyd_node *node, struct ly_set *node_when, struct lyd_meta **meta, uint32_t parse_opts);
Michal Vasko106f0862021-11-02 11:49:27 +0100136
137/**
138 * @brief Get schema node of a data node. Useful especially for opaque nodes.
139 *
140 * @param[in] node Data node to use.
141 * @return Schema node represented by data @p node, NULL if there is none.
142 */
143const struct lysc_node *lyd_node_schema(const struct lyd_node *node);
144
145/**
146 * @brief Check whether a node to be deleted is the root node, move it if it is.
147 *
148 * @param[in] root Root sibling.
149 * @param[in] to_del Node to be deleted.
150 * @param[in] mod If set, it is expected @p tree should point to the first node of @p mod. Otherwise it will simply be
151 * the first top-level sibling.
152 */
153void lyd_del_move_root(struct lyd_node **root, const struct lyd_node *to_del, const struct lys_module *mod);
154
155/**
156 * @brief Free stored prefix data.
157 *
158 * @param[in] format Format of the prefixes.
159 * @param[in] prefix_data Format-specific data to free:
160 * LY_PREF_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
161 * LY_PREF_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
162 * LY_PREF_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
163 * LY_PREF_JSON - NULL
164 */
165void ly_free_prefix_data(LY_VALUE_FORMAT format, void *prefix_data);
166
167/**
168 * @brief Duplicate prefix data.
169 *
170 * @param[in] ctx libyang context.
171 * @param[in] format Format of the prefixes in the value.
172 * @param[in] prefix_data Prefix data to duplicate.
173 * @param[out] prefix_data_p Duplicated prefix data.
174 * @return LY_ERR value.
175 */
176LY_ERR ly_dup_prefix_data(const struct ly_ctx *ctx, LY_VALUE_FORMAT format, const void *prefix_data, void **prefix_data_p);
177
178/**
179 * @brief Store used prefixes in a string.
180 *
181 * If @p prefix_data_p are non-NULL, they are treated as valid according to the @p format_p and new possible
182 * prefixes are simply added. This way it is possible to store prefix data for several strings together.
183 *
184 * @param[in] ctx libyang context.
185 * @param[in] value Value to be parsed.
186 * @param[in] value_len Length of the @p value.
187 * @param[in] format Format of the prefixes in the value.
188 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
189 * @param[in,out] format_p Resulting format of the prefixes.
190 * @param[in,out] prefix_data_p Resulting prefix data for the value in format @p format_p.
191 * @return LY_ERR value.
192 */
193LY_ERR ly_store_prefix_data(const struct ly_ctx *ctx, const void *value, size_t value_len, LY_VALUE_FORMAT format,
194 const void *prefix_data, LY_VALUE_FORMAT *format_p, void **prefix_data_p);
195
196/**
197 * @brief Get string name of the format.
198 *
199 * @param[in] format Format whose name to get.
200 * @return Format string name.
201 */
202const char *ly_format2str(LY_VALUE_FORMAT format);
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200203
204/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100205 * @brief Create a term (leaf/leaf-list) node from a string value.
206 *
207 * Hash is calculated and new node flag is set.
Michal Vasko90932a92020-02-12 14:33:03 +0100208 *
209 * @param[in] schema Schema node of the new data node.
210 * @param[in] value String value to be parsed.
Michal Vaskof03ed032020-03-04 13:31:44 +0100211 * @param[in] value_len Length of @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100212 * @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 +0100213 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200214 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200215 * @param[in] hints [Value hints](@ref lydvalhints) from the parser regarding the value type.
216 * @param[out] incomplete Whether the value needs to be resolved.
Michal Vasko90932a92020-02-12 14:33:03 +0100217 * @param[out] node Created node.
218 * @return LY_SUCCESS on success.
219 * @return LY_EINCOMPLETE in case data tree is needed to finish the validation.
220 * @return LY_ERR value if an error occurred.
221 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200222LY_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 +0200223 LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints, ly_bool *incomplete, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100224
225/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100226 * @brief Create a term (leaf/leaf-list) node from a parsed value by duplicating it.
227 *
228 * Hash is calculated and new node flag is set.
229 *
230 * @param[in] schema Schema node of the new data node.
231 * @param[in] val Parsed value to use.
232 * @param[out] node Created node.
233 * @return LY_SUCCESS on success.
234 * @return LY_ERR value if an error occurred.
235 */
236LY_ERR lyd_create_term2(const struct lysc_node *schema, const struct lyd_value *val, struct lyd_node **node);
237
238/**
239 * @brief Create an inner (container/list/RPC/action/notification) node.
240 *
241 * Hash is calculated and new node flag is set except
242 * for list with keys, when the hash is not calculated!
243 * Also, non-presence container has its default flag set.
Michal Vasko90932a92020-02-12 14:33:03 +0100244 *
245 * @param[in] schema Schema node of the new data node.
246 * @param[out] node Created node.
247 * @return LY_SUCCESS on success.
248 * @return LY_ERR value if an error occurred.
249 */
250LY_ERR lyd_create_inner(const struct lysc_node *schema, struct lyd_node **node);
251
252/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100253 * @brief Create a list with all its keys (cannot be used for key-less list).
254 *
255 * Hash is calculated and new node flag is set.
Michal Vasko90932a92020-02-12 14:33:03 +0100256 *
257 * @param[in] schema Schema node of the new data node.
Michal Vasko004d3152020-06-11 19:59:22 +0200258 * @param[in] predicates Compiled key list predicates.
Michal Vasko90932a92020-02-12 14:33:03 +0100259 * @param[out] node Created node.
260 * @return LY_SUCCESS on success.
261 * @return LY_ERR value if an error occurred.
262 */
Michal Vasko004d3152020-06-11 19:59:22 +0200263LY_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 +0100264
265/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100266 * @brief Create an anyxml/anydata node.
267 *
268 * Hash is calculated and flags are properly set based on @p is_valid.
Michal Vasko90932a92020-02-12 14:33:03 +0100269 *
270 * @param[in] schema Schema node of the new data node.
Michal Vasko366a4a12020-12-04 16:23:57 +0100271 * @param[in] value Value of the any node.
Michal Vasko90932a92020-02-12 14:33:03 +0100272 * @param[in] value_type Value type of the value.
Michal Vasko46f7ac92022-02-24 16:07:27 +0100273 * @param[in] use_value Whether to use dynamic @p value or duplicate it.
Michal Vasko90932a92020-02-12 14:33:03 +0100274 * @param[out] node Created node.
275 * @return LY_SUCCESS on success.
276 * @return LY_ERR value if an error occurred.
277 */
Michal Vasko9b368d32020-02-14 13:53:31 +0100278LY_ERR lyd_create_any(const struct lysc_node *schema, const void *value, LYD_ANYDATA_VALUETYPE value_type,
Michal Vasko366a4a12020-12-04 16:23:57 +0100279 ly_bool use_value, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100280
281/**
Michal Vasko52927e22020-03-16 17:26:14 +0100282 * @brief Create an opaque node.
283 *
284 * @param[in] ctx libyang context.
285 * @param[in] name Element name.
286 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko52927e22020-03-16 17:26:14 +0100287 * @param[in] prefix Element prefix.
288 * @param[in] pref_len Length of @p prefix, must be set correctly.
Radek Krejci1798aae2020-07-14 13:26:06 +0200289 * @param[in] module_key Mandatory key to reference module, can be namespace or name.
290 * @param[in] module_key_len Length of @p module_key, must be set correctly.
Michal Vasko501af032020-11-11 20:27:44 +0100291 * @param[in] value String value to be parsed.
292 * @param[in] value_len Length of @p value, must be set correctly.
293 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
294 * @param[in] format Input format of @p value and @p ns.
Radek Krejciec9ad602021-01-04 10:46:30 +0100295 * @param[in] val_prefix_data Format-specific prefix data, param is spent (even in case the function fails):
296 * LY_PREF_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
297 * LY_PREF_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
298 * LY_PREF_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
299 * LY_PREF_JSON - NULL
Michal Vasko501af032020-11-11 20:27:44 +0100300 * @param[in] hints [Hints](@ref lydhints) from the parser regarding the node/value type.
Michal Vasko52927e22020-03-16 17:26:14 +0100301 * @param[out] node Created node.
302 * @return LY_SUCCESS on success.
303 * @return LY_ERR value if an error occurred.
304 */
Michal Vasko501af032020-11-11 20:27:44 +0100305LY_ERR lyd_create_opaq(const struct ly_ctx *ctx, const char *name, size_t name_len, const char *prefix, size_t pref_len,
306 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 +0200307 LY_VALUE_FORMAT format, void *val_prefix_data, uint32_t hints, struct lyd_node **node);
Michal Vasko52927e22020-03-16 17:26:14 +0100308
309/**
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200310 * @brief Check the existence and create any non-existing implicit siblings, recursively for the created nodes.
311 *
312 * @param[in] parent Parent of the potential default values, NULL for top-level siblings.
313 * @param[in,out] first First sibling.
314 * @param[in] sparent Schema parent of the siblings, NULL if schema of @p parent can be used.
315 * @param[in] mod Module of the default values, NULL for nested siblings.
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200316 * @param[in] node_when Optional set to add nodes with "when" conditions into.
Michal Vaskoc43c8ab2021-03-05 13:32:44 +0100317 * @param[in] node_types Optional set to add nodes with unresolved types into.
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200318 * @param[in] impl_opts Implicit options (@ref implicitoptions).
319 * @param[in,out] diff Validation diff.
320 * @return LY_ERR value.
321 */
322LY_ERR lyd_new_implicit_r(struct lyd_node *parent, struct lyd_node **first, const struct lysc_node *sparent,
Michal Vaskoaac267d2022-01-17 13:34:48 +0100323 const struct lys_module *mod, struct ly_set *node_when, struct ly_set *node_types, uint32_t impl_opts,
324 struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200325
326/**
Michal Vaskob104f112020-07-17 09:54:54 +0200327 * @brief Find the next node, before which to insert the new node.
Michal Vasko90932a92020-02-12 14:33:03 +0100328 *
Michal Vaskob104f112020-07-17 09:54:54 +0200329 * @param[in] first_sibling First sibling of the nodes to consider.
330 * @param[in] new_node Node that will be inserted.
331 * @return Node to insert after.
332 * @return NULL if the new node should be first.
Michal Vasko90932a92020-02-12 14:33:03 +0100333 */
Michal Vaskob104f112020-07-17 09:54:54 +0200334struct 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 +0100335
336/**
Michal Vaskob104f112020-07-17 09:54:54 +0200337 * @brief Insert a node into parent/siblings. Order and hashes are fully handled.
Michal Vasko90932a92020-02-12 14:33:03 +0100338 *
Michal Vasko9b368d32020-02-14 13:53:31 +0100339 * @param[in] parent Parent to insert into, NULL for top-level sibling.
340 * @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 +0100341 * @param[in] node Individual node (without siblings) to insert.
Michal Vasko6ee6f432021-07-16 09:49:14 +0200342 * @param[in] last If set, do not search for the correct anchor but always insert at the end.
Michal Vasko90932a92020-02-12 14:33:03 +0100343 */
Michal Vasko6ee6f432021-07-16 09:49:14 +0200344void lyd_insert_node(struct lyd_node *parent, struct lyd_node **first_sibling, struct lyd_node *node, ly_bool last);
Michal Vasko90932a92020-02-12 14:33:03 +0100345
346/**
Michal Vaskoa5da3292020-08-12 13:10:50 +0200347 * @brief Insert a metadata (last) into a parent
348 *
349 * @param[in] parent Parent of the metadata.
350 * @param[in] meta Metadata (list) to be added into the @p parent.
Michal Vasko871a0252020-11-11 18:35:24 +0100351 * @param[in] clear_dflt Whether to clear dflt flag starting from @p parent, recursively all NP containers.
Michal Vaskoa5da3292020-08-12 13:10:50 +0200352 */
Michal Vasko871a0252020-11-11 18:35:24 +0100353void lyd_insert_meta(struct lyd_node *parent, struct lyd_meta *meta, ly_bool clear_dflt);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200354
355/**
Michal Vasko52927e22020-03-16 17:26:14 +0100356 * @brief Create and insert a metadata (last) into a parent.
Michal Vasko90932a92020-02-12 14:33:03 +0100357 *
Michal Vasko52927e22020-03-16 17:26:14 +0100358 * @param[in] parent Parent of the metadata, can be NULL.
Michal Vasko9f96a052020-03-10 09:41:45 +0100359 * @param[in,out] meta Metadata list to add at its end if @p parent is NULL, returned created attribute.
360 * @param[in] mod Metadata module (with the annotation definition).
Michal Vasko90932a92020-02-12 14:33:03 +0100361 * @param[in] name Attribute name.
Michal Vaskof03ed032020-03-04 13:31:44 +0100362 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100363 * @param[in] value String value to be parsed.
Michal Vaskof03ed032020-03-04 13:31:44 +0100364 * @param[in] value_len Length of @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100365 * @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 +0100366 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200367 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200368 * @param[in] hints [Value hints](@ref lydvalhints) from the parser regarding the value type.
Michal Vaskoaac267d2022-01-17 13:34:48 +0100369 * @param[in] ctx_node Value context node, may be NULL for metadata.
Michal Vasko871a0252020-11-11 18:35:24 +0100370 * @param[in] clear_dflt Whether to clear dflt flag starting from @p parent, recursively all NP containers.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200371 * @param[out] incomplete Whether the value needs to be resolved.
Michal Vasko90932a92020-02-12 14:33:03 +0100372 * @return LY_SUCCESS on success.
373 * @return LY_EINCOMPLETE in case data tree is needed to finish the validation.
374 * @return LY_ERR value if an error occurred.
375 */
Michal Vasko9f96a052020-03-10 09:41:45 +0100376LY_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 +0200377 size_t name_len, const char *value, size_t value_len, ly_bool *dynamic, LY_VALUE_FORMAT format,
Michal Vaskoaac267d2022-01-17 13:34:48 +0100378 void *prefix_data, uint32_t hints, const struct lysc_node *ctx_node, ly_bool clear_dflt, ly_bool *incomplete);
Radek Krejci1798aae2020-07-14 13:26:06 +0200379
380/**
Michal Vaskoa5da3292020-08-12 13:10:50 +0200381 * @brief Insert an attribute (last) into a parent
Radek Krejci1798aae2020-07-14 13:26:06 +0200382 *
Michal Vaskoa5da3292020-08-12 13:10:50 +0200383 * @param[in] parent Parent of the attributes.
384 * @param[in] attr Attribute (list) to be added into the @p parent.
Radek Krejci1798aae2020-07-14 13:26:06 +0200385 */
Michal Vaskoa5da3292020-08-12 13:10:50 +0200386void lyd_insert_attr(struct lyd_node *parent, struct lyd_attr *attr);
Michal Vasko90932a92020-02-12 14:33:03 +0100387
388/**
Michal Vasko52927e22020-03-16 17:26:14 +0100389 * @brief Create and insert a generic attribute (last) into a parent.
390 *
391 * @param[in] parent Parent of the attribute, can be NULL.
392 * @param[in,out] attr Attribute list to add at its end if @p parent is NULL, returned created attribute.
393 * @param[in] ctx libyang context.
394 * @param[in] name Attribute name.
395 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko52927e22020-03-16 17:26:14 +0100396 * @param[in] prefix Attribute prefix.
397 * @param[in] prefix_len Attribute prefix length.
Radek Krejci1798aae2020-07-14 13:26:06 +0200398 * @param[in] module_key Mandatory key to reference module, can be namespace or name.
399 * @param[in] module_key_len Length of @p module_key, must be set correctly.
Michal Vasko501af032020-11-11 20:27:44 +0100400 * @param[in] value String value to be parsed.
401 * @param[in] value_len Length of @p value, must be set correctly.
402 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
403 * @param[in] format Input format of @p value and @p ns.
404 * @param[in] val_prefix_data Format-specific prefix data, param is spent (even in case the function fails).
405 * @param[in] hints [Hints](@ref lydhints) from the parser regarding the node/value type.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200406 * @return LY_SUCCESS on success,
407 * @return LY_ERR value on error.
Michal Vasko52927e22020-03-16 17:26:14 +0100408 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200409LY_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 +0100410 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 +0200411 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 +0200412
413/**
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200414 * @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 +0200415 *
Michal Vasko8d544252020-03-02 10:19:52 +0100416 * @param[in] ctx libyang context.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200417 * @param[in,out] val Storage for the value.
418 * @param[in] type Type of the value.
Radek Krejcif9943642021-04-26 10:18:21 +0200419 * @param[in] value Value to be parsed, must not be NULL.
Michal Vaskof03ed032020-03-04 13:31:44 +0100420 * @param[in] value_len Length of the give @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100421 * @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 +0200422 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200423 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200424 * @param[in] hints [Value hints](@ref lydvalhints) from the parser.
425 * @param[in] ctx_node Context schema node.
426 * @param[out] incomplete Optional, set if the value also needs to be resolved.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200427 * @return LY_SUCCESS on success,
428 * @return LY_ERR value on error.
Radek Krejci38d85362019-09-05 16:26:38 +0200429 */
Radek Krejcif9943642021-04-26 10:18:21 +0200430LY_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 +0200431 size_t value_len, ly_bool *dynamic, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints,
Radek Krejci2efc45b2020-12-22 16:25:44 +0100432 const struct lysc_node *ctx_node, ly_bool *incomplete);
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200433
434/**
435 * @brief Validate previously incompletely stored value.
436 *
437 * @param[in] ctx libyang context.
438 * @param[in] type Schema type of the value (not the stored one, but the original one).
439 * @param[in,out] val Stored value to resolve.
440 * @param[in] ctx_node Context node for the resolution.
441 * @param[in] tree Data tree for the resolution.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200442 * @return LY_SUCCESS on success,
443 * @return LY_ERR value on error.
444 */
445LY_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 +0100446 const struct lyd_node *ctx_node, const struct lyd_node *tree);
Radek Krejci38d85362019-09-05 16:26:38 +0200447
Michal Vaskoaebbce02021-04-06 09:23:37 +0200448/**
449 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value coming
450 * from a schema.
451 *
452 * This function check just the type's restriction, if you want to check also the data tree context (e.g. in case of
453 * require-instance restriction), use ::lyd_value_validate().
454 *
455 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
456 * @param[in] node Schema node for the @p value.
457 * @param[in] value String value to be checked, expected to be in JSON format.
458 * @param[in] value_len Length of the given @p value (mandatory).
459 * @param[in] format Value prefix format.
460 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
461 * @return LY_SUCCESS on success
462 * @return LY_ERR value if an error occurred.
463 */
464LY_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 +0200465 LY_VALUE_FORMAT format, void *prefix_data);
Michal Vaskof937cfe2020-08-03 16:07:12 +0200466
Radek Krejci38d85362019-09-05 16:26:38 +0200467/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200468 * @defgroup datahash Data nodes hash manipulation
469 * @ingroup datatree
Michal Vasko8081a812021-07-15 09:19:43 +0200470 * @{
Radek Krejcie7b95092019-05-15 11:03:07 +0200471 */
472
473/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200474 * @brief Generate hash for the node.
475 *
476 * @param[in] node Data node to (re)generate hash value.
477 * @return LY_ERR value.
478 */
479LY_ERR lyd_hash(struct lyd_node *node);
480
481/**
482 * @brief Insert hash of the node into the hash table of its parent.
483 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200484 * @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 +0200485 * @return LY_ERR value.
486 */
487LY_ERR lyd_insert_hash(struct lyd_node *node);
488
489/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200490 * @brief Maintain node's parent's children hash table when unlinking the node.
491 *
492 * When completely freeing data tree, it is expected to free the parent's children hash table first, at once.
493 *
494 * @param[in] node The data node being unlinked from its parent.
495 */
496void lyd_unlink_hash(struct lyd_node *node);
497
498/** @} datahash */
499
Radek Krejci084289f2019-07-09 17:35:30 +0200500/**
Michal Vaskod59035b2020-07-08 12:00:06 +0200501 * @brief Append all list key predicates to path.
502 *
503 * @param[in] node Node with keys to print.
504 * @param[in,out] buffer Buffer to print to.
505 * @param[in,out] buflen Current buffer length.
506 * @param[in,out] bufused Current number of characters used in @p buffer.
507 * @param[in] is_static Whether buffer is static or can be reallocated.
508 * @return LY_ERR
509 */
Radek Krejci857189e2020-09-01 13:26:36 +0200510LY_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 +0200511
Michal Vasko88d37592021-12-13 11:50:51 +0100512/**
513 * @brief Remove an object on the specific set index keeping the order of the other objects.
514 *
515 * @param[in] set Set from which a node will be removed.
516 * @param[in] index Index of the object to remove in the \p set.
517 * @param[in] destructor Optional function to free the objects being removed.
518 * @return LY_ERR return value.
519 */
520LY_ERR ly_set_rm_index_ordered(struct ly_set *set, uint32_t index, void (*destructor)(void *obj));
521
Radek Krejcie7b95092019-05-15 11:03:07 +0200522#endif /* LY_TREE_DATA_INTERNAL_H_ */