blob: 05ad5fc52e03009109c0696cbedb82b1dd0dccc4 [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 Vaskod3bb12f2020-12-04 14:33:09 +010036 * @brief Check whether a node to be deleted is the root node, move it if it is.
Michal Vaskob1b5c262020-03-05 14:29:47 +010037 *
Michal Vaskod3bb12f2020-12-04 14:33:09 +010038 * @param[in] root Root sibling.
Michal Vaskob1b5c262020-03-05 14:29:47 +010039 * @param[in] to_del Node to be deleted.
Michal Vaskod3bb12f2020-12-04 14:33:09 +010040 * @param[in] mod If set, it is expected @p tree should point to the first node of @p mod. Otherwise it will simply be
41 * the first top-level sibling.
Michal Vaskob1b5c262020-03-05 14:29:47 +010042 */
Michal Vaskod3bb12f2020-12-04 14:33:09 +010043void 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 +010044
45/**
Radek Krejcie7b95092019-05-15 11:03:07 +020046 * @brief Get address of a node's child pointer if any.
47 *
Radek Krejcie7b95092019-05-15 11:03:07 +020048 * @param[in] node Node to check.
Michal Vasko9b368d32020-02-14 13:53:31 +010049 * @return Address of the node's child member,
50 * @return NULL if there is no child pointer.
Radek Krejcie7b95092019-05-15 11:03:07 +020051 */
Michal Vaskoe0665742021-02-11 11:08:44 +010052struct lyd_node **lyd_node_child_p(struct lyd_node *node);
Radek Krejcie7b95092019-05-15 11:03:07 +020053
54/**
Radek Krejci8678fa42020-08-18 16:07:28 +020055 * @brief Just like ::lys_getnext() but iterates over all data instances of the schema nodes.
Michal Vaskoa6669ba2020-08-06 16:14:26 +020056 *
57 * @param[in] last Last returned data node.
58 * @param[in] sibling Data node sibling to search in.
59 * @param[in,out] slast Schema last node, set to NULL for first call and do not change afterwards.
60 * May not be set if the function is used only for any suitable node existence check (such as the existence
61 * of any choice case data).
62 * @param[in] parent Schema parent of the iterated children nodes.
63 * @param[in] module Schema module of the iterated top-level nodes.
64 * @return Next matching data node,
65 * @return NULL if last data node was already returned.
66 */
67struct lyd_node *lys_getnext_data(const struct lyd_node *last, const struct lyd_node *sibling,
Radek Krejci0f969882020-08-21 16:56:47 +020068 const struct lysc_node **slast, const struct lysc_node *parent,
69 const struct lysc_module *module);
Michal Vaskoa6669ba2020-08-06 16:14:26 +020070
71/**
Michal Vasko9b368d32020-02-14 13:53:31 +010072 * @brief Create a term (leaf/leaf-list) node from a string value.
73 *
74 * Hash is calculated and new node flag is set.
Michal Vasko90932a92020-02-12 14:33:03 +010075 *
76 * @param[in] schema Schema node of the new data node.
77 * @param[in] value String value to be parsed.
Michal Vaskof03ed032020-03-04 13:31:44 +010078 * @param[in] value_len Length of @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +010079 * @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 +010080 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +020081 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +020082 * @param[in] hints [Value hints](@ref lydvalhints) from the parser regarding the value type.
83 * @param[out] incomplete Whether the value needs to be resolved.
Michal Vasko90932a92020-02-12 14:33:03 +010084 * @param[out] node Created node.
85 * @return LY_SUCCESS on success.
86 * @return LY_EINCOMPLETE in case data tree is needed to finish the validation.
87 * @return LY_ERR value if an error occurred.
88 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +020089LY_ERR lyd_create_term(const struct lysc_node *schema, const char *value, size_t value_len, ly_bool *dynamic,
90 LY_PREFIX_FORMAT format, void *prefix_data, uint32_t hints, ly_bool *incomplete, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +010091
92/**
Michal Vasko9b368d32020-02-14 13:53:31 +010093 * @brief Create a term (leaf/leaf-list) node from a parsed value by duplicating it.
94 *
95 * Hash is calculated and new node flag is set.
96 *
97 * @param[in] schema Schema node of the new data node.
98 * @param[in] val Parsed value to use.
99 * @param[out] node Created node.
100 * @return LY_SUCCESS on success.
101 * @return LY_ERR value if an error occurred.
102 */
103LY_ERR lyd_create_term2(const struct lysc_node *schema, const struct lyd_value *val, struct lyd_node **node);
104
105/**
106 * @brief Create an inner (container/list/RPC/action/notification) node.
107 *
108 * Hash is calculated and new node flag is set except
109 * for list with keys, when the hash is not calculated!
110 * Also, non-presence container has its default flag set.
Michal Vasko90932a92020-02-12 14:33:03 +0100111 *
112 * @param[in] schema Schema node of the new data node.
113 * @param[out] node Created node.
114 * @return LY_SUCCESS on success.
115 * @return LY_ERR value if an error occurred.
116 */
117LY_ERR lyd_create_inner(const struct lysc_node *schema, struct lyd_node **node);
118
119/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100120 * @brief Create a list with all its keys (cannot be used for key-less list).
121 *
122 * Hash is calculated and new node flag is set.
Michal Vasko90932a92020-02-12 14:33:03 +0100123 *
124 * @param[in] schema Schema node of the new data node.
Michal Vasko004d3152020-06-11 19:59:22 +0200125 * @param[in] predicates Compiled key list predicates.
Michal Vasko90932a92020-02-12 14:33:03 +0100126 * @param[out] node Created node.
127 * @return LY_SUCCESS on success.
128 * @return LY_ERR value if an error occurred.
129 */
Michal Vasko004d3152020-06-11 19:59:22 +0200130LY_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 +0100131
132/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100133 * @brief Create an anyxml/anydata node.
134 *
135 * Hash is calculated and flags are properly set based on @p is_valid.
Michal Vasko90932a92020-02-12 14:33:03 +0100136 *
137 * @param[in] schema Schema node of the new data node.
Michal Vasko366a4a12020-12-04 16:23:57 +0100138 * @param[in] value Value of the any node.
Michal Vasko90932a92020-02-12 14:33:03 +0100139 * @param[in] value_type Value type of the value.
Michal Vasko366a4a12020-12-04 16:23:57 +0100140 * @param[in] use_value Whether to directly assign (eat) the value or duplicate it.
Michal Vasko90932a92020-02-12 14:33:03 +0100141 * @param[out] node Created node.
142 * @return LY_SUCCESS on success.
143 * @return LY_ERR value if an error occurred.
144 */
Michal Vasko9b368d32020-02-14 13:53:31 +0100145LY_ERR lyd_create_any(const struct lysc_node *schema, const void *value, LYD_ANYDATA_VALUETYPE value_type,
Michal Vasko366a4a12020-12-04 16:23:57 +0100146 ly_bool use_value, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100147
148/**
Michal Vasko52927e22020-03-16 17:26:14 +0100149 * @brief Create an opaque node.
150 *
151 * @param[in] ctx libyang context.
152 * @param[in] name Element name.
153 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko52927e22020-03-16 17:26:14 +0100154 * @param[in] prefix Element prefix.
155 * @param[in] pref_len Length of @p prefix, must be set correctly.
Radek Krejci1798aae2020-07-14 13:26:06 +0200156 * @param[in] module_key Mandatory key to reference module, can be namespace or name.
157 * @param[in] module_key_len Length of @p module_key, must be set correctly.
Michal Vasko501af032020-11-11 20:27:44 +0100158 * @param[in] value String value to be parsed.
159 * @param[in] value_len Length of @p value, must be set correctly.
160 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
161 * @param[in] format Input format of @p value and @p ns.
Radek Krejciec9ad602021-01-04 10:46:30 +0100162 * @param[in] val_prefix_data Format-specific prefix data, param is spent (even in case the function fails):
163 * LY_PREF_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
164 * LY_PREF_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
165 * LY_PREF_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
166 * LY_PREF_JSON - NULL
Michal Vasko501af032020-11-11 20:27:44 +0100167 * @param[in] hints [Hints](@ref lydhints) from the parser regarding the node/value type.
Michal Vasko52927e22020-03-16 17:26:14 +0100168 * @param[out] node Created node.
169 * @return LY_SUCCESS on success.
170 * @return LY_ERR value if an error occurred.
171 */
Michal Vasko501af032020-11-11 20:27:44 +0100172LY_ERR lyd_create_opaq(const struct ly_ctx *ctx, const char *name, size_t name_len, const char *prefix, size_t pref_len,
173 const char *module_key, size_t module_key_len, const char *value, size_t value_len, ly_bool *dynamic,
174 LY_PREFIX_FORMAT format, void *val_prefix_data, uint32_t hints, struct lyd_node **node);
Michal Vasko52927e22020-03-16 17:26:14 +0100175
176/**
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200177 * @brief Check the existence and create any non-existing implicit siblings, recursively for the created nodes.
178 *
179 * @param[in] parent Parent of the potential default values, NULL for top-level siblings.
180 * @param[in,out] first First sibling.
181 * @param[in] sparent Schema parent of the siblings, NULL if schema of @p parent can be used.
182 * @param[in] mod Module of the default values, NULL for nested siblings.
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200183 * @param[in] node_when Optional set to add nodes with "when" conditions into.
Radek Krejci4f2e3e52021-03-30 14:20:28 +0200184 * @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 +0100185 * @param[in] node_types Optional set to add nodes with unresolved types into.
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200186 * @param[in] impl_opts Implicit options (@ref implicitoptions).
187 * @param[in,out] diff Validation diff.
188 * @return LY_ERR value.
189 */
190LY_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 +0200191 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 +0200192 uint32_t impl_opts, struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200193
194/**
Michal Vaskob104f112020-07-17 09:54:54 +0200195 * @brief Find the next node, before which to insert the new node.
Michal Vasko90932a92020-02-12 14:33:03 +0100196 *
Michal Vaskob104f112020-07-17 09:54:54 +0200197 * @param[in] first_sibling First sibling of the nodes to consider.
198 * @param[in] new_node Node that will be inserted.
199 * @return Node to insert after.
200 * @return NULL if the new node should be first.
Michal Vasko90932a92020-02-12 14:33:03 +0100201 */
Michal Vaskob104f112020-07-17 09:54:54 +0200202struct 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 +0100203
204/**
Michal Vaskob104f112020-07-17 09:54:54 +0200205 * @brief Insert a node into parent/siblings. Order and hashes are fully handled.
Michal Vasko90932a92020-02-12 14:33:03 +0100206 *
Michal Vasko9b368d32020-02-14 13:53:31 +0100207 * @param[in] parent Parent to insert into, NULL for top-level sibling.
208 * @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 +0100209 * @param[in] node Individual node (without siblings) to insert.
210 */
Michal Vasko9b368d32020-02-14 13:53:31 +0100211void lyd_insert_node(struct lyd_node *parent, struct lyd_node **first_sibling, struct lyd_node *node);
Michal Vasko90932a92020-02-12 14:33:03 +0100212
213/**
Michal Vaskoa5da3292020-08-12 13:10:50 +0200214 * @brief Insert a metadata (last) into a parent
215 *
216 * @param[in] parent Parent of the metadata.
217 * @param[in] meta Metadata (list) to be added into the @p parent.
Michal Vasko871a0252020-11-11 18:35:24 +0100218 * @param[in] clear_dflt Whether to clear dflt flag starting from @p parent, recursively all NP containers.
Michal Vaskoa5da3292020-08-12 13:10:50 +0200219 */
Michal Vasko871a0252020-11-11 18:35:24 +0100220void lyd_insert_meta(struct lyd_node *parent, struct lyd_meta *meta, ly_bool clear_dflt);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200221
222/**
Michal Vasko52927e22020-03-16 17:26:14 +0100223 * @brief Create and insert a metadata (last) into a parent.
Michal Vasko90932a92020-02-12 14:33:03 +0100224 *
Michal Vasko52927e22020-03-16 17:26:14 +0100225 * @param[in] parent Parent of the metadata, can be NULL.
Michal Vasko9f96a052020-03-10 09:41:45 +0100226 * @param[in,out] meta Metadata list to add at its end if @p parent is NULL, returned created attribute.
227 * @param[in] mod Metadata module (with the annotation definition).
Michal Vasko90932a92020-02-12 14:33:03 +0100228 * @param[in] name Attribute name.
Michal Vaskof03ed032020-03-04 13:31:44 +0100229 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100230 * @param[in] value String value to be parsed.
Michal Vaskof03ed032020-03-04 13:31:44 +0100231 * @param[in] value_len Length of @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100232 * @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 +0100233 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200234 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200235 * @param[in] hints [Value hints](@ref lydvalhints) from the parser regarding the value type.
Michal Vasko871a0252020-11-11 18:35:24 +0100236 * @param[in] clear_dflt Whether to clear dflt flag starting from @p parent, recursively all NP containers.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200237 * @param[out] incomplete Whether the value needs to be resolved.
Michal Vasko90932a92020-02-12 14:33:03 +0100238 * @return LY_SUCCESS on success.
239 * @return LY_EINCOMPLETE in case data tree is needed to finish the validation.
240 * @return LY_ERR value if an error occurred.
241 */
Michal Vasko9f96a052020-03-10 09:41:45 +0100242LY_ERR lyd_create_meta(struct lyd_node *parent, struct lyd_meta **meta, const struct lys_module *mod, const char *name,
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200243 size_t name_len, const char *value, size_t value_len, ly_bool *dynamic, LY_PREFIX_FORMAT format,
Michal Vasko871a0252020-11-11 18:35:24 +0100244 void *prefix_data, uint32_t hints, ly_bool clear_dlft, ly_bool *incomplete);
Radek Krejci1798aae2020-07-14 13:26:06 +0200245
246/**
Michal Vaskoa5da3292020-08-12 13:10:50 +0200247 * @brief Insert an attribute (last) into a parent
Radek Krejci1798aae2020-07-14 13:26:06 +0200248 *
Michal Vaskoa5da3292020-08-12 13:10:50 +0200249 * @param[in] parent Parent of the attributes.
250 * @param[in] attr Attribute (list) to be added into the @p parent.
Radek Krejci1798aae2020-07-14 13:26:06 +0200251 */
Michal Vaskoa5da3292020-08-12 13:10:50 +0200252void lyd_insert_attr(struct lyd_node *parent, struct lyd_attr *attr);
Michal Vasko90932a92020-02-12 14:33:03 +0100253
254/**
Michal Vasko52927e22020-03-16 17:26:14 +0100255 * @brief Create and insert a generic attribute (last) into a parent.
256 *
257 * @param[in] parent Parent of the attribute, can be NULL.
258 * @param[in,out] attr Attribute list to add at its end if @p parent is NULL, returned created attribute.
259 * @param[in] ctx libyang context.
260 * @param[in] name Attribute name.
261 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko52927e22020-03-16 17:26:14 +0100262 * @param[in] prefix Attribute prefix.
263 * @param[in] prefix_len Attribute prefix length.
Radek Krejci1798aae2020-07-14 13:26:06 +0200264 * @param[in] module_key Mandatory key to reference module, can be namespace or name.
265 * @param[in] module_key_len Length of @p module_key, must be set correctly.
Michal Vasko501af032020-11-11 20:27:44 +0100266 * @param[in] value String value to be parsed.
267 * @param[in] value_len Length of @p value, must be set correctly.
268 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
269 * @param[in] format Input format of @p value and @p ns.
270 * @param[in] val_prefix_data Format-specific prefix data, param is spent (even in case the function fails).
271 * @param[in] hints [Hints](@ref lydhints) from the parser regarding the node/value type.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200272 * @return LY_SUCCESS on success,
273 * @return LY_ERR value on error.
Michal Vasko52927e22020-03-16 17:26:14 +0100274 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200275LY_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 +0100276 size_t name_len, const char *prefix, size_t prefix_len, const char *module_key, size_t module_key_len,
277 const char *value, size_t value_len, ly_bool *dynamic, LY_PREFIX_FORMAT format, void *val_prefix_data, uint32_t hints);
Radek Krejci1798aae2020-07-14 13:26:06 +0200278
279/**
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200280 * @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 +0200281 *
Michal Vasko8d544252020-03-02 10:19:52 +0100282 * @param[in] ctx libyang context.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200283 * @param[in,out] val Storage for the value.
284 * @param[in] type Type of the value.
Radek Krejci38d85362019-09-05 16:26:38 +0200285 * @param[in] value String value to be parsed, must not be NULL.
Michal Vaskof03ed032020-03-04 13:31:44 +0100286 * @param[in] value_len Length of the give @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100287 * @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 +0200288 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200289 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200290 * @param[in] hints [Value hints](@ref lydvalhints) from the parser.
291 * @param[in] ctx_node Context schema node.
292 * @param[out] incomplete Optional, set if the value also needs to be resolved.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200293 * @return LY_SUCCESS on success,
294 * @return LY_ERR value on error.
Radek Krejci38d85362019-09-05 16:26:38 +0200295 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200296LY_ERR lyd_value_store(const struct ly_ctx *ctx, struct lyd_value *val, const struct lysc_type *type, const char *value,
297 size_t value_len, ly_bool *dynamic, LY_PREFIX_FORMAT format, void *prefix_data, uint32_t hints,
Radek Krejci2efc45b2020-12-22 16:25:44 +0100298 const struct lysc_node *ctx_node, ly_bool *incomplete);
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200299
300/**
301 * @brief Validate previously incompletely stored value.
302 *
303 * @param[in] ctx libyang context.
304 * @param[in] type Schema type of the value (not the stored one, but the original one).
305 * @param[in,out] val Stored value to resolve.
306 * @param[in] ctx_node Context node for the resolution.
307 * @param[in] tree Data tree for the resolution.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200308 * @return LY_SUCCESS on success,
309 * @return LY_ERR value on error.
310 */
311LY_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 +0100312 const struct lyd_node *ctx_node, const struct lyd_node *tree);
Radek Krejci38d85362019-09-05 16:26:38 +0200313
Michal Vaskoaebbce02021-04-06 09:23:37 +0200314/**
315 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value coming
316 * from a schema.
317 *
318 * This function check just the type's restriction, if you want to check also the data tree context (e.g. in case of
319 * require-instance restriction), use ::lyd_value_validate().
320 *
321 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
322 * @param[in] node Schema node for the @p value.
323 * @param[in] value String value to be checked, expected to be in JSON format.
324 * @param[in] value_len Length of the given @p value (mandatory).
325 * @param[in] format Value prefix format.
326 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
327 * @return LY_SUCCESS on success
328 * @return LY_ERR value if an error occurred.
329 */
330LY_ERR lys_value_validate(const struct ly_ctx *ctx, const struct lysc_node *node, const char *value, size_t value_len,
Radek Krejci0f969882020-08-21 16:56:47 +0200331 LY_PREFIX_FORMAT format, void *prefix_data);
Michal Vaskof937cfe2020-08-03 16:07:12 +0200332
Radek Krejci38d85362019-09-05 16:26:38 +0200333/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200334 * @defgroup datahash Data nodes hash manipulation
335 * @ingroup datatree
336 */
337
338/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200339 * @brief Generate hash for the node.
340 *
341 * @param[in] node Data node to (re)generate hash value.
342 * @return LY_ERR value.
343 */
344LY_ERR lyd_hash(struct lyd_node *node);
345
346/**
347 * @brief Insert hash of the node into the hash table of its parent.
348 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200349 * @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 +0200350 * @return LY_ERR value.
351 */
352LY_ERR lyd_insert_hash(struct lyd_node *node);
353
354/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200355 * @brief Maintain node's parent's children hash table when unlinking the node.
356 *
357 * When completely freeing data tree, it is expected to free the parent's children hash table first, at once.
358 *
359 * @param[in] node The data node being unlinked from its parent.
360 */
361void lyd_unlink_hash(struct lyd_node *node);
362
363/** @} datahash */
364
Radek Krejci084289f2019-07-09 17:35:30 +0200365/**
Michal Vaskob1b5c262020-03-05 14:29:47 +0100366 * @brief Iterate over implemented modules for functions that accept specific modules or the whole context.
367 *
368 * @param[in] tree Data tree.
Michal Vasko26e80012020-07-08 10:55:46 +0200369 * @param[in] module Selected module, NULL for all.
Michal Vaskob1b5c262020-03-05 14:29:47 +0100370 * @param[in] ctx Context, NULL for selected modules.
371 * @param[in,out] i Iterator, set to 0 on first call.
372 * @param[out] first First sibling of the returned module.
373 * @return Next module.
374 * @return NULL if all modules were traversed.
375 */
Michal Vasko26e80012020-07-08 10:55:46 +0200376const struct lys_module *lyd_mod_next_module(struct lyd_node *tree, const struct lys_module *module,
Radek Krejci0f969882020-08-21 16:56:47 +0200377 const struct ly_ctx *ctx, uint32_t *i, struct lyd_node **first);
Michal Vaskob1b5c262020-03-05 14:29:47 +0100378
379/**
380 * @brief Iterate over modules for functions that want to traverse all the top-level data.
381 *
382 * @param[in,out] next Pointer to the next module data, set to first top-level sibling on first call.
383 * @param[out] first First sibling of the returned module.
384 * @return Next module.
385 * @return NULL if all modules were traversed.
386 */
387const struct lys_module *lyd_data_next_module(struct lyd_node **next, struct lyd_node **first);
388
Michal Vasko9f96a052020-03-10 09:41:45 +0100389/**
390 * @brief Check that a list has all its keys.
391 *
392 * @param[in] node List to check.
Michal Vasko44685da2020-03-17 15:38:06 +0100393 * @return LY_SUCCESS on success.
394 * @return LY_ENOT on a missing key.
Michal Vasko9f96a052020-03-10 09:41:45 +0100395 */
396LY_ERR lyd_parse_check_keys(struct lyd_node *node);
397
Michal Vasko60ea6352020-06-29 13:39:39 +0200398/**
399 * @brief Set data flags for a newly parsed node.
400 *
401 * @param[in] node Node to use.
Radek Krejci4f2e3e52021-03-30 14:20:28 +0200402 * @param[in,out] when_check Set of nodes with unresolved when.
403 * @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 +0200404 * @param[in,out] meta Node metadata, may be removed from.
405 * @param[in] options Parse options.
406 */
Radek Krejci4f2e3e52021-03-30 14:20:28 +0200407void lyd_parse_set_data_flags(struct lyd_node *node, struct ly_set *when_check, struct ly_set *exts_check,
408 struct lyd_meta **meta, uint32_t options);
Michal Vasko60ea6352020-06-29 13:39:39 +0200409
410/**
Michal Vaskod59035b2020-07-08 12:00:06 +0200411 * @brief Append all list key predicates to path.
412 *
413 * @param[in] node Node with keys to print.
414 * @param[in,out] buffer Buffer to print to.
415 * @param[in,out] buflen Current buffer length.
416 * @param[in,out] bufused Current number of characters used in @p buffer.
417 * @param[in] is_static Whether buffer is static or can be reallocated.
418 * @return LY_ERR
419 */
Radek Krejci857189e2020-09-01 13:26:36 +0200420LY_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 +0200421
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100422/**
423 * @brief Free stored prefix data.
424 *
425 * @param[in] format Format of the prefixes.
Radek Krejciec9ad602021-01-04 10:46:30 +0100426 * @param[in] prefix_data Format-specific data to free:
427 * LY_PREF_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
428 * LY_PREF_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
429 * LY_PREF_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
430 * LY_PREF_JSON - NULL
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100431 */
432void ly_free_prefix_data(LY_PREFIX_FORMAT format, void *prefix_data);
433
434/**
435 * @brief Duplicate prefix data.
436 *
437 * @param[in] ctx libyang context.
438 * @param[in] format Format of the prefixes in the value.
439 * @param[in] prefix_data Prefix data to duplicate.
440 * @param[out] prefix_data_p Duplicated prefix data.
441 * @return LY_ERR value.
442 */
443LY_ERR ly_dup_prefix_data(const struct ly_ctx *ctx, LY_PREFIX_FORMAT format, const void *prefix_data, void **prefix_data_p);
444
445/**
Michal Vaskofc2cd072021-02-24 13:17:17 +0100446 * @brief Store used prefixes in a string.
447 *
448 * If @p prefix_data_p are non-NULL, they are treated as valid according to the @p format_p and new possible
449 * prefixes are simply added. This way it is possible to store prefix data for several strings together.
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100450 *
451 * @param[in] ctx libyang context.
452 * @param[in] value Value string to be parsed.
453 * @param[in] value_len Length of the @p value string.
454 * @param[in] format Format of the prefixes in the value.
455 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofc2cd072021-02-24 13:17:17 +0100456 * @param[in,out] format_p Resulting format of the prefixes.
457 * @param[in,out] prefix_data_p Resulting prefix data for the value in format @p format_p.
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100458 * @return LY_ERR value.
459 */
460LY_ERR ly_store_prefix_data(const struct ly_ctx *ctx, const char *value, size_t value_len, LY_PREFIX_FORMAT format,
Radek Krejcid64d6462021-03-16 15:58:00 +0100461 const void *prefix_data, LY_PREFIX_FORMAT *format_p, void **prefix_data_p);
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100462
Michal Vasko7ed1fcb2020-12-03 14:15:22 +0100463/**
464 * @brief Get string name of the format.
465 *
466 * @param[in] format Format whose name to get.
467 * @return Format string name.
468 */
469const char *ly_format2str(LY_PREFIX_FORMAT format);
470
Radek Krejcie7b95092019-05-15 11:03:07 +0200471#endif /* LY_TREE_DATA_INTERNAL_H_ */