libyang 3.4.2
libyang is YANG data modelling language parser and toolkit written (and providing API) in C.
Loading...
Searching...
No Matches
tree_data.h
Go to the documentation of this file.
1
16#ifndef LY_TREE_DATA_H_
17#define LY_TREE_DATA_H_
18
19#ifdef _WIN32
20# include <winsock2.h>
21# include <ws2tcpip.h>
22#else
23# include <arpa/inet.h>
24# if defined (__FreeBSD__) || defined (__NetBSD__) || defined (__OpenBSD__)
25# include <netinet/in.h>
26# include <sys/socket.h>
27# endif
28#endif
29#include <stddef.h>
30#include <stdint.h>
31#include <time.h>
32
33#include "log.h"
34#include "ly_config.h"
35#include "tree.h"
36#include "tree_schema.h"
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
42struct ly_ctx;
43struct ly_path;
44struct ly_set;
45struct lyd_node;
46struct lyd_node_opaq;
47struct lyd_node_term;
48struct timespec;
49struct lyxp_var;
50struct rb_node;
51
423/* *INDENT-OFF* */
424
450#define LYD_TREE_DFS_BEGIN(START, ELEM) \
451 { ly_bool LYD_TREE_DFS_continue = 0; struct lyd_node *LYD_TREE_DFS_next; \
452 for ((ELEM) = (LYD_TREE_DFS_next) = (struct lyd_node *)(START); \
453 (ELEM); \
454 (ELEM) = (LYD_TREE_DFS_next), LYD_TREE_DFS_continue = 0)
455
470#define LYD_TREE_DFS_END(START, ELEM) \
471 /* select element for the next run - children first */ \
472 if (LYD_TREE_DFS_continue) { \
473 (LYD_TREE_DFS_next) = NULL; \
474 } else { \
475 (LYD_TREE_DFS_next) = lyd_child(ELEM); \
476 }\
477 if (!(LYD_TREE_DFS_next)) { \
478 /* no children */ \
479 if ((ELEM) == (struct lyd_node *)(START)) { \
480 /* we are done, (START) has no children */ \
481 break; \
482 } \
483 /* try siblings */ \
484 (LYD_TREE_DFS_next) = (ELEM)->next; \
485 } \
486 while (!(LYD_TREE_DFS_next)) { \
487 /* parent is already processed, go to its sibling */ \
488 (ELEM) = (struct lyd_node *)(ELEM)->parent; \
489 /* no siblings, go back through parents */ \
490 if ((ELEM)->parent == (START)->parent) { \
491 /* we are done, no next element to process */ \
492 break; \
493 } \
494 (LYD_TREE_DFS_next) = (ELEM)->next; \
495 } }
496
504#define LYD_LIST_FOR_INST(START, SCHEMA, ELEM) \
505 for (lyd_find_sibling_val(START, SCHEMA, NULL, 0, &(ELEM)); \
506 (ELEM) && ((ELEM)->schema == (SCHEMA)); \
507 (ELEM) = (ELEM)->next)
508
517#define LYD_LIST_FOR_INST_SAFE(START, SCHEMA, NEXT, ELEM) \
518 for ((NEXT) = (ELEM) = NULL, lyd_find_sibling_val(START, SCHEMA, NULL, 0, &(ELEM)); \
519 (ELEM) && ((ELEM)->schema == (SCHEMA)) ? ((NEXT) = (ELEM)->next, 1) : 0; \
520 (ELEM) = (NEXT))
521
522/* *INDENT-ON* */
523
527#define LYD_CTX(node) ((node)->schema ? (node)->schema->module->ctx : ((const struct lyd_node_opaq *)(node))->ctx)
528
536#define LYD_NODE_IS_ALONE(NODE) \
537 (((NODE)->prev == NODE) || \
538 (((NODE)->prev->schema != (NODE)->schema) && (!(NODE)->next || ((NODE)->schema != (NODE)->next->schema))))
539
550
565
571struct lyd_value {
572 const char *_canonical;
575 const struct lysc_type *realtype;
583 union {
584 int8_t boolean;
585 int64_t dec64;
586 int8_t int8;
587 int16_t int16;
588 int32_t int32;
589 int64_t int64;
590 uint8_t uint8;
591 uint16_t uint16;
592 uint32_t uint32;
593 uint64_t uint64;
594 struct lysc_type_bitenum_item *enum_item;
595 struct lysc_ident *ident;
596 struct ly_path *target;
598 struct lyd_value_union *subvalue;
600 void *dyn_mem;
601 uint8_t fixed_mem[LYD_VALUE_FIXED_MEM_SIZE];
602 };
604};
605
614#define LYD_VALUE_GET(value, type_val) \
615 ((sizeof *(type_val) > LYD_VALUE_FIXED_MEM_SIZE) \
616 ? ((type_val) = (((value)->dyn_mem))) \
617 : ((type_val) = ((void *)((value)->fixed_mem))))
618
638
649
654 void *data;
655 size_t size;
656};
657
662 struct in_addr addr;
663};
664
669 struct in_addr addr;
670 const char *zone;
671};
672
677 struct in_addr addr;
678 uint8_t prefix;
679};
680
685 struct in6_addr addr;
686};
687
692 struct in6_addr addr;
693 const char *zone;
694};
695
700 struct in6_addr addr;
701 uint8_t prefix;
702};
703
712
717 struct lyxp_expr *exp;
718 const struct ly_ctx *ctx;
721};
722
727 struct rb_node *rbt;
728};
729
738 const char *name;
739 const char *prefix;
741 union {
742 const char *module_ns;
743 const char *module_name;
744 };
745};
746
759
760#define LYD_NODE_INNER (LYS_CONTAINER|LYS_LIST|LYS_RPC|LYS_ACTION|LYS_NOTIF)
761#define LYD_NODE_TERM (LYS_LEAF|LYS_LEAFLIST)
762#define LYD_NODE_ANY (LYS_ANYDATA)
789#define LYD_DEFAULT 0x01
790#define LYD_WHEN_TRUE 0x02
791#define LYD_NEW 0x04
792#define LYD_EXT 0x08
799struct lyd_node {
800 uint32_t hash;
804 uint32_t flags;
805 const struct lysc_node *schema;
807 struct lyd_node *next;
808 struct lyd_node *prev;
812 struct lyd_meta *meta;
813 void *priv;
814};
815
820 union {
821 struct lyd_node node;
823 struct {
824 uint32_t hash;
829 uint32_t flags;
830 const struct lysc_node *schema;
831 struct lyd_node_inner *parent;
832 struct lyd_node *next;
833 struct lyd_node *prev;
837 struct lyd_meta *meta;
838 void *priv;
839 };
840 };
842 struct lyd_node *child;
845#define LYD_HT_MIN_ITEMS 4
846};
847
852 union {
853 struct lyd_node node;
855 struct {
856 uint32_t hash;
861 uint32_t flags;
862 const struct lysc_node *schema;
863 struct lyd_node_inner *parent;
864 struct lyd_node *next;
865 struct lyd_node *prev;
869 struct lyd_meta *meta;
870 void *priv;
871 };
872 };
875};
876
881 struct lyd_node *tree;
882 const char *str;
883 const char *xml;
884 const char *json;
885 char *mem;
886};
887
893 union {
894 struct lyd_node node;
896 struct {
897 uint32_t hash;
902 uint32_t flags;
903 const struct lysc_node *schema;
904 struct lyd_node_inner *parent;
905 struct lyd_node *next;
906 struct lyd_node *prev;
910 struct lyd_meta *meta;
911 void *priv;
912 };
913 };
917};
918
925#define LYD_NAME(node) ((node)->schema ? (node)->schema->name : ((struct lyd_node_opaq *)node)->name.name)
926
936#define LYD_VALHINT_STRING 0x0001
937#define LYD_VALHINT_DECNUM 0x0002
938#define LYD_VALHINT_OCTNUM 0x0004
939#define LYD_VALHINT_HEXNUM 0x0008
940#define LYD_VALHINT_NUM64 0x0010
941#define LYD_VALHINT_BOOLEAN 0x0020
942#define LYD_VALHINT_EMPTY 0x0040
956#define LYD_NODEHINT_LIST 0x0080
957#define LYD_NODEHINT_LEAFLIST 0x0100
958#define LYD_NODEHINT_CONTAINER 0x0200
973#define LYD_HINT_DATA 0x03F3
977#define LYD_HINT_SCHEMA 0x03FF
989 union {
990 struct lyd_node node;
992 struct {
993 uint32_t hash;
994 uint32_t flags;
995 const struct lysc_node *schema;
996 struct lyd_node_inner *parent;
997 struct lyd_node *next;
998 struct lyd_node *prev;
1002 struct lyd_meta *meta;
1003 void *priv;
1004 };
1005 };
1007 struct lyd_node *child;
1010 const char *value;
1011 uint32_t hints;
1015 struct lyd_attr *attr;
1016 const struct ly_ctx *ctx;
1017};
1018
1034
1042static inline struct lyd_node *
1043lyd_parent(const struct lyd_node *node)
1044{
1045 return (node && node->parent) ? &node->parent->node : NULL;
1046}
1047
1058static inline struct lyd_node *
1059lyd_child(const struct lyd_node *node)
1060{
1061 if (!node) {
1062 return NULL;
1063 }
1064
1065 if (!node->schema) {
1066 /* opaq node */
1067 return ((const struct lyd_node_opaq *)node)->child;
1068 }
1069
1071 return ((const struct lyd_node_inner *)node)->child;
1072 }
1073
1074 return NULL;
1075}
1076
1087LIBYANG_API_DECL struct lyd_node *lyd_child_no_keys(const struct lyd_node *node);
1088
1098LIBYANG_API_DECL const struct lys_module *lyd_owner_module(const struct lyd_node *node);
1099
1106LIBYANG_API_DECL const struct lys_module *lyd_node_module(const struct lyd_node *node);
1107
1114LIBYANG_API_DECL ly_bool lyd_is_default(const struct lyd_node *node);
1115
1123LIBYANG_API_DECL uint32_t lyd_list_pos(const struct lyd_node *instance);
1124
1131LIBYANG_API_DECL struct lyd_node *lyd_first_sibling(const struct lyd_node *node);
1132
1140LIBYANG_API_DECL int lyd_lyb_data_length(const char *data);
1141
1151LIBYANG_API_DECL LY_ERR lyd_parse_opaq_error(const struct lyd_node *node);
1152
1162LIBYANG_API_DECL const char *lyd_value_get_canonical(const struct ly_ctx *ctx, const struct lyd_value *value);
1163
1170static inline const char *
1171lyd_get_value(const struct lyd_node *node)
1172{
1173 if (!node) {
1174 return NULL;
1175 }
1176
1177 if (!node->schema) {
1178 return ((const struct lyd_node_opaq *)node)->value;
1179 } else if (node->schema->nodetype & LYD_NODE_TERM) {
1180 const struct lyd_value *value = &((const struct lyd_node_term *)node)->value;
1181
1183 }
1184
1185 return NULL;
1186}
1187
1195LIBYANG_API_DECL LY_ERR lyd_any_value_str(const struct lyd_node *any, char **value_str);
1196
1205LIBYANG_API_DECL LY_ERR lyd_any_copy_value(struct lyd_node *trg, const union lyd_any_value *value,
1206 LYD_ANYDATA_VALUETYPE value_type);
1207
1214LIBYANG_API_DECL const struct lysc_node *lyd_node_schema(const struct lyd_node *node);
1215
1223LIBYANG_API_DECL ly_bool lyd_meta_is_internal(const struct lyd_meta *meta);
1224
1240LIBYANG_API_DECL LY_ERR lyd_new_inner(struct lyd_node *parent, const struct lys_module *module, const char *name,
1241 ly_bool output, struct lyd_node **node);
1242
1256LIBYANG_API_DECL LY_ERR lyd_new_ext_inner(const struct lysc_ext_instance *ext, const char *name, struct lyd_node **node);
1257
1279#define LYD_NEW_VAL_OUTPUT 0x01
1281#define LYD_NEW_VAL_STORE_ONLY 0x02
1282#define LYD_NEW_VAL_BIN 0x04
1284#define LYD_NEW_VAL_CANON 0x08
1287#define LYD_NEW_META_CLEAR_DFLT 0x10
1288#define LYD_NEW_PATH_UPDATE 0x20
1292#define LYD_NEW_PATH_OPAQ 0x40
1296#define LYD_NEW_PATH_WITH_OPAQ 0x80
1297#define LYD_NEW_ANY_USE_VALUE 0x100
1314LIBYANG_API_DECL LY_ERR lyd_new_list(struct lyd_node *parent, const struct lys_module *module, const char *name,
1315 uint32_t options, struct lyd_node **node, ...);
1316
1332LIBYANG_API_DECL LY_ERR lyd_new_ext_list(const struct lysc_ext_instance *ext, const char *name, uint32_t options,
1333 struct lyd_node **node, ...);
1334
1348LIBYANG_API_DECL LY_ERR lyd_new_list2(struct lyd_node *parent, const struct lys_module *module, const char *name,
1349 const char *keys, uint32_t options, struct lyd_node **node);
1350
1363LIBYANG_API_DECL LY_ERR lyd_new_list3(struct lyd_node *parent, const struct lys_module *module, const char *name,
1364 const char **key_values, uint32_t *value_lengths, uint32_t options, struct lyd_node **node);
1365
1380LIBYANG_API_DECL LY_ERR lyd_new_term(struct lyd_node *parent, const struct lys_module *module, const char *name,
1381 const char *value, uint32_t options, struct lyd_node **node);
1382
1395LIBYANG_API_DECL LY_ERR lyd_new_term_bin(struct lyd_node *parent, const struct lys_module *module, const char *name,
1396 const void *value, size_t value_len, uint32_t options, struct lyd_node **node);
1397
1412LIBYANG_API_DECL LY_ERR lyd_new_ext_term(const struct lysc_ext_instance *ext, const char *name, const void *value,
1413 size_t value_len, uint32_t options, struct lyd_node **node);
1414
1429LIBYANG_API_DECL LY_ERR lyd_new_any(struct lyd_node *parent, const struct lys_module *module, const char *name,
1430 const void *value, LYD_ANYDATA_VALUETYPE value_type, uint32_t options, struct lyd_node **node);
1431
1446LIBYANG_API_DECL LY_ERR lyd_new_ext_any(const struct lysc_ext_instance *ext, const char *name, const void *value,
1447 LYD_ANYDATA_VALUETYPE value_type, uint32_t options, struct lyd_node **node);
1448
1463LIBYANG_API_DECL LY_ERR lyd_new_meta(const struct ly_ctx *ctx, struct lyd_node *parent, const struct lys_module *module,
1464 const char *name, const char *val_str, uint32_t options, struct lyd_meta **meta);
1465
1478LIBYANG_API_DECL LY_ERR lyd_new_meta2(const struct ly_ctx *ctx, struct lyd_node *parent, uint32_t options,
1479 const struct lyd_attr *attr, struct lyd_meta **meta);
1480
1493LIBYANG_API_DECL LY_ERR lyd_new_opaq(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value,
1494 const char *prefix, const char *module_name, struct lyd_node **node);
1495
1508LIBYANG_API_DECL LY_ERR lyd_new_opaq2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value,
1509 const char *prefix, const char *module_ns, struct lyd_node **node);
1510
1524LIBYANG_API_DECL LY_ERR lyd_new_attr(struct lyd_node *parent, const char *module_name, const char *name, const char *value,
1525 struct lyd_attr **attr);
1526
1539LIBYANG_API_DECL LY_ERR lyd_new_attr2(struct lyd_node *parent, const char *module_ns, const char *name, const char *value,
1540 struct lyd_attr **attr);
1541
1570LIBYANG_API_DECL LY_ERR lyd_new_path(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const char *value,
1571 uint32_t options, struct lyd_node **node);
1572
1597LIBYANG_API_DECL LY_ERR lyd_new_path2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const void *value,
1598 size_t value_len, LYD_ANYDATA_VALUETYPE value_type, uint32_t options, struct lyd_node **new_parent,
1599 struct lyd_node **new_node);
1600
1623LIBYANG_API_DECL LY_ERR lyd_new_ext_path(struct lyd_node *parent, const struct lysc_ext_instance *ext, const char *path,
1624 const void *value, uint32_t options, struct lyd_node **node);
1625
1639#define LYD_IMPLICIT_NO_STATE 0x01
1640#define LYD_IMPLICIT_NO_CONFIG 0x02
1641#define LYD_IMPLICIT_OUTPUT 0x04
1642#define LYD_IMPLICIT_NO_DEFAULTS 0x08
1655LIBYANG_API_DECL LY_ERR lyd_new_implicit_tree(struct lyd_node *tree, uint32_t implicit_options, struct lyd_node **diff);
1656
1668LIBYANG_API_DECL LY_ERR lyd_new_implicit_all(struct lyd_node **tree, const struct ly_ctx *ctx, uint32_t implicit_options,
1669 struct lyd_node **diff);
1670
1682LIBYANG_API_DECL LY_ERR lyd_new_implicit_module(struct lyd_node **tree, const struct lys_module *module,
1683 uint32_t implicit_options, struct lyd_node **diff);
1684
1698LIBYANG_API_DECL LY_ERR lyd_change_term(struct lyd_node *term, const char *val_str);
1699
1714LIBYANG_API_DECL LY_ERR lyd_change_term_bin(struct lyd_node *term, const void *value, size_t value_len);
1715
1730LIBYANG_API_DECL LY_ERR lyd_change_term_canon(struct lyd_node *term, const char *val_str);
1731
1741LIBYANG_API_DECL LY_ERR lyd_change_meta(struct lyd_meta *meta, const char *val_str);
1742
1754LIBYANG_API_DECL LY_ERR lyd_insert_child(struct lyd_node *parent, struct lyd_node *node);
1755
1768LIBYANG_API_DECL LY_ERR lyd_insert_sibling(struct lyd_node *sibling, struct lyd_node *node, struct lyd_node **first);
1769
1781LIBYANG_API_DECL LY_ERR lyd_insert_before(struct lyd_node *sibling, struct lyd_node *node);
1782
1794LIBYANG_API_DECL LY_ERR lyd_insert_after(struct lyd_node *sibling, struct lyd_node *node);
1795
1803LIBYANG_API_DECL LY_ERR lyd_unlink_siblings(struct lyd_node *node);
1804
1812LIBYANG_API_DECL LY_ERR lyd_unlink_tree(struct lyd_node *node);
1813
1819LIBYANG_API_DECL void lyd_free_all(struct lyd_node *node);
1820
1826LIBYANG_API_DECL void lyd_free_siblings(struct lyd_node *node);
1827
1833LIBYANG_API_DECL void lyd_free_tree(struct lyd_node *node);
1834
1840LIBYANG_API_DECL void lyd_free_meta_single(struct lyd_meta *meta);
1841
1847LIBYANG_API_DECL void lyd_free_meta_siblings(struct lyd_meta *meta);
1848
1855LIBYANG_API_DECL void lyd_free_attr_single(const struct ly_ctx *ctx, struct lyd_attr *attr);
1856
1863LIBYANG_API_DECL void lyd_free_attr_siblings(const struct ly_ctx *ctx, struct lyd_attr *attr);
1864
1883LIBYANG_API_DECL LY_ERR lyd_value_validate(const struct ly_ctx *ctx, const struct lysc_node *schema, const char *value,
1884 size_t value_len, const struct lyd_node *ctx_node, const struct lysc_type **realtype, const char **canonical);
1885
1898LIBYANG_API_DECL LY_ERR lyd_value_compare(const struct lyd_node_term *node, const char *value, size_t value_len);
1899
1906#define LYD_COMPARE_FULL_RECURSION 0x01 /* Lists and containers are the same only in case all they children
1907 (subtree, so direct as well as indirect children) are the same. By default,
1908 containers are the same in case of the same schema node and lists are the same
1909 in case of equal keys (keyless lists do the full recursion comparison all the time). */
1910#define LYD_COMPARE_DEFAULTS 0x02 /* By default, implicit and explicit default nodes are considered to be equal. This flag
1911 changes this behavior and implicit (automatically created default node) and explicit
1912 (explicitly created node with the default value) default nodes are considered different. */
1913#define LYD_COMPARE_OPAQ 0x04 /* Opaque nodes can normally be never equal to data nodes. Using this flag even
1914 opaque nodes members are compared to data node schema and value and can result
1915 in a match. */
1929LIBYANG_API_DECL LY_ERR lyd_compare_single(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
1930
1942LIBYANG_API_DECL LY_ERR lyd_compare_siblings(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
1943
1954LIBYANG_API_DECL LY_ERR lyd_compare_meta(const struct lyd_meta *meta1, const struct lyd_meta *meta2);
1955
1968#define LYD_DUP_RECURSIVE 0x01
1970#define LYD_DUP_NO_META 0x02
1972#define LYD_DUP_WITH_PARENTS 0x04
1974#define LYD_DUP_WITH_FLAGS 0x08
1976#define LYD_DUP_NO_EXT 0x10
1977#define LYD_DUP_WITH_PRIV 0x20
1979#define LYD_DUP_NO_LYDS 0x40
1997LIBYANG_API_DECL LY_ERR lyd_dup_single(const struct lyd_node *node, struct lyd_node_inner *parent, uint32_t options,
1998 struct lyd_node **dup);
1999
2012LIBYANG_API_DECL LY_ERR lyd_dup_single_to_ctx(const struct lyd_node *node, const struct ly_ctx *trg_ctx,
2013 struct lyd_node_inner *parent, uint32_t options, struct lyd_node **dup);
2014
2026LIBYANG_API_DECL LY_ERR lyd_dup_siblings(const struct lyd_node *node, struct lyd_node_inner *parent, uint32_t options,
2027 struct lyd_node **dup);
2028
2042LIBYANG_API_DECL LY_ERR lyd_dup_siblings_to_ctx(const struct lyd_node *node, const struct ly_ctx *trg_ctx,
2043 struct lyd_node_inner *parent, uint32_t options, struct lyd_node **dup);
2044
2053LIBYANG_API_DECL LY_ERR lyd_dup_meta_single(const struct lyd_meta *meta, struct lyd_node *parent, struct lyd_meta **dup);
2054
2069#define LYD_MERGE_DESTRUCT 0x01
2070#define LYD_MERGE_DEFAULTS 0x02
2071#define LYD_MERGE_WITH_FLAGS 0x04
2095LIBYANG_API_DECL LY_ERR lyd_merge_tree(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
2096
2118LIBYANG_API_DECL LY_ERR lyd_merge_siblings(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
2119
2129typedef LY_ERR (*lyd_merge_cb)(struct lyd_node *trg_node, const struct lyd_node *src_node, void *cb_data);
2130
2146LIBYANG_API_DECL LY_ERR lyd_merge_module(struct lyd_node **target, const struct lyd_node *source, const struct lys_module *mod,
2147 lyd_merge_cb merge_cb, void *cb_data, uint16_t options);
2148
2160#define LYD_DIFF_DEFAULTS 0x01
2191LIBYANG_API_DECL LY_ERR lyd_diff_tree(const struct lyd_node *first, const struct lyd_node *second, uint16_t options,
2192 struct lyd_node **diff);
2193
2206LIBYANG_API_DECL LY_ERR lyd_diff_siblings(const struct lyd_node *first, const struct lyd_node *second, uint16_t options,
2207 struct lyd_node **diff);
2208
2217typedef LY_ERR (*lyd_diff_cb)(const struct lyd_node *diff_node, struct lyd_node *data_node, void *cb_data);
2218
2235LIBYANG_API_DECL LY_ERR lyd_diff_apply_module(struct lyd_node **data, const struct lyd_node *diff,
2236 const struct lys_module *mod, lyd_diff_cb diff_cb, void *cb_data);
2237
2248LIBYANG_API_DECL LY_ERR lyd_diff_apply_all(struct lyd_node **data, const struct lyd_node *diff);
2249
2261#define LYD_DIFF_MERGE_DEFAULTS 0x01
2289LIBYANG_API_DECL LY_ERR lyd_diff_merge_module(struct lyd_node **diff, const struct lyd_node *src_diff,
2290 const struct lys_module *mod, lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
2291
2308LIBYANG_API_DECL LY_ERR lyd_diff_merge_tree(struct lyd_node **diff_first, struct lyd_node *diff_parent,
2309 const struct lyd_node *src_sibling, lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
2310
2322LIBYANG_API_DECL LY_ERR lyd_diff_merge_all(struct lyd_node **diff, const struct lyd_node *src_diff, uint16_t options);
2323
2333LIBYANG_API_DECL LY_ERR lyd_diff_reverse_all(const struct lyd_node *src_diff, struct lyd_node **diff);
2334
2338typedef enum {
2339 LYD_PATH_STD,
2344
2360LIBYANG_API_DECL char *lyd_path(const struct lyd_node *node, LYD_PATH_TYPE pathtype, char *buffer, size_t buflen);
2361
2371LIBYANG_API_DECL struct lyd_meta *lyd_find_meta(const struct lyd_meta *first, const struct lys_module *module,
2372 const char *name);
2373
2385LIBYANG_API_DECL LY_ERR lyd_find_sibling_first(const struct lyd_node *siblings, const struct lyd_node *target,
2386 struct lyd_node **match);
2387
2412LIBYANG_API_DECL LY_ERR lyd_find_sibling_val(const struct lyd_node *siblings, const struct lysc_node *schema,
2413 const char *key_or_value, size_t val_len, struct lyd_node **match);
2414
2426LIBYANG_API_DECL LY_ERR lyd_find_sibling_dup_inst_set(const struct lyd_node *siblings, const struct lyd_node *target,
2427 struct ly_set **set);
2428
2439LIBYANG_API_DECL LY_ERR lyd_find_sibling_opaq_next(const struct lyd_node *first, const char *name, struct lyd_node **match);
2440
2452LIBYANG_API_DECL LY_ERR lyxp_vars_set(struct lyxp_var **vars, const char *name, const char *value);
2453
2459LIBYANG_API_DECL void lyxp_vars_free(struct lyxp_var *vars);
2460
2478LIBYANG_API_DECL LY_ERR lyd_find_xpath(const struct lyd_node *ctx_node, const char *xpath, struct ly_set **set);
2479
2493LIBYANG_API_DECL LY_ERR lyd_find_xpath2(const struct lyd_node *ctx_node, const char *xpath, const struct lyxp_var *vars,
2494 struct ly_set **set);
2495
2513LIBYANG_API_DECL LY_ERR lyd_find_xpath3(const struct lyd_node *ctx_node, const struct lyd_node *tree, const char *xpath,
2514 LY_VALUE_FORMAT format, void *prefix_data, const struct lyxp_var *vars, struct ly_set **set);
2515
2527LIBYANG_API_DECL LY_ERR lyd_eval_xpath(const struct lyd_node *ctx_node, const char *xpath, ly_bool *result);
2528
2541LIBYANG_API_DECL LY_ERR lyd_eval_xpath2(const struct lyd_node *ctx_node, const char *xpath,
2542 const struct lyxp_var *vars, ly_bool *result);
2543
2559LIBYANG_API_DECL LY_ERR lyd_eval_xpath3(const struct lyd_node *ctx_node, const struct lys_module *cur_mod,
2560 const char *xpath, LY_VALUE_FORMAT format, void *prefix_data, const struct lyxp_var *vars, ly_bool *result);
2565typedef enum {
2571
2594LIBYANG_API_DECL LY_ERR lyd_eval_xpath4(const struct lyd_node *ctx_node, const struct lyd_node *tree,
2595 const struct lys_module *cur_mod, const char *xpath, LY_VALUE_FORMAT format, void *prefix_data,
2596 const struct lyxp_var *vars, LY_XPATH_TYPE *ret_type, struct ly_set **node_set, char **string,
2597 long double *number, ly_bool *boolean);
2598
2608LIBYANG_API_DEF LY_ERR lyd_trim_xpath(struct lyd_node **tree, const char *xpath, const struct lyxp_var *vars);
2609
2627LIBYANG_API_DECL LY_ERR lyd_find_path(const struct lyd_node *ctx_node, const char *path, ly_bool output,
2628 struct lyd_node **match);
2629
2640LIBYANG_API_DECL LY_ERR lyd_find_target(const struct ly_path *path, const struct lyd_node *tree, struct lyd_node **match);
2641
2647LIBYANG_API_DECL int ly_time_tz_offset(void);
2655LIBYANG_API_DECL int ly_time_tz_offset_at(time_t time);
2656
2665LIBYANG_API_DECL LY_ERR ly_time_str2time(const char *value, time_t *time, char **fractions_s);
2666
2675LIBYANG_API_DECL LY_ERR ly_time_time2str(time_t time, const char *fractions_s, char **str);
2676
2684LIBYANG_API_DECL LY_ERR ly_time_str2ts(const char *value, struct timespec *ts);
2685
2693LIBYANG_API_DECL LY_ERR ly_time_ts2str(const struct timespec *ts, char **str);
2694
2705LIBYANG_API_DECL LY_ERR lyd_leafref_get_links(const struct lyd_node_term *node, const struct lyd_leafref_links_rec **record);
2706
2716LIBYANG_API_DECL LY_ERR lyd_leafref_link_node_tree(const struct lyd_node *tree);
2717
2718#ifdef __cplusplus
2719}
2720#endif
2721
2722#endif /* LY_TREE_DATA_H_ */
libyang context handler.
LYD_ANYDATA_VALUETYPE
List of possible value types stored in lyd_node_any.
Definition tree_data.h:554
LYD_FORMAT
Data input/output formats supported by libyang parser and printer functions.
Definition tree_data.h:544
#define LYD_CTX(node)
Macro to get context from a data tree node.
Definition tree_data.h:527
@ LYD_ANYDATA_DATATREE
Definition tree_data.h:555
@ LYD_ANYDATA_JSON
Definition tree_data.h:562
@ LYD_ANYDATA_XML
Definition tree_data.h:561
@ LYD_ANYDATA_LYB
Definition tree_data.h:563
@ LYD_ANYDATA_STRING
Definition tree_data.h:558
@ LYD_LYB
Definition tree_data.h:548
@ LYD_XML
Definition tree_data.h:546
@ LYD_UNKNOWN
Definition tree_data.h:545
@ LYD_JSON
Definition tree_data.h:547
LY_ERR
libyang's error codes returned by the libyang functions.
Definition log.h:237
Structure to hold a set of (not necessary somehow connected) objects. Usually used for lyd_node,...
Definition set.h:47
YANG extension compiled instance.
#define LYS_NOTIF
#define LYS_RPC
#define LYS_CONTAINER
#define LYS_ACTION
#define LYS_LIST
uint16_t nodetype
struct lys_module *struct lysc_node * parent
const char * name
Available YANG schema tree structures representing YANG module.
YANG identity-stmt.
Compiled YANG data node.
LY_VALUE_FORMAT
All kinds of supported value formats and prefix mappings to modules.
Definition tree.h:234
Logger manipulation routines and error definitions.
uint8_t ly_bool
Type to indicate boolean value.
Definition log.h:35
const char * name
Definition metadata.h:40
struct lyd_value value
Definition metadata.h:41
Metadata structure.
Definition metadata.h:36
libyang hash table.
libyang generic macros and functions to work with YANG schema or data trees.
LIBYANG_API_DECL void lyxp_vars_free(struct lyxp_var *vars)
Free the XPath variables.
LY_VALUE_FORMAT format
Definition tree_data.h:756
struct lyd_node * next
Definition tree_data.h:807
LIBYANG_API_DECL void lyd_free_all(struct lyd_node *node)
Free all the nodes (even parents of the node) in the data tree.
LIBYANG_API_DECL LY_ERR lyd_find_sibling_opaq_next(const struct lyd_node *first, const char *name, struct lyd_node **match)
Search the given siblings for an opaque node with a specific name.
void * val_prefix_data
Definition tree_data.h:1013
LIBYANG_API_DECL LY_ERR lyd_merge_siblings(struct lyd_node **target, const struct lyd_node *source, uint16_t options)
Merge the source data tree with any following siblings into the target data tree. Merge may not be co...
LIBYANG_API_DECL void lyd_free_meta_siblings(struct lyd_meta *meta)
Free the metadata instance with any following instances.
LIBYANG_API_DECL LY_ERR lyd_find_xpath(const struct lyd_node *ctx_node, const char *xpath, struct ly_set **set)
Search in the given data for instances of nodes matching the provided XPath.
const char * prefix
Definition tree_data.h:739
struct rb_node * rbt
Definition tree_data.h:727
LIBYANG_API_DECL LY_ERR ly_time_ts2str(const struct timespec *ts, char **str)
Convert timespec into date-and-time string value.
struct in_addr addr
Definition tree_data.h:669
LIBYANG_API_DECL LY_ERR ly_time_str2time(const char *value, time_t *time, char **fractions_s)
Convert date-and-time from string to UNIX timestamp and fractions of a second.
LIBYANG_API_DECL LY_ERR lyd_new_path(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const char *value, uint32_t options, struct lyd_node **node)
Create a new node in the data tree based on a path. If creating anyxml/anydata nodes,...
LIBYANG_API_DECL const char * lyd_value_get_canonical(const struct ly_ctx *ctx, const struct lyd_value *value)
Get the (canonical) value of a lyd_value.
LIBYANG_API_DECL char * lyd_path(const struct lyd_node *node, LYD_PATH_TYPE pathtype, char *buffer, size_t buflen)
Generate path of the given node in the requested format.
const char * str
Definition tree_data.h:882
LIBYANG_API_DECL LY_ERR lyd_find_target(const struct ly_path *path, const struct lyd_node *tree, struct lyd_node **match)
Find the target node of a compiled path (lyd_value instance-identifier).
LYD_PATH_TYPE
Types of the different data paths.
Definition tree_data.h:2331
@ LYD_PATH_STD_NO_LAST_PRED
Definition tree_data.h:2334
@ LYD_PATH_STD
Definition tree_data.h:2332
LIBYANG_API_DECL LY_ERR lyd_new_implicit_module(struct lyd_node **tree, const struct lys_module *module, uint32_t implicit_options, struct lyd_node **diff)
Add any missing implicit nodes of one module. Default nodes with a false "when" are not added.
LIBYANG_API_DECL LY_ERR lyd_new_path2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const void *value, size_t value_len, LYD_ANYDATA_VALUETYPE value_type, uint32_t options, struct lyd_node **new_parent, struct lyd_node **new_node)
Create a new node in the data tree based on a path. All node types can be created.
struct lyd_value value
Definition tree_data.h:874
LIBYANG_API_DECL int ly_time_tz_offset(void)
Get current timezone (including DST setting) UTC (GMT) time offset in seconds.
LIBYANG_API_DECL LY_ERR lyd_find_path(const struct lyd_node *ctx_node, const char *path, ly_bool output, struct lyd_node **match)
Search in given data for a node uniquely identified by a path.
const struct lysc_type * realtype
Definition tree_data.h:575
LIBYANG_API_DECL LY_ERR lyd_change_meta(struct lyd_meta *meta, const char *val_str)
Change the value of a metadata instance.
LIBYANG_API_DECL LY_ERR lyd_new_list3(struct lyd_node *parent, const struct lys_module *module, const char *name, const char **key_values, uint32_t *value_lengths, uint32_t options, struct lyd_node **node)
Create a new list node in the data tree.
struct lyd_node * tree
Definition tree_data.h:881
LIBYANG_API_DECL LY_ERR ly_time_str2ts(const char *value, struct timespec *ts)
Convert date-and-time from string to timespec.
uint32_t hints
Definition tree_data.h:755
LIBYANG_API_DECL LY_ERR lyd_new_opaq(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value, const char *prefix, const char *module_name, struct lyd_node **node)
Create a new JSON opaque node in the data tree. To create an XML opaque node, use lyd_new_opaq2().
LIBYANG_API_DECL LY_ERR lyd_change_term(struct lyd_node *term, const char *val_str)
Change the value of a term (leaf or leaf-list) node to a string value.
LYD_ANYDATA_VALUETYPE value_type
Definition tree_data.h:916
LIBYANG_API_DECL LY_ERR lyd_new_attr(struct lyd_node *parent, const char *module_name, const char *name, const char *value, struct lyd_attr **attr)
Create new JSON attribute for an opaque data node. To create an XML attribute, use lyd_new_attr2().
LIBYANG_API_DECL LY_ERR lyd_insert_child(struct lyd_node *parent, struct lyd_node *node)
Insert a child into a parent.
LIBYANG_API_DECL struct lyd_node * lyd_first_sibling(const struct lyd_node *node)
Get the first sibling of the given node.
const struct lyd_node_term ** leafref_nodes
Definition tree_data.h:1024
struct lyd_attr * attr
Definition tree_data.h:1015
LIBYANG_API_DECL LY_ERR lyd_new_list(struct lyd_node *parent, const struct lys_module *module, const char *name, uint32_t options, struct lyd_node **node,...)
Create a new list node in the data tree.
LIBYANG_API_DECL LY_ERR lyd_new_implicit_all(struct lyd_node **tree, const struct ly_ctx *ctx, uint32_t implicit_options, struct lyd_node **diff)
Add any missing implicit nodes. Default nodes with a false "when" are not added.
LY_ERR(* lyd_diff_cb)(const struct lyd_node *diff_node, struct lyd_node *data_node, void *cb_data)
Callback for diff nodes.
Definition tree_data.h:2210
LIBYANG_API_DECL const struct lys_module * lyd_node_module(const struct lyd_node *node)
Get the module of a node. Useful mainly for opaque nodes.
LIBYANG_API_DECL LY_ERR lyd_dup_siblings_to_ctx(const struct lyd_node *node, const struct ly_ctx *trg_ctx, struct lyd_node_inner *parent, uint32_t options, struct lyd_node **dup)
Create a copy of the specified data tree node with any following siblings. Schema references are assi...
struct lyd_node * child
Definition tree_data.h:1007
LIBYANG_API_DECL LY_ERR lyd_compare_meta(const struct lyd_meta *meta1, const struct lyd_meta *meta2)
Compare 2 metadata.
const char * json
Definition tree_data.h:884
LIBYANG_API_DECL void lyd_free_tree(struct lyd_node *node)
Free (and unlink) the specified data (sub)tree.
LIBYANG_API_DECL LY_ERR lyd_new_meta(const struct ly_ctx *ctx, struct lyd_node *parent, const struct lys_module *module, const char *name, const char *val_str, uint32_t options, struct lyd_meta **meta)
Create a new metadata.
LIBYANG_API_DECL LY_ERR lyd_diff_tree(const struct lyd_node *first, const struct lyd_node *second, uint16_t options, struct lyd_node **diff)
Learn the differences between 2 data trees.
LIBYANG_API_DECL LY_ERR lyd_new_implicit_tree(struct lyd_node *tree, uint32_t implicit_options, struct lyd_node **diff)
Add any missing implicit nodes into a data subtree. Default nodes with a false "when" are not added.
LIBYANG_API_DECL LY_ERR lyd_find_sibling_first(const struct lyd_node *siblings, const struct lyd_node *target, struct lyd_node **match)
Search in the given siblings (NOT recursively) for the first target instance with the same value....
LIBYANG_API_DECL LY_ERR lyd_eval_xpath4(const struct lyd_node *ctx_node, const struct lyd_node *tree, const struct lys_module *cur_mod, const char *xpath, LY_VALUE_FORMAT format, void *prefix_data, const struct lyxp_var *vars, LY_XPATH_TYPE *ret_type, struct ly_set **node_set, char **string, long double *number, ly_bool *boolean)
Evaluate an XPath on data and return the result or convert it first to an expected result type.
LIBYANG_API_DECL LY_ERR lyd_leafref_link_node_tree(const struct lyd_node *tree)
Traverse through data tree including root node siblings and adds leafrefs links to the given nodes.
LIBYANG_API_DECL LY_ERR lyd_dup_single_to_ctx(const struct lyd_node *node, const struct ly_ctx *trg_ctx, struct lyd_node_inner *parent, uint32_t options, struct lyd_node **dup)
Create a copy of the specified data tree node. Schema references are assigned from trg_ctx.
struct lysc_type_bitenum_item ** items
Definition tree_data.h:646
const struct ly_ctx * ctx
Definition tree_data.h:1016
LIBYANG_API_DECL LY_ERR lyd_dup_siblings(const struct lyd_node *node, struct lyd_node_inner *parent, uint32_t options, struct lyd_node **dup)
Create a copy of the specified data tree node with any following siblings. Schema references are kept...
LIBYANG_API_DECL LY_ERR lyd_find_sibling_dup_inst_set(const struct lyd_node *siblings, const struct lyd_node *target, struct ly_set **set)
Search the given siblings for all the exact same instances of a specific node instance....
LIBYANG_API_DECL LY_ERR lyd_eval_xpath(const struct lyd_node *ctx_node, const char *xpath, ly_bool *result)
Evaluate an XPath on data and return the result converted to boolean.
LIBYANG_API_DECL const struct lysc_node * lyd_node_schema(const struct lyd_node *node)
Get schema node of a data node. Useful especially for opaque nodes.
LIBYANG_API_DECL LY_ERR lyd_new_term(struct lyd_node *parent, const struct lys_module *module, const char *name, const char *value, uint32_t options, struct lyd_node **node)
Create a new term node in the data tree.
LY_ERR(* lyd_merge_cb)(struct lyd_node *trg_node, const struct lyd_node *src_node, void *cb_data)
Callback for matching merge nodes.
Definition tree_data.h:2122
struct lyd_meta * meta
Definition tree_data.h:812
LIBYANG_API_DECL LY_ERR lyd_diff_merge_module(struct lyd_node **diff, const struct lyd_node *src_diff, const struct lys_module *mod, lyd_diff_cb diff_cb, void *cb_data, uint16_t options)
Merge 2 diffs into each other but restrict the operation to one module.
const struct lyd_node_term ** target_nodes
Definition tree_data.h:1030
uint32_t flags
Definition tree_data.h:804
LIBYANG_API_DECL int lyd_lyb_data_length(const char *data)
Learn the length of LYB data.
LIBYANG_API_DECL ly_bool lyd_meta_is_internal(const struct lyd_meta *meta)
Check whether metadata are not an instance of internal metadata.
LIBYANG_API_DECL LY_ERR lyd_new_any(struct lyd_node *parent, const struct lys_module *module, const char *name, const void *value, LYD_ANYDATA_VALUETYPE value_type, uint32_t options, struct lyd_node **node)
Create a new any node in the data tree.
LY_XPATH_TYPE
XPath result type.
Definition tree_data.h:2558
@ LY_XPATH_NODE_SET
Definition tree_data.h:2559
@ LY_XPATH_NUMBER
Definition tree_data.h:2561
@ LY_XPATH_STRING
Definition tree_data.h:2560
@ LY_XPATH_BOOLEAN
Definition tree_data.h:2562
const struct lysc_node * schema
Definition tree_data.h:805
struct in6_addr addr
Definition tree_data.h:692
LIBYANG_API_DECL LY_ERR lyd_new_ext_inner(const struct lysc_ext_instance *ext, const char *name, struct lyd_node **node)
Create a new top-level inner node defined in the given extension instance.
LIBYANG_API_DECL LY_ERR lyd_unlink_siblings(struct lyd_node *node)
Unlink the specified node with all the following siblings.
LIBYANG_API_DECL void lyd_free_siblings(struct lyd_node *node)
Free all the sibling nodes (preceding as well as succeeding).
struct lyxp_expr * exp
Definition tree_data.h:717
LIBYANG_API_DECL LY_ERR lyd_diff_merge_all(struct lyd_node **diff, const struct lyd_node *src_diff, uint16_t options)
Merge 2 diffs into each other.
const char * value
Definition tree_data.h:1010
LIBYANG_API_DECL LY_ERR lyxp_vars_set(struct lyxp_var **vars, const char *name, const char *value)
Set a new XPath variable to vars.
LIBYANG_API_DECL struct lyd_node * lyd_child_no_keys(const struct lyd_node *node)
Get the child pointer of a generic data node but skip its keys in case it is LYS_LIST.
LIBYANG_API_DECL LY_ERR lyd_insert_before(struct lyd_node *sibling, struct lyd_node *node)
Insert a node before another node, can be used only for user-ordered nodes. If inserting several sibl...
LIBYANG_API_DECL LY_ERR lyd_new_meta2(const struct ly_ctx *ctx, struct lyd_node *parent, uint32_t options, const struct lyd_attr *attr, struct lyd_meta **meta)
Create new metadata from an opaque node attribute if possible.
LIBYANG_API_DECL LY_ERR lyd_diff_siblings(const struct lyd_node *first, const struct lyd_node *second, uint16_t options, struct lyd_node **diff)
Learn the differences between 2 data trees including all the following siblings.
LIBYANG_API_DECL LY_ERR lyd_leafref_get_links(const struct lyd_node_term *node, const struct lyd_leafref_links_rec **record)
Gets the leafref links record for given node.
const char * name
Definition tree_data.h:738
LIBYANG_API_DECL int ly_time_tz_offset_at(time_t time)
Get UTC (GMT) timezone offset in seconds at a specific timestamp (including DST setting).
void * prefix_data
Definition tree_data.h:635
LIBYANG_API_DECL LY_ERR lyd_compare_siblings(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options)
Compare 2 lists of siblings if they are equivalent.
LIBYANG_API_DECL LY_ERR lyd_new_ext_list(const struct lysc_ext_instance *ext, const char *name, uint32_t options, struct lyd_node **node,...)
Create a new top-level list node defined in the given extension instance.
LIBYANG_API_DECL LY_ERR ly_time_time2str(time_t time, const char *fractions_s, char **str)
Convert UNIX timestamp and fractions of a second into canonical date-and-time string value.
LIBYANG_API_DEF LY_ERR lyd_trim_xpath(struct lyd_node **tree, const char *xpath, const struct lyxp_var *vars)
Evaluate an XPath on data and free all the nodes except the subtrees selected by the expression.
const struct lyd_node_term * node
Definition tree_data.h:1023
LIBYANG_API_DECL LY_ERR lyd_value_compare(const struct lyd_node_term *node, const char *value, size_t value_len)
Compare the node's value with the given string value. The string value is first validated according t...
#define LYD_NODE_TERM
Definition tree_data.h:761
LIBYANG_API_DECL LY_ERR lyd_find_sibling_val(const struct lyd_node *siblings, const struct lysc_node *schema, const char *key_or_value, size_t val_len, struct lyd_node **match)
Search in the given siblings for the first schema instance. Uses hashes - should be used whenever pos...
uint32_t hints
Definition tree_data.h:1011
LIBYANG_API_DECL LY_ERR lyd_new_ext_path(struct lyd_node *parent, const struct lysc_ext_instance *ext, const char *path, const void *value, uint32_t options, struct lyd_node **node)
Create a new node defined in the given extension instance. In case of anyxml/anydata nodes,...
LIBYANG_API_DECL LY_ERR lyd_any_copy_value(struct lyd_node *trg, const union lyd_any_value *value, LYD_ANYDATA_VALUETYPE value_type)
Copy anydata value from one node to another. Target value is freed first.
LIBYANG_API_DECL uint32_t lyd_list_pos(const struct lyd_node *instance)
Learn the relative position of a list or leaf-list instance within other instances of the same schema...
LIBYANG_API_DECL LY_ERR lyd_insert_after(struct lyd_node *sibling, struct lyd_node *node)
Insert a node after another node, can be used only for user-ordered nodes. If inserting several sibli...
LIBYANG_API_DECL LY_ERR lyd_diff_reverse_all(const struct lyd_node *src_diff, struct lyd_node **diff)
Reverse a diff and make the opposite changes. Meaning change create to delete, delete to create,...
LIBYANG_API_DECL LY_ERR lyd_find_xpath3(const struct lyd_node *ctx_node, const struct lyd_node *tree, const char *xpath, LY_VALUE_FORMAT format, void *prefix_data, const struct lyxp_var *vars, struct ly_set **set)
Search in the given data for instances of nodes matching the provided XPath.
struct ly_opaq_name name
Definition tree_data.h:753
LIBYANG_API_DECL LY_ERR lyd_compare_single(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options)
Compare 2 data nodes if they are equivalent.
LIBYANG_API_DECL struct lyd_meta * lyd_find_meta(const struct lyd_meta *first, const struct lys_module *module, const char *name)
Find a specific metadata.
LIBYANG_API_DECL LY_ERR lyd_merge_tree(struct lyd_node **target, const struct lyd_node *source, uint16_t options)
Merge the source data subtree into the target data tree. Merge may not be complete until validation i...
LIBYANG_API_DECL LY_ERR lyd_dup_single(const struct lyd_node *node, struct lyd_node_inner *parent, uint32_t options, struct lyd_node **dup)
Create a copy of the specified data tree node. Schema references are kept the same.
LIBYANG_API_DECL LY_ERR lyd_new_attr2(struct lyd_node *parent, const char *module_ns, const char *name, const char *value, struct lyd_attr **attr)
Create new XML attribute for an opaque data node. To create a JSON attribute, use lyd_new_attr().
uint32_t hash
Definition tree_data.h:800
void * val_prefix_data
Definition tree_data.h:757
struct in_addr addr
Definition tree_data.h:677
LIBYANG_API_DECL LY_ERR lyd_change_term_bin(struct lyd_node *term, const void *value, size_t value_len)
Change the value of a term (leaf or leaf-list) node to a binary value.
struct lyd_node * prev
Definition tree_data.h:808
LIBYANG_API_DECL LY_ERR lyd_find_xpath2(const struct lyd_node *ctx_node, const char *xpath, const struct lyxp_var *vars, struct ly_set **set)
Search in the given data for instances of nodes matching the provided XPath.
LIBYANG_API_DECL LY_ERR lyd_new_list2(struct lyd_node *parent, const struct lys_module *module, const char *name, const char *keys, uint32_t options, struct lyd_node **node)
Create a new list node in the data tree.
LIBYANG_API_DECL const struct lys_module * lyd_owner_module(const struct lyd_node *node)
Get the owner module of the data node. It is the module of the top-level schema node....
struct lyd_node * child
Definition tree_data.h:842
const char * xml
Definition tree_data.h:883
LIBYANG_API_DECL void lyd_free_attr_siblings(const struct ly_ctx *ctx, struct lyd_attr *attr)
Free the attribute with any following attributes.
LIBYANG_API_DECL LY_ERR lyd_parse_opaq_error(const struct lyd_node *node)
Check node parsed into an opaque node for the reason (error) why it could not be parsed as data node.
LY_VALUE_FORMAT format
Definition tree_data.h:720
void * priv
Definition tree_data.h:813
LIBYANG_API_DECL ly_bool lyd_is_default(const struct lyd_node *node)
Check whether a node value equals to its default one.
LIBYANG_API_DECL LY_ERR lyd_diff_merge_tree(struct lyd_node **diff_first, struct lyd_node *diff_parent, const struct lyd_node *src_sibling, lyd_diff_cb diff_cb, void *cb_data, uint16_t options)
Merge 2 diff trees into each other.
LIBYANG_API_DECL LY_ERR lyd_value_validate(const struct ly_ctx *ctx, const struct lysc_node *schema, const char *value, size_t value_len, const struct lyd_node *ctx_node, const struct lysc_type **realtype, const char **canonical)
Check type restrictions applicable to the particular leaf/leaf-list with the given string value.
LIBYANG_API_DECL LY_ERR lyd_new_inner(struct lyd_node *parent, const struct lys_module *module, const char *name, ly_bool output, struct lyd_node **node)
Create a new inner node in the data tree.
struct ly_ht * children_ht
Definition tree_data.h:843
LY_VALUE_FORMAT format
Definition tree_data.h:1012
LIBYANG_API_DECL void lyd_free_attr_single(const struct ly_ctx *ctx, struct lyd_attr *attr)
Free a single attribute.
LIBYANG_API_DECL LY_ERR lyd_diff_apply_module(struct lyd_node **data, const struct lyd_node *diff, const struct lys_module *mod, lyd_diff_cb diff_cb, void *cb_data)
Apply the whole diff on a data tree but restrict the operation to one module.
const char * value
Definition tree_data.h:754
LIBYANG_API_DECL LY_ERR lyd_dup_meta_single(const struct lyd_meta *meta, struct lyd_node *parent, struct lyd_meta **dup)
Create a copy of the metadata.
const struct ly_ctx * ctx
Definition tree_data.h:718
LIBYANG_API_DECL LY_ERR lyd_unlink_tree(struct lyd_node *node)
Unlink the specified data subtree.
union lyd_any_value value
Definition tree_data.h:915
struct lyd_attr * next
Definition tree_data.h:752
LIBYANG_API_DECL LY_ERR lyd_diff_apply_all(struct lyd_node **data, const struct lyd_node *diff)
Apply the whole diff tree on a data tree.
LIBYANG_API_DECL LY_ERR lyd_new_ext_any(const struct lysc_ext_instance *ext, const char *name, const void *value, LYD_ANYDATA_VALUETYPE value_type, uint32_t options, struct lyd_node **node)
Create a new top-level any node defined in the given extension instance.
uint32_t hints
Definition tree_data.h:631
LIBYANG_API_DECL LY_ERR lyd_new_ext_term(const struct lysc_ext_instance *ext, const char *name, const void *value, size_t value_len, uint32_t options, struct lyd_node **node)
Create a new top-level term node defined in the given extension instance.
LIBYANG_API_DECL LY_ERR lyd_eval_xpath2(const struct lyd_node *ctx_node, const char *xpath, const struct lyxp_var *vars, ly_bool *result)
Evaluate an XPath on data and return the result converted to boolean.
struct in6_addr addr
Definition tree_data.h:700
struct lyd_value value
Definition tree_data.h:627
const char * _canonical
Definition tree_data.h:572
struct lyd_node_opaq * parent
Definition tree_data.h:751
LY_VALUE_FORMAT format
Definition tree_data.h:632
LIBYANG_API_DECL LY_ERR lyd_merge_module(struct lyd_node **target, const struct lyd_node *source, const struct lys_module *mod, lyd_merge_cb merge_cb, void *cb_data, uint16_t options)
Merge all the nodes of a module from source data tree into the target data tree. Merge may not be com...
LIBYANG_API_DECL LY_ERR lyd_new_term_bin(struct lyd_node *parent, const struct lys_module *module, const char *name, const void *value, size_t value_len, uint32_t options, struct lyd_node **node)
Create a new term node in the data tree based on binary value.
struct lyd_node_inner * parent
Definition tree_data.h:806
struct ly_opaq_name name
Definition tree_data.h:1009
LIBYANG_API_DECL void lyd_free_meta_single(struct lyd_meta *meta)
Free a single metadata instance.
LIBYANG_API_DECL LY_ERR lyd_change_term_canon(struct lyd_node *term, const char *val_str)
Change the value of a term (leaf or leaf-list) node to a canonical string value.
LIBYANG_API_DECL LY_ERR lyd_eval_xpath3(const struct lyd_node *ctx_node, const struct lys_module *cur_mod, const char *xpath, LY_VALUE_FORMAT format, void *prefix_data, const struct lyxp_var *vars, ly_bool *result)
Evaluate an XPath on data and return the result converted to boolean.
LIBYANG_API_DECL LY_ERR lyd_insert_sibling(struct lyd_node *sibling, struct lyd_node *node, struct lyd_node **first)
Insert a node into siblings.
const struct lysc_node * ctx_node
Definition tree_data.h:636
LIBYANG_API_DECL LY_ERR lyd_any_value_str(const struct lyd_node *any, char **value_str)
Get anydata string value.
LIBYANG_API_DECL LY_ERR lyd_new_opaq2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value, const char *prefix, const char *module_ns, struct lyd_node **node)
Create a new XML opaque node in the data tree. To create a JSON opaque node, use lyd_new_opaq().
Generic prefix and namespace mapping, meaning depends on the format.
Definition tree_data.h:737
Generic attribute structure.
Definition tree_data.h:750
Generic structure for a data node.
Definition tree_data.h:799
Data node structure for the anydata data tree nodes - anydata or anyxml.
Definition tree_data.h:892
Data node structure for the inner data tree nodes - containers, lists, RPCs, actions and Notification...
Definition tree_data.h:819
Data node structure for unparsed (opaque) nodes.
Definition tree_data.h:988
Data node structure for the terminal data tree nodes - leaves and leaf-lists.
Definition tree_data.h:851
YANG data representation.
Definition tree_data.h:571
Special lyd_value structure for built-in binary values.
Definition tree_data.h:653
Special lyd_value structure for built-in bits values.
Definition tree_data.h:642
Special lyd_value structure for ietf-yang-types date-and-time values.
Definition tree_data.h:707
Special lyd_value structure for ietf-inet-types ipv4-address values.
Definition tree_data.h:668
Special lyd_value structure for ietf-inet-types ipv4-address-no-zone values.
Definition tree_data.h:661
Special lyd_value structure for ietf-inet-types ipv4-prefix values.
Definition tree_data.h:676
Special lyd_value structure for ietf-inet-types ipv6-address values.
Definition tree_data.h:691
Special lyd_value structure for ietf-inet-types ipv6-address-no-zone values.
Definition tree_data.h:684
Special lyd_value structure for ietf-inet-types ipv6-prefix values.
Definition tree_data.h:699
Special lyd_value structure for lyds tree value.
Definition tree_data.h:726
Special lyd_value structure for built-in union values.
Definition tree_data.h:626
Special lyd_value structure for ietf-yang-types xpath1.0 values.
Definition tree_data.h:716
union for anydata/anyxml value representation.
Definition tree_data.h:880
libyang representation of YANG schema trees.