blob: e9f069aac55dee4ec5a38302f9b9f4267799cdfc [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| | | | | | | | | |
Christian Hopps7cfa9612021-02-04 11:45:41 -0500824 * LYS_SET_PRESENCE |x| | | | | | | | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100825 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
826 * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | |
827 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
828 * 12 LYS_SET_CONFIG |x|x|x|x|x|x| | | | | | | | |
Michal Vaskod1e53b92021-01-28 13:11:06 +0100829 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
830 * 13 LYS_IS_INPUT |x|x|x|x|x|x|x| | | | | | | |
831 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
832 * 14 LYS_IS_OUTPUT |x|x|x|x|x|x|x| | | | | | | |
833 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
834 * 15 LYS_IS_NOTIF |x|x|x|x|x|x|x| | | | | | | |
Michal Vaskoecd62de2019-11-13 12:35:11 +0100835 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100836 *
837 */
838
839/**
840 * @defgroup snodeflags Schema nodes flags
Radek Krejci8678fa42020-08-18 16:07:28 +0200841 *
842 * Various flags for schema nodes ([parsed](@ref spnodeflags) as well as [compiled](@ref scnodeflags)).
843 *
Radek Krejci4f28eda2018-11-12 11:46:16 +0100844 * @{
845 */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100846#define LYS_CONFIG_W 0x01 /**< config true; */
847#define LYS_CONFIG_R 0x02 /**< config false; */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200848#define LYS_CONFIG_MASK 0x03 /**< mask for config value */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100849#define LYS_STATUS_CURR 0x04 /**< status current; */
850#define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */
851#define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */
852#define LYS_STATUS_MASK 0x1C /**< mask for status value */
853#define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice,
Radek Krejcife909632019-02-12 15:34:42 +0100854 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
855 The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0.
856 The ::lysc_node_container has this flag if it is not a presence container and it has at least one
857 child with LYS_MAND_TRUE. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100858#define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice,
859 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
860 This flag is present only in case the mandatory false statement was explicitly specified. */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100861#define LYS_MAND_MASK 0x60 /**< mask for mandatory values */
Michal Vaskoc118ae22020-08-06 14:51:09 +0200862#define LYS_PRESENCE 0x80 /**< flag for presence property of a container, but it is not only for explicit presence
863 containers, but also for NP containers with some meaning, applicable only to
864 ::lysc_node_container */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100865#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 +0100866#define LYS_KEY 0x0100 /**< flag for leafs being a key of a list, applicable only to ::lysc_node_leaf */
867#define LYS_KEYLESS 0x0200 /**< flag for list without any key, applicable only to ::lysc_node_list */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100868#define LYS_FENABLED 0x20 /**< feature enabled flag, applicable only to ::lysp_feature. */
Radek Krejcife909632019-02-12 15:34:42 +0100869#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 +0100870 ::lysc_node_list/::lysp_node_list */
871#define LYS_ORDBY_USER 0x40 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and
872 ::lysc_node_list/::lysp_node_list */
873#define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */
874#define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100875#define LYS_YINELEM_FALSE 0x0100 /**< yin-element false for extension's argument */
876#define LYS_YINELEM_MASK 0x0180 /**< mask for yin-element value */
877#define LYS_USED_GRP 0x0400 /**< internal flag for validating not-instantiated groupings
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200878 (resp. do not validate again the instantiated groupings). */
Michal Vaskod1e53b92021-01-28 13:11:06 +0100879#define LYS_SET_VALUE 0x0200 /**< value attribute is set */
880#define LYS_SET_MIN 0x0200 /**< min attribute is set */
881#define LYS_SET_MAX 0x0400 /**< max attribute is set */
Radek Krejcid505e3d2018-11-13 09:04:17 +0100882
883#define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */
884#define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */
885#define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */
886#define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */
887#define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */
888#define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */
889#define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */
890#define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */
891#define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */
892#define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */
Radek Krejciccd20f12019-02-15 14:12:27 +0100893#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 +0100894 cases of choice. This information is important for refines, since it is prohibited to make leafs
895 with default statement mandatory. In case the default leaf value is taken from type, it is thrown
Radek Krejciccd20f12019-02-15 14:12:27 +0100896 away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish
897 between own default or the default values taken from the type. */
Christian Hopps7cfa9612021-02-04 11:45:41 -0500898#define LYS_SET_PRESENCE 0x0200 /**< flag to know if container presence property was set explicitly */
Radek Krejciccd20f12019-02-15 14:12:27 +0100899#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 +0100900#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 +0100901
Michal Vaskod1e53b92021-01-28 13:11:06 +0100902#define LYS_SINGLEQUOTED 0x0100 /**< flag for single-quoted argument of an extension instance's substatement, only when the source is YANG */
903#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 +0200904
Michal Vaskod1e53b92021-01-28 13:11:06 +0100905#define LYS_YIN_ATTR 0x0400 /**< flag to identify YIN attribute parsed as extension's substatement, only when the source is YIN */
906#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 +0200907
Michal Vasko3e9bc2f2020-11-04 17:13:56 +0100908#define LYS_INTERNAL 0x1000 /**< flag to identify internal parsed statements that should not be printed */
909
Michal Vaskod1e53b92021-01-28 13:11:06 +0100910#define LYS_IS_ENUM 0x0200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */
911
912#define LYS_IS_INPUT 0x1000 /**< flag for nodes that are in the subtree of an input statement */
913
914#define LYS_IS_OUTPUT 0x2000 /**< flag for nodes that are in the subtree of an output statement */
915
916#define LYS_IS_NOTIF 0x4000 /**< flag for nodes that are in the subtree of a notification statement */
Radek Krejci693262f2019-04-29 15:23:20 +0200917
Radek Krejcife909632019-02-12 15:34:42 +0100918#define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200919/** @} snodeflags */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200920
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200921/**
922 * @brief Generic YANG data node
923 */
924struct lysp_node {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100925 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200926 uint16_t nodetype; /**< type of the node (mandatory) */
927 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100928 struct lysp_node *next; /**< next sibling node (NULL if there is no one) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200929 const char *name; /**< node name (mandatory) */
930 const char *dsc; /**< description statement */
931 const char *ref; /**< reference statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200932 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)),
933 must be qname because of refines */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200934 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200935};
936
937/**
938 * @brief Extension structure of the lysp_node for YANG container
939 */
940struct lysp_node_container {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100941 union {
942 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
943 struct {
944 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
945 uint16_t nodetype; /**< LYS_CONTAINER */
946 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
947 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
948 const char *name; /**< node name (mandatory) */
949 const char *dsc; /**< description statement */
950 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100951 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
952 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
953 };
954 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200955
956 /* container */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200957 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +0100958 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200959 const char *presence; /**< presence description */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200960 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100961 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200962 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100963 struct lysp_node_action *actions;/**< list of actions (linked list) */
964 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200965};
966
967struct lysp_node_leaf {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100968 union {
969 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
970 struct {
971 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
972 uint16_t nodetype; /**< LYS_LEAF */
973 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
974 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
975 const char *name; /**< node name (mandatory) */
976 const char *dsc; /**< description statement */
977 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100978 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
979 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
980 };
981 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200982
983 /* leaf */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200984 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +0100985 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200986 struct lysp_type type; /**< type of the leaf node (mandatory) */
987 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +0200988 struct lysp_qname dflt; /**< default value, it may or may not be a qualified name */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200989};
990
991struct lysp_node_leaflist {
Radek Krejci2a9fc652021-01-22 17:44:34 +0100992 union {
993 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
994 struct {
995 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
996 uint16_t nodetype; /**< LYS_LEAFLIST */
997 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
998 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
999 const char *name; /**< node name (mandatory) */
1000 const char *dsc; /**< description statement */
1001 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001002 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1003 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1004 };
1005 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001006
1007 /* leaf-list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001008 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001009 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001010 struct lysp_type type; /**< type of the leaf node (mandatory) */
1011 const char *units; /**< units of the leaf's type */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001012 struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)), they may or
1013 may not be qualified names */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001014 uint32_t min; /**< min-elements constraint */
1015 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1016};
1017
1018struct lysp_node_list {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001019 union {
1020 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1021 struct {
1022 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1023 uint16_t nodetype; /**< LYS_LIST */
1024 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1025 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1026 const char *name; /**< node name (mandatory) */
1027 const char *dsc; /**< description statement */
1028 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001029 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1030 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1031 };
1032 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001033
1034 /* list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001035 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001036 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001037 const char *key; /**< keys specification */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001038 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001039 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001040 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001041 struct lysp_node_action *actions;/**< list of actions (linked list) */
1042 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001043 struct lysp_qname *uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001044 uint32_t min; /**< min-elements constraint */
1045 uint32_t max; /**< max-elements constraint, 0 means unbounded */
1046};
1047
1048struct lysp_node_choice {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001049 union {
1050 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1051 struct {
1052 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1053 uint16_t nodetype; /**< LYS_CHOICE */
1054 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1055 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1056 const char *name; /**< node name (mandatory) */
1057 const char *dsc; /**< description statement */
1058 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001059 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1060 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1061 };
1062 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001063
1064 /* choice */
1065 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001066 struct lysp_when *when; /**< when statement */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001067 struct lysp_qname dflt; /**< default case */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001068};
1069
1070struct lysp_node_case {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001071 union {
1072 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1073 struct {
1074 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1075 uint16_t nodetype; /**< LYS_CASE */
1076 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1077 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1078 const char *name; /**< node name (mandatory) */
1079 const char *dsc; /**< description statement */
1080 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001081 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1082 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1083 };
1084 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001085
1086 /* case */
1087 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001088 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001089};
1090
1091struct lysp_node_anydata {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001092 union {
1093 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1094 struct {
1095 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1096 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1097 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1098 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1099 const char *name; /**< node name (mandatory) */
1100 const char *dsc; /**< description statement */
1101 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001102 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1103 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1104 };
1105 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001106
1107 /* anyxml/anydata */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001108 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001109 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001110};
1111
1112struct lysp_node_uses {
Radek Krejci2a9fc652021-01-22 17:44:34 +01001113 union {
1114 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1115 struct {
1116 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1117 uint16_t nodetype; /**< LYS_USES */
1118 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1119 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
1120 const char *name; /**< grouping name reference (mandatory) */
1121 const char *dsc; /**< description statement */
1122 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001123 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1124 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1125 };
1126 }; /**< common part corresponding to ::lysp_node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001127
1128 /* uses */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001129 struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001130 struct lysp_node_augment *augments; /**< list of augments (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001131 struct lysp_when *when; /**< when statement */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001132};
1133
1134/**
1135 * @brief YANG input-stmt and output-stmt
1136 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001137struct lysp_node_action_inout {
1138 union {
1139 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1140 struct {
1141 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1142 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1143 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1144 struct lysp_node *next; /**< NULL */
1145 const char *name; /**< empty string */
1146 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1147 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysp_node */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001148 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1149 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1150 };
1151 }; /**< common part corresponding to ::lysp_node */
1152
1153 /* inout */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001154 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1155 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001156 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001157 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001158};
1159
1160/**
1161 * @brief YANG rpc-stmt and action-stmt
1162 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001163struct lysp_node_action {
1164 union {
1165 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1166 struct {
1167 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1168 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1169 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1170 struct lysp_node_action *next; /**< pointer to the next action (NULL if there is no one) */
1171 const char *name; /**< grouping name reference (mandatory) */
1172 const char *dsc; /**< description statement */
1173 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001174 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1175 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1176 };
1177 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001178
1179 /* action */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001180 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1181 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
1182
1183 struct lysp_node_action_inout input; /**< RPC's/Action's input */
1184 struct lysp_node_action_inout output; /**< RPC's/Action's output */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001185};
1186
1187/**
1188 * @brief YANG notification-stmt
1189 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001190struct lysp_node_notif {
1191 union {
1192 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1193 struct {
1194 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1195 uint16_t nodetype; /**< LYS_NOTIF */
1196 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1197 struct lysp_node_notif *next; /**< pointer to the next notification (NULL if there is no one) */
1198 const char *name; /**< grouping name reference (mandatory) */
1199 const char *dsc; /**< description statement */
1200 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001201 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1202 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1203 };
1204 }; /**< common part corresponding to ::lysp_node */
Michal Vasko7f45cf22020-10-01 12:49:44 +02001205
1206 /* notif */
1207 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001208 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1209 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001210 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001211};
1212
1213/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001214 * @brief YANG grouping-stmt
1215 */
1216struct lysp_node_grp {
1217 union {
1218 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1219 struct {
1220 struct lysp_node *parent;/**< parent node (NULL if this is a top-level grouping) */
1221 uint16_t nodetype; /**< LYS_GROUPING */
1222 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1223 struct lysp_node_grp *next; /**< pointer to the next grouping (NULL if there is no one) */
1224 const char *name; /**< grouping name (mandatory) */
1225 const char *dsc; /**< description statement */
1226 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001227 struct lysp_qname *iffeatures; /**< ALWAYS NULL, compatibility member with ::lysp_node */
1228 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1229 };
1230 }; /**< common part corresponding to ::lysp_node */
1231
1232 /* grp */
1233 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1234 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci01180ac2021-01-27 08:48:22 +01001235 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001236 struct lysp_node_action *actions; /**< list of actions (linked list) */
1237 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1238};
1239
1240/**
1241 * @brief YANG uses-augment-stmt and augment-stmt (compatible with struct lysp_node )
1242 */
1243struct lysp_node_augment {
1244 union {
1245 struct lysp_node node; /**< implicit cast for the members compatible with ::lysp_node */
1246 struct {
1247 struct lysp_node *parent;/**< parent node (NULL if this is a top-level augment) */
1248 uint16_t nodetype; /**< LYS_AUGMENT */
1249 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
1250 struct lysp_node_augment *next; /**< pointer to the next augment (NULL if there is no one) */
1251 const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */
1252 const char *dsc; /**< description statement */
1253 const char *ref; /**< reference statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001254 struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1255 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1256 };
1257 }; /**< common part corresponding to ::lysp_node */
1258
1259 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001260 struct lysp_when *when; /**< when statement */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001261 struct lysp_node_action *actions;/**< list of actions (linked list) */
1262 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
1263};
1264
1265/**
Radek Krejcif0fceb62018-09-05 14:58:45 +02001266 * @brief supported YANG schema version values
1267 */
1268typedef enum LYS_VERSION {
1269 LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */
Radek Krejci96e48da2020-09-04 13:18:06 +02001270 LYS_VERSION_1_0 = 1, /**< YANG 1 (1.0) */
Radek Krejcif0fceb62018-09-05 14:58:45 +02001271 LYS_VERSION_1_1 = 2 /**< YANG 1.1 */
1272} LYS_VERSION;
1273
1274/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001275 * @brief Printable YANG schema tree structure representing YANG module.
1276 *
1277 * Simple structure corresponding to the YANG format. The schema is only syntactically validated.
1278 */
1279struct lysp_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001280 struct lys_module *mod; /**< covering module structure */
1281
Radek Krejcib7db73a2018-10-24 14:18:40 +02001282 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1283 in the list is always the last (newest) revision of the module */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001284 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1285 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001286 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1287 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1288 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1289 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001290 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001291 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001292 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1293 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1294 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001295 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001296 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001297
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001298 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001299 uint8_t parsing : 1; /**< flag for circular check */
1300 uint8_t is_submod : 1; /**< always 0 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001301};
1302
1303struct lysp_submodule {
Michal Vaskoc3781c32020-10-06 14:04:08 +02001304 struct lys_module *mod; /**< belongs to parent module (submodule - mandatory) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001305
1306 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1307 in the list is always the last (newest) revision of the module */
1308 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1309 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
1310 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1311 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1312 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1313 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001314 struct lysp_node_grp *groupings; /**< list of groupings (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001315 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001316 struct lysp_node_augment *augments; /**< list of augments (linked list) */
1317 struct lysp_node_action *rpcs; /**< list of RPCs (linked list) */
1318 struct lysp_node_notif *notifs; /**< list of notifications (linked list) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001319 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001320 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001321
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001322 uint8_t version; /**< yang-version (LYS_VERSION values) */
Michal Vaskoc3781c32020-10-06 14:04:08 +02001323 uint8_t parsing : 1; /**< flag for circular check */
1324 uint8_t is_submod : 1; /**< always 1 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001325
Michal Vaskoc3781c32020-10-06 14:04:08 +02001326 uint8_t latest_revision : 2; /**< flag to mark the latest available revision:
Radek Krejci086c7132018-10-26 15:29:04 +02001327 1 - the latest revision in searchdirs was not searched yet and this is the
1328 latest revision in the current context
1329 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001330 const char *name; /**< name of the module (mandatory) */
1331 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1332 const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */
1333 const char *org; /**< party/company responsible for the module */
1334 const char *contact; /**< contact information for the module */
1335 const char *dsc; /**< description of the module */
1336 const char *ref; /**< cross-reference for the module */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001337};
1338
1339/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001340 * @brief Get the parsed module or submodule name.
1341 *
1342 * @param[in] PMOD Parsed module or submodule.
1343 * @return Module or submodule name.
1344 */
1345#define LYSP_MODULE_NAME(PMOD) (PMOD->is_submod ? ((struct lysp_submodule *)PMOD)->name : ((struct lysp_module *)PMOD)->mod->name)
1346
1347/**
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001348 * @brief Compiled prefix data pair mapping of prefixes to modules. In case the format is ::LY_PREF_SCHEMA_RESOLVED,
1349 * the expected prefix data is a sized array of these structures.
1350 */
1351struct lysc_prefix {
1352 char *prefix; /**< used prefix */
1353 const struct lys_module *mod; /**< mapping to a module */
1354};
1355
1356/**
Radek Krejci0e59c312019-08-15 15:34:15 +02001357 * @brief Compiled YANG extension-stmt
1358 */
1359struct lysc_ext {
1360 const char *name; /**< extension name */
1361 const char *argument; /**< argument name, NULL if not specified */
Radek Krejci0e59c312019-08-15 15:34:15 +02001362 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1363 struct lyext_plugin *plugin; /**< Plugin implementing the specific extension */
Radek Krejci0935f412019-08-20 16:15:18 +02001364 struct lys_module *module; /**< module structure */
Michal Vasko6f4cbb62020-02-28 11:15:47 +01001365 uint32_t refcount; /**< reference counter since extension definition is shared among all its instances */
Radek Krejci0e59c312019-08-15 15:34:15 +02001366 uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */
1367};
1368
1369/**
Radek Krejcice8c1592018-10-29 15:35:51 +01001370 * @brief YANG extension instance
1371 */
1372struct lysc_ext_instance {
Radek Krejciad5963b2019-09-06 16:03:05 +02001373 uint32_t insubstmt_index; /**< in case the instance is in a substatement that can appear multiple times,
1374 this identifies the index of the substatement for this extension instance */
Radek Krejci28681fa2019-09-06 13:08:45 +02001375 struct lys_module *module; /**< module where the extension instantiated is defined */
Radek Krejciad5963b2019-09-06 16:03:05 +02001376 struct lysc_ext *def; /**< pointer to the extension definition */
Radek Krejcice8c1592018-10-29 15:35:51 +01001377 void *parent; /**< pointer to the parent element holding the extension instance(s), use
1378 ::lysc_ext_instance#parent_type to access the schema element */
1379 const char *argument; /**< optional value of the extension's argument */
1380 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Radek Krejci2a408df2018-10-29 16:32:26 +01001381 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001382 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0e59c312019-08-15 15:34:15 +02001383 void *data; /**< private plugins's data, not used by libyang */
Radek Krejcice8c1592018-10-29 15:35:51 +01001384};
1385
1386/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001387 * @brief YANG when-stmt
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001388 */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001389struct lysc_when {
1390 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko175012e2019-11-06 15:49:14 +01001391 struct lysc_node *context; /**< context node for evaluating the expression, NULL if the context is root node */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001392 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001393 const char *dsc; /**< description */
1394 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001395 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00b874b2019-02-12 10:54:50 +01001396 uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */
Michal Vaskoecd62de2019-11-13 12:35:11 +01001397 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS is allowed */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001398};
1399
1400/**
Radek Krejci2a408df2018-10-29 16:32:26 +01001401 * @brief YANG identity-stmt
1402 */
1403struct lysc_ident {
1404 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejcic8b31002019-01-08 10:24:45 +01001405 const char *dsc; /**< description */
1406 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001407 struct lys_module *module; /**< module structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001408 struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */
1409 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1410 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
1411};
1412
1413/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001414 * @defgroup ifftokens if-feature expression tokens
Radek Krejci8678fa42020-08-18 16:07:28 +02001415 * Tokens of if-feature expression used in ::lysc_iffeature.expr.
Radek Krejci151a5b72018-10-19 14:21:44 +02001416 *
1417 * @{
1418 */
1419#define LYS_IFF_NOT 0x00 /**< operand "not" */
1420#define LYS_IFF_AND 0x01 /**< operand "and" */
1421#define LYS_IFF_OR 0x02 /**< operand "or" */
1422#define LYS_IFF_F 0x03 /**< feature */
Radek Krejci2ff0d572020-05-21 15:27:28 +02001423/** @} ifftokens */
Radek Krejci151a5b72018-10-19 14:21:44 +02001424
1425/**
Radek Krejcib7db73a2018-10-24 14:18:40 +02001426 * @brief Compiled YANG revision statement
1427 */
1428struct lysc_revision {
1429 char date[LY_REV_SIZE]; /**< revision-date (mandatory) */
1430 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1431};
1432
Radek Krejci2167ee12018-11-02 16:09:07 +01001433struct lysc_range {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001434 struct lysc_range_part {
Radek Krejci693262f2019-04-29 15:23:20 +02001435 union { /**< min boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001436 int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1437 uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001438 };
Radek Krejci693262f2019-04-29 15:23:20 +02001439 union { /**< max boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001440 int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1441 uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001442 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001443 } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001444 const char *dsc; /**< description */
1445 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001446 const char *emsg; /**< error-message */
1447 const char *eapptag; /**< error-app-tag value */
1448 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1449};
1450
1451struct lysc_pattern {
Radek Krejci54579462019-04-30 12:47:06 +02001452 const char *expr; /**< original, not compiled, regular expression */
1453 pcre2_code *code; /**< compiled regular expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001454 const char *dsc; /**< description */
1455 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001456 const char *emsg; /**< error-message */
1457 const char *eapptag; /**< error-app-tag value */
1458 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0f969882020-08-21 16:56:47 +02001459 uint32_t inverted : 1; /**< invert-match flag */
1460 uint32_t refcount : 31; /**< reference counter */
Radek Krejci2167ee12018-11-02 16:09:07 +01001461};
1462
1463struct lysc_must {
Radek Krejci2167ee12018-11-02 16:09:07 +01001464 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001465 struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001466 const char *dsc; /**< description */
1467 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001468 const char *emsg; /**< error-message */
1469 const char *eapptag; /**< error-app-tag value */
1470 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1471};
1472
1473struct lysc_type {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001474 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001475 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 +01001476 LY_DATA_TYPE basetype; /**< Base type of the type */
1477 uint32_t refcount; /**< reference counter for type sharing */
1478};
1479
1480struct lysc_type_num {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001481 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001482 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 +01001483 LY_DATA_TYPE basetype; /**< Base type of the type */
1484 uint32_t refcount; /**< reference counter for type sharing */
1485 struct lysc_range *range; /**< Optional range limitation */
1486};
1487
1488struct lysc_type_dec {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001489 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001490 struct lysc_type_plugin *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001491 LY_DATA_TYPE basetype; /**< Base type of the type */
1492 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci6cba4292018-11-15 17:33:29 +01001493 uint8_t fraction_digits; /**< fraction digits specification */
Radek Krejci2167ee12018-11-02 16:09:07 +01001494 struct lysc_range *range; /**< Optional range limitation */
1495};
1496
1497struct lysc_type_str {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001498 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001499 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 +01001500 LY_DATA_TYPE basetype; /**< Base type of the type */
1501 uint32_t refcount; /**< reference counter for type sharing */
1502 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci4586a022018-11-13 11:29:26 +01001503 struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001504};
1505
Radek Krejci693262f2019-04-29 15:23:20 +02001506struct lysc_type_bitenum_item {
1507 const char *name; /**< enumeration identifier */
1508 const char *dsc; /**< description */
1509 const char *ref; /**< reference */
1510 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci693262f2019-04-29 15:23:20 +02001511 union {
1512 int32_t value; /**< integer value associated with the enumeration */
1513 uint32_t position; /**< non-negative integer value associated with the bit */
1514 };
1515 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
1516 values are allowed */
1517};
1518
Radek Krejci2167ee12018-11-02 16:09:07 +01001519struct lysc_type_enum {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001520 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001521 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 +01001522 LY_DATA_TYPE basetype; /**< Base type of the type */
1523 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci693262f2019-04-29 15:23:20 +02001524 struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1525};
1526
1527struct lysc_type_bits {
1528 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001529 struct lysc_type_plugin *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci693262f2019-04-29 15:23:20 +02001530 LY_DATA_TYPE basetype; /**< Base type of the type */
1531 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci849a62a2019-05-22 15:29:05 +02001532 struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item),
1533 the items are ordered by their position value. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001534};
1535
1536struct lysc_type_leafref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001537 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001538 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 +01001539 LY_DATA_TYPE basetype; /**< Base type of the type */
1540 uint32_t refcount; /**< reference counter for type sharing */
Michal Vasko004d3152020-06-11 19:59:22 +02001541 struct lyxp_expr *path; /**< parsed target path, compiled path cannot be stored because of type sharing */
Michal Vasko5d24f6c2020-10-13 13:49:06 +02001542 struct lysc_prefix *prefixes; /**< resolved prefixes used in the path */
Michal Vaskoc0792ca2020-12-01 12:03:21 +01001543 const struct lys_module *cur_mod;/**< current module for the leafref (path) */
Radek Krejci412ddfa2018-11-23 11:44:11 +01001544 struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001545 uint8_t require_instance; /**< require-instance flag */
1546};
1547
1548struct lysc_type_identityref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001549 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001550 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 +01001551 LY_DATA_TYPE basetype; /**< Base type of the type */
1552 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci555cb5b2018-11-16 14:54:33 +01001553 struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)),
Radek Krejci2167ee12018-11-02 16:09:07 +01001554 mandatory (at least 1 item) */
1555};
1556
1557struct lysc_type_instanceid {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001558 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001559 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 +01001560 LY_DATA_TYPE basetype; /**< Base type of the type */
1561 uint32_t refcount; /**< reference counter for type sharing */
1562 uint8_t require_instance; /**< require-instance flag */
1563};
1564
Radek Krejci2167ee12018-11-02 16:09:07 +01001565struct lysc_type_union {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001566 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001567 struct lysc_type_plugin *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001568 LY_DATA_TYPE basetype; /**< Base type of the type */
1569 uint32_t refcount; /**< reference counter for type sharing */
1570 struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1571};
1572
1573struct lysc_type_bin {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001574 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +02001575 struct lysc_type_plugin *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001576 LY_DATA_TYPE basetype; /**< Base type of the type */
1577 uint32_t refcount; /**< reference counter for type sharing */
1578 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001579};
1580
Michal Vasko60ea6352020-06-29 13:39:39 +02001581/**
1582 * @brief Maximum number of hashes stored in a schema node.
1583 */
1584#define LYS_NODE_HASH_COUNT 4
1585
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001586/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001587 * @brief Compiled YANG data node
1588 */
1589struct lysc_node {
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001590 uint16_t nodetype; /**< type of the node (mandatory) */
1591 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Michal Vasko60ea6352020-06-29 13:39:39 +02001592 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001593 struct lys_module *module; /**< module structure */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001594 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1595 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1596 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1597 never NULL. If there is no sibling node, pointer points to the node
1598 itself. In case of the first node, this pointer points to the last
1599 node in the list. */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001600 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001601 const char *dsc; /**< description */
1602 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001603 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko2fd91b92020-07-17 16:39:02 +02001604 void *priv; /**< private arbitrary user data, not used by libyang */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001605};
1606
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001607struct lysc_node_action_inout {
1608 union {
1609 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1610 struct {
1611 uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */
1612 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1613 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1614 struct lys_module *module; /**< module structure */
Radek Krejci5960c312021-01-27 20:24:22 +01001615 struct lysc_node *parent;/**< parent node (NULL in case of top level node) */
Michal Vasko544e58a2021-01-28 14:33:41 +01001616 struct lysc_node *next; /**< next sibling node (output node for input, NULL for output) */
1617 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 +01001618 const char *name; /**< "input" or "output" */
1619 const char *dsc; /**< ALWAYS NULL, compatibility member with ::lysc_node */
1620 const char *ref; /**< ALWAYS NULL, compatibility member with ::lysc_node */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001621 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001622 void *priv; /** private arbitrary user data, not used by libyang */
1623 };
1624 };
1625
Radek Krejci9a3823e2021-01-27 20:26:46 +01001626 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001627 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1628};
1629
1630struct lysc_node_action {
1631 union {
1632 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1633 struct {
1634 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
1635 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1636 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1637 struct lys_module *module; /**< module structure */
1638 struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */
1639 struct lysc_node_action *next; /**< next sibling node (NULL if there is no one) */
1640 struct lysc_node_action *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1641 never NULL. If there is no sibling node, pointer points to the node
1642 itself. In case of the first node, this pointer points to the last
1643 node in the list. */
1644 const char *name; /**< action/RPC name (mandatory) */
1645 const char *dsc; /**< description */
1646 const char *ref; /**< reference */
1647 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001648 void *priv; /** private arbitrary user data, not used by libyang */
1649 };
1650 };
1651
Radek Krejci9a3823e2021-01-27 20:26:46 +01001652 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1653 the action/RPC nodes do not contain the when statement on their own, but they can
1654 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001655 struct lysc_node_action_inout input; /**< RPC's/action's input */
1656 struct lysc_node_action_inout output; /**< RPC's/action's output */
1657
1658};
1659
1660struct lysc_node_notif {
1661 union {
1662 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1663 struct {
1664 uint16_t nodetype; /**< LYS_NOTIF */
1665 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1666 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1667 struct lys_module *module; /**< module structure */
1668 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1669 struct lysc_node_notif *next; /**< next sibling node (NULL if there is no one) */
1670 struct lysc_node_notif *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1671 never NULL. If there is no sibling node, pointer points to the node
1672 itself. In case of the first node, this pointer points to the last
1673 node in the list. */
1674 const char *name; /**< Notification name (mandatory) */
1675 const char *dsc; /**< description */
1676 const char *ref; /**< reference */
1677 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001678 void *priv; /** private arbitrary user data, not used by libyang */
1679 };
1680 };
1681
Radek Krejci9a3823e2021-01-27 20:26:46 +01001682 struct lysc_node *child; /**< first child node (linked list) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001683 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001684 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)),
1685 the notification nodes do not contain the when statement on their own, but they can
1686 inherit it from the parent's uses. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001687};
1688
1689struct lysc_node_container {
1690 union {
1691 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1692 struct {
1693 uint16_t nodetype; /**< LYS_CONTAINER */
1694 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1695 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1696 struct lys_module *module; /**< module structure */
1697 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1698 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1699 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1700 never NULL. If there is no sibling node, pointer points to the node
1701 itself. In case of the first node, this pointer points to the last
1702 node in the list. */
1703 const char *name; /**< node name (mandatory) */
1704 const char *dsc; /**< description */
1705 const char *ref; /**< reference */
1706 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001707 void *priv; /**< private arbitrary user data, not used by libyang */
1708 };
1709 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001710
1711 struct lysc_node *child; /**< first child node (linked list) */
1712 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001713 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001714 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1715 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001716};
1717
Radek Krejcia3045382018-11-22 14:30:31 +01001718struct lysc_node_case {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001719 union {
1720 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1721 struct {
1722 uint16_t nodetype; /**< LYS_CASE */
1723 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1724 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1725 struct lys_module *module; /**< module structure */
1726 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1727 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1728 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejci056d0a82018-12-06 16:57:25 +01001729 never NULL. If there is no sibling node, pointer points to the node
1730 itself. In case of the first node, this pointer points to the last
1731 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001732 const char *name; /**< name of the case, including the implicit case */
1733 const char *dsc; /**< description */
1734 const char *ref; /**< reference */
1735 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001736 void *priv; /**< private arbitrary user data, not used by libyang */
1737 };
1738 };
Radek Krejci056d0a82018-12-06 16:57:25 +01001739
Radek Krejcia3045382018-11-22 14:30:31 +01001740 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 +01001741 each other as siblings with the parent pointer pointing to appropriate case node. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001742 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcia3045382018-11-22 14:30:31 +01001743};
1744
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001745struct lysc_node_choice {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001746 union {
1747 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1748 struct {
1749 uint16_t nodetype; /**< LYS_CHOICE */
1750 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1751 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */
1752 struct lys_module *module; /**< module structure */
1753 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1754 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1755 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001756 never NULL. If there is no sibling node, pointer points to the node
1757 itself. In case of the first node, this pointer points to the last
1758 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001759 const char *name; /**< node name (mandatory) */
1760 const char *dsc; /**< description */
1761 const char *ref; /**< reference */
1762 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001763 void *priv; /**< private arbitrary user data, not used by libyang */
1764 };
1765 };
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001766
Radek Krejcia9026eb2018-12-12 16:04:47 +01001767 struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other
1768 as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the
1769 case is simple. */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001770 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001771 struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001772};
1773
1774struct lysc_node_leaf {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001775 union {
1776 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1777 struct {
1778 uint16_t nodetype; /**< LYS_LEAF */
1779 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1780 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1781 struct lys_module *module; /**< module structure */
1782 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1783 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1784 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001785 never NULL. If there is no sibling node, pointer points to the node
1786 itself. In case of the first node, this pointer points to the last
1787 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001788 const char *name; /**< node name (mandatory) */
1789 const char *dsc; /**< description */
1790 const char *ref; /**< reference */
1791 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001792 void *priv; /**< private arbitrary user data, not used by libyang */
1793 };
1794 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001795
1796 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001797 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001798 struct lysc_type *type; /**< type of the leaf node (mandatory) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001799
Radek Krejci4f28eda2018-11-12 11:46:16 +01001800 const char *units; /**< units of the leaf's type */
Radek Krejcia1911222019-07-22 17:24:50 +02001801 struct lyd_value *dflt; /**< default value */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001802};
1803
1804struct lysc_node_leaflist {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001805 union {
1806 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1807 struct {
1808 uint16_t nodetype; /**< LYS_LEAFLIST */
1809 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1810 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1811 struct lys_module *module; /**< module structure */
1812 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1813 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1814 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001815 never NULL. If there is no sibling node, pointer points to the node
1816 itself. In case of the first node, this pointer points to the last
1817 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001818 const char *name; /**< node name (mandatory) */
1819 const char *dsc; /**< description */
1820 const char *ref; /**< reference */
1821 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001822 void *priv; /**< private arbitrary user data, not used by libyang */
1823 };
1824 };
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001825
1826 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001827 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001828 struct lysc_type *type; /**< type of the leaf node (mandatory) */
1829
Radek Krejci0e5d8382018-11-28 16:37:53 +01001830 const char *units; /**< units of the leaf's type */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001831 struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */
Michal Vaskoba99a3e2020-08-18 15:50:05 +02001832
Radek Krejci0e5d8382018-11-28 16:37:53 +01001833 uint32_t min; /**< min-elements constraint */
1834 uint32_t max; /**< max-elements constraint */
1835
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001836};
1837
1838struct lysc_node_list {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001839 union {
1840 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1841 struct {
1842 uint16_t nodetype; /**< LYS_LIST */
1843 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1844 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1845 struct lys_module *module; /**< module structure */
1846 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1847 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1848 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001849 never NULL. If there is no sibling node, pointer points to the node
1850 itself. In case of the first node, this pointer points to the last
1851 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001852 const char *name; /**< node name (mandatory) */
1853 const char *dsc; /**< description */
1854 const char *ref; /**< reference */
1855 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001856 void *priv; /**< private arbitrary user data, not used by libyang */
1857 };
1858 };
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001859
1860 struct lysc_node *child; /**< first child node (linked list) */
1861 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001862 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001863 struct lysc_node_action *actions;/**< first of actions nodes (linked list) */
1864 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001865
Radek Krejci2a9fc652021-01-22 17:44:34 +01001866 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 +01001867 uint32_t min; /**< min-elements constraint */
1868 uint32_t max; /**< max-elements constraint */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001869};
1870
1871struct lysc_node_anydata {
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001872 union {
1873 struct lysc_node node; /**< implicit cast for the members compatible with ::lysc_node */
1874 struct {
1875 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1876 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1877 uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */
1878 struct lys_module *module; /**< module structure */
1879 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1880 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1881 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001882 never NULL. If there is no sibling node, pointer points to the node
1883 itself. In case of the first node, this pointer points to the last
1884 node in the list. */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001885 const char *name; /**< node name (mandatory) */
1886 const char *dsc; /**< description */
1887 const char *ref; /**< reference */
1888 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00a3e8a2021-01-27 08:24:49 +01001889 void *priv; /**< private arbitrary user data, not used by libyang */
1890 };
1891 };
Radek Krejci9800fb82018-12-13 14:26:23 +01001892
1893 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci9a3823e2021-01-27 20:26:46 +01001894 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001895};
1896
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001897/**
1898 * @brief Compiled YANG schema tree structure representing YANG module.
1899 *
1900 * Semantically validated YANG schema tree for data tree parsing.
1901 * Contains only the necessary information for the data validation.
1902 */
1903struct lysc_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001904 struct lys_module *mod; /**< covering module structure */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001905
Radek Krejci2a408df2018-10-29 16:32:26 +01001906 struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001907 struct lysc_node_action *rpcs; /**< first of actions nodes (linked list) */
1908 struct lysc_node_notif *notifs; /**< first of notifications nodes (linked list) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001909 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001910};
1911
1912/**
Radek Krejci490a5462020-11-05 08:44:42 +01001913 * @brief Examine whether a node is user-ordered list or leaf-list.
1914 *
1915 * @param[in] lysc_node Schema node to examine.
1916 * @return Boolean value whether the @p node is user-ordered or not.
1917 */
1918#define lysc_is_userordered(lysc_node) \
1919 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAFLIST | LYS_LIST)) || !(lysc_node->flags & LYS_ORDBY_USER)) ? 0 : 1)
1920
1921/**
1922 * @brief Examine whether a node is a list's key.
1923 *
1924 * @param[in] lysc_node Schema node to examine.
1925 * @return Boolean value whether the @p node is a key or not.
1926 */
1927#define lysc_is_key(lysc_node) \
Michal Vaskobce7ee32021-02-04 11:05:25 +01001928 ((!lysc_node || (lysc_node->nodetype != LYS_LEAF) || !(lysc_node->flags & LYS_KEY)) ? 0 : 1)
Radek Krejci490a5462020-11-05 08:44:42 +01001929
1930/**
Michal Vasko5c123b02020-12-04 14:34:04 +01001931 * @brief Examine whether a node is a non-presence container.
1932 *
1933 * @param[in] lysc_node Schema node to examine.
1934 * @return Boolean value whether the @p node is a NP container or not.
1935 */
1936#define lysc_is_np_cont(lysc_node) \
Michal Vaskobce7ee32021-02-04 11:05:25 +01001937 ((!lysc_node || (lysc_node->nodetype != LYS_CONTAINER) || (lysc_node->flags & LYS_PRESENCE)) ? 0 : 1)
1938
1939/**
1940 * @brief Examine whether a node is a key-less list or a state leaf-list.
1941 *
1942 * @param[in] lysc_node Schema node to examine.
1943 * @return Boolean value whether the @p node is a list with duplicate instances allowed.
1944 */
1945#define lysc_is_dup_inst_list(lysc_node) \
1946 ((lysc_node && (((lysc_node->nodetype == LYS_LIST) && (lysc_node->flags & LYS_KEYLESS)) || \
1947 ((lysc_node->nodetype == LYS_LEAFLIST) && (lysc_node->flags & LYS_CONFIG_R)))) ? 1 : 0)
Michal Vasko5c123b02020-12-04 14:34:04 +01001948
1949/**
Michal Vaskod5cfa6e2020-11-23 16:56:08 +01001950 * @brief Check whether the schema node data instance existence depends on any when conditions.
1951 * This node and any direct parent choice and case schema nodes are also examined for when conditions.
1952 *
1953 * Be careful, this function is not recursive and checks only conditions that apply to this node directly.
1954 * Meaning if there are any conditions associated with any data parent instance of @p node, they are not returned.
1955 *
1956 * @param[in] node Schema node to examine.
1957 * @return When condition associated with the node data instance, NULL if there is none.
1958 */
1959const struct lysc_when *lysc_has_when(const struct lysc_node *node);
1960
1961/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001962 * @brief Get the groupings linked list of the given (parsed) schema node.
Radek Krejci53ea6152018-12-13 15:21:15 +01001963 * Decides the node's type and in case it has a groupings array, returns it.
1964 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001965 * @return The node's groupings linked list if any, NULL otherwise.
Radek Krejci53ea6152018-12-13 15:21:15 +01001966 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001967const struct lysp_node_grp *lysp_node_groupings(const struct lysp_node *node);
Radek Krejci53ea6152018-12-13 15:21:15 +01001968
1969/**
Radek Krejci056d0a82018-12-06 16:57:25 +01001970 * @brief Get the typedefs sized array of the given (parsed) schema node.
1971 * Decides the node's type and in case it has a typedefs array, returns it.
1972 * @param[in] node Node to examine.
1973 * @return The node's typedefs sized array if any, NULL otherwise.
1974 */
1975const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
1976
1977/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001978 * @brief Get the actions/RPCs linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001979 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1980 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001981 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01001982 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001983const struct lysp_node_action *lysp_node_actions(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01001984
1985/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01001986 * @brief Get the Notifications linked list of the given (parsed) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001987 * Decides the node's type and in case it has a Notifications array, returns it.
1988 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01001989 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01001990 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01001991const struct lysp_node_notif *lysp_node_notifs(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01001992
1993/**
1994 * @brief Get the children linked list of the given (parsed) schema node.
1995 * Decides the node's type and in case it has a children list, returns it.
1996 * @param[in] node Node to examine.
1997 * @return The node's children linked list if any, NULL otherwise.
1998 */
Michal Vasko544e58a2021-01-28 14:33:41 +01001999const struct lysp_node *lysp_node_child(const struct lysp_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002000
2001/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002002 * @brief Get the actions/RPCs linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002003 * Decides the node's type and in case it has a actions/RPCs array, returns it.
2004 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002005 * @return The node's actions/RPCs linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002006 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002007const struct lysc_node_action *lysc_node_actions(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002008
2009/**
Radek Krejci2a9fc652021-01-22 17:44:34 +01002010 * @brief Get the Notifications linked list of the given (compiled) schema node.
Radek Krejci056d0a82018-12-06 16:57:25 +01002011 * Decides the node's type and in case it has a Notifications array, returns it.
2012 * @param[in] node Node to examine.
Radek Krejci2a9fc652021-01-22 17:44:34 +01002013 * @return The node's Notifications linked list if any, NULL otherwise.
Radek Krejci056d0a82018-12-06 16:57:25 +01002014 */
Radek Krejci2a9fc652021-01-22 17:44:34 +01002015const struct lysc_node_notif *lysc_node_notifs(const struct lysc_node *node);
Radek Krejci056d0a82018-12-06 16:57:25 +01002016
2017/**
2018 * @brief Get the children linked list of the given (compiled) schema node.
Michal Vasko2a668712020-10-21 11:48:09 +02002019 *
Michal Vasko544e58a2021-01-28 14:33:41 +01002020 * Note that ::LYS_CHOICE has only ::LYS_CASE children.
2021 * Also, ::LYS_RPC and ::LYS_ACTION have the first child ::LYS_INPUT, its sibling is ::LYS_OUTPUT.
2022 *
Michal Vasko2a668712020-10-21 11:48:09 +02002023 * @param[in] node Node to examine.
Michal Vasko2a668712020-10-21 11:48:09 +02002024 * @return Children linked list if any,
2025 * @return NULL otherwise.
2026 */
Michal Vasko544e58a2021-01-28 14:33:41 +01002027const struct lysc_node *lysc_node_child(const struct lysc_node *node);
Michal Vasko2a668712020-10-21 11:48:09 +02002028
2029/**
Radek Krejci9a3823e2021-01-27 20:26:46 +01002030 * @brief Get the must statements list if present in the @p node
2031 *
2032 * @param[in] node Node to examine.
2033 * @return Pointer to the list of must restrictions ([sized array](@ref sizedarrays))
2034 * @return NULL if there is no must statement in the node, no matter if it is not even allowed or just present
2035 */
2036struct lysc_must *lysc_node_musts(const struct lysc_node *node);
2037
2038/**
2039 * @brief Get the when statements list if present in the @p node
2040 *
2041 * @param[in] node Node to examine.
2042 * @return Pointer to the list of pointers to when statements ([sized array](@ref sizedarrays))
2043 * @return NULL if there is no when statement in the node, no matter if it is not even allowed or just present
2044 */
2045struct lysc_when **lysc_node_when(const struct lysc_node *node);
2046
2047/**
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002048 * @brief Callback to be called for every schema node in a DFS traversal.
2049 *
2050 * @param[in] node Current node.
2051 * @param[in] data Arbitrary user data.
2052 * @param[out] dfs_continue Set to true if the current subtree should be skipped and continue with siblings instead.
2053 * @return LY_SUCCESS on success,
2054 * @return LY_ERR value to terminate DFS and return this value.
2055 */
Radek Krejci01180ac2021-01-27 08:48:22 +01002056typedef LY_ERR (*lysc_dfs_clb)(struct lysc_node *node, void *child, ly_bool *dfs_continue);
Michal Vaskof1ab44f2020-10-22 08:58:32 +02002057
2058/**
2059 * @brief DFS traversal of all the schema nodes in a (sub)tree including any actions and nested notifications.
2060 *
2061 * Node with children, actions, and notifications is traversed in this order:
2062 * 1) each child subtree;
2063 * 2) each action subtree;
2064 * 3) each notification subtree.
2065 *
2066 * For algorithm illustration or traversal with actions and notifications skipped, see ::LYSC_TREE_DFS_BEGIN.
2067 *
2068 * @param[in] root Schema root to fully traverse.
2069 * @param[in] dfs_clb Callback to call for each node.
2070 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2071 * @return LY_SUCCESS on success,
2072 * @return LY_ERR value returned by @p dfs_clb.
2073 */
2074LY_ERR lysc_tree_dfs_full(const struct lysc_node *root, lysc_dfs_clb dfs_clb, void *data);
2075
2076/**
2077 * @brief DFS traversal of all the schema nodes in a module including RPCs and notifications.
2078 *
2079 * For more details, see ::lysc_tree_dfs_full().
2080 *
2081 * @param[in] mod Module to fully traverse.
2082 * @param[in] dfs_clb Callback to call for each node.
2083 * @param[in] data Arbitrary user data passed to @p dfs_clb.
2084 * @return LY_SUCCESS on success,
2085 * @return LY_ERR value returned by @p dfs_clb.
2086 */
2087LY_ERR lysc_module_dfs_full(const struct lys_module *mod, lysc_dfs_clb dfs_clb, void *data);
2088
2089/**
Radek Krejci151a5b72018-10-19 14:21:44 +02002090 * @brief Get how the if-feature statement currently evaluates.
2091 *
2092 * @param[in] iff Compiled if-feature statement to evaluate.
Michal Vasko28d78432020-05-26 13:10:53 +02002093 * @return LY_SUCCESS if the statement evaluates to true,
2094 * @return LY_ENOT if it evaluates to false,
2095 * @return LY_ERR on error.
Radek Krejci151a5b72018-10-19 14:21:44 +02002096 */
Michal Vasko28d78432020-05-26 13:10:53 +02002097LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff);
Radek Krejci151a5b72018-10-19 14:21:44 +02002098
2099/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002100 * @brief Get the next feature in the module or submodules.
Radek Krejci151a5b72018-10-19 14:21:44 +02002101 *
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002102 * @param[in] last Last returned feature.
2103 * @param[in] pmod Parsed module and submodoules whose features to iterate over.
2104 * @param[in,out] idx Submodule index, set to 0 on first call.
2105 * @return Next found feature, NULL if the last has already been returned.
Radek Krejci151a5b72018-10-19 14:21:44 +02002106 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002107struct 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 +02002108
Radek Krejcibed13942020-10-19 16:06:28 +02002109/**
2110 * @defgroup findxpathoptions Atomize XPath options
2111 * Options to modify behavior of ::lys_find_xpath() and ::lys_find_xpath_atoms() searching for schema nodes in schema tree.
2112 * @{
2113 */
Michal Vaskocdad7122020-11-09 21:04:44 +01002114#define LYS_FIND_XP_SCHEMA 0x08 /**< Apply node access restrictions defined for 'when' and 'must' evaluation. */
2115#define LYS_FIND_XP_OUTPUT 0x10 /**< Search RPC/action output nodes instead of input ones. */
Radek Krejci576f8fa2020-10-26 21:23:58 +01002116/** @} findxpathoptions */
Michal Vasko072de482020-08-05 13:27:21 +02002117
Radek Krejci151a5b72018-10-19 14:21:44 +02002118/**
Michal Vasko40308e72020-10-20 16:38:40 +02002119 * @brief Get all the schema nodes that are required for @p xpath to be evaluated (atoms).
Michal Vasko519fd602020-05-26 12:17:39 +02002120 *
Michal Vasko26512682021-01-11 11:35:40 +01002121 * @param[in] ctx libyang context to use. May be NULL if @p ctx_node is set.
2122 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002123 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002124 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko519fd602020-05-26 12:17:39 +02002125 * @param[out] set Set of found atoms (schema nodes).
2126 * @return LY_SUCCESS on success, @p set is returned.
Michal Vasko40308e72020-10-20 16:38:40 +02002127 * @return LY_ERR value on error.
Michal Vasko519fd602020-05-26 12:17:39 +02002128 */
Michal Vasko26512682021-01-11 11:35:40 +01002129LY_ERR lys_find_xpath_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
2130 uint32_t options, struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002131
Michal Vasko072de482020-08-05 13:27:21 +02002132/**
Michal Vasko40308e72020-10-20 16:38:40 +02002133 * @brief Get all the schema nodes that are required for @p expr to be evaluated (atoms).
Michal Vasko072de482020-08-05 13:27:21 +02002134 *
Michal Vasko26512682021-01-11 11:35:40 +01002135 * @param[in] ctx_node XPath schema context node. Use NULL for the root node.
Michal Vasko40308e72020-10-20 16:38:40 +02002136 * @param[in] cur_mod Current module for the expression (where it was "instantiated").
2137 * @param[in] expr Parsed expression to use.
2138 * @param[in] prefixes Sized array of compiled prefixes.
2139 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
2140 * @param[out] set Set of found atoms (schema nodes).
2141 * @return LY_SUCCESS on success, @p set is returned.
2142 * @return LY_ERR value on error.
2143 */
2144LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod,
2145 const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set);
2146
2147/**
2148 * @brief Evaluate an @p xpath expression on schema nodes.
2149 *
Michal Vasko26512682021-01-11 11:35:40 +01002150 * @param[in] ctx libyang context to use for absolute @p xpath. May be NULL if @p ctx_node is set.
2151 * @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 +02002152 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected.
Radek Krejcibed13942020-10-19 16:06:28 +02002153 * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions.
Michal Vasko072de482020-08-05 13:27:21 +02002154 * @param[out] set Set of found schema nodes.
2155 * @return LY_SUCCESS on success, @p set is returned.
2156 * @return LY_ERR value if an error occurred.
2157 */
Michal Vasko26512682021-01-11 11:35:40 +01002158LY_ERR lys_find_xpath(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath, uint32_t options,
2159 struct ly_set **set);
Michal Vasko519fd602020-05-26 12:17:39 +02002160
2161/**
Radek Krejcibc5644c2020-10-27 14:53:17 +01002162 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2163 *
2164 * @param[in] path Compiled path to use.
2165 * @param[out] set Set of found atoms (schema nodes).
2166 * @return LY_SUCCESS on success, @p set is returned.
2167 * @return LY_ERR value on error.
2168 */
2169LY_ERR lys_find_lypath_atoms(const struct ly_path *path, struct ly_set **set);
2170
2171/**
2172 * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms).
2173 *
Michal Vasko26512682021-01-11 11:35:40 +01002174 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2175 * @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 +01002176 * @param[in] path JSON path to examine.
2177 * @param[in] output Search operation output instead of input.
2178 * @param[out] set Set of found atoms (schema nodes).
2179 * @return LY_ERR value on error.
2180 */
2181LY_ERR lys_find_path_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path, ly_bool output,
2182 struct ly_set **set);
2183
2184/**
2185 * @brief Get a schema node based on the given data path (JSON format, see @ref howtoXPath).
2186 *
Michal Vasko26512682021-01-11 11:35:40 +01002187 * @param[in] ctx libyang context to use for absolute @p path. May be NULL if @p ctx_node is set.
2188 * @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 +01002189 * @param[in] path JSON path of the node to get.
2190 * @param[in] output Search operation output instead of input.
2191 * @return Found schema node or NULL.
2192 */
2193const struct lysc_node *lys_find_path(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path,
2194 ly_bool output);
2195
2196/**
Michal Vasko03ff5a72019-09-11 13:49:33 +02002197 * @brief Types of the different schema paths.
2198 */
2199typedef enum {
Michal Vasko65de0402020-08-03 16:34:19 +02002200 LYSC_PATH_LOG, /**< Descriptive path format used in log messages */
2201 LYSC_PATH_DATA /**< Similar to ::LYSC_PATH_LOG except that schema-only nodes (choice, case) are skipped */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002202} LYSC_PATH_TYPE;
2203
2204/**
Radek Krejci327de162019-06-14 12:52:07 +02002205 * @brief Generate path of the given node in the requested format.
2206 *
2207 * @param[in] node Schema path of this node will be generated.
2208 * @param[in] pathtype Format of the path to generate.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002209 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
2210 * If NULL, memory for the complete path is allocated.
2211 * @param[in] buflen Size of the provided @p buffer.
Radek Krejci327de162019-06-14 12:52:07 +02002212 * @return NULL in case of memory allocation error, path of the node otherwise.
Radek Krejci1c0c3442019-07-23 16:08:47 +02002213 * 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 +02002214 */
Michal Vasko03ff5a72019-09-11 13:49:33 +02002215char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
Radek Krejci327de162019-06-14 12:52:07 +02002216
2217/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002218 * @brief Available YANG schema tree structures representing YANG module.
2219 */
2220struct lys_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002221 struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */
2222 const char *name; /**< name of the module (mandatory) */
Radek Krejci0af46292019-01-11 16:02:31 +01002223 const char *revision; /**< revision of the module (if present) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002224 const char *ns; /**< namespace of the module (module - mandatory) */
2225 const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */
2226 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
2227 const char *org; /**< party/company responsible for the module */
2228 const char *contact; /**< contact information for the module */
2229 const char *dsc; /**< description of the module */
2230 const char *ref; /**< cross-reference for the module */
2231
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002232 struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */
Radek Krejci0af46292019-01-11 16:02:31 +01002233 struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing.
2234 Available only for implemented modules. */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002235
Radek Krejci80d281e2020-09-14 17:42:54 +02002236 struct lysc_ident *identities; /**< List of compiled identities of the module ([sized array](@ref sizedarrays))
2237 Identities are outside the compiled tree to allow their linkage to the identities from
2238 the implemented modules. This avoids problems when the module became implemented in
2239 future (no matter if implicitly via augment/deviate or explicitly via
2240 ::lys_set_implemented()). Note that if the module is not implemented (compiled), the
2241 identities cannot be instantiated in data (in identityrefs). */
Michal Vasko7f45cf22020-10-01 12:49:44 +02002242
2243 struct lys_module **augmented_by;/**< List of modules that augment this module ([sized array](@ref sizedarrays)) */
2244 struct lys_module **deviated_by; /**< List of modules that deviate this module ([sized array](@ref sizedarrays)) */
2245
Michal Vasko89b5c072020-10-06 13:52:44 +02002246 ly_bool implemented; /**< flag if the module is implemented, not just imported */
Radek Krejci95710c92019-02-11 15:49:55 +01002247 uint8_t latest_revision; /**< flag to mark the latest available revision:
Radek Krejci0bcdaed2019-01-10 10:21:34 +01002248 1 - the latest revision in searchdirs was not searched yet and this is the
2249 latest revision in the current context
2250 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002251};
2252
Radek Krejci151a5b72018-10-19 14:21:44 +02002253/**
Michal Vasko82c31e62020-07-17 15:30:40 +02002254 * @brief Get the current real status of the specified feature in the module.
2255 *
2256 * If the feature is enabled, but some of its if-features are false, the feature is considered
2257 * disabled.
Radek Krejci151a5b72018-10-19 14:21:44 +02002258 *
2259 * @param[in] module Module where the feature is defined.
2260 * @param[in] feature Name of the feature to inspect.
Michal Vasko82c31e62020-07-17 15:30:40 +02002261 * @return LY_SUCCESS if the feature is enabled,
2262 * @return LY_ENOT if the feature is disabled,
2263 * @return LY_ENOTFOUND if the feature was not found.
Radek Krejci151a5b72018-10-19 14:21:44 +02002264 */
Michal Vasko82c31e62020-07-17 15:30:40 +02002265LY_ERR lys_feature_value(const struct lys_module *module, const char *feature);
Radek Krejcidd4e8d42018-10-16 14:55:43 +02002266
2267/**
Radek Krejcia3045382018-11-22 14:30:31 +01002268 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can
2269 * be from an augment.
2270 *
Radek Krejci8678fa42020-08-18 16:07:28 +02002271 * ::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 +01002272 * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module.
2273 * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
2274 * \p parent and \p module parameters.
2275 *
2276 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
2277 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
2278 * all the schema nodes are iteratively returned.
2279 *
2280 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
2281 * @param[in] parent Parent of the subtree where the function starts processing.
2282 * @param[in] module In case of iterating on top level elements, the \p parent is NULL and
2283 * module must be specified.
2284 * @param[in] options [ORed options](@ref sgetnextflags).
2285 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
2286 */
2287const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002288 const struct lysc_module *module, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002289
2290/**
Radek Krejci8678fa42020-08-18 16:07:28 +02002291 * @defgroup sgetnextflags Options for ::lys_getnext().
2292 *
2293 * Various options setting behavior of ::lys_getnext().
2294 *
Radek Krejcia3045382018-11-22 14:30:31 +01002295 * @{
2296 */
Radek Krejci8678fa42020-08-18 16:07:28 +02002297#define LYS_GETNEXT_WITHCHOICE 0x01 /**< ::lys_getnext() option to allow returning #LYS_CHOICE nodes instead of looking into them */
2298#define LYS_GETNEXT_NOCHOICE 0x02 /**< ::lys_getnext() option to ignore (kind of conditional) nodes within choice node */
2299#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 +01002300#define LYS_GETNEXT_INTONPCONT 0x08 /**< ::lys_getnext() option to look into non-presence container, instead of returning container itself */
2301#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 +01002302 provided by default */
Radek Krejcia3045382018-11-22 14:30:31 +01002303/** @} sgetnextflags */
2304
2305/**
2306 * @brief Get child node according to the specified criteria.
2307 *
2308 * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched.
2309 * @param[in] module module of the node to find. It is also limitation for the children node of the given parent.
2310 * @param[in] name Name of the node to find.
2311 * @param[in] name_len Optional length of the name in case it is not NULL-terminated string.
2312 * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find.
2313 * Used as a bitmask, so multiple nodetypes can be specified.
2314 * @param[in] options [ORed options](@ref sgetnextflags).
2315 * @return Found node if any.
2316 */
Michal Vaskoe444f752020-02-10 12:20:06 +01002317const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module,
Radek Krejci1deb5be2020-08-26 16:43:36 +02002318 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
Radek Krejcia3045382018-11-22 14:30:31 +01002319
2320/**
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002321 * @brief Make the specific module implemented.
2322 *
Michal Vaskoe8988e92021-01-25 11:26:29 +01002323 * If the module is already implemented but with a different set of features, the whole context is recompiled.
2324 *
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002325 * @param[in] mod Module to make implemented. It is not an error
2326 * to provide already implemented module, it just does nothing.
Michal Vaskoe8988e92021-01-25 11:26:29 +01002327 * @param[in] features Optional array specifying the enabled features terminated with NULL overriding any previous
2328 * feature setting. The feature string '*' enables all the features and array of length 1 with only the terminating
2329 * NULL explicitly disables all the features. In case the parameter is NULL, the features are untouched - left disabled
2330 * 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 +01002331 * @return LY_SUCCESS on success.
2332 * @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 +01002333 * @return LY_ERR on other errors during module compilation.
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002334 */
Michal Vasko7b1ad1a2020-11-02 15:41:27 +01002335LY_ERR lys_set_implemented(struct lys_module *mod, const char **features);
Radek Krejcia3045382018-11-22 14:30:31 +01002336
Radek Krejci084289f2019-07-09 17:35:30 +02002337/**
2338 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
2339 *
2340 * 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 +02002341 * require-instance restriction), use ::lyd_value_validate().
Radek Krejci084289f2019-07-09 17:35:30 +02002342 *
2343 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
2344 * @param[in] node Schema node for the @p value.
Michal Vaskof937cfe2020-08-03 16:07:12 +02002345 * @param[in] value String value to be checked, expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02002346 * @param[in] value_len Length of the given @p value (mandatory).
Radek Krejci084289f2019-07-09 17:35:30 +02002347 * @return LY_SUCCESS on success
2348 * @return LY_ERR value if an error occurred.
2349 */
Michal Vaskof937cfe2020-08-03 16:07:12 +02002350LY_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 +02002351
Radek Krejci0935f412019-08-20 16:15:18 +02002352/**
2353 * @brief Stringify schema nodetype.
Michal Vaskod43d71a2020-08-07 14:54:58 +02002354 *
Radek Krejci0935f412019-08-20 16:15:18 +02002355 * @param[in] nodetype Nodetype to stringify.
2356 * @return Constant string with the name of the node's type.
2357 */
2358const char *lys_nodetype2str(uint16_t nodetype);
2359
Michal Vaskod43d71a2020-08-07 14:54:58 +02002360/**
2361 * @brief Getter for original XPath expression from a parsed expression.
2362 *
2363 * @param[in] path Parsed expression.
2364 * @return Original string expression.
2365 */
2366const char *lyxp_get_expr(const struct lyxp_expr *path);
2367
Radek Krejci2ff0d572020-05-21 15:27:28 +02002368/** @} schematree */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002369
Radek Krejci70853c52018-10-15 14:46:16 +02002370#ifdef __cplusplus
2371}
2372#endif
2373
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002374#endif /* LY_TREE_SCHEMA_H_ */