blob: 7d7eacc28bca76aab1e412bff6c53c03c67ec992 [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,
75 * function, variable, ...) used by a caller application.
Radek Krejci8678fa42020-08-18 16:07:28 +020076 * Note that the object is not freed by libyang when the context is being destroyed. So the caller is responsible
77 * for freeing the provided structure after the context is destroyed or the private pointer is set to NULL in
78 * appropriate schema nodes where the object was previously set. This can be automated via destructor function
79 * to free these private objects. The destructor is passed to the ::ly_ctx_destroy() function.
80 *
81 * Despite all the schema structures and their members are available as part of the libyang API and callers can use
82 * it to navigate through the schema tree structure or to obtain various information, we recommend to use the following
83 * macros for the specific actions.
84 * - ::LYSC_TREE_DFS_BEGIN and ::LYSC_TREE_DFS_END to traverse the schema tree (depth-first).
85 * - ::LY_LIST_FOR and ::LY_ARRAY_FOR as described on @ref howtoStructures page.
86 *
87 * Further information about modules handling can be found on the following pages:
88 * - @subpage howtoSchemaParsers
89 * - @subpage howtoSchemaFeatures
90 * - @subpage howtoPlugins
91 * - @subpage howtoSchemaPrinters
92 *
93 * \note There are many functions to access information from the schema trees. Details are available in
94 * the [Schema Tree module](@ref schematree).
95 *
96 * For information about difference between implemented and imported modules, see the
97 * [context description](@ref howtoContext).
98 *
99 * Functions List (not assigned to above subsections)
100 * --------------------------------------------------
101 * - ::lys_getnext()
102 * - ::lys_nodetype2str()
103 * - ::lys_set_implemented()
104 * - ::lys_value_validate()
105 *
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 Krejci5aeea3a2018-09-05 13:29:36 +0200444 * @brief YANG import-stmt
445 */
446struct lysp_import {
Radek Krejci086c7132018-10-26 15:29:04 +0200447 struct lys_module *module; /**< pointer to the imported module
448 (mandatory, but resolved when the referring module is completely parsed) */
449 const char *name; /**< name of the imported module (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200450 const char *prefix; /**< prefix for the data from the imported schema (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200451 const char *dsc; /**< description */
452 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200453 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100454 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200455 char rev[LY_REV_SIZE]; /**< revision-date of the imported module */
456};
457
458/**
459 * @brief YANG include-stmt
460 */
461struct lysp_include {
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100462 struct lysp_submodule *submodule;/**< pointer to the parsed submodule structure
Radek Krejci086c7132018-10-26 15:29:04 +0200463 (mandatory, but resolved when the referring module is completely parsed) */
464 const char *name; /**< name of the included submodule (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200465 const char *dsc; /**< description */
466 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200467 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200468 char rev[LY_REV_SIZE]; /**< revision-date of the included submodule */
Radek Krejci771928a2021-01-19 13:42:36 +0100469 ly_bool injected; /**< flag to mark includes copied into main module from submodules,
470 only for backward compatibility with YANG 1.0, which does not require the
471 main module to include all submodules. */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200472};
473
474/**
475 * @brief YANG extension-stmt
476 */
477struct lysp_ext {
478 const char *name; /**< extension name */
Radek Krejci9f87b0c2021-03-05 14:45:26 +0100479 const char *argname; /**< argument name, NULL if not specified */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200480 const char *dsc; /**< description statement */
481 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200482 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200483 uint16_t flags; /**< LYS_STATUS_* and LYS_YINELEM_* values (@ref snodeflags) */
Michal Vasko5fe75f12020-03-02 13:52:37 +0100484
Radek Krejci720d2612021-03-03 19:44:22 +0100485 struct lysc_ext *compiled; /**< pointer to the compiled extension definition.
486 The extension definition is compiled only if there is compiled extension instance,
487 otherwise this pointer remains NULL. The compiled extension definition is shared
488 among all extension instances. */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200489};
490
491/**
492 * @brief Helper structure for generic storage of the extension instances content.
493 */
494struct lysp_stmt {
495 const char *stmt; /**< identifier of the statement */
496 const char *arg; /**< statement's argument */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100497 LY_PREFIX_FORMAT format; /**< prefix format of the identifier/argument (::LY_PREF_XML is YIN format) */
498 void *prefix_data; /**< Format-specific data for prefix resolution (see ::ly_type_store_resolve_prefix()) */
499
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200500 struct lysp_stmt *next; /**< link to the next statement */
Michal Vaskobc2559f2018-09-07 10:17:50 +0200501 struct lysp_stmt *child; /**< list of the statement's substatements (linked list) */
David Sedlákb9d75c42019-08-14 10:49:42 +0200502 uint16_t flags; /**< statement flags, can be set to LYS_YIN_ATTR */
Radek Krejci335332a2019-09-05 13:03:35 +0200503 enum ly_stmt kw; /**< numeric respresentation of the stmt value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200504};
505
David Sedlákae4b4512019-08-14 10:45:56 +0200506#define LYS_YIN 0x1 /**< used to specify input format of extension instance */
507
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200508/**
509 * @brief YANG extension instance
510 */
511struct lysp_ext_instance {
David Sedlákbbd06ca2019-06-27 14:15:38 +0200512 const char *name; /**< extension identifier, including possible prefix */
513 const char *argument; /**< optional value of the extension's argument */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100514 LY_PREFIX_FORMAT format; /**< prefix format of the extension name/argument (::LY_PREF_XML is YIN format) */
515 void *prefix_data; /**< Format-specific data for prefix resolution
516 (see ::ly_type_store_resolve_prefix()) */
517
Radek Krejci5f9a3672021-03-05 21:35:22 +0100518 struct lysp_stmt *child; /**< list of the extension's substatements (linked list) */
519
Radek Krejci335332a2019-09-05 13:03:35 +0200520 void *parent; /**< pointer to the parent element holding the extension instance(s), use
Radek Krejciab430862021-03-02 20:13:40 +0100521 ::lysp_ext_instance#parent_stmt to access the schema element */
Radek Krejciab430862021-03-02 20:13:40 +0100522 enum ly_stmt parent_stmt; /**< value identifying placement of the extension instance */
523 LY_ARRAY_COUNT_TYPE parent_stmt_index; /**< in case the instance is in a substatement, this identifies
524 the index of that substatement in its [sized array](@ref sizedarrays) (if any) */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100525 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200526};
527
528/**
529 * @brief YANG feature-stmt
530 */
531struct lysp_feature {
532 const char *name; /**< feature name (mandatory) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100533 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
534 struct lysc_iffeature *iffeatures_c; /**< compiled if-features */
535 struct lysp_feature **depfeatures; /**< list of pointers to other features depending on this one
536 ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200537 const char *dsc; /**< description statement */
538 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200539 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100540 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values and
541 LYS_FENABLED are allowed */
542};
543
544/**
545 * @brief Compiled YANG if-feature-stmt
546 */
547struct lysc_iffeature {
548 uint8_t *expr; /**< 2bits array describing the if-feature expression in prefix format, see @ref ifftokens */
549 struct lysp_feature **features; /**< array of pointers to the features used in expression ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200550};
551
552/**
Michal Vasko7f45cf22020-10-01 12:49:44 +0200553 * @brief Qualified name (optional prefix followed by an identifier).
554 */
555struct lysp_qname {
556 const char *str; /**< qualified name string */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200557 const struct lysp_module *mod; /**< module to resolve any prefixes found in the string, it must be
Michal Vasko7f45cf22020-10-01 12:49:44 +0200558 stored explicitly because of deviations/refines */
559};
560
561/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200562 * @brief YANG identity-stmt
563 */
564struct lysp_ident {
565 const char *name; /**< identity name (mandatory), including possible prefix */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200566 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200567 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200568 const char *dsc; /**< description statement */
569 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200570 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200571 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
572};
573
Michal Vasko71e64ca2018-09-07 16:30:29 +0200574/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200575 * @brief Covers restrictions: range, length, pattern, must
576 */
577struct lysp_restr {
Radek Krejcif13b87b2020-12-01 22:02:17 +0100578#define LYSP_RESTR_PATTERN_ACK 0x06
579#define LYSP_RESTR_PATTERN_NACK 0x15
Michal Vasko7f45cf22020-10-01 12:49:44 +0200580 struct lysp_qname arg; /**< The restriction expression/value (mandatory);
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200581 in case of pattern restriction, the first byte has a special meaning:
582 0x06 (ACK) for regular match and 0x15 (NACK) for invert-match */
583 const char *emsg; /**< error-message */
584 const char *eapptag; /**< error-app-tag value */
585 const char *dsc; /**< description */
586 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200587 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200588};
589
590/**
Michal Vasko71e64ca2018-09-07 16:30:29 +0200591 * @brief YANG revision-stmt
592 */
593struct lysp_revision {
Radek Krejcicb3e6472021-01-06 08:19:01 +0100594 char date[LY_REV_SIZE]; /**< revision date (madatory) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200595 const char *dsc; /**< description statement */
596 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200597 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200598};
599
600/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200601 * @brief Enumeration/Bit value definition
602 */
603struct lysp_type_enum {
604 const char *name; /**< name (mandatory) */
605 const char *dsc; /**< description statement */
606 const char *ref; /**< reference statement */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200607 int64_t value; /**< enum's value or bit's position */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200608 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200609 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200610 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
611 values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200612};
613
614/**
615 * @brief YANG type-stmt
616 *
617 * Some of the items in the structure may be mandatory, but it is necessary to resolve the type's base type first
618 */
619struct lysp_type {
620 const char *name; /**< name of the type (mandatory) */
621 struct lysp_restr *range; /**< allowed values range - numerical, decimal64 */
622 struct lysp_restr *length; /**< allowed length of the value - string, binary */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200623 struct lysp_restr *patterns; /**< list of patterns ([sized array](@ref sizedarrays)) - string */
624 struct lysp_type_enum *enums; /**< list of enum-stmts ([sized array](@ref sizedarrays)) - enum */
625 struct lysp_type_enum *bits; /**< list of bit-stmts ([sized array](@ref sizedarrays)) - bits */
Michal Vasko004d3152020-06-11 19:59:22 +0200626 struct lyxp_expr *path; /**< parsed path - leafref */
Radek Krejci151a5b72018-10-19 14:21:44 +0200627 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) - identityref */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200628 struct lysp_type *types; /**< list of sub-types ([sized array](@ref sizedarrays)) - union */
629 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200630
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200631 const struct lysp_module *pmod; /**< (sub)module where the type is defined (needed for deviations) */
Radek Krejci2167ee12018-11-02 16:09:07 +0100632 struct lysc_type *compiled; /**< pointer to the compiled type */
633
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200634 uint8_t fraction_digits; /**< number of fraction digits - decimal64 */
635 uint8_t require_instance; /**< require-instance flag - leafref, instance */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100636 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200637};
638
639/**
640 * @brief YANG typedef-stmt
641 */
642struct lysp_tpdf {
643 const char *name; /**< name of the newly defined type (mandatory) */
644 const char *units; /**< units of the newly defined type */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200645 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 +0200646 const char *dsc; /**< description statement */
647 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200648 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200649 struct lysp_type type; /**< base type from which the typedef is derived (mandatory) */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100650 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200651};
652
653/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200654 * @brief YANG when-stmt
655 */
656struct lysp_when {
657 const char *cond; /**< specified condition (mandatory) */
658 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};
662
663/**
664 * @brief YANG refine-stmt
665 */
666struct lysp_refine {
667 const char *nodeid; /**< target descendant schema nodeid (mandatory) */
668 const char *dsc; /**< description statement */
669 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200670 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200671 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200672 const char *presence; /**< presence description */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200673 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200674 uint32_t min; /**< min-elements constraint */
675 uint32_t max; /**< max-elements constraint, 0 means unbounded */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200676 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200677 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
678};
679
680/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200681 * @ingroup schematree
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200682 * @defgroup deviatetypes Deviate types
Radek Krejci8678fa42020-08-18 16:07:28 +0200683 *
684 * Type of the deviate operation (used as ::lysp_deviate.mod)
685 *
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200686 * @{
687 */
688#define LYS_DEV_NOT_SUPPORTED 1 /**< deviate type not-supported */
689#define LYS_DEV_ADD 2 /**< deviate type add */
690#define LYS_DEV_DELETE 3 /**< deviate type delete */
691#define LYS_DEV_REPLACE 4 /**< deviate type replace */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200692/** @} deviatetypes */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200693
694/**
695 * @brief Generic deviate structure to get type and cast to lysp_deviate_* structure
696 */
697struct lysp_deviate {
698 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
699 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200700 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200701};
702
703struct lysp_deviate_add {
704 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
705 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200706 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200707 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200708 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200709 struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
710 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200711 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
712 uint32_t min; /**< min-elements constraint */
713 uint32_t max; /**< max-elements constraint, 0 means unbounded */
714};
715
716struct lysp_deviate_del {
717 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
718 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200719 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200720 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200721 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200722 struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
723 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200724};
725
726struct lysp_deviate_rpl {
727 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
728 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200729 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200730 struct lysp_type *type; /**< type of the node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200731 const char *units; /**< units of the values */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200732 struct lysp_qname dflt; /**< default value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200733 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
734 uint32_t min; /**< min-elements constraint */
735 uint32_t max; /**< max-elements constraint, 0 means unbounded */
736};
737
738struct lysp_deviation {
Michal Vaskob55f6c12018-09-12 11:13:15 +0200739 const char *nodeid; /**< target absolute schema nodeid (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200740 const char *dsc; /**< description statement */
741 const char *ref; /**< reference statement */
Michal Vasko22df3f02020-08-24 13:29:22 +0200742 struct lysp_deviate *deviates; /**< list of deviate specifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200743 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200744};
745
Radek Krejci4f28eda2018-11-12 11:46:16 +0100746/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100747 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200748 * @defgroup spnodeflags Parsed schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100749 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200750 * Various flags for parsed schema nodes (used as ::lysp_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100751 *
752 * 1 - container 6 - anydata/anyxml 11 - output 16 - grouping 21 - enum
753 * 2 - choice 7 - case 12 - feature 17 - uses 22 - type
Radek Krejcid3ca0632019-04-16 16:54:54 +0200754 * 3 - leaf 8 - notification 13 - identity 18 - refine 23 - stmt
Radek Krejci4f28eda2018-11-12 11:46:16 +0100755 * 4 - leaflist 9 - rpc 14 - extension 19 - augment
756 * 5 - list 10 - input 15 - typedef 20 - deviate
757 *
Radek Krejcid3ca0632019-04-16 16:54:54 +0200758 * 1 1 1 1 1 1 1 1 1 1 2 2 2 2
759 * 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
760 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200761 * 1 LYS_CONFIG_W |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200762 * LYS_SET_BASE | | | | | | | | | | | | | | | | | | | | | |x| |
763 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200764 * 2 LYS_CONFIG_R |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200765 * LYS_SET_BIT | | | | | | | | | | | | | | | | | | | | | |x| |
766 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
767 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
768 * LYS_SET_ENUM | | | | | | | | | | | | | | | | | | | | | |x| |
769 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
770 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
771 * LYS_SET_FRDIGITS | | | | | | | | | | | | | | | | | | | | | |x| |
772 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
773 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
774 * LYS_SET_LENGTH | | | | | | | | | | | | | | | | | | | | | |x| |
775 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
776 * 6 LYS_MAND_TRUE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
777 * LYS_SET_PATH | | | | | | | | | | | | | | | | | | | | | |x| |
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100778 * LYS_FENABLED | | | | | | | | | | | |x| | | | | | | | | | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200779 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
780 * 7 LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
781 * LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | | | | | | | | |
782 * LYS_SET_PATTERN | | | | | | | | | | | | | | | | | | | | | |x| |
783 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
784 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | | | | | | | | |
785 * LYS_YINELEM_TRUE | | | | | | | | | | | | | |x| | | | | | | | | |
786 * LYS_SET_RANGE | | | | | | | | | | | | | | | | | | | | | |x| |
787 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
788 * 9 LYS_YINELEM_FALSE| | | | | | | | | | | | | |x| | | | | | | | | |
789 * LYS_SET_TYPE | | | | | | | | | | | | | | | | | | | | | |x| |
790 * LYS_SINGLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
791 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
792 * 10 LYS_SET_VALUE | | | | | | | | | | | | | | | | | | | | |x| | |
793 * LYS_SET_REQINST | | | | | | | | | | | | | | | | | | | | | |x| |
794 * LYS_SET_MIN | | | |x|x| | | | | | | | | | | | |x| |x| | | |
795 * LYS_DOUBLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
796 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
797 * 11 LYS_SET_MAX | | | |x|x| | | | | | | | | | | | |x| |x| | | |
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200798 * LYS_USED_GRP | | | | | | | | | | | | | | | |x| | | | | | | |
David Sedlákae4b4512019-08-14 10:45:56 +0200799 * LYS_YIN_ATTR | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko5297a432020-08-31 12:27:51 +0200800 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
801 * 12 LYS_YIN_ARGUMENT | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100802 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
803 * 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 +0200804 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100805 *
806 */
807
808/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100809 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200810 * @defgroup scnodeflags Compiled schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100811 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200812 * Various flags for compiled schema nodes (used as ::lysc_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100813 *
Radek Krejci61e042e2019-09-10 15:53:09 +0200814 * 1 - container 6 - anydata/anyxml 11 - identity
815 * 2 - choice 7 - case 12 - extension
816 * 3 - leaf 8 - notification 13 - bitenum
Michal Vasko03ff5a72019-09-11 13:49:33 +0200817 * 4 - leaflist 9 - rpc/action 14 - when
Michal Vaskoecd62de2019-11-13 12:35:11 +0100818 * 5 - list 10 - feature
Radek Krejci4f28eda2018-11-12 11:46:16 +0100819 *
Michal Vaskoecd62de2019-11-13 12:35:11 +0100820 * 1 1 1 1 1
821 * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4
822 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100823 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100824 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100825 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100826 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
827 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x|x|x|x| |x|
828 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
829 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x|x|x|x| |x|
830 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
831 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x|x|x|x| |x|
832 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
833 * 6 LYS_MAND_TRUE |x|x|x|x|x|x| | | | | | | | |
834 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
835 * 7 LYS_ORDBY_USER | | | |x|x| | | | | | | | | |
836 * LYS_MAND_FALSE | |x|x| | |x| | | | | | | | |
837 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
838 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | |
839 * LYS_PRESENCE |x| | | | | | | | | | | | | |
840 * LYS_UNIQUE | | |x| | | | | | | | | | | |
841 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
842 * 9 LYS_KEY | | |x| | | | | | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100843 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
844 * 10 LYS_SET_DFLT | | |x|x| | |x| | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100845 * LYS_IS_ENUM | | | | | | | | | | | | |x| |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100846 * LYS_KEYLESS | | | | |x| | | | | | | | | |
847 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
848 * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | |
849 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
850 * 12 LYS_SET_CONFIG |x|x|x|x|x|x| | | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100851 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
852 * 13 LYS_IS_INPUT |x|x|x|x|x|x|x| | | | | | | |
853 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
854 * 14 LYS_IS_OUTPUT |x|x|x|x|x|x|x| | | | | | | |
855 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
856 * 15 LYS_IS_NOTIF |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100857 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100858 *
859 */
860
861/**
862 * @defgroup snodeflags Schema nodes flags
Radek Krejci8678fa42020-08-18 16:07:28 +0200863 *
864 * Various flags for schema nodes ([parsed](@ref spnodeflags) as well as [compiled](@ref scnodeflags)).
865 *
Radek Krejci4f28eda2018-11-12 11:46:16 +0100866 * @{
867 */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100868#define LYS_CONFIG_W 0x01 /**< config true; */
869#define LYS_CONFIG_R 0x02 /**< config false; */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200870#define LYS_CONFIG_MASK 0x03 /**< mask for config value */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100871#define LYS_STATUS_CURR 0x04 /**< status current; */
872#define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */
873#define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */
874#define LYS_STATUS_MASK 0x1C /**< mask for status value */
875#define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice,
Radek Krejcife909632019-02-12 15:34:42 +0100876 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
877 The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0.
878 The ::lysc_node_container has this flag if it is not a presence container and it has at least one
879 child with LYS_MAND_TRUE. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100880#define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice,
881 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
882 This flag is present only in case the mandatory false statement was explicitly specified. */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100883#define LYS_MAND_MASK 0x60 /**< mask for mandatory values */
Michal Vaskoc118ae22020-08-06 14:51:09 +0200884#define LYS_PRESENCE 0x80 /**< flag for presence property of a container, but it is not only for explicit presence
885 containers, but also for NP containers with some meaning, applicable only to
886 ::lysc_node_container */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100887#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 +0100888#define LYS_KEY 0x0100 /**< flag for leafs being a key of a list, applicable only to ::lysc_node_leaf */
889#define LYS_KEYLESS 0x0200 /**< flag for list without any key, applicable only to ::lysc_node_list */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100890#define LYS_FENABLED 0x20 /**< feature enabled flag, applicable only to ::lysp_feature. */
Radek Krejcife909632019-02-12 15:34:42 +0100891#define LYS_ORDBY_SYSTEM 0x80 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and
Radek Krejci4f28eda2018-11-12 11:46:16 +0100892 ::lysc_node_list/::lysp_node_list */
893#define LYS_ORDBY_USER 0x40 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and
894 ::lysc_node_list/::lysp_node_list */
895#define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */
896#define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100897#define LYS_YINELEM_FALSE 0x0100 /**< yin-element false for extension's argument */
898#define LYS_YINELEM_MASK 0x0180 /**< mask for yin-element value */
899#define LYS_USED_GRP 0x0400 /**< internal flag for validating not-instantiated groupings
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200900 (resp. do not validate again the instantiated groupings). */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100901#define LYS_SET_VALUE 0x0200 /**< value attribute is set */
902#define LYS_SET_MIN 0x0200 /**< min attribute is set */
903#define LYS_SET_MAX 0x0400 /**< max attribute is set */
Radek Krejcid505e3d2018-11-13 09:04:17 +0100904
905#define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */
906#define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */
907#define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */
908#define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */
909#define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */
910#define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */
911#define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */
912#define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */
913#define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */
914#define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */
Radek Krejciccd20f12019-02-15 14:12:27 +0100915#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 +0100916 cases of choice. This information is important for refines, since it is prohibited to make leafs
917 with default statement mandatory. In case the default leaf value is taken from type, it is thrown
Radek Krejciccd20f12019-02-15 14:12:27 +0100918 away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish
919 between own default or the default values taken from the type. */
920#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 +0100921#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 +0100922
Michal Vaskod1e53b92021-01-28 13:11:06 +0100923#define LYS_SINGLEQUOTED 0x0100 /**< flag for single-quoted argument of an extension instance's substatement, only when the source is YANG */
924#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 +0200925
Michal Vaskod1e53b92021-01-28 13:11:06 +0100926#define LYS_YIN_ATTR 0x0400 /**< flag to identify YIN attribute parsed as extension's substatement, only when the source is YIN */
927#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 +0200928
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100929#define LYS_INTERNAL 0x1000 /**< flag to identify internal parsed statements that should not be printed */
930
Michal Vaskod1e53b92021-01-28 13:11:06 +0100931#define LYS_IS_ENUM 0x0200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */
932
933#define LYS_IS_INPUT 0x1000 /**< flag for nodes that are in the subtree of an input statement */
934
935#define LYS_IS_OUTPUT 0x2000 /**< flag for nodes that are in the subtree of an output statement */
936
937#define LYS_IS_NOTIF 0x4000 /**< flag for nodes that are in the subtree of a notification statement */
Radek Krejci693262f2019-04-29 15:23:20 +0200938
Radek Krejcife909632019-02-12 15:34:42 +0100939#define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200940/** @} snodeflags */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200941
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200942/**
943 * @brief Generic YANG data node
944 */
945struct lysp_node {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100946 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejcide7a9c42021-03-10 13:13:06 +0100947 uint16_t nodetype; /**< [type of the node](@ref schemanodetypes) (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200948 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100949 struct lysp_node *next; /**< next sibling node (NULL if there is no one) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200950 const char *name; /**< node name (mandatory) */
951 const char *dsc; /**< description statement */
952 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200953 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)),
954 must be qname because of refines */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200955 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200956};
957
958/**
959 * @brief Extension structure of the lysp_node for YANG container
960 */
961struct lysp_node_container {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100962 union {
963 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
964 struct {
965 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
966 uint16_t nodetype; /**< LYS_CONTAINER */
967 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
968 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
969 const char *name; /**< node name (mandatory) */
970 const char *dsc; /**< description statement */
971 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100972 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
973 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
974 };
975 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200976
977 /* container */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200978 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +0100979 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200980 const char *presence; /**< presence description */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200981 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100982 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200983 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100984 struct lysp_node_action *actions;/**< list of actions (linked list) */
985 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200986};
987
988struct lysp_node_leaf {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100989 union {
990 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
991 struct {
992 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
993 uint16_t nodetype; /**< LYS_LEAF */
994 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
995 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
996 const char *name; /**< node name (mandatory) */
997 const char *dsc; /**< description statement */
998 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100999 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1000 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1001 };
1002 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001003
1004 /* leaf */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001005 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001006 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001007 struct lysp_type type; /**< type of the leaf node (mandatory) */
1008 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001009 struct lysp_qname dflt; /**< default value, it may or may not be a qualified name */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001010};
1011
1012struct lysp_node_leaflist {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001013 union {
1014 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1015 struct {
1016 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1017 uint16_t nodetype; /**< LYS_LEAFLIST */
1018 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1019 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1020 const char *name; /**< node name (mandatory) */
1021 const char *dsc; /**< description statement */
1022 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001023 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1024 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1025 };
1026 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001027
1028 /* leaf-list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001029 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001030 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001031 struct lysp_type type; /**< type of the leaf node (mandatory) */
1032 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001033 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)), they may or
1034 may not be qualified names */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001035 uint32_t min; /**< min-elements constraint */
1036 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1037};
1038
1039struct lysp_node_list {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001040 union {
1041 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1042 struct {
1043 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1044 uint16_t nodetype; /**< LYS_LIST */
1045 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1046 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1047 const char *name; /**< node name (mandatory) */
1048 const char *dsc; /**< description statement */
1049 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001050 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1051 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1052 };
1053 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001054
1055 /* list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001056 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001057 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001058 const char *key; /**< keys specification */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001059 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001060 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001061 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001062 struct lysp_node_action *actions;/**< list of actions (linked list) */
1063 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001064 struct lysp_qname *uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001065 uint32_t min; /**< min-elements constraint */
1066 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1067};
1068
1069struct lysp_node_choice {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001070 union {
1071 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1072 struct {
1073 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1074 uint16_t nodetype; /**< LYS_CHOICE */
1075 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1076 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1077 const char *name; /**< node name (mandatory) */
1078 const char *dsc; /**< description statement */
1079 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001080 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1081 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1082 };
1083 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001084
1085 /* choice */
1086 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001087 struct lysp_when *when; /**< when statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001088 struct lysp_qname dflt; /**< default case */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001089};
1090
1091struct lysp_node_case {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001092 union {
1093 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1094 struct {
1095 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1096 uint16_t nodetype; /**< LYS_CASE */
1097 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1098 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1099 const char *name; /**< node name (mandatory) */
1100 const char *dsc; /**< description statement */
1101 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001102 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1103 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1104 };
1105 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001106
1107 /* case */
1108 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001109 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001110};
1111
1112struct lysp_node_anydata {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001113 union {
1114 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1115 struct {
1116 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1117 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1118 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1119 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1120 const char *name; /**< node name (mandatory) */
1121 const char *dsc; /**< description statement */
1122 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001123 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1124 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1125 };
1126 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001127
1128 /* anyxml/anydata */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001129 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001130 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001131};
1132
1133struct lysp_node_uses {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001134 union {
1135 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1136 struct {
1137 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1138 uint16_t nodetype; /**< LYS_USES */
1139 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1140 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1141 const char *name; /**< grouping name reference (mandatory) */
1142 const char *dsc; /**< description statement */
1143 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001144 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1145 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1146 };
1147 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001148
1149 /* uses */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001150 struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001151 struct lysp_node_augment *augments; /**< list of augments (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001152 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001153};
1154
1155/**
1156 * @brief YANG input-stmt and output-stmt
1157 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001158struct lysp_node_action_inout {
1159 union {
1160 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1161 struct {
1162 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1163 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1164 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1165 struct lysp_node *next; /**< NULL */
1166 const char *name; /**< empty string */
1167 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1168 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysp_node */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001169 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1170 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1171 };
1172 }; /**< common part corresponding to ::lysp_node */
1173
1174 /* inout */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001175 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1176 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001177 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001178 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001179};
1180
1181/**
1182 * @brief YANG rpc-stmt and action-stmt
1183 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001184struct lysp_node_action {
1185 union {
1186 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1187 struct {
1188 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1189 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1190 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1191 struct lysp_node_action *next; /**< pointer to the next action (NULL if there is no one) */
1192 const char *name; /**< grouping name reference (mandatory) */
1193 const char *dsc; /**< description statement */
1194 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001195 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1196 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1197 };
1198 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001199
1200 /* action */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001201 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1202 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
1203
1204 struct lysp_node_action_inout input; /**< RPC's/Action's input */
1205 struct lysp_node_action_inout output; /**< RPC's/Action's output */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001206};
1207
1208/**
1209 * @brief YANG notification-stmt
1210 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001211struct lysp_node_notif {
1212 union {
1213 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1214 struct {
1215 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1216 uint16_t nodetype; /**< LYS_NOTIF */
1217 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1218 struct lysp_node_notif *next; /**< pointer to the next notification (NULL if there is no one) */
1219 const char *name; /**< grouping name reference (mandatory) */
1220 const char *dsc; /**< description statement */
1221 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001222 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1223 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1224 };
1225 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001226
1227 /* notif */
1228 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001229 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1230 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001231 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001232};
1233
1234/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001235 * @brief YANG grouping-stmt
1236 */
1237struct lysp_node_grp {
1238 union {
1239 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1240 struct {
1241 struct lysp_node *parent;/**< parent node (NULL if this is a top-level grouping) */
1242 uint16_t nodetype; /**< LYS_GROUPING */
1243 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1244 struct lysp_node_grp *next; /**< pointer to the next grouping (NULL if there is no one) */
1245 const char *name; /**< grouping name (mandatory) */
1246 const char *dsc; /**< description statement */
1247 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001248 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1249 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1250 };
1251 }; /**< common part corresponding to ::lysp_node */
1252
1253 /* grp */
1254 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1255 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001256 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001257 struct lysp_node_action *actions; /**< list of actions (linked list) */
1258 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1259};
1260
1261/**
1262 * @brief YANG uses-augment-stmt and augment-stmt (compatible with struct lysp_node )
1263 */
1264struct lysp_node_augment {
1265 union {
1266 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1267 struct {
1268 struct lysp_node *parent;/**< parent node (NULL if this is a top-level augment) */
1269 uint16_t nodetype; /**< LYS_AUGMENT */
1270 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1271 struct lysp_node_augment *next; /**< pointer to the next augment (NULL if there is no one) */
1272 const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */
1273 const char *dsc; /**< description statement */
1274 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001275 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1276 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1277 };
1278 }; /**< common part corresponding to ::lysp_node */
1279
1280 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001281 struct lysp_when *when; /**< when statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001282 struct lysp_node_action *actions;/**< list of actions (linked list) */
1283 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1284};
1285
1286/**
Radek Krejcif0fceb62018-09-05 14:58:45 +02001287 * @brief supported YANG schema version values
1288 */
1289typedef enum LYS_VERSION {
1290 LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */
Radek Krejci96e48da2020-09-04 13:18:06 +02001291 LYS_VERSION_1_0 = 1, /**< YANG 1 (1.0) */
Radek Krejcif0fceb62018-09-05 14:58:45 +02001292 LYS_VERSION_1_1 = 2 /**< YANG 1.1 */
1293} LYS_VERSION;
1294
1295/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001296 * @brief Printable YANG schema tree structure representing YANG module.
1297 *
1298 * Simple structure corresponding to the YANG format. The schema is only syntactically validated.
1299 */
1300struct lysp_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001301 struct lys_module *mod; /**< covering module structure */
1302
Radek Krejcib7db73a2018-10-24 14:18:40 +02001303 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1304 in the list is always the last (newest) revision of the module */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001305 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1306 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001307 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1308 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1309 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1310 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001311 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001312 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001313 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1314 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1315 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001316 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001317 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001318
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001319 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001320 uint8_t parsing : 1; /**< flag for circular check */
1321 uint8_t is_submod : 1; /**< always 0 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001322};
1323
1324struct lysp_submodule {
Michal Vaskoc3781c32020-10-06 14:04:08 +02001325 struct lys_module *mod; /**< belongs to parent module (submodule - mandatory) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001326
1327 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1328 in the list is always the last (newest) revision of the module */
1329 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1330 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
1331 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1332 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1333 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1334 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001335 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001336 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001337 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1338 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1339 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001340 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001341 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001342
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001343 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001344 uint8_t parsing : 1; /**< flag for circular check */
1345 uint8_t is_submod : 1; /**< always 1 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001346
Michal Vaskoc3781c32020-10-06 14:04:08 +02001347 uint8_t latest_revision : 2; /**< flag to mark the latest available revision:
Radek Krejci086c7132018-10-26 15:29:04 +02001348 1 - the latest revision in searchdirs was not searched yet and this is the
1349 latest revision in the current context
1350 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001351 const char *name; /**< name of the module (mandatory) */
1352 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1353 const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */
1354 const char *org; /**< party/company responsible for the module */
1355 const char *contact; /**< contact information for the module */
1356 const char *dsc; /**< description of the module */
1357 const char *ref; /**< cross-reference for the module */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001358};
1359
1360/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001361 * @brief Get the parsed module or submodule name.
1362 *
1363 * @param[in] PMOD Parsed module or submodule.
1364 * @return Module or submodule name.
1365 */
1366#define LYSP_MODULE_NAME(PMOD) (PMOD->is_submod ? ((struct lysp_submodule *)PMOD)->name : ((struct lysp_module *)PMOD)->mod->name)
1367
1368/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001369 * @brief Compiled prefix data pair mapping of prefixes to modules. In case the format is ::LY_PREF_SCHEMA_RESOLVED,
1370 * the expected prefix data is a sized array of these structures.
1371 */
1372struct lysc_prefix {
1373 char *prefix; /**< used prefix */
1374 const struct lys_module *mod; /**< mapping to a module */
1375};
1376
1377/**
Radek Krejci0e59c312019-08-15 15:34:15 +02001378 * @brief Compiled YANG extension-stmt
Radek Krejci9f87b0c2021-03-05 14:45:26 +01001379 *
1380 * Note that the compiled extension definition is created only in case the extension is instantiated. It is not available
1381 * from the compiled schema, but from the parsed extension definition which is being searched when an extension instance
1382 * is being compiled.
Radek Krejci0e59c312019-08-15 15:34:15 +02001383 */
1384struct lysc_ext {
1385 const char *name; /**< extension name */
Radek Krejci9f87b0c2021-03-05 14:45:26 +01001386 const char *argname; /**< argument name, NULL if not specified */
Radek Krejci0e59c312019-08-15 15:34:15 +02001387 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1388 struct lyext_plugin *plugin; /**< Plugin implementing the specific extension */
Radek Krejci0935f412019-08-20 16:15:18 +02001389 struct lys_module *module; /**< module structure */
Michal Vasko6f4cbb62020-02-28 11:15:47 +01001390 uint32_t refcount; /**< reference counter since extension definition is shared among all its instances */
Radek Krejci0e59c312019-08-15 15:34:15 +02001391 uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */
1392};
1393
1394/**
Radek Krejcice8c1592018-10-29 15:35:51 +01001395 * @brief YANG extension instance
1396 */
1397struct lysc_ext_instance {
Radek Krejciad5963b2019-09-06 16:03:05 +02001398 struct lysc_ext *def; /**< pointer to the extension definition */
Radek Krejcice8c1592018-10-29 15:35:51 +01001399 const char *argument; /**< optional value of the extension's argument */
Radek Krejciab430862021-03-02 20:13:40 +01001400 struct lys_module *module; /**< module where the extension instantiated is defined */
Radek Krejci2a408df2018-10-29 16:32:26 +01001401 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5f9a3672021-03-05 21:35:22 +01001402 struct lysc_ext_substmt *substmts; /**< list of allowed substatements with the storage to access the present
1403 substatements ([sized array](@ref sizedarrays)) */
Radek Krejci0e59c312019-08-15 15:34:15 +02001404 void *data; /**< private plugins's data, not used by libyang */
Radek Krejciab430862021-03-02 20:13:40 +01001405
1406 void *parent; /**< pointer to the parent element holding the extension instance(s), use
1407 ::lysc_ext_instance#parent_stmt to access the schema element */
1408 enum ly_stmt parent_stmt; /**< value identifying placement of the extension instance in specific statement */
1409 LY_ARRAY_COUNT_TYPE parent_stmt_index; /**< in case the instance is in a substatement, this identifies
1410 the index of that substatement in its [sized array](@ref sizedarrays) (if any) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001411};
1412
1413/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001414 * @brief YANG when-stmt
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001415 */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001416struct lysc_when {
1417 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko175012e2019-11-06 15:49:14 +01001418 struct lysc_node *context; /**< context node for evaluating the expression, NULL if the context is root node */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001419 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001420 const char *dsc; /**< description */
1421 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001422 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00b874b2019-02-12 10:54:50 +01001423 uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */
Michal Vaskoecd62de2019-11-13 12:35:11 +01001424 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS is allowed */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001425};
1426
1427/**
Radek Krejci2a408df2018-10-29 16:32:26 +01001428 * @brief YANG identity-stmt
1429 */
1430struct lysc_ident {
1431 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejcic8b31002019-01-08 10:24:45 +01001432 const char *dsc; /**< description */
1433 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001434 struct lys_module *module; /**< module structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001435 struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */
1436 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1437 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
1438};
1439
1440/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001441 * @defgroup ifftokens if-feature expression tokens
Radek Krejci8678fa42020-08-18 16:07:28 +02001442 * Tokens of if-feature expression used in ::lysc_iffeature.expr.
Radek Krejci151a5b72018-10-19 14:21:44 +02001443 *
1444 * @{
1445 */
1446#define LYS_IFF_NOT 0x00 /**< operand "not" */
1447#define LYS_IFF_AND 0x01 /**< operand "and" */
1448#define LYS_IFF_OR 0x02 /**< operand "or" */
1449#define LYS_IFF_F 0x03 /**< feature */
Radek Krejci2ff0d572020-05-21 15:27:28 +02001450/** @} ifftokens */
Radek Krejci151a5b72018-10-19 14:21:44 +02001451
1452/**
Radek Krejcib7db73a2018-10-24 14:18:40 +02001453 * @brief Compiled YANG revision statement
1454 */
1455struct lysc_revision {
1456 char date[LY_REV_SIZE]; /**< revision-date (mandatory) */
1457 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1458};
1459
Radek Krejci2167ee12018-11-02 16:09:07 +01001460struct lysc_range {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001461 struct lysc_range_part {
Radek Krejci693262f2019-04-29 15:23:20 +02001462 union { /**< min boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001463 int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1464 uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001465 };
Radek Krejci693262f2019-04-29 15:23:20 +02001466 union { /**< max boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001467 int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1468 uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001469 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001470 } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001471 const char *dsc; /**< description */
1472 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001473 const char *emsg; /**< error-message */
1474 const char *eapptag; /**< error-app-tag value */
1475 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1476};
1477
1478struct lysc_pattern {
Radek Krejci54579462019-04-30 12:47:06 +02001479 const char *expr; /**< original, not compiled, regular expression */
1480 pcre2_code *code; /**< compiled regular expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001481 const char *dsc; /**< description */
1482 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001483 const char *emsg; /**< error-message */
1484 const char *eapptag; /**< error-app-tag value */
1485 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0f969882020-08-21 16:56:47 +02001486 uint32_t inverted : 1; /**< invert-match flag */
1487 uint32_t refcount : 31; /**< reference counter */
Radek Krejci2167ee12018-11-02 16:09:07 +01001488};
1489
1490struct lysc_must {
Radek Krejci2167ee12018-11-02 16:09:07 +01001491 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001492 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001493 const char *dsc; /**< description */
1494 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001495 const char *emsg; /**< error-message */
1496 const char *eapptag; /**< error-app-tag value */
1497 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1498};
1499
1500struct lysc_type {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001501 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001502 struct lysc_type_plugin *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 +01001503 LY_DATA_TYPE basetype; /**< Base type of the type */
1504 uint32_t refcount; /**< reference counter for type sharing */
1505};
1506
1507struct lysc_type_num {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001508 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001509 struct lysc_type_plugin *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 +01001510 LY_DATA_TYPE basetype; /**< Base type of the type */
1511 uint32_t refcount; /**< reference counter for type sharing */
1512 struct lysc_range *range; /**< Optional range limitation */
1513};
1514
1515struct lysc_type_dec {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001516 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001517 struct lysc_type_plugin *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 +01001518 LY_DATA_TYPE basetype; /**< Base type of the type */
1519 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci6cba4292018-11-15 17:33:29 +01001520 uint8_t fraction_digits; /**< fraction digits specification */
Radek Krejci2167ee12018-11-02 16:09:07 +01001521 struct lysc_range *range; /**< Optional range limitation */
1522};
1523
1524struct lysc_type_str {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001525 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001526 struct lysc_type_plugin *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 +01001527 LY_DATA_TYPE basetype; /**< Base type of the type */
1528 uint32_t refcount; /**< reference counter for type sharing */
1529 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci4586a022018-11-13 11:29:26 +01001530 struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001531};
1532
Radek Krejci693262f2019-04-29 15:23:20 +02001533struct lysc_type_bitenum_item {
1534 const char *name; /**< enumeration identifier */
1535 const char *dsc; /**< description */
1536 const char *ref; /**< reference */
1537 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci693262f2019-04-29 15:23:20 +02001538 union {
1539 int32_t value; /**< integer value associated with the enumeration */
1540 uint32_t position; /**< non-negative integer value associated with the bit */
1541 };
1542 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
1543 values are allowed */
1544};
1545
Radek Krejci2167ee12018-11-02 16:09:07 +01001546struct lysc_type_enum {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001547 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001548 struct lysc_type_plugin *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001549 LY_DATA_TYPE basetype; /**< Base type of the type */
1550 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci693262f2019-04-29 15:23:20 +02001551 struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1552};
1553
1554struct lysc_type_bits {
1555 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001556 struct lysc_type_plugin *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 +02001557 LY_DATA_TYPE basetype; /**< Base type of the type */
1558 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci849a62a2019-05-22 15:29:05 +02001559 struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item),
1560 the items are ordered by their position value. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001561};
1562
1563struct lysc_type_leafref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001564 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001565 struct lysc_type_plugin *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 +01001566 LY_DATA_TYPE basetype; /**< Base type of the type */
1567 uint32_t refcount; /**< reference counter for type sharing */
Michal Vasko004d3152020-06-11 19:59:22 +02001568 struct lyxp_expr *path; /**< parsed target path, compiled path cannot be stored because of type sharing */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001569 struct lysc_prefix *prefixes; /**< resolved prefixes used in the path */
Michal Vaskoc0792ca2020-12-01 12:03:21 +01001570 const struct lys_module *cur_mod;/**< current module for the leafref (path) */
Radek Krejci412ddfa2018-11-23 11:44:11 +01001571 struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001572 uint8_t require_instance; /**< require-instance flag */
1573};
1574
1575struct lysc_type_identityref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001576 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001577 struct lysc_type_plugin *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 +01001578 LY_DATA_TYPE basetype; /**< Base type of the type */
1579 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci555cb5b2018-11-16 14:54:33 +01001580 struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)),
Radek Krejci2167ee12018-11-02 16:09:07 +01001581 mandatory (at least 1 item) */
1582};
1583
1584struct lysc_type_instanceid {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001585 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001586 struct lysc_type_plugin *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 +01001587 LY_DATA_TYPE basetype; /**< Base type of the type */
1588 uint32_t refcount; /**< reference counter for type sharing */
1589 uint8_t require_instance; /**< require-instance flag */
1590};
1591
Radek Krejci2167ee12018-11-02 16:09:07 +01001592struct lysc_type_union {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001593 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001594 struct lysc_type_plugin *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 +01001595 LY_DATA_TYPE basetype; /**< Base type of the type */
1596 uint32_t refcount; /**< reference counter for type sharing */
1597 struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1598};
1599
1600struct lysc_type_bin {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001601 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001602 struct lysc_type_plugin *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 +01001603 LY_DATA_TYPE basetype; /**< Base type of the type */
1604 uint32_t refcount; /**< reference counter for type sharing */
1605 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001606};
1607
Michal Vasko60ea6352020-06-29 13:39:39 +02001608/**
1609 * @brief Maximum number of hashes stored in a schema node.
1610 */
1611#define LYS_NODE_HASH_COUNT 4
1612
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001613/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001614 * @brief Compiled YANG data node
1615 */
1616struct lysc_node {
Radek Krejcide7a9c42021-03-10 13:13:06 +01001617 uint16_t nodetype; /**< [type of the node](@ref schemanodetypes) (mandatory) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001618 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Michal Vasko60ea6352020-06-29 13:39:39 +02001619 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001620 struct lys_module *module; /**< module structure */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001621 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1622 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1623 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1624 never NULL. If there is no sibling node, pointer points to the node
1625 itself. In case of the first node, this pointer points to the last
1626 node in the list. */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001627 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001628 const char *dsc; /**< description */
1629 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001630 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko2fd91b92020-07-17 16:39:02 +02001631 void *priv; /**< private arbitrary user data, not used by libyang */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001632};
1633
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001634struct lysc_node_action_inout {
1635 union {
1636 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1637 struct {
1638 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1639 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1640 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1641 struct lys_module *module; /**< module structure */
Radek Krejci5960c312021-01-27 20:24:22 +01001642 struct lysc_node *parent;/**< parent node (NULL in case of top level node) */
Michal Vasko544e58a2021-01-28 14:33:41 +01001643 struct lysc_node *next; /**< next sibling node (output node for input, NULL for output) */
1644 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 +01001645 const char *name; /**< "input" or "output" */
1646 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysc_node */
1647 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysc_node */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001648 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001649 void *priv; /** private arbitrary user data, not used by libyang */
1650 };
1651 };
1652
Radek Krejci9a3823e2021-01-27 20:26:46 +01001653 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001654 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1655};
1656
1657struct lysc_node_action {
1658 union {
1659 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1660 struct {
1661 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1662 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1663 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1664 struct lys_module *module; /**< module structure */
1665 struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */
1666 struct lysc_node_action *next; /**< next sibling node (NULL if there is no one) */
1667 struct lysc_node_action *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1668 never NULL. If there is no sibling node, pointer points to the node
1669 itself. In case of the first node, this pointer points to the last
1670 node in the list. */
1671 const char *name; /**< action/RPC name (mandatory) */
1672 const char *dsc; /**< description */
1673 const char *ref; /**< reference */
1674 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001675 void *priv; /** private arbitrary user data, not used by libyang */
1676 };
1677 };
1678
Radek Krejci9a3823e2021-01-27 20:26:46 +01001679 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1680 the action/RPC nodes do not contain the when statement on their own, but they can
1681 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001682 struct lysc_node_action_inout input; /**< RPC's/action's input */
1683 struct lysc_node_action_inout output; /**< RPC's/action's output */
1684
1685};
1686
1687struct lysc_node_notif {
1688 union {
1689 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1690 struct {
1691 uint16_t nodetype; /**< LYS_NOTIF */
1692 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1693 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1694 struct lys_module *module; /**< module structure */
1695 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1696 struct lysc_node_notif *next; /**< next sibling node (NULL if there is no one) */
1697 struct lysc_node_notif *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1698 never NULL. If there is no sibling node, pointer points to the node
1699 itself. In case of the first node, this pointer points to the last
1700 node in the list. */
1701 const char *name; /**< Notification name (mandatory) */
1702 const char *dsc; /**< description */
1703 const char *ref; /**< reference */
1704 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001705 void *priv; /** private arbitrary user data, not used by libyang */
1706 };
1707 };
1708
Radek Krejci9a3823e2021-01-27 20:26:46 +01001709 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001710 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001711 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1712 the notification nodes do not contain the when statement on their own, but they can
1713 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001714};
1715
1716struct lysc_node_container {
1717 union {
1718 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1719 struct {
1720 uint16_t nodetype; /**< LYS_CONTAINER */
1721 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1722 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1723 struct lys_module *module; /**< module structure */
1724 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1725 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1726 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1727 never NULL. If there is no sibling node, pointer points to the node
1728 itself. In case of the first node, this pointer points to the last
1729 node in the list. */
1730 const char *name; /**< node name (mandatory) */
1731 const char *dsc; /**< description */
1732 const char *ref; /**< reference */
1733 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001734 void *priv; /**< private arbitrary user data, not used by libyang */
1735 };
1736 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001737
1738 struct lysc_node *child; /**< first child node (linked list) */
1739 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001740 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001741 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1742 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001743};
1744
Radek Krejcia3045382018-11-22 14:30:31 +01001745struct lysc_node_case {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001746 union {
1747 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1748 struct {
1749 uint16_t nodetype; /**< LYS_CASE */
1750 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1751 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1752 struct lys_module *module; /**< module structure */
1753 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1754 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1755 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejci056d0a82018-12-06 16:57:25 +01001756 never NULL. If there is no sibling node, pointer points to the node
1757 itself. In case of the first node, this pointer points to the last
1758 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001759 const char *name; /**< name of the case, including the implicit case */
1760 const char *dsc; /**< description */
1761 const char *ref; /**< reference */
1762 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001763 void *priv; /**< private arbitrary user data, not used by libyang */
1764 };
1765 };
Radek Krejci056d0a82018-12-06 16:57:25 +01001766
Radek Krejcia3045382018-11-22 14:30:31 +01001767 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 +01001768 each other as siblings with the parent pointer pointing to appropriate case node. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001769 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcia3045382018-11-22 14:30:31 +01001770};
1771
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001772struct lysc_node_choice {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001773 union {
1774 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1775 struct {
1776 uint16_t nodetype; /**< LYS_CHOICE */
1777 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1778 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1779 struct lys_module *module; /**< module structure */
1780 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1781 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1782 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001783 never NULL. If there is no sibling node, pointer points to the node
1784 itself. In case of the first node, this pointer points to the last
1785 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001786 const char *name; /**< node name (mandatory) */
1787 const char *dsc; /**< description */
1788 const char *ref; /**< reference */
1789 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001790 void *priv; /**< private arbitrary user data, not used by libyang */
1791 };
1792 };
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001793
Radek Krejcia9026eb2018-12-12 16:04:47 +01001794 struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other
1795 as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the
1796 case is simple. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001797 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001798 struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001799};
1800
1801struct lysc_node_leaf {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001802 union {
1803 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1804 struct {
1805 uint16_t nodetype; /**< LYS_LEAF */
1806 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1807 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1808 struct lys_module *module; /**< module structure */
1809 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1810 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1811 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001812 never NULL. If there is no sibling node, pointer points to the node
1813 itself. In case of the first node, this pointer points to the last
1814 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001815 const char *name; /**< node name (mandatory) */
1816 const char *dsc; /**< description */
1817 const char *ref; /**< reference */
1818 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001819 void *priv; /**< private arbitrary user data, not used by libyang */
1820 };
1821 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001822
1823 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001824 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001825 struct lysc_type *type; /**< type of the leaf node (mandatory) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001826
Radek Krejci4f28eda2018-11-12 11:46:16 +01001827 const char *units; /**< units of the leaf's type */
Radek Krejcia1911222019-07-22 17:24:50 +02001828 struct lyd_value *dflt; /**< default value */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001829};
1830
1831struct lysc_node_leaflist {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001832 union {
1833 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1834 struct {
1835 uint16_t nodetype; /**< LYS_LEAFLIST */
1836 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1837 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1838 struct lys_module *module; /**< module structure */
1839 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1840 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1841 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001842 never NULL. If there is no sibling node, pointer points to the node
1843 itself. In case of the first node, this pointer points to the last
1844 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001845 const char *name; /**< node name (mandatory) */
1846 const char *dsc; /**< description */
1847 const char *ref; /**< reference */
1848 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001849 void *priv; /**< private arbitrary user data, not used by libyang */
1850 };
1851 };
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001852
1853 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001854 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001855 struct lysc_type *type; /**< type of the leaf node (mandatory) */
1856
Radek Krejci0e5d8382018-11-28 16:37:53 +01001857 const char *units; /**< units of the leaf's type */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001858 struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */
Michal Vaskoba99a3e2020-08-18 15:50:05 +02001859
Radek Krejci0e5d8382018-11-28 16:37:53 +01001860 uint32_t min; /**< min-elements constraint */
1861 uint32_t max; /**< max-elements constraint */
1862
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001863};
1864
1865struct lysc_node_list {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001866 union {
1867 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1868 struct {
1869 uint16_t nodetype; /**< LYS_LIST */
1870 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1871 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1872 struct lys_module *module; /**< module structure */
1873 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1874 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1875 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001876 never NULL. If there is no sibling node, pointer points to the node
1877 itself. In case of the first node, this pointer points to the last
1878 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001879 const char *name; /**< node name (mandatory) */
1880 const char *dsc; /**< description */
1881 const char *ref; /**< reference */
1882 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001883 void *priv; /**< private arbitrary user data, not used by libyang */
1884 };
1885 };
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001886
1887 struct lysc_node *child; /**< first child node (linked list) */
1888 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001889 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001890 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1891 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001892
Radek Krejci2a9fc652021-01-22 17:44:34 +01001893 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 +01001894 uint32_t min; /**< min-elements constraint */
1895 uint32_t max; /**< max-elements constraint */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001896};
1897
1898struct lysc_node_anydata {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001899 union {
1900 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1901 struct {
1902 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1903 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1904 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1905 struct lys_module *module; /**< module structure */
1906 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1907 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1908 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001909 never NULL. If there is no sibling node, pointer points to the node
1910 itself. In case of the first node, this pointer points to the last
1911 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001912 const char *name; /**< node name (mandatory) */
1913 const char *dsc; /**< description */
1914 const char *ref; /**< reference */
1915 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001916 void *priv; /**< private arbitrary user data, not used by libyang */
1917 };
1918 };
Radek Krejci9800fb82018-12-13 14:26:23 +01001919
1920 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001921 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001922};
1923
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001924/**
1925 * @brief Compiled YANG schema tree structure representing YANG module.
1926 *
1927 * Semantically validated YANG schema tree for data tree parsing.
1928 * Contains only the necessary information for the data validation.
1929 */
1930struct lysc_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001931 struct lys_module *mod; /**< covering module structure */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001932
Radek Krejci2a408df2018-10-29 16:32:26 +01001933 struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001934 struct lysc_node_action *rpcs; /**< first of actions nodes (linked list) */
1935 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001936 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001937};
1938
1939/**
Radek Krejci490a5462020-11-05 08:44:42 +01001940 * @brief Examine whether a node is user-ordered list or leaf-list.
1941 *
1942 * @param[in] lysc_node Schema node to examine.
1943 * @return Boolean value whether the @p node is user-ordered or not.
1944 */
1945#define lysc_is_userordered(lysc_node) \
1946 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAFLIST | LYS_LIST)) || !(lysc_node->flags & LYS_ORDBY_USER)) ? 0 : 1)
1947
1948/**
1949 * @brief Examine whether a node is a list's key.
1950 *
1951 * @param[in] lysc_node Schema node to examine.
1952 * @return Boolean value whether the @p node is a key or not.
1953 */
1954#define lysc_is_key(lysc_node) \
Michal Vaskobce7ee32021-02-04 11:05:25 +01001955 ((!lysc_node || (lysc_node->nodetype != LYS_LEAF) || !(lysc_node->flags & LYS_KEY)) ? 0 : 1)
Radek Krejci490a5462020-11-05 08:44:42 +01001956
1957/**
Michal Vasko5c123b02020-12-04 14:34:04 +01001958 * @brief Examine whether a node is a non-presence container.
1959 *
1960 * @param[in] lysc_node Schema node to examine.
1961 * @return Boolean value whether the @p node is a NP container or not.
1962 */
1963#define lysc_is_np_cont(lysc_node) \
Michal Vaskobce7ee32021-02-04 11:05:25 +01001964 ((!lysc_node || (lysc_node->nodetype != LYS_CONTAINER) || (lysc_node->flags & LYS_PRESENCE)) ? 0 : 1)
1965
1966/**
1967 * @brief Examine whether a node is a key-less list or a state leaf-list.
1968 *
1969 * @param[in] lysc_node Schema node to examine.
1970 * @return Boolean value whether the @p node is a list with duplicate instances allowed.
1971 */
1972#define lysc_is_dup_inst_list(lysc_node) \
1973 ((lysc_node && (((lysc_node->nodetype == LYS_LIST) && (lysc_node->flags & LYS_KEYLESS)) || \
1974 ((lysc_node->nodetype == LYS_LEAFLIST) && (lysc_node->flags & LYS_CONFIG_R)))) ? 1 : 0)
Michal Vasko5c123b02020-12-04 14:34:04 +01001975
1976/**
Michal Vaskod5cfa6e2020-11-23 16:56:08 +01001977 * @brief Check whether the schema node data instance existence depends on any when conditions.
1978 * This node and any direct parent choice and case schema nodes are also examined for when conditions.
1979 *
1980 * Be careful, this function is not recursive and checks only conditions that apply to this node directly.
1981 * Meaning if there are any conditions associated with any data parent instance of @p node, they are not returned.
1982 *
1983 * @param[in] node Schema node to examine.
1984 * @return When condition associated with the node data instance, NULL if there is none.
1985 */
1986const struct lysc_when *lysc_has_when(const struct lysc_node *node);
1987
1988/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001989 * @brief Get the groupings linked list of the given (parsed) schema node.
Radek Krejci53ea6152018-12-13 15:21:15 +01001990 * Decides the node's type and in case it has a groupings array, returns it.
1991 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001992 * @return The node's groupings linked list if any, NULL otherwise.
Radek Krejci53ea6152018-12-13 15:21:15 +01001993 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001994const struct lysp_node_grp *lysp_node_groupings(const struct lysp_node *node);
Radek Krejci53ea6152018-12-13 15:21:15 +01001995
1996/**
Radek Krejci056d0a82018-12-06 16:57:25 +01001997 * @brief Get the typedefs sized array of the given (parsed) schema node.
1998 * Decides the node's type and in case it has a typedefs array, returns it.
1999 * @param[in] node Node to examine.
2000 * @return The node's typedefs sized array if any, NULL otherwise.
2001 */
2002const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
2003
2004/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002005 * @brief Get the actions/RPCs linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002006 * Decides the node's type and in case it has a actions/RPCs array, returns it.
2007 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002008 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002009 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002010const struct lysp_node_action *lysp_node_actions(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002011
2012/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002013 * @brief Get the Notifications linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002014 * Decides the node's type and in case it has a Notifications array, returns it.
2015 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002016 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002017 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002018const struct lysp_node_notif *lysp_node_notifs(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002019
2020/**
2021 * @brief Get the children linked list of the given (parsed) schema node.
2022 * Decides the node's type and in case it has a children list, returns it.
2023 * @param[in] node Node to examine.
2024 * @return The node's children linked list if any, NULL otherwise.
2025 */
Michal Vasko544e58a2021-01-28 14:33:41 +01002026const struct lysp_node *lysp_node_child(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002027
2028/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002029 * @brief Get the actions/RPCs linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002030 * Decides the node's type and in case it has a actions/RPCs array, returns it.
2031 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002032 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002033 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002034const struct lysc_node_action *lysc_node_actions(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002035
2036/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002037 * @brief Get the Notifications linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002038 * Decides the node's type and in case it has a Notifications array, returns it.
2039 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002040 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002041 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002042const struct lysc_node_notif *lysc_node_notifs(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002043
2044/**
2045 * @brief Get the children linked list of the given (compiled) schema node.
Michal Vasko2a668712020-10-21 11:48:09 +02002046 *
Michal Vasko544e58a2021-01-28 14:33:41 +01002047 * Note that ::LYS_CHOICE has only ::LYS_CASE children.
2048 * Also, ::LYS_RPC and ::LYS_ACTION have the first child ::LYS_INPUT, its sibling is ::LYS_OUTPUT.
2049 *
Michal Vasko2a668712020-10-21 11:48:09 +02002050 * @param[in] node Node to examine.
Michal Vasko2a668712020-10-21 11:48:09 +02002051 * @return Children linked list if any,
2052 * @return NULL otherwise.
2053 */
Michal Vasko544e58a2021-01-28 14:33:41 +01002054const struct lysc_node *lysc_node_child(const struct lysc_node *node);
Michal Vasko2a668712020-10-21 11:48:09 +02002055
2056/**
Radek Krejci9a3823e2021-01-27 20:26:46 +01002057 * @brief Get the must statements list if present in the @p node
2058 *
2059 * @param[in] node Node to examine.
2060 * @return Pointer to the list of must restrictions ([sized array](@ref sizedarrays))
2061 * @return NULL if there is no must statement in the node, no matter if it is not even allowed or just present
2062 */
2063struct lysc_must *lysc_node_musts(const struct lysc_node *node);
2064
2065/**
2066 * @brief Get the when statements list if present in the @p node
2067 *
2068 * @param[in] node Node to examine.
2069 * @return Pointer to the list of pointers to when statements ([sized array](@ref sizedarrays))
2070 * @return NULL if there is no when statement in the node, no matter if it is not even allowed or just present
2071 */
2072struct lysc_when **lysc_node_when(const struct lysc_node *node);
2073
2074/**
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002075 * @brief Callback to be called for every schema node in a DFS traversal.
2076 *
2077 * @param[in] node Current node.
2078 * @param[in] data Arbitrary user data.
2079 * @param[out] dfs_continue Set to true if the current subtree should be skipped and continue with siblings instead.
2080 * @return LY_SUCCESS on success,
2081 * @return LY_ERR value to terminate DFS and return this value.
2082 */
Michal Vasko8f07dfe2021-03-02 16:10:24 +01002083typedef LY_ERR (*lysc_dfs_clb)(struct lysc_node *node, void *data, ly_bool *dfs_continue);
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002084
2085/**
2086 * @brief DFS traversal of all the schema nodes in a (sub)tree including any actions and nested notifications.
2087 *
2088 * Node with children, actions, and notifications is traversed in this order:
2089 * 1) each child subtree;
2090 * 2) each action subtree;
2091 * 3) each notification subtree.
2092 *
2093 * For algorithm illustration or traversal with actions and notifications skipped, see ::LYSC_TREE_DFS_BEGIN.
2094 *
2095 * @param[in] root Schema root to fully traverse.
2096 * @param[in] dfs_clb Callback to call for each node.
2097 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2098 * @return LY_SUCCESS on success,
2099 * @return LY_ERR value returned by @p dfs_clb.
2100 */
2101LY_ERR lysc_tree_dfs_full(const struct lysc_node *root, lysc_dfs_clb dfs_clb, void *data);
2102
2103/**
2104 * @brief DFS traversal of all the schema nodes in a module including RPCs and notifications.
2105 *
2106 * For more details, see ::lysc_tree_dfs_full().
2107 *
2108 * @param[in] mod Module to fully traverse.
2109 * @param[in] dfs_clb Callback to call for each node.
2110 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2111 * @return LY_SUCCESS on success,
2112 * @return LY_ERR value returned by @p dfs_clb.
2113 */
2114LY_ERR lysc_module_dfs_full(const struct lys_module *mod, lysc_dfs_clb dfs_clb, void *data);
2115
2116/**
Radek Krejci151a5b72018-10-19 14:21:44 +02002117 * @brief Get how the if-feature statement currently evaluates.
2118 *
2119 * @param[in] iff Compiled if-feature statement to evaluate.
Michal Vasko28d78432020-05-26 13:10:53 +02002120 * @return LY_SUCCESS if the statement evaluates to true,
2121 * @return LY_ENOT if it evaluates to false,
2122 * @return LY_ERR on error.
Radek Krejci151a5b72018-10-19 14:21:44 +02002123 */
Michal Vasko28d78432020-05-26 13:10:53 +02002124LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff);
Radek Krejci151a5b72018-10-19 14:21:44 +02002125
2126/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002127 * @brief Get the next feature in the module or submodules.
Radek Krejci151a5b72018-10-19 14:21:44 +02002128 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002129 * @param[in] last Last returned feature.
2130 * @param[in] pmod Parsed module and submodoules whose features to iterate over.
2131 * @param[in,out] idx Submodule index, set to 0 on first call.
2132 * @return Next found feature, NULL if the last has already been returned.
Radek Krejci151a5b72018-10-19 14:21:44 +02002133 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002134struct 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 +02002135
Radek Krejcibed13942020-10-19 16:06:28 +02002136/**
2137 * @defgroup findxpathoptions Atomize XPath options
2138 * Options to modify behavior of ::lys_find_xpath() and ::lys_find_xpath_atoms() searching for schema nodes in schema tree.
2139 * @{
2140 */
Michal Vaskocdad7122020-11-09 21:04:44 +01002141#define LYS_FIND_XP_SCHEMA 0x08 /**< Apply node access restrictions defined for 'when' and 'must' evaluation. */
2142#define LYS_FIND_XP_OUTPUT 0x10 /**< Search RPC/action output nodes instead of input ones. */
Radek Krejci576f8fa2020-10-26 21:23:58 +01002143/** @} findxpathoptions */
Michal Vasko072de482020-08-05 13:27:21 +02002144
Radek Krejci151a5b72018-10-19 14:21:44 +02002145/**
Michal Vasko40308e72020-10-20 16:38:40 +02002146 * @brief Get all the schema nodes that are required for @p xpath to be evaluated (atoms).
Michal Vasko519fd602020-05-26 12:17:39 +02002147 *
Michal Vasko26512682021-01-11 11:35:40 +01002148 * @param[in] ctx libyang context to use. May be NULL if @p ctx_node is set.
2149 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002150 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002151 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko519fd602020-05-26 12:17:39 +02002152 * @param[out] set Set of found atoms (schema nodes).
2153 * @return LY_SUCCESS on success, @p set is returned.
Michal Vasko40308e72020-10-20 16:38:40 +02002154 * @return LY_ERR value on error.
Michal Vasko519fd602020-05-26 12:17:39 +02002155 */
Michal Vasko26512682021-01-11 11:35:40 +01002156LY_ERR lys_find_xpath_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
2157 uint32_t options, struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002158
Michal Vasko072de482020-08-05 13:27:21 +02002159/**
Michal Vasko40308e72020-10-20 16:38:40 +02002160 * @brief Get all the schema nodes that are required for @p expr to be evaluated (atoms).
Michal Vasko072de482020-08-05 13:27:21 +02002161 *
Michal Vasko26512682021-01-11 11:35:40 +01002162 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002163 * @param[in] cur_mod Current module for the expression (where it was "instantiated").
2164 * @param[in] expr Parsed expression to use.
2165 * @param[in] prefixes Sized array of compiled prefixes.
2166 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
2167 * @param[out] set Set of found atoms (schema nodes).
2168 * @return LY_SUCCESS on success, @p set is returned.
2169 * @return LY_ERR value on error.
2170 */
2171LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod,
2172 const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set);
2173
2174/**
2175 * @brief Evaluate an @p xpath expression on schema nodes.
2176 *
Michal Vasko26512682021-01-11 11:35:40 +01002177 * @param[in] ctx libyang context to use for absolute @p xpath. May be NULL if @p ctx_node is set.
2178 * @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 +02002179 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002180 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko072de482020-08-05 13:27:21 +02002181 * @param[out] set Set of found schema nodes.
2182 * @return LY_SUCCESS on success, @p set is returned.
2183 * @return LY_ERR value if an error occurred.
2184 */
Michal Vasko26512682021-01-11 11:35:40 +01002185LY_ERR lys_find_xpath(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath, uint32_t options,
2186 struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002187
2188/**
Radek Krejcibc5644c2020-10-27 14:53:17 +01002189 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2190 *
2191 * @param[in] path Compiled path to use.
2192 * @param[out] set Set of found atoms (schema nodes).
2193 * @return LY_SUCCESS on success, @p set is returned.
2194 * @return LY_ERR value on error.
2195 */
2196LY_ERR lys_find_lypath_atoms(const struct ly_path *path, struct ly_set **set);
2197
2198/**
2199 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2200 *
Michal Vasko26512682021-01-11 11:35:40 +01002201 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2202 * @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 +01002203 * @param[in] path JSON path to examine.
2204 * @param[in] output Search operation output instead of input.
2205 * @param[out] set Set of found atoms (schema nodes).
2206 * @return LY_ERR value on error.
2207 */
2208LY_ERR lys_find_path_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path, ly_bool output,
2209 struct ly_set **set);
2210
2211/**
2212 * @brief Get a schema node based on the given data path (JSON format, see @ref howtoXPath).
2213 *
Michal Vasko26512682021-01-11 11:35:40 +01002214 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2215 * @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 +01002216 * @param[in] path JSON path of the node to get.
2217 * @param[in] output Search operation output instead of input.
2218 * @return Found schema node or NULL.
2219 */
2220const struct lysc_node *lys_find_path(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path,
2221 ly_bool output);
2222
2223/**
Michal Vasko03ff5a72019-09-11 13:49:33 +02002224 * @brief Types of the different schema paths.
2225 */
2226typedef enum {
Michal Vasko65de0402020-08-03 16:34:19 +02002227 LYSC_PATH_LOG, /**< Descriptive path format used in log messages */
2228 LYSC_PATH_DATA /**< Similar to ::LYSC_PATH_LOG except that schema-only nodes (choice, case) are skipped */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002229} LYSC_PATH_TYPE;
2230
2231/**
Radek Krejci327de162019-06-14 12:52:07 +02002232 * @brief Generate path of the given node in the requested format.
2233 *
2234 * @param[in] node Schema path of this node will be generated.
2235 * @param[in] pathtype Format of the path to generate.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002236 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
2237 * If NULL, memory for the complete path is allocated.
2238 * @param[in] buflen Size of the provided @p buffer.
Radek Krejci327de162019-06-14 12:52:07 +02002239 * @return NULL in case of memory allocation error, path of the node otherwise.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002240 * 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 +02002241 */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002242char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
Radek Krejci327de162019-06-14 12:52:07 +02002243
2244/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002245 * @brief Available YANG schema tree structures representing YANG module.
2246 */
2247struct lys_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002248 struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */
2249 const char *name; /**< name of the module (mandatory) */
Radek Krejci0af46292019-01-11 16:02:31 +01002250 const char *revision; /**< revision of the module (if present) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002251 const char *ns; /**< namespace of the module (module - mandatory) */
2252 const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */
2253 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
2254 const char *org; /**< party/company responsible for the module */
2255 const char *contact; /**< contact information for the module */
2256 const char *dsc; /**< description of the module */
2257 const char *ref; /**< cross-reference for the module */
2258
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002259 struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */
Radek Krejci0af46292019-01-11 16:02:31 +01002260 struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing.
2261 Available only for implemented modules. */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002262
Radek Krejci80d281e2020-09-14 17:42:54 +02002263 struct lysc_ident *identities; /**< List of compiled identities of the module ([sized array](@ref sizedarrays))
2264 Identities are outside the compiled tree to allow their linkage to the identities from
2265 the implemented modules. This avoids problems when the module became implemented in
2266 future (no matter if implicitly via augment/deviate or explicitly via
2267 ::lys_set_implemented()). Note that if the module is not implemented (compiled), the
2268 identities cannot be instantiated in data (in identityrefs). */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002269
2270 struct lys_module **augmented_by;/**< List of modules that augment this module ([sized array](@ref sizedarrays)) */
2271 struct lys_module **deviated_by; /**< List of modules that deviate this module ([sized array](@ref sizedarrays)) */
2272
Michal Vasko89b5c072020-10-06 13:52:44 +02002273 ly_bool implemented; /**< flag if the module is implemented, not just imported */
Radek Krejci95710c92019-02-11 15:49:55 +01002274 uint8_t latest_revision; /**< flag to mark the latest available revision:
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002275 1 - the latest revision in searchdirs was not searched yet and this is the
2276 latest revision in the current context
2277 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002278};
2279
Radek Krejci151a5b72018-10-19 14:21:44 +02002280/**
Michal Vasko82c31e62020-07-17 15:30:40 +02002281 * @brief Get the current real status of the specified feature in the module.
2282 *
2283 * If the feature is enabled, but some of its if-features are false, the feature is considered
2284 * disabled.
Radek Krejci151a5b72018-10-19 14:21:44 +02002285 *
2286 * @param[in] module Module where the feature is defined.
2287 * @param[in] feature Name of the feature to inspect.
Michal Vasko82c31e62020-07-17 15:30:40 +02002288 * @return LY_SUCCESS if the feature is enabled,
2289 * @return LY_ENOT if the feature is disabled,
2290 * @return LY_ENOTFOUND if the feature was not found.
Radek Krejci151a5b72018-10-19 14:21:44 +02002291 */
Michal Vasko82c31e62020-07-17 15:30:40 +02002292LY_ERR lys_feature_value(const struct lys_module *module, const char *feature);
Radek Krejcidd4e8d42018-10-16 14:55:43 +02002293
2294/**
Radek Krejcia3045382018-11-22 14:30:31 +01002295 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can
2296 * be from an augment.
2297 *
Radek Krejci8678fa42020-08-18 16:07:28 +02002298 * ::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 +01002299 * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module.
2300 * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
2301 * \p parent and \p module parameters.
2302 *
2303 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
2304 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
2305 * all the schema nodes are iteratively returned.
2306 *
2307 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
2308 * @param[in] parent Parent of the subtree where the function starts processing.
2309 * @param[in] module In case of iterating on top level elements, the \p parent is NULL and
2310 * module must be specified.
2311 * @param[in] options [ORed options](@ref sgetnextflags).
2312 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
2313 */
2314const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002315 const struct lysc_module *module, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002316
2317/**
Radek Krejci035dacf2021-02-12 18:25:53 +01002318 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree.
Radek Krejci8678fa42020-08-18 16:07:28 +02002319 *
Radek Krejci035dacf2021-02-12 18:25:53 +01002320 * In contrast to ::lys_getnext(), ::lys_getnext_ext() is limited by the given @p ext instance as a schema tree root.
2321 * If the extension does not contain any schema node, NULL is returned. If the @p parent is provided, the functionality
2322 * is completely the same as ::lys_getnext().
2323 *
2324 * ::lys_getnext_ext() is supposed to be called sequentially. In the first call, the \p last parameter is usually NULL
2325 * and function starts returning i) the first \p parent's child or ii) the first top level element of the given @p ext
2326 * instance. Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
2327 * \p parent and \p ext parameters.
2328 *
2329 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
2330 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
2331 * all the schema nodes are iteratively returned.
2332 *
2333 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
2334 * @param[in] parent Parent of the subtree where the function starts processing.
2335 * @param[in] ext The extension instance to provide a separate schema tree. To consider the top level elements in the tree,
2336 * the \p parent must be NULL. anyway, at least one of @p parent and @p ext parameters must be specified.
2337 * @param[in] options [ORed options](@ref sgetnextflags).
2338 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
2339 */
2340const struct lysc_node *lys_getnext_ext(const struct lysc_node *last, const struct lysc_node *parent,
2341 const struct lysc_ext_instance *ext, uint32_t options);
2342
2343/**
2344 * @defgroup sgetnextflags Options for ::lys_getnext() and ::lys_getnext_ext().
2345 *
2346 * Various options setting behavior of ::lys_getnext() and ::lys_getnext_ext().
Radek Krejci8678fa42020-08-18 16:07:28 +02002347 *
Radek Krejcia3045382018-11-22 14:30:31 +01002348 * @{
2349 */
Radek Krejci8678fa42020-08-18 16:07:28 +02002350#define LYS_GETNEXT_WITHCHOICE 0x01 /**< ::lys_getnext() option to allow returning #LYS_CHOICE nodes instead of looking into them */
2351#define LYS_GETNEXT_NOCHOICE 0x02 /**< ::lys_getnext() option to ignore (kind of conditional) nodes within choice node */
2352#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 +01002353#define LYS_GETNEXT_INTONPCONT 0x08 /**< ::lys_getnext() option to look into non-presence container, instead of returning container itself */
2354#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 +01002355 provided by default */
Radek Krejcia3045382018-11-22 14:30:31 +01002356/** @} sgetnextflags */
2357
2358/**
2359 * @brief Get child node according to the specified criteria.
2360 *
2361 * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched.
2362 * @param[in] module module of the node to find. It is also limitation for the children node of the given parent.
2363 * @param[in] name Name of the node to find.
2364 * @param[in] name_len Optional length of the name in case it is not NULL-terminated string.
2365 * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find.
2366 * Used as a bitmask, so multiple nodetypes can be specified.
2367 * @param[in] options [ORed options](@ref sgetnextflags).
2368 * @return Found node if any.
2369 */
Michal Vaskoe444f752020-02-10 12:20:06 +01002370const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002371 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002372
2373/**
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002374 * @brief Make the specific module implemented.
2375 *
Michal Vaskoe8988e92021-01-25 11:26:29 +01002376 * If the module is already implemented but with a different set of features, the whole context is recompiled.
2377 *
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002378 * @param[in] mod Module to make implemented. It is not an error
2379 * to provide already implemented module, it just does nothing.
Michal Vaskoe8988e92021-01-25 11:26:29 +01002380 * @param[in] features Optional array specifying the enabled features terminated with NULL overriding any previous
2381 * feature setting. The feature string '*' enables all the features and array of length 1 with only the terminating
2382 * NULL explicitly disables all the features. In case the parameter is NULL, the features are untouched - left disabled
2383 * 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 +01002384 * @return LY_SUCCESS on success.
2385 * @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 +01002386 * @return LY_ERR on other errors during module compilation.
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002387 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002388LY_ERR lys_set_implemented(struct lys_module *mod, const char **features);
Radek Krejcia3045382018-11-22 14:30:31 +01002389
Radek Krejci084289f2019-07-09 17:35:30 +02002390/**
2391 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
2392 *
2393 * This function check just the type's restriction, if you want to check also the data tree context (e.g. in case of
Radek Krejci8678fa42020-08-18 16:07:28 +02002394 * require-instance restriction), use ::lyd_value_validate().
Radek Krejci084289f2019-07-09 17:35:30 +02002395 *
2396 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
2397 * @param[in] node Schema node for the @p value.
Michal Vaskof937cfe2020-08-03 16:07:12 +02002398 * @param[in] value String value to be checked, expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02002399 * @param[in] value_len Length of the given @p value (mandatory).
Radek Krejci084289f2019-07-09 17:35:30 +02002400 * @return LY_SUCCESS on success
2401 * @return LY_ERR value if an error occurred.
2402 */
Michal Vaskof937cfe2020-08-03 16:07:12 +02002403LY_ERR lys_value_validate(const struct ly_ctx *ctx, const struct lysc_node *node, const char *value, size_t value_len);
Radek Krejci084289f2019-07-09 17:35:30 +02002404
Radek Krejci0935f412019-08-20 16:15:18 +02002405/**
2406 * @brief Stringify schema nodetype.
Michal Vaskod43d71a2020-08-07 14:54:58 +02002407 *
Radek Krejci0935f412019-08-20 16:15:18 +02002408 * @param[in] nodetype Nodetype to stringify.
2409 * @return Constant string with the name of the node's type.
2410 */
2411const char *lys_nodetype2str(uint16_t nodetype);
2412
Michal Vaskod43d71a2020-08-07 14:54:58 +02002413/**
2414 * @brief Getter for original XPath expression from a parsed expression.
2415 *
2416 * @param[in] path Parsed expression.
2417 * @return Original string expression.
2418 */
2419const char *lyxp_get_expr(const struct lyxp_expr *path);
2420
Radek Krejci2ff0d572020-05-21 15:27:28 +02002421/** @} schematree */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002422
Radek Krejci70853c52018-10-15 14:46:16 +02002423#ifdef __cplusplus
2424}
2425#endif
2426
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002427#endif /* LY_TREE_SCHEMA_H_ */