blob: 419d68edde00962de712f5daa2d1b33ef6b6e4e6 [file] [log] [blame]
Radek Krejcif0e1ba52020-05-22 15:14:35 +02001/**
2 * @file parser_internal.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
Michal Vaskod027f382023-02-10 09:13:25 +01004 * @author Michal Vasko <mvasko@cesnet.cz>
Radek Krejcif0e1ba52020-05-22 15:14:35 +02005 * @brief Internal structures and functions for libyang parsers
6 *
Michal Vaskod027f382023-02-10 09:13:25 +01007 * Copyright (c) 2020 - 2023 CESNET, z.s.p.o.
Radek Krejcif0e1ba52020-05-22 15:14:35 +02008 *
9 * This source code is licensed under BSD 3-Clause License (the "License").
10 * You may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * https://opensource.org/licenses/BSD-3-Clause
14 */
15
16#ifndef LY_PARSER_INTERNAL_H_
17#define LY_PARSER_INTERNAL_H_
18
Michal Vaskoe0665742021-02-11 11:08:44 +010019#include "parser_data.h"
aPiecek704f8e92021-08-25 13:35:05 +020020#include "set.h"
Radek Krejcif0e1ba52020-05-22 15:14:35 +020021
Radek Krejci1798aae2020-07-14 13:26:06 +020022struct lyd_ctx;
Michal Vaskoafac7822020-10-20 14:22:26 +020023struct ly_in;
Michal Vasko193dacd2022-10-13 08:43:05 +020024struct lysp_ext_substmt;
25struct lysp_stmt;
Michal Vaskod0625d72022-10-06 15:02:50 +020026struct lysp_yang_ctx;
27struct lysp_yin_ctx;
28struct lysp_ctx;
Michal Vaskoc8a230d2020-08-14 12:17:10 +020029
Radek Krejci1798aae2020-07-14 13:26:06 +020030/**
Michal Vaskod027f382023-02-10 09:13:25 +010031 * @brief Check data parser error taking into account multi-error validation.
32 *
33 * @param[in] r Local return value.
34 * @param[in] err_cmd Command to perform on any error.
35 * @param[in] lydctx Data parser context.
36 * @param[in] label Label to go to on fatal error.
37 */
38#define LY_DPARSER_ERR_GOTO(r, err_cmd, lydctx, label) \
39 if (r) { \
40 err_cmd; \
Michal Vasko50da8cd2023-03-10 08:38:59 +010041 if ((r != LY_EVALID) || !lydctx || !(lydctx->val_opts & LYD_VALIDATE_MULTI_ERROR) || \
42 (ly_vecode(((struct lyd_ctx *)lydctx)->data_ctx->ctx) == LYVE_SYNTAX)) { \
Michal Vaskod027f382023-02-10 09:13:25 +010043 goto label; \
44 } \
45 }
46
47/**
Radek Krejci84d7fd72021-07-14 18:32:21 +020048 * @brief Callback for ::lyd_ctx to free the structure
Radek Krejci1798aae2020-07-14 13:26:06 +020049 *
50 * @param[in] ctx Data parser context to free.
51 */
52typedef void (*lyd_ctx_free_clb)(struct lyd_ctx *ctx);
53
54/**
Michal Vaskoe0665742021-02-11 11:08:44 +010055 * @brief Internal data parser flags.
56 */
57#define LYD_INTOPT_RPC 0x01 /**< RPC request is being parsed. */
58#define LYD_INTOPT_ACTION 0x02 /**< Action request is being parsed. */
59#define LYD_INTOPT_REPLY 0x04 /**< RPC/action reply is being parsed. */
60#define LYD_INTOPT_NOTIF 0x08 /**< Notification is being parsed. */
Michal Vasko02ed9d82021-07-15 14:58:04 +020061#define LYD_INTOPT_ANY 0x10 /**< Anydata/anyxml content is being parsed, there can be anything. */
62#define LYD_INTOPT_WITH_SIBLINGS 0x20 /**< Parse the whole input with any siblings. */
63#define LYD_INTOPT_NO_SIBLINGS 0x40 /**< If there are any siblings, return an error. */
Michal Vaskoe0665742021-02-11 11:08:44 +010064
65/**
Radek Krejci1798aae2020-07-14 13:26:06 +020066 * @brief Internal (common) context for YANG data parsers.
Radek Krejci4f2e3e52021-03-30 14:20:28 +020067 *
Radek Krejci84d7fd72021-07-14 18:32:21 +020068 * Covers ::lyd_xml_ctx, ::lyd_json_ctx and ::lyd_lyb_ctx.
Radek Krejci1798aae2020-07-14 13:26:06 +020069 */
70struct lyd_ctx {
Radek Krejcif16e2542021-02-17 15:39:23 +010071 const struct lysc_ext_instance *ext; /**< extension instance possibly changing document root context of the data being parsed */
Michal Vaskoe0665742021-02-11 11:08:44 +010072 uint32_t parse_opts; /**< various @ref dataparseroptions. */
73 uint32_t val_opts; /**< various @ref datavalidationoptions. */
74 uint32_t int_opts; /**< internal parser options */
Radek Krejci1798aae2020-07-14 13:26:06 +020075 uint32_t path_len; /**< used bytes in the path buffer */
Michal Vasko26bbb272022-08-02 14:54:33 +020076
Radek Krejci1798aae2020-07-14 13:26:06 +020077#define LYD_PARSER_BUFSIZE 4078
78 char path[LYD_PARSER_BUFSIZE]; /**< buffer for the generated path */
Michal Vaskoc43c8ab2021-03-05 13:32:44 +010079 struct ly_set node_when; /**< set of nodes with "when" conditions */
Michal Vasko32711382020-12-03 14:14:31 +010080 struct ly_set node_types; /**< set of nodes validated with LY_EINCOMPLETE result */
81 struct ly_set meta_types; /**< set of metadata validated with LY_EINCOMPLETE result */
Michal Vasko135719f2022-08-25 12:18:17 +020082 struct ly_set ext_node; /**< set of nodes with extension instances to validate */
83 struct ly_set ext_val; /**< set of nested subtrees parsed by extensions to validate */
Radek Krejci1798aae2020-07-14 13:26:06 +020084 struct lyd_node *op_node; /**< if an RPC/action/notification is being parsed, store the pointer to it */
85
86 /* callbacks */
Radek Krejci0bff0b12020-08-15 18:37:50 +020087 lyd_ctx_free_clb free; /**< destructor */
Radek Krejci1798aae2020-07-14 13:26:06 +020088
89 struct {
Radek Krejci0bff0b12020-08-15 18:37:50 +020090 const struct ly_ctx *ctx; /**< libyang context */
91 uint64_t line; /**< current line */
92 struct ly_in *in; /**< input structure */
93 } *data_ctx; /**< generic pointer supposed to map to and access (common part of) XML/JSON/... parser contexts */
Radek Krejci1798aae2020-07-14 13:26:06 +020094};
95
Radek Krejci7931b192020-06-25 17:05:03 +020096/**
Michal Vasko03fbaed2021-07-15 09:18:32 +020097 * @brief Internal context for XML data parser.
98 */
99struct lyd_xml_ctx {
100 const struct lysc_ext_instance *ext;
101 uint32_t parse_opts;
102 uint32_t val_opts;
103 uint32_t int_opts;
104 uint32_t path_len;
105 char path[LYD_PARSER_BUFSIZE];
106 struct ly_set node_when;
Michal Vasko03fbaed2021-07-15 09:18:32 +0200107 struct ly_set node_types;
108 struct ly_set meta_types;
Michal Vasko135719f2022-08-25 12:18:17 +0200109 struct ly_set ext_node;
Michal Vaskoddd76592022-01-17 13:34:48 +0100110 struct ly_set ext_val;
Michal Vasko03fbaed2021-07-15 09:18:32 +0200111 struct lyd_node *op_node;
112
113 /* callbacks */
114 lyd_ctx_free_clb free;
115
116 struct lyxml_ctx *xmlctx; /**< XML context */
117};
118
119/**
120 * @brief Internal context for JSON data parser.
121 */
122struct lyd_json_ctx {
123 const struct lysc_ext_instance *ext;
124 uint32_t parse_opts;
125 uint32_t val_opts;
126 uint32_t int_opts;
127 uint32_t path_len;
128 char path[LYD_PARSER_BUFSIZE];
129 struct ly_set node_when;
Michal Vasko03fbaed2021-07-15 09:18:32 +0200130 struct ly_set node_types;
131 struct ly_set meta_types;
Michal Vasko135719f2022-08-25 12:18:17 +0200132 struct ly_set ext_node;
Michal Vaskoddd76592022-01-17 13:34:48 +0100133 struct ly_set ext_val;
Michal Vasko03fbaed2021-07-15 09:18:32 +0200134 struct lyd_node *op_node;
135
136 /* callbacks */
137 lyd_ctx_free_clb free;
138
Michal Vasko80623c52023-04-28 14:22:06 +0200139 struct lyjson_ctx *jsonctx; /**< JSON context */
140 const struct lysc_node *any_schema; /**< parent anyxml/anydata schema node if parsing nested data tree */
Michal Vasko03fbaed2021-07-15 09:18:32 +0200141};
142
143/**
144 * @brief Internal context for LYB data parser/printer.
145 */
146struct lyd_lyb_ctx {
147 const struct lysc_ext_instance *ext;
Michal Vasko26bbb272022-08-02 14:54:33 +0200148
Michal Vasko03fbaed2021-07-15 09:18:32 +0200149 union {
150 struct {
151 uint32_t parse_opts;
152 uint32_t val_opts;
153 };
154 uint32_t print_options;
155 };
156 uint32_t int_opts;
157 uint32_t path_len;
158 char path[LYD_PARSER_BUFSIZE];
159 struct ly_set node_when;
Michal Vasko03fbaed2021-07-15 09:18:32 +0200160 struct ly_set node_types;
161 struct ly_set meta_types;
Michal Vasko135719f2022-08-25 12:18:17 +0200162 struct ly_set ext_node;
Michal Vaskoddd76592022-01-17 13:34:48 +0100163 struct ly_set ext_val;
Michal Vasko03fbaed2021-07-15 09:18:32 +0200164 struct lyd_node *op_node;
165
166 /* callbacks */
167 lyd_ctx_free_clb free;
168
169 struct lylyb_ctx *lybctx; /* LYB context */
170};
171
172/**
Michal Vaskoddd76592022-01-17 13:34:48 +0100173 * @brief Parsed extension instance data to validate.
174 */
175struct lyd_ctx_ext_val {
176 struct lysc_ext_instance *ext;
177 struct lyd_node *sibling;
178};
179
180/**
Michal Vasko135719f2022-08-25 12:18:17 +0200181 * @brief Parsed data node with extension instance to validate.
182 */
183struct lyd_ctx_ext_node {
184 struct lysc_ext_instance *ext;
185 struct lyd_node *node;
186};
187
188/**
Radek Krejci84d7fd72021-07-14 18:32:21 +0200189 * @brief Common part to supplement the specific ::lyd_ctx_free_clb callbacks.
Radek Krejci1798aae2020-07-14 13:26:06 +0200190 */
Michal Vaskoddd76592022-01-17 13:34:48 +0100191void lyd_ctx_free(struct lyd_ctx *ctx);
Radek Krejci1798aae2020-07-14 13:26:06 +0200192
193/**
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200194 * @brief Parse submodule from YANG data.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200195 * @param[in,out] context Parser context.
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200196 * @param[in] ly_ctx Context of YANG schemas.
197 * @param[in] main_ctx Parser context of main module.
Michal Vasko63f3d842020-07-08 10:10:14 +0200198 * @param[in] in Input structure.
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200199 * @param[out] submod Pointer to the parsed submodule structure.
200 * @return LY_ERR value - LY_SUCCESS, LY_EINVAL or LY_EVALID.
201 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200202LY_ERR yang_parse_submodule(struct lysp_yang_ctx **context, struct ly_ctx *ly_ctx, struct lysp_ctx *main_ctx,
Radek Krejci0f969882020-08-21 16:56:47 +0200203 struct ly_in *in, struct lysp_submodule **submod);
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200204
205/**
206 * @brief Parse module from YANG data.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200207 * @param[in] context Parser context.
Michal Vasko63f3d842020-07-08 10:10:14 +0200208 * @param[in] in Input structure.
209 * @param[in,out] mod Prepared module structure where the parsed information, including the parsed
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200210 * module structure, will be filled in.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100211 * @return LY_ERR values.
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200212 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200213LY_ERR yang_parse_module(struct lysp_yang_ctx **context, struct ly_in *in, struct lys_module *mod);
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200214
215/**
216 * @brief Parse module from YIN data.
217 *
218 * @param[in,out] yin_ctx Context created during parsing, is used to finalize lysp_model after it's completly parsed.
Michal Vasko63f3d842020-07-08 10:10:14 +0200219 * @param[in] in Input structure.
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200220 * @param[in,out] mod Prepared module structure where the parsed information, including the parsed
221 * module structure, will be filled in.
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200222 * @return LY_ERR values.
223 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200224LY_ERR yin_parse_module(struct lysp_yin_ctx **yin_ctx, struct ly_in *in, struct lys_module *mod);
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200225
226/**
227 * @brief Parse submodule from YIN data.
228 *
229 * @param[in,out] yin_ctx Context created during parsing, is used to finalize lysp_model after it's completly parsed.
230 * @param[in] ctx Libyang context.
231 * @param[in] main_ctx Parser context of main module.
Michal Vasko63f3d842020-07-08 10:10:14 +0200232 * @param[in] in Input structure.
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200233 * @param[in,out] submod Submodule structure where the parsed information, will be filled in.
234 * @return LY_ERR values.
235 */
Michal Vaskod0625d72022-10-06 15:02:50 +0200236LY_ERR yin_parse_submodule(struct lysp_yin_ctx **yin_ctx, struct ly_ctx *ctx, struct lysp_ctx *main_ctx,
Radek Krejci0f969882020-08-21 16:56:47 +0200237 struct ly_in *in, struct lysp_submodule **submod);
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200238
Radek Krejci1798aae2020-07-14 13:26:06 +0200239/**
Michal Vaskoe0665742021-02-11 11:08:44 +0100240 * @brief Parse XML string as a YANG data tree.
Michal Vaskoafac7822020-10-20 14:22:26 +0200241 *
Michal Vaskoe0665742021-02-11 11:08:44 +0100242 * @param[in] ctx libyang context.
aPiecekb0445f22021-06-24 11:34:07 +0200243 * @param[in] ext Optional extension instance to parse data following the schema tree specified in the extension instance
Michal Vaskoe0665742021-02-11 11:08:44 +0100244 * @param[in] parent Parent to connect the parsed nodes to, if any.
245 * @param[in,out] first_p Pointer to the first top-level parsed node, used only if @p parent is NULL.
Michal Vaskoafac7822020-10-20 14:22:26 +0200246 * @param[in] in Input structure.
Michal Vaskoe0665742021-02-11 11:08:44 +0100247 * @param[in] parse_opts Options for parser, see @ref dataparseroptions.
248 * @param[in] val_opts Options for the validation phase, see @ref datavalidationoptions.
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +0100249 * @param[in] int_opts Internal data parser options.
Michal Vaskoe0665742021-02-11 11:08:44 +0100250 * @param[out] parsed Set to add all the parsed siblings into.
Michal Vaskoddd76592022-01-17 13:34:48 +0100251 * @param[out] subtree_sibling Set if ::LYD_PARSE_SUBTREE is used and another subtree is following in @p in.
Michal Vaskoafac7822020-10-20 14:22:26 +0200252 * @param[out] lydctx_p Data parser context to finish validation.
253 * @return LY_ERR value.
254 */
Radek Krejcif16e2542021-02-17 15:39:23 +0100255LY_ERR lyd_parse_xml(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +0100256 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, uint32_t int_opts,
257 struct ly_set *parsed, ly_bool *subtree_sibling, struct lyd_ctx **lydctx_p);
258
259/**
260 * @brief Parse XML string as a NETCONF message.
261 *
262 * @param[in] ctx libyang context.
263 * @param[in] ext Optional extension instance to parse data following the schema tree specified in the extension instance
264 * @param[in] parent Parent to connect the parsed nodes to, if any.
265 * @param[in,out] first_p Pointer to the first top-level parsed node, used only if @p parent is NULL.
266 * @param[in] in Input structure.
267 * @param[in] parse_opts Options for parser, see @ref dataparseroptions.
268 * @param[in] val_opts Options for the validation phase, see @ref datavalidationoptions.
269 * @param[in] data_type Expected NETCONF data type of the data.
270 * @param[out] envp Individual parsed envelopes tree, may be returned possibly even on an error.
271 * @param[out] parsed Set to add all the parsed siblings into.
272 * @param[out] subtree_sibling Set if ::LYD_PARSE_SUBTREE is used and another subtree is following in @p in.
273 * @param[out] lydctx_p Data parser context to finish validation.
274 * @return LY_ERR value.
275 */
276LY_ERR lyd_parse_xml_netconf(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
Radek Krejcif16e2542021-02-17 15:39:23 +0100277 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, enum lyd_type data_type,
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +0100278 struct lyd_node **envp, struct ly_set *parsed, struct lyd_ctx **lydctx_p);
Michal Vaskoafac7822020-10-20 14:22:26 +0200279
280/**
Michal Vaskoe0665742021-02-11 11:08:44 +0100281 * @brief Parse JSON string as a YANG data tree.
Michal Vaskoafac7822020-10-20 14:22:26 +0200282 *
Michal Vaskoafac7822020-10-20 14:22:26 +0200283 * @param[in] ctx libyang context.
aPiecekb0445f22021-06-24 11:34:07 +0200284 * @param[in] ext Optional extension instance to parse data following the schema tree specified in the extension instance
Michal Vaskoe0665742021-02-11 11:08:44 +0100285 * @param[in] parent Parent to connect the parsed nodes to, if any.
286 * @param[in,out] first_p Pointer to the first top-level parsed node, used only if @p parent is NULL.
Michal Vaskoafac7822020-10-20 14:22:26 +0200287 * @param[in] in Input structure.
Michal Vaskoe0665742021-02-11 11:08:44 +0100288 * @param[in] parse_opts Options for parser, see @ref dataparseroptions.
289 * @param[in] val_opts Options for the validation phase, see @ref datavalidationoptions.
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +0100290 * @param[in] int_opts Internal data parser options.
Michal Vaskoe0665742021-02-11 11:08:44 +0100291 * @param[out] parsed Set to add all the parsed siblings into.
Michal Vaskoddd76592022-01-17 13:34:48 +0100292 * @param[out] subtree_sibling Set if ::LYD_PARSE_SUBTREE is used and another subtree is following in @p in.
Michal Vaskoafac7822020-10-20 14:22:26 +0200293 * @param[out] lydctx_p Data parser context to finish validation.
294 * @return LY_ERR value.
295 */
Radek Krejcif16e2542021-02-17 15:39:23 +0100296LY_ERR lyd_parse_json(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +0100297 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, uint32_t int_opts,
Michal Vaskoddd76592022-01-17 13:34:48 +0100298 struct ly_set *parsed, ly_bool *subtree_sibling, struct lyd_ctx **lydctx_p);
Michal Vaskoafac7822020-10-20 14:22:26 +0200299
300/**
Michal Vasko820efe82023-05-12 15:47:43 +0200301 * @brief Parse JSON string as a RESTCONF message.
302 *
303 * @param[in] ctx libyang context.
304 * @param[in] ext Optional extension instance to parse data following the schema tree specified in the extension instance
305 * @param[in] parent Parent to connect the parsed nodes to, if any.
306 * @param[in,out] first_p Pointer to the first top-level parsed node, used only if @p parent is NULL.
307 * @param[in] in Input structure.
308 * @param[in] parse_opts Options for parser, see @ref dataparseroptions.
309 * @param[in] val_opts Options for the validation phase, see @ref datavalidationoptions.
310 * @param[in] data_type Expected RESTCONF data type of the data.
311 * @param[out] envp Individual parsed envelopes tree, may be returned possibly even on an error.
312 * @param[out] parsed Set to add all the parsed siblings into.
313 * @param[out] subtree_sibling Set if ::LYD_PARSE_SUBTREE is used and another subtree is following in @p in.
314 * @param[out] lydctx_p Data parser context to finish validation.
315 * @return LY_ERR value.
316 */
317LY_ERR lyd_parse_json_restconf(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
318 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, enum lyd_type data_type,
319 struct lyd_node **envp, struct ly_set *parsed, struct lyd_ctx **lydctx_p);
320
321/**
Michal Vaskoe0665742021-02-11 11:08:44 +0100322 * @brief Parse binary LYB data as a YANG data tree.
Michal Vaskoafac7822020-10-20 14:22:26 +0200323 *
Michal Vaskoafac7822020-10-20 14:22:26 +0200324 * @param[in] ctx libyang context.
aPiecekb0445f22021-06-24 11:34:07 +0200325 * @param[in] ext Optional extension instance to parse data following the schema tree specified in the extension instance
Michal Vaskoe0665742021-02-11 11:08:44 +0100326 * @param[in] parent Parent to connect the parsed nodes to, if any.
327 * @param[in,out] first_p Pointer to the first top-level parsed node, used only if @p parent is NULL.
Michal Vaskoafac7822020-10-20 14:22:26 +0200328 * @param[in] in Input structure.
Michal Vaskoe0665742021-02-11 11:08:44 +0100329 * @param[in] parse_opts Options for parser, see @ref dataparseroptions.
330 * @param[in] val_opts Options for the validation phase, see @ref datavalidationoptions.
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +0100331 * @param[in] int_opts Internal data parser options.
Michal Vaskoe0665742021-02-11 11:08:44 +0100332 * @param[out] parsed Set to add all the parsed siblings into.
Michal Vaskoddd76592022-01-17 13:34:48 +0100333 * @param[out] subtree_sibling Set if ::LYD_PARSE_SUBTREE is used and another subtree is following in @p in.
Michal Vaskoafac7822020-10-20 14:22:26 +0200334 * @param[out] lydctx_p Data parser context to finish validation.
335 * @return LY_ERR value.
336 */
Radek Krejcif16e2542021-02-17 15:39:23 +0100337LY_ERR lyd_parse_lyb(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +0100338 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, uint32_t int_opts,
Michal Vaskoddd76592022-01-17 13:34:48 +0100339 struct ly_set *parsed, ly_bool *subtree_sibling, struct lyd_ctx **lydctx_p);
Michal Vaskoafac7822020-10-20 14:22:26 +0200340
341/**
Michal Vasko820efe82023-05-12 15:47:43 +0200342 * @brief Validate eventTime date-and-time value.
343 *
344 * @param[in] node Opaque eventTime node.
345 * @return LY_SUCCESS on success.
346 * @return LY_ERR value on error.
347 */
348LY_ERR lyd_parser_notif_eventtime_validate(const struct lyd_node *node);
349
350/**
Michal Vaskoe0665742021-02-11 11:08:44 +0100351 * @brief Search all the parents for an operation node, check validity based on internal parser flags.
Michal Vaskoafac7822020-10-20 14:22:26 +0200352 *
Michal Vaskoe0665742021-02-11 11:08:44 +0100353 * @param[in] parent Parent to connect the parsed nodes to.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200354 * @param[in] int_opts Internal parser options.
Michal Vaskoe0665742021-02-11 11:08:44 +0100355 * @param[out] op Found operation, if any.
Michal Vaskoafac7822020-10-20 14:22:26 +0200356 * @return LY_ERR value.
357 */
Michal Vaskoe0665742021-02-11 11:08:44 +0100358LY_ERR lyd_parser_find_operation(const struct lyd_node *parent, uint32_t int_opts, struct lyd_node **op);
Michal Vaskoafac7822020-10-20 14:22:26 +0200359
360/**
Radek Krejci1798aae2020-07-14 13:26:06 +0200361 * @brief Check that a data node representing the @p snode is suitable based on options.
362 *
363 * @param[in] lydctx Common data parsers context.
364 * @param[in] snode Schema node to check.
365 * @return LY_SUCCESS or LY_EVALID
366 */
367LY_ERR lyd_parser_check_schema(struct lyd_ctx *lydctx, const struct lysc_node *snode);
368
369/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200370 * @brief Wrapper around ::lyd_create_term() for data parsers.
Radek Krejci1798aae2020-07-14 13:26:06 +0200371 *
372 * @param[in] lydctx Data parser context.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200373 * @param[in] schema Schema node of the new data node.
374 * @param[in] value String value to be parsed.
375 * @param[in] value_len Length of @p value, must be set correctly.
376 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
377 * @param[in] format Input format of @p value.
378 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
379 * @param[in] hints [Data parser's hints](@ref lydvalhints) for the value's type.
380 * @param[out] node Created node.
381 * @return LY_SUCCESS on success.
382 * @return LY_EINCOMPLETE in case data tree is needed to finish the validation.
383 * @return LY_ERR value if an error occurred.
Radek Krejci1798aae2020-07-14 13:26:06 +0200384 */
Radek Krejci09c77442021-04-26 11:10:34 +0200385LY_ERR lyd_parser_create_term(struct lyd_ctx *lydctx, const struct lysc_node *schema, const void *value, size_t value_len,
Radek Krejci8df109d2021-04-23 12:19:08 +0200386 ly_bool *dynamic, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints, struct lyd_node **node);
Radek Krejci1798aae2020-07-14 13:26:06 +0200387
388/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200389 * @brief Wrapper around ::lyd_create_meta() for data parsers.
Radek Krejci1798aae2020-07-14 13:26:06 +0200390 *
391 * @param[in] lydctx Data parser context.
Michal Vaskob68571a2020-11-06 17:18:41 +0100392 * @param[in] parent Parent of the created meta. Must be set if @p meta is NULL.
393 * @param[in,out] meta First existing meta to connect to or empty pointer to set. Must be set if @p parent is NULL.
394 * @param[in] mod Module of the created metadata.
395 * @param[in] name Metadata name.
396 * @param[in] name_len Length of @p name.
397 * @param[in] value Metadata value.
398 * @param[in] value_len Length of @p value.
399 * @param[in,out] dynamic Whether the @p value is dynamically allocated, is adjusted once the value is assigned.
400 * @param[in] format Prefix format.
401 * @param[in] prefix_data Prefix format data (see ::ly_resolve_prefix()).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200402 * @param[in] hints [Value hint](@ref lydvalhints) from the parser regarding the value type.
Michal Vaskoddd76592022-01-17 13:34:48 +0100403 * @param[in] ctx_node Value context node.
Michal Vaskob68571a2020-11-06 17:18:41 +0100404 * @return LY_ERR value.
Radek Krejci1798aae2020-07-14 13:26:06 +0200405 */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200406LY_ERR lyd_parser_create_meta(struct lyd_ctx *lydctx, struct lyd_node *parent, struct lyd_meta **meta,
Michal Vaskoddd76592022-01-17 13:34:48 +0100407 const struct lys_module *mod, const char *name, size_t name_len, const void *value, size_t value_len,
408 ly_bool *dynamic, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints, const struct lysc_node *ctx_node);
Radek Krejci1798aae2020-07-14 13:26:06 +0200409
Michal Vasko95c6d5c2022-05-20 10:33:39 +0200410/**
411 * @brief Check that a list has all its keys.
412 *
413 * @param[in] node List to check.
414 * @return LY_SUCCESS on success.
415 * @return LY_ENOT on a missing key.
416 */
417LY_ERR lyd_parse_check_keys(struct lyd_node *node);
418
419/**
420 * @brief Set data flags for a newly parsed node.
421 *
422 * @param[in] node Node to use.
423 * @param[in,out] meta Node metadata, may be removed from.
424 * @param[in] lydctx Data parsing context.
425 * @param[in] ext Extension instance if @p node was parsed for one.
426 * @return LY_ERR value.
427 */
428LY_ERR lyd_parse_set_data_flags(struct lyd_node *node, struct lyd_meta **meta, struct lyd_ctx *lydctx,
429 struct lysc_ext_instance *ext);
430
Michal Vasko193dacd2022-10-13 08:43:05 +0200431/**
432 * @brief Parse an instance extension statement.
433 *
434 * @param[in] pctx Parse context.
435 * @param[in] substmt Parsed ext instance substatement info.
436 * @param[in] stmt Parsed generic statement to process.
437 * @return LY_ERR value.
438 */
439LY_ERR lys_parse_ext_instance_stmt(struct lysp_ctx *pctx, struct lysp_ext_substmt *substmt, struct lysp_stmt *stmt);
440
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200441#endif /* LY_PARSER_INTERNAL_H_ */