Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1 | /** |
| 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 Krejci | 5457946 | 2019-04-30 12:47:06 +0200 | [diff] [blame] | 18 | #define PCRE2_CODE_UNIT_WIDTH 8 |
| 19 | |
| 20 | #include <pcre2.h> |
Radek Krejci | 535ea9f | 2020-05-29 16:01:05 +0200 | [diff] [blame] | 21 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 22 | #include <stdint.h> |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 23 | #include <stdio.h> |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 24 | |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 25 | #include "log.h" |
| 26 | #include "tree.h" |
Radek Krejci | 535ea9f | 2020-05-29 16:01:05 +0200 | [diff] [blame] | 27 | #include "tree_data.h" |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 28 | |
Radek Krejci | 70853c5 | 2018-10-15 14:46:16 +0200 | [diff] [blame] | 29 | #ifdef __cplusplus |
| 30 | extern "C" { |
| 31 | #endif |
| 32 | |
Radek Krejci | ca376bd | 2020-06-11 16:04:06 +0200 | [diff] [blame] | 33 | struct ly_ctx; |
| 34 | struct ly_set; |
| 35 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 36 | /** |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 37 | * @page howtoSchema YANG Modules |
| 38 | * |
| 39 | * To be able to work with YANG data instances, libyang has to represent YANG data models. All the processed modules are stored |
| 40 | * in libyang [context](@ref howtoContext) and loaded using [parser functions](@ref howtoSchemaParsers). It means, that there is |
| 41 | * no way to create/change YANG module programmatically. However, all the YANG model definitions are available and can be examined |
| 42 | * through the C structures. All the context's modules together form YANG Schema for the data being instantiated. |
| 43 | * |
| 44 | * Any YANG module is represented as ::lys_module. In fact, the module is represented in two different formats. As ::lys_module.parsed, |
| 45 | * there is a parsed schema reflecting the source YANG module. It is exactly what is read from the input. This format is good for |
| 46 | * converting from one format to another (YANG to YIN and vice versa), but it is not very useful for validating/manipulating YANG |
| 47 | * data. Therefore, there is ::lys_module.compiled storing the compiled YANG module. It is based on the parsed module, but all the |
| 48 | * references are resolved. It means that, for example, there are no `grouping`s or `typedef`s since they are supposed to be placed instead of |
| 49 | * `uses` or `type` references. This split also means, that the YANG module is fully validated after compilation of the parsed |
| 50 | * representation of the module. YANG submodules are available only in the parsed representation. When a submodule is compiled, it |
| 51 | * is fully integrated into its main module. |
| 52 | * |
| 53 | * The context can contain even modules without the compiled representation. Such modules are still useful as imports of other |
| 54 | * modules. The grouping or typedef definition can be even compiled into the importing modules. This is actually the main |
| 55 | * difference between the imported and implemented modules in the libyang context. The implemented modules are compiled while the |
| 56 | * imported modules are only parsed. |
| 57 | * |
| 58 | * In case the context's ::LY_CTX_ALLIMPLEMENTED option is not set, the module is not implemented in case it is implicitly |
| 59 | * loaded as import for another module and it is not referenced in such a module (and no other) as target of leafref, augment |
| 60 | * or deviation. |
| 61 | * |
| 62 | * All modules with deviation definition are always marked as implemented. The imported (not implemented) module can be set implemented by ::lys_set_implemented(). But |
| 63 | * the implemented module cannot be changed back to just imported module. Note also that only one revision of a specific module |
| 64 | * can be implemented in a single context. The imported modules are used only as a |
| 65 | * source of definitions for types and groupings for uses statements. The data in such modules are ignored - caller |
| 66 | * is not allowed to create the data (including instantiating identities) defined in the model via data parsers, |
| 67 | * the default nodes are not added into any data tree and mandatory nodes are not checked in the data trees. |
| 68 | * |
| 69 | * The compiled schema tree nodes are able to hold private objects (::lysc_node.priv as a pointer to a structure, function, variable, ...) used by |
| 70 | * a caller application. Such an object can be assigned to a specific node using ::lysc_set_private() function. |
| 71 | * Note that the object is not freed by libyang when the context is being destroyed. So the caller is responsible |
| 72 | * for freeing the provided structure after the context is destroyed or the private pointer is set to NULL in |
| 73 | * appropriate schema nodes where the object was previously set. This can be automated via destructor function |
| 74 | * to free these private objects. The destructor is passed to the ::ly_ctx_destroy() function. |
| 75 | * |
| 76 | * Despite all the schema structures and their members are available as part of the libyang API and callers can use |
| 77 | * it to navigate through the schema tree structure or to obtain various information, we recommend to use the following |
| 78 | * macros for the specific actions. |
| 79 | * - ::LYSC_TREE_DFS_BEGIN and ::LYSC_TREE_DFS_END to traverse the schema tree (depth-first). |
| 80 | * - ::LY_LIST_FOR and ::LY_ARRAY_FOR as described on @ref howtoStructures page. |
| 81 | * |
| 82 | * Further information about modules handling can be found on the following pages: |
| 83 | * - @subpage howtoSchemaParsers |
| 84 | * - @subpage howtoSchemaFeatures |
| 85 | * - @subpage howtoPlugins |
| 86 | * - @subpage howtoSchemaPrinters |
| 87 | * |
| 88 | * \note There are many functions to access information from the schema trees. Details are available in |
| 89 | * the [Schema Tree module](@ref schematree). |
| 90 | * |
| 91 | * For information about difference between implemented and imported modules, see the |
| 92 | * [context description](@ref howtoContext). |
| 93 | * |
| 94 | * Functions List (not assigned to above subsections) |
| 95 | * -------------------------------------------------- |
| 96 | * - ::lys_getnext() |
| 97 | * - ::lys_nodetype2str() |
| 98 | * - ::lys_set_implemented() |
| 99 | * - ::lys_value_validate() |
| 100 | * |
| 101 | * - ::lysc_set_private() |
| 102 | * |
| 103 | * - ::lysc_node_children() |
Michal Vasko | 208a04a | 2020-10-21 15:17:12 +0200 | [diff] [blame^] | 104 | * - ::lysc_node_children_full() |
| 105 | * - ::lysc_node_parent_full() |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 106 | * - ::lysc_node_actions() |
| 107 | * - ::lysc_node_notifs() |
| 108 | * |
| 109 | * - ::lysp_node_children() |
| 110 | * - ::lysp_node_actions() |
| 111 | * - ::lysp_node_notifs() |
| 112 | * - ::lysp_node_groupings() |
| 113 | * - ::lysp_node_typedefs() |
| 114 | */ |
| 115 | |
| 116 | /** |
| 117 | * @page howtoSchemaFeatures YANG Features |
| 118 | * |
| 119 | * YANG feature statement is an iportant part of the language which can significantly affect the meaning of the schemas. Despite |
| 120 | * the features have similar effect as loading/removing schema from the context, manipulating with the feature value is not |
| 121 | * limited to the context preparation period before working with data. YANG features, respectively their use in if-feature |
| 122 | * statements, are evaluated as part of the [data validation process](@ref howtoDataValidation). |
| 123 | * |
| 124 | * The main functions with *lys_feature_* prefix are used to change the value (true/false) of the feature and to get its current |
| 125 | * value. Enabling/disabling all the features in a particular module can be done using '`*`' value instead of the feature name. |
| 126 | * |
| 127 | * There are two options to reflect feature's if-feature statements when enabling/disabling the feature. The ::lys_feature_enable() |
| 128 | * and ::lys_feature_disable() functions check their if-feature expressions (it is not possible to enable feature if it is not |
| 129 | * allowed by its if-feature expressions) and also checks for and update other features those if-feature expressions use the |
| 130 | * changed feature. On the contrary, ::lys_feature_enable_force() and ::lys_feature_disable_force() ignore all the if-feature |
| 131 | * limitations. |
| 132 | * |
| 133 | * The ::lysc_feature_value() and ::lys_feature_value() functions differ only by their parameters. The ::lysc_iffeature_value() |
| 134 | * is used to evaluate (possibly complex in YANG 1.1) logical expression from if-feature statement. |
| 135 | * |
| 136 | * The list of features of a particular YANG module is available in ::lys_module.features. |
| 137 | * |
| 138 | * To get know, if a specific schema node is currently disabled or enable, the ::lysc_node_is_disabled() function can be used. |
| 139 | * |
| 140 | * Note, that the feature's state can affect some of the output formats (e.g. Tree format). |
| 141 | * |
| 142 | * Functions List |
| 143 | * -------------- |
| 144 | * - ::lys_feature_enable() |
| 145 | * - ::lys_feature_enable_force() |
| 146 | * - ::lys_feature_disable() |
| 147 | * - ::lys_feature_disable_force() |
| 148 | * - ::lys_feature_value() |
| 149 | * - ::lysc_feature_value() |
| 150 | * - ::lysc_iffeature_value() |
| 151 | * |
| 152 | * - ::lysc_node_is_disabled() |
| 153 | */ |
| 154 | |
| 155 | /** |
Radek Krejci | 2ff0d57 | 2020-05-21 15:27:28 +0200 | [diff] [blame] | 156 | * @ingroup trees |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 157 | * @defgroup schematree Schema Tree |
Radek Krejci | 2ff0d57 | 2020-05-21 15:27:28 +0200 | [diff] [blame] | 158 | * @{ |
| 159 | * |
| 160 | * Data structures and functions to manipulate and access schema tree. |
| 161 | */ |
| 162 | |
Michal Vasko | 64246d8 | 2020-08-19 12:35:00 +0200 | [diff] [blame] | 163 | /* *INDENT-OFF* */ |
| 164 | |
Radek Krejci | 2ff0d57 | 2020-05-21 15:27:28 +0200 | [diff] [blame] | 165 | /** |
Michal Vasko | 208a04a | 2020-10-21 15:17:12 +0200 | [diff] [blame^] | 166 | * @brief Macro to iterate via all elements in a schema (sub)tree including input and output. |
| 167 | * Note that __actions__ and __notifications__ of traversed nodes __are ignored__! To traverse |
| 168 | * on all the nodes including those, use ::lysc_tree_dfs_full() instead. |
| 169 | * |
| 170 | * This is the opening part to the #LYSC_TREE_DFS_END - they always have to be used together. |
Radek Krejci | 0935f41 | 2019-08-20 16:15:18 +0200 | [diff] [blame] | 171 | * |
| 172 | * The function follows deep-first search algorithm: |
| 173 | * <pre> |
| 174 | * 1 |
| 175 | * / \ |
| 176 | * 2 4 |
| 177 | * / / \ |
| 178 | * 3 5 6 |
| 179 | * </pre> |
| 180 | * |
| 181 | * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While |
| 182 | * START can be any of the lysc_node* types (including lysc_action and lysc_notif), |
| 183 | * ELEM variable must be of the struct lysc_node* type. |
| 184 | * |
| 185 | * To skip a particular subtree, instead of the continue statement, set LYSC_TREE_DFS_continue |
| 186 | * variable to non-zero value. |
| 187 | * |
| 188 | * Use with opening curly bracket '{' after the macro. |
| 189 | * |
| 190 | * @param START Pointer to the starting element processed first. |
| 191 | * @param ELEM Iterator intended for use in the block. |
| 192 | */ |
| 193 | #define LYSC_TREE_DFS_BEGIN(START, ELEM) \ |
Radek Krejci | 857189e | 2020-09-01 13:26:36 +0200 | [diff] [blame] | 194 | { ly_bool LYSC_TREE_DFS_continue = 0; struct lysc_node *LYSC_TREE_DFS_next; \ |
Michal Vasko | 1c9e79f | 2020-08-10 11:08:03 +0200 | [diff] [blame] | 195 | for ((ELEM) = (LYSC_TREE_DFS_next) = (struct lysc_node*)(START); \ |
Radek Krejci | 0935f41 | 2019-08-20 16:15:18 +0200 | [diff] [blame] | 196 | (ELEM); \ |
| 197 | (ELEM) = (LYSC_TREE_DFS_next), LYSC_TREE_DFS_continue = 0) |
| 198 | |
| 199 | /** |
| 200 | * @brief Macro to iterate via all elements in a (sub)tree. This is the closing part |
| 201 | * to the #LYSC_TREE_DFS_BEGIN - they always have to be used together. |
| 202 | * |
| 203 | * Use the same parameters for #LYSC_TREE_DFS_BEGIN and #LYSC_TREE_DFS_END. While |
| 204 | * START can be a pointer to any of the lysc_node* types (including lysc_action and lysc_notif), |
| 205 | * ELEM variable must be pointer to the lysc_node type. |
| 206 | * |
| 207 | * Use with closing curly bracket '}' after the macro. |
| 208 | * |
| 209 | * @param START Pointer to the starting element processed first. |
| 210 | * @param ELEM Iterator intended for use in the block. |
| 211 | */ |
Radek Krejci | 0935f41 | 2019-08-20 16:15:18 +0200 | [diff] [blame] | 212 | #define LYSC_TREE_DFS_END(START, ELEM) \ |
| 213 | /* select element for the next run - children first */ \ |
| 214 | if (LYSC_TREE_DFS_continue) { \ |
| 215 | (LYSC_TREE_DFS_next) = NULL; \ |
| 216 | } else { \ |
Michal Vasko | 208a04a | 2020-10-21 15:17:12 +0200 | [diff] [blame^] | 217 | (LYSC_TREE_DFS_next) = (struct lysc_node *)lysc_node_children_full(ELEM, 0); \ |
| 218 | } \ |
Radek Krejci | 0935f41 | 2019-08-20 16:15:18 +0200 | [diff] [blame] | 219 | if (!(LYSC_TREE_DFS_next)) { \ |
Michal Vasko | 208a04a | 2020-10-21 15:17:12 +0200 | [diff] [blame^] | 220 | /* no children, try siblings */ \ |
| 221 | _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \ |
Radek Krejci | 0935f41 | 2019-08-20 16:15:18 +0200 | [diff] [blame] | 222 | } \ |
| 223 | while (!(LYSC_TREE_DFS_next)) { \ |
| 224 | /* parent is already processed, go to its sibling */ \ |
Michal Vasko | 208a04a | 2020-10-21 15:17:12 +0200 | [diff] [blame^] | 225 | (ELEM) = (struct lysc_node *)lysc_node_parent_full(ELEM); \ |
| 226 | _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \ |
| 227 | } } |
| 228 | |
| 229 | /** |
| 230 | * @brief Helper macro for #LYSC_TREE_DFS_END, should not be used directly! |
| 231 | */ |
| 232 | #define _LYSC_TREE_DFS_NEXT(START, ELEM, NEXT) \ |
| 233 | if ((ELEM) == (struct lysc_node *)(START)) { \ |
| 234 | /* we are done, no next element to process */ \ |
| 235 | break; \ |
| 236 | } \ |
| 237 | if ((ELEM)->nodetype == LYS_INPUT) { \ |
| 238 | /* after input, get output */ \ |
| 239 | (NEXT) = (struct lysc_node *)lysc_node_children_full(lysc_node_parent_full(ELEM), LYS_CONFIG_R); \ |
| 240 | } else if ((ELEM)->nodetype == LYS_OUTPUT) { \ |
| 241 | /* no sibling of output */ \ |
| 242 | (NEXT) = NULL; \ |
| 243 | } else { \ |
| 244 | (NEXT) = (ELEM)->next; \ |
| 245 | } |
Radek Krejci | 0935f41 | 2019-08-20 16:15:18 +0200 | [diff] [blame] | 246 | |
Michal Vasko | 64246d8 | 2020-08-19 12:35:00 +0200 | [diff] [blame] | 247 | /* *INDENT-ON* */ |
| 248 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 249 | #define LY_REV_SIZE 11 /**< revision data string length (including terminating NULL byte) */ |
| 250 | |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 251 | #define LYS_UNKNOWN 0x0000 /**< uninitalized unknown statement node */ |
| 252 | #define LYS_CONTAINER 0x0001 /**< container statement node */ |
| 253 | #define LYS_CHOICE 0x0002 /**< choice statement node */ |
| 254 | #define LYS_LEAF 0x0004 /**< leaf statement node */ |
| 255 | #define LYS_LEAFLIST 0x0008 /**< leaf-list statement node */ |
| 256 | #define LYS_LIST 0x0010 /**< list statement node */ |
| 257 | #define LYS_ANYXML 0x0020 /**< anyxml statement node */ |
| 258 | #define LYS_ANYDATA 0x0060 /**< anydata statement node, in tests it can be used for both #LYS_ANYXML and #LYS_ANYDATA */ |
| 259 | #define LYS_CASE 0x0080 /**< case statement node */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 260 | |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 261 | #define LYS_RPC 0x0100 /**< RPC statement node */ |
| 262 | #define LYS_ACTION 0x0200 /**< action statement node */ |
| 263 | #define LYS_NOTIF 0x0400 /**< notification statement node */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 264 | |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 265 | #define LYS_USES 0x0800 /**< uses statement node */ |
| 266 | #define LYS_INPUT 0x1000 /**< RPC/action input node */ |
| 267 | #define LYS_OUTPUT 0x2000 /**< RPC/action output node */ |
| 268 | #define LYS_GROUPING 0x4000 |
| 269 | #define LYS_AUGMENT 0x8000 |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 270 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 271 | /** |
Radek Krejci | d6b7645 | 2019-09-03 17:03:03 +0200 | [diff] [blame] | 272 | * @brief List of YANG statements |
| 273 | */ |
| 274 | enum ly_stmt { |
| 275 | LY_STMT_NONE = 0, |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 276 | LY_STMT_STATUS, /**< in ::lysc_ext_substmt.storage stored as a pointer to `uint16_t`, only cardinality < #LY_STMT_CARD_SOME is allowed */ |
| 277 | LY_STMT_CONFIG, /**< in ::lysc_ext_substmt.storage stored as a pointer to `uint16_t`, only cardinality < #LY_STMT_CARD_SOME is allowed */ |
Radek Krejci | 335332a | 2019-09-05 13:03:35 +0200 | [diff] [blame] | 278 | LY_STMT_MANDATORY, |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 279 | LY_STMT_UNITS, /**< in ::lysc_ext_substmt.storage stored as a pointer to `const char *` (cardinality < #LY_STMT_CARD_SOME) |
Radek Krejci | ad5963b | 2019-09-06 16:03:05 +0200 | [diff] [blame] | 280 | or as a pointer to a [sized array](@ref sizedarrays) `const char **` */ |
Radek Krejci | 335332a | 2019-09-05 13:03:35 +0200 | [diff] [blame] | 281 | LY_STMT_DEFAULT, |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 282 | LY_STMT_TYPE, /**< in ::lysc_ext_substmt.storage stored as a pointer to `struct lysc_type *` (cardinality < #LY_STMT_CARD_SOME) |
Radek Krejci | ad5963b | 2019-09-06 16:03:05 +0200 | [diff] [blame] | 283 | or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_type **` */ |
Radek Krejci | 335332a | 2019-09-05 13:03:35 +0200 | [diff] [blame] | 284 | |
Radek Krejci | d6b7645 | 2019-09-03 17:03:03 +0200 | [diff] [blame] | 285 | LY_STMT_ACTION, |
| 286 | LY_STMT_ANYDATA, |
| 287 | LY_STMT_ANYXML, |
| 288 | LY_STMT_ARGUMENT, |
| 289 | LY_STMT_AUGMENT, |
| 290 | LY_STMT_BASE, |
| 291 | LY_STMT_BELONGS_TO, |
| 292 | LY_STMT_BIT, |
| 293 | LY_STMT_CASE, |
| 294 | LY_STMT_CHOICE, |
Radek Krejci | d6b7645 | 2019-09-03 17:03:03 +0200 | [diff] [blame] | 295 | LY_STMT_CONTACT, |
| 296 | LY_STMT_CONTAINER, |
Radek Krejci | d6b7645 | 2019-09-03 17:03:03 +0200 | [diff] [blame] | 297 | LY_STMT_DESCRIPTION, |
| 298 | LY_STMT_DEVIATE, |
| 299 | LY_STMT_DEVIATION, |
| 300 | LY_STMT_ENUM, |
| 301 | LY_STMT_ERROR_APP_TAG, |
| 302 | LY_STMT_ERROR_MESSAGE, |
| 303 | LY_STMT_EXTENSION, |
| 304 | LY_STMT_FEATURE, |
| 305 | LY_STMT_FRACTION_DIGITS, |
| 306 | LY_STMT_GROUPING, |
| 307 | LY_STMT_IDENTITY, |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 308 | LY_STMT_IF_FEATURE, /**< in ::lysc_ext_substmt.storage stored as a pointer to `struct lysc_iffeature` (cardinality < #LY_STMT_CARD_SOME) |
Radek Krejci | ad5963b | 2019-09-06 16:03:05 +0200 | [diff] [blame] | 309 | or as a pointer to a [sized array](@ref sizedarrays) `struct lysc_iffeature *` */ |
Radek Krejci | d6b7645 | 2019-09-03 17:03:03 +0200 | [diff] [blame] | 310 | LY_STMT_IMPORT, |
| 311 | LY_STMT_INCLUDE, |
| 312 | LY_STMT_INPUT, |
| 313 | LY_STMT_KEY, |
| 314 | LY_STMT_LEAF, |
| 315 | LY_STMT_LEAF_LIST, |
| 316 | LY_STMT_LENGTH, |
| 317 | LY_STMT_LIST, |
Radek Krejci | d6b7645 | 2019-09-03 17:03:03 +0200 | [diff] [blame] | 318 | LY_STMT_MAX_ELEMENTS, |
| 319 | LY_STMT_MIN_ELEMENTS, |
| 320 | LY_STMT_MODIFIER, |
| 321 | LY_STMT_MODULE, |
| 322 | LY_STMT_MUST, |
| 323 | LY_STMT_NAMESPACE, |
| 324 | LY_STMT_NOTIFICATION, |
| 325 | LY_STMT_ORDERED_BY, |
| 326 | LY_STMT_ORGANIZATION, |
| 327 | LY_STMT_OUTPUT, |
| 328 | LY_STMT_PATH, |
| 329 | LY_STMT_PATTERN, |
| 330 | LY_STMT_POSITION, |
| 331 | LY_STMT_PREFIX, |
| 332 | LY_STMT_PRESENCE, |
| 333 | LY_STMT_RANGE, |
| 334 | LY_STMT_REFERENCE, |
| 335 | LY_STMT_REFINE, |
| 336 | LY_STMT_REQUIRE_INSTANCE, |
| 337 | LY_STMT_REVISION, |
| 338 | LY_STMT_REVISION_DATE, |
| 339 | LY_STMT_RPC, |
Radek Krejci | d6b7645 | 2019-09-03 17:03:03 +0200 | [diff] [blame] | 340 | LY_STMT_SUBMODULE, |
Radek Krejci | d6b7645 | 2019-09-03 17:03:03 +0200 | [diff] [blame] | 341 | LY_STMT_TYPEDEF, |
| 342 | LY_STMT_UNIQUE, |
Radek Krejci | d6b7645 | 2019-09-03 17:03:03 +0200 | [diff] [blame] | 343 | LY_STMT_USES, |
| 344 | LY_STMT_VALUE, |
| 345 | LY_STMT_WHEN, |
| 346 | LY_STMT_YANG_VERSION, |
| 347 | LY_STMT_YIN_ELEMENT, |
| 348 | LY_STMT_EXTENSION_INSTANCE, |
| 349 | |
| 350 | LY_STMT_SYNTAX_SEMICOLON, |
| 351 | LY_STMT_SYNTAX_LEFT_BRACE, |
| 352 | LY_STMT_SYNTAX_RIGHT_BRACE, |
| 353 | |
| 354 | LY_STMT_ARG_TEXT, |
| 355 | LY_STMT_ARG_VALUE |
| 356 | }; |
| 357 | |
| 358 | /** |
Radek Krejci | 0e59c31 | 2019-08-15 15:34:15 +0200 | [diff] [blame] | 359 | * @brief Extension instance structure parent enumeration |
| 360 | */ |
| 361 | typedef enum { |
Radek Krejci | 0935f41 | 2019-08-20 16:15:18 +0200 | [diff] [blame] | 362 | LYEXT_PAR_MODULE, /**< ::lysc_module */ |
| 363 | LYEXT_PAR_NODE, /**< ::lysc_node (and the derived structures including ::lysc_action and ::lysc_notif) */ |
| 364 | LYEXT_PAR_INPUT, /**< ::lysc_action_inout */ |
| 365 | LYEXT_PAR_OUTPUT, /**< ::lysc_action_inout */ |
| 366 | LYEXT_PAR_TYPE, /**< ::lysc_type */ |
| 367 | LYEXT_PAR_TYPE_BIT, /**< ::lysc_type_bitenum_item */ |
| 368 | LYEXT_PAR_TYPE_ENUM, /**< ::lysc_type_bitenum_item */ |
| 369 | LYEXT_PAR_FEATURE, /**< ::lysc_feature */ |
| 370 | LYEXT_PAR_MUST, /**< ::lysc_must */ |
| 371 | LYEXT_PAR_PATTERN, /**< ::lysc_pattern */ |
| 372 | LYEXT_PAR_LENGTH, /**< ::lysc_range */ |
| 373 | LYEXT_PAR_RANGE, /**< ::lysc_range */ |
| 374 | LYEXT_PAR_WHEN, /**< ::lysc_when */ |
| 375 | LYEXT_PAR_IDENT, /**< ::lysc_ident */ |
| 376 | LYEXT_PAR_EXT, /**< ::lysc_ext */ |
Michal Vasko | 6973015 | 2020-10-09 16:30:07 +0200 | [diff] [blame] | 377 | LYEXT_PAR_IMPORT /**< ::lysp_import */ |
Michal Vasko | 033278d | 2020-08-24 11:24:52 +0200 | [diff] [blame] | 378 | // LYEXT_PAR_TPDF, /**< ::lysp_tpdf */ |
| 379 | // LYEXT_PAR_EXTINST, /**< ::lysp_ext_instance */ |
| 380 | // LYEXT_PAR_REFINE, /**< ::lysp_refine */ |
| 381 | // LYEXT_PAR_DEVIATION, /**< ::lysp_deviation */ |
| 382 | // LYEXT_PAR_DEVIATE, /**< ::lysp_deviate */ |
| 383 | // LYEXT_PAR_INCLUDE, /**< ::lysp_include */ |
| 384 | // LYEXT_PAR_REVISION, /**< ::lysp_revision */ |
Radek Krejci | 0e59c31 | 2019-08-15 15:34:15 +0200 | [diff] [blame] | 385 | } LYEXT_PARENT; |
| 386 | |
| 387 | /** |
Radek Krejci | 0935f41 | 2019-08-20 16:15:18 +0200 | [diff] [blame] | 388 | * @brief Stringify extension instance parent type. |
| 389 | * @param[in] type Parent type to stringify. |
| 390 | * @return Constant string with the name of the parent statement. |
| 391 | */ |
| 392 | const char *lyext_parent2str(LYEXT_PARENT type); |
| 393 | |
| 394 | /** |
Radek Krejci | 0e59c31 | 2019-08-15 15:34:15 +0200 | [diff] [blame] | 395 | * @brief Enum of substatements in which extension instances can appear. |
| 396 | */ |
| 397 | typedef enum { |
| 398 | LYEXT_SUBSTMT_SELF = 0, /**< extension of the structure itself, not substatement's */ |
| 399 | LYEXT_SUBSTMT_ARGUMENT, /**< extension of the argument statement, can appear in lys_ext */ |
| 400 | LYEXT_SUBSTMT_BASE, /**< extension of the base statement, can appear (repeatedly) in lys_type and lys_ident */ |
| 401 | LYEXT_SUBSTMT_BELONGSTO, /**< extension of the belongs-to statement, can appear in lys_submodule */ |
| 402 | LYEXT_SUBSTMT_CONTACT, /**< extension of the contact statement, can appear in lys_module */ |
| 403 | LYEXT_SUBSTMT_DEFAULT, /**< extension of the default statement, can appear in lys_node_leaf, lys_node_leaflist, |
| 404 | lys_node_choice and lys_deviate */ |
| 405 | LYEXT_SUBSTMT_DESCRIPTION, /**< extension of the description statement, can appear in lys_module, lys_submodule, |
| 406 | lys_node, lys_import, lys_include, lys_ext, lys_feature, lys_tpdf, lys_restr, |
| 407 | lys_ident, lys_deviation, lys_type_enum, lys_type_bit, lys_when and lys_revision */ |
| 408 | LYEXT_SUBSTMT_ERRTAG, /**< extension of the error-app-tag statement, can appear in lys_restr */ |
| 409 | LYEXT_SUBSTMT_ERRMSG, /**< extension of the error-message statement, can appear in lys_restr */ |
| 410 | LYEXT_SUBSTMT_KEY, /**< extension of the key statement, can appear in lys_node_list */ |
| 411 | LYEXT_SUBSTMT_NAMESPACE, /**< extension of the namespace statement, can appear in lys_module */ |
| 412 | LYEXT_SUBSTMT_ORGANIZATION, /**< extension of the organization statement, can appear in lys_module and lys_submodule */ |
| 413 | LYEXT_SUBSTMT_PATH, /**< extension of the path statement, can appear in lys_type */ |
| 414 | LYEXT_SUBSTMT_PREFIX, /**< extension of the prefix statement, can appear in lys_module, lys_submodule (for |
| 415 | belongs-to's prefix) and lys_import */ |
| 416 | LYEXT_SUBSTMT_PRESENCE, /**< extension of the presence statement, can appear in lys_node_container */ |
| 417 | LYEXT_SUBSTMT_REFERENCE, /**< extension of the reference statement, can appear in lys_module, lys_submodule, |
| 418 | lys_node, lys_import, lys_include, lys_revision, lys_tpdf, lys_restr, lys_ident, |
| 419 | lys_ext, lys_feature, lys_deviation, lys_type_enum, lys_type_bit and lys_when */ |
| 420 | LYEXT_SUBSTMT_REVISIONDATE, /**< extension of the revision-date statement, can appear in lys_import and lys_include */ |
| 421 | LYEXT_SUBSTMT_UNITS, /**< extension of the units statement, can appear in lys_tpdf, lys_node_leaf, |
| 422 | lys_node_leaflist and lys_deviate */ |
| 423 | LYEXT_SUBSTMT_VALUE, /**< extension of the value statement, can appear in lys_type_enum */ |
| 424 | LYEXT_SUBSTMT_VERSION, /**< extension of the yang-version statement, can appear in lys_module and lys_submodule */ |
| 425 | LYEXT_SUBSTMT_MODIFIER, /**< extension of the modifier statement, can appear in lys_restr */ |
| 426 | LYEXT_SUBSTMT_REQINSTANCE, /**< extension of the require-instance statement, can appear in lys_type */ |
| 427 | LYEXT_SUBSTMT_YINELEM, /**< extension of the yin-element statement, can appear in lys_ext */ |
| 428 | LYEXT_SUBSTMT_CONFIG, /**< extension of the config statement, can appear in lys_node and lys_deviate */ |
| 429 | LYEXT_SUBSTMT_MANDATORY, /**< extension of the mandatory statement, can appear in lys_node_leaf, lys_node_choice, |
| 430 | lys_node_anydata and lys_deviate */ |
| 431 | LYEXT_SUBSTMT_ORDEREDBY, /**< extension of the ordered-by statement, can appear in lys_node_list and lys_node_leaflist */ |
| 432 | LYEXT_SUBSTMT_STATUS, /**< extension of the status statement, can appear in lys_tpdf, lys_node, lys_ident, |
| 433 | lys_ext, lys_feature, lys_type_enum and lys_type_bit */ |
| 434 | LYEXT_SUBSTMT_FRACDIGITS, /**< extension of the fraction-digits statement, can appear in lys_type */ |
| 435 | LYEXT_SUBSTMT_MAX, /**< extension of the max-elements statement, can appear in lys_node_list, |
| 436 | lys_node_leaflist and lys_deviate */ |
| 437 | LYEXT_SUBSTMT_MIN, /**< extension of the min-elements statement, can appear in lys_node_list, |
| 438 | lys_node_leaflist and lys_deviate */ |
| 439 | LYEXT_SUBSTMT_POSITION, /**< extension of the position statement, can appear in lys_type_bit */ |
| 440 | LYEXT_SUBSTMT_UNIQUE, /**< extension of the unique statement, can appear in lys_node_list and lys_deviate */ |
Michal Vasko | 6973015 | 2020-10-09 16:30:07 +0200 | [diff] [blame] | 441 | LYEXT_SUBSTMT_IFFEATURE /**< extension of the if-feature statement */ |
Radek Krejci | 0e59c31 | 2019-08-15 15:34:15 +0200 | [diff] [blame] | 442 | } LYEXT_SUBSTMT; |
| 443 | |
| 444 | /** |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 445 | * @brief YANG import-stmt |
| 446 | */ |
| 447 | struct lysp_import { |
Radek Krejci | 086c713 | 2018-10-26 15:29:04 +0200 | [diff] [blame] | 448 | struct lys_module *module; /**< pointer to the imported module |
| 449 | (mandatory, but resolved when the referring module is completely parsed) */ |
| 450 | const char *name; /**< name of the imported module (mandatory) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 451 | const char *prefix; /**< prefix for the data from the imported schema (mandatory) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 452 | const char *dsc; /**< description */ |
| 453 | const char *ref; /**< reference */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 454 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 455 | char rev[LY_REV_SIZE]; /**< revision-date of the imported module */ |
| 456 | }; |
| 457 | |
| 458 | /** |
| 459 | * @brief YANG include-stmt |
| 460 | */ |
| 461 | struct lysp_include { |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 462 | struct lysp_submodule *submodule;/**< pointer to the parsed submodule structure |
Radek Krejci | 086c713 | 2018-10-26 15:29:04 +0200 | [diff] [blame] | 463 | (mandatory, but resolved when the referring module is completely parsed) */ |
| 464 | const char *name; /**< name of the included submodule (mandatory) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 465 | const char *dsc; /**< description */ |
| 466 | const char *ref; /**< reference */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 467 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 468 | char rev[LY_REV_SIZE]; /**< revision-date of the included submodule */ |
| 469 | }; |
| 470 | |
| 471 | /** |
| 472 | * @brief YANG extension-stmt |
| 473 | */ |
| 474 | struct lysp_ext { |
| 475 | const char *name; /**< extension name */ |
| 476 | const char *argument; /**< argument name, NULL if not specified */ |
| 477 | const char *dsc; /**< description statement */ |
| 478 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 479 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | f56e2a4 | 2019-09-09 14:15:25 +0200 | [diff] [blame] | 480 | uint16_t flags; /**< LYS_STATUS_* and LYS_YINELEM_* values (@ref snodeflags) */ |
Michal Vasko | 5fe75f1 | 2020-03-02 13:52:37 +0100 | [diff] [blame] | 481 | |
| 482 | struct lysc_ext *compiled; /**< pointer to the compiled extension definition */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 483 | }; |
| 484 | |
| 485 | /** |
| 486 | * @brief Helper structure for generic storage of the extension instances content. |
| 487 | */ |
| 488 | struct lysp_stmt { |
| 489 | const char *stmt; /**< identifier of the statement */ |
| 490 | const char *arg; /**< statement's argument */ |
| 491 | struct lysp_stmt *next; /**< link to the next statement */ |
Michal Vasko | bc2559f | 2018-09-07 10:17:50 +0200 | [diff] [blame] | 492 | struct lysp_stmt *child; /**< list of the statement's substatements (linked list) */ |
David Sedlák | b9d75c4 | 2019-08-14 10:49:42 +0200 | [diff] [blame] | 493 | uint16_t flags; /**< statement flags, can be set to LYS_YIN_ATTR */ |
Radek Krejci | 335332a | 2019-09-05 13:03:35 +0200 | [diff] [blame] | 494 | enum ly_stmt kw; /**< numeric respresentation of the stmt value */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 495 | }; |
| 496 | |
David Sedlák | ae4b451 | 2019-08-14 10:45:56 +0200 | [diff] [blame] | 497 | #define LYS_YIN 0x1 /**< used to specify input format of extension instance */ |
| 498 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 499 | /** |
| 500 | * @brief YANG extension instance |
| 501 | */ |
| 502 | struct lysp_ext_instance { |
David Sedlák | bbd06ca | 2019-06-27 14:15:38 +0200 | [diff] [blame] | 503 | const char *name; /**< extension identifier, including possible prefix */ |
| 504 | const char *argument; /**< optional value of the extension's argument */ |
Radek Krejci | 335332a | 2019-09-05 13:03:35 +0200 | [diff] [blame] | 505 | void *parent; /**< pointer to the parent element holding the extension instance(s), use |
| 506 | ::lysp_ext_instance#parent_type to access the schema element */ |
David Sedlák | bbd06ca | 2019-06-27 14:15:38 +0200 | [diff] [blame] | 507 | struct lysp_stmt *child; /**< list of the extension's substatements (linked list) */ |
Radek Krejci | f56e2a4 | 2019-09-09 14:15:25 +0200 | [diff] [blame] | 508 | struct lysc_ext_instance *compiled; /**< pointer to the compiled data if any - in case the source format is YIN, |
| 509 | some of the information (argument) are available only after compilation */ |
David Sedlák | bbd06ca | 2019-06-27 14:15:38 +0200 | [diff] [blame] | 510 | LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */ |
Michal Vasko | fd69e1d | 2020-07-03 11:57:17 +0200 | [diff] [blame] | 511 | LY_ARRAY_COUNT_TYPE insubstmt_index; /**< in case the instance is in a substatement, this identifies |
David Sedlák | bbd06ca | 2019-06-27 14:15:38 +0200 | [diff] [blame] | 512 | the index of that substatement */ |
David Sedlák | ae4b451 | 2019-08-14 10:45:56 +0200 | [diff] [blame] | 513 | uint8_t yin; /** flag for YIN source format, can be set to LYS_YIN */ |
Radek Krejci | 335332a | 2019-09-05 13:03:35 +0200 | [diff] [blame] | 514 | LYEXT_PARENT parent_type; /**< type of the parent structure */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 515 | }; |
| 516 | |
| 517 | /** |
| 518 | * @brief YANG feature-stmt |
| 519 | */ |
| 520 | struct lysp_feature { |
| 521 | const char *name; /**< feature name (mandatory) */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 522 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 523 | const char *dsc; /**< description statement */ |
| 524 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 525 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 526 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values allowed */ |
| 527 | }; |
| 528 | |
| 529 | /** |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 530 | * @brief Qualified name (optional prefix followed by an identifier). |
| 531 | */ |
| 532 | struct lysp_qname { |
| 533 | const char *str; /**< qualified name string */ |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 534 | const struct lysp_module *mod; /**< module to resolve any prefixes found in the string, it must be |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 535 | stored explicitly because of deviations/refines */ |
| 536 | }; |
| 537 | |
| 538 | /** |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 539 | * @brief YANG identity-stmt |
| 540 | */ |
| 541 | struct lysp_ident { |
| 542 | const char *name; /**< identity name (mandatory), including possible prefix */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 543 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 544 | const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 545 | const char *dsc; /**< description statement */ |
| 546 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 547 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 548 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */ |
| 549 | }; |
| 550 | |
Michal Vasko | 71e64ca | 2018-09-07 16:30:29 +0200 | [diff] [blame] | 551 | /** |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 552 | * @brief Covers restrictions: range, length, pattern, must |
| 553 | */ |
| 554 | struct lysp_restr { |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 555 | struct lysp_qname arg; /**< The restriction expression/value (mandatory); |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 556 | in case of pattern restriction, the first byte has a special meaning: |
| 557 | 0x06 (ACK) for regular match and 0x15 (NACK) for invert-match */ |
| 558 | const char *emsg; /**< error-message */ |
| 559 | const char *eapptag; /**< error-app-tag value */ |
| 560 | const char *dsc; /**< description */ |
| 561 | const char *ref; /**< reference */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 562 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 563 | }; |
| 564 | |
| 565 | /** |
Michal Vasko | 71e64ca | 2018-09-07 16:30:29 +0200 | [diff] [blame] | 566 | * @brief YANG revision-stmt |
| 567 | */ |
| 568 | struct lysp_revision { |
Radek Krejci | b7db73a | 2018-10-24 14:18:40 +0200 | [diff] [blame] | 569 | char date[LY_REV_SIZE]; /**< revision date (madatory) */ |
Michal Vasko | 71e64ca | 2018-09-07 16:30:29 +0200 | [diff] [blame] | 570 | const char *dsc; /**< description statement */ |
| 571 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 572 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 71e64ca | 2018-09-07 16:30:29 +0200 | [diff] [blame] | 573 | }; |
| 574 | |
| 575 | /** |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 576 | * @brief Enumeration/Bit value definition |
| 577 | */ |
| 578 | struct lysp_type_enum { |
| 579 | const char *name; /**< name (mandatory) */ |
| 580 | const char *dsc; /**< description statement */ |
| 581 | const char *ref; /**< reference statement */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 582 | int64_t value; /**< enum's value or bit's position */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 583 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 584 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 585 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE |
| 586 | values are allowed */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 587 | }; |
| 588 | |
| 589 | /** |
| 590 | * @brief YANG type-stmt |
| 591 | * |
| 592 | * Some of the items in the structure may be mandatory, but it is necessary to resolve the type's base type first |
| 593 | */ |
| 594 | struct lysp_type { |
| 595 | const char *name; /**< name of the type (mandatory) */ |
| 596 | struct lysp_restr *range; /**< allowed values range - numerical, decimal64 */ |
| 597 | struct lysp_restr *length; /**< allowed length of the value - string, binary */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 598 | struct lysp_restr *patterns; /**< list of patterns ([sized array](@ref sizedarrays)) - string */ |
| 599 | struct lysp_type_enum *enums; /**< list of enum-stmts ([sized array](@ref sizedarrays)) - enum */ |
| 600 | struct lysp_type_enum *bits; /**< list of bit-stmts ([sized array](@ref sizedarrays)) - bits */ |
Michal Vasko | 004d315 | 2020-06-11 19:59:22 +0200 | [diff] [blame] | 601 | struct lyxp_expr *path; /**< parsed path - leafref */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 602 | const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) - identityref */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 603 | struct lysp_type *types; /**< list of sub-types ([sized array](@ref sizedarrays)) - union */ |
| 604 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 605 | |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 606 | const struct lysp_module *pmod; /**< (sub)module where the type is defined (needed for deviations) */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 607 | struct lysc_type *compiled; /**< pointer to the compiled type */ |
| 608 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 609 | uint8_t fraction_digits; /**< number of fraction digits - decimal64 */ |
| 610 | uint8_t require_instance; /**< require-instance flag - leafref, instance */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 611 | uint16_t flags; /**< [schema node flags](@ref spnodeflags) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 612 | }; |
| 613 | |
| 614 | /** |
| 615 | * @brief YANG typedef-stmt |
| 616 | */ |
| 617 | struct lysp_tpdf { |
| 618 | const char *name; /**< name of the newly defined type (mandatory) */ |
| 619 | const char *units; /**< units of the newly defined type */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 620 | struct lysp_qname dflt; /**< default value of the newly defined type, it may or may not be a qualified name */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 621 | const char *dsc; /**< description statement */ |
| 622 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 623 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 624 | struct lysp_type type; /**< base type from which the typedef is derived (mandatory) */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 625 | uint16_t flags; /**< [schema node flags](@ref spnodeflags) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 626 | }; |
| 627 | |
| 628 | /** |
| 629 | * @brief YANG grouping-stmt |
| 630 | */ |
| 631 | struct lysp_grp { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 632 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level grouping) */ |
| 633 | uint16_t nodetype; /**< LYS_GROUPING */ |
| 634 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 635 | const char *name; /**< grouping name (mandatory) */ |
| 636 | const char *dsc; /**< description statement */ |
| 637 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 638 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 639 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 640 | struct lysp_node *data; /**< list of data nodes (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 641 | struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 642 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
| 643 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 644 | }; |
| 645 | |
| 646 | /** |
| 647 | * @brief YANG when-stmt |
| 648 | */ |
| 649 | struct lysp_when { |
| 650 | const char *cond; /**< specified condition (mandatory) */ |
| 651 | const char *dsc; /**< description statement */ |
| 652 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 653 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 654 | }; |
| 655 | |
| 656 | /** |
| 657 | * @brief YANG refine-stmt |
| 658 | */ |
| 659 | struct lysp_refine { |
| 660 | const char *nodeid; /**< target descendant schema nodeid (mandatory) */ |
| 661 | const char *dsc; /**< description statement */ |
| 662 | const char *ref; /**< reference statement */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 663 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 664 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 665 | const char *presence; /**< presence description */ |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 666 | struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 667 | uint32_t min; /**< min-elements constraint */ |
| 668 | uint32_t max; /**< max-elements constraint, 0 means unbounded */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 669 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 670 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 671 | }; |
| 672 | |
| 673 | /** |
Michal Vasko | 82a8343 | 2019-11-14 12:33:04 +0100 | [diff] [blame] | 674 | * @brief YANG uses-augment-stmt and augment-stmt (compatible with struct lysp_node ) |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 675 | */ |
| 676 | struct lysp_augment { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 677 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level augment) */ |
| 678 | uint16_t nodetype; /**< LYS_AUGMENT */ |
| 679 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */ |
Michal Vasko | 82a8343 | 2019-11-14 12:33:04 +0100 | [diff] [blame] | 680 | struct lysp_node *child; /**< list of data nodes (linked list) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 681 | const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */ |
| 682 | const char *dsc; /**< description statement */ |
| 683 | const char *ref; /**< reference statement */ |
| 684 | struct lysp_when *when; /**< when statement */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 685 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 82a8343 | 2019-11-14 12:33:04 +0100 | [diff] [blame] | 686 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 687 | struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 688 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 689 | }; |
| 690 | |
| 691 | /** |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 692 | * @ingroup schematree |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 693 | * @defgroup deviatetypes Deviate types |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 694 | * |
| 695 | * Type of the deviate operation (used as ::lysp_deviate.mod) |
| 696 | * |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 697 | * @{ |
| 698 | */ |
| 699 | #define LYS_DEV_NOT_SUPPORTED 1 /**< deviate type not-supported */ |
| 700 | #define LYS_DEV_ADD 2 /**< deviate type add */ |
| 701 | #define LYS_DEV_DELETE 3 /**< deviate type delete */ |
| 702 | #define LYS_DEV_REPLACE 4 /**< deviate type replace */ |
Radek Krejci | 2ff0d57 | 2020-05-21 15:27:28 +0200 | [diff] [blame] | 703 | /** @} deviatetypes */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 704 | |
| 705 | /** |
| 706 | * @brief Generic deviate structure to get type and cast to lysp_deviate_* structure |
| 707 | */ |
| 708 | struct lysp_deviate { |
| 709 | uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */ |
| 710 | struct lysp_deviate *next; /**< next deviate structure in the list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 711 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 712 | }; |
| 713 | |
| 714 | struct lysp_deviate_add { |
| 715 | uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */ |
| 716 | struct lysp_deviate *next; /**< next deviate structure in the list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 717 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 718 | const char *units; /**< units of the values */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 719 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 720 | struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */ |
| 721 | struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 722 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 723 | uint32_t min; /**< min-elements constraint */ |
| 724 | uint32_t max; /**< max-elements constraint, 0 means unbounded */ |
| 725 | }; |
| 726 | |
| 727 | struct lysp_deviate_del { |
| 728 | uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */ |
| 729 | struct lysp_deviate *next; /**< next deviate structure in the list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 730 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 731 | const char *units; /**< units of the values */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 732 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 733 | struct lysp_qname *uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */ |
| 734 | struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 735 | }; |
| 736 | |
| 737 | struct lysp_deviate_rpl { |
| 738 | uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */ |
| 739 | struct lysp_deviate *next; /**< next deviate structure in the list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 740 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 741 | struct lysp_type *type; /**< type of the node */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 742 | const char *units; /**< units of the values */ |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 743 | struct lysp_qname dflt; /**< default value */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 744 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 745 | uint32_t min; /**< min-elements constraint */ |
| 746 | uint32_t max; /**< max-elements constraint, 0 means unbounded */ |
| 747 | }; |
| 748 | |
| 749 | struct lysp_deviation { |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 750 | const char *nodeid; /**< target absolute schema nodeid (mandatory) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 751 | const char *dsc; /**< description statement */ |
| 752 | const char *ref; /**< reference statement */ |
Michal Vasko | 22df3f0 | 2020-08-24 13:29:22 +0200 | [diff] [blame] | 753 | struct lysp_deviate *deviates; /**< list of deviate specifications (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 754 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 755 | }; |
| 756 | |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 757 | /** |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 758 | * @ingroup snodeflags |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 759 | * @defgroup spnodeflags Parsed schema nodes flags |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 760 | * |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 761 | * Various flags for parsed schema nodes (used as ::lysp_node.flags). |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 762 | * |
| 763 | * 1 - container 6 - anydata/anyxml 11 - output 16 - grouping 21 - enum |
| 764 | * 2 - choice 7 - case 12 - feature 17 - uses 22 - type |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 765 | * 3 - leaf 8 - notification 13 - identity 18 - refine 23 - stmt |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 766 | * 4 - leaflist 9 - rpc 14 - extension 19 - augment |
| 767 | * 5 - list 10 - input 15 - typedef 20 - deviate |
| 768 | * |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 769 | * 1 1 1 1 1 1 1 1 1 1 2 2 2 2 |
| 770 | * 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 |
| 771 | * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Michal Vasko | 5297a43 | 2020-08-31 12:27:51 +0200 | [diff] [blame] | 772 | * 1 LYS_CONFIG_W |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | | |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 773 | * LYS_SET_BASE | | | | | | | | | | | | | | | | | | | | | |x| | |
| 774 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Michal Vasko | 5297a43 | 2020-08-31 12:27:51 +0200 | [diff] [blame] | 775 | * 2 LYS_CONFIG_R |x|x|x|x|x|x| | | | | | | | | | | |x| |x| | | | |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 776 | * LYS_SET_BIT | | | | | | | | | | | | | | | | | | | | | |x| | |
| 777 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 778 | * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | | |
| 779 | * LYS_SET_ENUM | | | | | | | | | | | | | | | | | | | | | |x| | |
| 780 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 781 | * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | | |
| 782 | * LYS_SET_FRDIGITS | | | | | | | | | | | | | | | | | | | | | |x| | |
| 783 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 784 | * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | | |
| 785 | * LYS_SET_LENGTH | | | | | | | | | | | | | | | | | | | | | |x| | |
| 786 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 787 | * 6 LYS_MAND_TRUE | |x|x| | |x| | | | | | | | | | | |x| |x| | | | |
| 788 | * LYS_SET_PATH | | | | | | | | | | | | | | | | | | | | | |x| | |
| 789 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 790 | * 7 LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | | |x| |x| | | | |
| 791 | * LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | | | | | | | | | |
| 792 | * LYS_SET_PATTERN | | | | | | | | | | | | | | | | | | | | | |x| | |
| 793 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 794 | * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | | | | | | | | | |
| 795 | * LYS_YINELEM_TRUE | | | | | | | | | | | | | |x| | | | | | | | | | |
| 796 | * LYS_SET_RANGE | | | | | | | | | | | | | | | | | | | | | |x| | |
| 797 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 798 | * 9 LYS_YINELEM_FALSE| | | | | | | | | | | | | |x| | | | | | | | | | |
| 799 | * LYS_SET_TYPE | | | | | | | | | | | | | | | | | | | | | |x| | |
| 800 | * LYS_SINGLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x| |
| 801 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 802 | * 10 LYS_SET_VALUE | | | | | | | | | | | | | | | | | | | | |x| | | |
| 803 | * LYS_SET_REQINST | | | | | | | | | | | | | | | | | | | | | |x| | |
| 804 | * LYS_SET_MIN | | | |x|x| | | | | | | | | | | | |x| |x| | | | |
| 805 | * LYS_DOUBLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x| |
| 806 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 807 | * 11 LYS_SET_MAX | | | |x|x| | | | | | | | | | | | |x| |x| | | | |
Radek Krejci | f2de0ed | 2019-05-02 14:13:18 +0200 | [diff] [blame] | 808 | * LYS_USED_GRP | | | | | | | | | | | | | | | |x| | | | | | | | |
David Sedlák | ae4b451 | 2019-08-14 10:45:56 +0200 | [diff] [blame] | 809 | * LYS_YIN_ATTR | | | | | | | | | | | | | | | | | | | | | | |x| |
Michal Vasko | 5297a43 | 2020-08-31 12:27:51 +0200 | [diff] [blame] | 810 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 811 | * 12 LYS_YIN_ARGUMENT | | | | | | | | | | | | | | | | | | | | | | |x| |
Radek Krejci | f56e2a4 | 2019-09-09 14:15:25 +0200 | [diff] [blame] | 812 | * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 813 | * |
| 814 | */ |
| 815 | |
| 816 | /** |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 817 | * @ingroup snodeflags |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 818 | * @defgroup scnodeflags Compiled schema nodes flags |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 819 | * |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 820 | * Various flags for compiled schema nodes (used as ::lysc_node.flags). |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 821 | * |
Radek Krejci | 61e042e | 2019-09-10 15:53:09 +0200 | [diff] [blame] | 822 | * 1 - container 6 - anydata/anyxml 11 - identity |
| 823 | * 2 - choice 7 - case 12 - extension |
| 824 | * 3 - leaf 8 - notification 13 - bitenum |
Michal Vasko | 03ff5a7 | 2019-09-11 13:49:33 +0200 | [diff] [blame] | 825 | * 4 - leaflist 9 - rpc/action 14 - when |
Michal Vasko | ecd62de | 2019-11-13 12:35:11 +0100 | [diff] [blame] | 826 | * 5 - list 10 - feature |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 827 | * |
Michal Vasko | ecd62de | 2019-11-13 12:35:11 +0100 | [diff] [blame] | 828 | * 1 1 1 1 1 |
| 829 | * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4 |
| 830 | * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 831 | * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | | |
| 832 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 833 | * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | | |
| 834 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 835 | * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x|x|x|x| |x| |
| 836 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 837 | * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x|x|x|x| |x| |
| 838 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 839 | * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x|x|x|x| |x| |
| 840 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 841 | * 6 LYS_MAND_TRUE |x|x|x|x|x|x| | | | | | | | | |
| 842 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 843 | * 7 LYS_ORDBY_USER | | | |x|x| | | | | | | | | | |
| 844 | * LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | |
| 845 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 846 | * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | |
| 847 | * LYS_PRESENCE |x| | | | | | | | | | | | | | |
| 848 | * LYS_UNIQUE | | |x| | | | | | | | | | | | |
| 849 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 850 | * 9 LYS_KEY | | |x| | | | | | | | | | | | |
| 851 | * LYS_FENABLED | | | | | | | | | |x| | | | | |
| 852 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 853 | * 10 LYS_SET_DFLT | | |x|x| | |x| | | | | | | | |
| 854 | * LYS_ISENUM | | | | | | | | | | | | |x| | |
| 855 | * LYS_KEYLESS | | | | |x| | | | | | | | | | |
| 856 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 857 | * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | | |
| 858 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 859 | * 12 LYS_SET_CONFIG |x|x|x|x|x|x| | | | | | | | | |
| 860 | * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 861 | * |
| 862 | */ |
| 863 | |
| 864 | /** |
| 865 | * @defgroup snodeflags Schema nodes flags |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 866 | * |
| 867 | * Various flags for schema nodes ([parsed](@ref spnodeflags) as well as [compiled](@ref scnodeflags)). |
| 868 | * |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 869 | * @{ |
| 870 | */ |
Michal Vasko | 1bf0939 | 2020-03-27 12:38:10 +0100 | [diff] [blame] | 871 | #define LYS_CONFIG_W 0x01 /**< config true; also set for input children nodes */ |
| 872 | #define LYS_CONFIG_R 0x02 /**< config false; also set for output and notification children nodes */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 873 | #define LYS_CONFIG_MASK 0x03 /**< mask for config value */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 874 | #define LYS_STATUS_CURR 0x04 /**< status current; */ |
| 875 | #define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */ |
| 876 | #define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */ |
| 877 | #define LYS_STATUS_MASK 0x1C /**< mask for status value */ |
| 878 | #define LYS_MAND_TRUE 0x20 /**< mandatory true; applicable only to ::lysp_node_choice/::lysc_node_choice, |
Radek Krejci | fe90963 | 2019-02-12 15:34:42 +0100 | [diff] [blame] | 879 | ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata. |
| 880 | The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0. |
| 881 | The ::lysc_node_container has this flag if it is not a presence container and it has at least one |
| 882 | child with LYS_MAND_TRUE. */ |
Radek Krejci | f1421c2 | 2019-02-19 13:05:20 +0100 | [diff] [blame] | 883 | #define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice, |
| 884 | ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata. |
| 885 | This flag is present only in case the mandatory false statement was explicitly specified. */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 886 | #define LYS_MAND_MASK 0x60 /**< mask for mandatory values */ |
Michal Vasko | c118ae2 | 2020-08-06 14:51:09 +0200 | [diff] [blame] | 887 | #define LYS_PRESENCE 0x80 /**< flag for presence property of a container, but it is not only for explicit presence |
| 888 | containers, but also for NP containers with some meaning, applicable only to |
| 889 | ::lysc_node_container */ |
Radek Krejci | 7adf4ff | 2018-12-05 08:55:00 +0100 | [diff] [blame] | 890 | #define LYS_UNIQUE 0x80 /**< flag for leafs being part of a unique set, applicable only to ::lysc_node_leaf */ |
| 891 | #define LYS_KEY 0x100 /**< flag for leafs being a key of a list, applicable only to ::lysc_node_leaf */ |
Radek Krejci | 0fe9b51 | 2019-07-26 17:51:05 +0200 | [diff] [blame] | 892 | #define LYS_KEYLESS 0x200 /**< flag for list without any key, applicable only to ::lysc_node_list */ |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 893 | #define LYS_FENABLED 0x100 /**< feature enabled flag, applicable only to ::lysc_feature. |
| 894 | Do not interpret presence of this flag as enabled feature! Also if-feature statements |
| 895 | are supposed to be taken into account, so use ::lys_feature_value() or |
| 896 | ::lysc_feature_value() to get know if a specific feature is really enabled. */ |
Radek Krejci | fe90963 | 2019-02-12 15:34:42 +0100 | [diff] [blame] | 897 | #define LYS_ORDBY_SYSTEM 0x80 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 898 | ::lysc_node_list/::lysp_node_list */ |
| 899 | #define LYS_ORDBY_USER 0x40 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and |
| 900 | ::lysc_node_list/::lysp_node_list */ |
| 901 | #define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */ |
| 902 | #define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */ |
| 903 | #define LYS_YINELEM_FALSE 0x100 /**< yin-element false for extension's argument */ |
| 904 | #define LYS_YINELEM_MASK 0x180 /**< mask for yin-element value */ |
Radek Krejci | f2de0ed | 2019-05-02 14:13:18 +0200 | [diff] [blame] | 905 | #define LYS_USED_GRP 0x400 /**< internal flag for validating not-instantiated groupings |
| 906 | (resp. do not validate again the instantiated groupings). */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 907 | #define LYS_SET_VALUE 0x200 /**< value attribute is set */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 908 | #define LYS_SET_MIN 0x200 /**< min attribute is set */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 909 | #define LYS_SET_MAX 0x400 /**< max attribute is set */ |
Radek Krejci | d505e3d | 2018-11-13 09:04:17 +0100 | [diff] [blame] | 910 | |
| 911 | #define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */ |
| 912 | #define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */ |
| 913 | #define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */ |
| 914 | #define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */ |
| 915 | #define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */ |
| 916 | #define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */ |
| 917 | #define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */ |
| 918 | #define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */ |
| 919 | #define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */ |
| 920 | #define LYS_SET_REQINST 0x0200 /**< type's flag for present require-instance substatement */ |
Radek Krejci | ccd20f1 | 2019-02-15 14:12:27 +0100 | [diff] [blame] | 921 | #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 Krejci | 76b3e96 | 2018-12-14 17:01:25 +0100 | [diff] [blame] | 922 | cases of choice. This information is important for refines, since it is prohibited to make leafs |
| 923 | with default statement mandatory. In case the default leaf value is taken from type, it is thrown |
Radek Krejci | ccd20f1 | 2019-02-15 14:12:27 +0100 | [diff] [blame] | 924 | away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish |
| 925 | between own default or the default values taken from the type. */ |
| 926 | #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 Krejci | f1421c2 | 2019-02-19 13:05:20 +0100 | [diff] [blame] | 927 | #define LYS_SET_CONFIG 0x0800 /**< flag to know if the config property was set explicitly (flag set) or it is inherited. */ |
Radek Krejci | 0e5d838 | 2018-11-28 16:37:53 +0100 | [diff] [blame] | 928 | |
Radek Krejci | f56e2a4 | 2019-09-09 14:15:25 +0200 | [diff] [blame] | 929 | #define LYS_SINGLEQUOTED 0x100 /**< flag for single-quoted argument of an extension instance's substatement, only when the source is YANG */ |
| 930 | #define LYS_DOUBLEQUOTED 0x200 /**< flag for double-quoted argument of an extension instance's substatement, only when the source is YANG */ |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 931 | |
Radek Krejci | f56e2a4 | 2019-09-09 14:15:25 +0200 | [diff] [blame] | 932 | #define LYS_YIN_ATTR 0x400 /**< flag to identify YIN attribute parsed as extension's substatement, only when the source is YIN */ |
| 933 | #define LYS_YIN_ARGUMENT 0x800 /**< flag to identify statement representing extension's argument, only when the source is YIN */ |
David Sedlák | bbd06ca | 2019-06-27 14:15:38 +0200 | [diff] [blame] | 934 | |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 935 | #define LYS_ISENUM 0x200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */ |
| 936 | |
Radek Krejci | fe90963 | 2019-02-12 15:34:42 +0100 | [diff] [blame] | 937 | #define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */ |
Radek Krejci | 2ff0d57 | 2020-05-21 15:27:28 +0200 | [diff] [blame] | 938 | /** @} snodeflags */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 939 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 940 | /** |
| 941 | * @brief Generic YANG data node |
| 942 | */ |
| 943 | struct lysp_node { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 944 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 945 | uint16_t nodetype; /**< type of the node (mandatory) */ |
| 946 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 947 | struct lysp_node *next; /**< next sibling node (NULL if there is no one) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 948 | const char *name; /**< node name (mandatory) */ |
| 949 | const char *dsc; /**< description statement */ |
| 950 | const char *ref; /**< reference statement */ |
| 951 | struct lysp_when *when; /**< when statement */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 952 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)), |
| 953 | must be qname because of refines */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 954 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 955 | }; |
| 956 | |
| 957 | /** |
| 958 | * @brief Extension structure of the lysp_node for YANG container |
| 959 | */ |
| 960 | struct lysp_node_container { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 961 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 962 | uint16_t nodetype; /**< LYS_CONTAINER */ |
| 963 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 964 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 965 | const char *name; /**< node name (mandatory) */ |
| 966 | const char *dsc; /**< description statement */ |
| 967 | const char *ref; /**< reference statement */ |
| 968 | struct lysp_when *when; /**< when statement */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 969 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 970 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 971 | |
| 972 | /* container */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 973 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 974 | const char *presence; /**< presence description */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 975 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 976 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 977 | struct lysp_node *child; /**< list of data nodes (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 978 | struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 979 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 980 | }; |
| 981 | |
| 982 | struct lysp_node_leaf { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 983 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 984 | uint16_t nodetype; /**< LYS_LEAF */ |
| 985 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 986 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 987 | const char *name; /**< node name (mandatory) */ |
| 988 | const char *dsc; /**< description statement */ |
| 989 | const char *ref; /**< reference statement */ |
| 990 | struct lysp_when *when; /**< when statement */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 991 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 992 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 993 | |
| 994 | /* leaf */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 995 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 996 | struct lysp_type type; /**< type of the leaf node (mandatory) */ |
| 997 | const char *units; /**< units of the leaf's type */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 998 | struct lysp_qname dflt; /**< default value, it may or may not be a qualified name */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 999 | }; |
| 1000 | |
| 1001 | struct lysp_node_leaflist { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 1002 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1003 | uint16_t nodetype; /**< LYS_LEAFLIST */ |
| 1004 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1005 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 1006 | const char *name; /**< node name (mandatory) */ |
| 1007 | const char *dsc; /**< description statement */ |
| 1008 | const char *ref; /**< reference statement */ |
| 1009 | struct lysp_when *when; /**< when statement */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1010 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1011 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1012 | |
| 1013 | /* leaf-list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1014 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1015 | struct lysp_type type; /**< type of the leaf node (mandatory) */ |
| 1016 | const char *units; /**< units of the leaf's type */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1017 | struct lysp_qname *dflts; /**< list of default values ([sized array](@ref sizedarrays)), they may or |
| 1018 | may not be qualified names */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1019 | uint32_t min; /**< min-elements constraint */ |
| 1020 | uint32_t max; /**< max-elements constraint, 0 means unbounded */ |
| 1021 | }; |
| 1022 | |
| 1023 | struct lysp_node_list { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 1024 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1025 | uint16_t nodetype; /**< LYS_LIST */ |
| 1026 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1027 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 1028 | const char *name; /**< node name (mandatory) */ |
| 1029 | const char *dsc; /**< description statement */ |
| 1030 | const char *ref; /**< reference statement */ |
| 1031 | struct lysp_when *when; /**< when statement */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1032 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1033 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1034 | |
| 1035 | /* list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1036 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1037 | const char *key; /**< keys specification */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1038 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 1039 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1040 | struct lysp_node *child; /**< list of data nodes (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1041 | struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 1042 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1043 | struct lysp_qname *uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1044 | uint32_t min; /**< min-elements constraint */ |
| 1045 | uint32_t max; /**< max-elements constraint, 0 means unbounded */ |
| 1046 | }; |
| 1047 | |
| 1048 | struct lysp_node_choice { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 1049 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1050 | uint16_t nodetype; /**< LYS_CHOICE */ |
| 1051 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1052 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 1053 | const char *name; /**< node name (mandatory) */ |
| 1054 | const char *dsc; /**< description statement */ |
| 1055 | const char *ref; /**< reference statement */ |
| 1056 | struct lysp_when *when; /**< when statement */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1057 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1058 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1059 | |
| 1060 | /* choice */ |
| 1061 | struct lysp_node *child; /**< list of data nodes (linked list) */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1062 | struct lysp_qname dflt; /**< default case */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1063 | }; |
| 1064 | |
| 1065 | struct lysp_node_case { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 1066 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1067 | uint16_t nodetype; /**< LYS_CASE */ |
| 1068 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1069 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 1070 | const char *name; /**< node name (mandatory) */ |
| 1071 | const char *dsc; /**< description statement */ |
| 1072 | const char *ref; /**< reference statement */ |
| 1073 | struct lysp_when *when; /**< when statement */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1074 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1075 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1076 | |
| 1077 | /* case */ |
| 1078 | struct lysp_node *child; /**< list of data nodes (linked list) */ |
| 1079 | }; |
| 1080 | |
| 1081 | struct lysp_node_anydata { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 1082 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1083 | uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1084 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1085 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 1086 | const char *name; /**< node name (mandatory) */ |
| 1087 | const char *dsc; /**< description statement */ |
| 1088 | const char *ref; /**< reference statement */ |
| 1089 | struct lysp_when *when; /**< when statement */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1090 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1091 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1092 | |
| 1093 | /* anyxml/anydata */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1094 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1095 | }; |
| 1096 | |
| 1097 | struct lysp_node_uses { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 1098 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 1099 | uint16_t nodetype; /**< LYS_USES */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1100 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1101 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 1102 | const char *name; /**< grouping name reference (mandatory) */ |
| 1103 | const char *dsc; /**< description statement */ |
| 1104 | const char *ref; /**< reference statement */ |
| 1105 | struct lysp_when *when; /**< when statement */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1106 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1107 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1108 | |
| 1109 | /* uses */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1110 | struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */ |
| 1111 | struct lysp_augment *augments; /**< list of uses's augment ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1112 | }; |
| 1113 | |
| 1114 | /** |
| 1115 | * @brief YANG input-stmt and output-stmt |
| 1116 | */ |
| 1117 | struct lysp_action_inout { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 1118 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1119 | uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1120 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1121 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 1122 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1123 | struct lysp_node *data; /**< list of data nodes (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1124 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1125 | }; |
| 1126 | |
| 1127 | /** |
| 1128 | * @brief YANG rpc-stmt and action-stmt |
| 1129 | */ |
| 1130 | struct lysp_action { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 1131 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
Michal Vasko | 1bf0939 | 2020-03-27 12:38:10 +0100 | [diff] [blame] | 1132 | uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */ |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 1133 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1134 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1135 | const char *name; /**< grouping name reference (mandatory) */ |
| 1136 | const char *dsc; /**< description statement */ |
| 1137 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1138 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1139 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
| 1140 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1141 | |
| 1142 | /* action */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1143 | struct lysp_action_inout input; /**< RPC's/Action's input */ |
| 1144 | struct lysp_action_inout output; /**< RPC's/Action's output */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1145 | }; |
| 1146 | |
| 1147 | /** |
| 1148 | * @brief YANG notification-stmt |
| 1149 | */ |
| 1150 | struct lysp_notif { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 1151 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
| 1152 | uint16_t nodetype; /**< LYS_NOTIF */ |
| 1153 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values are allowed */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1154 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1155 | const char *name; /**< grouping name reference (mandatory) */ |
| 1156 | const char *dsc; /**< description statement */ |
| 1157 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1158 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1159 | struct lysp_qname *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1160 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1161 | |
| 1162 | /* notif */ |
| 1163 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1164 | struct lysp_node *data; /**< list of data nodes (linked list) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1165 | }; |
| 1166 | |
| 1167 | /** |
Radek Krejci | f0fceb6 | 2018-09-05 14:58:45 +0200 | [diff] [blame] | 1168 | * @brief supported YANG schema version values |
| 1169 | */ |
| 1170 | typedef enum LYS_VERSION { |
| 1171 | LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */ |
Radek Krejci | 96e48da | 2020-09-04 13:18:06 +0200 | [diff] [blame] | 1172 | LYS_VERSION_1_0 = 1, /**< YANG 1 (1.0) */ |
Radek Krejci | f0fceb6 | 2018-09-05 14:58:45 +0200 | [diff] [blame] | 1173 | LYS_VERSION_1_1 = 2 /**< YANG 1.1 */ |
| 1174 | } LYS_VERSION; |
| 1175 | |
| 1176 | /** |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1177 | * @brief Printable YANG schema tree structure representing YANG module. |
| 1178 | * |
| 1179 | * Simple structure corresponding to the YANG format. The schema is only syntactically validated. |
| 1180 | */ |
| 1181 | struct lysp_module { |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1182 | struct lys_module *mod; /**< covering module structure */ |
| 1183 | |
Radek Krejci | b7db73a | 2018-10-24 14:18:40 +0200 | [diff] [blame] | 1184 | struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision |
| 1185 | in the list is always the last (newest) revision of the module */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1186 | struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */ |
| 1187 | struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1188 | struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */ |
| 1189 | struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */ |
| 1190 | struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */ |
| 1191 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 1192 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1193 | struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1194 | struct lysp_augment *augments; /**< list of augments ([sized array](@ref sizedarrays)) */ |
| 1195 | struct lysp_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */ |
| 1196 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
| 1197 | struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */ |
Michal Vasko | c3781c3 | 2020-10-06 14:04:08 +0200 | [diff] [blame] | 1198 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1199 | |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 1200 | uint8_t version; /**< yang-version (LYS_VERSION values) */ |
Michal Vasko | c3781c3 | 2020-10-06 14:04:08 +0200 | [diff] [blame] | 1201 | uint8_t parsing : 1; /**< flag for circular check */ |
| 1202 | uint8_t is_submod : 1; /**< always 0 */ |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1203 | }; |
| 1204 | |
| 1205 | struct lysp_submodule { |
Michal Vasko | c3781c3 | 2020-10-06 14:04:08 +0200 | [diff] [blame] | 1206 | struct lys_module *mod; /**< belongs to parent module (submodule - mandatory) */ |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1207 | |
| 1208 | struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision |
| 1209 | in the list is always the last (newest) revision of the module */ |
| 1210 | struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */ |
| 1211 | struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */ |
| 1212 | struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */ |
| 1213 | struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */ |
| 1214 | struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */ |
| 1215 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 1216 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
| 1217 | struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */ |
| 1218 | struct lysp_augment *augments; /**< list of augments ([sized array](@ref sizedarrays)) */ |
| 1219 | struct lysp_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */ |
| 1220 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
| 1221 | struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */ |
Michal Vasko | c3781c3 | 2020-10-06 14:04:08 +0200 | [diff] [blame] | 1222 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1223 | |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 1224 | uint8_t version; /**< yang-version (LYS_VERSION values) */ |
Michal Vasko | c3781c3 | 2020-10-06 14:04:08 +0200 | [diff] [blame] | 1225 | uint8_t parsing : 1; /**< flag for circular check */ |
| 1226 | uint8_t is_submod : 1; /**< always 1 */ |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1227 | |
Michal Vasko | c3781c3 | 2020-10-06 14:04:08 +0200 | [diff] [blame] | 1228 | uint8_t latest_revision : 2; /**< flag to mark the latest available revision: |
Radek Krejci | 086c713 | 2018-10-26 15:29:04 +0200 | [diff] [blame] | 1229 | 1 - the latest revision in searchdirs was not searched yet and this is the |
| 1230 | latest revision in the current context |
| 1231 | 2 - searchdirs were searched and this is the latest available revision */ |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1232 | const char *name; /**< name of the module (mandatory) */ |
| 1233 | const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */ |
| 1234 | const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */ |
| 1235 | const char *org; /**< party/company responsible for the module */ |
| 1236 | const char *contact; /**< contact information for the module */ |
| 1237 | const char *dsc; /**< description of the module */ |
| 1238 | const char *ref; /**< cross-reference for the module */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1239 | }; |
| 1240 | |
| 1241 | /** |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 1242 | * @brief Get the parsed module or submodule name. |
| 1243 | * |
| 1244 | * @param[in] PMOD Parsed module or submodule. |
| 1245 | * @return Module or submodule name. |
| 1246 | */ |
| 1247 | #define LYSP_MODULE_NAME(PMOD) (PMOD->is_submod ? ((struct lysp_submodule *)PMOD)->name : ((struct lysp_module *)PMOD)->mod->name) |
| 1248 | |
| 1249 | /** |
| 1250 | * @brief Free the printable YANG schema tree structure. Works for both modules and submodules. |
Radek Krejci | 3f5e3db | 2018-10-11 15:57:47 +0200 | [diff] [blame] | 1251 | * |
| 1252 | * @param[in] module Printable YANG schema tree structure to free. |
| 1253 | */ |
| 1254 | void lysp_module_free(struct lysp_module *module); |
| 1255 | |
| 1256 | /** |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 1257 | * @brief Compiled prefix data pair mapping of prefixes to modules. In case the format is ::LY_PREF_SCHEMA_RESOLVED, |
| 1258 | * the expected prefix data is a sized array of these structures. |
| 1259 | */ |
| 1260 | struct lysc_prefix { |
| 1261 | char *prefix; /**< used prefix */ |
| 1262 | const struct lys_module *mod; /**< mapping to a module */ |
| 1263 | }; |
| 1264 | |
| 1265 | /** |
Radek Krejci | 0e59c31 | 2019-08-15 15:34:15 +0200 | [diff] [blame] | 1266 | * @brief Compiled YANG extension-stmt |
| 1267 | */ |
| 1268 | struct lysc_ext { |
| 1269 | const char *name; /**< extension name */ |
| 1270 | const char *argument; /**< argument name, NULL if not specified */ |
Radek Krejci | 0e59c31 | 2019-08-15 15:34:15 +0200 | [diff] [blame] | 1271 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1272 | struct lyext_plugin *plugin; /**< Plugin implementing the specific extension */ |
Radek Krejci | 0935f41 | 2019-08-20 16:15:18 +0200 | [diff] [blame] | 1273 | struct lys_module *module; /**< module structure */ |
Michal Vasko | 6f4cbb6 | 2020-02-28 11:15:47 +0100 | [diff] [blame] | 1274 | uint32_t refcount; /**< reference counter since extension definition is shared among all its instances */ |
Radek Krejci | 0e59c31 | 2019-08-15 15:34:15 +0200 | [diff] [blame] | 1275 | uint16_t flags; /**< LYS_STATUS_* value (@ref snodeflags) */ |
| 1276 | }; |
| 1277 | |
| 1278 | /** |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 1279 | * @brief YANG extension instance |
| 1280 | */ |
| 1281 | struct lysc_ext_instance { |
Radek Krejci | ad5963b | 2019-09-06 16:03:05 +0200 | [diff] [blame] | 1282 | uint32_t insubstmt_index; /**< in case the instance is in a substatement that can appear multiple times, |
| 1283 | this identifies the index of the substatement for this extension instance */ |
Radek Krejci | 28681fa | 2019-09-06 13:08:45 +0200 | [diff] [blame] | 1284 | struct lys_module *module; /**< module where the extension instantiated is defined */ |
Radek Krejci | ad5963b | 2019-09-06 16:03:05 +0200 | [diff] [blame] | 1285 | struct lysc_ext *def; /**< pointer to the extension definition */ |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 1286 | void *parent; /**< pointer to the parent element holding the extension instance(s), use |
| 1287 | ::lysc_ext_instance#parent_type to access the schema element */ |
| 1288 | const char *argument; /**< optional value of the extension's argument */ |
| 1289 | LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */ |
Radek Krejci | 2a408df | 2018-10-29 16:32:26 +0100 | [diff] [blame] | 1290 | LYEXT_PARENT parent_type; /**< type of the parent structure */ |
Radek Krejci | 2a408df | 2018-10-29 16:32:26 +0100 | [diff] [blame] | 1291 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 0e59c31 | 2019-08-15 15:34:15 +0200 | [diff] [blame] | 1292 | void *data; /**< private plugins's data, not used by libyang */ |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 1293 | }; |
| 1294 | |
| 1295 | /** |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1296 | * @brief Compiled YANG if-feature-stmt |
| 1297 | */ |
| 1298 | struct lysc_iffeature { |
| 1299 | uint8_t *expr; /**< 2bits array describing the if-feature expression in prefix format, see @ref ifftokens */ |
| 1300 | struct lysc_feature **features; /**< array of pointers to the features used in expression ([sized array](@ref sizedarrays)) */ |
| 1301 | }; |
| 1302 | |
| 1303 | /** |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1304 | * @brief YANG when-stmt |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1305 | */ |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1306 | struct lysc_when { |
| 1307 | struct lyxp_expr *cond; /**< XPath when condition */ |
Michal Vasko | 175012e | 2019-11-06 15:49:14 +0100 | [diff] [blame] | 1308 | struct lysc_node *context; /**< context node for evaluating the expression, NULL if the context is root node */ |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 1309 | struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 1310 | const char *dsc; /**< description */ |
| 1311 | const char *ref; /**< reference */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1312 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 00b874b | 2019-02-12 10:54:50 +0100 | [diff] [blame] | 1313 | uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */ |
Michal Vasko | ecd62de | 2019-11-13 12:35:11 +0100 | [diff] [blame] | 1314 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS is allowed */ |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1315 | }; |
| 1316 | |
| 1317 | /** |
Radek Krejci | 2a408df | 2018-10-29 16:32:26 +0100 | [diff] [blame] | 1318 | * @brief YANG identity-stmt |
| 1319 | */ |
| 1320 | struct lysc_ident { |
| 1321 | const char *name; /**< identity name (mandatory), including possible prefix */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 1322 | const char *dsc; /**< description */ |
| 1323 | const char *ref; /**< reference */ |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 1324 | struct lys_module *module; /**< module structure */ |
Radek Krejci | 2a408df | 2018-10-29 16:32:26 +0100 | [diff] [blame] | 1325 | struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */ |
| 1326 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1327 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 2a408df | 2018-10-29 16:32:26 +0100 | [diff] [blame] | 1328 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */ |
| 1329 | }; |
| 1330 | |
| 1331 | /** |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1332 | * @brief YANG feature-stmt |
| 1333 | */ |
| 1334 | struct lysc_feature { |
| 1335 | const char *name; /**< feature name (mandatory) */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 1336 | const char *dsc; /**< description */ |
| 1337 | const char *ref; /**< reference */ |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 1338 | struct lys_module *module; /**< module structure */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1339 | struct lysc_feature **depfeatures;/**< list of pointers to other features depending on this one ([sized array](@ref sizedarrays)) */ |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 1340 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1341 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1342 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* and |
| 1343 | #LYS_FENABLED values allowed */ |
| 1344 | }; |
| 1345 | |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1346 | /** |
| 1347 | * @defgroup ifftokens if-feature expression tokens |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 1348 | * Tokens of if-feature expression used in ::lysc_iffeature.expr. |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1349 | * |
| 1350 | * @{ |
| 1351 | */ |
| 1352 | #define LYS_IFF_NOT 0x00 /**< operand "not" */ |
| 1353 | #define LYS_IFF_AND 0x01 /**< operand "and" */ |
| 1354 | #define LYS_IFF_OR 0x02 /**< operand "or" */ |
| 1355 | #define LYS_IFF_F 0x03 /**< feature */ |
Radek Krejci | 2ff0d57 | 2020-05-21 15:27:28 +0200 | [diff] [blame] | 1356 | /** @} ifftokens */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1357 | |
| 1358 | /** |
Radek Krejci | b7db73a | 2018-10-24 14:18:40 +0200 | [diff] [blame] | 1359 | * @brief Compiled YANG revision statement |
| 1360 | */ |
| 1361 | struct lysc_revision { |
| 1362 | char date[LY_REV_SIZE]; /**< revision-date (mandatory) */ |
| 1363 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1364 | }; |
| 1365 | |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1366 | struct lysc_range { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1367 | struct lysc_range_part { |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 1368 | union { /**< min boundary */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1369 | int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */ |
| 1370 | uint64_t min_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1371 | }; |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 1372 | union { /**< max boundary */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1373 | int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */ |
| 1374 | uint64_t max_u64; /**< for uint8, uint16, uint32, uint64, string and binary ( < LY_TYPE_DEC64) */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1375 | }; |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1376 | } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 1377 | const char *dsc; /**< description */ |
| 1378 | const char *ref; /**< reference */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1379 | const char *emsg; /**< error-message */ |
| 1380 | const char *eapptag; /**< error-app-tag value */ |
| 1381 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1382 | }; |
| 1383 | |
| 1384 | struct lysc_pattern { |
Radek Krejci | 5457946 | 2019-04-30 12:47:06 +0200 | [diff] [blame] | 1385 | const char *expr; /**< original, not compiled, regular expression */ |
| 1386 | pcre2_code *code; /**< compiled regular expression */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 1387 | const char *dsc; /**< description */ |
| 1388 | const char *ref; /**< reference */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1389 | const char *emsg; /**< error-message */ |
| 1390 | const char *eapptag; /**< error-app-tag value */ |
| 1391 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 0f96988 | 2020-08-21 16:56:47 +0200 | [diff] [blame] | 1392 | uint32_t inverted : 1; /**< invert-match flag */ |
| 1393 | uint32_t refcount : 31; /**< reference counter */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1394 | }; |
| 1395 | |
| 1396 | struct lysc_must { |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1397 | struct lyxp_expr *cond; /**< XPath when condition */ |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 1398 | struct lysc_prefix *prefixes; /**< compiled used prefixes in the condition */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 1399 | const char *dsc; /**< description */ |
| 1400 | const char *ref; /**< reference */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1401 | const char *emsg; /**< error-message */ |
| 1402 | const char *eapptag; /**< error-app-tag value */ |
| 1403 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1404 | }; |
| 1405 | |
| 1406 | struct lysc_type { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1407 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1408 | 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 Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1409 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1410 | uint32_t refcount; /**< reference counter for type sharing */ |
| 1411 | }; |
| 1412 | |
| 1413 | struct lysc_type_num { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1414 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1415 | 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 Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1416 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1417 | uint32_t refcount; /**< reference counter for type sharing */ |
| 1418 | struct lysc_range *range; /**< Optional range limitation */ |
| 1419 | }; |
| 1420 | |
| 1421 | struct lysc_type_dec { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1422 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1423 | 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 Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1424 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1425 | uint32_t refcount; /**< reference counter for type sharing */ |
Radek Krejci | 6cba429 | 2018-11-15 17:33:29 +0100 | [diff] [blame] | 1426 | uint8_t fraction_digits; /**< fraction digits specification */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1427 | struct lysc_range *range; /**< Optional range limitation */ |
| 1428 | }; |
| 1429 | |
| 1430 | struct lysc_type_str { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1431 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1432 | 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 Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1433 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1434 | uint32_t refcount; /**< reference counter for type sharing */ |
| 1435 | struct lysc_range *length; /**< Optional length limitation */ |
Radek Krejci | 4586a02 | 2018-11-13 11:29:26 +0100 | [diff] [blame] | 1436 | struct lysc_pattern **patterns; /**< Optional list of pointers to pattern limitations ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1437 | }; |
| 1438 | |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 1439 | struct lysc_type_bitenum_item { |
| 1440 | const char *name; /**< enumeration identifier */ |
| 1441 | const char *dsc; /**< description */ |
| 1442 | const char *ref; /**< reference */ |
| 1443 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1444 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
| 1445 | union { |
| 1446 | int32_t value; /**< integer value associated with the enumeration */ |
| 1447 | uint32_t position; /**< non-negative integer value associated with the bit */ |
| 1448 | }; |
| 1449 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE |
| 1450 | values are allowed */ |
| 1451 | }; |
| 1452 | |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1453 | struct lysc_type_enum { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1454 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1455 | 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 Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1456 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1457 | uint32_t refcount; /**< reference counter for type sharing */ |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 1458 | struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */ |
| 1459 | }; |
| 1460 | |
| 1461 | struct lysc_type_bits { |
| 1462 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1463 | 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 Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 1464 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1465 | uint32_t refcount; /**< reference counter for type sharing */ |
Radek Krejci | 849a62a | 2019-05-22 15:29:05 +0200 | [diff] [blame] | 1466 | struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item), |
| 1467 | the items are ordered by their position value. */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1468 | }; |
| 1469 | |
| 1470 | struct lysc_type_leafref { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1471 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1472 | 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 Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1473 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1474 | uint32_t refcount; /**< reference counter for type sharing */ |
Michal Vasko | 004d315 | 2020-06-11 19:59:22 +0200 | [diff] [blame] | 1475 | struct lyxp_expr *path; /**< parsed target path, compiled path cannot be stored because of type sharing */ |
Michal Vasko | 5d24f6c | 2020-10-13 13:49:06 +0200 | [diff] [blame] | 1476 | struct lysc_prefix *prefixes; /**< resolved prefixes used in the path */ |
Radek Krejci | 412ddfa | 2018-11-23 11:44:11 +0100 | [diff] [blame] | 1477 | struct lysc_type *realtype; /**< pointer to the real (first non-leafref in possible leafrefs chain) type. */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1478 | uint8_t require_instance; /**< require-instance flag */ |
| 1479 | }; |
| 1480 | |
| 1481 | struct lysc_type_identityref { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1482 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1483 | 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 Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1484 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1485 | uint32_t refcount; /**< reference counter for type sharing */ |
Radek Krejci | 555cb5b | 2018-11-16 14:54:33 +0100 | [diff] [blame] | 1486 | struct lysc_ident **bases; /**< list of pointers to the base identities ([sized array](@ref sizedarrays)), |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1487 | mandatory (at least 1 item) */ |
| 1488 | }; |
| 1489 | |
| 1490 | struct lysc_type_instanceid { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1491 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1492 | 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 Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1493 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1494 | uint32_t refcount; /**< reference counter for type sharing */ |
| 1495 | uint8_t require_instance; /**< require-instance flag */ |
| 1496 | }; |
| 1497 | |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1498 | struct lysc_type_union { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1499 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1500 | 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 Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1501 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1502 | uint32_t refcount; /**< reference counter for type sharing */ |
| 1503 | struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */ |
| 1504 | }; |
| 1505 | |
| 1506 | struct lysc_type_bin { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1507 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1508 | 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 Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1509 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1510 | uint32_t refcount; /**< reference counter for type sharing */ |
| 1511 | struct lysc_range *length; /**< Optional length limitation */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1512 | }; |
| 1513 | |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1514 | struct lysc_action_inout { |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 1515 | uint16_t nodetype; /**< LYS_INPUT or LYS_OUTPUT */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1516 | struct lysc_node *data; /**< first child node (linked list) */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1517 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1518 | }; |
| 1519 | |
Michal Vasko | 60ea635 | 2020-06-29 13:39:39 +0200 | [diff] [blame] | 1520 | /** |
| 1521 | * @brief Maximum number of hashes stored in a schema node. |
| 1522 | */ |
| 1523 | #define LYS_NODE_HASH_COUNT 4 |
| 1524 | |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1525 | struct lysc_action { |
Michal Vasko | 1bf0939 | 2020-03-27 12:38:10 +0100 | [diff] [blame] | 1526 | uint16_t nodetype; /**< LYS_RPC or LYS_ACTION */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1527 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Michal Vasko | 60ea635 | 2020-06-29 13:39:39 +0200 | [diff] [blame] | 1528 | uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */ |
Radek Krejci | 95710c9 | 2019-02-11 15:49:55 +0100 | [diff] [blame] | 1529 | struct lys_module *module; /**< module structure */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1530 | 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. */ |
| 1531 | struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */ |
| 1532 | |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1533 | struct lysc_ext_instance *input_exts; /**< list of the extension instances of input ([sized array](@ref sizedarrays)) */ |
| 1534 | struct lysc_ext_instance *output_exts; /**< list of the extension instances of outpu ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1535 | |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1536 | const char *name; /**< action/RPC name (mandatory) */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1537 | const char *dsc; /**< description */ |
| 1538 | const char *ref; /**< reference */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1539 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1540 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
| 1541 | |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1542 | struct lysc_action_inout input; /**< RPC's/action's input */ |
| 1543 | struct lysc_action_inout output; /**< RPC's/action's output */ |
Michal Vasko | ceab6dd | 2020-10-09 16:53:36 +0200 | [diff] [blame] | 1544 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1545 | void *priv; /** private arbitrary user data, not used by libyang */ |
| 1546 | |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1547 | }; |
| 1548 | |
| 1549 | struct lysc_notif { |
| 1550 | uint16_t nodetype; /**< LYS_NOTIF */ |
| 1551 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Michal Vasko | 60ea635 | 2020-06-29 13:39:39 +0200 | [diff] [blame] | 1552 | uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */ |
Radek Krejci | 95710c9 | 2019-02-11 15:49:55 +0100 | [diff] [blame] | 1553 | struct lys_module *module; /**< module structure */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1554 | 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 Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1555 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1556 | |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1557 | struct lysc_node *data; /**< first child node (linked list) */ |
| 1558 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1559 | |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1560 | const char *name; /**< Notification name (mandatory) */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1561 | const char *dsc; /**< description */ |
| 1562 | const char *ref; /**< reference */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1563 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1564 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Michal Vasko | ceab6dd | 2020-10-09 16:53:36 +0200 | [diff] [blame] | 1565 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1566 | void *priv; /** private arbitrary user data, not used by libyang */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1567 | }; |
| 1568 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1569 | /** |
Radek Krejci | 0af5f5d | 2018-09-07 15:00:30 +0200 | [diff] [blame] | 1570 | * @brief Compiled YANG data node |
| 1571 | */ |
| 1572 | struct lysc_node { |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1573 | uint16_t nodetype; /**< type of the node (mandatory) */ |
| 1574 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Michal Vasko | 60ea635 | 2020-06-29 13:39:39 +0200 | [diff] [blame] | 1575 | uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1576 | struct lys_module *module; /**< module structure */ |
Michal Vasko | cc048b2 | 2020-03-27 15:52:38 +0100 | [diff] [blame] | 1577 | struct lysp_node *sp; /**< simply parsed (SP) original of the node, NULL if the SP schema was removed or |
| 1578 | in case of implicit case node. */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1579 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1580 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1581 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1582 | never NULL. If there is no sibling node, pointer points to the node |
| 1583 | itself. In case of the first node, this pointer points to the last |
| 1584 | node in the list. */ |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1585 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1586 | const char *dsc; /**< description */ |
| 1587 | const char *ref; /**< reference */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1588 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1589 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1590 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1591 | void *priv; /**< private arbitrary user data, not used by libyang */ |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1592 | }; |
| 1593 | |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1594 | struct lysc_node_container { |
| 1595 | uint16_t nodetype; /**< LYS_CONTAINER */ |
| 1596 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Michal Vasko | 60ea635 | 2020-06-29 13:39:39 +0200 | [diff] [blame] | 1597 | uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1598 | struct lys_module *module; /**< module structure */ |
| 1599 | 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. */ |
| 1600 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1601 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1602 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1603 | never NULL. If there is no sibling node, pointer points to the node |
| 1604 | itself. In case of the first node, this pointer points to the last |
| 1605 | node in the list. */ |
| 1606 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1607 | const char *dsc; /**< description */ |
| 1608 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1609 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1610 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1611 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1612 | void *priv; /**< private arbitrary user data, not used by libyang */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1613 | |
| 1614 | struct lysc_node *child; /**< first child node (linked list) */ |
| 1615 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1616 | struct lysc_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 1617 | struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1618 | }; |
| 1619 | |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 1620 | struct lysc_node_case { |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1621 | uint16_t nodetype; /**< LYS_CASE */ |
| 1622 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Michal Vasko | 60ea635 | 2020-06-29 13:39:39 +0200 | [diff] [blame] | 1623 | uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1624 | struct lys_module *module; /**< module structure */ |
| 1625 | 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. */ |
| 1626 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1627 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1628 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1629 | never NULL. If there is no sibling node, pointer points to the node |
| 1630 | itself. In case of the first node, this pointer points to the last |
| 1631 | node in the list. */ |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 1632 | const char *name; /**< name of the case, including the implicit case */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1633 | const char *dsc; /**< description */ |
| 1634 | const char *ref; /**< reference */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1635 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1636 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1637 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1638 | void *priv; /**< private arbitrary user data, not used by libyang */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1639 | |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 1640 | 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 Krejci | fe13da4 | 2019-02-15 14:51:01 +0100 | [diff] [blame] | 1641 | each other as siblings with the parent pointer pointing to appropriate case node. */ |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 1642 | }; |
| 1643 | |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1644 | struct lysc_node_choice { |
| 1645 | uint16_t nodetype; /**< LYS_CHOICE */ |
| 1646 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Michal Vasko | 60ea635 | 2020-06-29 13:39:39 +0200 | [diff] [blame] | 1647 | uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser, unused */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1648 | struct lys_module *module; /**< module structure */ |
| 1649 | 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. */ |
| 1650 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1651 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1652 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1653 | never NULL. If there is no sibling node, pointer points to the node |
| 1654 | itself. In case of the first node, this pointer points to the last |
| 1655 | node in the list. */ |
| 1656 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1657 | const char *dsc; /**< description */ |
| 1658 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1659 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1660 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1661 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1662 | void *priv; /**< private arbitrary user data, not used by libyang */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1663 | |
Radek Krejci | a9026eb | 2018-12-12 16:04:47 +0100 | [diff] [blame] | 1664 | struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other |
| 1665 | as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the |
| 1666 | case is simple. */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1667 | struct lysc_node_case *dflt; /**< default case of the choice, only a pointer into the cases array. */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1668 | }; |
| 1669 | |
| 1670 | struct lysc_node_leaf { |
| 1671 | uint16_t nodetype; /**< LYS_LEAF */ |
| 1672 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Michal Vasko | 60ea635 | 2020-06-29 13:39:39 +0200 | [diff] [blame] | 1673 | uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1674 | struct lys_module *module; /**< module structure */ |
| 1675 | 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. */ |
| 1676 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1677 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1678 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1679 | never NULL. If there is no sibling node, pointer points to the node |
| 1680 | itself. In case of the first node, this pointer points to the last |
| 1681 | node in the list. */ |
| 1682 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1683 | const char *dsc; /**< description */ |
| 1684 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1685 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1686 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1687 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1688 | void *priv; /**< private arbitrary user data, not used by libyang */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1689 | |
| 1690 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1691 | struct lysc_type *type; /**< type of the leaf node (mandatory) */ |
Radek Krejci | b57cf1e | 2018-11-23 14:07:05 +0100 | [diff] [blame] | 1692 | |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1693 | const char *units; /**< units of the leaf's type */ |
Radek Krejci | a191122 | 2019-07-22 17:24:50 +0200 | [diff] [blame] | 1694 | struct lyd_value *dflt; /**< default value */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1695 | }; |
| 1696 | |
| 1697 | struct lysc_node_leaflist { |
| 1698 | uint16_t nodetype; /**< LYS_LEAFLIST */ |
| 1699 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Michal Vasko | 60ea635 | 2020-06-29 13:39:39 +0200 | [diff] [blame] | 1700 | uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1701 | struct lys_module *module; /**< module structure */ |
| 1702 | 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. */ |
| 1703 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1704 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1705 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1706 | never NULL. If there is no sibling node, pointer points to the node |
| 1707 | itself. In case of the first node, this pointer points to the last |
| 1708 | node in the list. */ |
| 1709 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1710 | const char *dsc; /**< description */ |
| 1711 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1712 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | b57cf1e | 2018-11-23 14:07:05 +0100 | [diff] [blame] | 1713 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1714 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1715 | void *priv; /**< private arbitrary user data, not used by libyang */ |
Radek Krejci | b57cf1e | 2018-11-23 14:07:05 +0100 | [diff] [blame] | 1716 | |
| 1717 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1718 | struct lysc_type *type; /**< type of the leaf node (mandatory) */ |
| 1719 | |
Radek Krejci | 0e5d838 | 2018-11-28 16:37:53 +0100 | [diff] [blame] | 1720 | const char *units; /**< units of the leaf's type */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1721 | struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */ |
Michal Vasko | ba99a3e | 2020-08-18 15:50:05 +0200 | [diff] [blame] | 1722 | |
Radek Krejci | 0e5d838 | 2018-11-28 16:37:53 +0100 | [diff] [blame] | 1723 | uint32_t min; /**< min-elements constraint */ |
| 1724 | uint32_t max; /**< max-elements constraint */ |
| 1725 | |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1726 | }; |
| 1727 | |
| 1728 | struct lysc_node_list { |
| 1729 | uint16_t nodetype; /**< LYS_LIST */ |
| 1730 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Michal Vasko | 60ea635 | 2020-06-29 13:39:39 +0200 | [diff] [blame] | 1731 | uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1732 | struct lys_module *module; /**< module structure */ |
| 1733 | 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. */ |
| 1734 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1735 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1736 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1737 | never NULL. If there is no sibling node, pointer points to the node |
| 1738 | itself. In case of the first node, this pointer points to the last |
| 1739 | node in the list. */ |
| 1740 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1741 | const char *dsc; /**< description */ |
| 1742 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1743 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 9bb94eb | 2018-12-04 16:48:35 +0100 | [diff] [blame] | 1744 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1745 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1746 | void *priv; /**< private arbitrary user data, not used by libyang */ |
Radek Krejci | 9bb94eb | 2018-12-04 16:48:35 +0100 | [diff] [blame] | 1747 | |
| 1748 | struct lysc_node *child; /**< first child node (linked list) */ |
| 1749 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1750 | struct lysc_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 1751 | struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
| 1752 | |
Radek Krejci | 9bb94eb | 2018-12-04 16:48:35 +0100 | [diff] [blame] | 1753 | struct lysc_node_leaf ***uniques; /**< list of sized arrays of pointers to the unique nodes ([sized array](@ref sizedarrays)) */ |
| 1754 | uint32_t min; /**< min-elements constraint */ |
| 1755 | uint32_t max; /**< max-elements constraint */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1756 | }; |
| 1757 | |
| 1758 | struct lysc_node_anydata { |
| 1759 | uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */ |
| 1760 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Michal Vasko | 60ea635 | 2020-06-29 13:39:39 +0200 | [diff] [blame] | 1761 | uint8_t hash[LYS_NODE_HASH_COUNT]; /**< schema hash required for LYB printer/parser */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1762 | struct lys_module *module; /**< module structure */ |
| 1763 | 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. */ |
| 1764 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1765 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1766 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1767 | never NULL. If there is no sibling node, pointer points to the node |
| 1768 | itself. In case of the first node, this pointer points to the last |
| 1769 | node in the list. */ |
| 1770 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1771 | const char *dsc; /**< description */ |
| 1772 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1773 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1774 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1775 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1776 | void *priv; /**< private arbitrary user data, not used by libyang */ |
Radek Krejci | 9800fb8 | 2018-12-13 14:26:23 +0100 | [diff] [blame] | 1777 | |
| 1778 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1779 | }; |
| 1780 | |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1781 | /** |
| 1782 | * @brief Compiled YANG schema tree structure representing YANG module. |
| 1783 | * |
| 1784 | * Semantically validated YANG schema tree for data tree parsing. |
| 1785 | * Contains only the necessary information for the data validation. |
| 1786 | */ |
| 1787 | struct lysc_module { |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1788 | struct lys_module *mod; /**< covering module structure */ |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1789 | |
Radek Krejci | 2a408df | 2018-10-29 16:32:26 +0100 | [diff] [blame] | 1790 | struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */ |
| 1791 | struct lysc_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */ |
| 1792 | struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 1793 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 0af5f5d | 2018-09-07 15:00:30 +0200 | [diff] [blame] | 1794 | }; |
| 1795 | |
| 1796 | /** |
Radek Krejci | 53ea615 | 2018-12-13 15:21:15 +0100 | [diff] [blame] | 1797 | * @brief Get the groupings sized array of the given (parsed) schema node. |
| 1798 | * Decides the node's type and in case it has a groupings array, returns it. |
| 1799 | * @param[in] node Node to examine. |
| 1800 | * @return The node's groupings sized array if any, NULL otherwise. |
| 1801 | */ |
| 1802 | const struct lysp_grp *lysp_node_groupings(const struct lysp_node *node); |
| 1803 | |
| 1804 | /** |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1805 | * @brief Get the typedefs sized array of the given (parsed) schema node. |
| 1806 | * Decides the node's type and in case it has a typedefs array, returns it. |
| 1807 | * @param[in] node Node to examine. |
| 1808 | * @return The node's typedefs sized array if any, NULL otherwise. |
| 1809 | */ |
| 1810 | const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node); |
| 1811 | |
| 1812 | /** |
| 1813 | * @brief Get the actions/RPCs sized array of the given (parsed) schema node. |
| 1814 | * Decides the node's type and in case it has a actions/RPCs array, returns it. |
| 1815 | * @param[in] node Node to examine. |
| 1816 | * @return The node's actions/RPCs sized array if any, NULL otherwise. |
| 1817 | */ |
| 1818 | const struct lysp_action *lysp_node_actions(const struct lysp_node *node); |
| 1819 | |
| 1820 | /** |
| 1821 | * @brief Get the Notifications sized array of the given (parsed) schema node. |
| 1822 | * Decides the node's type and in case it has a Notifications array, returns it. |
| 1823 | * @param[in] node Node to examine. |
| 1824 | * @return The node's Notifications sized array if any, NULL otherwise. |
| 1825 | */ |
| 1826 | const struct lysp_notif *lysp_node_notifs(const struct lysp_node *node); |
| 1827 | |
| 1828 | /** |
| 1829 | * @brief Get the children linked list of the given (parsed) schema node. |
| 1830 | * Decides the node's type and in case it has a children list, returns it. |
| 1831 | * @param[in] node Node to examine. |
| 1832 | * @return The node's children linked list if any, NULL otherwise. |
| 1833 | */ |
| 1834 | const struct lysp_node *lysp_node_children(const struct lysp_node *node); |
| 1835 | |
| 1836 | /** |
| 1837 | * @brief Get the actions/RPCs sized array of the given (compiled) schema node. |
| 1838 | * Decides the node's type and in case it has a actions/RPCs array, returns it. |
| 1839 | * @param[in] node Node to examine. |
| 1840 | * @return The node's actions/RPCs sized array if any, NULL otherwise. |
| 1841 | */ |
| 1842 | const struct lysc_action *lysc_node_actions(const struct lysc_node *node); |
| 1843 | |
| 1844 | /** |
| 1845 | * @brief Get the Notifications sized array of the given (compiled) schema node. |
| 1846 | * Decides the node's type and in case it has a Notifications array, returns it. |
| 1847 | * @param[in] node Node to examine. |
| 1848 | * @return The node's Notifications sized array if any, NULL otherwise. |
| 1849 | */ |
| 1850 | const struct lysc_notif *lysc_node_notifs(const struct lysc_node *node); |
| 1851 | |
| 1852 | /** |
| 1853 | * @brief Get the children linked list of the given (compiled) schema node. |
Michal Vasko | 208a04a | 2020-10-21 15:17:12 +0200 | [diff] [blame^] | 1854 | * Skips over input and output nodes. To return them, use ::lysc_node_children_full(). |
Michal Vasko | 2a66871 | 2020-10-21 11:48:09 +0200 | [diff] [blame] | 1855 | * |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1856 | * @param[in] node Node to examine. |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1857 | * @param[in] flags Config flag to distinguish input (LYS_CONFIG_W) and output (LYS_CONFIG_R) data in case of RPC/action node. |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1858 | * @return The node's children linked list if any, NULL otherwise. |
| 1859 | */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1860 | const struct lysc_node *lysc_node_children(const struct lysc_node *node, uint16_t flags); |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1861 | |
| 1862 | /** |
Michal Vasko | 2a66871 | 2020-10-21 11:48:09 +0200 | [diff] [blame] | 1863 | * @brief Get the children linked list of the given (compiled) schema node. |
Michal Vasko | 208a04a | 2020-10-21 15:17:12 +0200 | [diff] [blame^] | 1864 | * Returns all children node types including input and output. To skip them, use ::lysc_node_children(). |
Michal Vasko | 2a66871 | 2020-10-21 11:48:09 +0200 | [diff] [blame] | 1865 | * |
| 1866 | * @param[in] node Node to examine. |
| 1867 | * @param[in] flags Config flag to distinguish input (LYS_CONFIG_W) and output (LYS_CONFIG_R) child in case of RPC/action node. |
| 1868 | * @return Children linked list if any, |
| 1869 | * @return NULL otherwise. |
| 1870 | */ |
Michal Vasko | 208a04a | 2020-10-21 15:17:12 +0200 | [diff] [blame^] | 1871 | const struct lysc_node *lysc_node_children_full(const struct lysc_node *node, uint16_t flags); |
Michal Vasko | 2a66871 | 2020-10-21 11:48:09 +0200 | [diff] [blame] | 1872 | |
| 1873 | /** |
| 1874 | * @brief Get the parent pointer from any type of (compiled) schema node. |
Michal Vasko | 208a04a | 2020-10-21 15:17:12 +0200 | [diff] [blame^] | 1875 | * Returns input or output for direct descendants of RPC/action nodes. |
| 1876 | * To skip them, use ::lysc_node.parent pointer directly. |
Michal Vasko | 2a66871 | 2020-10-21 11:48:09 +0200 | [diff] [blame] | 1877 | * |
| 1878 | * @param[in] node Node whose parent to get. |
| 1879 | * @return Node parent. |
| 1880 | * @return NULL is there is none. |
| 1881 | */ |
Michal Vasko | 208a04a | 2020-10-21 15:17:12 +0200 | [diff] [blame^] | 1882 | const struct lysc_node *lysc_node_parent_full(const struct lysc_node *node); |
Michal Vasko | 2a66871 | 2020-10-21 11:48:09 +0200 | [diff] [blame] | 1883 | |
| 1884 | /** |
Michal Vasko | d975f86 | 2020-06-23 13:29:28 +0200 | [diff] [blame] | 1885 | * @brief Examine whether a node is user-ordered list or leaf-list. |
| 1886 | * |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 1887 | * @param[in] schema Schema node to examine. |
Michal Vasko | d975f86 | 2020-06-23 13:29:28 +0200 | [diff] [blame] | 1888 | * @return non-zero if it is, |
Radek Krejci | 857189e | 2020-09-01 13:26:36 +0200 | [diff] [blame] | 1889 | * @return Boolean value whether the @p node is user-ordered or not. |
Michal Vasko | d975f86 | 2020-06-23 13:29:28 +0200 | [diff] [blame] | 1890 | */ |
Radek Krejci | 857189e | 2020-09-01 13:26:36 +0200 | [diff] [blame] | 1891 | ly_bool lysc_is_userordered(const struct lysc_node *schema); |
Michal Vasko | d975f86 | 2020-06-23 13:29:28 +0200 | [diff] [blame] | 1892 | |
| 1893 | /** |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1894 | * @brief Set a schema private pointer to a user pointer. |
| 1895 | * |
| 1896 | * @param[in] node Node, whose private field will be assigned. Works also for RPCs, actions, and notifications. |
| 1897 | * @param[in] priv Arbitrary user-specified pointer. |
Radek Krejci | af9cd80 | 2020-10-06 21:59:47 +0200 | [diff] [blame] | 1898 | * @param[out] prev_priv_p Optional previous private object of the \p node. Note, that |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1899 | * the caller is in this case responsible (if it is necessary) for freeing the replaced private object. |
| 1900 | * @return LY_ERR value. |
| 1901 | */ |
Radek Krejci | af9cd80 | 2020-10-06 21:59:47 +0200 | [diff] [blame] | 1902 | LY_ERR lysc_set_private(const struct lysc_node *node, void *priv, void **prev_priv_p); |
Michal Vasko | 2fd91b9 | 2020-07-17 16:39:02 +0200 | [diff] [blame] | 1903 | |
| 1904 | /** |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1905 | * @brief Get how the if-feature statement currently evaluates. |
| 1906 | * |
| 1907 | * @param[in] iff Compiled if-feature statement to evaluate. |
Michal Vasko | 28d7843 | 2020-05-26 13:10:53 +0200 | [diff] [blame] | 1908 | * @return LY_SUCCESS if the statement evaluates to true, |
| 1909 | * @return LY_ENOT if it evaluates to false, |
| 1910 | * @return LY_ERR on error. |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1911 | */ |
Michal Vasko | 28d7843 | 2020-05-26 13:10:53 +0200 | [diff] [blame] | 1912 | LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff); |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1913 | |
| 1914 | /** |
| 1915 | * @brief Get the current status of the provided feature. |
| 1916 | * |
| 1917 | * @param[in] feature Compiled feature statement to examine. |
Michal Vasko | 28d7843 | 2020-05-26 13:10:53 +0200 | [diff] [blame] | 1918 | * @return LY_SUCCESS if feature is enabled, |
| 1919 | * @return LY_ENOT if feature is disabled, |
| 1920 | * @return LY_ERR in case of error (invalid argument) |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1921 | */ |
Michal Vasko | 28d7843 | 2020-05-26 13:10:53 +0200 | [diff] [blame] | 1922 | LY_ERR lysc_feature_value(const struct lysc_feature *feature); |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1923 | |
Radek Krejci | bed1394 | 2020-10-19 16:06:28 +0200 | [diff] [blame] | 1924 | /** |
| 1925 | * @defgroup findxpathoptions Atomize XPath options |
| 1926 | * Options to modify behavior of ::lys_find_xpath() and ::lys_find_xpath_atoms() searching for schema nodes in schema tree. |
| 1927 | * @{ |
| 1928 | */ |
| 1929 | #define LYS_FIND_XP_SCHEMA 0x04 /**< Apply node access restrictions defined for 'when' and 'must' evaluation. */ |
| 1930 | #define LYS_FIND_XP_OUTPUT 0x08 /**< Search RPC/action output nodes instead of input ones. */ |
| 1931 | /* |
| 1932 | * }@ |
| 1933 | */ |
Michal Vasko | 072de48 | 2020-08-05 13:27:21 +0200 | [diff] [blame] | 1934 | |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1935 | /** |
Michal Vasko | 40308e7 | 2020-10-20 16:38:40 +0200 | [diff] [blame] | 1936 | * @brief Get all the schema nodes that are required for @p xpath to be evaluated (atoms). |
Michal Vasko | 519fd60 | 2020-05-26 12:17:39 +0200 | [diff] [blame] | 1937 | * |
| 1938 | * @param[in] ctx_node XPath schema context node. |
Michal Vasko | 40308e7 | 2020-10-20 16:38:40 +0200 | [diff] [blame] | 1939 | * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected. |
Radek Krejci | bed1394 | 2020-10-19 16:06:28 +0200 | [diff] [blame] | 1940 | * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions. |
Michal Vasko | 519fd60 | 2020-05-26 12:17:39 +0200 | [diff] [blame] | 1941 | * @param[out] set Set of found atoms (schema nodes). |
| 1942 | * @return LY_SUCCESS on success, @p set is returned. |
Michal Vasko | 40308e7 | 2020-10-20 16:38:40 +0200 | [diff] [blame] | 1943 | * @return LY_ERR value on error. |
Michal Vasko | 519fd60 | 2020-05-26 12:17:39 +0200 | [diff] [blame] | 1944 | */ |
Radek Krejci | bed1394 | 2020-10-19 16:06:28 +0200 | [diff] [blame] | 1945 | LY_ERR lys_find_xpath_atoms(const struct lysc_node *ctx_node, const char *xpath, uint32_t options, struct ly_set **set); |
Michal Vasko | 519fd60 | 2020-05-26 12:17:39 +0200 | [diff] [blame] | 1946 | |
Michal Vasko | 072de48 | 2020-08-05 13:27:21 +0200 | [diff] [blame] | 1947 | /** |
Michal Vasko | 40308e7 | 2020-10-20 16:38:40 +0200 | [diff] [blame] | 1948 | * @brief Get all the schema nodes that are required for @p path to be evaluated (atoms). |
| 1949 | * |
| 1950 | * @param[in] path Compiled path to use. |
| 1951 | * @param[out] set Set of found atoms (schema nodes). |
| 1952 | * @return LY_SUCCESS on success, @p set is returned. |
| 1953 | * @return LY_ERR value on error. |
| 1954 | */ |
| 1955 | LY_ERR lys_find_path_atoms(const struct ly_path *path, struct ly_set **set); |
| 1956 | |
| 1957 | /** |
| 1958 | * @brief Get all the schema nodes that are required for @p expr to be evaluated (atoms). |
Michal Vasko | 072de48 | 2020-08-05 13:27:21 +0200 | [diff] [blame] | 1959 | * |
| 1960 | * @param[in] ctx_node XPath schema context node. |
Michal Vasko | 40308e7 | 2020-10-20 16:38:40 +0200 | [diff] [blame] | 1961 | * @param[in] cur_mod Current module for the expression (where it was "instantiated"). |
| 1962 | * @param[in] expr Parsed expression to use. |
| 1963 | * @param[in] prefixes Sized array of compiled prefixes. |
| 1964 | * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions. |
| 1965 | * @param[out] set Set of found atoms (schema nodes). |
| 1966 | * @return LY_SUCCESS on success, @p set is returned. |
| 1967 | * @return LY_ERR value on error. |
| 1968 | */ |
| 1969 | LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod, |
| 1970 | const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set); |
| 1971 | |
| 1972 | /** |
| 1973 | * @brief Evaluate an @p xpath expression on schema nodes. |
| 1974 | * |
| 1975 | * @param[in] ctx_node XPath schema context node. |
| 1976 | * @param[in] xpath Data XPath expression filtering the matching nodes. ::LY_PREF_JSON prefix format is expected. |
Radek Krejci | bed1394 | 2020-10-19 16:06:28 +0200 | [diff] [blame] | 1977 | * @param[in] options Whether to apply some node access restrictions, see @ref findxpathoptions. |
Michal Vasko | 072de48 | 2020-08-05 13:27:21 +0200 | [diff] [blame] | 1978 | * @param[out] set Set of found schema nodes. |
| 1979 | * @return LY_SUCCESS on success, @p set is returned. |
| 1980 | * @return LY_ERR value if an error occurred. |
| 1981 | */ |
Radek Krejci | 1deb5be | 2020-08-26 16:43:36 +0200 | [diff] [blame] | 1982 | LY_ERR lys_find_xpath(const struct lysc_node *ctx_node, const char *xpath, uint32_t options, struct ly_set **set); |
Michal Vasko | 519fd60 | 2020-05-26 12:17:39 +0200 | [diff] [blame] | 1983 | |
| 1984 | /** |
Michal Vasko | 03ff5a7 | 2019-09-11 13:49:33 +0200 | [diff] [blame] | 1985 | * @brief Types of the different schema paths. |
| 1986 | */ |
| 1987 | typedef enum { |
Michal Vasko | 65de040 | 2020-08-03 16:34:19 +0200 | [diff] [blame] | 1988 | LYSC_PATH_LOG, /**< Descriptive path format used in log messages */ |
| 1989 | LYSC_PATH_DATA /**< Similar to ::LYSC_PATH_LOG except that schema-only nodes (choice, case) are skipped */ |
Michal Vasko | 03ff5a7 | 2019-09-11 13:49:33 +0200 | [diff] [blame] | 1990 | } LYSC_PATH_TYPE; |
| 1991 | |
| 1992 | /** |
Radek Krejci | 327de16 | 2019-06-14 12:52:07 +0200 | [diff] [blame] | 1993 | * @brief Generate path of the given node in the requested format. |
| 1994 | * |
| 1995 | * @param[in] node Schema path of this node will be generated. |
| 1996 | * @param[in] pathtype Format of the path to generate. |
Radek Krejci | 1c0c344 | 2019-07-23 16:08:47 +0200 | [diff] [blame] | 1997 | * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path. |
| 1998 | * If NULL, memory for the complete path is allocated. |
| 1999 | * @param[in] buflen Size of the provided @p buffer. |
Radek Krejci | 327de16 | 2019-06-14 12:52:07 +0200 | [diff] [blame] | 2000 | * @return NULL in case of memory allocation error, path of the node otherwise. |
Radek Krejci | 1c0c344 | 2019-07-23 16:08:47 +0200 | [diff] [blame] | 2001 | * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it. |
Radek Krejci | 327de16 | 2019-06-14 12:52:07 +0200 | [diff] [blame] | 2002 | */ |
Michal Vasko | 03ff5a7 | 2019-09-11 13:49:33 +0200 | [diff] [blame] | 2003 | char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen); |
Radek Krejci | 327de16 | 2019-06-14 12:52:07 +0200 | [diff] [blame] | 2004 | |
| 2005 | /** |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 2006 | * @brief Available YANG schema tree structures representing YANG module. |
| 2007 | */ |
| 2008 | struct lys_module { |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 2009 | struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */ |
| 2010 | const char *name; /**< name of the module (mandatory) */ |
Radek Krejci | 0af4629 | 2019-01-11 16:02:31 +0100 | [diff] [blame] | 2011 | const char *revision; /**< revision of the module (if present) */ |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 2012 | const char *ns; /**< namespace of the module (module - mandatory) */ |
| 2013 | const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */ |
| 2014 | const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */ |
| 2015 | const char *org; /**< party/company responsible for the module */ |
| 2016 | const char *contact; /**< contact information for the module */ |
| 2017 | const char *dsc; /**< description of the module */ |
| 2018 | const char *ref; /**< cross-reference for the module */ |
| 2019 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 2020 | struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */ |
Radek Krejci | 0af4629 | 2019-01-11 16:02:31 +0100 | [diff] [blame] | 2021 | struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing. |
| 2022 | Available only for implemented modules. */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 2023 | |
Radek Krejci | 14915cc | 2020-09-14 17:28:13 +0200 | [diff] [blame] | 2024 | struct lysc_feature *features; /**< List of compiled features of the module ([sized array](@ref sizedarrays)). |
| 2025 | Features are outside the compiled tree since they are needed even the module is not |
| 2026 | compiled. In such a case, the features are always disabled and cannot be enabled until |
| 2027 | the module is implemented. The features are present in this form to allow their linkage |
Radek Krejci | 0af4629 | 2019-01-11 16:02:31 +0100 | [diff] [blame] | 2028 | from if-feature statements of the compiled schemas and their proper use in case |
| 2029 | the module became implemented in future (no matter if implicitly via augment/deviate |
Radek Krejci | 14915cc | 2020-09-14 17:28:13 +0200 | [diff] [blame] | 2030 | or explicitly via ::lys_set_implemented()). */ |
Radek Krejci | 80d281e | 2020-09-14 17:42:54 +0200 | [diff] [blame] | 2031 | struct lysc_ident *identities; /**< List of compiled identities of the module ([sized array](@ref sizedarrays)) |
| 2032 | Identities are outside the compiled tree to allow their linkage to the identities from |
| 2033 | the implemented modules. This avoids problems when the module became implemented in |
| 2034 | future (no matter if implicitly via augment/deviate or explicitly via |
| 2035 | ::lys_set_implemented()). Note that if the module is not implemented (compiled), the |
| 2036 | identities cannot be instantiated in data (in identityrefs). */ |
Michal Vasko | 7f45cf2 | 2020-10-01 12:49:44 +0200 | [diff] [blame] | 2037 | |
| 2038 | struct lys_module **augmented_by;/**< List of modules that augment this module ([sized array](@ref sizedarrays)) */ |
| 2039 | struct lys_module **deviated_by; /**< List of modules that deviate this module ([sized array](@ref sizedarrays)) */ |
| 2040 | |
Michal Vasko | 89b5c07 | 2020-10-06 13:52:44 +0200 | [diff] [blame] | 2041 | ly_bool implemented; /**< flag if the module is implemented, not just imported */ |
Radek Krejci | 95710c9 | 2019-02-11 15:49:55 +0100 | [diff] [blame] | 2042 | uint8_t latest_revision; /**< flag to mark the latest available revision: |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 2043 | 1 - the latest revision in searchdirs was not searched yet and this is the |
| 2044 | latest revision in the current context |
| 2045 | 2 - searchdirs were searched and this is the latest available revision */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 2046 | }; |
| 2047 | |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 2048 | /** |
| 2049 | * @brief Enable specified feature in the module |
| 2050 | * |
| 2051 | * By default, when the module is loaded by libyang parser, all features are disabled. |
| 2052 | * |
Radek Krejci | ca3db00 | 2018-11-01 10:31:01 +0100 | [diff] [blame] | 2053 | * If all features are being enabled, it must be possible respecting their if-feature conditions. For example, |
| 2054 | * enabling all features on the following feature set will fail since it is not possible to enable both features |
| 2055 | * (and it is unclear which of them should be enabled then). In this case the LY_EDENIED is returned and the feature |
| 2056 | * is untouched. |
| 2057 | * |
| 2058 | * feature f1; |
| 2059 | * feature f2 { if-feature 'not f1';} |
| 2060 | * |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 2061 | * @param[in] module Module where the feature will be enabled. |
| 2062 | * @param[in] feature Name of the feature to enable. To enable all features at once, use asterisk (`*`) character. |
Michal Vasko | 82c31e6 | 2020-07-17 15:30:40 +0200 | [diff] [blame] | 2063 | * @return LY_SUCCESS on success, |
| 2064 | * @return LY_EINVAL if @p module is not implemented, |
| 2065 | * @return LY_ENOTFOUND if @p feature was not found, |
| 2066 | * @return LY_EDENIED if @p feature could not be enabled because it has some false if-feature statements. |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 2067 | */ |
Radek Krejci | ed5acc5 | 2019-04-25 15:57:04 +0200 | [diff] [blame] | 2068 | LY_ERR lys_feature_enable(const struct lys_module *module, const char *feature); |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 2069 | |
| 2070 | /** |
| 2071 | * @brief Disable specified feature in the module |
| 2072 | * |
| 2073 | * By default, when the module is loaded by libyang parser, all features are disabled. |
| 2074 | * |
Michal Vasko | 82c31e6 | 2020-07-17 15:30:40 +0200 | [diff] [blame] | 2075 | * If disabling a feature causes some other features that depend on this feature to become disabled. |
| 2076 | * |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 2077 | * @param[in] module Module where the feature will be disabled. |
| 2078 | * @param[in] feature Name of the feature to disable. To disable all features at once, use asterisk (`*`) character. |
Michal Vasko | 82c31e6 | 2020-07-17 15:30:40 +0200 | [diff] [blame] | 2079 | * @return LY_SUCCESS on success, |
| 2080 | * @return LY_EINVAL if @p module is not implemented, |
| 2081 | * @return LY_ENOTFOUND if @p feature was not found. |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 2082 | */ |
Radek Krejci | ed5acc5 | 2019-04-25 15:57:04 +0200 | [diff] [blame] | 2083 | LY_ERR lys_feature_disable(const struct lys_module *module, const char *feature); |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 2084 | |
| 2085 | /** |
Michal Vasko | 82c31e6 | 2020-07-17 15:30:40 +0200 | [diff] [blame] | 2086 | * @brief Enable specified feature in the module disregarding its if-features. |
| 2087 | * |
| 2088 | * @param[in] module Module where the feature will be enabled. |
| 2089 | * @param[in] feature Name of the feature to enable. To enable all features at once, use asterisk character. |
| 2090 | * @return LY_SUCCESS on success, |
| 2091 | * @return LY_EINVAL if @p module is not implemented, |
| 2092 | * @return LY_ENOTFOUND if @p feature was not found. |
| 2093 | */ |
| 2094 | LY_ERR lys_feature_enable_force(const struct lys_module *module, const char *feature); |
| 2095 | |
| 2096 | /** |
| 2097 | * @brief Disable specified feature in the module disregarding dependant features. |
| 2098 | * |
| 2099 | * By default, when the module is loaded by libyang parser, all features are disabled. |
| 2100 | * |
| 2101 | * @param[in] module Module where the feature will be disabled. |
| 2102 | * @param[in] feature Name of the feature to disable. To disable all features at once, use asterisk character. |
| 2103 | * @return LY_SUCCESS on success, |
| 2104 | * @return LY_EINVAL if @p module is not implemented, |
| 2105 | * @return LY_ENOTFOUND if @p feature was not found. |
| 2106 | */ |
| 2107 | LY_ERR lys_feature_disable_force(const struct lys_module *module, const char *feature); |
| 2108 | |
| 2109 | /** |
| 2110 | * @brief Get the current real status of the specified feature in the module. |
| 2111 | * |
| 2112 | * If the feature is enabled, but some of its if-features are false, the feature is considered |
| 2113 | * disabled. |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 2114 | * |
| 2115 | * @param[in] module Module where the feature is defined. |
| 2116 | * @param[in] feature Name of the feature to inspect. |
Michal Vasko | 82c31e6 | 2020-07-17 15:30:40 +0200 | [diff] [blame] | 2117 | * @return LY_SUCCESS if the feature is enabled, |
| 2118 | * @return LY_ENOT if the feature is disabled, |
| 2119 | * @return LY_ENOTFOUND if the feature was not found. |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 2120 | */ |
Michal Vasko | 82c31e6 | 2020-07-17 15:30:40 +0200 | [diff] [blame] | 2121 | LY_ERR lys_feature_value(const struct lys_module *module, const char *feature); |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 2122 | |
| 2123 | /** |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 2124 | * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can |
| 2125 | * be from an augment. |
| 2126 | * |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 2127 | * ::lys_getnext() is supposed to be called sequentially. In the first call, the \p last parameter is usually NULL |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 2128 | * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module. |
| 2129 | * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same |
| 2130 | * \p parent and \p module parameters. |
| 2131 | * |
| 2132 | * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding |
| 2133 | * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that |
| 2134 | * all the schema nodes are iteratively returned. |
| 2135 | * |
| 2136 | * @param[in] last Previously returned schema tree node, or NULL in case of the first call. |
| 2137 | * @param[in] parent Parent of the subtree where the function starts processing. |
| 2138 | * @param[in] module In case of iterating on top level elements, the \p parent is NULL and |
| 2139 | * module must be specified. |
| 2140 | * @param[in] options [ORed options](@ref sgetnextflags). |
| 2141 | * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element. |
| 2142 | */ |
| 2143 | const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent, |
Radek Krejci | 1deb5be | 2020-08-26 16:43:36 +0200 | [diff] [blame] | 2144 | const struct lysc_module *module, uint32_t options); |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 2145 | |
| 2146 | /** |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 2147 | * @defgroup sgetnextflags Options for ::lys_getnext(). |
| 2148 | * |
| 2149 | * Various options setting behavior of ::lys_getnext(). |
| 2150 | * |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 2151 | * @{ |
| 2152 | */ |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 2153 | #define LYS_GETNEXT_WITHCHOICE 0x01 /**< ::lys_getnext() option to allow returning #LYS_CHOICE nodes instead of looking into them */ |
| 2154 | #define LYS_GETNEXT_NOCHOICE 0x02 /**< ::lys_getnext() option to ignore (kind of conditional) nodes within choice node */ |
| 2155 | #define LYS_GETNEXT_WITHCASE 0x04 /**< ::lys_getnext() option to allow returning #LYS_CASE nodes instead of looking into them */ |
| 2156 | #define LYS_GETNEXT_INTONPCONT 0x40 /**< ::lys_getnext() option to look into non-presence container, instead of returning container itself */ |
| 2157 | #define LYS_GETNEXT_NOSTATECHECK 0x100 /**< ::lys_getnext() option to skip checking module validity (import-only, disabled) and |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 2158 | relevant if-feature conditions state */ |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 2159 | #define LYS_GETNEXT_OUTPUT 0x200 /**< ::lys_getnext() option to provide RPC's/action's output schema nodes instead of input schema nodes |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 2160 | provided by default */ |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 2161 | /** @} sgetnextflags */ |
| 2162 | |
| 2163 | /** |
| 2164 | * @brief Get child node according to the specified criteria. |
| 2165 | * |
| 2166 | * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched. |
| 2167 | * @param[in] module module of the node to find. It is also limitation for the children node of the given parent. |
| 2168 | * @param[in] name Name of the node to find. |
| 2169 | * @param[in] name_len Optional length of the name in case it is not NULL-terminated string. |
| 2170 | * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find. |
| 2171 | * Used as a bitmask, so multiple nodetypes can be specified. |
| 2172 | * @param[in] options [ORed options](@ref sgetnextflags). |
| 2173 | * @return Found node if any. |
| 2174 | */ |
Michal Vasko | e444f75 | 2020-02-10 12:20:06 +0100 | [diff] [blame] | 2175 | const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module, |
Radek Krejci | 1deb5be | 2020-08-26 16:43:36 +0200 | [diff] [blame] | 2176 | const char *name, size_t name_len, uint16_t nodetype, uint32_t options); |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 2177 | |
| 2178 | /** |
Radek Krejci | 77a8bcd | 2019-09-11 11:20:02 +0200 | [diff] [blame] | 2179 | * @brief Make the specific module implemented. |
| 2180 | * |
| 2181 | * @param[in] mod Module to make implemented. It is not an error |
| 2182 | * to provide already implemented module, it just does nothing. |
Michal Vasko | e444f75 | 2020-02-10 12:20:06 +0100 | [diff] [blame] | 2183 | * @return LY_SUCCESS on success. |
| 2184 | * @return LY_EDENIED in case the context contains some other revision of the same module which is already implemented. |
Radek Krejci | 77a8bcd | 2019-09-11 11:20:02 +0200 | [diff] [blame] | 2185 | */ |
| 2186 | LY_ERR lys_set_implemented(struct lys_module *mod); |
| 2187 | |
| 2188 | /** |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 2189 | * @brief Check if the schema node is disabled in the schema tree, i.e. there is any disabled if-feature statement |
| 2190 | * affecting the node. |
| 2191 | * |
| 2192 | * @param[in] node Schema node to check. |
| 2193 | * @param[in] recursive - 0 to check if-feature only in the \p node schema node, |
| 2194 | * - 1 to check if-feature in all ascendant schema nodes until there is a node possibly having an instance in a data tree |
Michal Vasko | e444f75 | 2020-02-10 12:20:06 +0100 | [diff] [blame] | 2195 | * @return NULL if enabled, |
Michal Vasko | c193ce9 | 2020-03-06 11:04:48 +0100 | [diff] [blame] | 2196 | * @return pointer to the node with the unsatisfied (disabled) if-feature expression. |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 2197 | */ |
Radek Krejci | 857189e | 2020-09-01 13:26:36 +0200 | [diff] [blame] | 2198 | const struct lysc_node *lysc_node_is_disabled(const struct lysc_node *node, ly_bool recursive); |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 2199 | |
Radek Krejci | 084289f | 2019-07-09 17:35:30 +0200 | [diff] [blame] | 2200 | /** |
| 2201 | * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value. |
| 2202 | * |
| 2203 | * This function check just the type's restriction, if you want to check also the data tree context (e.g. in case of |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 2204 | * require-instance restriction), use ::lyd_value_validate(). |
Radek Krejci | 084289f | 2019-07-09 17:35:30 +0200 | [diff] [blame] | 2205 | * |
| 2206 | * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL) |
| 2207 | * @param[in] node Schema node for the @p value. |
Michal Vasko | f937cfe | 2020-08-03 16:07:12 +0200 | [diff] [blame] | 2208 | * @param[in] value String value to be checked, expected to be in JSON format. |
Radek Krejci | 084289f | 2019-07-09 17:35:30 +0200 | [diff] [blame] | 2209 | * @param[in] value_len Length of the given @p value (mandatory). |
Radek Krejci | 084289f | 2019-07-09 17:35:30 +0200 | [diff] [blame] | 2210 | * @return LY_SUCCESS on success |
| 2211 | * @return LY_ERR value if an error occurred. |
| 2212 | */ |
Michal Vasko | f937cfe | 2020-08-03 16:07:12 +0200 | [diff] [blame] | 2213 | LY_ERR lys_value_validate(const struct ly_ctx *ctx, const struct lysc_node *node, const char *value, size_t value_len); |
Radek Krejci | 084289f | 2019-07-09 17:35:30 +0200 | [diff] [blame] | 2214 | |
Radek Krejci | 0935f41 | 2019-08-20 16:15:18 +0200 | [diff] [blame] | 2215 | /** |
| 2216 | * @brief Stringify schema nodetype. |
Michal Vasko | d43d71a | 2020-08-07 14:54:58 +0200 | [diff] [blame] | 2217 | * |
Radek Krejci | 0935f41 | 2019-08-20 16:15:18 +0200 | [diff] [blame] | 2218 | * @param[in] nodetype Nodetype to stringify. |
| 2219 | * @return Constant string with the name of the node's type. |
| 2220 | */ |
| 2221 | const char *lys_nodetype2str(uint16_t nodetype); |
| 2222 | |
Michal Vasko | d43d71a | 2020-08-07 14:54:58 +0200 | [diff] [blame] | 2223 | /** |
| 2224 | * @brief Getter for original XPath expression from a parsed expression. |
| 2225 | * |
| 2226 | * @param[in] path Parsed expression. |
| 2227 | * @return Original string expression. |
| 2228 | */ |
| 2229 | const char *lyxp_get_expr(const struct lyxp_expr *path); |
| 2230 | |
Radek Krejci | 2ff0d57 | 2020-05-21 15:27:28 +0200 | [diff] [blame] | 2231 | /** @} schematree */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 2232 | |
Radek Krejci | 70853c5 | 2018-10-15 14:46:16 +0200 | [diff] [blame] | 2233 | #ifdef __cplusplus |
| 2234 | } |
| 2235 | #endif |
| 2236 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 2237 | #endif /* LY_TREE_SCHEMA_H_ */ |