blob: 9b40e6f7b03d0bf5cc489f32ddada1928758a907 [file] [log] [blame]
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001/**
2 * @file tree_schema.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief libyang representation of YANG schema trees.
5 *
6 * Copyright (c) 2015 - 2018 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_SCHEMA_H_
16#define LY_TREE_SCHEMA_H_
17
Radek Krejci54579462019-04-30 12:47:06 +020018#define PCRE2_CODE_UNIT_WIDTH 8
19
20#include <pcre2.h>
Radek Krejci535ea9f2020-05-29 16:01:05 +020021
Radek Krejci5aeea3a2018-09-05 13:29:36 +020022#include <stdint.h>
Radek Krejcid3ca0632019-04-16 16:54:54 +020023#include <stdio.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020024
Michal Vaskobabf0bd2021-08-31 14:55:39 +020025#include "config.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020026#include "log.h"
27#include "tree.h"
Radek Krejcice8c1592018-10-29 15:35:51 +010028
Radek Krejci70853c52018-10-15 14:46:16 +020029#ifdef __cplusplus
30extern "C" {
31#endif
32
Radek Krejcica376bd2020-06-11 16:04:06 +020033struct ly_ctx;
Radek Krejci47fab892020-11-05 17:02:41 +010034struct ly_path;
Radek Krejcica376bd2020-06-11 16:04:06 +020035struct ly_set;
Radek Krejci47fab892020-11-05 17:02:41 +010036struct lys_module;
37struct lysc_node;
38struct lyxp_expr;
Radek Krejcica376bd2020-06-11 16:04:06 +020039
Radek Krejci5aeea3a2018-09-05 13:29:36 +020040/**
Radek Krejci8678fa42020-08-18 16:07:28 +020041 * @page howtoSchema YANG Modules
42 *
43 * To be able to work with YANG data instances, libyang has to represent YANG data models. All the processed modules are stored
44 * in libyang [context](@ref howtoContext) and loaded using [parser functions](@ref howtoSchemaParsers). It means, that there is
45 * no way to create/change YANG module programmatically. However, all the YANG model definitions are available and can be examined
46 * through the C structures. All the context's modules together form YANG Schema for the data being instantiated.
47 *
48 * Any YANG module is represented as ::lys_module. In fact, the module is represented in two different formats. As ::lys_module.parsed,
49 * there is a parsed schema reflecting the source YANG module. It is exactly what is read from the input. This format is good for
50 * converting from one format to another (YANG to YIN and vice versa), but it is not very useful for validating/manipulating YANG
51 * data. Therefore, there is ::lys_module.compiled storing the compiled YANG module. It is based on the parsed module, but all the
52 * references are resolved. It means that, for example, there are no `grouping`s or `typedef`s since they are supposed to be placed instead of
53 * `uses` or `type` references. This split also means, that the YANG module is fully validated after compilation of the parsed
54 * representation of the module. YANG submodules are available only in the parsed representation. When a submodule is compiled, it
55 * is fully integrated into its main module.
56 *
57 * The context can contain even modules without the compiled representation. Such modules are still useful as imports of other
58 * modules. The grouping or typedef definition can be even compiled into the importing modules. This is actually the main
59 * difference between the imported and implemented modules in the libyang context. The implemented modules are compiled while the
60 * imported modules are only parsed.
61 *
Radek Krejcib100b192020-10-26 08:37:45 +010062 * By default, the module is implemented (and compiled) in case it is explicitly loaded or referenced in another module as
63 * target of leafref, augment or deviation. This behavior can be changed via context options ::LY_CTX_ALL_IMPLEMENTED, when
64 * all the modules in the context are marked as implemented (note the problem with multiple revisions of a single module),
65 * or by ::LY_CTX_REF_IMPLEMENTED option, extending the set of references making the module implemented by when, must and
66 * default statements.
Radek Krejci8678fa42020-08-18 16:07:28 +020067 *
68 * All modules with deviation definition are always marked as implemented. The imported (not implemented) module can be set implemented by ::lys_set_implemented(). But
69 * the implemented module cannot be changed back to just imported module. Note also that only one revision of a specific module
70 * can be implemented in a single context. The imported modules are used only as a
71 * source of definitions for types and groupings for uses statements. The data in such modules are ignored - caller
72 * is not allowed to create the data (including instantiating identities) defined in the model via data parsers,
73 * the default nodes are not added into any data tree and mandatory nodes are not checked in the data trees.
74 *
Michal Vasko14ed9cd2021-01-28 14:16:25 +010075 * The compiled schema tree nodes are able to hold private objects (::lysc_node.priv as a pointer to a structure,
aPiecek9922ea92021-04-12 07:59:20 +020076 * function, variable, ...) used by a caller application unless ::LY_CTX_SET_PRIV_PARSED is set, in that case
77 * the ::lysc_node.priv pointers are used by libyang.
Radek Krejci8678fa42020-08-18 16:07:28 +020078 * Note that the object is not freed by libyang when the context is being destroyed. So the caller is responsible
79 * for freeing the provided structure after the context is destroyed or the private pointer is set to NULL in
Radek Krejci90ed21e2021-04-12 14:47:46 +020080 * appropriate schema nodes where the object was previously set. Also ::lysc_tree_dfs_full() can be useful to manage
81 * the private data.
Radek Krejci8678fa42020-08-18 16:07:28 +020082 *
83 * Despite all the schema structures and their members are available as part of the libyang API and callers can use
84 * it to navigate through the schema tree structure or to obtain various information, we recommend to use the following
85 * macros for the specific actions.
86 * - ::LYSC_TREE_DFS_BEGIN and ::LYSC_TREE_DFS_END to traverse the schema tree (depth-first).
87 * - ::LY_LIST_FOR and ::LY_ARRAY_FOR as described on @ref howtoStructures page.
88 *
89 * Further information about modules handling can be found on the following pages:
90 * - @subpage howtoSchemaParsers
91 * - @subpage howtoSchemaFeatures
92 * - @subpage howtoPlugins
93 * - @subpage howtoSchemaPrinters
94 *
95 * \note There are many functions to access information from the schema trees. Details are available in
96 * the [Schema Tree module](@ref schematree).
97 *
98 * For information about difference between implemented and imported modules, see the
99 * [context description](@ref howtoContext).
100 *
101 * Functions List (not assigned to above subsections)
102 * --------------------------------------------------
103 * - ::lys_getnext()
104 * - ::lys_nodetype2str()
105 * - ::lys_set_implemented()
Radek Krejci8678fa42020-08-18 16:07:28 +0200106 *
Michal Vaskod5cfa6e2020-11-23 16:56:08 +0100107 * - ::lysc_has_when()
108 *
Michal Vasko544e58a2021-01-28 14:33:41 +0100109 * - ::lysc_node_child()
Radek Krejci8678fa42020-08-18 16:07:28 +0200110 * - ::lysc_node_actions()
111 * - ::lysc_node_notifs()
112 *
Michal Vasko544e58a2021-01-28 14:33:41 +0100113 * - ::lysp_node_child()
Radek Krejci8678fa42020-08-18 16:07:28 +0200114 * - ::lysp_node_actions()
115 * - ::lysp_node_notifs()
116 * - ::lysp_node_groupings()
117 * - ::lysp_node_typedefs()
118 */
119
120/**
121 * @page howtoSchemaFeatures YANG Features
122 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100123 * YANG feature statement is an important part of the language which can significantly affect the meaning of the schemas.
124 * Modifying features may have similar effects as loading/removing schema from the context so it is limited to context
125 * preparation period before working with data. YANG features, respectively their use in if-feature
126 * statements, are evaluated as part of schema compilation so a feature-specific compiled schema tree is generated
127 * as a result.
Radek Krejci8678fa42020-08-18 16:07:28 +0200128 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100129 * To enable any features, they must currently be specified when implementing a new schema with ::lys_parse() or
130 * ::ly_ctx_load_module(). To later examine what the status of a feature is, check its ::LYS_FENABLED flag or
131 * search for it first with ::lys_feature_value(). Lastly, to evaluate compiled if-features, use ::lysc_iffeature_value().
Radek Krejci8678fa42020-08-18 16:07:28 +0200132 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100133 * To iterate over all features of a particular YANG module, use ::lysp_feature_next().
Radek Krejci8678fa42020-08-18 16:07:28 +0200134 *
135 * Note, that the feature's state can affect some of the output formats (e.g. Tree format).
136 *
137 * Functions List
138 * --------------
Radek Krejci8678fa42020-08-18 16:07:28 +0200139 * - ::lys_feature_value()
Radek Krejci8678fa42020-08-18 16:07:28 +0200140 * - ::lysc_iffeature_value()
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100141 * - ::lysp_feature_next()
Radek Krejci8678fa42020-08-18 16:07:28 +0200142 */
143
144/**
Radek Krejci2ff0d572020-05-21 15:27:28 +0200145 * @ingroup trees
Radek Krejci8678fa42020-08-18 16:07:28 +0200146 * @defgroup schematree Schema Tree
Radek Krejci2ff0d572020-05-21 15:27:28 +0200147 * @{
148 *
149 * Data structures and functions to manipulate and access schema tree.
150 */
151
Michal Vasko64246d82020-08-19 12:35:00 +0200152/* *INDENT-OFF* */
153
Radek Krejci2ff0d572020-05-21 15:27:28 +0200154/**
Michal Vasko208a04a2020-10-21 15:17:12 +0200155 * @brief Macro to iterate via all elements in a schema (sub)tree including input and output.
156 * Note that __actions__ and __notifications__ of traversed nodes __are ignored__! To traverse
157 * on all the nodes including those, use ::lysc_tree_dfs_full() instead.
158 *
159 * This is the opening part to the #LYSC_TREE_DFS_END - they always have to be used together.
Radek Krejci0935f412019-08-20 16:15:18 +0200160 *
161 * The function follows deep-first search algorithm:
162 * <pre>
163 * 1
164 * / \
165 * 2 4
166 * / / \
167 * 3 5 6
168 * </pre>
169 *
170 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
Radek Krejci2a9fc652021-01-22 17:44:34 +0100171 * START can be any of the lysc_node* types (including lysc_node_action and lysc_node_notif),
Radek Krejci0935f412019-08-20 16:15:18 +0200172 * ELEM variable must be of the struct lysc_node* type.
173 *
174 * To skip a particular subtree, instead of the continue statement, set LYSC_TREE_DFS_continue
175 * variable to non-zero value.
176 *
177 * Use with opening curly bracket '{' after the macro.
178 *
179 * @param START Pointer to the starting element processed first.
180 * @param ELEM Iterator intended for use in the block.
181 */
182#define LYSC_TREE_DFS_BEGIN(START, ELEM) \
Radek Krejci857189e2020-09-01 13:26:36 +0200183 { ly_bool LYSC_TREE_DFS_continue = 0; struct lysc_node *LYSC_TREE_DFS_next; \
Michal Vasko14ed9cd2021-01-28 14:16:25 +0100184 for ((ELEM) = (LYSC_TREE_DFS_next) = (struct lysc_node *)(START); \
Radek Krejci0935f412019-08-20 16:15:18 +0200185 (ELEM); \
186 (ELEM) = (LYSC_TREE_DFS_next), LYSC_TREE_DFS_continue = 0)
187
188/**
189 * @brief Macro to iterate via all elements in a (sub)tree. This is the closing part
190 * to the #LYSC_TREE_DFS_BEGIN - they always have to be used together.
191 *
192 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
Radek Krejci2a9fc652021-01-22 17:44:34 +0100193 * START can be a pointer to any of the lysc_node* types (including lysc_node_action and lysc_node_notif),
Radek Krejci0935f412019-08-20 16:15:18 +0200194 * ELEM variable must be pointer to the lysc_node type.
195 *
196 * Use with closing curly bracket '}' after the macro.
197 *
198 * @param START Pointer to the starting element processed first.
199 * @param ELEM Iterator intended for use in the block.
200 */
Radek Krejci0935f412019-08-20 16:15:18 +0200201#define LYSC_TREE_DFS_END(START, ELEM) \
202 /* select element for the next run - children first */ \
203 if (LYSC_TREE_DFS_continue) { \
204 (LYSC_TREE_DFS_next) = NULL; \
205 } else { \
Michal Vasko544e58a2021-01-28 14:33:41 +0100206 (LYSC_TREE_DFS_next) = (struct lysc_node *)lysc_node_child(ELEM); \
Michal Vasko208a04a2020-10-21 15:17:12 +0200207 } \
Radek Krejci0935f412019-08-20 16:15:18 +0200208 if (!(LYSC_TREE_DFS_next)) { \
Michal Vasko208a04a2020-10-21 15:17:12 +0200209 /* no children, try siblings */ \
210 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
Radek Krejci0935f412019-08-20 16:15:18 +0200211 } \
212 while (!(LYSC_TREE_DFS_next)) { \
213 /* parent is already processed, go to its sibling */ \
Radek Krejci7d95fbb2021-01-26 17:33:13 +0100214 (ELEM) = (ELEM)->parent; \
Michal Vasko208a04a2020-10-21 15:17:12 +0200215 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
216 } }
217
218/**
219 * @brief Helper macro for #LYSC_TREE_DFS_END, should not be used directly!
220 */
221#define _LYSC_TREE_DFS_NEXT(START, ELEM, NEXT) \
222 if ((ELEM) == (struct lysc_node *)(START)) { \
223 /* we are done, no next element to process */ \
224 break; \
225 } \
Michal Vasko544e58a2021-01-28 14:33:41 +0100226 (NEXT) = (ELEM)->next;
Radek Krejci0935f412019-08-20 16:15:18 +0200227
Michal Vasko64246d82020-08-19 12:35:00 +0200228/* *INDENT-ON* */
229
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200230#define LY_REV_SIZE 11 /**< revision data string length (including terminating NULL byte) */
231
Radek Krejcide7a9c42021-03-10 13:13:06 +0100232/**
233 * @defgroup schemanodetypes Schema Node Types
234 * Values of the ::lysp_node.nodetype and ::lysc_node.nodetype members.
235 * @{
236 */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200237#define LYS_UNKNOWN 0x0000 /**< uninitalized unknown statement node */
238#define LYS_CONTAINER 0x0001 /**< container statement node */
239#define LYS_CHOICE 0x0002 /**< choice statement node */
240#define LYS_LEAF 0x0004 /**< leaf statement node */
241#define LYS_LEAFLIST 0x0008 /**< leaf-list statement node */
242#define LYS_LIST 0x0010 /**< list statement node */
243#define LYS_ANYXML 0x0020 /**< anyxml statement node */
244#define LYS_ANYDATA 0x0060 /**< anydata statement node, in tests it can be used for both #LYS_ANYXML and #LYS_ANYDATA */
245#define LYS_CASE 0x0080 /**< case statement node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200246
Michal Vasko7f45cf22020-10-01 12:49:44 +0200247#define LYS_RPC 0x0100 /**< RPC statement node */
248#define LYS_ACTION 0x0200 /**< action statement node */
249#define LYS_NOTIF 0x0400 /**< notification statement node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200250
Michal Vasko7f45cf22020-10-01 12:49:44 +0200251#define LYS_USES 0x0800 /**< uses statement node */
252#define LYS_INPUT 0x1000 /**< RPC/action input node */
253#define LYS_OUTPUT 0x2000 /**< RPC/action output node */
254#define LYS_GROUPING 0x4000
255#define LYS_AUGMENT 0x8000
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100256
Radek Krejcif13b87b2020-12-01 22:02:17 +0100257#define LYS_NODETYPE_MASK 0xffff /**< Mask for nodetypes, the value is limited for 16 bits */
Radek Krejcide7a9c42021-03-10 13:13:06 +0100258/** @} schemanodetypes */
Radek Krejcif13b87b2020-12-01 22:02:17 +0100259
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200260/**
Radek Krejci61837f72021-03-02 19:53:59 +0100261 * @brief Generic test for operation statements.
262 *
263 * This macro matches a subset of schema nodes that maps to common ::lysc_node or ::lysp_node structures. To match all
264 * such nodes, use ::LY_STMT_IS_NODE()
265 *
266 * This macro matches action and RPC.
Radek Krejci6b88a462021-02-17 12:39:34 +0100267 */
268#define LY_STMT_IS_OP(STMT) (((STMT) == LY_STMT_ACTION) || ((STMT) == LY_STMT_RPC))
269
270/**
Radek Krejci61837f72021-03-02 19:53:59 +0100271 * @brief Generic test for schema data nodes.
Radek Krejci6b88a462021-02-17 12:39:34 +0100272 *
Radek Krejci61837f72021-03-02 19:53:59 +0100273 * This macro matches a subset of schema nodes that maps to common ::lysc_node or ::lysp_node structures. To match all
274 * such nodes, use ::LY_STMT_IS_NODE()
Radek Krejci6b88a462021-02-17 12:39:34 +0100275 *
Radek Krejci61837f72021-03-02 19:53:59 +0100276 * This macro matches anydata, anyxml, augment, case, choice, container, grouping, leaf, leaf-list, list and uses. Note
277 * that the list of statements that can appear in parsed or compiled schema trees differs (e.g. no uses in compiled tree).
Radek Krejci6b88a462021-02-17 12:39:34 +0100278 */
Radek Krejci61837f72021-03-02 19:53:59 +0100279#define LY_STMT_IS_DATA_NODE(STMT) (((STMT) >= LY_STMT_ANYDATA) && ((STMT) <= LY_STMT_LIST))
280
281/**
282 * @brief Generic test for any schema node that maps to common ::lysc_node or ::lysp_node structures.
283 *
284 * Note that the list of statements that can appear in parsed or compiled schema trees differs (e.g. no uses in compiled tree).
285 *
286 * To check for some of the subsets of this test, try ::LY_STMT_IS_DATA_NODE() or ::LY_STMT_IS_OP().
287 *
288 * This macro matches action, anydata, anyxml, augment, case, choice, container, grouping, input, leaf, leaf-list, list,
289 * notification, output, RPC and uses.
290 */
291#define LY_STMT_IS_NODE(STMT) (((STMT) >= LY_STMT_NOTIFICATION) && ((STMT) <= LY_STMT_LIST))
Radek Krejci6b88a462021-02-17 12:39:34 +0100292
293/**
Radek Krejcid6b76452019-09-03 17:03:03 +0200294 * @brief List of YANG statements
295 */
296enum ly_stmt {
297 LY_STMT_NONE = 0,
Radek Krejci6b88a462021-02-17 12:39:34 +0100298
299 LY_STMT_NOTIFICATION, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node_notif *`.
300 The RPCs/Actions and Notifications are expected in a separated lists than the rest of
301 data definition nodes as it is done in generic structures of libyang. */
Radek Krejci61837f72021-03-02 19:53:59 +0100302 LY_STMT_INPUT,
303 LY_STMT_OUTPUT,
Radek Krejci6b88a462021-02-17 12:39:34 +0100304
305/* LY_STMT_IS_OP */
Radek Krejcieccf6602021-02-05 19:42:54 +0100306 LY_STMT_ACTION, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node_action *`.
Radek Krejci6b88a462021-02-17 12:39:34 +0100307 The RPCs/Actions and Notifications are expected in a separated lists than the rest of
308 data definition nodes as it is done in generic structures of libyang. */
309 LY_STMT_RPC, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node_action *`.
310 The RPCs/Actions and Notifications are expected in a separated lists than the rest of
311 data definition nodes as it is done in generic structures of libyang. */
312
Radek Krejci61837f72021-03-02 19:53:59 +0100313/* LY_STMT_IS_DATA_NODE */
Radek Krejcieccf6602021-02-05 19:42:54 +0100314 LY_STMT_ANYDATA, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
Radek Krejci6b88a462021-02-17 12:39:34 +0100315 Note that due to ::lysc_node compatibility the anydata is expected to be actually
316 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
317 Notifications are expected in a separated lists as it is done in generic structures
318 of libyang. */
Radek Krejcieccf6602021-02-05 19:42:54 +0100319 LY_STMT_ANYXML, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
Radek Krejci6b88a462021-02-17 12:39:34 +0100320 Note that due to ::lysc_node compatibility the anyxml is expected to be actually
321 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
322 Notifications are expected in a separated lists as it is done in generic structures
323 of libyang. */
324 LY_STMT_AUGMENT,
325 LY_STMT_CASE, /**< TODO is it possible to compile cases without the parent choice? */
326 LY_STMT_CHOICE, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
327 Note that due to ::lysc_node compatibility the choice is expected to be actually
328 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
329 Notifications are expected in a separated lists as it is done in generic structures
330 of libyang. */
331 LY_STMT_CONTAINER, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
332 Note that due to ::lysc_node compatibility the container is expected to be actually
333 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
334 Notifications are expected in a separated lists as it is done in generic structures
335 of libyang. */
336 LY_STMT_GROUPING,
337 LY_STMT_LEAF, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
338 Note that due to ::lysc_node compatibility the leaf is expected to be actually
339 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
340 Notifications are expected in a separated lists as it is done in generic structures
341 of libyang. */
342 LY_STMT_LEAF_LIST, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
343 Note that due to ::lysc_node compatibility the leaf-list is expected to be actually
344 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
345 Notifications are expected in a separated lists as it is done in generic structures
346 of libyang. */
347 LY_STMT_LIST, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
348 Note that due to ::lysc_node compatibility the list is expected to be actually
349 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
350 Notifications are expected in a separated lists as it is done in generic structures
351 of libyang. */
352 LY_STMT_USES,
353
354/* rest */
Radek Krejcid6b76452019-09-03 17:03:03 +0200355 LY_STMT_ARGUMENT,
Radek Krejcid6b76452019-09-03 17:03:03 +0200356 LY_STMT_BASE,
357 LY_STMT_BELONGS_TO,
358 LY_STMT_BIT,
Radek Krejcieccf6602021-02-05 19:42:54 +0100359 LY_STMT_CONFIG, /**< in ::lysc_ext_substmt.storage stored as a pointer to `uint16_t`, only cardinality < #LY_STMT_CARD_SOME is allowed */
Radek Krejcid6b76452019-09-03 17:03:03 +0200360 LY_STMT_CONTACT,
Radek Krejcieccf6602021-02-05 19:42:54 +0100361 LY_STMT_DEFAULT,
Radek Krejci6b88a462021-02-17 12:39:34 +0100362 LY_STMT_DESCRIPTION, /**< in ::lysc_ext_substmt.storage stored as a pointer to `const char *` (cardinality < #LY_STMT_CARD_SOME)
363 or as a pointer to a [sized array](@ref sizedarrays) `const char **` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200364 LY_STMT_DEVIATE,
365 LY_STMT_DEVIATION,
366 LY_STMT_ENUM,
367 LY_STMT_ERROR_APP_TAG,
368 LY_STMT_ERROR_MESSAGE,
369 LY_STMT_EXTENSION,
Radek Krejcieccf6602021-02-05 19:42:54 +0100370 LY_STMT_EXTENSION_INSTANCE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200371 LY_STMT_FEATURE,
372 LY_STMT_FRACTION_DIGITS,
Radek Krejcid6b76452019-09-03 17:03:03 +0200373 LY_STMT_IDENTITY,
Radek Krejci6b88a462021-02-17 12:39:34 +0100374 LY_STMT_IF_FEATURE, /**< if-feature statements are not compiled, they are evaluated and the parent statement is
375 preserved only in case the evaluation of all the if-feature statements is true.
376 Therefore there is no storage expected. */
Radek Krejcid6b76452019-09-03 17:03:03 +0200377 LY_STMT_IMPORT,
378 LY_STMT_INCLUDE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200379 LY_STMT_KEY,
Radek Krejcid6b76452019-09-03 17:03:03 +0200380 LY_STMT_LENGTH,
Radek Krejcieccf6602021-02-05 19:42:54 +0100381 LY_STMT_MANDATORY, /**< in ::lysc_ext_substmt.storage stored as a pointer to `uint16_t`, only cardinality < #LY_STMT_CARD_SOME is allowed */
Radek Krejcid6b76452019-09-03 17:03:03 +0200382 LY_STMT_MAX_ELEMENTS,
383 LY_STMT_MIN_ELEMENTS,
384 LY_STMT_MODIFIER,
385 LY_STMT_MODULE,
386 LY_STMT_MUST,
387 LY_STMT_NAMESPACE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200388 LY_STMT_ORDERED_BY,
389 LY_STMT_ORGANIZATION,
Radek Krejcid6b76452019-09-03 17:03:03 +0200390 LY_STMT_PATH,
391 LY_STMT_PATTERN,
392 LY_STMT_POSITION,
393 LY_STMT_PREFIX,
394 LY_STMT_PRESENCE,
395 LY_STMT_RANGE,
Radek Krejci6b88a462021-02-17 12:39:34 +0100396 LY_STMT_REFERENCE, /**< in ::lysc_ext_substmt.storage stored as a pointer to `const char *` (cardinality < #LY_STMT_CARD_SOME)
397 or as a pointer to a [sized array](@ref sizedarrays) `const char **` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200398 LY_STMT_REFINE,
399 LY_STMT_REQUIRE_INSTANCE,
400 LY_STMT_REVISION,
401 LY_STMT_REVISION_DATE,
Radek Krejcieccf6602021-02-05 19:42:54 +0100402 LY_STMT_STATUS, /**< in ::lysc_ext_substmt.storage stored as a pointer to `uint16_t`, only cardinality < #LY_STMT_CARD_SOME is allowed */
Radek Krejcid6b76452019-09-03 17:03:03 +0200403 LY_STMT_SUBMODULE,
Radek Krejcieccf6602021-02-05 19:42:54 +0100404 LY_STMT_TYPE, /**< in ::lysc_ext_substmt.storage stored as a pointer to `struct lysc_type *` (cardinality < #LY_STMT_CARD_SOME)
405 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_type **` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200406 LY_STMT_TYPEDEF,
407 LY_STMT_UNIQUE,
Radek Krejcieccf6602021-02-05 19:42:54 +0100408 LY_STMT_UNITS, /**< in ::lysc_ext_substmt.storage stored as a pointer to `const char *` (cardinality < #LY_STMT_CARD_SOME)
409 or as a pointer to a [sized array](@ref sizedarrays) `const char **` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200410 LY_STMT_VALUE,
411 LY_STMT_WHEN,
412 LY_STMT_YANG_VERSION,
Radek Krejci2b0f0f12021-03-02 16:02:35 +0100413 LY_STMT_YIN_ELEMENT,
414
415 /* separated from the list of statements
416 * the following tokens are part of the syntax and parsers have to work
417 * with them, but they are not a standard YANG statements
418 */
419 LY_STMT_SYNTAX_SEMICOLON,
420 LY_STMT_SYNTAX_LEFT_BRACE,
421 LY_STMT_SYNTAX_RIGHT_BRACE,
422
423 /*
424 * YIN-specific tokens, still they are part of the syntax, but not the standard statements
425 */
426 LY_STMT_ARG_TEXT,
427 LY_STMT_ARG_VALUE
Radek Krejcid6b76452019-09-03 17:03:03 +0200428};
429
430/**
Radek Krejcif8ca8192021-03-02 16:50:06 +0100431 * @brief Stringify statement identifier.
432 * @param[in] stmt The statement identifier to stringify.
433 * @return Constant string representation of the given @p stmt.
434 */
435const char *ly_stmt2str(enum ly_stmt stmt);
436
437/**
Radek Krejci39b7fc22021-02-26 23:29:18 +0100438 * @brief Convert nodetype to statement identifier
439 * @param[in] nodetype Nodetype to convert.
440 * @return Statement identifier representing the given @p nodetype.
441 */
442enum ly_stmt lys_nodetype2stmt(uint16_t nodetype);
443
444/**
Radek Krejcib1c11532021-03-29 14:14:19 +0200445 * @brief Possible cardinalities of the YANG statements.
446 *
447 * Used in extensions plugins to define cardinalities of the extension instance substatements.
448 */
449enum ly_stmt_cardinality {
450 LY_STMT_CARD_OPT, /* 0..1 */
451 LY_STMT_CARD_MAND, /* 1 */
452 LY_STMT_CARD_SOME, /* 1..n */
453 LY_STMT_CARD_ANY /* 0..n */
454};
455
456/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200457 * @brief YANG import-stmt
458 */
459struct lysp_import {
Radek Krejci086c7132018-10-26 15:29:04 +0200460 struct lys_module *module; /**< pointer to the imported module
461 (mandatory, but resolved when the referring module is completely parsed) */
462 const char *name; /**< name of the imported module (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200463 const char *prefix; /**< prefix for the data from the imported schema (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200464 const char *dsc; /**< description */
465 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200466 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100467 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200468 char rev[LY_REV_SIZE]; /**< revision-date of the imported module */
469};
470
471/**
472 * @brief YANG include-stmt
473 */
474struct lysp_include {
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100475 struct lysp_submodule *submodule;/**< pointer to the parsed submodule structure
Radek Krejci086c7132018-10-26 15:29:04 +0200476 (mandatory, but resolved when the referring module is completely parsed) */
477 const char *name; /**< name of the included submodule (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200478 const char *dsc; /**< description */
479 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200480 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200481 char rev[LY_REV_SIZE]; /**< revision-date of the included submodule */
Radek Krejci771928a2021-01-19 13:42:36 +0100482 ly_bool injected; /**< flag to mark includes copied into main module from submodules,
483 only for backward compatibility with YANG 1.0, which does not require the
484 main module to include all submodules. */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200485};
486
487/**
488 * @brief YANG extension-stmt
489 */
490struct lysp_ext {
491 const char *name; /**< extension name */
Radek Krejci9f87b0c2021-03-05 14:45:26 +0100492 const char *argname; /**< argument name, NULL if not specified */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200493 const char *dsc; /**< description statement */
494 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200495 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200496 uint16_t flags; /**< LYS_STATUS_* and LYS_YINELEM_* values (@ref snodeflags) */
Michal Vasko5fe75f12020-03-02 13:52:37 +0100497
Radek Krejci720d2612021-03-03 19:44:22 +0100498 struct lysc_ext *compiled; /**< pointer to the compiled extension definition.
499 The extension definition is compiled only if there is compiled extension instance,
500 otherwise this pointer remains NULL. The compiled extension definition is shared
501 among all extension instances. */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200502};
503
504/**
505 * @brief Helper structure for generic storage of the extension instances content.
506 */
507struct lysp_stmt {
508 const char *stmt; /**< identifier of the statement */
509 const char *arg; /**< statement's argument */
Radek Krejci8df109d2021-04-23 12:19:08 +0200510 LY_VALUE_FORMAT format; /**< prefix format of the identifier/argument (::LY_VALUE_XML is YIN format) */
Radek Krejci0b013302021-03-29 15:22:32 +0200511 void *prefix_data; /**< Format-specific data for prefix resolution (see ly_resolve_prefix()) */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100512
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200513 struct lysp_stmt *next; /**< link to the next statement */
Michal Vaskobc2559f2018-09-07 10:17:50 +0200514 struct lysp_stmt *child; /**< list of the statement's substatements (linked list) */
David Sedlákb9d75c42019-08-14 10:49:42 +0200515 uint16_t flags; /**< statement flags, can be set to LYS_YIN_ATTR */
Radek Krejci335332a2019-09-05 13:03:35 +0200516 enum ly_stmt kw; /**< numeric respresentation of the stmt value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200517};
518
David Sedlákae4b4512019-08-14 10:45:56 +0200519#define LYS_YIN 0x1 /**< used to specify input format of extension instance */
520
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200521/**
522 * @brief YANG extension instance
523 */
524struct lysp_ext_instance {
David Sedlákbbd06ca2019-06-27 14:15:38 +0200525 const char *name; /**< extension identifier, including possible prefix */
526 const char *argument; /**< optional value of the extension's argument */
aPiecek60d9d672021-04-27 15:49:57 +0200527 LY_VALUE_FORMAT format; /**< prefix format of the extension name/argument (::LY_VALUE_XML is YIN format) */
528 struct lysp_node *parsed; /**< Simply parsed (unresolved) YANG schema tree serving as a cache.
529 Only lys_compile_extension_instance() can set this. */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100530 void *prefix_data; /**< Format-specific data for prefix resolution
Radek Krejci0b013302021-03-29 15:22:32 +0200531 (see ly_resolve_prefix()) */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100532
Radek Krejci5f9a3672021-03-05 21:35:22 +0100533 struct lysp_stmt *child; /**< list of the extension's substatements (linked list) */
534
Radek Krejci335332a2019-09-05 13:03:35 +0200535 void *parent; /**< pointer to the parent element holding the extension instance(s), use
Radek Krejciab430862021-03-02 20:13:40 +0100536 ::lysp_ext_instance#parent_stmt to access the schema element */
Radek Krejciab430862021-03-02 20:13:40 +0100537 enum ly_stmt parent_stmt; /**< value identifying placement of the extension instance */
538 LY_ARRAY_COUNT_TYPE parent_stmt_index; /**< in case the instance is in a substatement, this identifies
539 the index of that substatement in its [sized array](@ref sizedarrays) (if any) */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100540 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200541};
542
543/**
544 * @brief YANG feature-stmt
545 */
546struct lysp_feature {
547 const char *name; /**< feature name (mandatory) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100548 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
549 struct lysc_iffeature *iffeatures_c; /**< compiled if-features */
550 struct lysp_feature **depfeatures; /**< list of pointers to other features depending on this one
551 ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200552 const char *dsc; /**< description statement */
553 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200554 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100555 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values and
556 LYS_FENABLED are allowed */
557};
558
559/**
560 * @brief Compiled YANG if-feature-stmt
561 */
562struct lysc_iffeature {
563 uint8_t *expr; /**< 2bits array describing the if-feature expression in prefix format, see @ref ifftokens */
564 struct lysp_feature **features; /**< array of pointers to the features used in expression ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200565};
566
567/**
Michal Vasko7f45cf22020-10-01 12:49:44 +0200568 * @brief Qualified name (optional prefix followed by an identifier).
569 */
570struct lysp_qname {
571 const char *str; /**< qualified name string */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200572 const struct lysp_module *mod; /**< module to resolve any prefixes found in the string, it must be
Michal Vasko7f45cf22020-10-01 12:49:44 +0200573 stored explicitly because of deviations/refines */
574};
575
576/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200577 * @brief YANG identity-stmt
578 */
579struct lysp_ident {
580 const char *name; /**< identity name (mandatory), including possible prefix */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200581 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200582 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200583 const char *dsc; /**< description statement */
584 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200585 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200586 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
587};
588
Michal Vasko71e64ca2018-09-07 16:30:29 +0200589/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200590 * @brief Covers restrictions: range, length, pattern, must
591 */
592struct lysp_restr {
Radek Krejcif13b87b2020-12-01 22:02:17 +0100593#define LYSP_RESTR_PATTERN_ACK 0x06
594#define LYSP_RESTR_PATTERN_NACK 0x15
Michal Vasko7f45cf22020-10-01 12:49:44 +0200595 struct lysp_qname arg; /**< The restriction expression/value (mandatory);
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200596 in case of pattern restriction, the first byte has a special meaning:
597 0x06 (ACK) for regular match and 0x15 (NACK) for invert-match */
598 const char *emsg; /**< error-message */
599 const char *eapptag; /**< error-app-tag value */
600 const char *dsc; /**< description */
601 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200602 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200603};
604
605/**
Michal Vasko71e64ca2018-09-07 16:30:29 +0200606 * @brief YANG revision-stmt
607 */
608struct lysp_revision {
Radek Krejcicb3e6472021-01-06 08:19:01 +0100609 char date[LY_REV_SIZE]; /**< revision date (madatory) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200610 const char *dsc; /**< description statement */
611 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200612 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200613};
614
615/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200616 * @brief Enumeration/Bit value definition
617 */
618struct lysp_type_enum {
619 const char *name; /**< name (mandatory) */
620 const char *dsc; /**< description statement */
621 const char *ref; /**< reference statement */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200622 int64_t value; /**< enum's value or bit's position */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200623 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200624 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200625 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
626 values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200627};
628
629/**
630 * @brief YANG type-stmt
631 *
632 * Some of the items in the structure may be mandatory, but it is necessary to resolve the type's base type first
633 */
634struct lysp_type {
635 const char *name; /**< name of the type (mandatory) */
636 struct lysp_restr *range; /**< allowed values range - numerical, decimal64 */
637 struct lysp_restr *length; /**< allowed length of the value - string, binary */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200638 struct lysp_restr *patterns; /**< list of patterns ([sized array](@ref sizedarrays)) - string */
639 struct lysp_type_enum *enums; /**< list of enum-stmts ([sized array](@ref sizedarrays)) - enum */
640 struct lysp_type_enum *bits; /**< list of bit-stmts ([sized array](@ref sizedarrays)) - bits */
Michal Vasko004d3152020-06-11 19:59:22 +0200641 struct lyxp_expr *path; /**< parsed path - leafref */
Radek Krejci151a5b72018-10-19 14:21:44 +0200642 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) - identityref */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200643 struct lysp_type *types; /**< list of sub-types ([sized array](@ref sizedarrays)) - union */
644 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200645
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200646 const struct lysp_module *pmod; /**< (sub)module where the type is defined (needed for deviations) */
Radek Krejci2167ee12018-11-02 16:09:07 +0100647 struct lysc_type *compiled; /**< pointer to the compiled type */
648
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200649 uint8_t fraction_digits; /**< number of fraction digits - decimal64 */
650 uint8_t require_instance; /**< require-instance flag - leafref, instance */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100651 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200652};
653
654/**
655 * @brief YANG typedef-stmt
656 */
657struct lysp_tpdf {
658 const char *name; /**< name of the newly defined type (mandatory) */
659 const char *units; /**< units of the newly defined type */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200660 struct lysp_qname dflt; /**< default value of the newly defined type, it may or may not be a qualified name */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200661 const char *dsc; /**< description statement */
662 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200663 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200664 struct lysp_type type; /**< base type from which the typedef is derived (mandatory) */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100665 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200666};
667
668/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200669 * @brief YANG when-stmt
670 */
671struct lysp_when {
672 const char *cond; /**< specified condition (mandatory) */
673 const char *dsc; /**< description statement */
674 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200675 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200676};
677
678/**
679 * @brief YANG refine-stmt
680 */
681struct lysp_refine {
682 const char *nodeid; /**< target descendant schema nodeid (mandatory) */
683 const char *dsc; /**< description statement */
684 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200685 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200686 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200687 const char *presence; /**< presence description */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200688 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200689 uint32_t min; /**< min-elements constraint */
690 uint32_t max; /**< max-elements constraint, 0 means unbounded */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200691 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200692 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
693};
694
695/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200696 * @ingroup schematree
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200697 * @defgroup deviatetypes Deviate types
Radek Krejci8678fa42020-08-18 16:07:28 +0200698 *
699 * Type of the deviate operation (used as ::lysp_deviate.mod)
700 *
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200701 * @{
702 */
703#define LYS_DEV_NOT_SUPPORTED 1 /**< deviate type not-supported */
704#define LYS_DEV_ADD 2 /**< deviate type add */
705#define LYS_DEV_DELETE 3 /**< deviate type delete */
706#define LYS_DEV_REPLACE 4 /**< deviate type replace */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200707/** @} deviatetypes */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200708
709/**
710 * @brief Generic deviate structure to get type and cast to lysp_deviate_* structure
711 */
712struct lysp_deviate {
713 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
714 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200715 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200716};
717
718struct lysp_deviate_add {
719 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
720 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200721 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200722 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200723 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200724 struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
725 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200726 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
727 uint32_t min; /**< min-elements constraint */
728 uint32_t max; /**< max-elements constraint, 0 means unbounded */
729};
730
731struct lysp_deviate_del {
732 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
733 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200734 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200735 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200736 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200737 struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
738 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200739};
740
741struct lysp_deviate_rpl {
742 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
743 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200744 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200745 struct lysp_type *type; /**< type of the node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200746 const char *units; /**< units of the values */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200747 struct lysp_qname dflt; /**< default value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200748 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
749 uint32_t min; /**< min-elements constraint */
750 uint32_t max; /**< max-elements constraint, 0 means unbounded */
751};
752
753struct lysp_deviation {
Michal Vaskob55f6c12018-09-12 11:13:15 +0200754 const char *nodeid; /**< target absolute schema nodeid (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200755 const char *dsc; /**< description statement */
756 const char *ref; /**< reference statement */
Michal Vasko22df3f02020-08-24 13:29:22 +0200757 struct lysp_deviate *deviates; /**< list of deviate specifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200758 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200759};
760
Radek Krejci4f28eda2018-11-12 11:46:16 +0100761/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100762 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200763 * @defgroup spnodeflags Parsed schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100764 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200765 * Various flags for parsed schema nodes (used as ::lysp_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100766 *
767 * 1 - container 6 - anydata/anyxml 11 - output 16 - grouping 21 - enum
768 * 2 - choice 7 - case 12 - feature 17 - uses 22 - type
Radek Krejcid3ca0632019-04-16 16:54:54 +0200769 * 3 - leaf 8 - notification 13 - identity 18 - refine 23 - stmt
Radek Krejci4f28eda2018-11-12 11:46:16 +0100770 * 4 - leaflist 9 - rpc 14 - extension 19 - augment
771 * 5 - list 10 - input 15 - typedef 20 - deviate
772 *
Radek Krejcid3ca0632019-04-16 16:54:54 +0200773 * 1 1 1 1 1 1 1 1 1 1 2 2 2 2
774 * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3
775 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200776 * 1 LYS_CONFIG_W |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200777 * LYS_SET_BASE | | | | | | | | | | | | | | | | | | | | | |x| |
778 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200779 * 2 LYS_CONFIG_R |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200780 * LYS_SET_BIT | | | | | | | | | | | | | | | | | | | | | |x| |
781 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
782 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
783 * LYS_SET_ENUM | | | | | | | | | | | | | | | | | | | | | |x| |
784 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
785 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
786 * LYS_SET_FRDIGITS | | | | | | | | | | | | | | | | | | | | | |x| |
787 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
788 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
789 * LYS_SET_LENGTH | | | | | | | | | | | | | | | | | | | | | |x| |
790 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
791 * 6 LYS_MAND_TRUE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
792 * LYS_SET_PATH | | | | | | | | | | | | | | | | | | | | | |x| |
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100793 * LYS_FENABLED | | | | | | | | | | | |x| | | | | | | | | | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200794 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
795 * 7 LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
796 * LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | | | | | | | | |
797 * LYS_SET_PATTERN | | | | | | | | | | | | | | | | | | | | | |x| |
798 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
799 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | | | | | | | | |
800 * LYS_YINELEM_TRUE | | | | | | | | | | | | | |x| | | | | | | | | |
801 * LYS_SET_RANGE | | | | | | | | | | | | | | | | | | | | | |x| |
802 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
803 * 9 LYS_YINELEM_FALSE| | | | | | | | | | | | | |x| | | | | | | | | |
804 * LYS_SET_TYPE | | | | | | | | | | | | | | | | | | | | | |x| |
805 * LYS_SINGLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
806 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
807 * 10 LYS_SET_VALUE | | | | | | | | | | | | | | | | | | | | |x| | |
808 * LYS_SET_REQINST | | | | | | | | | | | | | | | | | | | | | |x| |
809 * LYS_SET_MIN | | | |x|x| | | | | | | | | | | | |x| |x| | | |
810 * LYS_DOUBLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
811 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
812 * 11 LYS_SET_MAX | | | |x|x| | | | | | | | | | | | |x| |x| | | |
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200813 * LYS_USED_GRP | | | | | | | | | | | | | | | |x| | | | | | | |
David Sedlákae4b4512019-08-14 10:45:56 +0200814 * LYS_YIN_ATTR | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko5297a432020-08-31 12:27:51 +0200815 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
816 * 12 LYS_YIN_ARGUMENT | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100817 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
818 * 13 LYS_INTERNAL |x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|
Radek Krejcif56e2a42019-09-09 14:15:25 +0200819 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100820 *
821 */
822
823/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100824 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200825 * @defgroup scnodeflags Compiled schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100826 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200827 * Various flags for compiled schema nodes (used as ::lysc_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100828 *
Radek Krejci61e042e2019-09-10 15:53:09 +0200829 * 1 - container 6 - anydata/anyxml 11 - identity
830 * 2 - choice 7 - case 12 - extension
831 * 3 - leaf 8 - notification 13 - bitenum
Michal Vasko03ff5a72019-09-11 13:49:33 +0200832 * 4 - leaflist 9 - rpc/action 14 - when
Michal Vaskoecd62de2019-11-13 12:35:11 +0100833 * 5 - list 10 - feature
Radek Krejci4f28eda2018-11-12 11:46:16 +0100834 *
Michal Vaskoecd62de2019-11-13 12:35:11 +0100835 * 1 1 1 1 1
836 * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4
837 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100838 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100839 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100840 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100841 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
842 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x|x|x|x| |x|
843 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
844 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x|x|x|x| |x|
845 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
846 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x|x|x|x| |x|
847 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
848 * 6 LYS_MAND_TRUE |x|x|x|x|x|x| | | | | | | | |
849 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
850 * 7 LYS_ORDBY_USER | | | |x|x| | | | | | | | | |
851 * LYS_MAND_FALSE | |x|x| | |x| | | | | | | | |
852 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
853 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | |
854 * LYS_PRESENCE |x| | | | | | | | | | | | | |
855 * LYS_UNIQUE | | |x| | | | | | | | | | | |
856 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
857 * 9 LYS_KEY | | |x| | | | | | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100858 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
859 * 10 LYS_SET_DFLT | | |x|x| | |x| | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100860 * LYS_IS_ENUM | | | | | | | | | | | | |x| |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100861 * LYS_KEYLESS | | | | |x| | | | | | | | | |
862 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
863 * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | |
864 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
865 * 12 LYS_SET_CONFIG |x|x|x|x|x|x| | | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100866 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
867 * 13 LYS_IS_INPUT |x|x|x|x|x|x|x| | | | | | | |
868 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
869 * 14 LYS_IS_OUTPUT |x|x|x|x|x|x|x| | | | | | | |
870 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
871 * 15 LYS_IS_NOTIF |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100872 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100873 *
874 */
875
876/**
877 * @defgroup snodeflags Schema nodes flags
Radek Krejci8678fa42020-08-18 16:07:28 +0200878 *
879 * Various flags for schema nodes ([parsed](@ref spnodeflags) as well as [compiled](@ref scnodeflags)).
880 *
Radek Krejci4f28eda2018-11-12 11:46:16 +0100881 * @{
882 */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100883#define LYS_CONFIG_W 0x01 /**< config true; */
884#define LYS_CONFIG_R 0x02 /**< config false; */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200885#define LYS_CONFIG_MASK 0x03 /**< mask for config value */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100886#define LYS_STATUS_CURR 0x04 /**< status current; */
887#define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */
888#define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */
889#define LYS_STATUS_MASK 0x1C /**< mask for status value */
890#define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice,
Radek Krejcife909632019-02-12 15:34:42 +0100891 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
892 The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0.
893 The ::lysc_node_container has this flag if it is not a presence container and it has at least one
894 child with LYS_MAND_TRUE. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100895#define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice,
896 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
897 This flag is present only in case the mandatory false statement was explicitly specified. */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100898#define LYS_MAND_MASK 0x60 /**< mask for mandatory values */
Michal Vaskoc118ae22020-08-06 14:51:09 +0200899#define LYS_PRESENCE 0x80 /**< flag for presence property of a container, but it is not only for explicit presence
900 containers, but also for NP containers with some meaning, applicable only to
901 ::lysc_node_container */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100902#define LYS_UNIQUE 0x80 /**< flag for leafs being part of a unique set, applicable only to ::lysc_node_leaf */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100903#define LYS_KEY 0x0100 /**< flag for leafs being a key of a list, applicable only to ::lysc_node_leaf */
904#define LYS_KEYLESS 0x0200 /**< flag for list without any key, applicable only to ::lysc_node_list */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100905#define LYS_FENABLED 0x20 /**< feature enabled flag, applicable only to ::lysp_feature. */
Michal Vaskoe78faec2021-04-08 17:24:43 +0200906#define LYS_ORDBY_SYSTEM 0x80 /**< ordered-by system configuration lists, applicable only to
907 ::lysc_node_leaflist/::lysp_node_leaflist and ::lysc_node_list/::lysp_node_list */
908#define LYS_ORDBY_USER 0x40 /**< ordered-by user configuration lists, applicable only to
909 ::lysc_node_leaflist/::lysp_node_leaflist and ::lysc_node_list/::lysp_node_list;
910 is always set for state leaf-lists, and key-less lists */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100911#define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */
912#define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100913#define LYS_YINELEM_FALSE 0x0100 /**< yin-element false for extension's argument */
914#define LYS_YINELEM_MASK 0x0180 /**< mask for yin-element value */
915#define LYS_USED_GRP 0x0400 /**< internal flag for validating not-instantiated groupings
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200916 (resp. do not validate again the instantiated groupings). */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100917#define LYS_SET_VALUE 0x0200 /**< value attribute is set */
918#define LYS_SET_MIN 0x0200 /**< min attribute is set */
919#define LYS_SET_MAX 0x0400 /**< max attribute is set */
Radek Krejcid505e3d2018-11-13 09:04:17 +0100920
921#define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */
922#define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */
923#define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */
924#define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */
925#define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */
926#define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */
927#define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */
928#define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */
929#define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */
930#define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */
Radek Krejciccd20f12019-02-15 14:12:27 +0100931#define LYS_SET_DFLT 0x0200 /**< flag to mark leaf/leaflist with own (or refined) default value, not a default value taken from its type, and default
Radek Krejci76b3e962018-12-14 17:01:25 +0100932 cases of choice. This information is important for refines, since it is prohibited to make leafs
933 with default statement mandatory. In case the default leaf value is taken from type, it is thrown
Radek Krejciccd20f12019-02-15 14:12:27 +0100934 away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish
935 between own default or the default values taken from the type. */
936#define LYS_SET_UNITS 0x0400 /**< flag to know if the leaf's/leaflist's units are their own (flag set) or it is taken from the type. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100937#define LYS_SET_CONFIG 0x0800 /**< flag to know if the config property was set explicitly (flag set) or it is inherited. */
Radek Krejci0e5d8382018-11-28 16:37:53 +0100938
Michal Vaskod1e53b92021-01-28 13:11:06 +0100939#define LYS_SINGLEQUOTED 0x0100 /**< flag for single-quoted argument of an extension instance's substatement, only when the source is YANG */
940#define LYS_DOUBLEQUOTED 0x0200 /**< flag for double-quoted argument of an extension instance's substatement, only when the source is YANG */
Radek Krejcid3ca0632019-04-16 16:54:54 +0200941
Michal Vaskod1e53b92021-01-28 13:11:06 +0100942#define LYS_YIN_ATTR 0x0400 /**< flag to identify YIN attribute parsed as extension's substatement, only when the source is YIN */
943#define LYS_YIN_ARGUMENT 0x0800 /**< flag to identify statement representing extension's argument, only when the source is YIN */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200944
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100945#define LYS_INTERNAL 0x1000 /**< flag to identify internal parsed statements that should not be printed */
946
Michal Vaskod1e53b92021-01-28 13:11:06 +0100947#define LYS_IS_ENUM 0x0200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */
948
949#define LYS_IS_INPUT 0x1000 /**< flag for nodes that are in the subtree of an input statement */
950
951#define LYS_IS_OUTPUT 0x2000 /**< flag for nodes that are in the subtree of an output statement */
952
953#define LYS_IS_NOTIF 0x4000 /**< flag for nodes that are in the subtree of a notification statement */
Radek Krejci693262f2019-04-29 15:23:20 +0200954
Radek Krejcife909632019-02-12 15:34:42 +0100955#define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200956/** @} snodeflags */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200957
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200958/**
959 * @brief Generic YANG data node
960 */
961struct lysp_node {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100962 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejcide7a9c42021-03-10 13:13:06 +0100963 uint16_t nodetype; /**< [type of the node](@ref schemanodetypes) (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200964 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100965 struct lysp_node *next; /**< next sibling node (NULL if there is no one) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200966 const char *name; /**< node name (mandatory) */
967 const char *dsc; /**< description statement */
968 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200969 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)),
970 must be qname because of refines */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200971 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200972};
973
974/**
975 * @brief Extension structure of the lysp_node for YANG container
976 */
977struct lysp_node_container {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100978 union {
979 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
980 struct {
981 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
982 uint16_t nodetype; /**< LYS_CONTAINER */
983 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
984 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
985 const char *name; /**< node name (mandatory) */
986 const char *dsc; /**< description statement */
987 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100988 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
989 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
990 };
991 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200992
993 /* container */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200994 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +0100995 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200996 const char *presence; /**< presence description */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200997 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100998 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200999 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001000 struct lysp_node_action *actions;/**< list of actions (linked list) */
1001 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001002};
1003
1004struct lysp_node_leaf {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001005 union {
1006 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1007 struct {
1008 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1009 uint16_t nodetype; /**< LYS_LEAF */
1010 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1011 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1012 const char *name; /**< node name (mandatory) */
1013 const char *dsc; /**< description statement */
1014 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001015 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1016 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1017 };
1018 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001019
1020 /* leaf */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001021 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001022 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001023 struct lysp_type type; /**< type of the leaf node (mandatory) */
1024 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001025 struct lysp_qname dflt; /**< default value, it may or may not be a qualified name */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001026};
1027
1028struct lysp_node_leaflist {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001029 union {
1030 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1031 struct {
1032 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1033 uint16_t nodetype; /**< LYS_LEAFLIST */
1034 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1035 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1036 const char *name; /**< node name (mandatory) */
1037 const char *dsc; /**< description statement */
1038 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001039 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1040 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1041 };
1042 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001043
1044 /* leaf-list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001045 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001046 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001047 struct lysp_type type; /**< type of the leaf node (mandatory) */
1048 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001049 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)), they may or
1050 may not be qualified names */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001051 uint32_t min; /**< min-elements constraint */
1052 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1053};
1054
1055struct lysp_node_list {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001056 union {
1057 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1058 struct {
1059 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1060 uint16_t nodetype; /**< LYS_LIST */
1061 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1062 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1063 const char *name; /**< node name (mandatory) */
1064 const char *dsc; /**< description statement */
1065 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001066 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1067 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1068 };
1069 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001070
1071 /* list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001072 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001073 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001074 const char *key; /**< keys specification */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001075 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001076 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001077 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001078 struct lysp_node_action *actions;/**< list of actions (linked list) */
1079 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001080 struct lysp_qname *uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001081 uint32_t min; /**< min-elements constraint */
1082 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1083};
1084
1085struct lysp_node_choice {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001086 union {
1087 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1088 struct {
1089 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1090 uint16_t nodetype; /**< LYS_CHOICE */
1091 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1092 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1093 const char *name; /**< node name (mandatory) */
1094 const char *dsc; /**< description statement */
1095 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001096 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1097 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1098 };
1099 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001100
1101 /* choice */
1102 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001103 struct lysp_when *when; /**< when statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001104 struct lysp_qname dflt; /**< default case */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001105};
1106
1107struct lysp_node_case {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001108 union {
1109 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1110 struct {
1111 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1112 uint16_t nodetype; /**< LYS_CASE */
1113 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1114 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1115 const char *name; /**< node name (mandatory) */
1116 const char *dsc; /**< description statement */
1117 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001118 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1119 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1120 };
1121 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001122
1123 /* case */
1124 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001125 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001126};
1127
1128struct lysp_node_anydata {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001129 union {
1130 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1131 struct {
1132 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1133 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1134 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1135 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1136 const char *name; /**< node name (mandatory) */
1137 const char *dsc; /**< description statement */
1138 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001139 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1140 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1141 };
1142 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001143
1144 /* anyxml/anydata */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001145 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001146 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001147};
1148
1149struct lysp_node_uses {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001150 union {
1151 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1152 struct {
1153 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1154 uint16_t nodetype; /**< LYS_USES */
1155 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1156 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1157 const char *name; /**< grouping name reference (mandatory) */
1158 const char *dsc; /**< description statement */
1159 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001160 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1161 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1162 };
1163 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001164
1165 /* uses */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001166 struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001167 struct lysp_node_augment *augments; /**< list of augments (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001168 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001169};
1170
1171/**
1172 * @brief YANG input-stmt and output-stmt
1173 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001174struct lysp_node_action_inout {
1175 union {
1176 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1177 struct {
1178 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1179 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1180 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1181 struct lysp_node *next; /**< NULL */
1182 const char *name; /**< empty string */
1183 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1184 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysp_node */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001185 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1186 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1187 };
1188 }; /**< common part corresponding to ::lysp_node */
1189
1190 /* inout */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001191 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1192 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001193 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001194 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001195};
1196
1197/**
1198 * @brief YANG rpc-stmt and action-stmt
1199 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001200struct lysp_node_action {
1201 union {
1202 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1203 struct {
1204 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1205 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1206 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1207 struct lysp_node_action *next; /**< pointer to the next action (NULL if there is no one) */
1208 const char *name; /**< grouping name reference (mandatory) */
1209 const char *dsc; /**< description statement */
1210 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001211 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1212 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1213 };
1214 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001215
1216 /* action */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001217 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1218 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
1219
1220 struct lysp_node_action_inout input; /**< RPC's/Action's input */
1221 struct lysp_node_action_inout output; /**< RPC's/Action's output */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001222};
1223
1224/**
1225 * @brief YANG notification-stmt
1226 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001227struct lysp_node_notif {
1228 union {
1229 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1230 struct {
1231 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1232 uint16_t nodetype; /**< LYS_NOTIF */
1233 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1234 struct lysp_node_notif *next; /**< pointer to the next notification (NULL if there is no one) */
1235 const char *name; /**< grouping name reference (mandatory) */
1236 const char *dsc; /**< description statement */
1237 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001238 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1239 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1240 };
1241 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001242
1243 /* notif */
1244 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001245 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1246 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001247 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001248};
1249
1250/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001251 * @brief YANG grouping-stmt
1252 */
1253struct lysp_node_grp {
1254 union {
1255 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1256 struct {
1257 struct lysp_node *parent;/**< parent node (NULL if this is a top-level grouping) */
1258 uint16_t nodetype; /**< LYS_GROUPING */
1259 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1260 struct lysp_node_grp *next; /**< pointer to the next grouping (NULL if there is no one) */
1261 const char *name; /**< grouping name (mandatory) */
1262 const char *dsc; /**< description statement */
1263 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001264 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1265 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1266 };
1267 }; /**< common part corresponding to ::lysp_node */
1268
1269 /* grp */
1270 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1271 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001272 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001273 struct lysp_node_action *actions; /**< list of actions (linked list) */
1274 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1275};
1276
1277/**
1278 * @brief YANG uses-augment-stmt and augment-stmt (compatible with struct lysp_node )
1279 */
1280struct lysp_node_augment {
1281 union {
1282 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1283 struct {
1284 struct lysp_node *parent;/**< parent node (NULL if this is a top-level augment) */
1285 uint16_t nodetype; /**< LYS_AUGMENT */
1286 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1287 struct lysp_node_augment *next; /**< pointer to the next augment (NULL if there is no one) */
1288 const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */
1289 const char *dsc; /**< description statement */
1290 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001291 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1292 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1293 };
1294 }; /**< common part corresponding to ::lysp_node */
1295
1296 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001297 struct lysp_when *when; /**< when statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001298 struct lysp_node_action *actions;/**< list of actions (linked list) */
1299 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1300};
1301
1302/**
Radek Krejcif0fceb62018-09-05 14:58:45 +02001303 * @brief supported YANG schema version values
1304 */
1305typedef enum LYS_VERSION {
1306 LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */
Radek Krejci96e48da2020-09-04 13:18:06 +02001307 LYS_VERSION_1_0 = 1, /**< YANG 1 (1.0) */
Radek Krejcif0fceb62018-09-05 14:58:45 +02001308 LYS_VERSION_1_1 = 2 /**< YANG 1.1 */
1309} LYS_VERSION;
1310
1311/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001312 * @brief Printable YANG schema tree structure representing YANG module.
1313 *
1314 * Simple structure corresponding to the YANG format. The schema is only syntactically validated.
1315 */
1316struct lysp_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001317 struct lys_module *mod; /**< covering module structure */
1318
Radek Krejcib7db73a2018-10-24 14:18:40 +02001319 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1320 in the list is always the last (newest) revision of the module */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001321 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1322 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001323 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1324 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1325 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1326 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001327 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001328 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001329 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1330 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1331 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001332 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001333 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001334
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001335 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001336 uint8_t parsing : 1; /**< flag for circular check */
1337 uint8_t is_submod : 1; /**< always 0 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001338};
1339
1340struct lysp_submodule {
Michal Vaskoc3781c32020-10-06 14:04:08 +02001341 struct lys_module *mod; /**< belongs to parent module (submodule - mandatory) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001342
1343 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1344 in the list is always the last (newest) revision of the module */
1345 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1346 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
1347 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1348 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1349 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1350 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001351 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001352 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001353 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1354 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1355 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001356 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001357 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001358
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001359 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001360 uint8_t parsing : 1; /**< flag for circular check */
1361 uint8_t is_submod : 1; /**< always 1 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001362
Michal Vaskoc3781c32020-10-06 14:04:08 +02001363 uint8_t latest_revision : 2; /**< flag to mark the latest available revision:
Radek Krejci086c7132018-10-26 15:29:04 +02001364 1 - the latest revision in searchdirs was not searched yet and this is the
1365 latest revision in the current context
1366 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001367 const char *name; /**< name of the module (mandatory) */
1368 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1369 const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */
1370 const char *org; /**< party/company responsible for the module */
1371 const char *contact; /**< contact information for the module */
1372 const char *dsc; /**< description of the module */
1373 const char *ref; /**< cross-reference for the module */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001374};
1375
1376/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001377 * @brief Get the parsed module or submodule name.
1378 *
1379 * @param[in] PMOD Parsed module or submodule.
1380 * @return Module or submodule name.
1381 */
1382#define LYSP_MODULE_NAME(PMOD) (PMOD->is_submod ? ((struct lysp_submodule *)PMOD)->name : ((struct lysp_module *)PMOD)->mod->name)
1383
1384/**
Radek Krejci8df109d2021-04-23 12:19:08 +02001385 * @brief Compiled prefix data pair mapping of prefixes to modules. In case the format is ::LY_VALUE_SCHEMA_RESOLVED,
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001386 * the expected prefix data is a sized array of these structures.
1387 */
1388struct lysc_prefix {
1389 char *prefix; /**< used prefix */
1390 const struct lys_module *mod; /**< mapping to a module */
1391};
1392
1393/**
Radek Krejci0e59c312019-08-15 15:34:15 +02001394 * @brief Compiled YANG extension-stmt
Radek Krejci9f87b0c2021-03-05 14:45:26 +01001395 *
1396 * Note that the compiled extension definition is created only in case the extension is instantiated. It is not available
1397 * from the compiled schema, but from the parsed extension definition which is being searched when an extension instance
1398 * is being compiled.
Radek Krejci0e59c312019-08-15 15:34:15 +02001399 */
1400struct lysc_ext {
1401 const char *name; /**< extension name */
Radek Krejci9f87b0c2021-03-05 14:45:26 +01001402 const char *argname; /**< argument name, NULL if not specified */
Radek Krejci0e59c312019-08-15 15:34:15 +02001403 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcicc9e30f2021-03-29 12:45:08 +02001404 struct lyplg_ext *plugin; /**< Plugin implementing the specific extension */
Radek Krejci0935f412019-08-20 16:15:18 +02001405 struct lys_module *module; /**< module structure */
Michal Vasko6f4cbb62020-02-28 11:15:47 +01001406 uint32_t refcount; /**< reference counter since extension definition is shared among all its instances */
Radek Krejci0e59c312019-08-15 15:34:15 +02001407 uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */
1408};
1409
1410/**
Radek Krejcib1c11532021-03-29 14:14:19 +02001411 * @brief Description of the extension instance substatements.
1412 *
1413 * Provided by extensions plugins to libyang to be able to correctly compile the content of extension instances.
1414 * Note that order of the defined records matters - just follow the values of ::ly_stmt and order the records from lower to higher values.
1415 */
1416struct lysc_ext_substmt {
1417 enum ly_stmt stmt; /**< allowed substatement */
1418 enum ly_stmt_cardinality cardinality; /**< cardinality of the substatement */
1419 void *storage; /**< pointer to the storage of the compiled statement according to the specific
1420 lysc_ext_substmt::stmt and lysc_ext_substmt::cardinality */
1421};
1422
1423/**
Radek Krejcice8c1592018-10-29 15:35:51 +01001424 * @brief YANG extension instance
1425 */
1426struct lysc_ext_instance {
Radek Krejciad5963b2019-09-06 16:03:05 +02001427 struct lysc_ext *def; /**< pointer to the extension definition */
Radek Krejcice8c1592018-10-29 15:35:51 +01001428 const char *argument; /**< optional value of the extension's argument */
Radek Krejciab430862021-03-02 20:13:40 +01001429 struct lys_module *module; /**< module where the extension instantiated is defined */
Radek Krejci2a408df2018-10-29 16:32:26 +01001430 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f9a3672021-03-05 21:35:22 +01001431 struct lysc_ext_substmt *substmts; /**< list of allowed substatements with the storage to access the present
1432 substatements ([sized array](@ref sizedarrays)) */
Radek Krejci0e59c312019-08-15 15:34:15 +02001433 void *data; /**< private plugins's data, not used by libyang */
Radek Krejciab430862021-03-02 20:13:40 +01001434
1435 void *parent; /**< pointer to the parent element holding the extension instance(s), use
1436 ::lysc_ext_instance#parent_stmt to access the schema element */
1437 enum ly_stmt parent_stmt; /**< value identifying placement of the extension instance in specific statement */
1438 LY_ARRAY_COUNT_TYPE parent_stmt_index; /**< in case the instance is in a substatement, this identifies
1439 the index of that substatement in its [sized array](@ref sizedarrays) (if any) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001440};
1441
1442/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001443 * @brief YANG when-stmt
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001444 */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001445struct lysc_when {
1446 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko175012e2019-11-06 15:49:14 +01001447 struct lysc_node *context; /**< context node for evaluating the expression, NULL if the context is root node */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001448 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001449 const char *dsc; /**< description */
1450 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001451 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00b874b2019-02-12 10:54:50 +01001452 uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */
Michal Vaskoecd62de2019-11-13 12:35:11 +01001453 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS is allowed */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001454};
1455
1456/**
Radek Krejci2a408df2018-10-29 16:32:26 +01001457 * @brief YANG identity-stmt
1458 */
1459struct lysc_ident {
1460 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejcic8b31002019-01-08 10:24:45 +01001461 const char *dsc; /**< description */
1462 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001463 struct lys_module *module; /**< module structure */
aPiecek6b3d5422021-07-30 15:55:43 +02001464 struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays))
1465 It also contains references to identities located in unimplemented modules. */
Radek Krejci2a408df2018-10-29 16:32:26 +01001466 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1467 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
1468};
1469
1470/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001471 * @defgroup ifftokens if-feature expression tokens
Radek Krejci8678fa42020-08-18 16:07:28 +02001472 * Tokens of if-feature expression used in ::lysc_iffeature.expr.
Radek Krejci151a5b72018-10-19 14:21:44 +02001473 *
1474 * @{
1475 */
1476#define LYS_IFF_NOT 0x00 /**< operand "not" */
1477#define LYS_IFF_AND 0x01 /**< operand "and" */
1478#define LYS_IFF_OR 0x02 /**< operand "or" */
1479#define LYS_IFF_F 0x03 /**< feature */
Radek Krejci2ff0d572020-05-21 15:27:28 +02001480/** @} ifftokens */
Radek Krejci151a5b72018-10-19 14:21:44 +02001481
1482/**
Radek Krejcib7db73a2018-10-24 14:18:40 +02001483 * @brief Compiled YANG revision statement
1484 */
1485struct lysc_revision {
1486 char date[LY_REV_SIZE]; /**< revision-date (mandatory) */
1487 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1488};
1489
Radek Krejci2167ee12018-11-02 16:09:07 +01001490struct lysc_range {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001491 struct lysc_range_part {
Radek Krejci693262f2019-04-29 15:23:20 +02001492 union { /**< min boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001493 int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1494 uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001495 };
Radek Krejci693262f2019-04-29 15:23:20 +02001496 union { /**< max boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001497 int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1498 uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001499 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001500 } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001501 const char *dsc; /**< description */
1502 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001503 const char *emsg; /**< error-message */
1504 const char *eapptag; /**< error-app-tag value */
1505 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1506};
1507
1508struct lysc_pattern {
Radek Krejci54579462019-04-30 12:47:06 +02001509 const char *expr; /**< original, not compiled, regular expression */
1510 pcre2_code *code; /**< compiled regular expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001511 const char *dsc; /**< description */
1512 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001513 const char *emsg; /**< error-message */
1514 const char *eapptag; /**< error-app-tag value */
1515 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0f969882020-08-21 16:56:47 +02001516 uint32_t inverted : 1; /**< invert-match flag */
1517 uint32_t refcount : 31; /**< reference counter */
Radek Krejci2167ee12018-11-02 16:09:07 +01001518};
1519
1520struct lysc_must {
Radek Krejci2167ee12018-11-02 16:09:07 +01001521 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001522 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001523 const char *dsc; /**< description */
1524 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001525 const char *emsg; /**< error-message */
1526 const char *eapptag; /**< error-app-tag value */
1527 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1528};
1529
1530struct lysc_type {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001531 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001532 struct lyplg_type *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001533 LY_DATA_TYPE basetype; /**< Base type of the type */
Michal Vasko080064b2021-08-31 15:20:44 +02001534 uint32_t refcount; /**< reference counter for type sharing, it may be accessed concurrently when
Michal Vaskobabf0bd2021-08-31 14:55:39 +02001535 creating/freeing data node values that reference it (instance-identifier) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001536};
1537
1538struct lysc_type_num {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001539 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001540 struct lyplg_type *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001541 LY_DATA_TYPE basetype; /**< Base type of the type */
Michal Vasko080064b2021-08-31 15:20:44 +02001542 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci2167ee12018-11-02 16:09:07 +01001543 struct lysc_range *range; /**< Optional range limitation */
1544};
1545
1546struct lysc_type_dec {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001547 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001548 struct lyplg_type *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001549 LY_DATA_TYPE basetype; /**< Base type of the type */
Michal Vasko080064b2021-08-31 15:20:44 +02001550 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci6cba4292018-11-15 17:33:29 +01001551 uint8_t fraction_digits; /**< fraction digits specification */
Radek Krejci2167ee12018-11-02 16:09:07 +01001552 struct lysc_range *range; /**< Optional range limitation */
1553};
1554
1555struct lysc_type_str {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001556 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001557 struct lyplg_type *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001558 LY_DATA_TYPE basetype; /**< Base type of the type */
Michal Vasko080064b2021-08-31 15:20:44 +02001559 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci2167ee12018-11-02 16:09:07 +01001560 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci4586a022018-11-13 11:29:26 +01001561 struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001562};
1563
Radek Krejci693262f2019-04-29 15:23:20 +02001564struct lysc_type_bitenum_item {
1565 const char *name; /**< enumeration identifier */
1566 const char *dsc; /**< description */
1567 const char *ref; /**< reference */
1568 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci693262f2019-04-29 15:23:20 +02001569 union {
1570 int32_t value; /**< integer value associated with the enumeration */
1571 uint32_t position; /**< non-negative integer value associated with the bit */
1572 };
1573 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
1574 values are allowed */
1575};
1576
Radek Krejci2167ee12018-11-02 16:09:07 +01001577struct lysc_type_enum {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001578 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001579 struct lyplg_type *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001580 LY_DATA_TYPE basetype; /**< Base type of the type */
Michal Vasko080064b2021-08-31 15:20:44 +02001581 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci693262f2019-04-29 15:23:20 +02001582 struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1583};
1584
1585struct lysc_type_bits {
1586 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001587 struct lyplg_type *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci693262f2019-04-29 15:23:20 +02001588 LY_DATA_TYPE basetype; /**< Base type of the type */
Michal Vasko080064b2021-08-31 15:20:44 +02001589 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci849a62a2019-05-22 15:29:05 +02001590 struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item),
1591 the items are ordered by their position value. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001592};
1593
1594struct lysc_type_leafref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001595 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001596 struct lyplg_type *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001597 LY_DATA_TYPE basetype; /**< Base type of the type */
Michal Vasko080064b2021-08-31 15:20:44 +02001598 uint32_t refcount; /**< reference counter for type sharing */
Michal Vasko004d3152020-06-11 19:59:22 +02001599 struct lyxp_expr *path; /**< parsed target path, compiled path cannot be stored because of type sharing */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001600 struct lysc_prefix *prefixes; /**< resolved prefixes used in the path */
Michal Vaskoed725d72021-06-23 12:03:45 +02001601 const struct lys_module *cur_mod;/**< unused, not needed */
Radek Krejci412ddfa2018-11-23 11:44:11 +01001602 struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001603 uint8_t require_instance; /**< require-instance flag */
1604};
1605
1606struct lysc_type_identityref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001607 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001608 struct lyplg_type *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001609 LY_DATA_TYPE basetype; /**< Base type of the type */
Michal Vasko080064b2021-08-31 15:20:44 +02001610 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci555cb5b2018-11-16 14:54:33 +01001611 struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)),
Radek Krejci2167ee12018-11-02 16:09:07 +01001612 mandatory (at least 1 item) */
1613};
1614
1615struct lysc_type_instanceid {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001616 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001617 struct lyplg_type *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001618 LY_DATA_TYPE basetype; /**< Base type of the type */
Michal Vasko080064b2021-08-31 15:20:44 +02001619 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci2167ee12018-11-02 16:09:07 +01001620 uint8_t require_instance; /**< require-instance flag */
1621};
1622
Radek Krejci2167ee12018-11-02 16:09:07 +01001623struct lysc_type_union {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001624 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001625 struct lyplg_type *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001626 LY_DATA_TYPE basetype; /**< Base type of the type */
Michal Vasko080064b2021-08-31 15:20:44 +02001627 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci2167ee12018-11-02 16:09:07 +01001628 struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1629};
1630
1631struct lysc_type_bin {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001632 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001633 struct lyplg_type *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001634 LY_DATA_TYPE basetype; /**< Base type of the type */
Michal Vasko080064b2021-08-31 15:20:44 +02001635 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci2167ee12018-11-02 16:09:07 +01001636 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001637};
1638
Michal Vasko60ea6352020-06-29 13:39:39 +02001639/**
1640 * @brief Maximum number of hashes stored in a schema node.
1641 */
1642#define LYS_NODE_HASH_COUNT 4
1643
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001644/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001645 * @brief Compiled YANG data node
1646 */
1647struct lysc_node {
Radek Krejcide7a9c42021-03-10 13:13:06 +01001648 uint16_t nodetype; /**< [type of the node](@ref schemanodetypes) (mandatory) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001649 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Michal Vasko60ea6352020-06-29 13:39:39 +02001650 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001651 struct lys_module *module; /**< module structure */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001652 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1653 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1654 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1655 never NULL. If there is no sibling node, pointer points to the node
1656 itself. In case of the first node, this pointer points to the last
1657 node in the list. */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001658 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001659 const char *dsc; /**< description */
1660 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001661 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001662 void *priv; /**< private arbitrary user data, not used by libyang unless ::LY_CTX_SET_PRIV_PARSED is set */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001663};
1664
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001665struct lysc_node_action_inout {
1666 union {
1667 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1668 struct {
1669 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1670 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1671 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1672 struct lys_module *module; /**< module structure */
Radek Krejci5960c312021-01-27 20:24:22 +01001673 struct lysc_node *parent;/**< parent node (NULL in case of top level node) */
Michal Vasko544e58a2021-01-28 14:33:41 +01001674 struct lysc_node *next; /**< next sibling node (output node for input, NULL for output) */
1675 struct lysc_node *prev; /**< pointer to the previous sibling node (input and output node pointing to each other) */
Radek Krejci5960c312021-01-27 20:24:22 +01001676 const char *name; /**< "input" or "output" */
1677 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysc_node */
1678 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysc_node */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001679 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001680 void *priv; /** private arbitrary user data, not used by libyang unless ::LY_CTX_SET_PRIV_PARSED is set */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001681 };
1682 };
1683
Radek Krejci9a3823e2021-01-27 20:26:46 +01001684 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001685 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1686};
1687
1688struct lysc_node_action {
1689 union {
1690 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1691 struct {
1692 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1693 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1694 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1695 struct lys_module *module; /**< module structure */
1696 struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */
1697 struct lysc_node_action *next; /**< next sibling node (NULL if there is no one) */
1698 struct lysc_node_action *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1699 never NULL. If there is no sibling node, pointer points to the node
1700 itself. In case of the first node, this pointer points to the last
1701 node in the list. */
1702 const char *name; /**< action/RPC name (mandatory) */
1703 const char *dsc; /**< description */
1704 const char *ref; /**< reference */
1705 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001706 void *priv; /** private arbitrary user data, not used by libyang unless ::LY_CTX_SET_PRIV_PARSED is set */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001707 };
1708 };
1709
Radek Krejci9a3823e2021-01-27 20:26:46 +01001710 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1711 the action/RPC nodes do not contain the when statement on their own, but they can
1712 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001713 struct lysc_node_action_inout input; /**< RPC's/action's input */
1714 struct lysc_node_action_inout output; /**< RPC's/action's output */
1715
1716};
1717
1718struct lysc_node_notif {
1719 union {
1720 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1721 struct {
1722 uint16_t nodetype; /**< LYS_NOTIF */
1723 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1724 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1725 struct lys_module *module; /**< module structure */
1726 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1727 struct lysc_node_notif *next; /**< next sibling node (NULL if there is no one) */
1728 struct lysc_node_notif *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1729 never NULL. If there is no sibling node, pointer points to the node
1730 itself. In case of the first node, this pointer points to the last
1731 node in the list. */
1732 const char *name; /**< Notification name (mandatory) */
1733 const char *dsc; /**< description */
1734 const char *ref; /**< reference */
1735 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001736 void *priv; /** private arbitrary user data, not used by libyang unless ::LY_CTX_SET_PRIV_PARSED is set */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001737 };
1738 };
1739
Radek Krejci9a3823e2021-01-27 20:26:46 +01001740 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001741 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001742 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1743 the notification nodes do not contain the when statement on their own, but they can
1744 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001745};
1746
1747struct lysc_node_container {
1748 union {
1749 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1750 struct {
1751 uint16_t nodetype; /**< LYS_CONTAINER */
1752 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1753 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1754 struct lys_module *module; /**< module structure */
1755 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1756 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1757 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1758 never NULL. If there is no sibling node, pointer points to the node
1759 itself. In case of the first node, this pointer points to the last
1760 node in the list. */
1761 const char *name; /**< node name (mandatory) */
1762 const char *dsc; /**< description */
1763 const char *ref; /**< reference */
1764 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001765 void *priv; /**< private arbitrary user data, not used by libyang unless ::LY_CTX_SET_PRIV_PARSED is set */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001766 };
1767 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001768
1769 struct lysc_node *child; /**< first child node (linked list) */
1770 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001771 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001772 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1773 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001774};
1775
Radek Krejcia3045382018-11-22 14:30:31 +01001776struct lysc_node_case {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001777 union {
1778 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1779 struct {
1780 uint16_t nodetype; /**< LYS_CASE */
1781 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1782 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1783 struct lys_module *module; /**< module structure */
1784 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1785 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1786 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejci056d0a82018-12-06 16:57:25 +01001787 never NULL. If there is no sibling node, pointer points to the node
1788 itself. In case of the first node, this pointer points to the last
1789 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001790 const char *name; /**< name of the case, including the implicit case */
1791 const char *dsc; /**< description */
1792 const char *ref; /**< reference */
1793 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001794 void *priv; /**< private arbitrary user data, not used by libyang unless ::LY_CTX_SET_PRIV_PARSED is set */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001795 };
1796 };
Radek Krejci056d0a82018-12-06 16:57:25 +01001797
Radek Krejcia3045382018-11-22 14:30:31 +01001798 struct lysc_node *child; /**< first child node of the case (linked list). Note that all the children of all the sibling cases are linked
Radek Krejcife13da42019-02-15 14:51:01 +01001799 each other as siblings with the parent pointer pointing to appropriate case node. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001800 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcia3045382018-11-22 14:30:31 +01001801};
1802
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001803struct lysc_node_choice {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001804 union {
1805 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1806 struct {
1807 uint16_t nodetype; /**< LYS_CHOICE */
1808 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1809 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1810 struct lys_module *module; /**< module structure */
1811 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1812 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1813 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001814 never NULL. If there is no sibling node, pointer points to the node
1815 itself. In case of the first node, this pointer points to the last
1816 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001817 const char *name; /**< node name (mandatory) */
1818 const char *dsc; /**< description */
1819 const char *ref; /**< reference */
1820 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001821 void *priv; /**< private arbitrary user data, not used by libyang unless ::LY_CTX_SET_PRIV_PARSED is set */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001822 };
1823 };
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001824
Radek Krejcia9026eb2018-12-12 16:04:47 +01001825 struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other
1826 as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the
1827 case is simple. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001828 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001829 struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001830};
1831
1832struct lysc_node_leaf {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001833 union {
1834 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1835 struct {
1836 uint16_t nodetype; /**< LYS_LEAF */
1837 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1838 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1839 struct lys_module *module; /**< module structure */
1840 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1841 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1842 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001843 never NULL. If there is no sibling node, pointer points to the node
1844 itself. In case of the first node, this pointer points to the last
1845 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001846 const char *name; /**< node name (mandatory) */
1847 const char *dsc; /**< description */
1848 const char *ref; /**< reference */
1849 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001850 void *priv; /**< private arbitrary user data, not used by libyang unless ::LY_CTX_SET_PRIV_PARSED is set */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001851 };
1852 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001853
1854 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001855 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001856 struct lysc_type *type; /**< type of the leaf node (mandatory) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001857
Radek Krejci4f28eda2018-11-12 11:46:16 +01001858 const char *units; /**< units of the leaf's type */
Michal Vasko33876022021-04-27 16:42:24 +02001859 struct lyd_value *dflt; /**< default value, use ::lyd_value_get_canonical() to get the canonical string */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001860};
1861
1862struct lysc_node_leaflist {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001863 union {
1864 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1865 struct {
1866 uint16_t nodetype; /**< LYS_LEAFLIST */
1867 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1868 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1869 struct lys_module *module; /**< module structure */
1870 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1871 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1872 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001873 never NULL. If there is no sibling node, pointer points to the node
1874 itself. In case of the first node, this pointer points to the last
1875 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001876 const char *name; /**< node name (mandatory) */
1877 const char *dsc; /**< description */
1878 const char *ref; /**< reference */
1879 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001880 void *priv; /**< private arbitrary user data, not used by libyang unless ::LY_CTX_SET_PRIV_PARSED is set */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001881 };
1882 };
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001883
1884 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001885 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001886 struct lysc_type *type; /**< type of the leaf node (mandatory) */
1887
Radek Krejci0e5d8382018-11-28 16:37:53 +01001888 const char *units; /**< units of the leaf's type */
Michal Vasko33876022021-04-27 16:42:24 +02001889 struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values, use
1890 ::lyd_value_get_canonical() to get the canonical strings */
Michal Vaskoba99a3e2020-08-18 15:50:05 +02001891
Radek Krejci0e5d8382018-11-28 16:37:53 +01001892 uint32_t min; /**< min-elements constraint */
1893 uint32_t max; /**< max-elements constraint */
1894
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001895};
1896
1897struct lysc_node_list {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001898 union {
1899 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1900 struct {
1901 uint16_t nodetype; /**< LYS_LIST */
1902 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1903 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1904 struct lys_module *module; /**< module structure */
1905 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1906 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1907 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001908 never NULL. If there is no sibling node, pointer points to the node
1909 itself. In case of the first node, this pointer points to the last
1910 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001911 const char *name; /**< node name (mandatory) */
1912 const char *dsc; /**< description */
1913 const char *ref; /**< reference */
1914 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001915 void *priv; /**< private arbitrary user data, not used by libyang unless ::LY_CTX_SET_PRIV_PARSED is set */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001916 };
1917 };
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001918
1919 struct lysc_node *child; /**< first child node (linked list) */
1920 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001921 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001922 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1923 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001924
Radek Krejci2a9fc652021-01-22 17:44:34 +01001925 struct lysc_node_leaf ***uniques;/**< list of sized arrays of pointers to the unique nodes ([sized array](@ref sizedarrays)) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001926 uint32_t min; /**< min-elements constraint */
1927 uint32_t max; /**< max-elements constraint */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001928};
1929
1930struct lysc_node_anydata {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001931 union {
1932 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1933 struct {
1934 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1935 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1936 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1937 struct lys_module *module; /**< module structure */
1938 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1939 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1940 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001941 never NULL. If there is no sibling node, pointer points to the node
1942 itself. In case of the first node, this pointer points to the last
1943 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001944 const char *name; /**< node name (mandatory) */
1945 const char *dsc; /**< description */
1946 const char *ref; /**< reference */
1947 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001948 void *priv; /**< private arbitrary user data, not used by libyang unless ::LY_CTX_SET_PRIV_PARSED is set */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001949 };
1950 };
Radek Krejci9800fb82018-12-13 14:26:23 +01001951
1952 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001953 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001954};
1955
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001956/**
1957 * @brief Compiled YANG schema tree structure representing YANG module.
1958 *
1959 * Semantically validated YANG schema tree for data tree parsing.
1960 * Contains only the necessary information for the data validation.
1961 */
1962struct lysc_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001963 struct lys_module *mod; /**< covering module structure */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001964
Radek Krejci2a408df2018-10-29 16:32:26 +01001965 struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001966 struct lysc_node_action *rpcs; /**< first of actions nodes (linked list) */
1967 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001968 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001969};
1970
1971/**
Radek Krejci490a5462020-11-05 08:44:42 +01001972 * @brief Examine whether a node is user-ordered list or leaf-list.
1973 *
1974 * @param[in] lysc_node Schema node to examine.
1975 * @return Boolean value whether the @p node is user-ordered or not.
1976 */
1977#define lysc_is_userordered(lysc_node) \
1978 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAFLIST | LYS_LIST)) || !(lysc_node->flags & LYS_ORDBY_USER)) ? 0 : 1)
1979
1980/**
1981 * @brief Examine whether a node is a list's key.
1982 *
1983 * @param[in] lysc_node Schema node to examine.
1984 * @return Boolean value whether the @p node is a key or not.
1985 */
1986#define lysc_is_key(lysc_node) \
Michal Vaskobce7ee32021-02-04 11:05:25 +01001987 ((!lysc_node || (lysc_node->nodetype != LYS_LEAF) || !(lysc_node->flags & LYS_KEY)) ? 0 : 1)
Radek Krejci490a5462020-11-05 08:44:42 +01001988
1989/**
Michal Vasko5c123b02020-12-04 14:34:04 +01001990 * @brief Examine whether a node is a non-presence container.
1991 *
1992 * @param[in] lysc_node Schema node to examine.
1993 * @return Boolean value whether the @p node is a NP container or not.
1994 */
1995#define lysc_is_np_cont(lysc_node) \
Michal Vaskobce7ee32021-02-04 11:05:25 +01001996 ((!lysc_node || (lysc_node->nodetype != LYS_CONTAINER) || (lysc_node->flags & LYS_PRESENCE)) ? 0 : 1)
1997
1998/**
Michal Vaskoe78faec2021-04-08 17:24:43 +02001999 * @brief Examine whether a node is a key-less list or a non-configuration leaf-list.
Michal Vaskobce7ee32021-02-04 11:05:25 +01002000 *
2001 * @param[in] lysc_node Schema node to examine.
2002 * @return Boolean value whether the @p node is a list with duplicate instances allowed.
2003 */
2004#define lysc_is_dup_inst_list(lysc_node) \
2005 ((lysc_node && (((lysc_node->nodetype == LYS_LIST) && (lysc_node->flags & LYS_KEYLESS)) || \
Michal Vaskoe78faec2021-04-08 17:24:43 +02002006 ((lysc_node->nodetype == LYS_LEAFLIST) && !(lysc_node->flags & LYS_CONFIG_W)))) ? 1 : 0)
Michal Vasko5c123b02020-12-04 14:34:04 +01002007
2008/**
Michal Vaskod5cfa6e2020-11-23 16:56:08 +01002009 * @brief Check whether the schema node data instance existence depends on any when conditions.
2010 * This node and any direct parent choice and case schema nodes are also examined for when conditions.
2011 *
2012 * Be careful, this function is not recursive and checks only conditions that apply to this node directly.
2013 * Meaning if there are any conditions associated with any data parent instance of @p node, they are not returned.
2014 *
2015 * @param[in] node Schema node to examine.
2016 * @return When condition associated with the node data instance, NULL if there is none.
2017 */
2018const struct lysc_when *lysc_has_when(const struct lysc_node *node);
2019
2020/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002021 * @brief Get the groupings linked list of the given (parsed) schema node.
Radek Krejci53ea6152018-12-13 15:21:15 +01002022 * Decides the node's type and in case it has a groupings array, returns it.
2023 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002024 * @return The node's groupings linked list if any, NULL otherwise.
Radek Krejci53ea6152018-12-13 15:21:15 +01002025 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002026const struct lysp_node_grp *lysp_node_groupings(const struct lysp_node *node);
Radek Krejci53ea6152018-12-13 15:21:15 +01002027
2028/**
Radek Krejci056d0a82018-12-06 16:57:25 +01002029 * @brief Get the typedefs sized array of the given (parsed) schema node.
2030 * Decides the node's type and in case it has a typedefs array, returns it.
2031 * @param[in] node Node to examine.
2032 * @return The node's typedefs sized array if any, NULL otherwise.
2033 */
2034const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
2035
2036/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002037 * @brief Get the actions/RPCs linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002038 * Decides the node's type and in case it has a actions/RPCs array, returns it.
2039 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002040 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002041 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002042const struct lysp_node_action *lysp_node_actions(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002043
2044/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002045 * @brief Get the Notifications linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002046 * Decides the node's type and in case it has a Notifications array, returns it.
2047 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002048 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002049 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002050const struct lysp_node_notif *lysp_node_notifs(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002051
2052/**
2053 * @brief Get the children linked list of the given (parsed) schema node.
2054 * Decides the node's type and in case it has a children list, returns it.
2055 * @param[in] node Node to examine.
2056 * @return The node's children linked list if any, NULL otherwise.
2057 */
Michal Vasko544e58a2021-01-28 14:33:41 +01002058const struct lysp_node *lysp_node_child(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002059
2060/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002061 * @brief Get the actions/RPCs linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002062 * Decides the node's type and in case it has a actions/RPCs array, returns it.
2063 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002064 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002065 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002066const struct lysc_node_action *lysc_node_actions(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002067
2068/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002069 * @brief Get the Notifications linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002070 * Decides the node's type and in case it has a Notifications array, returns it.
2071 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002072 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002073 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002074const struct lysc_node_notif *lysc_node_notifs(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002075
2076/**
2077 * @brief Get the children linked list of the given (compiled) schema node.
Michal Vasko2a668712020-10-21 11:48:09 +02002078 *
Michal Vasko544e58a2021-01-28 14:33:41 +01002079 * Note that ::LYS_CHOICE has only ::LYS_CASE children.
2080 * Also, ::LYS_RPC and ::LYS_ACTION have the first child ::LYS_INPUT, its sibling is ::LYS_OUTPUT.
2081 *
Michal Vasko2a668712020-10-21 11:48:09 +02002082 * @param[in] node Node to examine.
Michal Vasko2a668712020-10-21 11:48:09 +02002083 * @return Children linked list if any,
2084 * @return NULL otherwise.
2085 */
Michal Vasko544e58a2021-01-28 14:33:41 +01002086const struct lysc_node *lysc_node_child(const struct lysc_node *node);
Michal Vasko2a668712020-10-21 11:48:09 +02002087
2088/**
Radek Krejci9a3823e2021-01-27 20:26:46 +01002089 * @brief Get the must statements list if present in the @p node
2090 *
2091 * @param[in] node Node to examine.
2092 * @return Pointer to the list of must restrictions ([sized array](@ref sizedarrays))
2093 * @return NULL if there is no must statement in the node, no matter if it is not even allowed or just present
2094 */
2095struct lysc_must *lysc_node_musts(const struct lysc_node *node);
2096
2097/**
2098 * @brief Get the when statements list if present in the @p node
2099 *
2100 * @param[in] node Node to examine.
2101 * @return Pointer to the list of pointers to when statements ([sized array](@ref sizedarrays))
2102 * @return NULL if there is no when statement in the node, no matter if it is not even allowed or just present
2103 */
2104struct lysc_when **lysc_node_when(const struct lysc_node *node);
2105
2106/**
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002107 * @brief Callback to be called for every schema node in a DFS traversal.
2108 *
2109 * @param[in] node Current node.
2110 * @param[in] data Arbitrary user data.
2111 * @param[out] dfs_continue Set to true if the current subtree should be skipped and continue with siblings instead.
2112 * @return LY_SUCCESS on success,
2113 * @return LY_ERR value to terminate DFS and return this value.
2114 */
Michal Vasko8f07dfe2021-03-02 16:10:24 +01002115typedef LY_ERR (*lysc_dfs_clb)(struct lysc_node *node, void *data, ly_bool *dfs_continue);
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002116
2117/**
2118 * @brief DFS traversal of all the schema nodes in a (sub)tree including any actions and nested notifications.
2119 *
2120 * Node with children, actions, and notifications is traversed in this order:
2121 * 1) each child subtree;
2122 * 2) each action subtree;
2123 * 3) each notification subtree.
2124 *
2125 * For algorithm illustration or traversal with actions and notifications skipped, see ::LYSC_TREE_DFS_BEGIN.
2126 *
2127 * @param[in] root Schema root to fully traverse.
2128 * @param[in] dfs_clb Callback to call for each node.
2129 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2130 * @return LY_SUCCESS on success,
2131 * @return LY_ERR value returned by @p dfs_clb.
2132 */
2133LY_ERR lysc_tree_dfs_full(const struct lysc_node *root, lysc_dfs_clb dfs_clb, void *data);
2134
2135/**
2136 * @brief DFS traversal of all the schema nodes in a module including RPCs and notifications.
2137 *
2138 * For more details, see ::lysc_tree_dfs_full().
2139 *
2140 * @param[in] mod Module to fully traverse.
2141 * @param[in] dfs_clb Callback to call for each node.
2142 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2143 * @return LY_SUCCESS on success,
2144 * @return LY_ERR value returned by @p dfs_clb.
2145 */
2146LY_ERR lysc_module_dfs_full(const struct lys_module *mod, lysc_dfs_clb dfs_clb, void *data);
2147
2148/**
Radek Krejci151a5b72018-10-19 14:21:44 +02002149 * @brief Get how the if-feature statement currently evaluates.
2150 *
2151 * @param[in] iff Compiled if-feature statement to evaluate.
Michal Vasko28d78432020-05-26 13:10:53 +02002152 * @return LY_SUCCESS if the statement evaluates to true,
2153 * @return LY_ENOT if it evaluates to false,
2154 * @return LY_ERR on error.
Radek Krejci151a5b72018-10-19 14:21:44 +02002155 */
Michal Vasko28d78432020-05-26 13:10:53 +02002156LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff);
Radek Krejci151a5b72018-10-19 14:21:44 +02002157
2158/**
aPiecekf4a0a192021-08-03 15:14:17 +02002159 * @brief Get how the if-feature statement is evaluated for certain identity.
2160 *
2161 * The function can be called even if the identity does not contain
2162 * if-features, in which case ::LY_SUCCESS is returned.
2163 *
2164 * @param[in] ident Compiled identity statement to evaluate.
2165 * @return LY_SUCCESS if the statement evaluates to true,
2166 * @return LY_ENOT if it evaluates to false,
2167 * @return LY_ERR on error.
2168 */
2169LY_ERR lys_identity_iffeature_value(const struct lysc_ident *ident);
2170
2171/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002172 * @brief Get the next feature in the module or submodules.
Radek Krejci151a5b72018-10-19 14:21:44 +02002173 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002174 * @param[in] last Last returned feature.
2175 * @param[in] pmod Parsed module and submodoules whose features to iterate over.
2176 * @param[in,out] idx Submodule index, set to 0 on first call.
2177 * @return Next found feature, NULL if the last has already been returned.
Radek Krejci151a5b72018-10-19 14:21:44 +02002178 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002179struct lysp_feature *lysp_feature_next(const struct lysp_feature *last, const struct lysp_module *pmod, uint32_t *idx);
Radek Krejci151a5b72018-10-19 14:21:44 +02002180
Radek Krejcibed13942020-10-19 16:06:28 +02002181/**
Radek Krejcidab4f0b2021-03-29 14:07:18 +02002182 * @brief Get pointer to the storage of the specified substatement in the given extension instance.
2183 *
2184 * The function simplifies access into the ::lysc_ext_instance.substmts sized array.
2185 *
2186 * @param[in] ext Compiled extension instance to process.
2187 * @param[in] substmt Extension substatement to search for.
2188 * @param[out] instance_p Pointer where the storage of the @p substmt will be provided. The specific type returned depends
2189 * on the @p substmt and can be found in the documentation of each ::ly_stmt value. Also note that some of the substatements
2190 * (::lysc_node based or flags) can share the storage with other substatements. In case the pointer is NULL, still the return
2191 * code can be used to at least know if the substatement is allowed for the extension.
2192 * @param[out] cardinality_p Pointer to provide allowed cardinality of the substatements in the extension. Note that in some
2193 * cases, the type of the storage depends also on the cardinality of the substatement.
2194 * @return LY_SUCCESS if the @p substmt found.
2195 * @return LY_ENOT in case the @p ext is not able to store (does not allow) the specified @p substmt.
2196 */
2197LY_ERR lysc_ext_substmt(const struct lysc_ext_instance *ext, enum ly_stmt substmt,
2198 void **instance_p, enum ly_stmt_cardinality *cardinality_p);
2199
2200/**
Radek Krejcibed13942020-10-19 16:06:28 +02002201 * @defgroup findxpathoptions Atomize XPath options
2202 * Options to modify behavior of ::lys_find_xpath() and ::lys_find_xpath_atoms() searching for schema nodes in schema tree.
2203 * @{
2204 */
Michal Vaskocdad7122020-11-09 21:04:44 +01002205#define LYS_FIND_XP_SCHEMA 0x08 /**< Apply node access restrictions defined for 'when' and 'must' evaluation. */
2206#define LYS_FIND_XP_OUTPUT 0x10 /**< Search RPC/action output nodes instead of input ones. */
Radek Krejci576f8fa2020-10-26 21:23:58 +01002207/** @} findxpathoptions */
Michal Vasko072de482020-08-05 13:27:21 +02002208
Radek Krejci151a5b72018-10-19 14:21:44 +02002209/**
Michal Vasko40308e72020-10-20 16:38:40 +02002210 * @brief Get all the schema nodes that are required for @p xpath to be evaluated (atoms).
Michal Vasko519fd602020-05-26 12:17:39 +02002211 *
Michal Vasko26512682021-01-11 11:35:40 +01002212 * @param[in] ctx libyang context to use. May be NULL if @p ctx_node is set.
2213 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Radek Krejci8df109d2021-04-23 12:19:08 +02002214 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_VALUE_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002215 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko519fd602020-05-26 12:17:39 +02002216 * @param[out] set Set of found atoms (schema nodes).
2217 * @return LY_SUCCESS on success, @p set is returned.
Michal Vasko40308e72020-10-20 16:38:40 +02002218 * @return LY_ERR value on error.
Michal Vasko519fd602020-05-26 12:17:39 +02002219 */
Michal Vasko26512682021-01-11 11:35:40 +01002220LY_ERR lys_find_xpath_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
2221 uint32_t options, struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002222
Michal Vasko072de482020-08-05 13:27:21 +02002223/**
Michal Vasko40308e72020-10-20 16:38:40 +02002224 * @brief Get all the schema nodes that are required for @p expr to be evaluated (atoms).
Michal Vasko072de482020-08-05 13:27:21 +02002225 *
Michal Vasko26512682021-01-11 11:35:40 +01002226 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002227 * @param[in] cur_mod Current module for the expression (where it was "instantiated").
2228 * @param[in] expr Parsed expression to use.
2229 * @param[in] prefixes Sized array of compiled prefixes.
2230 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
2231 * @param[out] set Set of found atoms (schema nodes).
2232 * @return LY_SUCCESS on success, @p set is returned.
2233 * @return LY_ERR value on error.
2234 */
2235LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod,
2236 const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set);
2237
2238/**
2239 * @brief Evaluate an @p xpath expression on schema nodes.
2240 *
Michal Vasko26512682021-01-11 11:35:40 +01002241 * @param[in] ctx libyang context to use for absolute @p xpath. May be NULL if @p ctx_node is set.
2242 * @param[in] ctx_node XPath schema context node for relative @p xpath. Use NULL for the root node.
Radek Krejci8df109d2021-04-23 12:19:08 +02002243 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_VALUE_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002244 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko072de482020-08-05 13:27:21 +02002245 * @param[out] set Set of found schema nodes.
2246 * @return LY_SUCCESS on success, @p set is returned.
2247 * @return LY_ERR value if an error occurred.
2248 */
Michal Vasko26512682021-01-11 11:35:40 +01002249LY_ERR lys_find_xpath(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath, uint32_t options,
2250 struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002251
2252/**
Radek Krejcibc5644c2020-10-27 14:53:17 +01002253 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2254 *
2255 * @param[in] path Compiled path to use.
2256 * @param[out] set Set of found atoms (schema nodes).
2257 * @return LY_SUCCESS on success, @p set is returned.
2258 * @return LY_ERR value on error.
2259 */
2260LY_ERR lys_find_lypath_atoms(const struct ly_path *path, struct ly_set **set);
2261
2262/**
2263 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2264 *
Michal Vasko26512682021-01-11 11:35:40 +01002265 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2266 * @param[in] ctx_node XPath schema context node for relative @p path. Use NULL for the root node.
Radek Krejcibc5644c2020-10-27 14:53:17 +01002267 * @param[in] path JSON path to examine.
2268 * @param[in] output Search operation output instead of input.
2269 * @param[out] set Set of found atoms (schema nodes).
2270 * @return LY_ERR value on error.
2271 */
2272LY_ERR lys_find_path_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path, ly_bool output,
2273 struct ly_set **set);
2274
2275/**
2276 * @brief Get a schema node based on the given data path (JSON format, see @ref howtoXPath).
2277 *
Michal Vasko26512682021-01-11 11:35:40 +01002278 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2279 * @param[in] ctx_node XPath schema context node for relative @p path. Use NULL for the root node.
Radek Krejcibc5644c2020-10-27 14:53:17 +01002280 * @param[in] path JSON path of the node to get.
2281 * @param[in] output Search operation output instead of input.
2282 * @return Found schema node or NULL.
2283 */
2284const struct lysc_node *lys_find_path(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path,
2285 ly_bool output);
2286
2287/**
Michal Vasko03ff5a72019-09-11 13:49:33 +02002288 * @brief Types of the different schema paths.
2289 */
2290typedef enum {
Michal Vasko65de0402020-08-03 16:34:19 +02002291 LYSC_PATH_LOG, /**< Descriptive path format used in log messages */
2292 LYSC_PATH_DATA /**< Similar to ::LYSC_PATH_LOG except that schema-only nodes (choice, case) are skipped */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002293} LYSC_PATH_TYPE;
2294
2295/**
Radek Krejci327de162019-06-14 12:52:07 +02002296 * @brief Generate path of the given node in the requested format.
2297 *
2298 * @param[in] node Schema path of this node will be generated.
2299 * @param[in] pathtype Format of the path to generate.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002300 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
2301 * If NULL, memory for the complete path is allocated.
2302 * @param[in] buflen Size of the provided @p buffer.
Radek Krejci327de162019-06-14 12:52:07 +02002303 * @return NULL in case of memory allocation error, path of the node otherwise.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002304 * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it.
Radek Krejci327de162019-06-14 12:52:07 +02002305 */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002306char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
Radek Krejci327de162019-06-14 12:52:07 +02002307
2308/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002309 * @brief Available YANG schema tree structures representing YANG module.
2310 */
2311struct lys_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002312 struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */
2313 const char *name; /**< name of the module (mandatory) */
Radek Krejci0af46292019-01-11 16:02:31 +01002314 const char *revision; /**< revision of the module (if present) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002315 const char *ns; /**< namespace of the module (module - mandatory) */
2316 const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */
2317 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
2318 const char *org; /**< party/company responsible for the module */
2319 const char *contact; /**< contact information for the module */
2320 const char *dsc; /**< description of the module */
2321 const char *ref; /**< cross-reference for the module */
2322
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002323 struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */
Radek Krejci0af46292019-01-11 16:02:31 +01002324 struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing.
2325 Available only for implemented modules. */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002326
Radek Krejci80d281e2020-09-14 17:42:54 +02002327 struct lysc_ident *identities; /**< List of compiled identities of the module ([sized array](@ref sizedarrays))
aPiecek6b3d5422021-07-30 15:55:43 +02002328 also contains the disabled identities when their if-feature(s) are evaluated to \"false\",
2329 and also the list is filled even if the module is not implemented.
2330 The list is located here because it avoids problems when the module became implemented in
Radek Krejci80d281e2020-09-14 17:42:54 +02002331 future (no matter if implicitly via augment/deviate or explicitly via
2332 ::lys_set_implemented()). Note that if the module is not implemented (compiled), the
2333 identities cannot be instantiated in data (in identityrefs). */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002334
2335 struct lys_module **augmented_by;/**< List of modules that augment this module ([sized array](@ref sizedarrays)) */
2336 struct lys_module **deviated_by; /**< List of modules that deviate this module ([sized array](@ref sizedarrays)) */
2337
Michal Vasko89b5c072020-10-06 13:52:44 +02002338 ly_bool implemented; /**< flag if the module is implemented, not just imported */
Michal Vasko01db7de2021-04-16 12:23:30 +02002339 ly_bool to_compile; /**< flag marking a module that was changed but not (re)compiled, see
2340 ::LY_CTX_EXPLICIT_COMPILE. */
aPiecek8ca21bd2021-07-26 14:31:01 +02002341 uint8_t latest_revision; /**< Flag to mark the latest available revision, see [latest_revision options](@ref latestrevflags). */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002342};
2343
Radek Krejci151a5b72018-10-19 14:21:44 +02002344/**
aPiecek8ca21bd2021-07-26 14:31:01 +02002345 * @defgroup latestrevflags Options for ::lys_module.latest_revision.
2346 *
2347 * Various information bits of ::lys_module.latest_revision.
2348 *
2349 * @{
2350 */
aPiecek94d330b2021-08-04 11:57:31 +02002351#define LYS_MOD_LATEST_REV 0x01 /**< This is the latest revision of the module in the current context. */
2352#define LYS_MOD_LATEST_SEARCHDIRS 0x02 /**< This is the latest revision of the module found in searchdirs. */
aPiecekd4911ee2021-07-30 07:40:24 +02002353#define LYS_MOD_IMPORTED_REV 0x04 /**< This is the module revision used when importing the module without an explicit revision-date.
2354 It is used for all such imports regardless of any changes made in the context. */
aPiecek8ca21bd2021-07-26 14:31:01 +02002355/** @} latestrevflags */
2356
2357/**
Michal Vasko82c31e62020-07-17 15:30:40 +02002358 * @brief Get the current real status of the specified feature in the module.
2359 *
2360 * If the feature is enabled, but some of its if-features are false, the feature is considered
2361 * disabled.
Radek Krejci151a5b72018-10-19 14:21:44 +02002362 *
2363 * @param[in] module Module where the feature is defined.
2364 * @param[in] feature Name of the feature to inspect.
Michal Vasko82c31e62020-07-17 15:30:40 +02002365 * @return LY_SUCCESS if the feature is enabled,
2366 * @return LY_ENOT if the feature is disabled,
2367 * @return LY_ENOTFOUND if the feature was not found.
Radek Krejci151a5b72018-10-19 14:21:44 +02002368 */
Michal Vasko82c31e62020-07-17 15:30:40 +02002369LY_ERR lys_feature_value(const struct lys_module *module, const char *feature);
Radek Krejcidd4e8d42018-10-16 14:55:43 +02002370
2371/**
Radek Krejcia3045382018-11-22 14:30:31 +01002372 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can
2373 * be from an augment.
2374 *
Radek Krejci8678fa42020-08-18 16:07:28 +02002375 * ::lys_getnext() is supposed to be called sequentially. In the first call, the \p last parameter is usually NULL
Radek Krejcia3045382018-11-22 14:30:31 +01002376 * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module.
2377 * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
2378 * \p parent and \p module parameters.
2379 *
2380 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
2381 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
2382 * all the schema nodes are iteratively returned.
2383 *
2384 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
2385 * @param[in] parent Parent of the subtree where the function starts processing.
2386 * @param[in] module In case of iterating on top level elements, the \p parent is NULL and
2387 * module must be specified.
2388 * @param[in] options [ORed options](@ref sgetnextflags).
2389 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
2390 */
2391const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002392 const struct lysc_module *module, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002393
2394/**
Radek Krejci035dacf2021-02-12 18:25:53 +01002395 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree.
Radek Krejci8678fa42020-08-18 16:07:28 +02002396 *
Radek Krejci035dacf2021-02-12 18:25:53 +01002397 * In contrast to ::lys_getnext(), ::lys_getnext_ext() is limited by the given @p ext instance as a schema tree root.
2398 * If the extension does not contain any schema node, NULL is returned. If the @p parent is provided, the functionality
2399 * is completely the same as ::lys_getnext().
2400 *
2401 * ::lys_getnext_ext() is supposed to be called sequentially. In the first call, the \p last parameter is usually NULL
2402 * and function starts returning i) the first \p parent's child or ii) the first top level element of the given @p ext
2403 * instance. Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
2404 * \p parent and \p ext parameters.
2405 *
2406 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
2407 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
2408 * all the schema nodes are iteratively returned.
2409 *
2410 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
2411 * @param[in] parent Parent of the subtree where the function starts processing.
2412 * @param[in] ext The extension instance to provide a separate schema tree. To consider the top level elements in the tree,
2413 * the \p parent must be NULL. anyway, at least one of @p parent and @p ext parameters must be specified.
2414 * @param[in] options [ORed options](@ref sgetnextflags).
2415 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
2416 */
2417const struct lysc_node *lys_getnext_ext(const struct lysc_node *last, const struct lysc_node *parent,
2418 const struct lysc_ext_instance *ext, uint32_t options);
2419
2420/**
2421 * @defgroup sgetnextflags Options for ::lys_getnext() and ::lys_getnext_ext().
2422 *
2423 * Various options setting behavior of ::lys_getnext() and ::lys_getnext_ext().
Radek Krejci8678fa42020-08-18 16:07:28 +02002424 *
Radek Krejcia3045382018-11-22 14:30:31 +01002425 * @{
2426 */
Radek Krejci8678fa42020-08-18 16:07:28 +02002427#define LYS_GETNEXT_WITHCHOICE 0x01 /**< ::lys_getnext() option to allow returning #LYS_CHOICE nodes instead of looking into them */
2428#define LYS_GETNEXT_NOCHOICE 0x02 /**< ::lys_getnext() option to ignore (kind of conditional) nodes within choice node */
2429#define LYS_GETNEXT_WITHCASE 0x04 /**< ::lys_getnext() option to allow returning #LYS_CASE nodes instead of looking into them */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002430#define LYS_GETNEXT_INTONPCONT 0x08 /**< ::lys_getnext() option to look into non-presence container, instead of returning container itself */
2431#define LYS_GETNEXT_OUTPUT 0x10 /**< ::lys_getnext() option to provide RPC's/action's output schema nodes instead of input schema nodes
Radek Krejci6eeb58f2019-02-22 16:29:37 +01002432 provided by default */
Radek Krejcia3045382018-11-22 14:30:31 +01002433/** @} sgetnextflags */
2434
2435/**
2436 * @brief Get child node according to the specified criteria.
2437 *
2438 * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched.
2439 * @param[in] module module of the node to find. It is also limitation for the children node of the given parent.
2440 * @param[in] name Name of the node to find.
2441 * @param[in] name_len Optional length of the name in case it is not NULL-terminated string.
2442 * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find.
2443 * Used as a bitmask, so multiple nodetypes can be specified.
2444 * @param[in] options [ORed options](@ref sgetnextflags).
2445 * @return Found node if any.
2446 */
Michal Vaskoe444f752020-02-10 12:20:06 +01002447const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002448 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002449
2450/**
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002451 * @brief Make the specific module implemented.
2452 *
Michal Vaskoe8988e92021-01-25 11:26:29 +01002453 * If the module is already implemented but with a different set of features, the whole context is recompiled.
2454 *
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002455 * @param[in] mod Module to make implemented. It is not an error
2456 * to provide already implemented module, it just does nothing.
Michal Vaskoe8988e92021-01-25 11:26:29 +01002457 * @param[in] features Optional array specifying the enabled features terminated with NULL overriding any previous
2458 * feature setting. The feature string '*' enables all the features and array of length 1 with only the terminating
2459 * NULL explicitly disables all the features. In case the parameter is NULL, the features are untouched - left disabled
2460 * in a newly implemented module or with the current features settings in case the module is already implemented.
Michal Vaskoe444f752020-02-10 12:20:06 +01002461 * @return LY_SUCCESS on success.
2462 * @return LY_EDENIED in case the context contains some other revision of the same module which is already implemented.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002463 * @return LY_ERR on other errors during module compilation.
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002464 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002465LY_ERR lys_set_implemented(struct lys_module *mod, const char **features);
Radek Krejcia3045382018-11-22 14:30:31 +01002466
Radek Krejci084289f2019-07-09 17:35:30 +02002467/**
Radek Krejci0935f412019-08-20 16:15:18 +02002468 * @brief Stringify schema nodetype.
Michal Vaskod43d71a2020-08-07 14:54:58 +02002469 *
Radek Krejci0935f412019-08-20 16:15:18 +02002470 * @param[in] nodetype Nodetype to stringify.
2471 * @return Constant string with the name of the node's type.
2472 */
2473const char *lys_nodetype2str(uint16_t nodetype);
2474
Michal Vaskod43d71a2020-08-07 14:54:58 +02002475/**
2476 * @brief Getter for original XPath expression from a parsed expression.
2477 *
2478 * @param[in] path Parsed expression.
2479 * @return Original string expression.
2480 */
2481const char *lyxp_get_expr(const struct lyxp_expr *path);
2482
Radek Krejci2ff0d572020-05-21 15:27:28 +02002483/** @} schematree */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002484
Radek Krejci70853c52018-10-15 14:46:16 +02002485#ifdef __cplusplus
2486}
2487#endif
2488
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002489#endif /* LY_TREE_SCHEMA_H_ */