blob: 9e78e2bfd1abfe4375699cb1ebba2f8dcd426d1d [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 */ \
Radek Krejci7d95fbb2021-01-26 17:33:13 +0100229 (NEXT) = (struct lysc_node *)lysc_node_children((ELEM)->parent, LYS_CONFIG_R); \
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| | | | | | | |
832 * LYS_ISENUM | | | | | | | | | | | | |x| |
833 * LYS_KEYLESS | | | | |x| | | | | | | | | |
834 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
835 * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | |
836 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
837 * 12 LYS_SET_CONFIG |x|x|x|x|x|x| | | | | | | | |
838 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100839 *
840 */
841
842/**
843 * @defgroup snodeflags Schema nodes flags
Radek Krejci8678fa42020-08-18 16:07:28 +0200844 *
845 * Various flags for schema nodes ([parsed](@ref spnodeflags) as well as [compiled](@ref scnodeflags)).
846 *
Radek Krejci4f28eda2018-11-12 11:46:16 +0100847 * @{
848 */
Michal Vasko1bf09392020-03-27 12:38:10 +0100849#define LYS_CONFIG_W 0x01 /**< config true; also set for input children nodes */
850#define LYS_CONFIG_R 0x02 /**< config false; also set for output and notification children nodes */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200851#define LYS_CONFIG_MASK 0x03 /**< mask for config value */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100852#define LYS_STATUS_CURR 0x04 /**< status current; */
853#define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */
854#define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */
855#define LYS_STATUS_MASK 0x1C /**< mask for status value */
856#define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice,
Radek Krejcife909632019-02-12 15:34:42 +0100857 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
858 The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0.
859 The ::lysc_node_container has this flag if it is not a presence container and it has at least one
860 child with LYS_MAND_TRUE. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100861#define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice,
862 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
863 This flag is present only in case the mandatory false statement was explicitly specified. */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100864#define LYS_MAND_MASK 0x60 /**< mask for mandatory values */
Michal Vaskoc118ae22020-08-06 14:51:09 +0200865#define LYS_PRESENCE 0x80 /**< flag for presence property of a container, but it is not only for explicit presence
866 containers, but also for NP containers with some meaning, applicable only to
867 ::lysc_node_container */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100868#define LYS_UNIQUE 0x80 /**< flag for leafs being part of a unique set, applicable only to ::lysc_node_leaf */
869#define LYS_KEY 0x100 /**< flag for leafs being a key of a list, applicable only to ::lysc_node_leaf */
Radek Krejci0fe9b512019-07-26 17:51:05 +0200870#define LYS_KEYLESS 0x200 /**< flag for list without any key, applicable only to ::lysc_node_list */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100871#define LYS_FENABLED 0x20 /**< feature enabled flag, applicable only to ::lysp_feature. */
Radek Krejcife909632019-02-12 15:34:42 +0100872#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 +0100873 ::lysc_node_list/::lysp_node_list */
874#define LYS_ORDBY_USER 0x40 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and
875 ::lysc_node_list/::lysp_node_list */
876#define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */
877#define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */
878#define LYS_YINELEM_FALSE 0x100 /**< yin-element false for extension's argument */
879#define LYS_YINELEM_MASK 0x180 /**< mask for yin-element value */
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200880#define LYS_USED_GRP 0x400 /**< internal flag for validating not-instantiated groupings
881 (resp. do not validate again the instantiated groupings). */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100882#define LYS_SET_VALUE 0x200 /**< value attribute is set */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100883#define LYS_SET_MIN 0x200 /**< min attribute is set */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200884#define LYS_SET_MAX 0x400 /**< max attribute is set */
Radek Krejcid505e3d2018-11-13 09:04:17 +0100885
886#define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */
887#define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */
888#define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */
889#define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */
890#define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */
891#define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */
892#define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */
893#define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */
894#define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */
895#define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */
Radek Krejciccd20f12019-02-15 14:12:27 +0100896#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 +0100897 cases of choice. This information is important for refines, since it is prohibited to make leafs
898 with default statement mandatory. In case the default leaf value is taken from type, it is thrown
Radek Krejciccd20f12019-02-15 14:12:27 +0100899 away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish
900 between own default or the default values taken from the type. */
901#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 +0100902#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 +0100903
Radek Krejcif56e2a42019-09-09 14:15:25 +0200904#define LYS_SINGLEQUOTED 0x100 /**< flag for single-quoted argument of an extension instance's substatement, only when the source is YANG */
905#define LYS_DOUBLEQUOTED 0x200 /**< flag for double-quoted argument of an extension instance's substatement, only when the source is YANG */
Radek Krejcid3ca0632019-04-16 16:54:54 +0200906
Radek Krejcif56e2a42019-09-09 14:15:25 +0200907#define LYS_YIN_ATTR 0x400 /**< flag to identify YIN attribute parsed as extension's substatement, only when the source is YIN */
908#define LYS_YIN_ARGUMENT 0x800 /**< flag to identify statement representing extension's argument, only when the source is YIN */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200909
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100910#define LYS_INTERNAL 0x1000 /**< flag to identify internal parsed statements that should not be printed */
911
Radek Krejci693262f2019-04-29 15:23:20 +0200912#define LYS_ISENUM 0x200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */
913
Radek Krejcife909632019-02-12 15:34:42 +0100914#define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200915/** @} snodeflags */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200916
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200917/**
918 * @brief Generic YANG data node
919 */
920struct lysp_node {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100921 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200922 uint16_t nodetype; /**< type of the node (mandatory) */
923 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100924 struct lysp_node *next; /**< next sibling node (NULL if there is no one) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200925 const char *name; /**< node name (mandatory) */
926 const char *dsc; /**< description statement */
927 const char *ref; /**< reference statement */
928 struct lysp_when *when; /**< when statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200929 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)),
930 must be qname because of refines */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200931 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200932};
933
934/**
935 * @brief Extension structure of the lysp_node for YANG container
936 */
937struct lysp_node_container {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100938 union {
939 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
940 struct {
941 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
942 uint16_t nodetype; /**< LYS_CONTAINER */
943 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
944 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
945 const char *name; /**< node name (mandatory) */
946 const char *dsc; /**< description statement */
947 const char *ref; /**< reference statement */
948 struct lysp_when *when; /**< when statement */
949 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
950 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
951 };
952 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200953
954 /* container */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200955 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200956 const char *presence; /**< presence description */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200957 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100958 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200959 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100960 struct lysp_node_action *actions;/**< list of actions (linked list) */
961 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200962};
963
964struct lysp_node_leaf {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100965 union {
966 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
967 struct {
968 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
969 uint16_t nodetype; /**< LYS_LEAF */
970 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
971 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
972 const char *name; /**< node name (mandatory) */
973 const char *dsc; /**< description statement */
974 const char *ref; /**< reference statement */
975 struct lysp_when *when; /**< when statement */
976 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
977 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
978 };
979 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200980
981 /* leaf */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200982 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200983 struct lysp_type type; /**< type of the leaf node (mandatory) */
984 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200985 struct lysp_qname dflt; /**< default value, it may or may not be a qualified name */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200986};
987
988struct lysp_node_leaflist {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100989 union {
990 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
991 struct {
992 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
993 uint16_t nodetype; /**< LYS_LEAFLIST */
994 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
995 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
996 const char *name; /**< node name (mandatory) */
997 const char *dsc; /**< description statement */
998 const char *ref; /**< reference statement */
999 struct lysp_when *when; /**< when statement */
1000 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1001 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1002 };
1003 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001004
1005 /* leaf-list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001006 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001007 struct lysp_type type; /**< type of the leaf node (mandatory) */
1008 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001009 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)), they may or
1010 may not be qualified names */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001011 uint32_t min; /**< min-elements constraint */
1012 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1013};
1014
1015struct lysp_node_list {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001016 union {
1017 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1018 struct {
1019 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1020 uint16_t nodetype; /**< LYS_LIST */
1021 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1022 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1023 const char *name; /**< node name (mandatory) */
1024 const char *dsc; /**< description statement */
1025 const char *ref; /**< reference statement */
1026 struct lysp_when *when; /**< when statement */
1027 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1028 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1029 };
1030 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001031
1032 /* list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001033 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001034 const char *key; /**< keys specification */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001035 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001036 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001037 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001038 struct lysp_node_action *actions;/**< list of actions (linked list) */
1039 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001040 struct lysp_qname *uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001041 uint32_t min; /**< min-elements constraint */
1042 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1043};
1044
1045struct lysp_node_choice {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001046 union {
1047 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1048 struct {
1049 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1050 uint16_t nodetype; /**< LYS_CHOICE */
1051 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1052 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1053 const char *name; /**< node name (mandatory) */
1054 const char *dsc; /**< description statement */
1055 const char *ref; /**< reference statement */
1056 struct lysp_when *when; /**< when statement */
1057 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1058 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1059 };
1060 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001061
1062 /* choice */
1063 struct lysp_node *child; /**< list of data nodes (linked list) */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001064 struct lysp_qname dflt; /**< default case */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001065};
1066
1067struct lysp_node_case {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001068 union {
1069 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1070 struct {
1071 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1072 uint16_t nodetype; /**< LYS_CASE */
1073 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1074 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1075 const char *name; /**< node name (mandatory) */
1076 const char *dsc; /**< description statement */
1077 const char *ref; /**< reference statement */
1078 struct lysp_when *when; /**< when statement */
1079 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1080 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1081 };
1082 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001083
1084 /* case */
1085 struct lysp_node *child; /**< list of data nodes (linked list) */
1086};
1087
1088struct lysp_node_anydata {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001089 union {
1090 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1091 struct {
1092 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1093 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1094 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1095 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1096 const char *name; /**< node name (mandatory) */
1097 const char *dsc; /**< description statement */
1098 const char *ref; /**< reference statement */
1099 struct lysp_when *when; /**< when statement */
1100 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1101 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1102 };
1103 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001104
1105 /* anyxml/anydata */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001106 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001107};
1108
1109struct lysp_node_uses {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001110 union {
1111 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1112 struct {
1113 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1114 uint16_t nodetype; /**< LYS_USES */
1115 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1116 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1117 const char *name; /**< grouping name reference (mandatory) */
1118 const char *dsc; /**< description statement */
1119 const char *ref; /**< reference statement */
1120 struct lysp_when *when; /**< when statement */
1121 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1122 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1123 };
1124 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001125
1126 /* uses */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001127 struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001128 struct lysp_node_augment *augments; /**< list of augments (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001129};
1130
1131/**
1132 * @brief YANG input-stmt and output-stmt
1133 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001134struct lysp_node_action_inout {
1135 union {
1136 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1137 struct {
1138 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1139 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1140 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1141 struct lysp_node *next; /**< NULL */
1142 const char *name; /**< empty string */
1143 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1144 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1145 struct lysp_when *when; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1146 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1147 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1148 };
1149 }; /**< common part corresponding to ::lysp_node */
1150
1151 /* inout */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001152 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1153 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001154 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001155 struct lysp_node *data; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001156};
1157
1158/**
1159 * @brief YANG rpc-stmt and action-stmt
1160 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001161struct lysp_node_action {
1162 union {
1163 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1164 struct {
1165 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1166 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1167 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1168 struct lysp_node_action *next; /**< pointer to the next action (NULL if there is no one) */
1169 const char *name; /**< grouping name reference (mandatory) */
1170 const char *dsc; /**< description statement */
1171 const char *ref; /**< reference statement */
1172 struct lysp_when *when; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1173 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1174 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1175 };
1176 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001177
1178 /* action */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001179 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1180 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
1181
1182 struct lysp_node_action_inout input; /**< RPC's/Action's input */
1183 struct lysp_node_action_inout output; /**< RPC's/Action's output */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001184};
1185
1186/**
1187 * @brief YANG notification-stmt
1188 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001189struct lysp_node_notif {
1190 union {
1191 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1192 struct {
1193 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1194 uint16_t nodetype; /**< LYS_NOTIF */
1195 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1196 struct lysp_node_notif *next; /**< pointer to the next notification (NULL if there is no one) */
1197 const char *name; /**< grouping name reference (mandatory) */
1198 const char *dsc; /**< description statement */
1199 const char *ref; /**< reference statement */
1200 struct lysp_when *when; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1201 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1202 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1203 };
1204 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001205
1206 /* notif */
1207 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001208 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1209 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001210 struct lysp_node *data; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001211};
1212
1213/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001214 * @brief YANG grouping-stmt
1215 */
1216struct lysp_node_grp {
1217 union {
1218 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1219 struct {
1220 struct lysp_node *parent;/**< parent node (NULL if this is a top-level grouping) */
1221 uint16_t nodetype; /**< LYS_GROUPING */
1222 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1223 struct lysp_node_grp *next; /**< pointer to the next grouping (NULL if there is no one) */
1224 const char *name; /**< grouping name (mandatory) */
1225 const char *dsc; /**< description statement */
1226 const char *ref; /**< reference statement */
1227 struct lysp_when *when; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1228 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1229 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1230 };
1231 }; /**< common part corresponding to ::lysp_node */
1232
1233 /* grp */
1234 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1235 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
1236 struct lysp_node *data; /**< list of data nodes (linked list) */
1237 struct lysp_node_action *actions; /**< list of actions (linked list) */
1238 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1239};
1240
1241/**
1242 * @brief YANG uses-augment-stmt and augment-stmt (compatible with struct lysp_node )
1243 */
1244struct lysp_node_augment {
1245 union {
1246 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1247 struct {
1248 struct lysp_node *parent;/**< parent node (NULL if this is a top-level augment) */
1249 uint16_t nodetype; /**< LYS_AUGMENT */
1250 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1251 struct lysp_node_augment *next; /**< pointer to the next augment (NULL if there is no one) */
1252 const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */
1253 const char *dsc; /**< description statement */
1254 const char *ref; /**< reference statement */
1255 struct lysp_when *when; /**< when statement */
1256 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1257 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1258 };
1259 }; /**< common part corresponding to ::lysp_node */
1260
1261 struct lysp_node *child; /**< list of data nodes (linked list) */
1262 struct lysp_node_action *actions;/**< list of actions (linked list) */
1263 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1264};
1265
1266/**
Radek Krejcif0fceb62018-09-05 14:58:45 +02001267 * @brief supported YANG schema version values
1268 */
1269typedef enum LYS_VERSION {
1270 LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */
Radek Krejci96e48da2020-09-04 13:18:06 +02001271 LYS_VERSION_1_0 = 1, /**< YANG 1 (1.0) */
Radek Krejcif0fceb62018-09-05 14:58:45 +02001272 LYS_VERSION_1_1 = 2 /**< YANG 1.1 */
1273} LYS_VERSION;
1274
1275/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001276 * @brief Printable YANG schema tree structure representing YANG module.
1277 *
1278 * Simple structure corresponding to the YANG format. The schema is only syntactically validated.
1279 */
1280struct lysp_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001281 struct lys_module *mod; /**< covering module structure */
1282
Radek Krejcib7db73a2018-10-24 14:18:40 +02001283 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1284 in the list is always the last (newest) revision of the module */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001285 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1286 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001287 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1288 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1289 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1290 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001291 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001292 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001293 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1294 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1295 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001296 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001297 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001298
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001299 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001300 uint8_t parsing : 1; /**< flag for circular check */
1301 uint8_t is_submod : 1; /**< always 0 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001302};
1303
1304struct lysp_submodule {
Michal Vaskoc3781c32020-10-06 14:04:08 +02001305 struct lys_module *mod; /**< belongs to parent module (submodule - mandatory) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001306
1307 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1308 in the list is always the last (newest) revision of the module */
1309 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1310 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
1311 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1312 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1313 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1314 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001315 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001316 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001317 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1318 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1319 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001320 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001321 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001322
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001323 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001324 uint8_t parsing : 1; /**< flag for circular check */
1325 uint8_t is_submod : 1; /**< always 1 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001326
Michal Vaskoc3781c32020-10-06 14:04:08 +02001327 uint8_t latest_revision : 2; /**< flag to mark the latest available revision:
Radek Krejci086c7132018-10-26 15:29:04 +02001328 1 - the latest revision in searchdirs was not searched yet and this is the
1329 latest revision in the current context
1330 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001331 const char *name; /**< name of the module (mandatory) */
1332 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1333 const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */
1334 const char *org; /**< party/company responsible for the module */
1335 const char *contact; /**< contact information for the module */
1336 const char *dsc; /**< description of the module */
1337 const char *ref; /**< cross-reference for the module */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001338};
1339
1340/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001341 * @brief Get the parsed module or submodule name.
1342 *
1343 * @param[in] PMOD Parsed module or submodule.
1344 * @return Module or submodule name.
1345 */
1346#define LYSP_MODULE_NAME(PMOD) (PMOD->is_submod ? ((struct lysp_submodule *)PMOD)->name : ((struct lysp_module *)PMOD)->mod->name)
1347
1348/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001349 * @brief Compiled prefix data pair mapping of prefixes to modules. In case the format is ::LY_PREF_SCHEMA_RESOLVED,
1350 * the expected prefix data is a sized array of these structures.
1351 */
1352struct lysc_prefix {
1353 char *prefix; /**< used prefix */
1354 const struct lys_module *mod; /**< mapping to a module */
1355};
1356
1357/**
Radek Krejci0e59c312019-08-15 15:34:15 +02001358 * @brief Compiled YANG extension-stmt
1359 */
1360struct lysc_ext {
1361 const char *name; /**< extension name */
1362 const char *argument; /**< argument name, NULL if not specified */
Radek Krejci0e59c312019-08-15 15:34:15 +02001363 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1364 struct lyext_plugin *plugin; /**< Plugin implementing the specific extension */
Radek Krejci0935f412019-08-20 16:15:18 +02001365 struct lys_module *module; /**< module structure */
Michal Vasko6f4cbb62020-02-28 11:15:47 +01001366 uint32_t refcount; /**< reference counter since extension definition is shared among all its instances */
Radek Krejci0e59c312019-08-15 15:34:15 +02001367 uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */
1368};
1369
1370/**
Radek Krejcice8c1592018-10-29 15:35:51 +01001371 * @brief YANG extension instance
1372 */
1373struct lysc_ext_instance {
Radek Krejciad5963b2019-09-06 16:03:05 +02001374 uint32_t insubstmt_index; /**< in case the instance is in a substatement that can appear multiple times,
1375 this identifies the index of the substatement for this extension instance */
Radek Krejci28681fa2019-09-06 13:08:45 +02001376 struct lys_module *module; /**< module where the extension instantiated is defined */
Radek Krejciad5963b2019-09-06 16:03:05 +02001377 struct lysc_ext *def; /**< pointer to the extension definition */
Radek Krejcice8c1592018-10-29 15:35:51 +01001378 void *parent; /**< pointer to the parent element holding the extension instance(s), use
1379 ::lysc_ext_instance#parent_type to access the schema element */
1380 const char *argument; /**< optional value of the extension's argument */
1381 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Radek Krejci2a408df2018-10-29 16:32:26 +01001382 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001383 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0e59c312019-08-15 15:34:15 +02001384 void *data; /**< private plugins's data, not used by libyang */
Radek Krejcice8c1592018-10-29 15:35:51 +01001385};
1386
1387/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001388 * @brief YANG when-stmt
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001389 */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001390struct lysc_when {
1391 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko175012e2019-11-06 15:49:14 +01001392 struct lysc_node *context; /**< context node for evaluating the expression, NULL if the context is root node */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001393 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001394 const char *dsc; /**< description */
1395 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001396 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00b874b2019-02-12 10:54:50 +01001397 uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */
Michal Vaskoecd62de2019-11-13 12:35:11 +01001398 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS is allowed */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001399};
1400
1401/**
Radek Krejci2a408df2018-10-29 16:32:26 +01001402 * @brief YANG identity-stmt
1403 */
1404struct lysc_ident {
1405 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejcic8b31002019-01-08 10:24:45 +01001406 const char *dsc; /**< description */
1407 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001408 struct lys_module *module; /**< module structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001409 struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */
1410 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1411 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
1412};
1413
1414/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001415 * @defgroup ifftokens if-feature expression tokens
Radek Krejci8678fa42020-08-18 16:07:28 +02001416 * Tokens of if-feature expression used in ::lysc_iffeature.expr.
Radek Krejci151a5b72018-10-19 14:21:44 +02001417 *
1418 * @{
1419 */
1420#define LYS_IFF_NOT 0x00 /**< operand "not" */
1421#define LYS_IFF_AND 0x01 /**< operand "and" */
1422#define LYS_IFF_OR 0x02 /**< operand "or" */
1423#define LYS_IFF_F 0x03 /**< feature */
Radek Krejci2ff0d572020-05-21 15:27:28 +02001424/** @} ifftokens */
Radek Krejci151a5b72018-10-19 14:21:44 +02001425
1426/**
Radek Krejcib7db73a2018-10-24 14:18:40 +02001427 * @brief Compiled YANG revision statement
1428 */
1429struct lysc_revision {
1430 char date[LY_REV_SIZE]; /**< revision-date (mandatory) */
1431 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1432};
1433
Radek Krejci2167ee12018-11-02 16:09:07 +01001434struct lysc_range {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001435 struct lysc_range_part {
Radek Krejci693262f2019-04-29 15:23:20 +02001436 union { /**< min boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001437 int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1438 uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001439 };
Radek Krejci693262f2019-04-29 15:23:20 +02001440 union { /**< max boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001441 int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1442 uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001443 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001444 } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001445 const char *dsc; /**< description */
1446 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001447 const char *emsg; /**< error-message */
1448 const char *eapptag; /**< error-app-tag value */
1449 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1450};
1451
1452struct lysc_pattern {
Radek Krejci54579462019-04-30 12:47:06 +02001453 const char *expr; /**< original, not compiled, regular expression */
1454 pcre2_code *code; /**< compiled regular expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001455 const char *dsc; /**< description */
1456 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001457 const char *emsg; /**< error-message */
1458 const char *eapptag; /**< error-app-tag value */
1459 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0f969882020-08-21 16:56:47 +02001460 uint32_t inverted : 1; /**< invert-match flag */
1461 uint32_t refcount : 31; /**< reference counter */
Radek Krejci2167ee12018-11-02 16:09:07 +01001462};
1463
1464struct lysc_must {
Radek Krejci2167ee12018-11-02 16:09:07 +01001465 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001466 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001467 const char *dsc; /**< description */
1468 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001469 const char *emsg; /**< error-message */
1470 const char *eapptag; /**< error-app-tag value */
1471 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1472};
1473
1474struct lysc_type {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001475 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001476 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 +01001477 LY_DATA_TYPE basetype; /**< Base type of the type */
1478 uint32_t refcount; /**< reference counter for type sharing */
1479};
1480
1481struct lysc_type_num {
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 struct lysc_range *range; /**< Optional range limitation */
1487};
1488
1489struct lysc_type_dec {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001490 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001491 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 +01001492 LY_DATA_TYPE basetype; /**< Base type of the type */
1493 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci6cba4292018-11-15 17:33:29 +01001494 uint8_t fraction_digits; /**< fraction digits specification */
Radek Krejci2167ee12018-11-02 16:09:07 +01001495 struct lysc_range *range; /**< Optional range limitation */
1496};
1497
1498struct lysc_type_str {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001499 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001500 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 +01001501 LY_DATA_TYPE basetype; /**< Base type of the type */
1502 uint32_t refcount; /**< reference counter for type sharing */
1503 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci4586a022018-11-13 11:29:26 +01001504 struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001505};
1506
Radek Krejci693262f2019-04-29 15:23:20 +02001507struct lysc_type_bitenum_item {
1508 const char *name; /**< enumeration identifier */
1509 const char *dsc; /**< description */
1510 const char *ref; /**< reference */
1511 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci693262f2019-04-29 15:23:20 +02001512 union {
1513 int32_t value; /**< integer value associated with the enumeration */
1514 uint32_t position; /**< non-negative integer value associated with the bit */
1515 };
1516 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
1517 values are allowed */
1518};
1519
Radek Krejci2167ee12018-11-02 16:09:07 +01001520struct lysc_type_enum {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001521 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001522 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 +01001523 LY_DATA_TYPE basetype; /**< Base type of the type */
1524 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci693262f2019-04-29 15:23:20 +02001525 struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1526};
1527
1528struct lysc_type_bits {
1529 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001530 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 +02001531 LY_DATA_TYPE basetype; /**< Base type of the type */
1532 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci849a62a2019-05-22 15:29:05 +02001533 struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item),
1534 the items are ordered by their position value. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001535};
1536
1537struct lysc_type_leafref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001538 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001539 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 +01001540 LY_DATA_TYPE basetype; /**< Base type of the type */
1541 uint32_t refcount; /**< reference counter for type sharing */
Michal Vasko004d3152020-06-11 19:59:22 +02001542 struct lyxp_expr *path; /**< parsed target path, compiled path cannot be stored because of type sharing */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001543 struct lysc_prefix *prefixes; /**< resolved prefixes used in the path */
Michal Vaskoc0792ca2020-12-01 12:03:21 +01001544 const struct lys_module *cur_mod;/**< current module for the leafref (path) */
Radek Krejci412ddfa2018-11-23 11:44:11 +01001545 struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001546 uint8_t require_instance; /**< require-instance flag */
1547};
1548
1549struct lysc_type_identityref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001550 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001551 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 +01001552 LY_DATA_TYPE basetype; /**< Base type of the type */
1553 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci555cb5b2018-11-16 14:54:33 +01001554 struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)),
Radek Krejci2167ee12018-11-02 16:09:07 +01001555 mandatory (at least 1 item) */
1556};
1557
1558struct lysc_type_instanceid {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001559 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001560 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 +01001561 LY_DATA_TYPE basetype; /**< Base type of the type */
1562 uint32_t refcount; /**< reference counter for type sharing */
1563 uint8_t require_instance; /**< require-instance flag */
1564};
1565
Radek Krejci2167ee12018-11-02 16:09:07 +01001566struct lysc_type_union {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001567 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001568 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 +01001569 LY_DATA_TYPE basetype; /**< Base type of the type */
1570 uint32_t refcount; /**< reference counter for type sharing */
1571 struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1572};
1573
1574struct lysc_type_bin {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001575 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001576 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 +01001577 LY_DATA_TYPE basetype; /**< Base type of the type */
1578 uint32_t refcount; /**< reference counter for type sharing */
1579 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001580};
1581
Michal Vasko60ea6352020-06-29 13:39:39 +02001582/**
1583 * @brief Maximum number of hashes stored in a schema node.
1584 */
1585#define LYS_NODE_HASH_COUNT 4
1586
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001587/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001588 * @brief Compiled YANG data node
1589 */
1590struct lysc_node {
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001591 uint16_t nodetype; /**< type of the node (mandatory) */
1592 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Michal Vasko60ea6352020-06-29 13:39:39 +02001593 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001594 struct lys_module *module; /**< module structure */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001595 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1596 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1597 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1598 never NULL. If there is no sibling node, pointer points to the node
1599 itself. In case of the first node, this pointer points to the last
1600 node in the list. */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001601 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001602 const char *dsc; /**< description */
1603 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001604 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001605 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Michal Vasko2fd91b92020-07-17 16:39:02 +02001606 void *priv; /**< private arbitrary user data, not used by libyang */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001607};
1608
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001609struct lysc_node_action_inout {
1610 union {
1611 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1612 struct {
1613 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1614 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1615 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1616 struct lys_module *module; /**< module structure */
1617 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1618 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1619 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001620 never NULL. If there is no sibling node, pointer points to the node
1621 itself. In case of the first node, this pointer points to the last
1622 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001623 const char *name; /**< Notification name (mandatory) */
1624 const char *dsc; /**< description */
1625 const char *ref; /**< reference */
1626 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1627 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
1628 void *priv; /** private arbitrary user data, not used by libyang */
1629 };
1630 };
1631
1632 struct lysc_node *data; /**< first child node (linked list) */
1633 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1634};
1635
1636struct lysc_node_action {
1637 union {
1638 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1639 struct {
1640 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1641 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1642 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1643 struct lys_module *module; /**< module structure */
1644 struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */
1645 struct lysc_node_action *next; /**< next sibling node (NULL if there is no one) */
1646 struct lysc_node_action *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1647 never NULL. If there is no sibling node, pointer points to the node
1648 itself. In case of the first node, this pointer points to the last
1649 node in the list. */
1650 const char *name; /**< action/RPC name (mandatory) */
1651 const char *dsc; /**< description */
1652 const char *ref; /**< reference */
1653 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1654 struct lysc_when **when; /**< ALWAYS NULL, compatibility member with ::lysc_node */
1655 void *priv; /** private arbitrary user data, not used by libyang */
1656 };
1657 };
1658
1659 struct lysc_node_action_inout input; /**< RPC's/action's input */
1660 struct lysc_node_action_inout output; /**< RPC's/action's output */
1661
1662};
1663
1664struct lysc_node_notif {
1665 union {
1666 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1667 struct {
1668 uint16_t nodetype; /**< LYS_NOTIF */
1669 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1670 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1671 struct lys_module *module; /**< module structure */
1672 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1673 struct lysc_node_notif *next; /**< next sibling node (NULL if there is no one) */
1674 struct lysc_node_notif *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1675 never NULL. If there is no sibling node, pointer points to the node
1676 itself. In case of the first node, this pointer points to the last
1677 node in the list. */
1678 const char *name; /**< Notification name (mandatory) */
1679 const char *dsc; /**< description */
1680 const char *ref; /**< reference */
1681 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1682 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
1683 void *priv; /** private arbitrary user data, not used by libyang */
1684 };
1685 };
1686
1687 struct lysc_node *data; /**< first child node (linked list) */
1688 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1689};
1690
1691struct lysc_node_container {
1692 union {
1693 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1694 struct {
1695 uint16_t nodetype; /**< LYS_CONTAINER */
1696 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1697 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1698 struct lys_module *module; /**< module structure */
1699 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1700 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1701 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1702 never NULL. If there is no sibling node, pointer points to the node
1703 itself. In case of the first node, this pointer points to the last
1704 node in the list. */
1705 const char *name; /**< node name (mandatory) */
1706 const char *dsc; /**< description */
1707 const char *ref; /**< reference */
1708 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1709 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
1710 void *priv; /**< private arbitrary user data, not used by libyang */
1711 };
1712 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001713
1714 struct lysc_node *child; /**< first child node (linked list) */
1715 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001716 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1717 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001718};
1719
Radek Krejcia3045382018-11-22 14:30:31 +01001720struct lysc_node_case {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001721 union {
1722 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1723 struct {
1724 uint16_t nodetype; /**< LYS_CASE */
1725 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1726 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1727 struct lys_module *module; /**< module structure */
1728 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1729 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1730 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejci056d0a82018-12-06 16:57:25 +01001731 never NULL. If there is no sibling node, pointer points to the node
1732 itself. In case of the first node, this pointer points to the last
1733 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001734 const char *name; /**< name of the case, including the implicit case */
1735 const char *dsc; /**< description */
1736 const char *ref; /**< reference */
1737 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1738 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
1739 void *priv; /**< private arbitrary user data, not used by libyang */
1740 };
1741 };
Radek Krejci056d0a82018-12-06 16:57:25 +01001742
Radek Krejcia3045382018-11-22 14:30:31 +01001743 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 +01001744 each other as siblings with the parent pointer pointing to appropriate case node. */
Radek Krejcia3045382018-11-22 14:30:31 +01001745};
1746
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001747struct lysc_node_choice {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001748 union {
1749 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1750 struct {
1751 uint16_t nodetype; /**< LYS_CHOICE */
1752 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1753 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1754 struct lys_module *module; /**< module structure */
1755 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1756 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1757 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001758 never NULL. If there is no sibling node, pointer points to the node
1759 itself. In case of the first node, this pointer points to the last
1760 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001761 const char *name; /**< node name (mandatory) */
1762 const char *dsc; /**< description */
1763 const char *ref; /**< reference */
1764 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1765 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
1766 void *priv; /**< private arbitrary user data, not used by libyang */
1767 };
1768 };
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001769
Radek Krejcia9026eb2018-12-12 16:04:47 +01001770 struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other
1771 as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the
1772 case is simple. */
Radek Krejci056d0a82018-12-06 16:57:25 +01001773 struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001774};
1775
1776struct lysc_node_leaf {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001777 union {
1778 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1779 struct {
1780 uint16_t nodetype; /**< LYS_LEAF */
1781 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1782 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1783 struct lys_module *module; /**< module structure */
1784 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1785 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1786 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001787 never NULL. If there is no sibling node, pointer points to the node
1788 itself. In case of the first node, this pointer points to the last
1789 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001790 const char *name; /**< node name (mandatory) */
1791 const char *dsc; /**< description */
1792 const char *ref; /**< reference */
1793 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1794 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
1795 void *priv; /**< private arbitrary user data, not used by libyang */
1796 };
1797 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001798
1799 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1800 struct lysc_type *type; /**< type of the leaf node (mandatory) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001801
Radek Krejci4f28eda2018-11-12 11:46:16 +01001802 const char *units; /**< units of the leaf's type */
Radek Krejcia1911222019-07-22 17:24:50 +02001803 struct lyd_value *dflt; /**< default value */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001804};
1805
1806struct lysc_node_leaflist {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001807 union {
1808 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1809 struct {
1810 uint16_t nodetype; /**< LYS_LEAFLIST */
1811 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1812 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1813 struct lys_module *module; /**< module structure */
1814 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1815 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1816 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001817 never NULL. If there is no sibling node, pointer points to the node
1818 itself. In case of the first node, this pointer points to the last
1819 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001820 const char *name; /**< node name (mandatory) */
1821 const char *dsc; /**< description */
1822 const char *ref; /**< reference */
1823 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1824 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
1825 void *priv; /**< private arbitrary user data, not used by libyang */
1826 };
1827 };
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001828
1829 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1830 struct lysc_type *type; /**< type of the leaf node (mandatory) */
1831
Radek Krejci0e5d8382018-11-28 16:37:53 +01001832 const char *units; /**< units of the leaf's type */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001833 struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */
Michal Vaskoba99a3e2020-08-18 15:50:05 +02001834
Radek Krejci0e5d8382018-11-28 16:37:53 +01001835 uint32_t min; /**< min-elements constraint */
1836 uint32_t max; /**< max-elements constraint */
1837
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001838};
1839
1840struct lysc_node_list {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001841 union {
1842 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1843 struct {
1844 uint16_t nodetype; /**< LYS_LIST */
1845 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1846 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1847 struct lys_module *module; /**< module structure */
1848 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1849 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1850 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001851 never NULL. If there is no sibling node, pointer points to the node
1852 itself. In case of the first node, this pointer points to the last
1853 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001854 const char *name; /**< node name (mandatory) */
1855 const char *dsc; /**< description */
1856 const char *ref; /**< reference */
1857 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1858 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
1859 void *priv; /**< private arbitrary user data, not used by libyang */
1860 };
1861 };
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001862
1863 struct lysc_node *child; /**< first child node (linked list) */
1864 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001865 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1866 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001867
Radek Krejci2a9fc652021-01-22 17:44:34 +01001868 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 +01001869 uint32_t min; /**< min-elements constraint */
1870 uint32_t max; /**< max-elements constraint */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001871};
1872
1873struct lysc_node_anydata {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001874 union {
1875 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1876 struct {
1877 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1878 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1879 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1880 struct lys_module *module; /**< module structure */
1881 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1882 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1883 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001884 never NULL. If there is no sibling node, pointer points to the node
1885 itself. In case of the first node, this pointer points to the last
1886 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001887 const char *name; /**< node name (mandatory) */
1888 const char *dsc; /**< description */
1889 const char *ref; /**< reference */
1890 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1891 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
1892 void *priv; /**< private arbitrary user data, not used by libyang */
1893 };
1894 };
Radek Krejci9800fb82018-12-13 14:26:23 +01001895
1896 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001897};
1898
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001899/**
1900 * @brief Compiled YANG schema tree structure representing YANG module.
1901 *
1902 * Semantically validated YANG schema tree for data tree parsing.
1903 * Contains only the necessary information for the data validation.
1904 */
1905struct lysc_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001906 struct lys_module *mod; /**< covering module structure */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001907
Radek Krejci2a408df2018-10-29 16:32:26 +01001908 struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001909 struct lysc_node_action *rpcs; /**< first of actions nodes (linked list) */
1910 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001911 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001912};
1913
1914/**
Radek Krejci490a5462020-11-05 08:44:42 +01001915 * @brief Examine whether a node is user-ordered list or leaf-list.
1916 *
1917 * @param[in] lysc_node Schema node to examine.
1918 * @return Boolean value whether the @p node is user-ordered or not.
1919 */
1920#define lysc_is_userordered(lysc_node) \
1921 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAFLIST | LYS_LIST)) || !(lysc_node->flags & LYS_ORDBY_USER)) ? 0 : 1)
1922
1923/**
1924 * @brief Examine whether a node is a list's key.
1925 *
1926 * @param[in] lysc_node Schema node to examine.
1927 * @return Boolean value whether the @p node is a key or not.
1928 */
1929#define lysc_is_key(lysc_node) \
1930 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAF)) || !(lysc_node->flags & LYS_KEY)) ? 0 : 1)
1931
1932/**
Michal Vasko5c123b02020-12-04 14:34:04 +01001933 * @brief Examine whether a node is a non-presence container.
1934 *
1935 * @param[in] lysc_node Schema node to examine.
1936 * @return Boolean value whether the @p node is a NP container or not.
1937 */
1938#define lysc_is_np_cont(lysc_node) \
1939 ((!lysc_node || !(lysc_node->nodetype & (LYS_CONTAINER)) || (lysc_node->flags & LYS_PRESENCE)) ? 0 : 1)
1940
1941/**
Michal Vaskod5cfa6e2020-11-23 16:56:08 +01001942 * @brief Check whether the schema node data instance existence depends on any when conditions.
1943 * This node and any direct parent choice and case schema nodes are also examined for when conditions.
1944 *
1945 * Be careful, this function is not recursive and checks only conditions that apply to this node directly.
1946 * Meaning if there are any conditions associated with any data parent instance of @p node, they are not returned.
1947 *
1948 * @param[in] node Schema node to examine.
1949 * @return When condition associated with the node data instance, NULL if there is none.
1950 */
1951const struct lysc_when *lysc_has_when(const struct lysc_node *node);
1952
1953/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001954 * @brief Get the groupings linked list of the given (parsed) schema node.
Radek Krejci53ea6152018-12-13 15:21:15 +01001955 * Decides the node's type and in case it has a groupings array, returns it.
1956 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001957 * @return The node's groupings linked list if any, NULL otherwise.
Radek Krejci53ea6152018-12-13 15:21:15 +01001958 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001959const struct lysp_node_grp *lysp_node_groupings(const struct lysp_node *node);
Radek Krejci53ea6152018-12-13 15:21:15 +01001960
1961/**
Radek Krejci056d0a82018-12-06 16:57:25 +01001962 * @brief Get the typedefs sized array of the given (parsed) schema node.
1963 * Decides the node's type and in case it has a typedefs array, returns it.
1964 * @param[in] node Node to examine.
1965 * @return The node's typedefs sized array if any, NULL otherwise.
1966 */
1967const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
1968
1969/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001970 * @brief Get the actions/RPCs linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001971 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1972 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001973 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01001974 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001975const struct lysp_node_action *lysp_node_actions(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01001976
1977/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001978 * @brief Get the Notifications linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001979 * Decides the node's type and in case it has a Notifications array, returns it.
1980 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001981 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01001982 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001983const struct lysp_node_notif *lysp_node_notifs(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01001984
1985/**
1986 * @brief Get the children linked list of the given (parsed) schema node.
1987 * Decides the node's type and in case it has a children list, returns it.
1988 * @param[in] node Node to examine.
1989 * @return The node's children linked list if any, NULL otherwise.
1990 */
1991const struct lysp_node *lysp_node_children(const struct lysp_node *node);
1992
1993/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001994 * @brief Get the actions/RPCs linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001995 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1996 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001997 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01001998 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001999const struct lysc_node_action *lysc_node_actions(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002000
2001/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002002 * @brief Get the Notifications linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002003 * Decides the node's type and in case it has a Notifications array, returns it.
2004 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002005 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002006 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002007const struct lysc_node_notif *lysc_node_notifs(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002008
2009/**
2010 * @brief Get the children linked list of the given (compiled) schema node.
Michal Vasko2a668712020-10-21 11:48:09 +02002011 *
2012 * @param[in] node Node to examine.
2013 * @param[in] flags Config flag to distinguish input (LYS_CONFIG_W) and output (LYS_CONFIG_R) child in case of RPC/action node.
2014 * @return Children linked list if any,
2015 * @return NULL otherwise.
2016 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002017const struct lysc_node *lysc_node_children(const struct lysc_node *node, uint16_t flags);
Michal Vasko2a668712020-10-21 11:48:09 +02002018
2019/**
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002020 * @brief Callback to be called for every schema node in a DFS traversal.
2021 *
2022 * @param[in] node Current node.
2023 * @param[in] data Arbitrary user data.
2024 * @param[out] dfs_continue Set to true if the current subtree should be skipped and continue with siblings instead.
2025 * @return LY_SUCCESS on success,
2026 * @return LY_ERR value to terminate DFS and return this value.
2027 */
2028typedef LY_ERR (*lysc_dfs_clb)(struct lysc_node *node, void *data, ly_bool *dfs_continue);
2029
2030/**
2031 * @brief DFS traversal of all the schema nodes in a (sub)tree including any actions and nested notifications.
2032 *
2033 * Node with children, actions, and notifications is traversed in this order:
2034 * 1) each child subtree;
2035 * 2) each action subtree;
2036 * 3) each notification subtree.
2037 *
2038 * For algorithm illustration or traversal with actions and notifications skipped, see ::LYSC_TREE_DFS_BEGIN.
2039 *
2040 * @param[in] root Schema root to fully traverse.
2041 * @param[in] dfs_clb Callback to call for each node.
2042 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2043 * @return LY_SUCCESS on success,
2044 * @return LY_ERR value returned by @p dfs_clb.
2045 */
2046LY_ERR lysc_tree_dfs_full(const struct lysc_node *root, lysc_dfs_clb dfs_clb, void *data);
2047
2048/**
2049 * @brief DFS traversal of all the schema nodes in a module including RPCs and notifications.
2050 *
2051 * For more details, see ::lysc_tree_dfs_full().
2052 *
2053 * @param[in] mod Module to fully traverse.
2054 * @param[in] dfs_clb Callback to call for each node.
2055 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2056 * @return LY_SUCCESS on success,
2057 * @return LY_ERR value returned by @p dfs_clb.
2058 */
2059LY_ERR lysc_module_dfs_full(const struct lys_module *mod, lysc_dfs_clb dfs_clb, void *data);
2060
2061/**
Michal Vasko2fd91b92020-07-17 16:39:02 +02002062 * @brief Set a schema private pointer to a user pointer.
2063 *
2064 * @param[in] node Node, whose private field will be assigned. Works also for RPCs, actions, and notifications.
2065 * @param[in] priv Arbitrary user-specified pointer.
Radek Krejciaf9cd802020-10-06 21:59:47 +02002066 * @param[out] prev_priv_p Optional previous private object of the \p node. Note, that
Michal Vasko2fd91b92020-07-17 16:39:02 +02002067 * the caller is in this case responsible (if it is necessary) for freeing the replaced private object.
2068 * @return LY_ERR value.
2069 */
Radek Krejciaf9cd802020-10-06 21:59:47 +02002070LY_ERR lysc_set_private(const struct lysc_node *node, void *priv, void **prev_priv_p);
Michal Vasko2fd91b92020-07-17 16:39:02 +02002071
2072/**
Radek Krejci151a5b72018-10-19 14:21:44 +02002073 * @brief Get how the if-feature statement currently evaluates.
2074 *
2075 * @param[in] iff Compiled if-feature statement to evaluate.
Michal Vasko28d78432020-05-26 13:10:53 +02002076 * @return LY_SUCCESS if the statement evaluates to true,
2077 * @return LY_ENOT if it evaluates to false,
2078 * @return LY_ERR on error.
Radek Krejci151a5b72018-10-19 14:21:44 +02002079 */
Michal Vasko28d78432020-05-26 13:10:53 +02002080LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff);
Radek Krejci151a5b72018-10-19 14:21:44 +02002081
2082/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002083 * @brief Get the next feature in the module or submodules.
Radek Krejci151a5b72018-10-19 14:21:44 +02002084 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002085 * @param[in] last Last returned feature.
2086 * @param[in] pmod Parsed module and submodoules whose features to iterate over.
2087 * @param[in,out] idx Submodule index, set to 0 on first call.
2088 * @return Next found feature, NULL if the last has already been returned.
Radek Krejci151a5b72018-10-19 14:21:44 +02002089 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002090struct 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 +02002091
Radek Krejcibed13942020-10-19 16:06:28 +02002092/**
2093 * @defgroup findxpathoptions Atomize XPath options
2094 * Options to modify behavior of ::lys_find_xpath() and ::lys_find_xpath_atoms() searching for schema nodes in schema tree.
2095 * @{
2096 */
Michal Vaskocdad7122020-11-09 21:04:44 +01002097#define LYS_FIND_XP_SCHEMA 0x08 /**< Apply node access restrictions defined for 'when' and 'must' evaluation. */
2098#define LYS_FIND_XP_OUTPUT 0x10 /**< Search RPC/action output nodes instead of input ones. */
Radek Krejci576f8fa2020-10-26 21:23:58 +01002099/** @} findxpathoptions */
Michal Vasko072de482020-08-05 13:27:21 +02002100
Radek Krejci151a5b72018-10-19 14:21:44 +02002101/**
Michal Vasko40308e72020-10-20 16:38:40 +02002102 * @brief Get all the schema nodes that are required for @p xpath to be evaluated (atoms).
Michal Vasko519fd602020-05-26 12:17:39 +02002103 *
Michal Vasko26512682021-01-11 11:35:40 +01002104 * @param[in] ctx libyang context to use. May be NULL if @p ctx_node is set.
2105 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002106 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002107 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko519fd602020-05-26 12:17:39 +02002108 * @param[out] set Set of found atoms (schema nodes).
2109 * @return LY_SUCCESS on success, @p set is returned.
Michal Vasko40308e72020-10-20 16:38:40 +02002110 * @return LY_ERR value on error.
Michal Vasko519fd602020-05-26 12:17:39 +02002111 */
Michal Vasko26512682021-01-11 11:35:40 +01002112LY_ERR lys_find_xpath_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
2113 uint32_t options, struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002114
Michal Vasko072de482020-08-05 13:27:21 +02002115/**
Michal Vasko40308e72020-10-20 16:38:40 +02002116 * @brief Get all the schema nodes that are required for @p expr to be evaluated (atoms).
Michal Vasko072de482020-08-05 13:27:21 +02002117 *
Michal Vasko26512682021-01-11 11:35:40 +01002118 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002119 * @param[in] cur_mod Current module for the expression (where it was "instantiated").
2120 * @param[in] expr Parsed expression to use.
2121 * @param[in] prefixes Sized array of compiled prefixes.
2122 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
2123 * @param[out] set Set of found atoms (schema nodes).
2124 * @return LY_SUCCESS on success, @p set is returned.
2125 * @return LY_ERR value on error.
2126 */
2127LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod,
2128 const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set);
2129
2130/**
2131 * @brief Evaluate an @p xpath expression on schema nodes.
2132 *
Michal Vasko26512682021-01-11 11:35:40 +01002133 * @param[in] ctx libyang context to use for absolute @p xpath. May be NULL if @p ctx_node is set.
2134 * @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 +02002135 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002136 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko072de482020-08-05 13:27:21 +02002137 * @param[out] set Set of found schema nodes.
2138 * @return LY_SUCCESS on success, @p set is returned.
2139 * @return LY_ERR value if an error occurred.
2140 */
Michal Vasko26512682021-01-11 11:35:40 +01002141LY_ERR lys_find_xpath(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath, uint32_t options,
2142 struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002143
2144/**
Radek Krejcibc5644c2020-10-27 14:53:17 +01002145 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2146 *
2147 * @param[in] path Compiled path to use.
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_lypath_atoms(const struct ly_path *path, struct ly_set **set);
2153
2154/**
2155 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2156 *
Michal Vasko26512682021-01-11 11:35:40 +01002157 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2158 * @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 +01002159 * @param[in] path JSON path to examine.
2160 * @param[in] output Search operation output instead of input.
2161 * @param[out] set Set of found atoms (schema nodes).
2162 * @return LY_ERR value on error.
2163 */
2164LY_ERR lys_find_path_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path, ly_bool output,
2165 struct ly_set **set);
2166
2167/**
2168 * @brief Get a schema node based on the given data path (JSON format, see @ref howtoXPath).
2169 *
Michal Vasko26512682021-01-11 11:35:40 +01002170 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2171 * @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 +01002172 * @param[in] path JSON path of the node to get.
2173 * @param[in] output Search operation output instead of input.
2174 * @return Found schema node or NULL.
2175 */
2176const struct lysc_node *lys_find_path(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path,
2177 ly_bool output);
2178
2179/**
Michal Vasko03ff5a72019-09-11 13:49:33 +02002180 * @brief Types of the different schema paths.
2181 */
2182typedef enum {
Michal Vasko65de0402020-08-03 16:34:19 +02002183 LYSC_PATH_LOG, /**< Descriptive path format used in log messages */
2184 LYSC_PATH_DATA /**< Similar to ::LYSC_PATH_LOG except that schema-only nodes (choice, case) are skipped */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002185} LYSC_PATH_TYPE;
2186
2187/**
Radek Krejci327de162019-06-14 12:52:07 +02002188 * @brief Generate path of the given node in the requested format.
2189 *
2190 * @param[in] node Schema path of this node will be generated.
2191 * @param[in] pathtype Format of the path to generate.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002192 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
2193 * If NULL, memory for the complete path is allocated.
2194 * @param[in] buflen Size of the provided @p buffer.
Radek Krejci327de162019-06-14 12:52:07 +02002195 * @return NULL in case of memory allocation error, path of the node otherwise.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002196 * 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 +02002197 */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002198char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
Radek Krejci327de162019-06-14 12:52:07 +02002199
2200/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002201 * @brief Available YANG schema tree structures representing YANG module.
2202 */
2203struct lys_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002204 struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */
2205 const char *name; /**< name of the module (mandatory) */
Radek Krejci0af46292019-01-11 16:02:31 +01002206 const char *revision; /**< revision of the module (if present) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002207 const char *ns; /**< namespace of the module (module - mandatory) */
2208 const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */
2209 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
2210 const char *org; /**< party/company responsible for the module */
2211 const char *contact; /**< contact information for the module */
2212 const char *dsc; /**< description of the module */
2213 const char *ref; /**< cross-reference for the module */
2214
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002215 struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */
Radek Krejci0af46292019-01-11 16:02:31 +01002216 struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing.
2217 Available only for implemented modules. */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002218
Radek Krejci80d281e2020-09-14 17:42:54 +02002219 struct lysc_ident *identities; /**< List of compiled identities of the module ([sized array](@ref sizedarrays))
2220 Identities are outside the compiled tree to allow their linkage to the identities from
2221 the implemented modules. This avoids problems when the module became implemented in
2222 future (no matter if implicitly via augment/deviate or explicitly via
2223 ::lys_set_implemented()). Note that if the module is not implemented (compiled), the
2224 identities cannot be instantiated in data (in identityrefs). */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002225
2226 struct lys_module **augmented_by;/**< List of modules that augment this module ([sized array](@ref sizedarrays)) */
2227 struct lys_module **deviated_by; /**< List of modules that deviate this module ([sized array](@ref sizedarrays)) */
2228
Michal Vasko89b5c072020-10-06 13:52:44 +02002229 ly_bool implemented; /**< flag if the module is implemented, not just imported */
Radek Krejci95710c92019-02-11 15:49:55 +01002230 uint8_t latest_revision; /**< flag to mark the latest available revision:
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002231 1 - the latest revision in searchdirs was not searched yet and this is the
2232 latest revision in the current context
2233 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002234};
2235
Radek Krejci151a5b72018-10-19 14:21:44 +02002236/**
Michal Vasko82c31e62020-07-17 15:30:40 +02002237 * @brief Get the current real status of the specified feature in the module.
2238 *
2239 * If the feature is enabled, but some of its if-features are false, the feature is considered
2240 * disabled.
Radek Krejci151a5b72018-10-19 14:21:44 +02002241 *
2242 * @param[in] module Module where the feature is defined.
2243 * @param[in] feature Name of the feature to inspect.
Michal Vasko82c31e62020-07-17 15:30:40 +02002244 * @return LY_SUCCESS if the feature is enabled,
2245 * @return LY_ENOT if the feature is disabled,
2246 * @return LY_ENOTFOUND if the feature was not found.
Radek Krejci151a5b72018-10-19 14:21:44 +02002247 */
Michal Vasko82c31e62020-07-17 15:30:40 +02002248LY_ERR lys_feature_value(const struct lys_module *module, const char *feature);
Radek Krejcidd4e8d42018-10-16 14:55:43 +02002249
2250/**
Radek Krejcia3045382018-11-22 14:30:31 +01002251 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can
2252 * be from an augment.
2253 *
Radek Krejci8678fa42020-08-18 16:07:28 +02002254 * ::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 +01002255 * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module.
2256 * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
2257 * \p parent and \p module parameters.
2258 *
2259 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
2260 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
2261 * all the schema nodes are iteratively returned.
2262 *
2263 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
2264 * @param[in] parent Parent of the subtree where the function starts processing.
2265 * @param[in] module In case of iterating on top level elements, the \p parent is NULL and
2266 * module must be specified.
2267 * @param[in] options [ORed options](@ref sgetnextflags).
2268 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
2269 */
2270const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002271 const struct lysc_module *module, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002272
2273/**
Radek Krejci8678fa42020-08-18 16:07:28 +02002274 * @defgroup sgetnextflags Options for ::lys_getnext().
2275 *
2276 * Various options setting behavior of ::lys_getnext().
2277 *
Radek Krejcia3045382018-11-22 14:30:31 +01002278 * @{
2279 */
Radek Krejci8678fa42020-08-18 16:07:28 +02002280#define LYS_GETNEXT_WITHCHOICE 0x01 /**< ::lys_getnext() option to allow returning #LYS_CHOICE nodes instead of looking into them */
2281#define LYS_GETNEXT_NOCHOICE 0x02 /**< ::lys_getnext() option to ignore (kind of conditional) nodes within choice node */
2282#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 +01002283#define LYS_GETNEXT_INTONPCONT 0x08 /**< ::lys_getnext() option to look into non-presence container, instead of returning container itself */
2284#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 +01002285 provided by default */
Radek Krejcia3045382018-11-22 14:30:31 +01002286/** @} sgetnextflags */
2287
2288/**
2289 * @brief Get child node according to the specified criteria.
2290 *
2291 * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched.
2292 * @param[in] module module of the node to find. It is also limitation for the children node of the given parent.
2293 * @param[in] name Name of the node to find.
2294 * @param[in] name_len Optional length of the name in case it is not NULL-terminated string.
2295 * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find.
2296 * Used as a bitmask, so multiple nodetypes can be specified.
2297 * @param[in] options [ORed options](@ref sgetnextflags).
2298 * @return Found node if any.
2299 */
Michal Vaskoe444f752020-02-10 12:20:06 +01002300const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002301 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002302
2303/**
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002304 * @brief Make the specific module implemented.
2305 *
Michal Vaskoe8988e92021-01-25 11:26:29 +01002306 * If the module is already implemented but with a different set of features, the whole context is recompiled.
2307 *
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002308 * @param[in] mod Module to make implemented. It is not an error
2309 * to provide already implemented module, it just does nothing.
Michal Vaskoe8988e92021-01-25 11:26:29 +01002310 * @param[in] features Optional array specifying the enabled features terminated with NULL overriding any previous
2311 * feature setting. The feature string '*' enables all the features and array of length 1 with only the terminating
2312 * NULL explicitly disables all the features. In case the parameter is NULL, the features are untouched - left disabled
2313 * 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 +01002314 * @return LY_SUCCESS on success.
2315 * @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 +01002316 * @return LY_ERR on other errors during module compilation.
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002317 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002318LY_ERR lys_set_implemented(struct lys_module *mod, const char **features);
Radek Krejcia3045382018-11-22 14:30:31 +01002319
Radek Krejci084289f2019-07-09 17:35:30 +02002320/**
2321 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
2322 *
2323 * 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 +02002324 * require-instance restriction), use ::lyd_value_validate().
Radek Krejci084289f2019-07-09 17:35:30 +02002325 *
2326 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
2327 * @param[in] node Schema node for the @p value.
Michal Vaskof937cfe2020-08-03 16:07:12 +02002328 * @param[in] value String value to be checked, expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02002329 * @param[in] value_len Length of the given @p value (mandatory).
Radek Krejci084289f2019-07-09 17:35:30 +02002330 * @return LY_SUCCESS on success
2331 * @return LY_ERR value if an error occurred.
2332 */
Michal Vaskof937cfe2020-08-03 16:07:12 +02002333LY_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 +02002334
Radek Krejci0935f412019-08-20 16:15:18 +02002335/**
2336 * @brief Stringify schema nodetype.
Michal Vaskod43d71a2020-08-07 14:54:58 +02002337 *
Radek Krejci0935f412019-08-20 16:15:18 +02002338 * @param[in] nodetype Nodetype to stringify.
2339 * @return Constant string with the name of the node's type.
2340 */
2341const char *lys_nodetype2str(uint16_t nodetype);
2342
Michal Vaskod43d71a2020-08-07 14:54:58 +02002343/**
2344 * @brief Getter for original XPath expression from a parsed expression.
2345 *
2346 * @param[in] path Parsed expression.
2347 * @return Original string expression.
2348 */
2349const char *lyxp_get_expr(const struct lyxp_expr *path);
2350
Radek Krejci2ff0d572020-05-21 15:27:28 +02002351/** @} schematree */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002352
Radek Krejci70853c52018-10-15 14:46:16 +02002353#ifdef __cplusplus
2354}
2355#endif
2356
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002357#endif /* LY_TREE_SCHEMA_H_ */