libyang 5.8.5
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/* socket/ip includes in ly_config.h */
20
21#include <stddef.h>
22#include <stdint.h>
23#include <time.h>
24
25#include "log.h"
26#include "ly_config.h"
27#include "tree.h"
28#include "tree_schema.h"
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
34struct ly_ctx;
35struct ly_path;
36struct ly_set;
37struct lyd_node;
38struct lyd_node_opaq;
39struct lyd_node_term;
40struct timespec;
41struct lyxp_var;
42struct rb_node;
43
389/* *INDENT-OFF* */
390
416#define LYD_TREE_DFS_BEGIN(START, ELEM) \
417 { ly_bool LYD_TREE_DFS_continue = 0; struct lyd_node *LYD_TREE_DFS_next; \
418 for ((ELEM) = (LYD_TREE_DFS_next) = (struct lyd_node *)(START); \
419 (ELEM); \
420 (ELEM) = (LYD_TREE_DFS_next), LYD_TREE_DFS_continue = 0)
421
425#define _LYD_TREE_DFS_END(START, ELEM, FUNC) \
426 /* select element for the next run - children first */ \
427 if (LYD_TREE_DFS_continue) { \
428 (LYD_TREE_DFS_next) = NULL; \
429 } else { \
430 (LYD_TREE_DFS_next) = FUNC(ELEM); \
431 }\
432 if (!(LYD_TREE_DFS_next)) { \
433 /* no children */ \
434 if ((ELEM) == (struct lyd_node *)(START)) { \
435 /* we are done, (START) has no children */ \
436 break; \
437 } \
438 /* try siblings */ \
439 (LYD_TREE_DFS_next) = (ELEM)->next; \
440 } \
441 while (!(LYD_TREE_DFS_next)) { \
442 /* parent is already processed, go to its sibling */ \
443 (ELEM) = (struct lyd_node *)(ELEM)->parent; \
444 /* no siblings, go back through parents */ \
445 if ((ELEM)->parent == (START)->parent) { \
446 /* we are done, no next element to process */ \
447 break; \
448 } \
449 (LYD_TREE_DFS_next) = (ELEM)->next; \
450 } }
451
467#define LYD_TREE_DFS_END(START, ELEM) \
468 _LYD_TREE_DFS_END(START, ELEM, lyd_child)
469
485#define LYD_TREE_ANY_DFS_END(START, ELEM) \
486 _LYD_TREE_DFS_END(START, ELEM, lyd_child_any)
487
495#define LYD_LIST_FOR_INST(START, SCHEMA, ELEM) \
496 for (lyd_find_sibling_val(START, SCHEMA, NULL, 0, &(ELEM)); \
497 (ELEM) && ((ELEM)->schema == (SCHEMA)); \
498 (ELEM) = (ELEM)->next)
499
508#define LYD_LIST_FOR_INST_SAFE(START, SCHEMA, NEXT, ELEM) \
509 for ((NEXT) = (ELEM) = NULL, lyd_find_sibling_val(START, SCHEMA, NULL, 0, &(ELEM)); \
510 (ELEM) && ((ELEM)->schema == (SCHEMA)) ? ((NEXT) = (ELEM)->next, 1) : 0; \
511 (ELEM) = (NEXT))
512
513/* *INDENT-ON* */
514
518#define LYD_CTX(node) ((node)->schema ? (node)->schema->module->ctx : ((const struct lyd_node_opaq *)(node))->ctx)
519
527#define LYD_NODE_IS_ALONE(NODE) \
528 (((NODE)->prev == NODE) || \
529 (((NODE)->prev->schema != (NODE)->schema) && (!(NODE)->next || ((NODE)->schema != (NODE)->next->schema))))
530
541
547struct lyd_value {
548 const char *_canonical;
551 const struct lysc_type *realtype;
559 union {
560 int8_t boolean;
561 int64_t dec64;
562 int8_t int8;
563 int16_t int16;
564 int32_t int32;
565 int64_t int64;
566 uint8_t uint8;
567 uint16_t uint16;
568 uint32_t uint32;
569 uint64_t uint64;
570 struct lysc_type_bitenum_item *enum_item;
571 struct lysc_ident *ident;
572 struct ly_path *target;
574 struct lyd_value_union *subvalue;
576 void *dyn_mem;
577 uint8_t fixed_mem[LYD_VALUE_FIXED_MEM_SIZE];
578 };
580};
581
590#define LYD_VALUE_GET(value, type_val) \
591 ((sizeof *(type_val) > LYD_VALUE_FIXED_MEM_SIZE) \
592 ? ((type_val) = (((value)->dyn_mem))) \
593 : ((type_val) = ((void *)((value)->fixed_mem))))
594
614
625
630 void *data;
631 uint32_t size;
632};
633
638 struct in_addr addr;
639};
640
645 struct in_addr addr;
646 const char *zone;
647};
648
653 struct in_addr addr;
654 uint8_t prefix;
655};
656
661 struct in6_addr addr;
662};
663
668 struct in6_addr addr;
669 const char *zone;
670};
671
676 struct in6_addr addr;
677 uint8_t prefix;
678};
679
688
696
701 time_t time;
702};
703
712
717 uint32_t seconds;
719};
720
725 struct lyxp_expr *exp;
726 const struct ly_ctx *ctx;
729};
730
735 struct rb_node *rbt;
736};
737
746 const char *name;
747 const char *prefix;
749 union {
750 const char *module_ns;
751 const char *module_name;
752 };
753};
754
767
768#define LYD_NODE_INNER (LYS_CONTAINER|LYS_LIST|LYS_RPC|LYS_ACTION|LYS_NOTIF)
769#define LYD_NODE_TERM (LYS_LEAF|LYS_LEAFLIST)
770#define LYD_NODE_ANY (LYS_ANYDATA)
797#define LYD_DEFAULT 0x01
798#define LYD_WHEN_TRUE 0x02
799#define LYD_NEW 0x04
800#define LYD_EXT 0x08
807struct lyd_node {
808 uint32_t hash;
812 uint32_t flags;
813 const struct lysc_node *schema;
814 struct lyd_node *parent;
815 struct lyd_node *next;
816 struct lyd_node *prev;
820 struct lyd_meta *meta;
821 void *priv;
822};
823
828 union {
829 struct lyd_node node;
831 struct {
832 uint32_t hash;
837 uint32_t flags;
838 const struct lysc_node *schema;
839 struct lyd_node *parent;
840 struct lyd_node *next;
841 struct lyd_node *prev;
845 struct lyd_meta *meta;
846 void *priv;
847 };
848 };
850 struct lyd_node *child;
853#define LYD_HT_MIN_ITEMS 4
854};
855
860 union {
861 struct lyd_node node;
863 struct {
864 uint32_t hash;
869 uint32_t flags;
870 const struct lysc_node *schema;
871 struct lyd_node *parent;
872 struct lyd_node *next;
873 struct lyd_node *prev;
877 struct lyd_meta *meta;
878 void *priv;
879 };
880 };
883};
884
889 union {
890 struct lyd_node node;
892 struct {
893 uint32_t hash;
898 uint32_t flags;
899 const struct lysc_node *schema;
900 struct lyd_node *parent;
901 struct lyd_node *next;
902 struct lyd_node *prev;
906 struct lyd_meta *meta;
907 void *priv;
908 };
909 };
911 struct lyd_node *child;
913 const char *value;
914 uint32_t hints;
916};
917
924#define LYD_NAME(node) ((node)->schema ? (node)->schema->name : ((struct lyd_node_opaq *)node)->name.name)
925
935#define LYD_VALHINT_STRING 0x0001
936#define LYD_VALHINT_DECNUM 0x0002
937#define LYD_VALHINT_OCTNUM 0x0004
938#define LYD_VALHINT_HEXNUM 0x0008
939#define LYD_VALHINT_NUM64 0x0010
940#define LYD_VALHINT_BOOLEAN 0x0020
941#define LYD_VALHINT_EMPTY 0x0040
942#define LYD_VALHINT_STRING_DATATYPES 0x0080
956#define LYD_NODEHINT_LIST 0x1000
957#define LYD_NODEHINT_LEAFLIST 0x2000
958#define LYD_NODEHINT_CONTAINER 0x4000
973#define LYD_HINT_DATA 0xFFF3
977#define LYD_HINT_SCHEMA 0xFFFF
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 *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
1042#define lyd_parent(node) ((node) ? (node)->parent : NULL)
1043
1055static inline struct lyd_node *
1056lyd_child(const struct lyd_node *node)
1057{
1058 if (!node) {
1059 return NULL;
1060 }
1061
1062 if (!node->schema) {
1063 /* opaq node */
1064 return ((const struct lyd_node_opaq *)node)->child;
1065 }
1066
1068 return ((const struct lyd_node_inner *)node)->child;
1069 }
1070
1071 return NULL;
1072}
1073
1085static inline struct lyd_node *
1086lyd_child_any(const struct lyd_node *node)
1087{
1088 if (!node) {
1089 return NULL;
1090 }
1091
1092 if (!node->schema) {
1093 /* opaq node */
1094 return ((const struct lyd_node_opaq *)node)->child;
1095 }
1096
1098 return ((const struct lyd_node_inner *)node)->child;
1099 }
1100
1101 return NULL;
1102}
1103
1112LIBYANG_API_DECL struct lyd_node *lyd_child_no_keys(const struct lyd_node *node);
1113
1123LIBYANG_API_DECL const struct lys_module *lyd_owner_module(const struct lyd_node *node);
1124
1131LIBYANG_API_DECL const struct lys_module *lyd_node_module(const struct lyd_node *node);
1132
1139LIBYANG_API_DECL ly_bool lyd_is_default(const struct lyd_node *node);
1140
1148LIBYANG_API_DECL uint32_t lyd_list_pos(const struct lyd_node *instance);
1149
1156LIBYANG_API_DECL struct lyd_node *lyd_first_sibling(const struct lyd_node *node);
1157
1167LIBYANG_API_DECL LY_ERR lyd_parse_opaq_error(const struct lyd_node *node);
1168
1178LIBYANG_API_DECL const char *lyd_value_get_canonical(const struct ly_ctx *ctx, const struct lyd_value *value);
1179
1186static inline const char *
1187lyd_get_value(const struct lyd_node *node)
1188{
1189 if (!node) {
1190 return NULL;
1191 }
1192
1193 if (!node->schema) {
1194 return ((const struct lyd_node_opaq *)node)->value;
1195 } else if (node->schema->nodetype & LYD_NODE_TERM) {
1196 const struct lyd_value *value = &((const struct lyd_node_term *)node)->value;
1197
1199 }
1200
1201 return NULL;
1202}
1203
1212LIBYANG_API_DECL LY_ERR lyd_any_value_str(const struct lyd_node *any, LYD_FORMAT format, char **value_str);
1213
1225LIBYANG_API_DECL LY_ERR lyd_any_copy_value(struct lyd_node *trg, const struct lyd_node *child, const char *value,
1226 uint32_t hints);
1227
1234LIBYANG_API_DECL const struct lysc_node *lyd_node_schema(const struct lyd_node *node);
1235
1243LIBYANG_API_DECL ly_bool lyd_meta_is_internal(const struct lyd_meta *meta);
1244
1258LIBYANG_API_DECL LY_ERR lyd_new_inner(struct lyd_node *parent, const struct lys_module *module, const char *name,
1259 ly_bool output, struct lyd_node **node);
1260
1282#define LYD_NEW_VAL_OUTPUT 0x01
1284#define LYD_NEW_VAL_STORE_ONLY 0x02
1285#define LYD_NEW_VAL_CANON 0x04
1288#define LYD_NEW_META_CLEAR_DFLT 0x08
1289#define LYD_NEW_PATH_UPDATE 0x10
1293#define LYD_NEW_PATH_OPAQ 0x20
1297#define LYD_NEW_PATH_WITH_OPAQ 0x40
1298#define LYD_NEW_PATH_ANY_DATATREE 0x80
1299#define LYD_NEW_ANY_USE_VALUE 0x0100
1315LIBYANG_API_DECL LY_ERR lyd_new_list(struct lyd_node *parent, const struct lys_module *module, const char *name,
1316 uint32_t options, struct lyd_node **node, ...);
1317
1331LIBYANG_API_DECL LY_ERR lyd_new_list2(struct lyd_node *parent, const struct lys_module *module, const char *name,
1332 const char *keys, uint32_t options, struct lyd_node **node);
1333
1347LIBYANG_API_DECL LY_ERR lyd_new_list3(struct lyd_node *parent, const struct lys_module *module, const char *name,
1348 const void **key_values, uint32_t *value_sizes_bits, uint32_t options, struct lyd_node **node);
1349
1361LIBYANG_API_DECL LY_ERR lyd_new_term(struct lyd_node *parent, const struct lys_module *module, const char *name,
1362 const char *value, uint32_t options, struct lyd_node **node);
1363
1385LIBYANG_API_DECL LY_ERR lyd_new_term_raw(struct lyd_node *parent, const struct lys_module *module, const char *name,
1386 const void *value_ptr, uint32_t value_size, uint32_t options, struct lyd_node **node);
1387
1401LIBYANG_API_DECL LY_ERR lyd_new_any(struct lyd_node *parent, const struct lys_module *module, const char *name,
1402 const struct lyd_node *child, const char *value, uint32_t hints, uint32_t options, struct lyd_node **node);
1403
1418LIBYANG_API_DECL LY_ERR lyd_new_meta(const struct ly_ctx *ctx, struct lyd_node *parent, const struct lys_module *module,
1419 const char *name, const char *val_str, uint32_t options, struct lyd_meta **meta);
1420
1433LIBYANG_API_DECL LY_ERR lyd_new_meta2(const struct ly_ctx *ctx, struct lyd_node *parent, uint32_t options,
1434 const struct lyd_attr *attr, struct lyd_meta **meta);
1435
1448LIBYANG_API_DECL LY_ERR lyd_new_opaq(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value,
1449 const char *prefix, const char *module_name, struct lyd_node **node);
1450
1463LIBYANG_API_DECL LY_ERR lyd_new_opaq2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value,
1464 const char *prefix, const char *module_ns, struct lyd_node **node);
1465
1479LIBYANG_API_DECL LY_ERR lyd_new_attr(struct lyd_node *parent, const char *module_name, const char *name, const char *value,
1480 struct lyd_attr **attr);
1481
1494LIBYANG_API_DECL LY_ERR lyd_new_attr2(struct lyd_node *parent, const char *module_ns, const char *name, const char *value,
1495 struct lyd_attr **attr);
1496
1525LIBYANG_API_DECL LY_ERR lyd_new_path(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const char *value,
1526 uint32_t options, struct lyd_node **node);
1527
1553LIBYANG_API_DECL LY_ERR lyd_new_path2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path,
1554 const void *value, uint64_t value_size_bits, uint32_t any_hints, uint32_t options, struct lyd_node **new_parent,
1555 struct lyd_node **new_node);
1556
1570#define LYD_IMPLICIT_NO_STATE 0x01
1571#define LYD_IMPLICIT_NO_CONFIG 0x02
1572#define LYD_IMPLICIT_OUTPUT 0x04
1573#define LYD_IMPLICIT_NO_DEFAULTS 0x08
1586LIBYANG_API_DECL LY_ERR lyd_new_implicit_tree(struct lyd_node *tree, uint32_t implicit_options, struct lyd_node **diff);
1587
1599LIBYANG_API_DECL LY_ERR lyd_new_implicit_all(struct lyd_node **tree, const struct ly_ctx *ctx, uint32_t implicit_options,
1600 struct lyd_node **diff);
1601
1613LIBYANG_API_DECL LY_ERR lyd_new_implicit_module(struct lyd_node **tree, const struct lys_module *module,
1614 uint32_t implicit_options, struct lyd_node **diff);
1615
1629LIBYANG_API_DECL LY_ERR lyd_change_term(struct lyd_node *term, const char *val_str);
1630
1645LIBYANG_API_DECL LY_ERR lyd_change_term_canon(struct lyd_node *term, const char *val_str);
1646
1656LIBYANG_API_DECL LY_ERR lyd_change_meta(struct lyd_meta *meta, const char *val_str);
1657
1669LIBYANG_API_DECL LY_ERR lyd_insert_child(struct lyd_node *parent, struct lyd_node *node);
1670
1683LIBYANG_API_DECL LY_ERR lyd_insert_sibling(struct lyd_node *sibling, struct lyd_node *node, struct lyd_node **first);
1684
1696LIBYANG_API_DECL LY_ERR lyd_insert_before(struct lyd_node *sibling, struct lyd_node *node);
1697
1709LIBYANG_API_DECL LY_ERR lyd_insert_after(struct lyd_node *sibling, struct lyd_node *node);
1710
1718LIBYANG_API_DECL LY_ERR lyd_unlink_siblings(struct lyd_node *node);
1719
1727LIBYANG_API_DECL LY_ERR lyd_unlink_tree(struct lyd_node *node);
1728
1734LIBYANG_API_DECL void lyd_free_all(struct lyd_node *node);
1735
1741LIBYANG_API_DECL void lyd_free_siblings(struct lyd_node *node);
1742
1748LIBYANG_API_DECL void lyd_free_tree(struct lyd_node *node);
1749
1755LIBYANG_API_DECL void lyd_free_meta_single(struct lyd_meta *meta);
1756
1762LIBYANG_API_DECL void lyd_free_meta_siblings(struct lyd_meta *meta);
1763
1770LIBYANG_API_DECL void lyd_free_attr_single(const struct ly_ctx *ctx, struct lyd_attr *attr);
1771
1778LIBYANG_API_DECL void lyd_free_attr_siblings(const struct ly_ctx *ctx, struct lyd_attr *attr);
1779
1797LIBYANG_API_DECL LY_ERR lyd_value_validate(const struct lysc_node *schema, const char *value, uint32_t value_len,
1798 const struct lyd_node *ctx_node, const struct lysc_type **realtype, const char **canonical);
1799
1817LIBYANG_API_DECL LY_ERR lyd_value_validate_dflt(const struct lysc_node *schema, const char *value,
1818 struct lysc_prefix *prefixes, const struct lyd_node *ctx_node, const struct lysc_type **realtype,
1819 const char **canonical);
1820
1833LIBYANG_API_DECL LY_ERR lyd_value_compare(const struct lyd_node_term *node, const char *value, uint32_t value_len);
1834
1841#define LYD_COMPARE_FULL_RECURSION 0x01 /* Lists and containers are the same only in case all they children
1842 (subtree, so direct as well as indirect children) are the same. By default,
1843 containers are the same in case of the same schema node and lists are the same
1844 in case of equal keys (keyless lists do the full recursion comparison all the time). */
1845#define LYD_COMPARE_DEFAULTS 0x02 /* By default, implicit and explicit default nodes are considered to be equal. This flag
1846 changes this behavior and implicit (automatically created default node) and explicit
1847 (explicitly created node with the default value) default nodes are considered different. */
1848#define LYD_COMPARE_OPAQ 0x04 /* Opaque nodes can normally be never equal to data nodes. Using this flag even
1849 opaque nodes members are compared to data node schema and value and can result
1850 in a match. */
1864LIBYANG_API_DECL LY_ERR lyd_compare_single(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
1865
1877LIBYANG_API_DECL LY_ERR lyd_compare_siblings(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
1878
1889LIBYANG_API_DECL LY_ERR lyd_compare_meta(const struct lyd_meta *meta1, const struct lyd_meta *meta2);
1890
1903#define LYD_DUP_RECURSIVE 0x01
1905#define LYD_DUP_NO_META 0x02
1907#define LYD_DUP_WITH_PARENTS 0x04
1909#define LYD_DUP_WITH_FLAGS 0x08
1911#define LYD_DUP_NO_EXT 0x10
1912#define LYD_DUP_WITH_PRIV 0x20
1914#define LYD_DUP_NO_LYDS 0x40
1932LIBYANG_API_DECL LY_ERR lyd_dup_single(const struct lyd_node *node, struct lyd_node *parent, uint32_t options,
1933 struct lyd_node **dup);
1934
1948LIBYANG_API_DECL LY_ERR lyd_dup_single_to_ctx(const struct lyd_node *node, const struct ly_ctx *trg_ctx,
1949 struct lyd_node *parent, uint32_t options, struct lyd_node **dup);
1950
1962LIBYANG_API_DECL LY_ERR lyd_dup_siblings(const struct lyd_node *node, struct lyd_node *parent, uint32_t options,
1963 struct lyd_node **dup);
1964
1979LIBYANG_API_DECL LY_ERR lyd_dup_siblings_to_ctx(const struct lyd_node *node, const struct ly_ctx *trg_ctx,
1980 struct lyd_node *parent, uint32_t options, struct lyd_node **dup);
1981
1990LIBYANG_API_DECL LY_ERR lyd_dup_meta_single(const struct lyd_meta *meta, struct lyd_node *parent, struct lyd_meta **dup);
1991
2006#define LYD_MERGE_DESTRUCT 0x01
2007#define LYD_MERGE_DEFAULTS 0x02
2008#define LYD_MERGE_WITH_FLAGS 0x04
2032LIBYANG_API_DECL LY_ERR lyd_merge_tree(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
2033
2055LIBYANG_API_DECL LY_ERR lyd_merge_siblings(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
2056
2066typedef LY_ERR (*lyd_merge_cb)(struct lyd_node *trg_node, const struct lyd_node *src_node, void *cb_data);
2067
2083LIBYANG_API_DECL LY_ERR lyd_merge_module(struct lyd_node **target, const struct lyd_node *source, const struct lys_module *mod,
2084 lyd_merge_cb merge_cb, void *cb_data, uint16_t options);
2085
2100#define LYD_DIFF_DEFAULTS 0x01
2103#define LYD_DIFF_META 0x02
2134LIBYANG_API_DECL LY_ERR lyd_diff_tree(const struct lyd_node *first, const struct lyd_node *second, uint16_t options,
2135 struct lyd_node **diff);
2136
2149LIBYANG_API_DECL LY_ERR lyd_diff_siblings(const struct lyd_node *first, const struct lyd_node *second, uint16_t options,
2150 struct lyd_node **diff);
2151
2160typedef LY_ERR (*lyd_diff_cb)(const struct lyd_node *diff_node, struct lyd_node *data_node, void *cb_data);
2161
2178LIBYANG_API_DECL LY_ERR lyd_diff_apply_module(struct lyd_node **data, const struct lyd_node *diff,
2179 const struct lys_module *mod, lyd_diff_cb diff_cb, void *cb_data);
2180
2191LIBYANG_API_DECL LY_ERR lyd_diff_apply_all(struct lyd_node **data, const struct lyd_node *diff);
2192
2204#define LYD_DIFF_MERGE_DEFAULTS 0x01
2232LIBYANG_API_DECL LY_ERR lyd_diff_merge_module(struct lyd_node **diff, const struct lyd_node *src_diff,
2233 const struct lys_module *mod, lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
2234
2251LIBYANG_API_DECL LY_ERR lyd_diff_merge_tree(struct lyd_node **diff_first, struct lyd_node *diff_parent,
2252 const struct lyd_node *src_sibling, lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
2253
2265LIBYANG_API_DECL LY_ERR lyd_diff_merge_all(struct lyd_node **diff, const struct lyd_node *src_diff, uint16_t options);
2266
2276LIBYANG_API_DECL LY_ERR lyd_diff_reverse_all(const struct lyd_node *src_diff, struct lyd_node **diff);
2277
2281typedef enum {
2282 LYD_PATH_STD,
2287
2303LIBYANG_API_DECL char *lyd_path(const struct lyd_node *node, LYD_PATH_TYPE pathtype, char *buffer, size_t buflen);
2304
2314LIBYANG_API_DECL struct lyd_meta *lyd_find_meta(const struct lyd_meta *first, const struct lys_module *module,
2315 const char *name);
2316
2328LIBYANG_API_DECL LY_ERR lyd_find_sibling_first(const struct lyd_node *siblings, const struct lyd_node *target,
2329 struct lyd_node **match);
2330
2355LIBYANG_API_DECL LY_ERR lyd_find_sibling_val(const struct lyd_node *siblings, const struct lysc_node *schema,
2356 const char *key_or_value, uint32_t val_len, struct lyd_node **match);
2357
2369LIBYANG_API_DECL LY_ERR lyd_find_sibling_dup_inst_set(const struct lyd_node *siblings, const struct lyd_node *target,
2370 struct ly_set **set);
2371
2382LIBYANG_API_DECL LY_ERR lyd_find_sibling_opaq_next(const struct lyd_node *first, const char *name, struct lyd_node **match);
2383
2395LIBYANG_API_DECL LY_ERR lyxp_vars_set(struct lyxp_var **vars, const char *name, const char *value);
2396
2402LIBYANG_API_DECL void lyxp_vars_free(struct lyxp_var *vars);
2403
2423LIBYANG_API_DECL LY_ERR lyd_find_xpath(const struct lyd_node *ctx_node, const char *xpath, struct ly_set **set);
2424
2438LIBYANG_API_DECL LY_ERR lyd_find_xpath2(const struct lyd_node *ctx_node, const char *xpath, const struct lyxp_var *vars,
2439 struct ly_set **set);
2440
2458LIBYANG_API_DECL LY_ERR lyd_find_xpath3(const struct lyd_node *ctx_node, const struct lyd_node *tree, const char *xpath,
2459 LY_VALUE_FORMAT format, void *prefix_data, const struct lyxp_var *vars, struct ly_set **set);
2460
2472LIBYANG_API_DECL LY_ERR lyd_eval_xpath(const struct lyd_node *ctx_node, const char *xpath, ly_bool *result);
2473
2486LIBYANG_API_DECL LY_ERR lyd_eval_xpath2(const struct lyd_node *ctx_node, const char *xpath,
2487 const struct lyxp_var *vars, ly_bool *result);
2488
2504LIBYANG_API_DECL LY_ERR lyd_eval_xpath3(const struct lyd_node *ctx_node, const struct lys_module *cur_mod,
2505 const char *xpath, LY_VALUE_FORMAT format, void *prefix_data, const struct lyxp_var *vars, ly_bool *result);
2510typedef enum {
2516
2539LIBYANG_API_DECL LY_ERR lyd_eval_xpath4(const struct lyd_node *ctx_node, const struct lyd_node *tree,
2540 const struct lys_module *cur_mod, const char *xpath, LY_VALUE_FORMAT format, void *prefix_data,
2541 const struct lyxp_var *vars, LY_XPATH_TYPE *ret_type, struct ly_set **node_set, char **string,
2542 long double *number, ly_bool *boolean);
2543
2553LIBYANG_API_DEF LY_ERR lyd_trim_xpath(struct lyd_node **tree, const char *xpath, const struct lyxp_var *vars);
2554
2572LIBYANG_API_DECL LY_ERR lyd_find_path(const struct lyd_node *ctx_node, const char *path, ly_bool output,
2573 struct lyd_node **match);
2574
2585LIBYANG_API_DECL LY_ERR lyd_find_target(const struct ly_path *path, const struct lyd_node *tree, struct lyd_node **match);
2586
2592LIBYANG_API_DECL int ly_time_tz_offset(void);
2600LIBYANG_API_DECL int ly_time_tz_offset_at(time_t time);
2601
2610LIBYANG_API_DECL LY_ERR ly_time_str2time(const char *value, time_t *time, char **fractions_s);
2611
2620LIBYANG_API_DECL LY_ERR ly_time_time2str(time_t time, const char *fractions_s, char **str);
2621
2629LIBYANG_API_DECL LY_ERR ly_time_str2ts(const char *value, struct timespec *ts);
2630
2638LIBYANG_API_DECL LY_ERR ly_time_ts2str(const struct timespec *ts, char **str);
2639
2650LIBYANG_API_DECL LY_ERR lyd_leafref_get_links(const struct lyd_node_term *node, const struct lyd_leafref_links_rec **record);
2651
2661LIBYANG_API_DECL LY_ERR lyd_leafref_link_node_tree(const struct lyd_node *tree);
2662
2676LIBYANG_API_DECL LY_ERR ly_pattern_match(const struct ly_ctx *ctx, const char *pattern, const char *string,
2677 uint32_t str_len, void **pat_comp);
2678
2688LIBYANG_API_DECL LY_ERR ly_pattern_compile(const struct ly_ctx *ctx, const char *pattern, void **pat_comp);
2689
2695LIBYANG_API_DECL void ly_pattern_free(void *pat_comp);
2696
2697#ifdef __cplusplus
2698}
2699#endif
2700
2701#endif /* LY_TREE_DATA_H_ */
libyang context handler.
LYD_FORMAT
Data input/output formats supported by libyang parser and printer functions.
Definition tree_data.h:535
#define LYD_CTX(node)
Macro to get context from a data tree node.
Definition tree_data.h:518
@ LYD_LYB
Definition tree_data.h:539
@ LYD_XML
Definition tree_data.h:537
@ LYD_UNKNOWN
Definition tree_data.h:536
@ LYD_JSON
Definition tree_data.h:538
LY_ERR
libyang's error codes returned by the libyang functions.
Definition log.h:252
Structure to hold a set of (not necessary somehow connected) objects. Usually used for lyd_node,...
Definition set.h:47
#define LYS_NOTIF
#define LYS_ANYDATA
#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.
Compiled prefix data pair mapping of prefixes to modules. In case the format is LY_VALUE_SCHEMA_RESOL...
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:36
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:764
uint64_t orig_size_bits
Definition tree_data.h:606
struct lyd_node * next
Definition tree_data.h:815
LIBYANG_API_DECL void lyd_free_all(struct lyd_node *node)
Free all the nodes (even parents of the node) in the data tree.
uint32_t hints
Definition tree_data.h:914
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_dup_siblings_to_ctx(const struct lyd_node *node, const struct ly_ctx *trg_ctx, struct lyd_node *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...
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 LY_ERR lyd_any_copy_value(struct lyd_node *trg, const struct lyd_node *child, const char *value, uint32_t hints)
Copy anydata value from one node to another. Target value is freed first.
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:747
struct rb_node * rbt
Definition tree_data.h:735
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:645
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.
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:2274
@ LYD_PATH_STD_NO_LAST_PRED
Definition tree_data.h:2277
@ LYD_PATH_STD
Definition tree_data.h:2275
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.
struct lyd_value value
Definition tree_data.h:882
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:551
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 ly_time_str2ts(const char *value, struct timespec *ts)
Convert date-and-time from string to timespec.
uint32_t hints
Definition tree_data.h:763
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.
ly_bool unknown_tz
Definition tree_data.h:694
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.
LIBYANG_API_DECL LY_ERR lyd_value_validate(const struct lysc_node *schema, const char *value, uint32_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_value_validate_dflt(const struct lysc_node *schema, const char *value, struct lysc_prefix *prefixes, 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.
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:2153
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.
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.
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_new_path2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const void *value, uint64_t value_size_bits, uint32_t any_hints, 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 lysc_type_bitenum_item ** items
Definition tree_data.h:622
const struct ly_ctx * ctx
Definition tree_data.h:1016
char * fractions_s
Definition tree_data.h:709
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:2059
struct lyd_meta * meta
Definition tree_data.h:820
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.
LIBYANG_API_DECL LY_ERR lyd_any_value_str(const struct lyd_node *any, LYD_FORMAT format, char **value_str)
Get anydata string value.
const struct lyd_node_term ** target_nodes
Definition tree_data.h:1030
uint32_t flags
Definition tree_data.h:812
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 void ly_pattern_free(void *pat_comp)
Free a compiled XML Schema regex pattern.
LY_XPATH_TYPE
XPath result type.
Definition tree_data.h:2503
@ LY_XPATH_NODE_SET
Definition tree_data.h:2504
@ LY_XPATH_NUMBER
Definition tree_data.h:2506
@ LY_XPATH_STRING
Definition tree_data.h:2505
@ LY_XPATH_BOOLEAN
Definition tree_data.h:2507
const struct lysc_node * schema
Definition tree_data.h:813
uint32_t seconds
Definition tree_data.h:708
LIBYANG_API_DECL LY_ERR lyd_new_term_raw(struct lyd_node *parent, const struct lys_module *module, const char *name, const void *value_ptr, uint32_t value_size, uint32_t options, struct lyd_node **node)
Create a new term node in the data tree and set its value directly in its internal raw representation...
struct in6_addr addr
Definition tree_data.h:668
const char * value
Definition tree_data.h:913
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:725
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_list3(struct lyd_node *parent, const struct lys_module *module, const char *name, const void **key_values, uint32_t *value_sizes_bits, uint32_t options, struct lyd_node **node)
Create a new list node in the data tree.
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.
struct lyd_node * parent
Definition tree_data.h:814
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:746
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:611
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 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
#define LYD_NODE_TERM
Definition tree_data.h:769
uint32_t hints
Definition tree_data.h:1011
LIBYANG_API_DECL LY_ERR lyd_dup_single(const struct lyd_node *node, struct lyd_node *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 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:761
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_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:808
void * val_prefix_data
Definition tree_data.h:765
struct in_addr addr
Definition tree_data.h:653
struct lyd_node * prev
Definition tree_data.h:816
ly_bool unknown_tz
Definition tree_data.h:710
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 LY_ERR lyd_dup_siblings(const struct lyd_node *node, struct lyd_node *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 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:850
struct ly_ht * children_ht
Definition tree_data.h:912
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:728
void * priv
Definition tree_data.h:821
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_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:851
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.
struct lyd_node * child
Definition tree_data.h:911
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:762
LIBYANG_API_DECL LY_ERR lyd_find_sibling_val(const struct lyd_node *siblings, const struct lysc_node *schema, const char *key_or_value, uint32_t val_len, struct lyd_node **match)
Search in the given siblings for the first schema instance. Uses hashes - should be used whenever pos...
LIBYANG_API_DECL LY_ERR lyd_value_compare(const struct lyd_node_term *node, const char *value, uint32_t value_len)
Compare the node's value with the given string value. The string value is first validated according t...
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:726
LIBYANG_API_DECL LY_ERR lyd_unlink_tree(struct lyd_node *node)
Unlink the specified data subtree.
struct lyd_attr * next
Definition tree_data.h:760
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.
uint32_t hints
Definition tree_data.h:607
LIBYANG_API_DECL LY_ERR lyd_dup_single_to_ctx(const struct lyd_node *node, const struct ly_ctx *trg_ctx, struct lyd_node *parent, uint32_t options, struct lyd_node **dup)
Create a copy of the specified data tree node. Schema references are assigned from trg_ctx.
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:676
struct lyd_value value
Definition tree_data.h:603
const char * _canonical
Definition tree_data.h:548
struct lyd_node_opaq * parent
Definition tree_data.h:759
LY_VALUE_FORMAT format
Definition tree_data.h:608
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 ly_pattern_match(const struct ly_ctx *ctx, const char *pattern, const char *string, uint32_t str_len, void **pat_comp)
Check a string matches an XML Schema regex used in YANG.
struct ly_opaq_name name
Definition tree_data.h:1009
LIBYANG_API_DECL LY_ERR ly_pattern_compile(const struct ly_ctx *ctx, const char *pattern, void **pat_comp)
Compile an XML Schema regex pattern prior to matching.
LIBYANG_API_DECL void lyd_free_meta_single(struct lyd_meta *meta)
Free a single metadata instance.
LIBYANG_API_DECL LY_ERR lyd_new_any(struct lyd_node *parent, const struct lys_module *module, const char *name, const struct lyd_node *child, const char *value, uint32_t hints, uint32_t options, struct lyd_node **node)
Create a new any node in the data tree.
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:612
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:745
Generic attribute structure.
Definition tree_data.h:758
Generic structure for a data node.
Definition tree_data.h:807
Data node structure for the anydata data tree nodes - anydata or anyxml.
Definition tree_data.h:888
Data node structure for the inner data tree nodes - containers, lists, RPCs, actions and Notification...
Definition tree_data.h:827
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:859
YANG data representation.
Definition tree_data.h:547
Special lyd_value structure for built-in binary values.
Definition tree_data.h:629
Special lyd_value structure for built-in bits values.
Definition tree_data.h:618
Special lyd_value structure for ietf-yang-types date values.
Definition tree_data.h:692
Special lyd_value structure for ietf-yang-types date-and-time values.
Definition tree_data.h:683
Special lyd_value structure for ietf-yang-types date-no-zone values.
Definition tree_data.h:700
Special lyd_value structure for ietf-inet-types ipv4-address values.
Definition tree_data.h:644
Special lyd_value structure for ietf-inet-types ipv4-address-no-zone values.
Definition tree_data.h:637
Special lyd_value structure for ietf-inet-types ipv4-prefix values.
Definition tree_data.h:652
Special lyd_value structure for ietf-inet-types ipv6-address values.
Definition tree_data.h:667
Special lyd_value structure for ietf-inet-types ipv6-address-no-zone values.
Definition tree_data.h:660
Special lyd_value structure for ietf-inet-types ipv6-prefix values.
Definition tree_data.h:675
Special lyd_value structure for lyds tree value.
Definition tree_data.h:734
Special lyd_value structure for ietf-yang-types time values.
Definition tree_data.h:707
Special lyd_value structure for ietf-yang-types time-no-zone values.
Definition tree_data.h:716
Special lyd_value structure for built-in union values.
Definition tree_data.h:602
Special lyd_value structure for ietf-yang-types xpath1.0 values.
Definition tree_data.h:724
libyang representation of YANG schema trees.