libyang  2.1.30
libyang is YANG data modelling language parser and toolkit written (and providing API) in C.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
plugins_exts.h
Go to the documentation of this file.
1 
16 #ifndef LY_PLUGINS_EXTS_H_
17 #define LY_PLUGINS_EXTS_H_
18 
19 #include "log.h"
20 #include "parser_data.h"
21 #include "plugins.h"
22 #include "tree_data.h"
23 #include "tree_edit.h"
24 #include "tree_schema.h"
25 
26 struct ly_ctx;
27 struct ly_in;
28 struct lyd_node;
29 struct lysc_ctx;
30 struct lysc_ext_substmt;
31 struct lysp_ctx;
32 struct lyspr_ctx;
33 struct lyspr_tree_ctx;
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
112 #define LYPLG_EXT_API_VERSION 6
113 
119 #define LY_STMT_OP_MASK (LY_STMT_ACTION | LY_STMT_RPC)
120 
126 #define LY_STMT_DATA_NODE_MASK (LY_STMT_ANYDATA | LY_STMT_ANYXML | LY_STMT_CASE | LY_STMT_CHOICE | LY_STMT_CONTAINER |\
127  LY_STMT_LEAF | LY_STMT_LEAF_LIST | LY_STMT_LIST)
128 
135 #define LY_STMT_NODE_MASK 0xFFFF
136 
143 enum ly_stmt {
145 
148  LY_STMT_INPUT = 0x0002,
150  LY_STMT_OUTPUT = 0x0004,
152  LY_STMT_ACTION = 0x0008,
154  LY_STMT_RPC = 0x0010,
156  LY_STMT_ANYDATA = 0x0020,
158  LY_STMT_ANYXML = 0x0040,
160  LY_STMT_AUGMENT = 0x0080,
163  LY_STMT_CASE = 0x0100,
165  LY_STMT_CHOICE = 0x0200,
167  LY_STMT_CONTAINER = 0x0400,
169  LY_STMT_GROUPING = 0x0800,
172  LY_STMT_LEAF = 0x1000,
174  LY_STMT_LEAF_LIST = 0x2000,
176  LY_STMT_LIST = 0x4000,
178  LY_STMT_USES = 0x8000,
181  LY_STMT_ARGUMENT = 0x10000,
185  LY_STMT_BASE = 0x20000,
188  LY_STMT_BELONGS_TO = 0x30000,
192  LY_STMT_BIT = 0x40000,
196  LY_STMT_CONFIG = 0x50000,
199  LY_STMT_CONTACT = 0x60000,
203  LY_STMT_DEFAULT = 0x70000,
209  LY_STMT_DEVIATE = 0x90000,
212  LY_STMT_DEVIATION = 0xA0000,
216  LY_STMT_ENUM = 0xB0000,
228  LY_STMT_EXTENSION = 0xE0000,
234  LY_STMT_FEATURE = 0x100000,
241  LY_STMT_IDENTITY = 0x120000,
245  LY_STMT_IF_FEATURE = 0x130000,
248  LY_STMT_IMPORT = 0x140000,
251  LY_STMT_INCLUDE = 0x150000,
254  LY_STMT_KEY = 0x160000,
258  LY_STMT_LENGTH = 0x170000,
260  LY_STMT_MANDATORY = 0x180000,
263  LY_STMT_MAX_ELEMENTS = 0x190000,
266  LY_STMT_MIN_ELEMENTS = 0x1A0000,
269  LY_STMT_MODIFIER = 0x1B0000,
273  LY_STMT_MODULE = 0x1C0000,
276  LY_STMT_MUST = 0x1D0000,
280  LY_STMT_NAMESPACE = 0x1E0000,
284  LY_STMT_ORDERED_BY = 0x1F0000,
288  LY_STMT_ORGANIZATION = 0x200000,
292  LY_STMT_PATH = 0x210000,
296  LY_STMT_PATTERN = 0x220000,
300  LY_STMT_POSITION = 0x230000,
304  LY_STMT_PREFIX = 0x240000,
307  LY_STMT_PRESENCE = 0x250000,
310  LY_STMT_RANGE = 0x260000,
312  LY_STMT_REFERENCE = 0x270000,
315  LY_STMT_REFINE = 0x280000,
323  LY_STMT_REVISION = 0x2A0000,
328  LY_STMT_STATUS = 0x2C0000,
331  LY_STMT_SUBMODULE = 0x2D0000,
334  LY_STMT_TYPE = 0x2E0000,
336  LY_STMT_TYPEDEF = 0x2F0000,
340  LY_STMT_UNIQUE = 0x300000,
343  LY_STMT_UNITS = 0x310000,
346  LY_STMT_VALUE = 0x320000,
350  LY_STMT_WHEN = 0x330000,
352  LY_STMT_YANG_VERSION = 0x340000,
356  LY_STMT_YIN_ELEMENT = 0x350000,
361  /* separated from the list of statements
362  * the following tokens are part of the syntax and parsers have to work
363  * with them, but they are not a standard YANG statements
364  */
368 
369  /*
370  * YIN-specific tokens, still they are part of the syntax, but not the standard statements
371  */
374 };
375 
379 struct lysp_stmt {
380  const char *stmt;
381  const char *arg;
383  void *prefix_data;
385  struct lysp_stmt *next;
386  struct lysp_stmt *child;
387  uint16_t flags;
388  enum ly_stmt kw;
389 };
390 
395  enum ly_stmt stmt;
396  void *storage;
398 };
399 
404  const char *name;
405  const char *argument;
407  void *prefix_data;
408  struct lysp_ext *def;
410  void *parent;
415  uint16_t flags;
417  const struct lyplg_ext_record *record;
420  void *parsed;
421  struct lysp_stmt *child;
422 };
423 
428  enum ly_stmt stmt;
429  void *storage;
431 };
432 
437  struct lysc_ext *def;
438  const char *argument;
439  struct lys_module *module;
442  void *parent;
450  void *compiled;
451 };
452 
459 #define LYPLG_EXTENSIONS \
460  uint32_t plugins_extensions_apiver__ = LYPLG_EXT_API_VERSION; \
461  const struct lyplg_ext_record plugins_extensions__[]
462 
483 typedef LY_ERR (*lyplg_ext_parse_clb)(struct lysp_ctx *pctx, struct lysp_ext_instance *ext);
484 
495 LIBYANG_API_DECL void lyplg_ext_parse_log(const struct lysp_ctx *pctx, const struct lysp_ext_instance *ext,
496  LY_LOG_LEVEL level, LY_ERR err_no, const char *format, ...);
497 
504 LIBYANG_API_DECL const struct lysp_module *lyplg_ext_parse_get_cur_pmod(const struct lysp_ctx *pctx);
505 
518 LIBYANG_API_DECL LY_ERR lyplg_ext_parse_extension_instance(struct lysp_ctx *pctx, struct lysp_ext_instance *ext);
519 
537 #define LYS_COMPILE_GROUPING 0x01
542 #define LYS_COMPILE_DISABLED 0x02
545 #define LYS_COMPILE_NO_CONFIG 0x04
546 #define LYS_COMPILE_NO_DISABLED 0x08
548 #define LYS_COMPILE_RPC_INPUT (LYS_IS_INPUT | LYS_COMPILE_NO_CONFIG)
549 #define LYS_COMPILE_RPC_OUTPUT (LYS_IS_OUTPUT | LYS_COMPILE_NO_CONFIG)
550 #define LYS_COMPILE_NOTIFICATION (LYS_IS_NOTIF | LYS_COMPILE_NO_CONFIG)
569 typedef LY_ERR (*lyplg_ext_compile_clb)(struct lysc_ctx *cctx, const struct lysp_ext_instance *extp,
570  struct lysc_ext_instance *ext);
571 
581 LIBYANG_API_DECL void lyplg_ext_compile_log(const struct lysc_ctx *cctx, const struct lysc_ext_instance *ext,
582  LY_LOG_LEVEL level, LY_ERR err_no, const char *format, ...);
583 
593 LIBYANG_API_DECL void lyplg_ext_compile_log_path(const char *path, const struct lysc_ext_instance *ext,
594  LY_LOG_LEVEL level, LY_ERR err_no, const char *format, ...);
595 
602 LIBYANG_API_DECL struct ly_ctx *lyplg_ext_compile_get_ctx(const struct lysc_ctx *ctx);
603 
610 LIBYANG_API_DECL uint32_t *lyplg_ext_compile_get_options(const struct lysc_ctx *ctx);
611 
618 LIBYANG_API_DECL const struct lys_module *lyplg_ext_compile_get_cur_mod(const struct lysc_ctx *ctx);
619 
626 LIBYANG_API_DECL struct lysp_module *lyplg_ext_compile_get_pmod(const struct lysc_ctx *ctx);
627 
643 LIBYANG_API_DECL LY_ERR lyplg_ext_compile_extension_instance(struct lysc_ctx *ctx, const struct lysp_ext_instance *extp,
644  struct lysc_ext_instance *ext);
645 
666 typedef LY_ERR (*lyplg_ext_sprinter_info_clb)(struct lyspr_ctx *ctx, struct lysc_ext_instance *ext, ly_bool *flag);
667 
675 LIBYANG_API_DECL struct ly_out **lyplg_ext_print_get_out(const struct lyspr_ctx *ctx);
676 
683 LIBYANG_API_DECL uint32_t *lyplg_ext_print_get_options(const struct lyspr_ctx *ctx);
684 
691 LIBYANG_API_DECL uint16_t *lyplg_ext_print_get_level(const struct lyspr_ctx *ctx);
692 
703 LIBYANG_API_DECL void lyplg_ext_print_info_extension_instance(struct lyspr_ctx *ctx, const struct lysc_ext_instance *ext,
704  ly_bool *flag);
705 
734 typedef LY_ERR (*lyplg_ext_sprinter_ctree_clb)(struct lysc_ext_instance *ext, const struct lyspr_tree_ctx *ctx,
735  const char **flags, const char **add_opts);
736 
749 typedef LY_ERR (*lyplg_ext_sprinter_ctree_override_clb)(const struct lysc_node *node, const void *plugin_priv,
750  ly_bool *skip, const char **flags, const char **add_opts);
751 
760 LIBYANG_API_DECL LY_ERR lyplg_ext_sprinter_ctree_add_ext_nodes(const struct lyspr_tree_ctx *ctx,
762 
771 LIBYANG_API_DECL LY_ERR lyplg_ext_sprinter_ctree_add_nodes(const struct lyspr_tree_ctx *ctx, struct lysc_node *nodes,
773 
782 LIBYANG_API_DECL LY_ERR lyplg_ext_sprinter_tree_set_priv(const struct lyspr_tree_ctx *ctx, void *plugin_priv,
783  void (*free_clb)(void *plugin_priv));
784 
788 typedef LY_ERR (*lyplg_ext_sprinter_ptree_clb)(struct lysp_ext_instance *ext, const struct lyspr_tree_ctx *ctx,
789  const char **flags, const char **add_opts);
790 
794 typedef LY_ERR (*lyplg_ext_sprinter_ptree_override_clb)(const struct lysp_node *node, const void *plugin_priv,
795  ly_bool *skip, const char **flags, const char **add_opts);
796 
800 LIBYANG_API_DECL LY_ERR lyplg_ext_sprinter_ptree_add_ext_nodes(const struct lyspr_tree_ctx *ctx,
802 
806 LIBYANG_API_DECL LY_ERR lyplg_ext_sprinter_ptree_add_nodes(const struct lyspr_tree_ctx *ctx, struct lysp_node *nodes,
808 
811 /*
812  * data node
813  */
814 
827 typedef LY_ERR (*lyplg_ext_data_node_clb)(struct lysc_ext_instance *ext, struct lyd_node *node, uint32_t validate_options);
828 
829 /*
830  * snode
831  */
832 
851 typedef LY_ERR (*lyplg_ext_data_snode_clb)(struct lysc_ext_instance *ext, const struct lyd_node *parent,
852  const struct lysc_node *sparent, const char *prefix, size_t prefix_len, LY_VALUE_FORMAT format, void *prefix_data,
853  const char *name, size_t name_len, const struct lysc_node **snode);
854 
855 /*
856  * validate
857  */
858 
874 typedef LY_ERR (*lyplg_ext_data_validate_clb)(struct lysc_ext_instance *ext, struct lyd_node *sibling,
875  const struct lyd_node *dep_tree, enum lyd_type data_type, uint32_t val_opts, struct lyd_node **diff);
876 
877 /*
878  * parse free
879  */
887 typedef void (*lyplg_ext_parse_free_clb)(const struct ly_ctx *ctx, struct lysp_ext_instance *ext);
888 
895 LIBYANG_API_DECL void lyplg_ext_pfree_instance_substatements(const struct ly_ctx *ctx, struct lysp_ext_substmt *substmts);
896 
897 /*
898  * compile free
899  */
900 
907 typedef void (*lyplg_ext_compile_free_clb)(const struct ly_ctx *ctx, struct lysc_ext_instance *ext);
908 
915 LIBYANG_API_DECL void lyplg_ext_cfree_instance_substatements(const struct ly_ctx *ctx, struct lysc_ext_substmt *substmts);
916 
920 struct lyplg_ext {
921  const char *id;
939 };
941 struct lyplg_ext_record {
942  /* plugin identification */
943  const char *module;
944  const char *revision;
949  const char *name;
951  /* runtime data */
952  struct lyplg_ext plugin;
953 };
954 
961 LIBYANG_API_DECL const char *lyplg_ext_stmt2str(enum ly_stmt stmt);
962 
969 LIBYANG_API_DECL enum ly_stmt lyplg_ext_nodetype2stmt(uint16_t nodetype);
970 
982 LIBYANG_API_DECL LY_ERR lyplg_ext_get_storage(const struct lysc_ext_instance *ext, int stmt, uint32_t storage_size,
983  const void **storage);
984 
996 LIBYANG_API_DECL LY_ERR lyplg_ext_parsed_get_storage(const struct lysc_ext_instance *ext, int stmt,
997  uint32_t storage_size, const void **storage);
998 
1009 LIBYANG_API_DECL LY_ERR lyplg_ext_get_data(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, void **ext_data,
1010  ly_bool *ext_data_free);
1011 
1020 LIBYANG_API_DECL LY_ERR lyplg_ext_insert(struct lyd_node *parent, struct lyd_node *first);
1021 
1029 LIBYANG_API_DECL LY_ERR lyplg_ext_schema_mount_get_parent_ref(const struct lysc_ext_instance *ext, struct ly_set **refs);
1030 
1040 LIBYANG_API_DECL LY_ERR lyplg_ext_schema_mount_create_context(const struct lysc_ext_instance *ext, struct ly_ctx **ctx);
1041 
1044 #ifdef __cplusplus
1045 }
1046 #endif
1047 
1048 #endif /* LY_PLUGINS_EXTS_H_ */
LIBYANG_API_DECL LY_ERR lyplg_ext_sprinter_tree_set_priv(const struct lyspr_tree_ctx *ctx, void *plugin_priv, void(*free_clb)(void *plugin_priv))
Registration of plugin-private data defined by the plugin that is shared between override_clb calls...
const char * module
Definition: plugins_exts.h:949
Printer output structure specifying where the data are printed.
Compiled YANG data node.
Definition: tree_schema.h:1414
LIBYANG_API_DECL void lyplg_ext_pfree_instance_substatements(const struct ly_ctx *ctx, struct lysp_ext_substmt *substmts)
Free the extension instance's data parsed with lyplg_ext_parse_extension_instance().
LY_ERR(* lyplg_ext_data_node_clb)(struct lysc_ext_instance *ext, struct lyd_node *node, uint32_t validate_options)
Callback called for all data nodes connected to the extension instance.
Definition: plugins_exts.h:833
LY_ERR(* lyplg_ext_sprinter_info_clb)(struct lyspr_ctx *ctx, struct lysc_ext_instance *ext, ly_bool *flag)
Callback to print the compiled extension instance's private data in the INFO format.
Definition: plugins_exts.h:672
struct ly_ctx * ctx
Definition: tree_schema.h:2098
LIBYANG_API_DECL LY_ERR lyplg_ext_sprinter_ctree_add_nodes(const struct lyspr_tree_ctx *ctx, struct lysc_node *nodes, lyplg_ext_sprinter_ctree_override_clb clb)
Registration of printing the group of nodes which were defined in the plugin.
const char * name
Definition: plugins_exts.h:955
struct lysp_stmt * next
Definition: plugins_exts.h:385
const char * revision
Definition: plugins_exts.h:950
lyplg_ext_sprinter_info_clb printer_info
Definition: plugins_exts.h:931
LIBYANG_API_DECL struct lysp_module * lyplg_ext_compile_get_pmod(const struct lysc_ctx *ctx)
YANG schema compilation context getter for currently processed module.
LY_ERR(* lyplg_ext_sprinter_ctree_override_clb)(const struct lysc_node *node, const void *plugin_priv, ly_bool *skip, const char **flags, const char **add_opts)
Callback for rewriting the tree-diagram form of a specific node.
Definition: plugins_exts.h:755
Extension plugin implementing various aspects of a YANG extension.
Definition: plugins_exts.h:926
enum ly_stmt kw
Definition: plugins_exts.h:388
Generic structure for a data node.
Definition: tree_data.h:781
Structure representing a compiled known YANG substatement in an extension instance.
Definition: plugins_exts.h:427
uint16_t flags
Definition: plugins_exts.h:387
LIBYANG_API_DECL struct ly_ctx * lyplg_ext_compile_get_ctx(const struct lysc_ctx *ctx)
YANG schema compilation context getter for libyang context.
YANG extension compiled instance.
Definition: plugins_exts.h:436
LIBYANG_API_DECL LY_ERR lyplg_ext_sprinter_ptree_add_ext_nodes(const struct lyspr_tree_ctx *ctx, struct lysp_ext_instance *ext, lyplg_ext_sprinter_ptree_override_clb clb)
Registration of printing a group of nodes, which is already in the extension.
void(* lyplg_ext_parse_free_clb)(const struct ly_ctx *ctx, struct lysp_ext_instance *ext)
Callback to free the extension-specific data created by its parsing.
Definition: plugins_exts.h:893
LY_ERR(* lyplg_ext_sprinter_ptree_override_clb)(const struct lysp_node *node, const void *plugin_priv, ly_bool *skip, const char **flags, const char **add_opts)
Callback for rewriting the tree-diagram form of a specific node.
Definition: plugins_exts.h:800
uint64_t parent_stmt_index
Definition: plugins_exts.h:445
lyplg_ext_parse_clb parse
Definition: plugins_exts.h:929
enum ly_stmt stmt
Definition: plugins_exts.h:395
uint8_t ly_bool
Type to indicate boolean value.
Definition: log.h:28
Compiled YANG extension-stmt.
Definition: tree_schema.h:1198
ly_stmt
List of YANG statements.
Definition: plugins_exts.h:143
Structure representing a parsed known YANG substatement in an extension instance. ...
Definition: plugins_exts.h:394
const char * stmt
Definition: plugins_exts.h:380
struct lysp_ext_substmt * substmts
Definition: plugins_exts.h:418
LY_ERR(* lyplg_ext_parse_clb)(struct lysp_ctx *pctx, struct lysp_ext_instance *ext)
Callback for parsing extension instance substatements.
Definition: plugins_exts.h:483
const char * name
Definition: tree_schema.h:1425
LIBYANG_API_DECL LY_ERR lyplg_ext_parse_extension_instance(struct lysp_ctx *pctx, struct lysp_ext_instance *ext)
Parse substatements of an extension instance.
LIBYANG_API_DECL void lyplg_ext_parse_log(const struct lysp_ctx *pctx, const struct lysp_ext_instance *ext, LY_LOG_LEVEL level, LY_ERR err_no, const char *format,...)
Log a message from an extension plugin using the parsed extension instance.
struct lysp_ext * def
Definition: plugins_exts.h:408
libyang representation of YANG schema trees.
struct lysc_ext_instance * exts
Definition: plugins_exts.h:440
lyplg_ext_sprinter_ptree_clb printer_ptree
Definition: plugins_exts.h:935
uint64_t parent_stmt_index
Definition: plugins_exts.h:413
LIBYANG_API_DECL struct lys_module * lyplg_ext_compile_get_cur_mod(const struct lysc_ctx *ctx)
YANG schema compilation context getter for current module.
LIBYANG_API_DECL uint16_t * lyplg_ext_print_get_level(const struct lyspr_ctx *ctx)
YANG printer context getter for printer indentation level.
struct lysc_ext_substmt * substmts
Definition: plugins_exts.h:448
lyplg_ext_data_validate_clb validate
Definition: plugins_exts.h:940
LIBYANG_API_DECL LY_ERR lyplg_ext_get_storage(const struct lysc_ext_instance *ext, int stmt, uint32_t storage_size, const void **storage)
Get compiled ext instance storage for a specific statement.
LY_ERR(* lyplg_ext_data_validate_clb)(struct lysc_ext_instance *ext, struct lyd_node *sibling, const struct lyd_node *dep_tree, enum lyd_type data_type, uint32_t val_opts, struct lyd_node **diff)
Callback for validating parsed YANG instance data described by an extension instance.
Definition: plugins_exts.h:880
struct lyd_node_inner * parent
Definition: tree_data.h:788
LIBYANG_API_DECL void lyplg_ext_compile_log_path(const char *path, const struct lysc_ext_instance *ext, LY_LOG_LEVEL level, LY_ERR err_no, const char *format,...)
Log a message from an extension plugin using the compiled extension instance with an explicit error p...
LIBYANG_API_DECL void lyplg_ext_print_info_extension_instance(struct lyspr_ctx *ctx, const struct lysc_ext_instance *ext, ly_bool *flag)
Print substatements of an extension instance in info format (compiled YANG).
enum ly_stmt parent_stmt
Definition: plugins_exts.h:412
struct lyplg_ext_record * record
Definition: plugins_exts.h:417
struct lysp_stmt * child
Definition: plugins_exts.h:421
Data parsers for libyang.
const char * id
Definition: plugins_exts.h:927
LY_ERR(* lyplg_ext_compile_clb)(struct lysc_ctx *cctx, const struct lysp_ext_instance *extp, struct lysc_ext_instance *ext)
Callback to compile extension from the lysp_ext_instance to the lysc_ext_instance. The later structure is generally prepared and only the extension specific data are supposed to be added (if any).
Definition: plugins_exts.h:575
libyang representation of YANG data trees.
LIBYANG_API_DECL LY_ERR lyplg_ext_schema_mount_create_context(const struct lysc_ext_instance *ext, struct ly_ctx **ctx)
Allocate a new context for a particular instance of the yangmnt:mount-point extension. Caller is responsible for destroying the resulting context.
const char * name
Definition: plugins_exts.h:404
LY_ERR(* lyplg_ext_sprinter_ptree_clb)(struct lysp_ext_instance *ext, const struct lyspr_tree_ctx *ctx, const char **flags, const char **add_opts)
Callback to print parent node of ext or to print the contents of the extension.
Definition: plugins_exts.h:794
LY_VALUE_FORMAT format
Definition: plugins_exts.h:406
Parser input structure specifying where the data are read.
LY_ERR(* lyplg_ext_data_snode_clb)(struct lysc_ext_instance *ext, const struct lyd_node *parent, const struct lysc_node *sparent, const char *prefix, size_t prefix_len, LY_VALUE_FORMAT format, void *prefix_data, const char *name, size_t name_len, const struct lysc_node **snode)
Callback for getting a schema node for a new YANG instance data described by an extension instance...
Definition: plugins_exts.h:857
LIBYANG_API_DECL LY_ERR lyplg_ext_insert(struct lyd_node *parent, struct lyd_node *first)
Insert extension instance data into a parent.
enum ly_stmt stmt
Definition: plugins_exts.h:428
LY_LOG_LEVEL
Verbosity levels of the libyang logger.
Definition: log.h:88
struct lyplg_ext plugin
Definition: plugins_exts.h:958
lyplg_ext_compile_clb compile
Definition: plugins_exts.h:930
LIBYANG_API_DECL enum ly_stmt lyplg_ext_nodetype2stmt(uint16_t nodetype)
Convert nodetype to statement identifier.
lyplg_ext_data_node_clb node
Definition: plugins_exts.h:937
LIBYANG_API_DECL LY_ERR lyplg_ext_compile_extension_instance(struct lysc_ctx *ctx, const struct lysp_ext_instance *extp, struct lysc_ext_instance *ext)
Compile substatements of an extension instance.
LY_ERR(* lyplg_ext_sprinter_ctree_clb)(struct lysc_ext_instance *ext, const struct lyspr_tree_ctx *ctx, const char **flags, const char **add_opts)
Callback to print parent node of ext or to print the contents of the extension.
Definition: plugins_exts.h:740
YANG extension-stmt.
Definition: tree_schema.h:296
LIBYANG_API_DECL LY_ERR lyplg_ext_schema_mount_get_parent_ref(const struct lysc_ext_instance *ext, struct ly_set **refs)
Expand parent-reference xpath expressions.
const char * argument
Definition: plugins_exts.h:405
struct lys_module * module
Definition: plugins_exts.h:439
LIBYANG_API_DECL LY_ERR lyplg_ext_parsed_get_storage(const struct lysc_ext_instance *ext, int stmt, uint32_t storage_size, const void **storage)
Get parsed ext instance storage for a specific statement.
LIBYANG_API_DECL void lyplg_ext_cfree_instance_substatements(const struct ly_ctx *ctx, struct lysc_ext_substmt *substmts)
Free the extension instance's data compiled with lyplg_ext_compile_extension_instance().
lyplg_ext_compile_free_clb cfree
Definition: plugins_exts.h:944
LIBYANG_API_DECL LY_ERR lyplg_ext_sprinter_ptree_add_nodes(const struct lyspr_tree_ctx *ctx, struct lysp_node *nodes, lyplg_ext_sprinter_ptree_override_clb clb)
Registration of printing the group of nodes which were defined in the plugin.
lyd_type
Definition: parser_data.h:323
Structure to hold a set of (not necessary somehow connected) objects. Usually used for lyd_node...
Definition: set.h:46
Printable YANG schema tree structure representing YANG module.
Definition: tree_schema.h:1114
struct lysp_stmt * child
Definition: plugins_exts.h:386
Available YANG schema tree structures representing YANG module.
Definition: tree_schema.h:2097
LIBYANG_API_DECL struct ly_out ** lyplg_ext_print_get_out(const struct lyspr_ctx *ctx)
YANG printer context getter for output handler.
enum ly_stmt parent_stmt
Definition: plugins_exts.h:444
LIBYANG_API_DECL struct lysp_module * lyplg_ext_parse_get_cur_pmod(const struct lysp_ctx *pctx)
Get current parsed module from a parse context.
LIBYANG_API_DECL uint32_t * lyplg_ext_print_get_options(const struct lyspr_ctx *ctx)
YANG printer context getter for printer options.
lyplg_ext_data_snode_clb snode
Definition: plugins_exts.h:939
const char * argument
Definition: plugins_exts.h:438
#define LY_ARRAY_COUNT_TYPE
Type (i.e. size) of the sized array's size counter.
Definition: tree.h:104
struct lysc_ext * def
Definition: plugins_exts.h:437
const char * arg
Definition: plugins_exts.h:381
uint16_t flags
Definition: tree_schema.h:1416
libyang generic macros and functions to modify YANG schema or data trees. Intended for internal use a...
lyplg_ext_parse_free_clb pfree
Definition: plugins_exts.h:943
Generic YANG data node.
Definition: tree_schema.h:746
uint16_t flags
Definition: tree_schema.h:749
void(* lyplg_ext_compile_free_clb)(const struct ly_ctx *ctx, struct lysc_ext_instance *ext)
Callback to free the extension-specific data created by its compilation.
Definition: plugins_exts.h:913
LY_VALUE_FORMAT
All kinds of supported value formats and prefix mappings to modules.
Definition: tree.h:234
LIBYANG_API_DECL LY_ERR lyplg_ext_get_data(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, void **ext_data, ly_bool *ext_data_free)
Get specific run-time extension instance data from a callback set by ly_ctx_set_ext_data_clb().
Plugins manipulation.
LIBYANG_API_DECL const char * lyplg_ext_stmt2str(enum ly_stmt stmt)
Stringify statement identifier.
Structure representing a generic parsed YANG substatement in an extension instance.
Definition: plugins_exts.h:379
LIBYANG_API_DECL LY_ERR lyplg_ext_sprinter_ctree_add_ext_nodes(const struct lyspr_tree_ctx *ctx, struct lysc_ext_instance *ext, lyplg_ext_sprinter_ctree_override_clb clb)
Registration of printing a group of nodes, which is already in the extension.
LIBYANG_API_DECL uint32_t * lyplg_ext_compile_get_options(const struct lysc_ctx *ctx)
YANG schema compilation context getter for compilation options.
LY_ERR
libyang's error codes returned by the libyang functions.
Definition: log.h:254
LIBYANG_API_DECL void lyplg_ext_compile_log(const struct lysc_ctx *cctx, const struct lysc_ext_instance *ext, LY_LOG_LEVEL level, LY_ERR err_no, const char *format,...)
Log a message from an extension plugin using the compiled extension instance.
Logger manipulation routines and error definitions.
lyplg_ext_sprinter_ctree_clb printer_ctree
Definition: plugins_exts.h:933
libyang context handler.
LY_VALUE_FORMAT format
Definition: plugins_exts.h:382
void * prefix_data
Definition: plugins_exts.h:383
YANG extension parsed instance.
Definition: plugins_exts.h:403