blob: 2b0becb15ca8d76b76b74280fd7970c0ce85e793 [file] [log] [blame]
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001/**
2 * @file tree_schema.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief libyang representation of YANG schema trees.
5 *
6 * Copyright (c) 2015 - 2018 CESNET, z.s.p.o.
7 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_TREE_SCHEMA_H_
16#define LY_TREE_SCHEMA_H_
17
Radek Krejci54579462019-04-30 12:47:06 +020018#define PCRE2_CODE_UNIT_WIDTH 8
19
20#include <pcre2.h>
Radek Krejci535ea9f2020-05-29 16:01:05 +020021
Radek Krejci5aeea3a2018-09-05 13:29:36 +020022#include <stdint.h>
Radek Krejcid3ca0632019-04-16 16:54:54 +020023#include <stdio.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020024
Radek Krejcie7b95092019-05-15 11:03:07 +020025#include "log.h"
26#include "tree.h"
Radek Krejcice8c1592018-10-29 15:35:51 +010027
Radek Krejci70853c52018-10-15 14:46:16 +020028#ifdef __cplusplus
29extern "C" {
30#endif
31
Radek Krejcica376bd2020-06-11 16:04:06 +020032struct ly_ctx;
Radek Krejci47fab892020-11-05 17:02:41 +010033struct ly_path;
Radek Krejcica376bd2020-06-11 16:04:06 +020034struct ly_set;
Radek Krejci47fab892020-11-05 17:02:41 +010035struct lys_module;
36struct lysc_node;
37struct lyxp_expr;
Radek Krejcica376bd2020-06-11 16:04:06 +020038
Radek Krejci5aeea3a2018-09-05 13:29:36 +020039/**
Radek Krejci8678fa42020-08-18 16:07:28 +020040 * @page howtoSchema YANG Modules
41 *
42 * To be able to work with YANG data instances, libyang has to represent YANG data models. All the processed modules are stored
43 * in libyang [context](@ref howtoContext) and loaded using [parser functions](@ref howtoSchemaParsers). It means, that there is
44 * no way to create/change YANG module programmatically. However, all the YANG model definitions are available and can be examined
45 * through the C structures. All the context's modules together form YANG Schema for the data being instantiated.
46 *
47 * Any YANG module is represented as ::lys_module. In fact, the module is represented in two different formats. As ::lys_module.parsed,
48 * there is a parsed schema reflecting the source YANG module. It is exactly what is read from the input. This format is good for
49 * converting from one format to another (YANG to YIN and vice versa), but it is not very useful for validating/manipulating YANG
50 * data. Therefore, there is ::lys_module.compiled storing the compiled YANG module. It is based on the parsed module, but all the
51 * references are resolved. It means that, for example, there are no `grouping`s or `typedef`s since they are supposed to be placed instead of
52 * `uses` or `type` references. This split also means, that the YANG module is fully validated after compilation of the parsed
53 * representation of the module. YANG submodules are available only in the parsed representation. When a submodule is compiled, it
54 * is fully integrated into its main module.
55 *
56 * The context can contain even modules without the compiled representation. Such modules are still useful as imports of other
57 * modules. The grouping or typedef definition can be even compiled into the importing modules. This is actually the main
58 * difference between the imported and implemented modules in the libyang context. The implemented modules are compiled while the
59 * imported modules are only parsed.
60 *
Radek Krejcib100b192020-10-26 08:37:45 +010061 * By default, the module is implemented (and compiled) in case it is explicitly loaded or referenced in another module as
62 * target of leafref, augment or deviation. This behavior can be changed via context options ::LY_CTX_ALL_IMPLEMENTED, when
63 * all the modules in the context are marked as implemented (note the problem with multiple revisions of a single module),
64 * or by ::LY_CTX_REF_IMPLEMENTED option, extending the set of references making the module implemented by when, must and
65 * default statements.
Radek Krejci8678fa42020-08-18 16:07:28 +020066 *
67 * All modules with deviation definition are always marked as implemented. The imported (not implemented) module can be set implemented by ::lys_set_implemented(). But
68 * the implemented module cannot be changed back to just imported module. Note also that only one revision of a specific module
69 * can be implemented in a single context. The imported modules are used only as a
70 * source of definitions for types and groupings for uses statements. The data in such modules are ignored - caller
71 * is not allowed to create the data (including instantiating identities) defined in the model via data parsers,
72 * the default nodes are not added into any data tree and mandatory nodes are not checked in the data trees.
73 *
Michal Vasko14ed9cd2021-01-28 14:16:25 +010074 * The compiled schema tree nodes are able to hold private objects (::lysc_node.priv as a pointer to a structure,
75 * function, variable, ...) used by a caller application.
Radek Krejci8678fa42020-08-18 16:07:28 +020076 * Note that the object is not freed by libyang when the context is being destroyed. So the caller is responsible
77 * for freeing the provided structure after the context is destroyed or the private pointer is set to NULL in
78 * appropriate schema nodes where the object was previously set. This can be automated via destructor function
79 * to free these private objects. The destructor is passed to the ::ly_ctx_destroy() function.
80 *
81 * Despite all the schema structures and their members are available as part of the libyang API and callers can use
82 * it to navigate through the schema tree structure or to obtain various information, we recommend to use the following
83 * macros for the specific actions.
84 * - ::LYSC_TREE_DFS_BEGIN and ::LYSC_TREE_DFS_END to traverse the schema tree (depth-first).
85 * - ::LY_LIST_FOR and ::LY_ARRAY_FOR as described on @ref howtoStructures page.
86 *
87 * Further information about modules handling can be found on the following pages:
88 * - @subpage howtoSchemaParsers
89 * - @subpage howtoSchemaFeatures
90 * - @subpage howtoPlugins
91 * - @subpage howtoSchemaPrinters
92 *
93 * \note There are many functions to access information from the schema trees. Details are available in
94 * the [Schema Tree module](@ref schematree).
95 *
96 * For information about difference between implemented and imported modules, see the
97 * [context description](@ref howtoContext).
98 *
99 * Functions List (not assigned to above subsections)
100 * --------------------------------------------------
101 * - ::lys_getnext()
102 * - ::lys_nodetype2str()
103 * - ::lys_set_implemented()
104 * - ::lys_value_validate()
105 *
Michal Vaskod5cfa6e2020-11-23 16:56:08 +0100106 * - ::lysc_has_when()
107 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200108 * - ::lysc_node_children()
109 * - ::lysc_node_actions()
110 * - ::lysc_node_notifs()
111 *
112 * - ::lysp_node_children()
113 * - ::lysp_node_actions()
114 * - ::lysp_node_notifs()
115 * - ::lysp_node_groupings()
116 * - ::lysp_node_typedefs()
117 */
118
119/**
120 * @page howtoSchemaFeatures YANG Features
121 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100122 * YANG feature statement is an important part of the language which can significantly affect the meaning of the schemas.
123 * Modifying features may have similar effects as loading/removing schema from the context so it is limited to context
124 * preparation period before working with data. YANG features, respectively their use in if-feature
125 * statements, are evaluated as part of schema compilation so a feature-specific compiled schema tree is generated
126 * as a result.
Radek Krejci8678fa42020-08-18 16:07:28 +0200127 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100128 * To enable any features, they must currently be specified when implementing a new schema with ::lys_parse() or
129 * ::ly_ctx_load_module(). To later examine what the status of a feature is, check its ::LYS_FENABLED flag or
130 * search for it first with ::lys_feature_value(). Lastly, to evaluate compiled if-features, use ::lysc_iffeature_value().
Radek Krejci8678fa42020-08-18 16:07:28 +0200131 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100132 * To iterate over all features of a particular YANG module, use ::lysp_feature_next().
Radek Krejci8678fa42020-08-18 16:07:28 +0200133 *
134 * Note, that the feature's state can affect some of the output formats (e.g. Tree format).
135 *
136 * Functions List
137 * --------------
Radek Krejci8678fa42020-08-18 16:07:28 +0200138 * - ::lys_feature_value()
Radek Krejci8678fa42020-08-18 16:07:28 +0200139 * - ::lysc_iffeature_value()
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100140 * - ::lysp_feature_next()
Radek Krejci8678fa42020-08-18 16:07:28 +0200141 */
142
143/**
Radek Krejci2ff0d572020-05-21 15:27:28 +0200144 * @ingroup trees
Radek Krejci8678fa42020-08-18 16:07:28 +0200145 * @defgroup schematree Schema Tree
Radek Krejci2ff0d572020-05-21 15:27:28 +0200146 * @{
147 *
148 * Data structures and functions to manipulate and access schema tree.
149 */
150
Michal Vasko64246d82020-08-19 12:35:00 +0200151/* *INDENT-OFF* */
152
Radek Krejci2ff0d572020-05-21 15:27:28 +0200153/**
Michal Vasko208a04a2020-10-21 15:17:12 +0200154 * @brief Macro to iterate via all elements in a schema (sub)tree including input and output.
155 * Note that __actions__ and __notifications__ of traversed nodes __are ignored__! To traverse
156 * on all the nodes including those, use ::lysc_tree_dfs_full() instead.
157 *
158 * This is the opening part to the #LYSC_TREE_DFS_END - they always have to be used together.
Radek Krejci0935f412019-08-20 16:15:18 +0200159 *
160 * The function follows deep-first search algorithm:
161 * <pre>
162 * 1
163 * / \
164 * 2 4
165 * / / \
166 * 3 5 6
167 * </pre>
168 *
169 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
Radek Krejci2a9fc652021-01-22 17:44:34 +0100170 * START can be any of the lysc_node* types (including lysc_node_action and lysc_node_notif),
Radek Krejci0935f412019-08-20 16:15:18 +0200171 * ELEM variable must be of the struct lysc_node* type.
172 *
173 * To skip a particular subtree, instead of the continue statement, set LYSC_TREE_DFS_continue
174 * variable to non-zero value.
175 *
176 * Use with opening curly bracket '{' after the macro.
177 *
178 * @param START Pointer to the starting element processed first.
179 * @param ELEM Iterator intended for use in the block.
180 */
181#define LYSC_TREE_DFS_BEGIN(START, ELEM) \
Radek Krejci857189e2020-09-01 13:26:36 +0200182 { ly_bool LYSC_TREE_DFS_continue = 0; struct lysc_node *LYSC_TREE_DFS_next; \
Michal Vasko14ed9cd2021-01-28 14:16:25 +0100183 for ((ELEM) = (LYSC_TREE_DFS_next) = (struct lysc_node *)(START); \
Radek Krejci0935f412019-08-20 16:15:18 +0200184 (ELEM); \
185 (ELEM) = (LYSC_TREE_DFS_next), LYSC_TREE_DFS_continue = 0)
186
187/**
188 * @brief Macro to iterate via all elements in a (sub)tree. This is the closing part
189 * to the #LYSC_TREE_DFS_BEGIN - they always have to be used together.
190 *
191 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
Radek Krejci2a9fc652021-01-22 17:44:34 +0100192 * START can be a pointer to any of the lysc_node* types (including lysc_node_action and lysc_node_notif),
Radek Krejci0935f412019-08-20 16:15:18 +0200193 * ELEM variable must be pointer to the lysc_node type.
194 *
195 * Use with closing curly bracket '}' after the macro.
196 *
197 * @param START Pointer to the starting element processed first.
198 * @param ELEM Iterator intended for use in the block.
199 */
Radek Krejci0935f412019-08-20 16:15:18 +0200200#define LYSC_TREE_DFS_END(START, ELEM) \
201 /* select element for the next run - children first */ \
202 if (LYSC_TREE_DFS_continue) { \
203 (LYSC_TREE_DFS_next) = NULL; \
204 } else { \
Radek Krejci2a9fc652021-01-22 17:44:34 +0100205 (LYSC_TREE_DFS_next) = (struct lysc_node *)lysc_node_children(ELEM, 0); \
Michal Vasko208a04a2020-10-21 15:17:12 +0200206 } \
Radek Krejci0935f412019-08-20 16:15:18 +0200207 if (!(LYSC_TREE_DFS_next)) { \
Michal Vasko208a04a2020-10-21 15:17:12 +0200208 /* no children, try siblings */ \
209 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
Radek Krejci0935f412019-08-20 16:15:18 +0200210 } \
211 while (!(LYSC_TREE_DFS_next)) { \
212 /* parent is already processed, go to its sibling */ \
Radek Krejci7d95fbb2021-01-26 17:33:13 +0100213 (ELEM) = (ELEM)->parent; \
Michal Vasko208a04a2020-10-21 15:17:12 +0200214 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
215 } }
216
217/**
218 * @brief Helper macro for #LYSC_TREE_DFS_END, should not be used directly!
219 */
220#define _LYSC_TREE_DFS_NEXT(START, ELEM, NEXT) \
221 if ((ELEM) == (struct lysc_node *)(START)) { \
222 /* we are done, no next element to process */ \
223 break; \
224 } \
225 if ((ELEM)->nodetype == LYS_INPUT) { \
226 /* after input, get output */ \
Michal Vaskod1e53b92021-01-28 13:11:06 +0100227 (NEXT) = (struct lysc_node *)lysc_node_children((ELEM)->parent, LYS_IS_OUTPUT); \
Michal Vasko208a04a2020-10-21 15:17:12 +0200228 } else if ((ELEM)->nodetype == LYS_OUTPUT) { \
229 /* no sibling of output */ \
230 (NEXT) = NULL; \
231 } else { \
232 (NEXT) = (ELEM)->next; \
233 }
Radek Krejci0935f412019-08-20 16:15:18 +0200234
Michal Vasko64246d82020-08-19 12:35:00 +0200235/* *INDENT-ON* */
236
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200237#define LY_REV_SIZE 11 /**< revision data string length (including terminating NULL byte) */
238
Michal Vasko7f45cf22020-10-01 12:49:44 +0200239#define LYS_UNKNOWN 0x0000 /**< uninitalized unknown statement node */
240#define LYS_CONTAINER 0x0001 /**< container statement node */
241#define LYS_CHOICE 0x0002 /**< choice statement node */
242#define LYS_LEAF 0x0004 /**< leaf statement node */
243#define LYS_LEAFLIST 0x0008 /**< leaf-list statement node */
244#define LYS_LIST 0x0010 /**< list statement node */
245#define LYS_ANYXML 0x0020 /**< anyxml statement node */
246#define LYS_ANYDATA 0x0060 /**< anydata statement node, in tests it can be used for both #LYS_ANYXML and #LYS_ANYDATA */
247#define LYS_CASE 0x0080 /**< case statement node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200248
Michal Vasko7f45cf22020-10-01 12:49:44 +0200249#define LYS_RPC 0x0100 /**< RPC statement node */
250#define LYS_ACTION 0x0200 /**< action statement node */
251#define LYS_NOTIF 0x0400 /**< notification statement node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200252
Michal Vasko7f45cf22020-10-01 12:49:44 +0200253#define LYS_USES 0x0800 /**< uses statement node */
254#define LYS_INPUT 0x1000 /**< RPC/action input node */
255#define LYS_OUTPUT 0x2000 /**< RPC/action output node */
256#define LYS_GROUPING 0x4000
257#define LYS_AUGMENT 0x8000
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100258
Radek Krejcif13b87b2020-12-01 22:02:17 +0100259#define LYS_NODETYPE_MASK 0xffff /**< Mask for nodetypes, the value is limited for 16 bits */
260
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200261/**
Radek Krejcid6b76452019-09-03 17:03:03 +0200262 * @brief List of YANG statements
263 */
264enum ly_stmt {
265 LY_STMT_NONE = 0,
Radek Krejci8678fa42020-08-18 16:07:28 +0200266 LY_STMT_STATUS, /**< in ::lysc_ext_substmt.storage stored as a pointer to `uint16_t`, only cardinality < #LY_STMT_CARD_SOME is allowed */
267 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 +0200268 LY_STMT_MANDATORY,
Radek Krejci8678fa42020-08-18 16:07:28 +0200269 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 +0200270 or as a pointer to a [sized array](@ref sizedarrays) `const char **` */
Radek Krejci335332a2019-09-05 13:03:35 +0200271 LY_STMT_DEFAULT,
Radek Krejci8678fa42020-08-18 16:07:28 +0200272 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 +0200273 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_type **` */
Radek Krejci335332a2019-09-05 13:03:35 +0200274
Radek Krejcid6b76452019-09-03 17:03:03 +0200275 LY_STMT_ACTION,
276 LY_STMT_ANYDATA,
277 LY_STMT_ANYXML,
278 LY_STMT_ARGUMENT,
279 LY_STMT_AUGMENT,
280 LY_STMT_BASE,
281 LY_STMT_BELONGS_TO,
282 LY_STMT_BIT,
283 LY_STMT_CASE,
284 LY_STMT_CHOICE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200285 LY_STMT_CONTACT,
286 LY_STMT_CONTAINER,
Radek Krejcid6b76452019-09-03 17:03:03 +0200287 LY_STMT_DESCRIPTION,
288 LY_STMT_DEVIATE,
289 LY_STMT_DEVIATION,
290 LY_STMT_ENUM,
291 LY_STMT_ERROR_APP_TAG,
292 LY_STMT_ERROR_MESSAGE,
293 LY_STMT_EXTENSION,
294 LY_STMT_FEATURE,
295 LY_STMT_FRACTION_DIGITS,
296 LY_STMT_GROUPING,
297 LY_STMT_IDENTITY,
Radek Krejci8678fa42020-08-18 16:07:28 +0200298 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 +0200299 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_iffeature *` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200300 LY_STMT_IMPORT,
301 LY_STMT_INCLUDE,
302 LY_STMT_INPUT,
303 LY_STMT_KEY,
304 LY_STMT_LEAF,
305 LY_STMT_LEAF_LIST,
306 LY_STMT_LENGTH,
307 LY_STMT_LIST,
Radek Krejcid6b76452019-09-03 17:03:03 +0200308 LY_STMT_MAX_ELEMENTS,
309 LY_STMT_MIN_ELEMENTS,
310 LY_STMT_MODIFIER,
311 LY_STMT_MODULE,
312 LY_STMT_MUST,
313 LY_STMT_NAMESPACE,
314 LY_STMT_NOTIFICATION,
315 LY_STMT_ORDERED_BY,
316 LY_STMT_ORGANIZATION,
317 LY_STMT_OUTPUT,
318 LY_STMT_PATH,
319 LY_STMT_PATTERN,
320 LY_STMT_POSITION,
321 LY_STMT_PREFIX,
322 LY_STMT_PRESENCE,
323 LY_STMT_RANGE,
324 LY_STMT_REFERENCE,
325 LY_STMT_REFINE,
326 LY_STMT_REQUIRE_INSTANCE,
327 LY_STMT_REVISION,
328 LY_STMT_REVISION_DATE,
329 LY_STMT_RPC,
Radek Krejcid6b76452019-09-03 17:03:03 +0200330 LY_STMT_SUBMODULE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200331 LY_STMT_TYPEDEF,
332 LY_STMT_UNIQUE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200333 LY_STMT_USES,
334 LY_STMT_VALUE,
335 LY_STMT_WHEN,
336 LY_STMT_YANG_VERSION,
337 LY_STMT_YIN_ELEMENT,
338 LY_STMT_EXTENSION_INSTANCE,
339
340 LY_STMT_SYNTAX_SEMICOLON,
341 LY_STMT_SYNTAX_LEFT_BRACE,
342 LY_STMT_SYNTAX_RIGHT_BRACE,
343
344 LY_STMT_ARG_TEXT,
345 LY_STMT_ARG_VALUE
346};
347
348/**
Radek Krejci0e59c312019-08-15 15:34:15 +0200349 * @brief Extension instance structure parent enumeration
350 */
351typedef enum {
Radek Krejci0935f412019-08-20 16:15:18 +0200352 LYEXT_PAR_MODULE, /**< ::lysc_module */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100353 LYEXT_PAR_NODE, /**< ::lysc_node (and the derived structures including ::lysc_node_action and ::lysc_node_notif) */
354 LYEXT_PAR_INPUT, /**< ::lysc_node_action_inout */
355 LYEXT_PAR_OUTPUT, /**< ::lysc_node_action_inout */
Radek Krejci0935f412019-08-20 16:15:18 +0200356 LYEXT_PAR_TYPE, /**< ::lysc_type */
357 LYEXT_PAR_TYPE_BIT, /**< ::lysc_type_bitenum_item */
358 LYEXT_PAR_TYPE_ENUM, /**< ::lysc_type_bitenum_item */
Radek Krejci0935f412019-08-20 16:15:18 +0200359 LYEXT_PAR_MUST, /**< ::lysc_must */
360 LYEXT_PAR_PATTERN, /**< ::lysc_pattern */
361 LYEXT_PAR_LENGTH, /**< ::lysc_range */
362 LYEXT_PAR_RANGE, /**< ::lysc_range */
363 LYEXT_PAR_WHEN, /**< ::lysc_when */
364 LYEXT_PAR_IDENT, /**< ::lysc_ident */
365 LYEXT_PAR_EXT, /**< ::lysc_ext */
Michal Vasko69730152020-10-09 16:30:07 +0200366 LYEXT_PAR_IMPORT /**< ::lysp_import */
Radek Krejcif13b87b2020-12-01 22:02:17 +0100367#if 0
368 LYEXT_PAR_TPDF, /**< ::lysp_tpdf */
369 LYEXT_PAR_EXTINST, /**< ::lysp_ext_instance */
370 LYEXT_PAR_REFINE, /**< ::lysp_refine */
371 LYEXT_PAR_DEVIATION, /**< ::lysp_deviation */
372 LYEXT_PAR_DEVIATE, /**< ::lysp_deviate */
373 LYEXT_PAR_INCLUDE, /**< ::lysp_include */
374 LYEXT_PAR_REVISION /**< ::lysp_revision */
375#endif
Radek Krejci0e59c312019-08-15 15:34:15 +0200376} LYEXT_PARENT;
377
378/**
Radek Krejci0935f412019-08-20 16:15:18 +0200379 * @brief Stringify extension instance parent type.
380 * @param[in] type Parent type to stringify.
381 * @return Constant string with the name of the parent statement.
382 */
383const char *lyext_parent2str(LYEXT_PARENT type);
384
385/**
Radek Krejci0e59c312019-08-15 15:34:15 +0200386 * @brief Enum of substatements in which extension instances can appear.
387 */
388typedef enum {
389 LYEXT_SUBSTMT_SELF = 0, /**< extension of the structure itself, not substatement's */
390 LYEXT_SUBSTMT_ARGUMENT, /**< extension of the argument statement, can appear in lys_ext */
391 LYEXT_SUBSTMT_BASE, /**< extension of the base statement, can appear (repeatedly) in lys_type and lys_ident */
392 LYEXT_SUBSTMT_BELONGSTO, /**< extension of the belongs-to statement, can appear in lys_submodule */
393 LYEXT_SUBSTMT_CONTACT, /**< extension of the contact statement, can appear in lys_module */
394 LYEXT_SUBSTMT_DEFAULT, /**< extension of the default statement, can appear in lys_node_leaf, lys_node_leaflist,
395 lys_node_choice and lys_deviate */
396 LYEXT_SUBSTMT_DESCRIPTION, /**< extension of the description statement, can appear in lys_module, lys_submodule,
397 lys_node, lys_import, lys_include, lys_ext, lys_feature, lys_tpdf, lys_restr,
398 lys_ident, lys_deviation, lys_type_enum, lys_type_bit, lys_when and lys_revision */
399 LYEXT_SUBSTMT_ERRTAG, /**< extension of the error-app-tag statement, can appear in lys_restr */
400 LYEXT_SUBSTMT_ERRMSG, /**< extension of the error-message statement, can appear in lys_restr */
401 LYEXT_SUBSTMT_KEY, /**< extension of the key statement, can appear in lys_node_list */
402 LYEXT_SUBSTMT_NAMESPACE, /**< extension of the namespace statement, can appear in lys_module */
403 LYEXT_SUBSTMT_ORGANIZATION, /**< extension of the organization statement, can appear in lys_module and lys_submodule */
404 LYEXT_SUBSTMT_PATH, /**< extension of the path statement, can appear in lys_type */
405 LYEXT_SUBSTMT_PREFIX, /**< extension of the prefix statement, can appear in lys_module, lys_submodule (for
406 belongs-to's prefix) and lys_import */
407 LYEXT_SUBSTMT_PRESENCE, /**< extension of the presence statement, can appear in lys_node_container */
408 LYEXT_SUBSTMT_REFERENCE, /**< extension of the reference statement, can appear in lys_module, lys_submodule,
409 lys_node, lys_import, lys_include, lys_revision, lys_tpdf, lys_restr, lys_ident,
410 lys_ext, lys_feature, lys_deviation, lys_type_enum, lys_type_bit and lys_when */
411 LYEXT_SUBSTMT_REVISIONDATE, /**< extension of the revision-date statement, can appear in lys_import and lys_include */
412 LYEXT_SUBSTMT_UNITS, /**< extension of the units statement, can appear in lys_tpdf, lys_node_leaf,
413 lys_node_leaflist and lys_deviate */
414 LYEXT_SUBSTMT_VALUE, /**< extension of the value statement, can appear in lys_type_enum */
415 LYEXT_SUBSTMT_VERSION, /**< extension of the yang-version statement, can appear in lys_module and lys_submodule */
416 LYEXT_SUBSTMT_MODIFIER, /**< extension of the modifier statement, can appear in lys_restr */
417 LYEXT_SUBSTMT_REQINSTANCE, /**< extension of the require-instance statement, can appear in lys_type */
418 LYEXT_SUBSTMT_YINELEM, /**< extension of the yin-element statement, can appear in lys_ext */
419 LYEXT_SUBSTMT_CONFIG, /**< extension of the config statement, can appear in lys_node and lys_deviate */
420 LYEXT_SUBSTMT_MANDATORY, /**< extension of the mandatory statement, can appear in lys_node_leaf, lys_node_choice,
421 lys_node_anydata and lys_deviate */
422 LYEXT_SUBSTMT_ORDEREDBY, /**< extension of the ordered-by statement, can appear in lys_node_list and lys_node_leaflist */
423 LYEXT_SUBSTMT_STATUS, /**< extension of the status statement, can appear in lys_tpdf, lys_node, lys_ident,
424 lys_ext, lys_feature, lys_type_enum and lys_type_bit */
425 LYEXT_SUBSTMT_FRACDIGITS, /**< extension of the fraction-digits statement, can appear in lys_type */
426 LYEXT_SUBSTMT_MAX, /**< extension of the max-elements statement, can appear in lys_node_list,
427 lys_node_leaflist and lys_deviate */
428 LYEXT_SUBSTMT_MIN, /**< extension of the min-elements statement, can appear in lys_node_list,
429 lys_node_leaflist and lys_deviate */
430 LYEXT_SUBSTMT_POSITION, /**< extension of the position statement, can appear in lys_type_bit */
431 LYEXT_SUBSTMT_UNIQUE, /**< extension of the unique statement, can appear in lys_node_list and lys_deviate */
Michal Vasko69730152020-10-09 16:30:07 +0200432 LYEXT_SUBSTMT_IFFEATURE /**< extension of the if-feature statement */
Radek Krejci0e59c312019-08-15 15:34:15 +0200433} LYEXT_SUBSTMT;
434
435/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200436 * @brief YANG import-stmt
437 */
438struct lysp_import {
Radek Krejci086c7132018-10-26 15:29:04 +0200439 struct lys_module *module; /**< pointer to the imported module
440 (mandatory, but resolved when the referring module is completely parsed) */
441 const char *name; /**< name of the imported module (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200442 const char *prefix; /**< prefix for the data from the imported schema (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200443 const char *dsc; /**< description */
444 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200445 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100446 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200447 char rev[LY_REV_SIZE]; /**< revision-date of the imported module */
448};
449
450/**
451 * @brief YANG include-stmt
452 */
453struct lysp_include {
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100454 struct lysp_submodule *submodule;/**< pointer to the parsed submodule structure
Radek Krejci086c7132018-10-26 15:29:04 +0200455 (mandatory, but resolved when the referring module is completely parsed) */
456 const char *name; /**< name of the included submodule (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200457 const char *dsc; /**< description */
458 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200459 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200460 char rev[LY_REV_SIZE]; /**< revision-date of the included submodule */
Radek Krejci771928a2021-01-19 13:42:36 +0100461 ly_bool injected; /**< flag to mark includes copied into main module from submodules,
462 only for backward compatibility with YANG 1.0, which does not require the
463 main module to include all submodules. */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200464};
465
466/**
467 * @brief YANG extension-stmt
468 */
469struct lysp_ext {
470 const char *name; /**< extension name */
471 const char *argument; /**< argument name, NULL if not specified */
472 const char *dsc; /**< description statement */
473 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200474 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200475 uint16_t flags; /**< LYS_STATUS_* and LYS_YINELEM_* values (@ref snodeflags) */
Michal Vasko5fe75f12020-03-02 13:52:37 +0100476
477 struct lysc_ext *compiled; /**< pointer to the compiled extension definition */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200478};
479
480/**
481 * @brief Helper structure for generic storage of the extension instances content.
482 */
483struct lysp_stmt {
484 const char *stmt; /**< identifier of the statement */
485 const char *arg; /**< statement's argument */
486 struct lysp_stmt *next; /**< link to the next statement */
Michal Vaskobc2559f2018-09-07 10:17:50 +0200487 struct lysp_stmt *child; /**< list of the statement's substatements (linked list) */
David Sedlákb9d75c42019-08-14 10:49:42 +0200488 uint16_t flags; /**< statement flags, can be set to LYS_YIN_ATTR */
Radek Krejci335332a2019-09-05 13:03:35 +0200489 enum ly_stmt kw; /**< numeric respresentation of the stmt value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200490};
491
David Sedlákae4b4512019-08-14 10:45:56 +0200492#define LYS_YIN 0x1 /**< used to specify input format of extension instance */
493
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200494/**
495 * @brief YANG extension instance
496 */
497struct lysp_ext_instance {
David Sedlákbbd06ca2019-06-27 14:15:38 +0200498 const char *name; /**< extension identifier, including possible prefix */
499 const char *argument; /**< optional value of the extension's argument */
Radek Krejci335332a2019-09-05 13:03:35 +0200500 void *parent; /**< pointer to the parent element holding the extension instance(s), use
501 ::lysp_ext_instance#parent_type to access the schema element */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200502 struct lysp_stmt *child; /**< list of the extension's substatements (linked list) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200503 struct lysc_ext_instance *compiled; /**< pointer to the compiled data if any - in case the source format is YIN,
504 some of the information (argument) are available only after compilation */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200505 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200506 LY_ARRAY_COUNT_TYPE insubstmt_index; /**< in case the instance is in a substatement, this identifies
David Sedlákbbd06ca2019-06-27 14:15:38 +0200507 the index of that substatement */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100508 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
509 uint8_t yin; /**< flag for YIN source format, can be set to LYS_YIN */
Radek Krejci335332a2019-09-05 13:03:35 +0200510 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200511};
512
513/**
514 * @brief YANG feature-stmt
515 */
516struct lysp_feature {
517 const char *name; /**< feature name (mandatory) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100518 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
519 struct lysc_iffeature *iffeatures_c; /**< compiled if-features */
520 struct lysp_feature **depfeatures; /**< list of pointers to other features depending on this one
521 ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200522 const char *dsc; /**< description statement */
523 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200524 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100525 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values and
526 LYS_FENABLED are allowed */
527};
528
529/**
530 * @brief Compiled YANG if-feature-stmt
531 */
532struct lysc_iffeature {
533 uint8_t *expr; /**< 2bits array describing the if-feature expression in prefix format, see @ref ifftokens */
534 struct lysp_feature **features; /**< array of pointers to the features used in expression ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200535};
536
537/**
Michal Vasko7f45cf22020-10-01 12:49:44 +0200538 * @brief Qualified name (optional prefix followed by an identifier).
539 */
540struct lysp_qname {
541 const char *str; /**< qualified name string */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200542 const struct lysp_module *mod; /**< module to resolve any prefixes found in the string, it must be
Michal Vasko7f45cf22020-10-01 12:49:44 +0200543 stored explicitly because of deviations/refines */
544};
545
546/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200547 * @brief YANG identity-stmt
548 */
549struct lysp_ident {
550 const char *name; /**< identity name (mandatory), including possible prefix */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200551 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200552 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200553 const char *dsc; /**< description statement */
554 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200555 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200556 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
557};
558
Michal Vasko71e64ca2018-09-07 16:30:29 +0200559/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200560 * @brief Covers restrictions: range, length, pattern, must
561 */
562struct lysp_restr {
Radek Krejcif13b87b2020-12-01 22:02:17 +0100563#define LYSP_RESTR_PATTERN_ACK 0x06
564#define LYSP_RESTR_PATTERN_NACK 0x15
Michal Vasko7f45cf22020-10-01 12:49:44 +0200565 struct lysp_qname arg; /**< The restriction expression/value (mandatory);
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200566 in case of pattern restriction, the first byte has a special meaning:
567 0x06 (ACK) for regular match and 0x15 (NACK) for invert-match */
568 const char *emsg; /**< error-message */
569 const char *eapptag; /**< error-app-tag value */
570 const char *dsc; /**< description */
571 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200572 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200573};
574
575/**
Michal Vasko71e64ca2018-09-07 16:30:29 +0200576 * @brief YANG revision-stmt
577 */
578struct lysp_revision {
Radek Krejcicb3e6472021-01-06 08:19:01 +0100579 char date[LY_REV_SIZE]; /**< revision date (madatory) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200580 const char *dsc; /**< description statement */
581 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200582 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200583};
584
585/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200586 * @brief Enumeration/Bit value definition
587 */
588struct lysp_type_enum {
589 const char *name; /**< name (mandatory) */
590 const char *dsc; /**< description statement */
591 const char *ref; /**< reference statement */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200592 int64_t value; /**< enum's value or bit's position */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200593 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200594 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200595 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
596 values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200597};
598
599/**
600 * @brief YANG type-stmt
601 *
602 * Some of the items in the structure may be mandatory, but it is necessary to resolve the type's base type first
603 */
604struct lysp_type {
605 const char *name; /**< name of the type (mandatory) */
606 struct lysp_restr *range; /**< allowed values range - numerical, decimal64 */
607 struct lysp_restr *length; /**< allowed length of the value - string, binary */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200608 struct lysp_restr *patterns; /**< list of patterns ([sized array](@ref sizedarrays)) - string */
609 struct lysp_type_enum *enums; /**< list of enum-stmts ([sized array](@ref sizedarrays)) - enum */
610 struct lysp_type_enum *bits; /**< list of bit-stmts ([sized array](@ref sizedarrays)) - bits */
Michal Vasko004d3152020-06-11 19:59:22 +0200611 struct lyxp_expr *path; /**< parsed path - leafref */
Radek Krejci151a5b72018-10-19 14:21:44 +0200612 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) - identityref */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200613 struct lysp_type *types; /**< list of sub-types ([sized array](@ref sizedarrays)) - union */
614 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200615
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200616 const struct lysp_module *pmod; /**< (sub)module where the type is defined (needed for deviations) */
Radek Krejci2167ee12018-11-02 16:09:07 +0100617 struct lysc_type *compiled; /**< pointer to the compiled type */
618
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200619 uint8_t fraction_digits; /**< number of fraction digits - decimal64 */
620 uint8_t require_instance; /**< require-instance flag - leafref, instance */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100621 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200622};
623
624/**
625 * @brief YANG typedef-stmt
626 */
627struct lysp_tpdf {
628 const char *name; /**< name of the newly defined type (mandatory) */
629 const char *units; /**< units of the newly defined type */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200630 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 +0200631 const char *dsc; /**< description statement */
632 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200633 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200634 struct lysp_type type; /**< base type from which the typedef is derived (mandatory) */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100635 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200636};
637
638/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200639 * @brief YANG when-stmt
640 */
641struct lysp_when {
642 const char *cond; /**< specified condition (mandatory) */
643 const char *dsc; /**< description statement */
644 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200645 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200646};
647
648/**
649 * @brief YANG refine-stmt
650 */
651struct lysp_refine {
652 const char *nodeid; /**< target descendant schema nodeid (mandatory) */
653 const char *dsc; /**< description statement */
654 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200655 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200656 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200657 const char *presence; /**< presence description */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200658 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200659 uint32_t min; /**< min-elements constraint */
660 uint32_t max; /**< max-elements constraint, 0 means unbounded */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200661 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200662 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
663};
664
665/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200666 * @ingroup schematree
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200667 * @defgroup deviatetypes Deviate types
Radek Krejci8678fa42020-08-18 16:07:28 +0200668 *
669 * Type of the deviate operation (used as ::lysp_deviate.mod)
670 *
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200671 * @{
672 */
673#define LYS_DEV_NOT_SUPPORTED 1 /**< deviate type not-supported */
674#define LYS_DEV_ADD 2 /**< deviate type add */
675#define LYS_DEV_DELETE 3 /**< deviate type delete */
676#define LYS_DEV_REPLACE 4 /**< deviate type replace */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200677/** @} deviatetypes */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200678
679/**
680 * @brief Generic deviate structure to get type and cast to lysp_deviate_* structure
681 */
682struct lysp_deviate {
683 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
684 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200685 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200686};
687
688struct lysp_deviate_add {
689 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
690 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200691 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200692 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200693 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200694 struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
695 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200696 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
697 uint32_t min; /**< min-elements constraint */
698 uint32_t max; /**< max-elements constraint, 0 means unbounded */
699};
700
701struct lysp_deviate_del {
702 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
703 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200704 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200705 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200706 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200707 struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
708 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200709};
710
711struct lysp_deviate_rpl {
712 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
713 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200714 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200715 struct lysp_type *type; /**< type of the node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200716 const char *units; /**< units of the values */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200717 struct lysp_qname dflt; /**< default value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200718 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
719 uint32_t min; /**< min-elements constraint */
720 uint32_t max; /**< max-elements constraint, 0 means unbounded */
721};
722
723struct lysp_deviation {
Michal Vaskob55f6c12018-09-12 11:13:15 +0200724 const char *nodeid; /**< target absolute schema nodeid (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200725 const char *dsc; /**< description statement */
726 const char *ref; /**< reference statement */
Michal Vasko22df3f02020-08-24 13:29:22 +0200727 struct lysp_deviate *deviates; /**< list of deviate specifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200728 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200729};
730
Radek Krejci4f28eda2018-11-12 11:46:16 +0100731/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100732 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200733 * @defgroup spnodeflags Parsed schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100734 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200735 * Various flags for parsed schema nodes (used as ::lysp_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100736 *
737 * 1 - container 6 - anydata/anyxml 11 - output 16 - grouping 21 - enum
738 * 2 - choice 7 - case 12 - feature 17 - uses 22 - type
Radek Krejcid3ca0632019-04-16 16:54:54 +0200739 * 3 - leaf 8 - notification 13 - identity 18 - refine 23 - stmt
Radek Krejci4f28eda2018-11-12 11:46:16 +0100740 * 4 - leaflist 9 - rpc 14 - extension 19 - augment
741 * 5 - list 10 - input 15 - typedef 20 - deviate
742 *
Radek Krejcid3ca0632019-04-16 16:54:54 +0200743 * 1 1 1 1 1 1 1 1 1 1 2 2 2 2
744 * 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
745 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200746 * 1 LYS_CONFIG_W |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200747 * LYS_SET_BASE | | | | | | | | | | | | | | | | | | | | | |x| |
748 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200749 * 2 LYS_CONFIG_R |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200750 * LYS_SET_BIT | | | | | | | | | | | | | | | | | | | | | |x| |
751 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
752 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
753 * LYS_SET_ENUM | | | | | | | | | | | | | | | | | | | | | |x| |
754 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
755 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
756 * LYS_SET_FRDIGITS | | | | | | | | | | | | | | | | | | | | | |x| |
757 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
758 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
759 * LYS_SET_LENGTH | | | | | | | | | | | | | | | | | | | | | |x| |
760 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
761 * 6 LYS_MAND_TRUE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
762 * LYS_SET_PATH | | | | | | | | | | | | | | | | | | | | | |x| |
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100763 * LYS_FENABLED | | | | | | | | | | | |x| | | | | | | | | | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200764 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
765 * 7 LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
766 * LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | | | | | | | | |
767 * LYS_SET_PATTERN | | | | | | | | | | | | | | | | | | | | | |x| |
768 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
769 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | | | | | | | | |
770 * LYS_YINELEM_TRUE | | | | | | | | | | | | | |x| | | | | | | | | |
771 * LYS_SET_RANGE | | | | | | | | | | | | | | | | | | | | | |x| |
772 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
773 * 9 LYS_YINELEM_FALSE| | | | | | | | | | | | | |x| | | | | | | | | |
774 * LYS_SET_TYPE | | | | | | | | | | | | | | | | | | | | | |x| |
775 * LYS_SINGLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
776 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
777 * 10 LYS_SET_VALUE | | | | | | | | | | | | | | | | | | | | |x| | |
778 * LYS_SET_REQINST | | | | | | | | | | | | | | | | | | | | | |x| |
779 * LYS_SET_MIN | | | |x|x| | | | | | | | | | | | |x| |x| | | |
780 * LYS_DOUBLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
781 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
782 * 11 LYS_SET_MAX | | | |x|x| | | | | | | | | | | | |x| |x| | | |
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200783 * LYS_USED_GRP | | | | | | | | | | | | | | | |x| | | | | | | |
David Sedlákae4b4512019-08-14 10:45:56 +0200784 * LYS_YIN_ATTR | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko5297a432020-08-31 12:27:51 +0200785 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
786 * 12 LYS_YIN_ARGUMENT | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100787 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
788 * 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 +0200789 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100790 *
791 */
792
793/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100794 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200795 * @defgroup scnodeflags Compiled schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100796 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200797 * Various flags for compiled schema nodes (used as ::lysc_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100798 *
Radek Krejci61e042e2019-09-10 15:53:09 +0200799 * 1 - container 6 - anydata/anyxml 11 - identity
800 * 2 - choice 7 - case 12 - extension
801 * 3 - leaf 8 - notification 13 - bitenum
Michal Vasko03ff5a72019-09-11 13:49:33 +0200802 * 4 - leaflist 9 - rpc/action 14 - when
Michal Vaskoecd62de2019-11-13 12:35:11 +0100803 * 5 - list 10 - feature
Radek Krejci4f28eda2018-11-12 11:46:16 +0100804 *
Michal Vaskoecd62de2019-11-13 12:35:11 +0100805 * 1 1 1 1 1
806 * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4
807 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100808 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100809 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100810 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100811 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
812 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x|x|x|x| |x|
813 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
814 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x|x|x|x| |x|
815 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
816 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x|x|x|x| |x|
817 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
818 * 6 LYS_MAND_TRUE |x|x|x|x|x|x| | | | | | | | |
819 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
820 * 7 LYS_ORDBY_USER | | | |x|x| | | | | | | | | |
821 * LYS_MAND_FALSE | |x|x| | |x| | | | | | | | |
822 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
823 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | |
824 * LYS_PRESENCE |x| | | | | | | | | | | | | |
825 * LYS_UNIQUE | | |x| | | | | | | | | | | |
826 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
827 * 9 LYS_KEY | | |x| | | | | | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100828 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
829 * 10 LYS_SET_DFLT | | |x|x| | |x| | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100830 * LYS_IS_ENUM | | | | | | | | | | | | |x| |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100831 * LYS_KEYLESS | | | | |x| | | | | | | | | |
832 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
833 * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | |
834 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
835 * 12 LYS_SET_CONFIG |x|x|x|x|x|x| | | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100836 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
837 * 13 LYS_IS_INPUT |x|x|x|x|x|x|x| | | | | | | |
838 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
839 * 14 LYS_IS_OUTPUT |x|x|x|x|x|x|x| | | | | | | |
840 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
841 * 15 LYS_IS_NOTIF |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100842 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100843 *
844 */
845
846/**
847 * @defgroup snodeflags Schema nodes flags
Radek Krejci8678fa42020-08-18 16:07:28 +0200848 *
849 * Various flags for schema nodes ([parsed](@ref spnodeflags) as well as [compiled](@ref scnodeflags)).
850 *
Radek Krejci4f28eda2018-11-12 11:46:16 +0100851 * @{
852 */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100853#define LYS_CONFIG_W 0x01 /**< config true; */
854#define LYS_CONFIG_R 0x02 /**< config false; */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200855#define LYS_CONFIG_MASK 0x03 /**< mask for config value */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100856#define LYS_STATUS_CURR 0x04 /**< status current; */
857#define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */
858#define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */
859#define LYS_STATUS_MASK 0x1C /**< mask for status value */
860#define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice,
Radek Krejcife909632019-02-12 15:34:42 +0100861 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
862 The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0.
863 The ::lysc_node_container has this flag if it is not a presence container and it has at least one
864 child with LYS_MAND_TRUE. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100865#define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice,
866 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
867 This flag is present only in case the mandatory false statement was explicitly specified. */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100868#define LYS_MAND_MASK 0x60 /**< mask for mandatory values */
Michal Vaskoc118ae22020-08-06 14:51:09 +0200869#define LYS_PRESENCE 0x80 /**< flag for presence property of a container, but it is not only for explicit presence
870 containers, but also for NP containers with some meaning, applicable only to
871 ::lysc_node_container */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100872#define LYS_UNIQUE 0x80 /**< flag for leafs being part of a unique set, applicable only to ::lysc_node_leaf */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100873#define LYS_KEY 0x0100 /**< flag for leafs being a key of a list, applicable only to ::lysc_node_leaf */
874#define LYS_KEYLESS 0x0200 /**< flag for list without any key, applicable only to ::lysc_node_list */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100875#define LYS_FENABLED 0x20 /**< feature enabled flag, applicable only to ::lysp_feature. */
Radek Krejcife909632019-02-12 15:34:42 +0100876#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 +0100877 ::lysc_node_list/::lysp_node_list */
878#define LYS_ORDBY_USER 0x40 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and
879 ::lysc_node_list/::lysp_node_list */
880#define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */
881#define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100882#define LYS_YINELEM_FALSE 0x0100 /**< yin-element false for extension's argument */
883#define LYS_YINELEM_MASK 0x0180 /**< mask for yin-element value */
884#define LYS_USED_GRP 0x0400 /**< internal flag for validating not-instantiated groupings
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200885 (resp. do not validate again the instantiated groupings). */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100886#define LYS_SET_VALUE 0x0200 /**< value attribute is set */
887#define LYS_SET_MIN 0x0200 /**< min attribute is set */
888#define LYS_SET_MAX 0x0400 /**< max attribute is set */
Radek Krejcid505e3d2018-11-13 09:04:17 +0100889
890#define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */
891#define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */
892#define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */
893#define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */
894#define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */
895#define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */
896#define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */
897#define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */
898#define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */
899#define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */
Radek Krejciccd20f12019-02-15 14:12:27 +0100900#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 +0100901 cases of choice. This information is important for refines, since it is prohibited to make leafs
902 with default statement mandatory. In case the default leaf value is taken from type, it is thrown
Radek Krejciccd20f12019-02-15 14:12:27 +0100903 away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish
904 between own default or the default values taken from the type. */
905#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 +0100906#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 +0100907
Michal Vaskod1e53b92021-01-28 13:11:06 +0100908#define LYS_SINGLEQUOTED 0x0100 /**< flag for single-quoted argument of an extension instance's substatement, only when the source is YANG */
909#define LYS_DOUBLEQUOTED 0x0200 /**< flag for double-quoted argument of an extension instance's substatement, only when the source is YANG */
Radek Krejcid3ca0632019-04-16 16:54:54 +0200910
Michal Vaskod1e53b92021-01-28 13:11:06 +0100911#define LYS_YIN_ATTR 0x0400 /**< flag to identify YIN attribute parsed as extension's substatement, only when the source is YIN */
912#define LYS_YIN_ARGUMENT 0x0800 /**< flag to identify statement representing extension's argument, only when the source is YIN */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200913
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100914#define LYS_INTERNAL 0x1000 /**< flag to identify internal parsed statements that should not be printed */
915
Michal Vaskod1e53b92021-01-28 13:11:06 +0100916#define LYS_IS_ENUM 0x0200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */
917
918#define LYS_IS_INPUT 0x1000 /**< flag for nodes that are in the subtree of an input statement */
919
920#define LYS_IS_OUTPUT 0x2000 /**< flag for nodes that are in the subtree of an output statement */
921
922#define LYS_IS_NOTIF 0x4000 /**< flag for nodes that are in the subtree of a notification statement */
Radek Krejci693262f2019-04-29 15:23:20 +0200923
Radek Krejcife909632019-02-12 15:34:42 +0100924#define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200925/** @} snodeflags */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200926
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200927/**
928 * @brief Generic YANG data node
929 */
930struct lysp_node {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100931 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200932 uint16_t nodetype; /**< type of the node (mandatory) */
933 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100934 struct lysp_node *next; /**< next sibling node (NULL if there is no one) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200935 const char *name; /**< node name (mandatory) */
936 const char *dsc; /**< description statement */
937 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200938 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)),
939 must be qname because of refines */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200940 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200941};
942
943/**
944 * @brief Extension structure of the lysp_node for YANG container
945 */
946struct lysp_node_container {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100947 union {
948 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
949 struct {
950 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
951 uint16_t nodetype; /**< LYS_CONTAINER */
952 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
953 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
954 const char *name; /**< node name (mandatory) */
955 const char *dsc; /**< description statement */
956 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100957 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
958 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
959 };
960 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200961
962 /* container */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200963 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +0100964 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200965 const char *presence; /**< presence description */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200966 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100967 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200968 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100969 struct lysp_node_action *actions;/**< list of actions (linked list) */
970 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200971};
972
973struct lysp_node_leaf {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100974 union {
975 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
976 struct {
977 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
978 uint16_t nodetype; /**< LYS_LEAF */
979 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
980 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
981 const char *name; /**< node name (mandatory) */
982 const char *dsc; /**< description statement */
983 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100984 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
985 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
986 };
987 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200988
989 /* leaf */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200990 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +0100991 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200992 struct lysp_type type; /**< type of the leaf node (mandatory) */
993 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200994 struct lysp_qname dflt; /**< default value, it may or may not be a qualified name */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200995};
996
997struct lysp_node_leaflist {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100998 union {
999 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1000 struct {
1001 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1002 uint16_t nodetype; /**< LYS_LEAFLIST */
1003 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1004 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1005 const char *name; /**< node name (mandatory) */
1006 const char *dsc; /**< description statement */
1007 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001008 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1009 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1010 };
1011 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001012
1013 /* leaf-list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001014 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001015 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001016 struct lysp_type type; /**< type of the leaf node (mandatory) */
1017 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001018 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)), they may or
1019 may not be qualified names */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001020 uint32_t min; /**< min-elements constraint */
1021 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1022};
1023
1024struct lysp_node_list {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001025 union {
1026 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1027 struct {
1028 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1029 uint16_t nodetype; /**< LYS_LIST */
1030 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1031 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1032 const char *name; /**< node name (mandatory) */
1033 const char *dsc; /**< description statement */
1034 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001035 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1036 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1037 };
1038 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001039
1040 /* list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001041 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001042 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001043 const char *key; /**< keys specification */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001044 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001045 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001046 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001047 struct lysp_node_action *actions;/**< list of actions (linked list) */
1048 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001049 struct lysp_qname *uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001050 uint32_t min; /**< min-elements constraint */
1051 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1052};
1053
1054struct lysp_node_choice {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001055 union {
1056 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1057 struct {
1058 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1059 uint16_t nodetype; /**< LYS_CHOICE */
1060 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1061 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1062 const char *name; /**< node name (mandatory) */
1063 const char *dsc; /**< description statement */
1064 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001065 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1066 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1067 };
1068 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001069
1070 /* choice */
1071 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001072 struct lysp_when *when; /**< when statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001073 struct lysp_qname dflt; /**< default case */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001074};
1075
1076struct lysp_node_case {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001077 union {
1078 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1079 struct {
1080 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1081 uint16_t nodetype; /**< LYS_CASE */
1082 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1083 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1084 const char *name; /**< node name (mandatory) */
1085 const char *dsc; /**< description statement */
1086 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001087 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1088 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1089 };
1090 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001091
1092 /* case */
1093 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001094 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001095};
1096
1097struct lysp_node_anydata {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001098 union {
1099 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1100 struct {
1101 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1102 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1103 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1104 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1105 const char *name; /**< node name (mandatory) */
1106 const char *dsc; /**< description statement */
1107 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001108 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1109 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1110 };
1111 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001112
1113 /* anyxml/anydata */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001114 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001115 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001116};
1117
1118struct lysp_node_uses {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001119 union {
1120 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1121 struct {
1122 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1123 uint16_t nodetype; /**< LYS_USES */
1124 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1125 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1126 const char *name; /**< grouping name reference (mandatory) */
1127 const char *dsc; /**< description statement */
1128 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001129 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1130 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1131 };
1132 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001133
1134 /* uses */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001135 struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001136 struct lysp_node_augment *augments; /**< list of augments (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001137 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001138};
1139
1140/**
1141 * @brief YANG input-stmt and output-stmt
1142 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001143struct lysp_node_action_inout {
1144 union {
1145 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1146 struct {
1147 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1148 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1149 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1150 struct lysp_node *next; /**< NULL */
1151 const char *name; /**< empty string */
1152 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1153 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysp_node */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001154 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1155 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1156 };
1157 }; /**< common part corresponding to ::lysp_node */
1158
1159 /* inout */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001160 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1161 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001162 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001163 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001164};
1165
1166/**
1167 * @brief YANG rpc-stmt and action-stmt
1168 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001169struct lysp_node_action {
1170 union {
1171 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1172 struct {
1173 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1174 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1175 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1176 struct lysp_node_action *next; /**< pointer to the next action (NULL if there is no one) */
1177 const char *name; /**< grouping name reference (mandatory) */
1178 const char *dsc; /**< description statement */
1179 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001180 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1181 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1182 };
1183 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001184
1185 /* action */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001186 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1187 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
1188
1189 struct lysp_node_action_inout input; /**< RPC's/Action's input */
1190 struct lysp_node_action_inout output; /**< RPC's/Action's output */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001191};
1192
1193/**
1194 * @brief YANG notification-stmt
1195 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001196struct lysp_node_notif {
1197 union {
1198 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1199 struct {
1200 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1201 uint16_t nodetype; /**< LYS_NOTIF */
1202 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1203 struct lysp_node_notif *next; /**< pointer to the next notification (NULL if there is no one) */
1204 const char *name; /**< grouping name reference (mandatory) */
1205 const char *dsc; /**< description statement */
1206 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001207 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1208 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1209 };
1210 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001211
1212 /* notif */
1213 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001214 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1215 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001216 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001217};
1218
1219/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001220 * @brief YANG grouping-stmt
1221 */
1222struct lysp_node_grp {
1223 union {
1224 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1225 struct {
1226 struct lysp_node *parent;/**< parent node (NULL if this is a top-level grouping) */
1227 uint16_t nodetype; /**< LYS_GROUPING */
1228 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1229 struct lysp_node_grp *next; /**< pointer to the next grouping (NULL if there is no one) */
1230 const char *name; /**< grouping name (mandatory) */
1231 const char *dsc; /**< description statement */
1232 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001233 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1234 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1235 };
1236 }; /**< common part corresponding to ::lysp_node */
1237
1238 /* grp */
1239 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1240 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001241 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001242 struct lysp_node_action *actions; /**< list of actions (linked list) */
1243 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1244};
1245
1246/**
1247 * @brief YANG uses-augment-stmt and augment-stmt (compatible with struct lysp_node )
1248 */
1249struct lysp_node_augment {
1250 union {
1251 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1252 struct {
1253 struct lysp_node *parent;/**< parent node (NULL if this is a top-level augment) */
1254 uint16_t nodetype; /**< LYS_AUGMENT */
1255 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1256 struct lysp_node_augment *next; /**< pointer to the next augment (NULL if there is no one) */
1257 const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */
1258 const char *dsc; /**< description statement */
1259 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001260 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1261 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1262 };
1263 }; /**< common part corresponding to ::lysp_node */
1264
1265 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001266 struct lysp_when *when; /**< when statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001267 struct lysp_node_action *actions;/**< list of actions (linked list) */
1268 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1269};
1270
1271/**
Radek Krejcif0fceb62018-09-05 14:58:45 +02001272 * @brief supported YANG schema version values
1273 */
1274typedef enum LYS_VERSION {
1275 LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */
Radek Krejci96e48da2020-09-04 13:18:06 +02001276 LYS_VERSION_1_0 = 1, /**< YANG 1 (1.0) */
Radek Krejcif0fceb62018-09-05 14:58:45 +02001277 LYS_VERSION_1_1 = 2 /**< YANG 1.1 */
1278} LYS_VERSION;
1279
1280/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001281 * @brief Printable YANG schema tree structure representing YANG module.
1282 *
1283 * Simple structure corresponding to the YANG format. The schema is only syntactically validated.
1284 */
1285struct lysp_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001286 struct lys_module *mod; /**< covering module structure */
1287
Radek Krejcib7db73a2018-10-24 14:18:40 +02001288 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1289 in the list is always the last (newest) revision of the module */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001290 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1291 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001292 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1293 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1294 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1295 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001296 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001297 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001298 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1299 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1300 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001301 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001302 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001303
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001304 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001305 uint8_t parsing : 1; /**< flag for circular check */
1306 uint8_t is_submod : 1; /**< always 0 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001307};
1308
1309struct lysp_submodule {
Michal Vaskoc3781c32020-10-06 14:04:08 +02001310 struct lys_module *mod; /**< belongs to parent module (submodule - mandatory) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001311
1312 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1313 in the list is always the last (newest) revision of the module */
1314 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1315 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
1316 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1317 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1318 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1319 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001320 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001321 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001322 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1323 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1324 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001325 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001326 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001327
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001328 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001329 uint8_t parsing : 1; /**< flag for circular check */
1330 uint8_t is_submod : 1; /**< always 1 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001331
Michal Vaskoc3781c32020-10-06 14:04:08 +02001332 uint8_t latest_revision : 2; /**< flag to mark the latest available revision:
Radek Krejci086c7132018-10-26 15:29:04 +02001333 1 - the latest revision in searchdirs was not searched yet and this is the
1334 latest revision in the current context
1335 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001336 const char *name; /**< name of the module (mandatory) */
1337 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1338 const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */
1339 const char *org; /**< party/company responsible for the module */
1340 const char *contact; /**< contact information for the module */
1341 const char *dsc; /**< description of the module */
1342 const char *ref; /**< cross-reference for the module */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001343};
1344
1345/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001346 * @brief Get the parsed module or submodule name.
1347 *
1348 * @param[in] PMOD Parsed module or submodule.
1349 * @return Module or submodule name.
1350 */
1351#define LYSP_MODULE_NAME(PMOD) (PMOD->is_submod ? ((struct lysp_submodule *)PMOD)->name : ((struct lysp_module *)PMOD)->mod->name)
1352
1353/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001354 * @brief Compiled prefix data pair mapping of prefixes to modules. In case the format is ::LY_PREF_SCHEMA_RESOLVED,
1355 * the expected prefix data is a sized array of these structures.
1356 */
1357struct lysc_prefix {
1358 char *prefix; /**< used prefix */
1359 const struct lys_module *mod; /**< mapping to a module */
1360};
1361
1362/**
Radek Krejci0e59c312019-08-15 15:34:15 +02001363 * @brief Compiled YANG extension-stmt
1364 */
1365struct lysc_ext {
1366 const char *name; /**< extension name */
1367 const char *argument; /**< argument name, NULL if not specified */
Radek Krejci0e59c312019-08-15 15:34:15 +02001368 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1369 struct lyext_plugin *plugin; /**< Plugin implementing the specific extension */
Radek Krejci0935f412019-08-20 16:15:18 +02001370 struct lys_module *module; /**< module structure */
Michal Vasko6f4cbb62020-02-28 11:15:47 +01001371 uint32_t refcount; /**< reference counter since extension definition is shared among all its instances */
Radek Krejci0e59c312019-08-15 15:34:15 +02001372 uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */
1373};
1374
1375/**
Radek Krejcice8c1592018-10-29 15:35:51 +01001376 * @brief YANG extension instance
1377 */
1378struct lysc_ext_instance {
Radek Krejciad5963b2019-09-06 16:03:05 +02001379 uint32_t insubstmt_index; /**< in case the instance is in a substatement that can appear multiple times,
1380 this identifies the index of the substatement for this extension instance */
Radek Krejci28681fa2019-09-06 13:08:45 +02001381 struct lys_module *module; /**< module where the extension instantiated is defined */
Radek Krejciad5963b2019-09-06 16:03:05 +02001382 struct lysc_ext *def; /**< pointer to the extension definition */
Radek Krejcice8c1592018-10-29 15:35:51 +01001383 void *parent; /**< pointer to the parent element holding the extension instance(s), use
1384 ::lysc_ext_instance#parent_type to access the schema element */
1385 const char *argument; /**< optional value of the extension's argument */
1386 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Radek Krejci2a408df2018-10-29 16:32:26 +01001387 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001388 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0e59c312019-08-15 15:34:15 +02001389 void *data; /**< private plugins's data, not used by libyang */
Radek Krejcice8c1592018-10-29 15:35:51 +01001390};
1391
1392/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001393 * @brief YANG when-stmt
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001394 */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001395struct lysc_when {
1396 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko175012e2019-11-06 15:49:14 +01001397 struct lysc_node *context; /**< context node for evaluating the expression, NULL if the context is root node */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001398 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001399 const char *dsc; /**< description */
1400 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001401 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00b874b2019-02-12 10:54:50 +01001402 uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */
Michal Vaskoecd62de2019-11-13 12:35:11 +01001403 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS is allowed */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001404};
1405
1406/**
Radek Krejci2a408df2018-10-29 16:32:26 +01001407 * @brief YANG identity-stmt
1408 */
1409struct lysc_ident {
1410 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejcic8b31002019-01-08 10:24:45 +01001411 const char *dsc; /**< description */
1412 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001413 struct lys_module *module; /**< module structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001414 struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */
1415 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1416 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
1417};
1418
1419/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001420 * @defgroup ifftokens if-feature expression tokens
Radek Krejci8678fa42020-08-18 16:07:28 +02001421 * Tokens of if-feature expression used in ::lysc_iffeature.expr.
Radek Krejci151a5b72018-10-19 14:21:44 +02001422 *
1423 * @{
1424 */
1425#define LYS_IFF_NOT 0x00 /**< operand "not" */
1426#define LYS_IFF_AND 0x01 /**< operand "and" */
1427#define LYS_IFF_OR 0x02 /**< operand "or" */
1428#define LYS_IFF_F 0x03 /**< feature */
Radek Krejci2ff0d572020-05-21 15:27:28 +02001429/** @} ifftokens */
Radek Krejci151a5b72018-10-19 14:21:44 +02001430
1431/**
Radek Krejcib7db73a2018-10-24 14:18:40 +02001432 * @brief Compiled YANG revision statement
1433 */
1434struct lysc_revision {
1435 char date[LY_REV_SIZE]; /**< revision-date (mandatory) */
1436 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1437};
1438
Radek Krejci2167ee12018-11-02 16:09:07 +01001439struct lysc_range {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001440 struct lysc_range_part {
Radek Krejci693262f2019-04-29 15:23:20 +02001441 union { /**< min boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001442 int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1443 uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001444 };
Radek Krejci693262f2019-04-29 15:23:20 +02001445 union { /**< max boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001446 int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1447 uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001448 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001449 } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001450 const char *dsc; /**< description */
1451 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001452 const char *emsg; /**< error-message */
1453 const char *eapptag; /**< error-app-tag value */
1454 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1455};
1456
1457struct lysc_pattern {
Radek Krejci54579462019-04-30 12:47:06 +02001458 const char *expr; /**< original, not compiled, regular expression */
1459 pcre2_code *code; /**< compiled regular expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001460 const char *dsc; /**< description */
1461 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001462 const char *emsg; /**< error-message */
1463 const char *eapptag; /**< error-app-tag value */
1464 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0f969882020-08-21 16:56:47 +02001465 uint32_t inverted : 1; /**< invert-match flag */
1466 uint32_t refcount : 31; /**< reference counter */
Radek Krejci2167ee12018-11-02 16:09:07 +01001467};
1468
1469struct lysc_must {
Radek Krejci2167ee12018-11-02 16:09:07 +01001470 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001471 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001472 const char *dsc; /**< description */
1473 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001474 const char *emsg; /**< error-message */
1475 const char *eapptag; /**< error-app-tag value */
1476 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1477};
1478
1479struct lysc_type {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001480 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001481 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 +01001482 LY_DATA_TYPE basetype; /**< Base type of the type */
1483 uint32_t refcount; /**< reference counter for type sharing */
1484};
1485
1486struct lysc_type_num {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001487 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001488 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 +01001489 LY_DATA_TYPE basetype; /**< Base type of the type */
1490 uint32_t refcount; /**< reference counter for type sharing */
1491 struct lysc_range *range; /**< Optional range limitation */
1492};
1493
1494struct lysc_type_dec {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001495 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001496 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 +01001497 LY_DATA_TYPE basetype; /**< Base type of the type */
1498 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci6cba4292018-11-15 17:33:29 +01001499 uint8_t fraction_digits; /**< fraction digits specification */
Radek Krejci2167ee12018-11-02 16:09:07 +01001500 struct lysc_range *range; /**< Optional range limitation */
1501};
1502
1503struct lysc_type_str {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001504 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001505 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 +01001506 LY_DATA_TYPE basetype; /**< Base type of the type */
1507 uint32_t refcount; /**< reference counter for type sharing */
1508 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci4586a022018-11-13 11:29:26 +01001509 struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001510};
1511
Radek Krejci693262f2019-04-29 15:23:20 +02001512struct lysc_type_bitenum_item {
1513 const char *name; /**< enumeration identifier */
1514 const char *dsc; /**< description */
1515 const char *ref; /**< reference */
1516 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci693262f2019-04-29 15:23:20 +02001517 union {
1518 int32_t value; /**< integer value associated with the enumeration */
1519 uint32_t position; /**< non-negative integer value associated with the bit */
1520 };
1521 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
1522 values are allowed */
1523};
1524
Radek Krejci2167ee12018-11-02 16:09:07 +01001525struct lysc_type_enum {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001526 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001527 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 +01001528 LY_DATA_TYPE basetype; /**< Base type of the type */
1529 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci693262f2019-04-29 15:23:20 +02001530 struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1531};
1532
1533struct lysc_type_bits {
1534 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001535 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 +02001536 LY_DATA_TYPE basetype; /**< Base type of the type */
1537 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci849a62a2019-05-22 15:29:05 +02001538 struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item),
1539 the items are ordered by their position value. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001540};
1541
1542struct lysc_type_leafref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001543 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001544 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 +01001545 LY_DATA_TYPE basetype; /**< Base type of the type */
1546 uint32_t refcount; /**< reference counter for type sharing */
Michal Vasko004d3152020-06-11 19:59:22 +02001547 struct lyxp_expr *path; /**< parsed target path, compiled path cannot be stored because of type sharing */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001548 struct lysc_prefix *prefixes; /**< resolved prefixes used in the path */
Michal Vaskoc0792ca2020-12-01 12:03:21 +01001549 const struct lys_module *cur_mod;/**< current module for the leafref (path) */
Radek Krejci412ddfa2018-11-23 11:44:11 +01001550 struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001551 uint8_t require_instance; /**< require-instance flag */
1552};
1553
1554struct lysc_type_identityref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001555 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001556 struct lysc_type_plugin *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001557 LY_DATA_TYPE basetype; /**< Base type of the type */
1558 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci555cb5b2018-11-16 14:54:33 +01001559 struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)),
Radek Krejci2167ee12018-11-02 16:09:07 +01001560 mandatory (at least 1 item) */
1561};
1562
1563struct lysc_type_instanceid {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001564 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001565 struct lysc_type_plugin *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001566 LY_DATA_TYPE basetype; /**< Base type of the type */
1567 uint32_t refcount; /**< reference counter for type sharing */
1568 uint8_t require_instance; /**< require-instance flag */
1569};
1570
Radek Krejci2167ee12018-11-02 16:09:07 +01001571struct lysc_type_union {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001572 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001573 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 +01001574 LY_DATA_TYPE basetype; /**< Base type of the type */
1575 uint32_t refcount; /**< reference counter for type sharing */
1576 struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1577};
1578
1579struct lysc_type_bin {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001580 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001581 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 +01001582 LY_DATA_TYPE basetype; /**< Base type of the type */
1583 uint32_t refcount; /**< reference counter for type sharing */
1584 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001585};
1586
Michal Vasko60ea6352020-06-29 13:39:39 +02001587/**
1588 * @brief Maximum number of hashes stored in a schema node.
1589 */
1590#define LYS_NODE_HASH_COUNT 4
1591
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001592/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001593 * @brief Compiled YANG data node
1594 */
1595struct lysc_node {
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001596 uint16_t nodetype; /**< type of the node (mandatory) */
1597 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Michal Vasko60ea6352020-06-29 13:39:39 +02001598 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001599 struct lys_module *module; /**< module structure */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001600 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1601 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1602 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1603 never NULL. If there is no sibling node, pointer points to the node
1604 itself. In case of the first node, this pointer points to the last
1605 node in the list. */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001606 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001607 const char *dsc; /**< description */
1608 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001609 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko2fd91b92020-07-17 16:39:02 +02001610 void *priv; /**< private arbitrary user data, not used by libyang */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001611};
1612
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001613struct lysc_node_action_inout {
1614 union {
1615 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1616 struct {
1617 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1618 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1619 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1620 struct lys_module *module; /**< module structure */
Radek Krejci5960c312021-01-27 20:24:22 +01001621 struct lysc_node *parent;/**< parent node (NULL in case of top level node) */
1622 struct lysc_node *next; /**< NULL */
1623 struct lysc_node *prev; /**< pointer to the node itself - compatibility with ::lysc_node, input and output are
1624 supposed to be a separated subtrees, so they do not link each other as siblings. */
1625 const char *name; /**< "input" or "output" */
1626 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysc_node */
1627 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysc_node */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001628 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001629 void *priv; /** private arbitrary user data, not used by libyang */
1630 };
1631 };
1632
Radek Krejci9a3823e2021-01-27 20:26:46 +01001633 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001634 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1635};
1636
1637struct lysc_node_action {
1638 union {
1639 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1640 struct {
1641 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1642 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1643 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1644 struct lys_module *module; /**< module structure */
1645 struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */
1646 struct lysc_node_action *next; /**< next sibling node (NULL if there is no one) */
1647 struct lysc_node_action *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1648 never NULL. If there is no sibling node, pointer points to the node
1649 itself. In case of the first node, this pointer points to the last
1650 node in the list. */
1651 const char *name; /**< action/RPC name (mandatory) */
1652 const char *dsc; /**< description */
1653 const char *ref; /**< reference */
1654 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001655 void *priv; /** private arbitrary user data, not used by libyang */
1656 };
1657 };
1658
Radek Krejci9a3823e2021-01-27 20:26:46 +01001659 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1660 the action/RPC nodes do not contain the when statement on their own, but they can
1661 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001662 struct lysc_node_action_inout input; /**< RPC's/action's input */
1663 struct lysc_node_action_inout output; /**< RPC's/action's output */
1664
1665};
1666
1667struct lysc_node_notif {
1668 union {
1669 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1670 struct {
1671 uint16_t nodetype; /**< LYS_NOTIF */
1672 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1673 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1674 struct lys_module *module; /**< module structure */
1675 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1676 struct lysc_node_notif *next; /**< next sibling node (NULL if there is no one) */
1677 struct lysc_node_notif *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1678 never NULL. If there is no sibling node, pointer points to the node
1679 itself. In case of the first node, this pointer points to the last
1680 node in the list. */
1681 const char *name; /**< Notification name (mandatory) */
1682 const char *dsc; /**< description */
1683 const char *ref; /**< reference */
1684 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001685 void *priv; /** private arbitrary user data, not used by libyang */
1686 };
1687 };
1688
Radek Krejci9a3823e2021-01-27 20:26:46 +01001689 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001690 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001691 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1692 the notification nodes do not contain the when statement on their own, but they can
1693 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001694};
1695
1696struct lysc_node_container {
1697 union {
1698 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1699 struct {
1700 uint16_t nodetype; /**< LYS_CONTAINER */
1701 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1702 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1703 struct lys_module *module; /**< module structure */
1704 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1705 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1706 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1707 never NULL. If there is no sibling node, pointer points to the node
1708 itself. In case of the first node, this pointer points to the last
1709 node in the list. */
1710 const char *name; /**< node name (mandatory) */
1711 const char *dsc; /**< description */
1712 const char *ref; /**< reference */
1713 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001714 void *priv; /**< private arbitrary user data, not used by libyang */
1715 };
1716 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001717
1718 struct lysc_node *child; /**< first child node (linked list) */
1719 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001720 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001721 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1722 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001723};
1724
Radek Krejcia3045382018-11-22 14:30:31 +01001725struct lysc_node_case {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001726 union {
1727 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1728 struct {
1729 uint16_t nodetype; /**< LYS_CASE */
1730 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1731 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1732 struct lys_module *module; /**< module structure */
1733 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1734 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1735 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejci056d0a82018-12-06 16:57:25 +01001736 never NULL. If there is no sibling node, pointer points to the node
1737 itself. In case of the first node, this pointer points to the last
1738 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001739 const char *name; /**< name of the case, including the implicit case */
1740 const char *dsc; /**< description */
1741 const char *ref; /**< reference */
1742 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001743 void *priv; /**< private arbitrary user data, not used by libyang */
1744 };
1745 };
Radek Krejci056d0a82018-12-06 16:57:25 +01001746
Radek Krejcia3045382018-11-22 14:30:31 +01001747 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 +01001748 each other as siblings with the parent pointer pointing to appropriate case node. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001749 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcia3045382018-11-22 14:30:31 +01001750};
1751
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001752struct lysc_node_choice {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001753 union {
1754 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1755 struct {
1756 uint16_t nodetype; /**< LYS_CHOICE */
1757 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1758 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1759 struct lys_module *module; /**< module structure */
1760 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1761 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1762 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001763 never NULL. If there is no sibling node, pointer points to the node
1764 itself. In case of the first node, this pointer points to the last
1765 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001766 const char *name; /**< node name (mandatory) */
1767 const char *dsc; /**< description */
1768 const char *ref; /**< reference */
1769 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001770 void *priv; /**< private arbitrary user data, not used by libyang */
1771 };
1772 };
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001773
Radek Krejcia9026eb2018-12-12 16:04:47 +01001774 struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other
1775 as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the
1776 case is simple. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001777 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001778 struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001779};
1780
1781struct lysc_node_leaf {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001782 union {
1783 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1784 struct {
1785 uint16_t nodetype; /**< LYS_LEAF */
1786 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1787 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1788 struct lys_module *module; /**< module structure */
1789 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1790 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1791 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001792 never NULL. If there is no sibling node, pointer points to the node
1793 itself. In case of the first node, this pointer points to the last
1794 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001795 const char *name; /**< node name (mandatory) */
1796 const char *dsc; /**< description */
1797 const char *ref; /**< reference */
1798 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001799 void *priv; /**< private arbitrary user data, not used by libyang */
1800 };
1801 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001802
1803 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001804 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001805 struct lysc_type *type; /**< type of the leaf node (mandatory) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001806
Radek Krejci4f28eda2018-11-12 11:46:16 +01001807 const char *units; /**< units of the leaf's type */
Radek Krejcia1911222019-07-22 17:24:50 +02001808 struct lyd_value *dflt; /**< default value */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001809};
1810
1811struct lysc_node_leaflist {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001812 union {
1813 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1814 struct {
1815 uint16_t nodetype; /**< LYS_LEAFLIST */
1816 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1817 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1818 struct lys_module *module; /**< module structure */
1819 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1820 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1821 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001822 never NULL. If there is no sibling node, pointer points to the node
1823 itself. In case of the first node, this pointer points to the last
1824 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001825 const char *name; /**< node name (mandatory) */
1826 const char *dsc; /**< description */
1827 const char *ref; /**< reference */
1828 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001829 void *priv; /**< private arbitrary user data, not used by libyang */
1830 };
1831 };
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001832
1833 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001834 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001835 struct lysc_type *type; /**< type of the leaf node (mandatory) */
1836
Radek Krejci0e5d8382018-11-28 16:37:53 +01001837 const char *units; /**< units of the leaf's type */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001838 struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */
Michal Vaskoba99a3e2020-08-18 15:50:05 +02001839
Radek Krejci0e5d8382018-11-28 16:37:53 +01001840 uint32_t min; /**< min-elements constraint */
1841 uint32_t max; /**< max-elements constraint */
1842
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001843};
1844
1845struct lysc_node_list {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001846 union {
1847 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1848 struct {
1849 uint16_t nodetype; /**< LYS_LIST */
1850 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1851 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1852 struct lys_module *module; /**< module structure */
1853 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1854 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1855 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001856 never NULL. If there is no sibling node, pointer points to the node
1857 itself. In case of the first node, this pointer points to the last
1858 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001859 const char *name; /**< node name (mandatory) */
1860 const char *dsc; /**< description */
1861 const char *ref; /**< reference */
1862 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001863 void *priv; /**< private arbitrary user data, not used by libyang */
1864 };
1865 };
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001866
1867 struct lysc_node *child; /**< first child node (linked list) */
1868 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001869 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001870 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1871 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001872
Radek Krejci2a9fc652021-01-22 17:44:34 +01001873 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 +01001874 uint32_t min; /**< min-elements constraint */
1875 uint32_t max; /**< max-elements constraint */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001876};
1877
1878struct lysc_node_anydata {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001879 union {
1880 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1881 struct {
1882 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1883 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1884 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1885 struct lys_module *module; /**< module structure */
1886 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1887 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1888 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001889 never NULL. If there is no sibling node, pointer points to the node
1890 itself. In case of the first node, this pointer points to the last
1891 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001892 const char *name; /**< node name (mandatory) */
1893 const char *dsc; /**< description */
1894 const char *ref; /**< reference */
1895 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001896 void *priv; /**< private arbitrary user data, not used by libyang */
1897 };
1898 };
Radek Krejci9800fb82018-12-13 14:26:23 +01001899
1900 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001901 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001902};
1903
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001904/**
1905 * @brief Compiled YANG schema tree structure representing YANG module.
1906 *
1907 * Semantically validated YANG schema tree for data tree parsing.
1908 * Contains only the necessary information for the data validation.
1909 */
1910struct lysc_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001911 struct lys_module *mod; /**< covering module structure */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001912
Radek Krejci2a408df2018-10-29 16:32:26 +01001913 struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001914 struct lysc_node_action *rpcs; /**< first of actions nodes (linked list) */
1915 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001916 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001917};
1918
1919/**
Radek Krejci490a5462020-11-05 08:44:42 +01001920 * @brief Examine whether a node is user-ordered list or leaf-list.
1921 *
1922 * @param[in] lysc_node Schema node to examine.
1923 * @return Boolean value whether the @p node is user-ordered or not.
1924 */
1925#define lysc_is_userordered(lysc_node) \
1926 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAFLIST | LYS_LIST)) || !(lysc_node->flags & LYS_ORDBY_USER)) ? 0 : 1)
1927
1928/**
1929 * @brief Examine whether a node is a list's key.
1930 *
1931 * @param[in] lysc_node Schema node to examine.
1932 * @return Boolean value whether the @p node is a key or not.
1933 */
1934#define lysc_is_key(lysc_node) \
1935 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAF)) || !(lysc_node->flags & LYS_KEY)) ? 0 : 1)
1936
1937/**
Michal Vasko5c123b02020-12-04 14:34:04 +01001938 * @brief Examine whether a node is a non-presence container.
1939 *
1940 * @param[in] lysc_node Schema node to examine.
1941 * @return Boolean value whether the @p node is a NP container or not.
1942 */
1943#define lysc_is_np_cont(lysc_node) \
1944 ((!lysc_node || !(lysc_node->nodetype & (LYS_CONTAINER)) || (lysc_node->flags & LYS_PRESENCE)) ? 0 : 1)
1945
1946/**
Michal Vaskod5cfa6e2020-11-23 16:56:08 +01001947 * @brief Check whether the schema node data instance existence depends on any when conditions.
1948 * This node and any direct parent choice and case schema nodes are also examined for when conditions.
1949 *
1950 * Be careful, this function is not recursive and checks only conditions that apply to this node directly.
1951 * Meaning if there are any conditions associated with any data parent instance of @p node, they are not returned.
1952 *
1953 * @param[in] node Schema node to examine.
1954 * @return When condition associated with the node data instance, NULL if there is none.
1955 */
1956const struct lysc_when *lysc_has_when(const struct lysc_node *node);
1957
1958/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001959 * @brief Get the groupings linked list of the given (parsed) schema node.
Radek Krejci53ea6152018-12-13 15:21:15 +01001960 * Decides the node's type and in case it has a groupings array, returns it.
1961 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001962 * @return The node's groupings linked list if any, NULL otherwise.
Radek Krejci53ea6152018-12-13 15:21:15 +01001963 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001964const struct lysp_node_grp *lysp_node_groupings(const struct lysp_node *node);
Radek Krejci53ea6152018-12-13 15:21:15 +01001965
1966/**
Radek Krejci056d0a82018-12-06 16:57:25 +01001967 * @brief Get the typedefs sized array of the given (parsed) schema node.
1968 * Decides the node's type and in case it has a typedefs array, returns it.
1969 * @param[in] node Node to examine.
1970 * @return The node's typedefs sized array if any, NULL otherwise.
1971 */
1972const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
1973
1974/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001975 * @brief Get the actions/RPCs linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001976 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1977 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001978 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01001979 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001980const struct lysp_node_action *lysp_node_actions(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01001981
1982/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001983 * @brief Get the Notifications linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001984 * Decides the node's type and in case it has a Notifications array, returns it.
1985 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001986 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01001987 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001988const struct lysp_node_notif *lysp_node_notifs(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01001989
1990/**
1991 * @brief Get the children linked list of the given (parsed) schema node.
1992 * Decides the node's type and in case it has a children list, returns it.
1993 * @param[in] node Node to examine.
1994 * @return The node's children linked list if any, NULL otherwise.
1995 */
1996const struct lysp_node *lysp_node_children(const struct lysp_node *node);
1997
1998/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001999 * @brief Get the actions/RPCs linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002000 * Decides the node's type and in case it has a actions/RPCs array, returns it.
2001 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002002 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002003 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002004const struct lysc_node_action *lysc_node_actions(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002005
2006/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002007 * @brief Get the Notifications linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002008 * Decides the node's type and in case it has a Notifications array, returns it.
2009 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002010 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002011 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002012const struct lysc_node_notif *lysc_node_notifs(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002013
2014/**
2015 * @brief Get the children linked list of the given (compiled) schema node.
Michal Vasko2a668712020-10-21 11:48:09 +02002016 *
2017 * @param[in] node Node to examine.
Michal Vaskod1e53b92021-01-28 13:11:06 +01002018 * @param[in] flags Flag to distinguish input (LYS_IS_INPUT) and output (LYS_IS_OUTPUT) child in case of RPC/action node.
Michal Vasko2a668712020-10-21 11:48:09 +02002019 * @return Children linked list if any,
2020 * @return NULL otherwise.
2021 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002022const struct lysc_node *lysc_node_children(const struct lysc_node *node, uint16_t flags);
Michal Vasko2a668712020-10-21 11:48:09 +02002023
2024/**
Radek Krejci9a3823e2021-01-27 20:26:46 +01002025 * @brief Get the must statements list if present in the @p node
2026 *
2027 * @param[in] node Node to examine.
2028 * @return Pointer to the list of must restrictions ([sized array](@ref sizedarrays))
2029 * @return NULL if there is no must statement in the node, no matter if it is not even allowed or just present
2030 */
2031struct lysc_must *lysc_node_musts(const struct lysc_node *node);
2032
2033/**
2034 * @brief Get the when statements list if present in the @p node
2035 *
2036 * @param[in] node Node to examine.
2037 * @return Pointer to the list of pointers to when statements ([sized array](@ref sizedarrays))
2038 * @return NULL if there is no when statement in the node, no matter if it is not even allowed or just present
2039 */
2040struct lysc_when **lysc_node_when(const struct lysc_node *node);
2041
2042/**
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002043 * @brief Callback to be called for every schema node in a DFS traversal.
2044 *
2045 * @param[in] node Current node.
2046 * @param[in] data Arbitrary user data.
2047 * @param[out] dfs_continue Set to true if the current subtree should be skipped and continue with siblings instead.
2048 * @return LY_SUCCESS on success,
2049 * @return LY_ERR value to terminate DFS and return this value.
2050 */
Radek Krejci01180ac2021-01-27 08:48:22 +01002051typedef LY_ERR (*lysc_dfs_clb)(struct lysc_node *node, void *child, ly_bool *dfs_continue);
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002052
2053/**
2054 * @brief DFS traversal of all the schema nodes in a (sub)tree including any actions and nested notifications.
2055 *
2056 * Node with children, actions, and notifications is traversed in this order:
2057 * 1) each child subtree;
2058 * 2) each action subtree;
2059 * 3) each notification subtree.
2060 *
2061 * For algorithm illustration or traversal with actions and notifications skipped, see ::LYSC_TREE_DFS_BEGIN.
2062 *
2063 * @param[in] root Schema root to fully traverse.
2064 * @param[in] dfs_clb Callback to call for each node.
2065 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2066 * @return LY_SUCCESS on success,
2067 * @return LY_ERR value returned by @p dfs_clb.
2068 */
2069LY_ERR lysc_tree_dfs_full(const struct lysc_node *root, lysc_dfs_clb dfs_clb, void *data);
2070
2071/**
2072 * @brief DFS traversal of all the schema nodes in a module including RPCs and notifications.
2073 *
2074 * For more details, see ::lysc_tree_dfs_full().
2075 *
2076 * @param[in] mod Module to fully traverse.
2077 * @param[in] dfs_clb Callback to call for each node.
2078 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2079 * @return LY_SUCCESS on success,
2080 * @return LY_ERR value returned by @p dfs_clb.
2081 */
2082LY_ERR lysc_module_dfs_full(const struct lys_module *mod, lysc_dfs_clb dfs_clb, void *data);
2083
2084/**
Radek Krejci151a5b72018-10-19 14:21:44 +02002085 * @brief Get how the if-feature statement currently evaluates.
2086 *
2087 * @param[in] iff Compiled if-feature statement to evaluate.
Michal Vasko28d78432020-05-26 13:10:53 +02002088 * @return LY_SUCCESS if the statement evaluates to true,
2089 * @return LY_ENOT if it evaluates to false,
2090 * @return LY_ERR on error.
Radek Krejci151a5b72018-10-19 14:21:44 +02002091 */
Michal Vasko28d78432020-05-26 13:10:53 +02002092LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff);
Radek Krejci151a5b72018-10-19 14:21:44 +02002093
2094/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002095 * @brief Get the next feature in the module or submodules.
Radek Krejci151a5b72018-10-19 14:21:44 +02002096 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002097 * @param[in] last Last returned feature.
2098 * @param[in] pmod Parsed module and submodoules whose features to iterate over.
2099 * @param[in,out] idx Submodule index, set to 0 on first call.
2100 * @return Next found feature, NULL if the last has already been returned.
Radek Krejci151a5b72018-10-19 14:21:44 +02002101 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002102struct 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 +02002103
Radek Krejcibed13942020-10-19 16:06:28 +02002104/**
2105 * @defgroup findxpathoptions Atomize XPath options
2106 * Options to modify behavior of ::lys_find_xpath() and ::lys_find_xpath_atoms() searching for schema nodes in schema tree.
2107 * @{
2108 */
Michal Vaskocdad7122020-11-09 21:04:44 +01002109#define LYS_FIND_XP_SCHEMA 0x08 /**< Apply node access restrictions defined for 'when' and 'must' evaluation. */
2110#define LYS_FIND_XP_OUTPUT 0x10 /**< Search RPC/action output nodes instead of input ones. */
Radek Krejci576f8fa2020-10-26 21:23:58 +01002111/** @} findxpathoptions */
Michal Vasko072de482020-08-05 13:27:21 +02002112
Radek Krejci151a5b72018-10-19 14:21:44 +02002113/**
Michal Vasko40308e72020-10-20 16:38:40 +02002114 * @brief Get all the schema nodes that are required for @p xpath to be evaluated (atoms).
Michal Vasko519fd602020-05-26 12:17:39 +02002115 *
Michal Vasko26512682021-01-11 11:35:40 +01002116 * @param[in] ctx libyang context to use. May be NULL if @p ctx_node is set.
2117 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002118 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002119 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko519fd602020-05-26 12:17:39 +02002120 * @param[out] set Set of found atoms (schema nodes).
2121 * @return LY_SUCCESS on success, @p set is returned.
Michal Vasko40308e72020-10-20 16:38:40 +02002122 * @return LY_ERR value on error.
Michal Vasko519fd602020-05-26 12:17:39 +02002123 */
Michal Vasko26512682021-01-11 11:35:40 +01002124LY_ERR lys_find_xpath_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
2125 uint32_t options, struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002126
Michal Vasko072de482020-08-05 13:27:21 +02002127/**
Michal Vasko40308e72020-10-20 16:38:40 +02002128 * @brief Get all the schema nodes that are required for @p expr to be evaluated (atoms).
Michal Vasko072de482020-08-05 13:27:21 +02002129 *
Michal Vasko26512682021-01-11 11:35:40 +01002130 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002131 * @param[in] cur_mod Current module for the expression (where it was "instantiated").
2132 * @param[in] expr Parsed expression to use.
2133 * @param[in] prefixes Sized array of compiled prefixes.
2134 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
2135 * @param[out] set Set of found atoms (schema nodes).
2136 * @return LY_SUCCESS on success, @p set is returned.
2137 * @return LY_ERR value on error.
2138 */
2139LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod,
2140 const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set);
2141
2142/**
2143 * @brief Evaluate an @p xpath expression on schema nodes.
2144 *
Michal Vasko26512682021-01-11 11:35:40 +01002145 * @param[in] ctx libyang context to use for absolute @p xpath. May be NULL if @p ctx_node is set.
2146 * @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 +02002147 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002148 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko072de482020-08-05 13:27:21 +02002149 * @param[out] set Set of found schema nodes.
2150 * @return LY_SUCCESS on success, @p set is returned.
2151 * @return LY_ERR value if an error occurred.
2152 */
Michal Vasko26512682021-01-11 11:35:40 +01002153LY_ERR lys_find_xpath(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath, uint32_t options,
2154 struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002155
2156/**
Radek Krejcibc5644c2020-10-27 14:53:17 +01002157 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2158 *
2159 * @param[in] path Compiled path to use.
2160 * @param[out] set Set of found atoms (schema nodes).
2161 * @return LY_SUCCESS on success, @p set is returned.
2162 * @return LY_ERR value on error.
2163 */
2164LY_ERR lys_find_lypath_atoms(const struct ly_path *path, struct ly_set **set);
2165
2166/**
2167 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2168 *
Michal Vasko26512682021-01-11 11:35:40 +01002169 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2170 * @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 +01002171 * @param[in] path JSON path to examine.
2172 * @param[in] output Search operation output instead of input.
2173 * @param[out] set Set of found atoms (schema nodes).
2174 * @return LY_ERR value on error.
2175 */
2176LY_ERR lys_find_path_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path, ly_bool output,
2177 struct ly_set **set);
2178
2179/**
2180 * @brief Get a schema node based on the given data path (JSON format, see @ref howtoXPath).
2181 *
Michal Vasko26512682021-01-11 11:35:40 +01002182 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2183 * @param[in] ctx_node XPath schema context node for relative @p path. Use NULL for the root node.
Radek Krejcibc5644c2020-10-27 14:53:17 +01002184 * @param[in] path JSON path of the node to get.
2185 * @param[in] output Search operation output instead of input.
2186 * @return Found schema node or NULL.
2187 */
2188const struct lysc_node *lys_find_path(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path,
2189 ly_bool output);
2190
2191/**
Michal Vasko03ff5a72019-09-11 13:49:33 +02002192 * @brief Types of the different schema paths.
2193 */
2194typedef enum {
Michal Vasko65de0402020-08-03 16:34:19 +02002195 LYSC_PATH_LOG, /**< Descriptive path format used in log messages */
2196 LYSC_PATH_DATA /**< Similar to ::LYSC_PATH_LOG except that schema-only nodes (choice, case) are skipped */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002197} LYSC_PATH_TYPE;
2198
2199/**
Radek Krejci327de162019-06-14 12:52:07 +02002200 * @brief Generate path of the given node in the requested format.
2201 *
2202 * @param[in] node Schema path of this node will be generated.
2203 * @param[in] pathtype Format of the path to generate.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002204 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
2205 * If NULL, memory for the complete path is allocated.
2206 * @param[in] buflen Size of the provided @p buffer.
Radek Krejci327de162019-06-14 12:52:07 +02002207 * @return NULL in case of memory allocation error, path of the node otherwise.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002208 * 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 +02002209 */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002210char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
Radek Krejci327de162019-06-14 12:52:07 +02002211
2212/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002213 * @brief Available YANG schema tree structures representing YANG module.
2214 */
2215struct lys_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002216 struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */
2217 const char *name; /**< name of the module (mandatory) */
Radek Krejci0af46292019-01-11 16:02:31 +01002218 const char *revision; /**< revision of the module (if present) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002219 const char *ns; /**< namespace of the module (module - mandatory) */
2220 const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */
2221 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
2222 const char *org; /**< party/company responsible for the module */
2223 const char *contact; /**< contact information for the module */
2224 const char *dsc; /**< description of the module */
2225 const char *ref; /**< cross-reference for the module */
2226
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002227 struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */
Radek Krejci0af46292019-01-11 16:02:31 +01002228 struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing.
2229 Available only for implemented modules. */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002230
Radek Krejci80d281e2020-09-14 17:42:54 +02002231 struct lysc_ident *identities; /**< List of compiled identities of the module ([sized array](@ref sizedarrays))
2232 Identities are outside the compiled tree to allow their linkage to the identities from
2233 the implemented modules. This avoids problems when the module became implemented in
2234 future (no matter if implicitly via augment/deviate or explicitly via
2235 ::lys_set_implemented()). Note that if the module is not implemented (compiled), the
2236 identities cannot be instantiated in data (in identityrefs). */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002237
2238 struct lys_module **augmented_by;/**< List of modules that augment this module ([sized array](@ref sizedarrays)) */
2239 struct lys_module **deviated_by; /**< List of modules that deviate this module ([sized array](@ref sizedarrays)) */
2240
Michal Vasko89b5c072020-10-06 13:52:44 +02002241 ly_bool implemented; /**< flag if the module is implemented, not just imported */
Radek Krejci95710c92019-02-11 15:49:55 +01002242 uint8_t latest_revision; /**< flag to mark the latest available revision:
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002243 1 - the latest revision in searchdirs was not searched yet and this is the
2244 latest revision in the current context
2245 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002246};
2247
Radek Krejci151a5b72018-10-19 14:21:44 +02002248/**
Michal Vasko82c31e62020-07-17 15:30:40 +02002249 * @brief Get the current real status of the specified feature in the module.
2250 *
2251 * If the feature is enabled, but some of its if-features are false, the feature is considered
2252 * disabled.
Radek Krejci151a5b72018-10-19 14:21:44 +02002253 *
2254 * @param[in] module Module where the feature is defined.
2255 * @param[in] feature Name of the feature to inspect.
Michal Vasko82c31e62020-07-17 15:30:40 +02002256 * @return LY_SUCCESS if the feature is enabled,
2257 * @return LY_ENOT if the feature is disabled,
2258 * @return LY_ENOTFOUND if the feature was not found.
Radek Krejci151a5b72018-10-19 14:21:44 +02002259 */
Michal Vasko82c31e62020-07-17 15:30:40 +02002260LY_ERR lys_feature_value(const struct lys_module *module, const char *feature);
Radek Krejcidd4e8d42018-10-16 14:55:43 +02002261
2262/**
Radek Krejcia3045382018-11-22 14:30:31 +01002263 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can
2264 * be from an augment.
2265 *
Radek Krejci8678fa42020-08-18 16:07:28 +02002266 * ::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 +01002267 * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module.
2268 * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
2269 * \p parent and \p module parameters.
2270 *
2271 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
2272 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
2273 * all the schema nodes are iteratively returned.
2274 *
2275 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
2276 * @param[in] parent Parent of the subtree where the function starts processing.
2277 * @param[in] module In case of iterating on top level elements, the \p parent is NULL and
2278 * module must be specified.
2279 * @param[in] options [ORed options](@ref sgetnextflags).
2280 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
2281 */
2282const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002283 const struct lysc_module *module, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002284
2285/**
Radek Krejci8678fa42020-08-18 16:07:28 +02002286 * @defgroup sgetnextflags Options for ::lys_getnext().
2287 *
2288 * Various options setting behavior of ::lys_getnext().
2289 *
Radek Krejcia3045382018-11-22 14:30:31 +01002290 * @{
2291 */
Radek Krejci8678fa42020-08-18 16:07:28 +02002292#define LYS_GETNEXT_WITHCHOICE 0x01 /**< ::lys_getnext() option to allow returning #LYS_CHOICE nodes instead of looking into them */
2293#define LYS_GETNEXT_NOCHOICE 0x02 /**< ::lys_getnext() option to ignore (kind of conditional) nodes within choice node */
2294#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 +01002295#define LYS_GETNEXT_INTONPCONT 0x08 /**< ::lys_getnext() option to look into non-presence container, instead of returning container itself */
2296#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 +01002297 provided by default */
Radek Krejcia3045382018-11-22 14:30:31 +01002298/** @} sgetnextflags */
2299
2300/**
2301 * @brief Get child node according to the specified criteria.
2302 *
2303 * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched.
2304 * @param[in] module module of the node to find. It is also limitation for the children node of the given parent.
2305 * @param[in] name Name of the node to find.
2306 * @param[in] name_len Optional length of the name in case it is not NULL-terminated string.
2307 * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find.
2308 * Used as a bitmask, so multiple nodetypes can be specified.
2309 * @param[in] options [ORed options](@ref sgetnextflags).
2310 * @return Found node if any.
2311 */
Michal Vaskoe444f752020-02-10 12:20:06 +01002312const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002313 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002314
2315/**
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002316 * @brief Make the specific module implemented.
2317 *
Michal Vaskoe8988e92021-01-25 11:26:29 +01002318 * If the module is already implemented but with a different set of features, the whole context is recompiled.
2319 *
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002320 * @param[in] mod Module to make implemented. It is not an error
2321 * to provide already implemented module, it just does nothing.
Michal Vaskoe8988e92021-01-25 11:26:29 +01002322 * @param[in] features Optional array specifying the enabled features terminated with NULL overriding any previous
2323 * feature setting. The feature string '*' enables all the features and array of length 1 with only the terminating
2324 * NULL explicitly disables all the features. In case the parameter is NULL, the features are untouched - left disabled
2325 * 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 +01002326 * @return LY_SUCCESS on success.
2327 * @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 +01002328 * @return LY_ERR on other errors during module compilation.
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002329 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002330LY_ERR lys_set_implemented(struct lys_module *mod, const char **features);
Radek Krejcia3045382018-11-22 14:30:31 +01002331
Radek Krejci084289f2019-07-09 17:35:30 +02002332/**
2333 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
2334 *
2335 * 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 +02002336 * require-instance restriction), use ::lyd_value_validate().
Radek Krejci084289f2019-07-09 17:35:30 +02002337 *
2338 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
2339 * @param[in] node Schema node for the @p value.
Michal Vaskof937cfe2020-08-03 16:07:12 +02002340 * @param[in] value String value to be checked, expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02002341 * @param[in] value_len Length of the given @p value (mandatory).
Radek Krejci084289f2019-07-09 17:35:30 +02002342 * @return LY_SUCCESS on success
2343 * @return LY_ERR value if an error occurred.
2344 */
Michal Vaskof937cfe2020-08-03 16:07:12 +02002345LY_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 +02002346
Radek Krejci0935f412019-08-20 16:15:18 +02002347/**
2348 * @brief Stringify schema nodetype.
Michal Vaskod43d71a2020-08-07 14:54:58 +02002349 *
Radek Krejci0935f412019-08-20 16:15:18 +02002350 * @param[in] nodetype Nodetype to stringify.
2351 * @return Constant string with the name of the node's type.
2352 */
2353const char *lys_nodetype2str(uint16_t nodetype);
2354
Michal Vaskod43d71a2020-08-07 14:54:58 +02002355/**
2356 * @brief Getter for original XPath expression from a parsed expression.
2357 *
2358 * @param[in] path Parsed expression.
2359 * @return Original string expression.
2360 */
2361const char *lyxp_get_expr(const struct lyxp_expr *path);
2362
Radek Krejci2ff0d572020-05-21 15:27:28 +02002363/** @} schematree */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002364
Radek Krejci70853c52018-10-15 14:46:16 +02002365#ifdef __cplusplus
2366}
2367#endif
2368
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002369#endif /* LY_TREE_SCHEMA_H_ */