libyang 5.8.6
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
15
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
199
315
368
380
388
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
543
547struct lyd_value {
548 const char *_canonical;
551 const struct lysc_type *realtype;
558
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;
571 struct lysc_ident *ident;
572 struct ly_path *target;
574 struct lyd_value_union *subvalue;
575
576 void *dyn_mem;
577 uint8_t fixed_mem[LYD_VALUE_FIXED_MEM_SIZE];
578 };
579
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;
748
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)
771
798
799#define LYD_DEFAULT 0x01
800#define LYD_WHEN_TRUE 0x02
801#define LYD_NEW 0x04
802#define LYD_EXT 0x08
803#define LYD_WHEN_FALSE 0x10
806
808
812struct lyd_node {
813 uint32_t hash;
817 uint32_t flags;
818 const struct lysc_node *schema;
819 struct lyd_node *parent;
820 struct lyd_node *next;
821 struct lyd_node *prev;
825 struct lyd_meta *meta;
826 void *priv;
827};
828
833 union {
834 struct lyd_node node;
835
836 struct {
837 uint32_t hash;
842 uint32_t flags;
843 const struct lysc_node *schema;
844 struct lyd_node *parent;
845 struct lyd_node *next;
846 struct lyd_node *prev;
850 struct lyd_meta *meta;
851 void *priv;
852 };
853 };
854
855 struct lyd_node *child;
857
858#define LYD_HT_MIN_ITEMS 4
859};
860
865 union {
866 struct lyd_node node;
867
868 struct {
869 uint32_t hash;
874 uint32_t flags;
875 const struct lysc_node *schema;
876 struct lyd_node *parent;
877 struct lyd_node *next;
878 struct lyd_node *prev;
882 struct lyd_meta *meta;
883 void *priv;
884 };
885 };
886
888};
889
894 union {
895 struct lyd_node node;
896
897 struct {
898 uint32_t hash;
903 uint32_t flags;
904 const struct lysc_node *schema;
905 struct lyd_node *parent;
906 struct lyd_node *next;
907 struct lyd_node *prev;
911 struct lyd_meta *meta;
912 void *priv;
913 };
914 };
915
916 struct lyd_node *child;
918 const char *value;
919 uint32_t hints;
921};
922
929#define LYD_NAME(node) ((node)->schema ? (node)->schema->name : ((struct lyd_node_opaq *)node)->name.name)
930
940#define LYD_VALHINT_STRING 0x0001
941#define LYD_VALHINT_DECNUM 0x0002
942#define LYD_VALHINT_OCTNUM 0x0004
943#define LYD_VALHINT_HEXNUM 0x0008
944#define LYD_VALHINT_NUM64 0x0010
945#define LYD_VALHINT_BOOLEAN 0x0020
946#define LYD_VALHINT_EMPTY 0x0040
947#define LYD_VALHINT_STRING_DATATYPES 0x0080
951
961#define LYD_NODEHINT_LIST 0x1000
962#define LYD_NODEHINT_LEAFLIST 0x2000
963#define LYD_NODEHINT_CONTAINER 0x4000
967
978#define LYD_HINT_DATA 0xFFF3
982#define LYD_HINT_SCHEMA 0xFFFF
989
994 union {
995 struct lyd_node node;
996
997 struct {
998 uint32_t hash;
999 uint32_t flags;
1000 const struct lysc_node *schema;
1001 struct lyd_node *parent;
1002 struct lyd_node *next;
1003 struct lyd_node *prev;
1007 struct lyd_meta *meta;
1008 void *priv;
1009 };
1010 };
1011
1012 struct lyd_node *child;
1013
1015 const char *value;
1016 uint32_t hints;
1019
1020 struct lyd_attr *attr;
1021 const struct ly_ctx *ctx;
1022};
1023
1039
1047#define lyd_parent(node) ((node) ? (node)->parent : NULL)
1048
1060static inline struct lyd_node *
1061lyd_child(const struct lyd_node *node)
1062{
1063 if (!node) {
1064 return NULL;
1065 }
1066
1067 if (!node->schema) {
1068 /* opaq node */
1069 return ((const struct lyd_node_opaq *)node)->child;
1070 }
1071
1073 return ((const struct lyd_node_inner *)node)->child;
1074 }
1075
1076 return NULL;
1077}
1078
1090static inline struct lyd_node *
1091lyd_child_any(const struct lyd_node *node)
1092{
1093 if (!node) {
1094 return NULL;
1095 }
1096
1097 if (!node->schema) {
1098 /* opaq node */
1099 return ((const struct lyd_node_opaq *)node)->child;
1100 }
1101
1103 return ((const struct lyd_node_inner *)node)->child;
1104 }
1105
1106 return NULL;
1107}
1108
1117LIBYANG_API_DECL struct lyd_node *lyd_child_no_keys(const struct lyd_node *node);
1118
1128LIBYANG_API_DECL const struct lys_module *lyd_owner_module(const struct lyd_node *node);
1129
1136LIBYANG_API_DECL const struct lys_module *lyd_node_module(const struct lyd_node *node);
1137
1144LIBYANG_API_DECL ly_bool lyd_is_default(const struct lyd_node *node);
1145
1153LIBYANG_API_DECL uint32_t lyd_list_pos(const struct lyd_node *instance);
1154
1161LIBYANG_API_DECL struct lyd_node *lyd_first_sibling(const struct lyd_node *node);
1162
1172LIBYANG_API_DECL LY_ERR lyd_parse_opaq_error(const struct lyd_node *node);
1173
1183LIBYANG_API_DECL const char *lyd_value_get_canonical(const struct ly_ctx *ctx, const struct lyd_value *value);
1184
1191static inline const char *
1192lyd_get_value(const struct lyd_node *node)
1193{
1194 if (!node) {
1195 return NULL;
1196 }
1197
1198 if (!node->schema) {
1199 return ((const struct lyd_node_opaq *)node)->value;
1200 } else if (node->schema->nodetype & LYD_NODE_TERM) {
1201 const struct lyd_value *value = &((const struct lyd_node_term *)node)->value;
1202
1204 }
1205
1206 return NULL;
1207}
1208
1217LIBYANG_API_DECL LY_ERR lyd_any_value_str(const struct lyd_node *any, LYD_FORMAT format, char **value_str);
1218
1230LIBYANG_API_DECL LY_ERR lyd_any_copy_value(struct lyd_node *trg, const struct lyd_node *child, const char *value,
1231 uint32_t hints);
1232
1239LIBYANG_API_DECL const struct lysc_node *lyd_node_schema(const struct lyd_node *node);
1240
1248LIBYANG_API_DECL ly_bool lyd_meta_is_internal(const struct lyd_meta *meta);
1249
1263LIBYANG_API_DECL LY_ERR lyd_new_inner(struct lyd_node *parent, const struct lys_module *module, const char *name,
1264 ly_bool output, struct lyd_node **node);
1265
1286
1287#define LYD_NEW_VAL_OUTPUT 0x01
1289#define LYD_NEW_VAL_STORE_ONLY 0x02
1290#define LYD_NEW_VAL_CANON 0x04
1293#define LYD_NEW_META_CLEAR_DFLT 0x08
1294#define LYD_NEW_PATH_UPDATE 0x10
1298#define LYD_NEW_PATH_OPAQ 0x20
1302#define LYD_NEW_PATH_WITH_OPAQ 0x40
1303#define LYD_NEW_PATH_ANY_DATATREE 0x80
1304#define LYD_NEW_ANY_USE_VALUE 0x0100
1305
1307
1320LIBYANG_API_DECL LY_ERR lyd_new_list(struct lyd_node *parent, const struct lys_module *module, const char *name,
1321 uint32_t options, struct lyd_node **node, ...);
1322
1336LIBYANG_API_DECL LY_ERR lyd_new_list2(struct lyd_node *parent, const struct lys_module *module, const char *name,
1337 const char *keys, uint32_t options, struct lyd_node **node);
1338
1352LIBYANG_API_DECL LY_ERR lyd_new_list3(struct lyd_node *parent, const struct lys_module *module, const char *name,
1353 const void **key_values, uint32_t *value_sizes_bits, uint32_t options, struct lyd_node **node);
1354
1366LIBYANG_API_DECL LY_ERR lyd_new_term(struct lyd_node *parent, const struct lys_module *module, const char *name,
1367 const char *value, uint32_t options, struct lyd_node **node);
1368
1390LIBYANG_API_DECL LY_ERR lyd_new_term_raw(struct lyd_node *parent, const struct lys_module *module, const char *name,
1391 const void *value_ptr, uint32_t value_size, uint32_t options, struct lyd_node **node);
1392
1406LIBYANG_API_DECL LY_ERR lyd_new_any(struct lyd_node *parent, const struct lys_module *module, const char *name,
1407 const struct lyd_node *child, const char *value, uint32_t hints, uint32_t options, struct lyd_node **node);
1408
1423LIBYANG_API_DECL LY_ERR lyd_new_meta(const struct ly_ctx *ctx, struct lyd_node *parent, const struct lys_module *module,
1424 const char *name, const char *val_str, uint32_t options, struct lyd_meta **meta);
1425
1438LIBYANG_API_DECL LY_ERR lyd_new_meta2(const struct ly_ctx *ctx, struct lyd_node *parent, uint32_t options,
1439 const struct lyd_attr *attr, struct lyd_meta **meta);
1440
1453LIBYANG_API_DECL LY_ERR lyd_new_opaq(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value,
1454 const char *prefix, const char *module_name, struct lyd_node **node);
1455
1468LIBYANG_API_DECL LY_ERR lyd_new_opaq2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value,
1469 const char *prefix, const char *module_ns, struct lyd_node **node);
1470
1484LIBYANG_API_DECL LY_ERR lyd_new_attr(struct lyd_node *parent, const char *module_name, const char *name, const char *value,
1485 struct lyd_attr **attr);
1486
1499LIBYANG_API_DECL LY_ERR lyd_new_attr2(struct lyd_node *parent, const char *module_ns, const char *name, const char *value,
1500 struct lyd_attr **attr);
1501
1530LIBYANG_API_DECL LY_ERR lyd_new_path(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const char *value,
1531 uint32_t options, struct lyd_node **node);
1532
1558LIBYANG_API_DECL LY_ERR lyd_new_path2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path,
1559 const void *value, uint64_t value_size_bits, uint32_t any_hints, uint32_t options, struct lyd_node **new_parent,
1560 struct lyd_node **new_node);
1561
1574
1575#define LYD_IMPLICIT_NO_STATE 0x01
1576#define LYD_IMPLICIT_NO_CONFIG 0x02
1577#define LYD_IMPLICIT_OUTPUT 0x04
1578#define LYD_IMPLICIT_NO_DEFAULTS 0x08
1580
1582
1591LIBYANG_API_DECL LY_ERR lyd_new_implicit_tree(struct lyd_node *tree, uint32_t implicit_options, struct lyd_node **diff);
1592
1604LIBYANG_API_DECL LY_ERR lyd_new_implicit_all(struct lyd_node **tree, const struct ly_ctx *ctx, uint32_t implicit_options,
1605 struct lyd_node **diff);
1606
1618LIBYANG_API_DECL LY_ERR lyd_new_implicit_module(struct lyd_node **tree, const struct lys_module *module,
1619 uint32_t implicit_options, struct lyd_node **diff);
1620
1634LIBYANG_API_DECL LY_ERR lyd_change_term(struct lyd_node *term, const char *val_str);
1635
1650LIBYANG_API_DECL LY_ERR lyd_change_term_canon(struct lyd_node *term, const char *val_str);
1651
1661LIBYANG_API_DECL LY_ERR lyd_change_meta(struct lyd_meta *meta, const char *val_str);
1662
1674LIBYANG_API_DECL LY_ERR lyd_insert_child(struct lyd_node *parent, struct lyd_node *node);
1675
1688LIBYANG_API_DECL LY_ERR lyd_insert_sibling(struct lyd_node *sibling, struct lyd_node *node, struct lyd_node **first);
1689
1701LIBYANG_API_DECL LY_ERR lyd_insert_before(struct lyd_node *sibling, struct lyd_node *node);
1702
1714LIBYANG_API_DECL LY_ERR lyd_insert_after(struct lyd_node *sibling, struct lyd_node *node);
1715
1723LIBYANG_API_DECL LY_ERR lyd_unlink_siblings(struct lyd_node *node);
1724
1732LIBYANG_API_DECL LY_ERR lyd_unlink_tree(struct lyd_node *node);
1733
1739LIBYANG_API_DECL void lyd_free_all(struct lyd_node *node);
1740
1746LIBYANG_API_DECL void lyd_free_siblings(struct lyd_node *node);
1747
1753LIBYANG_API_DECL void lyd_free_tree(struct lyd_node *node);
1754
1760LIBYANG_API_DECL void lyd_free_meta_single(struct lyd_meta *meta);
1761
1767LIBYANG_API_DECL void lyd_free_meta_siblings(struct lyd_meta *meta);
1768
1775LIBYANG_API_DECL void lyd_free_attr_single(const struct ly_ctx *ctx, struct lyd_attr *attr);
1776
1783LIBYANG_API_DECL void lyd_free_attr_siblings(const struct ly_ctx *ctx, struct lyd_attr *attr);
1784
1802LIBYANG_API_DECL LY_ERR lyd_value_validate(const struct lysc_node *schema, const char *value, uint32_t value_len,
1803 const struct lyd_node *ctx_node, const struct lysc_type **realtype, const char **canonical);
1804
1822LIBYANG_API_DECL LY_ERR lyd_value_validate_dflt(const struct lysc_node *schema, const char *value,
1823 struct lysc_prefix *prefixes, const struct lyd_node *ctx_node, const struct lysc_type **realtype,
1824 const char **canonical);
1825
1838LIBYANG_API_DECL LY_ERR lyd_value_compare(const struct lyd_node_term *node, const char *value, uint32_t value_len);
1839
1846#define LYD_COMPARE_FULL_RECURSION 0x01 /* Lists and containers are the same only in case all they children
1847 (subtree, so direct as well as indirect children) are the same. By default,
1848 containers are the same in case of the same schema node and lists are the same
1849 in case of equal keys (keyless lists do the full recursion comparison all the time). */
1850#define LYD_COMPARE_DEFAULTS 0x02 /* By default, implicit and explicit default nodes are considered to be equal. This flag
1851 changes this behavior and implicit (automatically created default node) and explicit
1852 (explicitly created node with the default value) default nodes are considered different. */
1853#define LYD_COMPARE_OPAQ 0x04 /* Opaque nodes can normally be never equal to data nodes. Using this flag even
1854 opaque nodes members are compared to data node schema and value and can result
1855 in a match. */
1857
1869LIBYANG_API_DECL LY_ERR lyd_compare_single(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
1870
1882LIBYANG_API_DECL LY_ERR lyd_compare_siblings(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
1883
1894LIBYANG_API_DECL LY_ERR lyd_compare_meta(const struct lyd_meta *meta1, const struct lyd_meta *meta2);
1895
1908#define LYD_DUP_RECURSIVE 0x01
1910#define LYD_DUP_NO_META 0x02
1912#define LYD_DUP_WITH_PARENTS 0x04
1914#define LYD_DUP_WITH_FLAGS 0x08
1916#define LYD_DUP_NO_EXT 0x10
1917#define LYD_DUP_WITH_PRIV 0x20
1919#define LYD_DUP_NO_LYDS 0x40
1923
1925
1937LIBYANG_API_DECL LY_ERR lyd_dup_single(const struct lyd_node *node, struct lyd_node *parent, uint32_t options,
1938 struct lyd_node **dup);
1939
1953LIBYANG_API_DECL LY_ERR lyd_dup_single_to_ctx(const struct lyd_node *node, const struct ly_ctx *trg_ctx,
1954 struct lyd_node *parent, uint32_t options, struct lyd_node **dup);
1955
1967LIBYANG_API_DECL LY_ERR lyd_dup_siblings(const struct lyd_node *node, struct lyd_node *parent, uint32_t options,
1968 struct lyd_node **dup);
1969
1984LIBYANG_API_DECL LY_ERR lyd_dup_siblings_to_ctx(const struct lyd_node *node, const struct ly_ctx *trg_ctx,
1985 struct lyd_node *parent, uint32_t options, struct lyd_node **dup);
1986
1995LIBYANG_API_DECL LY_ERR lyd_dup_meta_single(const struct lyd_meta *meta, struct lyd_node *parent, struct lyd_meta **dup);
1996
2010
2011#define LYD_MERGE_DESTRUCT 0x01
2012#define LYD_MERGE_DEFAULTS 0x02
2013#define LYD_MERGE_WITH_FLAGS 0x04
2014
2016
2037LIBYANG_API_DECL LY_ERR lyd_merge_tree(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
2038
2060LIBYANG_API_DECL LY_ERR lyd_merge_siblings(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
2061
2071typedef LY_ERR (*lyd_merge_cb)(struct lyd_node *trg_node, const struct lyd_node *src_node, void *cb_data);
2072
2088LIBYANG_API_DECL LY_ERR lyd_merge_module(struct lyd_node **target, const struct lyd_node *source, const struct lys_module *mod,
2089 lyd_merge_cb merge_cb, void *cb_data, uint16_t options);
2090
2104
2105#define LYD_DIFF_DEFAULTS 0x01
2108#define LYD_DIFF_META 0x02
2111
2113
2139LIBYANG_API_DECL LY_ERR lyd_diff_tree(const struct lyd_node *first, const struct lyd_node *second, uint16_t options,
2140 struct lyd_node **diff);
2141
2154LIBYANG_API_DECL LY_ERR lyd_diff_siblings(const struct lyd_node *first, const struct lyd_node *second, uint16_t options,
2155 struct lyd_node **diff);
2156
2165typedef LY_ERR (*lyd_diff_cb)(const struct lyd_node *diff_node, struct lyd_node *data_node, void *cb_data);
2166
2183LIBYANG_API_DECL LY_ERR lyd_diff_apply_module(struct lyd_node **data, const struct lyd_node *diff,
2184 const struct lys_module *mod, lyd_diff_cb diff_cb, void *cb_data);
2185
2196LIBYANG_API_DECL LY_ERR lyd_diff_apply_all(struct lyd_node **data, const struct lyd_node *diff);
2197
2208
2209#define LYD_DIFF_MERGE_DEFAULTS 0x01
2210
2212
2237LIBYANG_API_DECL LY_ERR lyd_diff_merge_module(struct lyd_node **diff, const struct lyd_node *src_diff,
2238 const struct lys_module *mod, lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
2239
2256LIBYANG_API_DECL LY_ERR lyd_diff_merge_tree(struct lyd_node **diff_first, struct lyd_node *diff_parent,
2257 const struct lyd_node *src_sibling, lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
2258
2270LIBYANG_API_DECL LY_ERR lyd_diff_merge_all(struct lyd_node **diff, const struct lyd_node *src_diff, uint16_t options);
2271
2279 * @return LY_ERR on error.
2281LIBYANG_API_DECL LY_ERR lyd_diff_reverse_all(const struct lyd_node *src_diff, struct lyd_node **diff);
2285
2286typedef enum {
2287 LYD_PATH_STD,
2292
2308LIBYANG_API_DECL char *lyd_path(const struct lyd_node *node, LYD_PATH_TYPE pathtype, char *buffer, size_t buflen);
2309
2319LIBYANG_API_DECL struct lyd_meta *lyd_find_meta(const struct lyd_meta *first, const struct lys_module *module,
2320 const char *name);
2321
2333LIBYANG_API_DECL LY_ERR lyd_find_sibling_first(const struct lyd_node *siblings, const struct lyd_node *target,
2334 struct lyd_node **match);
2335
2360LIBYANG_API_DECL LY_ERR lyd_find_sibling_val(const struct lyd_node *siblings, const struct lysc_node *schema,
2361 const char *key_or_value, uint32_t val_len, struct lyd_node **match);
2362
2374LIBYANG_API_DECL LY_ERR lyd_find_sibling_dup_inst_set(const struct lyd_node *siblings, const struct lyd_node *target,
2375 struct ly_set **set);
2376
2387LIBYANG_API_DECL LY_ERR lyd_find_sibling_opaq_next(const struct lyd_node *first, const char *name, struct lyd_node **match);
2388
2400LIBYANG_API_DECL LY_ERR lyxp_vars_set(struct lyxp_var **vars, const char *name, const char *value);
2401
2407LIBYANG_API_DECL void lyxp_vars_free(struct lyxp_var *vars);
2408
2428LIBYANG_API_DECL LY_ERR lyd_find_xpath(const struct lyd_node *ctx_node, const char *xpath, struct ly_set **set);
2429
2443LIBYANG_API_DECL LY_ERR lyd_find_xpath2(const struct lyd_node *ctx_node, const char *xpath, const struct lyxp_var *vars,
2444 struct ly_set **set);
2445
2463LIBYANG_API_DECL LY_ERR lyd_find_xpath3(const struct lyd_node *ctx_node, const struct lyd_node *tree, const char *xpath,
2464 LY_VALUE_FORMAT format, void *prefix_data, const struct lyxp_var *vars, struct ly_set **set);
2465
2477LIBYANG_API_DECL LY_ERR lyd_eval_xpath(const struct lyd_node *ctx_node, const char *xpath, ly_bool *result);
2478
2491LIBYANG_API_DECL LY_ERR lyd_eval_xpath2(const struct lyd_node *ctx_node, const char *xpath,
2492 const struct lyxp_var *vars, ly_bool *result);
2493
2509LIBYANG_API_DECL LY_ERR lyd_eval_xpath3(const struct lyd_node *ctx_node, const struct lys_module *cur_mod,
2510 const char *xpath, LY_VALUE_FORMAT format, void *prefix_data, const struct lyxp_var *vars, ly_bool *result);
2514
2515typedef enum {
2521
2544LIBYANG_API_DECL LY_ERR lyd_eval_xpath4(const struct lyd_node *ctx_node, const struct lyd_node *tree,
2545 const struct lys_module *cur_mod, const char *xpath, LY_VALUE_FORMAT format, void *prefix_data,
2546 const struct lyxp_var *vars, LY_XPATH_TYPE *ret_type, struct ly_set **node_set, char **string,
2547 long double *number, ly_bool *boolean);
2548
2558LIBYANG_API_DEF LY_ERR lyd_trim_xpath(struct lyd_node **tree, const char *xpath, const struct lyxp_var *vars);
2559
2577LIBYANG_API_DECL LY_ERR lyd_find_path(const struct lyd_node *ctx_node, const char *path, ly_bool output,
2578 struct lyd_node **match);
2579
2590LIBYANG_API_DECL LY_ERR lyd_find_target(const struct ly_path *path, const struct lyd_node *tree, struct lyd_node **match);
2591
2597LIBYANG_API_DECL int ly_time_tz_offset(void);
2605LIBYANG_API_DECL int ly_time_tz_offset_at(time_t time);
2606
2615LIBYANG_API_DECL LY_ERR ly_time_str2time(const char *value, time_t *time, char **fractions_s);
2616
2625LIBYANG_API_DECL LY_ERR ly_time_time2str(time_t time, const char *fractions_s, char **str);
2626
2634LIBYANG_API_DECL LY_ERR ly_time_str2ts(const char *value, struct timespec *ts);
2635
2643LIBYANG_API_DECL LY_ERR ly_time_ts2str(const struct timespec *ts, char **str);
2644
2655LIBYANG_API_DECL LY_ERR lyd_leafref_get_links(const struct lyd_node_term *node, const struct lyd_leafref_links_rec **record);
2656
2666LIBYANG_API_DECL LY_ERR lyd_leafref_link_node_tree(const struct lyd_node *tree);
2667
2681LIBYANG_API_DECL LY_ERR ly_pattern_match(const struct ly_ctx *ctx, const char *pattern, const char *string,
2682 uint32_t str_len, void **pat_comp);
2683
2693LIBYANG_API_DECL LY_ERR ly_pattern_compile(const struct ly_ctx *ctx, const char *pattern, void **pat_comp);
2694
2700LIBYANG_API_DECL void ly_pattern_free(void *pat_comp);
2701
2702#ifdef __cplusplus
2703}
2704#endif
2705
2706#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 * 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:820
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:919
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:1018
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:2279
@ LYD_PATH_STD_NO_LAST_PRED
Definition tree_data.h:2282
@ LYD_PATH_STD
Definition tree_data.h:2280
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:887
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:1029
struct lyd_attr * attr
Definition tree_data.h:1020
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:2158
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:1012
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....
struct ly_path * target
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:1021
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.
uint8_t fixed_mem[LYD_VALUE_FIXED_MEM_SIZE]
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:2064
struct lyd_meta * meta
Definition tree_data.h:825
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:1035
uint32_t flags
Definition tree_data.h:817
struct lysc_ident * ident
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:2508
@ LY_XPATH_NODE_SET
Definition tree_data.h:2509
@ LY_XPATH_NUMBER
Definition tree_data.h:2511
@ LY_XPATH_STRING
Definition tree_data.h:2510
@ LY_XPATH_BOOLEAN
Definition tree_data.h:2512
const struct lysc_node * schema
Definition tree_data.h:818
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:918
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:1015
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:819
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:1028
#define LYD_NODE_TERM
Definition tree_data.h:769
uint32_t hints
Definition tree_data.h:1016
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:813
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:821
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:855
struct ly_ht * children_ht
Definition tree_data.h:917
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:826
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 lyd_value_union * subvalue
struct ly_ht * children_ht
Definition tree_data.h:856
LY_VALUE_FORMAT format
Definition tree_data.h:1017
LIBYANG_API_DECL void lyd_free_attr_single(const struct ly_ctx *ctx, struct lyd_attr *attr)
Free a single attribute.
struct lysc_type_bitenum_item * enum_item
struct lyd_node * child
Definition tree_data.h:916
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:1014
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:812
Data node structure for the anydata data tree nodes - anydata or anyxml.
Definition tree_data.h:893
Data node structure for the inner data tree nodes - containers, lists, RPCs, actions and Notification...
Definition tree_data.h:832
Data node structure for unparsed (opaque) nodes.
Definition tree_data.h:993
Data node structure for the terminal data tree nodes - leaves and leaf-lists.
Definition tree_data.h:864
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.