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 | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 21 | #include <stdint.h> |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 22 | #include <stdio.h> |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 23 | |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 24 | #include "log.h" |
| 25 | #include "tree.h" |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 26 | #include "extensions.h" |
Radek Krejci | 084289f | 2019-07-09 17:35:30 +0200 | [diff] [blame] | 27 | #include "tree_data.h" |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 28 | |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 29 | struct ly_ctx; |
| 30 | |
Radek Krejci | 70853c5 | 2018-10-15 14:46:16 +0200 | [diff] [blame] | 31 | #ifdef __cplusplus |
| 32 | extern "C" { |
| 33 | #endif |
| 34 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 35 | /** |
Radek Krejci | 0af5f5d | 2018-09-07 15:00:30 +0200 | [diff] [blame] | 36 | * @brief Schema input formats accepted by libyang [parser functions](@ref howtoschemasparsers). |
| 37 | */ |
| 38 | typedef enum { |
| 39 | LYS_IN_UNKNOWN = 0, /**< unknown format, used as return value in case of error */ |
| 40 | LYS_IN_YANG = 1, /**< YANG schema input format */ |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 41 | LYS_IN_YIN = 3 /**< YIN schema input format */ |
Radek Krejci | 0af5f5d | 2018-09-07 15:00:30 +0200 | [diff] [blame] | 42 | } LYS_INFORMAT; |
| 43 | |
| 44 | /** |
| 45 | * @brief Schema output formats accepted by libyang [printer functions](@ref howtoschemasprinters). |
| 46 | */ |
| 47 | typedef enum { |
| 48 | LYS_OUT_UNKNOWN = 0, /**< unknown format, used as return value in case of error */ |
| 49 | LYS_OUT_YANG = 1, /**< YANG schema output format */ |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 50 | LYS_OUT_YIN = 3, /**< YIN schema output format */ |
| 51 | LYS_OUT_YANG_COMPILED = 2, /**< YANG schema output format of the compiled schema tree */ |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 52 | |
Radek Krejci | 0af5f5d | 2018-09-07 15:00:30 +0200 | [diff] [blame] | 53 | LYS_OUT_TREE, /**< Tree schema output format, for more information see the [printers](@ref howtoschemasprinters) page */ |
| 54 | LYS_OUT_INFO, /**< Info schema output format, for more information see the [printers](@ref howtoschemasprinters) page */ |
| 55 | LYS_OUT_JSON, /**< JSON schema output format, reflecting YIN format with conversion of attributes to object's members */ |
| 56 | } LYS_OUTFORMAT; |
| 57 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 58 | #define LY_REV_SIZE 11 /**< revision data string length (including terminating NULL byte) */ |
| 59 | |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 60 | #define LYS_UNKNOWN 0x0000 /**< uninitalized unknown statement node */ |
| 61 | #define LYS_CONTAINER 0x0001 /**< container statement node */ |
| 62 | #define LYS_CHOICE 0x0002 /**< choice statement node */ |
| 63 | #define LYS_LEAF 0x0004 /**< leaf statement node */ |
| 64 | #define LYS_LEAFLIST 0x0008 /**< leaf-list statement node */ |
| 65 | #define LYS_LIST 0x0010 /**< list statement node */ |
| 66 | #define LYS_ANYXML 0x0020 /**< anyxml statement node */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 67 | #define LYS_ANYDATA 0x0120 /**< anydata statement node, in tests it can be used for both #LYS_ANYXML and #LYS_ANYDATA */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 68 | |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 69 | #define LYS_ACTION 0x400 /**< RPC or action */ |
| 70 | #define LYS_NOTIF 0x800 |
| 71 | |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 72 | #define LYS_CASE 0x0040 /**< case statement node */ |
| 73 | #define LYS_USES 0x0080 /**< uses statement node */ |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 74 | #define LYS_INPUT 0x100 |
| 75 | #define LYS_OUTPUT 0x200 |
| 76 | #define LYS_INOUT 0x300 |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 77 | #define LYS_GROUPING 0x1000 |
| 78 | #define LYS_AUGMENT 0x2000 |
| 79 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 80 | /** |
| 81 | * @brief YANG import-stmt |
| 82 | */ |
| 83 | struct lysp_import { |
Radek Krejci | 086c713 | 2018-10-26 15:29:04 +0200 | [diff] [blame] | 84 | struct lys_module *module; /**< pointer to the imported module |
| 85 | (mandatory, but resolved when the referring module is completely parsed) */ |
| 86 | const char *name; /**< name of the imported module (mandatory) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 87 | const char *prefix; /**< prefix for the data from the imported schema (mandatory) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 88 | const char *dsc; /**< description */ |
| 89 | const char *ref; /**< reference */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 90 | 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] | 91 | char rev[LY_REV_SIZE]; /**< revision-date of the imported module */ |
| 92 | }; |
| 93 | |
| 94 | /** |
| 95 | * @brief YANG include-stmt |
| 96 | */ |
| 97 | struct lysp_include { |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 98 | struct lysp_submodule *submodule;/**< pointer to the parsed submodule structure |
Radek Krejci | 086c713 | 2018-10-26 15:29:04 +0200 | [diff] [blame] | 99 | (mandatory, but resolved when the referring module is completely parsed) */ |
| 100 | const char *name; /**< name of the included submodule (mandatory) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 101 | const char *dsc; /**< description */ |
| 102 | const char *ref; /**< reference */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 103 | 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] | 104 | char rev[LY_REV_SIZE]; /**< revision-date of the included submodule */ |
| 105 | }; |
| 106 | |
| 107 | /** |
| 108 | * @brief YANG extension-stmt |
| 109 | */ |
| 110 | struct lysp_ext { |
| 111 | const char *name; /**< extension name */ |
| 112 | const char *argument; /**< argument name, NULL if not specified */ |
| 113 | const char *dsc; /**< description statement */ |
| 114 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 115 | 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] | 116 | uint16_t flags; /**< LYS_STATUS_* and LYS_YINELEM values (@ref snodeflags) */ |
| 117 | }; |
| 118 | |
| 119 | /** |
| 120 | * @brief Helper structure for generic storage of the extension instances content. |
| 121 | */ |
| 122 | struct lysp_stmt { |
| 123 | const char *stmt; /**< identifier of the statement */ |
| 124 | const char *arg; /**< statement's argument */ |
| 125 | struct lysp_stmt *next; /**< link to the next statement */ |
Michal Vasko | bc2559f | 2018-09-07 10:17:50 +0200 | [diff] [blame] | 126 | struct lysp_stmt *child; /**< list of the statement's substatements (linked list) */ |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 127 | uint16_t flags; |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 128 | }; |
| 129 | |
| 130 | /** |
| 131 | * @brief YANG extension instance |
| 132 | */ |
| 133 | struct lysp_ext_instance { |
| 134 | const char *name; /**< extension identifier, including possible prefix */ |
| 135 | const char *argument; /**< optional value of the extension's argument */ |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 136 | struct lysp_stmt *child; /**< list of the extension's substatements (linked list) */ |
Michal Vasko | d92e42a | 2018-09-07 08:35:02 +0200 | [diff] [blame] | 137 | LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */ |
| 138 | uint32_t insubstmt_index; /**< in case the instance is in a substatement, this identifies |
| 139 | the index of that substatement */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 140 | }; |
| 141 | |
| 142 | /** |
| 143 | * @brief YANG feature-stmt |
| 144 | */ |
| 145 | struct lysp_feature { |
| 146 | const char *name; /**< feature name (mandatory) */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 147 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 148 | const char *dsc; /**< description statement */ |
| 149 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 150 | 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] | 151 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* values allowed */ |
| 152 | }; |
| 153 | |
| 154 | /** |
| 155 | * @brief YANG identity-stmt |
| 156 | */ |
| 157 | struct lysp_ident { |
| 158 | const char *name; /**< identity name (mandatory), including possible prefix */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 159 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
| 160 | const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 161 | const char *dsc; /**< description statement */ |
| 162 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 163 | 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] | 164 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */ |
| 165 | }; |
| 166 | |
Michal Vasko | 71e64ca | 2018-09-07 16:30:29 +0200 | [diff] [blame] | 167 | /** |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 168 | * @brief Covers restrictions: range, length, pattern, must |
| 169 | */ |
| 170 | struct lysp_restr { |
| 171 | const char *arg; /**< The restriction expression/value (mandatory); |
| 172 | in case of pattern restriction, the first byte has a special meaning: |
| 173 | 0x06 (ACK) for regular match and 0x15 (NACK) for invert-match */ |
| 174 | const char *emsg; /**< error-message */ |
| 175 | const char *eapptag; /**< error-app-tag value */ |
| 176 | const char *dsc; /**< description */ |
| 177 | const char *ref; /**< reference */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 178 | 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] | 179 | }; |
| 180 | |
| 181 | /** |
Michal Vasko | 71e64ca | 2018-09-07 16:30:29 +0200 | [diff] [blame] | 182 | * @brief YANG revision-stmt |
| 183 | */ |
| 184 | struct lysp_revision { |
Radek Krejci | b7db73a | 2018-10-24 14:18:40 +0200 | [diff] [blame] | 185 | char date[LY_REV_SIZE]; /**< revision date (madatory) */ |
Michal Vasko | 71e64ca | 2018-09-07 16:30:29 +0200 | [diff] [blame] | 186 | const char *dsc; /**< description statement */ |
| 187 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 188 | 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] | 189 | }; |
| 190 | |
| 191 | /** |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 192 | * @brief Enumeration/Bit value definition |
| 193 | */ |
| 194 | struct lysp_type_enum { |
| 195 | const char *name; /**< name (mandatory) */ |
| 196 | const char *dsc; /**< description statement */ |
| 197 | const char *ref; /**< reference statement */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 198 | int64_t value; /**< enum's value or bit's position */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 199 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 200 | 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] | 201 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE |
| 202 | values are allowed */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 203 | }; |
| 204 | |
| 205 | /** |
| 206 | * @brief YANG type-stmt |
| 207 | * |
| 208 | * Some of the items in the structure may be mandatory, but it is necessary to resolve the type's base type first |
| 209 | */ |
| 210 | struct lysp_type { |
| 211 | const char *name; /**< name of the type (mandatory) */ |
| 212 | struct lysp_restr *range; /**< allowed values range - numerical, decimal64 */ |
| 213 | struct lysp_restr *length; /**< allowed length of the value - string, binary */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 214 | struct lysp_restr *patterns; /**< list of patterns ([sized array](@ref sizedarrays)) - string */ |
| 215 | struct lysp_type_enum *enums; /**< list of enum-stmts ([sized array](@ref sizedarrays)) - enum */ |
| 216 | struct lysp_type_enum *bits; /**< list of bit-stmts ([sized array](@ref sizedarrays)) - bits */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 217 | const char *path; /**< path - leafref */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 218 | const char **bases; /**< list of base identifiers ([sized array](@ref sizedarrays)) - identityref */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 219 | struct lysp_type *types; /**< list of sub-types ([sized array](@ref sizedarrays)) - union */ |
| 220 | 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] | 221 | |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 222 | struct lysc_type *compiled; /**< pointer to the compiled type */ |
| 223 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 224 | uint8_t fraction_digits; /**< number of fraction digits - decimal64 */ |
| 225 | uint8_t require_instance; /**< require-instance flag - leafref, instance */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 226 | uint16_t flags; /**< [schema node flags](@ref spnodeflags) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 227 | }; |
| 228 | |
| 229 | /** |
| 230 | * @brief YANG typedef-stmt |
| 231 | */ |
| 232 | struct lysp_tpdf { |
| 233 | const char *name; /**< name of the newly defined type (mandatory) */ |
| 234 | const char *units; /**< units of the newly defined type */ |
| 235 | const char *dflt; /**< default value of the newly defined type */ |
| 236 | const char *dsc; /**< description statement */ |
| 237 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 238 | 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] | 239 | 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] | 240 | uint16_t flags; /**< [schema node flags](@ref spnodeflags) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 241 | }; |
| 242 | |
| 243 | /** |
| 244 | * @brief YANG grouping-stmt |
| 245 | */ |
| 246 | struct lysp_grp { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 247 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level grouping) */ |
| 248 | uint16_t nodetype; /**< LYS_GROUPING */ |
| 249 | 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] | 250 | const char *name; /**< grouping name (mandatory) */ |
| 251 | const char *dsc; /**< description statement */ |
| 252 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 253 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 254 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 255 | struct lysp_node *data; /**< list of data nodes (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 256 | struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 257 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
| 258 | 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] | 259 | }; |
| 260 | |
| 261 | /** |
| 262 | * @brief YANG when-stmt |
| 263 | */ |
| 264 | struct lysp_when { |
| 265 | const char *cond; /**< specified condition (mandatory) */ |
| 266 | const char *dsc; /**< description statement */ |
| 267 | const char *ref; /**< reference statement */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 268 | 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] | 269 | }; |
| 270 | |
| 271 | /** |
| 272 | * @brief YANG refine-stmt |
| 273 | */ |
| 274 | struct lysp_refine { |
| 275 | const char *nodeid; /**< target descendant schema nodeid (mandatory) */ |
| 276 | const char *dsc; /**< description statement */ |
| 277 | const char *ref; /**< reference statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 278 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 279 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 280 | const char *presence; /**< presence description */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 281 | const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 282 | uint32_t min; /**< min-elements constraint */ |
| 283 | uint32_t max; /**< max-elements constraint, 0 means unbounded */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 284 | 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] | 285 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 286 | }; |
| 287 | |
| 288 | /** |
| 289 | * @brief YANG uses-augment-stmt and augment-stmt |
| 290 | */ |
| 291 | struct lysp_augment { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 292 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level augment) */ |
| 293 | uint16_t nodetype; /**< LYS_AUGMENT */ |
| 294 | 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] | 295 | const char *nodeid; /**< target schema nodeid (mandatory) - absolute for global augments, descendant for uses's augments */ |
| 296 | const char *dsc; /**< description statement */ |
| 297 | const char *ref; /**< reference statement */ |
| 298 | struct lysp_when *when; /**< when statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 299 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 300 | struct lysp_node *child; /**< list of data nodes (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 301 | struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 302 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
| 303 | 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] | 304 | }; |
| 305 | |
| 306 | /** |
| 307 | * @defgroup deviatetypes Deviate types |
| 308 | * @{ |
| 309 | */ |
| 310 | #define LYS_DEV_NOT_SUPPORTED 1 /**< deviate type not-supported */ |
| 311 | #define LYS_DEV_ADD 2 /**< deviate type add */ |
| 312 | #define LYS_DEV_DELETE 3 /**< deviate type delete */ |
| 313 | #define LYS_DEV_REPLACE 4 /**< deviate type replace */ |
| 314 | /** @} */ |
| 315 | |
| 316 | /** |
| 317 | * @brief Generic deviate structure to get type and cast to lysp_deviate_* structure |
| 318 | */ |
| 319 | struct lysp_deviate { |
| 320 | uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */ |
| 321 | struct lysp_deviate *next; /**< next deviate structure in the list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 322 | 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] | 323 | }; |
| 324 | |
| 325 | struct lysp_deviate_add { |
| 326 | uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */ |
| 327 | struct lysp_deviate *next; /**< next deviate structure in the list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 328 | 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] | 329 | const char *units; /**< units of the values */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 330 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 331 | const char **uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */ |
| 332 | const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 333 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 334 | uint32_t min; /**< min-elements constraint */ |
| 335 | uint32_t max; /**< max-elements constraint, 0 means unbounded */ |
| 336 | }; |
| 337 | |
| 338 | struct lysp_deviate_del { |
| 339 | uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */ |
| 340 | struct lysp_deviate *next; /**< next deviate structure in the list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 341 | 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] | 342 | const char *units; /**< units of the values */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 343 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 344 | const char **uniques; /**< list of uniques specifications ([sized array](@ref sizedarrays)) */ |
| 345 | const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 346 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 347 | }; |
| 348 | |
| 349 | struct lysp_deviate_rpl { |
| 350 | uint8_t mod; /**< [type](@ref deviatetypes) of the deviate modification */ |
| 351 | struct lysp_deviate *next; /**< next deviate structure in the list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 352 | 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] | 353 | struct lysp_type *type; /**< type of the node */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 354 | const char *units; /**< units of the values */ |
| 355 | const char *dflt; /**< default value */ |
| 356 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 357 | uint32_t min; /**< min-elements constraint */ |
| 358 | uint32_t max; /**< max-elements constraint, 0 means unbounded */ |
| 359 | }; |
| 360 | |
| 361 | struct lysp_deviation { |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 362 | const char *nodeid; /**< target absolute schema nodeid (mandatory) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 363 | const char *dsc; /**< description statement */ |
| 364 | const char *ref; /**< reference statement */ |
| 365 | struct lysp_deviate* deviates; /**< list of deviate specifications (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 366 | 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] | 367 | }; |
| 368 | |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 369 | /** |
| 370 | * @defgroup spnodeflags Parsed schema nodes flags |
| 371 | * @ingroup snodeflags |
| 372 | * |
| 373 | * Various flags for parsed schema nodes. |
| 374 | * |
| 375 | * 1 - container 6 - anydata/anyxml 11 - output 16 - grouping 21 - enum |
| 376 | * 2 - choice 7 - case 12 - feature 17 - uses 22 - type |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 377 | * 3 - leaf 8 - notification 13 - identity 18 - refine 23 - stmt |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 378 | * 4 - leaflist 9 - rpc 14 - extension 19 - augment |
| 379 | * 5 - list 10 - input 15 - typedef 20 - deviate |
| 380 | * |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 381 | * 1 1 1 1 1 1 1 1 1 1 2 2 2 2 |
| 382 | * 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 |
| 383 | * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 384 | * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | | | | |x| |x| | | | |
| 385 | * LYS_SET_BASE | | | | | | | | | | | | | | | | | | | | | |x| | |
| 386 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 387 | * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | | | | |x| |x| | | | |
| 388 | * LYS_SET_BIT | | | | | | | | | | | | | | | | | | | | | |x| | |
| 389 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 390 | * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | | |
| 391 | * LYS_SET_ENUM | | | | | | | | | | | | | | | | | | | | | |x| | |
| 392 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 393 | * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | | |
| 394 | * LYS_SET_FRDIGITS | | | | | | | | | | | | | | | | | | | | | |x| | |
| 395 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 396 | * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x|x|x|x| |x|x|x| | | |
| 397 | * LYS_SET_LENGTH | | | | | | | | | | | | | | | | | | | | | |x| | |
| 398 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 399 | * 6 LYS_MAND_TRUE | |x|x| | |x| | | | | | | | | | | |x| |x| | | | |
| 400 | * LYS_SET_PATH | | | | | | | | | | | | | | | | | | | | | |x| | |
| 401 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 402 | * 7 LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | | |x| |x| | | | |
| 403 | * LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | | | | | | | | | |
| 404 | * LYS_SET_PATTERN | | | | | | | | | | | | | | | | | | | | | |x| | |
| 405 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 406 | * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | | | | | | | | | |
| 407 | * LYS_YINELEM_TRUE | | | | | | | | | | | | | |x| | | | | | | | | | |
| 408 | * LYS_SET_RANGE | | | | | | | | | | | | | | | | | | | | | |x| | |
| 409 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 410 | * 9 LYS_YINELEM_FALSE| | | | | | | | | | | | | |x| | | | | | | | | | |
| 411 | * LYS_SET_TYPE | | | | | | | | | | | | | | | | | | | | | |x| | |
| 412 | * LYS_SINGLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x| |
| 413 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 414 | * 10 LYS_SET_VALUE | | | | | | | | | | | | | | | | | | | | |x| | | |
| 415 | * LYS_SET_REQINST | | | | | | | | | | | | | | | | | | | | | |x| | |
| 416 | * LYS_SET_MIN | | | |x|x| | | | | | | | | | | | |x| |x| | | | |
| 417 | * LYS_DOUBLEQUOTED | | | | | | | | | | | | | | | | | | | | | | |x| |
| 418 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 419 | * 11 LYS_SET_MAX | | | |x|x| | | | | | | | | | | | |x| |x| | | | |
Radek Krejci | f2de0ed | 2019-05-02 14:13:18 +0200 | [diff] [blame] | 420 | * LYS_USED_GRP | | | | | | | | | | | | | | | |x| | | | | | | | |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 421 | * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 422 | * |
| 423 | */ |
| 424 | |
| 425 | /** |
| 426 | * @defgroup scnodeflags Compiled schema nodes flags |
| 427 | * @ingroup snodeflags |
| 428 | * |
| 429 | * Various flags for compiled schema nodes. |
| 430 | * |
| 431 | * 1 - container 6 - anydata/anyxml 11 - output |
| 432 | * 2 - choice 7 - case 12 - feature |
| 433 | * 3 - leaf 8 - notification 13 - identity |
| 434 | * 4 - leaflist 9 - rpc 14 - extension |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 435 | * 5 - list 10 - input 15 - bitenum |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 436 | * |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 437 | * 1 1 1 1 1 1 |
| 438 | * bit name 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 |
| 439 | * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 440 | * 1 LYS_CONFIG_W |x|x|x|x|x|x|x| | | | | | | | | |
| 441 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 442 | * 2 LYS_CONFIG_R |x|x|x|x|x|x|x| | | | | | | | | |
| 443 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 444 | * 3 LYS_STATUS_CURR |x|x|x|x|x|x|x|x|x| | |x|x|x| | |
| 445 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 446 | * 4 LYS_STATUS_DEPRC |x|x|x|x|x|x|x|x|x| | |x|x|x| | |
| 447 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 448 | * 5 LYS_STATUS_OBSLT |x|x|x|x|x|x|x|x|x| | |x|x|x| | |
| 449 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 450 | * 6 LYS_MAND_TRUE |x|x|x|x|x|x| | | | | | | | | | |
| 451 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 452 | * 7 LYS_ORDBY_USER | | | |x|x| | | | | | | | | | | |
| 453 | * LYS_MAND_FALSE | |x|x| | |x| | | | | | | | | | |
| 454 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 455 | * 8 LYS_ORDBY_SYSTEM | | | |x|x| | | | | | | | | | | |
| 456 | * LYS_PRESENCE |x| | | | | | | | | | | | | | | |
| 457 | * LYS_UNIQUE | | |x| | | | | | | | | | | | | |
| 458 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 459 | * 9 LYS_KEY | | |x| | | | | | | | | | | | | |
| 460 | * LYS_FENABLED | | | | | | | | | | | |x| | | | |
| 461 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 462 | * 10 LYS_SET_DFLT | | |x|x| | |x| | | | | | | | | |
| 463 | * LYS_ISENUM | | | | | | | | | | | | | | |x| |
| 464 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 465 | * 11 LYS_SET_UNITS | | |x|x| | | | | | | | | | | | |
| 466 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Radek Krejci | 1c0c344 | 2019-07-23 16:08:47 +0200 | [diff] [blame] | 467 | * 12 LYS_SET_CONFIG |x|x|x|x|x|x|x| | |x|x| | | | | |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 468 | * ---------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 469 | * |
| 470 | */ |
| 471 | |
| 472 | /** |
| 473 | * @defgroup snodeflags Schema nodes flags |
| 474 | * @ingroup schematree |
| 475 | * @{ |
| 476 | */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 477 | #define LYS_CONFIG_W 0x01 /**< config true; */ |
| 478 | #define LYS_CONFIG_R 0x02 /**< config false; */ |
| 479 | #define LYS_CONFIG_MASK 0x03 /**< mask for config value */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 480 | #define LYS_STATUS_CURR 0x04 /**< status current; */ |
| 481 | #define LYS_STATUS_DEPRC 0x08 /**< status deprecated; */ |
| 482 | #define LYS_STATUS_OBSLT 0x10 /**< status obsolete; */ |
| 483 | #define LYS_STATUS_MASK 0x1C /**< mask for status value */ |
| 484 | #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] | 485 | ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata. |
| 486 | The ::lysc_node_leaflist and ::lysc_node_leaflist have this flag in case that min-elements > 0. |
| 487 | The ::lysc_node_container has this flag if it is not a presence container and it has at least one |
| 488 | child with LYS_MAND_TRUE. */ |
Radek Krejci | f1421c2 | 2019-02-19 13:05:20 +0100 | [diff] [blame] | 489 | #define LYS_MAND_FALSE 0x40 /**< mandatory false; applicable only to ::lysp_node_choice/::lysc_node_choice, |
| 490 | ::lysp_node_leaf/::lysc_node_leaf and ::lysp_node_anydata/::lysc_node_anydata. |
| 491 | 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] | 492 | #define LYS_MAND_MASK 0x60 /**< mask for mandatory values */ |
Radek Krejci | 7adf4ff | 2018-12-05 08:55:00 +0100 | [diff] [blame] | 493 | #define LYS_PRESENCE 0x80 /**< flag for presence property of a container, applicable only to ::lysc_node_container */ |
| 494 | #define LYS_UNIQUE 0x80 /**< flag for leafs being part of a unique set, applicable only to ::lysc_node_leaf */ |
| 495 | #define LYS_KEY 0x100 /**< flag for leafs being a key of a list, applicable only to ::lysc_node_leaf */ |
| 496 | #define LYS_FENABLED 0x100 /**< feature enabled flag, applicable only to ::lysc_feature */ |
Radek Krejci | fe90963 | 2019-02-12 15:34:42 +0100 | [diff] [blame] | 497 | #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] | 498 | ::lysc_node_list/::lysp_node_list */ |
| 499 | #define LYS_ORDBY_USER 0x40 /**< ordered-by user lists, applicable only to ::lysc_node_leaflist/::lysp_node_leaflist and |
| 500 | ::lysc_node_list/::lysp_node_list */ |
| 501 | #define LYS_ORDBY_MASK 0x60 /**< mask for ordered-by values */ |
| 502 | #define LYS_YINELEM_TRUE 0x80 /**< yin-element true for extension's argument */ |
| 503 | #define LYS_YINELEM_FALSE 0x100 /**< yin-element false for extension's argument */ |
| 504 | #define LYS_YINELEM_MASK 0x180 /**< mask for yin-element value */ |
Radek Krejci | f2de0ed | 2019-05-02 14:13:18 +0200 | [diff] [blame] | 505 | #define LYS_USED_GRP 0x400 /**< internal flag for validating not-instantiated groupings |
| 506 | (resp. do not validate again the instantiated groupings). */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 507 | #define LYS_SET_VALUE 0x200 /**< value attribute is set */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 508 | #define LYS_SET_MIN 0x200 /**< min attribute is set */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 509 | #define LYS_SET_MAX 0x400 /**< max attribute is set */ |
Radek Krejci | d505e3d | 2018-11-13 09:04:17 +0100 | [diff] [blame] | 510 | |
| 511 | #define LYS_SET_BASE 0x0001 /**< type's flag for present base substatement */ |
| 512 | #define LYS_SET_BIT 0x0002 /**< type's flag for present bit substatement */ |
| 513 | #define LYS_SET_ENUM 0x0004 /**< type's flag for present enum substatement */ |
| 514 | #define LYS_SET_FRDIGITS 0x0008 /**< type's flag for present fraction-digits substatement */ |
| 515 | #define LYS_SET_LENGTH 0x0010 /**< type's flag for present length substatement */ |
| 516 | #define LYS_SET_PATH 0x0020 /**< type's flag for present path substatement */ |
| 517 | #define LYS_SET_PATTERN 0x0040 /**< type's flag for present pattern substatement */ |
| 518 | #define LYS_SET_RANGE 0x0080 /**< type's flag for present range substatement */ |
| 519 | #define LYS_SET_TYPE 0x0100 /**< type's flag for present type substatement */ |
| 520 | #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] | 521 | #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] | 522 | cases of choice. This information is important for refines, since it is prohibited to make leafs |
| 523 | 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] | 524 | away when it is refined to be mandatory node. Similarly it is used for deviations to distinguish |
| 525 | between own default or the default values taken from the type. */ |
| 526 | #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] | 527 | #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] | 528 | |
Radek Krejci | d3ca063 | 2019-04-16 16:54:54 +0200 | [diff] [blame] | 529 | #define LYS_SINGLEQUOTED 0x100 /**< flag for single-quoted argument of an extension instance's substatement */ |
| 530 | #define LYS_DOUBLEQUOTED 0x200 /**< flag for double-quoted argument of an extension instance's substatement */ |
| 531 | |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 532 | #define LYS_ISENUM 0x200 /**< flag to simply distinguish type in struct lysc_type_bitenum_item */ |
| 533 | |
Radek Krejci | fe90963 | 2019-02-12 15:34:42 +0100 | [diff] [blame] | 534 | #define LYS_FLAGS_COMPILED_MASK 0xff /**< mask for flags that maps to the compiled structures */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 535 | /** @} */ |
Michal Vasko | b55f6c1 | 2018-09-12 11:13:15 +0200 | [diff] [blame] | 536 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 537 | /** |
| 538 | * @brief Generic YANG data node |
| 539 | */ |
| 540 | struct lysp_node { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 541 | 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] | 542 | uint16_t nodetype; /**< type of the node (mandatory) */ |
| 543 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 544 | 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] | 545 | const char *name; /**< node name (mandatory) */ |
| 546 | const char *dsc; /**< description statement */ |
| 547 | const char *ref; /**< reference statement */ |
| 548 | struct lysp_when *when; /**< when statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 549 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 550 | 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] | 551 | }; |
| 552 | |
| 553 | /** |
| 554 | * @brief Extension structure of the lysp_node for YANG container |
| 555 | */ |
| 556 | struct lysp_node_container { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 557 | 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] | 558 | uint16_t nodetype; /**< LYS_CONTAINER */ |
| 559 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 560 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 561 | const char *name; /**< node name (mandatory) */ |
| 562 | const char *dsc; /**< description statement */ |
| 563 | const char *ref; /**< reference statement */ |
| 564 | struct lysp_when *when; /**< when statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 565 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 566 | 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] | 567 | |
| 568 | /* container */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 569 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 570 | const char *presence; /**< presence description */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 571 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 572 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 573 | struct lysp_node *child; /**< list of data nodes (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 574 | struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 575 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 576 | }; |
| 577 | |
| 578 | struct lysp_node_leaf { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 579 | 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] | 580 | uint16_t nodetype; /**< LYS_LEAF */ |
| 581 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 582 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 583 | const char *name; /**< node name (mandatory) */ |
| 584 | const char *dsc; /**< description statement */ |
| 585 | const char *ref; /**< reference statement */ |
| 586 | struct lysp_when *when; /**< when statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 587 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 588 | 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] | 589 | |
| 590 | /* leaf */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 591 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 592 | struct lysp_type type; /**< type of the leaf node (mandatory) */ |
| 593 | const char *units; /**< units of the leaf's type */ |
| 594 | const char *dflt; /**< default value */ |
| 595 | }; |
| 596 | |
| 597 | struct lysp_node_leaflist { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 598 | 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] | 599 | uint16_t nodetype; /**< LYS_LEAFLIST */ |
| 600 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 601 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 602 | const char *name; /**< node name (mandatory) */ |
| 603 | const char *dsc; /**< description statement */ |
| 604 | const char *ref; /**< reference statement */ |
| 605 | struct lysp_when *when; /**< when statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 606 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 607 | 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] | 608 | |
| 609 | /* leaf-list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 610 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 611 | struct lysp_type type; /**< type of the leaf node (mandatory) */ |
| 612 | const char *units; /**< units of the leaf's type */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 613 | const char **dflts; /**< list of default values ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 614 | uint32_t min; /**< min-elements constraint */ |
| 615 | uint32_t max; /**< max-elements constraint, 0 means unbounded */ |
| 616 | }; |
| 617 | |
| 618 | struct lysp_node_list { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 619 | 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] | 620 | uint16_t nodetype; /**< LYS_LIST */ |
| 621 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 622 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 623 | const char *name; /**< node name (mandatory) */ |
| 624 | const char *dsc; /**< description statement */ |
| 625 | const char *ref; /**< reference statement */ |
| 626 | struct lysp_when *when; /**< when statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 627 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 628 | 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] | 629 | |
| 630 | /* list */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 631 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 632 | const char *key; /**< keys specification */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 633 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 634 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 635 | struct lysp_node *child; /**< list of data nodes (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 636 | struct lysp_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 637 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 638 | const char **uniques; /**< list of unique specifications ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 639 | uint32_t min; /**< min-elements constraint */ |
| 640 | uint32_t max; /**< max-elements constraint, 0 means unbounded */ |
| 641 | }; |
| 642 | |
| 643 | struct lysp_node_choice { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 644 | 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] | 645 | uint16_t nodetype; /**< LYS_CHOICE */ |
| 646 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 647 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 648 | const char *name; /**< node name (mandatory) */ |
| 649 | const char *dsc; /**< description statement */ |
| 650 | const char *ref; /**< reference statement */ |
| 651 | struct lysp_when *when; /**< when statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 652 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
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 | /* choice */ |
| 656 | struct lysp_node *child; /**< list of data nodes (linked list) */ |
| 657 | const char* dflt; /**< default case */ |
| 658 | }; |
| 659 | |
| 660 | struct lysp_node_case { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 661 | 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] | 662 | uint16_t nodetype; /**< LYS_CASE */ |
| 663 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 664 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 665 | const char *name; /**< node name (mandatory) */ |
| 666 | const char *dsc; /**< description statement */ |
| 667 | const char *ref; /**< reference statement */ |
| 668 | struct lysp_when *when; /**< when statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 669 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 670 | 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] | 671 | |
| 672 | /* case */ |
| 673 | struct lysp_node *child; /**< list of data nodes (linked list) */ |
| 674 | }; |
| 675 | |
| 676 | struct lysp_node_anydata { |
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 node) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 678 | uint16_t nodetype; /**< LYS_ANYXML || LYS_ANYDATA */ |
| 679 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 680 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 681 | const char *name; /**< node name (mandatory) */ |
| 682 | const char *dsc; /**< description statement */ |
| 683 | const char *ref; /**< reference statement */ |
| 684 | struct lysp_when *when; /**< when statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 685 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 686 | 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] | 687 | |
| 688 | /* anyxml/anydata */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 689 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 690 | }; |
| 691 | |
| 692 | struct lysp_node_uses { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 693 | 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] | 694 | uint16_t nodetype; /**< LYS_USES */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 695 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 696 | struct lysp_node *next; /**< pointer to the next sibling node (NULL if there is no one) */ |
| 697 | const char *name; /**< grouping name reference (mandatory) */ |
| 698 | const char *dsc; /**< description statement */ |
| 699 | const char *ref; /**< reference statement */ |
| 700 | struct lysp_when *when; /**< when statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 701 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 702 | 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] | 703 | |
| 704 | /* uses */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 705 | struct lysp_refine *refines; /**< list of uses's refines ([sized array](@ref sizedarrays)) */ |
| 706 | 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] | 707 | }; |
| 708 | |
| 709 | /** |
| 710 | * @brief YANG input-stmt and output-stmt |
| 711 | */ |
| 712 | struct lysp_action_inout { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 713 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
| 714 | uint16_t nodetype; /**< LYS_INOUT */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 715 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 716 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 717 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 718 | struct lysp_node *data; /**< list of data nodes (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 719 | 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] | 720 | }; |
| 721 | |
| 722 | /** |
| 723 | * @brief YANG rpc-stmt and action-stmt |
| 724 | */ |
| 725 | struct lysp_action { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 726 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
| 727 | uint16_t nodetype; /**< LYS_ACTION */ |
| 728 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 729 | const char *name; /**< grouping name reference (mandatory) */ |
| 730 | const char *dsc; /**< description statement */ |
| 731 | const char *ref; /**< reference statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 732 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 733 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 734 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 735 | struct lysp_action_inout input; /**< RPC's/Action's input */ |
| 736 | struct lysp_action_inout output; /**< RPC's/Action's output */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 737 | 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] | 738 | }; |
| 739 | |
| 740 | /** |
| 741 | * @brief YANG notification-stmt |
| 742 | */ |
| 743 | struct lysp_notif { |
Radek Krejci | 6d9b9b5 | 2018-11-02 12:43:39 +0100 | [diff] [blame] | 744 | struct lysp_node *parent; /**< parent node (NULL if this is a top-level node) */ |
| 745 | uint16_t nodetype; /**< LYS_NOTIF */ |
| 746 | 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] | 747 | const char *name; /**< grouping name reference (mandatory) */ |
| 748 | const char *dsc; /**< description statement */ |
| 749 | const char *ref; /**< reference statement */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 750 | const char **iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 751 | struct lysp_restr *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 752 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 753 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 754 | struct lysp_node *data; /**< list of data nodes (linked list) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 755 | 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] | 756 | }; |
| 757 | |
| 758 | /** |
Radek Krejci | f0fceb6 | 2018-09-05 14:58:45 +0200 | [diff] [blame] | 759 | * @brief supported YANG schema version values |
| 760 | */ |
| 761 | typedef enum LYS_VERSION { |
| 762 | LYS_VERSION_UNDEF = 0, /**< no specific version, YANG 1.0 as default */ |
| 763 | LYS_VERSION_1_0 = 1, /**< YANG 1.0 */ |
| 764 | LYS_VERSION_1_1 = 2 /**< YANG 1.1 */ |
| 765 | } LYS_VERSION; |
| 766 | |
| 767 | /** |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 768 | * @brief Printable YANG schema tree structure representing YANG module. |
| 769 | * |
| 770 | * Simple structure corresponding to the YANG format. The schema is only syntactically validated. |
| 771 | */ |
| 772 | struct lysp_module { |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 773 | struct lys_module *mod; /**< covering module structure */ |
| 774 | |
Radek Krejci | b7db73a | 2018-10-24 14:18:40 +0200 | [diff] [blame] | 775 | struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision |
| 776 | in the list is always the last (newest) revision of the module */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 777 | struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */ |
| 778 | struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 779 | struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */ |
| 780 | struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */ |
| 781 | struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */ |
| 782 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 783 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 784 | 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] | 785 | struct lysp_augment *augments; /**< list of augments ([sized array](@ref sizedarrays)) */ |
| 786 | struct lysp_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */ |
| 787 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
| 788 | struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */ |
| 789 | 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] | 790 | |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 791 | uint8_t parsing:1; /**< flag for circular check */ |
| 792 | }; |
| 793 | |
| 794 | struct lysp_submodule { |
| 795 | const char *belongsto; /**< belongs to parent module (submodule - mandatory) */ |
| 796 | |
| 797 | struct lysp_revision *revs; /**< list of the module revisions ([sized array](@ref sizedarrays)), the first revision |
| 798 | in the list is always the last (newest) revision of the module */ |
| 799 | struct lysp_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */ |
| 800 | struct lysp_include *includes; /**< list of included submodules ([sized array](@ref sizedarrays)) */ |
| 801 | struct lysp_ext *extensions; /**< list of extension statements ([sized array](@ref sizedarrays)) */ |
| 802 | struct lysp_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */ |
| 803 | struct lysp_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */ |
| 804 | struct lysp_tpdf *typedefs; /**< list of typedefs ([sized array](@ref sizedarrays)) */ |
| 805 | struct lysp_grp *groupings; /**< list of groupings ([sized array](@ref sizedarrays)) */ |
| 806 | struct lysp_node *data; /**< list of module's top-level data nodes (linked list) */ |
| 807 | struct lysp_augment *augments; /**< list of augments ([sized array](@ref sizedarrays)) */ |
| 808 | struct lysp_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */ |
| 809 | struct lysp_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
| 810 | struct lysp_deviation *deviations; /**< list of deviations ([sized array](@ref sizedarrays)) */ |
| 811 | struct lysp_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 812 | |
| 813 | uint8_t parsing:1; /**< flag for circular check */ |
| 814 | |
Radek Krejci | 086c713 | 2018-10-26 15:29:04 +0200 | [diff] [blame] | 815 | uint8_t latest_revision:2; /**< flag to mark the latest available revision: |
| 816 | 1 - the latest revision in searchdirs was not searched yet and this is the |
| 817 | latest revision in the current context |
| 818 | 2 - searchdirs were searched and this is the latest available revision */ |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 819 | const char *name; /**< name of the module (mandatory) */ |
| 820 | const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */ |
| 821 | const char *prefix; /**< submodule belongsto prefix of main module (mandatory) */ |
| 822 | const char *org; /**< party/company responsible for the module */ |
| 823 | const char *contact; /**< contact information for the module */ |
| 824 | const char *dsc; /**< description of the module */ |
| 825 | const char *ref; /**< cross-reference for the module */ |
Radek Krejci | 086c713 | 2018-10-26 15:29:04 +0200 | [diff] [blame] | 826 | uint8_t version; /**< yang-version (LYS_VERSION values) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 827 | }; |
| 828 | |
| 829 | /** |
Radek Krejci | 3f5e3db | 2018-10-11 15:57:47 +0200 | [diff] [blame] | 830 | * @brief Free the printable YANG schema tree structure. |
| 831 | * |
| 832 | * @param[in] module Printable YANG schema tree structure to free. |
| 833 | */ |
| 834 | void lysp_module_free(struct lysp_module *module); |
| 835 | |
| 836 | /** |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 837 | * @brief YANG extension instance |
| 838 | */ |
| 839 | struct lysc_ext_instance { |
| 840 | struct lyext_plugin *plugin; /**< pointer to the plugin implementing the extension (if present) */ |
| 841 | void *parent; /**< pointer to the parent element holding the extension instance(s), use |
| 842 | ::lysc_ext_instance#parent_type to access the schema element */ |
| 843 | const char *argument; /**< optional value of the extension's argument */ |
| 844 | LYEXT_SUBSTMT insubstmt; /**< value identifying placement of the extension instance */ |
| 845 | uint32_t insubstmt_index; /**< in case the instance is in a substatement that can appear multiple times, |
| 846 | this identifies the index of the substatement for this extension instance */ |
Radek Krejci | 2a408df | 2018-10-29 16:32:26 +0100 | [diff] [blame] | 847 | LYEXT_PARENT parent_type; /**< type of the parent structure */ |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 848 | #if 0 |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 849 | uint8_t ext_type; /**< extension type (#LYEXT_TYPE) */ |
| 850 | uint8_t padding; /**< 32b padding */ |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 851 | struct lys_module *module; /**< pointer to the extension instance's module (mandatory) */ |
| 852 | LYS_NODE nodetype; /**< LYS_EXT */ |
| 853 | #endif |
Radek Krejci | 2a408df | 2018-10-29 16:32:26 +0100 | [diff] [blame] | 854 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 855 | void *priv; /**< private caller's data, not used by libyang */ |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 856 | }; |
| 857 | |
| 858 | /** |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 859 | * @brief Compiled YANG if-feature-stmt |
| 860 | */ |
| 861 | struct lysc_iffeature { |
| 862 | uint8_t *expr; /**< 2bits array describing the if-feature expression in prefix format, see @ref ifftokens */ |
| 863 | struct lysc_feature **features; /**< array of pointers to the features used in expression ([sized array](@ref sizedarrays)) */ |
| 864 | }; |
| 865 | |
| 866 | /** |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 867 | * @brief YANG import-stmt |
| 868 | */ |
| 869 | struct lysc_import { |
Radek Krejci | 6d6e4e4 | 2018-10-29 13:28:19 +0100 | [diff] [blame] | 870 | struct lys_module *module; /**< link to the imported module */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 871 | const char *prefix; /**< prefix for the data from the imported schema (mandatory) */ |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 872 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 873 | }; |
| 874 | |
| 875 | /** |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 876 | * @brief YANG when-stmt |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 877 | */ |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 878 | struct lysc_when { |
| 879 | struct lyxp_expr *cond; /**< XPath when condition */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 880 | const char *dsc; /**< description */ |
| 881 | const char *ref; /**< reference */ |
Radek Krejci | 00b874b | 2019-02-12 10:54:50 +0100 | [diff] [blame] | 882 | struct lysc_node *context; /**< context node for evaluating the expression */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 883 | 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] | 884 | uint32_t refcount; /**< reference counter since some of the when statements are shared among several nodes */ |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 885 | }; |
| 886 | |
| 887 | /** |
Radek Krejci | 2a408df | 2018-10-29 16:32:26 +0100 | [diff] [blame] | 888 | * @brief YANG identity-stmt |
| 889 | */ |
| 890 | struct lysc_ident { |
| 891 | const char *name; /**< identity name (mandatory), including possible prefix */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 892 | const char *dsc; /**< description */ |
| 893 | const char *ref; /**< reference */ |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 894 | struct lys_module *module; /**< module structure */ |
Radek Krejci | 2a408df | 2018-10-29 16:32:26 +0100 | [diff] [blame] | 895 | struct lysc_ident **derived; /**< list of (pointers to the) derived identities ([sized array](@ref sizedarrays)) */ |
| 896 | 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] | 897 | 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] | 898 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values are allowed */ |
| 899 | }; |
| 900 | |
| 901 | /** |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 902 | * @brief YANG feature-stmt |
| 903 | */ |
| 904 | struct lysc_feature { |
| 905 | const char *name; /**< feature name (mandatory) */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 906 | const char *dsc; /**< description */ |
| 907 | const char *ref; /**< reference */ |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 908 | struct lys_module *module; /**< module structure */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 909 | 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] | 910 | 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] | 911 | 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] | 912 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_* and |
| 913 | #LYS_FENABLED values allowed */ |
| 914 | }; |
| 915 | |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 916 | /** |
| 917 | * @defgroup ifftokens if-feature expression tokens |
| 918 | * Tokens of if-feature expression used in ::lysc_iffeature#expr |
| 919 | * |
| 920 | * @{ |
| 921 | */ |
| 922 | #define LYS_IFF_NOT 0x00 /**< operand "not" */ |
| 923 | #define LYS_IFF_AND 0x01 /**< operand "and" */ |
| 924 | #define LYS_IFF_OR 0x02 /**< operand "or" */ |
| 925 | #define LYS_IFF_F 0x03 /**< feature */ |
| 926 | /** |
| 927 | * @} |
| 928 | */ |
| 929 | |
| 930 | /** |
Radek Krejci | b7db73a | 2018-10-24 14:18:40 +0200 | [diff] [blame] | 931 | * @brief Compiled YANG revision statement |
| 932 | */ |
| 933 | struct lysc_revision { |
| 934 | char date[LY_REV_SIZE]; /**< revision-date (mandatory) */ |
| 935 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 936 | }; |
| 937 | |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 938 | struct lysc_range { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 939 | struct lysc_range_part { |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 940 | union { /**< min boundary */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 941 | int64_t min_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */ |
| 942 | 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] | 943 | }; |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 944 | union { /**< max boundary */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 945 | int64_t max_64; /**< for int8, int16, int32, int64 and decimal64 ( >= LY_TYPE_DEC64) */ |
| 946 | 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] | 947 | }; |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 948 | } *parts; /**< compiled range expression ([sized array](@ref sizedarrays)) */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 949 | const char *dsc; /**< description */ |
| 950 | const char *ref; /**< reference */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 951 | const char *emsg; /**< error-message */ |
| 952 | const char *eapptag; /**< error-app-tag value */ |
| 953 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 954 | }; |
| 955 | |
| 956 | struct lysc_pattern { |
Radek Krejci | 5457946 | 2019-04-30 12:47:06 +0200 | [diff] [blame] | 957 | const char *expr; /**< original, not compiled, regular expression */ |
| 958 | pcre2_code *code; /**< compiled regular expression */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 959 | const char *dsc; /**< description */ |
| 960 | const char *ref; /**< reference */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 961 | const char *emsg; /**< error-message */ |
| 962 | const char *eapptag; /**< error-app-tag value */ |
| 963 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 4586a02 | 2018-11-13 11:29:26 +0100 | [diff] [blame] | 964 | uint32_t inverted:1; /**< invert-match flag */ |
| 965 | uint32_t refcount:31; /**< reference counter */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 966 | }; |
| 967 | |
| 968 | struct lysc_must { |
| 969 | struct lys_module *module; /**< module where the must was defined */ |
| 970 | struct lyxp_expr *cond; /**< XPath when condition */ |
Radek Krejci | c8b3100 | 2019-01-08 10:24:45 +0100 | [diff] [blame] | 971 | const char *dsc; /**< description */ |
| 972 | const char *ref; /**< reference */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 973 | const char *emsg; /**< error-message */ |
| 974 | const char *eapptag; /**< error-app-tag value */ |
| 975 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 976 | }; |
| 977 | |
| 978 | struct lysc_type { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 979 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | a191122 | 2019-07-22 17:24:50 +0200 | [diff] [blame] | 980 | struct lyd_value *dflt; /**< type's default value if any */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 981 | struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 982 | 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] | 983 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 984 | uint32_t refcount; /**< reference counter for type sharing */ |
| 985 | }; |
| 986 | |
| 987 | struct lysc_type_num { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 988 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | a191122 | 2019-07-22 17:24:50 +0200 | [diff] [blame] | 989 | struct lyd_value *dflt; /**< type's default value if any */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 990 | struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 991 | 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] | 992 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 993 | uint32_t refcount; /**< reference counter for type sharing */ |
| 994 | struct lysc_range *range; /**< Optional range limitation */ |
| 995 | }; |
| 996 | |
| 997 | struct lysc_type_dec { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 998 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | a191122 | 2019-07-22 17:24:50 +0200 | [diff] [blame] | 999 | struct lyd_value *dflt; /**< type's default value if any */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1000 | struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1001 | 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] | 1002 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1003 | uint32_t refcount; /**< reference counter for type sharing */ |
Radek Krejci | 6cba429 | 2018-11-15 17:33:29 +0100 | [diff] [blame] | 1004 | uint8_t fraction_digits; /**< fraction digits specification */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1005 | struct lysc_range *range; /**< Optional range limitation */ |
| 1006 | }; |
| 1007 | |
| 1008 | struct lysc_type_str { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1009 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | a191122 | 2019-07-22 17:24:50 +0200 | [diff] [blame] | 1010 | struct lyd_value *dflt; /**< type's default value if any */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1011 | struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1012 | 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] | 1013 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1014 | uint32_t refcount; /**< reference counter for type sharing */ |
| 1015 | struct lysc_range *length; /**< Optional length limitation */ |
Radek Krejci | 4586a02 | 2018-11-13 11:29:26 +0100 | [diff] [blame] | 1016 | 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] | 1017 | }; |
| 1018 | |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 1019 | struct lysc_type_bitenum_item { |
| 1020 | const char *name; /**< enumeration identifier */ |
| 1021 | const char *dsc; /**< description */ |
| 1022 | const char *ref; /**< reference */ |
| 1023 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1024 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
| 1025 | union { |
| 1026 | int32_t value; /**< integer value associated with the enumeration */ |
| 1027 | uint32_t position; /**< non-negative integer value associated with the bit */ |
| 1028 | }; |
| 1029 | uint16_t flags; /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_SET_VALUE |
| 1030 | values are allowed */ |
| 1031 | }; |
| 1032 | |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1033 | struct lysc_type_enum { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1034 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 01342af | 2019-01-03 15:18:08 +0100 | [diff] [blame] | 1035 | const char *dflt; /**< type's default value if any */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1036 | struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1037 | 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] | 1038 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1039 | uint32_t refcount; /**< reference counter for type sharing */ |
Radek Krejci | 693262f | 2019-04-29 15:23:20 +0200 | [diff] [blame] | 1040 | struct lysc_type_bitenum_item *enums; /**< enumerations list ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */ |
| 1041 | }; |
| 1042 | |
| 1043 | struct lysc_type_bits { |
| 1044 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1045 | const char *dflt; /**< type's default value if any */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1046 | struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1047 | 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] | 1048 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1049 | uint32_t refcount; /**< reference counter for type sharing */ |
Radek Krejci | 849a62a | 2019-05-22 15:29:05 +0200 | [diff] [blame] | 1050 | struct lysc_type_bitenum_item *bits; /**< bits list ([sized array](@ref sizedarrays)), mandatory (at least 1 item), |
| 1051 | the items are ordered by their position value. */ |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1052 | }; |
| 1053 | |
| 1054 | struct lysc_type_leafref { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1055 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 01342af | 2019-01-03 15:18:08 +0100 | [diff] [blame] | 1056 | const char *dflt; /**< type's default value if any */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1057 | struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1058 | 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] | 1059 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1060 | uint32_t refcount; /**< reference counter for type sharing */ |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 1061 | const char* path; /**< target path */ |
Radek Krejci | 96a0bfd | 2018-11-22 15:25:06 +0100 | [diff] [blame] | 1062 | struct lys_module *path_context; /**< module where the path is defined, so it provides context to resolve prefixes */ |
Radek Krejci | 412ddfa | 2018-11-23 11:44:11 +0100 | [diff] [blame] | 1063 | 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] | 1064 | uint8_t require_instance; /**< require-instance flag */ |
| 1065 | }; |
| 1066 | |
| 1067 | struct lysc_type_identityref { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1068 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 01342af | 2019-01-03 15:18:08 +0100 | [diff] [blame] | 1069 | const char *dflt; /**< type's default value if any */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1070 | struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1071 | 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] | 1072 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1073 | uint32_t refcount; /**< reference counter for type sharing */ |
Radek Krejci | 555cb5b | 2018-11-16 14:54:33 +0100 | [diff] [blame] | 1074 | 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] | 1075 | mandatory (at least 1 item) */ |
| 1076 | }; |
| 1077 | |
| 1078 | struct lysc_type_instanceid { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1079 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 01342af | 2019-01-03 15:18:08 +0100 | [diff] [blame] | 1080 | const char *dflt; /**< type's default value if any */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1081 | struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1082 | 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] | 1083 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1084 | uint32_t refcount; /**< reference counter for type sharing */ |
| 1085 | uint8_t require_instance; /**< require-instance flag */ |
| 1086 | }; |
| 1087 | |
Radek Krejci | 2167ee1 | 2018-11-02 16:09:07 +0100 | [diff] [blame] | 1088 | struct lysc_type_union { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1089 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 01342af | 2019-01-03 15:18:08 +0100 | [diff] [blame] | 1090 | const char *dflt; /**< type's default value if any */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1091 | struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1092 | 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] | 1093 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1094 | uint32_t refcount; /**< reference counter for type sharing */ |
| 1095 | struct lysc_type **types; /**< list of types in the union ([sized array](@ref sizedarrays)), mandatory (at least 1 item) */ |
| 1096 | }; |
| 1097 | |
| 1098 | struct lysc_type_bin { |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1099 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 01342af | 2019-01-03 15:18:08 +0100 | [diff] [blame] | 1100 | const char *dflt; /**< type's default value if any */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1101 | struct lys_module *dflt_mod; /**< module where the lysc_type::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | e7b9509 | 2019-05-15 11:03:07 +0200 | [diff] [blame] | 1102 | 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] | 1103 | LY_DATA_TYPE basetype; /**< Base type of the type */ |
| 1104 | uint32_t refcount; /**< reference counter for type sharing */ |
| 1105 | struct lysc_range *length; /**< Optional length limitation */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1106 | }; |
| 1107 | |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1108 | struct lysc_action_inout { |
| 1109 | struct lysc_node *data; /**< first child node (linked list) */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1110 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1111 | }; |
| 1112 | |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1113 | struct lysc_action { |
| 1114 | uint16_t nodetype; /**< LYS_ACTION */ |
| 1115 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Radek Krejci | 95710c9 | 2019-02-11 15:49:55 +0100 | [diff] [blame] | 1116 | struct lys_module *module; /**< module structure */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1117 | 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. */ |
| 1118 | struct lysc_node *parent; /**< parent node (NULL in case of top level node - RPC) */ |
| 1119 | |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1120 | struct lysc_ext_instance *input_exts; /**< list of the extension instances of input ([sized array](@ref sizedarrays)) */ |
| 1121 | 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] | 1122 | |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1123 | const char *name; /**< action/RPC name (mandatory) */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1124 | const char *dsc; /**< description */ |
| 1125 | const char *ref; /**< reference */ |
| 1126 | |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1127 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1128 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
| 1129 | |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1130 | struct lysc_action_inout input; /**< RPC's/action's input */ |
| 1131 | struct lysc_action_inout output; /**< RPC's/action's output */ |
| 1132 | |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1133 | }; |
| 1134 | |
| 1135 | struct lysc_notif { |
| 1136 | uint16_t nodetype; /**< LYS_NOTIF */ |
| 1137 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Radek Krejci | 95710c9 | 2019-02-11 15:49:55 +0100 | [diff] [blame] | 1138 | struct lys_module *module; /**< module structure */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1139 | 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] | 1140 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1141 | |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1142 | struct lysc_node *data; /**< first child node (linked list) */ |
| 1143 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1144 | |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1145 | const char *name; /**< Notification name (mandatory) */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1146 | const char *dsc; /**< description */ |
| 1147 | const char *ref; /**< reference */ |
Radek Krejci | fc11bd7 | 2019-04-11 16:00:05 +0200 | [diff] [blame] | 1148 | |
| 1149 | struct lysc_ext_instance *exts; /**< list of the extension instances ([sized array](@ref sizedarrays)) */ |
| 1150 | struct lysc_iffeature *iffeatures; /**< list of if-feature expressions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1151 | }; |
| 1152 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1153 | /** |
Radek Krejci | 0af5f5d | 2018-09-07 15:00:30 +0200 | [diff] [blame] | 1154 | * @brief Compiled YANG data node |
| 1155 | */ |
| 1156 | struct lysc_node { |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1157 | uint16_t nodetype; /**< type of the node (mandatory) */ |
| 1158 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1159 | struct lys_module *module; /**< module structure */ |
| 1160 | 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. */ |
| 1161 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1162 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1163 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1164 | never NULL. If there is no sibling node, pointer points to the node |
| 1165 | itself. In case of the first node, this pointer points to the last |
| 1166 | node in the list. */ |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1167 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1168 | const char *dsc; /**< description */ |
| 1169 | const char *ref; /**< reference */ |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1170 | 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] | 1171 | 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] | 1172 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1173 | }; |
| 1174 | |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1175 | struct lysc_node_container { |
| 1176 | uint16_t nodetype; /**< LYS_CONTAINER */ |
| 1177 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1178 | struct lys_module *module; /**< module structure */ |
| 1179 | 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. */ |
| 1180 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1181 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1182 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1183 | never NULL. If there is no sibling node, pointer points to the node |
| 1184 | itself. In case of the first node, this pointer points to the last |
| 1185 | node in the list. */ |
| 1186 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1187 | const char *dsc; /**< description */ |
| 1188 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1189 | 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] | 1190 | 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] | 1191 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1192 | |
| 1193 | struct lysc_node *child; /**< first child node (linked list) */ |
| 1194 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1195 | struct lysc_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 1196 | struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1197 | }; |
| 1198 | |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 1199 | struct lysc_node_case { |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1200 | uint16_t nodetype; /**< LYS_CASE */ |
| 1201 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1202 | struct lys_module *module; /**< module structure */ |
| 1203 | 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. */ |
| 1204 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1205 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1206 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1207 | never NULL. If there is no sibling node, pointer points to the node |
| 1208 | itself. In case of the first node, this pointer points to the last |
| 1209 | node in the list. */ |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 1210 | const char *name; /**< name of the case, including the implicit case */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1211 | const char *dsc; /**< description */ |
| 1212 | const char *ref; /**< reference */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1213 | 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] | 1214 | 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] | 1215 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1216 | |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 1217 | 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] | 1218 | 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] | 1219 | }; |
| 1220 | |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1221 | struct lysc_node_choice { |
| 1222 | uint16_t nodetype; /**< LYS_CHOICE */ |
| 1223 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1224 | struct lys_module *module; /**< module structure */ |
| 1225 | 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. */ |
| 1226 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1227 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1228 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1229 | never NULL. If there is no sibling node, pointer points to the node |
| 1230 | itself. In case of the first node, this pointer points to the last |
| 1231 | node in the list. */ |
| 1232 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1233 | const char *dsc; /**< description */ |
| 1234 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1235 | 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] | 1236 | 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] | 1237 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1238 | |
Radek Krejci | a9026eb | 2018-12-12 16:04:47 +0100 | [diff] [blame] | 1239 | struct lysc_node_case *cases; /**< list of the cases (linked list). Note that all the children of all the cases are linked each other |
| 1240 | as siblings. Their parent pointers points to the specific case they belongs to, so distinguish the |
| 1241 | case is simple. */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1242 | 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] | 1243 | }; |
| 1244 | |
| 1245 | struct lysc_node_leaf { |
| 1246 | uint16_t nodetype; /**< LYS_LEAF */ |
| 1247 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1248 | struct lys_module *module; /**< module structure */ |
| 1249 | 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. */ |
| 1250 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1251 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1252 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1253 | never NULL. If there is no sibling node, pointer points to the node |
| 1254 | itself. In case of the first node, this pointer points to the last |
| 1255 | node in the list. */ |
| 1256 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1257 | const char *dsc; /**< description */ |
| 1258 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1259 | 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] | 1260 | 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] | 1261 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1262 | |
| 1263 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1264 | struct lysc_type *type; /**< type of the leaf node (mandatory) */ |
Radek Krejci | b57cf1e | 2018-11-23 14:07:05 +0100 | [diff] [blame] | 1265 | |
Radek Krejci | 4f28eda | 2018-11-12 11:46:16 +0100 | [diff] [blame] | 1266 | const char *units; /**< units of the leaf's type */ |
Radek Krejci | a191122 | 2019-07-22 17:24:50 +0200 | [diff] [blame] | 1267 | struct lyd_value *dflt; /**< default value */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1268 | struct lys_module *dflt_mod; /**< module where the lysc_node_leaf::dflt value was defined (needed to correctly map prefixes). */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1269 | }; |
| 1270 | |
| 1271 | struct lysc_node_leaflist { |
| 1272 | uint16_t nodetype; /**< LYS_LEAFLIST */ |
| 1273 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1274 | struct lys_module *module; /**< module structure */ |
| 1275 | 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. */ |
| 1276 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1277 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1278 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1279 | never NULL. If there is no sibling node, pointer points to the node |
| 1280 | itself. In case of the first node, this pointer points to the last |
| 1281 | node in the list. */ |
| 1282 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1283 | const char *dsc; /**< description */ |
| 1284 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1285 | 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] | 1286 | 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] | 1287 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Radek Krejci | b57cf1e | 2018-11-23 14:07:05 +0100 | [diff] [blame] | 1288 | |
| 1289 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1290 | struct lysc_type *type; /**< type of the leaf node (mandatory) */ |
| 1291 | |
Radek Krejci | 0e5d838 | 2018-11-28 16:37:53 +0100 | [diff] [blame] | 1292 | const char *units; /**< units of the leaf's type */ |
Radek Krejci | d0ef1af | 2019-07-23 12:22:05 +0200 | [diff] [blame] | 1293 | struct lyd_value **dflts; /**< list ([sized array](@ref sizedarrays)) of default values */ |
| 1294 | struct lys_module **dflts_mods; /**< list ([sized array](@ref sizedarrays)) of modules where the lysc_node_leaflist::dflts values were defined |
| 1295 | (needed to correctly map prefixes). */ |
Radek Krejci | 0e5d838 | 2018-11-28 16:37:53 +0100 | [diff] [blame] | 1296 | uint32_t min; /**< min-elements constraint */ |
| 1297 | uint32_t max; /**< max-elements constraint */ |
| 1298 | |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1299 | }; |
| 1300 | |
| 1301 | struct lysc_node_list { |
| 1302 | uint16_t nodetype; /**< LYS_LIST */ |
| 1303 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1304 | struct lys_module *module; /**< module structure */ |
| 1305 | 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. */ |
| 1306 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1307 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1308 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1309 | never NULL. If there is no sibling node, pointer points to the node |
| 1310 | itself. In case of the first node, this pointer points to the last |
| 1311 | node in the list. */ |
| 1312 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1313 | const char *dsc; /**< description */ |
| 1314 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1315 | 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] | 1316 | 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] | 1317 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 9bb94eb | 2018-12-04 16:48:35 +0100 | [diff] [blame] | 1318 | |
| 1319 | struct lysc_node *child; /**< first child node (linked list) */ |
| 1320 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
| 1321 | struct lysc_action *actions; /**< list of actions ([sized array](@ref sizedarrays)) */ |
| 1322 | struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
| 1323 | |
| 1324 | struct lysc_node_leaf **keys; /**< list of pointers to the keys ([sized array](@ref sizedarrays)) */ |
| 1325 | struct lysc_node_leaf ***uniques; /**< list of sized arrays of pointers to the unique nodes ([sized array](@ref sizedarrays)) */ |
| 1326 | uint32_t min; /**< min-elements constraint */ |
| 1327 | uint32_t max; /**< max-elements constraint */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1328 | }; |
| 1329 | |
| 1330 | struct lysc_node_anydata { |
| 1331 | uint16_t nodetype; /**< LYS_ANYXML or LYS_ANYDATA */ |
| 1332 | uint16_t flags; /**< [schema node flags](@ref snodeflags) */ |
| 1333 | struct lys_module *module; /**< module structure */ |
| 1334 | 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. */ |
| 1335 | struct lysc_node *parent; /**< parent node (NULL in case of top level node) */ |
| 1336 | struct lysc_node *next; /**< next sibling node (NULL if there is no one) */ |
| 1337 | struct lysc_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is |
| 1338 | never NULL. If there is no sibling node, pointer points to the node |
| 1339 | itself. In case of the first node, this pointer points to the last |
| 1340 | node in the list. */ |
| 1341 | const char *name; /**< node name (mandatory) */ |
Radek Krejci | 12fb914 | 2019-01-08 09:45:30 +0100 | [diff] [blame] | 1342 | const char *dsc; /**< description */ |
| 1343 | const char *ref; /**< reference */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1344 | 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] | 1345 | 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] | 1346 | struct lysc_when **when; /**< list of pointers to when statements ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 9800fb8 | 2018-12-13 14:26:23 +0100 | [diff] [blame] | 1347 | |
| 1348 | struct lysc_must *musts; /**< list of must restrictions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | bd8d9ba | 2018-11-02 16:06:26 +0100 | [diff] [blame] | 1349 | }; |
| 1350 | |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1351 | /** |
| 1352 | * @brief Compiled YANG schema tree structure representing YANG module. |
| 1353 | * |
| 1354 | * Semantically validated YANG schema tree for data tree parsing. |
| 1355 | * Contains only the necessary information for the data validation. |
| 1356 | */ |
| 1357 | struct lysc_module { |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1358 | struct lys_module *mod; /**< covering module structure */ |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1359 | struct lysc_import *imports; /**< list of imported modules ([sized array](@ref sizedarrays)) */ |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1360 | |
Radek Krejci | e53a8dc | 2018-10-17 12:52:40 +0200 | [diff] [blame] | 1361 | struct lysc_feature *features; /**< list of feature definitions ([sized array](@ref sizedarrays)) */ |
Radek Krejci | 2a408df | 2018-10-29 16:32:26 +0100 | [diff] [blame] | 1362 | struct lysc_ident *identities; /**< list of identities ([sized array](@ref sizedarrays)) */ |
| 1363 | struct lysc_node *data; /**< list of module's top-level data nodes (linked list) */ |
| 1364 | struct lysc_action *rpcs; /**< list of RPCs ([sized array](@ref sizedarrays)) */ |
| 1365 | struct lysc_notif *notifs; /**< list of notifications ([sized array](@ref sizedarrays)) */ |
Radek Krejci | ce8c159 | 2018-10-29 15:35:51 +0100 | [diff] [blame] | 1366 | 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] | 1367 | }; |
| 1368 | |
| 1369 | /** |
Radek Krejci | 53ea615 | 2018-12-13 15:21:15 +0100 | [diff] [blame] | 1370 | * @brief Get the groupings sized array of the given (parsed) schema node. |
| 1371 | * Decides the node's type and in case it has a groupings array, returns it. |
| 1372 | * @param[in] node Node to examine. |
| 1373 | * @return The node's groupings sized array if any, NULL otherwise. |
| 1374 | */ |
| 1375 | const struct lysp_grp *lysp_node_groupings(const struct lysp_node *node); |
| 1376 | |
| 1377 | /** |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1378 | * @brief Get the typedefs sized array of the given (parsed) schema node. |
| 1379 | * Decides the node's type and in case it has a typedefs array, returns it. |
| 1380 | * @param[in] node Node to examine. |
| 1381 | * @return The node's typedefs sized array if any, NULL otherwise. |
| 1382 | */ |
| 1383 | const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node); |
| 1384 | |
| 1385 | /** |
| 1386 | * @brief Get the actions/RPCs sized array of the given (parsed) schema node. |
| 1387 | * Decides the node's type and in case it has a actions/RPCs array, returns it. |
| 1388 | * @param[in] node Node to examine. |
| 1389 | * @return The node's actions/RPCs sized array if any, NULL otherwise. |
| 1390 | */ |
| 1391 | const struct lysp_action *lysp_node_actions(const struct lysp_node *node); |
| 1392 | |
| 1393 | /** |
| 1394 | * @brief Get the Notifications sized array of the given (parsed) schema node. |
| 1395 | * Decides the node's type and in case it has a Notifications array, returns it. |
| 1396 | * @param[in] node Node to examine. |
| 1397 | * @return The node's Notifications sized array if any, NULL otherwise. |
| 1398 | */ |
| 1399 | const struct lysp_notif *lysp_node_notifs(const struct lysp_node *node); |
| 1400 | |
| 1401 | /** |
| 1402 | * @brief Get the children linked list of the given (parsed) schema node. |
| 1403 | * Decides the node's type and in case it has a children list, returns it. |
| 1404 | * @param[in] node Node to examine. |
| 1405 | * @return The node's children linked list if any, NULL otherwise. |
| 1406 | */ |
| 1407 | const struct lysp_node *lysp_node_children(const struct lysp_node *node); |
| 1408 | |
| 1409 | /** |
| 1410 | * @brief Get the actions/RPCs sized array of the given (compiled) schema node. |
| 1411 | * Decides the node's type and in case it has a actions/RPCs array, returns it. |
| 1412 | * @param[in] node Node to examine. |
| 1413 | * @return The node's actions/RPCs sized array if any, NULL otherwise. |
| 1414 | */ |
| 1415 | const struct lysc_action *lysc_node_actions(const struct lysc_node *node); |
| 1416 | |
| 1417 | /** |
| 1418 | * @brief Get the Notifications sized array of the given (compiled) schema node. |
| 1419 | * Decides the node's type and in case it has a Notifications array, returns it. |
| 1420 | * @param[in] node Node to examine. |
| 1421 | * @return The node's Notifications sized array if any, NULL otherwise. |
| 1422 | */ |
| 1423 | const struct lysc_notif *lysc_node_notifs(const struct lysc_node *node); |
| 1424 | |
| 1425 | /** |
| 1426 | * @brief Get the children linked list of the given (compiled) schema node. |
| 1427 | * Decides the node's type and in case it has a children list, returns it. |
| 1428 | * @param[in] node Node to examine. |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1429 | * @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] | 1430 | * @return The node's children linked list if any, NULL otherwise. |
| 1431 | */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1432 | 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] | 1433 | |
| 1434 | /** |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1435 | * @brief Get how the if-feature statement currently evaluates. |
| 1436 | * |
| 1437 | * @param[in] iff Compiled if-feature statement to evaluate. |
| 1438 | * @return If the statement evaluates to true, 1 is returned. 0 is returned when the statement evaluates to false. |
| 1439 | */ |
| 1440 | int lysc_iffeature_value(const struct lysc_iffeature *iff); |
| 1441 | |
| 1442 | /** |
| 1443 | * @brief Get the current status of the provided feature. |
| 1444 | * |
| 1445 | * @param[in] feature Compiled feature statement to examine. |
| 1446 | * @return |
| 1447 | * - 1 if feature is enabled, |
| 1448 | * - 0 if feature is disabled, |
| 1449 | * - -1 in case of error (invalid argument) |
| 1450 | */ |
| 1451 | int lysc_feature_value(const struct lysc_feature *feature); |
| 1452 | |
| 1453 | /** |
Radek Krejci | 327de16 | 2019-06-14 12:52:07 +0200 | [diff] [blame] | 1454 | * @brief Generate path of the given node in the requested format. |
| 1455 | * |
| 1456 | * @param[in] node Schema path of this node will be generated. |
| 1457 | * @param[in] pathtype Format of the path to generate. |
Radek Krejci | 1c0c344 | 2019-07-23 16:08:47 +0200 | [diff] [blame] | 1458 | * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path. |
| 1459 | * If NULL, memory for the complete path is allocated. |
| 1460 | * @param[in] buflen Size of the provided @p buffer. |
Radek Krejci | 327de16 | 2019-06-14 12:52:07 +0200 | [diff] [blame] | 1461 | * @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] | 1462 | * 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] | 1463 | */ |
Radek Krejci | 1c0c344 | 2019-07-23 16:08:47 +0200 | [diff] [blame] | 1464 | char *lysc_path(struct lysc_node *node, LY_PATH_TYPE pathtype, char *buffer, size_t buflen); |
Radek Krejci | 327de16 | 2019-06-14 12:52:07 +0200 | [diff] [blame] | 1465 | |
| 1466 | /** |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1467 | * @brief Available YANG schema tree structures representing YANG module. |
| 1468 | */ |
| 1469 | struct lys_module { |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1470 | struct ly_ctx *ctx; /**< libyang context of the module (mandatory) */ |
| 1471 | const char *name; /**< name of the module (mandatory) */ |
Radek Krejci | 0af4629 | 2019-01-11 16:02:31 +0100 | [diff] [blame] | 1472 | const char *revision; /**< revision of the module (if present) */ |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1473 | const char *ns; /**< namespace of the module (module - mandatory) */ |
| 1474 | const char *prefix; /**< module prefix or submodule belongsto prefix of main module (mandatory) */ |
| 1475 | const char *filepath; /**< path, if the schema was read from a file, NULL in case of reading from memory */ |
| 1476 | const char *org; /**< party/company responsible for the module */ |
| 1477 | const char *contact; /**< contact information for the module */ |
| 1478 | const char *dsc; /**< description of the module */ |
| 1479 | const char *ref; /**< cross-reference for the module */ |
| 1480 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1481 | struct lysp_module *parsed; /**< Simply parsed (unresolved) YANG schema tree */ |
Radek Krejci | 0af4629 | 2019-01-11 16:02:31 +0100 | [diff] [blame] | 1482 | struct lysc_module *compiled; /**< Compiled and fully validated YANG schema tree for data parsing. |
| 1483 | Available only for implemented modules. */ |
| 1484 | struct lysc_feature *off_features;/**< List of pre-compiled features of the module in non implemented modules ([sized array](@ref sizedarrays)). |
| 1485 | These features are always disabled and cannot be enabled until the module |
| 1486 | become implemented. The features are present in this form to allow their linkage |
| 1487 | from if-feature statements of the compiled schemas and their proper use in case |
| 1488 | the module became implemented in future (no matter if implicitly via augment/deviate |
| 1489 | or explicitly via ly_ctx_module_implement()). */ |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1490 | |
Radek Krejci | 95710c9 | 2019-02-11 15:49:55 +0100 | [diff] [blame] | 1491 | uint8_t implemented; /**< flag if the module is implemented, not just imported. The module is implemented if |
| 1492 | the flag has non-zero value. Specific values are used internally: |
| 1493 | 1 - implemented module |
| 1494 | 2 - recently implemented module by dependency, it can be reverted in rollback procedure */ |
| 1495 | uint8_t latest_revision; /**< flag to mark the latest available revision: |
Radek Krejci | 0bcdaed | 2019-01-10 10:21:34 +0100 | [diff] [blame] | 1496 | 1 - the latest revision in searchdirs was not searched yet and this is the |
| 1497 | latest revision in the current context |
| 1498 | 2 - searchdirs were searched and this is the latest available revision */ |
| 1499 | uint8_t version; /**< yang-version (LYS_VERSION values) */ |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1500 | }; |
| 1501 | |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1502 | /** |
| 1503 | * @brief Enable specified feature in the module |
| 1504 | * |
| 1505 | * By default, when the module is loaded by libyang parser, all features are disabled. |
| 1506 | * |
Radek Krejci | ca3db00 | 2018-11-01 10:31:01 +0100 | [diff] [blame] | 1507 | * If all features are being enabled, it must be possible respecting their if-feature conditions. For example, |
| 1508 | * enabling all features on the following feature set will fail since it is not possible to enable both features |
| 1509 | * (and it is unclear which of them should be enabled then). In this case the LY_EDENIED is returned and the feature |
| 1510 | * is untouched. |
| 1511 | * |
| 1512 | * feature f1; |
| 1513 | * feature f2 { if-feature 'not f1';} |
| 1514 | * |
Radek Krejci | 151a5b7 | 2018-10-19 14:21:44 +0200 | [diff] [blame] | 1515 | * @param[in] module Module where the feature will be enabled. |
| 1516 | * @param[in] feature Name of the feature to enable. To enable all features at once, use asterisk (`*`) character. |
| 1517 | * @return LY_ERR value. |
| 1518 | */ |
Radek Krejci | ed5acc5 | 2019-04-25 15:57:04 +0200 | [diff] [blame] | 1519 | 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] | 1520 | |
| 1521 | /** |
| 1522 | * @brief Disable specified feature in the module |
| 1523 | * |
| 1524 | * By default, when the module is loaded by libyang parser, all features are disabled. |
| 1525 | * |
| 1526 | * @param[in] module Module where the feature will be disabled. |
| 1527 | * @param[in] feature Name of the feature to disable. To disable all features at once, use asterisk (`*`) character. |
| 1528 | * @return LY_ERR value |
| 1529 | */ |
Radek Krejci | ed5acc5 | 2019-04-25 15:57:04 +0200 | [diff] [blame] | 1530 | 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] | 1531 | |
| 1532 | /** |
| 1533 | * @brief Get the current status of the specified feature in the module. |
| 1534 | * |
| 1535 | * @param[in] module Module where the feature is defined. |
| 1536 | * @param[in] feature Name of the feature to inspect. |
| 1537 | * @return |
| 1538 | * - 1 if feature is enabled, |
| 1539 | * - 0 if feature is disabled, |
| 1540 | * - -1 in case of error (e.g. feature is not defined or invalid arguments) |
| 1541 | */ |
| 1542 | int lys_feature_value(const struct lys_module *module, const char *feature); |
Radek Krejci | dd4e8d4 | 2018-10-16 14:55:43 +0200 | [diff] [blame] | 1543 | |
| 1544 | /** |
Radek Krejci | 86d106e | 2018-10-18 09:53:19 +0200 | [diff] [blame] | 1545 | * @brief Load a schema into the specified context. |
| 1546 | * |
| 1547 | * @param[in] ctx libyang context where to process the data model. |
| 1548 | * @param[in] data The string containing the dumped data model in the specified |
| 1549 | * format. |
| 1550 | * @param[in] format Format of the input data (YANG or YIN). |
| 1551 | * @return Pointer to the data model structure or NULL on error. |
| 1552 | */ |
Radek Krejci | d14e969 | 2018-11-01 11:00:37 +0100 | [diff] [blame] | 1553 | struct lys_module *lys_parse_mem(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format); |
Radek Krejci | 86d106e | 2018-10-18 09:53:19 +0200 | [diff] [blame] | 1554 | |
| 1555 | /** |
| 1556 | * @brief Read a schema from file descriptor into the specified context. |
| 1557 | * |
| 1558 | * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc. |
| 1559 | * |
| 1560 | * @param[in] ctx libyang context where to process the data model. |
| 1561 | * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema |
| 1562 | * in the specified format. |
| 1563 | * @param[in] format Format of the input data (YANG or YIN). |
| 1564 | * @return Pointer to the data model structure or NULL on error. |
| 1565 | */ |
Radek Krejci | d14e969 | 2018-11-01 11:00:37 +0100 | [diff] [blame] | 1566 | struct lys_module *lys_parse_fd(struct ly_ctx *ctx, int fd, LYS_INFORMAT format); |
Radek Krejci | 86d106e | 2018-10-18 09:53:19 +0200 | [diff] [blame] | 1567 | |
| 1568 | /** |
Radek Krejci | d33273d | 2018-10-25 14:55:52 +0200 | [diff] [blame] | 1569 | * @brief Read a schema into the specified context from a file. |
Radek Krejci | 86d106e | 2018-10-18 09:53:19 +0200 | [diff] [blame] | 1570 | * |
| 1571 | * @param[in] ctx libyang context where to process the data model. |
| 1572 | * @param[in] path Path to the file with the model in the specified format. |
| 1573 | * @param[in] format Format of the input data (YANG or YIN). |
| 1574 | * @return Pointer to the data model structure or NULL on error. |
| 1575 | */ |
Radek Krejci | d14e969 | 2018-11-01 11:00:37 +0100 | [diff] [blame] | 1576 | struct lys_module *lys_parse_path(struct ly_ctx *ctx, const char *path, LYS_INFORMAT format); |
Radek Krejci | 86d106e | 2018-10-18 09:53:19 +0200 | [diff] [blame] | 1577 | |
| 1578 | /** |
Radek Krejci | d33273d | 2018-10-25 14:55:52 +0200 | [diff] [blame] | 1579 | * @brief Search for the schema file in the specified searchpaths. |
| 1580 | * |
| 1581 | * @param[in] searchpaths NULL-terminated array of paths to be searched (recursively). Current working |
| 1582 | * directory is searched automatically (but non-recursively if not in the provided list). Caller can use |
| 1583 | * result of the ly_ctx_get_searchdirs(). |
| 1584 | * @param[in] cwd Flag to implicitly search also in the current working directory (non-recursively). |
| 1585 | * @param[in] name Name of the schema to find. |
| 1586 | * @param[in] revision Revision of the schema to find. If NULL, the newest found schema filepath is returned. |
| 1587 | * @param[out] localfile Mandatory output variable containing absolute path of the found schema. If no schema |
| 1588 | * complying the provided restriction is found, NULL is set. |
| 1589 | * @param[out] format Optional output variable containing expected format of the schema document according to the |
| 1590 | * file suffix. |
| 1591 | * @return LY_ERR value (LY_SUCCESS is returned even if the file is not found, then the *localfile is NULL). |
| 1592 | */ |
| 1593 | LY_ERR lys_search_localfile(const char * const *searchpaths, int cwd, const char *name, const char *revision, char **localfile, LYS_INFORMAT *format); |
| 1594 | |
| 1595 | /** |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 1596 | * @brief Get next schema tree (sibling) node element that can be instantiated in a data tree. Returned node can |
| 1597 | * be from an augment. |
| 1598 | * |
| 1599 | * lys_getnext() is supposed to be called sequentially. In the first call, the \p last parameter is usually NULL |
| 1600 | * and function starts returning i) the first \p parent's child or ii) the first top level element of the \p module. |
| 1601 | * Consequent calls suppose to provide the previously returned node as the \p last parameter and still the same |
| 1602 | * \p parent and \p module parameters. |
| 1603 | * |
| 1604 | * Without options, the function is used to traverse only the schema nodes that can be paired with corresponding |
| 1605 | * data nodes in a data tree. By setting some \p options the behavior can be modified to the extent that |
| 1606 | * all the schema nodes are iteratively returned. |
| 1607 | * |
| 1608 | * @param[in] last Previously returned schema tree node, or NULL in case of the first call. |
| 1609 | * @param[in] parent Parent of the subtree where the function starts processing. |
| 1610 | * @param[in] module In case of iterating on top level elements, the \p parent is NULL and |
| 1611 | * module must be specified. |
| 1612 | * @param[in] options [ORed options](@ref sgetnextflags). |
| 1613 | * @return Next schema tree node that can be instantiated in a data tree, NULL in case there is no such element. |
| 1614 | */ |
| 1615 | const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent, |
| 1616 | const struct lysc_module *module, int options); |
| 1617 | |
| 1618 | /** |
| 1619 | * @defgroup sgetnextflags lys_getnext() flags |
| 1620 | * @ingroup schematree |
| 1621 | * |
| 1622 | * @{ |
| 1623 | */ |
| 1624 | #define LYS_GETNEXT_WITHCHOICE 0x01 /**< lys_getnext() option to allow returning #LYS_CHOICE nodes instead of looking into them */ |
Radek Krejci | 9bb94eb | 2018-12-04 16:48:35 +0100 | [diff] [blame] | 1625 | #define LYS_GETNEXT_NOCHOICE 0x02 /**< lys_getnext() option to ignore (kind of conditional) nodes within choice node */ |
Radek Krejci | 056d0a8 | 2018-12-06 16:57:25 +0100 | [diff] [blame] | 1626 | #define LYS_GETNEXT_WITHCASE 0x04 /**< lys_getnext() option to allow returning #LYS_CASE nodes instead of looking into them */ |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 1627 | #define LYS_GETNEXT_INTONPCONT 0x40 /**< lys_getnext() option to look into non-presence container, instead of returning container itself */ |
| 1628 | #define LYS_GETNEXT_NOSTATECHECK 0x100 /**< lys_getnext() option to skip checking module validity (import-only, disabled) and |
| 1629 | relevant if-feature conditions state */ |
Radek Krejci | 6eeb58f | 2019-02-22 16:29:37 +0100 | [diff] [blame] | 1630 | #define LYS_GETNEXT_OUTPUT 0x200 /**< lys_getnext() option to provide RPC's/action's output schema nodes instead of input schema nodes |
| 1631 | provided by default */ |
Radek Krejci | a304538 | 2018-11-22 14:30:31 +0100 | [diff] [blame] | 1632 | /** @} sgetnextflags */ |
| 1633 | |
| 1634 | /** |
| 1635 | * @brief Get child node according to the specified criteria. |
| 1636 | * |
| 1637 | * @param[in] parent Optional parent of the node to find. If not specified, the module's top-level nodes are searched. |
| 1638 | * @param[in] module module of the node to find. It is also limitation for the children node of the given parent. |
| 1639 | * @param[in] name Name of the node to find. |
| 1640 | * @param[in] name_len Optional length of the name in case it is not NULL-terminated string. |
| 1641 | * @param[in] nodetype Optional criteria (to speedup) specifying nodetype(s) of the node to find. |
| 1642 | * Used as a bitmask, so multiple nodetypes can be specified. |
| 1643 | * @param[in] options [ORed options](@ref sgetnextflags). |
| 1644 | * @return Found node if any. |
| 1645 | */ |
| 1646 | const struct lysc_node *lys_child(const struct lysc_node *parent, const struct lys_module *module, |
| 1647 | const char *name, size_t name_len, uint16_t nodetype, int options); |
| 1648 | |
| 1649 | /** |
| 1650 | * @brief Check if the schema node is disabled in the schema tree, i.e. there is any disabled if-feature statement |
| 1651 | * affecting the node. |
| 1652 | * |
| 1653 | * @param[in] node Schema node to check. |
| 1654 | * @param[in] recursive - 0 to check if-feature only in the \p node schema node, |
| 1655 | * - 1 to check if-feature in all ascendant schema nodes until there is a node possibly having an instance in a data tree |
| 1656 | * @return - NULL if enabled, |
| 1657 | * - pointer to the node with the unsatisfied (disabling) if-feature expression. |
| 1658 | */ |
| 1659 | const struct lysc_iffeature *lys_is_disabled(const struct lysc_node *node, int recursive); |
| 1660 | |
Radek Krejci | 084289f | 2019-07-09 17:35:30 +0200 | [diff] [blame] | 1661 | /** |
| 1662 | * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value. |
| 1663 | * |
| 1664 | * This function check just the type's restriction, if you want to check also the data tree context (e.g. in case of |
| 1665 | * require-instance restriction), use lyd_value_validate(). |
| 1666 | * |
| 1667 | * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL) |
| 1668 | * @param[in] node Schema node for the @p value. |
| 1669 | * @param[in] value String value to be checked. |
| 1670 | * @param[in] value_len Length of the given @p value (mandatory). |
| 1671 | * @param[in] get_prefix Callback function to resolve prefixes used in the @p value string. |
| 1672 | * @param[in] get_prefix_data Private data for the @p get_prefix callback. |
| 1673 | * @param[in] format Input format of the @p value. |
| 1674 | * @return LY_SUCCESS on success |
| 1675 | * @return LY_ERR value if an error occurred. |
| 1676 | */ |
| 1677 | LY_ERR lys_value_validate(struct ly_ctx *ctx, const struct lysc_node *node, const char *value, size_t value_len, |
| 1678 | ly_clb_resolve_prefix get_prefix, void *get_prefix_data, LYD_FORMAT format); |
| 1679 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1680 | /** @} */ |
| 1681 | |
Radek Krejci | 70853c5 | 2018-10-15 14:46:16 +0200 | [diff] [blame] | 1682 | #ifdef __cplusplus |
| 1683 | } |
| 1684 | #endif |
| 1685 | |
Radek Krejci | 5aeea3a | 2018-09-05 13:29:36 +0200 | [diff] [blame] | 1686 | #endif /* LY_TREE_SCHEMA_H_ */ |