blob: eea2f4bd4f933da1eb45f5d79ecfbc3d30ad47f2 [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 *
74 * The compiled schema tree nodes are able to hold private objects (::lysc_node.priv as a pointer to a structure, function, variable, ...) used by
75 * a caller application. Such an object can be assigned to a specific node using ::lysc_set_private() function.
76 * 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 *
106 * - ::lysc_set_private()
107 *
Michal Vaskod5cfa6e2020-11-23 16:56:08 +0100108 * - ::lysc_has_when()
109 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200110 * - ::lysc_node_children()
111 * - ::lysc_node_actions()
112 * - ::lysc_node_notifs()
113 *
114 * - ::lysp_node_children()
115 * - ::lysp_node_actions()
116 * - ::lysp_node_notifs()
117 * - ::lysp_node_groupings()
118 * - ::lysp_node_typedefs()
119 */
120
121/**
122 * @page howtoSchemaFeatures YANG Features
123 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100124 * YANG feature statement is an important part of the language which can significantly affect the meaning of the schemas.
125 * Modifying features may have similar effects as loading/removing schema from the context so it is limited to context
126 * preparation period before working with data. YANG features, respectively their use in if-feature
127 * statements, are evaluated as part of schema compilation so a feature-specific compiled schema tree is generated
128 * as a result.
Radek Krejci8678fa42020-08-18 16:07:28 +0200129 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100130 * To enable any features, they must currently be specified when implementing a new schema with ::lys_parse() or
131 * ::ly_ctx_load_module(). To later examine what the status of a feature is, check its ::LYS_FENABLED flag or
132 * 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 +0200133 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100134 * To iterate over all features of a particular YANG module, use ::lysp_feature_next().
Radek Krejci8678fa42020-08-18 16:07:28 +0200135 *
136 * Note, that the feature's state can affect some of the output formats (e.g. Tree format).
137 *
138 * Functions List
139 * --------------
Radek Krejci8678fa42020-08-18 16:07:28 +0200140 * - ::lys_feature_value()
Radek Krejci8678fa42020-08-18 16:07:28 +0200141 * - ::lysc_iffeature_value()
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100142 * - ::lysp_feature_next()
Radek Krejci8678fa42020-08-18 16:07:28 +0200143 */
144
145/**
Radek Krejci2ff0d572020-05-21 15:27:28 +0200146 * @ingroup trees
Radek Krejci8678fa42020-08-18 16:07:28 +0200147 * @defgroup schematree Schema Tree
Radek Krejci2ff0d572020-05-21 15:27:28 +0200148 * @{
149 *
150 * Data structures and functions to manipulate and access schema tree.
151 */
152
Michal Vasko64246d82020-08-19 12:35:00 +0200153/* *INDENT-OFF* */
154
Radek Krejci2ff0d572020-05-21 15:27:28 +0200155/**
Michal Vasko208a04a2020-10-21 15:17:12 +0200156 * @brief Macro to iterate via all elements in a schema (sub)tree including input and output.
157 * Note that __actions__ and __notifications__ of traversed nodes __are ignored__! To traverse
158 * on all the nodes including those, use ::lysc_tree_dfs_full() instead.
159 *
160 * 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 +0200161 *
162 * The function follows deep-first search algorithm:
163 * <pre>
164 * 1
165 * / \
166 * 2 4
167 * / / \
168 * 3 5 6
169 * </pre>
170 *
171 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
Radek Krejci2a9fc652021-01-22 17:44:34 +0100172 * START can be any of the lysc_node* types (including lysc_node_action and lysc_node_notif),
Radek Krejci0935f412019-08-20 16:15:18 +0200173 * ELEM variable must be of the struct lysc_node* type.
174 *
175 * To skip a particular subtree, instead of the continue statement, set LYSC_TREE_DFS_continue
176 * variable to non-zero value.
177 *
178 * Use with opening curly bracket '{' after the macro.
179 *
180 * @param START Pointer to the starting element processed first.
181 * @param ELEM Iterator intended for use in the block.
182 */
183#define LYSC_TREE_DFS_BEGIN(START, ELEM) \
Radek Krejci857189e2020-09-01 13:26:36 +0200184 { ly_bool LYSC_TREE_DFS_continue = 0; struct lysc_node *LYSC_TREE_DFS_next; \
Michal Vasko1c9e79f2020-08-10 11:08:03 +0200185 for ((ELEM) = (LYSC_TREE_DFS_next) = (struct lysc_node*)(START); \
Radek Krejci0935f412019-08-20 16:15:18 +0200186 (ELEM); \
187 (ELEM) = (LYSC_TREE_DFS_next), LYSC_TREE_DFS_continue = 0)
188
189/**
190 * @brief Macro to iterate via all elements in a (sub)tree. This is the closing part
191 * to the #LYSC_TREE_DFS_BEGIN - they always have to be used together.
192 *
193 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
Radek Krejci2a9fc652021-01-22 17:44:34 +0100194 * 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 +0200195 * ELEM variable must be pointer to the lysc_node type.
196 *
197 * Use with closing curly bracket '}' after the macro.
198 *
199 * @param START Pointer to the starting element processed first.
200 * @param ELEM Iterator intended for use in the block.
201 */
Radek Krejci0935f412019-08-20 16:15:18 +0200202#define LYSC_TREE_DFS_END(START, ELEM) \
203 /* select element for the next run - children first */ \
204 if (LYSC_TREE_DFS_continue) { \
205 (LYSC_TREE_DFS_next) = NULL; \
206 } else { \
Radek Krejci2a9fc652021-01-22 17:44:34 +0100207 (LYSC_TREE_DFS_next) = (struct lysc_node *)lysc_node_children(ELEM, 0); \
Michal Vasko208a04a2020-10-21 15:17:12 +0200208 } \
Radek Krejci0935f412019-08-20 16:15:18 +0200209 if (!(LYSC_TREE_DFS_next)) { \
Michal Vasko208a04a2020-10-21 15:17:12 +0200210 /* no children, try siblings */ \
211 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
Radek Krejci0935f412019-08-20 16:15:18 +0200212 } \
213 while (!(LYSC_TREE_DFS_next)) { \
214 /* parent is already processed, go to its sibling */ \
Radek Krejci7d95fbb2021-01-26 17:33:13 +0100215 (ELEM) = (ELEM)->parent; \
Michal Vasko208a04a2020-10-21 15:17:12 +0200216 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
217 } }
218
219/**
220 * @brief Helper macro for #LYSC_TREE_DFS_END, should not be used directly!
221 */
222#define _LYSC_TREE_DFS_NEXT(START, ELEM, NEXT) \
223 if ((ELEM) == (struct lysc_node *)(START)) { \
224 /* we are done, no next element to process */ \
225 break; \
226 } \
227 if ((ELEM)->nodetype == LYS_INPUT) { \
228 /* after input, get output */ \
Michal Vaskod1e53b92021-01-28 13:11:06 +0100229 (NEXT) = (struct lysc_node *)lysc_node_children((ELEM)->parent, LYS_IS_OUTPUT); \
Michal Vasko208a04a2020-10-21 15:17:12 +0200230 } else if ((ELEM)->nodetype == LYS_OUTPUT) { \
231 /* no sibling of output */ \
232 (NEXT) = NULL; \
233 } else { \
234 (NEXT) = (ELEM)->next; \
235 }
Radek Krejci0935f412019-08-20 16:15:18 +0200236
Michal Vasko64246d82020-08-19 12:35:00 +0200237/* *INDENT-ON* */
238
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200239#define LY_REV_SIZE 11 /**< revision data string length (including terminating NULL byte) */
240
Michal Vasko7f45cf22020-10-01 12:49:44 +0200241#define LYS_UNKNOWN 0x0000 /**< uninitalized unknown statement node */
242#define LYS_CONTAINER 0x0001 /**< container statement node */
243#define LYS_CHOICE 0x0002 /**< choice statement node */
244#define LYS_LEAF 0x0004 /**< leaf statement node */
245#define LYS_LEAFLIST 0x0008 /**< leaf-list statement node */
246#define LYS_LIST 0x0010 /**< list statement node */
247#define LYS_ANYXML 0x0020 /**< anyxml statement node */
248#define LYS_ANYDATA 0x0060 /**< anydata statement node, in tests it can be used for both #LYS_ANYXML and #LYS_ANYDATA */
249#define LYS_CASE 0x0080 /**< case statement node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200250
Michal Vasko7f45cf22020-10-01 12:49:44 +0200251#define LYS_RPC 0x0100 /**< RPC statement node */
252#define LYS_ACTION 0x0200 /**< action statement node */
253#define LYS_NOTIF 0x0400 /**< notification statement node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200254
Michal Vasko7f45cf22020-10-01 12:49:44 +0200255#define LYS_USES 0x0800 /**< uses statement node */
256#define LYS_INPUT 0x1000 /**< RPC/action input node */
257#define LYS_OUTPUT 0x2000 /**< RPC/action output node */
258#define LYS_GROUPING 0x4000
259#define LYS_AUGMENT 0x8000
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100260
Radek Krejcif13b87b2020-12-01 22:02:17 +0100261#define LYS_NODETYPE_MASK 0xffff /**< Mask for nodetypes, the value is limited for 16 bits */
262
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200263/**
Radek Krejcid6b76452019-09-03 17:03:03 +0200264 * @brief List of YANG statements
265 */
266enum ly_stmt {
267 LY_STMT_NONE = 0,
Radek Krejci8678fa42020-08-18 16:07:28 +0200268 LY_STMT_STATUS, /**< in ::lysc_ext_substmt.storage stored as a pointer to `uint16_t`, only cardinality < #LY_STMT_CARD_SOME is allowed */
269 LY_STMT_CONFIG, /**< in ::lysc_ext_substmt.storage stored as a pointer to `uint16_t`, only cardinality < #LY_STMT_CARD_SOME is allowed */
Radek Krejci335332a2019-09-05 13:03:35 +0200270 LY_STMT_MANDATORY,
Radek Krejci8678fa42020-08-18 16:07:28 +0200271 LY_STMT_UNITS, /**< in ::lysc_ext_substmt.storage stored as a pointer to `const char *` (cardinality < #LY_STMT_CARD_SOME)
Radek Krejciad5963b2019-09-06 16:03:05 +0200272 or as a pointer to a [sized array](@ref sizedarrays) `const char **` */
Radek Krejci335332a2019-09-05 13:03:35 +0200273 LY_STMT_DEFAULT,
Radek Krejci8678fa42020-08-18 16:07:28 +0200274 LY_STMT_TYPE, /**< in ::lysc_ext_substmt.storage stored as a pointer to `struct lysc_type *` (cardinality < #LY_STMT_CARD_SOME)
Radek Krejciad5963b2019-09-06 16:03:05 +0200275 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_type **` */
Radek Krejci335332a2019-09-05 13:03:35 +0200276
Radek Krejcid6b76452019-09-03 17:03:03 +0200277 LY_STMT_ACTION,
278 LY_STMT_ANYDATA,
279 LY_STMT_ANYXML,
280 LY_STMT_ARGUMENT,
281 LY_STMT_AUGMENT,
282 LY_STMT_BASE,
283 LY_STMT_BELONGS_TO,
284 LY_STMT_BIT,
285 LY_STMT_CASE,
286 LY_STMT_CHOICE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200287 LY_STMT_CONTACT,
288 LY_STMT_CONTAINER,
Radek Krejcid6b76452019-09-03 17:03:03 +0200289 LY_STMT_DESCRIPTION,
290 LY_STMT_DEVIATE,
291 LY_STMT_DEVIATION,
292 LY_STMT_ENUM,
293 LY_STMT_ERROR_APP_TAG,
294 LY_STMT_ERROR_MESSAGE,
295 LY_STMT_EXTENSION,
296 LY_STMT_FEATURE,
297 LY_STMT_FRACTION_DIGITS,
298 LY_STMT_GROUPING,
299 LY_STMT_IDENTITY,
Radek Krejci8678fa42020-08-18 16:07:28 +0200300 LY_STMT_IF_FEATURE, /**< in ::lysc_ext_substmt.storage stored as a pointer to `struct lysc_iffeature` (cardinality < #LY_STMT_CARD_SOME)
Radek Krejciad5963b2019-09-06 16:03:05 +0200301 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_iffeature *` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200302 LY_STMT_IMPORT,
303 LY_STMT_INCLUDE,
304 LY_STMT_INPUT,
305 LY_STMT_KEY,
306 LY_STMT_LEAF,
307 LY_STMT_LEAF_LIST,
308 LY_STMT_LENGTH,
309 LY_STMT_LIST,
Radek Krejcid6b76452019-09-03 17:03:03 +0200310 LY_STMT_MAX_ELEMENTS,
311 LY_STMT_MIN_ELEMENTS,
312 LY_STMT_MODIFIER,
313 LY_STMT_MODULE,
314 LY_STMT_MUST,
315 LY_STMT_NAMESPACE,
316 LY_STMT_NOTIFICATION,
317 LY_STMT_ORDERED_BY,
318 LY_STMT_ORGANIZATION,
319 LY_STMT_OUTPUT,
320 LY_STMT_PATH,
321 LY_STMT_PATTERN,
322 LY_STMT_POSITION,
323 LY_STMT_PREFIX,
324 LY_STMT_PRESENCE,
325 LY_STMT_RANGE,
326 LY_STMT_REFERENCE,
327 LY_STMT_REFINE,
328 LY_STMT_REQUIRE_INSTANCE,
329 LY_STMT_REVISION,
330 LY_STMT_REVISION_DATE,
331 LY_STMT_RPC,
Radek Krejcid6b76452019-09-03 17:03:03 +0200332 LY_STMT_SUBMODULE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200333 LY_STMT_TYPEDEF,
334 LY_STMT_UNIQUE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200335 LY_STMT_USES,
336 LY_STMT_VALUE,
337 LY_STMT_WHEN,
338 LY_STMT_YANG_VERSION,
339 LY_STMT_YIN_ELEMENT,
340 LY_STMT_EXTENSION_INSTANCE,
341
342 LY_STMT_SYNTAX_SEMICOLON,
343 LY_STMT_SYNTAX_LEFT_BRACE,
344 LY_STMT_SYNTAX_RIGHT_BRACE,
345
346 LY_STMT_ARG_TEXT,
347 LY_STMT_ARG_VALUE
348};
349
350/**
Radek Krejci0e59c312019-08-15 15:34:15 +0200351 * @brief Extension instance structure parent enumeration
352 */
353typedef enum {
Radek Krejci0935f412019-08-20 16:15:18 +0200354 LYEXT_PAR_MODULE, /**< ::lysc_module */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100355 LYEXT_PAR_NODE, /**< ::lysc_node (and the derived structures including ::lysc_node_action and ::lysc_node_notif) */
356 LYEXT_PAR_INPUT, /**< ::lysc_node_action_inout */
357 LYEXT_PAR_OUTPUT, /**< ::lysc_node_action_inout */
Radek Krejci0935f412019-08-20 16:15:18 +0200358 LYEXT_PAR_TYPE, /**< ::lysc_type */
359 LYEXT_PAR_TYPE_BIT, /**< ::lysc_type_bitenum_item */
360 LYEXT_PAR_TYPE_ENUM, /**< ::lysc_type_bitenum_item */
Radek Krejci0935f412019-08-20 16:15:18 +0200361 LYEXT_PAR_MUST, /**< ::lysc_must */
362 LYEXT_PAR_PATTERN, /**< ::lysc_pattern */
363 LYEXT_PAR_LENGTH, /**< ::lysc_range */
364 LYEXT_PAR_RANGE, /**< ::lysc_range */
365 LYEXT_PAR_WHEN, /**< ::lysc_when */
366 LYEXT_PAR_IDENT, /**< ::lysc_ident */
367 LYEXT_PAR_EXT, /**< ::lysc_ext */
Michal Vasko69730152020-10-09 16:30:07 +0200368 LYEXT_PAR_IMPORT /**< ::lysp_import */
Radek Krejcif13b87b2020-12-01 22:02:17 +0100369#if 0
370 LYEXT_PAR_TPDF, /**< ::lysp_tpdf */
371 LYEXT_PAR_EXTINST, /**< ::lysp_ext_instance */
372 LYEXT_PAR_REFINE, /**< ::lysp_refine */
373 LYEXT_PAR_DEVIATION, /**< ::lysp_deviation */
374 LYEXT_PAR_DEVIATE, /**< ::lysp_deviate */
375 LYEXT_PAR_INCLUDE, /**< ::lysp_include */
376 LYEXT_PAR_REVISION /**< ::lysp_revision */
377#endif
Radek Krejci0e59c312019-08-15 15:34:15 +0200378} LYEXT_PARENT;
379
380/**
Radek Krejci0935f412019-08-20 16:15:18 +0200381 * @brief Stringify extension instance parent type.
382 * @param[in] type Parent type to stringify.
383 * @return Constant string with the name of the parent statement.
384 */
385const char *lyext_parent2str(LYEXT_PARENT type);
386
387/**
Radek Krejci0e59c312019-08-15 15:34:15 +0200388 * @brief Enum of substatements in which extension instances can appear.
389 */
390typedef enum {
391 LYEXT_SUBSTMT_SELF = 0, /**< extension of the structure itself, not substatement's */
392 LYEXT_SUBSTMT_ARGUMENT, /**< extension of the argument statement, can appear in lys_ext */
393 LYEXT_SUBSTMT_BASE, /**< extension of the base statement, can appear (repeatedly) in lys_type and lys_ident */
394 LYEXT_SUBSTMT_BELONGSTO, /**< extension of the belongs-to statement, can appear in lys_submodule */
395 LYEXT_SUBSTMT_CONTACT, /**< extension of the contact statement, can appear in lys_module */
396 LYEXT_SUBSTMT_DEFAULT, /**< extension of the default statement, can appear in lys_node_leaf, lys_node_leaflist,
397 lys_node_choice and lys_deviate */
398 LYEXT_SUBSTMT_DESCRIPTION, /**< extension of the description statement, can appear in lys_module, lys_submodule,
399 lys_node, lys_import, lys_include, lys_ext, lys_feature, lys_tpdf, lys_restr,
400 lys_ident, lys_deviation, lys_type_enum, lys_type_bit, lys_when and lys_revision */
401 LYEXT_SUBSTMT_ERRTAG, /**< extension of the error-app-tag statement, can appear in lys_restr */
402 LYEXT_SUBSTMT_ERRMSG, /**< extension of the error-message statement, can appear in lys_restr */
403 LYEXT_SUBSTMT_KEY, /**< extension of the key statement, can appear in lys_node_list */
404 LYEXT_SUBSTMT_NAMESPACE, /**< extension of the namespace statement, can appear in lys_module */
405 LYEXT_SUBSTMT_ORGANIZATION, /**< extension of the organization statement, can appear in lys_module and lys_submodule */
406 LYEXT_SUBSTMT_PATH, /**< extension of the path statement, can appear in lys_type */
407 LYEXT_SUBSTMT_PREFIX, /**< extension of the prefix statement, can appear in lys_module, lys_submodule (for
408 belongs-to's prefix) and lys_import */
409 LYEXT_SUBSTMT_PRESENCE, /**< extension of the presence statement, can appear in lys_node_container */
410 LYEXT_SUBSTMT_REFERENCE, /**< extension of the reference statement, can appear in lys_module, lys_submodule,
411 lys_node, lys_import, lys_include, lys_revision, lys_tpdf, lys_restr, lys_ident,
412 lys_ext, lys_feature, lys_deviation, lys_type_enum, lys_type_bit and lys_when */
413 LYEXT_SUBSTMT_REVISIONDATE, /**< extension of the revision-date statement, can appear in lys_import and lys_include */
414 LYEXT_SUBSTMT_UNITS, /**< extension of the units statement, can appear in lys_tpdf, lys_node_leaf,
415 lys_node_leaflist and lys_deviate */
416 LYEXT_SUBSTMT_VALUE, /**< extension of the value statement, can appear in lys_type_enum */
417 LYEXT_SUBSTMT_VERSION, /**< extension of the yang-version statement, can appear in lys_module and lys_submodule */
418 LYEXT_SUBSTMT_MODIFIER, /**< extension of the modifier statement, can appear in lys_restr */
419 LYEXT_SUBSTMT_REQINSTANCE, /**< extension of the require-instance statement, can appear in lys_type */
420 LYEXT_SUBSTMT_YINELEM, /**< extension of the yin-element statement, can appear in lys_ext */
421 LYEXT_SUBSTMT_CONFIG, /**< extension of the config statement, can appear in lys_node and lys_deviate */
422 LYEXT_SUBSTMT_MANDATORY, /**< extension of the mandatory statement, can appear in lys_node_leaf, lys_node_choice,
423 lys_node_anydata and lys_deviate */
424 LYEXT_SUBSTMT_ORDEREDBY, /**< extension of the ordered-by statement, can appear in lys_node_list and lys_node_leaflist */
425 LYEXT_SUBSTMT_STATUS, /**< extension of the status statement, can appear in lys_tpdf, lys_node, lys_ident,
426 lys_ext, lys_feature, lys_type_enum and lys_type_bit */
427 LYEXT_SUBSTMT_FRACDIGITS, /**< extension of the fraction-digits statement, can appear in lys_type */
428 LYEXT_SUBSTMT_MAX, /**< extension of the max-elements statement, can appear in lys_node_list,
429 lys_node_leaflist and lys_deviate */
430 LYEXT_SUBSTMT_MIN, /**< extension of the min-elements statement, can appear in lys_node_list,
431 lys_node_leaflist and lys_deviate */
432 LYEXT_SUBSTMT_POSITION, /**< extension of the position statement, can appear in lys_type_bit */
433 LYEXT_SUBSTMT_UNIQUE, /**< extension of the unique statement, can appear in lys_node_list and lys_deviate */
Michal Vasko69730152020-10-09 16:30:07 +0200434 LYEXT_SUBSTMT_IFFEATURE /**< extension of the if-feature statement */
Radek Krejci0e59c312019-08-15 15:34:15 +0200435} LYEXT_SUBSTMT;
436
437/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200438 * @brief YANG import-stmt
439 */
440struct lysp_import {
Radek Krejci086c7132018-10-26 15:29:04 +0200441 struct lys_module *module; /**< pointer to the imported module
442 (mandatory, but resolved when the referring module is completely parsed) */
443 const char *name; /**< name of the imported module (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200444 const char *prefix; /**< prefix for the data from the imported schema (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200445 const char *dsc; /**< description */
446 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200447 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100448 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200449 char rev[LY_REV_SIZE]; /**< revision-date of the imported module */
450};
451
452/**
453 * @brief YANG include-stmt
454 */
455struct lysp_include {
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100456 struct lysp_submodule *submodule;/**< pointer to the parsed submodule structure
Radek Krejci086c7132018-10-26 15:29:04 +0200457 (mandatory, but resolved when the referring module is completely parsed) */
458 const char *name; /**< name of the included submodule (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200459 const char *dsc; /**< description */
460 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200461 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200462 char rev[LY_REV_SIZE]; /**< revision-date of the included submodule */
Radek Krejci771928a2021-01-19 13:42:36 +0100463 ly_bool injected; /**< flag to mark includes copied into main module from submodules,
464 only for backward compatibility with YANG 1.0, which does not require the
465 main module to include all submodules. */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200466};
467
468/**
469 * @brief YANG extension-stmt
470 */
471struct lysp_ext {
472 const char *name; /**< extension name */
473 const char *argument; /**< argument name, NULL if not specified */
474 const char *dsc; /**< description statement */
475 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200476 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200477 uint16_t flags; /**< LYS_STATUS_* and LYS_YINELEM_* values (@ref snodeflags) */
Michal Vasko5fe75f12020-03-02 13:52:37 +0100478
479 struct lysc_ext *compiled; /**< pointer to the compiled extension definition */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200480};
481
482/**
483 * @brief Helper structure for generic storage of the extension instances content.
484 */
485struct lysp_stmt {
486 const char *stmt; /**< identifier of the statement */
487 const char *arg; /**< statement's argument */
488 struct lysp_stmt *next; /**< link to the next statement */
Michal Vaskobc2559f2018-09-07 10:17:50 +0200489 struct lysp_stmt *child; /**< list of the statement's substatements (linked list) */
David Sedlákb9d75c42019-08-14 10:49:42 +0200490 uint16_t flags; /**< statement flags, can be set to LYS_YIN_ATTR */
Radek Krejci335332a2019-09-05 13:03:35 +0200491 enum ly_stmt kw; /**< numeric respresentation of the stmt value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200492};
493
David Sedlákae4b4512019-08-14 10:45:56 +0200494#define LYS_YIN 0x1 /**< used to specify input format of extension instance */
495
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200496/**
497 * @brief YANG extension instance
498 */
499struct lysp_ext_instance {
David Sedlákbbd06ca2019-06-27 14:15:38 +0200500 const char *name; /**< extension identifier, including possible prefix */
501 const char *argument; /**< optional value of the extension's argument */
Radek Krejci335332a2019-09-05 13:03:35 +0200502 void *parent; /**< pointer to the parent element holding the extension instance(s), use
503 ::lysp_ext_instance#parent_type to access the schema element */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200504 struct lysp_stmt *child; /**< list of the extension's substatements (linked list) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200505 struct lysc_ext_instance *compiled; /**< pointer to the compiled data if any - in case the source format is YIN,
506 some of the information (argument) are available only after compilation */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200507 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200508 LY_ARRAY_COUNT_TYPE insubstmt_index; /**< in case the instance is in a substatement, this identifies
David Sedlákbbd06ca2019-06-27 14:15:38 +0200509 the index of that substatement */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100510 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
511 uint8_t yin; /**< flag for YIN source format, can be set to LYS_YIN */
Radek Krejci335332a2019-09-05 13:03:35 +0200512 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200513};
514
515/**
516 * @brief YANG feature-stmt
517 */
518struct lysp_feature {
519 const char *name; /**< feature name (mandatory) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100520 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
521 struct lysc_iffeature *iffeatures_c; /**< compiled if-features */
522 struct lysp_feature **depfeatures; /**< list of pointers to other features depending on this one
523 ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200524 const char *dsc; /**< description statement */
525 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200526 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100527 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values and
528 LYS_FENABLED are allowed */
529};
530
531/**
532 * @brief Compiled YANG if-feature-stmt
533 */
534struct lysc_iffeature {
535 uint8_t *expr; /**< 2bits array describing the if-feature expression in prefix format, see @ref ifftokens */
536 struct lysp_feature **features; /**< array of pointers to the features used in expression ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200537};
538
539/**
Michal Vasko7f45cf22020-10-01 12:49:44 +0200540 * @brief Qualified name (optional prefix followed by an identifier).
541 */
542struct lysp_qname {
543 const char *str; /**< qualified name string */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200544 const struct lysp_module *mod; /**< module to resolve any prefixes found in the string, it must be
Michal Vasko7f45cf22020-10-01 12:49:44 +0200545 stored explicitly because of deviations/refines */
546};
547
548/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200549 * @brief YANG identity-stmt
550 */
551struct lysp_ident {
552 const char *name; /**< identity name (mandatory), including possible prefix */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200553 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200554 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200555 const char *dsc; /**< description statement */
556 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200557 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200558 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
559};
560
Michal Vasko71e64ca2018-09-07 16:30:29 +0200561/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200562 * @brief Covers restrictions: range, length, pattern, must
563 */
564struct lysp_restr {
Radek Krejcif13b87b2020-12-01 22:02:17 +0100565#define LYSP_RESTR_PATTERN_ACK 0x06
566#define LYSP_RESTR_PATTERN_NACK 0x15
Michal Vasko7f45cf22020-10-01 12:49:44 +0200567 struct lysp_qname arg; /**< The restriction expression/value (mandatory);
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200568 in case of pattern restriction, the first byte has a special meaning:
569 0x06 (ACK) for regular match and 0x15 (NACK) for invert-match */
570 const char *emsg; /**< error-message */
571 const char *eapptag; /**< error-app-tag value */
572 const char *dsc; /**< description */
573 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200574 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200575};
576
577/**
Michal Vasko71e64ca2018-09-07 16:30:29 +0200578 * @brief YANG revision-stmt
579 */
580struct lysp_revision {
Radek Krejcicb3e6472021-01-06 08:19:01 +0100581 char date[LY_REV_SIZE]; /**< revision date (madatory) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200582 const char *dsc; /**< description statement */
583 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200584 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200585};
586
587/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200588 * @brief Enumeration/Bit value definition
589 */
590struct lysp_type_enum {
591 const char *name; /**< name (mandatory) */
592 const char *dsc; /**< description statement */
593 const char *ref; /**< reference statement */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200594 int64_t value; /**< enum's value or bit's position */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200595 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200596 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200597 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
598 values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200599};
600
601/**
602 * @brief YANG type-stmt
603 *
604 * Some of the items in the structure may be mandatory, but it is necessary to resolve the type's base type first
605 */
606struct lysp_type {
607 const char *name; /**< name of the type (mandatory) */
608 struct lysp_restr *range; /**< allowed values range - numerical, decimal64 */
609 struct lysp_restr *length; /**< allowed length of the value - string, binary */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200610 struct lysp_restr *patterns; /**< list of patterns ([sized array](@ref sizedarrays)) - string */
611 struct lysp_type_enum *enums; /**< list of enum-stmts ([sized array](@ref sizedarrays)) - enum */
612 struct lysp_type_enum *bits; /**< list of bit-stmts ([sized array](@ref sizedarrays)) - bits */
Michal Vasko004d3152020-06-11 19:59:22 +0200613 struct lyxp_expr *path; /**< parsed path - leafref */
Radek Krejci151a5b72018-10-19 14:21:44 +0200614 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) - identityref */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200615 struct lysp_type *types; /**< list of sub-types ([sized array](@ref sizedarrays)) - union */
616 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200617
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200618 const struct lysp_module *pmod; /**< (sub)module where the type is defined (needed for deviations) */
Radek Krejci2167ee12018-11-02 16:09:07 +0100619 struct lysc_type *compiled; /**< pointer to the compiled type */
620
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200621 uint8_t fraction_digits; /**< number of fraction digits - decimal64 */
622 uint8_t require_instance; /**< require-instance flag - leafref, instance */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100623 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200624};
625
626/**
627 * @brief YANG typedef-stmt
628 */
629struct lysp_tpdf {
630 const char *name; /**< name of the newly defined type (mandatory) */
631 const char *units; /**< units of the newly defined type */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200632 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 +0200633 const char *dsc; /**< description statement */
634 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200635 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200636 struct lysp_type type; /**< base type from which the typedef is derived (mandatory) */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100637 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200638};
639
640/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200641 * @brief YANG when-stmt
642 */
643struct lysp_when {
644 const char *cond; /**< specified condition (mandatory) */
645 const char *dsc; /**< description statement */
646 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200647 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200648};
649
650/**
651 * @brief YANG refine-stmt
652 */
653struct lysp_refine {
654 const char *nodeid; /**< target descendant schema nodeid (mandatory) */
655 const char *dsc; /**< description statement */
656 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200657 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200658 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200659 const char *presence; /**< presence description */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200660 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200661 uint32_t min; /**< min-elements constraint */
662 uint32_t max; /**< max-elements constraint, 0 means unbounded */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200663 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200664 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
665};
666
667/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200668 * @ingroup schematree
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200669 * @defgroup deviatetypes Deviate types
Radek Krejci8678fa42020-08-18 16:07:28 +0200670 *
671 * Type of the deviate operation (used as ::lysp_deviate.mod)
672 *
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200673 * @{
674 */
675#define LYS_DEV_NOT_SUPPORTED 1 /**< deviate type not-supported */
676#define LYS_DEV_ADD 2 /**< deviate type add */
677#define LYS_DEV_DELETE 3 /**< deviate type delete */
678#define LYS_DEV_REPLACE 4 /**< deviate type replace */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200679/** @} deviatetypes */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200680
681/**
682 * @brief Generic deviate structure to get type and cast to lysp_deviate_* structure
683 */
684struct lysp_deviate {
685 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
686 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200687 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200688};
689
690struct lysp_deviate_add {
691 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
692 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200693 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200694 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200695 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200696 struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
697 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200698 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
699 uint32_t min; /**< min-elements constraint */
700 uint32_t max; /**< max-elements constraint, 0 means unbounded */
701};
702
703struct lysp_deviate_del {
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};
712
713struct lysp_deviate_rpl {
714 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
715 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200716 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200717 struct lysp_type *type; /**< type of the node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200718 const char *units; /**< units of the values */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200719 struct lysp_qname dflt; /**< default value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200720 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
721 uint32_t min; /**< min-elements constraint */
722 uint32_t max; /**< max-elements constraint, 0 means unbounded */
723};
724
725struct lysp_deviation {
Michal Vaskob55f6c12018-09-12 11:13:15 +0200726 const char *nodeid; /**< target absolute schema nodeid (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200727 const char *dsc; /**< description statement */
728 const char *ref; /**< reference statement */
Michal Vasko22df3f02020-08-24 13:29:22 +0200729 struct lysp_deviate *deviates; /**< list of deviate specifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200730 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200731};
732
Radek Krejci4f28eda2018-11-12 11:46:16 +0100733/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100734 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200735 * @defgroup spnodeflags Parsed schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100736 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200737 * Various flags for parsed schema nodes (used as ::lysp_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100738 *
739 * 1 - container 6 - anydata/anyxml 11 - output 16 - grouping 21 - enum
740 * 2 - choice 7 - case 12 - feature 17 - uses 22 - type
Radek Krejcid3ca0632019-04-16 16:54:54 +0200741 * 3 - leaf 8 - notification 13 - identity 18 - refine 23 - stmt
Radek Krejci4f28eda2018-11-12 11:46:16 +0100742 * 4 - leaflist 9 - rpc 14 - extension 19 - augment
743 * 5 - list 10 - input 15 - typedef 20 - deviate
744 *
Radek Krejcid3ca0632019-04-16 16:54:54 +0200745 * 1 1 1 1 1 1 1 1 1 1 2 2 2 2
746 * 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
747 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200748 * 1 LYS_CONFIG_W |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200749 * LYS_SET_BASE | | | | | | | | | | | | | | | | | | | | | |x| |
750 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200751 * 2 LYS_CONFIG_R |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200752 * LYS_SET_BIT | | | | | | | | | | | | | | | | | | | | | |x| |
753 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
754 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
755 * LYS_SET_ENUM | | | | | | | | | | | | | | | | | | | | | |x| |
756 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
757 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
758 * LYS_SET_FRDIGITS | | | | | | | | | | | | | | | | | | | | | |x| |
759 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
760 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
761 * LYS_SET_LENGTH | | | | | | | | | | | | | | | | | | | | | |x| |
762 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
763 * 6 LYS_MAND_TRUE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
764 * LYS_SET_PATH | | | | | | | | | | | | | | | | | | | | | |x| |
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100765 * LYS_FENABLED | | | | | | | | | | | |x| | | | | | | | | | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200766 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
767 * 7 LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
768 * LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | | | | | | | | |
769 * LYS_SET_PATTERN | | | | | | | | | | | | | | | | | | | | | |x| |
770 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
771 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | | | | | | | | |
772 * LYS_YINELEM_TRUE | | | | | | | | | | | | | |x| | | | | | | | | |
773 * LYS_SET_RANGE | | | | | | | | | | | | | | | | | | | | | |x| |
774 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
775 * 9 LYS_YINELEM_FALSE| | | | | | | | | | | | | |x| | | | | | | | | |
776 * LYS_SET_TYPE | | | | | | | | | | | | | | | | | | | | | |x| |
777 * LYS_SINGLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
778 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
779 * 10 LYS_SET_VALUE | | | | | | | | | | | | | | | | | | | | |x| | |
780 * LYS_SET_REQINST | | | | | | | | | | | | | | | | | | | | | |x| |
781 * LYS_SET_MIN | | | |x|x| | | | | | | | | | | | |x| |x| | | |
782 * LYS_DOUBLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
783 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
784 * 11 LYS_SET_MAX | | | |x|x| | | | | | | | | | | | |x| |x| | | |
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200785 * LYS_USED_GRP | | | | | | | | | | | | | | | |x| | | | | | | |
David Sedlákae4b4512019-08-14 10:45:56 +0200786 * LYS_YIN_ATTR | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko5297a432020-08-31 12:27:51 +0200787 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
788 * 12 LYS_YIN_ARGUMENT | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100789 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
790 * 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 +0200791 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100792 *
793 */
794
795/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100796 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200797 * @defgroup scnodeflags Compiled schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100798 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200799 * Various flags for compiled schema nodes (used as ::lysc_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100800 *
Radek Krejci61e042e2019-09-10 15:53:09 +0200801 * 1 - container 6 - anydata/anyxml 11 - identity
802 * 2 - choice 7 - case 12 - extension
803 * 3 - leaf 8 - notification 13 - bitenum
Michal Vasko03ff5a72019-09-11 13:49:33 +0200804 * 4 - leaflist 9 - rpc/action 14 - when
Michal Vaskoecd62de2019-11-13 12:35:11 +0100805 * 5 - list 10 - feature
Radek Krejci4f28eda2018-11-12 11:46:16 +0100806 *
Michal Vaskoecd62de2019-11-13 12:35:11 +0100807 * 1 1 1 1 1
808 * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4
809 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100810 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100811 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100812 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100813 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
814 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x|x|x|x| |x|
815 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
816 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x|x|x|x| |x|
817 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
818 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x|x|x|x| |x|
819 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
820 * 6 LYS_MAND_TRUE |x|x|x|x|x|x| | | | | | | | |
821 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
822 * 7 LYS_ORDBY_USER | | | |x|x| | | | | | | | | |
823 * LYS_MAND_FALSE | |x|x| | |x| | | | | | | | |
824 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
825 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | |
826 * LYS_PRESENCE |x| | | | | | | | | | | | | |
827 * LYS_UNIQUE | | |x| | | | | | | | | | | |
828 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
829 * 9 LYS_KEY | | |x| | | | | | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100830 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
831 * 10 LYS_SET_DFLT | | |x|x| | |x| | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100832 * LYS_IS_ENUM | | | | | | | | | | | | |x| |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100833 * LYS_KEYLESS | | | | |x| | | | | | | | | |
834 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
835 * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | |
836 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
837 * 12 LYS_SET_CONFIG |x|x|x|x|x|x| | | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100838 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
839 * 13 LYS_IS_INPUT |x|x|x|x|x|x|x| | | | | | | |
840 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
841 * 14 LYS_IS_OUTPUT |x|x|x|x|x|x|x| | | | | | | |
842 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
843 * 15 LYS_IS_NOTIF |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100844 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100845 *
846 */
847
848/**
849 * @defgroup snodeflags Schema nodes flags
Radek Krejci8678fa42020-08-18 16:07:28 +0200850 *
851 * Various flags for schema nodes ([parsed](@ref spnodeflags) as well as [compiled](@ref scnodeflags)).
852 *
Radek Krejci4f28eda2018-11-12 11:46:16 +0100853 * @{
854 */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100855#define LYS_CONFIG_W 0x01 /**< config true; */
856#define LYS_CONFIG_R 0x02 /**< config false; */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200857#define LYS_CONFIG_MASK 0x03 /**< mask for config value */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100858#define LYS_STATUS_CURR 0x04 /**< status current; */
859#define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */
860#define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */
861#define LYS_STATUS_MASK 0x1C /**< mask for status value */
862#define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice,
Radek Krejcife909632019-02-12 15:34:42 +0100863 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
864 The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0.
865 The ::lysc_node_container has this flag if it is not a presence container and it has at least one
866 child with LYS_MAND_TRUE. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100867#define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice,
868 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
869 This flag is present only in case the mandatory false statement was explicitly specified. */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100870#define LYS_MAND_MASK 0x60 /**< mask for mandatory values */
Michal Vaskoc118ae22020-08-06 14:51:09 +0200871#define LYS_PRESENCE 0x80 /**< flag for presence property of a container, but it is not only for explicit presence
872 containers, but also for NP containers with some meaning, applicable only to
873 ::lysc_node_container */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100874#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 +0100875#define LYS_KEY 0x0100 /**< flag for leafs being a key of a list, applicable only to ::lysc_node_leaf */
876#define LYS_KEYLESS 0x0200 /**< flag for list without any key, applicable only to ::lysc_node_list */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100877#define LYS_FENABLED 0x20 /**< feature enabled flag, applicable only to ::lysp_feature. */
Radek Krejcife909632019-02-12 15:34:42 +0100878#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 +0100879 ::lysc_node_list/::lysp_node_list */
880#define LYS_ORDBY_USER 0x40 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and
881 ::lysc_node_list/::lysp_node_list */
882#define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */
883#define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100884#define LYS_YINELEM_FALSE 0x0100 /**< yin-element false for extension's argument */
885#define LYS_YINELEM_MASK 0x0180 /**< mask for yin-element value */
886#define LYS_USED_GRP 0x0400 /**< internal flag for validating not-instantiated groupings
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200887 (resp. do not validate again the instantiated groupings). */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100888#define LYS_SET_VALUE 0x0200 /**< value attribute is set */
889#define LYS_SET_MIN 0x0200 /**< min attribute is set */
890#define LYS_SET_MAX 0x0400 /**< max attribute is set */
Radek Krejcid505e3d2018-11-13 09:04:17 +0100891
892#define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */
893#define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */
894#define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */
895#define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */
896#define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */
897#define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */
898#define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */
899#define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */
900#define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */
901#define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */
Radek Krejciccd20f12019-02-15 14:12:27 +0100902#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 +0100903 cases of choice. This information is important for refines, since it is prohibited to make leafs
904 with default statement mandatory. In case the default leaf value is taken from type, it is thrown
Radek Krejciccd20f12019-02-15 14:12:27 +0100905 away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish
906 between own default or the default values taken from the type. */
907#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 +0100908#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 +0100909
Michal Vaskod1e53b92021-01-28 13:11:06 +0100910#define LYS_SINGLEQUOTED 0x0100 /**< flag for single-quoted argument of an extension instance's substatement, only when the source is YANG */
911#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 +0200912
Michal Vaskod1e53b92021-01-28 13:11:06 +0100913#define LYS_YIN_ATTR 0x0400 /**< flag to identify YIN attribute parsed as extension's substatement, only when the source is YIN */
914#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 +0200915
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100916#define LYS_INTERNAL 0x1000 /**< flag to identify internal parsed statements that should not be printed */
917
Michal Vaskod1e53b92021-01-28 13:11:06 +0100918#define LYS_IS_ENUM 0x0200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */
919
920#define LYS_IS_INPUT 0x1000 /**< flag for nodes that are in the subtree of an input statement */
921
922#define LYS_IS_OUTPUT 0x2000 /**< flag for nodes that are in the subtree of an output statement */
923
924#define LYS_IS_NOTIF 0x4000 /**< flag for nodes that are in the subtree of a notification statement */
Radek Krejci693262f2019-04-29 15:23:20 +0200925
Radek Krejcife909632019-02-12 15:34:42 +0100926#define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200927/** @} snodeflags */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200928
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200929/**
930 * @brief Generic YANG data node
931 */
932struct lysp_node {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100933 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200934 uint16_t nodetype; /**< type of the node (mandatory) */
935 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100936 struct lysp_node *next; /**< next sibling node (NULL if there is no one) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200937 const char *name; /**< node name (mandatory) */
938 const char *dsc; /**< description statement */
939 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200940 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)),
941 must be qname because of refines */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200942 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200943};
944
945/**
946 * @brief Extension structure of the lysp_node for YANG container
947 */
948struct lysp_node_container {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100949 union {
950 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
951 struct {
952 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
953 uint16_t nodetype; /**< LYS_CONTAINER */
954 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
955 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
956 const char *name; /**< node name (mandatory) */
957 const char *dsc; /**< description statement */
958 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100959 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
960 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
961 };
962 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200963
964 /* container */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200965 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +0100966 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200967 const char *presence; /**< presence description */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200968 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100969 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200970 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100971 struct lysp_node_action *actions;/**< list of actions (linked list) */
972 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200973};
974
975struct lysp_node_leaf {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100976 union {
977 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
978 struct {
979 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
980 uint16_t nodetype; /**< LYS_LEAF */
981 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
982 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
983 const char *name; /**< node name (mandatory) */
984 const char *dsc; /**< description statement */
985 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100986 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
987 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
988 };
989 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200990
991 /* leaf */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200992 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +0100993 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200994 struct lysp_type type; /**< type of the leaf node (mandatory) */
995 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200996 struct lysp_qname dflt; /**< default value, it may or may not be a qualified name */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200997};
998
999struct lysp_node_leaflist {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001000 union {
1001 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1002 struct {
1003 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1004 uint16_t nodetype; /**< LYS_LEAFLIST */
1005 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1006 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1007 const char *name; /**< node name (mandatory) */
1008 const char *dsc; /**< description statement */
1009 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001010 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1011 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1012 };
1013 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001014
1015 /* leaf-list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001016 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001017 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001018 struct lysp_type type; /**< type of the leaf node (mandatory) */
1019 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001020 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)), they may or
1021 may not be qualified names */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001022 uint32_t min; /**< min-elements constraint */
1023 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1024};
1025
1026struct lysp_node_list {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001027 union {
1028 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1029 struct {
1030 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1031 uint16_t nodetype; /**< LYS_LIST */
1032 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1033 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1034 const char *name; /**< node name (mandatory) */
1035 const char *dsc; /**< description statement */
1036 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001037 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1038 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1039 };
1040 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001041
1042 /* list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001043 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001044 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001045 const char *key; /**< keys specification */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001046 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001047 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001048 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001049 struct lysp_node_action *actions;/**< list of actions (linked list) */
1050 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001051 struct lysp_qname *uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001052 uint32_t min; /**< min-elements constraint */
1053 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1054};
1055
1056struct lysp_node_choice {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001057 union {
1058 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1059 struct {
1060 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1061 uint16_t nodetype; /**< LYS_CHOICE */
1062 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1063 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1064 const char *name; /**< node name (mandatory) */
1065 const char *dsc; /**< description statement */
1066 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001067 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1068 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1069 };
1070 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001071
1072 /* choice */
1073 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001074 struct lysp_when *when; /**< when statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001075 struct lysp_qname dflt; /**< default case */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001076};
1077
1078struct lysp_node_case {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001079 union {
1080 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1081 struct {
1082 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1083 uint16_t nodetype; /**< LYS_CASE */
1084 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1085 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1086 const char *name; /**< node name (mandatory) */
1087 const char *dsc; /**< description statement */
1088 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001089 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1090 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1091 };
1092 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001093
1094 /* case */
1095 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001096 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001097};
1098
1099struct lysp_node_anydata {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001100 union {
1101 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1102 struct {
1103 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1104 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1105 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1106 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1107 const char *name; /**< node name (mandatory) */
1108 const char *dsc; /**< description statement */
1109 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001110 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1111 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1112 };
1113 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001114
1115 /* anyxml/anydata */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001116 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001117 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001118};
1119
1120struct lysp_node_uses {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001121 union {
1122 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1123 struct {
1124 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1125 uint16_t nodetype; /**< LYS_USES */
1126 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1127 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1128 const char *name; /**< grouping name reference (mandatory) */
1129 const char *dsc; /**< description statement */
1130 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001131 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1132 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1133 };
1134 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001135
1136 /* uses */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001137 struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001138 struct lysp_node_augment *augments; /**< list of augments (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001139 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001140};
1141
1142/**
1143 * @brief YANG input-stmt and output-stmt
1144 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001145struct lysp_node_action_inout {
1146 union {
1147 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1148 struct {
1149 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1150 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1151 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1152 struct lysp_node *next; /**< NULL */
1153 const char *name; /**< empty string */
1154 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1155 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysp_node */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001156 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1157 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1158 };
1159 }; /**< common part corresponding to ::lysp_node */
1160
1161 /* inout */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001162 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1163 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001164 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001165 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001166};
1167
1168/**
1169 * @brief YANG rpc-stmt and action-stmt
1170 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001171struct lysp_node_action {
1172 union {
1173 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1174 struct {
1175 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1176 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1177 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1178 struct lysp_node_action *next; /**< pointer to the next action (NULL if there is no one) */
1179 const char *name; /**< grouping name reference (mandatory) */
1180 const char *dsc; /**< description statement */
1181 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001182 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1183 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1184 };
1185 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001186
1187 /* action */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001188 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1189 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
1190
1191 struct lysp_node_action_inout input; /**< RPC's/Action's input */
1192 struct lysp_node_action_inout output; /**< RPC's/Action's output */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001193};
1194
1195/**
1196 * @brief YANG notification-stmt
1197 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001198struct lysp_node_notif {
1199 union {
1200 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1201 struct {
1202 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1203 uint16_t nodetype; /**< LYS_NOTIF */
1204 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1205 struct lysp_node_notif *next; /**< pointer to the next notification (NULL if there is no one) */
1206 const char *name; /**< grouping name reference (mandatory) */
1207 const char *dsc; /**< description statement */
1208 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001209 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1210 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1211 };
1212 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001213
1214 /* notif */
1215 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001216 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1217 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001218 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001219};
1220
1221/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001222 * @brief YANG grouping-stmt
1223 */
1224struct lysp_node_grp {
1225 union {
1226 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1227 struct {
1228 struct lysp_node *parent;/**< parent node (NULL if this is a top-level grouping) */
1229 uint16_t nodetype; /**< LYS_GROUPING */
1230 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1231 struct lysp_node_grp *next; /**< pointer to the next grouping (NULL if there is no one) */
1232 const char *name; /**< grouping name (mandatory) */
1233 const char *dsc; /**< description statement */
1234 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001235 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1236 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1237 };
1238 }; /**< common part corresponding to ::lysp_node */
1239
1240 /* grp */
1241 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1242 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001243 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001244 struct lysp_node_action *actions; /**< list of actions (linked list) */
1245 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1246};
1247
1248/**
1249 * @brief YANG uses-augment-stmt and augment-stmt (compatible with struct lysp_node )
1250 */
1251struct lysp_node_augment {
1252 union {
1253 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1254 struct {
1255 struct lysp_node *parent;/**< parent node (NULL if this is a top-level augment) */
1256 uint16_t nodetype; /**< LYS_AUGMENT */
1257 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1258 struct lysp_node_augment *next; /**< pointer to the next augment (NULL if there is no one) */
1259 const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */
1260 const char *dsc; /**< description statement */
1261 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001262 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1263 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1264 };
1265 }; /**< common part corresponding to ::lysp_node */
1266
1267 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001268 struct lysp_when *when; /**< when statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001269 struct lysp_node_action *actions;/**< list of actions (linked list) */
1270 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1271};
1272
1273/**
Radek Krejcif0fceb62018-09-05 14:58:45 +02001274 * @brief supported YANG schema version values
1275 */
1276typedef enum LYS_VERSION {
1277 LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */
Radek Krejci96e48da2020-09-04 13:18:06 +02001278 LYS_VERSION_1_0 = 1, /**< YANG 1 (1.0) */
Radek Krejcif0fceb62018-09-05 14:58:45 +02001279 LYS_VERSION_1_1 = 2 /**< YANG 1.1 */
1280} LYS_VERSION;
1281
1282/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001283 * @brief Printable YANG schema tree structure representing YANG module.
1284 *
1285 * Simple structure corresponding to the YANG format. The schema is only syntactically validated.
1286 */
1287struct lysp_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001288 struct lys_module *mod; /**< covering module structure */
1289
Radek Krejcib7db73a2018-10-24 14:18:40 +02001290 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1291 in the list is always the last (newest) revision of the module */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001292 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1293 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001294 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1295 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1296 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1297 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001298 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001299 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001300 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1301 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1302 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001303 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001304 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001305
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001306 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001307 uint8_t parsing : 1; /**< flag for circular check */
1308 uint8_t is_submod : 1; /**< always 0 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001309};
1310
1311struct lysp_submodule {
Michal Vaskoc3781c32020-10-06 14:04:08 +02001312 struct lys_module *mod; /**< belongs to parent module (submodule - mandatory) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001313
1314 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1315 in the list is always the last (newest) revision of the module */
1316 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1317 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
1318 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1319 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1320 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1321 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001322 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001323 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001324 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1325 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1326 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001327 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001328 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001329
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001330 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001331 uint8_t parsing : 1; /**< flag for circular check */
1332 uint8_t is_submod : 1; /**< always 1 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001333
Michal Vaskoc3781c32020-10-06 14:04:08 +02001334 uint8_t latest_revision : 2; /**< flag to mark the latest available revision:
Radek Krejci086c7132018-10-26 15:29:04 +02001335 1 - the latest revision in searchdirs was not searched yet and this is the
1336 latest revision in the current context
1337 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001338 const char *name; /**< name of the module (mandatory) */
1339 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1340 const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */
1341 const char *org; /**< party/company responsible for the module */
1342 const char *contact; /**< contact information for the module */
1343 const char *dsc; /**< description of the module */
1344 const char *ref; /**< cross-reference for the module */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001345};
1346
1347/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001348 * @brief Get the parsed module or submodule name.
1349 *
1350 * @param[in] PMOD Parsed module or submodule.
1351 * @return Module or submodule name.
1352 */
1353#define LYSP_MODULE_NAME(PMOD) (PMOD->is_submod ? ((struct lysp_submodule *)PMOD)->name : ((struct lysp_module *)PMOD)->mod->name)
1354
1355/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001356 * @brief Compiled prefix data pair mapping of prefixes to modules. In case the format is ::LY_PREF_SCHEMA_RESOLVED,
1357 * the expected prefix data is a sized array of these structures.
1358 */
1359struct lysc_prefix {
1360 char *prefix; /**< used prefix */
1361 const struct lys_module *mod; /**< mapping to a module */
1362};
1363
1364/**
Radek Krejci0e59c312019-08-15 15:34:15 +02001365 * @brief Compiled YANG extension-stmt
1366 */
1367struct lysc_ext {
1368 const char *name; /**< extension name */
1369 const char *argument; /**< argument name, NULL if not specified */
Radek Krejci0e59c312019-08-15 15:34:15 +02001370 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1371 struct lyext_plugin *plugin; /**< Plugin implementing the specific extension */
Radek Krejci0935f412019-08-20 16:15:18 +02001372 struct lys_module *module; /**< module structure */
Michal Vasko6f4cbb62020-02-28 11:15:47 +01001373 uint32_t refcount; /**< reference counter since extension definition is shared among all its instances */
Radek Krejci0e59c312019-08-15 15:34:15 +02001374 uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */
1375};
1376
1377/**
Radek Krejcice8c1592018-10-29 15:35:51 +01001378 * @brief YANG extension instance
1379 */
1380struct lysc_ext_instance {
Radek Krejciad5963b2019-09-06 16:03:05 +02001381 uint32_t insubstmt_index; /**< in case the instance is in a substatement that can appear multiple times,
1382 this identifies the index of the substatement for this extension instance */
Radek Krejci28681fa2019-09-06 13:08:45 +02001383 struct lys_module *module; /**< module where the extension instantiated is defined */
Radek Krejciad5963b2019-09-06 16:03:05 +02001384 struct lysc_ext *def; /**< pointer to the extension definition */
Radek Krejcice8c1592018-10-29 15:35:51 +01001385 void *parent; /**< pointer to the parent element holding the extension instance(s), use
1386 ::lysc_ext_instance#parent_type to access the schema element */
1387 const char *argument; /**< optional value of the extension's argument */
1388 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Radek Krejci2a408df2018-10-29 16:32:26 +01001389 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001390 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0e59c312019-08-15 15:34:15 +02001391 void *data; /**< private plugins's data, not used by libyang */
Radek Krejcice8c1592018-10-29 15:35:51 +01001392};
1393
1394/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001395 * @brief YANG when-stmt
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001396 */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001397struct lysc_when {
1398 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko175012e2019-11-06 15:49:14 +01001399 struct lysc_node *context; /**< context node for evaluating the expression, NULL if the context is root node */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001400 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001401 const char *dsc; /**< description */
1402 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001403 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00b874b2019-02-12 10:54:50 +01001404 uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */
Michal Vaskoecd62de2019-11-13 12:35:11 +01001405 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS is allowed */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001406};
1407
1408/**
Radek Krejci2a408df2018-10-29 16:32:26 +01001409 * @brief YANG identity-stmt
1410 */
1411struct lysc_ident {
1412 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejcic8b31002019-01-08 10:24:45 +01001413 const char *dsc; /**< description */
1414 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001415 struct lys_module *module; /**< module structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001416 struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */
1417 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1418 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
1419};
1420
1421/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001422 * @defgroup ifftokens if-feature expression tokens
Radek Krejci8678fa42020-08-18 16:07:28 +02001423 * Tokens of if-feature expression used in ::lysc_iffeature.expr.
Radek Krejci151a5b72018-10-19 14:21:44 +02001424 *
1425 * @{
1426 */
1427#define LYS_IFF_NOT 0x00 /**< operand "not" */
1428#define LYS_IFF_AND 0x01 /**< operand "and" */
1429#define LYS_IFF_OR 0x02 /**< operand "or" */
1430#define LYS_IFF_F 0x03 /**< feature */
Radek Krejci2ff0d572020-05-21 15:27:28 +02001431/** @} ifftokens */
Radek Krejci151a5b72018-10-19 14:21:44 +02001432
1433/**
Radek Krejcib7db73a2018-10-24 14:18:40 +02001434 * @brief Compiled YANG revision statement
1435 */
1436struct lysc_revision {
1437 char date[LY_REV_SIZE]; /**< revision-date (mandatory) */
1438 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1439};
1440
Radek Krejci2167ee12018-11-02 16:09:07 +01001441struct lysc_range {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001442 struct lysc_range_part {
Radek Krejci693262f2019-04-29 15:23:20 +02001443 union { /**< min boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001444 int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1445 uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001446 };
Radek Krejci693262f2019-04-29 15:23:20 +02001447 union { /**< max boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001448 int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1449 uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001450 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001451 } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001452 const char *dsc; /**< description */
1453 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001454 const char *emsg; /**< error-message */
1455 const char *eapptag; /**< error-app-tag value */
1456 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1457};
1458
1459struct lysc_pattern {
Radek Krejci54579462019-04-30 12:47:06 +02001460 const char *expr; /**< original, not compiled, regular expression */
1461 pcre2_code *code; /**< compiled regular expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001462 const char *dsc; /**< description */
1463 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001464 const char *emsg; /**< error-message */
1465 const char *eapptag; /**< error-app-tag value */
1466 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0f969882020-08-21 16:56:47 +02001467 uint32_t inverted : 1; /**< invert-match flag */
1468 uint32_t refcount : 31; /**< reference counter */
Radek Krejci2167ee12018-11-02 16:09:07 +01001469};
1470
1471struct lysc_must {
Radek Krejci2167ee12018-11-02 16:09:07 +01001472 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001473 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001474 const char *dsc; /**< description */
1475 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001476 const char *emsg; /**< error-message */
1477 const char *eapptag; /**< error-app-tag value */
1478 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1479};
1480
1481struct lysc_type {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001482 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001483 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 +01001484 LY_DATA_TYPE basetype; /**< Base type of the type */
1485 uint32_t refcount; /**< reference counter for type sharing */
1486};
1487
1488struct lysc_type_num {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001489 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001490 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 +01001491 LY_DATA_TYPE basetype; /**< Base type of the type */
1492 uint32_t refcount; /**< reference counter for type sharing */
1493 struct lysc_range *range; /**< Optional range limitation */
1494};
1495
1496struct lysc_type_dec {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001497 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001498 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 +01001499 LY_DATA_TYPE basetype; /**< Base type of the type */
1500 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci6cba4292018-11-15 17:33:29 +01001501 uint8_t fraction_digits; /**< fraction digits specification */
Radek Krejci2167ee12018-11-02 16:09:07 +01001502 struct lysc_range *range; /**< Optional range limitation */
1503};
1504
1505struct lysc_type_str {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001506 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001507 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 +01001508 LY_DATA_TYPE basetype; /**< Base type of the type */
1509 uint32_t refcount; /**< reference counter for type sharing */
1510 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci4586a022018-11-13 11:29:26 +01001511 struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001512};
1513
Radek Krejci693262f2019-04-29 15:23:20 +02001514struct lysc_type_bitenum_item {
1515 const char *name; /**< enumeration identifier */
1516 const char *dsc; /**< description */
1517 const char *ref; /**< reference */
1518 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci693262f2019-04-29 15:23:20 +02001519 union {
1520 int32_t value; /**< integer value associated with the enumeration */
1521 uint32_t position; /**< non-negative integer value associated with the bit */
1522 };
1523 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
1524 values are allowed */
1525};
1526
Radek Krejci2167ee12018-11-02 16:09:07 +01001527struct lysc_type_enum {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001528 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001529 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 +01001530 LY_DATA_TYPE basetype; /**< Base type of the type */
1531 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci693262f2019-04-29 15:23:20 +02001532 struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1533};
1534
1535struct lysc_type_bits {
1536 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001537 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 +02001538 LY_DATA_TYPE basetype; /**< Base type of the type */
1539 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci849a62a2019-05-22 15:29:05 +02001540 struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item),
1541 the items are ordered by their position value. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001542};
1543
1544struct lysc_type_leafref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001545 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001546 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 +01001547 LY_DATA_TYPE basetype; /**< Base type of the type */
1548 uint32_t refcount; /**< reference counter for type sharing */
Michal Vasko004d3152020-06-11 19:59:22 +02001549 struct lyxp_expr *path; /**< parsed target path, compiled path cannot be stored because of type sharing */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001550 struct lysc_prefix *prefixes; /**< resolved prefixes used in the path */
Michal Vaskoc0792ca2020-12-01 12:03:21 +01001551 const struct lys_module *cur_mod;/**< current module for the leafref (path) */
Radek Krejci412ddfa2018-11-23 11:44:11 +01001552 struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001553 uint8_t require_instance; /**< require-instance flag */
1554};
1555
1556struct lysc_type_identityref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001557 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001558 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 +01001559 LY_DATA_TYPE basetype; /**< Base type of the type */
1560 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci555cb5b2018-11-16 14:54:33 +01001561 struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)),
Radek Krejci2167ee12018-11-02 16:09:07 +01001562 mandatory (at least 1 item) */
1563};
1564
1565struct lysc_type_instanceid {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001566 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001567 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 +01001568 LY_DATA_TYPE basetype; /**< Base type of the type */
1569 uint32_t refcount; /**< reference counter for type sharing */
1570 uint8_t require_instance; /**< require-instance flag */
1571};
1572
Radek Krejci2167ee12018-11-02 16:09:07 +01001573struct lysc_type_union {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001574 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001575 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 +01001576 LY_DATA_TYPE basetype; /**< Base type of the type */
1577 uint32_t refcount; /**< reference counter for type sharing */
1578 struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1579};
1580
1581struct lysc_type_bin {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001582 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001583 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 +01001584 LY_DATA_TYPE basetype; /**< Base type of the type */
1585 uint32_t refcount; /**< reference counter for type sharing */
1586 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001587};
1588
Michal Vasko60ea6352020-06-29 13:39:39 +02001589/**
1590 * @brief Maximum number of hashes stored in a schema node.
1591 */
1592#define LYS_NODE_HASH_COUNT 4
1593
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001594/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001595 * @brief Compiled YANG data node
1596 */
1597struct lysc_node {
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001598 uint16_t nodetype; /**< type of the node (mandatory) */
1599 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Michal Vasko60ea6352020-06-29 13:39:39 +02001600 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001601 struct lys_module *module; /**< module structure */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001602 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1603 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1604 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1605 never NULL. If there is no sibling node, pointer points to the node
1606 itself. In case of the first node, this pointer points to the last
1607 node in the list. */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001608 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001609 const char *dsc; /**< description */
1610 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001611 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko2fd91b92020-07-17 16:39:02 +02001612 void *priv; /**< private arbitrary user data, not used by libyang */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001613};
1614
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001615struct lysc_node_action_inout {
1616 union {
1617 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1618 struct {
1619 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1620 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1621 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1622 struct lys_module *module; /**< module structure */
Radek Krejci5960c312021-01-27 20:24:22 +01001623 struct lysc_node *parent;/**< parent node (NULL in case of top level node) */
1624 struct lysc_node *next; /**< NULL */
1625 struct lysc_node *prev; /**< pointer to the node itself - compatibility with ::lysc_node, input and output are
1626 supposed to be a separated subtrees, so they do not link each other as siblings. */
1627 const char *name; /**< "input" or "output" */
1628 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysc_node */
1629 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysc_node */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001630 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001631 void *priv; /** private arbitrary user data, not used by libyang */
1632 };
1633 };
1634
Radek Krejci9a3823e2021-01-27 20:26:46 +01001635 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001636 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1637};
1638
1639struct lysc_node_action {
1640 union {
1641 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1642 struct {
1643 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1644 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1645 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1646 struct lys_module *module; /**< module structure */
1647 struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */
1648 struct lysc_node_action *next; /**< next sibling node (NULL if there is no one) */
1649 struct lysc_node_action *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1650 never NULL. If there is no sibling node, pointer points to the node
1651 itself. In case of the first node, this pointer points to the last
1652 node in the list. */
1653 const char *name; /**< action/RPC name (mandatory) */
1654 const char *dsc; /**< description */
1655 const char *ref; /**< reference */
1656 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001657 void *priv; /** private arbitrary user data, not used by libyang */
1658 };
1659 };
1660
Radek Krejci9a3823e2021-01-27 20:26:46 +01001661 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1662 the action/RPC nodes do not contain the when statement on their own, but they can
1663 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001664 struct lysc_node_action_inout input; /**< RPC's/action's input */
1665 struct lysc_node_action_inout output; /**< RPC's/action's output */
1666
1667};
1668
1669struct lysc_node_notif {
1670 union {
1671 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1672 struct {
1673 uint16_t nodetype; /**< LYS_NOTIF */
1674 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1675 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1676 struct lys_module *module; /**< module structure */
1677 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1678 struct lysc_node_notif *next; /**< next sibling node (NULL if there is no one) */
1679 struct lysc_node_notif *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1680 never NULL. If there is no sibling node, pointer points to the node
1681 itself. In case of the first node, this pointer points to the last
1682 node in the list. */
1683 const char *name; /**< Notification name (mandatory) */
1684 const char *dsc; /**< description */
1685 const char *ref; /**< reference */
1686 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001687 void *priv; /** private arbitrary user data, not used by libyang */
1688 };
1689 };
1690
Radek Krejci9a3823e2021-01-27 20:26:46 +01001691 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001692 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001693 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1694 the notification nodes do not contain the when statement on their own, but they can
1695 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001696};
1697
1698struct lysc_node_container {
1699 union {
1700 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1701 struct {
1702 uint16_t nodetype; /**< LYS_CONTAINER */
1703 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1704 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1705 struct lys_module *module; /**< module structure */
1706 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1707 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1708 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1709 never NULL. If there is no sibling node, pointer points to the node
1710 itself. In case of the first node, this pointer points to the last
1711 node in the list. */
1712 const char *name; /**< node name (mandatory) */
1713 const char *dsc; /**< description */
1714 const char *ref; /**< reference */
1715 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001716 void *priv; /**< private arbitrary user data, not used by libyang */
1717 };
1718 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001719
1720 struct lysc_node *child; /**< first child node (linked list) */
1721 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001722 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001723 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1724 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001725};
1726
Radek Krejcia3045382018-11-22 14:30:31 +01001727struct lysc_node_case {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001728 union {
1729 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1730 struct {
1731 uint16_t nodetype; /**< LYS_CASE */
1732 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1733 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1734 struct lys_module *module; /**< module structure */
1735 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1736 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1737 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejci056d0a82018-12-06 16:57:25 +01001738 never NULL. If there is no sibling node, pointer points to the node
1739 itself. In case of the first node, this pointer points to the last
1740 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001741 const char *name; /**< name of the case, including the implicit case */
1742 const char *dsc; /**< description */
1743 const char *ref; /**< reference */
1744 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001745 void *priv; /**< private arbitrary user data, not used by libyang */
1746 };
1747 };
Radek Krejci056d0a82018-12-06 16:57:25 +01001748
Radek Krejcia3045382018-11-22 14:30:31 +01001749 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 +01001750 each other as siblings with the parent pointer pointing to appropriate case node. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001751 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcia3045382018-11-22 14:30:31 +01001752};
1753
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001754struct lysc_node_choice {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001755 union {
1756 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1757 struct {
1758 uint16_t nodetype; /**< LYS_CHOICE */
1759 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1760 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1761 struct lys_module *module; /**< module structure */
1762 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1763 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1764 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001765 never NULL. If there is no sibling node, pointer points to the node
1766 itself. In case of the first node, this pointer points to the last
1767 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001768 const char *name; /**< node name (mandatory) */
1769 const char *dsc; /**< description */
1770 const char *ref; /**< reference */
1771 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001772 void *priv; /**< private arbitrary user data, not used by libyang */
1773 };
1774 };
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001775
Radek Krejcia9026eb2018-12-12 16:04:47 +01001776 struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other
1777 as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the
1778 case is simple. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001779 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001780 struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001781};
1782
1783struct lysc_node_leaf {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001784 union {
1785 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1786 struct {
1787 uint16_t nodetype; /**< LYS_LEAF */
1788 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1789 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1790 struct lys_module *module; /**< module structure */
1791 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1792 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1793 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001794 never NULL. If there is no sibling node, pointer points to the node
1795 itself. In case of the first node, this pointer points to the last
1796 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001797 const char *name; /**< node name (mandatory) */
1798 const char *dsc; /**< description */
1799 const char *ref; /**< reference */
1800 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001801 void *priv; /**< private arbitrary user data, not used by libyang */
1802 };
1803 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001804
1805 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001806 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001807 struct lysc_type *type; /**< type of the leaf node (mandatory) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001808
Radek Krejci4f28eda2018-11-12 11:46:16 +01001809 const char *units; /**< units of the leaf's type */
Radek Krejcia1911222019-07-22 17:24:50 +02001810 struct lyd_value *dflt; /**< default value */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001811};
1812
1813struct lysc_node_leaflist {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001814 union {
1815 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1816 struct {
1817 uint16_t nodetype; /**< LYS_LEAFLIST */
1818 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1819 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1820 struct lys_module *module; /**< module structure */
1821 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1822 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1823 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001824 never NULL. If there is no sibling node, pointer points to the node
1825 itself. In case of the first node, this pointer points to the last
1826 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001827 const char *name; /**< node name (mandatory) */
1828 const char *dsc; /**< description */
1829 const char *ref; /**< reference */
1830 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001831 void *priv; /**< private arbitrary user data, not used by libyang */
1832 };
1833 };
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001834
1835 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001836 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001837 struct lysc_type *type; /**< type of the leaf node (mandatory) */
1838
Radek Krejci0e5d8382018-11-28 16:37:53 +01001839 const char *units; /**< units of the leaf's type */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001840 struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */
Michal Vaskoba99a3e2020-08-18 15:50:05 +02001841
Radek Krejci0e5d8382018-11-28 16:37:53 +01001842 uint32_t min; /**< min-elements constraint */
1843 uint32_t max; /**< max-elements constraint */
1844
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001845};
1846
1847struct lysc_node_list {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001848 union {
1849 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1850 struct {
1851 uint16_t nodetype; /**< LYS_LIST */
1852 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1853 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1854 struct lys_module *module; /**< module structure */
1855 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1856 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1857 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001858 never NULL. If there is no sibling node, pointer points to the node
1859 itself. In case of the first node, this pointer points to the last
1860 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001861 const char *name; /**< node name (mandatory) */
1862 const char *dsc; /**< description */
1863 const char *ref; /**< reference */
1864 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001865 void *priv; /**< private arbitrary user data, not used by libyang */
1866 };
1867 };
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001868
1869 struct lysc_node *child; /**< first child node (linked list) */
1870 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001871 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001872 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1873 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001874
Radek Krejci2a9fc652021-01-22 17:44:34 +01001875 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 +01001876 uint32_t min; /**< min-elements constraint */
1877 uint32_t max; /**< max-elements constraint */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001878};
1879
1880struct lysc_node_anydata {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001881 union {
1882 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1883 struct {
1884 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1885 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1886 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1887 struct lys_module *module; /**< module structure */
1888 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1889 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1890 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001891 never NULL. If there is no sibling node, pointer points to the node
1892 itself. In case of the first node, this pointer points to the last
1893 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001894 const char *name; /**< node name (mandatory) */
1895 const char *dsc; /**< description */
1896 const char *ref; /**< reference */
1897 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001898 void *priv; /**< private arbitrary user data, not used by libyang */
1899 };
1900 };
Radek Krejci9800fb82018-12-13 14:26:23 +01001901
1902 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001903 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001904};
1905
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001906/**
1907 * @brief Compiled YANG schema tree structure representing YANG module.
1908 *
1909 * Semantically validated YANG schema tree for data tree parsing.
1910 * Contains only the necessary information for the data validation.
1911 */
1912struct lysc_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001913 struct lys_module *mod; /**< covering module structure */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001914
Radek Krejci2a408df2018-10-29 16:32:26 +01001915 struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001916 struct lysc_node_action *rpcs; /**< first of actions nodes (linked list) */
1917 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001918 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001919};
1920
1921/**
Radek Krejci490a5462020-11-05 08:44:42 +01001922 * @brief Examine whether a node is user-ordered list or leaf-list.
1923 *
1924 * @param[in] lysc_node Schema node to examine.
1925 * @return Boolean value whether the @p node is user-ordered or not.
1926 */
1927#define lysc_is_userordered(lysc_node) \
1928 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAFLIST | LYS_LIST)) || !(lysc_node->flags & LYS_ORDBY_USER)) ? 0 : 1)
1929
1930/**
1931 * @brief Examine whether a node is a list's key.
1932 *
1933 * @param[in] lysc_node Schema node to examine.
1934 * @return Boolean value whether the @p node is a key or not.
1935 */
1936#define lysc_is_key(lysc_node) \
1937 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAF)) || !(lysc_node->flags & LYS_KEY)) ? 0 : 1)
1938
1939/**
Michal Vasko5c123b02020-12-04 14:34:04 +01001940 * @brief Examine whether a node is a non-presence container.
1941 *
1942 * @param[in] lysc_node Schema node to examine.
1943 * @return Boolean value whether the @p node is a NP container or not.
1944 */
1945#define lysc_is_np_cont(lysc_node) \
1946 ((!lysc_node || !(lysc_node->nodetype & (LYS_CONTAINER)) || (lysc_node->flags & LYS_PRESENCE)) ? 0 : 1)
1947
1948/**
Michal Vaskod5cfa6e2020-11-23 16:56:08 +01001949 * @brief Check whether the schema node data instance existence depends on any when conditions.
1950 * This node and any direct parent choice and case schema nodes are also examined for when conditions.
1951 *
1952 * Be careful, this function is not recursive and checks only conditions that apply to this node directly.
1953 * Meaning if there are any conditions associated with any data parent instance of @p node, they are not returned.
1954 *
1955 * @param[in] node Schema node to examine.
1956 * @return When condition associated with the node data instance, NULL if there is none.
1957 */
1958const struct lysc_when *lysc_has_when(const struct lysc_node *node);
1959
1960/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001961 * @brief Get the groupings linked list of the given (parsed) schema node.
Radek Krejci53ea6152018-12-13 15:21:15 +01001962 * Decides the node's type and in case it has a groupings array, returns it.
1963 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001964 * @return The node's groupings linked list if any, NULL otherwise.
Radek Krejci53ea6152018-12-13 15:21:15 +01001965 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001966const struct lysp_node_grp *lysp_node_groupings(const struct lysp_node *node);
Radek Krejci53ea6152018-12-13 15:21:15 +01001967
1968/**
Radek Krejci056d0a82018-12-06 16:57:25 +01001969 * @brief Get the typedefs sized array of the given (parsed) schema node.
1970 * Decides the node's type and in case it has a typedefs array, returns it.
1971 * @param[in] node Node to examine.
1972 * @return The node's typedefs sized array if any, NULL otherwise.
1973 */
1974const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
1975
1976/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001977 * @brief Get the actions/RPCs linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001978 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1979 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001980 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01001981 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001982const struct lysp_node_action *lysp_node_actions(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01001983
1984/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001985 * @brief Get the Notifications linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001986 * Decides the node's type and in case it has a Notifications array, returns it.
1987 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001988 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01001989 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001990const struct lysp_node_notif *lysp_node_notifs(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01001991
1992/**
1993 * @brief Get the children linked list of the given (parsed) schema node.
1994 * Decides the node's type and in case it has a children list, returns it.
1995 * @param[in] node Node to examine.
1996 * @return The node's children linked list if any, NULL otherwise.
1997 */
1998const struct lysp_node *lysp_node_children(const struct lysp_node *node);
1999
2000/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002001 * @brief Get the actions/RPCs linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002002 * Decides the node's type and in case it has a actions/RPCs array, returns it.
2003 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002004 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002005 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002006const struct lysc_node_action *lysc_node_actions(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002007
2008/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002009 * @brief Get the Notifications linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002010 * Decides the node's type and in case it has a Notifications array, returns it.
2011 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002012 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002013 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002014const struct lysc_node_notif *lysc_node_notifs(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002015
2016/**
2017 * @brief Get the children linked list of the given (compiled) schema node.
Michal Vasko2a668712020-10-21 11:48:09 +02002018 *
2019 * @param[in] node Node to examine.
Michal Vaskod1e53b92021-01-28 13:11:06 +01002020 * @param[in] flags Flag to distinguish input (LYS_IS_INPUT) and output (LYS_IS_OUTPUT) child in case of RPC/action node.
Michal Vasko2a668712020-10-21 11:48:09 +02002021 * @return Children linked list if any,
2022 * @return NULL otherwise.
2023 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002024const struct lysc_node *lysc_node_children(const struct lysc_node *node, uint16_t flags);
Michal Vasko2a668712020-10-21 11:48:09 +02002025
2026/**
Radek Krejci9a3823e2021-01-27 20:26:46 +01002027 * @brief Get the must statements list if present in the @p node
2028 *
2029 * @param[in] node Node to examine.
2030 * @return Pointer to the list of must restrictions ([sized array](@ref sizedarrays))
2031 * @return NULL if there is no must statement in the node, no matter if it is not even allowed or just present
2032 */
2033struct lysc_must *lysc_node_musts(const struct lysc_node *node);
2034
2035/**
2036 * @brief Get the when statements list if present in the @p node
2037 *
2038 * @param[in] node Node to examine.
2039 * @return Pointer to the list of pointers to when statements ([sized array](@ref sizedarrays))
2040 * @return NULL if there is no when statement in the node, no matter if it is not even allowed or just present
2041 */
2042struct lysc_when **lysc_node_when(const struct lysc_node *node);
2043
2044/**
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002045 * @brief Callback to be called for every schema node in a DFS traversal.
2046 *
2047 * @param[in] node Current node.
2048 * @param[in] data Arbitrary user data.
2049 * @param[out] dfs_continue Set to true if the current subtree should be skipped and continue with siblings instead.
2050 * @return LY_SUCCESS on success,
2051 * @return LY_ERR value to terminate DFS and return this value.
2052 */
Radek Krejci01180ac2021-01-27 08:48:22 +01002053typedef LY_ERR (*lysc_dfs_clb)(struct lysc_node *node, void *child, ly_bool *dfs_continue);
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002054
2055/**
2056 * @brief DFS traversal of all the schema nodes in a (sub)tree including any actions and nested notifications.
2057 *
2058 * Node with children, actions, and notifications is traversed in this order:
2059 * 1) each child subtree;
2060 * 2) each action subtree;
2061 * 3) each notification subtree.
2062 *
2063 * For algorithm illustration or traversal with actions and notifications skipped, see ::LYSC_TREE_DFS_BEGIN.
2064 *
2065 * @param[in] root Schema root to fully traverse.
2066 * @param[in] dfs_clb Callback to call for each node.
2067 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2068 * @return LY_SUCCESS on success,
2069 * @return LY_ERR value returned by @p dfs_clb.
2070 */
2071LY_ERR lysc_tree_dfs_full(const struct lysc_node *root, lysc_dfs_clb dfs_clb, void *data);
2072
2073/**
2074 * @brief DFS traversal of all the schema nodes in a module including RPCs and notifications.
2075 *
2076 * For more details, see ::lysc_tree_dfs_full().
2077 *
2078 * @param[in] mod Module to fully traverse.
2079 * @param[in] dfs_clb Callback to call for each node.
2080 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2081 * @return LY_SUCCESS on success,
2082 * @return LY_ERR value returned by @p dfs_clb.
2083 */
2084LY_ERR lysc_module_dfs_full(const struct lys_module *mod, lysc_dfs_clb dfs_clb, void *data);
2085
2086/**
Michal Vasko2fd91b92020-07-17 16:39:02 +02002087 * @brief Set a schema private pointer to a user pointer.
2088 *
2089 * @param[in] node Node, whose private field will be assigned. Works also for RPCs, actions, and notifications.
2090 * @param[in] priv Arbitrary user-specified pointer.
Radek Krejciaf9cd802020-10-06 21:59:47 +02002091 * @param[out] prev_priv_p Optional previous private object of the \p node. Note, that
Michal Vasko2fd91b92020-07-17 16:39:02 +02002092 * the caller is in this case responsible (if it is necessary) for freeing the replaced private object.
2093 * @return LY_ERR value.
2094 */
Radek Krejciaf9cd802020-10-06 21:59:47 +02002095LY_ERR lysc_set_private(const struct lysc_node *node, void *priv, void **prev_priv_p);
Michal Vasko2fd91b92020-07-17 16:39:02 +02002096
2097/**
Radek Krejci151a5b72018-10-19 14:21:44 +02002098 * @brief Get how the if-feature statement currently evaluates.
2099 *
2100 * @param[in] iff Compiled if-feature statement to evaluate.
Michal Vasko28d78432020-05-26 13:10:53 +02002101 * @return LY_SUCCESS if the statement evaluates to true,
2102 * @return LY_ENOT if it evaluates to false,
2103 * @return LY_ERR on error.
Radek Krejci151a5b72018-10-19 14:21:44 +02002104 */
Michal Vasko28d78432020-05-26 13:10:53 +02002105LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff);
Radek Krejci151a5b72018-10-19 14:21:44 +02002106
2107/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002108 * @brief Get the next feature in the module or submodules.
Radek Krejci151a5b72018-10-19 14:21:44 +02002109 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002110 * @param[in] last Last returned feature.
2111 * @param[in] pmod Parsed module and submodoules whose features to iterate over.
2112 * @param[in,out] idx Submodule index, set to 0 on first call.
2113 * @return Next found feature, NULL if the last has already been returned.
Radek Krejci151a5b72018-10-19 14:21:44 +02002114 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002115struct 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 +02002116
Radek Krejcibed13942020-10-19 16:06:28 +02002117/**
2118 * @defgroup findxpathoptions Atomize XPath options
2119 * Options to modify behavior of ::lys_find_xpath() and ::lys_find_xpath_atoms() searching for schema nodes in schema tree.
2120 * @{
2121 */
Michal Vaskocdad7122020-11-09 21:04:44 +01002122#define LYS_FIND_XP_SCHEMA 0x08 /**< Apply node access restrictions defined for 'when' and 'must' evaluation. */
2123#define LYS_FIND_XP_OUTPUT 0x10 /**< Search RPC/action output nodes instead of input ones. */
Radek Krejci576f8fa2020-10-26 21:23:58 +01002124/** @} findxpathoptions */
Michal Vasko072de482020-08-05 13:27:21 +02002125
Radek Krejci151a5b72018-10-19 14:21:44 +02002126/**
Michal Vasko40308e72020-10-20 16:38:40 +02002127 * @brief Get all the schema nodes that are required for @p xpath to be evaluated (atoms).
Michal Vasko519fd602020-05-26 12:17:39 +02002128 *
Michal Vasko26512682021-01-11 11:35:40 +01002129 * @param[in] ctx libyang context to use. May be NULL if @p ctx_node is set.
2130 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002131 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002132 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko519fd602020-05-26 12:17:39 +02002133 * @param[out] set Set of found atoms (schema nodes).
2134 * @return LY_SUCCESS on success, @p set is returned.
Michal Vasko40308e72020-10-20 16:38:40 +02002135 * @return LY_ERR value on error.
Michal Vasko519fd602020-05-26 12:17:39 +02002136 */
Michal Vasko26512682021-01-11 11:35:40 +01002137LY_ERR lys_find_xpath_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
2138 uint32_t options, struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002139
Michal Vasko072de482020-08-05 13:27:21 +02002140/**
Michal Vasko40308e72020-10-20 16:38:40 +02002141 * @brief Get all the schema nodes that are required for @p expr to be evaluated (atoms).
Michal Vasko072de482020-08-05 13:27:21 +02002142 *
Michal Vasko26512682021-01-11 11:35:40 +01002143 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002144 * @param[in] cur_mod Current module for the expression (where it was "instantiated").
2145 * @param[in] expr Parsed expression to use.
2146 * @param[in] prefixes Sized array of compiled prefixes.
2147 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
2148 * @param[out] set Set of found atoms (schema nodes).
2149 * @return LY_SUCCESS on success, @p set is returned.
2150 * @return LY_ERR value on error.
2151 */
2152LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod,
2153 const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set);
2154
2155/**
2156 * @brief Evaluate an @p xpath expression on schema nodes.
2157 *
Michal Vasko26512682021-01-11 11:35:40 +01002158 * @param[in] ctx libyang context to use for absolute @p xpath. May be NULL if @p ctx_node is set.
2159 * @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 +02002160 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002161 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko072de482020-08-05 13:27:21 +02002162 * @param[out] set Set of found schema nodes.
2163 * @return LY_SUCCESS on success, @p set is returned.
2164 * @return LY_ERR value if an error occurred.
2165 */
Michal Vasko26512682021-01-11 11:35:40 +01002166LY_ERR lys_find_xpath(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath, uint32_t options,
2167 struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002168
2169/**
Radek Krejcibc5644c2020-10-27 14:53:17 +01002170 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2171 *
2172 * @param[in] path Compiled path to use.
2173 * @param[out] set Set of found atoms (schema nodes).
2174 * @return LY_SUCCESS on success, @p set is returned.
2175 * @return LY_ERR value on error.
2176 */
2177LY_ERR lys_find_lypath_atoms(const struct ly_path *path, struct ly_set **set);
2178
2179/**
2180 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2181 *
Michal Vasko26512682021-01-11 11:35:40 +01002182 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2183 * @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 +01002184 * @param[in] path JSON path to examine.
2185 * @param[in] output Search operation output instead of input.
2186 * @param[out] set Set of found atoms (schema nodes).
2187 * @return LY_ERR value on error.
2188 */
2189LY_ERR lys_find_path_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path, ly_bool output,
2190 struct ly_set **set);
2191
2192/**
2193 * @brief Get a schema node based on the given data path (JSON format, see @ref howtoXPath).
2194 *
Michal Vasko26512682021-01-11 11:35:40 +01002195 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2196 * @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 +01002197 * @param[in] path JSON path of the node to get.
2198 * @param[in] output Search operation output instead of input.
2199 * @return Found schema node or NULL.
2200 */
2201const struct lysc_node *lys_find_path(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path,
2202 ly_bool output);
2203
2204/**
Michal Vasko03ff5a72019-09-11 13:49:33 +02002205 * @brief Types of the different schema paths.
2206 */
2207typedef enum {
Michal Vasko65de0402020-08-03 16:34:19 +02002208 LYSC_PATH_LOG, /**< Descriptive path format used in log messages */
2209 LYSC_PATH_DATA /**< Similar to ::LYSC_PATH_LOG except that schema-only nodes (choice, case) are skipped */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002210} LYSC_PATH_TYPE;
2211
2212/**
Radek Krejci327de162019-06-14 12:52:07 +02002213 * @brief Generate path of the given node in the requested format.
2214 *
2215 * @param[in] node Schema path of this node will be generated.
2216 * @param[in] pathtype Format of the path to generate.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002217 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
2218 * If NULL, memory for the complete path is allocated.
2219 * @param[in] buflen Size of the provided @p buffer.
Radek Krejci327de162019-06-14 12:52:07 +02002220 * @return NULL in case of memory allocation error, path of the node otherwise.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002221 * 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 +02002222 */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002223char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
Radek Krejci327de162019-06-14 12:52:07 +02002224
2225/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002226 * @brief Available YANG schema tree structures representing YANG module.
2227 */
2228struct lys_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002229 struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */
2230 const char *name; /**< name of the module (mandatory) */
Radek Krejci0af46292019-01-11 16:02:31 +01002231 const char *revision; /**< revision of the module (if present) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002232 const char *ns; /**< namespace of the module (module - mandatory) */
2233 const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */
2234 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
2235 const char *org; /**< party/company responsible for the module */
2236 const char *contact; /**< contact information for the module */
2237 const char *dsc; /**< description of the module */
2238 const char *ref; /**< cross-reference for the module */
2239
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002240 struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */
Radek Krejci0af46292019-01-11 16:02:31 +01002241 struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing.
2242 Available only for implemented modules. */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002243
Radek Krejci80d281e2020-09-14 17:42:54 +02002244 struct lysc_ident *identities; /**< List of compiled identities of the module ([sized array](@ref sizedarrays))
2245 Identities are outside the compiled tree to allow their linkage to the identities from
2246 the implemented modules. This avoids problems when the module became implemented in
2247 future (no matter if implicitly via augment/deviate or explicitly via
2248 ::lys_set_implemented()). Note that if the module is not implemented (compiled), the
2249 identities cannot be instantiated in data (in identityrefs). */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002250
2251 struct lys_module **augmented_by;/**< List of modules that augment this module ([sized array](@ref sizedarrays)) */
2252 struct lys_module **deviated_by; /**< List of modules that deviate this module ([sized array](@ref sizedarrays)) */
2253
Michal Vasko89b5c072020-10-06 13:52:44 +02002254 ly_bool implemented; /**< flag if the module is implemented, not just imported */
Radek Krejci95710c92019-02-11 15:49:55 +01002255 uint8_t latest_revision; /**< flag to mark the latest available revision:
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002256 1 - the latest revision in searchdirs was not searched yet and this is the
2257 latest revision in the current context
2258 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002259};
2260
Radek Krejci151a5b72018-10-19 14:21:44 +02002261/**
Michal Vasko82c31e62020-07-17 15:30:40 +02002262 * @brief Get the current real status of the specified feature in the module.
2263 *
2264 * If the feature is enabled, but some of its if-features are false, the feature is considered
2265 * disabled.
Radek Krejci151a5b72018-10-19 14:21:44 +02002266 *
2267 * @param[in] module Module where the feature is defined.
2268 * @param[in] feature Name of the feature to inspect.
Michal Vasko82c31e62020-07-17 15:30:40 +02002269 * @return LY_SUCCESS if the feature is enabled,
2270 * @return LY_ENOT if the feature is disabled,
2271 * @return LY_ENOTFOUND if the feature was not found.
Radek Krejci151a5b72018-10-19 14:21:44 +02002272 */
Michal Vasko82c31e62020-07-17 15:30:40 +02002273LY_ERR lys_feature_value(const struct lys_module *module, const char *feature);
Radek Krejcidd4e8d42018-10-16 14:55:43 +02002274
2275/**
Radek Krejcia3045382018-11-22 14:30:31 +01002276 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can
2277 * be from an augment.
2278 *
Radek Krejci8678fa42020-08-18 16:07:28 +02002279 * ::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 +01002280 * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module.
2281 * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
2282 * \p parent and \p module parameters.
2283 *
2284 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
2285 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
2286 * all the schema nodes are iteratively returned.
2287 *
2288 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
2289 * @param[in] parent Parent of the subtree where the function starts processing.
2290 * @param[in] module In case of iterating on top level elements, the \p parent is NULL and
2291 * module must be specified.
2292 * @param[in] options [ORed options](@ref sgetnextflags).
2293 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
2294 */
2295const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002296 const struct lysc_module *module, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002297
2298/**
Radek Krejci8678fa42020-08-18 16:07:28 +02002299 * @defgroup sgetnextflags Options for ::lys_getnext().
2300 *
2301 * Various options setting behavior of ::lys_getnext().
2302 *
Radek Krejcia3045382018-11-22 14:30:31 +01002303 * @{
2304 */
Radek Krejci8678fa42020-08-18 16:07:28 +02002305#define LYS_GETNEXT_WITHCHOICE 0x01 /**< ::lys_getnext() option to allow returning #LYS_CHOICE nodes instead of looking into them */
2306#define LYS_GETNEXT_NOCHOICE 0x02 /**< ::lys_getnext() option to ignore (kind of conditional) nodes within choice node */
2307#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 +01002308#define LYS_GETNEXT_INTONPCONT 0x08 /**< ::lys_getnext() option to look into non-presence container, instead of returning container itself */
2309#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 +01002310 provided by default */
Radek Krejcia3045382018-11-22 14:30:31 +01002311/** @} sgetnextflags */
2312
2313/**
2314 * @brief Get child node according to the specified criteria.
2315 *
2316 * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched.
2317 * @param[in] module module of the node to find. It is also limitation for the children node of the given parent.
2318 * @param[in] name Name of the node to find.
2319 * @param[in] name_len Optional length of the name in case it is not NULL-terminated string.
2320 * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find.
2321 * Used as a bitmask, so multiple nodetypes can be specified.
2322 * @param[in] options [ORed options](@ref sgetnextflags).
2323 * @return Found node if any.
2324 */
Michal Vaskoe444f752020-02-10 12:20:06 +01002325const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002326 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002327
2328/**
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002329 * @brief Make the specific module implemented.
2330 *
Michal Vaskoe8988e92021-01-25 11:26:29 +01002331 * If the module is already implemented but with a different set of features, the whole context is recompiled.
2332 *
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002333 * @param[in] mod Module to make implemented. It is not an error
2334 * to provide already implemented module, it just does nothing.
Michal Vaskoe8988e92021-01-25 11:26:29 +01002335 * @param[in] features Optional array specifying the enabled features terminated with NULL overriding any previous
2336 * feature setting. The feature string '*' enables all the features and array of length 1 with only the terminating
2337 * NULL explicitly disables all the features. In case the parameter is NULL, the features are untouched - left disabled
2338 * 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 +01002339 * @return LY_SUCCESS on success.
2340 * @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 +01002341 * @return LY_ERR on other errors during module compilation.
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002342 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002343LY_ERR lys_set_implemented(struct lys_module *mod, const char **features);
Radek Krejcia3045382018-11-22 14:30:31 +01002344
Radek Krejci084289f2019-07-09 17:35:30 +02002345/**
2346 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
2347 *
2348 * 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 +02002349 * require-instance restriction), use ::lyd_value_validate().
Radek Krejci084289f2019-07-09 17:35:30 +02002350 *
2351 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
2352 * @param[in] node Schema node for the @p value.
Michal Vaskof937cfe2020-08-03 16:07:12 +02002353 * @param[in] value String value to be checked, expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02002354 * @param[in] value_len Length of the given @p value (mandatory).
Radek Krejci084289f2019-07-09 17:35:30 +02002355 * @return LY_SUCCESS on success
2356 * @return LY_ERR value if an error occurred.
2357 */
Michal Vaskof937cfe2020-08-03 16:07:12 +02002358LY_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 +02002359
Radek Krejci0935f412019-08-20 16:15:18 +02002360/**
2361 * @brief Stringify schema nodetype.
Michal Vaskod43d71a2020-08-07 14:54:58 +02002362 *
Radek Krejci0935f412019-08-20 16:15:18 +02002363 * @param[in] nodetype Nodetype to stringify.
2364 * @return Constant string with the name of the node's type.
2365 */
2366const char *lys_nodetype2str(uint16_t nodetype);
2367
Michal Vaskod43d71a2020-08-07 14:54:58 +02002368/**
2369 * @brief Getter for original XPath expression from a parsed expression.
2370 *
2371 * @param[in] path Parsed expression.
2372 * @return Original string expression.
2373 */
2374const char *lyxp_get_expr(const struct lyxp_expr *path);
2375
Radek Krejci2ff0d572020-05-21 15:27:28 +02002376/** @} schematree */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002377
Radek Krejci70853c52018-10-15 14:46:16 +02002378#ifdef __cplusplus
2379}
2380#endif
2381
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002382#endif /* LY_TREE_SCHEMA_H_ */