blob: d54ac09bcb2c27eaeae1aa75d82c021ad8f63d92 [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
Radek Krejcie7b95092019-05-15 11:03:07 +020025#include "log.h"
26#include "tree.h"
Radek Krejcice8c1592018-10-29 15:35:51 +010027
Radek Krejci70853c52018-10-15 14:46:16 +020028#ifdef __cplusplus
29extern "C" {
30#endif
31
Radek Krejcica376bd2020-06-11 16:04:06 +020032struct ly_ctx;
Radek Krejci47fab892020-11-05 17:02:41 +010033struct ly_path;
Radek Krejcica376bd2020-06-11 16:04:06 +020034struct ly_set;
Radek Krejci47fab892020-11-05 17:02:41 +010035struct lys_module;
36struct lysc_node;
37struct lyxp_expr;
Radek Krejcica376bd2020-06-11 16:04:06 +020038
Radek Krejci5aeea3a2018-09-05 13:29:36 +020039/**
Radek Krejci8678fa42020-08-18 16:07:28 +020040 * @page howtoSchema YANG Modules
41 *
42 * To be able to work with YANG data instances, libyang has to represent YANG data models. All the processed modules are stored
43 * in libyang [context](@ref howtoContext) and loaded using [parser functions](@ref howtoSchemaParsers). It means, that there is
44 * no way to create/change YANG module programmatically. However, all the YANG model definitions are available and can be examined
45 * through the C structures. All the context's modules together form YANG Schema for the data being instantiated.
46 *
47 * Any YANG module is represented as ::lys_module. In fact, the module is represented in two different formats. As ::lys_module.parsed,
48 * there is a parsed schema reflecting the source YANG module. It is exactly what is read from the input. This format is good for
49 * converting from one format to another (YANG to YIN and vice versa), but it is not very useful for validating/manipulating YANG
50 * data. Therefore, there is ::lys_module.compiled storing the compiled YANG module. It is based on the parsed module, but all the
51 * 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
52 * `uses` or `type` references. This split also means, that the YANG module is fully validated after compilation of the parsed
53 * representation of the module. YANG submodules are available only in the parsed representation. When a submodule is compiled, it
54 * is fully integrated into its main module.
55 *
56 * The context can contain even modules without the compiled representation. Such modules are still useful as imports of other
57 * modules. The grouping or typedef definition can be even compiled into the importing modules. This is actually the main
58 * difference between the imported and implemented modules in the libyang context. The implemented modules are compiled while the
59 * imported modules are only parsed.
60 *
Radek Krejcib100b192020-10-26 08:37:45 +010061 * By default, the module is implemented (and compiled) in case it is explicitly loaded or referenced in another module as
62 * target of leafref, augment or deviation. This behavior can be changed via context options ::LY_CTX_ALL_IMPLEMENTED, when
63 * all the modules in the context are marked as implemented (note the problem with multiple revisions of a single module),
64 * or by ::LY_CTX_REF_IMPLEMENTED option, extending the set of references making the module implemented by when, must and
65 * default statements.
Radek Krejci8678fa42020-08-18 16:07:28 +020066 *
67 * All modules with deviation definition are always marked as implemented. The imported (not implemented) module can be set implemented by ::lys_set_implemented(). But
68 * the implemented module cannot be changed back to just imported module. Note also that only one revision of a specific module
69 * can be implemented in a single context. The imported modules are used only as a
70 * source of definitions for types and groupings for uses statements. The data in such modules are ignored - caller
71 * is not allowed to create the data (including instantiating identities) defined in the model via data parsers,
72 * the default nodes are not added into any data tree and mandatory nodes are not checked in the data trees.
73 *
Michal Vasko14ed9cd2021-01-28 14:16:25 +010074 * 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 +020075 * function, variable, ...) used by a caller application unless ::LY_CTX_SET_PRIV_PARSED is set, in that case
76 * the ::lysc_node.priv pointers are used by libyang.
Radek Krejci8678fa42020-08-18 16:07:28 +020077 * Note that the object is not freed by libyang when the context is being destroyed. So the caller is responsible
78 * for freeing the provided structure after the context is destroyed or the private pointer is set to NULL in
79 * appropriate schema nodes where the object was previously set. This can be automated via destructor function
80 * to free these private objects. The destructor is passed to the ::ly_ctx_destroy() function.
81 *
82 * Despite all the schema structures and their members are available as part of the libyang API and callers can use
83 * it to navigate through the schema tree structure or to obtain various information, we recommend to use the following
84 * macros for the specific actions.
85 * - ::LYSC_TREE_DFS_BEGIN and ::LYSC_TREE_DFS_END to traverse the schema tree (depth-first).
86 * - ::LY_LIST_FOR and ::LY_ARRAY_FOR as described on @ref howtoStructures page.
87 *
88 * Further information about modules handling can be found on the following pages:
89 * - @subpage howtoSchemaParsers
90 * - @subpage howtoSchemaFeatures
91 * - @subpage howtoPlugins
92 * - @subpage howtoSchemaPrinters
93 *
94 * \note There are many functions to access information from the schema trees. Details are available in
95 * the [Schema Tree module](@ref schematree).
96 *
97 * For information about difference between implemented and imported modules, see the
98 * [context description](@ref howtoContext).
99 *
100 * Functions List (not assigned to above subsections)
101 * --------------------------------------------------
102 * - ::lys_getnext()
103 * - ::lys_nodetype2str()
104 * - ::lys_set_implemented()
Radek Krejci8678fa42020-08-18 16:07:28 +0200105 *
Michal Vaskod5cfa6e2020-11-23 16:56:08 +0100106 * - ::lysc_has_when()
107 *
Michal Vasko544e58a2021-01-28 14:33:41 +0100108 * - ::lysc_node_child()
Radek Krejci8678fa42020-08-18 16:07:28 +0200109 * - ::lysc_node_actions()
110 * - ::lysc_node_notifs()
111 *
Michal Vasko544e58a2021-01-28 14:33:41 +0100112 * - ::lysp_node_child()
Radek Krejci8678fa42020-08-18 16:07:28 +0200113 * - ::lysp_node_actions()
114 * - ::lysp_node_notifs()
115 * - ::lysp_node_groupings()
116 * - ::lysp_node_typedefs()
117 */
118
119/**
120 * @page howtoSchemaFeatures YANG Features
121 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100122 * YANG feature statement is an important part of the language which can significantly affect the meaning of the schemas.
123 * Modifying features may have similar effects as loading/removing schema from the context so it is limited to context
124 * preparation period before working with data. YANG features, respectively their use in if-feature
125 * statements, are evaluated as part of schema compilation so a feature-specific compiled schema tree is generated
126 * as a result.
Radek Krejci8678fa42020-08-18 16:07:28 +0200127 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100128 * To enable any features, they must currently be specified when implementing a new schema with ::lys_parse() or
129 * ::ly_ctx_load_module(). To later examine what the status of a feature is, check its ::LYS_FENABLED flag or
130 * 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 +0200131 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100132 * To iterate over all features of a particular YANG module, use ::lysp_feature_next().
Radek Krejci8678fa42020-08-18 16:07:28 +0200133 *
134 * Note, that the feature's state can affect some of the output formats (e.g. Tree format).
135 *
136 * Functions List
137 * --------------
Radek Krejci8678fa42020-08-18 16:07:28 +0200138 * - ::lys_feature_value()
Radek Krejci8678fa42020-08-18 16:07:28 +0200139 * - ::lysc_iffeature_value()
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100140 * - ::lysp_feature_next()
Radek Krejci8678fa42020-08-18 16:07:28 +0200141 */
142
143/**
Radek Krejci2ff0d572020-05-21 15:27:28 +0200144 * @ingroup trees
Radek Krejci8678fa42020-08-18 16:07:28 +0200145 * @defgroup schematree Schema Tree
Radek Krejci2ff0d572020-05-21 15:27:28 +0200146 * @{
147 *
148 * Data structures and functions to manipulate and access schema tree.
149 */
150
Michal Vasko64246d82020-08-19 12:35:00 +0200151/* *INDENT-OFF* */
152
Radek Krejci2ff0d572020-05-21 15:27:28 +0200153/**
Michal Vasko208a04a2020-10-21 15:17:12 +0200154 * @brief Macro to iterate via all elements in a schema (sub)tree including input and output.
155 * Note that __actions__ and __notifications__ of traversed nodes __are ignored__! To traverse
156 * on all the nodes including those, use ::lysc_tree_dfs_full() instead.
157 *
158 * 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 +0200159 *
160 * The function follows deep-first search algorithm:
161 * <pre>
162 * 1
163 * / \
164 * 2 4
165 * / / \
166 * 3 5 6
167 * </pre>
168 *
169 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
Radek Krejci2a9fc652021-01-22 17:44:34 +0100170 * START can be any of the lysc_node* types (including lysc_node_action and lysc_node_notif),
Radek Krejci0935f412019-08-20 16:15:18 +0200171 * ELEM variable must be of the struct lysc_node* type.
172 *
173 * To skip a particular subtree, instead of the continue statement, set LYSC_TREE_DFS_continue
174 * variable to non-zero value.
175 *
176 * Use with opening curly bracket '{' after the macro.
177 *
178 * @param START Pointer to the starting element processed first.
179 * @param ELEM Iterator intended for use in the block.
180 */
181#define LYSC_TREE_DFS_BEGIN(START, ELEM) \
Radek Krejci857189e2020-09-01 13:26:36 +0200182 { ly_bool LYSC_TREE_DFS_continue = 0; struct lysc_node *LYSC_TREE_DFS_next; \
Michal Vasko14ed9cd2021-01-28 14:16:25 +0100183 for ((ELEM) = (LYSC_TREE_DFS_next) = (struct lysc_node *)(START); \
Radek Krejci0935f412019-08-20 16:15:18 +0200184 (ELEM); \
185 (ELEM) = (LYSC_TREE_DFS_next), LYSC_TREE_DFS_continue = 0)
186
187/**
188 * @brief Macro to iterate via all elements in a (sub)tree. This is the closing part
189 * to the #LYSC_TREE_DFS_BEGIN - they always have to be used together.
190 *
191 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
Radek Krejci2a9fc652021-01-22 17:44:34 +0100192 * 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 +0200193 * ELEM variable must be pointer to the lysc_node type.
194 *
195 * Use with closing curly bracket '}' after the macro.
196 *
197 * @param START Pointer to the starting element processed first.
198 * @param ELEM Iterator intended for use in the block.
199 */
Radek Krejci0935f412019-08-20 16:15:18 +0200200#define LYSC_TREE_DFS_END(START, ELEM) \
201 /* select element for the next run - children first */ \
202 if (LYSC_TREE_DFS_continue) { \
203 (LYSC_TREE_DFS_next) = NULL; \
204 } else { \
Michal Vasko544e58a2021-01-28 14:33:41 +0100205 (LYSC_TREE_DFS_next) = (struct lysc_node *)lysc_node_child(ELEM); \
Michal Vasko208a04a2020-10-21 15:17:12 +0200206 } \
Radek Krejci0935f412019-08-20 16:15:18 +0200207 if (!(LYSC_TREE_DFS_next)) { \
Michal Vasko208a04a2020-10-21 15:17:12 +0200208 /* no children, try siblings */ \
209 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
Radek Krejci0935f412019-08-20 16:15:18 +0200210 } \
211 while (!(LYSC_TREE_DFS_next)) { \
212 /* parent is already processed, go to its sibling */ \
Radek Krejci7d95fbb2021-01-26 17:33:13 +0100213 (ELEM) = (ELEM)->parent; \
Michal Vasko208a04a2020-10-21 15:17:12 +0200214 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
215 } }
216
217/**
218 * @brief Helper macro for #LYSC_TREE_DFS_END, should not be used directly!
219 */
220#define _LYSC_TREE_DFS_NEXT(START, ELEM, NEXT) \
221 if ((ELEM) == (struct lysc_node *)(START)) { \
222 /* we are done, no next element to process */ \
223 break; \
224 } \
Michal Vasko544e58a2021-01-28 14:33:41 +0100225 (NEXT) = (ELEM)->next;
Radek Krejci0935f412019-08-20 16:15:18 +0200226
Michal Vasko64246d82020-08-19 12:35:00 +0200227/* *INDENT-ON* */
228
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200229#define LY_REV_SIZE 11 /**< revision data string length (including terminating NULL byte) */
230
Radek Krejcide7a9c42021-03-10 13:13:06 +0100231/**
232 * @defgroup schemanodetypes Schema Node Types
233 * Values of the ::lysp_node.nodetype and ::lysc_node.nodetype members.
234 * @{
235 */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200236#define LYS_UNKNOWN 0x0000 /**< uninitalized unknown statement node */
237#define LYS_CONTAINER 0x0001 /**< container statement node */
238#define LYS_CHOICE 0x0002 /**< choice statement node */
239#define LYS_LEAF 0x0004 /**< leaf statement node */
240#define LYS_LEAFLIST 0x0008 /**< leaf-list statement node */
241#define LYS_LIST 0x0010 /**< list statement node */
242#define LYS_ANYXML 0x0020 /**< anyxml statement node */
243#define LYS_ANYDATA 0x0060 /**< anydata statement node, in tests it can be used for both #LYS_ANYXML and #LYS_ANYDATA */
244#define LYS_CASE 0x0080 /**< case statement node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200245
Michal Vasko7f45cf22020-10-01 12:49:44 +0200246#define LYS_RPC 0x0100 /**< RPC statement node */
247#define LYS_ACTION 0x0200 /**< action statement node */
248#define LYS_NOTIF 0x0400 /**< notification statement node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200249
Michal Vasko7f45cf22020-10-01 12:49:44 +0200250#define LYS_USES 0x0800 /**< uses statement node */
251#define LYS_INPUT 0x1000 /**< RPC/action input node */
252#define LYS_OUTPUT 0x2000 /**< RPC/action output node */
253#define LYS_GROUPING 0x4000
254#define LYS_AUGMENT 0x8000
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100255
Radek Krejcif13b87b2020-12-01 22:02:17 +0100256#define LYS_NODETYPE_MASK 0xffff /**< Mask for nodetypes, the value is limited for 16 bits */
Radek Krejcide7a9c42021-03-10 13:13:06 +0100257/** @} schemanodetypes */
Radek Krejcif13b87b2020-12-01 22:02:17 +0100258
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200259/**
Radek Krejci61837f72021-03-02 19:53:59 +0100260 * @brief Generic test for operation statements.
261 *
262 * This macro matches a subset of schema nodes that maps to common ::lysc_node or ::lysp_node structures. To match all
263 * such nodes, use ::LY_STMT_IS_NODE()
264 *
265 * This macro matches action and RPC.
Radek Krejci6b88a462021-02-17 12:39:34 +0100266 */
267#define LY_STMT_IS_OP(STMT) (((STMT) == LY_STMT_ACTION) || ((STMT) == LY_STMT_RPC))
268
269/**
Radek Krejci61837f72021-03-02 19:53:59 +0100270 * @brief Generic test for schema data nodes.
Radek Krejci6b88a462021-02-17 12:39:34 +0100271 *
Radek Krejci61837f72021-03-02 19:53:59 +0100272 * This macro matches a subset of schema nodes that maps to common ::lysc_node or ::lysp_node structures. To match all
273 * such nodes, use ::LY_STMT_IS_NODE()
Radek Krejci6b88a462021-02-17 12:39:34 +0100274 *
Radek Krejci61837f72021-03-02 19:53:59 +0100275 * This macro matches anydata, anyxml, augment, case, choice, container, grouping, leaf, leaf-list, list and uses. Note
276 * 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 +0100277 */
Radek Krejci61837f72021-03-02 19:53:59 +0100278#define LY_STMT_IS_DATA_NODE(STMT) (((STMT) >= LY_STMT_ANYDATA) && ((STMT) <= LY_STMT_LIST))
279
280/**
281 * @brief Generic test for any schema node that maps to common ::lysc_node or ::lysp_node structures.
282 *
283 * Note that the list of statements that can appear in parsed or compiled schema trees differs (e.g. no uses in compiled tree).
284 *
285 * To check for some of the subsets of this test, try ::LY_STMT_IS_DATA_NODE() or ::LY_STMT_IS_OP().
286 *
287 * This macro matches action, anydata, anyxml, augment, case, choice, container, grouping, input, leaf, leaf-list, list,
288 * notification, output, RPC and uses.
289 */
290#define LY_STMT_IS_NODE(STMT) (((STMT) >= LY_STMT_NOTIFICATION) && ((STMT) <= LY_STMT_LIST))
Radek Krejci6b88a462021-02-17 12:39:34 +0100291
292/**
Radek Krejcid6b76452019-09-03 17:03:03 +0200293 * @brief List of YANG statements
294 */
295enum ly_stmt {
296 LY_STMT_NONE = 0,
Radek Krejci6b88a462021-02-17 12:39:34 +0100297
298 LY_STMT_NOTIFICATION, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node_notif *`.
299 The RPCs/Actions and Notifications are expected in a separated lists than the rest of
300 data definition nodes as it is done in generic structures of libyang. */
Radek Krejci61837f72021-03-02 19:53:59 +0100301 LY_STMT_INPUT,
302 LY_STMT_OUTPUT,
Radek Krejci6b88a462021-02-17 12:39:34 +0100303
304/* LY_STMT_IS_OP */
Radek Krejcieccf6602021-02-05 19:42:54 +0100305 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 +0100306 The RPCs/Actions and Notifications are expected in a separated lists than the rest of
307 data definition nodes as it is done in generic structures of libyang. */
308 LY_STMT_RPC, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node_action *`.
309 The RPCs/Actions and Notifications are expected in a separated lists than the rest of
310 data definition nodes as it is done in generic structures of libyang. */
311
Radek Krejci61837f72021-03-02 19:53:59 +0100312/* LY_STMT_IS_DATA_NODE */
Radek Krejcieccf6602021-02-05 19:42:54 +0100313 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 +0100314 Note that due to ::lysc_node compatibility the anydata is expected to be actually
315 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
316 Notifications are expected in a separated lists as it is done in generic structures
317 of libyang. */
Radek Krejcieccf6602021-02-05 19:42:54 +0100318 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 +0100319 Note that due to ::lysc_node compatibility the anyxml is expected to be actually
320 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
321 Notifications are expected in a separated lists as it is done in generic structures
322 of libyang. */
323 LY_STMT_AUGMENT,
324 LY_STMT_CASE, /**< TODO is it possible to compile cases without the parent choice? */
325 LY_STMT_CHOICE, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
326 Note that due to ::lysc_node compatibility the choice is expected to be actually
327 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
328 Notifications are expected in a separated lists as it is done in generic structures
329 of libyang. */
330 LY_STMT_CONTAINER, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
331 Note that due to ::lysc_node compatibility the container is expected to be actually
332 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
333 Notifications are expected in a separated lists as it is done in generic structures
334 of libyang. */
335 LY_STMT_GROUPING,
336 LY_STMT_LEAF, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
337 Note that due to ::lysc_node compatibility the leaf is expected to be actually
338 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
339 Notifications are expected in a separated lists as it is done in generic structures
340 of libyang. */
341 LY_STMT_LEAF_LIST, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
342 Note that due to ::lysc_node compatibility the leaf-list is expected to be actually
343 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
344 Notifications are expected in a separated lists as it is done in generic structures
345 of libyang. */
346 LY_STMT_LIST, /**< in ::lysc_ext_substmt.storage stored as a pointer to linked list of `struct lysc_node *`.
347 Note that due to ::lysc_node compatibility the list is expected to be actually
348 mixed in the linked list with other ::lysc_node based nodes. The RPCs/Actions and
349 Notifications are expected in a separated lists as it is done in generic structures
350 of libyang. */
351 LY_STMT_USES,
352
353/* rest */
Radek Krejcid6b76452019-09-03 17:03:03 +0200354 LY_STMT_ARGUMENT,
Radek Krejcid6b76452019-09-03 17:03:03 +0200355 LY_STMT_BASE,
356 LY_STMT_BELONGS_TO,
357 LY_STMT_BIT,
Radek Krejcieccf6602021-02-05 19:42:54 +0100358 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 +0200359 LY_STMT_CONTACT,
Radek Krejcieccf6602021-02-05 19:42:54 +0100360 LY_STMT_DEFAULT,
Radek Krejci6b88a462021-02-17 12:39:34 +0100361 LY_STMT_DESCRIPTION, /**< in ::lysc_ext_substmt.storage stored as a pointer to `const char *` (cardinality < #LY_STMT_CARD_SOME)
362 or as a pointer to a [sized array](@ref sizedarrays) `const char **` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200363 LY_STMT_DEVIATE,
364 LY_STMT_DEVIATION,
365 LY_STMT_ENUM,
366 LY_STMT_ERROR_APP_TAG,
367 LY_STMT_ERROR_MESSAGE,
368 LY_STMT_EXTENSION,
Radek Krejcieccf6602021-02-05 19:42:54 +0100369 LY_STMT_EXTENSION_INSTANCE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200370 LY_STMT_FEATURE,
371 LY_STMT_FRACTION_DIGITS,
Radek Krejcid6b76452019-09-03 17:03:03 +0200372 LY_STMT_IDENTITY,
Radek Krejci6b88a462021-02-17 12:39:34 +0100373 LY_STMT_IF_FEATURE, /**< if-feature statements are not compiled, they are evaluated and the parent statement is
374 preserved only in case the evaluation of all the if-feature statements is true.
375 Therefore there is no storage expected. */
Radek Krejcid6b76452019-09-03 17:03:03 +0200376 LY_STMT_IMPORT,
377 LY_STMT_INCLUDE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200378 LY_STMT_KEY,
Radek Krejcid6b76452019-09-03 17:03:03 +0200379 LY_STMT_LENGTH,
Radek Krejcieccf6602021-02-05 19:42:54 +0100380 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 +0200381 LY_STMT_MAX_ELEMENTS,
382 LY_STMT_MIN_ELEMENTS,
383 LY_STMT_MODIFIER,
384 LY_STMT_MODULE,
385 LY_STMT_MUST,
386 LY_STMT_NAMESPACE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200387 LY_STMT_ORDERED_BY,
388 LY_STMT_ORGANIZATION,
Radek Krejcid6b76452019-09-03 17:03:03 +0200389 LY_STMT_PATH,
390 LY_STMT_PATTERN,
391 LY_STMT_POSITION,
392 LY_STMT_PREFIX,
393 LY_STMT_PRESENCE,
394 LY_STMT_RANGE,
Radek Krejci6b88a462021-02-17 12:39:34 +0100395 LY_STMT_REFERENCE, /**< in ::lysc_ext_substmt.storage stored as a pointer to `const char *` (cardinality < #LY_STMT_CARD_SOME)
396 or as a pointer to a [sized array](@ref sizedarrays) `const char **` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200397 LY_STMT_REFINE,
398 LY_STMT_REQUIRE_INSTANCE,
399 LY_STMT_REVISION,
400 LY_STMT_REVISION_DATE,
Radek Krejcieccf6602021-02-05 19:42:54 +0100401 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 +0200402 LY_STMT_SUBMODULE,
Radek Krejcieccf6602021-02-05 19:42:54 +0100403 LY_STMT_TYPE, /**< in ::lysc_ext_substmt.storage stored as a pointer to `struct lysc_type *` (cardinality < #LY_STMT_CARD_SOME)
404 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_type **` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200405 LY_STMT_TYPEDEF,
406 LY_STMT_UNIQUE,
Radek Krejcieccf6602021-02-05 19:42:54 +0100407 LY_STMT_UNITS, /**< in ::lysc_ext_substmt.storage stored as a pointer to `const char *` (cardinality < #LY_STMT_CARD_SOME)
408 or as a pointer to a [sized array](@ref sizedarrays) `const char **` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200409 LY_STMT_VALUE,
410 LY_STMT_WHEN,
411 LY_STMT_YANG_VERSION,
Radek Krejci2b0f0f12021-03-02 16:02:35 +0100412 LY_STMT_YIN_ELEMENT,
413
414 /* separated from the list of statements
415 * the following tokens are part of the syntax and parsers have to work
416 * with them, but they are not a standard YANG statements
417 */
418 LY_STMT_SYNTAX_SEMICOLON,
419 LY_STMT_SYNTAX_LEFT_BRACE,
420 LY_STMT_SYNTAX_RIGHT_BRACE,
421
422 /*
423 * YIN-specific tokens, still they are part of the syntax, but not the standard statements
424 */
425 LY_STMT_ARG_TEXT,
426 LY_STMT_ARG_VALUE
Radek Krejcid6b76452019-09-03 17:03:03 +0200427};
428
429/**
Radek Krejcif8ca8192021-03-02 16:50:06 +0100430 * @brief Stringify statement identifier.
431 * @param[in] stmt The statement identifier to stringify.
432 * @return Constant string representation of the given @p stmt.
433 */
434const char *ly_stmt2str(enum ly_stmt stmt);
435
436/**
Radek Krejci39b7fc22021-02-26 23:29:18 +0100437 * @brief Convert nodetype to statement identifier
438 * @param[in] nodetype Nodetype to convert.
439 * @return Statement identifier representing the given @p nodetype.
440 */
441enum ly_stmt lys_nodetype2stmt(uint16_t nodetype);
442
443/**
Radek Krejcib1c11532021-03-29 14:14:19 +0200444 * @brief Possible cardinalities of the YANG statements.
445 *
446 * Used in extensions plugins to define cardinalities of the extension instance substatements.
447 */
448enum ly_stmt_cardinality {
449 LY_STMT_CARD_OPT, /* 0..1 */
450 LY_STMT_CARD_MAND, /* 1 */
451 LY_STMT_CARD_SOME, /* 1..n */
452 LY_STMT_CARD_ANY /* 0..n */
453};
454
455/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200456 * @brief YANG import-stmt
457 */
458struct lysp_import {
Radek Krejci086c7132018-10-26 15:29:04 +0200459 struct lys_module *module; /**< pointer to the imported module
460 (mandatory, but resolved when the referring module is completely parsed) */
461 const char *name; /**< name of the imported module (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200462 const char *prefix; /**< prefix for the data from the imported schema (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200463 const char *dsc; /**< description */
464 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200465 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100466 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200467 char rev[LY_REV_SIZE]; /**< revision-date of the imported module */
468};
469
470/**
471 * @brief YANG include-stmt
472 */
473struct lysp_include {
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100474 struct lysp_submodule *submodule;/**< pointer to the parsed submodule structure
Radek Krejci086c7132018-10-26 15:29:04 +0200475 (mandatory, but resolved when the referring module is completely parsed) */
476 const char *name; /**< name of the included submodule (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200477 const char *dsc; /**< description */
478 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200479 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200480 char rev[LY_REV_SIZE]; /**< revision-date of the included submodule */
Radek Krejci771928a2021-01-19 13:42:36 +0100481 ly_bool injected; /**< flag to mark includes copied into main module from submodules,
482 only for backward compatibility with YANG 1.0, which does not require the
483 main module to include all submodules. */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200484};
485
486/**
487 * @brief YANG extension-stmt
488 */
489struct lysp_ext {
490 const char *name; /**< extension name */
Radek Krejci9f87b0c2021-03-05 14:45:26 +0100491 const char *argname; /**< argument name, NULL if not specified */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200492 const char *dsc; /**< description statement */
493 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200494 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200495 uint16_t flags; /**< LYS_STATUS_* and LYS_YINELEM_* values (@ref snodeflags) */
Michal Vasko5fe75f12020-03-02 13:52:37 +0100496
Radek Krejci720d2612021-03-03 19:44:22 +0100497 struct lysc_ext *compiled; /**< pointer to the compiled extension definition.
498 The extension definition is compiled only if there is compiled extension instance,
499 otherwise this pointer remains NULL. The compiled extension definition is shared
500 among all extension instances. */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200501};
502
503/**
504 * @brief Helper structure for generic storage of the extension instances content.
505 */
506struct lysp_stmt {
507 const char *stmt; /**< identifier of the statement */
508 const char *arg; /**< statement's argument */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100509 LY_PREFIX_FORMAT format; /**< prefix format of the identifier/argument (::LY_PREF_XML is YIN format) */
Radek Krejci0b013302021-03-29 15:22:32 +0200510 void *prefix_data; /**< Format-specific data for prefix resolution (see ly_resolve_prefix()) */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100511
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200512 struct lysp_stmt *next; /**< link to the next statement */
Michal Vaskobc2559f2018-09-07 10:17:50 +0200513 struct lysp_stmt *child; /**< list of the statement's substatements (linked list) */
David Sedlákb9d75c42019-08-14 10:49:42 +0200514 uint16_t flags; /**< statement flags, can be set to LYS_YIN_ATTR */
Radek Krejci335332a2019-09-05 13:03:35 +0200515 enum ly_stmt kw; /**< numeric respresentation of the stmt value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200516};
517
David Sedlákae4b4512019-08-14 10:45:56 +0200518#define LYS_YIN 0x1 /**< used to specify input format of extension instance */
519
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200520/**
521 * @brief YANG extension instance
522 */
523struct lysp_ext_instance {
David Sedlákbbd06ca2019-06-27 14:15:38 +0200524 const char *name; /**< extension identifier, including possible prefix */
525 const char *argument; /**< optional value of the extension's argument */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100526 LY_PREFIX_FORMAT format; /**< prefix format of the extension name/argument (::LY_PREF_XML is YIN format) */
527 void *prefix_data; /**< Format-specific data for prefix resolution
Radek Krejci0b013302021-03-29 15:22:32 +0200528 (see ly_resolve_prefix()) */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100529
Radek Krejci5f9a3672021-03-05 21:35:22 +0100530 struct lysp_stmt *child; /**< list of the extension's substatements (linked list) */
531
Radek Krejci335332a2019-09-05 13:03:35 +0200532 void *parent; /**< pointer to the parent element holding the extension instance(s), use
Radek Krejciab430862021-03-02 20:13:40 +0100533 ::lysp_ext_instance#parent_stmt to access the schema element */
Radek Krejciab430862021-03-02 20:13:40 +0100534 enum ly_stmt parent_stmt; /**< value identifying placement of the extension instance */
535 LY_ARRAY_COUNT_TYPE parent_stmt_index; /**< in case the instance is in a substatement, this identifies
536 the index of that substatement in its [sized array](@ref sizedarrays) (if any) */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100537 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200538};
539
540/**
541 * @brief YANG feature-stmt
542 */
543struct lysp_feature {
544 const char *name; /**< feature name (mandatory) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100545 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
546 struct lysc_iffeature *iffeatures_c; /**< compiled if-features */
547 struct lysp_feature **depfeatures; /**< list of pointers to other features depending on this one
548 ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200549 const char *dsc; /**< description statement */
550 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200551 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100552 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values and
553 LYS_FENABLED are allowed */
554};
555
556/**
557 * @brief Compiled YANG if-feature-stmt
558 */
559struct lysc_iffeature {
560 uint8_t *expr; /**< 2bits array describing the if-feature expression in prefix format, see @ref ifftokens */
561 struct lysp_feature **features; /**< array of pointers to the features used in expression ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200562};
563
564/**
Michal Vasko7f45cf22020-10-01 12:49:44 +0200565 * @brief Qualified name (optional prefix followed by an identifier).
566 */
567struct lysp_qname {
568 const char *str; /**< qualified name string */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200569 const struct lysp_module *mod; /**< module to resolve any prefixes found in the string, it must be
Michal Vasko7f45cf22020-10-01 12:49:44 +0200570 stored explicitly because of deviations/refines */
571};
572
573/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200574 * @brief YANG identity-stmt
575 */
576struct lysp_ident {
577 const char *name; /**< identity name (mandatory), including possible prefix */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200578 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200579 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200580 const char *dsc; /**< description statement */
581 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200582 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200583 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
584};
585
Michal Vasko71e64ca2018-09-07 16:30:29 +0200586/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200587 * @brief Covers restrictions: range, length, pattern, must
588 */
589struct lysp_restr {
Radek Krejcif13b87b2020-12-01 22:02:17 +0100590#define LYSP_RESTR_PATTERN_ACK 0x06
591#define LYSP_RESTR_PATTERN_NACK 0x15
Michal Vasko7f45cf22020-10-01 12:49:44 +0200592 struct lysp_qname arg; /**< The restriction expression/value (mandatory);
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200593 in case of pattern restriction, the first byte has a special meaning:
594 0x06 (ACK) for regular match and 0x15 (NACK) for invert-match */
595 const char *emsg; /**< error-message */
596 const char *eapptag; /**< error-app-tag value */
597 const char *dsc; /**< description */
598 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200599 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200600};
601
602/**
Michal Vasko71e64ca2018-09-07 16:30:29 +0200603 * @brief YANG revision-stmt
604 */
605struct lysp_revision {
Radek Krejcicb3e6472021-01-06 08:19:01 +0100606 char date[LY_REV_SIZE]; /**< revision date (madatory) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200607 const char *dsc; /**< description statement */
608 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200609 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200610};
611
612/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200613 * @brief Enumeration/Bit value definition
614 */
615struct lysp_type_enum {
616 const char *name; /**< name (mandatory) */
617 const char *dsc; /**< description statement */
618 const char *ref; /**< reference statement */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200619 int64_t value; /**< enum's value or bit's position */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200620 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200621 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200622 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
623 values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200624};
625
626/**
627 * @brief YANG type-stmt
628 *
629 * Some of the items in the structure may be mandatory, but it is necessary to resolve the type's base type first
630 */
631struct lysp_type {
632 const char *name; /**< name of the type (mandatory) */
633 struct lysp_restr *range; /**< allowed values range - numerical, decimal64 */
634 struct lysp_restr *length; /**< allowed length of the value - string, binary */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200635 struct lysp_restr *patterns; /**< list of patterns ([sized array](@ref sizedarrays)) - string */
636 struct lysp_type_enum *enums; /**< list of enum-stmts ([sized array](@ref sizedarrays)) - enum */
637 struct lysp_type_enum *bits; /**< list of bit-stmts ([sized array](@ref sizedarrays)) - bits */
Michal Vasko004d3152020-06-11 19:59:22 +0200638 struct lyxp_expr *path; /**< parsed path - leafref */
Radek Krejci151a5b72018-10-19 14:21:44 +0200639 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) - identityref */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200640 struct lysp_type *types; /**< list of sub-types ([sized array](@ref sizedarrays)) - union */
641 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200642
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200643 const struct lysp_module *pmod; /**< (sub)module where the type is defined (needed for deviations) */
Radek Krejci2167ee12018-11-02 16:09:07 +0100644 struct lysc_type *compiled; /**< pointer to the compiled type */
645
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200646 uint8_t fraction_digits; /**< number of fraction digits - decimal64 */
647 uint8_t require_instance; /**< require-instance flag - leafref, instance */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100648 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200649};
650
651/**
652 * @brief YANG typedef-stmt
653 */
654struct lysp_tpdf {
655 const char *name; /**< name of the newly defined type (mandatory) */
656 const char *units; /**< units of the newly defined type */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200657 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 +0200658 const char *dsc; /**< description statement */
659 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200660 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200661 struct lysp_type type; /**< base type from which the typedef is derived (mandatory) */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100662 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200663};
664
665/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200666 * @brief YANG when-stmt
667 */
668struct lysp_when {
669 const char *cond; /**< specified condition (mandatory) */
670 const char *dsc; /**< description statement */
671 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200672 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200673};
674
675/**
676 * @brief YANG refine-stmt
677 */
678struct lysp_refine {
679 const char *nodeid; /**< target descendant schema nodeid (mandatory) */
680 const char *dsc; /**< description statement */
681 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200682 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200683 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200684 const char *presence; /**< presence description */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200685 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200686 uint32_t min; /**< min-elements constraint */
687 uint32_t max; /**< max-elements constraint, 0 means unbounded */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200688 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200689 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
690};
691
692/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200693 * @ingroup schematree
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200694 * @defgroup deviatetypes Deviate types
Radek Krejci8678fa42020-08-18 16:07:28 +0200695 *
696 * Type of the deviate operation (used as ::lysp_deviate.mod)
697 *
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200698 * @{
699 */
700#define LYS_DEV_NOT_SUPPORTED 1 /**< deviate type not-supported */
701#define LYS_DEV_ADD 2 /**< deviate type add */
702#define LYS_DEV_DELETE 3 /**< deviate type delete */
703#define LYS_DEV_REPLACE 4 /**< deviate type replace */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200704/** @} deviatetypes */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200705
706/**
707 * @brief Generic deviate structure to get type and cast to lysp_deviate_* structure
708 */
709struct lysp_deviate {
710 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
711 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200712 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200713};
714
715struct lysp_deviate_add {
716 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
717 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200718 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200719 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200720 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200721 struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
722 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200723 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
724 uint32_t min; /**< min-elements constraint */
725 uint32_t max; /**< max-elements constraint, 0 means unbounded */
726};
727
728struct lysp_deviate_del {
729 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
730 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200731 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200732 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200733 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200734 struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
735 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200736};
737
738struct lysp_deviate_rpl {
739 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
740 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200741 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200742 struct lysp_type *type; /**< type of the node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200743 const char *units; /**< units of the values */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200744 struct lysp_qname dflt; /**< default value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200745 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
746 uint32_t min; /**< min-elements constraint */
747 uint32_t max; /**< max-elements constraint, 0 means unbounded */
748};
749
750struct lysp_deviation {
Michal Vaskob55f6c12018-09-12 11:13:15 +0200751 const char *nodeid; /**< target absolute schema nodeid (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200752 const char *dsc; /**< description statement */
753 const char *ref; /**< reference statement */
Michal Vasko22df3f02020-08-24 13:29:22 +0200754 struct lysp_deviate *deviates; /**< list of deviate specifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200755 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200756};
757
Radek Krejci4f28eda2018-11-12 11:46:16 +0100758/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100759 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200760 * @defgroup spnodeflags Parsed schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100761 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200762 * Various flags for parsed schema nodes (used as ::lysp_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100763 *
764 * 1 - container 6 - anydata/anyxml 11 - output 16 - grouping 21 - enum
765 * 2 - choice 7 - case 12 - feature 17 - uses 22 - type
Radek Krejcid3ca0632019-04-16 16:54:54 +0200766 * 3 - leaf 8 - notification 13 - identity 18 - refine 23 - stmt
Radek Krejci4f28eda2018-11-12 11:46:16 +0100767 * 4 - leaflist 9 - rpc 14 - extension 19 - augment
768 * 5 - list 10 - input 15 - typedef 20 - deviate
769 *
Radek Krejcid3ca0632019-04-16 16:54:54 +0200770 * 1 1 1 1 1 1 1 1 1 1 2 2 2 2
771 * 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
772 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200773 * 1 LYS_CONFIG_W |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200774 * LYS_SET_BASE | | | | | | | | | | | | | | | | | | | | | |x| |
775 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200776 * 2 LYS_CONFIG_R |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200777 * LYS_SET_BIT | | | | | | | | | | | | | | | | | | | | | |x| |
778 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
779 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
780 * LYS_SET_ENUM | | | | | | | | | | | | | | | | | | | | | |x| |
781 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
782 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
783 * LYS_SET_FRDIGITS | | | | | | | | | | | | | | | | | | | | | |x| |
784 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
785 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
786 * LYS_SET_LENGTH | | | | | | | | | | | | | | | | | | | | | |x| |
787 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
788 * 6 LYS_MAND_TRUE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
789 * LYS_SET_PATH | | | | | | | | | | | | | | | | | | | | | |x| |
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100790 * LYS_FENABLED | | | | | | | | | | | |x| | | | | | | | | | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200791 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
792 * 7 LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
793 * LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | | | | | | | | |
794 * LYS_SET_PATTERN | | | | | | | | | | | | | | | | | | | | | |x| |
795 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
796 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | | | | | | | | |
797 * LYS_YINELEM_TRUE | | | | | | | | | | | | | |x| | | | | | | | | |
798 * LYS_SET_RANGE | | | | | | | | | | | | | | | | | | | | | |x| |
799 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
800 * 9 LYS_YINELEM_FALSE| | | | | | | | | | | | | |x| | | | | | | | | |
801 * LYS_SET_TYPE | | | | | | | | | | | | | | | | | | | | | |x| |
802 * LYS_SINGLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
803 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
804 * 10 LYS_SET_VALUE | | | | | | | | | | | | | | | | | | | | |x| | |
805 * LYS_SET_REQINST | | | | | | | | | | | | | | | | | | | | | |x| |
806 * LYS_SET_MIN | | | |x|x| | | | | | | | | | | | |x| |x| | | |
807 * LYS_DOUBLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
808 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
809 * 11 LYS_SET_MAX | | | |x|x| | | | | | | | | | | | |x| |x| | | |
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200810 * LYS_USED_GRP | | | | | | | | | | | | | | | |x| | | | | | | |
David Sedlákae4b4512019-08-14 10:45:56 +0200811 * LYS_YIN_ATTR | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko5297a432020-08-31 12:27:51 +0200812 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
813 * 12 LYS_YIN_ARGUMENT | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100814 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
815 * 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 +0200816 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100817 *
818 */
819
820/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100821 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200822 * @defgroup scnodeflags Compiled schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100823 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200824 * Various flags for compiled schema nodes (used as ::lysc_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100825 *
Radek Krejci61e042e2019-09-10 15:53:09 +0200826 * 1 - container 6 - anydata/anyxml 11 - identity
827 * 2 - choice 7 - case 12 - extension
828 * 3 - leaf 8 - notification 13 - bitenum
Michal Vasko03ff5a72019-09-11 13:49:33 +0200829 * 4 - leaflist 9 - rpc/action 14 - when
Michal Vaskoecd62de2019-11-13 12:35:11 +0100830 * 5 - list 10 - feature
Radek Krejci4f28eda2018-11-12 11:46:16 +0100831 *
Michal Vaskoecd62de2019-11-13 12:35:11 +0100832 * 1 1 1 1 1
833 * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4
834 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100835 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100836 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100837 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100838 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
839 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x|x|x|x| |x|
840 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
841 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x|x|x|x| |x|
842 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
843 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x|x|x|x| |x|
844 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
845 * 6 LYS_MAND_TRUE |x|x|x|x|x|x| | | | | | | | |
846 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
847 * 7 LYS_ORDBY_USER | | | |x|x| | | | | | | | | |
848 * LYS_MAND_FALSE | |x|x| | |x| | | | | | | | |
849 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
850 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | |
851 * LYS_PRESENCE |x| | | | | | | | | | | | | |
852 * LYS_UNIQUE | | |x| | | | | | | | | | | |
853 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
854 * 9 LYS_KEY | | |x| | | | | | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100855 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
856 * 10 LYS_SET_DFLT | | |x|x| | |x| | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100857 * LYS_IS_ENUM | | | | | | | | | | | | |x| |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100858 * LYS_KEYLESS | | | | |x| | | | | | | | | |
859 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
860 * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | |
861 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
862 * 12 LYS_SET_CONFIG |x|x|x|x|x|x| | | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100863 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
864 * 13 LYS_IS_INPUT |x|x|x|x|x|x|x| | | | | | | |
865 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
866 * 14 LYS_IS_OUTPUT |x|x|x|x|x|x|x| | | | | | | |
867 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
868 * 15 LYS_IS_NOTIF |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100869 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100870 *
871 */
872
873/**
874 * @defgroup snodeflags Schema nodes flags
Radek Krejci8678fa42020-08-18 16:07:28 +0200875 *
876 * Various flags for schema nodes ([parsed](@ref spnodeflags) as well as [compiled](@ref scnodeflags)).
877 *
Radek Krejci4f28eda2018-11-12 11:46:16 +0100878 * @{
879 */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100880#define LYS_CONFIG_W 0x01 /**< config true; */
881#define LYS_CONFIG_R 0x02 /**< config false; */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200882#define LYS_CONFIG_MASK 0x03 /**< mask for config value */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100883#define LYS_STATUS_CURR 0x04 /**< status current; */
884#define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */
885#define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */
886#define LYS_STATUS_MASK 0x1C /**< mask for status value */
887#define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice,
Radek Krejcife909632019-02-12 15:34:42 +0100888 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
889 The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0.
890 The ::lysc_node_container has this flag if it is not a presence container and it has at least one
891 child with LYS_MAND_TRUE. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100892#define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice,
893 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
894 This flag is present only in case the mandatory false statement was explicitly specified. */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100895#define LYS_MAND_MASK 0x60 /**< mask for mandatory values */
Michal Vaskoc118ae22020-08-06 14:51:09 +0200896#define LYS_PRESENCE 0x80 /**< flag for presence property of a container, but it is not only for explicit presence
897 containers, but also for NP containers with some meaning, applicable only to
898 ::lysc_node_container */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100899#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 +0100900#define LYS_KEY 0x0100 /**< flag for leafs being a key of a list, applicable only to ::lysc_node_leaf */
901#define LYS_KEYLESS 0x0200 /**< flag for list without any key, applicable only to ::lysc_node_list */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100902#define LYS_FENABLED 0x20 /**< feature enabled flag, applicable only to ::lysp_feature. */
Michal Vaskoe78faec2021-04-08 17:24:43 +0200903#define LYS_ORDBY_SYSTEM 0x80 /**< ordered-by system configuration lists, applicable only to
904 ::lysc_node_leaflist/::lysp_node_leaflist and ::lysc_node_list/::lysp_node_list */
905#define LYS_ORDBY_USER 0x40 /**< ordered-by user configuration lists, applicable only to
906 ::lysc_node_leaflist/::lysp_node_leaflist and ::lysc_node_list/::lysp_node_list;
907 is always set for state leaf-lists, and key-less lists */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100908#define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */
909#define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100910#define LYS_YINELEM_FALSE 0x0100 /**< yin-element false for extension's argument */
911#define LYS_YINELEM_MASK 0x0180 /**< mask for yin-element value */
912#define LYS_USED_GRP 0x0400 /**< internal flag for validating not-instantiated groupings
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200913 (resp. do not validate again the instantiated groupings). */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100914#define LYS_SET_VALUE 0x0200 /**< value attribute is set */
915#define LYS_SET_MIN 0x0200 /**< min attribute is set */
916#define LYS_SET_MAX 0x0400 /**< max attribute is set */
Radek Krejcid505e3d2018-11-13 09:04:17 +0100917
918#define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */
919#define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */
920#define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */
921#define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */
922#define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */
923#define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */
924#define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */
925#define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */
926#define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */
927#define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */
Radek Krejciccd20f12019-02-15 14:12:27 +0100928#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 +0100929 cases of choice. This information is important for refines, since it is prohibited to make leafs
930 with default statement mandatory. In case the default leaf value is taken from type, it is thrown
Radek Krejciccd20f12019-02-15 14:12:27 +0100931 away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish
932 between own default or the default values taken from the type. */
933#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 +0100934#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 +0100935
Michal Vaskod1e53b92021-01-28 13:11:06 +0100936#define LYS_SINGLEQUOTED 0x0100 /**< flag for single-quoted argument of an extension instance's substatement, only when the source is YANG */
937#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 +0200938
Michal Vaskod1e53b92021-01-28 13:11:06 +0100939#define LYS_YIN_ATTR 0x0400 /**< flag to identify YIN attribute parsed as extension's substatement, only when the source is YIN */
940#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 +0200941
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100942#define LYS_INTERNAL 0x1000 /**< flag to identify internal parsed statements that should not be printed */
943
Michal Vaskod1e53b92021-01-28 13:11:06 +0100944#define LYS_IS_ENUM 0x0200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */
945
946#define LYS_IS_INPUT 0x1000 /**< flag for nodes that are in the subtree of an input statement */
947
948#define LYS_IS_OUTPUT 0x2000 /**< flag for nodes that are in the subtree of an output statement */
949
950#define LYS_IS_NOTIF 0x4000 /**< flag for nodes that are in the subtree of a notification statement */
Radek Krejci693262f2019-04-29 15:23:20 +0200951
Radek Krejcife909632019-02-12 15:34:42 +0100952#define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200953/** @} snodeflags */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200954
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200955/**
956 * @brief Generic YANG data node
957 */
958struct lysp_node {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100959 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejcide7a9c42021-03-10 13:13:06 +0100960 uint16_t nodetype; /**< [type of the node](@ref schemanodetypes) (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200961 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100962 struct lysp_node *next; /**< next sibling node (NULL if there is no one) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200963 const char *name; /**< node name (mandatory) */
964 const char *dsc; /**< description statement */
965 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200966 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)),
967 must be qname because of refines */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200968 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200969};
970
971/**
972 * @brief Extension structure of the lysp_node for YANG container
973 */
974struct lysp_node_container {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100975 union {
976 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
977 struct {
978 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
979 uint16_t nodetype; /**< LYS_CONTAINER */
980 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
981 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
982 const char *name; /**< node name (mandatory) */
983 const char *dsc; /**< description statement */
984 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100985 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
986 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
987 };
988 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200989
990 /* container */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200991 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +0100992 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200993 const char *presence; /**< presence description */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200994 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100995 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200996 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100997 struct lysp_node_action *actions;/**< list of actions (linked list) */
998 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200999};
1000
1001struct lysp_node_leaf {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001002 union {
1003 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1004 struct {
1005 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1006 uint16_t nodetype; /**< LYS_LEAF */
1007 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1008 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1009 const char *name; /**< node name (mandatory) */
1010 const char *dsc; /**< description statement */
1011 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001012 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1013 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1014 };
1015 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001016
1017 /* leaf */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001018 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001019 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001020 struct lysp_type type; /**< type of the leaf node (mandatory) */
1021 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001022 struct lysp_qname dflt; /**< default value, it may or may not be a qualified name */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001023};
1024
1025struct lysp_node_leaflist {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001026 union {
1027 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1028 struct {
1029 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1030 uint16_t nodetype; /**< LYS_LEAFLIST */
1031 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1032 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1033 const char *name; /**< node name (mandatory) */
1034 const char *dsc; /**< description statement */
1035 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001036 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1037 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1038 };
1039 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001040
1041 /* leaf-list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001042 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001043 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001044 struct lysp_type type; /**< type of the leaf node (mandatory) */
1045 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001046 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)), they may or
1047 may not be qualified names */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001048 uint32_t min; /**< min-elements constraint */
1049 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1050};
1051
1052struct lysp_node_list {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001053 union {
1054 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1055 struct {
1056 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1057 uint16_t nodetype; /**< LYS_LIST */
1058 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1059 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1060 const char *name; /**< node name (mandatory) */
1061 const char *dsc; /**< description statement */
1062 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001063 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1064 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1065 };
1066 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001067
1068 /* list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001069 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001070 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001071 const char *key; /**< keys specification */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001072 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001073 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001074 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001075 struct lysp_node_action *actions;/**< list of actions (linked list) */
1076 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001077 struct lysp_qname *uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001078 uint32_t min; /**< min-elements constraint */
1079 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1080};
1081
1082struct lysp_node_choice {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001083 union {
1084 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1085 struct {
1086 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1087 uint16_t nodetype; /**< LYS_CHOICE */
1088 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1089 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1090 const char *name; /**< node name (mandatory) */
1091 const char *dsc; /**< description statement */
1092 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001093 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1094 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1095 };
1096 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001097
1098 /* choice */
1099 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001100 struct lysp_when *when; /**< when statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001101 struct lysp_qname dflt; /**< default case */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001102};
1103
1104struct lysp_node_case {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001105 union {
1106 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1107 struct {
1108 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1109 uint16_t nodetype; /**< LYS_CASE */
1110 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1111 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1112 const char *name; /**< node name (mandatory) */
1113 const char *dsc; /**< description statement */
1114 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001115 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1116 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1117 };
1118 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001119
1120 /* case */
1121 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001122 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001123};
1124
1125struct lysp_node_anydata {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001126 union {
1127 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1128 struct {
1129 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1130 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1131 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1132 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1133 const char *name; /**< node name (mandatory) */
1134 const char *dsc; /**< description statement */
1135 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001136 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1137 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1138 };
1139 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001140
1141 /* anyxml/anydata */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001142 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001143 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001144};
1145
1146struct lysp_node_uses {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001147 union {
1148 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1149 struct {
1150 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1151 uint16_t nodetype; /**< LYS_USES */
1152 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1153 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1154 const char *name; /**< grouping name reference (mandatory) */
1155 const char *dsc; /**< description statement */
1156 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001157 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1158 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1159 };
1160 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001161
1162 /* uses */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001163 struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001164 struct lysp_node_augment *augments; /**< list of augments (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001165 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001166};
1167
1168/**
1169 * @brief YANG input-stmt and output-stmt
1170 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001171struct lysp_node_action_inout {
1172 union {
1173 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1174 struct {
1175 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1176 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1177 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1178 struct lysp_node *next; /**< NULL */
1179 const char *name; /**< empty string */
1180 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1181 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysp_node */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001182 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1183 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1184 };
1185 }; /**< common part corresponding to ::lysp_node */
1186
1187 /* inout */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001188 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1189 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001190 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001191 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001192};
1193
1194/**
1195 * @brief YANG rpc-stmt and action-stmt
1196 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001197struct lysp_node_action {
1198 union {
1199 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1200 struct {
1201 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1202 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1203 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1204 struct lysp_node_action *next; /**< pointer to the next action (NULL if there is no one) */
1205 const char *name; /**< grouping name reference (mandatory) */
1206 const char *dsc; /**< description statement */
1207 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001208 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1209 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1210 };
1211 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001212
1213 /* action */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001214 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1215 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
1216
1217 struct lysp_node_action_inout input; /**< RPC's/Action's input */
1218 struct lysp_node_action_inout output; /**< RPC's/Action's output */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001219};
1220
1221/**
1222 * @brief YANG notification-stmt
1223 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001224struct lysp_node_notif {
1225 union {
1226 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1227 struct {
1228 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1229 uint16_t nodetype; /**< LYS_NOTIF */
1230 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1231 struct lysp_node_notif *next; /**< pointer to the next notification (NULL if there is no one) */
1232 const char *name; /**< grouping name reference (mandatory) */
1233 const char *dsc; /**< description statement */
1234 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001235 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1236 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1237 };
1238 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001239
1240 /* notif */
1241 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001242 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1243 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001244 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001245};
1246
1247/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001248 * @brief YANG grouping-stmt
1249 */
1250struct lysp_node_grp {
1251 union {
1252 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1253 struct {
1254 struct lysp_node *parent;/**< parent node (NULL if this is a top-level grouping) */
1255 uint16_t nodetype; /**< LYS_GROUPING */
1256 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1257 struct lysp_node_grp *next; /**< pointer to the next grouping (NULL if there is no one) */
1258 const char *name; /**< grouping name (mandatory) */
1259 const char *dsc; /**< description statement */
1260 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001261 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1262 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1263 };
1264 }; /**< common part corresponding to ::lysp_node */
1265
1266 /* grp */
1267 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1268 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001269 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001270 struct lysp_node_action *actions; /**< list of actions (linked list) */
1271 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1272};
1273
1274/**
1275 * @brief YANG uses-augment-stmt and augment-stmt (compatible with struct lysp_node )
1276 */
1277struct lysp_node_augment {
1278 union {
1279 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1280 struct {
1281 struct lysp_node *parent;/**< parent node (NULL if this is a top-level augment) */
1282 uint16_t nodetype; /**< LYS_AUGMENT */
1283 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1284 struct lysp_node_augment *next; /**< pointer to the next augment (NULL if there is no one) */
1285 const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */
1286 const char *dsc; /**< description statement */
1287 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001288 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1289 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1290 };
1291 }; /**< common part corresponding to ::lysp_node */
1292
1293 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001294 struct lysp_when *when; /**< when statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001295 struct lysp_node_action *actions;/**< list of actions (linked list) */
1296 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1297};
1298
1299/**
Radek Krejcif0fceb62018-09-05 14:58:45 +02001300 * @brief supported YANG schema version values
1301 */
1302typedef enum LYS_VERSION {
1303 LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */
Radek Krejci96e48da2020-09-04 13:18:06 +02001304 LYS_VERSION_1_0 = 1, /**< YANG 1 (1.0) */
Radek Krejcif0fceb62018-09-05 14:58:45 +02001305 LYS_VERSION_1_1 = 2 /**< YANG 1.1 */
1306} LYS_VERSION;
1307
1308/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001309 * @brief Printable YANG schema tree structure representing YANG module.
1310 *
1311 * Simple structure corresponding to the YANG format. The schema is only syntactically validated.
1312 */
1313struct lysp_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001314 struct lys_module *mod; /**< covering module structure */
1315
Radek Krejcib7db73a2018-10-24 14:18:40 +02001316 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1317 in the list is always the last (newest) revision of the module */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001318 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1319 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001320 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1321 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1322 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1323 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001324 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001325 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001326 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1327 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1328 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001329 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001330 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001331
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001332 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001333 uint8_t parsing : 1; /**< flag for circular check */
1334 uint8_t is_submod : 1; /**< always 0 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001335};
1336
1337struct lysp_submodule {
Michal Vaskoc3781c32020-10-06 14:04:08 +02001338 struct lys_module *mod; /**< belongs to parent module (submodule - mandatory) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001339
1340 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1341 in the list is always the last (newest) revision of the module */
1342 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1343 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
1344 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1345 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1346 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1347 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001348 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001349 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001350 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1351 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1352 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001353 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001354 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001355
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001356 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001357 uint8_t parsing : 1; /**< flag for circular check */
1358 uint8_t is_submod : 1; /**< always 1 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001359
Michal Vaskoc3781c32020-10-06 14:04:08 +02001360 uint8_t latest_revision : 2; /**< flag to mark the latest available revision:
Radek Krejci086c7132018-10-26 15:29:04 +02001361 1 - the latest revision in searchdirs was not searched yet and this is the
1362 latest revision in the current context
1363 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001364 const char *name; /**< name of the module (mandatory) */
1365 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1366 const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */
1367 const char *org; /**< party/company responsible for the module */
1368 const char *contact; /**< contact information for the module */
1369 const char *dsc; /**< description of the module */
1370 const char *ref; /**< cross-reference for the module */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001371};
1372
1373/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001374 * @brief Get the parsed module or submodule name.
1375 *
1376 * @param[in] PMOD Parsed module or submodule.
1377 * @return Module or submodule name.
1378 */
1379#define LYSP_MODULE_NAME(PMOD) (PMOD->is_submod ? ((struct lysp_submodule *)PMOD)->name : ((struct lysp_module *)PMOD)->mod->name)
1380
1381/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001382 * @brief Compiled prefix data pair mapping of prefixes to modules. In case the format is ::LY_PREF_SCHEMA_RESOLVED,
1383 * the expected prefix data is a sized array of these structures.
1384 */
1385struct lysc_prefix {
1386 char *prefix; /**< used prefix */
1387 const struct lys_module *mod; /**< mapping to a module */
1388};
1389
1390/**
Radek Krejci0e59c312019-08-15 15:34:15 +02001391 * @brief Compiled YANG extension-stmt
Radek Krejci9f87b0c2021-03-05 14:45:26 +01001392 *
1393 * Note that the compiled extension definition is created only in case the extension is instantiated. It is not available
1394 * from the compiled schema, but from the parsed extension definition which is being searched when an extension instance
1395 * is being compiled.
Radek Krejci0e59c312019-08-15 15:34:15 +02001396 */
1397struct lysc_ext {
1398 const char *name; /**< extension name */
Radek Krejci9f87b0c2021-03-05 14:45:26 +01001399 const char *argname; /**< argument name, NULL if not specified */
Radek Krejci0e59c312019-08-15 15:34:15 +02001400 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcicc9e30f2021-03-29 12:45:08 +02001401 struct lyplg_ext *plugin; /**< Plugin implementing the specific extension */
Radek Krejci0935f412019-08-20 16:15:18 +02001402 struct lys_module *module; /**< module structure */
Michal Vasko6f4cbb62020-02-28 11:15:47 +01001403 uint32_t refcount; /**< reference counter since extension definition is shared among all its instances */
Radek Krejci0e59c312019-08-15 15:34:15 +02001404 uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */
1405};
1406
1407/**
Radek Krejcib1c11532021-03-29 14:14:19 +02001408 * @brief Description of the extension instance substatements.
1409 *
1410 * Provided by extensions plugins to libyang to be able to correctly compile the content of extension instances.
1411 * Note that order of the defined records matters - just follow the values of ::ly_stmt and order the records from lower to higher values.
1412 */
1413struct lysc_ext_substmt {
1414 enum ly_stmt stmt; /**< allowed substatement */
1415 enum ly_stmt_cardinality cardinality; /**< cardinality of the substatement */
1416 void *storage; /**< pointer to the storage of the compiled statement according to the specific
1417 lysc_ext_substmt::stmt and lysc_ext_substmt::cardinality */
1418};
1419
1420/**
Radek Krejcice8c1592018-10-29 15:35:51 +01001421 * @brief YANG extension instance
1422 */
1423struct lysc_ext_instance {
Radek Krejciad5963b2019-09-06 16:03:05 +02001424 struct lysc_ext *def; /**< pointer to the extension definition */
Radek Krejcice8c1592018-10-29 15:35:51 +01001425 const char *argument; /**< optional value of the extension's argument */
Radek Krejciab430862021-03-02 20:13:40 +01001426 struct lys_module *module; /**< module where the extension instantiated is defined */
Radek Krejci2a408df2018-10-29 16:32:26 +01001427 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f9a3672021-03-05 21:35:22 +01001428 struct lysc_ext_substmt *substmts; /**< list of allowed substatements with the storage to access the present
1429 substatements ([sized array](@ref sizedarrays)) */
Radek Krejci0e59c312019-08-15 15:34:15 +02001430 void *data; /**< private plugins's data, not used by libyang */
Radek Krejciab430862021-03-02 20:13:40 +01001431
1432 void *parent; /**< pointer to the parent element holding the extension instance(s), use
1433 ::lysc_ext_instance#parent_stmt to access the schema element */
1434 enum ly_stmt parent_stmt; /**< value identifying placement of the extension instance in specific statement */
1435 LY_ARRAY_COUNT_TYPE parent_stmt_index; /**< in case the instance is in a substatement, this identifies
1436 the index of that substatement in its [sized array](@ref sizedarrays) (if any) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001437};
1438
1439/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001440 * @brief YANG when-stmt
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001441 */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001442struct lysc_when {
1443 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko175012e2019-11-06 15:49:14 +01001444 struct lysc_node *context; /**< context node for evaluating the expression, NULL if the context is root node */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001445 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001446 const char *dsc; /**< description */
1447 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001448 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00b874b2019-02-12 10:54:50 +01001449 uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */
Michal Vaskoecd62de2019-11-13 12:35:11 +01001450 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS is allowed */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001451};
1452
1453/**
Radek Krejci2a408df2018-10-29 16:32:26 +01001454 * @brief YANG identity-stmt
1455 */
1456struct lysc_ident {
1457 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejcic8b31002019-01-08 10:24:45 +01001458 const char *dsc; /**< description */
1459 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001460 struct lys_module *module; /**< module structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001461 struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */
1462 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1463 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
1464};
1465
1466/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001467 * @defgroup ifftokens if-feature expression tokens
Radek Krejci8678fa42020-08-18 16:07:28 +02001468 * Tokens of if-feature expression used in ::lysc_iffeature.expr.
Radek Krejci151a5b72018-10-19 14:21:44 +02001469 *
1470 * @{
1471 */
1472#define LYS_IFF_NOT 0x00 /**< operand "not" */
1473#define LYS_IFF_AND 0x01 /**< operand "and" */
1474#define LYS_IFF_OR 0x02 /**< operand "or" */
1475#define LYS_IFF_F 0x03 /**< feature */
Radek Krejci2ff0d572020-05-21 15:27:28 +02001476/** @} ifftokens */
Radek Krejci151a5b72018-10-19 14:21:44 +02001477
1478/**
Radek Krejcib7db73a2018-10-24 14:18:40 +02001479 * @brief Compiled YANG revision statement
1480 */
1481struct lysc_revision {
1482 char date[LY_REV_SIZE]; /**< revision-date (mandatory) */
1483 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1484};
1485
Radek Krejci2167ee12018-11-02 16:09:07 +01001486struct lysc_range {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001487 struct lysc_range_part {
Radek Krejci693262f2019-04-29 15:23:20 +02001488 union { /**< min boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001489 int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1490 uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001491 };
Radek Krejci693262f2019-04-29 15:23:20 +02001492 union { /**< max boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001493 int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1494 uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001495 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001496 } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001497 const char *dsc; /**< description */
1498 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001499 const char *emsg; /**< error-message */
1500 const char *eapptag; /**< error-app-tag value */
1501 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1502};
1503
1504struct lysc_pattern {
Radek Krejci54579462019-04-30 12:47:06 +02001505 const char *expr; /**< original, not compiled, regular expression */
1506 pcre2_code *code; /**< compiled regular expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001507 const char *dsc; /**< description */
1508 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001509 const char *emsg; /**< error-message */
1510 const char *eapptag; /**< error-app-tag value */
1511 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0f969882020-08-21 16:56:47 +02001512 uint32_t inverted : 1; /**< invert-match flag */
1513 uint32_t refcount : 31; /**< reference counter */
Radek Krejci2167ee12018-11-02 16:09:07 +01001514};
1515
1516struct lysc_must {
Radek Krejci2167ee12018-11-02 16:09:07 +01001517 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001518 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001519 const char *dsc; /**< description */
1520 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001521 const char *emsg; /**< error-message */
1522 const char *eapptag; /**< error-app-tag value */
1523 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1524};
1525
1526struct lysc_type {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001527 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001528 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 +01001529 LY_DATA_TYPE basetype; /**< Base type of the type */
1530 uint32_t refcount; /**< reference counter for type sharing */
1531};
1532
1533struct lysc_type_num {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001534 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001535 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 +01001536 LY_DATA_TYPE basetype; /**< Base type of the type */
1537 uint32_t refcount; /**< reference counter for type sharing */
1538 struct lysc_range *range; /**< Optional range limitation */
1539};
1540
1541struct lysc_type_dec {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001542 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001543 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 +01001544 LY_DATA_TYPE basetype; /**< Base type of the type */
1545 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci6cba4292018-11-15 17:33:29 +01001546 uint8_t fraction_digits; /**< fraction digits specification */
Radek Krejci2167ee12018-11-02 16:09:07 +01001547 struct lysc_range *range; /**< Optional range limitation */
1548};
1549
1550struct lysc_type_str {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001551 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001552 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 +01001553 LY_DATA_TYPE basetype; /**< Base type of the type */
1554 uint32_t refcount; /**< reference counter for type sharing */
1555 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci4586a022018-11-13 11:29:26 +01001556 struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001557};
1558
Radek Krejci693262f2019-04-29 15:23:20 +02001559struct lysc_type_bitenum_item {
1560 const char *name; /**< enumeration identifier */
1561 const char *dsc; /**< description */
1562 const char *ref; /**< reference */
1563 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci693262f2019-04-29 15:23:20 +02001564 union {
1565 int32_t value; /**< integer value associated with the enumeration */
1566 uint32_t position; /**< non-negative integer value associated with the bit */
1567 };
1568 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
1569 values are allowed */
1570};
1571
Radek Krejci2167ee12018-11-02 16:09:07 +01001572struct lysc_type_enum {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001573 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001574 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 +01001575 LY_DATA_TYPE basetype; /**< Base type of the type */
1576 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci693262f2019-04-29 15:23:20 +02001577 struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1578};
1579
1580struct lysc_type_bits {
1581 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001582 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 +02001583 LY_DATA_TYPE basetype; /**< Base type of the type */
1584 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci849a62a2019-05-22 15:29:05 +02001585 struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item),
1586 the items are ordered by their position value. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001587};
1588
1589struct lysc_type_leafref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001590 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001591 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 +01001592 LY_DATA_TYPE basetype; /**< Base type of the type */
1593 uint32_t refcount; /**< reference counter for type sharing */
Michal Vasko004d3152020-06-11 19:59:22 +02001594 struct lyxp_expr *path; /**< parsed target path, compiled path cannot be stored because of type sharing */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001595 struct lysc_prefix *prefixes; /**< resolved prefixes used in the path */
Michal Vaskoc0792ca2020-12-01 12:03:21 +01001596 const struct lys_module *cur_mod;/**< current module for the leafref (path) */
Radek Krejci412ddfa2018-11-23 11:44:11 +01001597 struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001598 uint8_t require_instance; /**< require-instance flag */
1599};
1600
1601struct lysc_type_identityref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001602 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001603 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 +01001604 LY_DATA_TYPE basetype; /**< Base type of the type */
1605 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci555cb5b2018-11-16 14:54:33 +01001606 struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)),
Radek Krejci2167ee12018-11-02 16:09:07 +01001607 mandatory (at least 1 item) */
1608};
1609
1610struct lysc_type_instanceid {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001611 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001612 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 +01001613 LY_DATA_TYPE basetype; /**< Base type of the type */
1614 uint32_t refcount; /**< reference counter for type sharing */
1615 uint8_t require_instance; /**< require-instance flag */
1616};
1617
Radek Krejci2167ee12018-11-02 16:09:07 +01001618struct lysc_type_union {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001619 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001620 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 +01001621 LY_DATA_TYPE basetype; /**< Base type of the type */
1622 uint32_t refcount; /**< reference counter for type sharing */
1623 struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1624};
1625
1626struct lysc_type_bin {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001627 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f351892021-03-22 16:13:05 +01001628 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 +01001629 LY_DATA_TYPE basetype; /**< Base type of the type */
1630 uint32_t refcount; /**< reference counter for type sharing */
1631 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001632};
1633
Michal Vasko60ea6352020-06-29 13:39:39 +02001634/**
1635 * @brief Maximum number of hashes stored in a schema node.
1636 */
1637#define LYS_NODE_HASH_COUNT 4
1638
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001639/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001640 * @brief Compiled YANG data node
1641 */
1642struct lysc_node {
Radek Krejcide7a9c42021-03-10 13:13:06 +01001643 uint16_t nodetype; /**< [type of the node](@ref schemanodetypes) (mandatory) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001644 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Michal Vasko60ea6352020-06-29 13:39:39 +02001645 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001646 struct lys_module *module; /**< module structure */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001647 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1648 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1649 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1650 never NULL. If there is no sibling node, pointer points to the node
1651 itself. In case of the first node, this pointer points to the last
1652 node in the list. */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001653 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001654 const char *dsc; /**< description */
1655 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001656 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001657 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 +02001658};
1659
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001660struct lysc_node_action_inout {
1661 union {
1662 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1663 struct {
1664 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1665 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1666 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1667 struct lys_module *module; /**< module structure */
Radek Krejci5960c312021-01-27 20:24:22 +01001668 struct lysc_node *parent;/**< parent node (NULL in case of top level node) */
Michal Vasko544e58a2021-01-28 14:33:41 +01001669 struct lysc_node *next; /**< next sibling node (output node for input, NULL for output) */
1670 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 +01001671 const char *name; /**< "input" or "output" */
1672 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysc_node */
1673 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysc_node */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001674 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001675 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 +01001676 };
1677 };
1678
Radek Krejci9a3823e2021-01-27 20:26:46 +01001679 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001680 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1681};
1682
1683struct lysc_node_action {
1684 union {
1685 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1686 struct {
1687 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1688 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1689 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1690 struct lys_module *module; /**< module structure */
1691 struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */
1692 struct lysc_node_action *next; /**< next sibling node (NULL if there is no one) */
1693 struct lysc_node_action *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1694 never NULL. If there is no sibling node, pointer points to the node
1695 itself. In case of the first node, this pointer points to the last
1696 node in the list. */
1697 const char *name; /**< action/RPC name (mandatory) */
1698 const char *dsc; /**< description */
1699 const char *ref; /**< reference */
1700 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001701 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 +01001702 };
1703 };
1704
Radek Krejci9a3823e2021-01-27 20:26:46 +01001705 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1706 the action/RPC nodes do not contain the when statement on their own, but they can
1707 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001708 struct lysc_node_action_inout input; /**< RPC's/action's input */
1709 struct lysc_node_action_inout output; /**< RPC's/action's output */
1710
1711};
1712
1713struct lysc_node_notif {
1714 union {
1715 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1716 struct {
1717 uint16_t nodetype; /**< LYS_NOTIF */
1718 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1719 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1720 struct lys_module *module; /**< module structure */
1721 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1722 struct lysc_node_notif *next; /**< next sibling node (NULL if there is no one) */
1723 struct lysc_node_notif *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1724 never NULL. If there is no sibling node, pointer points to the node
1725 itself. In case of the first node, this pointer points to the last
1726 node in the list. */
1727 const char *name; /**< Notification name (mandatory) */
1728 const char *dsc; /**< description */
1729 const char *ref; /**< reference */
1730 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001731 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 +01001732 };
1733 };
1734
Radek Krejci9a3823e2021-01-27 20:26:46 +01001735 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001736 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001737 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1738 the notification nodes do not contain the when statement on their own, but they can
1739 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001740};
1741
1742struct lysc_node_container {
1743 union {
1744 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1745 struct {
1746 uint16_t nodetype; /**< LYS_CONTAINER */
1747 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1748 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1749 struct lys_module *module; /**< module structure */
1750 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1751 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1752 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1753 never NULL. If there is no sibling node, pointer points to the node
1754 itself. In case of the first node, this pointer points to the last
1755 node in the list. */
1756 const char *name; /**< node name (mandatory) */
1757 const char *dsc; /**< description */
1758 const char *ref; /**< reference */
1759 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001760 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 +01001761 };
1762 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001763
1764 struct lysc_node *child; /**< first child node (linked list) */
1765 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001766 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001767 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1768 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001769};
1770
Radek Krejcia3045382018-11-22 14:30:31 +01001771struct lysc_node_case {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001772 union {
1773 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1774 struct {
1775 uint16_t nodetype; /**< LYS_CASE */
1776 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1777 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1778 struct lys_module *module; /**< module structure */
1779 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1780 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1781 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejci056d0a82018-12-06 16:57:25 +01001782 never NULL. If there is no sibling node, pointer points to the node
1783 itself. In case of the first node, this pointer points to the last
1784 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001785 const char *name; /**< name of the case, including the implicit case */
1786 const char *dsc; /**< description */
1787 const char *ref; /**< reference */
1788 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001789 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 +01001790 };
1791 };
Radek Krejci056d0a82018-12-06 16:57:25 +01001792
Radek Krejcia3045382018-11-22 14:30:31 +01001793 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 +01001794 each other as siblings with the parent pointer pointing to appropriate case node. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001795 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcia3045382018-11-22 14:30:31 +01001796};
1797
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001798struct lysc_node_choice {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001799 union {
1800 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1801 struct {
1802 uint16_t nodetype; /**< LYS_CHOICE */
1803 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1804 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1805 struct lys_module *module; /**< module structure */
1806 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1807 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1808 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001809 never NULL. If there is no sibling node, pointer points to the node
1810 itself. In case of the first node, this pointer points to the last
1811 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001812 const char *name; /**< node name (mandatory) */
1813 const char *dsc; /**< description */
1814 const char *ref; /**< reference */
1815 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001816 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 +01001817 };
1818 };
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001819
Radek Krejcia9026eb2018-12-12 16:04:47 +01001820 struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other
1821 as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the
1822 case is simple. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001823 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001824 struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001825};
1826
1827struct lysc_node_leaf {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001828 union {
1829 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1830 struct {
1831 uint16_t nodetype; /**< LYS_LEAF */
1832 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1833 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1834 struct lys_module *module; /**< module structure */
1835 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1836 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1837 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001838 never NULL. If there is no sibling node, pointer points to the node
1839 itself. In case of the first node, this pointer points to the last
1840 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001841 const char *name; /**< node name (mandatory) */
1842 const char *dsc; /**< description */
1843 const char *ref; /**< reference */
1844 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001845 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 +01001846 };
1847 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001848
1849 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001850 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001851 struct lysc_type *type; /**< type of the leaf node (mandatory) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001852
Radek Krejci4f28eda2018-11-12 11:46:16 +01001853 const char *units; /**< units of the leaf's type */
Radek Krejcia1911222019-07-22 17:24:50 +02001854 struct lyd_value *dflt; /**< default value */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001855};
1856
1857struct lysc_node_leaflist {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001858 union {
1859 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1860 struct {
1861 uint16_t nodetype; /**< LYS_LEAFLIST */
1862 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1863 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1864 struct lys_module *module; /**< module structure */
1865 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1866 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1867 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001868 never NULL. If there is no sibling node, pointer points to the node
1869 itself. In case of the first node, this pointer points to the last
1870 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001871 const char *name; /**< node name (mandatory) */
1872 const char *dsc; /**< description */
1873 const char *ref; /**< reference */
1874 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001875 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 +01001876 };
1877 };
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001878
1879 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001880 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001881 struct lysc_type *type; /**< type of the leaf node (mandatory) */
1882
Radek Krejci0e5d8382018-11-28 16:37:53 +01001883 const char *units; /**< units of the leaf's type */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001884 struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */
Michal Vaskoba99a3e2020-08-18 15:50:05 +02001885
Radek Krejci0e5d8382018-11-28 16:37:53 +01001886 uint32_t min; /**< min-elements constraint */
1887 uint32_t max; /**< max-elements constraint */
1888
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001889};
1890
1891struct lysc_node_list {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001892 union {
1893 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1894 struct {
1895 uint16_t nodetype; /**< LYS_LIST */
1896 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1897 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1898 struct lys_module *module; /**< module structure */
1899 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1900 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1901 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001902 never NULL. If there is no sibling node, pointer points to the node
1903 itself. In case of the first node, this pointer points to the last
1904 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001905 const char *name; /**< node name (mandatory) */
1906 const char *dsc; /**< description */
1907 const char *ref; /**< reference */
1908 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001909 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 +01001910 };
1911 };
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001912
1913 struct lysc_node *child; /**< first child node (linked list) */
1914 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001915 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001916 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1917 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001918
Radek Krejci2a9fc652021-01-22 17:44:34 +01001919 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 +01001920 uint32_t min; /**< min-elements constraint */
1921 uint32_t max; /**< max-elements constraint */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001922};
1923
1924struct lysc_node_anydata {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001925 union {
1926 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1927 struct {
1928 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1929 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1930 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1931 struct lys_module *module; /**< module structure */
1932 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1933 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1934 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001935 never NULL. If there is no sibling node, pointer points to the node
1936 itself. In case of the first node, this pointer points to the last
1937 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001938 const char *name; /**< node name (mandatory) */
1939 const char *dsc; /**< description */
1940 const char *ref; /**< reference */
1941 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
aPiecek9922ea92021-04-12 07:59:20 +02001942 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 +01001943 };
1944 };
Radek Krejci9800fb82018-12-13 14:26:23 +01001945
1946 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001947 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001948};
1949
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001950/**
1951 * @brief Compiled YANG schema tree structure representing YANG module.
1952 *
1953 * Semantically validated YANG schema tree for data tree parsing.
1954 * Contains only the necessary information for the data validation.
1955 */
1956struct lysc_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001957 struct lys_module *mod; /**< covering module structure */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001958
Radek Krejci2a408df2018-10-29 16:32:26 +01001959 struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001960 struct lysc_node_action *rpcs; /**< first of actions nodes (linked list) */
1961 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001962 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001963};
1964
1965/**
Radek Krejci490a5462020-11-05 08:44:42 +01001966 * @brief Examine whether a node is user-ordered list or leaf-list.
1967 *
1968 * @param[in] lysc_node Schema node to examine.
1969 * @return Boolean value whether the @p node is user-ordered or not.
1970 */
1971#define lysc_is_userordered(lysc_node) \
1972 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAFLIST | LYS_LIST)) || !(lysc_node->flags & LYS_ORDBY_USER)) ? 0 : 1)
1973
1974/**
1975 * @brief Examine whether a node is a list's key.
1976 *
1977 * @param[in] lysc_node Schema node to examine.
1978 * @return Boolean value whether the @p node is a key or not.
1979 */
1980#define lysc_is_key(lysc_node) \
Michal Vaskobce7ee32021-02-04 11:05:25 +01001981 ((!lysc_node || (lysc_node->nodetype != LYS_LEAF) || !(lysc_node->flags & LYS_KEY)) ? 0 : 1)
Radek Krejci490a5462020-11-05 08:44:42 +01001982
1983/**
Michal Vasko5c123b02020-12-04 14:34:04 +01001984 * @brief Examine whether a node is a non-presence container.
1985 *
1986 * @param[in] lysc_node Schema node to examine.
1987 * @return Boolean value whether the @p node is a NP container or not.
1988 */
1989#define lysc_is_np_cont(lysc_node) \
Michal Vaskobce7ee32021-02-04 11:05:25 +01001990 ((!lysc_node || (lysc_node->nodetype != LYS_CONTAINER) || (lysc_node->flags & LYS_PRESENCE)) ? 0 : 1)
1991
1992/**
Michal Vaskoe78faec2021-04-08 17:24:43 +02001993 * @brief Examine whether a node is a key-less list or a non-configuration leaf-list.
Michal Vaskobce7ee32021-02-04 11:05:25 +01001994 *
1995 * @param[in] lysc_node Schema node to examine.
1996 * @return Boolean value whether the @p node is a list with duplicate instances allowed.
1997 */
1998#define lysc_is_dup_inst_list(lysc_node) \
1999 ((lysc_node && (((lysc_node->nodetype == LYS_LIST) && (lysc_node->flags & LYS_KEYLESS)) || \
Michal Vaskoe78faec2021-04-08 17:24:43 +02002000 ((lysc_node->nodetype == LYS_LEAFLIST) && !(lysc_node->flags & LYS_CONFIG_W)))) ? 1 : 0)
Michal Vasko5c123b02020-12-04 14:34:04 +01002001
2002/**
Michal Vaskod5cfa6e2020-11-23 16:56:08 +01002003 * @brief Check whether the schema node data instance existence depends on any when conditions.
2004 * This node and any direct parent choice and case schema nodes are also examined for when conditions.
2005 *
2006 * Be careful, this function is not recursive and checks only conditions that apply to this node directly.
2007 * Meaning if there are any conditions associated with any data parent instance of @p node, they are not returned.
2008 *
2009 * @param[in] node Schema node to examine.
2010 * @return When condition associated with the node data instance, NULL if there is none.
2011 */
2012const struct lysc_when *lysc_has_when(const struct lysc_node *node);
2013
2014/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002015 * @brief Get the groupings linked list of the given (parsed) schema node.
Radek Krejci53ea6152018-12-13 15:21:15 +01002016 * Decides the node's type and in case it has a groupings array, returns it.
2017 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002018 * @return The node's groupings linked list if any, NULL otherwise.
Radek Krejci53ea6152018-12-13 15:21:15 +01002019 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002020const struct lysp_node_grp *lysp_node_groupings(const struct lysp_node *node);
Radek Krejci53ea6152018-12-13 15:21:15 +01002021
2022/**
Radek Krejci056d0a82018-12-06 16:57:25 +01002023 * @brief Get the typedefs sized array of the given (parsed) schema node.
2024 * Decides the node's type and in case it has a typedefs array, returns it.
2025 * @param[in] node Node to examine.
2026 * @return The node's typedefs sized array if any, NULL otherwise.
2027 */
2028const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
2029
2030/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002031 * @brief Get the actions/RPCs linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002032 * Decides the node's type and in case it has a actions/RPCs array, returns it.
2033 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002034 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002035 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002036const struct lysp_node_action *lysp_node_actions(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002037
2038/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002039 * @brief Get the Notifications linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002040 * Decides the node's type and in case it has a Notifications array, returns it.
2041 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002042 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002043 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002044const struct lysp_node_notif *lysp_node_notifs(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002045
2046/**
2047 * @brief Get the children linked list of the given (parsed) schema node.
2048 * Decides the node's type and in case it has a children list, returns it.
2049 * @param[in] node Node to examine.
2050 * @return The node's children linked list if any, NULL otherwise.
2051 */
Michal Vasko544e58a2021-01-28 14:33:41 +01002052const struct lysp_node *lysp_node_child(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002053
2054/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002055 * @brief Get the actions/RPCs linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002056 * Decides the node's type and in case it has a actions/RPCs array, returns it.
2057 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002058 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002059 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002060const struct lysc_node_action *lysc_node_actions(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002061
2062/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002063 * @brief Get the Notifications linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002064 * Decides the node's type and in case it has a Notifications array, returns it.
2065 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002066 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002067 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002068const struct lysc_node_notif *lysc_node_notifs(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002069
2070/**
2071 * @brief Get the children linked list of the given (compiled) schema node.
Michal Vasko2a668712020-10-21 11:48:09 +02002072 *
Michal Vasko544e58a2021-01-28 14:33:41 +01002073 * Note that ::LYS_CHOICE has only ::LYS_CASE children.
2074 * Also, ::LYS_RPC and ::LYS_ACTION have the first child ::LYS_INPUT, its sibling is ::LYS_OUTPUT.
2075 *
Michal Vasko2a668712020-10-21 11:48:09 +02002076 * @param[in] node Node to examine.
Michal Vasko2a668712020-10-21 11:48:09 +02002077 * @return Children linked list if any,
2078 * @return NULL otherwise.
2079 */
Michal Vasko544e58a2021-01-28 14:33:41 +01002080const struct lysc_node *lysc_node_child(const struct lysc_node *node);
Michal Vasko2a668712020-10-21 11:48:09 +02002081
2082/**
Radek Krejci9a3823e2021-01-27 20:26:46 +01002083 * @brief Get the must statements list if present in the @p node
2084 *
2085 * @param[in] node Node to examine.
2086 * @return Pointer to the list of must restrictions ([sized array](@ref sizedarrays))
2087 * @return NULL if there is no must statement in the node, no matter if it is not even allowed or just present
2088 */
2089struct lysc_must *lysc_node_musts(const struct lysc_node *node);
2090
2091/**
2092 * @brief Get the when statements list if present in the @p node
2093 *
2094 * @param[in] node Node to examine.
2095 * @return Pointer to the list of pointers to when statements ([sized array](@ref sizedarrays))
2096 * @return NULL if there is no when statement in the node, no matter if it is not even allowed or just present
2097 */
2098struct lysc_when **lysc_node_when(const struct lysc_node *node);
2099
2100/**
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002101 * @brief Callback to be called for every schema node in a DFS traversal.
2102 *
2103 * @param[in] node Current node.
2104 * @param[in] data Arbitrary user data.
2105 * @param[out] dfs_continue Set to true if the current subtree should be skipped and continue with siblings instead.
2106 * @return LY_SUCCESS on success,
2107 * @return LY_ERR value to terminate DFS and return this value.
2108 */
Michal Vasko8f07dfe2021-03-02 16:10:24 +01002109typedef LY_ERR (*lysc_dfs_clb)(struct lysc_node *node, void *data, ly_bool *dfs_continue);
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002110
2111/**
2112 * @brief DFS traversal of all the schema nodes in a (sub)tree including any actions and nested notifications.
2113 *
2114 * Node with children, actions, and notifications is traversed in this order:
2115 * 1) each child subtree;
2116 * 2) each action subtree;
2117 * 3) each notification subtree.
2118 *
2119 * For algorithm illustration or traversal with actions and notifications skipped, see ::LYSC_TREE_DFS_BEGIN.
2120 *
2121 * @param[in] root Schema root to fully traverse.
2122 * @param[in] dfs_clb Callback to call for each node.
2123 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2124 * @return LY_SUCCESS on success,
2125 * @return LY_ERR value returned by @p dfs_clb.
2126 */
2127LY_ERR lysc_tree_dfs_full(const struct lysc_node *root, lysc_dfs_clb dfs_clb, void *data);
2128
2129/**
2130 * @brief DFS traversal of all the schema nodes in a module including RPCs and notifications.
2131 *
2132 * For more details, see ::lysc_tree_dfs_full().
2133 *
2134 * @param[in] mod Module to fully traverse.
2135 * @param[in] dfs_clb Callback to call for each node.
2136 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2137 * @return LY_SUCCESS on success,
2138 * @return LY_ERR value returned by @p dfs_clb.
2139 */
2140LY_ERR lysc_module_dfs_full(const struct lys_module *mod, lysc_dfs_clb dfs_clb, void *data);
2141
2142/**
Radek Krejci151a5b72018-10-19 14:21:44 +02002143 * @brief Get how the if-feature statement currently evaluates.
2144 *
2145 * @param[in] iff Compiled if-feature statement to evaluate.
Michal Vasko28d78432020-05-26 13:10:53 +02002146 * @return LY_SUCCESS if the statement evaluates to true,
2147 * @return LY_ENOT if it evaluates to false,
2148 * @return LY_ERR on error.
Radek Krejci151a5b72018-10-19 14:21:44 +02002149 */
Michal Vasko28d78432020-05-26 13:10:53 +02002150LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff);
Radek Krejci151a5b72018-10-19 14:21:44 +02002151
2152/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002153 * @brief Get the next feature in the module or submodules.
Radek Krejci151a5b72018-10-19 14:21:44 +02002154 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002155 * @param[in] last Last returned feature.
2156 * @param[in] pmod Parsed module and submodoules whose features to iterate over.
2157 * @param[in,out] idx Submodule index, set to 0 on first call.
2158 * @return Next found feature, NULL if the last has already been returned.
Radek Krejci151a5b72018-10-19 14:21:44 +02002159 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002160struct 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 +02002161
Radek Krejcibed13942020-10-19 16:06:28 +02002162/**
Radek Krejcidab4f0b2021-03-29 14:07:18 +02002163 * @brief Get pointer to the storage of the specified substatement in the given extension instance.
2164 *
2165 * The function simplifies access into the ::lysc_ext_instance.substmts sized array.
2166 *
2167 * @param[in] ext Compiled extension instance to process.
2168 * @param[in] substmt Extension substatement to search for.
2169 * @param[out] instance_p Pointer where the storage of the @p substmt will be provided. The specific type returned depends
2170 * on the @p substmt and can be found in the documentation of each ::ly_stmt value. Also note that some of the substatements
2171 * (::lysc_node based or flags) can share the storage with other substatements. In case the pointer is NULL, still the return
2172 * code can be used to at least know if the substatement is allowed for the extension.
2173 * @param[out] cardinality_p Pointer to provide allowed cardinality of the substatements in the extension. Note that in some
2174 * cases, the type of the storage depends also on the cardinality of the substatement.
2175 * @return LY_SUCCESS if the @p substmt found.
2176 * @return LY_ENOT in case the @p ext is not able to store (does not allow) the specified @p substmt.
2177 */
2178LY_ERR lysc_ext_substmt(const struct lysc_ext_instance *ext, enum ly_stmt substmt,
2179 void **instance_p, enum ly_stmt_cardinality *cardinality_p);
2180
2181/**
Radek Krejcibed13942020-10-19 16:06:28 +02002182 * @defgroup findxpathoptions Atomize XPath options
2183 * Options to modify behavior of ::lys_find_xpath() and ::lys_find_xpath_atoms() searching for schema nodes in schema tree.
2184 * @{
2185 */
Michal Vaskocdad7122020-11-09 21:04:44 +01002186#define LYS_FIND_XP_SCHEMA 0x08 /**< Apply node access restrictions defined for 'when' and 'must' evaluation. */
2187#define LYS_FIND_XP_OUTPUT 0x10 /**< Search RPC/action output nodes instead of input ones. */
Radek Krejci576f8fa2020-10-26 21:23:58 +01002188/** @} findxpathoptions */
Michal Vasko072de482020-08-05 13:27:21 +02002189
Radek Krejci151a5b72018-10-19 14:21:44 +02002190/**
Michal Vasko40308e72020-10-20 16:38:40 +02002191 * @brief Get all the schema nodes that are required for @p xpath to be evaluated (atoms).
Michal Vasko519fd602020-05-26 12:17:39 +02002192 *
Michal Vasko26512682021-01-11 11:35:40 +01002193 * @param[in] ctx libyang context to use. May be NULL if @p ctx_node is set.
2194 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002195 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002196 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko519fd602020-05-26 12:17:39 +02002197 * @param[out] set Set of found atoms (schema nodes).
2198 * @return LY_SUCCESS on success, @p set is returned.
Michal Vasko40308e72020-10-20 16:38:40 +02002199 * @return LY_ERR value on error.
Michal Vasko519fd602020-05-26 12:17:39 +02002200 */
Michal Vasko26512682021-01-11 11:35:40 +01002201LY_ERR lys_find_xpath_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
2202 uint32_t options, struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002203
Michal Vasko072de482020-08-05 13:27:21 +02002204/**
Michal Vasko40308e72020-10-20 16:38:40 +02002205 * @brief Get all the schema nodes that are required for @p expr to be evaluated (atoms).
Michal Vasko072de482020-08-05 13:27:21 +02002206 *
Michal Vasko26512682021-01-11 11:35:40 +01002207 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002208 * @param[in] cur_mod Current module for the expression (where it was "instantiated").
2209 * @param[in] expr Parsed expression to use.
2210 * @param[in] prefixes Sized array of compiled prefixes.
2211 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
2212 * @param[out] set Set of found atoms (schema nodes).
2213 * @return LY_SUCCESS on success, @p set is returned.
2214 * @return LY_ERR value on error.
2215 */
2216LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod,
2217 const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set);
2218
2219/**
2220 * @brief Evaluate an @p xpath expression on schema nodes.
2221 *
Michal Vasko26512682021-01-11 11:35:40 +01002222 * @param[in] ctx libyang context to use for absolute @p xpath. May be NULL if @p ctx_node is set.
2223 * @param[in] ctx_node XPath schema context node for relative @p xpath. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002224 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002225 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko072de482020-08-05 13:27:21 +02002226 * @param[out] set Set of found schema nodes.
2227 * @return LY_SUCCESS on success, @p set is returned.
2228 * @return LY_ERR value if an error occurred.
2229 */
Michal Vasko26512682021-01-11 11:35:40 +01002230LY_ERR lys_find_xpath(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath, uint32_t options,
2231 struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002232
2233/**
Radek Krejcibc5644c2020-10-27 14:53:17 +01002234 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2235 *
2236 * @param[in] path Compiled path to use.
2237 * @param[out] set Set of found atoms (schema nodes).
2238 * @return LY_SUCCESS on success, @p set is returned.
2239 * @return LY_ERR value on error.
2240 */
2241LY_ERR lys_find_lypath_atoms(const struct ly_path *path, struct ly_set **set);
2242
2243/**
2244 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2245 *
Michal Vasko26512682021-01-11 11:35:40 +01002246 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2247 * @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 +01002248 * @param[in] path JSON path to examine.
2249 * @param[in] output Search operation output instead of input.
2250 * @param[out] set Set of found atoms (schema nodes).
2251 * @return LY_ERR value on error.
2252 */
2253LY_ERR lys_find_path_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path, ly_bool output,
2254 struct ly_set **set);
2255
2256/**
2257 * @brief Get a schema node based on the given data path (JSON format, see @ref howtoXPath).
2258 *
Michal Vasko26512682021-01-11 11:35:40 +01002259 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2260 * @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 +01002261 * @param[in] path JSON path of the node to get.
2262 * @param[in] output Search operation output instead of input.
2263 * @return Found schema node or NULL.
2264 */
2265const struct lysc_node *lys_find_path(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path,
2266 ly_bool output);
2267
2268/**
Michal Vasko03ff5a72019-09-11 13:49:33 +02002269 * @brief Types of the different schema paths.
2270 */
2271typedef enum {
Michal Vasko65de0402020-08-03 16:34:19 +02002272 LYSC_PATH_LOG, /**< Descriptive path format used in log messages */
2273 LYSC_PATH_DATA /**< Similar to ::LYSC_PATH_LOG except that schema-only nodes (choice, case) are skipped */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002274} LYSC_PATH_TYPE;
2275
2276/**
Radek Krejci327de162019-06-14 12:52:07 +02002277 * @brief Generate path of the given node in the requested format.
2278 *
2279 * @param[in] node Schema path of this node will be generated.
2280 * @param[in] pathtype Format of the path to generate.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002281 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
2282 * If NULL, memory for the complete path is allocated.
2283 * @param[in] buflen Size of the provided @p buffer.
Radek Krejci327de162019-06-14 12:52:07 +02002284 * @return NULL in case of memory allocation error, path of the node otherwise.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002285 * 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 +02002286 */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002287char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
Radek Krejci327de162019-06-14 12:52:07 +02002288
2289/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002290 * @brief Available YANG schema tree structures representing YANG module.
2291 */
2292struct lys_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002293 struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */
2294 const char *name; /**< name of the module (mandatory) */
Radek Krejci0af46292019-01-11 16:02:31 +01002295 const char *revision; /**< revision of the module (if present) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002296 const char *ns; /**< namespace of the module (module - mandatory) */
2297 const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */
2298 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
2299 const char *org; /**< party/company responsible for the module */
2300 const char *contact; /**< contact information for the module */
2301 const char *dsc; /**< description of the module */
2302 const char *ref; /**< cross-reference for the module */
2303
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002304 struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */
Radek Krejci0af46292019-01-11 16:02:31 +01002305 struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing.
2306 Available only for implemented modules. */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002307
Radek Krejci80d281e2020-09-14 17:42:54 +02002308 struct lysc_ident *identities; /**< List of compiled identities of the module ([sized array](@ref sizedarrays))
2309 Identities are outside the compiled tree to allow their linkage to the identities from
2310 the implemented modules. This avoids problems when the module became implemented in
2311 future (no matter if implicitly via augment/deviate or explicitly via
2312 ::lys_set_implemented()). Note that if the module is not implemented (compiled), the
2313 identities cannot be instantiated in data (in identityrefs). */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002314
2315 struct lys_module **augmented_by;/**< List of modules that augment this module ([sized array](@ref sizedarrays)) */
2316 struct lys_module **deviated_by; /**< List of modules that deviate this module ([sized array](@ref sizedarrays)) */
2317
Michal Vasko89b5c072020-10-06 13:52:44 +02002318 ly_bool implemented; /**< flag if the module is implemented, not just imported */
Radek Krejci95710c92019-02-11 15:49:55 +01002319 uint8_t latest_revision; /**< flag to mark the latest available revision:
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002320 1 - the latest revision in searchdirs was not searched yet and this is the
2321 latest revision in the current context
2322 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002323};
2324
Radek Krejci151a5b72018-10-19 14:21:44 +02002325/**
Michal Vasko82c31e62020-07-17 15:30:40 +02002326 * @brief Get the current real status of the specified feature in the module.
2327 *
2328 * If the feature is enabled, but some of its if-features are false, the feature is considered
2329 * disabled.
Radek Krejci151a5b72018-10-19 14:21:44 +02002330 *
2331 * @param[in] module Module where the feature is defined.
2332 * @param[in] feature Name of the feature to inspect.
Michal Vasko82c31e62020-07-17 15:30:40 +02002333 * @return LY_SUCCESS if the feature is enabled,
2334 * @return LY_ENOT if the feature is disabled,
2335 * @return LY_ENOTFOUND if the feature was not found.
Radek Krejci151a5b72018-10-19 14:21:44 +02002336 */
Michal Vasko82c31e62020-07-17 15:30:40 +02002337LY_ERR lys_feature_value(const struct lys_module *module, const char *feature);
Radek Krejcidd4e8d42018-10-16 14:55:43 +02002338
2339/**
Radek Krejcia3045382018-11-22 14:30:31 +01002340 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can
2341 * be from an augment.
2342 *
Radek Krejci8678fa42020-08-18 16:07:28 +02002343 * ::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 +01002344 * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module.
2345 * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
2346 * \p parent and \p module parameters.
2347 *
2348 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
2349 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
2350 * all the schema nodes are iteratively returned.
2351 *
2352 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
2353 * @param[in] parent Parent of the subtree where the function starts processing.
2354 * @param[in] module In case of iterating on top level elements, the \p parent is NULL and
2355 * module must be specified.
2356 * @param[in] options [ORed options](@ref sgetnextflags).
2357 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
2358 */
2359const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002360 const struct lysc_module *module, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002361
2362/**
Radek Krejci035dacf2021-02-12 18:25:53 +01002363 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree.
Radek Krejci8678fa42020-08-18 16:07:28 +02002364 *
Radek Krejci035dacf2021-02-12 18:25:53 +01002365 * In contrast to ::lys_getnext(), ::lys_getnext_ext() is limited by the given @p ext instance as a schema tree root.
2366 * If the extension does not contain any schema node, NULL is returned. If the @p parent is provided, the functionality
2367 * is completely the same as ::lys_getnext().
2368 *
2369 * ::lys_getnext_ext() is supposed to be called sequentially. In the first call, the \p last parameter is usually NULL
2370 * and function starts returning i) the first \p parent's child or ii) the first top level element of the given @p ext
2371 * instance. Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
2372 * \p parent and \p ext parameters.
2373 *
2374 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
2375 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
2376 * all the schema nodes are iteratively returned.
2377 *
2378 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
2379 * @param[in] parent Parent of the subtree where the function starts processing.
2380 * @param[in] ext The extension instance to provide a separate schema tree. To consider the top level elements in the tree,
2381 * the \p parent must be NULL. anyway, at least one of @p parent and @p ext parameters must be specified.
2382 * @param[in] options [ORed options](@ref sgetnextflags).
2383 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
2384 */
2385const struct lysc_node *lys_getnext_ext(const struct lysc_node *last, const struct lysc_node *parent,
2386 const struct lysc_ext_instance *ext, uint32_t options);
2387
2388/**
2389 * @defgroup sgetnextflags Options for ::lys_getnext() and ::lys_getnext_ext().
2390 *
2391 * Various options setting behavior of ::lys_getnext() and ::lys_getnext_ext().
Radek Krejci8678fa42020-08-18 16:07:28 +02002392 *
Radek Krejcia3045382018-11-22 14:30:31 +01002393 * @{
2394 */
Radek Krejci8678fa42020-08-18 16:07:28 +02002395#define LYS_GETNEXT_WITHCHOICE 0x01 /**< ::lys_getnext() option to allow returning #LYS_CHOICE nodes instead of looking into them */
2396#define LYS_GETNEXT_NOCHOICE 0x02 /**< ::lys_getnext() option to ignore (kind of conditional) nodes within choice node */
2397#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 +01002398#define LYS_GETNEXT_INTONPCONT 0x08 /**< ::lys_getnext() option to look into non-presence container, instead of returning container itself */
2399#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 +01002400 provided by default */
Radek Krejcia3045382018-11-22 14:30:31 +01002401/** @} sgetnextflags */
2402
2403/**
2404 * @brief Get child node according to the specified criteria.
2405 *
2406 * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched.
2407 * @param[in] module module of the node to find. It is also limitation for the children node of the given parent.
2408 * @param[in] name Name of the node to find.
2409 * @param[in] name_len Optional length of the name in case it is not NULL-terminated string.
2410 * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find.
2411 * Used as a bitmask, so multiple nodetypes can be specified.
2412 * @param[in] options [ORed options](@ref sgetnextflags).
2413 * @return Found node if any.
2414 */
Michal Vaskoe444f752020-02-10 12:20:06 +01002415const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002416 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002417
2418/**
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002419 * @brief Make the specific module implemented.
2420 *
Michal Vaskoe8988e92021-01-25 11:26:29 +01002421 * If the module is already implemented but with a different set of features, the whole context is recompiled.
2422 *
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002423 * @param[in] mod Module to make implemented. It is not an error
2424 * to provide already implemented module, it just does nothing.
Michal Vaskoe8988e92021-01-25 11:26:29 +01002425 * @param[in] features Optional array specifying the enabled features terminated with NULL overriding any previous
2426 * feature setting. The feature string '*' enables all the features and array of length 1 with only the terminating
2427 * NULL explicitly disables all the features. In case the parameter is NULL, the features are untouched - left disabled
2428 * 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 +01002429 * @return LY_SUCCESS on success.
2430 * @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 +01002431 * @return LY_ERR on other errors during module compilation.
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002432 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002433LY_ERR lys_set_implemented(struct lys_module *mod, const char **features);
Radek Krejcia3045382018-11-22 14:30:31 +01002434
Radek Krejci084289f2019-07-09 17:35:30 +02002435/**
Radek Krejci0935f412019-08-20 16:15:18 +02002436 * @brief Stringify schema nodetype.
Michal Vaskod43d71a2020-08-07 14:54:58 +02002437 *
Radek Krejci0935f412019-08-20 16:15:18 +02002438 * @param[in] nodetype Nodetype to stringify.
2439 * @return Constant string with the name of the node's type.
2440 */
2441const char *lys_nodetype2str(uint16_t nodetype);
2442
Michal Vaskod43d71a2020-08-07 14:54:58 +02002443/**
2444 * @brief Getter for original XPath expression from a parsed expression.
2445 *
2446 * @param[in] path Parsed expression.
2447 * @return Original string expression.
2448 */
2449const char *lyxp_get_expr(const struct lyxp_expr *path);
2450
Radek Krejci2ff0d572020-05-21 15:27:28 +02002451/** @} schematree */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002452
Radek Krejci70853c52018-10-15 14:46:16 +02002453#ifdef __cplusplus
2454}
2455#endif
2456
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002457#endif /* LY_TREE_SCHEMA_H_ */