libyang  2.0.194
libyang is YANG data modelling language parser and toolkit written (and providing API) in C.
parser_data.h
Go to the documentation of this file.
1 
15 #ifndef LY_PARSER_DATA_H_
16 #define LY_PARSER_DATA_H_
17 
18 #include "tree_data.h"
19 
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
24 struct ly_in;
25 
138 /* note: keep the lower 16bits free for use by LYD_VALIDATE_ flags. They are not supposed to be combined together,
139  * but since they are used (as a separate parameter) together in some functions, we want to keep them in a separated
140  * range to be able detect that the caller put wrong flags into the parser/validate options parameter. */
141 #define LYD_PARSE_ONLY 0x010000
144 #define LYD_PARSE_STRICT 0x020000
146 #define LYD_PARSE_OPAQ 0x040000
148 #define LYD_PARSE_NO_STATE 0x080000
150 #define LYD_PARSE_LYB_MOD_UPDATE 0x100000
153 #define LYD_PARSE_ORDERED 0x200000
159 #define LYD_PARSE_SUBTREE 0x400000
163 #define LYD_PARSE_OPTS_MASK 0xFFFF0000
190 #define LYD_VALIDATE_NO_STATE 0x0001
192 #define LYD_VALIDATE_PRESENT 0x0002
194 #define LYD_VALIDATE_OPTS_MASK 0x0000FFFF
211 LIBYANG_API_DECL LY_ERR lyd_parse_data(const struct ly_ctx *ctx, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format,
212  uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree);
213 
228 LIBYANG_API_DECL LY_ERR lyd_parse_data_mem(const struct ly_ctx *ctx, const char *data, LYD_FORMAT format, uint32_t parse_options,
229  uint32_t validate_options, struct lyd_node **tree);
230 
246 LIBYANG_API_DECL LY_ERR lyd_parse_data_fd(const struct ly_ctx *ctx, int fd, LYD_FORMAT format, uint32_t parse_options,
247  uint32_t validate_options, struct lyd_node **tree);
248 
263 LIBYANG_API_DECL LY_ERR lyd_parse_data_path(const struct ly_ctx *ctx, const char *path, LYD_FORMAT format,
264  uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree);
265 
285 LIBYANG_API_DECL LY_ERR lyd_parse_ext_data(const struct lysc_ext_instance *ext, struct lyd_node *parent, struct ly_in *in,
286  LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree);
287 
299 enum lyd_type {
300  LYD_TYPE_DATA_YANG = 0, /* generic YANG instance data */
301  LYD_TYPE_RPC_YANG, /* instance of a YANG RPC/action request with only "input" data children,
302  including all parents in case of an action */
303  LYD_TYPE_NOTIF_YANG, /* instance of a YANG notification , including all parents in case of a nested one */
304  LYD_TYPE_REPLY_YANG, /* instance of a YANG RPC/action reply with only "output" data children,
305  including all parents in case of an action */
306 
307  LYD_TYPE_RPC_NETCONF, /* complete NETCONF RPC invocation as defined for
308  [RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
309  [action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */
310  LYD_TYPE_NOTIF_NETCONF, /* complete NETCONF notification message as defined for
311  [notification](https://tools.ietf.org/html/rfc7950#section-7.16.2) */
312  LYD_TYPE_REPLY_NETCONF /* complete NETCONF RPC reply as defined for
313  [RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
314  [action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */
315 };
356 LIBYANG_API_DECL LY_ERR lyd_parse_op(const struct ly_ctx *ctx, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format,
357  enum lyd_type data_type, struct lyd_node **tree, struct lyd_node **op);
358 
399 LIBYANG_API_DECL LY_ERR lyd_parse_ext_op(const struct lysc_ext_instance *ext, struct lyd_node *parent, struct ly_in *in,
400  LYD_FORMAT format, enum lyd_type data_type, struct lyd_node **tree, struct lyd_node **op);
401 
415 LIBYANG_API_DECL LY_ERR lyd_validate_all(struct lyd_node **tree, const struct ly_ctx *ctx, uint32_t val_opts,
416  struct lyd_node **diff);
417 
431 LIBYANG_API_DECL LY_ERR lyd_validate_module(struct lyd_node **tree, const struct lys_module *module, uint32_t val_opts,
432  struct lyd_node **diff);
433 
446 LIBYANG_API_DECL LY_ERR lyd_validate_op(struct lyd_node *op_tree, const struct lyd_node *dep_tree, enum lyd_type data_type,
447  struct lyd_node **diff);
448 
451 #ifdef __cplusplus
452 }
453 #endif
454 
455 #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.
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.
LYD_FORMAT
Data input/output formats supported by libyang parser and printer functions.
Definition: tree_data.h:533
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
Definition: parser_data.h:299
@ LYD_TYPE_DATA_YANG
Definition: parser_data.h:300
@ LYD_TYPE_NOTIF_YANG
Definition: parser_data.h:303
@ LYD_TYPE_RPC_YANG
Definition: parser_data.h:301
@ LYD_TYPE_REPLY_YANG
Definition: parser_data.h:304
@ LYD_TYPE_REPLY_NETCONF
Definition: parser_data.h:312
@ LYD_TYPE_NOTIF_NETCONF
Definition: parser_data.h:310
@ LYD_TYPE_RPC_NETCONF
Definition: parser_data.h:307
LY_ERR
libyang's error codes returned by the libyang functions.
Definition: log.h:244
Available YANG schema tree structures representing YANG module.
Definition: tree_schema.h:2341
YANG extension instance.
Definition: tree_schema.h:1429
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:798