blob: b7a8c5df7510d6621302b080ac3d4515e539ad11 [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 Krejcif56e2a42019-09-09 14:15:25 +0200373 uint16_t flags; /**< LYS_STATUS_* and LYS_YINELEM_* values (@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200374};
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) */
Radek Krejcif56e2a42019-09-09 14:15:25 +0200399 struct lysc_ext_instance *compiled; /**< pointer to the compiled data if any - in case the source format is YIN,
400 some of the information (argument) are available only after compilation */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200401 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
402 uint32_t insubstmt_index; /**< in case the instance is in a substatement, this identifies
403 the index of that substatement */
David Sedlákae4b4512019-08-14 10:45:56 +0200404 uint8_t yin; /** flag for YIN source format, can be set to LYS_YIN */
Radek Krejci335332a2019-09-05 13:03:35 +0200405 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200406};
407
408/**
409 * @brief YANG feature-stmt
410 */
411struct lysp_feature {
412 const char *name; /**< feature name (mandatory) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200413 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200414 const char *dsc; /**< description statement */
415 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200416 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200417 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values allowed */
418};
419
420/**
421 * @brief YANG identity-stmt
422 */
423struct lysp_ident {
424 const char *name; /**< identity name (mandatory), including possible prefix */
Radek Krejci151a5b72018-10-19 14:21:44 +0200425 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
426 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200427 const char *dsc; /**< description statement */
428 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200429 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200430 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
431};
432
Michal Vasko71e64ca2018-09-07 16:30:29 +0200433/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200434 * @brief Covers restrictions: range, length, pattern, must
435 */
436struct lysp_restr {
437 const char *arg; /**< The restriction expression/value (mandatory);
438 in case of pattern restriction, the first byte has a special meaning:
439 0x06 (ACK) for regular match and 0x15 (NACK) for invert-match */
440 const char *emsg; /**< error-message */
441 const char *eapptag; /**< error-app-tag value */
442 const char *dsc; /**< description */
443 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200444 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200445};
446
447/**
Michal Vasko71e64ca2018-09-07 16:30:29 +0200448 * @brief YANG revision-stmt
449 */
450struct lysp_revision {
Radek Krejcib7db73a2018-10-24 14:18:40 +0200451 char date[LY_REV_SIZE]; /**< revision date (madatory) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200452 const char *dsc; /**< description statement */
453 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200454 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko71e64ca2018-09-07 16:30:29 +0200455};
456
457/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200458 * @brief Enumeration/Bit value definition
459 */
460struct lysp_type_enum {
461 const char *name; /**< name (mandatory) */
462 const char *dsc; /**< description statement */
463 const char *ref; /**< reference statement */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200464 int64_t value; /**< enum's value or bit's position */
Radek Krejci151a5b72018-10-19 14:21:44 +0200465 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200466 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200467 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
468 values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200469};
470
471/**
472 * @brief YANG type-stmt
473 *
474 * Some of the items in the structure may be mandatory, but it is necessary to resolve the type's base type first
475 */
476struct lysp_type {
477 const char *name; /**< name of the type (mandatory) */
478 struct lysp_restr *range; /**< allowed values range - numerical, decimal64 */
479 struct lysp_restr *length; /**< allowed length of the value - string, binary */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200480 struct lysp_restr *patterns; /**< list of patterns ([sized array](@ref sizedarrays)) - string */
481 struct lysp_type_enum *enums; /**< list of enum-stmts ([sized array](@ref sizedarrays)) - enum */
482 struct lysp_type_enum *bits; /**< list of bit-stmts ([sized array](@ref sizedarrays)) - bits */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200483 const char *path; /**< path - leafref */
Radek Krejci151a5b72018-10-19 14:21:44 +0200484 const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) - identityref */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200485 struct lysp_type *types; /**< list of sub-types ([sized array](@ref sizedarrays)) - union */
486 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200487
Radek Krejci2167ee12018-11-02 16:09:07 +0100488 struct lysc_type *compiled; /**< pointer to the compiled type */
489
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200490 uint8_t fraction_digits; /**< number of fraction digits - decimal64 */
491 uint8_t require_instance; /**< require-instance flag - leafref, instance */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100492 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200493};
494
495/**
496 * @brief YANG typedef-stmt
497 */
498struct lysp_tpdf {
499 const char *name; /**< name of the newly defined type (mandatory) */
500 const char *units; /**< units of the newly defined type */
501 const char *dflt; /**< default value of the newly defined type */
502 const char *dsc; /**< description statement */
503 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200504 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200505 struct lysp_type type; /**< base type from which the typedef is derived (mandatory) */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100506 uint16_t flags; /**< [schema node flags](@ref spnodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200507};
508
509/**
510 * @brief YANG grouping-stmt
511 */
512struct lysp_grp {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100513 struct lysp_node *parent; /**< parent node (NULL if this is a top-level grouping) */
514 uint16_t nodetype; /**< LYS_GROUPING */
515 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200516 const char *name; /**< grouping name (mandatory) */
517 const char *dsc; /**< description statement */
518 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200519 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
520 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200521 struct lysp_node *data; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200522 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
523 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
524 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200525};
526
527/**
528 * @brief YANG when-stmt
529 */
530struct lysp_when {
531 const char *cond; /**< specified condition (mandatory) */
532 const char *dsc; /**< description statement */
533 const char *ref; /**< reference statement */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200534 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200535};
536
537/**
538 * @brief YANG refine-stmt
539 */
540struct lysp_refine {
541 const char *nodeid; /**< target descendant schema nodeid (mandatory) */
542 const char *dsc; /**< description statement */
543 const char *ref; /**< reference statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200544 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200545 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200546 const char *presence; /**< presence description */
Radek Krejci151a5b72018-10-19 14:21:44 +0200547 const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200548 uint32_t min; /**< min-elements constraint */
549 uint32_t max; /**< max-elements constraint, 0 means unbounded */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200550 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200551 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
552};
553
554/**
555 * @brief YANG uses-augment-stmt and augment-stmt
556 */
557struct lysp_augment {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100558 struct lysp_node *parent; /**< parent node (NULL if this is a top-level augment) */
559 uint16_t nodetype; /**< LYS_AUGMENT */
560 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200561 const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */
562 const char *dsc; /**< description statement */
563 const char *ref; /**< reference statement */
564 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200565 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200566 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200567 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
568 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
569 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200570};
571
572/**
573 * @defgroup deviatetypes Deviate types
574 * @{
575 */
576#define LYS_DEV_NOT_SUPPORTED 1 /**< deviate type not-supported */
577#define LYS_DEV_ADD 2 /**< deviate type add */
578#define LYS_DEV_DELETE 3 /**< deviate type delete */
579#define LYS_DEV_REPLACE 4 /**< deviate type replace */
580/** @} */
581
582/**
583 * @brief Generic deviate structure to get type and cast to lysp_deviate_* structure
584 */
585struct lysp_deviate {
586 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
587 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200588 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200589};
590
591struct lysp_deviate_add {
592 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
593 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200594 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200595 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200596 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200597 const char **uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
598 const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200599 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
600 uint32_t min; /**< min-elements constraint */
601 uint32_t max; /**< max-elements constraint, 0 means unbounded */
602};
603
604struct lysp_deviate_del {
605 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
606 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200607 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200608 const char *units; /**< units of the values */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200609 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200610 const char **uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */
611 const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200612};
613
614struct lysp_deviate_rpl {
615 uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */
616 struct lysp_deviate *next; /**< next deviate structure in the list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200617 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200618 struct lysp_type *type; /**< type of the node */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200619 const char *units; /**< units of the values */
620 const char *dflt; /**< default value */
621 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
622 uint32_t min; /**< min-elements constraint */
623 uint32_t max; /**< max-elements constraint, 0 means unbounded */
624};
625
626struct lysp_deviation {
Michal Vaskob55f6c12018-09-12 11:13:15 +0200627 const char *nodeid; /**< target absolute schema nodeid (mandatory) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200628 const char *dsc; /**< description statement */
629 const char *ref; /**< reference statement */
630 struct lysp_deviate* deviates; /**< list of deviate specifications (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200631 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200632};
633
Radek Krejci4f28eda2018-11-12 11:46:16 +0100634/**
635 * @defgroup spnodeflags Parsed schema nodes flags
636 * @ingroup snodeflags
637 *
638 * Various flags for parsed schema nodes.
639 *
640 * 1 - container 6 - anydata/anyxml 11 - output 16 - grouping 21 - enum
641 * 2 - choice 7 - case 12 - feature 17 - uses 22 - type
Radek Krejcid3ca0632019-04-16 16:54:54 +0200642 * 3 - leaf 8 - notification 13 - identity 18 - refine 23 - stmt
Radek Krejci4f28eda2018-11-12 11:46:16 +0100643 * 4 - leaflist 9 - rpc 14 - extension 19 - augment
644 * 5 - list 10 - input 15 - typedef 20 - deviate
645 *
Radek Krejcid3ca0632019-04-16 16:54:54 +0200646 * 1 1 1 1 1 1 1 1 1 1 2 2 2 2
647 * 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
648 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
649 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | | | | |x| |x| | | |
650 * LYS_SET_BASE | | | | | | | | | | | | | | | | | | | | | |x| |
651 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
652 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | | | | |x| |x| | | |
653 * LYS_SET_BIT | | | | | | | | | | | | | | | | | | | | | |x| |
654 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
655 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
656 * LYS_SET_ENUM | | | | | | | | | | | | | | | | | | | | | |x| |
657 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
658 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
659 * LYS_SET_FRDIGITS | | | | | | | | | | | | | | | | | | | | | |x| |
660 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
661 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | |
662 * LYS_SET_LENGTH | | | | | | | | | | | | | | | | | | | | | |x| |
663 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
664 * 6 LYS_MAND_TRUE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
665 * LYS_SET_PATH | | | | | | | | | | | | | | | | | | | | | |x| |
666 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
667 * 7 LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | | |x| |x| | | |
668 * LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | | | | | | | | |
669 * LYS_SET_PATTERN | | | | | | | | | | | | | | | | | | | | | |x| |
670 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
671 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | | | | | | | | |
672 * LYS_YINELEM_TRUE | | | | | | | | | | | | | |x| | | | | | | | | |
673 * LYS_SET_RANGE | | | | | | | | | | | | | | | | | | | | | |x| |
674 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
675 * 9 LYS_YINELEM_FALSE| | | | | | | | | | | | | |x| | | | | | | | | |
676 * LYS_SET_TYPE | | | | | | | | | | | | | | | | | | | | | |x| |
677 * LYS_SINGLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
678 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
679 * 10 LYS_SET_VALUE | | | | | | | | | | | | | | | | | | | | |x| | |
680 * LYS_SET_REQINST | | | | | | | | | | | | | | | | | | | | | |x| |
681 * LYS_SET_MIN | | | |x|x| | | | | | | | | | | | |x| |x| | | |
682 * LYS_DOUBLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x|
683 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
684 * 11 LYS_SET_MAX | | | |x|x| | | | | | | | | | | | |x| |x| | | |
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200685 * LYS_USED_GRP | | | | | | | | | | | | | | | |x| | | | | | | |
David Sedlákae4b4512019-08-14 10:45:56 +0200686 * LYS_YIN_ATTR | | | | | | | | | | | | | | | | | | | | | | |x|
Radek Krejcid3ca0632019-04-16 16:54:54 +0200687 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejcif56e2a42019-09-09 14:15:25 +0200688 * 12 LYS_YIN_ARGUMENT | | | | | | | | | | | | | | | | | | | | | | |x|
689 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100690 *
691 */
692
693/**
694 * @defgroup scnodeflags Compiled schema nodes flags
695 * @ingroup snodeflags
696 *
697 * Various flags for compiled schema nodes.
698 *
Radek Krejci61e042e2019-09-10 15:53:09 +0200699 * 1 - container 6 - anydata/anyxml 11 - identity
700 * 2 - choice 7 - case 12 - extension
701 * 3 - leaf 8 - notification 13 - bitenum
Michal Vasko03ff5a72019-09-11 13:49:33 +0200702 * 4 - leaflist 9 - rpc/action 14 - when
703 * 5 - list 10 - feature 15 - must
Radek Krejci4f28eda2018-11-12 11:46:16 +0100704 *
Michal Vasko03ff5a72019-09-11 13:49:33 +0200705 * 1 1 1 1 1 1
706 * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
707 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
708 * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | | |
709 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
710 * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | | |
711 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
712 * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x|x|x|x| | | |
713 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
714 * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x|x|x|x| | | |
715 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
716 * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x|x|x|x| | | |
717 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
718 * 6 LYS_MAND_TRUE |x|x|x|x|x|x| | | | | | | | | |
719 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
720 * 7 LYS_ORDBY_USER | | | |x|x| | | | | | | | | | |
721 * LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | |
722 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
723 * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | |
724 * LYS_PRESENCE |x| | | | | | | | | | | | | | |
725 * LYS_UNIQUE | | |x| | | | | | | | | | | | |
726 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
727 * 9 LYS_KEY | | |x| | | | | | | | | | | | |
728 * LYS_FENABLED | | | | | | | | | |x| | | | | |
729 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
730 * 10 LYS_SET_DFLT | | |x|x| | |x| | | | | | | | |
731 * LYS_ISENUM | | | | | | | | | | | | |x| | |
732 * LYS_KEYLESS | | | | |x| | | | | | | | | | |
733 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
734 * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | | |
735 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
736 * 12 LYS_SET_CONFIG |x|x|x|x|x|x| | | | | | | | | |
737 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
738 * 13 LYS_XPATH_DEP |x|x|x|x|x|x|x|x| | | | | |x|x|
739 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
740 * 14 LYS_LEAFREF_DEP | | |x|x| | | | | | | | | | | |
741 * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Radek Krejci4f28eda2018-11-12 11:46:16 +0100742 *
743 */
744
745/**
746 * @defgroup snodeflags Schema nodes flags
747 * @ingroup schematree
748 * @{
749 */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200750#define LYS_CONFIG_W 0x01 /**< config true; */
751#define LYS_CONFIG_R 0x02 /**< config false; */
752#define LYS_CONFIG_MASK 0x03 /**< mask for config value */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100753#define LYS_STATUS_CURR 0x04 /**< status current; */
754#define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */
755#define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */
756#define LYS_STATUS_MASK 0x1C /**< mask for status value */
757#define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice,
Radek Krejcife909632019-02-12 15:34:42 +0100758 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
759 The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0.
760 The ::lysc_node_container has this flag if it is not a presence container and it has at least one
761 child with LYS_MAND_TRUE. */
Radek Krejcif1421c22019-02-19 13:05:20 +0100762#define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice,
763 ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata.
764 This flag is present only in case the mandatory false statement was explicitly specified. */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100765#define LYS_MAND_MASK 0x60 /**< mask for mandatory values */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100766#define LYS_PRESENCE 0x80 /**< flag for presence property of a container, applicable only to ::lysc_node_container */
767#define LYS_UNIQUE 0x80 /**< flag for leafs being part of a unique set, applicable only to ::lysc_node_leaf */
768#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 +0200769#define LYS_KEYLESS 0x200 /**< flag for list without any key, applicable only to ::lysc_node_list */
Radek Krejci7adf4ff2018-12-05 08:55:00 +0100770#define LYS_FENABLED 0x100 /**< feature enabled flag, applicable only to ::lysc_feature */
Radek Krejcife909632019-02-12 15:34:42 +0100771#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 +0100772 ::lysc_node_list/::lysp_node_list */
773#define LYS_ORDBY_USER 0x40 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and
774 ::lysc_node_list/::lysp_node_list */
775#define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */
776#define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */
777#define LYS_YINELEM_FALSE 0x100 /**< yin-element false for extension's argument */
778#define LYS_YINELEM_MASK 0x180 /**< mask for yin-element value */
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200779#define LYS_USED_GRP 0x400 /**< internal flag for validating not-instantiated groupings
780 (resp. do not validate again the instantiated groupings). */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100781#define LYS_SET_VALUE 0x200 /**< value attribute is set */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100782#define LYS_SET_MIN 0x200 /**< min attribute is set */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200783#define LYS_SET_MAX 0x400 /**< max attribute is set */
Radek Krejcid505e3d2018-11-13 09:04:17 +0100784
785#define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */
786#define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */
787#define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */
788#define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */
789#define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */
790#define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */
791#define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */
792#define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */
793#define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */
794#define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */
Radek Krejciccd20f12019-02-15 14:12:27 +0100795#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 +0100796 cases of choice. This information is important for refines, since it is prohibited to make leafs
797 with default statement mandatory. In case the default leaf value is taken from type, it is thrown
Radek Krejciccd20f12019-02-15 14:12:27 +0100798 away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish
799 between own default or the default values taken from the type. */
800#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 +0100801#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 +0100802
Michal Vasko03ff5a72019-09-11 13:49:33 +0200803#define LYS_XPATH_DEP 0x1000 /**< flag for nodes with when/must with external data dependency. */
804#define LYS_LEAFREF_DEP 0x2000 /**< flag for leaves(-lists) with leafref with external dependency. */
805
Radek Krejcif56e2a42019-09-09 14:15:25 +0200806#define LYS_SINGLEQUOTED 0x100 /**< flag for single-quoted argument of an extension instance's substatement, only when the source is YANG */
807#define LYS_DOUBLEQUOTED 0x200 /**< flag for double-quoted argument of an extension instance's substatement, only when the source is YANG */
Radek Krejcid3ca0632019-04-16 16:54:54 +0200808
Radek Krejcif56e2a42019-09-09 14:15:25 +0200809#define LYS_YIN_ATTR 0x400 /**< flag to identify YIN attribute parsed as extension's substatement, only when the source is YIN */
810#define LYS_YIN_ARGUMENT 0x800 /**< flag to identify statement representing extension's argument, only when the source is YIN */
David Sedlákbbd06ca2019-06-27 14:15:38 +0200811
Radek Krejci693262f2019-04-29 15:23:20 +0200812#define LYS_ISENUM 0x200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */
813
Radek Krejcife909632019-02-12 15:34:42 +0100814#define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */
Radek Krejci4f28eda2018-11-12 11:46:16 +0100815/** @} */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200816
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200817/**
818 * @brief Generic YANG data node
819 */
820struct lysp_node {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100821 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200822 uint16_t nodetype; /**< type of the node (mandatory) */
823 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100824 struct lysp_node *next; /**< next sibling node (NULL if there is no one) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200825 const char *name; /**< node name (mandatory) */
826 const char *dsc; /**< description statement */
827 const char *ref; /**< reference statement */
828 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200829 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200830 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200831};
832
833/**
834 * @brief Extension structure of the lysp_node for YANG container
835 */
836struct lysp_node_container {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100837 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200838 uint16_t nodetype; /**< LYS_CONTAINER */
839 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
840 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
841 const char *name; /**< node name (mandatory) */
842 const char *dsc; /**< description statement */
843 const char *ref; /**< reference statement */
844 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200845 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200846 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200847
848 /* container */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200849 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200850 const char *presence; /**< presence description */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200851 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
852 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200853 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200854 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
855 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200856};
857
858struct lysp_node_leaf {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100859 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200860 uint16_t nodetype; /**< LYS_LEAF */
861 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
862 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
863 const char *name; /**< node name (mandatory) */
864 const char *dsc; /**< description statement */
865 const char *ref; /**< reference statement */
866 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200867 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200868 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200869
870 /* leaf */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200871 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200872 struct lysp_type type; /**< type of the leaf node (mandatory) */
873 const char *units; /**< units of the leaf's type */
874 const char *dflt; /**< default value */
875};
876
877struct lysp_node_leaflist {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100878 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200879 uint16_t nodetype; /**< LYS_LEAFLIST */
880 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
881 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
882 const char *name; /**< node name (mandatory) */
883 const char *dsc; /**< description statement */
884 const char *ref; /**< reference statement */
885 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200886 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200887 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200888
889 /* leaf-list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200890 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200891 struct lysp_type type; /**< type of the leaf node (mandatory) */
892 const char *units; /**< units of the leaf's type */
Radek Krejci151a5b72018-10-19 14:21:44 +0200893 const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200894 uint32_t min; /**< min-elements constraint */
895 uint32_t max; /**< max-elements constraint, 0 means unbounded */
896};
897
898struct lysp_node_list {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100899 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200900 uint16_t nodetype; /**< LYS_LIST */
901 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
902 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
903 const char *name; /**< node name (mandatory) */
904 const char *dsc; /**< description statement */
905 const char *ref; /**< reference statement */
906 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200907 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200908 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200909
910 /* list */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200911 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200912 const char *key; /**< keys specification */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200913 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
914 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200915 struct lysp_node *child; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200916 struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
917 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +0200918 const char **uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200919 uint32_t min; /**< min-elements constraint */
920 uint32_t max; /**< max-elements constraint, 0 means unbounded */
921};
922
923struct lysp_node_choice {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100924 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200925 uint16_t nodetype; /**< LYS_CHOICE */
926 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
927 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
928 const char *name; /**< node name (mandatory) */
929 const char *dsc; /**< description statement */
930 const char *ref; /**< reference statement */
931 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200932 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200933 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200934
935 /* choice */
936 struct lysp_node *child; /**< list of data nodes (linked list) */
937 const char* dflt; /**< default case */
938};
939
940struct lysp_node_case {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100941 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200942 uint16_t nodetype; /**< LYS_CASE */
943 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
944 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
945 const char *name; /**< node name (mandatory) */
946 const char *dsc; /**< description statement */
947 const char *ref; /**< reference statement */
948 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200949 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200950 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200951
952 /* case */
953 struct lysp_node *child; /**< list of data nodes (linked list) */
954};
955
956struct lysp_node_anydata {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100957 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200958 uint16_t nodetype; /**< LYS_ANYXML || LYS_ANYDATA */
959 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
960 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
961 const char *name; /**< node name (mandatory) */
962 const char *dsc; /**< description statement */
963 const char *ref; /**< reference statement */
964 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200965 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200966 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200967
968 /* anyxml/anydata */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200969 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200970};
971
972struct lysp_node_uses {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100973 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
Michal Vaskob55f6c12018-09-12 11:13:15 +0200974 uint16_t nodetype; /**< LYS_USES */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200975 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
976 struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
977 const char *name; /**< grouping name reference (mandatory) */
978 const char *dsc; /**< description statement */
979 const char *ref; /**< reference statement */
980 struct lysp_when *when; /**< when statement */
Radek Krejci151a5b72018-10-19 14:21:44 +0200981 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200982 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200983
984 /* uses */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200985 struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */
986 struct lysp_augment *augments; /**< list of uses's augment ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200987};
988
989/**
990 * @brief YANG input-stmt and output-stmt
991 */
992struct lysp_action_inout {
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100993 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
994 uint16_t nodetype; /**< LYS_INOUT */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200995 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
996 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
997 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200998 struct lysp_node *data; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200999 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001000};
1001
1002/**
1003 * @brief YANG rpc-stmt and action-stmt
1004 */
1005struct lysp_action {
Radek Krejci6d9b9b52018-11-02 12:43:39 +01001006 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1007 uint16_t nodetype; /**< LYS_ACTION */
1008 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001009 const char *name; /**< grouping name reference (mandatory) */
1010 const char *dsc; /**< description statement */
1011 const char *ref; /**< reference statement */
Radek Krejci151a5b72018-10-19 14:21:44 +02001012 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001013 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1014 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001015 struct lysp_action_inout input; /**< RPC's/Action's input */
1016 struct lysp_action_inout output; /**< RPC's/Action's output */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001017 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001018};
1019
1020/**
1021 * @brief YANG notification-stmt
1022 */
1023struct lysp_notif {
Radek Krejci6d9b9b52018-11-02 12:43:39 +01001024 struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */
1025 uint16_t nodetype; /**< LYS_NOTIF */
1026 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001027 const char *name; /**< grouping name reference (mandatory) */
1028 const char *dsc; /**< description statement */
1029 const char *ref; /**< reference statement */
Radek Krejci151a5b72018-10-19 14:21:44 +02001030 const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001031 struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1032 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1033 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001034 struct lysp_node *data; /**< list of data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001035 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001036};
1037
1038/**
Radek Krejcif0fceb62018-09-05 14:58:45 +02001039 * @brief supported YANG schema version values
1040 */
1041typedef enum LYS_VERSION {
1042 LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */
1043 LYS_VERSION_1_0 = 1, /**< YANG 1.0 */
1044 LYS_VERSION_1_1 = 2 /**< YANG 1.1 */
1045} LYS_VERSION;
1046
1047/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001048 * @brief Printable YANG schema tree structure representing YANG module.
1049 *
1050 * Simple structure corresponding to the YANG format. The schema is only syntactically validated.
1051 */
1052struct lysp_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001053 struct lys_module *mod; /**< covering module structure */
1054
Radek Krejcib7db73a2018-10-24 14:18:40 +02001055 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1056 in the list is always the last (newest) revision of the module */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001057 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1058 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001059 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1060 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1061 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1062 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1063 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001064 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001065 struct lysp_augment *augments; /**< list of augments ([sized array](@ref sizedarrays)) */
1066 struct lysp_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */
1067 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
1068 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
1069 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001070
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001071 uint8_t parsing:1; /**< flag for circular check */
1072};
1073
1074struct lysp_submodule {
1075 const char *belongsto; /**< belongs to parent module (submodule - mandatory) */
1076
1077 struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision
1078 in the list is always the last (newest) revision of the module */
1079 struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
1080 struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */
1081 struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */
1082 struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
1083 struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1084 struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */
1085 struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */
1086 struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */
1087 struct lysp_augment *augments; /**< list of augments ([sized array](@ref sizedarrays)) */
1088 struct lysp_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */
1089 struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
1090 struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */
1091 struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1092
1093 uint8_t parsing:1; /**< flag for circular check */
1094
Radek Krejci086c7132018-10-26 15:29:04 +02001095 uint8_t latest_revision:2; /**< flag to mark the latest available revision:
1096 1 - the latest revision in searchdirs was not searched yet and this is the
1097 latest revision in the current context
1098 2 - searchdirs were searched and this is the latest available revision */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001099 const char *name; /**< name of the module (mandatory) */
1100 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1101 const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */
1102 const char *org; /**< party/company responsible for the module */
1103 const char *contact; /**< contact information for the module */
1104 const char *dsc; /**< description of the module */
1105 const char *ref; /**< cross-reference for the module */
Radek Krejci086c7132018-10-26 15:29:04 +02001106 uint8_t version; /**< yang-version (LYS_VERSION values) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001107};
1108
1109/**
Radek Krejci3f5e3db2018-10-11 15:57:47 +02001110 * @brief Free the printable YANG schema tree structure.
1111 *
1112 * @param[in] module Printable YANG schema tree structure to free.
1113 */
1114void lysp_module_free(struct lysp_module *module);
1115
1116/**
Radek Krejci0e59c312019-08-15 15:34:15 +02001117 * @brief Compiled YANG extension-stmt
1118 */
1119struct lysc_ext {
1120 const char *name; /**< extension name */
1121 const char *argument; /**< argument name, NULL if not specified */
Radek Krejci0e59c312019-08-15 15:34:15 +02001122 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1123 struct lyext_plugin *plugin; /**< Plugin implementing the specific extension */
Radek Krejci0935f412019-08-20 16:15:18 +02001124 struct lys_module *module; /**< module structure */
Radek Krejci0e59c312019-08-15 15:34:15 +02001125 uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */
1126};
1127
1128/**
Radek Krejcice8c1592018-10-29 15:35:51 +01001129 * @brief YANG extension instance
1130 */
1131struct lysc_ext_instance {
Radek Krejciad5963b2019-09-06 16:03:05 +02001132 uint32_t insubstmt_index; /**< in case the instance is in a substatement that can appear multiple times,
1133 this identifies the index of the substatement for this extension instance */
Radek Krejci28681fa2019-09-06 13:08:45 +02001134 struct lys_module *module; /**< module where the extension instantiated is defined */
Radek Krejciad5963b2019-09-06 16:03:05 +02001135 struct lysc_ext *def; /**< pointer to the extension definition */
Radek Krejcice8c1592018-10-29 15:35:51 +01001136 void *parent; /**< pointer to the parent element holding the extension instance(s), use
1137 ::lysc_ext_instance#parent_type to access the schema element */
1138 const char *argument; /**< optional value of the extension's argument */
1139 LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */
Radek Krejci2a408df2018-10-29 16:32:26 +01001140 LYEXT_PARENT parent_type; /**< type of the parent structure */
Radek Krejci2a408df2018-10-29 16:32:26 +01001141 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0e59c312019-08-15 15:34:15 +02001142 void *data; /**< private plugins's data, not used by libyang */
Radek Krejcice8c1592018-10-29 15:35:51 +01001143};
1144
1145/**
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001146 * @brief Compiled YANG if-feature-stmt
1147 */
1148struct lysc_iffeature {
1149 uint8_t *expr; /**< 2bits array describing the if-feature expression in prefix format, see @ref ifftokens */
1150 struct lysc_feature **features; /**< array of pointers to the features used in expression ([sized array](@ref sizedarrays)) */
1151};
1152
1153/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001154 * @brief YANG import-stmt
1155 */
1156struct lysc_import {
Radek Krejci6d6e4e42018-10-29 13:28:19 +01001157 struct lys_module *module; /**< link to the imported module */
Radek Krejci151a5b72018-10-19 14:21:44 +02001158 const char *prefix; /**< prefix for the data from the imported schema (mandatory) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001159 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci151a5b72018-10-19 14:21:44 +02001160};
1161
1162/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001163 * @brief YANG when-stmt
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001164 */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001165struct lysc_when {
Radek Krejcia0f704a2019-09-09 16:12:23 +02001166 struct lys_module *module; /**< module where the must was defined */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001167 struct lyxp_expr *cond; /**< XPath when condition */
Radek Krejcia0f704a2019-09-09 16:12:23 +02001168 struct lysc_node *context; /**< context node for evaluating the expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001169 const char *dsc; /**< description */
1170 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001171 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci00b874b2019-02-12 10:54:50 +01001172 uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */
Michal Vasko03ff5a72019-09-11 13:49:33 +02001173 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_XPATH_DEP is allowed */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001174};
1175
1176/**
Radek Krejci2a408df2018-10-29 16:32:26 +01001177 * @brief YANG identity-stmt
1178 */
1179struct lysc_ident {
1180 const char *name; /**< identity name (mandatory), including possible prefix */
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 Krejci2a408df2018-10-29 16:32:26 +01001184 struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */
1185 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 Krejci2a408df2018-10-29 16:32:26 +01001187 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */
1188};
1189
1190/**
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001191 * @brief YANG feature-stmt
1192 */
1193struct lysc_feature {
1194 const char *name; /**< feature name (mandatory) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001195 const char *dsc; /**< description */
1196 const char *ref; /**< reference */
Radek Krejci693262f2019-04-29 15:23:20 +02001197 struct lys_module *module; /**< module structure */
Radek Krejci151a5b72018-10-19 14:21:44 +02001198 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 +01001199 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001200 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001201 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* and
1202 #LYS_FENABLED values allowed */
1203};
1204
Radek Krejci151a5b72018-10-19 14:21:44 +02001205/**
1206 * @defgroup ifftokens if-feature expression tokens
1207 * Tokens of if-feature expression used in ::lysc_iffeature#expr
1208 *
1209 * @{
1210 */
1211#define LYS_IFF_NOT 0x00 /**< operand "not" */
1212#define LYS_IFF_AND 0x01 /**< operand "and" */
1213#define LYS_IFF_OR 0x02 /**< operand "or" */
1214#define LYS_IFF_F 0x03 /**< feature */
1215/**
1216 * @}
1217 */
1218
1219/**
Radek Krejcib7db73a2018-10-24 14:18:40 +02001220 * @brief Compiled YANG revision statement
1221 */
1222struct lysc_revision {
1223 char date[LY_REV_SIZE]; /**< revision-date (mandatory) */
1224 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1225};
1226
Radek Krejci2167ee12018-11-02 16:09:07 +01001227struct lysc_range {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001228 struct lysc_range_part {
Radek Krejci693262f2019-04-29 15:23:20 +02001229 union { /**< min boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001230 int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1231 uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001232 };
Radek Krejci693262f2019-04-29 15:23:20 +02001233 union { /**< max boundary */
Radek Krejcie7b95092019-05-15 11:03:07 +02001234 int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */
1235 uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001236 };
Radek Krejci4f28eda2018-11-12 11:46:16 +01001237 } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */
Radek Krejcic8b31002019-01-08 10:24:45 +01001238 const char *dsc; /**< description */
1239 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001240 const char *emsg; /**< error-message */
1241 const char *eapptag; /**< error-app-tag value */
1242 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1243};
1244
1245struct lysc_pattern {
Radek Krejci54579462019-04-30 12:47:06 +02001246 const char *expr; /**< original, not compiled, regular expression */
1247 pcre2_code *code; /**< compiled regular expression */
Radek Krejcic8b31002019-01-08 10:24:45 +01001248 const char *dsc; /**< description */
1249 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001250 const char *emsg; /**< error-message */
1251 const char *eapptag; /**< error-app-tag value */
1252 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci4586a022018-11-13 11:29:26 +01001253 uint32_t inverted:1; /**< invert-match flag */
1254 uint32_t refcount:31; /**< reference counter */
Radek Krejci2167ee12018-11-02 16:09:07 +01001255};
1256
1257struct lysc_must {
1258 struct lys_module *module; /**< module where the must was defined */
1259 struct lyxp_expr *cond; /**< XPath when condition */
Radek Krejcic8b31002019-01-08 10:24:45 +01001260 const char *dsc; /**< description */
1261 const char *ref; /**< reference */
Radek Krejci2167ee12018-11-02 16:09:07 +01001262 const char *emsg; /**< error-message */
1263 const char *eapptag; /**< error-app-tag value */
1264 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Michal Vasko03ff5a72019-09-11 13:49:33 +02001265 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_XPATH_DEP is allowed */
Radek Krejci2167ee12018-11-02 16:09:07 +01001266};
1267
1268struct lysc_type {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001269 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001270 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001271 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 +02001272 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 +01001273 LY_DATA_TYPE basetype; /**< Base type of the type */
1274 uint32_t refcount; /**< reference counter for type sharing */
1275};
1276
1277struct lysc_type_num {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001278 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001279 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001280 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 +02001281 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 +01001282 LY_DATA_TYPE basetype; /**< Base type of the type */
1283 uint32_t refcount; /**< reference counter for type sharing */
1284 struct lysc_range *range; /**< Optional range limitation */
1285};
1286
1287struct lysc_type_dec {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001288 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001289 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001290 struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */
Radek Krejcie7b95092019-05-15 11:03:07 +02001291 struct lysc_type_plugin *plugin; /**< type's plugin with built-in as well as user functions to canonize or validate the value of the type */
Radek Krejci2167ee12018-11-02 16:09:07 +01001292 LY_DATA_TYPE basetype; /**< Base type of the type */
1293 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci6cba4292018-11-15 17:33:29 +01001294 uint8_t fraction_digits; /**< fraction digits specification */
Radek Krejci2167ee12018-11-02 16:09:07 +01001295 struct lysc_range *range; /**< Optional range limitation */
1296};
1297
1298struct lysc_type_str {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001299 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcia1911222019-07-22 17:24:50 +02001300 struct lyd_value *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001301 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 +02001302 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 +01001303 LY_DATA_TYPE basetype; /**< Base type of the type */
1304 uint32_t refcount; /**< reference counter for type sharing */
1305 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci4586a022018-11-13 11:29:26 +01001306 struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */
Radek Krejci2167ee12018-11-02 16:09:07 +01001307};
1308
Radek Krejci693262f2019-04-29 15:23:20 +02001309struct lysc_type_bitenum_item {
1310 const char *name; /**< enumeration identifier */
1311 const char *dsc; /**< description */
1312 const char *ref; /**< reference */
1313 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1314 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1315 union {
1316 int32_t value; /**< integer value associated with the enumeration */
1317 uint32_t position; /**< non-negative integer value associated with the bit */
1318 };
1319 uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE
1320 values are allowed */
1321};
1322
Radek Krejci2167ee12018-11-02 16:09:07 +01001323struct lysc_type_enum {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001324 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001325 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001326 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 +02001327 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 +01001328 LY_DATA_TYPE basetype; /**< Base type of the type */
1329 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci693262f2019-04-29 15:23:20 +02001330 struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1331};
1332
1333struct lysc_type_bits {
1334 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1335 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001336 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 +02001337 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 +02001338 LY_DATA_TYPE basetype; /**< Base type of the type */
1339 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci849a62a2019-05-22 15:29:05 +02001340 struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item),
1341 the items are ordered by their position value. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001342};
1343
1344struct lysc_type_leafref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001345 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001346 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001347 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 +02001348 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 +01001349 LY_DATA_TYPE basetype; /**< Base type of the type */
1350 uint32_t refcount; /**< reference counter for type sharing */
Michal Vasko03ff5a72019-09-11 13:49:33 +02001351 const char *path; /**< target path */
Radek Krejci96a0bfd2018-11-22 15:25:06 +01001352 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 +01001353 struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */
Radek Krejci2167ee12018-11-02 16:09:07 +01001354 uint8_t require_instance; /**< require-instance flag */
1355};
1356
1357struct lysc_type_identityref {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001358 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001359 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001360 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 +02001361 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 +01001362 LY_DATA_TYPE basetype; /**< Base type of the type */
1363 uint32_t refcount; /**< reference counter for type sharing */
Radek Krejci555cb5b2018-11-16 14:54:33 +01001364 struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)),
Radek Krejci2167ee12018-11-02 16:09:07 +01001365 mandatory (at least 1 item) */
1366};
1367
1368struct lysc_type_instanceid {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001369 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001370 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001371 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 +02001372 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 +01001373 LY_DATA_TYPE basetype; /**< Base type of the type */
1374 uint32_t refcount; /**< reference counter for type sharing */
1375 uint8_t require_instance; /**< require-instance flag */
1376};
1377
Radek Krejci2167ee12018-11-02 16:09:07 +01001378struct lysc_type_union {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001379 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001380 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001381 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 +02001382 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 +01001383 LY_DATA_TYPE basetype; /**< Base type of the type */
1384 uint32_t refcount; /**< reference counter for type sharing */
1385 struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */
1386};
1387
1388struct lysc_type_bin {
Radek Krejci4f28eda2018-11-12 11:46:16 +01001389 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci01342af2019-01-03 15:18:08 +01001390 const char *dflt; /**< type's default value if any */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001391 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 +02001392 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 +01001393 LY_DATA_TYPE basetype; /**< Base type of the type */
1394 uint32_t refcount; /**< reference counter for type sharing */
1395 struct lysc_range *length; /**< Optional length limitation */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001396};
1397
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001398struct lysc_action_inout {
1399 struct lysc_node *data; /**< first child node (linked list) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001400 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1401};
1402
Radek Krejci056d0a82018-12-06 16:57:25 +01001403struct lysc_action {
1404 uint16_t nodetype; /**< LYS_ACTION */
1405 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci95710c92019-02-11 15:49:55 +01001406 struct lys_module *module; /**< module structure */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001407 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. */
1408 struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */
1409
Radek Krejcifc11bd72019-04-11 16:00:05 +02001410 struct lysc_ext_instance *input_exts; /**< list of the extension instances of input ([sized array](@ref sizedarrays)) */
1411 struct lysc_ext_instance *output_exts; /**< list of the extension instances of outpu ([sized array](@ref sizedarrays)) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001412
Radek Krejci056d0a82018-12-06 16:57:25 +01001413 const char *name; /**< action/RPC name (mandatory) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001414 const char *dsc; /**< description */
1415 const char *ref; /**< reference */
1416
Radek Krejcifc11bd72019-04-11 16:00:05 +02001417 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1418 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
1419
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001420 struct lysc_action_inout input; /**< RPC's/action's input */
1421 struct lysc_action_inout output; /**< RPC's/action's output */
1422
Radek Krejci056d0a82018-12-06 16:57:25 +01001423};
1424
1425struct lysc_notif {
1426 uint16_t nodetype; /**< LYS_NOTIF */
1427 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejci95710c92019-02-11 15:49:55 +01001428 struct lys_module *module; /**< module structure */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001429 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 +01001430 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1431
Radek Krejcifc11bd72019-04-11 16:00:05 +02001432 struct lysc_node *data; /**< first child node (linked list) */
1433 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1434
Radek Krejci056d0a82018-12-06 16:57:25 +01001435 const char *name; /**< Notification name (mandatory) */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001436 const char *dsc; /**< description */
1437 const char *ref; /**< reference */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001438
1439 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
1440 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001441};
1442
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001443/**
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001444 * @brief Compiled YANG data node
1445 */
1446struct lysc_node {
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001447 uint16_t nodetype; /**< type of the node (mandatory) */
1448 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001449 struct lys_module *module; /**< module structure */
1450 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. */
1451 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1452 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1453 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1454 never NULL. If there is no sibling node, pointer points to the node
1455 itself. In case of the first node, this pointer points to the last
1456 node in the list. */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001457 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001458 const char *dsc; /**< description */
1459 const char *ref; /**< reference */
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001460 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001461 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001462 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001463};
1464
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001465struct lysc_node_container {
1466 uint16_t nodetype; /**< LYS_CONTAINER */
1467 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1468 struct lys_module *module; /**< module structure */
1469 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. */
1470 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1471 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1472 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1473 never NULL. If there is no sibling node, pointer points to the node
1474 itself. In case of the first node, this pointer points to the last
1475 node in the list. */
1476 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001477 const char *dsc; /**< description */
1478 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001479 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001480 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001481 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001482
1483 struct lysc_node *child; /**< first child node (linked list) */
1484 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1485 struct lysc_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
1486 struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001487};
1488
Radek Krejcia3045382018-11-22 14:30:31 +01001489struct lysc_node_case {
Radek Krejci056d0a82018-12-06 16:57:25 +01001490 uint16_t nodetype; /**< LYS_CASE */
1491 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1492 struct lys_module *module; /**< module structure */
1493 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. */
1494 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1495 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1496 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1497 never NULL. If there is no sibling node, pointer points to the node
1498 itself. In case of the first node, this pointer points to the last
1499 node in the list. */
Radek Krejcia3045382018-11-22 14:30:31 +01001500 const char *name; /**< name of the case, including the implicit case */
Radek Krejci12fb9142019-01-08 09:45:30 +01001501 const char *dsc; /**< description */
1502 const char *ref; /**< reference */
Radek Krejci056d0a82018-12-06 16:57:25 +01001503 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001504 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001505 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001506
Radek Krejcia3045382018-11-22 14:30:31 +01001507 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 +01001508 each other as siblings with the parent pointer pointing to appropriate case node. */
Radek Krejcia3045382018-11-22 14:30:31 +01001509};
1510
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001511struct lysc_node_choice {
1512 uint16_t nodetype; /**< LYS_CHOICE */
1513 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1514 struct lys_module *module; /**< module structure */
1515 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. */
1516 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1517 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1518 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1519 never NULL. If there is no sibling node, pointer points to the node
1520 itself. In case of the first node, this pointer points to the last
1521 node in the list. */
1522 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001523 const char *dsc; /**< description */
1524 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001525 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001526 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001527 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001528
Radek Krejcia9026eb2018-12-12 16:04:47 +01001529 struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other
1530 as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the
1531 case is simple. */
Radek Krejci056d0a82018-12-06 16:57:25 +01001532 struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001533};
1534
1535struct lysc_node_leaf {
1536 uint16_t nodetype; /**< LYS_LEAF */
1537 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1538 struct lys_module *module; /**< module structure */
1539 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. */
1540 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1541 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1542 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1543 never NULL. If there is no sibling node, pointer points to the node
1544 itself. In case of the first node, this pointer points to the last
1545 node in the list. */
1546 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001547 const char *dsc; /**< description */
1548 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001549 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001550 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001551 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci4f28eda2018-11-12 11:46:16 +01001552
1553 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1554 struct lysc_type *type; /**< type of the leaf node (mandatory) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001555
Radek Krejci4f28eda2018-11-12 11:46:16 +01001556 const char *units; /**< units of the leaf's type */
Radek Krejcia1911222019-07-22 17:24:50 +02001557 struct lyd_value *dflt; /**< default value */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001558 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 +01001559};
1560
1561struct lysc_node_leaflist {
1562 uint16_t nodetype; /**< LYS_LEAFLIST */
1563 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1564 struct lys_module *module; /**< module structure */
1565 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. */
1566 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1567 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1568 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1569 never NULL. If there is no sibling node, pointer points to the node
1570 itself. In case of the first node, this pointer points to the last
1571 node in the list. */
1572 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001573 const char *dsc; /**< description */
1574 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001575 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001576 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001577 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejcib57cf1e2018-11-23 14:07:05 +01001578
1579 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1580 struct lysc_type *type; /**< type of the leaf node (mandatory) */
1581
Radek Krejci0e5d8382018-11-28 16:37:53 +01001582 const char *units; /**< units of the leaf's type */
Radek Krejcid0ef1af2019-07-23 12:22:05 +02001583 struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */
1584 struct lys_module **dflts_mods; /**< list ([sized array](@ref sizedarrays)) of modules where the lysc_node_leaflist::dflts values were defined
1585 (needed to correctly map prefixes). */
Radek Krejci0e5d8382018-11-28 16:37:53 +01001586 uint32_t min; /**< min-elements constraint */
1587 uint32_t max; /**< max-elements constraint */
1588
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001589};
1590
1591struct lysc_node_list {
1592 uint16_t nodetype; /**< LYS_LIST */
1593 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1594 struct lys_module *module; /**< module structure */
1595 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. */
1596 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1597 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1598 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1599 never NULL. If there is no sibling node, pointer points to the node
1600 itself. In case of the first node, this pointer points to the last
1601 node in the list. */
1602 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001603 const char *dsc; /**< description */
1604 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001605 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001606 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001607 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001608
1609 struct lysc_node *child; /**< first child node (linked list) */
1610 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
1611 struct lysc_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */
1612 struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
1613
Radek Krejci9bb94eb2018-12-04 16:48:35 +01001614 struct lysc_node_leaf ***uniques; /**< list of sized arrays of pointers to the unique nodes ([sized array](@ref sizedarrays)) */
1615 uint32_t min; /**< min-elements constraint */
1616 uint32_t max; /**< max-elements constraint */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001617};
1618
1619struct lysc_node_anydata {
1620 uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */
1621 uint16_t flags; /**< [schema node flags](@ref snodeflags) */
1622 struct lys_module *module; /**< module structure */
1623 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. */
1624 struct lysc_node *parent; /**< parent node (NULL in case of top level node) */
1625 struct lysc_node *next; /**< next sibling node (NULL if there is no one) */
1626 struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
1627 never NULL. If there is no sibling node, pointer points to the node
1628 itself. In case of the first node, this pointer points to the last
1629 node in the list. */
1630 const char *name; /**< node name (mandatory) */
Radek Krejci12fb9142019-01-08 09:45:30 +01001631 const char *dsc; /**< description */
1632 const char *ref; /**< reference */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001633 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci056d0a82018-12-06 16:57:25 +01001634 struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */
Radek Krejcifc11bd72019-04-11 16:00:05 +02001635 struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */
Radek Krejci9800fb82018-12-13 14:26:23 +01001636
1637 struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */
Radek Krejcibd8d9ba2018-11-02 16:06:26 +01001638};
1639
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001640/**
1641 * @brief Compiled YANG schema tree structure representing YANG module.
1642 *
1643 * Semantically validated YANG schema tree for data tree parsing.
1644 * Contains only the necessary information for the data validation.
1645 */
1646struct lysc_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001647 struct lys_module *mod; /**< covering module structure */
Radek Krejci151a5b72018-10-19 14:21:44 +02001648 struct lysc_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001649
Radek Krejcie53a8dc2018-10-17 12:52:40 +02001650 struct lysc_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */
Radek Krejci2a408df2018-10-29 16:32:26 +01001651 struct lysc_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */
1652 struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */
1653 struct lysc_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */
1654 struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */
Radek Krejci0935f412019-08-20 16:15:18 +02001655 struct lysc_ext *extensions; /**< list of the extension definitions ([sized array](@ref sizedarrays)) */
Radek Krejcice8c1592018-10-29 15:35:51 +01001656 struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001657};
1658
1659/**
Radek Krejci53ea6152018-12-13 15:21:15 +01001660 * @brief Get the groupings sized array of the given (parsed) schema node.
1661 * Decides the node's type and in case it has a groupings array, returns it.
1662 * @param[in] node Node to examine.
1663 * @return The node's groupings sized array if any, NULL otherwise.
1664 */
1665const struct lysp_grp *lysp_node_groupings(const struct lysp_node *node);
1666
1667/**
Radek Krejci056d0a82018-12-06 16:57:25 +01001668 * @brief Get the typedefs sized array of the given (parsed) schema node.
1669 * Decides the node's type and in case it has a typedefs array, returns it.
1670 * @param[in] node Node to examine.
1671 * @return The node's typedefs sized array if any, NULL otherwise.
1672 */
1673const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
1674
1675/**
1676 * @brief Get the actions/RPCs sized array of the given (parsed) schema node.
1677 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1678 * @param[in] node Node to examine.
1679 * @return The node's actions/RPCs sized array if any, NULL otherwise.
1680 */
1681const struct lysp_action *lysp_node_actions(const struct lysp_node *node);
1682
1683/**
1684 * @brief Get the Notifications sized array of the given (parsed) schema node.
1685 * Decides the node's type and in case it has a Notifications array, returns it.
1686 * @param[in] node Node to examine.
1687 * @return The node's Notifications sized array if any, NULL otherwise.
1688 */
1689const struct lysp_notif *lysp_node_notifs(const struct lysp_node *node);
1690
1691/**
1692 * @brief Get the children linked list of the given (parsed) schema node.
1693 * Decides the node's type and in case it has a children list, returns it.
1694 * @param[in] node Node to examine.
1695 * @return The node's children linked list if any, NULL otherwise.
1696 */
1697const struct lysp_node *lysp_node_children(const struct lysp_node *node);
1698
1699/**
1700 * @brief Get the actions/RPCs sized array of the given (compiled) schema node.
1701 * Decides the node's type and in case it has a actions/RPCs array, returns it.
1702 * @param[in] node Node to examine.
1703 * @return The node's actions/RPCs sized array if any, NULL otherwise.
1704 */
1705const struct lysc_action *lysc_node_actions(const struct lysc_node *node);
1706
1707/**
1708 * @brief Get the Notifications sized array of the given (compiled) schema node.
1709 * Decides the node's type and in case it has a Notifications array, returns it.
1710 * @param[in] node Node to examine.
1711 * @return The node's Notifications sized array if any, NULL otherwise.
1712 */
1713const struct lysc_notif *lysc_node_notifs(const struct lysc_node *node);
1714
1715/**
1716 * @brief Get the children linked list of the given (compiled) schema node.
1717 * Decides the node's type and in case it has a children list, returns it.
1718 * @param[in] node Node to examine.
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001719 * @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 +01001720 * @return The node's children linked list if any, NULL otherwise.
1721 */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001722const struct lysc_node *lysc_node_children(const struct lysc_node *node, uint16_t flags);
Radek Krejci056d0a82018-12-06 16:57:25 +01001723
1724/**
Radek Krejci151a5b72018-10-19 14:21:44 +02001725 * @brief Get how the if-feature statement currently evaluates.
1726 *
1727 * @param[in] iff Compiled if-feature statement to evaluate.
1728 * @return If the statement evaluates to true, 1 is returned. 0 is returned when the statement evaluates to false.
1729 */
1730int lysc_iffeature_value(const struct lysc_iffeature *iff);
1731
1732/**
1733 * @brief Get the current status of the provided feature.
1734 *
1735 * @param[in] feature Compiled feature statement to examine.
1736 * @return
1737 * - 1 if feature is enabled,
1738 * - 0 if feature is disabled,
1739 * - -1 in case of error (invalid argument)
1740 */
1741int lysc_feature_value(const struct lysc_feature *feature);
1742
1743/**
Michal Vasko03ff5a72019-09-11 13:49:33 +02001744 * @brief Types of the different schema paths.
1745 */
1746typedef enum {
1747 LYSC_PATH_LOG /**< Descriptive path format used in log messages */
1748} LYSC_PATH_TYPE;
1749
1750/**
Radek Krejci327de162019-06-14 12:52:07 +02001751 * @brief Generate path of the given node in the requested format.
1752 *
1753 * @param[in] node Schema path of this node will be generated.
1754 * @param[in] pathtype Format of the path to generate.
Radek Krejci1c0c3442019-07-23 16:08:47 +02001755 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
1756 * If NULL, memory for the complete path is allocated.
1757 * @param[in] buflen Size of the provided @p buffer.
Radek Krejci327de162019-06-14 12:52:07 +02001758 * @return NULL in case of memory allocation error, path of the node otherwise.
Radek Krejci1c0c3442019-07-23 16:08:47 +02001759 * 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 +02001760 */
Michal Vasko03ff5a72019-09-11 13:49:33 +02001761char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
Radek Krejci327de162019-06-14 12:52:07 +02001762
1763/**
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001764 * @brief Available YANG schema tree structures representing YANG module.
1765 */
1766struct lys_module {
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001767 struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */
1768 const char *name; /**< name of the module (mandatory) */
Radek Krejci0af46292019-01-11 16:02:31 +01001769 const char *revision; /**< revision of the module (if present) */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001770 const char *ns; /**< namespace of the module (module - mandatory) */
1771 const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */
1772 const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */
1773 const char *org; /**< party/company responsible for the module */
1774 const char *contact; /**< contact information for the module */
1775 const char *dsc; /**< description of the module */
1776 const char *ref; /**< cross-reference for the module */
1777
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001778 struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */
Radek Krejci0af46292019-01-11 16:02:31 +01001779 struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing.
1780 Available only for implemented modules. */
1781 struct lysc_feature *off_features;/**< List of pre-compiled features of the module in non implemented modules ([sized array](@ref sizedarrays)).
1782 These features are always disabled and cannot be enabled until the module
1783 become implemented. The features are present in this form to allow their linkage
1784 from if-feature statements of the compiled schemas and their proper use in case
1785 the module became implemented in future (no matter if implicitly via augment/deviate
1786 or explicitly via ly_ctx_module_implement()). */
Radek Krejci0935f412019-08-20 16:15:18 +02001787 struct lysc_ext *off_extensions; /**< List of pre-compiled extension definitions of the module in non-implemented modules
1788 ([sized array](@ref sizedarrays)). These extensions are prepared to be linked with the extension instances,
1789 but they are not implemented (connected with any extension plugin). In case the module become
1790 implemented, the list is moved into the compiled module structure and available extension plugins
1791 are connected with the appropriate extension definision. */
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001792
Radek Krejci95710c92019-02-11 15:49:55 +01001793 uint8_t implemented; /**< flag if the module is implemented, not just imported. The module is implemented if
1794 the flag has non-zero value. Specific values are used internally:
1795 1 - implemented module
1796 2 - recently implemented module by dependency, it can be reverted in rollback procedure */
1797 uint8_t latest_revision; /**< flag to mark the latest available revision:
Radek Krejci0bcdaed2019-01-10 10:21:34 +01001798 1 - the latest revision in searchdirs was not searched yet and this is the
1799 latest revision in the current context
1800 2 - searchdirs were searched and this is the latest available revision */
1801 uint8_t version; /**< yang-version (LYS_VERSION values) */
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001802};
1803
Radek Krejci151a5b72018-10-19 14:21:44 +02001804/**
1805 * @brief Enable specified feature in the module
1806 *
1807 * By default, when the module is loaded by libyang parser, all features are disabled.
1808 *
Radek Krejcica3db002018-11-01 10:31:01 +01001809 * If all features are being enabled, it must be possible respecting their if-feature conditions. For example,
1810 * enabling all features on the following feature set will fail since it is not possible to enable both features
1811 * (and it is unclear which of them should be enabled then). In this case the LY_EDENIED is returned and the feature
1812 * is untouched.
1813 *
1814 * feature f1;
1815 * feature f2 { if-feature 'not f1';}
1816 *
Radek Krejci151a5b72018-10-19 14:21:44 +02001817 * @param[in] module Module where the feature will be enabled.
1818 * @param[in] feature Name of the feature to enable. To enable all features at once, use asterisk (`*`) character.
1819 * @return LY_ERR value.
1820 */
Radek Krejcied5acc52019-04-25 15:57:04 +02001821LY_ERR lys_feature_enable(const struct lys_module *module, const char *feature);
Radek Krejci151a5b72018-10-19 14:21:44 +02001822
1823/**
1824 * @brief Disable specified feature in the module
1825 *
1826 * By default, when the module is loaded by libyang parser, all features are disabled.
1827 *
1828 * @param[in] module Module where the feature will be disabled.
1829 * @param[in] feature Name of the feature to disable. To disable all features at once, use asterisk (`*`) character.
1830 * @return LY_ERR value
1831 */
Radek Krejcied5acc52019-04-25 15:57:04 +02001832LY_ERR lys_feature_disable(const struct lys_module *module, const char *feature);
Radek Krejci151a5b72018-10-19 14:21:44 +02001833
1834/**
1835 * @brief Get the current status of the specified feature in the module.
1836 *
1837 * @param[in] module Module where the feature is defined.
1838 * @param[in] feature Name of the feature to inspect.
1839 * @return
1840 * - 1 if feature is enabled,
1841 * - 0 if feature is disabled,
1842 * - -1 in case of error (e.g. feature is not defined or invalid arguments)
1843 */
1844int lys_feature_value(const struct lys_module *module, const char *feature);
Radek Krejcidd4e8d42018-10-16 14:55:43 +02001845
1846/**
Radek Krejci86d106e2018-10-18 09:53:19 +02001847 * @brief Load a schema into the specified context.
1848 *
1849 * @param[in] ctx libyang context where to process the data model.
1850 * @param[in] data The string containing the dumped data model in the specified
1851 * format.
1852 * @param[in] format Format of the input data (YANG or YIN).
1853 * @return Pointer to the data model structure or NULL on error.
1854 */
Radek Krejcid14e9692018-11-01 11:00:37 +01001855struct lys_module *lys_parse_mem(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format);
Radek Krejci86d106e2018-10-18 09:53:19 +02001856
1857/**
1858 * @brief Read a schema from file descriptor into the specified context.
1859 *
1860 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
1861 *
1862 * @param[in] ctx libyang context where to process the data model.
1863 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
1864 * in the specified format.
1865 * @param[in] format Format of the input data (YANG or YIN).
1866 * @return Pointer to the data model structure or NULL on error.
1867 */
Radek Krejcid14e9692018-11-01 11:00:37 +01001868struct lys_module *lys_parse_fd(struct ly_ctx *ctx, int fd, LYS_INFORMAT format);
Radek Krejci86d106e2018-10-18 09:53:19 +02001869
1870/**
Radek Krejcid33273d2018-10-25 14:55:52 +02001871 * @brief Read a schema into the specified context from a file.
Radek Krejci86d106e2018-10-18 09:53:19 +02001872 *
1873 * @param[in] ctx libyang context where to process the data model.
1874 * @param[in] path Path to the file with the model in the specified format.
1875 * @param[in] format Format of the input data (YANG or YIN).
1876 * @return Pointer to the data model structure or NULL on error.
1877 */
Radek Krejcid14e9692018-11-01 11:00:37 +01001878struct lys_module *lys_parse_path(struct ly_ctx *ctx, const char *path, LYS_INFORMAT format);
Radek Krejci86d106e2018-10-18 09:53:19 +02001879
1880/**
Radek Krejcid33273d2018-10-25 14:55:52 +02001881 * @brief Search for the schema file in the specified searchpaths.
1882 *
1883 * @param[in] searchpaths NULL-terminated array of paths to be searched (recursively). Current working
1884 * directory is searched automatically (but non-recursively if not in the provided list). Caller can use
1885 * result of the ly_ctx_get_searchdirs().
1886 * @param[in] cwd Flag to implicitly search also in the current working directory (non-recursively).
1887 * @param[in] name Name of the schema to find.
1888 * @param[in] revision Revision of the schema to find. If NULL, the newest found schema filepath is returned.
1889 * @param[out] localfile Mandatory output variable containing absolute path of the found schema. If no schema
1890 * complying the provided restriction is found, NULL is set.
1891 * @param[out] format Optional output variable containing expected format of the schema document according to the
1892 * file suffix.
1893 * @return LY_ERR value (LY_SUCCESS is returned even if the file is not found, then the *localfile is NULL).
1894 */
1895LY_ERR lys_search_localfile(const char * const *searchpaths, int cwd, const char *name, const char *revision, char **localfile, LYS_INFORMAT *format);
1896
1897/**
Radek Krejcia3045382018-11-22 14:30:31 +01001898 * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can
1899 * be from an augment.
1900 *
1901 * lys_getnext() is supposed to be called sequentially. In the first call, the \p last parameter is usually NULL
1902 * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module.
1903 * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same
1904 * \p parent and \p module parameters.
1905 *
1906 * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding
1907 * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that
1908 * all the schema nodes are iteratively returned.
1909 *
1910 * @param[in] last Previously returned schema tree node, or NULL in case of the first call.
1911 * @param[in] parent Parent of the subtree where the function starts processing.
1912 * @param[in] module In case of iterating on top level elements, the \p parent is NULL and
1913 * module must be specified.
1914 * @param[in] options [ORed options](@ref sgetnextflags).
1915 * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element.
1916 */
1917const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
1918 const struct lysc_module *module, int options);
1919
1920/**
1921 * @defgroup sgetnextflags lys_getnext() flags
1922 * @ingroup schematree
1923 *
1924 * @{
1925 */
1926#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 +01001927#define LYS_GETNEXT_NOCHOICE 0x02 /**< lys_getnext() option to ignore (kind of conditional) nodes within choice node */
Radek Krejci056d0a82018-12-06 16:57:25 +01001928#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 +01001929#define LYS_GETNEXT_INTONPCONT 0x40 /**< lys_getnext() option to look into non-presence container, instead of returning container itself */
1930#define LYS_GETNEXT_NOSTATECHECK 0x100 /**< lys_getnext() option to skip checking module validity (import-only, disabled) and
1931 relevant if-feature conditions state */
Radek Krejci6eeb58f2019-02-22 16:29:37 +01001932#define LYS_GETNEXT_OUTPUT 0x200 /**< lys_getnext() option to provide RPC's/action's output schema nodes instead of input schema nodes
1933 provided by default */
Radek Krejcia3045382018-11-22 14:30:31 +01001934/** @} sgetnextflags */
1935
1936/**
1937 * @brief Get child node according to the specified criteria.
1938 *
1939 * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched.
1940 * @param[in] module module of the node to find. It is also limitation for the children node of the given parent.
1941 * @param[in] name Name of the node to find.
1942 * @param[in] name_len Optional length of the name in case it is not NULL-terminated string.
1943 * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find.
1944 * Used as a bitmask, so multiple nodetypes can be specified.
1945 * @param[in] options [ORed options](@ref sgetnextflags).
1946 * @return Found node if any.
1947 */
1948const struct lysc_node *lys_child(const struct lysc_node *parent, const struct lys_module *module,
1949 const char *name, size_t name_len, uint16_t nodetype, int options);
1950
1951/**
Radek Krejci77a8bcd2019-09-11 11:20:02 +02001952 * @brief Make the specific module implemented.
1953 *
1954 * @param[in] mod Module to make implemented. It is not an error
1955 * to provide already implemented module, it just does nothing.
1956 * @return LY_SUCCESS or LY_EDENIED in case the context contains some other revision of the
1957 * same module which is already implemented.
1958 */
1959LY_ERR lys_set_implemented(struct lys_module *mod);
1960
1961/**
Radek Krejcia3045382018-11-22 14:30:31 +01001962 * @brief Check if the schema node is disabled in the schema tree, i.e. there is any disabled if-feature statement
1963 * affecting the node.
1964 *
1965 * @param[in] node Schema node to check.
1966 * @param[in] recursive - 0 to check if-feature only in the \p node schema node,
1967 * - 1 to check if-feature in all ascendant schema nodes until there is a node possibly having an instance in a data tree
1968 * @return - NULL if enabled,
1969 * - pointer to the node with the unsatisfied (disabling) if-feature expression.
1970 */
Radek Krejcifab954b2019-09-11 11:25:14 +02001971const struct lysc_iffeature *lysc_node_is_disabled(const struct lysc_node *node, int recursive);
Radek Krejcia3045382018-11-22 14:30:31 +01001972
Radek Krejci084289f2019-07-09 17:35:30 +02001973/**
1974 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
1975 *
1976 * This function check just the type's restriction, if you want to check also the data tree context (e.g. in case of
1977 * require-instance restriction), use lyd_value_validate().
1978 *
1979 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
1980 * @param[in] node Schema node for the @p value.
1981 * @param[in] value String value to be checked.
1982 * @param[in] value_len Length of the given @p value (mandatory).
1983 * @param[in] get_prefix Callback function to resolve prefixes used in the @p value string.
1984 * @param[in] get_prefix_data Private data for the @p get_prefix callback.
1985 * @param[in] format Input format of the @p value.
1986 * @return LY_SUCCESS on success
1987 * @return LY_ERR value if an error occurred.
1988 */
1989LY_ERR lys_value_validate(struct ly_ctx *ctx, const struct lysc_node *node, const char *value, size_t value_len,
1990 ly_clb_resolve_prefix get_prefix, void *get_prefix_data, LYD_FORMAT format);
1991
Radek Krejci0935f412019-08-20 16:15:18 +02001992/**
1993 * @brief Stringify schema nodetype.
1994 * @param[in] nodetype Nodetype to stringify.
1995 * @return Constant string with the name of the node's type.
1996 */
1997const char *lys_nodetype2str(uint16_t nodetype);
1998
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001999/** @} */
2000
Radek Krejci70853c52018-10-15 14:46:16 +02002001#ifdef __cplusplus
2002}
2003#endif
2004
Radek Krejci5aeea3a2018-09-05 13:29:36 +02002005#endif /* LY_TREE_SCHEMA_H_ */