libyang 3.4.2
libyang is YANG data modelling language parser and toolkit written (and providing API) in C.
Loading...
Searching...
No Matches
parser_data.h
Go to the documentation of this file.
1
16#ifndef LY_PARSER_DATA_H_
17#define LY_PARSER_DATA_H_
18
19#include "tree_data.h"
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25struct ly_in;
26
139/* note: keep the lower 16bits free for use by LYD_VALIDATE_ flags. They are not supposed to be combined together,
140 * but since they are used (as a separate parameter) together in some functions, we want to keep them in a separated
141 * range to be able detect that the caller put wrong flags into the parser/validate options parameter. */
142#define LYD_PARSE_ONLY 0x010000
147#define LYD_PARSE_STRICT 0x020000
149#define LYD_PARSE_OPAQ 0x040000
151#define LYD_PARSE_NO_STATE 0x080000
152#define LYD_PARSE_LYB_MOD_UPDATE 0x100000
155#define LYD_PARSE_ORDERED 0x200000
161#define LYD_PARSE_SUBTREE 0x400000
169#define LYD_PARSE_WHEN_TRUE 0x800000
172#define LYD_PARSE_NO_NEW 0x1000000
175#define LYD_PARSE_STORE_ONLY 0x2010000
179#define LYD_PARSE_JSON_NULL 0x4000000
183#define LYD_PARSE_OPTS_MASK 0xFFFF0000
210#define LYD_VALIDATE_NO_STATE 0x0001
212#define LYD_VALIDATE_PRESENT 0x0002
213#define LYD_VALIDATE_MULTI_ERROR 0x0004
214#define LYD_VALIDATE_OPERATIONAL 0x0008
216#define LYD_VALIDATE_NO_DEFAULTS 0x0010
219#define LYD_VALIDATE_NOT_FINAL 0x0020
223#define LYD_VALIDATE_OPTS_MASK 0x0000FFFF
246LIBYANG_API_DECL LY_ERR lyd_parse_data(const struct ly_ctx *ctx, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format,
247 uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree);
248
263LIBYANG_API_DECL LY_ERR lyd_parse_data_mem(const struct ly_ctx *ctx, const char *data, LYD_FORMAT format, uint32_t parse_options,
264 uint32_t validate_options, struct lyd_node **tree);
265
281LIBYANG_API_DECL LY_ERR lyd_parse_data_fd(const struct ly_ctx *ctx, int fd, LYD_FORMAT format, uint32_t parse_options,
282 uint32_t validate_options, struct lyd_node **tree);
283
298LIBYANG_API_DECL LY_ERR lyd_parse_data_path(const struct ly_ctx *ctx, const char *path, LYD_FORMAT format,
299 uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree);
300
320LIBYANG_API_DECL LY_ERR lyd_parse_ext_data(const struct lysc_ext_instance *ext, struct lyd_node *parent, struct ly_in *in,
321 LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree);
322
335 LYD_TYPE_DATA_YANG = 0, /* generic YANG instance data */
336 LYD_TYPE_RPC_YANG, /* instance of a YANG RPC/action request with only "input" data children,
337 including all parents and optional top-level "action" element in case of an action */
338 LYD_TYPE_NOTIF_YANG, /* instance of a YANG notification, including all parents in case of a nested one */
339 LYD_TYPE_REPLY_YANG, /* instance of a YANG RPC/action reply with only "output" data children,
340 including all parents in case of an action */
341
342 LYD_TYPE_RPC_NETCONF, /* complete NETCONF RPC invocation as defined for
343 [RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
344 [action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */
345 LYD_TYPE_NOTIF_NETCONF, /* complete NETCONF notification message as defined for
346 [notification](https://tools.ietf.org/html/rfc7950#section-7.16.2) */
347 LYD_TYPE_REPLY_NETCONF, /* complete NETCONF RPC reply as defined for
348 [RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
349 [action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */
350
351 LYD_TYPE_RPC_RESTCONF, /* message-body of a RESTCONF operation input parameters
352 ([ref](https://www.rfc-editor.org/rfc/rfc8040.html#section-3.6.1)) */
353 LYD_TYPE_NOTIF_RESTCONF, /* RESTCONF JSON notification data
354 ([ref](https://www.rfc-editor.org/rfc/rfc8040.html#section-6.4)), to parse
355 a notification in XML, use ::LYD_TYPE_NOTIF_NETCONF */
356 LYD_TYPE_REPLY_RESTCONF /* message-body of a RESTCONF operation output parameters
357 ([ref](https://www.rfc-editor.org/rfc/rfc8040.html#section-3.6.2)) */
422LIBYANG_API_DECL LY_ERR lyd_parse_op(const struct ly_ctx *ctx, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format,
423 enum lyd_type data_type, struct lyd_node **tree, struct lyd_node **op);
424
465LIBYANG_API_DECL LY_ERR lyd_parse_ext_op(const struct lysc_ext_instance *ext, struct lyd_node *parent, struct ly_in *in,
466 LYD_FORMAT format, enum lyd_type data_type, struct lyd_node **tree, struct lyd_node **op);
467
481LIBYANG_API_DECL LY_ERR lyd_validate_all(struct lyd_node **tree, const struct ly_ctx *ctx, uint32_t val_opts,
482 struct lyd_node **diff);
483
501LIBYANG_API_DECL LY_ERR lyd_validate_module(struct lyd_node **tree, const struct lys_module *module, uint32_t val_opts,
502 struct lyd_node **diff);
503
515LIBYANG_API_DECL LY_ERR lyd_validate_module_final(struct lyd_node *tree, const struct lys_module *module,
516 uint32_t val_opts);
517
530LIBYANG_API_DECL LY_ERR lyd_validate_op(struct lyd_node *op_tree, const struct lyd_node *dep_tree, enum lyd_type data_type,
531 struct lyd_node **diff);
532
535#ifdef __cplusplus
536}
537#endif
538
539#endif /* LY_PARSER_DATA_H_ */
libyang context handler.
LIBYANG_API_DECL LY_ERR lyd_parse_ext_data(const struct lysc_ext_instance *ext, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree)
Parse (and validate) data from the input handler as an extension data tree following the schema tree ...
LIBYANG_API_DECL LY_ERR lyd_parse_op(const struct ly_ctx *ctx, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format, enum lyd_type data_type, struct lyd_node **tree, struct lyd_node **op)
Parse YANG data into an operation data tree. Specific parsing flags LYD_PARSE_ONLY,...
LIBYANG_API_DECL LY_ERR lyd_parse_data(const struct ly_ctx *ctx, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree)
Parse (and validate) data from the input handler as a YANG data tree.
LIBYANG_API_DECL LY_ERR lyd_validate_all(struct lyd_node **tree, const struct ly_ctx *ctx, uint32_t val_opts, struct lyd_node **diff)
Fully validate a data tree.
LIBYANG_API_DECL LY_ERR lyd_validate_module_final(struct lyd_node *tree, const struct lys_module *module, uint32_t val_opts)
Finish validation of a module data that have previously been validated with LYD_VALIDATE_NOT_FINAL fl...
LYD_FORMAT
Data input/output formats supported by libyang parser and printer functions.
Definition tree_data.h:544
LIBYANG_API_DECL LY_ERR lyd_validate_op(struct lyd_node *op_tree, const struct lyd_node *dep_tree, enum lyd_type data_type, struct lyd_node **diff)
Validate an RPC/action request, reply, or notification. Only the operation data tree (input/output/no...
LIBYANG_API_DECL LY_ERR lyd_validate_module(struct lyd_node **tree, const struct lys_module *module, uint32_t val_opts, struct lyd_node **diff)
Fully validate a data tree of a module.
LIBYANG_API_DECL LY_ERR lyd_parse_data_fd(const struct ly_ctx *ctx, int fd, LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree)
Parse (and validate) input data as a YANG data tree.
LIBYANG_API_DECL LY_ERR lyd_parse_ext_op(const struct lysc_ext_instance *ext, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format, enum lyd_type data_type, struct lyd_node **tree, struct lyd_node **op)
Parse extension data into an operation data tree following only the specification from the given exte...
LIBYANG_API_DECL LY_ERR lyd_parse_data_path(const struct ly_ctx *ctx, const char *path, LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree)
Parse (and validate) input data as a YANG data tree.
LIBYANG_API_DECL LY_ERR lyd_parse_data_mem(const struct ly_ctx *ctx, const char *data, LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree)
Parse (and validate) input data as a YANG data tree.
lyd_type
@ LYD_TYPE_REPLY_RESTCONF
@ LYD_TYPE_NOTIF_RESTCONF
@ LYD_TYPE_DATA_YANG
@ LYD_TYPE_NOTIF_YANG
@ LYD_TYPE_RPC_YANG
@ LYD_TYPE_REPLY_YANG
@ LYD_TYPE_REPLY_NETCONF
@ LYD_TYPE_NOTIF_NETCONF
@ LYD_TYPE_RPC_RESTCONF
@ LYD_TYPE_RPC_NETCONF
LY_ERR
libyang's error codes returned by the libyang functions.
Definition log.h:237
YANG extension compiled instance.
Available YANG schema tree structures representing YANG module.
Parser input structure specifying where the data are read.
libyang representation of YANG data trees.
Generic structure for a data node.
Definition tree_data.h:799