Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 1 | /** |
| 2 | * @file parser_internal.h |
| 3 | * @author Radek Krejci <rkrejci@cesnet.cz> |
| 4 | * @brief Internal structures and functions for libyang parsers |
| 5 | * |
| 6 | * Copyright (c) 2020 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_PARSER_INTERNAL_H_ |
| 16 | #define LY_PARSER_INTERNAL_H_ |
| 17 | |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 18 | #include "parser_data.h" |
Michal Vasko | c8a230d | 2020-08-14 12:17:10 +0200 | [diff] [blame] | 19 | #include "plugins_types.h" |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 20 | #include "tree_schema_internal.h" |
| 21 | |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 22 | struct lyd_ctx; |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 23 | struct ly_in; |
Michal Vasko | c8a230d | 2020-08-14 12:17:10 +0200 | [diff] [blame] | 24 | |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 25 | /** |
Radek Krejci | 84d7fd7 | 2021-07-14 18:32:21 +0200 | [diff] [blame] | 26 | * @brief Callback for ::lyd_ctx to free the structure |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 27 | * |
| 28 | * @param[in] ctx Data parser context to free. |
| 29 | */ |
| 30 | typedef void (*lyd_ctx_free_clb)(struct lyd_ctx *ctx); |
| 31 | |
| 32 | /** |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 33 | * @brief Internal data parser flags. |
| 34 | */ |
| 35 | #define LYD_INTOPT_RPC 0x01 /**< RPC request is being parsed. */ |
| 36 | #define LYD_INTOPT_ACTION 0x02 /**< Action request is being parsed. */ |
| 37 | #define LYD_INTOPT_REPLY 0x04 /**< RPC/action reply is being parsed. */ |
| 38 | #define LYD_INTOPT_NOTIF 0x08 /**< Notification is being parsed. */ |
| 39 | #define LYD_INTOPT_WITH_SIBLINGS 0x10 /**< Parse the whole input with any siblings. */ |
| 40 | #define LYD_INTOPT_NO_SIBLINGS 0x20 /**< If there are any siblings, return an error. */ |
| 41 | |
| 42 | /** |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 43 | * @brief Internal (common) context for YANG data parsers. |
Radek Krejci | 4f2e3e5 | 2021-03-30 14:20:28 +0200 | [diff] [blame] | 44 | * |
Radek Krejci | 84d7fd7 | 2021-07-14 18:32:21 +0200 | [diff] [blame] | 45 | * Covers ::lyd_xml_ctx, ::lyd_json_ctx and ::lyd_lyb_ctx. |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 46 | */ |
| 47 | struct lyd_ctx { |
Radek Krejci | f16e254 | 2021-02-17 15:39:23 +0100 | [diff] [blame] | 48 | const struct lysc_ext_instance *ext; /**< extension instance possibly changing document root context of the data being parsed */ |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 49 | uint32_t parse_opts; /**< various @ref dataparseroptions. */ |
| 50 | uint32_t val_opts; /**< various @ref datavalidationoptions. */ |
| 51 | uint32_t int_opts; /**< internal parser options */ |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 52 | uint32_t path_len; /**< used bytes in the path buffer */ |
| 53 | #define LYD_PARSER_BUFSIZE 4078 |
| 54 | char path[LYD_PARSER_BUFSIZE]; /**< buffer for the generated path */ |
Michal Vasko | c43c8ab | 2021-03-05 13:32:44 +0100 | [diff] [blame] | 55 | struct ly_set node_when; /**< set of nodes with "when" conditions */ |
Radek Krejci | 4f2e3e5 | 2021-03-30 14:20:28 +0200 | [diff] [blame] | 56 | struct ly_set node_exts; /**< set of nodes and extensions connected with a plugin providing own validation callback */ |
Michal Vasko | 3271138 | 2020-12-03 14:14:31 +0100 | [diff] [blame] | 57 | struct ly_set node_types; /**< set of nodes validated with LY_EINCOMPLETE result */ |
| 58 | struct ly_set meta_types; /**< set of metadata validated with LY_EINCOMPLETE result */ |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 59 | struct lyd_node *op_node; /**< if an RPC/action/notification is being parsed, store the pointer to it */ |
| 60 | |
| 61 | /* callbacks */ |
Radek Krejci | 0bff0b1 | 2020-08-15 18:37:50 +0200 | [diff] [blame] | 62 | lyd_ctx_free_clb free; /**< destructor */ |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 63 | |
| 64 | struct { |
Radek Krejci | 0bff0b1 | 2020-08-15 18:37:50 +0200 | [diff] [blame] | 65 | const struct ly_ctx *ctx; /**< libyang context */ |
| 66 | uint64_t line; /**< current line */ |
| 67 | struct ly_in *in; /**< input structure */ |
| 68 | } *data_ctx; /**< generic pointer supposed to map to and access (common part of) XML/JSON/... parser contexts */ |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 69 | }; |
| 70 | |
Radek Krejci | 7931b19 | 2020-06-25 17:05:03 +0200 | [diff] [blame] | 71 | /** |
Michal Vasko | 03fbaed | 2021-07-15 09:18:32 +0200 | [diff] [blame^] | 72 | * @brief Internal context for XML data parser. |
| 73 | */ |
| 74 | struct lyd_xml_ctx { |
| 75 | const struct lysc_ext_instance *ext; |
| 76 | uint32_t parse_opts; |
| 77 | uint32_t val_opts; |
| 78 | uint32_t int_opts; |
| 79 | uint32_t path_len; |
| 80 | char path[LYD_PARSER_BUFSIZE]; |
| 81 | struct ly_set node_when; |
| 82 | struct ly_set node_exts; |
| 83 | struct ly_set node_types; |
| 84 | struct ly_set meta_types; |
| 85 | struct lyd_node *op_node; |
| 86 | |
| 87 | /* callbacks */ |
| 88 | lyd_ctx_free_clb free; |
| 89 | |
| 90 | struct lyxml_ctx *xmlctx; /**< XML context */ |
| 91 | }; |
| 92 | |
| 93 | /** |
| 94 | * @brief Internal context for JSON data parser. |
| 95 | */ |
| 96 | struct lyd_json_ctx { |
| 97 | const struct lysc_ext_instance *ext; |
| 98 | uint32_t parse_opts; |
| 99 | uint32_t val_opts; |
| 100 | uint32_t int_opts; |
| 101 | uint32_t path_len; |
| 102 | char path[LYD_PARSER_BUFSIZE]; |
| 103 | struct ly_set node_when; |
| 104 | struct ly_set node_exts; |
| 105 | struct ly_set node_types; |
| 106 | struct ly_set meta_types; |
| 107 | struct lyd_node *op_node; |
| 108 | |
| 109 | /* callbacks */ |
| 110 | lyd_ctx_free_clb free; |
| 111 | |
| 112 | struct lyjson_ctx *jsonctx; /**< JSON context */ |
| 113 | }; |
| 114 | |
| 115 | /** |
| 116 | * @brief Internal context for LYB data parser/printer. |
| 117 | */ |
| 118 | struct lyd_lyb_ctx { |
| 119 | const struct lysc_ext_instance *ext; |
| 120 | union { |
| 121 | struct { |
| 122 | uint32_t parse_opts; |
| 123 | uint32_t val_opts; |
| 124 | }; |
| 125 | uint32_t print_options; |
| 126 | }; |
| 127 | uint32_t int_opts; |
| 128 | uint32_t path_len; |
| 129 | char path[LYD_PARSER_BUFSIZE]; |
| 130 | struct ly_set node_when; |
| 131 | struct ly_set node_exts; |
| 132 | struct ly_set node_types; |
| 133 | struct ly_set meta_types; |
| 134 | struct lyd_node *op_node; |
| 135 | |
| 136 | /* callbacks */ |
| 137 | lyd_ctx_free_clb free; |
| 138 | |
| 139 | struct lylyb_ctx *lybctx; /* LYB context */ |
| 140 | }; |
| 141 | |
| 142 | /** |
Radek Krejci | 84d7fd7 | 2021-07-14 18:32:21 +0200 | [diff] [blame] | 143 | * @brief Common part to supplement the specific ::lyd_ctx_free_clb callbacks. |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 144 | */ |
| 145 | void lyd_ctx_free(struct lyd_ctx *); |
| 146 | |
| 147 | /** |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 148 | * @brief Parse submodule from YANG data. |
Radek Krejci | 84d7fd7 | 2021-07-14 18:32:21 +0200 | [diff] [blame] | 149 | * @param[in,out] context Parser context. |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 150 | * @param[in] ly_ctx Context of YANG schemas. |
| 151 | * @param[in] main_ctx Parser context of main module. |
Michal Vasko | 63f3d84 | 2020-07-08 10:10:14 +0200 | [diff] [blame] | 152 | * @param[in] in Input structure. |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 153 | * @param[out] submod Pointer to the parsed submodule structure. |
| 154 | * @return LY_ERR value - LY_SUCCESS, LY_EINVAL or LY_EVALID. |
| 155 | */ |
| 156 | LY_ERR yang_parse_submodule(struct lys_yang_parser_ctx **context, struct ly_ctx *ly_ctx, struct lys_parser_ctx *main_ctx, |
Radek Krejci | 0f96988 | 2020-08-21 16:56:47 +0200 | [diff] [blame] | 157 | struct ly_in *in, struct lysp_submodule **submod); |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 158 | |
| 159 | /** |
| 160 | * @brief Parse module from YANG data. |
Radek Krejci | 84d7fd7 | 2021-07-14 18:32:21 +0200 | [diff] [blame] | 161 | * @param[in] context Parser context. |
Michal Vasko | 63f3d84 | 2020-07-08 10:10:14 +0200 | [diff] [blame] | 162 | * @param[in] in Input structure. |
| 163 | * @param[in,out] mod Prepared module structure where the parsed information, including the parsed |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 164 | * module structure, will be filled in. |
Michal Vasko | 405cc9e | 2020-12-01 12:01:27 +0100 | [diff] [blame] | 165 | * @return LY_ERR values. |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 166 | */ |
aPiecek | c3e2614 | 2021-06-22 14:25:49 +0200 | [diff] [blame] | 167 | LY_ERR yang_parse_module(struct lys_yang_parser_ctx **context, struct ly_in *in, struct lys_module *mod); |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 168 | |
| 169 | /** |
| 170 | * @brief Parse module from YIN data. |
| 171 | * |
| 172 | * @param[in,out] yin_ctx Context created during parsing, is used to finalize lysp_model after it's completly parsed. |
Michal Vasko | 63f3d84 | 2020-07-08 10:10:14 +0200 | [diff] [blame] | 173 | * @param[in] in Input structure. |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 174 | * @param[in,out] mod Prepared module structure where the parsed information, including the parsed |
| 175 | * module structure, will be filled in. |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 176 | * @return LY_ERR values. |
| 177 | */ |
aPiecek | c3e2614 | 2021-06-22 14:25:49 +0200 | [diff] [blame] | 178 | LY_ERR yin_parse_module(struct lys_yin_parser_ctx **yin_ctx, struct ly_in *in, struct lys_module *mod); |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 179 | |
| 180 | /** |
| 181 | * @brief Parse submodule from YIN data. |
| 182 | * |
| 183 | * @param[in,out] yin_ctx Context created during parsing, is used to finalize lysp_model after it's completly parsed. |
| 184 | * @param[in] ctx Libyang context. |
| 185 | * @param[in] main_ctx Parser context of main module. |
Michal Vasko | 63f3d84 | 2020-07-08 10:10:14 +0200 | [diff] [blame] | 186 | * @param[in] in Input structure. |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 187 | * @param[in,out] submod Submodule structure where the parsed information, will be filled in. |
| 188 | * @return LY_ERR values. |
| 189 | */ |
| 190 | LY_ERR yin_parse_submodule(struct lys_yin_parser_ctx **yin_ctx, struct ly_ctx *ctx, struct lys_parser_ctx *main_ctx, |
Radek Krejci | 0f96988 | 2020-08-21 16:56:47 +0200 | [diff] [blame] | 191 | struct ly_in *in, struct lysp_submodule **submod); |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 192 | |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 193 | /** |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 194 | * @brief Parse XML string as a YANG data tree. |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 195 | * |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 196 | * @param[in] ctx libyang context. |
aPiecek | b0445f2 | 2021-06-24 11:34:07 +0200 | [diff] [blame] | 197 | * @param[in] ext Optional extension instance to parse data following the schema tree specified in the extension instance |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 198 | * @param[in] parent Parent to connect the parsed nodes to, if any. |
| 199 | * @param[in,out] first_p Pointer to the first top-level parsed node, used only if @p parent is NULL. |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 200 | * @param[in] in Input structure. |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 201 | * @param[in] parse_opts Options for parser, see @ref dataparseroptions. |
| 202 | * @param[in] val_opts Options for the validation phase, see @ref datavalidationoptions. |
| 203 | * @param[in] data_type Expected data type of the data. |
Michal Vasko | 299d5d1 | 2021-02-16 16:36:37 +0100 | [diff] [blame] | 204 | * @param[out] envp Individual parsed envelopes tree, returned only by specific @p data_type and possibly even if |
| 205 | * an error occurs later. |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 206 | * @param[out] parsed Set to add all the parsed siblings into. |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 207 | * @param[out] lydctx_p Data parser context to finish validation. |
| 208 | * @return LY_ERR value. |
| 209 | */ |
Radek Krejci | f16e254 | 2021-02-17 15:39:23 +0100 | [diff] [blame] | 210 | LY_ERR lyd_parse_xml(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent, |
| 211 | struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, enum lyd_type data_type, |
| 212 | struct lyd_node **envp, struct ly_set *parsed, struct lyd_ctx **lydctx_p); |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 213 | |
| 214 | /** |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 215 | * @brief Parse JSON string as a YANG data tree. |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 216 | * |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 217 | * @param[in] ctx libyang context. |
aPiecek | b0445f2 | 2021-06-24 11:34:07 +0200 | [diff] [blame] | 218 | * @param[in] ext Optional extension instance to parse data following the schema tree specified in the extension instance |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 219 | * @param[in] parent Parent to connect the parsed nodes to, if any. |
| 220 | * @param[in,out] first_p Pointer to the first top-level parsed node, used only if @p parent is NULL. |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 221 | * @param[in] in Input structure. |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 222 | * @param[in] parse_opts Options for parser, see @ref dataparseroptions. |
| 223 | * @param[in] val_opts Options for the validation phase, see @ref datavalidationoptions. |
| 224 | * @param[in] data_type Expected data type of the data. |
| 225 | * @param[out] parsed Set to add all the parsed siblings into. |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 226 | * @param[out] lydctx_p Data parser context to finish validation. |
| 227 | * @return LY_ERR value. |
| 228 | */ |
Radek Krejci | f16e254 | 2021-02-17 15:39:23 +0100 | [diff] [blame] | 229 | LY_ERR lyd_parse_json(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent, |
| 230 | struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, enum lyd_type data_type, |
| 231 | struct ly_set *parsed, struct lyd_ctx **lydctx_p); |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 232 | |
| 233 | /** |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 234 | * @brief Parse binary LYB data as a YANG data tree. |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 235 | * |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 236 | * @param[in] ctx libyang context. |
aPiecek | b0445f2 | 2021-06-24 11:34:07 +0200 | [diff] [blame] | 237 | * @param[in] ext Optional extension instance to parse data following the schema tree specified in the extension instance |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 238 | * @param[in] parent Parent to connect the parsed nodes to, if any. |
| 239 | * @param[in,out] first_p Pointer to the first top-level parsed node, used only if @p parent is NULL. |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 240 | * @param[in] in Input structure. |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 241 | * @param[in] parse_opts Options for parser, see @ref dataparseroptions. |
| 242 | * @param[in] val_opts Options for the validation phase, see @ref datavalidationoptions. |
| 243 | * @param[in] data_type Expected data type of the data. |
| 244 | * @param[out] parsed Set to add all the parsed siblings into. |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 245 | * @param[out] lydctx_p Data parser context to finish validation. |
| 246 | * @return LY_ERR value. |
| 247 | */ |
Radek Krejci | f16e254 | 2021-02-17 15:39:23 +0100 | [diff] [blame] | 248 | LY_ERR lyd_parse_lyb(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent, |
| 249 | struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, enum lyd_type data_type, |
| 250 | struct ly_set *parsed, struct lyd_ctx **lydctx_p); |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 251 | |
| 252 | /** |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 253 | * @brief Search all the parents for an operation node, check validity based on internal parser flags. |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 254 | * |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 255 | * @param[in] parent Parent to connect the parsed nodes to. |
Radek Krejci | 84d7fd7 | 2021-07-14 18:32:21 +0200 | [diff] [blame] | 256 | * @param[in] int_opts Internal parser options. |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 257 | * @param[out] op Found operation, if any. |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 258 | * @return LY_ERR value. |
| 259 | */ |
Michal Vasko | e066574 | 2021-02-11 11:08:44 +0100 | [diff] [blame] | 260 | LY_ERR lyd_parser_find_operation(const struct lyd_node *parent, uint32_t int_opts, struct lyd_node **op); |
Michal Vasko | afac782 | 2020-10-20 14:22:26 +0200 | [diff] [blame] | 261 | |
| 262 | /** |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 263 | * @brief Check that a data node representing the @p snode is suitable based on options. |
| 264 | * |
| 265 | * @param[in] lydctx Common data parsers context. |
| 266 | * @param[in] snode Schema node to check. |
| 267 | * @return LY_SUCCESS or LY_EVALID |
| 268 | */ |
| 269 | LY_ERR lyd_parser_check_schema(struct lyd_ctx *lydctx, const struct lysc_node *snode); |
| 270 | |
| 271 | /** |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 272 | * @brief Wrapper around ::lyd_create_term() for data parsers. |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 273 | * |
| 274 | * @param[in] lydctx Data parser context. |
Radek Krejci | 84d7fd7 | 2021-07-14 18:32:21 +0200 | [diff] [blame] | 275 | * @param[in] schema Schema node of the new data node. |
| 276 | * @param[in] value String value to be parsed. |
| 277 | * @param[in] value_len Length of @p value, must be set correctly. |
| 278 | * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed. |
| 279 | * @param[in] format Input format of @p value. |
| 280 | * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix). |
| 281 | * @param[in] hints [Data parser's hints](@ref lydvalhints) for the value's type. |
| 282 | * @param[out] node Created node. |
| 283 | * @return LY_SUCCESS on success. |
| 284 | * @return LY_EINCOMPLETE in case data tree is needed to finish the validation. |
| 285 | * @return LY_ERR value if an error occurred. |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 286 | */ |
Radek Krejci | 09c7744 | 2021-04-26 11:10:34 +0200 | [diff] [blame] | 287 | LY_ERR lyd_parser_create_term(struct lyd_ctx *lydctx, const struct lysc_node *schema, const void *value, size_t value_len, |
Radek Krejci | 8df109d | 2021-04-23 12:19:08 +0200 | [diff] [blame] | 288 | ly_bool *dynamic, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints, struct lyd_node **node); |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 289 | |
| 290 | /** |
Radek Krejci | 8678fa4 | 2020-08-18 16:07:28 +0200 | [diff] [blame] | 291 | * @brief Wrapper around ::lyd_create_meta() for data parsers. |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 292 | * |
| 293 | * @param[in] lydctx Data parser context. |
Michal Vasko | b68571a | 2020-11-06 17:18:41 +0100 | [diff] [blame] | 294 | * @param[in] parent Parent of the created meta. Must be set if @p meta is NULL. |
| 295 | * @param[in,out] meta First existing meta to connect to or empty pointer to set. Must be set if @p parent is NULL. |
| 296 | * @param[in] mod Module of the created metadata. |
| 297 | * @param[in] name Metadata name. |
| 298 | * @param[in] name_len Length of @p name. |
| 299 | * @param[in] value Metadata value. |
| 300 | * @param[in] value_len Length of @p value. |
| 301 | * @param[in,out] dynamic Whether the @p value is dynamically allocated, is adjusted once the value is assigned. |
| 302 | * @param[in] format Prefix format. |
| 303 | * @param[in] prefix_data Prefix format data (see ::ly_resolve_prefix()). |
Michal Vasko | feca4fb | 2020-10-05 08:58:40 +0200 | [diff] [blame] | 304 | * @param[in] hints [Value hint](@ref lydvalhints) from the parser regarding the value type. |
Michal Vasko | b68571a | 2020-11-06 17:18:41 +0100 | [diff] [blame] | 305 | * @return LY_ERR value. |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 306 | */ |
Michal Vasko | c8a230d | 2020-08-14 12:17:10 +0200 | [diff] [blame] | 307 | LY_ERR lyd_parser_create_meta(struct lyd_ctx *lydctx, struct lyd_node *parent, struct lyd_meta **meta, |
Radek Krejci | f994364 | 2021-04-26 10:18:21 +0200 | [diff] [blame] | 308 | const struct lys_module *mod, const char *name, size_t name_len, const void *value, |
Radek Krejci | 8df109d | 2021-04-23 12:19:08 +0200 | [diff] [blame] | 309 | size_t value_len, ly_bool *dynamic, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints); |
Radek Krejci | 1798aae | 2020-07-14 13:26:06 +0200 | [diff] [blame] | 310 | |
Radek Krejci | f0e1ba5 | 2020-05-22 15:14:35 +0200 | [diff] [blame] | 311 | #endif /* LY_PARSER_INTERNAL_H_ */ |