blob: bc573c8e91d913c132a655b5d7f14327edefceea [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 Krejci535ea9f2020-05-29 16:01:05 +020027#include "tree_data.h"
Radek Krejcice8c1592018-10-29 15:35:51 +010028
Radek Krejcie7b95092019-05-15 11:03:07 +020029struct ly_ctx;
Michal Vasko004d3152020-06-11 19:59:22 +020030struct ly_path;
Radek Krejci535ea9f2020-05-29 16:01:05 +020031struct ly_set;
Radek Krejcie7b95092019-05-15 11:03:07 +020032
Radek Krejci70853c52018-10-15 14:46:16 +020033#ifdef __cplusplus
34extern "C" {
35#endif
36
Radek Krejci5aeea3a2018-09-05 13:29:36 +020037/**
Radek Krejci2ff0d572020-05-21 15:27:28 +020038 * @defgroup schematree Schema Tree
39 * @ingroup trees
40 * @{
41 *
42 * Data structures and functions to manipulate and access schema tree.
43 */
44
45/**
Radek Krejci0935f412019-08-20 16:15:18 +020046 * @brief Macro to iterate via all elements in a schema tree which can be instantiated in data tree
Radek Krejciad5963b2019-09-06 16:03:05 +020047 * (skips cases, input, output). 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 +020048 *
49 * The function follows deep-first search algorithm:
50 * <pre>
51 * 1
52 * / \
53 * 2 4
54 * / / \
55 * 3 5 6
56 * </pre>
57 *
58 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
59 * START can be any of the lysc_node* types (including lysc_action and lysc_notif),
60 * ELEM variable must be of the struct lysc_node* type.
61 *
62 * To skip a particular subtree, instead of the continue statement, set LYSC_TREE_DFS_continue
63 * variable to non-zero value.
64 *
65 * Use with opening curly bracket '{' after the macro.
66 *
67 * @param START Pointer to the starting element processed first.
68 * @param ELEM Iterator intended for use in the block.
69 */
70#define LYSC_TREE_DFS_BEGIN(START, ELEM) \
71 { int LYSC_TREE_DFS_continue = 0; struct lysc_node *LYSC_TREE_DFS_next; \
72 for ((ELEM) = (LYSC_TREE_DFS_next) = (START); \
73 (ELEM); \
74 (ELEM) = (LYSC_TREE_DFS_next), LYSC_TREE_DFS_continue = 0)
75
76/**
77 * @brief Macro to iterate via all elements in a (sub)tree. This is the closing part
78 * to the #LYSC_TREE_DFS_BEGIN - they always have to be used together.
79 *
80 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
81 * START can be a pointer to any of the lysc_node* types (including lysc_action and lysc_notif),
82 * ELEM variable must be pointer to the lysc_node type.
83 *
84 * Use with closing curly bracket '}' after the macro.
85 *
86 * @param START Pointer to the starting element processed first.
87 * @param ELEM Iterator intended for use in the block.
88 */
89
90#define LYSC_TREE_DFS_END(START, ELEM) \
91 /* select element for the next run - children first */ \
92 if (LYSC_TREE_DFS_continue) { \
93 (LYSC_TREE_DFS_next) = NULL; \
94 } else { \
95 (LYSC_TREE_DFS_next) = (struct lysc_node*)lysc_node_children(ELEM, 0); \
96 }\
97 if (!(LYSC_TREE_DFS_next)) { \
98 /* in case of RPC/action, get also the output children */ \
Michal Vasko1bf09392020-03-27 12:38:10 +010099 if (!LYSC_TREE_DFS_continue && (ELEM)->nodetype & (LYS_RPC | LYS_ACTION)) { \
Radek Krejci0935f412019-08-20 16:15:18 +0200100 (LYSC_TREE_DFS_next) = (struct lysc_node*)lysc_node_children(ELEM, LYS_CONFIG_R); \
101 } \
102 if (!(LYSC_TREE_DFS_next)) { \
103 /* no children */ \
104 if ((ELEM) == (struct lysc_node*)(START)) { \
105 /* we are done, (START) has no children */ \
106 break; \
107 } \
108 /* try siblings */ \
109 (LYSC_TREE_DFS_next) = (ELEM)->next; \
110 } \
111 } \
112 while (!(LYSC_TREE_DFS_next)) { \
113 /* parent is already processed, go to its sibling */ \
114 (ELEM) = (ELEM)->parent; \
115 /* no siblings, go back through parents */ \
116 if ((ELEM) == (struct lysc_node*)(START)) { \
117 /* we are done, no next element to process */ \
118 break; \
119 } \
Michal Vasko1bf09392020-03-27 12:38:10 +0100120 if ((ELEM)->nodetype & (LYS_RPC | LYS_ACTION)) { \
Radek Krejci0935f412019-08-20 16:15:18 +0200121 /* there is actually next node as a child of action's output */ \
122 (LYSC_TREE_DFS_next) = (struct lysc_node*)lysc_node_children(ELEM, LYS_CONFIG_R); \
123 } \
124 if (!(LYSC_TREE_DFS_next)) { \
125 (LYSC_TREE_DFS_next) = (ELEM)->next; \
126 } \
127 } } \
128
129/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200130 * @brief Schema input formats accepted by libyang [parser functions](@ref howtoschemasparsers).
131 */
132typedef enum {
133 LYS_IN_UNKNOWN = 0, /**< unknown format, used as return value in case of error */
134 LYS_IN_YANG = 1, /**< YANG schema input format */
Radek Krejci693262f2019-04-29 15:23:20 +0200135 LYS_IN_YIN = 3 /**< YIN schema input format */
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200136} LYS_INFORMAT;
137
138/**
139 * @brief Schema output formats accepted by libyang [printer functions](@ref howtoschemasprinters).
140 */
141typedef enum {
142 LYS_OUT_UNKNOWN = 0, /**< unknown format, used as return value in case of error */
143 LYS_OUT_YANG = 1, /**< YANG schema output format */
Radek Krejci693262f2019-04-29 15:23:20 +0200144 LYS_OUT_YANG_COMPILED = 2, /**< YANG schema output format of the compiled schema tree */
FredGand944bdc2019-11-05 21:57:07 +0800145 LYS_OUT_YIN = 3, /**< YIN schema output format */
Radek Krejcid3ca0632019-04-16 16:54:54 +0200146
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200147 LYS_OUT_TREE, /**< Tree schema output format, for more information see the [printers](@ref howtoschemasprinters) page */
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200148} LYS_OUTFORMAT;
149
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200150#define LY_REV_SIZE 11 /**< revision data string length (including terminating NULL byte) */
151
Michal Vaskob55f6c12018-09-12 11:13:15 +0200152#define LYS_UNKNOWN 0x0000 /**< uninitalized unknown statement node */
153#define LYS_CONTAINER 0x0001 /**< container statement node */
154#define LYS_CHOICE 0x0002 /**< choice statement node */
155#define LYS_LEAF 0x0004 /**< leaf statement node */
156#define LYS_LEAFLIST 0x0008 /**< leaf-list statement node */
157#define LYS_LIST 0x0010 /**< list statement node */
158#define LYS_ANYXML 0x0020 /**< anyxml statement node */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200159#define LYS_ANYDATA 0x0120 /**< anydata statement node, in tests it can be used for both #LYS_ANYXML and #LYS_ANYDATA */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200160
Michal Vasko1bf09392020-03-27 12:38:10 +0100161#define LYS_RPC 0x400 /**< RPC statement node */
162#define LYS_ACTION 0x800 /**< action statement node */
163#define LYS_NOTIF 0x1000 /**< notification statement node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200164
Radek Krejcia3045382018-11-22 14:30:31 +0100165#define LYS_CASE 0x0040 /**< case statement node */
166#define LYS_USES 0x0080 /**< uses statement node */
Radek Krejcid3ca0632019-04-16 16:54:54 +0200167#define LYS_INPUT 0x100
168#define LYS_OUTPUT 0x200
169#define LYS_INOUT 0x300
Michal Vasko1bf09392020-03-27 12:38:10 +0100170#define LYS_GROUPING 0x2000
171#define LYS_AUGMENT 0x4000
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100172
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200173/**
Radek Krejcid6b76452019-09-03 17:03:03 +0200174 * @brief List of YANG statements
175 */
176enum ly_stmt {
177 LY_STMT_NONE = 0,
Radek Krejciad5963b2019-09-06 16:03:05 +0200178 LY_STMT_STATUS, /**< in lysc_ext_substmt::storage stored as a pointer to `uint16_t`, only cardinality < #LY_STMT_CARD_SOME is allowed */
179 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 +0200180 LY_STMT_MANDATORY,
Radek Krejciad5963b2019-09-06 16:03:05 +0200181 LY_STMT_UNITS, /**< in lysc_ext_substmt::storage stored as a pointer to `const char *` (cardinality < #LY_STMT_CARD_SOME)
182 or as a pointer to a [sized array](@ref sizedarrays) `const char **` */
Radek Krejci335332a2019-09-05 13:03:35 +0200183 LY_STMT_DEFAULT,
Radek Krejciad5963b2019-09-06 16:03:05 +0200184 LY_STMT_TYPE, /**< in lysc_ext_substmt::storage stored as a pointer to `struct lysc_type *` (cardinality < #LY_STMT_CARD_SOME)
185 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_type **` */
Radek Krejci335332a2019-09-05 13:03:35 +0200186
Radek Krejcid6b76452019-09-03 17:03:03 +0200187 LY_STMT_ACTION,
188 LY_STMT_ANYDATA,
189 LY_STMT_ANYXML,
190 LY_STMT_ARGUMENT,
191 LY_STMT_AUGMENT,
192 LY_STMT_BASE,
193 LY_STMT_BELONGS_TO,
194 LY_STMT_BIT,
195 LY_STMT_CASE,
196 LY_STMT_CHOICE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200197 LY_STMT_CONTACT,
198 LY_STMT_CONTAINER,
Radek Krejcid6b76452019-09-03 17:03:03 +0200199 LY_STMT_DESCRIPTION,
200 LY_STMT_DEVIATE,
201 LY_STMT_DEVIATION,
202 LY_STMT_ENUM,
203 LY_STMT_ERROR_APP_TAG,
204 LY_STMT_ERROR_MESSAGE,
205 LY_STMT_EXTENSION,
206 LY_STMT_FEATURE,
207 LY_STMT_FRACTION_DIGITS,
208 LY_STMT_GROUPING,
209 LY_STMT_IDENTITY,
Radek Krejciad5963b2019-09-06 16:03:05 +0200210 LY_STMT_IF_FEATURE, /**< in lysc_ext_substmt::storage stored as a pointer to `struct lysc_iffeature` (cardinality < #LY_STMT_CARD_SOME)
211 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_iffeature *` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200212 LY_STMT_IMPORT,
213 LY_STMT_INCLUDE,
214 LY_STMT_INPUT,
215 LY_STMT_KEY,
216 LY_STMT_LEAF,
217 LY_STMT_LEAF_LIST,
218 LY_STMT_LENGTH,
219 LY_STMT_LIST,
Radek Krejcid6b76452019-09-03 17:03:03 +0200220 LY_STMT_MAX_ELEMENTS,
221 LY_STMT_MIN_ELEMENTS,
222 LY_STMT_MODIFIER,
223 LY_STMT_MODULE,
224 LY_STMT_MUST,
225 LY_STMT_NAMESPACE,
226 LY_STMT_NOTIFICATION,
227 LY_STMT_ORDERED_BY,
228 LY_STMT_ORGANIZATION,
229 LY_STMT_OUTPUT,
230 LY_STMT_PATH,
231 LY_STMT_PATTERN,
232 LY_STMT_POSITION,
233 LY_STMT_PREFIX,
234 LY_STMT_PRESENCE,
235 LY_STMT_RANGE,
236 LY_STMT_REFERENCE,
237 LY_STMT_REFINE,
238 LY_STMT_REQUIRE_INSTANCE,
239 LY_STMT_REVISION,
240 LY_STMT_REVISION_DATE,
241 LY_STMT_RPC,
Radek Krejcid6b76452019-09-03 17:03:03 +0200242 LY_STMT_SUBMODULE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200243 LY_STMT_TYPEDEF,
244 LY_STMT_UNIQUE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200245 LY_STMT_USES,
246 LY_STMT_VALUE,
247 LY_STMT_WHEN,
248 LY_STMT_YANG_VERSION,
249 LY_STMT_YIN_ELEMENT,
250 LY_STMT_EXTENSION_INSTANCE,
251
252 LY_STMT_SYNTAX_SEMICOLON,
253 LY_STMT_SYNTAX_LEFT_BRACE,
254 LY_STMT_SYNTAX_RIGHT_BRACE,
255
256 LY_STMT_ARG_TEXT,
257 LY_STMT_ARG_VALUE
258};
259
260/**
Radek Krejci0e59c312019-08-15 15:34:15 +0200261 * @brief Extension instance structure parent enumeration
262 */
263typedef enum {
Radek Krejci0935f412019-08-20 16:15:18 +0200264 LYEXT_PAR_MODULE, /**< ::lysc_module */
265 LYEXT_PAR_NODE, /**< ::lysc_node (and the derived structures including ::lysc_action and ::lysc_notif) */
266 LYEXT_PAR_INPUT, /**< ::lysc_action_inout */
267 LYEXT_PAR_OUTPUT, /**< ::lysc_action_inout */
268 LYEXT_PAR_TYPE, /**< ::lysc_type */
269 LYEXT_PAR_TYPE_BIT, /**< ::lysc_type_bitenum_item */
270 LYEXT_PAR_TYPE_ENUM, /**< ::lysc_type_bitenum_item */
271 LYEXT_PAR_FEATURE, /**< ::lysc_feature */
272 LYEXT_PAR_MUST, /**< ::lysc_must */
273 LYEXT_PAR_PATTERN, /**< ::lysc_pattern */
274 LYEXT_PAR_LENGTH, /**< ::lysc_range */
275 LYEXT_PAR_RANGE, /**< ::lysc_range */
276 LYEXT_PAR_WHEN, /**< ::lysc_when */
277 LYEXT_PAR_IDENT, /**< ::lysc_ident */
278 LYEXT_PAR_EXT, /**< ::lysc_ext */
279 LYEXT_PAR_IMPORT, /**< ::lysc_import */
280// LYEXT_PAR_TPDF, /**< ::lysp_tpdf */
281// LYEXT_PAR_EXTINST, /**< ::lysp_ext_instance */
282// LYEXT_PAR_REFINE, /**< ::lysp_refine */
283// LYEXT_PAR_DEVIATION, /**< ::lysp_deviation */
284// LYEXT_PAR_DEVIATE, /**< ::lysp_deviate */
285// LYEXT_PAR_INCLUDE, /**< ::lysp_include */
286// LYEXT_PAR_REVISION, /**< ::lysp_revision */
Radek Krejci0e59c312019-08-15 15:34:15 +0200287} LYEXT_PARENT;
288
289/**
Radek Krejci0935f412019-08-20 16:15:18 +0200290 * @brief Stringify extension instance parent type.
291 * @param[in] type Parent type to stringify.
292 * @return Constant string with the name of the parent statement.
293 */
294const char *lyext_parent2str(LYEXT_PARENT type);
295
296/**
Radek Krejci0e59c312019-08-15 15:34:15 +0200297 * @brief Enum of substatements in which extension instances can appear.
298 */
299typedef enum {
300 LYEXT_SUBSTMT_SELF = 0, /**< extension of the structure itself, not substatement's */
301 LYEXT_SUBSTMT_ARGUMENT, /**< extension of the argument statement, can appear in lys_ext */
302 LYEXT_SUBSTMT_BASE, /**< extension of the base statement, can appear (repeatedly) in lys_type and lys_ident */
303 LYEXT_SUBSTMT_BELONGSTO, /**< extension of the belongs-to statement, can appear in lys_submodule */
304 LYEXT_SUBSTMT_CONTACT, /**< extension of the contact statement, can appear in lys_module */
305 LYEXT_SUBSTMT_DEFAULT, /**< extension of the default statement, can appear in lys_node_leaf, lys_node_leaflist,
306 lys_node_choice and lys_deviate */
307 LYEXT_SUBSTMT_DESCRIPTION, /**< extension of the description statement, can appear in lys_module, lys_submodule,
308 lys_node, lys_import, lys_include, lys_ext, lys_feature, lys_tpdf, lys_restr,
309 lys_ident, lys_deviation, lys_type_enum, lys_type_bit, lys_when and lys_revision */
310 LYEXT_SUBSTMT_ERRTAG, /**< extension of the error-app-tag statement, can appear in lys_restr */
311 LYEXT_SUBSTMT_ERRMSG, /**< extension of the error-message statement, can appear in lys_restr */
312 LYEXT_SUBSTMT_KEY, /**< extension of the key statement, can appear in lys_node_list */
313 LYEXT_SUBSTMT_NAMESPACE, /**< extension of the namespace statement, can appear in lys_module */
314 LYEXT_SUBSTMT_ORGANIZATION, /**< extension of the organization statement, can appear in lys_module and lys_submodule */
315 LYEXT_SUBSTMT_PATH, /**< extension of the path statement, can appear in lys_type */
316 LYEXT_SUBSTMT_PREFIX, /**< extension of the prefix statement, can appear in lys_module, lys_submodule (for
317 belongs-to's prefix) and lys_import */
318 LYEXT_SUBSTMT_PRESENCE, /**< extension of the presence statement, can appear in lys_node_container */
319 LYEXT_SUBSTMT_REFERENCE, /**< extension of the reference statement, can appear in lys_module, lys_submodule,
320 lys_node, lys_import, lys_include, lys_revision, lys_tpdf, lys_restr, lys_ident,
321 lys_ext, lys_feature, lys_deviation, lys_type_enum, lys_type_bit and lys_when */
322 LYEXT_SUBSTMT_REVISIONDATE, /**< extension of the revision-date statement, can appear in lys_import and lys_include */
323 LYEXT_SUBSTMT_UNITS, /**< extension of the units statement, can appear in lys_tpdf, lys_node_leaf,
324 lys_node_leaflist and lys_deviate */
325 LYEXT_SUBSTMT_VALUE, /**< extension of the value statement, can appear in lys_type_enum */
326 LYEXT_SUBSTMT_VERSION, /**< extension of the yang-version statement, can appear in lys_module and lys_submodule */
327 LYEXT_SUBSTMT_MODIFIER, /**< extension of the modifier statement, can appear in lys_restr */
328 LYEXT_SUBSTMT_REQINSTANCE, /**< extension of the require-instance statement, can appear in lys_type */
329 LYEXT_SUBSTMT_YINELEM, /**< extension of the yin-element statement, can appear in lys_ext */
330 LYEXT_SUBSTMT_CONFIG, /**< extension of the config statement, can appear in lys_node and lys_deviate */
331 LYEXT_SUBSTMT_MANDATORY, /**< extension of the mandatory statement, can appear in lys_node_leaf, lys_node_choice,
332 lys_node_anydata and lys_deviate */
333 LYEXT_SUBSTMT_ORDEREDBY, /**< extension of the ordered-by statement, can appear in lys_node_list and lys_node_leaflist */
334 LYEXT_SUBSTMT_STATUS, /**< extension of the status statement, can appear in lys_tpdf, lys_node, lys_ident,
335 lys_ext, lys_feature, lys_type_enum and lys_type_bit */
336 LYEXT_SUBSTMT_FRACDIGITS, /**< extension of the fraction-digits statement, can appear in lys_type */
337 LYEXT_SUBSTMT_MAX, /**< extension of the max-elements statement, can appear in lys_node_list,
338 lys_node_leaflist and lys_deviate */
339 LYEXT_SUBSTMT_MIN, /**< extension of the min-elements statement, can appear in lys_node_list,
340 lys_node_leaflist and lys_deviate */
341 LYEXT_SUBSTMT_POSITION, /**< extension of the position statement, can appear in lys_type_bit */
342 LYEXT_SUBSTMT_UNIQUE, /**< extension of the unique statement, can appear in lys_node_list and lys_deviate */
343 LYEXT_SUBSTMT_IFFEATURE, /**< extension of the if-feature statement */
344} LYEXT_SUBSTMT;
345
346/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200347 * @brief YANG import-stmt
348 */
349struct lysp_import {
Radek Krejci086c7132018-10-26 15:29:04 +0200350 struct lys_module *module; /**< pointer to the imported module
351 (mandatory, but resolved when the referring module is completely parsed) */
352 const char *name; /**< name of the imported module (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200353 const char *prefix; /**< prefix for the data from the imported schema (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200354 const char *dsc; /**< description */
355 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200356 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200357 char rev[LY_REV_SIZE]; /**< revision-date of the imported module */
358};
359
360/**
361 * @brief YANG include-stmt
362 */
363struct lysp_include {
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100364 struct lysp_submodule *submodule;/**< pointer to the parsed submodule structure
Radek Krejci086c7132018-10-26 15:29:04 +0200365 (mandatory, but resolved when the referring module is completely parsed) */
366 const char *name; /**< name of the included submodule (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200367 const char *dsc; /**< description */
368 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200369 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200370 char rev[LY_REV_SIZE]; /**< revision-date of the included submodule */
371};
372
373/**
374 * @brief YANG extension-stmt
375 */
376struct lysp_ext {
377 const char *name; /**< extension name */
378 const char *argument; /**< argument name, NULL if not specified */
379 const char *dsc; /**< description statement */
380 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200381 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200382 uint16_t flags; /**< LYS_STATUS_* and LYS_YINELEM_* values (@ref snodeflags) */
Michal Vasko5fe75f12020-03-02 13:52:37 +0100383
384 struct lysc_ext *compiled; /**< pointer to the compiled extension definition */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200385};
386
387/**
388 * @brief Helper structure for generic storage of the extension instances content.
389 */
390struct lysp_stmt {
391 const char *stmt; /**< identifier of the statement */
392 const char *arg; /**< statement's argument */
393 struct lysp_stmt *next; /**< link to the next statement */
Michal Vaskobc2559f2018-09-07 10:17:50 +0200394 struct lysp_stmt *child; /**< list of the statement's substatements (linked list) */
David Sedlákb9d75c42019-08-14 10:49:42 +0200395 uint16_t flags; /**< statement flags, can be set to LYS_YIN_ATTR */
Radek Krejci335332a2019-09-05 13:03:35 +0200396 enum ly_stmt kw; /**< numeric respresentation of the stmt value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200397};
398
David Sedlákae4b4512019-08-14 10:45:56 +0200399#define LYS_YIN 0x1 /**< used to specify input format of extension instance */
400
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200401/**
402 * @brief YANG extension instance
403 */
404struct lysp_ext_instance {
David Sedlákbbd06ca2019-06-27 14:15:38 +0200405 const char *name; /**< extension identifier, including possible prefix */
406 const char *argument; /**< optional value of the extension's argument */
Radek Krejci335332a2019-09-05 13:03:35 +0200407 void *parent; /**< pointer to the parent element holding the extension instance(s), use
408 ::lysp_ext_instance#parent_type to access the schema element */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200409 struct lysp_stmt *child; /**< list of the extension's substatements (linked list) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200410 struct lysc_ext_instance *compiled; /**< pointer to the compiled data if any - in case the source format is YIN,
411 some of the information (argument) are available only after compilation */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200412 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Radek Krejci7eb54ba2020-05-18 16:30:04 +0200413 LY_ARRAY_SIZE_TYPE insubstmt_index; /**< in case the instance is in a substatement, this identifies
David Sedlákbbd06ca2019-06-27 14:15:38 +0200414 the index of that substatement */
David Sedlákae4b4512019-08-14 10:45:56 +0200415 uint8_t yin; /** flag for YIN source format, can be set to LYS_YIN */
Radek Krejci335332a2019-09-05 13:03:35 +0200416 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200417};
418
419/**
420 * @brief YANG feature-stmt
421 */
422struct lysp_feature {
423 const char *name; /**< feature name (mandatory) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200424 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200425 const char *dsc; /**< description statement */
426 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200427 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200428 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values allowed */
429};
430
431/**
432 * @brief YANG identity-stmt
433 */
434struct lysp_ident {
435 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejci151a5b72018-10-19 14:21:44 +0200436 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
437 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200438 const char *dsc; /**< description statement */
439 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200440 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200441 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
442};
443
Michal Vasko71e64ca2018-09-07 16:30:29 +0200444/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200445 * @brief Covers restrictions: range, length, pattern, must
446 */
447struct lysp_restr {
448 const char *arg; /**< The restriction expression/value (mandatory);
449 in case of pattern restriction, the first byte has a special meaning:
450 0x06 (ACK) for regular match and 0x15 (NACK) for invert-match */
451 const char *emsg; /**< error-message */
452 const char *eapptag; /**< error-app-tag value */
453 const char *dsc; /**< description */
454 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200455 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200456};
457
458/**
Michal Vasko71e64ca2018-09-07 16:30:29 +0200459 * @brief YANG revision-stmt
460 */
461struct lysp_revision {
Radek Krejcib7db73a2018-10-24 14:18:40 +0200462 char date[LY_REV_SIZE]; /**< revision date (madatory) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200463 const char *dsc; /**< description statement */
464 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200465 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200466};
467
468/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200469 * @brief Enumeration/Bit value definition
470 */
471struct lysp_type_enum {
472 const char *name; /**< name (mandatory) */
473 const char *dsc; /**< description statement */
474 const char *ref; /**< reference statement */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200475 int64_t value; /**< enum's value or bit's position */
Radek Krejci151a5b72018-10-19 14:21:44 +0200476 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200477 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200478 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
479 values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200480};
481
482/**
483 * @brief YANG type-stmt
484 *
485 * Some of the items in the structure may be mandatory, but it is necessary to resolve the type's base type first
486 */
487struct lysp_type {
488 const char *name; /**< name of the type (mandatory) */
489 struct lysp_restr *range; /**< allowed values range - numerical, decimal64 */
490 struct lysp_restr *length; /**< allowed length of the value - string, binary */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200491 struct lysp_restr *patterns; /**< list of patterns ([sized array](@ref sizedarrays)) - string */
492 struct lysp_type_enum *enums; /**< list of enum-stmts ([sized array](@ref sizedarrays)) - enum */
493 struct lysp_type_enum *bits; /**< list of bit-stmts ([sized array](@ref sizedarrays)) - bits */
Michal Vasko004d3152020-06-11 19:59:22 +0200494 struct lyxp_expr *path; /**< parsed path - leafref */
Radek Krejci151a5b72018-10-19 14:21:44 +0200495 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) - identityref */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200496 struct lysp_type *types; /**< list of sub-types ([sized array](@ref sizedarrays)) - union */
497 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200498
Radek Krejci2167ee12018-11-02 16:09:07 +0100499 struct lysc_type *compiled; /**< pointer to the compiled type */
500
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200501 uint8_t fraction_digits; /**< number of fraction digits - decimal64 */
502 uint8_t require_instance; /**< require-instance flag - leafref, instance */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100503 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200504};
505
506/**
507 * @brief YANG typedef-stmt
508 */
509struct lysp_tpdf {
510 const char *name; /**< name of the newly defined type (mandatory) */
511 const char *units; /**< units of the newly defined type */
512 const char *dflt; /**< default value of the newly defined type */
513 const char *dsc; /**< description statement */
514 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200515 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200516 struct lysp_type type; /**< base type from which the typedef is derived (mandatory) */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100517 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200518};
519
520/**
521 * @brief YANG grouping-stmt
522 */
523struct lysp_grp {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100524 struct lysp_node *parent; /**< parent node (NULL if this is a top-level grouping) */
525 uint16_t nodetype; /**< LYS_GROUPING */
526 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200527 const char *name; /**< grouping name (mandatory) */
528 const char *dsc; /**< description statement */
529 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200530 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
531 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200532 struct lysp_node *data; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200533 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
534 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
535 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200536};
537
538/**
539 * @brief YANG when-stmt
540 */
541struct lysp_when {
542 const char *cond; /**< specified condition (mandatory) */
543 const char *dsc; /**< description statement */
544 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200545 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200546};
547
548/**
549 * @brief YANG refine-stmt
550 */
551struct lysp_refine {
552 const char *nodeid; /**< target descendant schema nodeid (mandatory) */
553 const char *dsc; /**< description statement */
554 const char *ref; /**< reference statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200555 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200556 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200557 const char *presence; /**< presence description */
Radek Krejci151a5b72018-10-19 14:21:44 +0200558 const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200559 uint32_t min; /**< min-elements constraint */
560 uint32_t max; /**< max-elements constraint, 0 means unbounded */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200561 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200562 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
563};
564
565/**
Michal Vasko82a83432019-11-14 12:33:04 +0100566 * @brief YANG uses-augment-stmt and augment-stmt (compatible with struct lysp_node )
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200567 */
568struct lysp_augment {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100569 struct lysp_node *parent; /**< parent node (NULL if this is a top-level augment) */
570 uint16_t nodetype; /**< LYS_AUGMENT */
571 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
Michal Vasko82a83432019-11-14 12:33:04 +0100572 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200573 const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */
574 const char *dsc; /**< description statement */
575 const char *ref; /**< reference statement */
576 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200577 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Michal Vasko82a83432019-11-14 12:33:04 +0100578 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200579 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
580 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200581};
582
583/**
584 * @defgroup deviatetypes Deviate types
585 * @{
586 */
587#define LYS_DEV_NOT_SUPPORTED 1 /**< deviate type not-supported */
588#define LYS_DEV_ADD 2 /**< deviate type add */
589#define LYS_DEV_DELETE 3 /**< deviate type delete */
590#define LYS_DEV_REPLACE 4 /**< deviate type replace */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200591/** @} deviatetypes */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200592
593/**
594 * @brief Generic deviate structure to get type and cast to lysp_deviate_* structure
595 */
596struct lysp_deviate {
597 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
598 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200599 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200600};
601
602struct lysp_deviate_add {
603 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
604 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200605 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200606 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200607 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200608 const char **uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
609 const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200610 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
611 uint32_t min; /**< min-elements constraint */
612 uint32_t max; /**< max-elements constraint, 0 means unbounded */
613};
614
615struct lysp_deviate_del {
616 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
617 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200618 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200619 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200620 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200621 const char **uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
622 const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200623};
624
625struct lysp_deviate_rpl {
626 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
627 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200628 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200629 struct lysp_type *type; /**< type of the node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200630 const char *units; /**< units of the values */
631 const char *dflt; /**< default value */
632 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
633 uint32_t min; /**< min-elements constraint */
634 uint32_t max; /**< max-elements constraint, 0 means unbounded */
635};
636
637struct lysp_deviation {
Michal Vaskob55f6c12018-09-12 11:13:15 +0200638 const char *nodeid; /**< target absolute schema nodeid (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200639 const char *dsc; /**< description statement */
640 const char *ref; /**< reference statement */
641 struct lysp_deviate* deviates; /**< list of deviate specifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200642 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200643};
644
Radek Krejci4f28eda2018-11-12 11:46:16 +0100645/**
646 * @defgroup spnodeflags Parsed schema nodes flags
647 * @ingroup snodeflags
648 *
649 * Various flags for parsed schema nodes.
650 *
651 * 1 - container 6 - anydata/anyxml 11 - output 16 - grouping 21 - enum
652 * 2 - choice 7 - case 12 - feature 17 - uses 22 - type
Radek Krejcid3ca0632019-04-16 16:54:54 +0200653 * 3 - leaf 8 - notification 13 - identity 18 - refine 23 - stmt
Radek Krejci4f28eda2018-11-12 11:46:16 +0100654 * 4 - leaflist 9 - rpc 14 - extension 19 - augment
655 * 5 - list 10 - input 15 - typedef 20 - deviate
656 *
Radek Krejcid3ca0632019-04-16 16:54:54 +0200657 * 1 1 1 1 1 1 1 1 1 1 2 2 2 2
658 * 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
659 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
660 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | | | | |x| |x| | | |
661 * LYS_SET_BASE | | | | | | | | | | | | | | | | | | | | | |x| |
662 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
663 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | | | | |x| |x| | | |
664 * LYS_SET_BIT | | | | | | | | | | | | | | | | | | | | | |x| |
665 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
666 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
667 * LYS_SET_ENUM | | | | | | | | | | | | | | | | | | | | | |x| |
668 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
669 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
670 * LYS_SET_FRDIGITS | | | | | | | | | | | | | | | | | | | | | |x| |
671 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
672 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
673 * LYS_SET_LENGTH | | | | | | | | | | | | | | | | | | | | | |x| |
674 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
675 * 6 LYS_MAND_TRUE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
676 * LYS_SET_PATH | | | | | | | | | | | | | | | | | | | | | |x| |
677 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
678 * 7 LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
679 * LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | | | | | | | | |
680 * LYS_SET_PATTERN | | | | | | | | | | | | | | | | | | | | | |x| |
681 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
682 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | | | | | | | | |
683 * LYS_YINELEM_TRUE | | | | | | | | | | | | | |x| | | | | | | | | |
684 * LYS_SET_RANGE | | | | | | | | | | | | | | | | | | | | | |x| |
685 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
686 * 9 LYS_YINELEM_FALSE| | | | | | | | | | | | | |x| | | | | | | | | |
687 * LYS_SET_TYPE | | | | | | | | | | | | | | | | | | | | | |x| |
688 * LYS_SINGLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
689 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
690 * 10 LYS_SET_VALUE | | | | | | | | | | | | | | | | | | | | |x| | |
691 * LYS_SET_REQINST | | | | | | | | | | | | | | | | | | | | | |x| |
692 * LYS_SET_MIN | | | |x|x| | | | | | | | | | | | |x| |x| | | |
693 * LYS_DOUBLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
694 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
695 * 11 LYS_SET_MAX | | | |x|x| | | | | | | | | | | | |x| |x| | | |
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200696 * LYS_USED_GRP | | | | | | | | | | | | | | | |x| | | | | | | |
David Sedlákae4b4512019-08-14 10:45:56 +0200697 * LYS_YIN_ATTR | | | | | | | | | | | | | | | | | | | | | | |x|
Radek Krejcid3ca0632019-04-16 16:54:54 +0200698 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejcif56e2a42019-09-09 14:15:25 +0200699 * 12 LYS_YIN_ARGUMENT | | | | | | | | | | | | | | | | | | | | | | |x|
700 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100701 *
702 */
703
704/**
705 * @defgroup scnodeflags Compiled schema nodes flags
706 * @ingroup snodeflags
707 *
708 * Various flags for compiled schema nodes.
709 *
Radek Krejci61e042e2019-09-10 15:53:09 +0200710 * 1 - container 6 - anydata/anyxml 11 - identity
711 * 2 - choice 7 - case 12 - extension
712 * 3 - leaf 8 - notification 13 - bitenum
Michal Vasko03ff5a72019-09-11 13:49:33 +0200713 * 4 - leaflist 9 - rpc/action 14 - when
Michal Vaskoecd62de2019-11-13 12:35:11 +0100714 * 5 - list 10 - feature
Radek Krejci4f28eda2018-11-12 11:46:16 +0100715 *
Michal Vaskoecd62de2019-11-13 12:35:11 +0100716 * 1 1 1 1 1
717 * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4
718 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
719 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | |
720 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
721 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | |
722 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
723 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x|x|x|x| |x|
724 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
725 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x|x|x|x| |x|
726 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
727 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x|x|x|x| |x|
728 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
729 * 6 LYS_MAND_TRUE |x|x|x|x|x|x| | | | | | | | |
730 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
731 * 7 LYS_ORDBY_USER | | | |x|x| | | | | | | | | |
732 * LYS_MAND_FALSE | |x|x| | |x| | | | | | | | |
733 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
734 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | |
735 * LYS_PRESENCE |x| | | | | | | | | | | | | |
736 * LYS_UNIQUE | | |x| | | | | | | | | | | |
737 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
738 * 9 LYS_KEY | | |x| | | | | | | | | | | |
739 * LYS_FENABLED | | | | | | | | | |x| | | | |
740 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
741 * 10 LYS_SET_DFLT | | |x|x| | |x| | | | | | | |
742 * LYS_ISENUM | | | | | | | | | | | | |x| |
743 * LYS_KEYLESS | | | | |x| | | | | | | | | |
744 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
745 * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | |
746 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+
747 * 12 LYS_SET_CONFIG |x|x|x|x|x|x| | | | | | | | |
748 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100749 *
750 */
751
752/**
753 * @defgroup snodeflags Schema nodes flags
Radek Krejci4f28eda2018-11-12 11:46:16 +0100754 * @{
755 */
Michal Vasko1bf09392020-03-27 12:38:10 +0100756#define LYS_CONFIG_W 0x01 /**< config true; also set for input children nodes */
757#define LYS_CONFIG_R 0x02 /**< config false; also set for output and notification children nodes */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200758#define LYS_CONFIG_MASK 0x03 /**< mask for config value */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100759#define LYS_STATUS_CURR 0x04 /**< status current; */
760#define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */
761#define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */
762#define LYS_STATUS_MASK 0x1C /**< mask for status value */
763#define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice,
Radek Krejcife909632019-02-12 15:34:42 +0100764 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
765 The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0.
766 The ::lysc_node_container has this flag if it is not a presence container and it has at least one
767 child with LYS_MAND_TRUE. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100768#define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice,
769 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
770 This flag is present only in case the mandatory false statement was explicitly specified. */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100771#define LYS_MAND_MASK 0x60 /**< mask for mandatory values */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100772#define LYS_PRESENCE 0x80 /**< flag for presence property of a container, applicable only to ::lysc_node_container */
773#define LYS_UNIQUE 0x80 /**< flag for leafs being part of a unique set, applicable only to ::lysc_node_leaf */
774#define LYS_KEY 0x100 /**< flag for leafs being a key of a list, applicable only to ::lysc_node_leaf */
Radek Krejci0fe9b512019-07-26 17:51:05 +0200775#define LYS_KEYLESS 0x200 /**< flag for list without any key, applicable only to ::lysc_node_list */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100776#define LYS_FENABLED 0x100 /**< feature enabled flag, applicable only to ::lysc_feature */
Radek Krejcife909632019-02-12 15:34:42 +0100777#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 +0100778 ::lysc_node_list/::lysp_node_list */
779#define LYS_ORDBY_USER 0x40 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and
780 ::lysc_node_list/::lysp_node_list */
781#define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */
782#define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */
783#define LYS_YINELEM_FALSE 0x100 /**< yin-element false for extension's argument */
784#define LYS_YINELEM_MASK 0x180 /**< mask for yin-element value */
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200785#define LYS_USED_GRP 0x400 /**< internal flag for validating not-instantiated groupings
786 (resp. do not validate again the instantiated groupings). */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100787#define LYS_SET_VALUE 0x200 /**< value attribute is set */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100788#define LYS_SET_MIN 0x200 /**< min attribute is set */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200789#define LYS_SET_MAX 0x400 /**< max attribute is set */
Radek Krejcid505e3d2018-11-13 09:04:17 +0100790
791#define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */
792#define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */
793#define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */
794#define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */
795#define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */
796#define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */
797#define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */
798#define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */
799#define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */
800#define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */
Radek Krejciccd20f12019-02-15 14:12:27 +0100801#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 +0100802 cases of choice. This information is important for refines, since it is prohibited to make leafs
803 with default statement mandatory. In case the default leaf value is taken from type, it is thrown
Radek Krejciccd20f12019-02-15 14:12:27 +0100804 away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish
805 between own default or the default values taken from the type. */
806#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 +0100807#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 +0100808
Radek Krejcif56e2a42019-09-09 14:15:25 +0200809#define LYS_SINGLEQUOTED 0x100 /**< flag for single-quoted argument of an extension instance's substatement, only when the source is YANG */
810#define LYS_DOUBLEQUOTED 0x200 /**< flag for double-quoted argument of an extension instance's substatement, only when the source is YANG */
Radek Krejcid3ca0632019-04-16 16:54:54 +0200811
Radek Krejcif56e2a42019-09-09 14:15:25 +0200812#define LYS_YIN_ATTR 0x400 /**< flag to identify YIN attribute parsed as extension's substatement, only when the source is YIN */
813#define LYS_YIN_ARGUMENT 0x800 /**< flag to identify statement representing extension's argument, only when the source is YIN */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200814
Radek Krejci693262f2019-04-29 15:23:20 +0200815#define LYS_ISENUM 0x200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */
816
Radek Krejcife909632019-02-12 15:34:42 +0100817#define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */
Radek Krejci2ff0d572020-05-21 15:27:28 +0200818/** @} snodeflags */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200819
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200820/**
821 * @brief Generic YANG data node
822 */
823struct lysp_node {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100824 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200825 uint16_t nodetype; /**< type of the node (mandatory) */
826 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100827 struct lysp_node *next; /**< next sibling node (NULL if there is no one) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200828 const char *name; /**< node name (mandatory) */
829 const char *dsc; /**< description statement */
830 const char *ref; /**< reference statement */
831 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200832 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200833 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200834};
835
836/**
837 * @brief Extension structure of the lysp_node for YANG container
838 */
839struct lysp_node_container {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100840 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200841 uint16_t nodetype; /**< LYS_CONTAINER */
842 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
843 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
844 const char *name; /**< node name (mandatory) */
845 const char *dsc; /**< description statement */
846 const char *ref; /**< reference statement */
847 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200848 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200849 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200850
851 /* container */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200852 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200853 const char *presence; /**< presence description */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200854 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
855 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200856 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200857 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
858 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200859};
860
861struct lysp_node_leaf {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100862 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200863 uint16_t nodetype; /**< LYS_LEAF */
864 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
865 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
866 const char *name; /**< node name (mandatory) */
867 const char *dsc; /**< description statement */
868 const char *ref; /**< reference statement */
869 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200870 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200871 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200872
873 /* leaf */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200874 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200875 struct lysp_type type; /**< type of the leaf node (mandatory) */
876 const char *units; /**< units of the leaf's type */
877 const char *dflt; /**< default value */
878};
879
880struct lysp_node_leaflist {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100881 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200882 uint16_t nodetype; /**< LYS_LEAFLIST */
883 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
884 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
885 const char *name; /**< node name (mandatory) */
886 const char *dsc; /**< description statement */
887 const char *ref; /**< reference statement */
888 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200889 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200890 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200891
892 /* leaf-list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200893 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200894 struct lysp_type type; /**< type of the leaf node (mandatory) */
895 const char *units; /**< units of the leaf's type */
Radek Krejci151a5b72018-10-19 14:21:44 +0200896 const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200897 uint32_t min; /**< min-elements constraint */
898 uint32_t max; /**< max-elements constraint, 0 means unbounded */
899};
900
901struct lysp_node_list {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100902 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200903 uint16_t nodetype; /**< LYS_LIST */
904 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
905 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
906 const char *name; /**< node name (mandatory) */
907 const char *dsc; /**< description statement */
908 const char *ref; /**< reference statement */
909 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200910 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200911 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200912
913 /* list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200914 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200915 const char *key; /**< keys specification */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200916 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
917 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200918 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200919 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
920 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200921 const char **uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200922 uint32_t min; /**< min-elements constraint */
923 uint32_t max; /**< max-elements constraint, 0 means unbounded */
924};
925
926struct lysp_node_choice {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100927 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200928 uint16_t nodetype; /**< LYS_CHOICE */
929 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
930 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
931 const char *name; /**< node name (mandatory) */
932 const char *dsc; /**< description statement */
933 const char *ref; /**< reference statement */
934 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200935 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200936 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200937
938 /* choice */
939 struct lysp_node *child; /**< list of data nodes (linked list) */
940 const char* dflt; /**< default case */
941};
942
943struct lysp_node_case {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100944 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200945 uint16_t nodetype; /**< LYS_CASE */
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 */
951 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200952 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200953 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200954
955 /* case */
956 struct lysp_node *child; /**< list of data nodes (linked list) */
957};
958
959struct lysp_node_anydata {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100960 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200961 uint16_t nodetype; /**< LYS_ANYXML || LYS_ANYDATA */
962 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
963 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
964 const char *name; /**< node name (mandatory) */
965 const char *dsc; /**< description statement */
966 const char *ref; /**< reference statement */
967 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200968 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200969 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200970
971 /* anyxml/anydata */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200972 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200973};
974
975struct lysp_node_uses {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100976 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200977 uint16_t nodetype; /**< LYS_USES */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200978 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
979 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
980 const char *name; /**< grouping name reference (mandatory) */
981 const char *dsc; /**< description statement */
982 const char *ref; /**< reference statement */
983 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200984 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200985 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200986
987 /* uses */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200988 struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */
989 struct lysp_augment *augments; /**< list of uses's augment ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200990};
991
992/**
993 * @brief YANG input-stmt and output-stmt
994 */
995struct lysp_action_inout {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100996 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
997 uint16_t nodetype; /**< LYS_INOUT */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200998 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
999 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1000 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001001 struct lysp_node *data; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001002 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001003};
1004
1005/**
1006 * @brief YANG rpc-stmt and action-stmt
1007 */
1008struct lysp_action {
Radek Krejci6d9b9b52018-11-02 12:43:39 +01001009 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Michal Vasko1bf09392020-03-27 12:38:10 +01001010 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
Radek Krejci6d9b9b52018-11-02 12:43:39 +01001011 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001012 const char *name; /**< grouping name reference (mandatory) */
1013 const char *dsc; /**< description statement */
1014 const char *ref; /**< reference statement */
Radek Krejci151a5b72018-10-19 14:21:44 +02001015 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001016 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1017 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001018 struct lysp_action_inout input; /**< RPC's/Action's input */
1019 struct lysp_action_inout output; /**< RPC's/Action's output */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001020 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001021};
1022
1023/**
1024 * @brief YANG notification-stmt
1025 */
1026struct lysp_notif {
Radek Krejci6d9b9b52018-11-02 12:43:39 +01001027 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1028 uint16_t nodetype; /**< LYS_NOTIF */
1029 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001030 const char *name; /**< grouping name reference (mandatory) */
1031 const char *dsc; /**< description statement */
1032 const char *ref; /**< reference statement */
Radek Krejci151a5b72018-10-19 14:21:44 +02001033 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001034 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1035 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1036 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001037 struct lysp_node *data; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001038 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001039};
1040
1041/**
Radek Krejcif0fceb62018-09-05 14:58:45 +02001042 * @brief supported YANG schema version values
1043 */
1044typedef enum LYS_VERSION {
1045 LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */
1046 LYS_VERSION_1_0 = 1, /**< YANG 1.0 */
1047 LYS_VERSION_1_1 = 2 /**< YANG 1.1 */
1048} LYS_VERSION;
1049
1050/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001051 * @brief Printable YANG schema tree structure representing YANG module.
1052 *
1053 * Simple structure corresponding to the YANG format. The schema is only syntactically validated.
1054 */
1055struct lysp_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001056 struct lys_module *mod; /**< covering module structure */
1057
Radek Krejcib7db73a2018-10-24 14:18:40 +02001058 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1059 in the list is always the last (newest) revision of the module */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001060 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1061 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001062 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1063 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1064 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1065 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1066 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001067 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001068 struct lysp_augment *augments; /**< list of augments ([sized array](@ref sizedarrays)) */
1069 struct lysp_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */
1070 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
1071 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
1072 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001073
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001074 uint8_t parsing:1; /**< flag for circular check */
1075};
1076
1077struct lysp_submodule {
1078 const char *belongsto; /**< belongs to parent module (submodule - mandatory) */
1079
1080 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1081 in the list is always the last (newest) revision of the module */
1082 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1083 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
1084 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1085 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1086 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1087 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1088 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
1089 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
1090 struct lysp_augment *augments; /**< list of augments ([sized array](@ref sizedarrays)) */
1091 struct lysp_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */
1092 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
1093 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
1094 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1095
1096 uint8_t parsing:1; /**< flag for circular check */
1097
Radek Krejci086c7132018-10-26 15:29:04 +02001098 uint8_t latest_revision:2; /**< flag to mark the latest available revision:
1099 1 - the latest revision in searchdirs was not searched yet and this is the
1100 latest revision in the current context
1101 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001102 const char *name; /**< name of the module (mandatory) */
1103 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1104 const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */
1105 const char *org; /**< party/company responsible for the module */
1106 const char *contact; /**< contact information for the module */
1107 const char *dsc; /**< description of the module */
1108 const char *ref; /**< cross-reference for the module */
Radek Krejci086c7132018-10-26 15:29:04 +02001109 uint8_t version; /**< yang-version (LYS_VERSION values) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001110};
1111
1112/**
Radek Krejci3f5e3db2018-10-11 15:57:47 +02001113 * @brief Free the printable YANG schema tree structure.
1114 *
1115 * @param[in] module Printable YANG schema tree structure to free.
1116 */
1117void lysp_module_free(struct lysp_module *module);
1118
1119/**
Radek Krejci535ea9f2020-05-29 16:01:05 +02001120 * @defgroup scflags Schema compile flags
1121 * @ingroup schematree
1122 *
1123 * @{
1124 */
1125#define LYSC_OPT_RPC_INPUT LYS_CONFIG_W /**< Internal option when compiling schema tree of RPC/action input */
1126#define LYSC_OPT_RPC_OUTPUT LYS_CONFIG_R /**< Internal option when compiling schema tree of RPC/action output */
1127#define LYSC_OPT_RPC_MASK LYS_CONFIG_MASK /**< mask for the internal RPC options */
1128#define LYSC_OPT_FREE_SP 0x04 /**< Free the input printable schema */
1129#define LYSC_OPT_INTERNAL 0x08 /**< Internal compilation caused by dependency */
1130#define LYSC_OPT_NOTIFICATION 0x10 /**< Internal option when compiling schema tree of Notification */
1131
1132#define LYSC_OPT_GROUPING 0x20 /** Compiling (validation) of a non-instantiated grouping.
1133 In this case not all the restrictions are checked since they can be valid only
1134 in the real placement of the grouping. TODO - what specifically is not done */
1135/** @} scflags */
1136
1137/**
Radek Krejci0e59c312019-08-15 15:34:15 +02001138 * @brief Compiled YANG extension-stmt
1139 */
1140struct lysc_ext {
1141 const char *name; /**< extension name */
1142 const char *argument; /**< argument name, NULL if not specified */
Radek Krejci0e59c312019-08-15 15:34:15 +02001143 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1144 struct lyext_plugin *plugin; /**< Plugin implementing the specific extension */
Radek Krejci0935f412019-08-20 16:15:18 +02001145 struct lys_module *module; /**< module structure */
Michal Vasko6f4cbb62020-02-28 11:15:47 +01001146 uint32_t refcount; /**< reference counter since extension definition is shared among all its instances */
Radek Krejci0e59c312019-08-15 15:34:15 +02001147 uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */
1148};
1149
1150/**
Radek Krejcice8c1592018-10-29 15:35:51 +01001151 * @brief YANG extension instance
1152 */
1153struct lysc_ext_instance {
Radek Krejciad5963b2019-09-06 16:03:05 +02001154 uint32_t insubstmt_index; /**< in case the instance is in a substatement that can appear multiple times,
1155 this identifies the index of the substatement for this extension instance */
Radek Krejci28681fa2019-09-06 13:08:45 +02001156 struct lys_module *module; /**< module where the extension instantiated is defined */
Radek Krejciad5963b2019-09-06 16:03:05 +02001157 struct lysc_ext *def; /**< pointer to the extension definition */
Radek Krejcice8c1592018-10-29 15:35:51 +01001158 void *parent; /**< pointer to the parent element holding the extension instance(s), use
1159 ::lysc_ext_instance#parent_type to access the schema element */
1160 const char *argument; /**< optional value of the extension's argument */
1161 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Radek Krejci2a408df2018-10-29 16:32:26 +01001162 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001163 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0e59c312019-08-15 15:34:15 +02001164 void *data; /**< private plugins's data, not used by libyang */
Radek Krejcice8c1592018-10-29 15:35:51 +01001165};
1166
1167/**
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001168 * @brief Compiled YANG if-feature-stmt
1169 */
1170struct lysc_iffeature {
1171 uint8_t *expr; /**< 2bits array describing the if-feature expression in prefix format, see @ref ifftokens */
1172 struct lysc_feature **features; /**< array of pointers to the features used in expression ([sized array](@ref sizedarrays)) */
1173};
1174
1175/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001176 * @brief YANG import-stmt
1177 */
1178struct lysc_import {
Radek Krejci6d6e4e42018-10-29 13:28:19 +01001179 struct lys_module *module; /**< link to the imported module */
Radek Krejci151a5b72018-10-19 14:21:44 +02001180 const char *prefix; /**< prefix for the data from the imported schema (mandatory) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001181 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +02001182};
1183
1184/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001185 * @brief YANG when-stmt
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001186 */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001187struct lysc_when {
Radek Krejcia0f704a2019-09-09 16:12:23 +02001188 struct lys_module *module; /**< module where the must was defined */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001189 struct lyxp_expr *cond; /**< XPath when condition */
Michal Vasko175012e2019-11-06 15:49:14 +01001190 struct lysc_node *context; /**< context node for evaluating the expression, NULL if the context is root node */
Radek Krejcic8b31002019-01-08 10:24:45 +01001191 const char *dsc; /**< description */
1192 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001193 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00b874b2019-02-12 10:54:50 +01001194 uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */
Michal Vaskoecd62de2019-11-13 12:35:11 +01001195 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS is allowed */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001196};
1197
1198/**
Radek Krejci2a408df2018-10-29 16:32:26 +01001199 * @brief YANG identity-stmt
1200 */
1201struct lysc_ident {
1202 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejcic8b31002019-01-08 10:24:45 +01001203 const char *dsc; /**< description */
1204 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001205 struct lys_module *module; /**< module structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001206 struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */
1207 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001208 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci2a408df2018-10-29 16:32:26 +01001209 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
1210};
1211
1212/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001213 * @brief YANG feature-stmt
1214 */
1215struct lysc_feature {
1216 const char *name; /**< feature name (mandatory) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001217 const char *dsc; /**< description */
1218 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001219 struct lys_module *module; /**< module structure */
Radek Krejci151a5b72018-10-19 14:21:44 +02001220 struct lysc_feature **depfeatures;/**< list of pointers to other features depending on this one ([sized array](@ref sizedarrays)) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001221 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001222 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001223 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* and
1224 #LYS_FENABLED values allowed */
1225};
1226
Radek Krejci151a5b72018-10-19 14:21:44 +02001227/**
1228 * @defgroup ifftokens if-feature expression tokens
1229 * Tokens of if-feature expression used in ::lysc_iffeature#expr
1230 *
1231 * @{
1232 */
1233#define LYS_IFF_NOT 0x00 /**< operand "not" */
1234#define LYS_IFF_AND 0x01 /**< operand "and" */
1235#define LYS_IFF_OR 0x02 /**< operand "or" */
1236#define LYS_IFF_F 0x03 /**< feature */
Radek Krejci2ff0d572020-05-21 15:27:28 +02001237/** @} ifftokens */
Radek Krejci151a5b72018-10-19 14:21:44 +02001238
1239/**
Radek Krejcib7db73a2018-10-24 14:18:40 +02001240 * @brief Compiled YANG revision statement
1241 */
1242struct lysc_revision {
1243 char date[LY_REV_SIZE]; /**< revision-date (mandatory) */
1244 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1245};
1246
Radek Krejci2167ee12018-11-02 16:09:07 +01001247struct lysc_range {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001248 struct lysc_range_part {
Radek Krejci693262f2019-04-29 15:23:20 +02001249 union { /**< min boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001250 int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1251 uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001252 };
Radek Krejci693262f2019-04-29 15:23:20 +02001253 union { /**< max boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001254 int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1255 uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001256 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001257 } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001258 const char *dsc; /**< description */
1259 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001260 const char *emsg; /**< error-message */
1261 const char *eapptag; /**< error-app-tag value */
1262 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1263};
1264
1265struct lysc_pattern {
Radek Krejci54579462019-04-30 12:47:06 +02001266 const char *expr; /**< original, not compiled, regular expression */
1267 pcre2_code *code; /**< compiled regular expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001268 const char *dsc; /**< description */
1269 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001270 const char *emsg; /**< error-message */
1271 const char *eapptag; /**< error-app-tag value */
1272 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci4586a022018-11-13 11:29:26 +01001273 uint32_t inverted:1; /**< invert-match flag */
1274 uint32_t refcount:31; /**< reference counter */
Radek Krejci2167ee12018-11-02 16:09:07 +01001275};
1276
1277struct lysc_must {
1278 struct lys_module *module; /**< module where the must was defined */
1279 struct lyxp_expr *cond; /**< XPath when condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001280 const char *dsc; /**< description */
1281 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001282 const char *emsg; /**< error-message */
1283 const char *eapptag; /**< error-app-tag value */
1284 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1285};
1286
1287struct lysc_type {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001288 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001289 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001290 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001291 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 +01001292 LY_DATA_TYPE basetype; /**< Base type of the type */
1293 uint32_t refcount; /**< reference counter for type sharing */
1294};
1295
1296struct lysc_type_num {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001297 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001298 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001299 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001300 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 +01001301 LY_DATA_TYPE basetype; /**< Base type of the type */
1302 uint32_t refcount; /**< reference counter for type sharing */
1303 struct lysc_range *range; /**< Optional range limitation */
1304};
1305
1306struct lysc_type_dec {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001307 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001308 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001309 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001310 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 +01001311 LY_DATA_TYPE basetype; /**< Base type of the type */
1312 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci6cba4292018-11-15 17:33:29 +01001313 uint8_t fraction_digits; /**< fraction digits specification */
Radek Krejci2167ee12018-11-02 16:09:07 +01001314 struct lysc_range *range; /**< Optional range limitation */
1315};
1316
1317struct lysc_type_str {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001318 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001319 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001320 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001321 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 +01001322 LY_DATA_TYPE basetype; /**< Base type of the type */
1323 uint32_t refcount; /**< reference counter for type sharing */
1324 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci4586a022018-11-13 11:29:26 +01001325 struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001326};
1327
Radek Krejci693262f2019-04-29 15:23:20 +02001328struct lysc_type_bitenum_item {
1329 const char *name; /**< enumeration identifier */
1330 const char *dsc; /**< description */
1331 const char *ref; /**< reference */
1332 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1333 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1334 union {
1335 int32_t value; /**< integer value associated with the enumeration */
1336 uint32_t position; /**< non-negative integer value associated with the bit */
1337 };
1338 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
1339 values are allowed */
1340};
1341
Radek Krejci2167ee12018-11-02 16:09:07 +01001342struct lysc_type_enum {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001343 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001344 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001345 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001346 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 +01001347 LY_DATA_TYPE basetype; /**< Base type of the type */
1348 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci693262f2019-04-29 15:23:20 +02001349 struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1350};
1351
1352struct lysc_type_bits {
1353 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1354 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001355 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001356 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 +02001357 LY_DATA_TYPE basetype; /**< Base type of the type */
1358 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci849a62a2019-05-22 15:29:05 +02001359 struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item),
1360 the items are ordered by their position value. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001361};
1362
1363struct lysc_type_leafref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001364 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001365 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001366 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001367 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 +01001368 LY_DATA_TYPE basetype; /**< Base type of the type */
1369 uint32_t refcount; /**< reference counter for type sharing */
Michal Vasko004d3152020-06-11 19:59:22 +02001370 struct lyxp_expr *path; /**< parsed target path, compiled path cannot be stored because of type sharing */
Radek Krejci96a0bfd2018-11-22 15:25:06 +01001371 struct lys_module *path_context; /**< module where the path is defined, so it provides context to resolve prefixes */
Radek Krejci412ddfa2018-11-23 11:44:11 +01001372 struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001373 uint8_t require_instance; /**< require-instance flag */
1374};
1375
1376struct lysc_type_identityref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001377 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001378 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001379 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001380 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 +01001381 LY_DATA_TYPE basetype; /**< Base type of the type */
1382 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci555cb5b2018-11-16 14:54:33 +01001383 struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)),
Radek Krejci2167ee12018-11-02 16:09:07 +01001384 mandatory (at least 1 item) */
1385};
1386
1387struct lysc_type_instanceid {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001388 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001389 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001390 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001391 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 +01001392 LY_DATA_TYPE basetype; /**< Base type of the type */
1393 uint32_t refcount; /**< reference counter for type sharing */
1394 uint8_t require_instance; /**< require-instance flag */
1395};
1396
Radek Krejci2167ee12018-11-02 16:09:07 +01001397struct lysc_type_union {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001398 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001399 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001400 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001401 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 +01001402 LY_DATA_TYPE basetype; /**< Base type of the type */
1403 uint32_t refcount; /**< reference counter for type sharing */
1404 struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1405};
1406
1407struct lysc_type_bin {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001408 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001409 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001410 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001411 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 +01001412 LY_DATA_TYPE basetype; /**< Base type of the type */
1413 uint32_t refcount; /**< reference counter for type sharing */
1414 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001415};
1416
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001417struct lysc_action_inout {
1418 struct lysc_node *data; /**< first child node (linked list) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001419 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1420};
1421
Radek Krejci056d0a82018-12-06 16:57:25 +01001422struct lysc_action {
Michal Vasko1bf09392020-03-27 12:38:10 +01001423 uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */
Radek Krejci056d0a82018-12-06 16:57:25 +01001424 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci95710c92019-02-11 15:49:55 +01001425 struct lys_module *module; /**< module structure */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001426 struct lysp_action *sp; /**< simply parsed (SP) original of the node, NULL if the SP schema was removed or in case of implicit case node. */
1427 struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */
1428
Radek Krejcifc11bd72019-04-11 16:00:05 +02001429 struct lysc_ext_instance *input_exts; /**< list of the extension instances of input ([sized array](@ref sizedarrays)) */
1430 struct lysc_ext_instance *output_exts; /**< list of the extension instances of outpu ([sized array](@ref sizedarrays)) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001431
Radek Krejci056d0a82018-12-06 16:57:25 +01001432 const char *name; /**< action/RPC name (mandatory) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001433 const char *dsc; /**< description */
1434 const char *ref; /**< reference */
1435
Radek Krejcifc11bd72019-04-11 16:00:05 +02001436 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1437 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1438
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001439 struct lysc_action_inout input; /**< RPC's/action's input */
1440 struct lysc_action_inout output; /**< RPC's/action's output */
1441
Radek Krejci056d0a82018-12-06 16:57:25 +01001442};
1443
1444struct lysc_notif {
1445 uint16_t nodetype; /**< LYS_NOTIF */
1446 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci95710c92019-02-11 15:49:55 +01001447 struct lys_module *module; /**< module structure */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001448 struct lysp_notif *sp; /**< simply parsed (SP) original of the node, NULL if the SP schema was removed or in case of implicit case node. */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001449 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1450
Radek Krejcifc11bd72019-04-11 16:00:05 +02001451 struct lysc_node *data; /**< first child node (linked list) */
1452 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1453
Radek Krejci056d0a82018-12-06 16:57:25 +01001454 const char *name; /**< Notification name (mandatory) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001455 const char *dsc; /**< description */
1456 const char *ref; /**< reference */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001457
1458 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1459 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001460};
1461
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001462/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001463 * @brief Compiled YANG data node
1464 */
1465struct lysc_node {
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001466 uint16_t nodetype; /**< type of the node (mandatory) */
1467 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001468 struct lys_module *module; /**< module structure */
Michal Vaskocc048b22020-03-27 15:52:38 +01001469 struct lysp_node *sp; /**< simply parsed (SP) original of the node, NULL if the SP schema was removed or
1470 in case of implicit case node. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001471 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1472 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1473 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1474 never NULL. If there is no sibling node, pointer points to the node
1475 itself. In case of the first node, this pointer points to the last
1476 node in the list. */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001477 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001478 const char *dsc; /**< description */
1479 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001480 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001481 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001482 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001483};
1484
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001485struct lysc_node_container {
1486 uint16_t nodetype; /**< LYS_CONTAINER */
1487 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1488 struct lys_module *module; /**< module structure */
1489 struct lysp_node *sp; /**< simply parsed (SP) original of the node, NULL if the SP schema was removed or in case of implicit case node. */
1490 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1491 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1492 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1493 never NULL. If there is no sibling node, pointer points to the node
1494 itself. In case of the first node, this pointer points to the last
1495 node in the list. */
1496 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001497 const char *dsc; /**< description */
1498 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001499 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001500 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001501 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001502
1503 struct lysc_node *child; /**< first child node (linked list) */
1504 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1505 struct lysc_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
1506 struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001507};
1508
Radek Krejcia3045382018-11-22 14:30:31 +01001509struct lysc_node_case {
Radek Krejci056d0a82018-12-06 16:57:25 +01001510 uint16_t nodetype; /**< LYS_CASE */
1511 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1512 struct lys_module *module; /**< module structure */
1513 struct lysp_node *sp; /**< simply parsed (SP) original of the node, NULL if the SP schema was removed or in case of implicit case node. */
1514 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1515 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1516 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1517 never NULL. If there is no sibling node, pointer points to the node
1518 itself. In case of the first node, this pointer points to the last
1519 node in the list. */
Radek Krejcia3045382018-11-22 14:30:31 +01001520 const char *name; /**< name of the case, including the implicit case */
Radek Krejci12fb9142019-01-08 09:45:30 +01001521 const char *dsc; /**< description */
1522 const char *ref; /**< reference */
Radek Krejci056d0a82018-12-06 16:57:25 +01001523 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001524 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001525 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001526
Radek Krejcia3045382018-11-22 14:30:31 +01001527 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 +01001528 each other as siblings with the parent pointer pointing to appropriate case node. */
Radek Krejcia3045382018-11-22 14:30:31 +01001529};
1530
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001531struct lysc_node_choice {
1532 uint16_t nodetype; /**< LYS_CHOICE */
1533 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1534 struct lys_module *module; /**< module structure */
1535 struct lysp_node *sp; /**< simply parsed (SP) original of the node, NULL if the SP schema was removed or in case of implicit case node. */
1536 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1537 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1538 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1539 never NULL. If there is no sibling node, pointer points to the node
1540 itself. In case of the first node, this pointer points to the last
1541 node in the list. */
1542 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001543 const char *dsc; /**< description */
1544 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001545 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001546 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001547 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001548
Radek Krejcia9026eb2018-12-12 16:04:47 +01001549 struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other
1550 as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the
1551 case is simple. */
Radek Krejci056d0a82018-12-06 16:57:25 +01001552 struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001553};
1554
1555struct lysc_node_leaf {
1556 uint16_t nodetype; /**< LYS_LEAF */
1557 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1558 struct lys_module *module; /**< module structure */
1559 struct lysp_node *sp; /**< simply parsed (SP) original of the node, NULL if the SP schema was removed or in case of implicit case node. */
1560 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1561 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1562 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1563 never NULL. If there is no sibling node, pointer points to the node
1564 itself. In case of the first node, this pointer points to the last
1565 node in the list. */
1566 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001567 const char *dsc; /**< description */
1568 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001569 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001570 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001571 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001572
1573 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1574 struct lysc_type *type; /**< type of the leaf node (mandatory) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001575
Radek Krejci4f28eda2018-11-12 11:46:16 +01001576 const char *units; /**< units of the leaf's type */
Radek Krejcia1911222019-07-22 17:24:50 +02001577 struct lyd_value *dflt; /**< default value */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001578 struct lys_module *dflt_mod; /**< module where the lysc_node_leaf::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001579};
1580
1581struct lysc_node_leaflist {
1582 uint16_t nodetype; /**< LYS_LEAFLIST */
1583 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1584 struct lys_module *module; /**< module structure */
1585 struct lysp_node *sp; /**< simply parsed (SP) original of the node, NULL if the SP schema was removed or in case of implicit case node. */
1586 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1587 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1588 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1589 never NULL. If there is no sibling node, pointer points to the node
1590 itself. In case of the first node, this pointer points to the last
1591 node in the list. */
1592 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001593 const char *dsc; /**< description */
1594 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001595 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001596 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001597 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001598
1599 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1600 struct lysc_type *type; /**< type of the leaf node (mandatory) */
1601
Radek Krejci0e5d8382018-11-28 16:37:53 +01001602 const char *units; /**< units of the leaf's type */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001603 struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */
1604 struct lys_module **dflts_mods; /**< list ([sized array](@ref sizedarrays)) of modules where the lysc_node_leaflist::dflts values were defined
1605 (needed to correctly map prefixes). */
Radek Krejci0e5d8382018-11-28 16:37:53 +01001606 uint32_t min; /**< min-elements constraint */
1607 uint32_t max; /**< max-elements constraint */
1608
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001609};
1610
1611struct lysc_node_list {
1612 uint16_t nodetype; /**< LYS_LIST */
1613 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1614 struct lys_module *module; /**< module structure */
1615 struct lysp_node *sp; /**< simply parsed (SP) original of the node, NULL if the SP schema was removed or in case of implicit case node. */
1616 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1617 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1618 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1619 never NULL. If there is no sibling node, pointer points to the node
1620 itself. In case of the first node, this pointer points to the last
1621 node in the list. */
1622 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001623 const char *dsc; /**< description */
1624 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001625 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001626 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001627 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001628
1629 struct lysc_node *child; /**< first child node (linked list) */
1630 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1631 struct lysc_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
1632 struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
1633
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001634 struct lysc_node_leaf ***uniques; /**< list of sized arrays of pointers to the unique nodes ([sized array](@ref sizedarrays)) */
1635 uint32_t min; /**< min-elements constraint */
1636 uint32_t max; /**< max-elements constraint */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001637};
1638
1639struct lysc_node_anydata {
1640 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1641 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1642 struct lys_module *module; /**< module structure */
1643 struct lysp_node *sp; /**< simply parsed (SP) original of the node, NULL if the SP schema was removed or in case of implicit case node. */
1644 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1645 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1646 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1647 never NULL. If there is no sibling node, pointer points to the node
1648 itself. In case of the first node, this pointer points to the last
1649 node in the list. */
1650 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001651 const char *dsc; /**< description */
1652 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001653 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001654 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001655 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci9800fb82018-12-13 14:26:23 +01001656
1657 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001658};
1659
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001660/**
1661 * @brief Compiled YANG schema tree structure representing YANG module.
1662 *
1663 * Semantically validated YANG schema tree for data tree parsing.
1664 * Contains only the necessary information for the data validation.
1665 */
1666struct lysc_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001667 struct lys_module *mod; /**< covering module structure */
Radek Krejci151a5b72018-10-19 14:21:44 +02001668 struct lysc_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001669
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001670 struct lysc_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
Radek Krejci2a408df2018-10-29 16:32:26 +01001671 struct lysc_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1672 struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */
1673 struct lysc_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */
1674 struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001675 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko57c10cd2020-05-27 15:57:11 +02001676 struct lys_module **deviated_by; /**< List of modules that deviate this module ([sized array](@ref sizedarrays)) */
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001677};
1678
1679/**
Radek Krejci53ea6152018-12-13 15:21:15 +01001680 * @brief Get the groupings sized array of the given (parsed) schema node.
1681 * Decides the node's type and in case it has a groupings array, returns it.
1682 * @param[in] node Node to examine.
1683 * @return The node's groupings sized array if any, NULL otherwise.
1684 */
1685const struct lysp_grp *lysp_node_groupings(const struct lysp_node *node);
1686
1687/**
Radek Krejci056d0a82018-12-06 16:57:25 +01001688 * @brief Get the typedefs sized array of the given (parsed) schema node.
1689 * Decides the node's type and in case it has a typedefs array, returns it.
1690 * @param[in] node Node to examine.
1691 * @return The node's typedefs sized array if any, NULL otherwise.
1692 */
1693const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
1694
1695/**
1696 * @brief Get the actions/RPCs sized array of the given (parsed) schema node.
1697 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1698 * @param[in] node Node to examine.
1699 * @return The node's actions/RPCs sized array if any, NULL otherwise.
1700 */
1701const struct lysp_action *lysp_node_actions(const struct lysp_node *node);
1702
1703/**
1704 * @brief Get the Notifications sized array of the given (parsed) schema node.
1705 * Decides the node's type and in case it has a Notifications array, returns it.
1706 * @param[in] node Node to examine.
1707 * @return The node's Notifications sized array if any, NULL otherwise.
1708 */
1709const struct lysp_notif *lysp_node_notifs(const struct lysp_node *node);
1710
1711/**
1712 * @brief Get the children linked list of the given (parsed) schema node.
1713 * Decides the node's type and in case it has a children list, returns it.
1714 * @param[in] node Node to examine.
1715 * @return The node's children linked list if any, NULL otherwise.
1716 */
1717const struct lysp_node *lysp_node_children(const struct lysp_node *node);
1718
1719/**
1720 * @brief Get the actions/RPCs sized array of the given (compiled) schema node.
1721 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1722 * @param[in] node Node to examine.
1723 * @return The node's actions/RPCs sized array if any, NULL otherwise.
1724 */
1725const struct lysc_action *lysc_node_actions(const struct lysc_node *node);
1726
1727/**
1728 * @brief Get the Notifications sized array of the given (compiled) schema node.
1729 * Decides the node's type and in case it has a Notifications array, returns it.
1730 * @param[in] node Node to examine.
1731 * @return The node's Notifications sized array if any, NULL otherwise.
1732 */
1733const struct lysc_notif *lysc_node_notifs(const struct lysc_node *node);
1734
1735/**
1736 * @brief Get the children linked list of the given (compiled) schema node.
1737 * Decides the node's type and in case it has a children list, returns it.
1738 * @param[in] node Node to examine.
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001739 * @param[in] flags Config flag to distinguish input (LYS_CONFIG_W) and output (LYS_CONFIG_R) data in case of RPC/action node.
Radek Krejci056d0a82018-12-06 16:57:25 +01001740 * @return The node's children linked list if any, NULL otherwise.
1741 */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001742const struct lysc_node *lysc_node_children(const struct lysc_node *node, uint16_t flags);
Radek Krejci056d0a82018-12-06 16:57:25 +01001743
1744/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001745 * @brief Get how the if-feature statement currently evaluates.
1746 *
1747 * @param[in] iff Compiled if-feature statement to evaluate.
Michal Vasko28d78432020-05-26 13:10:53 +02001748 * @return LY_SUCCESS if the statement evaluates to true,
1749 * @return LY_ENOT if it evaluates to false,
1750 * @return LY_ERR on error.
Radek Krejci151a5b72018-10-19 14:21:44 +02001751 */
Michal Vasko28d78432020-05-26 13:10:53 +02001752LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff);
Radek Krejci151a5b72018-10-19 14:21:44 +02001753
1754/**
1755 * @brief Get the current status of the provided feature.
1756 *
1757 * @param[in] feature Compiled feature statement to examine.
Michal Vasko28d78432020-05-26 13:10:53 +02001758 * @return LY_SUCCESS if feature is enabled,
1759 * @return LY_ENOT if feature is disabled,
1760 * @return LY_ERR in case of error (invalid argument)
Radek Krejci151a5b72018-10-19 14:21:44 +02001761 */
Michal Vasko28d78432020-05-26 13:10:53 +02001762LY_ERR lysc_feature_value(const struct lysc_feature *feature);
Radek Krejci151a5b72018-10-19 14:21:44 +02001763
1764/**
Michal Vasko519fd602020-05-26 12:17:39 +02001765 * @brief Get all the schema nodes (atoms) that are required for \p xpath to be evaluated.
1766 *
1767 * @param[in] ctx_node XPath schema context node.
1768 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LYD_JSON format is expected.
1769 * @param[in] options Whether to apply some node access restrictions, one of the options should always be used.
1770 * If none is set, ::LYXP_SCNODE is used.
1771 * @param[out] set Set of found atoms (schema nodes).
1772 * @return LY_SUCCESS on success, @p set is returned.
1773 * @return LY_ERR value if an error occurred.
1774 */
1775LY_ERR lys_atomize_xpath(const struct lysc_node *ctx_node, const char *xpath, int options, struct ly_set **set);
1776
1777#define LYXP_SCNODE 0x02 /**< No special tree access modifiers. */
1778#define LYXP_SCNODE_SCHEMA 0x04 /**< Apply node access restrictions defined for 'when' and 'must' evaluation. */
1779#define LYXP_SCNODE_OUTPUT 0x08 /**< Search RPC/action output nodes instead of input ones. */
1780
1781/**
Michal Vasko03ff5a72019-09-11 13:49:33 +02001782 * @brief Types of the different schema paths.
1783 */
1784typedef enum {
1785 LYSC_PATH_LOG /**< Descriptive path format used in log messages */
1786} LYSC_PATH_TYPE;
1787
1788/**
Radek Krejci327de162019-06-14 12:52:07 +02001789 * @brief Generate path of the given node in the requested format.
1790 *
1791 * @param[in] node Schema path of this node will be generated.
1792 * @param[in] pathtype Format of the path to generate.
Radek Krejci1c0c3442019-07-23 16:08:47 +02001793 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
1794 * If NULL, memory for the complete path is allocated.
1795 * @param[in] buflen Size of the provided @p buffer.
Radek Krejci327de162019-06-14 12:52:07 +02001796 * @return NULL in case of memory allocation error, path of the node otherwise.
Radek Krejci1c0c3442019-07-23 16:08:47 +02001797 * 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 +02001798 */
Michal Vasko03ff5a72019-09-11 13:49:33 +02001799char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
Radek Krejci327de162019-06-14 12:52:07 +02001800
1801/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001802 * @brief Available YANG schema tree structures representing YANG module.
1803 */
1804struct lys_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001805 struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */
1806 const char *name; /**< name of the module (mandatory) */
Radek Krejci0af46292019-01-11 16:02:31 +01001807 const char *revision; /**< revision of the module (if present) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001808 const char *ns; /**< namespace of the module (module - mandatory) */
1809 const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */
1810 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1811 const char *org; /**< party/company responsible for the module */
1812 const char *contact; /**< contact information for the module */
1813 const char *dsc; /**< description of the module */
1814 const char *ref; /**< cross-reference for the module */
1815
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001816 struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */
Radek Krejci0af46292019-01-11 16:02:31 +01001817 struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing.
1818 Available only for implemented modules. */
1819 struct lysc_feature *off_features;/**< List of pre-compiled features of the module in non implemented modules ([sized array](@ref sizedarrays)).
1820 These features are always disabled and cannot be enabled until the module
1821 become implemented. The features are present in this form to allow their linkage
1822 from if-feature statements of the compiled schemas and their proper use in case
1823 the module became implemented in future (no matter if implicitly via augment/deviate
1824 or explicitly via ly_ctx_module_implement()). */
Radek Krejci95710c92019-02-11 15:49:55 +01001825 uint8_t implemented; /**< flag if the module is implemented, not just imported. The module is implemented if
1826 the flag has non-zero value. Specific values are used internally:
1827 1 - implemented module
1828 2 - recently implemented module by dependency, it can be reverted in rollback procedure */
1829 uint8_t latest_revision; /**< flag to mark the latest available revision:
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001830 1 - the latest revision in searchdirs was not searched yet and this is the
1831 latest revision in the current context
1832 2 - searchdirs were searched and this is the latest available revision */
1833 uint8_t version; /**< yang-version (LYS_VERSION values) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001834};
1835
Radek Krejci151a5b72018-10-19 14:21:44 +02001836/**
1837 * @brief Enable specified feature in the module
1838 *
1839 * By default, when the module is loaded by libyang parser, all features are disabled.
1840 *
Radek Krejcica3db002018-11-01 10:31:01 +01001841 * If all features are being enabled, it must be possible respecting their if-feature conditions. For example,
1842 * enabling all features on the following feature set will fail since it is not possible to enable both features
1843 * (and it is unclear which of them should be enabled then). In this case the LY_EDENIED is returned and the feature
1844 * is untouched.
1845 *
1846 * feature f1;
1847 * feature f2 { if-feature 'not f1';}
1848 *
Radek Krejci151a5b72018-10-19 14:21:44 +02001849 * @param[in] module Module where the feature will be enabled.
1850 * @param[in] feature Name of the feature to enable. To enable all features at once, use asterisk (`*`) character.
1851 * @return LY_ERR value.
1852 */
Radek Krejcied5acc52019-04-25 15:57:04 +02001853LY_ERR lys_feature_enable(const struct lys_module *module, const char *feature);
Radek Krejci151a5b72018-10-19 14:21:44 +02001854
1855/**
1856 * @brief Disable specified feature in the module
1857 *
1858 * By default, when the module is loaded by libyang parser, all features are disabled.
1859 *
1860 * @param[in] module Module where the feature will be disabled.
1861 * @param[in] feature Name of the feature to disable. To disable all features at once, use asterisk (`*`) character.
1862 * @return LY_ERR value
1863 */
Radek Krejcied5acc52019-04-25 15:57:04 +02001864LY_ERR lys_feature_disable(const struct lys_module *module, const char *feature);
Radek Krejci151a5b72018-10-19 14:21:44 +02001865
1866/**
1867 * @brief Get the current status of the specified feature in the module.
1868 *
1869 * @param[in] module Module where the feature is defined.
1870 * @param[in] feature Name of the feature to inspect.
1871 * @return
1872 * - 1 if feature is enabled,
1873 * - 0 if feature is disabled,
1874 * - -1 in case of error (e.g. feature is not defined or invalid arguments)
1875 */
1876int lys_feature_value(const struct lys_module *module, const char *feature);
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001877
1878/**
Radek Krejci86d106e2018-10-18 09:53:19 +02001879 * @brief Load a schema into the specified context.
1880 *
1881 * @param[in] ctx libyang context where to process the data model.
1882 * @param[in] data The string containing the dumped data model in the specified
1883 * format.
1884 * @param[in] format Format of the input data (YANG or YIN).
1885 * @return Pointer to the data model structure or NULL on error.
1886 */
Radek Krejcid14e9692018-11-01 11:00:37 +01001887struct lys_module *lys_parse_mem(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format);
Radek Krejci86d106e2018-10-18 09:53:19 +02001888
1889/**
1890 * @brief Read a schema from file descriptor into the specified context.
1891 *
1892 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
1893 *
1894 * @param[in] ctx libyang context where to process the data model.
1895 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
1896 * in the specified format.
1897 * @param[in] format Format of the input data (YANG or YIN).
1898 * @return Pointer to the data model structure or NULL on error.
1899 */
Radek Krejcid14e9692018-11-01 11:00:37 +01001900struct lys_module *lys_parse_fd(struct ly_ctx *ctx, int fd, LYS_INFORMAT format);
Radek Krejci86d106e2018-10-18 09:53:19 +02001901
1902/**
Radek Krejcid33273d2018-10-25 14:55:52 +02001903 * @brief Read a schema into the specified context from a file.
Radek Krejci86d106e2018-10-18 09:53:19 +02001904 *
1905 * @param[in] ctx libyang context where to process the data model.
1906 * @param[in] path Path to the file with the model in the specified format.
1907 * @param[in] format Format of the input data (YANG or YIN).
1908 * @return Pointer to the data model structure or NULL on error.
1909 */
Radek Krejcid14e9692018-11-01 11:00:37 +01001910struct lys_module *lys_parse_path(struct ly_ctx *ctx, const char *path, LYS_INFORMAT format);
Radek Krejci86d106e2018-10-18 09:53:19 +02001911
1912/**
Radek Krejcid33273d2018-10-25 14:55:52 +02001913 * @brief Search for the schema file in the specified searchpaths.
1914 *
1915 * @param[in] searchpaths NULL-terminated array of paths to be searched (recursively). Current working
1916 * directory is searched automatically (but non-recursively if not in the provided list). Caller can use
1917 * result of the ly_ctx_get_searchdirs().
1918 * @param[in] cwd Flag to implicitly search also in the current working directory (non-recursively).
1919 * @param[in] name Name of the schema to find.
1920 * @param[in] revision Revision of the schema to find. If NULL, the newest found schema filepath is returned.
1921 * @param[out] localfile Mandatory output variable containing absolute path of the found schema. If no schema
1922 * complying the provided restriction is found, NULL is set.
1923 * @param[out] format Optional output variable containing expected format of the schema document according to the
1924 * file suffix.
1925 * @return LY_ERR value (LY_SUCCESS is returned even if the file is not found, then the *localfile is NULL).
1926 */
1927LY_ERR lys_search_localfile(const char * const *searchpaths, int cwd, const char *name, const char *revision, char **localfile, LYS_INFORMAT *format);
1928
1929/**
Radek Krejcia3045382018-11-22 14:30:31 +01001930 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can
1931 * be from an augment.
1932 *
1933 * lys_getnext() is supposed to be called sequentially. In the first call, the \p last parameter is usually NULL
1934 * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module.
1935 * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
1936 * \p parent and \p module parameters.
1937 *
1938 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
1939 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
1940 * all the schema nodes are iteratively returned.
1941 *
1942 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
1943 * @param[in] parent Parent of the subtree where the function starts processing.
1944 * @param[in] module In case of iterating on top level elements, the \p parent is NULL and
1945 * module must be specified.
1946 * @param[in] options [ORed options](@ref sgetnextflags).
1947 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
1948 */
1949const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
1950 const struct lysc_module *module, int options);
1951
1952/**
1953 * @defgroup sgetnextflags lys_getnext() flags
Radek Krejcia3045382018-11-22 14:30:31 +01001954 * @{
1955 */
1956#define LYS_GETNEXT_WITHCHOICE 0x01 /**< lys_getnext() option to allow returning #LYS_CHOICE nodes instead of looking into them */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001957#define LYS_GETNEXT_NOCHOICE 0x02 /**< lys_getnext() option to ignore (kind of conditional) nodes within choice node */
Radek Krejci056d0a82018-12-06 16:57:25 +01001958#define LYS_GETNEXT_WITHCASE 0x04 /**< lys_getnext() option to allow returning #LYS_CASE nodes instead of looking into them */
Radek Krejcia3045382018-11-22 14:30:31 +01001959#define LYS_GETNEXT_INTONPCONT 0x40 /**< lys_getnext() option to look into non-presence container, instead of returning container itself */
1960#define LYS_GETNEXT_NOSTATECHECK 0x100 /**< lys_getnext() option to skip checking module validity (import-only, disabled) and
1961 relevant if-feature conditions state */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001962#define LYS_GETNEXT_OUTPUT 0x200 /**< lys_getnext() option to provide RPC's/action's output schema nodes instead of input schema nodes
1963 provided by default */
Radek Krejcia3045382018-11-22 14:30:31 +01001964/** @} sgetnextflags */
1965
1966/**
1967 * @brief Get child node according to the specified criteria.
1968 *
1969 * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched.
1970 * @param[in] module module of the node to find. It is also limitation for the children node of the given parent.
1971 * @param[in] name Name of the node to find.
1972 * @param[in] name_len Optional length of the name in case it is not NULL-terminated string.
1973 * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find.
1974 * Used as a bitmask, so multiple nodetypes can be specified.
1975 * @param[in] options [ORed options](@ref sgetnextflags).
1976 * @return Found node if any.
1977 */
Michal Vaskoe444f752020-02-10 12:20:06 +01001978const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module,
1979 const char *name, size_t name_len, uint16_t nodetype, int options);
Radek Krejcia3045382018-11-22 14:30:31 +01001980
1981/**
Radek Krejci09e8d0a2019-11-17 12:14:15 +08001982 * @brief Get schema node specified by the schema path.
1983 *
1984 * In case the @p qpath uses prefixes (from imports or of the schema itself), the @p context_node must be specified
1985 * even if the path is absolute. In case the @p context_node is not provided, the names of the schemas are expected as the
1986 * node's prefixes in the @qpath. It also means that the relative paths are accepted only with the schema prefixes,
1987 * not the full names.
1988 *
1989 * @param[in] ctx libyang context for logging and getting the correct schema if @p contet_node not provided.
1990 * @param[in] context_node Context node for relative paths and/or as a source of the context module to resolve node's
1991 * prefixes in @qpath.
1992 * @param[in] qpath Schema path to be resolved. Not prefixed nodes inherits the prefix from its parent nodes. It means
1993 * that the first node in the path must be prefixed. Both, import prefixes as well as full schema names are accepted as
1994 * prefixes according to the @p context_node parameter presence.
1995 * @return NULL in case of invalid path.
1996 * @return found schema node.
1997 */
1998const struct lysc_node *lys_find_node(struct ly_ctx *ctx, const struct lysc_node *context_node, const char *qpath);
1999
2000/**
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002001 * @brief Make the specific module implemented.
2002 *
2003 * @param[in] mod Module to make implemented. It is not an error
2004 * to provide already implemented module, it just does nothing.
Michal Vaskoe444f752020-02-10 12:20:06 +01002005 * @return LY_SUCCESS on success.
2006 * @return LY_EDENIED in case the context contains some other revision of the same module which is already implemented.
Radek Krejci77a8bcd2019-09-11 11:20:02 +02002007 */
2008LY_ERR lys_set_implemented(struct lys_module *mod);
2009
2010/**
Radek Krejcia3045382018-11-22 14:30:31 +01002011 * @brief Check if the schema node is disabled in the schema tree, i.e. there is any disabled if-feature statement
2012 * affecting the node.
2013 *
2014 * @param[in] node Schema node to check.
2015 * @param[in] recursive - 0 to check if-feature only in the \p node schema node,
2016 * - 1 to check if-feature in all ascendant schema nodes until there is a node possibly having an instance in a data tree
Michal Vaskoe444f752020-02-10 12:20:06 +01002017 * @return NULL if enabled,
Michal Vaskoc193ce92020-03-06 11:04:48 +01002018 * @return pointer to the node with the unsatisfied (disabled) if-feature expression.
Radek Krejcia3045382018-11-22 14:30:31 +01002019 */
Michal Vaskoc193ce92020-03-06 11:04:48 +01002020const struct lysc_node *lysc_node_is_disabled(const struct lysc_node *node, int recursive);
Radek Krejcia3045382018-11-22 14:30:31 +01002021
Radek Krejci084289f2019-07-09 17:35:30 +02002022/**
2023 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
2024 *
2025 * This function check just the type's restriction, if you want to check also the data tree context (e.g. in case of
2026 * require-instance restriction), use lyd_value_validate().
2027 *
2028 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
2029 * @param[in] node Schema node for the @p value.
2030 * @param[in] value String value to be checked.
2031 * @param[in] value_len Length of the given @p value (mandatory).
2032 * @param[in] get_prefix Callback function to resolve prefixes used in the @p value string.
2033 * @param[in] get_prefix_data Private data for the @p get_prefix callback.
2034 * @param[in] format Input format of the @p value.
2035 * @return LY_SUCCESS on success
2036 * @return LY_ERR value if an error occurred.
2037 */
Michal Vasko44685da2020-03-17 15:38:06 +01002038LY_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 +02002039 ly_clb_resolve_prefix get_prefix, void *get_prefix_data, LYD_FORMAT format);
2040
Radek Krejci0935f412019-08-20 16:15:18 +02002041/**
2042 * @brief Stringify schema nodetype.
2043 * @param[in] nodetype Nodetype to stringify.
2044 * @return Constant string with the name of the node's type.
2045 */
2046const char *lys_nodetype2str(uint16_t nodetype);
2047
Radek Krejci2ff0d572020-05-21 15:27:28 +02002048/** @} schematree */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002049
Radek Krejci70853c52018-10-15 14:46:16 +02002050#ifdef __cplusplus
2051}
2052#endif
2053
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002054#endif /* LY_TREE_SCHEMA_H_ */