blob: fe84d175cec2ac7c3d325e5a59f02f3fac40e10d [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 Krejci5aeea3a2018-09-05 13:29:36 +020021#include <stdint.h>
Radek Krejcid3ca0632019-04-16 16:54:54 +020022#include <stdio.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020023
Radek Krejcie7b95092019-05-15 11:03:07 +020024#include "log.h"
25#include "tree.h"
Radek Krejci084289f2019-07-09 17:35:30 +020026#include "tree_data.h"
Radek Krejcice8c1592018-10-29 15:35:51 +010027
Radek Krejcie7b95092019-05-15 11:03:07 +020028struct ly_ctx;
29
Radek Krejci70853c52018-10-15 14:46:16 +020030#ifdef __cplusplus
31extern "C" {
32#endif
33
Radek Krejci5aeea3a2018-09-05 13:29:36 +020034/**
Radek Krejci0935f412019-08-20 16:15:18 +020035 * @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 +020036 * (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 +020037 *
38 * The function follows deep-first search algorithm:
39 * <pre>
40 * 1
41 * / \
42 * 2 4
43 * / / \
44 * 3 5 6
45 * </pre>
46 *
47 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
48 * START can be any of the lysc_node* types (including lysc_action and lysc_notif),
49 * ELEM variable must be of the struct lysc_node* type.
50 *
51 * To skip a particular subtree, instead of the continue statement, set LYSC_TREE_DFS_continue
52 * variable to non-zero value.
53 *
54 * Use with opening curly bracket '{' after the macro.
55 *
56 * @param START Pointer to the starting element processed first.
57 * @param ELEM Iterator intended for use in the block.
58 */
59#define LYSC_TREE_DFS_BEGIN(START, ELEM) \
60 { int LYSC_TREE_DFS_continue = 0; struct lysc_node *LYSC_TREE_DFS_next; \
61 for ((ELEM) = (LYSC_TREE_DFS_next) = (START); \
62 (ELEM); \
63 (ELEM) = (LYSC_TREE_DFS_next), LYSC_TREE_DFS_continue = 0)
64
65/**
66 * @brief Macro to iterate via all elements in a (sub)tree. This is the closing part
67 * to the #LYSC_TREE_DFS_BEGIN - they always have to be used together.
68 *
69 * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While
70 * START can be a pointer to any of the lysc_node* types (including lysc_action and lysc_notif),
71 * ELEM variable must be pointer to the lysc_node type.
72 *
73 * Use with closing curly bracket '}' after the macro.
74 *
75 * @param START Pointer to the starting element processed first.
76 * @param ELEM Iterator intended for use in the block.
77 */
78
79#define LYSC_TREE_DFS_END(START, ELEM) \
80 /* select element for the next run - children first */ \
81 if (LYSC_TREE_DFS_continue) { \
82 (LYSC_TREE_DFS_next) = NULL; \
83 } else { \
84 (LYSC_TREE_DFS_next) = (struct lysc_node*)lysc_node_children(ELEM, 0); \
85 }\
86 if (!(LYSC_TREE_DFS_next)) { \
87 /* in case of RPC/action, get also the output children */ \
88 if (!LYSC_TREE_DFS_continue && (ELEM)->nodetype == LYS_ACTION) { \
89 (LYSC_TREE_DFS_next) = (struct lysc_node*)lysc_node_children(ELEM, LYS_CONFIG_R); \
90 } \
91 if (!(LYSC_TREE_DFS_next)) { \
92 /* no children */ \
93 if ((ELEM) == (struct lysc_node*)(START)) { \
94 /* we are done, (START) has no children */ \
95 break; \
96 } \
97 /* try siblings */ \
98 (LYSC_TREE_DFS_next) = (ELEM)->next; \
99 } \
100 } \
101 while (!(LYSC_TREE_DFS_next)) { \
102 /* parent is already processed, go to its sibling */ \
103 (ELEM) = (ELEM)->parent; \
104 /* no siblings, go back through parents */ \
105 if ((ELEM) == (struct lysc_node*)(START)) { \
106 /* we are done, no next element to process */ \
107 break; \
108 } \
109 if ((ELEM)->nodetype == LYS_ACTION) { \
110 /* there is actually next node as a child of action's output */ \
111 (LYSC_TREE_DFS_next) = (struct lysc_node*)lysc_node_children(ELEM, LYS_CONFIG_R); \
112 } \
113 if (!(LYSC_TREE_DFS_next)) { \
114 (LYSC_TREE_DFS_next) = (ELEM)->next; \
115 } \
116 } } \
117
118/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200119 * @brief Schema input formats accepted by libyang [parser functions](@ref howtoschemasparsers).
120 */
121typedef enum {
122 LYS_IN_UNKNOWN = 0, /**< unknown format, used as return value in case of error */
123 LYS_IN_YANG = 1, /**< YANG schema input format */
Radek Krejci693262f2019-04-29 15:23:20 +0200124 LYS_IN_YIN = 3 /**< YIN schema input format */
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200125} LYS_INFORMAT;
126
127/**
128 * @brief Schema output formats accepted by libyang [printer functions](@ref howtoschemasprinters).
129 */
130typedef enum {
131 LYS_OUT_UNKNOWN = 0, /**< unknown format, used as return value in case of error */
132 LYS_OUT_YANG = 1, /**< YANG schema output format */
Radek Krejci693262f2019-04-29 15:23:20 +0200133 LYS_OUT_YIN = 3, /**< YIN schema output format */
134 LYS_OUT_YANG_COMPILED = 2, /**< YANG schema output format of the compiled schema tree */
Radek Krejcid3ca0632019-04-16 16:54:54 +0200135
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200136 LYS_OUT_TREE, /**< Tree schema output format, for more information see the [printers](@ref howtoschemasprinters) page */
137 LYS_OUT_INFO, /**< Info schema output format, for more information see the [printers](@ref howtoschemasprinters) page */
138 LYS_OUT_JSON, /**< JSON schema output format, reflecting YIN format with conversion of attributes to object's members */
139} LYS_OUTFORMAT;
140
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200141#define LY_REV_SIZE 11 /**< revision data string length (including terminating NULL byte) */
142
Michal Vaskob55f6c12018-09-12 11:13:15 +0200143#define LYS_UNKNOWN 0x0000 /**< uninitalized unknown statement node */
144#define LYS_CONTAINER 0x0001 /**< container statement node */
145#define LYS_CHOICE 0x0002 /**< choice statement node */
146#define LYS_LEAF 0x0004 /**< leaf statement node */
147#define LYS_LEAFLIST 0x0008 /**< leaf-list statement node */
148#define LYS_LIST 0x0010 /**< list statement node */
149#define LYS_ANYXML 0x0020 /**< anyxml statement node */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200150#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 +0200151
Radek Krejcie7b95092019-05-15 11:03:07 +0200152#define LYS_ACTION 0x400 /**< RPC or action */
Radek Krejcif3b6fec2019-07-24 15:53:11 +0200153#define LYS_RPC LYS_ACTION /**< RPC or action (for backward compatibility) */
Radek Krejcie7b95092019-05-15 11:03:07 +0200154#define LYS_NOTIF 0x800
155
Radek Krejcia3045382018-11-22 14:30:31 +0100156#define LYS_CASE 0x0040 /**< case statement node */
157#define LYS_USES 0x0080 /**< uses statement node */
Radek Krejcid3ca0632019-04-16 16:54:54 +0200158#define LYS_INPUT 0x100
159#define LYS_OUTPUT 0x200
160#define LYS_INOUT 0x300
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100161#define LYS_GROUPING 0x1000
162#define LYS_AUGMENT 0x2000
163
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200164/**
Radek Krejcid6b76452019-09-03 17:03:03 +0200165 * @brief List of YANG statements
166 */
167enum ly_stmt {
168 LY_STMT_NONE = 0,
Radek Krejciad5963b2019-09-06 16:03:05 +0200169 LY_STMT_STATUS, /**< in lysc_ext_substmt::storage stored as a pointer to `uint16_t`, only cardinality < #LY_STMT_CARD_SOME is allowed */
170 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 +0200171 LY_STMT_MANDATORY,
Radek Krejciad5963b2019-09-06 16:03:05 +0200172 LY_STMT_UNITS, /**< in lysc_ext_substmt::storage stored as a pointer to `const char *` (cardinality < #LY_STMT_CARD_SOME)
173 or as a pointer to a [sized array](@ref sizedarrays) `const char **` */
Radek Krejci335332a2019-09-05 13:03:35 +0200174 LY_STMT_DEFAULT,
Radek Krejciad5963b2019-09-06 16:03:05 +0200175 LY_STMT_TYPE, /**< in lysc_ext_substmt::storage stored as a pointer to `struct lysc_type *` (cardinality < #LY_STMT_CARD_SOME)
176 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_type **` */
Radek Krejci335332a2019-09-05 13:03:35 +0200177
Radek Krejcid6b76452019-09-03 17:03:03 +0200178 LY_STMT_ACTION,
179 LY_STMT_ANYDATA,
180 LY_STMT_ANYXML,
181 LY_STMT_ARGUMENT,
182 LY_STMT_AUGMENT,
183 LY_STMT_BASE,
184 LY_STMT_BELONGS_TO,
185 LY_STMT_BIT,
186 LY_STMT_CASE,
187 LY_STMT_CHOICE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200188 LY_STMT_CONTACT,
189 LY_STMT_CONTAINER,
Radek Krejcid6b76452019-09-03 17:03:03 +0200190 LY_STMT_DESCRIPTION,
191 LY_STMT_DEVIATE,
192 LY_STMT_DEVIATION,
193 LY_STMT_ENUM,
194 LY_STMT_ERROR_APP_TAG,
195 LY_STMT_ERROR_MESSAGE,
196 LY_STMT_EXTENSION,
197 LY_STMT_FEATURE,
198 LY_STMT_FRACTION_DIGITS,
199 LY_STMT_GROUPING,
200 LY_STMT_IDENTITY,
Radek Krejciad5963b2019-09-06 16:03:05 +0200201 LY_STMT_IF_FEATURE, /**< in lysc_ext_substmt::storage stored as a pointer to `struct lysc_iffeature` (cardinality < #LY_STMT_CARD_SOME)
202 or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_iffeature *` */
Radek Krejcid6b76452019-09-03 17:03:03 +0200203 LY_STMT_IMPORT,
204 LY_STMT_INCLUDE,
205 LY_STMT_INPUT,
206 LY_STMT_KEY,
207 LY_STMT_LEAF,
208 LY_STMT_LEAF_LIST,
209 LY_STMT_LENGTH,
210 LY_STMT_LIST,
Radek Krejcid6b76452019-09-03 17:03:03 +0200211 LY_STMT_MAX_ELEMENTS,
212 LY_STMT_MIN_ELEMENTS,
213 LY_STMT_MODIFIER,
214 LY_STMT_MODULE,
215 LY_STMT_MUST,
216 LY_STMT_NAMESPACE,
217 LY_STMT_NOTIFICATION,
218 LY_STMT_ORDERED_BY,
219 LY_STMT_ORGANIZATION,
220 LY_STMT_OUTPUT,
221 LY_STMT_PATH,
222 LY_STMT_PATTERN,
223 LY_STMT_POSITION,
224 LY_STMT_PREFIX,
225 LY_STMT_PRESENCE,
226 LY_STMT_RANGE,
227 LY_STMT_REFERENCE,
228 LY_STMT_REFINE,
229 LY_STMT_REQUIRE_INSTANCE,
230 LY_STMT_REVISION,
231 LY_STMT_REVISION_DATE,
232 LY_STMT_RPC,
Radek Krejcid6b76452019-09-03 17:03:03 +0200233 LY_STMT_SUBMODULE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200234 LY_STMT_TYPEDEF,
235 LY_STMT_UNIQUE,
Radek Krejcid6b76452019-09-03 17:03:03 +0200236 LY_STMT_USES,
237 LY_STMT_VALUE,
238 LY_STMT_WHEN,
239 LY_STMT_YANG_VERSION,
240 LY_STMT_YIN_ELEMENT,
241 LY_STMT_EXTENSION_INSTANCE,
242
243 LY_STMT_SYNTAX_SEMICOLON,
244 LY_STMT_SYNTAX_LEFT_BRACE,
245 LY_STMT_SYNTAX_RIGHT_BRACE,
246
247 LY_STMT_ARG_TEXT,
248 LY_STMT_ARG_VALUE
249};
250
251/**
Radek Krejci0e59c312019-08-15 15:34:15 +0200252 * @brief Extension instance structure parent enumeration
253 */
254typedef enum {
Radek Krejci0935f412019-08-20 16:15:18 +0200255 LYEXT_PAR_MODULE, /**< ::lysc_module */
256 LYEXT_PAR_NODE, /**< ::lysc_node (and the derived structures including ::lysc_action and ::lysc_notif) */
257 LYEXT_PAR_INPUT, /**< ::lysc_action_inout */
258 LYEXT_PAR_OUTPUT, /**< ::lysc_action_inout */
259 LYEXT_PAR_TYPE, /**< ::lysc_type */
260 LYEXT_PAR_TYPE_BIT, /**< ::lysc_type_bitenum_item */
261 LYEXT_PAR_TYPE_ENUM, /**< ::lysc_type_bitenum_item */
262 LYEXT_PAR_FEATURE, /**< ::lysc_feature */
263 LYEXT_PAR_MUST, /**< ::lysc_must */
264 LYEXT_PAR_PATTERN, /**< ::lysc_pattern */
265 LYEXT_PAR_LENGTH, /**< ::lysc_range */
266 LYEXT_PAR_RANGE, /**< ::lysc_range */
267 LYEXT_PAR_WHEN, /**< ::lysc_when */
268 LYEXT_PAR_IDENT, /**< ::lysc_ident */
269 LYEXT_PAR_EXT, /**< ::lysc_ext */
270 LYEXT_PAR_IMPORT, /**< ::lysc_import */
271// LYEXT_PAR_TPDF, /**< ::lysp_tpdf */
272// LYEXT_PAR_EXTINST, /**< ::lysp_ext_instance */
273// LYEXT_PAR_REFINE, /**< ::lysp_refine */
274// LYEXT_PAR_DEVIATION, /**< ::lysp_deviation */
275// LYEXT_PAR_DEVIATE, /**< ::lysp_deviate */
276// LYEXT_PAR_INCLUDE, /**< ::lysp_include */
277// LYEXT_PAR_REVISION, /**< ::lysp_revision */
Radek Krejci0e59c312019-08-15 15:34:15 +0200278} LYEXT_PARENT;
279
280/**
Radek Krejci0935f412019-08-20 16:15:18 +0200281 * @brief Stringify extension instance parent type.
282 * @param[in] type Parent type to stringify.
283 * @return Constant string with the name of the parent statement.
284 */
285const char *lyext_parent2str(LYEXT_PARENT type);
286
287/**
Radek Krejci0e59c312019-08-15 15:34:15 +0200288 * @brief Enum of substatements in which extension instances can appear.
289 */
290typedef enum {
291 LYEXT_SUBSTMT_SELF = 0, /**< extension of the structure itself, not substatement's */
292 LYEXT_SUBSTMT_ARGUMENT, /**< extension of the argument statement, can appear in lys_ext */
293 LYEXT_SUBSTMT_BASE, /**< extension of the base statement, can appear (repeatedly) in lys_type and lys_ident */
294 LYEXT_SUBSTMT_BELONGSTO, /**< extension of the belongs-to statement, can appear in lys_submodule */
295 LYEXT_SUBSTMT_CONTACT, /**< extension of the contact statement, can appear in lys_module */
296 LYEXT_SUBSTMT_DEFAULT, /**< extension of the default statement, can appear in lys_node_leaf, lys_node_leaflist,
297 lys_node_choice and lys_deviate */
298 LYEXT_SUBSTMT_DESCRIPTION, /**< extension of the description statement, can appear in lys_module, lys_submodule,
299 lys_node, lys_import, lys_include, lys_ext, lys_feature, lys_tpdf, lys_restr,
300 lys_ident, lys_deviation, lys_type_enum, lys_type_bit, lys_when and lys_revision */
301 LYEXT_SUBSTMT_ERRTAG, /**< extension of the error-app-tag statement, can appear in lys_restr */
302 LYEXT_SUBSTMT_ERRMSG, /**< extension of the error-message statement, can appear in lys_restr */
303 LYEXT_SUBSTMT_KEY, /**< extension of the key statement, can appear in lys_node_list */
304 LYEXT_SUBSTMT_NAMESPACE, /**< extension of the namespace statement, can appear in lys_module */
305 LYEXT_SUBSTMT_ORGANIZATION, /**< extension of the organization statement, can appear in lys_module and lys_submodule */
306 LYEXT_SUBSTMT_PATH, /**< extension of the path statement, can appear in lys_type */
307 LYEXT_SUBSTMT_PREFIX, /**< extension of the prefix statement, can appear in lys_module, lys_submodule (for
308 belongs-to's prefix) and lys_import */
309 LYEXT_SUBSTMT_PRESENCE, /**< extension of the presence statement, can appear in lys_node_container */
310 LYEXT_SUBSTMT_REFERENCE, /**< extension of the reference statement, can appear in lys_module, lys_submodule,
311 lys_node, lys_import, lys_include, lys_revision, lys_tpdf, lys_restr, lys_ident,
312 lys_ext, lys_feature, lys_deviation, lys_type_enum, lys_type_bit and lys_when */
313 LYEXT_SUBSTMT_REVISIONDATE, /**< extension of the revision-date statement, can appear in lys_import and lys_include */
314 LYEXT_SUBSTMT_UNITS, /**< extension of the units statement, can appear in lys_tpdf, lys_node_leaf,
315 lys_node_leaflist and lys_deviate */
316 LYEXT_SUBSTMT_VALUE, /**< extension of the value statement, can appear in lys_type_enum */
317 LYEXT_SUBSTMT_VERSION, /**< extension of the yang-version statement, can appear in lys_module and lys_submodule */
318 LYEXT_SUBSTMT_MODIFIER, /**< extension of the modifier statement, can appear in lys_restr */
319 LYEXT_SUBSTMT_REQINSTANCE, /**< extension of the require-instance statement, can appear in lys_type */
320 LYEXT_SUBSTMT_YINELEM, /**< extension of the yin-element statement, can appear in lys_ext */
321 LYEXT_SUBSTMT_CONFIG, /**< extension of the config statement, can appear in lys_node and lys_deviate */
322 LYEXT_SUBSTMT_MANDATORY, /**< extension of the mandatory statement, can appear in lys_node_leaf, lys_node_choice,
323 lys_node_anydata and lys_deviate */
324 LYEXT_SUBSTMT_ORDEREDBY, /**< extension of the ordered-by statement, can appear in lys_node_list and lys_node_leaflist */
325 LYEXT_SUBSTMT_STATUS, /**< extension of the status statement, can appear in lys_tpdf, lys_node, lys_ident,
326 lys_ext, lys_feature, lys_type_enum and lys_type_bit */
327 LYEXT_SUBSTMT_FRACDIGITS, /**< extension of the fraction-digits statement, can appear in lys_type */
328 LYEXT_SUBSTMT_MAX, /**< extension of the max-elements statement, can appear in lys_node_list,
329 lys_node_leaflist and lys_deviate */
330 LYEXT_SUBSTMT_MIN, /**< extension of the min-elements statement, can appear in lys_node_list,
331 lys_node_leaflist and lys_deviate */
332 LYEXT_SUBSTMT_POSITION, /**< extension of the position statement, can appear in lys_type_bit */
333 LYEXT_SUBSTMT_UNIQUE, /**< extension of the unique statement, can appear in lys_node_list and lys_deviate */
334 LYEXT_SUBSTMT_IFFEATURE, /**< extension of the if-feature statement */
335} LYEXT_SUBSTMT;
336
337/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200338 * @brief YANG import-stmt
339 */
340struct lysp_import {
Radek Krejci086c7132018-10-26 15:29:04 +0200341 struct lys_module *module; /**< pointer to the imported module
342 (mandatory, but resolved when the referring module is completely parsed) */
343 const char *name; /**< name of the imported module (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200344 const char *prefix; /**< prefix for the data from the imported schema (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200345 const char *dsc; /**< description */
346 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200347 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200348 char rev[LY_REV_SIZE]; /**< revision-date of the imported module */
349};
350
351/**
352 * @brief YANG include-stmt
353 */
354struct lysp_include {
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100355 struct lysp_submodule *submodule;/**< pointer to the parsed submodule structure
Radek Krejci086c7132018-10-26 15:29:04 +0200356 (mandatory, but resolved when the referring module is completely parsed) */
357 const char *name; /**< name of the included submodule (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200358 const char *dsc; /**< description */
359 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200360 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200361 char rev[LY_REV_SIZE]; /**< revision-date of the included submodule */
362};
363
364/**
365 * @brief YANG extension-stmt
366 */
367struct lysp_ext {
368 const char *name; /**< extension name */
369 const char *argument; /**< argument name, NULL if not specified */
370 const char *dsc; /**< description statement */
371 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200372 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200373 uint16_t flags; /**< LYS_STATUS_* and LYS_YINELEM values (@ref snodeflags) */
374};
375
376/**
377 * @brief Helper structure for generic storage of the extension instances content.
378 */
379struct lysp_stmt {
380 const char *stmt; /**< identifier of the statement */
381 const char *arg; /**< statement's argument */
382 struct lysp_stmt *next; /**< link to the next statement */
Michal Vaskobc2559f2018-09-07 10:17:50 +0200383 struct lysp_stmt *child; /**< list of the statement's substatements (linked list) */
David Sedlákb9d75c42019-08-14 10:49:42 +0200384 uint16_t flags; /**< statement flags, can be set to LYS_YIN_ATTR */
Radek Krejci335332a2019-09-05 13:03:35 +0200385 enum ly_stmt kw; /**< numeric respresentation of the stmt value */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200386};
387
David Sedlákae4b4512019-08-14 10:45:56 +0200388#define LYS_YIN 0x1 /**< used to specify input format of extension instance */
389
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200390/**
391 * @brief YANG extension instance
392 */
393struct lysp_ext_instance {
David Sedlákbbd06ca2019-06-27 14:15:38 +0200394 const char *name; /**< extension identifier, including possible prefix */
395 const char *argument; /**< optional value of the extension's argument */
Radek Krejci335332a2019-09-05 13:03:35 +0200396 void *parent; /**< pointer to the parent element holding the extension instance(s), use
397 ::lysp_ext_instance#parent_type to access the schema element */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200398 struct lysp_stmt *child; /**< list of the extension's substatements (linked list) */
399 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
400 uint32_t insubstmt_index; /**< in case the instance is in a substatement, this identifies
401 the index of that substatement */
David Sedlákae4b4512019-08-14 10:45:56 +0200402 uint8_t yin; /** flag for YIN source format, can be set to LYS_YIN */
Radek Krejci335332a2019-09-05 13:03:35 +0200403 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200404};
405
406/**
407 * @brief YANG feature-stmt
408 */
409struct lysp_feature {
410 const char *name; /**< feature name (mandatory) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200411 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200412 const char *dsc; /**< description statement */
413 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200414 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200415 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values allowed */
416};
417
418/**
419 * @brief YANG identity-stmt
420 */
421struct lysp_ident {
422 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejci151a5b72018-10-19 14:21:44 +0200423 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
424 const char **bases; /**< list of base identifiers ([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 are allowed */
429};
430
Michal Vasko71e64ca2018-09-07 16:30:29 +0200431/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200432 * @brief Covers restrictions: range, length, pattern, must
433 */
434struct lysp_restr {
435 const char *arg; /**< The restriction expression/value (mandatory);
436 in case of pattern restriction, the first byte has a special meaning:
437 0x06 (ACK) for regular match and 0x15 (NACK) for invert-match */
438 const char *emsg; /**< error-message */
439 const char *eapptag; /**< error-app-tag value */
440 const char *dsc; /**< description */
441 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200442 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200443};
444
445/**
Michal Vasko71e64ca2018-09-07 16:30:29 +0200446 * @brief YANG revision-stmt
447 */
448struct lysp_revision {
Radek Krejcib7db73a2018-10-24 14:18:40 +0200449 char date[LY_REV_SIZE]; /**< revision date (madatory) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200450 const char *dsc; /**< description statement */
451 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200452 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200453};
454
455/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200456 * @brief Enumeration/Bit value definition
457 */
458struct lysp_type_enum {
459 const char *name; /**< name (mandatory) */
460 const char *dsc; /**< description statement */
461 const char *ref; /**< reference statement */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200462 int64_t value; /**< enum's value or bit's position */
Radek Krejci151a5b72018-10-19 14:21:44 +0200463 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200464 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200465 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
466 values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200467};
468
469/**
470 * @brief YANG type-stmt
471 *
472 * Some of the items in the structure may be mandatory, but it is necessary to resolve the type's base type first
473 */
474struct lysp_type {
475 const char *name; /**< name of the type (mandatory) */
476 struct lysp_restr *range; /**< allowed values range - numerical, decimal64 */
477 struct lysp_restr *length; /**< allowed length of the value - string, binary */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200478 struct lysp_restr *patterns; /**< list of patterns ([sized array](@ref sizedarrays)) - string */
479 struct lysp_type_enum *enums; /**< list of enum-stmts ([sized array](@ref sizedarrays)) - enum */
480 struct lysp_type_enum *bits; /**< list of bit-stmts ([sized array](@ref sizedarrays)) - bits */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200481 const char *path; /**< path - leafref */
Radek Krejci151a5b72018-10-19 14:21:44 +0200482 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) - identityref */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200483 struct lysp_type *types; /**< list of sub-types ([sized array](@ref sizedarrays)) - union */
484 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200485
Radek Krejci2167ee12018-11-02 16:09:07 +0100486 struct lysc_type *compiled; /**< pointer to the compiled type */
487
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200488 uint8_t fraction_digits; /**< number of fraction digits - decimal64 */
489 uint8_t require_instance; /**< require-instance flag - leafref, instance */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100490 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200491};
492
493/**
494 * @brief YANG typedef-stmt
495 */
496struct lysp_tpdf {
497 const char *name; /**< name of the newly defined type (mandatory) */
498 const char *units; /**< units of the newly defined type */
499 const char *dflt; /**< default value of the newly defined type */
500 const char *dsc; /**< description statement */
501 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200502 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200503 struct lysp_type type; /**< base type from which the typedef is derived (mandatory) */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100504 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200505};
506
507/**
508 * @brief YANG grouping-stmt
509 */
510struct lysp_grp {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100511 struct lysp_node *parent; /**< parent node (NULL if this is a top-level grouping) */
512 uint16_t nodetype; /**< LYS_GROUPING */
513 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200514 const char *name; /**< grouping name (mandatory) */
515 const char *dsc; /**< description statement */
516 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200517 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
518 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200519 struct lysp_node *data; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200520 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
521 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
522 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200523};
524
525/**
526 * @brief YANG when-stmt
527 */
528struct lysp_when {
529 const char *cond; /**< specified condition (mandatory) */
530 const char *dsc; /**< description statement */
531 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200532 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200533};
534
535/**
536 * @brief YANG refine-stmt
537 */
538struct lysp_refine {
539 const char *nodeid; /**< target descendant schema nodeid (mandatory) */
540 const char *dsc; /**< description statement */
541 const char *ref; /**< reference statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200542 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200543 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200544 const char *presence; /**< presence description */
Radek Krejci151a5b72018-10-19 14:21:44 +0200545 const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200546 uint32_t min; /**< min-elements constraint */
547 uint32_t max; /**< max-elements constraint, 0 means unbounded */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200548 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200549 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
550};
551
552/**
553 * @brief YANG uses-augment-stmt and augment-stmt
554 */
555struct lysp_augment {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100556 struct lysp_node *parent; /**< parent node (NULL if this is a top-level augment) */
557 uint16_t nodetype; /**< LYS_AUGMENT */
558 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200559 const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */
560 const char *dsc; /**< description statement */
561 const char *ref; /**< reference statement */
562 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200563 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200564 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200565 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
566 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
567 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200568};
569
570/**
571 * @defgroup deviatetypes Deviate types
572 * @{
573 */
574#define LYS_DEV_NOT_SUPPORTED 1 /**< deviate type not-supported */
575#define LYS_DEV_ADD 2 /**< deviate type add */
576#define LYS_DEV_DELETE 3 /**< deviate type delete */
577#define LYS_DEV_REPLACE 4 /**< deviate type replace */
578/** @} */
579
580/**
581 * @brief Generic deviate structure to get type and cast to lysp_deviate_* structure
582 */
583struct lysp_deviate {
584 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
585 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200586 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200587};
588
589struct lysp_deviate_add {
590 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
591 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200592 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200593 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200594 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200595 const char **uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
596 const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200597 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
598 uint32_t min; /**< min-elements constraint */
599 uint32_t max; /**< max-elements constraint, 0 means unbounded */
600};
601
602struct lysp_deviate_del {
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};
611
612struct lysp_deviate_rpl {
613 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
614 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200615 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200616 struct lysp_type *type; /**< type of the node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200617 const char *units; /**< units of the values */
618 const char *dflt; /**< default value */
619 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
620 uint32_t min; /**< min-elements constraint */
621 uint32_t max; /**< max-elements constraint, 0 means unbounded */
622};
623
624struct lysp_deviation {
Michal Vaskob55f6c12018-09-12 11:13:15 +0200625 const char *nodeid; /**< target absolute schema nodeid (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200626 const char *dsc; /**< description statement */
627 const char *ref; /**< reference statement */
628 struct lysp_deviate* deviates; /**< list of deviate specifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200629 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200630};
631
Radek Krejci4f28eda2018-11-12 11:46:16 +0100632/**
633 * @defgroup spnodeflags Parsed schema nodes flags
634 * @ingroup snodeflags
635 *
636 * Various flags for parsed schema nodes.
637 *
638 * 1 - container 6 - anydata/anyxml 11 - output 16 - grouping 21 - enum
639 * 2 - choice 7 - case 12 - feature 17 - uses 22 - type
Radek Krejcid3ca0632019-04-16 16:54:54 +0200640 * 3 - leaf 8 - notification 13 - identity 18 - refine 23 - stmt
Radek Krejci4f28eda2018-11-12 11:46:16 +0100641 * 4 - leaflist 9 - rpc 14 - extension 19 - augment
642 * 5 - list 10 - input 15 - typedef 20 - deviate
643 *
Radek Krejcid3ca0632019-04-16 16:54:54 +0200644 * 1 1 1 1 1 1 1 1 1 1 2 2 2 2
645 * 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
646 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
647 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | | | | |x| |x| | | |
648 * LYS_SET_BASE | | | | | | | | | | | | | | | | | | | | | |x| |
649 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
650 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | | | | |x| |x| | | |
651 * LYS_SET_BIT | | | | | | | | | | | | | | | | | | | | | |x| |
652 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
653 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
654 * LYS_SET_ENUM | | | | | | | | | | | | | | | | | | | | | |x| |
655 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
656 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
657 * LYS_SET_FRDIGITS | | | | | | | | | | | | | | | | | | | | | |x| |
658 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
659 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
660 * LYS_SET_LENGTH | | | | | | | | | | | | | | | | | | | | | |x| |
661 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
662 * 6 LYS_MAND_TRUE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
663 * LYS_SET_PATH | | | | | | | | | | | | | | | | | | | | | |x| |
664 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
665 * 7 LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
666 * LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | | | | | | | | |
667 * LYS_SET_PATTERN | | | | | | | | | | | | | | | | | | | | | |x| |
668 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
669 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | | | | | | | | |
670 * LYS_YINELEM_TRUE | | | | | | | | | | | | | |x| | | | | | | | | |
671 * LYS_SET_RANGE | | | | | | | | | | | | | | | | | | | | | |x| |
672 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
673 * 9 LYS_YINELEM_FALSE| | | | | | | | | | | | | |x| | | | | | | | | |
674 * LYS_SET_TYPE | | | | | | | | | | | | | | | | | | | | | |x| |
675 * LYS_SINGLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
676 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
677 * 10 LYS_SET_VALUE | | | | | | | | | | | | | | | | | | | | |x| | |
678 * LYS_SET_REQINST | | | | | | | | | | | | | | | | | | | | | |x| |
679 * LYS_SET_MIN | | | |x|x| | | | | | | | | | | | |x| |x| | | |
680 * LYS_DOUBLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
681 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
682 * 11 LYS_SET_MAX | | | |x|x| | | | | | | | | | | | |x| |x| | | |
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200683 * LYS_USED_GRP | | | | | | | | | | | | | | | |x| | | | | | | |
David Sedlákae4b4512019-08-14 10:45:56 +0200684 * LYS_YIN_ATTR | | | | | | | | | | | | | | | | | | | | | | |x|
Radek Krejcid3ca0632019-04-16 16:54:54 +0200685 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100686 *
687 */
688
689/**
690 * @defgroup scnodeflags Compiled schema nodes flags
691 * @ingroup snodeflags
692 *
693 * Various flags for compiled schema nodes.
694 *
695 * 1 - container 6 - anydata/anyxml 11 - output
696 * 2 - choice 7 - case 12 - feature
697 * 3 - leaf 8 - notification 13 - identity
698 * 4 - leaflist 9 - rpc 14 - extension
Radek Krejci693262f2019-04-29 15:23:20 +0200699 * 5 - list 10 - input 15 - bitenum
Radek Krejci4f28eda2018-11-12 11:46:16 +0100700 *
Radek Krejci693262f2019-04-29 15:23:20 +0200701 * 1 1 1 1 1 1
702 * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
703 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
704 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | | |
705 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
706 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | | |
707 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
708 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x| |
709 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
710 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x| |
711 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
712 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x| |
713 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
714 * 6 LYS_MAND_TRUE |x|x|x|x|x|x| | | | | | | | | |
715 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
716 * 7 LYS_ORDBY_USER | | | |x|x| | | | | | | | | | |
717 * LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | |
718 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
719 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | |
720 * LYS_PRESENCE |x| | | | | | | | | | | | | | |
721 * LYS_UNIQUE | | |x| | | | | | | | | | | | |
722 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
723 * 9 LYS_KEY | | |x| | | | | | | | | | | | |
724 * LYS_FENABLED | | | | | | | | | | | |x| | | |
725 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
726 * 10 LYS_SET_DFLT | | |x|x| | |x| | | | | | | | |
727 * LYS_ISENUM | | | | | | | | | | | | | | |x|
Radek Krejci0fe9b512019-07-26 17:51:05 +0200728 * LYS_KEYLESS | | | | |x| | | | | | | | | | |
Radek Krejci693262f2019-04-29 15:23:20 +0200729 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
730 * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | | |
731 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci1c0c3442019-07-23 16:08:47 +0200732 * 12 LYS_SET_CONFIG |x|x|x|x|x|x|x| | |x|x| | | | |
Radek Krejci693262f2019-04-29 15:23:20 +0200733 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100734 *
735 */
736
737/**
738 * @defgroup snodeflags Schema nodes flags
739 * @ingroup schematree
740 * @{
741 */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200742#define LYS_CONFIG_W 0x01 /**< config true; */
743#define LYS_CONFIG_R 0x02 /**< config false; */
744#define LYS_CONFIG_MASK 0x03 /**< mask for config value */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100745#define LYS_STATUS_CURR 0x04 /**< status current; */
746#define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */
747#define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */
748#define LYS_STATUS_MASK 0x1C /**< mask for status value */
749#define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice,
Radek Krejcife909632019-02-12 15:34:42 +0100750 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
751 The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0.
752 The ::lysc_node_container has this flag if it is not a presence container and it has at least one
753 child with LYS_MAND_TRUE. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100754#define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice,
755 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
756 This flag is present only in case the mandatory false statement was explicitly specified. */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100757#define LYS_MAND_MASK 0x60 /**< mask for mandatory values */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100758#define LYS_PRESENCE 0x80 /**< flag for presence property of a container, applicable only to ::lysc_node_container */
759#define LYS_UNIQUE 0x80 /**< flag for leafs being part of a unique set, applicable only to ::lysc_node_leaf */
760#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 +0200761#define LYS_KEYLESS 0x200 /**< flag for list without any key, applicable only to ::lysc_node_list */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100762#define LYS_FENABLED 0x100 /**< feature enabled flag, applicable only to ::lysc_feature */
Radek Krejcife909632019-02-12 15:34:42 +0100763#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 +0100764 ::lysc_node_list/::lysp_node_list */
765#define LYS_ORDBY_USER 0x40 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and
766 ::lysc_node_list/::lysp_node_list */
767#define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */
768#define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */
769#define LYS_YINELEM_FALSE 0x100 /**< yin-element false for extension's argument */
770#define LYS_YINELEM_MASK 0x180 /**< mask for yin-element value */
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200771#define LYS_USED_GRP 0x400 /**< internal flag for validating not-instantiated groupings
772 (resp. do not validate again the instantiated groupings). */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100773#define LYS_SET_VALUE 0x200 /**< value attribute is set */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100774#define LYS_SET_MIN 0x200 /**< min attribute is set */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200775#define LYS_SET_MAX 0x400 /**< max attribute is set */
Radek Krejcid505e3d2018-11-13 09:04:17 +0100776
777#define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */
778#define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */
779#define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */
780#define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */
781#define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */
782#define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */
783#define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */
784#define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */
785#define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */
786#define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */
Radek Krejciccd20f12019-02-15 14:12:27 +0100787#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 +0100788 cases of choice. This information is important for refines, since it is prohibited to make leafs
789 with default statement mandatory. In case the default leaf value is taken from type, it is thrown
Radek Krejciccd20f12019-02-15 14:12:27 +0100790 away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish
791 between own default or the default values taken from the type. */
792#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 +0100793#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 +0100794
Radek Krejcid3ca0632019-04-16 16:54:54 +0200795#define LYS_SINGLEQUOTED 0x100 /**< flag for single-quoted argument of an extension instance's substatement */
796#define LYS_DOUBLEQUOTED 0x200 /**< flag for double-quoted argument of an extension instance's substatement */
797
David Sedlákae4b4512019-08-14 10:45:56 +0200798#define LYS_YIN_ATTR 0x400 /**< flag to identify YIN attribute */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200799
Radek Krejci693262f2019-04-29 15:23:20 +0200800#define LYS_ISENUM 0x200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */
801
Radek Krejcife909632019-02-12 15:34:42 +0100802#define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100803/** @} */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200804
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200805/**
806 * @brief Generic YANG data node
807 */
808struct lysp_node {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100809 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200810 uint16_t nodetype; /**< type of the node (mandatory) */
811 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100812 struct lysp_node *next; /**< next sibling node (NULL if there is no one) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200813 const char *name; /**< node name (mandatory) */
814 const char *dsc; /**< description statement */
815 const char *ref; /**< reference statement */
816 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200817 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200818 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200819};
820
821/**
822 * @brief Extension structure of the lysp_node for YANG container
823 */
824struct lysp_node_container {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100825 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200826 uint16_t nodetype; /**< LYS_CONTAINER */
827 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
828 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
829 const char *name; /**< node name (mandatory) */
830 const char *dsc; /**< description statement */
831 const char *ref; /**< reference statement */
832 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200833 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200834 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200835
836 /* container */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200837 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200838 const char *presence; /**< presence description */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200839 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
840 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200841 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200842 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
843 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200844};
845
846struct lysp_node_leaf {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100847 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200848 uint16_t nodetype; /**< LYS_LEAF */
849 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
850 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
851 const char *name; /**< node name (mandatory) */
852 const char *dsc; /**< description statement */
853 const char *ref; /**< reference statement */
854 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200855 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200856 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200857
858 /* leaf */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200859 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200860 struct lysp_type type; /**< type of the leaf node (mandatory) */
861 const char *units; /**< units of the leaf's type */
862 const char *dflt; /**< default value */
863};
864
865struct lysp_node_leaflist {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100866 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200867 uint16_t nodetype; /**< LYS_LEAFLIST */
868 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
869 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
870 const char *name; /**< node name (mandatory) */
871 const char *dsc; /**< description statement */
872 const char *ref; /**< reference statement */
873 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200874 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200875 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200876
877 /* leaf-list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200878 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200879 struct lysp_type type; /**< type of the leaf node (mandatory) */
880 const char *units; /**< units of the leaf's type */
Radek Krejci151a5b72018-10-19 14:21:44 +0200881 const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200882 uint32_t min; /**< min-elements constraint */
883 uint32_t max; /**< max-elements constraint, 0 means unbounded */
884};
885
886struct lysp_node_list {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100887 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200888 uint16_t nodetype; /**< LYS_LIST */
889 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
890 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
891 const char *name; /**< node name (mandatory) */
892 const char *dsc; /**< description statement */
893 const char *ref; /**< reference statement */
894 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200895 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200896 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200897
898 /* list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200899 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200900 const char *key; /**< keys specification */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200901 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
902 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200903 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200904 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
905 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200906 const char **uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200907 uint32_t min; /**< min-elements constraint */
908 uint32_t max; /**< max-elements constraint, 0 means unbounded */
909};
910
911struct lysp_node_choice {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100912 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200913 uint16_t nodetype; /**< LYS_CHOICE */
914 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
915 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
916 const char *name; /**< node name (mandatory) */
917 const char *dsc; /**< description statement */
918 const char *ref; /**< reference statement */
919 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200920 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200921 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200922
923 /* choice */
924 struct lysp_node *child; /**< list of data nodes (linked list) */
925 const char* dflt; /**< default case */
926};
927
928struct lysp_node_case {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100929 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200930 uint16_t nodetype; /**< LYS_CASE */
931 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
932 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
933 const char *name; /**< node name (mandatory) */
934 const char *dsc; /**< description statement */
935 const char *ref; /**< reference statement */
936 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200937 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200938 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200939
940 /* case */
941 struct lysp_node *child; /**< list of data nodes (linked list) */
942};
943
944struct lysp_node_anydata {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100945 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200946 uint16_t nodetype; /**< LYS_ANYXML || LYS_ANYDATA */
947 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
948 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
949 const char *name; /**< node name (mandatory) */
950 const char *dsc; /**< description statement */
951 const char *ref; /**< reference statement */
952 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200953 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200954 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200955
956 /* anyxml/anydata */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200957 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200958};
959
960struct lysp_node_uses {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100961 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200962 uint16_t nodetype; /**< LYS_USES */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200963 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
964 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
965 const char *name; /**< grouping name reference (mandatory) */
966 const char *dsc; /**< description statement */
967 const char *ref; /**< reference statement */
968 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200969 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200970 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200971
972 /* uses */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200973 struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */
974 struct lysp_augment *augments; /**< list of uses's augment ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200975};
976
977/**
978 * @brief YANG input-stmt and output-stmt
979 */
980struct lysp_action_inout {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100981 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
982 uint16_t nodetype; /**< LYS_INOUT */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200983 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
984 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
985 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200986 struct lysp_node *data; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200987 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200988};
989
990/**
991 * @brief YANG rpc-stmt and action-stmt
992 */
993struct lysp_action {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100994 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
995 uint16_t nodetype; /**< LYS_ACTION */
996 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200997 const char *name; /**< grouping name reference (mandatory) */
998 const char *dsc; /**< description statement */
999 const char *ref; /**< reference statement */
Radek Krejci151a5b72018-10-19 14:21:44 +02001000 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001001 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1002 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001003 struct lysp_action_inout input; /**< RPC's/Action's input */
1004 struct lysp_action_inout output; /**< RPC's/Action's output */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001005 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001006};
1007
1008/**
1009 * @brief YANG notification-stmt
1010 */
1011struct lysp_notif {
Radek Krejci6d9b9b52018-11-02 12:43:39 +01001012 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1013 uint16_t nodetype; /**< LYS_NOTIF */
1014 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001015 const char *name; /**< grouping name reference (mandatory) */
1016 const char *dsc; /**< description statement */
1017 const char *ref; /**< reference statement */
Radek Krejci151a5b72018-10-19 14:21:44 +02001018 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001019 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1020 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1021 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001022 struct lysp_node *data; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001023 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001024};
1025
1026/**
Radek Krejcif0fceb62018-09-05 14:58:45 +02001027 * @brief supported YANG schema version values
1028 */
1029typedef enum LYS_VERSION {
1030 LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */
1031 LYS_VERSION_1_0 = 1, /**< YANG 1.0 */
1032 LYS_VERSION_1_1 = 2 /**< YANG 1.1 */
1033} LYS_VERSION;
1034
1035/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001036 * @brief Printable YANG schema tree structure representing YANG module.
1037 *
1038 * Simple structure corresponding to the YANG format. The schema is only syntactically validated.
1039 */
1040struct lysp_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001041 struct lys_module *mod; /**< covering module structure */
1042
Radek Krejcib7db73a2018-10-24 14:18:40 +02001043 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1044 in the list is always the last (newest) revision of the module */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001045 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1046 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001047 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1048 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1049 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1050 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1051 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001052 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001053 struct lysp_augment *augments; /**< list of augments ([sized array](@ref sizedarrays)) */
1054 struct lysp_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */
1055 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
1056 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
1057 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001058
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001059 uint8_t parsing:1; /**< flag for circular check */
1060};
1061
1062struct lysp_submodule {
1063 const char *belongsto; /**< belongs to parent module (submodule - mandatory) */
1064
1065 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1066 in the list is always the last (newest) revision of the module */
1067 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1068 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
1069 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1070 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1071 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1072 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1073 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
1074 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
1075 struct lysp_augment *augments; /**< list of augments ([sized array](@ref sizedarrays)) */
1076 struct lysp_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */
1077 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
1078 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
1079 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1080
1081 uint8_t parsing:1; /**< flag for circular check */
1082
Radek Krejci086c7132018-10-26 15:29:04 +02001083 uint8_t latest_revision:2; /**< flag to mark the latest available revision:
1084 1 - the latest revision in searchdirs was not searched yet and this is the
1085 latest revision in the current context
1086 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001087 const char *name; /**< name of the module (mandatory) */
1088 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1089 const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */
1090 const char *org; /**< party/company responsible for the module */
1091 const char *contact; /**< contact information for the module */
1092 const char *dsc; /**< description of the module */
1093 const char *ref; /**< cross-reference for the module */
Radek Krejci086c7132018-10-26 15:29:04 +02001094 uint8_t version; /**< yang-version (LYS_VERSION values) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001095};
1096
1097/**
Radek Krejci3f5e3db2018-10-11 15:57:47 +02001098 * @brief Free the printable YANG schema tree structure.
1099 *
1100 * @param[in] module Printable YANG schema tree structure to free.
1101 */
1102void lysp_module_free(struct lysp_module *module);
1103
1104/**
Radek Krejci0e59c312019-08-15 15:34:15 +02001105 * @brief Compiled YANG extension-stmt
1106 */
1107struct lysc_ext {
1108 const char *name; /**< extension name */
1109 const char *argument; /**< argument name, NULL if not specified */
Radek Krejci0e59c312019-08-15 15:34:15 +02001110 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1111 struct lyext_plugin *plugin; /**< Plugin implementing the specific extension */
Radek Krejci0935f412019-08-20 16:15:18 +02001112 struct lys_module *module; /**< module structure */
Radek Krejci0e59c312019-08-15 15:34:15 +02001113 uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */
1114};
1115
1116/**
Radek Krejcice8c1592018-10-29 15:35:51 +01001117 * @brief YANG extension instance
1118 */
1119struct lysc_ext_instance {
Radek Krejciad5963b2019-09-06 16:03:05 +02001120 uint32_t insubstmt_index; /**< in case the instance is in a substatement that can appear multiple times,
1121 this identifies the index of the substatement for this extension instance */
Radek Krejci28681fa2019-09-06 13:08:45 +02001122 struct lys_module *module; /**< module where the extension instantiated is defined */
Radek Krejciad5963b2019-09-06 16:03:05 +02001123 struct lysc_ext *def; /**< pointer to the extension definition */
Radek Krejcice8c1592018-10-29 15:35:51 +01001124 void *parent; /**< pointer to the parent element holding the extension instance(s), use
1125 ::lysc_ext_instance#parent_type to access the schema element */
1126 const char *argument; /**< optional value of the extension's argument */
1127 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Radek Krejci2a408df2018-10-29 16:32:26 +01001128 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001129 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0e59c312019-08-15 15:34:15 +02001130 void *data; /**< private plugins's data, not used by libyang */
Radek Krejcice8c1592018-10-29 15:35:51 +01001131};
1132
1133/**
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001134 * @brief Compiled YANG if-feature-stmt
1135 */
1136struct lysc_iffeature {
1137 uint8_t *expr; /**< 2bits array describing the if-feature expression in prefix format, see @ref ifftokens */
1138 struct lysc_feature **features; /**< array of pointers to the features used in expression ([sized array](@ref sizedarrays)) */
1139};
1140
1141/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001142 * @brief YANG import-stmt
1143 */
1144struct lysc_import {
Radek Krejci6d6e4e42018-10-29 13:28:19 +01001145 struct lys_module *module; /**< link to the imported module */
Radek Krejci151a5b72018-10-19 14:21:44 +02001146 const char *prefix; /**< prefix for the data from the imported schema (mandatory) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001147 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +02001148};
1149
1150/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001151 * @brief YANG when-stmt
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001152 */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001153struct lysc_when {
1154 struct lyxp_expr *cond; /**< XPath when condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001155 const char *dsc; /**< description */
1156 const char *ref; /**< reference */
Radek Krejci00b874b2019-02-12 10:54:50 +01001157 struct lysc_node *context; /**< context node for evaluating the expression */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001158 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00b874b2019-02-12 10:54:50 +01001159 uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001160};
1161
1162/**
Radek Krejci2a408df2018-10-29 16:32:26 +01001163 * @brief YANG identity-stmt
1164 */
1165struct lysc_ident {
1166 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejcic8b31002019-01-08 10:24:45 +01001167 const char *dsc; /**< description */
1168 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001169 struct lys_module *module; /**< module structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001170 struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */
1171 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001172 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci2a408df2018-10-29 16:32:26 +01001173 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
1174};
1175
1176/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001177 * @brief YANG feature-stmt
1178 */
1179struct lysc_feature {
1180 const char *name; /**< feature name (mandatory) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001181 const char *dsc; /**< description */
1182 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001183 struct lys_module *module; /**< module structure */
Radek Krejci151a5b72018-10-19 14:21:44 +02001184 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 +01001185 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001186 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001187 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* and
1188 #LYS_FENABLED values allowed */
1189};
1190
Radek Krejci151a5b72018-10-19 14:21:44 +02001191/**
1192 * @defgroup ifftokens if-feature expression tokens
1193 * Tokens of if-feature expression used in ::lysc_iffeature#expr
1194 *
1195 * @{
1196 */
1197#define LYS_IFF_NOT 0x00 /**< operand "not" */
1198#define LYS_IFF_AND 0x01 /**< operand "and" */
1199#define LYS_IFF_OR 0x02 /**< operand "or" */
1200#define LYS_IFF_F 0x03 /**< feature */
1201/**
1202 * @}
1203 */
1204
1205/**
Radek Krejcib7db73a2018-10-24 14:18:40 +02001206 * @brief Compiled YANG revision statement
1207 */
1208struct lysc_revision {
1209 char date[LY_REV_SIZE]; /**< revision-date (mandatory) */
1210 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1211};
1212
Radek Krejci2167ee12018-11-02 16:09:07 +01001213struct lysc_range {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001214 struct lysc_range_part {
Radek Krejci693262f2019-04-29 15:23:20 +02001215 union { /**< min boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001216 int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1217 uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001218 };
Radek Krejci693262f2019-04-29 15:23:20 +02001219 union { /**< max boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001220 int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1221 uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001222 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001223 } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001224 const char *dsc; /**< description */
1225 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001226 const char *emsg; /**< error-message */
1227 const char *eapptag; /**< error-app-tag value */
1228 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1229};
1230
1231struct lysc_pattern {
Radek Krejci54579462019-04-30 12:47:06 +02001232 const char *expr; /**< original, not compiled, regular expression */
1233 pcre2_code *code; /**< compiled regular expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001234 const char *dsc; /**< description */
1235 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001236 const char *emsg; /**< error-message */
1237 const char *eapptag; /**< error-app-tag value */
1238 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci4586a022018-11-13 11:29:26 +01001239 uint32_t inverted:1; /**< invert-match flag */
1240 uint32_t refcount:31; /**< reference counter */
Radek Krejci2167ee12018-11-02 16:09:07 +01001241};
1242
1243struct lysc_must {
1244 struct lys_module *module; /**< module where the must was defined */
1245 struct lyxp_expr *cond; /**< XPath when condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001246 const char *dsc; /**< description */
1247 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001248 const char *emsg; /**< error-message */
1249 const char *eapptag; /**< error-app-tag value */
1250 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1251};
1252
1253struct lysc_type {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001254 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001255 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001256 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 +02001257 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 +01001258 LY_DATA_TYPE basetype; /**< Base type of the type */
1259 uint32_t refcount; /**< reference counter for type sharing */
1260};
1261
1262struct lysc_type_num {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001263 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001264 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001265 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 +02001266 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 +01001267 LY_DATA_TYPE basetype; /**< Base type of the type */
1268 uint32_t refcount; /**< reference counter for type sharing */
1269 struct lysc_range *range; /**< Optional range limitation */
1270};
1271
1272struct lysc_type_dec {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001273 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001274 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001275 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 +02001276 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 +01001277 LY_DATA_TYPE basetype; /**< Base type of the type */
1278 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci6cba4292018-11-15 17:33:29 +01001279 uint8_t fraction_digits; /**< fraction digits specification */
Radek Krejci2167ee12018-11-02 16:09:07 +01001280 struct lysc_range *range; /**< Optional range limitation */
1281};
1282
1283struct lysc_type_str {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001284 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001285 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001286 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 +02001287 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 +01001288 LY_DATA_TYPE basetype; /**< Base type of the type */
1289 uint32_t refcount; /**< reference counter for type sharing */
1290 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci4586a022018-11-13 11:29:26 +01001291 struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001292};
1293
Radek Krejci693262f2019-04-29 15:23:20 +02001294struct lysc_type_bitenum_item {
1295 const char *name; /**< enumeration identifier */
1296 const char *dsc; /**< description */
1297 const char *ref; /**< reference */
1298 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1299 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1300 union {
1301 int32_t value; /**< integer value associated with the enumeration */
1302 uint32_t position; /**< non-negative integer value associated with the bit */
1303 };
1304 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
1305 values are allowed */
1306};
1307
Radek Krejci2167ee12018-11-02 16:09:07 +01001308struct lysc_type_enum {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001309 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001310 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001311 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 +02001312 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 +01001313 LY_DATA_TYPE basetype; /**< Base type of the type */
1314 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci693262f2019-04-29 15:23:20 +02001315 struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1316};
1317
1318struct lysc_type_bits {
1319 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1320 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001321 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 +02001322 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 +02001323 LY_DATA_TYPE basetype; /**< Base type of the type */
1324 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci849a62a2019-05-22 15:29:05 +02001325 struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item),
1326 the items are ordered by their position value. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001327};
1328
1329struct lysc_type_leafref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001330 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001331 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001332 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 +02001333 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 +01001334 LY_DATA_TYPE basetype; /**< Base type of the type */
1335 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejcia3045382018-11-22 14:30:31 +01001336 const char* path; /**< target path */
Radek Krejci96a0bfd2018-11-22 15:25:06 +01001337 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 +01001338 struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001339 uint8_t require_instance; /**< require-instance flag */
1340};
1341
1342struct lysc_type_identityref {
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 Krejci555cb5b2018-11-16 14:54:33 +01001349 struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)),
Radek Krejci2167ee12018-11-02 16:09:07 +01001350 mandatory (at least 1 item) */
1351};
1352
1353struct lysc_type_instanceid {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001354 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001355 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001356 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 +02001357 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 +01001358 LY_DATA_TYPE basetype; /**< Base type of the type */
1359 uint32_t refcount; /**< reference counter for type sharing */
1360 uint8_t require_instance; /**< require-instance flag */
1361};
1362
Radek Krejci2167ee12018-11-02 16:09:07 +01001363struct lysc_type_union {
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 */
1370 struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1371};
1372
1373struct lysc_type_bin {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001374 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001375 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001376 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 +02001377 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 +01001378 LY_DATA_TYPE basetype; /**< Base type of the type */
1379 uint32_t refcount; /**< reference counter for type sharing */
1380 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001381};
1382
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001383struct lysc_action_inout {
1384 struct lysc_node *data; /**< first child node (linked list) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001385 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1386};
1387
Radek Krejci056d0a82018-12-06 16:57:25 +01001388struct lysc_action {
1389 uint16_t nodetype; /**< LYS_ACTION */
1390 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci95710c92019-02-11 15:49:55 +01001391 struct lys_module *module; /**< module structure */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001392 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. */
1393 struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */
1394
Radek Krejcifc11bd72019-04-11 16:00:05 +02001395 struct lysc_ext_instance *input_exts; /**< list of the extension instances of input ([sized array](@ref sizedarrays)) */
1396 struct lysc_ext_instance *output_exts; /**< list of the extension instances of outpu ([sized array](@ref sizedarrays)) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001397
Radek Krejci056d0a82018-12-06 16:57:25 +01001398 const char *name; /**< action/RPC name (mandatory) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001399 const char *dsc; /**< description */
1400 const char *ref; /**< reference */
1401
Radek Krejcifc11bd72019-04-11 16:00:05 +02001402 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1403 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1404
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001405 struct lysc_action_inout input; /**< RPC's/action's input */
1406 struct lysc_action_inout output; /**< RPC's/action's output */
1407
Radek Krejci056d0a82018-12-06 16:57:25 +01001408};
1409
1410struct lysc_notif {
1411 uint16_t nodetype; /**< LYS_NOTIF */
1412 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci95710c92019-02-11 15:49:55 +01001413 struct lys_module *module; /**< module structure */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001414 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 +01001415 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1416
Radek Krejcifc11bd72019-04-11 16:00:05 +02001417 struct lysc_node *data; /**< first child node (linked list) */
1418 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1419
Radek Krejci056d0a82018-12-06 16:57:25 +01001420 const char *name; /**< Notification name (mandatory) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001421 const char *dsc; /**< description */
1422 const char *ref; /**< reference */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001423
1424 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1425 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001426};
1427
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001428/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001429 * @brief Compiled YANG data node
1430 */
1431struct lysc_node {
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001432 uint16_t nodetype; /**< type of the node (mandatory) */
1433 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001434 struct lys_module *module; /**< module structure */
1435 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. */
1436 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1437 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1438 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1439 never NULL. If there is no sibling node, pointer points to the node
1440 itself. In case of the first node, this pointer points to the last
1441 node in the list. */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001442 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001443 const char *dsc; /**< description */
1444 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001445 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001446 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001447 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001448};
1449
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001450struct lysc_node_container {
1451 uint16_t nodetype; /**< LYS_CONTAINER */
1452 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1453 struct lys_module *module; /**< module structure */
1454 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. */
1455 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1456 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1457 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1458 never NULL. If there is no sibling node, pointer points to the node
1459 itself. In case of the first node, this pointer points to the last
1460 node in the list. */
1461 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001462 const char *dsc; /**< description */
1463 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001464 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001465 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001466 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001467
1468 struct lysc_node *child; /**< first child node (linked list) */
1469 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1470 struct lysc_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
1471 struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001472};
1473
Radek Krejcia3045382018-11-22 14:30:31 +01001474struct lysc_node_case {
Radek Krejci056d0a82018-12-06 16:57:25 +01001475 uint16_t nodetype; /**< LYS_CASE */
1476 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1477 struct lys_module *module; /**< module structure */
1478 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. */
1479 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1480 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1481 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1482 never NULL. If there is no sibling node, pointer points to the node
1483 itself. In case of the first node, this pointer points to the last
1484 node in the list. */
Radek Krejcia3045382018-11-22 14:30:31 +01001485 const char *name; /**< name of the case, including the implicit case */
Radek Krejci12fb9142019-01-08 09:45:30 +01001486 const char *dsc; /**< description */
1487 const char *ref; /**< reference */
Radek Krejci056d0a82018-12-06 16:57:25 +01001488 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001489 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001490 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001491
Radek Krejcia3045382018-11-22 14:30:31 +01001492 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 +01001493 each other as siblings with the parent pointer pointing to appropriate case node. */
Radek Krejcia3045382018-11-22 14:30:31 +01001494};
1495
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001496struct lysc_node_choice {
1497 uint16_t nodetype; /**< LYS_CHOICE */
1498 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1499 struct lys_module *module; /**< module structure */
1500 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. */
1501 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1502 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1503 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1504 never NULL. If there is no sibling node, pointer points to the node
1505 itself. In case of the first node, this pointer points to the last
1506 node in the list. */
1507 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001508 const char *dsc; /**< description */
1509 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001510 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001511 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001512 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001513
Radek Krejcia9026eb2018-12-12 16:04:47 +01001514 struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other
1515 as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the
1516 case is simple. */
Radek Krejci056d0a82018-12-06 16:57:25 +01001517 struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001518};
1519
1520struct lysc_node_leaf {
1521 uint16_t nodetype; /**< LYS_LEAF */
1522 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1523 struct lys_module *module; /**< module structure */
1524 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. */
1525 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1526 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1527 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1528 never NULL. If there is no sibling node, pointer points to the node
1529 itself. In case of the first node, this pointer points to the last
1530 node in the list. */
1531 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001532 const char *dsc; /**< description */
1533 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001534 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001535 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001536 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001537
1538 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1539 struct lysc_type *type; /**< type of the leaf node (mandatory) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001540
Radek Krejci4f28eda2018-11-12 11:46:16 +01001541 const char *units; /**< units of the leaf's type */
Radek Krejcia1911222019-07-22 17:24:50 +02001542 struct lyd_value *dflt; /**< default value */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001543 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 +01001544};
1545
1546struct lysc_node_leaflist {
1547 uint16_t nodetype; /**< LYS_LEAFLIST */
1548 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1549 struct lys_module *module; /**< module structure */
1550 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. */
1551 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1552 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1553 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1554 never NULL. If there is no sibling node, pointer points to the node
1555 itself. In case of the first node, this pointer points to the last
1556 node in the list. */
1557 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001558 const char *dsc; /**< description */
1559 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001560 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001561 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001562 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001563
1564 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1565 struct lysc_type *type; /**< type of the leaf node (mandatory) */
1566
Radek Krejci0e5d8382018-11-28 16:37:53 +01001567 const char *units; /**< units of the leaf's type */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001568 struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */
1569 struct lys_module **dflts_mods; /**< list ([sized array](@ref sizedarrays)) of modules where the lysc_node_leaflist::dflts values were defined
1570 (needed to correctly map prefixes). */
Radek Krejci0e5d8382018-11-28 16:37:53 +01001571 uint32_t min; /**< min-elements constraint */
1572 uint32_t max; /**< max-elements constraint */
1573
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001574};
1575
1576struct lysc_node_list {
1577 uint16_t nodetype; /**< LYS_LIST */
1578 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1579 struct lys_module *module; /**< module structure */
1580 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. */
1581 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1582 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1583 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1584 never NULL. If there is no sibling node, pointer points to the node
1585 itself. In case of the first node, this pointer points to the last
1586 node in the list. */
1587 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001588 const char *dsc; /**< description */
1589 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001590 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001591 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001592 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001593
1594 struct lysc_node *child; /**< first child node (linked list) */
1595 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1596 struct lysc_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
1597 struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
1598
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001599 struct lysc_node_leaf ***uniques; /**< list of sized arrays of pointers to the unique nodes ([sized array](@ref sizedarrays)) */
1600 uint32_t min; /**< min-elements constraint */
1601 uint32_t max; /**< max-elements constraint */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001602};
1603
1604struct lysc_node_anydata {
1605 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1606 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1607 struct lys_module *module; /**< module structure */
1608 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. */
1609 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1610 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1611 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1612 never NULL. If there is no sibling node, pointer points to the node
1613 itself. In case of the first node, this pointer points to the last
1614 node in the list. */
1615 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001616 const char *dsc; /**< description */
1617 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001618 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001619 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001620 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci9800fb82018-12-13 14:26:23 +01001621
1622 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001623};
1624
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001625/**
1626 * @brief Compiled YANG schema tree structure representing YANG module.
1627 *
1628 * Semantically validated YANG schema tree for data tree parsing.
1629 * Contains only the necessary information for the data validation.
1630 */
1631struct lysc_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001632 struct lys_module *mod; /**< covering module structure */
Radek Krejci151a5b72018-10-19 14:21:44 +02001633 struct lysc_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001634
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001635 struct lysc_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
Radek Krejci2a408df2018-10-29 16:32:26 +01001636 struct lysc_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1637 struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */
1638 struct lysc_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */
1639 struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejci0935f412019-08-20 16:15:18 +02001640 struct lysc_ext *extensions; /**< list of the extension definitions ([sized array](@ref sizedarrays)) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001641 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001642};
1643
1644/**
Radek Krejci53ea6152018-12-13 15:21:15 +01001645 * @brief Get the groupings sized array of the given (parsed) schema node.
1646 * Decides the node's type and in case it has a groupings array, returns it.
1647 * @param[in] node Node to examine.
1648 * @return The node's groupings sized array if any, NULL otherwise.
1649 */
1650const struct lysp_grp *lysp_node_groupings(const struct lysp_node *node);
1651
1652/**
Radek Krejci056d0a82018-12-06 16:57:25 +01001653 * @brief Get the typedefs sized array of the given (parsed) schema node.
1654 * Decides the node's type and in case it has a typedefs array, returns it.
1655 * @param[in] node Node to examine.
1656 * @return The node's typedefs sized array if any, NULL otherwise.
1657 */
1658const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
1659
1660/**
1661 * @brief Get the actions/RPCs sized array of the given (parsed) schema node.
1662 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1663 * @param[in] node Node to examine.
1664 * @return The node's actions/RPCs sized array if any, NULL otherwise.
1665 */
1666const struct lysp_action *lysp_node_actions(const struct lysp_node *node);
1667
1668/**
1669 * @brief Get the Notifications sized array of the given (parsed) schema node.
1670 * Decides the node's type and in case it has a Notifications array, returns it.
1671 * @param[in] node Node to examine.
1672 * @return The node's Notifications sized array if any, NULL otherwise.
1673 */
1674const struct lysp_notif *lysp_node_notifs(const struct lysp_node *node);
1675
1676/**
1677 * @brief Get the children linked list of the given (parsed) schema node.
1678 * Decides the node's type and in case it has a children list, returns it.
1679 * @param[in] node Node to examine.
1680 * @return The node's children linked list if any, NULL otherwise.
1681 */
1682const struct lysp_node *lysp_node_children(const struct lysp_node *node);
1683
1684/**
1685 * @brief Get the actions/RPCs sized array of the given (compiled) schema node.
1686 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1687 * @param[in] node Node to examine.
1688 * @return The node's actions/RPCs sized array if any, NULL otherwise.
1689 */
1690const struct lysc_action *lysc_node_actions(const struct lysc_node *node);
1691
1692/**
1693 * @brief Get the Notifications sized array of the given (compiled) schema node.
1694 * Decides the node's type and in case it has a Notifications array, returns it.
1695 * @param[in] node Node to examine.
1696 * @return The node's Notifications sized array if any, NULL otherwise.
1697 */
1698const struct lysc_notif *lysc_node_notifs(const struct lysc_node *node);
1699
1700/**
1701 * @brief Get the children linked list of the given (compiled) schema node.
1702 * Decides the node's type and in case it has a children list, returns it.
1703 * @param[in] node Node to examine.
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001704 * @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 +01001705 * @return The node's children linked list if any, NULL otherwise.
1706 */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001707const struct lysc_node *lysc_node_children(const struct lysc_node *node, uint16_t flags);
Radek Krejci056d0a82018-12-06 16:57:25 +01001708
1709/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001710 * @brief Get how the if-feature statement currently evaluates.
1711 *
1712 * @param[in] iff Compiled if-feature statement to evaluate.
1713 * @return If the statement evaluates to true, 1 is returned. 0 is returned when the statement evaluates to false.
1714 */
1715int lysc_iffeature_value(const struct lysc_iffeature *iff);
1716
1717/**
1718 * @brief Get the current status of the provided feature.
1719 *
1720 * @param[in] feature Compiled feature statement to examine.
1721 * @return
1722 * - 1 if feature is enabled,
1723 * - 0 if feature is disabled,
1724 * - -1 in case of error (invalid argument)
1725 */
1726int lysc_feature_value(const struct lysc_feature *feature);
1727
1728/**
Radek Krejci327de162019-06-14 12:52:07 +02001729 * @brief Generate path of the given node in the requested format.
1730 *
1731 * @param[in] node Schema path of this node will be generated.
1732 * @param[in] pathtype Format of the path to generate.
Radek Krejci1c0c3442019-07-23 16:08:47 +02001733 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
1734 * If NULL, memory for the complete path is allocated.
1735 * @param[in] buflen Size of the provided @p buffer.
Radek Krejci327de162019-06-14 12:52:07 +02001736 * @return NULL in case of memory allocation error, path of the node otherwise.
Radek Krejci1c0c3442019-07-23 16:08:47 +02001737 * 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 +02001738 */
Radek Krejci1c0c3442019-07-23 16:08:47 +02001739char *lysc_path(struct lysc_node *node, LY_PATH_TYPE pathtype, char *buffer, size_t buflen);
Radek Krejci327de162019-06-14 12:52:07 +02001740
1741/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001742 * @brief Available YANG schema tree structures representing YANG module.
1743 */
1744struct lys_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001745 struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */
1746 const char *name; /**< name of the module (mandatory) */
Radek Krejci0af46292019-01-11 16:02:31 +01001747 const char *revision; /**< revision of the module (if present) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001748 const char *ns; /**< namespace of the module (module - mandatory) */
1749 const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */
1750 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1751 const char *org; /**< party/company responsible for the module */
1752 const char *contact; /**< contact information for the module */
1753 const char *dsc; /**< description of the module */
1754 const char *ref; /**< cross-reference for the module */
1755
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001756 struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */
Radek Krejci0af46292019-01-11 16:02:31 +01001757 struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing.
1758 Available only for implemented modules. */
1759 struct lysc_feature *off_features;/**< List of pre-compiled features of the module in non implemented modules ([sized array](@ref sizedarrays)).
1760 These features are always disabled and cannot be enabled until the module
1761 become implemented. The features are present in this form to allow their linkage
1762 from if-feature statements of the compiled schemas and their proper use in case
1763 the module became implemented in future (no matter if implicitly via augment/deviate
1764 or explicitly via ly_ctx_module_implement()). */
Radek Krejci0935f412019-08-20 16:15:18 +02001765 struct lysc_ext *off_extensions; /**< List of pre-compiled extension definitions of the module in non-implemented modules
1766 ([sized array](@ref sizedarrays)). These extensions are prepared to be linked with the extension instances,
1767 but they are not implemented (connected with any extension plugin). In case the module become
1768 implemented, the list is moved into the compiled module structure and available extension plugins
1769 are connected with the appropriate extension definision. */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001770
Radek Krejci95710c92019-02-11 15:49:55 +01001771 uint8_t implemented; /**< flag if the module is implemented, not just imported. The module is implemented if
1772 the flag has non-zero value. Specific values are used internally:
1773 1 - implemented module
1774 2 - recently implemented module by dependency, it can be reverted in rollback procedure */
1775 uint8_t latest_revision; /**< flag to mark the latest available revision:
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001776 1 - the latest revision in searchdirs was not searched yet and this is the
1777 latest revision in the current context
1778 2 - searchdirs were searched and this is the latest available revision */
1779 uint8_t version; /**< yang-version (LYS_VERSION values) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001780};
1781
Radek Krejci151a5b72018-10-19 14:21:44 +02001782/**
1783 * @brief Enable specified feature in the module
1784 *
1785 * By default, when the module is loaded by libyang parser, all features are disabled.
1786 *
Radek Krejcica3db002018-11-01 10:31:01 +01001787 * If all features are being enabled, it must be possible respecting their if-feature conditions. For example,
1788 * enabling all features on the following feature set will fail since it is not possible to enable both features
1789 * (and it is unclear which of them should be enabled then). In this case the LY_EDENIED is returned and the feature
1790 * is untouched.
1791 *
1792 * feature f1;
1793 * feature f2 { if-feature 'not f1';}
1794 *
Radek Krejci151a5b72018-10-19 14:21:44 +02001795 * @param[in] module Module where the feature will be enabled.
1796 * @param[in] feature Name of the feature to enable. To enable all features at once, use asterisk (`*`) character.
1797 * @return LY_ERR value.
1798 */
Radek Krejcied5acc52019-04-25 15:57:04 +02001799LY_ERR lys_feature_enable(const struct lys_module *module, const char *feature);
Radek Krejci151a5b72018-10-19 14:21:44 +02001800
1801/**
1802 * @brief Disable specified feature in the module
1803 *
1804 * By default, when the module is loaded by libyang parser, all features are disabled.
1805 *
1806 * @param[in] module Module where the feature will be disabled.
1807 * @param[in] feature Name of the feature to disable. To disable all features at once, use asterisk (`*`) character.
1808 * @return LY_ERR value
1809 */
Radek Krejcied5acc52019-04-25 15:57:04 +02001810LY_ERR lys_feature_disable(const struct lys_module *module, const char *feature);
Radek Krejci151a5b72018-10-19 14:21:44 +02001811
1812/**
1813 * @brief Get the current status of the specified feature in the module.
1814 *
1815 * @param[in] module Module where the feature is defined.
1816 * @param[in] feature Name of the feature to inspect.
1817 * @return
1818 * - 1 if feature is enabled,
1819 * - 0 if feature is disabled,
1820 * - -1 in case of error (e.g. feature is not defined or invalid arguments)
1821 */
1822int lys_feature_value(const struct lys_module *module, const char *feature);
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001823
1824/**
Radek Krejci86d106e2018-10-18 09:53:19 +02001825 * @brief Load a schema into the specified context.
1826 *
1827 * @param[in] ctx libyang context where to process the data model.
1828 * @param[in] data The string containing the dumped data model in the specified
1829 * format.
1830 * @param[in] format Format of the input data (YANG or YIN).
1831 * @return Pointer to the data model structure or NULL on error.
1832 */
Radek Krejcid14e9692018-11-01 11:00:37 +01001833struct lys_module *lys_parse_mem(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format);
Radek Krejci86d106e2018-10-18 09:53:19 +02001834
1835/**
1836 * @brief Read a schema from file descriptor into the specified context.
1837 *
1838 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
1839 *
1840 * @param[in] ctx libyang context where to process the data model.
1841 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
1842 * in the specified format.
1843 * @param[in] format Format of the input data (YANG or YIN).
1844 * @return Pointer to the data model structure or NULL on error.
1845 */
Radek Krejcid14e9692018-11-01 11:00:37 +01001846struct lys_module *lys_parse_fd(struct ly_ctx *ctx, int fd, LYS_INFORMAT format);
Radek Krejci86d106e2018-10-18 09:53:19 +02001847
1848/**
Radek Krejcid33273d2018-10-25 14:55:52 +02001849 * @brief Read a schema into the specified context from a file.
Radek Krejci86d106e2018-10-18 09:53:19 +02001850 *
1851 * @param[in] ctx libyang context where to process the data model.
1852 * @param[in] path Path to the file with the model in the specified format.
1853 * @param[in] format Format of the input data (YANG or YIN).
1854 * @return Pointer to the data model structure or NULL on error.
1855 */
Radek Krejcid14e9692018-11-01 11:00:37 +01001856struct lys_module *lys_parse_path(struct ly_ctx *ctx, const char *path, LYS_INFORMAT format);
Radek Krejci86d106e2018-10-18 09:53:19 +02001857
1858/**
Radek Krejcid33273d2018-10-25 14:55:52 +02001859 * @brief Search for the schema file in the specified searchpaths.
1860 *
1861 * @param[in] searchpaths NULL-terminated array of paths to be searched (recursively). Current working
1862 * directory is searched automatically (but non-recursively if not in the provided list). Caller can use
1863 * result of the ly_ctx_get_searchdirs().
1864 * @param[in] cwd Flag to implicitly search also in the current working directory (non-recursively).
1865 * @param[in] name Name of the schema to find.
1866 * @param[in] revision Revision of the schema to find. If NULL, the newest found schema filepath is returned.
1867 * @param[out] localfile Mandatory output variable containing absolute path of the found schema. If no schema
1868 * complying the provided restriction is found, NULL is set.
1869 * @param[out] format Optional output variable containing expected format of the schema document according to the
1870 * file suffix.
1871 * @return LY_ERR value (LY_SUCCESS is returned even if the file is not found, then the *localfile is NULL).
1872 */
1873LY_ERR lys_search_localfile(const char * const *searchpaths, int cwd, const char *name, const char *revision, char **localfile, LYS_INFORMAT *format);
1874
1875/**
Radek Krejcia3045382018-11-22 14:30:31 +01001876 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can
1877 * be from an augment.
1878 *
1879 * lys_getnext() is supposed to be called sequentially. In the first call, the \p last parameter is usually NULL
1880 * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module.
1881 * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
1882 * \p parent and \p module parameters.
1883 *
1884 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
1885 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
1886 * all the schema nodes are iteratively returned.
1887 *
1888 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
1889 * @param[in] parent Parent of the subtree where the function starts processing.
1890 * @param[in] module In case of iterating on top level elements, the \p parent is NULL and
1891 * module must be specified.
1892 * @param[in] options [ORed options](@ref sgetnextflags).
1893 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
1894 */
1895const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
1896 const struct lysc_module *module, int options);
1897
1898/**
1899 * @defgroup sgetnextflags lys_getnext() flags
1900 * @ingroup schematree
1901 *
1902 * @{
1903 */
1904#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 +01001905#define LYS_GETNEXT_NOCHOICE 0x02 /**< lys_getnext() option to ignore (kind of conditional) nodes within choice node */
Radek Krejci056d0a82018-12-06 16:57:25 +01001906#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 +01001907#define LYS_GETNEXT_INTONPCONT 0x40 /**< lys_getnext() option to look into non-presence container, instead of returning container itself */
1908#define LYS_GETNEXT_NOSTATECHECK 0x100 /**< lys_getnext() option to skip checking module validity (import-only, disabled) and
1909 relevant if-feature conditions state */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001910#define LYS_GETNEXT_OUTPUT 0x200 /**< lys_getnext() option to provide RPC's/action's output schema nodes instead of input schema nodes
1911 provided by default */
Radek Krejcia3045382018-11-22 14:30:31 +01001912/** @} sgetnextflags */
1913
1914/**
1915 * @brief Get child node according to the specified criteria.
1916 *
1917 * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched.
1918 * @param[in] module module of the node to find. It is also limitation for the children node of the given parent.
1919 * @param[in] name Name of the node to find.
1920 * @param[in] name_len Optional length of the name in case it is not NULL-terminated string.
1921 * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find.
1922 * Used as a bitmask, so multiple nodetypes can be specified.
1923 * @param[in] options [ORed options](@ref sgetnextflags).
1924 * @return Found node if any.
1925 */
1926const struct lysc_node *lys_child(const struct lysc_node *parent, const struct lys_module *module,
1927 const char *name, size_t name_len, uint16_t nodetype, int options);
1928
1929/**
1930 * @brief Check if the schema node is disabled in the schema tree, i.e. there is any disabled if-feature statement
1931 * affecting the node.
1932 *
1933 * @param[in] node Schema node to check.
1934 * @param[in] recursive - 0 to check if-feature only in the \p node schema node,
1935 * - 1 to check if-feature in all ascendant schema nodes until there is a node possibly having an instance in a data tree
1936 * @return - NULL if enabled,
1937 * - pointer to the node with the unsatisfied (disabling) if-feature expression.
1938 */
1939const struct lysc_iffeature *lys_is_disabled(const struct lysc_node *node, int recursive);
1940
Radek Krejci084289f2019-07-09 17:35:30 +02001941/**
1942 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
1943 *
1944 * This function check just the type's restriction, if you want to check also the data tree context (e.g. in case of
1945 * require-instance restriction), use lyd_value_validate().
1946 *
1947 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
1948 * @param[in] node Schema node for the @p value.
1949 * @param[in] value String value to be checked.
1950 * @param[in] value_len Length of the given @p value (mandatory).
1951 * @param[in] get_prefix Callback function to resolve prefixes used in the @p value string.
1952 * @param[in] get_prefix_data Private data for the @p get_prefix callback.
1953 * @param[in] format Input format of the @p value.
1954 * @return LY_SUCCESS on success
1955 * @return LY_ERR value if an error occurred.
1956 */
1957LY_ERR lys_value_validate(struct ly_ctx *ctx, const struct lysc_node *node, const char *value, size_t value_len,
1958 ly_clb_resolve_prefix get_prefix, void *get_prefix_data, LYD_FORMAT format);
1959
Radek Krejci0935f412019-08-20 16:15:18 +02001960/**
1961 * @brief Stringify schema nodetype.
1962 * @param[in] nodetype Nodetype to stringify.
1963 * @return Constant string with the name of the node's type.
1964 */
1965const char *lys_nodetype2str(uint16_t nodetype);
1966
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001967/** @} */
1968
Radek Krejci70853c52018-10-15 14:46:16 +02001969#ifdef __cplusplus
1970}
1971#endif
1972
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001973#endif /* LY_TREE_SCHEMA_H_ */