blob: 3792439f71315f0e96b2aae07df196dcde1d62fe [file] [log] [blame]
Radek Krejcie7b95092019-05-15 11:03:07 +02001/**
2 * @file tree_data.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief libyang representation of YANG data trees.
5 *
6 * Copyright (c) 2015 - 2019 CESNET, z.s.p.o.
7 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_TREE_DATA_H_
16#define LY_TREE_DATA_H_
17
18#include <stddef.h>
19#include <stdint.h>
20
21#include "log.h"
Christian Hopps59618972021-02-01 05:01:35 -050022#include "tree.h"
23#include "tree_schema.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020024
Radek Krejcica376bd2020-06-11 16:04:06 +020025#ifdef __cplusplus
26extern "C" {
27#endif
28
Radek Krejcie7b95092019-05-15 11:03:07 +020029struct ly_ctx;
Michal Vasko004d3152020-06-11 19:59:22 +020030struct ly_path;
Radek Krejci535ea9f2020-05-29 16:01:05 +020031struct ly_set;
32struct lyd_node;
33struct lyd_node_opaq;
Radek Krejci47fab892020-11-05 17:02:41 +010034struct lyd_node_term;
Radek Krejcie7b95092019-05-15 11:03:07 +020035
Radek Krejcie7b95092019-05-15 11:03:07 +020036/**
Radek Krejci8678fa42020-08-18 16:07:28 +020037 * @page howtoData Data Instances
38 *
39 * All the nodes in data tree comes are based on ::lyd_node structure. According to the content of the ::lyd_node.schema
40 * it can be cast to several other structures.
41 *
42 * In case the ::lyd_node.schema pointer is NULL, the node is actually __opaq__ and can be safely cast to ::lyd_node_opaq.
43 * The opaq node represent an unknown node which wasn't mapped to any [(compiled) schema](@ref howtoSchema) node in the
44 * context. Such a node can appear in several places in the data tree.
45 * - As a part of the tree structure, but only in the case the ::LYD_PARSE_OPAQ option was used when input data were
46 * [parsed](@ref howtoDataParsers), because unknown data instances are ignored by default. The same way, the opaq nodes can
47 * appear as a node's attributes.
48 * - As a representation of YANG anydata/anyxml content.
49 * - As envelopes of standard data tree instances (RPCs, actions or Notifications).
50 *
51 * In case the data node has its definition in a [compiled schema tree](@ref howtoSchema), the structure of the data node is
52 * actually one of the followings according to the schema node's nodetype (::lysc_node.nodetype).
53 * - ::lyd_node_inner - represents data nodes corresponding to schema nodes matching ::LYD_NODE_INNER nodetypes. They provide
54 * structure of the tree by having children nodes.
55 * - ::lyd_node_term - represents data nodes corresponding to schema nodes matching ::LYD_NODE_TERM nodetypes. The terminal
56 * nodes provide values of the particular configuration/status information. The values are represented as ::lyd_value
Radek Krejci6d5ba0c2021-04-26 07:49:59 +020057 * structure with string representation of the value (retrieved by ::lyd_get_value() and ::lyd_get_meta_value()) and
58 * the type specific data stored in the structure's union according to the real type of the value (::lyd_value.realtype).
59 * The string representation provides canonical representation of the value in case the type has the canonical
60 * representation specified. Otherwise, it is the original value or, in case the value can contain prefixes, the JSON
61 * format is used to make the value unambiguous.
Radek Krejci8678fa42020-08-18 16:07:28 +020062 * - ::lyd_node_any - represents data nodes corresponding to schema nodes matching ::LYD_NODE_ANY nodetypes.
63 *
64 * Despite all the aforementioned structures and their members are available as part of the libyang API and callers can use
65 * it to navigate through the data tree structure or to obtain various information, we recommend to use the following macros
66 * and functions.
67 * - ::lyd_child() (or ::lyd_child_no_keys()) and ::lyd_parent() to get the node's child/parent node.
68 * - ::LYD_CTX to get libyang context from a data node.
Radek Krejci6d5ba0c2021-04-26 07:49:59 +020069 * - ::lyd_get_value()/::lyd_get_meta_value() to get canonical string value from a terminal node/metadata instance.
Radek Krejci8678fa42020-08-18 16:07:28 +020070 * - ::LYD_TREE_DFS_BEGIN and ::LYD_TREE_DFS_END to traverse the data tree (depth-first).
71 * - ::LY_LIST_FOR and ::LY_ARRAY_FOR as described on @ref howtoStructures page.
72 *
73 * Instead of going through the data tree on your own, a specific data node can be also located using a wide set of
74 * \b lyd_find_*() functions.
75 *
76 * More information about specific operations with data instances can be found on the following pages:
77 * - @subpage howtoDataParsers
78 * - @subpage howtoDataValidation
79 * - @subpage howtoDataWD
80 * - @subpage howtoDataManipulation
81 * - @subpage howtoDataPrinters
82 *
83 * \note API for this group of functions is described in the [Data Instances module](@ref datatree).
84 *
85 * Functions List (not assigned to above subsections)
86 * --------------------------------------------------
87 * - ::lyd_child()
88 * - ::lyd_child_no_keys()
89 * - ::lyd_parent()
90 * - ::lyd_owner_module()
Radek Krejci6d5ba0c2021-04-26 07:49:59 +020091 * - ::lyd_get_value()
92 * - ::lyd_get_meta_value()
Radek Krejci8678fa42020-08-18 16:07:28 +020093 * - ::lyd_find_xpath()
Michal Vasko3e1f6552021-01-14 09:27:55 +010094 * - ::lyd_find_path()
Radek Krejci8678fa42020-08-18 16:07:28 +020095 * - ::lyd_find_sibling_val()
96 * - ::lyd_find_sibling_first()
Michal Vasko1d4af6c2021-02-22 13:31:26 +010097 * - ::lyd_find_sibling_opaq_next()
Radek Krejci8678fa42020-08-18 16:07:28 +020098 * - ::lyd_find_meta()
99 *
100 * - ::lyd_path()
101 * - ::lyd_target()
102 *
103 * - ::lyd_lyb_data_length()
Radek Krejci75104122021-04-01 15:37:45 +0200104 *
105 *
106 * @section howtoDataMetadata Metadata Support
107 *
108 * YANG Metadata annotations are defined in [RFC 7952](https://tools.ietf.org/html/rfc7952) as YANG extension (and libyang
109 * [implements them as internal extension plugin](@ref howtoPluginsExtensions)). In practice, it allows to have XML
110 * attributes (there is also a special encoding for JSON) in YANG modeled data. libyang does not allow to have any XML
111 * attribute without the appropriate annotation definition describing the data as it is done e.g. for leafs. When an
112 * attribute without a matching annotation definition is found in the input data, it is:
113 * - silently dropped (with warning) or
114 * - an error is reported in case the ::LYD_PARSE_STRICT parser option is provided to the
115 * [parser function](@ref howtoDataParsers) or
116 * - stored into a generic ::lyd_attr structure without a connection with any YANG module in case the ::LYD_PARSE_OPAQ
117 * parser options is provided to the [parser function](@ref howtoDataParsers).
118 *
119 * There are some XML attributes, described by [YANG](https://tools.ietf.org/html/rfc7950) and
120 * [NETCONF](https://tools.ietf.org/html/rfc6241) specifications, which are not defined as annotations, but libyang
121 * implements them this way. In case of attributes in the YANG namespace (`insert`, `value` and `key` attributes
122 * for the NETCONF edit-config operation), they are defined in special libyang's internal module `yang`, which is
123 * available in each context and the content of this schema can be printed via
124 * [schema printers](@ref howtoSchemaPrinters).
125 *
126 * In case of the attributes described in [NETCONF specification](https://tools.ietf.org/html/rfc6241), the libyang's
127 * annotations structures are hidden and cannot be printed despite, internally, they are part of the `ietf-netconf`'s
128 * schema structure. Therefore, these attributes are available only when the `ietf-netconf` schema is loaded in the
129 * context. The definitions of these annotations are as follows:
130 *
131 * md:annotation operation {
132 * type enumeration {
133 * enum merge;
134 * enum replace;
135 * enum create;
136 * enum delete;
137 * enum remove;
138 * }
139 * }
140 *
141 * md:annotation type {
142 * type enumeration {
143 * enum subtree;
144 * enum xpath {
145 * if-feature "nc:xpath";
146 * }
147 * }
148 * }
149 *
150 * md:annotation select {
151 * type string;
152 * }
153 *
154 * Note, that, following the specification,
155 * - the `type` and `select` XML attributes are supposed to be unqualified (without namespace) and that
156 * - the `select`'s content is XPath and it is internally transformed by libyang into the format where the
157 * XML namespace prefixes are replaced by the YANG module names.
158 *
159 *
160 * @section howtoDataYangdata yang-data Support
161 *
162 * [RFC 8040](https://tools.ietf.org/html/rfc8040) defines ietf-restconf module, which includes yang-data extension. Despite
163 * the definition in the RESTCONF YANG module, the yang-data concept is quite generic and used even in modules without a
164 * connection to RESTCONF protocol. The extension allows to define a separated YANG trees usable separately from any
165 * datastore.
166 *
167 * libyang implements support for yang-data internally as an [extension plugin](@ref howtoPluginsExtensions). To ease the
168 * use of yang-data with libyang, there are several generic functions, which are usable for yang-data:
169 *
170 * - ::lyd_parse_ext_data()
171 * - ::lyd_parse_ext_op()
172 *
173 * - ::lys_getnext_ext()
174 *
175 * - ::lyd_new_ext_inner()
176 * - ::lyd_new_ext_list()
177 * - ::lyd_new_ext_term()
178 * - ::lyd_new_ext_any()
179 * - ::lyd_new_ext_path()
Radek Krejci8678fa42020-08-18 16:07:28 +0200180 */
181
182/**
183 * @page howtoDataManipulation Manipulating Data
184 *
185 * There are many functions to create or modify an existing data tree. You can add new nodes, reconnect nodes from
186 * one tree to another (or e.g. from one list instance to another) or remove nodes. The functions doesn't allow you
187 * to put a node to a wrong place (by checking the YANG module structure), but not all validation checks can be made directly
188 * (or you have to make a valid change by multiple tree modifications) when the tree is being changed. Therefore,
189 * the [validation process](@ref howtoDataValidation) is expected to be invoked after changing the data tree to make sure
190 * that the changed data tree is valid.
191 *
192 * When inserting a node into data tree (no matter if the node already exists, via ::lyd_insert_child() and
193 * ::lyd_insert_sibling(), or a new node is being created), the node is automatically inserted to the place respecting the
194 * nodes order from the YANG schema. So the node is not inserted to the end or beginning of the siblings list, but after the
195 * existing instance of the closest preceding sibling node from the schema. In case the node is opaq (it is not connected
196 * with any schema node), it is placed to the end of the sibling node in the order they are inserted in. The only situation
197 * when it is possible to influence the order of the nodes is the order of user-ordered list/leaf-list instances. In such
198 * a case the ::lyd_insert_after() or ::lyd_insert_before() can be used.
199 *
200 * Creating data is generally possible in two ways, they can be combined. You can add nodes one-by-one based on
201 * the node name and/or its parent (::lyd_new_inner(), ::lyd_new_term(), ::lyd_new_any(), ::lyd_new_list(), ::lyd_new_list2()
Michal Vasko493900b2020-12-08 10:23:41 +0100202 * and ::lyd_new_opaq()) or address the nodes using a [simple XPath addressing](@ref howtoXPath) (::lyd_new_path() and
203 * ::lyd_new_path2()). The latter enables to create a whole path of nodes, requires less information
Radek Krejci8678fa42020-08-18 16:07:28 +0200204 * about the modified data, and is generally simpler to use. Actually the third way is duplicating the existing data using
205 * ::lyd_dup_single(), ::lyd_dup_siblings() and ::lyd_dup_meta_single().
206 *
Radek Krejci8a5afc22021-03-12 11:10:47 +0100207 * Note, that in case the node is defined in an extension instance, the functions mentioned above do not work until you
208 * provide parent where the new node is supposed to be inserted. The reason is that all the functions searches for the
209 * top-level nodes directly inside modules. To create a top-level node defined in an extension instance, use
Radek Krejci95ccd1b2021-03-12 14:57:22 +0100210 * ::lyd_new_ext_inner(), ::lyd_new_ext_term(), ::lyd_new_ext_any(), ::lyd_new_ext_list() and ::lyd_new_ext_path()
211 * functions.
Radek Krejci8a5afc22021-03-12 11:10:47 +0100212 *
Radek Krejci75104122021-04-01 15:37:45 +0200213 * The [metadata](@ref howtoDataMetadata) (and attributes in opaq nodes) can be created with ::lyd_new_meta()
Radek Krejci8678fa42020-08-18 16:07:28 +0200214 * and ::lyd_new_attr().
215 *
216 * Changing value of a terminal node (leaf, leaf-list) is possible with ::lyd_change_term(). Similarly, the metadata value
217 * can be changed with ::lyd_change_meta(). Before changing the value, it might be useful to compare the node's value
218 * with a string value (::lyd_value_compare()) or verify that the new string value is correct for the specific data node
219 * (::lyd_value_validate()).
220 *
221 * Working with two existing subtrees can also be performed two ways. Usually, you would use lyd_insert*() functions.
222 * They are generally meant for simple inserts of a node into a data tree. For more complicated inserts and when
223 * merging 2 trees use ::lyd_merge_tree() or ::lyd_merge_siblings(). It offers additional options and is basically a more
224 * powerful insert.
225 *
226 * Besides merging, libyang is also capable to provide information about differences between two data trees. For this purpose,
227 * ::lyd_diff_tree() and ::lyd_diff_siblings() generates annotated data trees which can be, in addition, used to change one
228 * data tree to another one using ::lyd_diff_apply_all(), ::lyd_diff_apply_module() and ::lyd_diff_reverse_all(). Multiple
229 * diff data trees can be also put together for further work using ::lyd_diff_merge_all(), ::lyd_diff_merge_module() and
230 * ::lyd_diff_merge_tree() functions. To just check equivalence of the data nodes, ::lyd_compare_single(),
231 * ::lyd_compare_siblings() and ::lyd_compare_meta() can be used.
232 *
233 * To remove a node or subtree from a data tree, use ::lyd_unlink_tree() and then free the unwanted data using
234 * ::lyd_free_all() (or other \b lyd_free_*() functions).
235 *
236 * Also remember, that when you are creating/inserting a node, all the objects in that operation must belong to the
237 * same context.
238 *
239 * Modifying the single data tree in multiple threads is not safe.
240 *
241 * Functions List
242 * --------------
243 * - ::lyd_new_inner()
244 * - ::lyd_new_term()
245 * - ::lyd_new_list()
246 * - ::lyd_new_list2()
247 * - ::lyd_new_any()
248 * - ::lyd_new_opaq()
Michal Vasko8d65f852021-02-17 11:28:13 +0100249 * - ::lyd_new_opaq2()
Radek Krejci8678fa42020-08-18 16:07:28 +0200250 * - ::lyd_new_attr()
Michal Vasko8d65f852021-02-17 11:28:13 +0100251 * - ::lyd_new_attr2()
Radek Krejci8678fa42020-08-18 16:07:28 +0200252 * - ::lyd_new_meta()
253 * - ::lyd_new_path()
254 * - ::lyd_new_path2()
Radek Krejci8678fa42020-08-18 16:07:28 +0200255 *
Radek Krejcidd2a7662021-03-12 11:26:34 +0100256 * - ::lyd_new_ext_inner()
Radek Krejci8a5afc22021-03-12 11:10:47 +0100257 * - ::lyd_new_ext_term()
Radek Krejci8247bae2021-03-12 11:47:02 +0100258 * - ::lyd_new_ext_list()
Radek Krejci0b963da2021-03-12 13:23:44 +0100259 * - ::lyd_new_ext_any()
Radek Krejci95ccd1b2021-03-12 14:57:22 +0100260 * - ::lyd_new_ext_path()
Radek Krejci8a5afc22021-03-12 11:10:47 +0100261 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200262 * - ::lyd_dup_single()
263 * - ::lyd_dup_siblings()
264 * - ::lyd_dup_meta_single()
265 *
266 * - ::lyd_insert_child()
267 * - ::lyd_insert_sibling()
268 * - ::lyd_insert_after()
269 * - ::lyd_insert_before()
270 *
271 * - ::lyd_value_compare()
272 * - ::lyd_value_validate()
273 *
274 * - ::lyd_change_term()
275 * - ::lyd_change_meta()
276 *
277 * - ::lyd_compare_single()
278 * - ::lyd_compare_siblings()
279 * - ::lyd_compare_meta()
280 * - ::lyd_diff_tree()
281 * - ::lyd_diff_siblings()
282 * - ::lyd_diff_apply_all()
283 * - ::lyd_diff_apply_module()
284 * - ::lyd_diff_reverse_all()
285 * - ::lyd_diff_merge_all()
286 * - ::lyd_diff_merge_module()
287 * - ::lyd_diff_merge_tree()
288 *
289 * - ::lyd_merge_tree()
290 * - ::lyd_merge_siblings()
291 *
292 * - ::lyd_unlink_tree()
293 *
294 * - ::lyd_free_all()
295 * - ::lyd_free_siblings()
296 * - ::lyd_free_tree()
297 * - ::lyd_free_meta_single()
298 * - ::lyd_free_meta_siblings()
299 * - ::lyd_free_attr_single()
300 * - ::lyd_free_attr_siblings()
301 *
Michal Vaskoa820c312021-02-05 16:33:00 +0100302 * - ::lyd_any_value_str()
Radek Krejci8678fa42020-08-18 16:07:28 +0200303 * - ::lyd_any_copy_value()
304 */
305
306/**
307 * @page howtoDataWD Default Values
308 *
309 * libyang provides support for work with default values as defined in [RFC 6243](https://tools.ietf.org/html/rfc6243).
310 * However, libyang context do not contains the *ietf-netconf-with-defaults* module on its own and caller is supposed to
311 * add this YANG module to enable full support of the *with-defaults* features described below. Without presence of the
312 * mentioned module in the context, the default nodes are still present and handled in the data trees, but the metadata
313 * providing the information about the default values cannot be used. It means that when parsing data, the default nodes
314 * marked with the metadata as implicit default nodes are handled as explicit data and when printing data tree, the expected
315 * nodes are printed without the ietf-netconf-with-defaults metadata.
316 *
317 * The RFC document defines 4 modes for handling default nodes in a data tree, libyang adds the fifth mode and use them
318 * via @ref dataprinterflags when printing data trees.
319 * - \b explicit - Only the explicitly set configuration data. But in the case of status data, missing default
320 * data are added into the tree. In libyang, this mode is represented by ::LYD_PRINT_WD_EXPLICIT option.
321 * This is the default with-defaults mode of the printer. The data nodes do not contain any additional
322 * metadata information.
323 * - \b trim - Data nodes containing the default value are removed. This mode is applied with ::LYD_PRINT_WD_TRIM option.
324 * - \b report-all - This mode provides all the default data nodes despite they were explicitly present in source data or
325 * they were added by libyang's [validation process](@ref howtoDataValidation). This mode is activated by
326 * ::LYD_PRINT_WD_ALL option.
327 * - \b report-all-tagged - In this case, all the data nodes (implicit as well the explicit) containing the default value
328 * are printed and tagged (see the note below). Printers accept ::LYD_PRINT_WD_ALL_TAG option for this mode.
329 * - \b report-implicit-tagged - The last mode is similar to the previous one, except only the implicitly added nodes
330 * are tagged. This is the libyang's extension and it is activated by ::LYD_PRINT_WD_IMPL_TAG option.
331 *
332 * Internally, libyang adds the default nodes into the data tree as part of the [validation process](@ref howtoDataValidation).
333 * When [parsing data](@ref howtoDataParsers) from an input source, adding default nodes can be avoided only by avoiding
334 * the whole [validation process](@ref howtoDataValidation). In case the ietf-netconf-with-defaults module is present in the
335 * context, the [parser process](@ref howtoDataParsers) also supports to recognize the implicit default nodes marked with the
336 * appropriate metadata.
337 *
338 * Note, that in a modified data tree (via e.g. \b lyd_insert_*() or \b lyd_free_*() functions), some of the default nodes
339 * can be missing or they can be present by mistake. Such a data tree is again corrected during the next run of the
340 * [validation process](@ref howtoDataValidation) or manualy using \b lyd_new_implicit_*() functions.
341 *
342 * The implicit (default) nodes, created by libyang, are marked with the ::LYD_DEFAULT flag in ::lyd_node.flags member
343 * Note, that besides leafs and leaf-lists, the flag can appear also in containers, where it means that the container
344 * holds only a default node(s) or it is implicitly added empty container (according to YANG 1.1 spec, all such containers are part of
345 * the accessible data tree). When printing data trees, the presence of empty containers (despite they were added
346 * explicitly or implicitly as part of accessible data tree) depends on ::LYD_PRINT_KEEPEMPTYCONT option.
347 *
348 * To get know if the particular leaf or leaf-list node contains default value (despite implicit or explicit), you can
349 * use ::lyd_is_default() function.
350 *
351 * Functions List
352 * --------------
353 * - ::lyd_is_default()
354 * - ::lyd_new_implicit_all()
355 * - ::lyd_new_implicit_module()
356 * - ::lyd_new_implicit_tree()
357 */
358
359/**
Radek Krejci2ff0d572020-05-21 15:27:28 +0200360 * @ingroup trees
Radek Krejci8678fa42020-08-18 16:07:28 +0200361 * @defgroup datatree Data Tree
Radek Krejcie7b95092019-05-15 11:03:07 +0200362 * @{
363 *
364 * Data structures and functions to manipulate and access instance data tree.
365 */
366
Michal Vasko64246d82020-08-19 12:35:00 +0200367/* *INDENT-OFF* */
368
Michal Vaskoa276cd92020-08-10 15:10:08 +0200369/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200370 * @brief Macro to iterate via all elements in a data tree. This is the opening part
371 * to the #LYD_TREE_DFS_END - they always have to be used together.
372 *
373 * The function follows deep-first search algorithm:
374 * <pre>
375 * 1
376 * / \
Michal Vaskoc193ce92020-03-06 11:04:48 +0100377 * 2 4
Radek Krejcie7b95092019-05-15 11:03:07 +0200378 * / / \
Michal Vaskoc193ce92020-03-06 11:04:48 +0100379 * 3 5 6
Radek Krejcie7b95092019-05-15 11:03:07 +0200380 * </pre>
381 *
Radek Krejci0935f412019-08-20 16:15:18 +0200382 * Use the same parameters for #LYD_TREE_DFS_BEGIN and #LYD_TREE_DFS_END. While
Michal Vasko56daf732020-08-10 10:57:18 +0200383 * START can be any of the lyd_node* types, ELEM variable must be a pointer to
384 * the generic struct lyd_node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200385 *
Michal Vasko56daf732020-08-10 10:57:18 +0200386 * To skip a particular subtree, instead of the continue statement, set LYD_TREE_DFS_continue
387 * variable to non-zero value.
Radek Krejcie7b95092019-05-15 11:03:07 +0200388 *
389 * Use with opening curly bracket '{' after the macro.
390 *
391 * @param START Pointer to the starting element processed first.
Radek Krejcie7b95092019-05-15 11:03:07 +0200392 * @param ELEM Iterator intended for use in the block.
393 */
Michal Vasko56daf732020-08-10 10:57:18 +0200394#define LYD_TREE_DFS_BEGIN(START, ELEM) \
Radek Krejci857189e2020-09-01 13:26:36 +0200395 { ly_bool LYD_TREE_DFS_continue = 0; struct lyd_node *LYD_TREE_DFS_next; \
Michal Vasko56daf732020-08-10 10:57:18 +0200396 for ((ELEM) = (LYD_TREE_DFS_next) = (struct lyd_node *)(START); \
Radek Krejcie7b95092019-05-15 11:03:07 +0200397 (ELEM); \
Michal Vasko56daf732020-08-10 10:57:18 +0200398 (ELEM) = (LYD_TREE_DFS_next), LYD_TREE_DFS_continue = 0)
Radek Krejcie7b95092019-05-15 11:03:07 +0200399
400/**
401 * @brief Macro to iterate via all elements in a tree. This is the closing part
402 * to the #LYD_TREE_DFS_BEGIN - they always have to be used together.
403 *
404 * Use the same parameters for #LYD_TREE_DFS_BEGIN and #LYD_TREE_DFS_END. While
Michal Vasko56daf732020-08-10 10:57:18 +0200405 * START can be any of the lyd_node* types, ELEM variable must be a pointer
406 * to the generic struct lyd_node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200407 *
408 * Use with closing curly bracket '}' after the macro.
409 *
410 * @param START Pointer to the starting element processed first.
Radek Krejcie7b95092019-05-15 11:03:07 +0200411 * @param ELEM Iterator intended for use in the block.
412 */
413
Michal Vasko56daf732020-08-10 10:57:18 +0200414#define LYD_TREE_DFS_END(START, ELEM) \
Radek Krejcie7b95092019-05-15 11:03:07 +0200415 /* select element for the next run - children first */ \
Michal Vasko56daf732020-08-10 10:57:18 +0200416 if (LYD_TREE_DFS_continue) { \
417 (LYD_TREE_DFS_next) = NULL; \
418 } else { \
Radek Krejcia1c1e542020-09-29 16:06:52 +0200419 (LYD_TREE_DFS_next) = lyd_child(ELEM); \
Michal Vasko56daf732020-08-10 10:57:18 +0200420 }\
421 if (!(LYD_TREE_DFS_next)) { \
Radek Krejcie7b95092019-05-15 11:03:07 +0200422 /* no children */ \
Michal Vasko9e685082021-01-29 14:49:09 +0100423 if ((ELEM) == (struct lyd_node *)(START)) { \
Radek Krejcie7b95092019-05-15 11:03:07 +0200424 /* we are done, (START) has no children */ \
425 break; \
426 } \
427 /* try siblings */ \
Michal Vasko56daf732020-08-10 10:57:18 +0200428 (LYD_TREE_DFS_next) = (ELEM)->next; \
Radek Krejcie7b95092019-05-15 11:03:07 +0200429 } \
Michal Vasko56daf732020-08-10 10:57:18 +0200430 while (!(LYD_TREE_DFS_next)) { \
Radek Krejcie7b95092019-05-15 11:03:07 +0200431 /* parent is already processed, go to its sibling */ \
Michal Vasko9e685082021-01-29 14:49:09 +0100432 (ELEM) = (struct lyd_node *)(ELEM)->parent; \
Radek Krejcie7b95092019-05-15 11:03:07 +0200433 /* no siblings, go back through parents */ \
434 if ((ELEM)->parent == (START)->parent) { \
435 /* we are done, no next element to process */ \
436 break; \
437 } \
Michal Vasko56daf732020-08-10 10:57:18 +0200438 (LYD_TREE_DFS_next) = (ELEM)->next; \
Christian Hopps59618972021-02-01 05:01:35 -0500439 } }
440
441/**
442 * @brief Macro to iterate via all schema node data instances in data siblings.
443 *
444 * @param START Pointer to the starting sibling. Even if it is not first, all the siblings are searched.
445 * @param SCHEMA Schema node of the searched instances.
446 * @param ELEM Iterator.
447 */
448#define LYD_LIST_FOR_INST(START, SCHEMA, ELEM) \
449 for (lyd_find_sibling_val(START, SCHEMA, NULL, 0, &(ELEM)); \
450 (ELEM) && ((ELEM)->schema == (SCHEMA)); \
451 (ELEM) = (ELEM)->next)
452
453/**
454 * @brief Macro to iterate via all schema node data instances in data siblings allowing to modify the list itself.
455 *
456 * @param START Pointer to the starting sibling. Even if it is not first, all the siblings are searched.
457 * @param SCHEMA Schema node of the searched instances.
458 * @param NEXT Temporary storage to allow removing of the current iterator content.
459 * @param ELEM Iterator.
460 */
461#define LYD_LIST_FOR_INST_SAFE(START, SCHEMA, NEXT, ELEM) \
462 for (lyd_find_sibling_val(START, SCHEMA, NULL, 0, &(ELEM)); \
463 (ELEM) && ((ELEM)->schema == (SCHEMA)) ? ((NEXT) = (ELEM)->next, 1) : 0; \
464 (ELEM) = (NEXT))
Radek Krejcie7b95092019-05-15 11:03:07 +0200465
Michal Vasko64246d82020-08-19 12:35:00 +0200466/* *INDENT-ON* */
467
Radek Krejcie7b95092019-05-15 11:03:07 +0200468/**
Michal Vasko03ff5a72019-09-11 13:49:33 +0200469 * @brief Macro to get context from a data tree node.
470 */
Michal Vaskob7be7a82020-08-20 09:09:04 +0200471#define LYD_CTX(node) ((node)->schema ? (node)->schema->module->ctx : ((struct lyd_node_opaq *)(node))->ctx)
Michal Vasko03ff5a72019-09-11 13:49:33 +0200472
473/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200474 * @brief Data input/output formats supported by libyang [parser](@ref howtoDataParsers) and
475 * [printer](@ref howtoDataPrinters) functions.
Radek Krejcie7b95092019-05-15 11:03:07 +0200476 */
477typedef enum {
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200478 LYD_UNKNOWN = 0, /**< unknown data format, invalid value */
479 LYD_XML, /**< XML instance data format */
480 LYD_JSON, /**< JSON instance data format */
Michal Vasko69730152020-10-09 16:30:07 +0200481 LYD_LYB /**< LYB instance data format */
Radek Krejcie7b95092019-05-15 11:03:07 +0200482} LYD_FORMAT;
483
484/**
Radek Krejci59583bb2019-09-11 12:57:55 +0200485 * @brief List of possible value types stored in ::lyd_node_any.
Radek Krejcie7b95092019-05-15 11:03:07 +0200486 */
487typedef enum {
Radek Krejci8678fa42020-08-18 16:07:28 +0200488 LYD_ANYDATA_DATATREE, /**< Value is a pointer to ::lyd_node structure (first sibling). When provided as input parameter, the pointer
Radek Krejciee4cab22019-07-17 17:07:47 +0200489 is directly connected into the anydata node without duplication, caller is supposed to not manipulate
Radek Krejci8678fa42020-08-18 16:07:28 +0200490 with the data after a successful call (including calling ::lyd_free_all() on the provided data) */
Radek Krejci22ebdba2019-07-25 13:59:43 +0200491 LYD_ANYDATA_STRING, /**< Value is a generic string without any knowledge about its format (e.g. anyxml value in JSON encoded
Radek Krejciee4cab22019-07-17 17:07:47 +0200492 as string). XML sensitive characters (such as & or \>) are automatically escaped when the anydata
493 is printed in XML format. */
Radek Krejci22ebdba2019-07-25 13:59:43 +0200494 LYD_ANYDATA_XML, /**< Value is a string containing the serialized XML data. */
495 LYD_ANYDATA_JSON, /**< Value is a string containing the data modeled by YANG and encoded as I-JSON. */
Michal Vasko69730152020-10-09 16:30:07 +0200496 LYD_ANYDATA_LYB /**< Value is a memory chunk with the serialized data tree in LYB format. */
Radek Krejcie7b95092019-05-15 11:03:07 +0200497} LYD_ANYDATA_VALUETYPE;
498
499/** @} */
500
501/**
502 * @brief YANG data representation
503 */
504struct lyd_value {
Radek Krejci995784f2021-04-26 08:02:13 +0200505 const char *_canonical; /**< Should never be accessed directly, instead ::lyd_get_value() and ::lyd_get_meta_value()
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200506 should be used. Serves as a cache for the canonical value or the JSON
507 representation if no canonical value is defined. */
Radek Krejci8678fa42020-08-18 16:07:28 +0200508
Radek Krejcie7b95092019-05-15 11:03:07 +0200509 union {
Radek Krejcie7b95092019-05-15 11:03:07 +0200510 int8_t boolean; /**< 0 as false, 1 as true */
511 int64_t dec64; /**< decimal64: value = dec64 / 10^fraction-digits */
Radek Krejci8dc4f2d2019-07-16 12:24:00 +0200512 int8_t int8; /**< 8-bit signed integer */
513 int16_t int16; /**< 16-bit signed integer */
514 int32_t int32; /**< 32-bit signed integer */
515 int64_t int64; /**< 64-bit signed integer */
516 uint8_t uint8; /**< 8-bit unsigned integer */
Michal Vasko7c8439f2020-08-05 13:25:19 +0200517 uint16_t uint16; /**< 16-bit unsigned integer */
518 uint32_t uint32; /**< 32-bit unsigned integer */
519 uint64_t uint64; /**< 64-bit unsigned integer */
Radek Krejcie7b95092019-05-15 11:03:07 +0200520 struct lysc_type_bitenum_item *enum_item; /**< pointer to the definition of the enumeration value */
Radek Krejci849a62a2019-05-22 15:29:05 +0200521 struct lysc_type_bitenum_item **bits_items; /**< list of set pointers to the specification of the set bits ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +0200522 struct lysc_ident *ident; /**< pointer to the schema definition of the identityref value */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200523 struct ly_path *target; /**< Instance-identifier target path. */
524 struct lyd_value_subvalue *subvalue; /** Union value with some metadata. */
Radek Krejcie7b95092019-05-15 11:03:07 +0200525 void *ptr; /**< generic data type structure used to store the data */
Radek Krejci8678fa42020-08-18 16:07:28 +0200526 }; /**< The union is just a list of shorthands to possible values stored by a type's plugin. libyang itself uses the ::lyd_value.realtype
527 plugin's callbacks to work with the data.*/
Radek Krejci084289f2019-07-09 17:35:30 +0200528
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200529 const struct lysc_type *realtype; /**< pointer to the real type of the data stored in the value structure. This type can differ from the type
Radek Krejci8678fa42020-08-18 16:07:28 +0200530 in the schema node of the data node since the type's store plugin can use other types/plugins for
531 storing data. Speaking about built-in types, this is the case of leafref which stores data as its
532 target type. In contrast, union type also uses its subtype's callbacks, but inside an internal data
533 stored in subvalue member of ::lyd_value structure, so here is the pointer to the union type.
534 In general, this type is used to get free callback for this lyd_value structure, so it must reflect
535 the type used to store data directly in the same lyd_value instance. */
Radek Krejcie7b95092019-05-15 11:03:07 +0200536};
537
538/**
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200539 * @brief Special lyd_value structure for union.
540 *
541 * Represents data with multiple types (union). Original value is stored in the main lyd_value:canonical_cache while
Radek Krejci8678fa42020-08-18 16:07:28 +0200542 * the ::lyd_value_subvalue.value contains representation according to one of the union's types.
543 * The ::lyd_value_subvalue.prefix_data provides (possible) mappings from prefixes in the original value to YANG modules.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200544 * These prefixes are necessary to parse original value to the union's subtypes.
545 */
546struct lyd_value_subvalue {
547 struct lyd_value value; /**< representation of the value according to the selected union's subtype
Radek Krejci8678fa42020-08-18 16:07:28 +0200548 (stored as ::lyd_value.realtype here, in subvalue structure */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200549 const char *original; /**< Original value in the dictionary. */
Radek Krejci8df109d2021-04-23 12:19:08 +0200550 LY_VALUE_FORMAT format; /**< Prefix format of the value. However, this information is also used to decide
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200551 whether a value is valid for the specific format or not on later validations
552 (instance-identifier in XML looks different than in JSON). */
Radek Krejci0b013302021-03-29 15:22:32 +0200553 void *prefix_data; /**< Format-specific data for prefix resolution (see ly_resolve_prefix()) */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200554 uint32_t hints; /**< [Value hints](@ref lydvalhints) from the parser */
555 const struct lysc_node *ctx_node; /**< Context schema node. */
556};
557
558/**
Michal Vasko9f96a052020-03-10 09:41:45 +0100559 * @brief Metadata structure.
Radek Krejcie7b95092019-05-15 11:03:07 +0200560 *
Michal Vasko9f96a052020-03-10 09:41:45 +0100561 * The structure provides information about metadata of a data element. Such attributes must map to
Radek Krejcie7b95092019-05-15 11:03:07 +0200562 * annotations as specified in RFC 7952. The only exception is the filter type (in NETCONF get operations)
563 * and edit-config's operation attributes. In XML, they are represented as standard XML attributes. In JSON,
564 * they are represented as JSON elements starting with the '@' character (for more information, see the
565 * YANG metadata RFC.
566 *
567 */
Michal Vasko9f96a052020-03-10 09:41:45 +0100568struct lyd_meta {
569 struct lyd_node *parent; /**< data node where the metadata is placed */
570 struct lyd_meta *next; /**< pointer to the next metadata of the same element */
571 struct lysc_ext_instance *annotation; /**< pointer to the annotation's definition */
572 const char *name; /**< metadata name */
573 struct lyd_value value; /**< metadata value representation */
Radek Krejcie7b95092019-05-15 11:03:07 +0200574};
575
Michal Vasko52927e22020-03-16 17:26:14 +0100576/**
577 * @brief Generic prefix and namespace mapping, meaning depends on the format.
Radek Krejci1798aae2020-07-14 13:26:06 +0200578 *
579 * The union is used as a reference to the data's module and according to the format, it can be used as a key for
Radek Krejci8678fa42020-08-18 16:07:28 +0200580 * ::ly_ctx_get_module_implemented_ns() or ::ly_ctx_get_module_implemented(). While the module reference is always present,
Michal Vaskoad92b672020-11-12 13:11:31 +0100581 * the prefix member can be omitted in case it is not present in the source data as a reference to the default module/namespace.
Michal Vasko52927e22020-03-16 17:26:14 +0100582 */
Michal Vaskoad92b672020-11-12 13:11:31 +0100583struct ly_opaq_name {
584 const char *name; /**< node name, without prefix if any was defined */
585 const char *prefix; /**< identifier used in the qualified name as the prefix, can be NULL */
Radek Krejci1798aae2020-07-14 13:26:06 +0200586 union {
Radek Krejci8df109d2021-04-23 12:19:08 +0200587 const char *module_ns; /**< format ::LY_VALUE_XML - XML namespace of the node element */
588 const char *module_name; /**< format ::LY_VALUE_JSON - (inherited) name of the module of the element */
Radek Krejci1798aae2020-07-14 13:26:06 +0200589 };
Michal Vasko52927e22020-03-16 17:26:14 +0100590};
591
592/**
593 * @brief Generic attribute structure.
594 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200595struct lyd_attr {
Michal Vasko52927e22020-03-16 17:26:14 +0100596 struct lyd_node_opaq *parent; /**< data node where the attribute is placed */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100597 struct lyd_attr *next; /**< pointer to the next attribute */
Michal Vaskoad92b672020-11-12 13:11:31 +0100598 struct ly_opaq_name name; /**< attribute name with module information */
Michal Vasko501af032020-11-11 20:27:44 +0100599 const char *value; /**< attribute value */
Radek Krejci8df109d2021-04-23 12:19:08 +0200600 LY_VALUE_FORMAT format; /**< format of the attribute and any prefixes, ::LY_VALUE_XML or ::LY_VALUE_JSON */
Radek Krejciec9ad602021-01-04 10:46:30 +0100601 void *val_prefix_data; /**< format-specific prefix data */
Michal Vasko501af032020-11-11 20:27:44 +0100602 uint32_t hints; /**< additional information about from the data source, see the [hints list](@ref lydhints) */
Michal Vasko52927e22020-03-16 17:26:14 +0100603};
Radek Krejcie7b95092019-05-15 11:03:07 +0200604
Michal Vasko1bf09392020-03-27 12:38:10 +0100605#define LYD_NODE_INNER (LYS_CONTAINER|LYS_LIST|LYS_RPC|LYS_ACTION|LYS_NOTIF) /**< Schema nodetype mask for lyd_node_inner */
Radek Krejcie7b95092019-05-15 11:03:07 +0200606#define LYD_NODE_TERM (LYS_LEAF|LYS_LEAFLIST) /**< Schema nodetype mask for lyd_node_term */
607#define LYD_NODE_ANY (LYS_ANYDATA) /**< Schema nodetype mask for lyd_node_any */
608
609/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200610 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +0200611 * @defgroup dnodeflags Data node flags
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200612 * @{
613 *
614 * Various flags of data nodes.
615 *
616 * 1 - container 5 - anydata/anyxml
617 * 2 - list 6 - rpc/action
618 * 3 - leaf 7 - notification
619 * 4 - leaflist
620 *
621 * bit name 1 2 3 4 5 6 7
622 * ---------------------+-+-+-+-+-+-+-+
623 * 1 LYD_DEFAULT |x| |x|x| | | |
624 * +-+-+-+-+-+-+-+
Michal Vasko5c4e5892019-11-14 12:31:38 +0100625 * 2 LYD_WHEN_TRUE |x|x|x|x|x| | |
Michal Vasko9b368d32020-02-14 13:53:31 +0100626 * +-+-+-+-+-+-+-+
627 * 3 LYD_NEW |x|x|x|x|x|x|x|
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200628 * ---------------------+-+-+-+-+-+-+-+
629 *
630 */
631
Michal Vasko5c4e5892019-11-14 12:31:38 +0100632#define LYD_DEFAULT 0x01 /**< default (implicit) node */
633#define LYD_WHEN_TRUE 0x02 /**< all when conditions of this node were evaluated to true */
Michal Vasko9b368d32020-02-14 13:53:31 +0100634#define LYD_NEW 0x04 /**< node was created after the last validation, is needed for the next validation */
Michal Vasko52927e22020-03-16 17:26:14 +0100635
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200636/** @} */
637
638/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200639 * @brief Generic structure for a data node.
640 */
641struct lyd_node {
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200642 uint32_t hash; /**< hash of this particular node (module name + schema name + key string values if list or
643 hashes of all nodes of subtree in case of keyless list). Note that while hash can be
644 used to get know that nodes are not equal, it cannot be used to decide that the
645 nodes are equal due to possible collisions. */
646 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100647 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200648 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
649 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
650 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
651 never NULL. If there is no sibling node, pointer points to the node
652 itself. In case of the first node, this pointer points to the last
653 node in the list. */
Michal Vasko9f96a052020-03-10 09:41:45 +0100654 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200655 void *priv; /**< private user data, not used by libyang */
Radek Krejcie7b95092019-05-15 11:03:07 +0200656};
657
658/**
Radek Krejcif3b6fec2019-07-24 15:53:11 +0200659 * @brief Data node structure for the inner data tree nodes - containers, lists, RPCs, actions and Notifications.
Radek Krejcie7b95092019-05-15 11:03:07 +0200660 */
661struct lyd_node_inner {
Michal Vasko9e685082021-01-29 14:49:09 +0100662 union {
663 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
664 struct {
665 uint32_t hash; /**< hash of this particular node (module name + schema name + key string
666 values if list or hashes of all nodes of subtree in case of keyless
667 list). Note that while hash can be used to get know that nodes are
668 not equal, it cannot be used to decide that the nodes are equal due
669 to possible collisions. */
670 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
671 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
672 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
673 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
674 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
675 never NULL. If there is no sibling node, pointer points to the node
676 itself. In case of the first node, this pointer points to the last
677 node in the list. */
678 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
679 void *priv; /**< private user data, not used by libyang */
680 };
681 }; /**< common part corresponding to ::lyd_node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200682
683 struct lyd_node *child; /**< pointer to the first child node. */
684 struct hash_table *children_ht; /**< hash table with all the direct children (except keys for a list, lists without keys) */
Radek Krejci8678fa42020-08-18 16:07:28 +0200685#define LYD_HT_MIN_ITEMS 4 /**< minimal number of children to create ::lyd_node_inner.children_ht hash table. */
Radek Krejcie7b95092019-05-15 11:03:07 +0200686};
687
688/**
Michal Vaskof03ed032020-03-04 13:31:44 +0100689 * @brief Data node structure for the terminal data tree nodes - leaves and leaf-lists.
Radek Krejcie7b95092019-05-15 11:03:07 +0200690 */
691struct lyd_node_term {
Michal Vasko9e685082021-01-29 14:49:09 +0100692 union {
693 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
694 struct {
695 uint32_t hash; /**< hash of this particular node (module name + schema name + key string
696 values if list or hashes of all nodes of subtree in case of keyless
697 list). Note that while hash can be used to get know that nodes are
698 not equal, it cannot be used to decide that the nodes are equal due
699 to possible collisions. */
700 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
701 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
702 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
703 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
704 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
705 never NULL. If there is no sibling node, pointer points to the node
706 itself. In case of the first node, this pointer points to the last
707 node in the list. */
708 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
709 void *priv; /**< private user data, not used by libyang */
710 };
711 }; /**< common part corresponding to ::lyd_node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200712
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200713 struct lyd_value value; /**< node's value representation */
Radek Krejcie7b95092019-05-15 11:03:07 +0200714};
715
716/**
Christian Hopps61213e02021-04-12 20:41:32 -0400717 * @brief union for anydata/anyxml value representation.
718 */
719union lyd_any_value {
720 struct lyd_node *tree; /**< data tree */
721 const char *str; /**< Generic string data */
722 const char *xml; /**< Serialized XML data */
723 const char *json; /**< I-JSON encoded string */
724 char *mem; /**< LYD_ANYDATA_LYB memory chunk */
725};
726
727/**
728 * @brief Data node structure for the anydata data tree nodes - anydata or
729 * anyxml.
Radek Krejcie7b95092019-05-15 11:03:07 +0200730 */
731struct lyd_node_any {
Michal Vasko9e685082021-01-29 14:49:09 +0100732 union {
733 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
734 struct {
735 uint32_t hash; /**< hash of this particular node (module name + schema name + key string
736 values if list or hashes of all nodes of subtree in case of keyless
737 list). Note that while hash can be used to get know that nodes are
738 not equal, it cannot be used to decide that the nodes are equal due
739 to possible collisions. */
740 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
741 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
742 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
743 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
744 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
745 never NULL. If there is no sibling node, pointer points to the node
746 itself. In case of the first node, this pointer points to the last
747 node in the list. */
748 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
749 void *priv; /**< private user data, not used by libyang */
750 };
751 }; /**< common part corresponding to ::lyd_node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200752
Christian Hopps61213e02021-04-12 20:41:32 -0400753 union lyd_any_value value; /**< pointer to the stored value representation of the anydata/anyxml node */
Michal Vasko9e685082021-01-29 14:49:09 +0100754 LYD_ANYDATA_VALUETYPE value_type; /**< type of the data stored as ::lyd_node_any.value */
Radek Krejcie7b95092019-05-15 11:03:07 +0200755};
756
757/**
Michal Vasko1d4af6c2021-02-22 13:31:26 +0100758 * @brief Get the name (associated with) of a data node. Works for opaque nodes as well.
759 *
760 * @param[in] node Node to examine.
761 * @return Data node name.
762 */
763#define LYD_NAME(node) ((node)->schema ? (node)->schema->name : ((struct lyd_node_opaq *)node)->name.name)
764
765/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200766 * @ingroup datatree
767 * @defgroup lydvalhints Value format hints.
Radek Krejci1798aae2020-07-14 13:26:06 +0200768 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200769 *
770 * Hints for the type of the data value.
771 *
772 * Any information about value types encoded in the format is hinted by these values.
Radek Krejci1798aae2020-07-14 13:26:06 +0200773 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200774#define LYD_VALHINT_STRING 0x0001 /**< value is allowed to be a string */
775#define LYD_VALHINT_DECNUM 0x0002 /**< value is allowed to be a decimal number */
776#define LYD_VALHINT_OCTNUM 0x0004 /**< value is allowed to be an octal number */
777#define LYD_VALHINT_HEXNUM 0x0008 /**< value is allowed to be a hexadecimal number */
778#define LYD_VALHINT_NUM64 0x0010 /**< value is allowed to be an int64 or uint64 */
779#define LYD_VALHINT_BOOLEAN 0x0020 /**< value is allowed to be a boolean */
780#define LYD_VALHINT_EMPTY 0x0040 /**< value is allowed to be empty */
781/**
782 * @} lydvalhints
783 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200784
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200785/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200786 * @ingroup datatree
787 * @defgroup lydnodehints Node type format hints
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200788 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200789 *
790 * Hints for the type of the data node.
791 *
792 * Any information about node types encoded in the format is hinted by these values.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200793 */
794#define LYD_NODEHINT_LIST 0x0080 /**< node is allowed to be a list instance */
795#define LYD_NODEHINT_LEAFLIST 0x0100 /**< node is allowed to be a leaf-list instance */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200796/**
797 * @} lydnodehints
798 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200799
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200800/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200801 * @ingroup datatree
802 * @defgroup lydhints Value and node type format hints
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200803 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200804 *
805 * Hints for the types of data node and its value.
806 *
807 * Any information about value and node types encoded in the format is hinted by these values.
808 * It combines [value hints](@ref lydvalhints) and [node hints](@ref lydnodehints).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200809 */
810#define LYD_HINT_DATA 0x01F3 /**< special node/value hint to be used for generic data node/value (for cases when
811 there is no encoding or it does not provide any additional information about
812 a node/value type); do not combine with specific [value hints](@ref lydvalhints)
813 or [node hints](@ref lydnodehints). */
814#define LYD_HINT_SCHEMA 0x01FF /**< special node/value hint to be used for generic schema node/value(for cases when
815 there is no encoding or it does not provide any additional information about
816 a node/value type); do not combine with specific [value hints](@ref lydvalhints)
817 or [node hints](@ref lydnodehints). */
818/**
819 * @} lydhints
820 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200821
822/**
Michal Vasko52927e22020-03-16 17:26:14 +0100823 * @brief Data node structure for unparsed (opaque) nodes.
824 */
825struct lyd_node_opaq {
Michal Vasko9e685082021-01-29 14:49:09 +0100826 union {
827 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
828 struct {
829 uint32_t hash; /**< always 0 */
830 uint32_t flags; /**< always 0 */
831 const struct lysc_node *schema; /**< always NULL */
832 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
833 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
834 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
835 never NULL. If there is no sibling node, pointer points to the node
836 itself. In case of the first node, this pointer points to the last
837 node in the list. */
838 struct lyd_meta *meta; /**< always NULL */
839 void *priv; /**< private user data, not used by libyang */
840 };
841 }; /**< common part corresponding to ::lyd_node */
Michal Vasko52927e22020-03-16 17:26:14 +0100842
Michal Vasko501af032020-11-11 20:27:44 +0100843 struct lyd_node *child; /**< pointer to the child node (compatible with ::lyd_node_inner) */
844
Michal Vaskoad92b672020-11-12 13:11:31 +0100845 struct ly_opaq_name name; /**< node name with module information */
Michal Vasko52927e22020-03-16 17:26:14 +0100846 const char *value; /**< original value */
Radek Krejci8df109d2021-04-23 12:19:08 +0200847 LY_VALUE_FORMAT format; /**< format of the node and any prefixes, ::LY_VALUE_XML or ::LY_VALUE_JSON */
Radek Krejciec9ad602021-01-04 10:46:30 +0100848 void *val_prefix_data; /**< format-specific prefix data */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200849 uint32_t hints; /**< additional information about from the data source, see the [hints list](@ref lydhints) */
Michal Vasko501af032020-11-11 20:27:44 +0100850
Michal Vasko9e685082021-01-29 14:49:09 +0100851 struct lyd_attr *attr; /**< pointer to the list of generic attributes of this node */
Michal Vasko52927e22020-03-16 17:26:14 +0100852 const struct ly_ctx *ctx; /**< libyang context */
853};
854
855/**
Radek Krejcia1c1e542020-09-29 16:06:52 +0200856 * @brief Get the generic parent pointer of a data node.
857 *
858 * @param[in] node Node whose parent pointer to get.
859 * @return Pointer to the parent node of the @p node.
860 * @return NULL in case of the top-level node or if the @p node is NULL itself.
Michal Vasko5bfd4be2020-06-23 13:26:19 +0200861 */
Christian Hopps59618972021-02-01 05:01:35 -0500862static inline struct lyd_node *
863lyd_parent(const struct lyd_node *node)
864{
865 if (!node) {
866 return NULL;
867 }
868
869 return &node->parent->node;
870}
Michal Vasko5bfd4be2020-06-23 13:26:19 +0200871
872/**
Radek Krejcia1c1e542020-09-29 16:06:52 +0200873 * @brief Get the child pointer of a generic data node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200874 *
Radek Krejcia1c1e542020-09-29 16:06:52 +0200875 * Decides the node's type and in case it has a children list, returns it. Supports even the opaq nodes (::lyd_node_opaq).
876 *
877 * If you need to skip key children, use ::lyd_child_no_keys().
878 *
879 * @param[in] node Node to use.
880 * @return Pointer to the first child node (if any) of the @p node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200881 */
Christian Hopps59618972021-02-01 05:01:35 -0500882static inline struct lyd_node *
883lyd_child(const struct lyd_node *node)
884{
885 if (!node) {
886 return NULL;
887 }
888
889 if (!node->schema) {
890 /* opaq node */
891 return ((struct lyd_node_opaq *)node)->child;
892 }
893
894 switch (node->schema->nodetype) {
895 case LYS_CONTAINER:
896 case LYS_LIST:
897 case LYS_RPC:
898 case LYS_ACTION:
899 case LYS_NOTIF:
900 return ((struct lyd_node_inner *)node)->child;
901 default:
902 return NULL;
903 }
904}
Radek Krejcia1c1e542020-09-29 16:06:52 +0200905
906/**
907 * @brief Get the child pointer of a generic data node but skip its keys in case it is ::LYS_LIST.
908 *
909 * Decides the node's type and in case it has a children list, returns it. Supports even the opaq nodes (::lyd_node_opaq).
910 *
911 * If you need to take key children into account, use ::lyd_child().
912 *
913 * @param[in] node Node to use.
914 * @return Pointer to the first child node (if any) of the @p node.
915 */
916struct lyd_node *lyd_child_no_keys(const struct lyd_node *node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200917
918/**
Michal Vaskoc193ce92020-03-06 11:04:48 +0100919 * @brief Get the owner module of the data node. It is the module of the top-level schema node. Generally,
920 * in case of augments it is the target module, recursively, otherwise it is the module where the data node is defined.
921 *
Michal Vaskofcdf3012020-11-23 16:57:03 +0100922 * Also works for opaque nodes, if it is possible to resolve the module.
923 *
Michal Vaskoc193ce92020-03-06 11:04:48 +0100924 * @param[in] node Data node to examine.
925 * @return Module owner of the node.
926 */
927const struct lys_module *lyd_owner_module(const struct lyd_node *node);
928
929/**
Radek Krejci19611252020-10-04 13:54:53 +0200930 * @brief Check whether a node value equals to its default one.
931 *
932 * @param[in] node Term node to test.
933 * @return false (no, it is not a default node) or true (yes, it is default)
934 */
935ly_bool lyd_is_default(const struct lyd_node *node);
936
937/**
Radek Krejcica989142020-11-05 11:32:22 +0100938 * @brief Learn the relative position of a list or leaf-list instance within other instances of the same schema node.
939 *
940 * @param[in] instance List or leaf-list instance to get the position of.
Michal Vaskoe78faec2021-04-08 17:24:43 +0200941 * @return 0 on error.
942 * @return Positive integer of the @p instance position.
Radek Krejcica989142020-11-05 11:32:22 +0100943 */
944uint32_t lyd_list_pos(const struct lyd_node *instance);
945
946/**
Radek Krejci4233f9b2020-11-05 12:38:35 +0100947 * @brief Get the first sibling of the given node.
948 *
949 * @param[in] node Node which first sibling is going to be the result.
950 * @return The first sibling of the given node or the node itself if it is the first child of the parent.
951 */
Michal Vasko6ae16d62020-11-06 17:23:23 +0100952struct lyd_node *lyd_first_sibling(const struct lyd_node *node);
Radek Krejci4233f9b2020-11-05 12:38:35 +0100953
954/**
Michal Vasko60ea6352020-06-29 13:39:39 +0200955 * @brief Learn the length of LYB data.
956 *
957 * @param[in] data LYB data to examine.
958 * @return Length of the LYB data chunk,
959 * @return -1 on error.
960 */
961int lyd_lyb_data_length(const char *data);
962
963/**
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200964 * @brief Get the (canonical) value of a data node.
965 *
966 * @param[in] node Data node to use.
967 * @return Canonical value.
968 */
969const char *lyd_get_value(const struct lyd_node *node);
970
971/**
972 * @brief Get the (canonical) value of a metadata node.
973 *
974 * @param[in] meta Metadata node to use.
975 * @return Canonical value.
976 */
977const char *lyd_get_meta_value(const struct lyd_meta *meta);
978
979/**
Michal Vaskoa820c312021-02-05 16:33:00 +0100980 * @brief Get anydata string value.
981 *
982 * @param[in] any Anyxml/anydata node to read from.
983 * @param[out] value_str String representation of the value.
984 * @return LY_ERR value.
985 */
986LY_ERR lyd_any_value_str(const struct lyd_node *any, char **value_str);
987
988/**
Michal Vaskoc0004272020-08-06 08:32:34 +0200989 * @brief Copy anydata value from one node to another. Target value is freed first.
990 *
991 * @param[in,out] trg Target node.
992 * @param[in] value Source value, may be NULL when the target value is only freed.
993 * @param[in] value_type Source value type.
994 * @return LY_ERR value.
995 */
996LY_ERR lyd_any_copy_value(struct lyd_node *trg, const union lyd_any_value *value, LYD_ANYDATA_VALUETYPE value_type);
997
998/**
Michal Vasko00cbf532020-06-15 13:58:47 +0200999 * @brief Create a new inner node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001000 *
Radek Krejcidd2a7662021-03-12 11:26:34 +01001001 * To create list, use ::lyd_new_list() or ::lyd_new_list2().
1002 *
1003 * To create a top-level inner node defined in an extension instance, use ::lyd_new_ext_inner().
1004 *
Michal Vasko013a8182020-03-03 10:46:53 +01001005 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vaskof03ed032020-03-04 13:31:44 +01001006 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001007 * @param[in] name Schema node name of the new data node. The node can be #LYS_CONTAINER, #LYS_NOTIF, #LYS_RPC, or #LYS_ACTION.
Radek Krejci41ac9942020-11-02 14:47:56 +01001008 * @param[in] output Flag in case the @p parent is RPC/Action. If value is 0, the input's data nodes of the RPC/Action are
1009 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001010 * @param[out] node Optional created node.
1011 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001012 */
Michal Vasko53587422021-02-05 16:34:13 +01001013LY_ERR lyd_new_inner(struct lyd_node *parent, const struct lys_module *module, const char *name, ly_bool output,
1014 struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001015
1016/**
Radek Krejcidd2a7662021-03-12 11:26:34 +01001017 * @brief Create a new top-level inner node defined in the given extension instance.
1018 *
1019 * To create list, use ::lyd_new_list() or ::lyd_new_list2().
1020 *
1021 * To create an inner node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1022 * node of a standard module's tree, use ::lyd_new_inner().
1023 *
1024 * @param[in] ext Extension instance where the inner node being created is defined.
1025 * @param[in] name Schema node name of the new data node. The node can be #LYS_CONTAINER, #LYS_NOTIF, #LYS_RPC, or #LYS_ACTION.
1026 * @param[out] node The created node.
1027 * @return LY_ERR value.
1028 */
1029LY_ERR lyd_new_ext_inner(const struct lysc_ext_instance *ext, const char *name, struct lyd_node **node);
1030
1031/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001032 * @brief Create a new list node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001033 *
1034 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vaskof03ed032020-03-04 13:31:44 +01001035 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001036 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
Radek Krejci41ac9942020-11-02 14:47:56 +01001037 * @param[in] output Flag in case the @p parent is RPC/Action. If value is 0, the input's data nodes of the RPC/Action are
1038 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001039 * @param[out] node Optional created node.
Michal Vasko013a8182020-03-03 10:46:53 +01001040 * @param[in] ... Ordered key values of the new list instance, all must be set. In case of an instance-identifier
Michal Vasko004d3152020-06-11 19:59:22 +02001041 * or identityref value, the JSON format is expected (module names instead of prefixes). No keys are expected for
1042 * key-less lists.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001043 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001044 */
Radek Krejci41ac9942020-11-02 14:47:56 +01001045LY_ERR lyd_new_list(struct lyd_node *parent, const struct lys_module *module, const char *name, ly_bool output, struct lyd_node **node, ...);
Michal Vasko013a8182020-03-03 10:46:53 +01001046
1047/**
Radek Krejci8247bae2021-03-12 11:47:02 +01001048 * @brief Create a new top-level list node defined in the given extension instance.
1049 *
1050 * To create a list node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1051 * list node of a standard module's tree, use ::lyd_new_list() or ::lyd_new_list2().
1052 *
1053 * @param[in] ext Extension instance where the list node being created is defined.
1054 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
1055 * @param[out] node The created node.
1056 * @param[in] ... Ordered key values of the new list instance, all must be set. In case of an instance-identifier
1057 * or identityref value, the JSON format is expected (module names instead of prefixes). No keys are expected for
1058 * key-less lists.
1059 * @return LY_ERR value.
1060 */
1061LY_ERR lyd_new_ext_list(const struct lysc_ext_instance *ext, const char *name, struct lyd_node **node, ...);
1062
1063/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001064 * @brief Create a new list node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001065 *
1066 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vaskof03ed032020-03-04 13:31:44 +01001067 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001068 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
1069 * @param[in] keys All key values predicate in the form of "[key1='val1'][key2='val2']...", they do not have to be ordered.
1070 * In case of an instance-identifier or identityref value, the JSON format is expected (module names instead of prefixes).
Michal Vasko004d3152020-06-11 19:59:22 +02001071 * Use NULL or string of length 0 in case of key-less list.
Radek Krejci41ac9942020-11-02 14:47:56 +01001072 * @param[in] output Flag in case the @p parent is RPC/Action. If value is 0, the input's data nodes of the RPC/Action are
1073 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001074 * @param[out] node Optional created node.
1075 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001076 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001077LY_ERR lyd_new_list2(struct lyd_node *parent, const struct lys_module *module, const char *name, const char *keys,
Radek Krejci41ac9942020-11-02 14:47:56 +01001078 ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001079
1080/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001081 * @brief Create a new term node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001082 *
Radek Krejci8a5afc22021-03-12 11:10:47 +01001083 * To create a top-level term node defined in an extension instance, use ::lyd_new_ext_term().
1084 *
Michal Vasko013a8182020-03-03 10:46:53 +01001085 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vaskof03ed032020-03-04 13:31:44 +01001086 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001087 * @param[in] name Schema node name of the new data node. The node can be #LYS_LEAF or #LYS_LEAFLIST.
1088 * @param[in] val_str String form of the value of the node being created. In case of an instance-identifier or identityref
1089 * value, the JSON format is expected (module names instead of prefixes).
Radek Krejci41ac9942020-11-02 14:47:56 +01001090 * @param[in] output Flag in case the @p parent is RPC/Action. If value is 0, the input's data nodes of the RPC/Action are
1091 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001092 * @param[out] node Optional created node.
1093 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001094 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001095LY_ERR lyd_new_term(struct lyd_node *parent, const struct lys_module *module, const char *name, const char *val_str,
Radek Krejci41ac9942020-11-02 14:47:56 +01001096 ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001097
1098/**
Radek Krejci8a5afc22021-03-12 11:10:47 +01001099 * @brief Create a new top-level term node defined in the given extension instance.
1100 *
1101 * To create a term node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1102 * node of a standard module's tree, use ::lyd_new_term().
1103 *
1104 * @param[in] ext Extension instance where the term node being created is defined.
1105 * @param[in] name Schema node name of the new data node. The node can be #LYS_LEAF or #LYS_LEAFLIST.
1106 * @param[in] val_str String form of the value of the node being created. In case of an instance-identifier or identityref
1107 * value, the JSON format is expected (module names instead of prefixes).
1108 * @param[out] node The created node.
1109 * @return LY_ERR value.
1110 */
1111LY_ERR lyd_new_ext_term(const struct lysc_ext_instance *ext, const char *name, const char *val_str, struct lyd_node **node);
1112
1113/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001114 * @brief Create a new any node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001115 *
Radek Krejci0b963da2021-03-12 13:23:44 +01001116 * To create a top-level any node defined in an extension instance, use ::lyd_new_ext_any().
1117 *
Michal Vasko013a8182020-03-03 10:46:53 +01001118 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vaskof03ed032020-03-04 13:31:44 +01001119 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001120 * @param[in] name Schema node name of the new data node. The node can be #LYS_ANYDATA or #LYS_ANYXML.
Michal Vasko2a4ab2b2021-03-04 15:52:40 +01001121 * @param[in] value Value for the node. Expected type is determined by @p value_type.
1122 * @param[in] use_value Whether to directly take @p value and assign it to the node or make a copy.
Michal Vasko013a8182020-03-03 10:46:53 +01001123 * @param[in] value_type Type of the provided value in @p value.
Radek Krejci41ac9942020-11-02 14:47:56 +01001124 * @param[in] output Flag in case the @p parent is RPC/Action. If value is 0, the input's data nodes of the RPC/Action are
1125 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001126 * @param[out] node Optional created node.
1127 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001128 */
Michal Vasko2a4ab2b2021-03-04 15:52:40 +01001129LY_ERR lyd_new_any(struct lyd_node *parent, const struct lys_module *module, const char *name, const void *value,
1130 ly_bool use_value, LYD_ANYDATA_VALUETYPE value_type, ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001131
1132/**
Radek Krejci0b963da2021-03-12 13:23:44 +01001133 * @brief Create a new top-level any node defined in the given extension instance.
1134 *
1135 * To create an any node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1136 * any node of a standard module's tree, use ::lyd_new_any().
1137 *
1138 * @param[in] ext Extension instance where the any node being created is defined.
1139 * @param[in] name Schema node name of the new data node. The node can be #LYS_ANYDATA or #LYS_ANYXML.
1140 * @param[in] value Value for the node. Expected type is determined by @p value_type.
1141 * @param[in] use_value Whether to directly take @p value and assign it to the node or make a copy.
1142 * @param[in] value_type Type of the provided value in @p value.
1143 * @param[out] node The created node.
1144 * @return LY_ERR value.
1145 */
1146LY_ERR lyd_new_ext_any(const struct lysc_ext_instance *ext, const char *name, const void *value, ly_bool use_value,
1147 LYD_ANYDATA_VALUETYPE value_type, struct lyd_node **node);
1148
1149/**
Michal Vasko871a0252020-11-11 18:35:24 +01001150 * @brief Create new metadata.
Michal Vaskod86997b2020-05-26 15:19:54 +02001151 *
Michal Vasko871a0252020-11-11 18:35:24 +01001152 * @param[in] ctx libyang context,
1153 * @param[in] parent Optional parent node for the metadata being created. Must be set if @p meta is NULL.
Michal Vasko00cbf532020-06-15 13:58:47 +02001154 * @param[in] module Module of the metadata being created. If NULL, @p name must include module name as the prefix.
Michal Vaskod86997b2020-05-26 15:19:54 +02001155 * @param[in] name Annotation name of the new metadata. It can include the annotation module as the prefix.
1156 * If the prefix is specified it is always used but if not specified, @p module must be set.
Michal Vasko00cbf532020-06-15 13:58:47 +02001157 * @param[in] val_str String form of the value of the metadata. In case of an instance-identifier or identityref
Michal Vaskod86997b2020-05-26 15:19:54 +02001158 * value, the JSON format is expected (module names instead of prefixes).
Michal Vasko871a0252020-11-11 18:35:24 +01001159 * @param[in] clear_dflt Whether to clear the default flag starting from @p parent, recursively all NP containers.
1160 * @param[out] meta Optional created metadata. Must be set if @p parent is NULL.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001161 * @return LY_ERR value.
Michal Vaskod86997b2020-05-26 15:19:54 +02001162 */
Michal Vasko871a0252020-11-11 18:35:24 +01001163LY_ERR lyd_new_meta(const struct ly_ctx *ctx, struct lyd_node *parent, const struct lys_module *module, const char *name,
1164 const char *val_str, ly_bool clear_dflt, struct lyd_meta **meta);
Michal Vaskod86997b2020-05-26 15:19:54 +02001165
1166/**
Michal Vaskoba696702020-11-11 19:12:45 +01001167 * @brief Create new metadata from an opaque node attribute if possible.
1168 *
1169 * @param[in] ctx libyang context.
1170 * @param[in] parent Optional parent node for the metadata being created. Must be set if @p meta is NULL.
1171 * @param[in] clear_dflt Whether to clear the default flag starting from @p parent, recursively all NP containers.
1172 * @param[in] attr Opaque node attribute to parse into metadata.
1173 * @param[out] meta Optional created metadata. Must be set if @p parent is NULL.
1174 * @return LY_SUCCESS on success.
1175 * @return LY_ENOT if the attribute could not be parsed into any metadata.
1176 * @return LY_ERR on error.
1177 */
1178LY_ERR lyd_new_meta2(const struct ly_ctx *ctx, struct lyd_node *parent, ly_bool clear_dflt, const struct lyd_attr *attr,
1179 struct lyd_meta **meta);
1180
1181/**
Michal Vasko8d65f852021-02-17 11:28:13 +01001182 * @brief Create a new JSON opaque node in the data tree. To create an XML opaque node, use ::lyd_new_opaq2().
Michal Vasko00cbf532020-06-15 13:58:47 +02001183 *
1184 * @param[in] parent Parent node for the node beaing created. NULL in case of creating a top level element.
1185 * @param[in] ctx libyang context. If NULL, @p parent context will be used.
1186 * @param[in] name Node name.
Michal Vasko0ab974d2021-02-24 13:18:26 +01001187 * @param[in] value Optional node value.
1188 * @param[in] prefix Optional node prefix, must be equal to @p module_name if set.
Michal Vasko00cbf532020-06-15 13:58:47 +02001189 * @param[in] module_name Node module name.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001190 * @param[out] node Optional created node.
1191 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +02001192 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001193LY_ERR lyd_new_opaq(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value,
Michal Vasko0ab974d2021-02-24 13:18:26 +01001194 const char *prefix, const char *module_name, struct lyd_node **node);
Michal Vasko00cbf532020-06-15 13:58:47 +02001195
1196/**
Michal Vasko8d65f852021-02-17 11:28:13 +01001197 * @brief Create a new XML opaque node in the data tree. To create a JSON opaque node, use ::lyd_new_opaq().
1198 *
1199 * @param[in] parent Parent node for the node beaing created. NULL in case of creating a top level element.
1200 * @param[in] ctx libyang context. If NULL, @p parent context will be used.
1201 * @param[in] name Node name.
Michal Vasko0ab974d2021-02-24 13:18:26 +01001202 * @param[in] value Optional node value.
1203 * @param[in] prefix Optional node prefix.
Michal Vasko8d65f852021-02-17 11:28:13 +01001204 * @param[in] module_ns Node module namespace.
1205 * @param[out] node Optional created node.
1206 * @return LY_ERR value.
1207 */
1208LY_ERR lyd_new_opaq2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value,
Michal Vasko0ab974d2021-02-24 13:18:26 +01001209 const char *prefix, const char *module_ns, struct lyd_node **node);
Michal Vasko8d65f852021-02-17 11:28:13 +01001210
1211/**
1212 * @brief Create new JSON attribute for an opaque data node. To create an XML attribute, use ::lyd_new_attr2().
Michal Vasko00cbf532020-06-15 13:58:47 +02001213 *
1214 * @param[in] parent Parent opaque node for the attribute being created.
Radek Krejci8678fa42020-08-18 16:07:28 +02001215 * @param[in] module_name Name of the module of the attribute being created. There may be none.
Michal Vasko00cbf532020-06-15 13:58:47 +02001216 * @param[in] name Attribute name. It can include the module name as the prefix.
Michal Vasko8d65f852021-02-17 11:28:13 +01001217 * @param[in] value Attribute value, may be NULL.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001218 * @param[out] attr Optional created attribute.
1219 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +02001220 */
Michal Vasko8d65f852021-02-17 11:28:13 +01001221LY_ERR lyd_new_attr(struct lyd_node *parent, const char *module_name, const char *name, const char *value,
1222 struct lyd_attr **attr);
1223
1224/**
1225 * @brief Create new XML attribute for an opaque data node. To create a JSON attribute, use ::lyd_new_attr().
1226 *
1227 * @param[in] parent Parent opaque node for the attribute being created.
1228 * @param[in] module_ns Namespace of the module of the attribute being created. There may be none.
1229 * @param[in] name Attribute name. It can include an XML prefix.
1230 * @param[in] value Attribute value, may be NULL.
1231 * @param[out] attr Optional created attribute.
1232 * @return LY_ERR value.
1233 */
1234LY_ERR lyd_new_attr2(struct lyd_node *parent, const char *module_ns, const char *name, const char *value,
Radek Krejci0f969882020-08-21 16:56:47 +02001235 struct lyd_attr **attr);
Michal Vasko00cbf532020-06-15 13:58:47 +02001236
1237/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001238 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001239 * @defgroup pathoptions Data path creation options
Michal Vasko00cbf532020-06-15 13:58:47 +02001240 *
1241 * Various options to change lyd_new_path*() behavior.
1242 *
1243 * Default behavior:
1244 * - if the target node already exists (and is not default), an error is returned.
1245 * - the whole path to the target node is created (with any missing parents) if necessary.
1246 * - RPC output schema children are completely ignored in all modules. Input is searched and nodes created normally.
1247 * @{
1248 */
1249
Radek Krejci092e33c2020-10-12 15:33:10 +02001250#define LYD_NEW_PATH_UPDATE 0x01 /**< If the target node exists, is a leaf, and it is updated with a new value or its
1251 default flag is changed, it is returned. If the target node exists and is not
1252 a leaf or generally no change occurs in the @p parent tree, NULL is returned and
1253 no error set. */
1254#define LYD_NEW_PATH_OUTPUT 0x02 /**< Changes the behavior to ignoring RPC/action input schema nodes and using only
1255 output ones. */
1256#define LYD_NEW_PATH_OPAQ 0x04 /**< Enables the creation of opaque nodes with some specific rules. If the __last node__
1257 in the path is not uniquely defined ((leaf-)list without a predicate) or has an
1258 invalid value (leaf/leaf-list), it is created as opaque. */
Michal Vasko00cbf532020-06-15 13:58:47 +02001259
1260/** @} pathoptions */
1261
1262/**
Michal Vaskod5e67442021-03-04 15:56:31 +01001263 * @brief Create a new node in the data tree based on a path. If creating anyxml/anydata nodes, ::lyd_new_path2
1264 * should be used instead, this function expects the value as string.
Michal Vasko00cbf532020-06-15 13:58:47 +02001265 *
Radek Krejci95ccd1b2021-03-12 14:57:22 +01001266 * If creating data nodes defined inside an extension instance, use ::lyd_new_ext_path().
1267 *
Michal Vasko00cbf532020-06-15 13:58:47 +02001268 * If @p path points to a list key and the list instance does not exist, the key value from the predicate is used
1269 * and @p value is ignored. Also, if a leaf-list is being created and both a predicate is defined in @p path
1270 * and @p value is set, the predicate is preferred.
1271 *
Michal Vasko65591ab2021-04-09 14:29:34 +02001272 * For key-less lists and non-configuration leaf-lists, positional predicates should be used. If no predicate is used
1273 * for these nodes, they are always created.
Michal Vasko6741dc62021-02-04 09:27:45 +01001274 *
Michal Vasko104fe962020-11-06 17:23:44 +01001275 * @param[in] parent Data parent to add to/modify, can be NULL. Note that in case a first top-level sibling is used,
1276 * it may no longer be first if @p path is absolute and starts with a non-existing top-level node inserted
1277 * before @p parent. Use ::lyd_first_sibling() to adjust @p parent in these cases.
Michal Vasko00cbf532020-06-15 13:58:47 +02001278 * @param[in] ctx libyang context, must be set if @p parent is NULL.
Michal Vasko104fe962020-11-06 17:23:44 +01001279 * @param[in] path [Path](@ref howtoXPath) to create.
Michal Vasko00cbf532020-06-15 13:58:47 +02001280 * @param[in] value Value of the new leaf/leaf-list. For other node types, it is ignored.
1281 * @param[in] options Bitmask of options, see @ref pathoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001282 * @param[out] node Optional first created node.
1283 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +02001284 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001285LY_ERR lyd_new_path(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const char *value,
Radek Krejci1deb5be2020-08-26 16:43:36 +02001286 uint32_t options, struct lyd_node **node);
Michal Vasko00cbf532020-06-15 13:58:47 +02001287
1288/**
1289 * @brief Create a new node in the data tree based on a path. All node types can be created.
1290 *
Michal Vasko65591ab2021-04-09 14:29:34 +02001291 * Details are mentioned in ::lyd_new_path().
Michal Vasko6741dc62021-02-04 09:27:45 +01001292 *
Michal Vasko104fe962020-11-06 17:23:44 +01001293 * @param[in] parent Data parent to add to/modify, can be NULL. Note that in case a first top-level sibling is used,
1294 * it may no longer be first if @p path is absolute and starts with a non-existing top-level node inserted
1295 * before @p parent. Use ::lyd_first_sibling() to adjust @p parent in these cases.
Michal Vasko00cbf532020-06-15 13:58:47 +02001296 * @param[in] ctx libyang context, must be set if @p parent is NULL.
Michal Vasko104fe962020-11-06 17:23:44 +01001297 * @param[in] path [Path](@ref howtoXPath) to create.
Michal Vasko90cdd762021-01-11 10:25:07 +01001298 * @param[in] value Value of the new leaf/leaf-list (const char *) or anyxml/anydata (expected type depends on @p value_type).
1299 * For other node types, it is ignored.
Michal Vasko00cbf532020-06-15 13:58:47 +02001300 * @param[in] value_type Anyxml/anydata node @p value type.
1301 * @param[in] options Bitmask of options, see @ref pathoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001302 * @param[out] new_parent Optional first parent node created. If only one node was created, equals to @p new_node.
1303 * @param[out] new_node Optional last node created.
Michal Vasko00cbf532020-06-15 13:58:47 +02001304 * @return LY_ERR value.
1305 */
1306LY_ERR lyd_new_path2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const void *value,
Radek Krejci1deb5be2020-08-26 16:43:36 +02001307 LYD_ANYDATA_VALUETYPE value_type, uint32_t options, struct lyd_node **new_parent, struct lyd_node **new_node);
Michal Vasko00cbf532020-06-15 13:58:47 +02001308
1309/**
Radek Krejci95ccd1b2021-03-12 14:57:22 +01001310 * @brief Create a new node defined in the given extension instance. In case of anyxml/anydata nodes, this function expects
1311 * the @p value as string.
1312 *
1313 * If creating data nodes defined in a module's standard tree, use ::lyd_new_path() or ::lyd_new_path2().
1314 *
Michal Vasko65591ab2021-04-09 14:29:34 +02001315 * Details are mentioned in ::lyd_new_path().
Radek Krejci95ccd1b2021-03-12 14:57:22 +01001316 *
1317 * @param[in] parent Data parent to add to/modify, can be NULL. Note that in case a first top-level sibling is used,
1318 * it may no longer be first if @p path is absolute and starts with a non-existing top-level node inserted
1319 * before @p parent. Use ::lyd_first_sibling() to adjust @p parent in these cases.
1320 * @param[in] ext Extension instance where the node being created is defined.
1321 * @param[in] path [Path](@ref howtoXPath) to create.
1322 * @param[in] value Value of the new leaf/leaf-list. For other node types, it is ignored.
1323 * @param[in] options Bitmask of options, see @ref pathoptions.
1324 * @param[out] node Optional first created node.
1325 * @return LY_ERR value.
1326 */
1327LY_ERR lyd_new_ext_path(struct lyd_node *parent, const struct lysc_ext_instance *ext, const char *path, const void *value,
1328 uint32_t options, struct lyd_node **node);
1329
1330/**
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001331 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001332 * @defgroup implicitoptions Implicit node creation options
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001333 *
1334 * Various options to change lyd_new_implicit*() behavior.
1335 *
1336 * Default behavior:
1337 * - both configuration and state missing implicit nodes are added.
Michal Vasko630d9892020-12-08 17:11:08 +01001338 * - for existing RPC/action nodes, input implicit nodes are added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001339 * - all implicit node types are added (non-presence containers, default leaves, and default leaf-lists).
1340 * @{
1341 */
1342
Michal Vasko44b19a12020-08-07 09:21:30 +02001343#define LYD_IMPLICIT_NO_STATE 0x01 /**< Do not add any implicit state nodes. */
1344#define LYD_IMPLICIT_NO_CONFIG 0x02 /**< Do not add any implicit config nodes. */
Michal Vasko630d9892020-12-08 17:11:08 +01001345#define LYD_IMPLICIT_OUTPUT 0x04 /**< For RPC/action nodes, add output implicit nodes instead of input. */
1346#define LYD_IMPLICIT_NO_DEFAULTS 0x08 /**< Do not add any default nodes (leaves/leaf-lists), only non-presence
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001347 containers. */
1348
1349/** @} implicitoptions */
1350
1351/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001352 * @brief Add any missing implicit nodes into a data subtree. Default nodes with a false "when" are not added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001353 *
1354 * @param[in] tree Tree to add implicit nodes into.
1355 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1356 * @param[out] diff Optional diff with any created nodes.
1357 * @return LY_ERR value.
1358 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001359LY_ERR lyd_new_implicit_tree(struct lyd_node *tree, uint32_t implicit_options, struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001360
1361/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001362 * @brief Add any missing implicit nodes. Default nodes with a false "when" are not added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001363 *
Michal Vaskod3bb12f2020-12-04 14:33:09 +01001364 * @param[in,out] tree Tree to add implicit nodes into. Note that in case a first top-level sibling is used,
1365 * it may no longer be first if an implicit node was inserted before @p tree. Use ::lyd_first_sibling() to
1366 * adjust @p tree in these cases.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001367 * @param[in] ctx libyang context, must be set only if @p tree is an empty tree.
1368 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1369 * @param[out] diff Optional diff with any created nodes.
1370 * @return LY_ERR value.
1371 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001372LY_ERR lyd_new_implicit_all(struct lyd_node **tree, const struct ly_ctx *ctx, uint32_t implicit_options, struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001373
1374/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001375 * @brief Add any missing implicit nodes of one module. Default nodes with a false "when" are not added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001376 *
Michal Vaskod3bb12f2020-12-04 14:33:09 +01001377 * @param[in,out] tree Tree to add implicit nodes into. Note that in case a first top-level sibling is used,
1378 * it may no longer be first if an implicit node was inserted before @p tree. Use ::lyd_first_sibling() to
1379 * adjust @p tree in these cases.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001380 * @param[in] module Module whose implicit nodes to create.
1381 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1382 * @param[out] diff Optional diff with any created nodes.
1383 * @return LY_ERR value.
1384 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001385LY_ERR lyd_new_implicit_module(struct lyd_node **tree, const struct lys_module *module, uint32_t implicit_options,
Radek Krejci0f969882020-08-21 16:56:47 +02001386 struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001387
1388/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001389 * @brief Change the value of a term (leaf or leaf-list) node.
1390 *
1391 * Node changed this way is always considered explicitly set, meaning its default flag
1392 * is always cleared.
1393 *
1394 * @param[in] term Term node to change.
1395 * @param[in] val_str New value to set, any prefixes are expected in JSON format.
1396 * @return LY_SUCCESS if value was changed,
1397 * @return LY_EEXIST if value was the same and only the default flag was cleared,
1398 * @return LY_ENOT if the values were equal and no change occured,
1399 * @return LY_ERR value on other errors.
1400 */
1401LY_ERR lyd_change_term(struct lyd_node *term, const char *val_str);
1402
1403/**
Michal Vasko41586352020-07-13 13:54:25 +02001404 * @brief Change the value of a metadata instance.
1405 *
Michal Vasko41586352020-07-13 13:54:25 +02001406 * @param[in] meta Metadata to change.
1407 * @param[in] val_str New value to set, any prefixes are expected in JSON format.
1408 * @return LY_SUCCESS if value was changed,
1409 * @return LY_ENOT if the values were equal and no change occured,
1410 * @return LY_ERR value on other errors.
1411 */
1412LY_ERR lyd_change_meta(struct lyd_meta *meta, const char *val_str);
1413
1414/**
Michal Vaskob104f112020-07-17 09:54:54 +02001415 * @brief Insert a child into a parent.
Michal Vaskof03ed032020-03-04 13:31:44 +01001416 *
1417 * - if the node is part of some other tree, it is automatically unlinked.
1418 * - if the node is the first node of a node list (with no parent), all the subsequent nodes are also inserted.
1419 *
1420 * @param[in] parent Parent node to insert into.
1421 * @param[in] node Node to insert.
1422 * @return LY_SUCCESS on success.
1423 * @return LY_ERR error on error.
1424 */
Michal Vaskob104f112020-07-17 09:54:54 +02001425LY_ERR lyd_insert_child(struct lyd_node *parent, struct lyd_node *node);
Michal Vaskof03ed032020-03-04 13:31:44 +01001426
1427/**
Michal Vaskob104f112020-07-17 09:54:54 +02001428 * @brief Insert a node into siblings.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001429 *
1430 * - if the node is part of some other tree, it is automatically unlinked.
1431 * - if the node is the first node of a node list (with no parent), all the subsequent nodes are also inserted.
1432 *
Michal Vaskob104f112020-07-17 09:54:54 +02001433 * @param[in] sibling Siblings to insert into, can even be NULL.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001434 * @param[in] node Node to insert.
Michal Vaskob104f112020-07-17 09:54:54 +02001435 * @param[out] first Optionally return the first sibling after insertion. Can be the address of @p sibling.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001436 * @return LY_SUCCESS on success.
1437 * @return LY_ERR error on error.
1438 */
Michal Vaskob104f112020-07-17 09:54:54 +02001439LY_ERR lyd_insert_sibling(struct lyd_node *sibling, struct lyd_node *node, struct lyd_node **first);
Michal Vaskob1b5c262020-03-05 14:29:47 +01001440
1441/**
Michal Vaskob104f112020-07-17 09:54:54 +02001442 * @brief Insert a node before another node, can be used only for user-ordered nodes.
Michal Vasko4bc2ce32020-12-08 10:06:16 +01001443 * If inserting several siblings, each of them must be inserted individually.
Michal Vaskof03ed032020-03-04 13:31:44 +01001444 *
1445 * - if the node is part of some other tree, it is automatically unlinked.
Michal Vaskof03ed032020-03-04 13:31:44 +01001446 *
1447 * @param[in] sibling Sibling node to insert before.
1448 * @param[in] node Node to insert.
1449 * @return LY_SUCCESS on success.
1450 * @return LY_ERR error on error.
1451 */
1452LY_ERR lyd_insert_before(struct lyd_node *sibling, struct lyd_node *node);
1453
1454/**
Michal Vaskob104f112020-07-17 09:54:54 +02001455 * @brief Insert a node after another node, can be used only for user-ordered nodes.
Michal Vasko4bc2ce32020-12-08 10:06:16 +01001456 * If inserting several siblings, each of them must be inserted individually.
Michal Vaskof03ed032020-03-04 13:31:44 +01001457 *
1458 * - if the node is part of some other tree, it is automatically unlinked.
Michal Vaskof03ed032020-03-04 13:31:44 +01001459 *
1460 * @param[in] sibling Sibling node to insert after.
1461 * @param[in] node Node to insert.
1462 * @return LY_SUCCESS on success.
1463 * @return LY_ERR error on error.
1464 */
1465LY_ERR lyd_insert_after(struct lyd_node *sibling, struct lyd_node *node);
1466
1467/**
1468 * @brief Unlink the specified data subtree.
1469 *
1470 * @param[in] node Data tree node to be unlinked (together with all the children).
1471 */
1472void lyd_unlink_tree(struct lyd_node *node);
1473
1474/**
Radek Krejcib0849a22019-07-25 12:31:04 +02001475 * @brief Free all the nodes (even parents of the node) in the data tree.
Radek Krejcie7b95092019-05-15 11:03:07 +02001476 *
1477 * @param[in] node Any of the nodes inside the tree.
1478 */
1479void lyd_free_all(struct lyd_node *node);
1480
1481/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001482 * @brief Free all the sibling nodes (preceding as well as succeeding).
Radek Krejcib0849a22019-07-25 12:31:04 +02001483 *
1484 * @param[in] node Any of the sibling nodes to free.
1485 */
Michal Vaskof03ed032020-03-04 13:31:44 +01001486void lyd_free_siblings(struct lyd_node *node);
Radek Krejcib0849a22019-07-25 12:31:04 +02001487
1488/**
Radek Krejcie7b95092019-05-15 11:03:07 +02001489 * @brief Free (and unlink) the specified data (sub)tree.
1490 *
Radek Krejcie7b95092019-05-15 11:03:07 +02001491 * @param[in] node Root of the (sub)tree to be freed.
1492 */
1493void lyd_free_tree(struct lyd_node *node);
1494
1495/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001496 * @brief Free a single metadata instance.
Radek Krejcie7b95092019-05-15 11:03:07 +02001497 *
Michal Vasko3a41dff2020-07-15 14:30:28 +02001498 * @param[in] meta Metadata to free.
Radek Krejcie7b95092019-05-15 11:03:07 +02001499 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001500void lyd_free_meta_single(struct lyd_meta *meta);
Michal Vasko52927e22020-03-16 17:26:14 +01001501
1502/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001503 * @brief Free the metadata instance with any following instances.
1504 *
1505 * @param[in] meta Metadata to free.
1506 */
1507void lyd_free_meta_siblings(struct lyd_meta *meta);
1508
1509/**
1510 * @brief Free a single attribute.
Michal Vasko52927e22020-03-16 17:26:14 +01001511 *
1512 * @param[in] ctx Context where the attributes were created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001513 * @param[in] attr Attribute to free.
Michal Vasko52927e22020-03-16 17:26:14 +01001514 */
Radek Krejci011e4aa2020-09-04 15:22:31 +02001515void lyd_free_attr_single(const struct ly_ctx *ctx, struct lyd_attr *attr);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001516
1517/**
1518 * @brief Free the attribute with any following attributes.
1519 *
1520 * @param[in] ctx Context where the attributes were created.
1521 * @param[in] attr First attribute to free.
1522 */
Radek Krejci011e4aa2020-09-04 15:22:31 +02001523void lyd_free_attr_siblings(const struct ly_ctx *ctx, struct lyd_attr *attr);
Radek Krejcie7b95092019-05-15 11:03:07 +02001524
Radek Krejci084289f2019-07-09 17:35:30 +02001525/**
1526 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
1527 *
1528 * The given node is not modified in any way - it is just checked if the @p value can be set to the node.
1529 *
Radek Krejci084289f2019-07-09 17:35:30 +02001530 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
Michal Vaskoaebbce02021-04-06 09:23:37 +02001531 * @param[in] schema Schema node of the @p value.
Michal Vaskof937cfe2020-08-03 16:07:12 +02001532 * @param[in] value String value to be checked, it is expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02001533 * @param[in] value_len Length of the given @p value (mandatory).
Michal Vaskoaebbce02021-04-06 09:23:37 +02001534 * @param[in] ctx_node Optional data tree context node for the value (leafref target, instance-identifier).
1535 * If not set and is required for the validation to complete, ::LY_EINCOMPLETE is be returned.
1536 * @param[out] realtype Optional real type of @p value.
1537 * @param[out] canonical Optional canonical value of @p value (in the dictionary).
Radek Krejci084289f2019-07-09 17:35:30 +02001538 * @return LY_SUCCESS on success
Michal Vaskoaebbce02021-04-06 09:23:37 +02001539 * @return LY_EINCOMPLETE in case the @p ctx_node is not provided and it was needed to finish the validation
1540 * (e.g. due to require-instance).
Radek Krejci084289f2019-07-09 17:35:30 +02001541 * @return LY_ERR value if an error occurred.
1542 */
Michal Vaskoaebbce02021-04-06 09:23:37 +02001543LY_ERR lyd_value_validate(const struct ly_ctx *ctx, const struct lysc_node *schema, const char *value, size_t value_len,
1544 const struct lyd_node *ctx_node, const struct lysc_type **realtype, const char **canonical);
Radek Krejci084289f2019-07-09 17:35:30 +02001545
1546/**
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001547 * @brief Compare the node's value with the given string value. The string value is first validated according to
1548 * the (current) node's type.
Radek Krejci084289f2019-07-09 17:35:30 +02001549 *
1550 * @param[in] node Data node to compare.
1551 * @param[in] value String value to be compared. It does not need to be in a canonical form - as part of the process,
Michal Vaskof937cfe2020-08-03 16:07:12 +02001552 * it is validated and canonized if possible. But it is expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02001553 * @param[in] value_len Length of the given @p value (mandatory).
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001554 * @return LY_SUCCESS on success,
1555 * @return LY_ENOT if the values do not match,
Radek Krejci084289f2019-07-09 17:35:30 +02001556 * @return LY_ERR value if an error occurred.
1557 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001558LY_ERR lyd_value_compare(const struct lyd_node_term *node, const char *value, size_t value_len);
Radek Krejci084289f2019-07-09 17:35:30 +02001559
Radek Krejci576b23f2019-07-12 14:06:32 +02001560/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001561 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001562 * @defgroup datacompareoptions Data compare options
1563 * @{
1564 * Various options to change the ::lyd_compare_single() and ::lyd_compare_siblings() behavior.
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001565 */
1566#define LYD_COMPARE_FULL_RECURSION 0x01 /* lists and containers are the same only in case all they children
1567 (subtree, so direct as well as indirect children) are the same. By default,
1568 containers are the same in case of the same schema node and lists are the same
1569 in case of equal keys (keyless lists do the full recursion comparison all the time). */
1570#define LYD_COMPARE_DEFAULTS 0x02 /* By default, implicit and explicit default nodes are considered to be equal. This flag
1571 changes this behavior and implicit (automatically created default node) and explicit
1572 (explicitly created node with the default value) default nodes are considered different. */
Michal Vasko60ea6352020-06-29 13:39:39 +02001573/** @} datacompareoptions */
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001574
1575/**
1576 * @brief Compare 2 data nodes if they are equivalent.
1577 *
1578 * @param[in] node1 The first node to compare.
1579 * @param[in] node2 The second node to compare.
Radek Krejcic5ad9652019-09-11 11:31:51 +02001580 * @param[in] options Various @ref datacompareoptions.
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001581 * @return LY_SUCCESS if the nodes are equivalent.
1582 * @return LY_ENOT if the nodes are not equivalent.
1583 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001584LY_ERR lyd_compare_single(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
Michal Vasko8f359bf2020-07-28 10:41:15 +02001585
1586/**
1587 * @brief Compare 2 lists of siblings if they are equivalent.
1588 *
1589 * @param[in] node1 The first sibling list to compare.
1590 * @param[in] node2 The second sibling list to compare.
1591 * @param[in] options Various @ref datacompareoptions.
1592 * @return LY_SUCCESS if all the siblings are equivalent.
1593 * @return LY_ENOT if the siblings are not equivalent.
1594 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001595LY_ERR lyd_compare_siblings(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001596
1597/**
Michal Vasko21725742020-06-29 11:49:25 +02001598 * @brief Compare 2 metadata.
1599 *
1600 * @param[in] meta1 First metadata.
1601 * @param[in] meta2 Second metadata.
1602 * @return LY_SUCCESS if the metadata are equivalent.
1603 * @return LY_ENOT if not.
1604 */
1605LY_ERR lyd_compare_meta(const struct lyd_meta *meta1, const struct lyd_meta *meta2);
1606
1607/**
Radek Krejci22ebdba2019-07-25 13:59:43 +02001608 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001609 * @defgroup dupoptions Data duplication options
Radek Krejci22ebdba2019-07-25 13:59:43 +02001610 *
Michal Vaskoe78faec2021-04-08 17:24:43 +02001611 * Various options to change ::lyd_dup_single() and ::lyd_dup_siblings() behavior.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001612 *
1613 * Default behavior:
1614 * - only the specified node is duplicated without siblings, parents, or children.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001615 * - all the metadata of the duplicated nodes are also duplicated.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001616 * @{
1617 */
1618
1619#define LYD_DUP_RECURSIVE 0x01 /**< Duplicate not just the node but also all the children. Note that
1620 list's keys are always duplicated. */
Michal Vaskoa29a5762020-06-23 13:28:49 +02001621#define LYD_DUP_NO_META 0x02 /**< Do not duplicate metadata of any node. */
Radek Krejci22ebdba2019-07-25 13:59:43 +02001622#define LYD_DUP_WITH_PARENTS 0x04 /**< If a nested node is being duplicated, duplicate also all the parents.
1623 Keys are also duplicated for lists. Return value does not change! */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001624#define LYD_DUP_WITH_FLAGS 0x08 /**< Also copy any data node flags. That will cause the duplicated data to preserve
Michal Vaskof6df0a02020-06-16 13:08:34 +02001625 its validation/default node state. */
Radek Krejci22ebdba2019-07-25 13:59:43 +02001626
1627/** @} dupoptions */
1628
1629/**
1630 * @brief Create a copy of the specified data tree \p node. Schema references are kept the same.
1631 *
Radek Krejci22ebdba2019-07-25 13:59:43 +02001632 * @param[in] node Data tree node to be duplicated.
1633 * @param[in] parent Optional parent node where to connect the duplicated node(s).
Michal Vasko3a41dff2020-07-15 14:30:28 +02001634 * If set in combination with LYD_DUP_WITH_PARENTS, the parents chain is duplicated until it comes to and connects with
1635 * the @p parent.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001636 * @param[in] options Bitmask of options flags, see @ref dupoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001637 * @param[out] dup Optional created copy of the node. Note that in case the parents chain is duplicated for the duplicated
1638 * node(s) (when LYD_DUP_WITH_PARENTS used), the first duplicated node is still returned.
1639 * @return LY_ERR value.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001640 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001641LY_ERR lyd_dup_single(const struct lyd_node *node, struct lyd_node_inner *parent, uint32_t options, struct lyd_node **dup);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001642
1643/**
1644 * @brief Create a copy of the specified data tree \p node with any following siblings. Schema references are kept the same.
1645 *
1646 * @param[in] node Data tree node to be duplicated.
1647 * @param[in] parent Optional parent node where to connect the duplicated node(s).
1648 * If set in combination with LYD_DUP_WITH_PARENTS, the parents chain is duplicated until it comes to and connects with
1649 * the @p parent.
1650 * @param[in] options Bitmask of options flags, see @ref dupoptions.
1651 * @param[out] dup Optional created copy of the node. Note that in case the parents chain is duplicated for the duplicated
1652 * node(s) (when LYD_DUP_WITH_PARENTS used), the first duplicated node is still returned.
1653 * @return LY_ERR value.
1654 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001655LY_ERR lyd_dup_siblings(const struct lyd_node *node, struct lyd_node_inner *parent, uint32_t options, struct lyd_node **dup);
Radek Krejci22ebdba2019-07-25 13:59:43 +02001656
1657/**
Michal Vasko25a32822020-07-09 15:48:22 +02001658 * @brief Create a copy of the metadata.
1659 *
1660 * @param[in] meta Metadata to copy.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001661 * @param[in] parent Node where to append the new metadata.
1662 * @param[out] dup Optional created metadata copy.
1663 * @return LY_ERR value.
Michal Vasko25a32822020-07-09 15:48:22 +02001664 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001665LY_ERR lyd_dup_meta_single(const struct lyd_meta *meta, struct lyd_node *parent, struct lyd_meta **dup);
Michal Vasko25a32822020-07-09 15:48:22 +02001666
1667/**
Michal Vasko4490d312020-06-16 13:08:55 +02001668 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001669 * @defgroup mergeoptions Data merge options.
Radek Krejci576b23f2019-07-12 14:06:32 +02001670 *
Radek Krejci8678fa42020-08-18 16:07:28 +02001671 * Various options to change ::lyd_merge_tree() and ::lyd_merge_siblings() behavior.
Michal Vasko4490d312020-06-16 13:08:55 +02001672 *
1673 * Default behavior:
1674 * - source data tree is not modified in any way,
Michal Vasko745d6f62021-04-12 16:55:23 +02001675 * - any default nodes in the source are ignored if there are explicit nodes in the target,
1676 * - any metadata are ignored - those present in the target are kept, those in the source are not merged.
Michal Vasko4490d312020-06-16 13:08:55 +02001677 * @{
1678 */
1679
1680#define LYD_MERGE_DESTRUCT 0x01 /**< Spend source data tree in the function, it cannot be used afterwards! */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001681#define LYD_MERGE_DEFAULTS 0x02 /**< Default nodes in the source tree replace even explicit nodes in the target. */
Michal Vasko4490d312020-06-16 13:08:55 +02001682
1683/** @} mergeoptions */
1684
1685/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001686 * @brief Merge the source data subtree into the target data tree. Merge may not be complete until validation
Michal Vasko4490d312020-06-16 13:08:55 +02001687 * is called on the resulting data tree (data from more cases may be present, default and non-default values).
1688 *
Michal Vasko2f510942020-11-13 10:26:25 +01001689 * Example input:
1690 *
1691 * source (A1) - A2 - A3 target (B1) - B2 - B3
1692 * /\ /\ /\ /\ /\ /\
1693 * .... .... .... .... .... ....
1694 *
1695 * result target (A1) - B1 - B2 - B3
1696 * /\ /\ /\ /\
1697 * .... .... .... ....
1698 *
Michal Vasko4490d312020-06-16 13:08:55 +02001699 * @param[in,out] target Target data tree to merge into, must be a top-level tree.
1700 * @param[in] source Source data tree to merge, must be a top-level tree.
1701 * @param[in] options Bitmask of option flags, see @ref mergeoptions.
1702 * @return LY_SUCCESS on success,
1703 * @return LY_ERR value on error.
1704 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001705LY_ERR lyd_merge_tree(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001706
1707/**
1708 * @brief Merge the source data tree with any following siblings into the target data tree. Merge may not be
1709 * complete until validation called on the resulting data tree (data from more cases may be present, default
1710 * and non-default values).
1711 *
Michal Vasko2f510942020-11-13 10:26:25 +01001712 * Example input:
1713 *
1714 * source (A1) - A2 - A3 target (B1) - B2 - B3
1715 * /\ /\ /\ /\ /\ /\
1716 * .... .... .... .... .... ....
1717 *
1718 * result target (A1) - A2 - A3 - B1 - B2 - B3
1719 * /\ /\ /\ /\ /\ /\
1720 * .... .... .... .... .... ....
1721 *
Michal Vasko3a41dff2020-07-15 14:30:28 +02001722 * @param[in,out] target Target data tree to merge into, must be a top-level tree.
1723 * @param[in] source Source data tree to merge, must be a top-level tree.
1724 * @param[in] options Bitmask of option flags, see @ref mergeoptions.
1725 * @return LY_SUCCESS on success,
1726 * @return LY_ERR value on error.
1727 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001728LY_ERR lyd_merge_siblings(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
Michal Vasko4490d312020-06-16 13:08:55 +02001729
1730/**
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001731 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001732 * @defgroup diffoptions Data diff options.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001733 *
Radek Krejci8678fa42020-08-18 16:07:28 +02001734 * Various options to change ::lyd_diff_tree() and ::lyd_diff_siblings() behavior.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001735 *
1736 * Default behavior:
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001737 * - any default nodes are treated as non-existent and ignored.
1738 * @{
1739 */
1740
Michal Vasko3a41dff2020-07-15 14:30:28 +02001741#define LYD_DIFF_DEFAULTS 0x01 /**< Default nodes in the trees are not ignored but treated similarly to explicit
1742 nodes. Also, leaves and leaf-lists are added into diff even in case only their
1743 default flag (state) was changed. */
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001744
1745/** @} diffoptions */
1746
1747/**
1748 * @brief Learn the differences between 2 data trees.
1749 *
1750 * The resulting diff is represented as a data tree with specific metadata from the internal 'yang'
1751 * module. Most importantly, every node has an effective 'operation' metadata. If there is none
1752 * defined on the node, it inherits the operation from the nearest parent. Top-level nodes must
1753 * always have the 'operation' metadata defined. Additional metadata ('orig-default', 'value',
1754 * 'orig-value', 'key', 'orig-key') are used for storing more information about the value in the first
1755 * or the second tree.
1756 *
1757 * The diff tree is completely independent on the @p first and @p second trees, meaning all
1758 * the information about the change is stored in the diff and the trees are not needed.
1759 *
Michal Vaskoff857812021-03-05 17:03:52 +01001760 * __!! Caution !!__
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001761 * The diff tree should never be validated because it may easily not be valid! For example,
1762 * when data from one case branch are deleted and data from another branch created - data from both
1763 * branches are then stored in the diff tree simultaneously.
1764 *
1765 * @param[in] first First data tree.
1766 * @param[in] second Second data tree.
1767 * @param[in] options Bitmask of options flags, see @ref diffoptions.
1768 * @param[out] diff Generated diff.
1769 * @return LY_SUCCESS on success,
1770 * @return LY_ERR on error.
1771 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001772LY_ERR lyd_diff_tree(const struct lyd_node *first, const struct lyd_node *second, uint16_t options, struct lyd_node **diff);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001773
1774/**
1775 * @brief Learn the differences between 2 data trees including all the following siblings.
1776 *
Michal Vaskoff857812021-03-05 17:03:52 +01001777 * Details are mentioned in ::lyd_diff_tree().
1778 *
Michal Vasko3a41dff2020-07-15 14:30:28 +02001779 * @param[in] first First data tree.
1780 * @param[in] second Second data tree.
1781 * @param[in] options Bitmask of options flags, see @ref diffoptions.
1782 * @param[out] diff Generated diff.
1783 * @return LY_SUCCESS on success,
1784 * @return LY_ERR on error.
1785 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001786LY_ERR lyd_diff_siblings(const struct lyd_node *first, const struct lyd_node *second, uint16_t options, struct lyd_node **diff);
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001787
1788/**
1789 * @brief Callback for diff nodes.
1790 *
1791 * @param[in] diff_node Diff node.
1792 * @param[in] data_node Matching node in data.
1793 * @param[in] cb_data Arbitrary callback data.
1794 * @return LY_ERR value.
1795 */
1796typedef LY_ERR (*lyd_diff_cb)(const struct lyd_node *diff_node, struct lyd_node *data_node, void *cb_data);
1797
1798/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001799 * @brief Apply the whole diff on a data tree but restrict the operation to one module.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001800 *
Michal Vaskoa98dcba2021-03-05 17:04:14 +01001801 * __!! Caution !!__
1802 * If applying a diff that was created __without__ the ::LYD_DIFF_DEFAULTS flag, there may be some duplicate values
1803 * created. Unless the resulting tree is validated (and default values thus consolidated), using it further
1804 * (such as applying another diff) may cause unexpected results or errors.
1805 *
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001806 * @param[in,out] data Data to apply the diff on.
1807 * @param[in] diff Diff to apply.
1808 * @param[in] mod Module, whose diff/data only to consider, NULL for all modules.
1809 * @param[in] diff_cb Optional diff callback that will be called for every changed node.
1810 * @param[in] cb_data Arbitrary callback data.
1811 * @return LY_SUCCESS on success,
1812 * @return LY_ERR on error.
1813 */
1814LY_ERR lyd_diff_apply_module(struct lyd_node **data, const struct lyd_node *diff, const struct lys_module *mod,
Radek Krejci0f969882020-08-21 16:56:47 +02001815 lyd_diff_cb diff_cb, void *cb_data);
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001816
1817/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001818 * @brief Apply the whole diff tree on a data tree.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001819 *
Michal Vaskoff857812021-03-05 17:03:52 +01001820 * Details are mentioned in ::lyd_diff_apply_module().
1821 *
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001822 * @param[in,out] data Data to apply the diff on.
1823 * @param[in] diff Diff to apply.
1824 * @return LY_SUCCESS on success,
1825 * @return LY_ERR on error.
1826 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001827LY_ERR lyd_diff_apply_all(struct lyd_node **data, const struct lyd_node *diff);
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001828
1829/**
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001830 * @ingroup datatree
1831 * @defgroup diffmergeoptions Data diff merge options.
1832 *
1833 * Various options to change ::lyd_diff_merge_module(), ::lyd_diff_merge_tree(), and ::lyd_diff_merge_all() behavior.
1834 *
1835 * Default behavior:
1836 * - any default nodes are expected to be a result of validation corrections and not explicitly modified.
1837 * @{
1838 */
1839
1840#define LYD_DIFF_MERGE_DEFAULTS 0x01 /**< Default nodes in the diffs are treated as possibly explicitly modified. */
1841
Michal Vaskoff857812021-03-05 17:03:52 +01001842/** @} diffmergeoptions */
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001843
1844/**
Michal Vaskoe6323f62020-07-09 15:49:02 +02001845 * @brief Merge 2 diffs into each other but restrict the operation to one module.
1846 *
1847 * The diffs must be possible to be merged, which is guaranteed only if the source diff was
1848 * created on data that had the target diff applied on them. In other words, this sequence is legal
1849 *
Michal Vaskoff857812021-03-05 17:03:52 +01001850 * 1) get diff1 from data1 and data2 -> get data11 from apply diff1 on data1 -> get diff2 from data11 and data3 ->
1851 * -> get data 33 from apply diff2 on data1
Michal Vaskoe6323f62020-07-09 15:49:02 +02001852 *
1853 * and reusing these diffs
1854 *
Michal Vaskoff857812021-03-05 17:03:52 +01001855 * 2) get diff11 from merge diff1 and diff2 -> get data33 from apply diff11 on data1
Michal Vaskoe6323f62020-07-09 15:49:02 +02001856 *
Michal Vaskofb737aa2020-08-06 13:53:53 +02001857 * @param[in,out] diff Target diff to merge into.
Michal Vaskoe6323f62020-07-09 15:49:02 +02001858 * @param[in] src_diff Source diff.
1859 * @param[in] mod Module, whose diff only to consider, NULL for all modules.
Michal Vaskoe2af8412020-12-03 14:11:38 +01001860 * @param[in] diff_cb Optional diff callback that will be called for every merged node. Param @p diff_node is the source
1861 * diff node while @p data_node is the updated target diff node. In case a whole subtree is added, the callback is
1862 * called on the root with @p diff_node being NULL.
Michal Vaskoe6323f62020-07-09 15:49:02 +02001863 * @param[in] cb_data Arbitrary callback data.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001864 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vaskoe6323f62020-07-09 15:49:02 +02001865 * @return LY_SUCCESS on success,
1866 * @return LY_ERR on error.
1867 */
Michal Vaskofb737aa2020-08-06 13:53:53 +02001868LY_ERR lyd_diff_merge_module(struct lyd_node **diff, const struct lyd_node *src_diff, const struct lys_module *mod,
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001869 lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
Michal Vaskoe6323f62020-07-09 15:49:02 +02001870
1871/**
Michal Vasko04f85912020-08-07 12:14:58 +02001872 * @brief Merge 2 diff trees into each other.
1873 *
Michal Vaskoff857812021-03-05 17:03:52 +01001874 * Details are mentioned in ::lyd_diff_merge_module().
1875 *
Michal Vasko04f85912020-08-07 12:14:58 +02001876 * @param[in,out] diff_first Target diff first sibling to merge into.
1877 * @param[in] diff_parent Target diff parent to merge into.
1878 * @param[in] src_sibling Source diff sibling to merge.
Michal Vaskoe2af8412020-12-03 14:11:38 +01001879 * @param[in] diff_cb Optional diff callback that will be called for every merged node. Param @p diff_node is the source
1880 * diff node while @p data_node is the updated target diff node. In case a whole subtree is added, the callback is
1881 * called on the root with @p diff_node being NULL.
Michal Vasko04f85912020-08-07 12:14:58 +02001882 * @param[in] cb_data Arbitrary callback data.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001883 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vasko04f85912020-08-07 12:14:58 +02001884 * @return LY_SUCCESS on success,
1885 * @return LY_ERR on error.
1886 */
1887LY_ERR lyd_diff_merge_tree(struct lyd_node **diff_first, struct lyd_node *diff_parent, const struct lyd_node *src_sibling,
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001888 lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
Michal Vasko04f85912020-08-07 12:14:58 +02001889
1890/**
Michal Vaskoe6323f62020-07-09 15:49:02 +02001891 * @brief Merge 2 diffs into each other.
1892 *
Michal Vaskoff857812021-03-05 17:03:52 +01001893 * Details are mentioned in ::lyd_diff_merge_module().
1894 *
Michal Vaskoe6323f62020-07-09 15:49:02 +02001895 * @param[in,out] diff Target diff to merge into.
Michal Vaskofb737aa2020-08-06 13:53:53 +02001896 * @param[in] src_diff Source diff.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001897 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vaskoe6323f62020-07-09 15:49:02 +02001898 * @return LY_SUCCESS on success,
1899 * @return LY_ERR on error.
1900 */
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001901LY_ERR lyd_diff_merge_all(struct lyd_node **diff, const struct lyd_node *src_diff, uint16_t options);
Michal Vaskoe6323f62020-07-09 15:49:02 +02001902
1903/**
Michal Vasko4231fb62020-07-13 13:54:47 +02001904 * @brief Reverse a diff and make the opposite changes. Meaning change create to delete, delete to create,
1905 * or move from place A to B to move from B to A and so on.
1906 *
1907 * @param[in] src_diff Diff to reverse.
1908 * @param[out] diff Reversed diff.
1909 * @return LY_SUCCESS on success.
1910 * @return LY_ERR on error.
1911 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001912LY_ERR lyd_diff_reverse_all(const struct lyd_node *src_diff, struct lyd_node **diff);
Michal Vasko4231fb62020-07-13 13:54:47 +02001913
1914/**
Radek Krejcifba9c622020-10-30 08:28:54 +01001915 * @brief Find the target in data of a compiled instance-identifier path (the target member in ::lyd_value).
Michal Vasko4490d312020-06-16 13:08:55 +02001916 *
1917 * @param[in] path Compiled path structure.
Michal Vaskof03ed032020-03-04 13:31:44 +01001918 * @param[in] tree Data tree to be searched.
Michal Vasko4490d312020-06-16 13:08:55 +02001919 * @return Found target node,
1920 * @return NULL if not found.
Radek Krejci576b23f2019-07-12 14:06:32 +02001921 */
Michal Vasko004d3152020-06-11 19:59:22 +02001922const struct lyd_node_term *lyd_target(const struct ly_path *path, const struct lyd_node *tree);
Radek Krejci084289f2019-07-09 17:35:30 +02001923
Michal Vasko5ec7cda2019-09-11 13:43:08 +02001924/**
Michal Vasko5ec7cda2019-09-11 13:43:08 +02001925 * @brief Types of the different data paths.
1926 */
1927typedef enum {
Radek Krejci635d2b82021-01-04 11:26:51 +01001928 LYD_PATH_STD, /**< Generic data path used for logging, node searching (::lyd_find_xpath(), ::lys_find_path()) as well as
Radek Krejci95ccd1b2021-03-12 14:57:22 +01001929 creating new nodes (::lyd_new_path(), ::lyd_new_path2(), ::lyd_new_ext_path()). */
Radek Krejci635d2b82021-01-04 11:26:51 +01001930 LYD_PATH_STD_NO_LAST_PRED /**< Similar to ::LYD_PATH_STD except there is never a predicate on the last node. While it
1931 can be used to search for nodes, do not use it to create new data nodes (lists). */
Michal Vasko5ec7cda2019-09-11 13:43:08 +02001932} LYD_PATH_TYPE;
1933
1934/**
1935 * @brief Generate path of the given node in the requested format.
1936 *
Radek Krejci635d2b82021-01-04 11:26:51 +01001937 * @param[in] node Data path of this node will be generated.
Michal Vasko5ec7cda2019-09-11 13:43:08 +02001938 * @param[in] pathtype Format of the path to generate.
1939 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
1940 * If NULL, memory for the complete path is allocated.
1941 * @param[in] buflen Size of the provided @p buffer.
1942 * @return NULL in case of memory allocation error, path of the node otherwise.
1943 * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it.
1944 */
1945char *lyd_path(const struct lyd_node *node, LYD_PATH_TYPE pathtype, char *buffer, size_t buflen);
1946
Michal Vaskoe444f752020-02-10 12:20:06 +01001947/**
Michal Vasko25a32822020-07-09 15:48:22 +02001948 * @brief Find a specific metadata.
1949 *
1950 * @param[in] first First metadata to consider.
1951 * @param[in] module Module of the metadata definition, may be NULL if @p name includes a prefix.
1952 * @param[in] name Name of the metadata to find, may not include a prefix (module name) if @p module is set.
1953 * @return Found metadata,
1954 * @return NULL if not found.
1955 */
1956struct lyd_meta *lyd_find_meta(const struct lyd_meta *first, const struct lys_module *module, const char *name);
1957
1958/**
Michal Vaskoda859032020-07-14 12:20:14 +02001959 * @brief Search in the given siblings (NOT recursively) for the first target instance with the same value.
Michal Vaskoe444f752020-02-10 12:20:06 +01001960 * Uses hashes - should be used whenever possible for best performance.
1961 *
1962 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
1963 * @param[in] target Target node to find.
Michal Vasko9b368d32020-02-14 13:53:31 +01001964 * @param[out] match Can be NULL, otherwise the found data node.
Michal Vaskoe444f752020-02-10 12:20:06 +01001965 * @return LY_SUCCESS on success, @p match set.
1966 * @return LY_ENOTFOUND if not found, @p match set to NULL.
1967 * @return LY_ERR value if another error occurred.
1968 */
1969LY_ERR lyd_find_sibling_first(const struct lyd_node *siblings, const struct lyd_node *target, struct lyd_node **match);
1970
1971/**
Michal Vaskoe444f752020-02-10 12:20:06 +01001972 * @brief Search in the given siblings for the first schema instance.
1973 * Uses hashes - should be used whenever possible for best performance.
1974 *
1975 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
1976 * @param[in] schema Schema node of the data node to find.
Michal Vaskob104f112020-07-17 09:54:54 +02001977 * @param[in] key_or_value If it is NULL, the first schema node data instance is found. For nodes with many
1978 * instances, it can be set based on the type of @p schema:
Michal Vaskoe444f752020-02-10 12:20:06 +01001979 * LYS_LEAFLIST:
1980 * Searched instance value.
1981 * LYS_LIST:
Michal Vasko90932a92020-02-12 14:33:03 +01001982 * Searched instance key values in the form of "[key1='val1'][key2='val2']...".
1983 * The keys do not have to be ordered but all of them must be set.
1984 *
1985 * Note that any explicit values (leaf-list or list key values) will be canonized first
1986 * before comparison. But values that do not have a canonical value are expected to be in the
1987 * JSON format!
Michal Vaskof03ed032020-03-04 13:31:44 +01001988 * @param[in] val_len Optional length of @p key_or_value in case it is not 0-terminated.
Michal Vasko9b368d32020-02-14 13:53:31 +01001989 * @param[out] match Can be NULL, otherwise the found data node.
Michal Vaskoe444f752020-02-10 12:20:06 +01001990 * @return LY_SUCCESS on success, @p match set.
1991 * @return LY_ENOTFOUND if not found, @p match set to NULL.
1992 * @return LY_EINVAL if @p schema is a key-less list.
1993 * @return LY_ERR value if another error occurred.
1994 */
1995LY_ERR lyd_find_sibling_val(const struct lyd_node *siblings, const struct lysc_node *schema, const char *key_or_value,
Radek Krejci0f969882020-08-21 16:56:47 +02001996 size_t val_len, struct lyd_node **match);
Michal Vaskoe444f752020-02-10 12:20:06 +01001997
Michal Vaskoccc02342020-05-21 10:09:21 +02001998/**
Michal Vaskoe78faec2021-04-08 17:24:43 +02001999 * @brief Search the given siblings for all the exact same instances of a specific node instance. Accepts only nodes
2000 * that are allowed to have several exact same instances. Uses hashes to whatever extent possible.
2001 *
2002 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
2003 * @param[in] target Target node instance to find.
2004 * @param[out] set Set with all the found instances. The first item is always the first instance.
2005 * @return LY_SUCCESS on success, @p set returned.
2006 * @return LY_ENOTFOUND if not found, empty @p set returned.
2007 * @return LY_ERR value if another error occurred.
2008 */
2009LY_ERR lyd_find_sibling_dup_inst_set(const struct lyd_node *siblings, const struct lyd_node *target, struct ly_set **set);
2010
2011/**
Michal Vasko1d4af6c2021-02-22 13:31:26 +01002012 * @brief Search the given siblings for an opaque node with a specific name.
2013 *
2014 * @param[in] first First sibling to consider.
2015 * @param[in] name Opaque node name to find.
2016 * @param[out] match Can be NULL, otherwise the found data node.
2017 * @return LY_SUCCESS on success, @p match set.
2018 * @return LY_ENOTFOUND if not found, @p match set to NULL.
2019 * @return LY_ERR value is an error occurred.
2020 */
2021LY_ERR lyd_find_sibling_opaq_next(const struct lyd_node *first, const char *name, struct lyd_node **match);
2022
2023/**
Michal Vaskoccc02342020-05-21 10:09:21 +02002024 * @brief Search in the given data for instances of nodes matching the provided XPath.
2025 *
Michal Vasko19a30602020-05-25 10:40:19 +02002026 * If a list instance is being selected with all its key values specified (but not necessarily ordered)
2027 * in the form `list[key1='val1'][key2='val2'][key3='val3']` or a leaf-list instance in the form
2028 * `leaf-list[.='val']`, these instances are found using hashes with constant (*O(1)*) complexity
2029 * (unless they are defined in top-level). Other predicates can still follow the aforementioned ones.
2030 *
Michal Vaskoccc02342020-05-21 10:09:21 +02002031 * @param[in] ctx_node XPath context node.
Michal Vasko3e1f6552021-01-14 09:27:55 +01002032 * @param[in] xpath [XPath](@ref howtoXPath) to select.
Michal Vaskoccc02342020-05-21 10:09:21 +02002033 * @param[out] set Set of found data nodes. In case the result is a number, a string, or a boolean,
2034 * the returned set is empty.
2035 * @return LY_SUCCESS on success, @p set is returned.
2036 * @return LY_ERR value if an error occurred.
2037 */
2038LY_ERR lyd_find_xpath(const struct lyd_node *ctx_node, const char *xpath, struct ly_set **set);
2039
Michal Vasko3e1f6552021-01-14 09:27:55 +01002040/**
2041 * @brief Search in given data for a node uniquely identifier by a path.
2042 *
Michal Vasko257bdcf2021-01-14 13:15:30 +01002043 * Always works in constant (*O(1)*) complexity. To be exact, it is *O(n)* where *n* is the depth
2044 * of the path used.
2045 *
Michal Vasko3e1f6552021-01-14 09:27:55 +01002046 * @param[in] ctx_node Path context node.
2047 * @param[in] path [Path](@ref howtoXPath) to find.
2048 * @param[in] output Whether to search in RPC/action output nodes or in input nodes.
2049 * @param[out] match Can be NULL, otherwise the found data node.
2050 * @return LY_SUCCESS on success, @p match is set to the found node.
2051 * @return LY_EINCOMPLETE if only a parent of the node was found, @p match is set to this parent node.
2052 * @return LY_ENOTFOUND if no nodes in the path were found.
2053 * @return LY_ERR on other errors.
2054 */
2055LY_ERR lyd_find_path(const struct lyd_node *ctx_node, const char *path, ly_bool output, struct lyd_node **match);
2056
Radek Krejcie7b95092019-05-15 11:03:07 +02002057#ifdef __cplusplus
2058}
2059#endif
2060
2061#endif /* LY_TREE_DATA_H_ */