blob: 8f23b9748bc4495c14794f22b72a239d1de41f56 [file] [log] [blame]
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001/**
2 * @file tree_schema.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief libyang representation of YANG schema trees.
5 *
6 * Copyright (c) 2015 - 2018 CESNET, z.s.p.o.
7 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_TREE_SCHEMA_H_
16#define LY_TREE_SCHEMA_H_
17
Radek Krejci54579462019-04-30 12:47:06 +020018#define PCRE2_CODE_UNIT_WIDTH 8
19
20#include <pcre2.h>
Radek Krejci535ea9f2020-05-29 16:01:05 +020021
Radek Krejci5aeea3a2018-09-05 13:29:36 +020022#include <stdint.h>
Radek Krejcid3ca0632019-04-16 16:54:54 +020023#include <stdio.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020024
Radek Krejcie7b95092019-05-15 11:03:07 +020025#include "log.h"
26#include "tree.h"
Radek Krejcice8c1592018-10-29 15:35:51 +010027
Radek Krejci70853c52018-10-15 14:46:16 +020028#ifdef __cplusplus
29extern "C" {
30#endif
31
Radek Krejcica376bd2020-06-11 16:04:06 +020032struct ly_ctx;
Radek Krejci47fab892020-11-05 17:02:41 +010033struct ly_path;
Radek Krejcica376bd2020-06-11 16:04:06 +020034struct ly_set;
Radek Krejci47fab892020-11-05 17:02:41 +010035struct lys_module;
36struct lysc_node;
37struct lyxp_expr;
Radek Krejcica376bd2020-06-11 16:04:06 +020038
Radek Krejci5aeea3a2018-09-05 13:29:36 +020039/**
Radek Krejci8678fa42020-08-18 16:07:28 +020040 * @page howtoSchema YANG Modules
41 *
42 * To be able to work with YANG data instances, libyang has to represent YANG data models. All the processed modules are stored
43 * in libyang [context](@ref howtoContext) and loaded using [parser functions](@ref howtoSchemaParsers). It means, that there is
44 * no way to create/change YANG module programmatically. However, all the YANG model definitions are available and can be examined
45 * through the C structures. All the context's modules together form YANG Schema for the data being instantiated.
46 *
47 * Any YANG module is represented as ::lys_module. In fact, the module is represented in two different formats. As ::lys_module.parsed,
48 * there is a parsed schema reflecting the source YANG module. It is exactly what is read from the input. This format is good for
49 * converting from one format to another (YANG to YIN and vice versa), but it is not very useful for validating/manipulating YANG
50 * data. Therefore, there is ::lys_module.compiled storing the compiled YANG module. It is based on the parsed module, but all the
51 * references are resolved. It means that, for example, there are no `grouping`s or `typedef`s since they are supposed to be placed instead of
52 * `uses` or `type` references. This split also means, that the YANG module is fully validated after compilation of the parsed
53 * representation of the module. YANG submodules are available only in the parsed representation. When a submodule is compiled, it
54 * is fully integrated into its main module.
55 *
56 * The context can contain even modules without the compiled representation. Such modules are still useful as imports of other
57 * modules. The grouping or typedef definition can be even compiled into the importing modules. This is actually the main
58 * difference between the imported and implemented modules in the libyang context. The implemented modules are compiled while the
59 * imported modules are only parsed.
60 *
Radek Krejcib100b192020-10-26 08:37:45 +010061 * By default, the module is implemented (and compiled) in case it is explicitly loaded or referenced in another module as
62 * target of leafref, augment or deviation. This behavior can be changed via context options ::LY_CTX_ALL_IMPLEMENTED, when
63 * all the modules in the context are marked as implemented (note the problem with multiple revisions of a single module),
64 * or by ::LY_CTX_REF_IMPLEMENTED option, extending the set of references making the module implemented by when, must and
65 * default statements.
Radek Krejci8678fa42020-08-18 16:07:28 +020066 *
67 * All modules with deviation definition are always marked as implemented. The imported (not implemented) module can be set implemented by ::lys_set_implemented(). But
68 * the implemented module cannot be changed back to just imported module. Note also that only one revision of a specific module
69 * can be implemented in a single context. The imported modules are used only as a
70 * source of definitions for types and groupings for uses statements. The data in such modules are ignored - caller
71 * is not allowed to create the data (including instantiating identities) defined in the model via data parsers,
72 * the default nodes are not added into any data tree and mandatory nodes are not checked in the data trees.
73 *
Michal Vasko14ed9cd2021-01-28 14:16:25 +010074 * The compiled schema tree nodes are able to hold private objects (::lysc_node.priv as a pointer to a structure,
75 * function, variable, ...) used by a caller application.
Radek Krejci8678fa42020-08-18 16:07:28 +020076 * Note that the object is not freed by libyang when the context is being destroyed. So the caller is responsible
77 * for freeing the provided structure after the context is destroyed or the private pointer is set to NULL in
78 * appropriate schema nodes where the object was previously set. This can be automated via destructor function
79 * to free these private objects. The destructor is passed to the ::ly_ctx_destroy() function.
80 *
81 * Despite all the schema structures and their members are available as part of the libyang API and callers can use
82 * it to navigate through the schema tree structure or to obtain various information, we recommend to use the following
83 * macros for the specific actions.
84 * - ::LYSC_TREE_DFS_BEGIN and ::LYSC_TREE_DFS_END to traverse the schema tree (depth-first).
85 * - ::LY_LIST_FOR and ::LY_ARRAY_FOR as described on @ref howtoStructures page.
86 *
87 * Further information about modules handling can be found on the following pages:
88 * - @subpage howtoSchemaParsers
89 * - @subpage howtoSchemaFeatures
90 * - @subpage howtoPlugins
91 * - @subpage howtoSchemaPrinters
92 *
93 * \note There are many functions to access information from the schema trees. Details are available in
94 * the [Schema Tree module](@ref schematree).
95 *
96 * For information about difference between implemented and imported modules, see the
97 * [context description](@ref howtoContext).
98 *
99 * Functions List (not assigned to above subsections)
100 * --------------------------------------------------
101 * - ::lys_getnext()
102 * - ::lys_nodetype2str()
103 * - ::lys_set_implemented()
104 * - ::lys_value_validate()
105 *
Michal Vaskod5cfa6e2020-11-23 16:56:08 +0100106 * - ::lysc_has_when()
107 *
Michal Vasko544e58a2021-01-28 14:33:41 +0100108 * - ::lysc_node_child()
Radek Krejci8678fa42020-08-18 16:07:28 +0200109 * - ::lysc_node_actions()
110 * - ::lysc_node_notifs()
111 *
Michal Vasko544e58a2021-01-28 14:33:41 +0100112 * - ::lysp_node_child()
Radek Krejci8678fa42020-08-18 16:07:28 +0200113 * - ::lysp_node_actions()
114 * - ::lysp_node_notifs()
115 * - ::lysp_node_groupings()
116 * - ::lysp_node_typedefs()
117 */
118
119/**
120 * @page howtoSchemaFeatures YANG Features
121 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100122 * YANG feature statement is an important part of the language which can significantly affect the meaning of the schemas.
123 * Modifying features may have similar effects as loading/removing schema from the context so it is limited to context
124 * preparation period before working with data. YANG features, respectively their use in if-feature
125 * statements, are evaluated as part of schema compilation so a feature-specific compiled schema tree is generated
126 * as a result.
Radek Krejci8678fa42020-08-18 16:07:28 +0200127 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100128 * To enable any features, they must currently be specified when implementing a new schema with ::lys_parse() or
129 * ::ly_ctx_load_module(). To later examine what the status of a feature is, check its ::LYS_FENABLED flag or
130 * search for it first with ::lys_feature_value(). Lastly, to evaluate compiled if-features, use ::lysc_iffeature_value().
Radek Krejci8678fa42020-08-18 16:07:28 +0200131 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100132 * To iterate over all features of a particular YANG module, use ::lysp_feature_next().
Radek Krejci8678fa42020-08-18 16:07:28 +0200133 *
134 * Note, that the feature's state can affect some of the output formats (e.g. Tree format).
135 *
136 * Functions List
137 * --------------
Radek Krejci8678fa42020-08-18 16:07:28 +0200138 * - ::lys_feature_value()
Radek Krejci8678fa42020-08-18 16:07:28 +0200139 * - ::lysc_iffeature_value()
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100140 * - ::lysp_feature_next()
Radek Krejci8678fa42020-08-18 16:07:28 +0200141 */
142
143/**
Radek Krejci2ff0d572020-05-21 15:27:28 +0200144 * @ingroup trees
Radek Krejci8678fa42020-08-18 16:07:28 +0200145 * @defgroup schematree Schema Tree
Radek Krejci2ff0d572020-05-21 15:27:28 +0200146 * @{
147 *
148 * Data structures and functions to manipulate and access schema tree.
149 */
150
Michal Vasko64246d82020-08-19 12:35:00 +0200151/* *INDENT-OFF* */
152
Radek Krejci2ff0d572020-05-21 15:27:28 +0200153/**
Michal Vasko208a04a2020-10-21 15:17:12 +0200154 * @brief Macro to iterate via all elements in a schema (sub)tree including input and output.
155 * Note that __actions__ and __notifications__ of traversed nodes __are ignored__! To traverse
156 * on all the nodes including those, use ::lysc_tree_dfs_full() instead.
157 *
158 * This is the opening part to the #LYSC_TREE_DFS_END - they always have to be used together.
Radek Krejci0935f412019-08-20 16:15:18 +0200159 *
160 * The function follows deep-first search algorithm:
161 * <pre>
162 * 1
163 * / \
164 * 2 4
165 * / / \
166 * 3 5 6
167 * </pre>
168 *
169 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
Radek Krejci2a9fc652021-01-22 17:44:34 +0100170 * START can be any of the lysc_node* types (including lysc_node_action and lysc_node_notif),
Radek Krejci0935f412019-08-20 16:15:18 +0200171 * ELEM variable must be of the struct lysc_node* type.
172 *
173 * To skip a particular subtree, instead of the continue statement, set LYSC_TREE_DFS_continue
174 * variable to non-zero value.
175 *
176 * Use with opening curly bracket '{' after the macro.
177 *
178 * @param START Pointer to the starting element processed first.
179 * @param ELEM Iterator intended for use in the block.
180 */
181#define LYSC_TREE_DFS_BEGIN(START, ELEM) \
Radek Krejci857189e2020-09-01 13:26:36 +0200182 { ly_bool LYSC_TREE_DFS_continue = 0; struct lysc_node *LYSC_TREE_DFS_next; \
Michal Vasko14ed9cd2021-01-28 14:16:25 +0100183 for ((ELEM) = (LYSC_TREE_DFS_next) = (struct lysc_node *)(START); \
Radek Krejci0935f412019-08-20 16:15:18 +0200184 (ELEM); \
185 (ELEM) = (LYSC_TREE_DFS_next), LYSC_TREE_DFS_continue = 0)
186
187/**
188 * @brief Macro to iterate via all elements in a (sub)tree. This is the closing part
189 * to the #LYSC_TREE_DFS_BEGIN - they always have to be used together.
190 *
191 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
Radek Krejci2a9fc652021-01-22 17:44:34 +0100192 * START can be a pointer to any of the lysc_node* types (including lysc_node_action and lysc_node_notif),
Radek Krejci0935f412019-08-20 16:15:18 +0200193 * ELEM variable must be pointer to the lysc_node type.
194 *
195 * Use with closing curly bracket '}' after the macro.
196 *
197 * @param START Pointer to the starting element processed first.
198 * @param ELEM Iterator intended for use in the block.
199 */
Radek Krejci0935f412019-08-20 16:15:18 +0200200#define LYSC_TREE_DFS_END(START, ELEM) \
201 /* select element for the next run - children first */ \
202 if (LYSC_TREE_DFS_continue) { \
203 (LYSC_TREE_DFS_next) = NULL; \
204 } else { \
Michal Vasko544e58a2021-01-28 14:33:41 +0100205 (LYSC_TREE_DFS_next) = (struct lysc_node *)lysc_node_child(ELEM); \
Michal Vasko208a04a2020-10-21 15:17:12 +0200206 } \
Radek Krejci0935f412019-08-20 16:15:18 +0200207 if (!(LYSC_TREE_DFS_next)) { \
Michal Vasko208a04a2020-10-21 15:17:12 +0200208 /* no children, try siblings */ \
209 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
Radek Krejci0935f412019-08-20 16:15:18 +0200210 } \
211 while (!(LYSC_TREE_DFS_next)) { \
212 /* parent is already processed, go to its sibling */ \
Radek Krejci7d95fbb2021-01-26 17:33:13 +0100213 (ELEM) = (ELEM)->parent; \
Michal Vasko208a04a2020-10-21 15:17:12 +0200214 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
215 } }
216
217/**
218 * @brief Helper macro for #LYSC_TREE_DFS_END, should not be used directly!
219 */
220#define _LYSC_TREE_DFS_NEXT(START, ELEM, NEXT) \
221 if ((ELEM) == (struct lysc_node *)(START)) { \
222 /* we are done, no next element to process */ \
223 break; \
224 } \
Michal Vasko544e58a2021-01-28 14:33:41 +0100225 (NEXT) = (ELEM)->next;
Radek Krejci0935f412019-08-20 16:15:18 +0200226
Michal Vasko64246d82020-08-19 12:35:00 +0200227/* *INDENT-ON* */
228
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200229#define LY_REV_SIZE 11 /**< revision data string length (including terminating NULL byte) */
230
Michal Vasko7f45cf22020-10-01 12:49:44 +0200231#define LYS_UNKNOWN 0x0000 /**< uninitalized unknown statement node */
232#define LYS_CONTAINER 0x0001 /**< container statement node */
233#define LYS_CHOICE 0x0002 /**< choice statement node */
234#define LYS_LEAF 0x0004 /**< leaf statement node */
235#define LYS_LEAFLIST 0x0008 /**< leaf-list statement node */
236#define LYS_LIST 0x0010 /**< list statement node */
237#define LYS_ANYXML 0x0020 /**< anyxml statement node */
238#define LYS_ANYDATA 0x0060 /**< anydata statement node, in tests it can be used for both #LYS_ANYXML and #LYS_ANYDATA */
239#define LYS_CASE 0x0080 /**< case statement node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200240
Michal Vasko7f45cf22020-10-01 12:49:44 +0200241#define LYS_RPC 0x0100 /**< RPC statement node */
242#define LYS_ACTION 0x0200 /**< action statement node */
243#define LYS_NOTIF 0x0400 /**< notification statement node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200244
Michal Vasko7f45cf22020-10-01 12:49:44 +0200245#define LYS_USES 0x0800 /**< uses statement node */
246#define LYS_INPUT 0x1000 /**< RPC/action input node */
247#define LYS_OUTPUT 0x2000 /**< RPC/action output node */
248#define LYS_GROUPING 0x4000
249#define LYS_AUGMENT 0x8000
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100250
Radek Krejcif13b87b2020-12-01 22:02:17 +0100251#define LYS_NODETYPE_MASK 0xffff /**< Mask for nodetypes, the value is limited for 16 bits */
252
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200253/**
Radek Krejcid6b76452019-09-03 17:03:03 +0200254 * @brief List of YANG statements
255 */
256enum ly_stmt {
257 LY_STMT_NONE = 0,
Radek Krejci8678fa42020-08-18 16:07:28 +0200258 LY_STMT_STATUS, /**< in ::lysc_ext_substmt.storage stored as a pointer to `uint16_t`, only cardinality < #LY_STMT_CARD_SOME is allowed */
259 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 +0200260 LY_STMT_MANDATORY,
Radek Krejci8678fa42020-08-18 16:07:28 +0200261 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 +0200262 or as a pointer to a [sized array](@ref sizedarrays) `const char **` */
Radek Krejci335332a2019-09-05 13:03:35 +0200263 LY_STMT_DEFAULT,
Radek Krejci8678fa42020-08-18 16:07:28 +0200264 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 +0200265 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_type **` */
Radek Krejci335332a2019-09-05 13:03:35 +0200266
Radek Krejcid6b76452019-09-03 17:03:03 +0200267 LY_STMT_ACTION,
268 LY_STMT_ANYDATA,
269 LY_STMT_ANYXML,
270 LY_STMT_ARGUMENT,
271 LY_STMT_AUGMENT,
272 LY_STMT_BASE,
273 LY_STMT_BELONGS_TO,
274 LY_STMT_BIT,
275 LY_STMT_CASE,
276 LY_STMT_CHOICE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200277 LY_STMT_CONTACT,
278 LY_STMT_CONTAINER,
Radek Krejcid6b76452019-09-03 17:03:03 +0200279 LY_STMT_DESCRIPTION,
280 LY_STMT_DEVIATE,
281 LY_STMT_DEVIATION,
282 LY_STMT_ENUM,
283 LY_STMT_ERROR_APP_TAG,
284 LY_STMT_ERROR_MESSAGE,
285 LY_STMT_EXTENSION,
286 LY_STMT_FEATURE,
287 LY_STMT_FRACTION_DIGITS,
288 LY_STMT_GROUPING,
289 LY_STMT_IDENTITY,
Radek Krejci8678fa42020-08-18 16:07:28 +0200290 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 +0200291 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_iffeature *` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200292 LY_STMT_IMPORT,
293 LY_STMT_INCLUDE,
294 LY_STMT_INPUT,
295 LY_STMT_KEY,
296 LY_STMT_LEAF,
297 LY_STMT_LEAF_LIST,
298 LY_STMT_LENGTH,
299 LY_STMT_LIST,
Radek Krejcid6b76452019-09-03 17:03:03 +0200300 LY_STMT_MAX_ELEMENTS,
301 LY_STMT_MIN_ELEMENTS,
302 LY_STMT_MODIFIER,
303 LY_STMT_MODULE,
304 LY_STMT_MUST,
305 LY_STMT_NAMESPACE,
306 LY_STMT_NOTIFICATION,
307 LY_STMT_ORDERED_BY,
308 LY_STMT_ORGANIZATION,
309 LY_STMT_OUTPUT,
310 LY_STMT_PATH,
311 LY_STMT_PATTERN,
312 LY_STMT_POSITION,
313 LY_STMT_PREFIX,
314 LY_STMT_PRESENCE,
315 LY_STMT_RANGE,
316 LY_STMT_REFERENCE,
317 LY_STMT_REFINE,
318 LY_STMT_REQUIRE_INSTANCE,
319 LY_STMT_REVISION,
320 LY_STMT_REVISION_DATE,
321 LY_STMT_RPC,
Radek Krejcid6b76452019-09-03 17:03:03 +0200322 LY_STMT_SUBMODULE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200323 LY_STMT_TYPEDEF,
324 LY_STMT_UNIQUE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200325 LY_STMT_USES,
326 LY_STMT_VALUE,
327 LY_STMT_WHEN,
328 LY_STMT_YANG_VERSION,
329 LY_STMT_YIN_ELEMENT,
330 LY_STMT_EXTENSION_INSTANCE,
331
332 LY_STMT_SYNTAX_SEMICOLON,
333 LY_STMT_SYNTAX_LEFT_BRACE,
334 LY_STMT_SYNTAX_RIGHT_BRACE,
335
336 LY_STMT_ARG_TEXT,
337 LY_STMT_ARG_VALUE
338};
339
340/**
Radek Krejci0e59c312019-08-15 15:34:15 +0200341 * @brief Extension instance structure parent enumeration
342 */
343typedef enum {
Radek Krejci0935f412019-08-20 16:15:18 +0200344 LYEXT_PAR_MODULE, /**< ::lysc_module */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100345 LYEXT_PAR_NODE, /**< ::lysc_node (and the derived structures including ::lysc_node_action and ::lysc_node_notif) */
346 LYEXT_PAR_INPUT, /**< ::lysc_node_action_inout */
347 LYEXT_PAR_OUTPUT, /**< ::lysc_node_action_inout */
Radek Krejci0935f412019-08-20 16:15:18 +0200348 LYEXT_PAR_TYPE, /**< ::lysc_type */
349 LYEXT_PAR_TYPE_BIT, /**< ::lysc_type_bitenum_item */
350 LYEXT_PAR_TYPE_ENUM, /**< ::lysc_type_bitenum_item */
Radek Krejci0935f412019-08-20 16:15:18 +0200351 LYEXT_PAR_MUST, /**< ::lysc_must */
352 LYEXT_PAR_PATTERN, /**< ::lysc_pattern */
353 LYEXT_PAR_LENGTH, /**< ::lysc_range */
354 LYEXT_PAR_RANGE, /**< ::lysc_range */
355 LYEXT_PAR_WHEN, /**< ::lysc_when */
356 LYEXT_PAR_IDENT, /**< ::lysc_ident */
357 LYEXT_PAR_EXT, /**< ::lysc_ext */
Michal Vasko69730152020-10-09 16:30:07 +0200358 LYEXT_PAR_IMPORT /**< ::lysp_import */
Radek Krejcif13b87b2020-12-01 22:02:17 +0100359#if 0
360 LYEXT_PAR_TPDF, /**< ::lysp_tpdf */
361 LYEXT_PAR_EXTINST, /**< ::lysp_ext_instance */
362 LYEXT_PAR_REFINE, /**< ::lysp_refine */
363 LYEXT_PAR_DEVIATION, /**< ::lysp_deviation */
364 LYEXT_PAR_DEVIATE, /**< ::lysp_deviate */
365 LYEXT_PAR_INCLUDE, /**< ::lysp_include */
366 LYEXT_PAR_REVISION /**< ::lysp_revision */
367#endif
Radek Krejci0e59c312019-08-15 15:34:15 +0200368} LYEXT_PARENT;
369
370/**
Radek Krejci0935f412019-08-20 16:15:18 +0200371 * @brief Stringify extension instance parent type.
372 * @param[in] type Parent type to stringify.
373 * @return Constant string with the name of the parent statement.
374 */
375const char *lyext_parent2str(LYEXT_PARENT type);
376
377/**
Radek Krejci0e59c312019-08-15 15:34:15 +0200378 * @brief Enum of substatements in which extension instances can appear.
379 */
380typedef enum {
381 LYEXT_SUBSTMT_SELF = 0, /**< extension of the structure itself, not substatement's */
382 LYEXT_SUBSTMT_ARGUMENT, /**< extension of the argument statement, can appear in lys_ext */
383 LYEXT_SUBSTMT_BASE, /**< extension of the base statement, can appear (repeatedly) in lys_type and lys_ident */
384 LYEXT_SUBSTMT_BELONGSTO, /**< extension of the belongs-to statement, can appear in lys_submodule */
385 LYEXT_SUBSTMT_CONTACT, /**< extension of the contact statement, can appear in lys_module */
386 LYEXT_SUBSTMT_DEFAULT, /**< extension of the default statement, can appear in lys_node_leaf, lys_node_leaflist,
387 lys_node_choice and lys_deviate */
388 LYEXT_SUBSTMT_DESCRIPTION, /**< extension of the description statement, can appear in lys_module, lys_submodule,
389 lys_node, lys_import, lys_include, lys_ext, lys_feature, lys_tpdf, lys_restr,
390 lys_ident, lys_deviation, lys_type_enum, lys_type_bit, lys_when and lys_revision */
391 LYEXT_SUBSTMT_ERRTAG, /**< extension of the error-app-tag statement, can appear in lys_restr */
392 LYEXT_SUBSTMT_ERRMSG, /**< extension of the error-message statement, can appear in lys_restr */
393 LYEXT_SUBSTMT_KEY, /**< extension of the key statement, can appear in lys_node_list */
394 LYEXT_SUBSTMT_NAMESPACE, /**< extension of the namespace statement, can appear in lys_module */
395 LYEXT_SUBSTMT_ORGANIZATION, /**< extension of the organization statement, can appear in lys_module and lys_submodule */
396 LYEXT_SUBSTMT_PATH, /**< extension of the path statement, can appear in lys_type */
397 LYEXT_SUBSTMT_PREFIX, /**< extension of the prefix statement, can appear in lys_module, lys_submodule (for
398 belongs-to's prefix) and lys_import */
399 LYEXT_SUBSTMT_PRESENCE, /**< extension of the presence statement, can appear in lys_node_container */
400 LYEXT_SUBSTMT_REFERENCE, /**< extension of the reference statement, can appear in lys_module, lys_submodule,
401 lys_node, lys_import, lys_include, lys_revision, lys_tpdf, lys_restr, lys_ident,
402 lys_ext, lys_feature, lys_deviation, lys_type_enum, lys_type_bit and lys_when */
403 LYEXT_SUBSTMT_REVISIONDATE, /**< extension of the revision-date statement, can appear in lys_import and lys_include */
404 LYEXT_SUBSTMT_UNITS, /**< extension of the units statement, can appear in lys_tpdf, lys_node_leaf,
405 lys_node_leaflist and lys_deviate */
406 LYEXT_SUBSTMT_VALUE, /**< extension of the value statement, can appear in lys_type_enum */
407 LYEXT_SUBSTMT_VERSION, /**< extension of the yang-version statement, can appear in lys_module and lys_submodule */
408 LYEXT_SUBSTMT_MODIFIER, /**< extension of the modifier statement, can appear in lys_restr */
409 LYEXT_SUBSTMT_REQINSTANCE, /**< extension of the require-instance statement, can appear in lys_type */
410 LYEXT_SUBSTMT_YINELEM, /**< extension of the yin-element statement, can appear in lys_ext */
411 LYEXT_SUBSTMT_CONFIG, /**< extension of the config statement, can appear in lys_node and lys_deviate */
412 LYEXT_SUBSTMT_MANDATORY, /**< extension of the mandatory statement, can appear in lys_node_leaf, lys_node_choice,
413 lys_node_anydata and lys_deviate */
414 LYEXT_SUBSTMT_ORDEREDBY, /**< extension of the ordered-by statement, can appear in lys_node_list and lys_node_leaflist */
415 LYEXT_SUBSTMT_STATUS, /**< extension of the status statement, can appear in lys_tpdf, lys_node, lys_ident,
416 lys_ext, lys_feature, lys_type_enum and lys_type_bit */
417 LYEXT_SUBSTMT_FRACDIGITS, /**< extension of the fraction-digits statement, can appear in lys_type */
418 LYEXT_SUBSTMT_MAX, /**< extension of the max-elements statement, can appear in lys_node_list,
419 lys_node_leaflist and lys_deviate */
420 LYEXT_SUBSTMT_MIN, /**< extension of the min-elements statement, can appear in lys_node_list,
421 lys_node_leaflist and lys_deviate */
422 LYEXT_SUBSTMT_POSITION, /**< extension of the position statement, can appear in lys_type_bit */
423 LYEXT_SUBSTMT_UNIQUE, /**< extension of the unique statement, can appear in lys_node_list and lys_deviate */
Michal Vasko69730152020-10-09 16:30:07 +0200424 LYEXT_SUBSTMT_IFFEATURE /**< extension of the if-feature statement */
Radek Krejci0e59c312019-08-15 15:34:15 +0200425} LYEXT_SUBSTMT;
426
427/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200428 * @brief YANG import-stmt
429 */
430struct lysp_import {
Radek Krejci086c7132018-10-26 15:29:04 +0200431 struct lys_module *module; /**< pointer to the imported module
432 (mandatory, but resolved when the referring module is completely parsed) */
433 const char *name; /**< name of the imported module (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200434 const char *prefix; /**< prefix for the data from the imported schema (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200435 const char *dsc; /**< description */
436 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200437 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100438 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200439 char rev[LY_REV_SIZE]; /**< revision-date of the imported module */
440};
441
442/**
443 * @brief YANG include-stmt
444 */
445struct lysp_include {
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100446 struct lysp_submodule *submodule;/**< pointer to the parsed submodule structure
Radek Krejci086c7132018-10-26 15:29:04 +0200447 (mandatory, but resolved when the referring module is completely parsed) */
448 const char *name; /**< name of the included submodule (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200449 const char *dsc; /**< description */
450 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200451 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200452 char rev[LY_REV_SIZE]; /**< revision-date of the included submodule */
Radek Krejci771928a2021-01-19 13:42:36 +0100453 ly_bool injected; /**< flag to mark includes copied into main module from submodules,
454 only for backward compatibility with YANG 1.0, which does not require the
455 main module to include all submodules. */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200456};
457
458/**
459 * @brief YANG extension-stmt
460 */
461struct lysp_ext {
462 const char *name; /**< extension name */
463 const char *argument; /**< argument name, NULL if not specified */
464 const char *dsc; /**< description statement */
465 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200466 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200467 uint16_t flags; /**< LYS_STATUS_* and LYS_YINELEM_* values (@ref snodeflags) */
Michal Vasko5fe75f12020-03-02 13:52:37 +0100468
469 struct lysc_ext *compiled; /**< pointer to the compiled extension definition */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200470};
471
472/**
473 * @brief Helper structure for generic storage of the extension instances content.
474 */
475struct lysp_stmt {
476 const char *stmt; /**< identifier of the statement */
477 const char *arg; /**< statement's argument */
478 struct lysp_stmt *next; /**< link to the next statement */
Michal Vaskobc2559f2018-09-07 10:17:50 +0200479 struct lysp_stmt *child; /**< list of the statement's substatements (linked list) */
David Sedlákb9d75c42019-08-14 10:49:42 +0200480 uint16_t flags; /**< statement flags, can be set to LYS_YIN_ATTR */
Radek Krejci335332a2019-09-05 13:03:35 +0200481 enum ly_stmt kw; /**< numeric respresentation of the stmt value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200482};
483
David Sedlákae4b4512019-08-14 10:45:56 +0200484#define LYS_YIN 0x1 /**< used to specify input format of extension instance */
485
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200486/**
487 * @brief YANG extension instance
488 */
489struct lysp_ext_instance {
David Sedlákbbd06ca2019-06-27 14:15:38 +0200490 const char *name; /**< extension identifier, including possible prefix */
491 const char *argument; /**< optional value of the extension's argument */
Radek Krejci335332a2019-09-05 13:03:35 +0200492 void *parent; /**< pointer to the parent element holding the extension instance(s), use
493 ::lysp_ext_instance#parent_type to access the schema element */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200494 struct lysp_stmt *child; /**< list of the extension's substatements (linked list) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200495 struct lysc_ext_instance *compiled; /**< pointer to the compiled data if any - in case the source format is YIN,
496 some of the information (argument) are available only after compilation */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200497 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200498 LY_ARRAY_COUNT_TYPE insubstmt_index; /**< in case the instance is in a substatement, this identifies
David Sedlákbbd06ca2019-06-27 14:15:38 +0200499 the index of that substatement */
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100500 uint16_t flags; /**< LYS_INTERNAL value (@ref snodeflags) */
501 uint8_t yin; /**< flag for YIN source format, can be set to LYS_YIN */
Radek Krejci335332a2019-09-05 13:03:35 +0200502 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200503};
504
505/**
506 * @brief YANG feature-stmt
507 */
508struct lysp_feature {
509 const char *name; /**< feature name (mandatory) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100510 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
511 struct lysc_iffeature *iffeatures_c; /**< compiled if-features */
512 struct lysp_feature **depfeatures; /**< list of pointers to other features depending on this one
513 ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200514 const char *dsc; /**< description statement */
515 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200516 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100517 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values and
518 LYS_FENABLED are allowed */
519};
520
521/**
522 * @brief Compiled YANG if-feature-stmt
523 */
524struct lysc_iffeature {
525 uint8_t *expr; /**< 2bits array describing the if-feature expression in prefix format, see @ref ifftokens */
526 struct lysp_feature **features; /**< array of pointers to the features used in expression ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200527};
528
529/**
Michal Vasko7f45cf22020-10-01 12:49:44 +0200530 * @brief Qualified name (optional prefix followed by an identifier).
531 */
532struct lysp_qname {
533 const char *str; /**< qualified name string */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200534 const struct lysp_module *mod; /**< module to resolve any prefixes found in the string, it must be
Michal Vasko7f45cf22020-10-01 12:49:44 +0200535 stored explicitly because of deviations/refines */
536};
537
538/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200539 * @brief YANG identity-stmt
540 */
541struct lysp_ident {
542 const char *name; /**< identity name (mandatory), including possible prefix */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200543 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200544 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200545 const char *dsc; /**< description statement */
546 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200547 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200548 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
549};
550
Michal Vasko71e64ca2018-09-07 16:30:29 +0200551/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200552 * @brief Covers restrictions: range, length, pattern, must
553 */
554struct lysp_restr {
Radek Krejcif13b87b2020-12-01 22:02:17 +0100555#define LYSP_RESTR_PATTERN_ACK 0x06
556#define LYSP_RESTR_PATTERN_NACK 0x15
Michal Vasko7f45cf22020-10-01 12:49:44 +0200557 struct lysp_qname arg; /**< The restriction expression/value (mandatory);
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200558 in case of pattern restriction, the first byte has a special meaning:
559 0x06 (ACK) for regular match and 0x15 (NACK) for invert-match */
560 const char *emsg; /**< error-message */
561 const char *eapptag; /**< error-app-tag value */
562 const char *dsc; /**< description */
563 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200564 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200565};
566
567/**
Michal Vasko71e64ca2018-09-07 16:30:29 +0200568 * @brief YANG revision-stmt
569 */
570struct lysp_revision {
Radek Krejcicb3e6472021-01-06 08:19:01 +0100571 char date[LY_REV_SIZE]; /**< revision date (madatory) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200572 const char *dsc; /**< description statement */
573 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200574 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200575};
576
577/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200578 * @brief Enumeration/Bit value definition
579 */
580struct lysp_type_enum {
581 const char *name; /**< name (mandatory) */
582 const char *dsc; /**< description statement */
583 const char *ref; /**< reference statement */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200584 int64_t value; /**< enum's value or bit's position */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200585 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200586 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200587 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
588 values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200589};
590
591/**
592 * @brief YANG type-stmt
593 *
594 * Some of the items in the structure may be mandatory, but it is necessary to resolve the type's base type first
595 */
596struct lysp_type {
597 const char *name; /**< name of the type (mandatory) */
598 struct lysp_restr *range; /**< allowed values range - numerical, decimal64 */
599 struct lysp_restr *length; /**< allowed length of the value - string, binary */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200600 struct lysp_restr *patterns; /**< list of patterns ([sized array](@ref sizedarrays)) - string */
601 struct lysp_type_enum *enums; /**< list of enum-stmts ([sized array](@ref sizedarrays)) - enum */
602 struct lysp_type_enum *bits; /**< list of bit-stmts ([sized array](@ref sizedarrays)) - bits */
Michal Vasko004d3152020-06-11 19:59:22 +0200603 struct lyxp_expr *path; /**< parsed path - leafref */
Radek Krejci151a5b72018-10-19 14:21:44 +0200604 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) - identityref */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200605 struct lysp_type *types; /**< list of sub-types ([sized array](@ref sizedarrays)) - union */
606 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200607
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200608 const struct lysp_module *pmod; /**< (sub)module where the type is defined (needed for deviations) */
Radek Krejci2167ee12018-11-02 16:09:07 +0100609 struct lysc_type *compiled; /**< pointer to the compiled type */
610
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200611 uint8_t fraction_digits; /**< number of fraction digits - decimal64 */
612 uint8_t require_instance; /**< require-instance flag - leafref, instance */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100613 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200614};
615
616/**
617 * @brief YANG typedef-stmt
618 */
619struct lysp_tpdf {
620 const char *name; /**< name of the newly defined type (mandatory) */
621 const char *units; /**< units of the newly defined type */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200622 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 +0200623 const char *dsc; /**< description statement */
624 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200625 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200626 struct lysp_type type; /**< base type from which the typedef is derived (mandatory) */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100627 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200628};
629
630/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200631 * @brief YANG when-stmt
632 */
633struct lysp_when {
634 const char *cond; /**< specified condition (mandatory) */
635 const char *dsc; /**< description statement */
636 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200637 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200638};
639
640/**
641 * @brief YANG refine-stmt
642 */
643struct lysp_refine {
644 const char *nodeid; /**< target descendant schema nodeid (mandatory) */
645 const char *dsc; /**< description statement */
646 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200647 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200648 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200649 const char *presence; /**< presence description */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200650 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200651 uint32_t min; /**< min-elements constraint */
652 uint32_t max; /**< max-elements constraint, 0 means unbounded */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200653 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200654 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
655};
656
657/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200658 * @ingroup schematree
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200659 * @defgroup deviatetypes Deviate types
Radek Krejci8678fa42020-08-18 16:07:28 +0200660 *
661 * Type of the deviate operation (used as ::lysp_deviate.mod)
662 *
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200663 * @{
664 */
665#define LYS_DEV_NOT_SUPPORTED 1 /**< deviate type not-supported */
666#define LYS_DEV_ADD 2 /**< deviate type add */
667#define LYS_DEV_DELETE 3 /**< deviate type delete */
668#define LYS_DEV_REPLACE 4 /**< deviate type replace */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200669/** @} deviatetypes */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200670
671/**
672 * @brief Generic deviate structure to get type and cast to lysp_deviate_* structure
673 */
674struct lysp_deviate {
675 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
676 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200677 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200678};
679
680struct lysp_deviate_add {
681 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
682 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200683 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200684 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200685 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200686 struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
687 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200688 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
689 uint32_t min; /**< min-elements constraint */
690 uint32_t max; /**< max-elements constraint, 0 means unbounded */
691};
692
693struct lysp_deviate_del {
694 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
695 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200696 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200697 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200698 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200699 struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
700 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200701};
702
703struct lysp_deviate_rpl {
704 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
705 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200706 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200707 struct lysp_type *type; /**< type of the node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200708 const char *units; /**< units of the values */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200709 struct lysp_qname dflt; /**< default value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200710 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
711 uint32_t min; /**< min-elements constraint */
712 uint32_t max; /**< max-elements constraint, 0 means unbounded */
713};
714
715struct lysp_deviation {
Michal Vaskob55f6c12018-09-12 11:13:15 +0200716 const char *nodeid; /**< target absolute schema nodeid (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200717 const char *dsc; /**< description statement */
718 const char *ref; /**< reference statement */
Michal Vasko22df3f02020-08-24 13:29:22 +0200719 struct lysp_deviate *deviates; /**< list of deviate specifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200720 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200721};
722
Radek Krejci4f28eda2018-11-12 11:46:16 +0100723/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100724 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200725 * @defgroup spnodeflags Parsed schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100726 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200727 * Various flags for parsed schema nodes (used as ::lysp_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100728 *
729 * 1 - container 6 - anydata/anyxml 11 - output 16 - grouping 21 - enum
730 * 2 - choice 7 - case 12 - feature 17 - uses 22 - type
Radek Krejcid3ca0632019-04-16 16:54:54 +0200731 * 3 - leaf 8 - notification 13 - identity 18 - refine 23 - stmt
Radek Krejci4f28eda2018-11-12 11:46:16 +0100732 * 4 - leaflist 9 - rpc 14 - extension 19 - augment
733 * 5 - list 10 - input 15 - typedef 20 - deviate
734 *
Radek Krejcid3ca0632019-04-16 16:54:54 +0200735 * 1 1 1 1 1 1 1 1 1 1 2 2 2 2
736 * 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
737 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200738 * 1 LYS_CONFIG_W |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200739 * LYS_SET_BASE | | | | | | | | | | | | | | | | | | | | | |x| |
740 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vasko5297a432020-08-31 12:27:51 +0200741 * 2 LYS_CONFIG_R |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200742 * LYS_SET_BIT | | | | | | | | | | | | | | | | | | | | | |x| |
743 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
744 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
745 * LYS_SET_ENUM | | | | | | | | | | | | | | | | | | | | | |x| |
746 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
747 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
748 * LYS_SET_FRDIGITS | | | | | | | | | | | | | | | | | | | | | |x| |
749 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
750 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
751 * LYS_SET_LENGTH | | | | | | | | | | | | | | | | | | | | | |x| |
752 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
753 * 6 LYS_MAND_TRUE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
754 * LYS_SET_PATH | | | | | | | | | | | | | | | | | | | | | |x| |
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100755 * LYS_FENABLED | | | | | | | | | | | |x| | | | | | | | | | | |
Radek Krejcid3ca0632019-04-16 16:54:54 +0200756 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
757 * 7 LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
758 * LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | | | | | | | | |
759 * LYS_SET_PATTERN | | | | | | | | | | | | | | | | | | | | | |x| |
760 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
761 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | | | | | | | | |
762 * LYS_YINELEM_TRUE | | | | | | | | | | | | | |x| | | | | | | | | |
763 * LYS_SET_RANGE | | | | | | | | | | | | | | | | | | | | | |x| |
764 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
765 * 9 LYS_YINELEM_FALSE| | | | | | | | | | | | | |x| | | | | | | | | |
766 * LYS_SET_TYPE | | | | | | | | | | | | | | | | | | | | | |x| |
767 * LYS_SINGLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
768 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
769 * 10 LYS_SET_VALUE | | | | | | | | | | | | | | | | | | | | |x| | |
770 * LYS_SET_REQINST | | | | | | | | | | | | | | | | | | | | | |x| |
771 * LYS_SET_MIN | | | |x|x| | | | | | | | | | | | |x| |x| | | |
772 * LYS_DOUBLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
773 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
774 * 11 LYS_SET_MAX | | | |x|x| | | | | | | | | | | | |x| |x| | | |
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200775 * LYS_USED_GRP | | | | | | | | | | | | | | | |x| | | | | | | |
David Sedlákae4b4512019-08-14 10:45:56 +0200776 * LYS_YIN_ATTR | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko5297a432020-08-31 12:27:51 +0200777 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
778 * 12 LYS_YIN_ARGUMENT | | | | | | | | | | | | | | | | | | | | | | |x|
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100779 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
780 * 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 +0200781 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100782 *
783 */
784
785/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100786 * @ingroup snodeflags
Radek Krejci8678fa42020-08-18 16:07:28 +0200787 * @defgroup scnodeflags Compiled schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100788 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200789 * Various flags for compiled schema nodes (used as ::lysc_node.flags).
Radek Krejci4f28eda2018-11-12 11:46:16 +0100790 *
Radek Krejci61e042e2019-09-10 15:53:09 +0200791 * 1 - container 6 - anydata/anyxml 11 - identity
792 * 2 - choice 7 - case 12 - extension
793 * 3 - leaf 8 - notification 13 - bitenum
Michal Vasko03ff5a72019-09-11 13:49:33 +0200794 * 4 - leaflist 9 - rpc/action 14 - when
Michal Vaskoecd62de2019-11-13 12:35:11 +0100795 * 5 - list 10 - feature
Radek Krejci4f28eda2018-11-12 11:46:16 +0100796 *
Michal Vaskoecd62de2019-11-13 12:35:11 +0100797 * 1 1 1 1 1
798 * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4
799 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100800 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100801 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Michal Vaskod09b7622021-01-26 09:14:13 +0100802 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100803 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
804 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x|x|x|x| |x|
805 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
806 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x|x|x|x| |x|
807 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
808 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x|x|x|x| |x|
809 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
810 * 6 LYS_MAND_TRUE |x|x|x|x|x|x| | | | | | | | |
811 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
812 * 7 LYS_ORDBY_USER | | | |x|x| | | | | | | | | |
813 * LYS_MAND_FALSE | |x|x| | |x| | | | | | | | |
814 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
815 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | |
816 * LYS_PRESENCE |x| | | | | | | | | | | | | |
817 * LYS_UNIQUE | | |x| | | | | | | | | | | |
818 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
819 * 9 LYS_KEY | | |x| | | | | | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100820 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
821 * 10 LYS_SET_DFLT | | |x|x| | |x| | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100822 * LYS_IS_ENUM | | | | | | | | | | | | |x| |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100823 * LYS_KEYLESS | | | | |x| | | | | | | | | |
824 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
825 * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | |
826 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
827 * 12 LYS_SET_CONFIG |x|x|x|x|x|x| | | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100828 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
829 * 13 LYS_IS_INPUT |x|x|x|x|x|x|x| | | | | | | |
830 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
831 * 14 LYS_IS_OUTPUT |x|x|x|x|x|x|x| | | | | | | |
832 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
833 * 15 LYS_IS_NOTIF |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100834 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100835 *
836 */
837
838/**
839 * @defgroup snodeflags Schema nodes flags
Radek Krejci8678fa42020-08-18 16:07:28 +0200840 *
841 * Various flags for schema nodes ([parsed](@ref spnodeflags) as well as [compiled](@ref scnodeflags)).
842 *
Radek Krejci4f28eda2018-11-12 11:46:16 +0100843 * @{
844 */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100845#define LYS_CONFIG_W 0x01 /**< config true; */
846#define LYS_CONFIG_R 0x02 /**< config false; */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200847#define LYS_CONFIG_MASK 0x03 /**< mask for config value */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100848#define LYS_STATUS_CURR 0x04 /**< status current; */
849#define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */
850#define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */
851#define LYS_STATUS_MASK 0x1C /**< mask for status value */
852#define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice,
Radek Krejcife909632019-02-12 15:34:42 +0100853 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
854 The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0.
855 The ::lysc_node_container has this flag if it is not a presence container and it has at least one
856 child with LYS_MAND_TRUE. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100857#define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice,
858 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
859 This flag is present only in case the mandatory false statement was explicitly specified. */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100860#define LYS_MAND_MASK 0x60 /**< mask for mandatory values */
Michal Vaskoc118ae22020-08-06 14:51:09 +0200861#define LYS_PRESENCE 0x80 /**< flag for presence property of a container, but it is not only for explicit presence
862 containers, but also for NP containers with some meaning, applicable only to
863 ::lysc_node_container */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100864#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 +0100865#define LYS_KEY 0x0100 /**< flag for leafs being a key of a list, applicable only to ::lysc_node_leaf */
866#define LYS_KEYLESS 0x0200 /**< flag for list without any key, applicable only to ::lysc_node_list */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100867#define LYS_FENABLED 0x20 /**< feature enabled flag, applicable only to ::lysp_feature. */
Radek Krejcife909632019-02-12 15:34:42 +0100868#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 +0100869 ::lysc_node_list/::lysp_node_list */
870#define LYS_ORDBY_USER 0x40 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and
871 ::lysc_node_list/::lysp_node_list */
872#define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */
873#define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100874#define LYS_YINELEM_FALSE 0x0100 /**< yin-element false for extension's argument */
875#define LYS_YINELEM_MASK 0x0180 /**< mask for yin-element value */
876#define LYS_USED_GRP 0x0400 /**< internal flag for validating not-instantiated groupings
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200877 (resp. do not validate again the instantiated groupings). */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100878#define LYS_SET_VALUE 0x0200 /**< value attribute is set */
879#define LYS_SET_MIN 0x0200 /**< min attribute is set */
880#define LYS_SET_MAX 0x0400 /**< max attribute is set */
Radek Krejcid505e3d2018-11-13 09:04:17 +0100881
882#define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */
883#define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */
884#define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */
885#define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */
886#define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */
887#define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */
888#define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */
889#define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */
890#define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */
891#define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */
Radek Krejciccd20f12019-02-15 14:12:27 +0100892#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 +0100893 cases of choice. This information is important for refines, since it is prohibited to make leafs
894 with default statement mandatory. In case the default leaf value is taken from type, it is thrown
Radek Krejciccd20f12019-02-15 14:12:27 +0100895 away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish
896 between own default or the default values taken from the type. */
897#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 +0100898#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 +0100899
Michal Vaskod1e53b92021-01-28 13:11:06 +0100900#define LYS_SINGLEQUOTED 0x0100 /**< flag for single-quoted argument of an extension instance's substatement, only when the source is YANG */
901#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 +0200902
Michal Vaskod1e53b92021-01-28 13:11:06 +0100903#define LYS_YIN_ATTR 0x0400 /**< flag to identify YIN attribute parsed as extension's substatement, only when the source is YIN */
904#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 +0200905
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100906#define LYS_INTERNAL 0x1000 /**< flag to identify internal parsed statements that should not be printed */
907
Michal Vaskod1e53b92021-01-28 13:11:06 +0100908#define LYS_IS_ENUM 0x0200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */
909
910#define LYS_IS_INPUT 0x1000 /**< flag for nodes that are in the subtree of an input statement */
911
912#define LYS_IS_OUTPUT 0x2000 /**< flag for nodes that are in the subtree of an output statement */
913
914#define LYS_IS_NOTIF 0x4000 /**< flag for nodes that are in the subtree of a notification statement */
Radek Krejci693262f2019-04-29 15:23:20 +0200915
Radek Krejcife909632019-02-12 15:34:42 +0100916#define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200917/** @} snodeflags */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200918
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200919/**
920 * @brief Generic YANG data node
921 */
922struct lysp_node {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100923 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200924 uint16_t nodetype; /**< type of the node (mandatory) */
925 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100926 struct lysp_node *next; /**< next sibling node (NULL if there is no one) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200927 const char *name; /**< node name (mandatory) */
928 const char *dsc; /**< description statement */
929 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200930 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)),
931 must be qname because of refines */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200932 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200933};
934
935/**
936 * @brief Extension structure of the lysp_node for YANG container
937 */
938struct lysp_node_container {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100939 union {
940 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
941 struct {
942 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
943 uint16_t nodetype; /**< LYS_CONTAINER */
944 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
945 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
946 const char *name; /**< node name (mandatory) */
947 const char *dsc; /**< description statement */
948 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100949 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
950 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
951 };
952 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200953
954 /* container */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200955 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +0100956 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200957 const char *presence; /**< presence description */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200958 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100959 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200960 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100961 struct lysp_node_action *actions;/**< list of actions (linked list) */
962 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200963};
964
965struct lysp_node_leaf {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100966 union {
967 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
968 struct {
969 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
970 uint16_t nodetype; /**< LYS_LEAF */
971 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
972 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
973 const char *name; /**< node name (mandatory) */
974 const char *dsc; /**< description statement */
975 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100976 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
977 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
978 };
979 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200980
981 /* leaf */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200982 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +0100983 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200984 struct lysp_type type; /**< type of the leaf node (mandatory) */
985 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200986 struct lysp_qname dflt; /**< default value, it may or may not be a qualified name */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200987};
988
989struct lysp_node_leaflist {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100990 union {
991 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
992 struct {
993 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
994 uint16_t nodetype; /**< LYS_LEAFLIST */
995 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
996 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
997 const char *name; /**< node name (mandatory) */
998 const char *dsc; /**< description statement */
999 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001000 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1001 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1002 };
1003 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001004
1005 /* leaf-list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001006 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001007 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001008 struct lysp_type type; /**< type of the leaf node (mandatory) */
1009 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001010 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)), they may or
1011 may not be qualified names */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001012 uint32_t min; /**< min-elements constraint */
1013 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1014};
1015
1016struct lysp_node_list {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001017 union {
1018 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1019 struct {
1020 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1021 uint16_t nodetype; /**< LYS_LIST */
1022 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1023 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1024 const char *name; /**< node name (mandatory) */
1025 const char *dsc; /**< description statement */
1026 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001027 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1028 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1029 };
1030 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001031
1032 /* list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001033 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001034 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001035 const char *key; /**< keys specification */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001036 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001037 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001038 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001039 struct lysp_node_action *actions;/**< list of actions (linked list) */
1040 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001041 struct lysp_qname *uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001042 uint32_t min; /**< min-elements constraint */
1043 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1044};
1045
1046struct lysp_node_choice {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001047 union {
1048 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1049 struct {
1050 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1051 uint16_t nodetype; /**< LYS_CHOICE */
1052 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1053 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1054 const char *name; /**< node name (mandatory) */
1055 const char *dsc; /**< description statement */
1056 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001057 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1058 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1059 };
1060 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001061
1062 /* choice */
1063 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001064 struct lysp_when *when; /**< when statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001065 struct lysp_qname dflt; /**< default case */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001066};
1067
1068struct lysp_node_case {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001069 union {
1070 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1071 struct {
1072 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1073 uint16_t nodetype; /**< LYS_CASE */
1074 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1075 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1076 const char *name; /**< node name (mandatory) */
1077 const char *dsc; /**< description statement */
1078 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001079 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1080 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1081 };
1082 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001083
1084 /* case */
1085 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001086 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001087};
1088
1089struct lysp_node_anydata {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001090 union {
1091 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1092 struct {
1093 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1094 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1095 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1096 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1097 const char *name; /**< node name (mandatory) */
1098 const char *dsc; /**< description statement */
1099 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001100 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1101 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1102 };
1103 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001104
1105 /* anyxml/anydata */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001106 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001107 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001108};
1109
1110struct lysp_node_uses {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001111 union {
1112 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1113 struct {
1114 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1115 uint16_t nodetype; /**< LYS_USES */
1116 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1117 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1118 const char *name; /**< grouping name reference (mandatory) */
1119 const char *dsc; /**< description statement */
1120 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001121 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1122 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1123 };
1124 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001125
1126 /* uses */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001127 struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001128 struct lysp_node_augment *augments; /**< list of augments (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001129 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001130};
1131
1132/**
1133 * @brief YANG input-stmt and output-stmt
1134 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001135struct lysp_node_action_inout {
1136 union {
1137 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1138 struct {
1139 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1140 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1141 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1142 struct lysp_node *next; /**< NULL */
1143 const char *name; /**< empty string */
1144 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1145 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysp_node */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001146 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1147 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1148 };
1149 }; /**< common part corresponding to ::lysp_node */
1150
1151 /* inout */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001152 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1153 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001154 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001155 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001156};
1157
1158/**
1159 * @brief YANG rpc-stmt and action-stmt
1160 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001161struct lysp_node_action {
1162 union {
1163 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1164 struct {
1165 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1166 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1167 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1168 struct lysp_node_action *next; /**< pointer to the next action (NULL if there is no one) */
1169 const char *name; /**< grouping name reference (mandatory) */
1170 const char *dsc; /**< description statement */
1171 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001172 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1173 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1174 };
1175 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001176
1177 /* action */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001178 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1179 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
1180
1181 struct lysp_node_action_inout input; /**< RPC's/Action's input */
1182 struct lysp_node_action_inout output; /**< RPC's/Action's output */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001183};
1184
1185/**
1186 * @brief YANG notification-stmt
1187 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001188struct lysp_node_notif {
1189 union {
1190 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1191 struct {
1192 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1193 uint16_t nodetype; /**< LYS_NOTIF */
1194 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1195 struct lysp_node_notif *next; /**< pointer to the next notification (NULL if there is no one) */
1196 const char *name; /**< grouping name reference (mandatory) */
1197 const char *dsc; /**< description statement */
1198 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001199 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1200 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1201 };
1202 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001203
1204 /* notif */
1205 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001206 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1207 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001208 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001209};
1210
1211/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001212 * @brief YANG grouping-stmt
1213 */
1214struct lysp_node_grp {
1215 union {
1216 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1217 struct {
1218 struct lysp_node *parent;/**< parent node (NULL if this is a top-level grouping) */
1219 uint16_t nodetype; /**< LYS_GROUPING */
1220 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1221 struct lysp_node_grp *next; /**< pointer to the next grouping (NULL if there is no one) */
1222 const char *name; /**< grouping name (mandatory) */
1223 const char *dsc; /**< description statement */
1224 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001225 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1226 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1227 };
1228 }; /**< common part corresponding to ::lysp_node */
1229
1230 /* grp */
1231 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1232 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001233 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001234 struct lysp_node_action *actions; /**< list of actions (linked list) */
1235 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1236};
1237
1238/**
1239 * @brief YANG uses-augment-stmt and augment-stmt (compatible with struct lysp_node )
1240 */
1241struct lysp_node_augment {
1242 union {
1243 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1244 struct {
1245 struct lysp_node *parent;/**< parent node (NULL if this is a top-level augment) */
1246 uint16_t nodetype; /**< LYS_AUGMENT */
1247 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1248 struct lysp_node_augment *next; /**< pointer to the next augment (NULL if there is no one) */
1249 const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */
1250 const char *dsc; /**< description statement */
1251 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001252 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1253 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1254 };
1255 }; /**< common part corresponding to ::lysp_node */
1256
1257 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001258 struct lysp_when *when; /**< when statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001259 struct lysp_node_action *actions;/**< list of actions (linked list) */
1260 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1261};
1262
1263/**
Radek Krejcif0fceb62018-09-05 14:58:45 +02001264 * @brief supported YANG schema version values
1265 */
1266typedef enum LYS_VERSION {
1267 LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */
Radek Krejci96e48da2020-09-04 13:18:06 +02001268 LYS_VERSION_1_0 = 1, /**< YANG 1 (1.0) */
Radek Krejcif0fceb62018-09-05 14:58:45 +02001269 LYS_VERSION_1_1 = 2 /**< YANG 1.1 */
1270} LYS_VERSION;
1271
1272/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001273 * @brief Printable YANG schema tree structure representing YANG module.
1274 *
1275 * Simple structure corresponding to the YANG format. The schema is only syntactically validated.
1276 */
1277struct lysp_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001278 struct lys_module *mod; /**< covering module structure */
1279
Radek Krejcib7db73a2018-10-24 14:18:40 +02001280 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1281 in the list is always the last (newest) revision of the module */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001282 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1283 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001284 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1285 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1286 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1287 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001288 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001289 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001290 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1291 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1292 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001293 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001294 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001295
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001296 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001297 uint8_t parsing : 1; /**< flag for circular check */
1298 uint8_t is_submod : 1; /**< always 0 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001299};
1300
1301struct lysp_submodule {
Michal Vaskoc3781c32020-10-06 14:04:08 +02001302 struct lys_module *mod; /**< belongs to parent module (submodule - mandatory) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001303
1304 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1305 in the list is always the last (newest) revision of the module */
1306 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1307 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
1308 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1309 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1310 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1311 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001312 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001313 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001314 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1315 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1316 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001317 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001318 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001319
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001320 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001321 uint8_t parsing : 1; /**< flag for circular check */
1322 uint8_t is_submod : 1; /**< always 1 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001323
Michal Vaskoc3781c32020-10-06 14:04:08 +02001324 uint8_t latest_revision : 2; /**< flag to mark the latest available revision:
Radek Krejci086c7132018-10-26 15:29:04 +02001325 1 - the latest revision in searchdirs was not searched yet and this is the
1326 latest revision in the current context
1327 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001328 const char *name; /**< name of the module (mandatory) */
1329 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1330 const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */
1331 const char *org; /**< party/company responsible for the module */
1332 const char *contact; /**< contact information for the module */
1333 const char *dsc; /**< description of the module */
1334 const char *ref; /**< cross-reference for the module */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001335};
1336
1337/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001338 * @brief Get the parsed module or submodule name.
1339 *
1340 * @param[in] PMOD Parsed module or submodule.
1341 * @return Module or submodule name.
1342 */
1343#define LYSP_MODULE_NAME(PMOD) (PMOD->is_submod ? ((struct lysp_submodule *)PMOD)->name : ((struct lysp_module *)PMOD)->mod->name)
1344
1345/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001346 * @brief Compiled prefix data pair mapping of prefixes to modules. In case the format is ::LY_PREF_SCHEMA_RESOLVED,
1347 * the expected prefix data is a sized array of these structures.
1348 */
1349struct lysc_prefix {
1350 char *prefix; /**< used prefix */
1351 const struct lys_module *mod; /**< mapping to a module */
1352};
1353
1354/**
Radek Krejci0e59c312019-08-15 15:34:15 +02001355 * @brief Compiled YANG extension-stmt
1356 */
1357struct lysc_ext {
1358 const char *name; /**< extension name */
1359 const char *argument; /**< argument name, NULL if not specified */
Radek Krejci0e59c312019-08-15 15:34:15 +02001360 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1361 struct lyext_plugin *plugin; /**< Plugin implementing the specific extension */
Radek Krejci0935f412019-08-20 16:15:18 +02001362 struct lys_module *module; /**< module structure */
Michal Vasko6f4cbb62020-02-28 11:15:47 +01001363 uint32_t refcount; /**< reference counter since extension definition is shared among all its instances */
Radek Krejci0e59c312019-08-15 15:34:15 +02001364 uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */
1365};
1366
1367/**
Radek Krejcice8c1592018-10-29 15:35:51 +01001368 * @brief YANG extension instance
1369 */
1370struct lysc_ext_instance {
Radek Krejciad5963b2019-09-06 16:03:05 +02001371 uint32_t insubstmt_index; /**< in case the instance is in a substatement that can appear multiple times,
1372 this identifies the index of the substatement for this extension instance */
Radek Krejci28681fa2019-09-06 13:08:45 +02001373 struct lys_module *module; /**< module where the extension instantiated is defined */
Radek Krejciad5963b2019-09-06 16:03:05 +02001374 struct lysc_ext *def; /**< pointer to the extension definition */
Radek Krejcice8c1592018-10-29 15:35:51 +01001375 void *parent; /**< pointer to the parent element holding the extension instance(s), use
1376 ::lysc_ext_instance#parent_type to access the schema element */
1377 const char *argument; /**< optional value of the extension's argument */
1378 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Radek Krejci2a408df2018-10-29 16:32:26 +01001379 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001380 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0e59c312019-08-15 15:34:15 +02001381 void *data; /**< private plugins's data, not used by libyang */
Radek Krejcice8c1592018-10-29 15:35:51 +01001382};
1383
1384/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001385 * @brief YANG when-stmt
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001386 */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001387struct lysc_when {
1388 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko175012e2019-11-06 15:49:14 +01001389 struct lysc_node *context; /**< context node for evaluating the expression, NULL if the context is root node */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001390 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001391 const char *dsc; /**< description */
1392 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001393 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00b874b2019-02-12 10:54:50 +01001394 uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */
Michal Vaskoecd62de2019-11-13 12:35:11 +01001395 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS is allowed */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001396};
1397
1398/**
Radek Krejci2a408df2018-10-29 16:32:26 +01001399 * @brief YANG identity-stmt
1400 */
1401struct lysc_ident {
1402 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejcic8b31002019-01-08 10:24:45 +01001403 const char *dsc; /**< description */
1404 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001405 struct lys_module *module; /**< module structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001406 struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */
1407 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1408 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
1409};
1410
1411/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001412 * @defgroup ifftokens if-feature expression tokens
Radek Krejci8678fa42020-08-18 16:07:28 +02001413 * Tokens of if-feature expression used in ::lysc_iffeature.expr.
Radek Krejci151a5b72018-10-19 14:21:44 +02001414 *
1415 * @{
1416 */
1417#define LYS_IFF_NOT 0x00 /**< operand "not" */
1418#define LYS_IFF_AND 0x01 /**< operand "and" */
1419#define LYS_IFF_OR 0x02 /**< operand "or" */
1420#define LYS_IFF_F 0x03 /**< feature */
Radek Krejci2ff0d572020-05-21 15:27:28 +02001421/** @} ifftokens */
Radek Krejci151a5b72018-10-19 14:21:44 +02001422
1423/**
Radek Krejcib7db73a2018-10-24 14:18:40 +02001424 * @brief Compiled YANG revision statement
1425 */
1426struct lysc_revision {
1427 char date[LY_REV_SIZE]; /**< revision-date (mandatory) */
1428 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1429};
1430
Radek Krejci2167ee12018-11-02 16:09:07 +01001431struct lysc_range {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001432 struct lysc_range_part {
Radek Krejci693262f2019-04-29 15:23:20 +02001433 union { /**< min boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001434 int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1435 uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001436 };
Radek Krejci693262f2019-04-29 15:23:20 +02001437 union { /**< max boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001438 int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1439 uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001440 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001441 } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001442 const char *dsc; /**< description */
1443 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001444 const char *emsg; /**< error-message */
1445 const char *eapptag; /**< error-app-tag value */
1446 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1447};
1448
1449struct lysc_pattern {
Radek Krejci54579462019-04-30 12:47:06 +02001450 const char *expr; /**< original, not compiled, regular expression */
1451 pcre2_code *code; /**< compiled regular expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001452 const char *dsc; /**< description */
1453 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001454 const char *emsg; /**< error-message */
1455 const char *eapptag; /**< error-app-tag value */
1456 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0f969882020-08-21 16:56:47 +02001457 uint32_t inverted : 1; /**< invert-match flag */
1458 uint32_t refcount : 31; /**< reference counter */
Radek Krejci2167ee12018-11-02 16:09:07 +01001459};
1460
1461struct lysc_must {
Radek Krejci2167ee12018-11-02 16:09:07 +01001462 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001463 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001464 const char *dsc; /**< description */
1465 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001466 const char *emsg; /**< error-message */
1467 const char *eapptag; /**< error-app-tag value */
1468 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1469};
1470
1471struct lysc_type {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001472 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001473 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 +01001474 LY_DATA_TYPE basetype; /**< Base type of the type */
1475 uint32_t refcount; /**< reference counter for type sharing */
1476};
1477
1478struct lysc_type_num {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001479 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001480 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 +01001481 LY_DATA_TYPE basetype; /**< Base type of the type */
1482 uint32_t refcount; /**< reference counter for type sharing */
1483 struct lysc_range *range; /**< Optional range limitation */
1484};
1485
1486struct lysc_type_dec {
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 */
Radek Krejci6cba4292018-11-15 17:33:29 +01001491 uint8_t fraction_digits; /**< fraction digits specification */
Radek Krejci2167ee12018-11-02 16:09:07 +01001492 struct lysc_range *range; /**< Optional range limitation */
1493};
1494
1495struct lysc_type_str {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001496 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001497 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 +01001498 LY_DATA_TYPE basetype; /**< Base type of the type */
1499 uint32_t refcount; /**< reference counter for type sharing */
1500 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci4586a022018-11-13 11:29:26 +01001501 struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001502};
1503
Radek Krejci693262f2019-04-29 15:23:20 +02001504struct lysc_type_bitenum_item {
1505 const char *name; /**< enumeration identifier */
1506 const char *dsc; /**< description */
1507 const char *ref; /**< reference */
1508 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci693262f2019-04-29 15:23:20 +02001509 union {
1510 int32_t value; /**< integer value associated with the enumeration */
1511 uint32_t position; /**< non-negative integer value associated with the bit */
1512 };
1513 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
1514 values are allowed */
1515};
1516
Radek Krejci2167ee12018-11-02 16:09:07 +01001517struct lysc_type_enum {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001518 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001519 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 +01001520 LY_DATA_TYPE basetype; /**< Base type of the type */
1521 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci693262f2019-04-29 15:23:20 +02001522 struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1523};
1524
1525struct lysc_type_bits {
1526 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 Krejci693262f2019-04-29 15:23:20 +02001528 LY_DATA_TYPE basetype; /**< Base type of the type */
1529 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci849a62a2019-05-22 15:29:05 +02001530 struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item),
1531 the items are ordered by their position value. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001532};
1533
1534struct lysc_type_leafref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001535 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001536 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 +01001537 LY_DATA_TYPE basetype; /**< Base type of the type */
1538 uint32_t refcount; /**< reference counter for type sharing */
Michal Vasko004d3152020-06-11 19:59:22 +02001539 struct lyxp_expr *path; /**< parsed target path, compiled path cannot be stored because of type sharing */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001540 struct lysc_prefix *prefixes; /**< resolved prefixes used in the path */
Michal Vaskoc0792ca2020-12-01 12:03:21 +01001541 const struct lys_module *cur_mod;/**< current module for the leafref (path) */
Radek Krejci412ddfa2018-11-23 11:44:11 +01001542 struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001543 uint8_t require_instance; /**< require-instance flag */
1544};
1545
1546struct lysc_type_identityref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001547 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001548 struct lysc_type_plugin *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001549 LY_DATA_TYPE basetype; /**< Base type of the type */
1550 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci555cb5b2018-11-16 14:54:33 +01001551 struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)),
Radek Krejci2167ee12018-11-02 16:09:07 +01001552 mandatory (at least 1 item) */
1553};
1554
1555struct lysc_type_instanceid {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001556 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001557 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 +01001558 LY_DATA_TYPE basetype; /**< Base type of the type */
1559 uint32_t refcount; /**< reference counter for type sharing */
1560 uint8_t require_instance; /**< require-instance flag */
1561};
1562
Radek Krejci2167ee12018-11-02 16:09:07 +01001563struct lysc_type_union {
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 struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1569};
1570
1571struct lysc_type_bin {
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_range *length; /**< Optional length limitation */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001577};
1578
Michal Vasko60ea6352020-06-29 13:39:39 +02001579/**
1580 * @brief Maximum number of hashes stored in a schema node.
1581 */
1582#define LYS_NODE_HASH_COUNT 4
1583
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001584/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001585 * @brief Compiled YANG data node
1586 */
1587struct lysc_node {
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001588 uint16_t nodetype; /**< type of the node (mandatory) */
1589 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Michal Vasko60ea6352020-06-29 13:39:39 +02001590 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001591 struct lys_module *module; /**< module structure */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001592 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1593 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1594 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1595 never NULL. If there is no sibling node, pointer points to the node
1596 itself. In case of the first node, this pointer points to the last
1597 node in the list. */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001598 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001599 const char *dsc; /**< description */
1600 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001601 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko2fd91b92020-07-17 16:39:02 +02001602 void *priv; /**< private arbitrary user data, not used by libyang */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001603};
1604
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001605struct lysc_node_action_inout {
1606 union {
1607 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1608 struct {
1609 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1610 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1611 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1612 struct lys_module *module; /**< module structure */
Radek Krejci5960c312021-01-27 20:24:22 +01001613 struct lysc_node *parent;/**< parent node (NULL in case of top level node) */
Michal Vasko544e58a2021-01-28 14:33:41 +01001614 struct lysc_node *next; /**< next sibling node (output node for input, NULL for output) */
1615 struct lysc_node *prev; /**< pointer to the previous sibling node (input and output node pointing to each other) */
Radek Krejci5960c312021-01-27 20:24:22 +01001616 const char *name; /**< "input" or "output" */
1617 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysc_node */
1618 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysc_node */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001619 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001620 void *priv; /** private arbitrary user data, not used by libyang */
1621 };
1622 };
1623
Radek Krejci9a3823e2021-01-27 20:26:46 +01001624 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001625 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1626};
1627
1628struct lysc_node_action {
1629 union {
1630 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1631 struct {
1632 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1633 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1634 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1635 struct lys_module *module; /**< module structure */
1636 struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */
1637 struct lysc_node_action *next; /**< next sibling node (NULL if there is no one) */
1638 struct lysc_node_action *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1639 never NULL. If there is no sibling node, pointer points to the node
1640 itself. In case of the first node, this pointer points to the last
1641 node in the list. */
1642 const char *name; /**< action/RPC name (mandatory) */
1643 const char *dsc; /**< description */
1644 const char *ref; /**< reference */
1645 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001646 void *priv; /** private arbitrary user data, not used by libyang */
1647 };
1648 };
1649
Radek Krejci9a3823e2021-01-27 20:26:46 +01001650 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1651 the action/RPC nodes do not contain the when statement on their own, but they can
1652 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001653 struct lysc_node_action_inout input; /**< RPC's/action's input */
1654 struct lysc_node_action_inout output; /**< RPC's/action's output */
1655
1656};
1657
1658struct lysc_node_notif {
1659 union {
1660 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1661 struct {
1662 uint16_t nodetype; /**< LYS_NOTIF */
1663 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1664 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1665 struct lys_module *module; /**< module structure */
1666 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1667 struct lysc_node_notif *next; /**< next sibling node (NULL if there is no one) */
1668 struct lysc_node_notif *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1669 never NULL. If there is no sibling node, pointer points to the node
1670 itself. In case of the first node, this pointer points to the last
1671 node in the list. */
1672 const char *name; /**< Notification name (mandatory) */
1673 const char *dsc; /**< description */
1674 const char *ref; /**< reference */
1675 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001676 void *priv; /** private arbitrary user data, not used by libyang */
1677 };
1678 };
1679
Radek Krejci9a3823e2021-01-27 20:26:46 +01001680 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001681 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001682 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1683 the notification nodes do not contain the when statement on their own, but they can
1684 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001685};
1686
1687struct lysc_node_container {
1688 union {
1689 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1690 struct {
1691 uint16_t nodetype; /**< LYS_CONTAINER */
1692 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1693 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1694 struct lys_module *module; /**< module structure */
1695 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1696 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1697 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1698 never NULL. If there is no sibling node, pointer points to the node
1699 itself. In case of the first node, this pointer points to the last
1700 node in the list. */
1701 const char *name; /**< node name (mandatory) */
1702 const char *dsc; /**< description */
1703 const char *ref; /**< reference */
1704 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001705 void *priv; /**< private arbitrary user data, not used by libyang */
1706 };
1707 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001708
1709 struct lysc_node *child; /**< first child node (linked list) */
1710 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001711 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001712 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1713 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001714};
1715
Radek Krejcia3045382018-11-22 14:30:31 +01001716struct lysc_node_case {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001717 union {
1718 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1719 struct {
1720 uint16_t nodetype; /**< LYS_CASE */
1721 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1722 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1723 struct lys_module *module; /**< module structure */
1724 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1725 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1726 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejci056d0a82018-12-06 16:57:25 +01001727 never NULL. If there is no sibling node, pointer points to the node
1728 itself. In case of the first node, this pointer points to the last
1729 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001730 const char *name; /**< name of the case, including the implicit case */
1731 const char *dsc; /**< description */
1732 const char *ref; /**< reference */
1733 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001734 void *priv; /**< private arbitrary user data, not used by libyang */
1735 };
1736 };
Radek Krejci056d0a82018-12-06 16:57:25 +01001737
Radek Krejcia3045382018-11-22 14:30:31 +01001738 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 +01001739 each other as siblings with the parent pointer pointing to appropriate case node. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001740 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcia3045382018-11-22 14:30:31 +01001741};
1742
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001743struct lysc_node_choice {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001744 union {
1745 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1746 struct {
1747 uint16_t nodetype; /**< LYS_CHOICE */
1748 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1749 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1750 struct lys_module *module; /**< module structure */
1751 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1752 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1753 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001754 never NULL. If there is no sibling node, pointer points to the node
1755 itself. In case of the first node, this pointer points to the last
1756 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001757 const char *name; /**< node name (mandatory) */
1758 const char *dsc; /**< description */
1759 const char *ref; /**< reference */
1760 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001761 void *priv; /**< private arbitrary user data, not used by libyang */
1762 };
1763 };
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001764
Radek Krejcia9026eb2018-12-12 16:04:47 +01001765 struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other
1766 as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the
1767 case is simple. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001768 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001769 struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001770};
1771
1772struct lysc_node_leaf {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001773 union {
1774 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1775 struct {
1776 uint16_t nodetype; /**< LYS_LEAF */
1777 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1778 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1779 struct lys_module *module; /**< module structure */
1780 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1781 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1782 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001783 never NULL. If there is no sibling node, pointer points to the node
1784 itself. In case of the first node, this pointer points to the last
1785 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001786 const char *name; /**< node name (mandatory) */
1787 const char *dsc; /**< description */
1788 const char *ref; /**< reference */
1789 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001790 void *priv; /**< private arbitrary user data, not used by libyang */
1791 };
1792 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001793
1794 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001795 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001796 struct lysc_type *type; /**< type of the leaf node (mandatory) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001797
Radek Krejci4f28eda2018-11-12 11:46:16 +01001798 const char *units; /**< units of the leaf's type */
Radek Krejcia1911222019-07-22 17:24:50 +02001799 struct lyd_value *dflt; /**< default value */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001800};
1801
1802struct lysc_node_leaflist {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001803 union {
1804 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1805 struct {
1806 uint16_t nodetype; /**< LYS_LEAFLIST */
1807 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1808 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1809 struct lys_module *module; /**< module structure */
1810 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1811 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1812 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001813 never NULL. If there is no sibling node, pointer points to the node
1814 itself. In case of the first node, this pointer points to the last
1815 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001816 const char *name; /**< node name (mandatory) */
1817 const char *dsc; /**< description */
1818 const char *ref; /**< reference */
1819 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001820 void *priv; /**< private arbitrary user data, not used by libyang */
1821 };
1822 };
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001823
1824 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001825 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001826 struct lysc_type *type; /**< type of the leaf node (mandatory) */
1827
Radek Krejci0e5d8382018-11-28 16:37:53 +01001828 const char *units; /**< units of the leaf's type */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001829 struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */
Michal Vaskoba99a3e2020-08-18 15:50:05 +02001830
Radek Krejci0e5d8382018-11-28 16:37:53 +01001831 uint32_t min; /**< min-elements constraint */
1832 uint32_t max; /**< max-elements constraint */
1833
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001834};
1835
1836struct lysc_node_list {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001837 union {
1838 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1839 struct {
1840 uint16_t nodetype; /**< LYS_LIST */
1841 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1842 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1843 struct lys_module *module; /**< module structure */
1844 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1845 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1846 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001847 never NULL. If there is no sibling node, pointer points to the node
1848 itself. In case of the first node, this pointer points to the last
1849 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001850 const char *name; /**< node name (mandatory) */
1851 const char *dsc; /**< description */
1852 const char *ref; /**< reference */
1853 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001854 void *priv; /**< private arbitrary user data, not used by libyang */
1855 };
1856 };
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001857
1858 struct lysc_node *child; /**< first child node (linked list) */
1859 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001860 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001861 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1862 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001863
Radek Krejci2a9fc652021-01-22 17:44:34 +01001864 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 +01001865 uint32_t min; /**< min-elements constraint */
1866 uint32_t max; /**< max-elements constraint */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001867};
1868
1869struct lysc_node_anydata {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001870 union {
1871 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1872 struct {
1873 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1874 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1875 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1876 struct lys_module *module; /**< module structure */
1877 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1878 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1879 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001880 never NULL. If there is no sibling node, pointer points to the node
1881 itself. In case of the first node, this pointer points to the last
1882 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001883 const char *name; /**< node name (mandatory) */
1884 const char *dsc; /**< description */
1885 const char *ref; /**< reference */
1886 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001887 void *priv; /**< private arbitrary user data, not used by libyang */
1888 };
1889 };
Radek Krejci9800fb82018-12-13 14:26:23 +01001890
1891 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001892 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001893};
1894
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001895/**
1896 * @brief Compiled YANG schema tree structure representing YANG module.
1897 *
1898 * Semantically validated YANG schema tree for data tree parsing.
1899 * Contains only the necessary information for the data validation.
1900 */
1901struct lysc_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001902 struct lys_module *mod; /**< covering module structure */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001903
Radek Krejci2a408df2018-10-29 16:32:26 +01001904 struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001905 struct lysc_node_action *rpcs; /**< first of actions nodes (linked list) */
1906 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001907 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001908};
1909
1910/**
Radek Krejci490a5462020-11-05 08:44:42 +01001911 * @brief Examine whether a node is user-ordered list or leaf-list.
1912 *
1913 * @param[in] lysc_node Schema node to examine.
1914 * @return Boolean value whether the @p node is user-ordered or not.
1915 */
1916#define lysc_is_userordered(lysc_node) \
1917 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAFLIST | LYS_LIST)) || !(lysc_node->flags & LYS_ORDBY_USER)) ? 0 : 1)
1918
1919/**
1920 * @brief Examine whether a node is a list's key.
1921 *
1922 * @param[in] lysc_node Schema node to examine.
1923 * @return Boolean value whether the @p node is a key or not.
1924 */
1925#define lysc_is_key(lysc_node) \
Michal Vaskobce7ee32021-02-04 11:05:25 +01001926 ((!lysc_node || (lysc_node->nodetype != LYS_LEAF) || !(lysc_node->flags & LYS_KEY)) ? 0 : 1)
Radek Krejci490a5462020-11-05 08:44:42 +01001927
1928/**
Michal Vasko5c123b02020-12-04 14:34:04 +01001929 * @brief Examine whether a node is a non-presence container.
1930 *
1931 * @param[in] lysc_node Schema node to examine.
1932 * @return Boolean value whether the @p node is a NP container or not.
1933 */
1934#define lysc_is_np_cont(lysc_node) \
Michal Vaskobce7ee32021-02-04 11:05:25 +01001935 ((!lysc_node || (lysc_node->nodetype != LYS_CONTAINER) || (lysc_node->flags & LYS_PRESENCE)) ? 0 : 1)
1936
1937/**
1938 * @brief Examine whether a node is a key-less list or a state leaf-list.
1939 *
1940 * @param[in] lysc_node Schema node to examine.
1941 * @return Boolean value whether the @p node is a list with duplicate instances allowed.
1942 */
1943#define lysc_is_dup_inst_list(lysc_node) \
1944 ((lysc_node && (((lysc_node->nodetype == LYS_LIST) && (lysc_node->flags & LYS_KEYLESS)) || \
1945 ((lysc_node->nodetype == LYS_LEAFLIST) && (lysc_node->flags & LYS_CONFIG_R)))) ? 1 : 0)
Michal Vasko5c123b02020-12-04 14:34:04 +01001946
1947/**
Michal Vaskod5cfa6e2020-11-23 16:56:08 +01001948 * @brief Check whether the schema node data instance existence depends on any when conditions.
1949 * This node and any direct parent choice and case schema nodes are also examined for when conditions.
1950 *
1951 * Be careful, this function is not recursive and checks only conditions that apply to this node directly.
1952 * Meaning if there are any conditions associated with any data parent instance of @p node, they are not returned.
1953 *
1954 * @param[in] node Schema node to examine.
1955 * @return When condition associated with the node data instance, NULL if there is none.
1956 */
1957const struct lysc_when *lysc_has_when(const struct lysc_node *node);
1958
1959/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001960 * @brief Get the groupings linked list of the given (parsed) schema node.
Radek Krejci53ea6152018-12-13 15:21:15 +01001961 * Decides the node's type and in case it has a groupings array, returns it.
1962 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001963 * @return The node's groupings linked list if any, NULL otherwise.
Radek Krejci53ea6152018-12-13 15:21:15 +01001964 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001965const struct lysp_node_grp *lysp_node_groupings(const struct lysp_node *node);
Radek Krejci53ea6152018-12-13 15:21:15 +01001966
1967/**
Radek Krejci056d0a82018-12-06 16:57:25 +01001968 * @brief Get the typedefs sized array of the given (parsed) schema node.
1969 * Decides the node's type and in case it has a typedefs array, returns it.
1970 * @param[in] node Node to examine.
1971 * @return The node's typedefs sized array if any, NULL otherwise.
1972 */
1973const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
1974
1975/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001976 * @brief Get the actions/RPCs linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001977 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1978 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001979 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01001980 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001981const struct lysp_node_action *lysp_node_actions(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01001982
1983/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001984 * @brief Get the Notifications linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001985 * Decides the node's type and in case it has a Notifications array, returns it.
1986 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001987 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01001988 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001989const struct lysp_node_notif *lysp_node_notifs(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01001990
1991/**
1992 * @brief Get the children linked list of the given (parsed) schema node.
1993 * Decides the node's type and in case it has a children list, returns it.
1994 * @param[in] node Node to examine.
1995 * @return The node's children linked list if any, NULL otherwise.
1996 */
Michal Vasko544e58a2021-01-28 14:33:41 +01001997const struct lysp_node *lysp_node_child(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01001998
1999/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002000 * @brief Get the actions/RPCs linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002001 * Decides the node's type and in case it has a actions/RPCs array, returns it.
2002 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002003 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002004 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002005const struct lysc_node_action *lysc_node_actions(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002006
2007/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002008 * @brief Get the Notifications linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002009 * Decides the node's type and in case it has a Notifications array, returns it.
2010 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002011 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002012 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002013const struct lysc_node_notif *lysc_node_notifs(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002014
2015/**
2016 * @brief Get the children linked list of the given (compiled) schema node.
Michal Vasko2a668712020-10-21 11:48:09 +02002017 *
Michal Vasko544e58a2021-01-28 14:33:41 +01002018 * Note that ::LYS_CHOICE has only ::LYS_CASE children.
2019 * Also, ::LYS_RPC and ::LYS_ACTION have the first child ::LYS_INPUT, its sibling is ::LYS_OUTPUT.
2020 *
Michal Vasko2a668712020-10-21 11:48:09 +02002021 * @param[in] node Node to examine.
Michal Vasko2a668712020-10-21 11:48:09 +02002022 * @return Children linked list if any,
2023 * @return NULL otherwise.
2024 */
Michal Vasko544e58a2021-01-28 14:33:41 +01002025const struct lysc_node *lysc_node_child(const struct lysc_node *node);
Michal Vasko2a668712020-10-21 11:48:09 +02002026
2027/**
Radek Krejci9a3823e2021-01-27 20:26:46 +01002028 * @brief Get the must statements list if present in the @p node
2029 *
2030 * @param[in] node Node to examine.
2031 * @return Pointer to the list of must restrictions ([sized array](@ref sizedarrays))
2032 * @return NULL if there is no must statement in the node, no matter if it is not even allowed or just present
2033 */
2034struct lysc_must *lysc_node_musts(const struct lysc_node *node);
2035
2036/**
2037 * @brief Get the when statements list if present in the @p node
2038 *
2039 * @param[in] node Node to examine.
2040 * @return Pointer to the list of pointers to when statements ([sized array](@ref sizedarrays))
2041 * @return NULL if there is no when statement in the node, no matter if it is not even allowed or just present
2042 */
2043struct lysc_when **lysc_node_when(const struct lysc_node *node);
2044
2045/**
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002046 * @brief Callback to be called for every schema node in a DFS traversal.
2047 *
2048 * @param[in] node Current node.
2049 * @param[in] data Arbitrary user data.
2050 * @param[out] dfs_continue Set to true if the current subtree should be skipped and continue with siblings instead.
2051 * @return LY_SUCCESS on success,
2052 * @return LY_ERR value to terminate DFS and return this value.
2053 */
Radek Krejci01180ac2021-01-27 08:48:22 +01002054typedef LY_ERR (*lysc_dfs_clb)(struct lysc_node *node, void *child, ly_bool *dfs_continue);
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002055
2056/**
2057 * @brief DFS traversal of all the schema nodes in a (sub)tree including any actions and nested notifications.
2058 *
2059 * Node with children, actions, and notifications is traversed in this order:
2060 * 1) each child subtree;
2061 * 2) each action subtree;
2062 * 3) each notification subtree.
2063 *
2064 * For algorithm illustration or traversal with actions and notifications skipped, see ::LYSC_TREE_DFS_BEGIN.
2065 *
2066 * @param[in] root Schema root to fully traverse.
2067 * @param[in] dfs_clb Callback to call for each node.
2068 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2069 * @return LY_SUCCESS on success,
2070 * @return LY_ERR value returned by @p dfs_clb.
2071 */
2072LY_ERR lysc_tree_dfs_full(const struct lysc_node *root, lysc_dfs_clb dfs_clb, void *data);
2073
2074/**
2075 * @brief DFS traversal of all the schema nodes in a module including RPCs and notifications.
2076 *
2077 * For more details, see ::lysc_tree_dfs_full().
2078 *
2079 * @param[in] mod Module to fully traverse.
2080 * @param[in] dfs_clb Callback to call for each node.
2081 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2082 * @return LY_SUCCESS on success,
2083 * @return LY_ERR value returned by @p dfs_clb.
2084 */
2085LY_ERR lysc_module_dfs_full(const struct lys_module *mod, lysc_dfs_clb dfs_clb, void *data);
2086
2087/**
Radek Krejci151a5b72018-10-19 14:21:44 +02002088 * @brief Get how the if-feature statement currently evaluates.
2089 *
2090 * @param[in] iff Compiled if-feature statement to evaluate.
Michal Vasko28d78432020-05-26 13:10:53 +02002091 * @return LY_SUCCESS if the statement evaluates to true,
2092 * @return LY_ENOT if it evaluates to false,
2093 * @return LY_ERR on error.
Radek Krejci151a5b72018-10-19 14:21:44 +02002094 */
Michal Vasko28d78432020-05-26 13:10:53 +02002095LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff);
Radek Krejci151a5b72018-10-19 14:21:44 +02002096
2097/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002098 * @brief Get the next feature in the module or submodules.
Radek Krejci151a5b72018-10-19 14:21:44 +02002099 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002100 * @param[in] last Last returned feature.
2101 * @param[in] pmod Parsed module and submodoules whose features to iterate over.
2102 * @param[in,out] idx Submodule index, set to 0 on first call.
2103 * @return Next found feature, NULL if the last has already been returned.
Radek Krejci151a5b72018-10-19 14:21:44 +02002104 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002105struct 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 +02002106
Radek Krejcibed13942020-10-19 16:06:28 +02002107/**
2108 * @defgroup findxpathoptions Atomize XPath options
2109 * Options to modify behavior of ::lys_find_xpath() and ::lys_find_xpath_atoms() searching for schema nodes in schema tree.
2110 * @{
2111 */
Michal Vaskocdad7122020-11-09 21:04:44 +01002112#define LYS_FIND_XP_SCHEMA 0x08 /**< Apply node access restrictions defined for 'when' and 'must' evaluation. */
2113#define LYS_FIND_XP_OUTPUT 0x10 /**< Search RPC/action output nodes instead of input ones. */
Radek Krejci576f8fa2020-10-26 21:23:58 +01002114/** @} findxpathoptions */
Michal Vasko072de482020-08-05 13:27:21 +02002115
Radek Krejci151a5b72018-10-19 14:21:44 +02002116/**
Michal Vasko40308e72020-10-20 16:38:40 +02002117 * @brief Get all the schema nodes that are required for @p xpath to be evaluated (atoms).
Michal Vasko519fd602020-05-26 12:17:39 +02002118 *
Michal Vasko26512682021-01-11 11:35:40 +01002119 * @param[in] ctx libyang context to use. May be NULL if @p ctx_node is set.
2120 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002121 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002122 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko519fd602020-05-26 12:17:39 +02002123 * @param[out] set Set of found atoms (schema nodes).
2124 * @return LY_SUCCESS on success, @p set is returned.
Michal Vasko40308e72020-10-20 16:38:40 +02002125 * @return LY_ERR value on error.
Michal Vasko519fd602020-05-26 12:17:39 +02002126 */
Michal Vasko26512682021-01-11 11:35:40 +01002127LY_ERR lys_find_xpath_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
2128 uint32_t options, struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002129
Michal Vasko072de482020-08-05 13:27:21 +02002130/**
Michal Vasko40308e72020-10-20 16:38:40 +02002131 * @brief Get all the schema nodes that are required for @p expr to be evaluated (atoms).
Michal Vasko072de482020-08-05 13:27:21 +02002132 *
Michal Vasko26512682021-01-11 11:35:40 +01002133 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002134 * @param[in] cur_mod Current module for the expression (where it was "instantiated").
2135 * @param[in] expr Parsed expression to use.
2136 * @param[in] prefixes Sized array of compiled prefixes.
2137 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
2138 * @param[out] set Set of found atoms (schema nodes).
2139 * @return LY_SUCCESS on success, @p set is returned.
2140 * @return LY_ERR value on error.
2141 */
2142LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod,
2143 const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set);
2144
2145/**
2146 * @brief Evaluate an @p xpath expression on schema nodes.
2147 *
Michal Vasko26512682021-01-11 11:35:40 +01002148 * @param[in] ctx libyang context to use for absolute @p xpath. May be NULL if @p ctx_node is set.
2149 * @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 +02002150 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002151 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko072de482020-08-05 13:27:21 +02002152 * @param[out] set Set of found schema nodes.
2153 * @return LY_SUCCESS on success, @p set is returned.
2154 * @return LY_ERR value if an error occurred.
2155 */
Michal Vasko26512682021-01-11 11:35:40 +01002156LY_ERR lys_find_xpath(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath, uint32_t options,
2157 struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002158
2159/**
Radek Krejcibc5644c2020-10-27 14:53:17 +01002160 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2161 *
2162 * @param[in] path Compiled path to use.
2163 * @param[out] set Set of found atoms (schema nodes).
2164 * @return LY_SUCCESS on success, @p set is returned.
2165 * @return LY_ERR value on error.
2166 */
2167LY_ERR lys_find_lypath_atoms(const struct ly_path *path, struct ly_set **set);
2168
2169/**
2170 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2171 *
Michal Vasko26512682021-01-11 11:35:40 +01002172 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2173 * @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 +01002174 * @param[in] path JSON path to examine.
2175 * @param[in] output Search operation output instead of input.
2176 * @param[out] set Set of found atoms (schema nodes).
2177 * @return LY_ERR value on error.
2178 */
2179LY_ERR lys_find_path_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path, ly_bool output,
2180 struct ly_set **set);
2181
2182/**
2183 * @brief Get a schema node based on the given data path (JSON format, see @ref howtoXPath).
2184 *
Michal Vasko26512682021-01-11 11:35:40 +01002185 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2186 * @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 +01002187 * @param[in] path JSON path of the node to get.
2188 * @param[in] output Search operation output instead of input.
2189 * @return Found schema node or NULL.
2190 */
2191const struct lysc_node *lys_find_path(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path,
2192 ly_bool output);
2193
2194/**
Michal Vasko03ff5a72019-09-11 13:49:33 +02002195 * @brief Types of the different schema paths.
2196 */
2197typedef enum {
Michal Vasko65de0402020-08-03 16:34:19 +02002198 LYSC_PATH_LOG, /**< Descriptive path format used in log messages */
2199 LYSC_PATH_DATA /**< Similar to ::LYSC_PATH_LOG except that schema-only nodes (choice, case) are skipped */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002200} LYSC_PATH_TYPE;
2201
2202/**
Radek Krejci327de162019-06-14 12:52:07 +02002203 * @brief Generate path of the given node in the requested format.
2204 *
2205 * @param[in] node Schema path of this node will be generated.
2206 * @param[in] pathtype Format of the path to generate.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002207 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
2208 * If NULL, memory for the complete path is allocated.
2209 * @param[in] buflen Size of the provided @p buffer.
Radek Krejci327de162019-06-14 12:52:07 +02002210 * @return NULL in case of memory allocation error, path of the node otherwise.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002211 * 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 +02002212 */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002213char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
Radek Krejci327de162019-06-14 12:52:07 +02002214
2215/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002216 * @brief Available YANG schema tree structures representing YANG module.
2217 */
2218struct lys_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002219 struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */
2220 const char *name; /**< name of the module (mandatory) */
Radek Krejci0af46292019-01-11 16:02:31 +01002221 const char *revision; /**< revision of the module (if present) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002222 const char *ns; /**< namespace of the module (module - mandatory) */
2223 const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */
2224 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
2225 const char *org; /**< party/company responsible for the module */
2226 const char *contact; /**< contact information for the module */
2227 const char *dsc; /**< description of the module */
2228 const char *ref; /**< cross-reference for the module */
2229
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002230 struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */
Radek Krejci0af46292019-01-11 16:02:31 +01002231 struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing.
2232 Available only for implemented modules. */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002233
Radek Krejci80d281e2020-09-14 17:42:54 +02002234 struct lysc_ident *identities; /**< List of compiled identities of the module ([sized array](@ref sizedarrays))
2235 Identities are outside the compiled tree to allow their linkage to the identities from
2236 the implemented modules. This avoids problems when the module became implemented in
2237 future (no matter if implicitly via augment/deviate or explicitly via
2238 ::lys_set_implemented()). Note that if the module is not implemented (compiled), the
2239 identities cannot be instantiated in data (in identityrefs). */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002240
2241 struct lys_module **augmented_by;/**< List of modules that augment this module ([sized array](@ref sizedarrays)) */
2242 struct lys_module **deviated_by; /**< List of modules that deviate this module ([sized array](@ref sizedarrays)) */
2243
Michal Vasko89b5c072020-10-06 13:52:44 +02002244 ly_bool implemented; /**< flag if the module is implemented, not just imported */
Radek Krejci95710c92019-02-11 15:49:55 +01002245 uint8_t latest_revision; /**< flag to mark the latest available revision:
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002246 1 - the latest revision in searchdirs was not searched yet and this is the
2247 latest revision in the current context
2248 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002249};
2250
Radek Krejci151a5b72018-10-19 14:21:44 +02002251/**
Michal Vasko82c31e62020-07-17 15:30:40 +02002252 * @brief Get the current real status of the specified feature in the module.
2253 *
2254 * If the feature is enabled, but some of its if-features are false, the feature is considered
2255 * disabled.
Radek Krejci151a5b72018-10-19 14:21:44 +02002256 *
2257 * @param[in] module Module where the feature is defined.
2258 * @param[in] feature Name of the feature to inspect.
Michal Vasko82c31e62020-07-17 15:30:40 +02002259 * @return LY_SUCCESS if the feature is enabled,
2260 * @return LY_ENOT if the feature is disabled,
2261 * @return LY_ENOTFOUND if the feature was not found.
Radek Krejci151a5b72018-10-19 14:21:44 +02002262 */
Michal Vasko82c31e62020-07-17 15:30:40 +02002263LY_ERR lys_feature_value(const struct lys_module *module, const char *feature);
Radek Krejcidd4e8d42018-10-16 14:55:43 +02002264
2265/**
Radek Krejcia3045382018-11-22 14:30:31 +01002266 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can
2267 * be from an augment.
2268 *
Radek Krejci8678fa42020-08-18 16:07:28 +02002269 * ::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 +01002270 * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module.
2271 * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
2272 * \p parent and \p module parameters.
2273 *
2274 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
2275 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
2276 * all the schema nodes are iteratively returned.
2277 *
2278 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
2279 * @param[in] parent Parent of the subtree where the function starts processing.
2280 * @param[in] module In case of iterating on top level elements, the \p parent is NULL and
2281 * module must be specified.
2282 * @param[in] options [ORed options](@ref sgetnextflags).
2283 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
2284 */
2285const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002286 const struct lysc_module *module, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002287
2288/**
Radek Krejci8678fa42020-08-18 16:07:28 +02002289 * @defgroup sgetnextflags Options for ::lys_getnext().
2290 *
2291 * Various options setting behavior of ::lys_getnext().
2292 *
Radek Krejcia3045382018-11-22 14:30:31 +01002293 * @{
2294 */
Radek Krejci8678fa42020-08-18 16:07:28 +02002295#define LYS_GETNEXT_WITHCHOICE 0x01 /**< ::lys_getnext() option to allow returning #LYS_CHOICE nodes instead of looking into them */
2296#define LYS_GETNEXT_NOCHOICE 0x02 /**< ::lys_getnext() option to ignore (kind of conditional) nodes within choice node */
2297#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 +01002298#define LYS_GETNEXT_INTONPCONT 0x08 /**< ::lys_getnext() option to look into non-presence container, instead of returning container itself */
2299#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 +01002300 provided by default */
Radek Krejcia3045382018-11-22 14:30:31 +01002301/** @} sgetnextflags */
2302
2303/**
2304 * @brief Get child node according to the specified criteria.
2305 *
2306 * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched.
2307 * @param[in] module module of the node to find. It is also limitation for the children node of the given parent.
2308 * @param[in] name Name of the node to find.
2309 * @param[in] name_len Optional length of the name in case it is not NULL-terminated string.
2310 * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find.
2311 * Used as a bitmask, so multiple nodetypes can be specified.
2312 * @param[in] options [ORed options](@ref sgetnextflags).
2313 * @return Found node if any.
2314 */
Michal Vaskoe444f752020-02-10 12:20:06 +01002315const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002316 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002317
2318/**
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002319 * @brief Make the specific module implemented.
2320 *
Michal Vaskoe8988e92021-01-25 11:26:29 +01002321 * If the module is already implemented but with a different set of features, the whole context is recompiled.
2322 *
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002323 * @param[in] mod Module to make implemented. It is not an error
2324 * to provide already implemented module, it just does nothing.
Michal Vaskoe8988e92021-01-25 11:26:29 +01002325 * @param[in] features Optional array specifying the enabled features terminated with NULL overriding any previous
2326 * feature setting. The feature string '*' enables all the features and array of length 1 with only the terminating
2327 * NULL explicitly disables all the features. In case the parameter is NULL, the features are untouched - left disabled
2328 * 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 +01002329 * @return LY_SUCCESS on success.
2330 * @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 +01002331 * @return LY_ERR on other errors during module compilation.
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002332 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002333LY_ERR lys_set_implemented(struct lys_module *mod, const char **features);
Radek Krejcia3045382018-11-22 14:30:31 +01002334
Radek Krejci084289f2019-07-09 17:35:30 +02002335/**
2336 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
2337 *
2338 * 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 +02002339 * require-instance restriction), use ::lyd_value_validate().
Radek Krejci084289f2019-07-09 17:35:30 +02002340 *
2341 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
2342 * @param[in] node Schema node for the @p value.
Michal Vaskof937cfe2020-08-03 16:07:12 +02002343 * @param[in] value String value to be checked, expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02002344 * @param[in] value_len Length of the given @p value (mandatory).
Radek Krejci084289f2019-07-09 17:35:30 +02002345 * @return LY_SUCCESS on success
2346 * @return LY_ERR value if an error occurred.
2347 */
Michal Vaskof937cfe2020-08-03 16:07:12 +02002348LY_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 +02002349
Radek Krejci0935f412019-08-20 16:15:18 +02002350/**
2351 * @brief Stringify schema nodetype.
Michal Vaskod43d71a2020-08-07 14:54:58 +02002352 *
Radek Krejci0935f412019-08-20 16:15:18 +02002353 * @param[in] nodetype Nodetype to stringify.
2354 * @return Constant string with the name of the node's type.
2355 */
2356const char *lys_nodetype2str(uint16_t nodetype);
2357
Michal Vaskod43d71a2020-08-07 14:54:58 +02002358/**
2359 * @brief Getter for original XPath expression from a parsed expression.
2360 *
2361 * @param[in] path Parsed expression.
2362 * @return Original string expression.
2363 */
2364const char *lyxp_get_expr(const struct lyxp_expr *path);
2365
Radek Krejci2ff0d572020-05-21 15:27:28 +02002366/** @} schematree */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002367
Radek Krejci70853c52018-10-15 14:46:16 +02002368#ifdef __cplusplus
2369}
2370#endif
2371
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002372#endif /* LY_TREE_SCHEMA_H_ */