libyang 2.1.148
libyang is YANG data modelling language parser and toolkit written (and providing API) in C.
Loading...
Searching...
No Matches
tree_schema.h
Go to the documentation of this file.
1
16#ifndef LY_TREE_SCHEMA_H_
17#define LY_TREE_SCHEMA_H_
18
19#define PCRE2_CODE_UNIT_WIDTH 8
20
21#include <pcre2.h>
22
23#include <stdint.h>
24#include <stdio.h>
25
26#include "config.h"
27#include "log.h"
28#include "tree.h"
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
34struct ly_ctx;
35struct ly_path;
36struct ly_set;
37struct lys_module;
38struct lysc_node;
39struct lyxp_expr;
40
154/* *INDENT-OFF* */
155
184#define LYSC_TREE_DFS_BEGIN(START, ELEM) \
185 { ly_bool LYSC_TREE_DFS_continue = 0; struct lysc_node *LYSC_TREE_DFS_next; \
186 for ((ELEM) = (LYSC_TREE_DFS_next) = (struct lysc_node *)(START); \
187 (ELEM); \
188 (ELEM) = (LYSC_TREE_DFS_next), LYSC_TREE_DFS_continue = 0)
189
203#define LYSC_TREE_DFS_END(START, ELEM) \
204 /* select element for the next run - children first */ \
205 if (LYSC_TREE_DFS_continue) { \
206 (LYSC_TREE_DFS_next) = NULL; \
207 } else { \
208 (LYSC_TREE_DFS_next) = (struct lysc_node *)lysc_node_child(ELEM); \
209 } \
210 if (!(LYSC_TREE_DFS_next)) { \
211 /* no children, try siblings */ \
212 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
213 } \
214 while (!(LYSC_TREE_DFS_next)) { \
215 /* parent is already processed, go to its sibling */ \
216 (ELEM) = (ELEM)->parent; \
217 _LYSC_TREE_DFS_NEXT(START, ELEM, LYSC_TREE_DFS_next); \
218 } }
219
223#define _LYSC_TREE_DFS_NEXT(START, ELEM, NEXT) \
224 if ((ELEM) == (struct lysc_node *)(START)) { \
225 /* we are done, no next element to process */ \
226 break; \
227 } \
228 (NEXT) = (ELEM)->next;
229
230/* *INDENT-ON* */
231
232#define LY_REV_SIZE 11
239#define LYS_UNKNOWN 0x0000
240#define LYS_CONTAINER 0x0001
241#define LYS_CHOICE 0x0002
242#define LYS_LEAF 0x0004
243#define LYS_LEAFLIST 0x0008
244#define LYS_LIST 0x0010
245#define LYS_ANYXML 0x0020
246#define LYS_ANYDATA 0x0060
247#define LYS_CASE 0x0080
249#define LYS_RPC 0x0100
250#define LYS_ACTION 0x0200
251#define LYS_NOTIF 0x0400
253#define LYS_USES 0x0800
254#define LYS_INPUT 0x1000
255#define LYS_OUTPUT 0x2000
256#define LYS_GROUPING 0x4000
257#define LYS_AUGMENT 0x8000
258
259#define LYS_NODETYPE_MASK 0xffff
268 const char *name;
269 const char *prefix;
270 const char *dsc;
271 const char *ref;
273 uint16_t flags;
275};
276
283 const char *name;
284 const char *dsc;
285 const char *ref;
291};
292
296struct lysp_ext {
297 const char *name;
298 const char *argname;
299 const char *dsc;
300 const char *ref;
302 uint16_t flags;
308};
309
314 const char *name;
319 const char *dsc;
320 const char *ref;
322 uint16_t flags;
324};
325
330 uint8_t *expr;
332};
333
338 const char *str;
339 const struct lysp_module *mod;
341};
342
347 const char *name;
349 const char **bases;
350 const char *dsc;
351 const char *ref;
353 uint16_t flags;
354};
355
360#define LYSP_RESTR_PATTERN_ACK 0x06
361#define LYSP_RESTR_PATTERN_NACK 0x15
365 const char *emsg;
366 const char *eapptag;
367 const char *dsc;
368 const char *ref;
370};
371
377 const char *dsc;
378 const char *ref;
380};
381
386 const char *name;
387 const char *dsc;
388 const char *ref;
389 int64_t value;
392 uint16_t flags;
394};
395
401struct lysp_type {
402 const char *name;
408 struct lyxp_expr *path;
409 const char **bases;
410 struct lysp_type *types;
413 const struct lysp_module *pmod;
418 uint16_t flags;
419};
420
424struct lysp_tpdf {
425 const char *name;
426 const char *units;
428 const char *dsc;
429 const char *ref;
432 uint16_t flags;
433};
434
438struct lysp_when {
439 const char *cond;
440 const char *dsc;
441 const char *ref;
443};
444
449 const char *nodeid;
450 const char *dsc;
451 const char *ref;
454 const char *presence;
456 uint32_t min;
457 uint32_t max;
459 uint16_t flags;
460};
461
470#define LYS_DEV_NOT_SUPPORTED 1
471#define LYS_DEV_ADD 2
472#define LYS_DEV_DELETE 3
473#define LYS_DEV_REPLACE 4
480 uint8_t mod;
483};
484
486 uint8_t mod;
489 const char *units;
493 uint16_t flags;
494 uint32_t min;
495 uint32_t max;
496};
497
499 uint8_t mod;
502 const char *units;
506};
507
509 uint8_t mod;
512 struct lysp_type *type;
513 const char *units;
515 uint16_t flags;
516 uint32_t min;
517 uint32_t max;
518};
519
521 const char *nodeid;
522 const char *dsc;
523 const char *ref;
526};
527
651#define LYS_CONFIG_W 0x01
652#define LYS_CONFIG_R 0x02
653#define LYS_CONFIG_MASK 0x03
654#define LYS_STATUS_CURR 0x04
655#define LYS_STATUS_DEPRC 0x08
656#define LYS_STATUS_OBSLT 0x10
657#define LYS_STATUS_MASK 0x1C
658#define LYS_MAND_TRUE 0x20
663#define LYS_MAND_FALSE 0x40
666#define LYS_MAND_MASK 0x60
667#define LYS_PRESENCE 0x80
670#define LYS_UNIQUE 0x80
671#define LYS_KEY 0x0100
672#define LYS_KEYLESS 0x0200
673#define LYS_DISABLED 0x0100
674#define LYS_FENABLED 0x20
675#define LYS_ORDBY_SYSTEM 0x80
677#define LYS_ORDBY_USER 0x40
680#define LYS_ORDBY_MASK 0x60
681#define LYS_YINELEM_TRUE 0x80
682#define LYS_YINELEM_FALSE 0x0100
683#define LYS_YINELEM_MASK 0x0180
684#define LYS_USED_GRP 0x0400
686#define LYS_SET_VALUE 0x0200
687#define LYS_SET_MIN 0x0200
688#define LYS_SET_MAX 0x0400
690#define LYS_SET_BASE 0x0001
691#define LYS_SET_BIT 0x0002
692#define LYS_SET_ENUM 0x0004
693#define LYS_SET_FRDIGITS 0x0008
694#define LYS_SET_LENGTH 0x0010
695#define LYS_SET_PATH 0x0020
696#define LYS_SET_PATTERN 0x0040
697#define LYS_SET_RANGE 0x0080
698#define LYS_SET_TYPE 0x0100
699#define LYS_SET_REQINST 0x0200
700#define LYS_SET_DFLT 0x0200
705#define LYS_SET_UNITS 0x0400
706#define LYS_SET_CONFIG 0x0800
708#define LYS_SINGLEQUOTED 0x0100
709#define LYS_DOUBLEQUOTED 0x0200
711#define LYS_YIN_ATTR 0x0400
712#define LYS_YIN_ARGUMENT 0x0800
714#define LYS_INTERNAL 0x1000
716#define LYS_IS_ENUM 0x0200
718#define LYS_IS_INPUT 0x1000
720#define LYS_IS_OUTPUT 0x2000
722#define LYS_IS_NOTIF 0x4000
724#define LYS_FLAGS_COMPILED_MASK 0xff
730struct lysp_node {
732 uint16_t nodetype;
733 uint16_t flags;
734 struct lysp_node *next;
735 const char *name;
736 const char *dsc;
737 const char *ref;
741};
742
747 union {
748 struct lysp_node node;
750 struct {
751 struct lysp_node *parent;
752 uint16_t nodetype;
753 uint16_t flags;
754 struct lysp_node *next;
755 const char *name;
756 const char *dsc;
757 const char *ref;
758 struct lysp_qname *iffeatures;
759 struct lysp_ext_instance *exts;
760 };
761 };
763 /* container */
765 struct lysp_when *when;
766 const char *presence;
769 struct lysp_node *child;
772};
773
775 union {
776 struct lysp_node node;
778 struct {
779 struct lysp_node *parent;
780 uint16_t nodetype;
781 uint16_t flags;
782 struct lysp_node *next;
783 const char *name;
784 const char *dsc;
785 const char *ref;
786 struct lysp_qname *iffeatures;
787 struct lysp_ext_instance *exts;
788 };
789 };
791 /* leaf */
793 struct lysp_when *when;
795 const char *units;
797};
798
800 union {
801 struct lysp_node node;
803 struct {
804 struct lysp_node *parent;
805 uint16_t nodetype;
806 uint16_t flags;
807 struct lysp_node *next;
808 const char *name;
809 const char *dsc;
810 const char *ref;
811 struct lysp_qname *iffeatures;
812 struct lysp_ext_instance *exts;
813 };
814 };
816 /* leaf-list */
818 struct lysp_when *when;
820 const char *units;
823 uint32_t min;
824 uint32_t max;
825};
826
828 union {
829 struct lysp_node node;
831 struct {
832 struct lysp_node *parent;
833 uint16_t nodetype;
834 uint16_t flags;
835 struct lysp_node *next;
836 const char *name;
837 const char *dsc;
838 const char *ref;
839 struct lysp_qname *iffeatures;
840 struct lysp_ext_instance *exts;
841 };
842 };
844 /* list */
846 struct lysp_when *when;
847 const char *key;
850 struct lysp_node *child;
854 uint32_t min;
855 uint32_t max;
856};
857
859 union {
860 struct lysp_node node;
862 struct {
863 struct lysp_node *parent;
864 uint16_t nodetype;
865 uint16_t flags;
866 struct lysp_node *next;
867 const char *name;
868 const char *dsc;
869 const char *ref;
870 struct lysp_qname *iffeatures;
871 struct lysp_ext_instance *exts;
872 };
873 };
875 /* choice */
876 struct lysp_node *child;
877 struct lysp_when *when;
879};
880
882 union {
883 struct lysp_node node;
885 struct {
886 struct lysp_node *parent;
887 uint16_t nodetype;
888 uint16_t flags;
889 struct lysp_node *next;
890 const char *name;
891 const char *dsc;
892 const char *ref;
893 struct lysp_qname *iffeatures;
894 struct lysp_ext_instance *exts;
895 };
896 };
898 /* case */
899 struct lysp_node *child;
900 struct lysp_when *when;
901};
902
904 union {
905 struct lysp_node node;
907 struct {
908 struct lysp_node *parent;
909 uint16_t nodetype;
910 uint16_t flags;
911 struct lysp_node *next;
912 const char *name;
913 const char *dsc;
914 const char *ref;
915 struct lysp_qname *iffeatures;
916 struct lysp_ext_instance *exts;
917 };
918 };
920 /* anyxml/anydata */
922 struct lysp_when *when;
923};
924
926 union {
927 struct lysp_node node;
929 struct {
930 struct lysp_node *parent;
931 uint16_t nodetype;
932 uint16_t flags;
933 struct lysp_node *next;
934 const char *name;
935 const char *dsc;
936 const char *ref;
937 struct lysp_qname *iffeatures;
938 struct lysp_ext_instance *exts;
939 };
940 };
942 /* uses */
945 struct lysp_when *when;
946};
947
952 union {
953 struct lysp_node node;
955 struct {
956 struct lysp_node *parent;
957 uint16_t nodetype;
958 uint16_t flags;
959 struct lysp_node *next;
960 const char *name;
961 const char *dsc;
962 const char *ref;
963 struct lysp_qname *iffeatures;
964 struct lysp_ext_instance *exts;
965 };
966 };
968 /* inout */
972 struct lysp_node *child;
973};
974
979 union {
980 struct lysp_node node;
982 struct {
983 struct lysp_node *parent;
984 uint16_t nodetype;
985 uint16_t flags;
986 struct lysp_node_action *next;
987 const char *name;
988 const char *dsc;
989 const char *ref;
990 struct lysp_qname *iffeatures;
991 struct lysp_ext_instance *exts;
992 };
993 };
995 /* action */
1001};
1002
1007 union {
1008 struct lysp_node node;
1010 struct {
1011 struct lysp_node *parent;
1012 uint16_t nodetype;
1013 uint16_t flags;
1014 struct lysp_node_notif *next;
1015 const char *name;
1016 const char *dsc;
1017 const char *ref;
1018 struct lysp_qname *iffeatures;
1019 struct lysp_ext_instance *exts;
1020 };
1021 };
1023 /* notif */
1028};
1029
1034 union {
1035 struct lysp_node node;
1037 struct {
1038 struct lysp_node *parent;
1039 uint16_t nodetype;
1040 uint16_t flags;
1041 struct lysp_node_grp *next;
1042 const char *name;
1043 const char *dsc;
1044 const char *ref;
1045 struct lysp_qname *iffeatures;
1046 struct lysp_ext_instance *exts;
1047 };
1048 };
1050 /* grp */
1056};
1057
1062 union {
1063 struct lysp_node node;
1065 struct {
1066 struct lysp_node *parent;
1067 uint16_t nodetype;
1068 uint16_t flags;
1069 struct lysp_node_augment *next;
1070 const char *nodeid;
1071 const char *dsc;
1072 const char *ref;
1073 struct lysp_qname *iffeatures;
1074 struct lysp_ext_instance *exts;
1075 };
1076 };
1079 struct lysp_when *when;
1082};
1083
1092
1121
1157
1164#define LYSP_MODULE_NAME(PMOD) (PMOD->is_submod ? ((struct lysp_submodule *)PMOD)->name : ((struct lysp_module *)PMOD)->mod->name)
1165
1171 char *prefix;
1172 const struct lys_module *mod;
1173};
1174
1182struct lysc_ext {
1183 const char *name;
1184 const char *argname;
1188 uint32_t refcount;
1189 uint16_t flags;
1190};
1191
1196 struct lyxp_expr *cond;
1199 const char *dsc;
1200 const char *ref;
1202 uint32_t refcount;
1203 uint16_t flags;
1204};
1205
1210 const char *name;
1211 const char *dsc;
1212 const char *ref;
1217 uint16_t flags;
1218};
1219
1226#define LYS_IFF_NOT 0x00
1227#define LYS_IFF_AND 0x01
1228#define LYS_IFF_OR 0x02
1229#define LYS_IFF_F 0x03
1239
1242 union {
1243 int64_t min_64;
1244 uint64_t min_u64;
1245 };
1246 union {
1247 int64_t max_64;
1248 uint64_t max_u64;
1249 };
1251 const char *dsc;
1252 const char *ref;
1253 const char *emsg;
1254 const char *eapptag;
1256};
1257
1259 const char *expr;
1260 pcre2_code *code;
1261 const char *dsc;
1262 const char *ref;
1263 const char *emsg;
1264 const char *eapptag;
1266 uint32_t inverted : 1;
1267 uint32_t refcount : 31;
1268};
1269
1271 struct lyxp_expr *cond;
1273 const char *dsc;
1274 const char *ref;
1275 const char *emsg;
1276 const char *eapptag;
1278};
1279
1287
1295
1304
1313
1315 const char *name;
1316 const char *dsc;
1317 const char *ref;
1320 union {
1321 int32_t value;
1322 uint32_t position;
1323 };
1324 uint16_t flags;
1326};
1327
1335
1344
1356
1365
1373
1381
1389
1393#define LYS_NODE_HASH_COUNT 4
1394
1399 uint16_t nodetype;
1400 uint16_t flags;
1404 struct lysc_node *next;
1405 struct lysc_node *prev;
1409 const char *name;
1410 const char *dsc;
1411 const char *ref;
1413 void *priv;
1414};
1415
1417 union {
1418 struct lysc_node node;
1420 struct {
1421 uint16_t nodetype;
1422 uint16_t flags;
1423 uint8_t hash[LYS_NODE_HASH_COUNT];
1424 struct lys_module *module;
1425 struct lysc_node *parent;
1426 struct lysc_node *next;
1427 struct lysc_node *prev;
1428 const char *name;
1429 const char *dsc;
1430 const char *ref;
1431 struct lysc_ext_instance *exts;
1432 void *priv;
1433 };
1434 };
1435
1438};
1439
1441 union {
1442 struct lysc_node node;
1444 struct {
1445 uint16_t nodetype;
1446 uint16_t flags;
1447 uint8_t hash[LYS_NODE_HASH_COUNT];
1448 struct lys_module *module;
1449 struct lysc_node *parent;
1450 struct lysc_node_action *next;
1451 struct lysc_node_action *prev;
1455 const char *name;
1456 const char *dsc;
1457 const char *ref;
1458 struct lysc_ext_instance *exts;
1459 void *priv;
1460 };
1461 };
1462
1463 struct lysc_when **when;
1469};
1470
1472 union {
1473 struct lysc_node node;
1475 struct {
1476 uint16_t nodetype;
1477 uint16_t flags;
1478 uint8_t hash[LYS_NODE_HASH_COUNT];
1479 struct lys_module *module;
1480 struct lysc_node *parent;
1481 struct lysc_node_notif *next;
1482 struct lysc_node_notif *prev;
1486 const char *name;
1487 const char *dsc;
1488 const char *ref;
1489 struct lysc_ext_instance *exts;
1490 void *priv;
1491 };
1492 };
1493
1496 struct lysc_when **when;
1499};
1500
1502 union {
1503 struct lysc_node node;
1505 struct {
1506 uint16_t nodetype;
1507 uint16_t flags;
1508 uint8_t hash[LYS_NODE_HASH_COUNT];
1509 struct lys_module *module;
1510 struct lysc_node *parent;
1511 struct lysc_node *next;
1512 struct lysc_node *prev;
1516 const char *name;
1517 const char *dsc;
1518 const char *ref;
1519 struct lysc_ext_instance *exts;
1520 void *priv;
1521 };
1522 };
1523
1526 struct lysc_when **when;
1529};
1530
1532 union {
1533 struct lysc_node node;
1535 struct {
1536 uint16_t nodetype;
1537 uint16_t flags;
1538 uint8_t hash[LYS_NODE_HASH_COUNT];
1539 struct lys_module *module;
1540 struct lysc_node *parent;
1541 struct lysc_node *next;
1542 struct lysc_node *prev;
1546 const char *name;
1547 const char *dsc;
1548 const char *ref;
1549 struct lysc_ext_instance *exts;
1550 void *priv;
1551 };
1552 };
1553
1556 struct lysc_when **when;
1557};
1558
1560 union {
1561 struct lysc_node node;
1563 struct {
1564 uint16_t nodetype;
1565 uint16_t flags;
1566 uint8_t hash[LYS_NODE_HASH_COUNT];
1567 struct lys_module *module;
1568 struct lysc_node *parent;
1569 struct lysc_node *next;
1570 struct lysc_node *prev;
1574 const char *name;
1575 const char *dsc;
1576 const char *ref;
1577 struct lysc_ext_instance *exts;
1578 void *priv;
1579 };
1580 };
1581
1583 struct lysc_when **when;
1585};
1586
1588 union {
1589 struct lysc_node node;
1591 struct {
1592 uint16_t nodetype;
1593 uint16_t flags;
1594 uint8_t hash[LYS_NODE_HASH_COUNT];
1595 struct lys_module *module;
1596 struct lysc_node *parent;
1597 struct lysc_node *next;
1598 struct lysc_node *prev;
1602 const char *name;
1603 const char *dsc;
1604 const char *ref;
1605 struct lysc_ext_instance *exts;
1606 void *priv;
1607 };
1608 };
1609
1611 struct lysc_when **when;
1612 struct lysc_type *type;
1614 const char *units;
1615 struct lyd_value *dflt;
1616};
1617
1619 union {
1620 struct lysc_node node;
1622 struct {
1623 uint16_t nodetype;
1624 uint16_t flags;
1625 uint8_t hash[LYS_NODE_HASH_COUNT];
1626 struct lys_module *module;
1627 struct lysc_node *parent;
1628 struct lysc_node *next;
1629 struct lysc_node *prev;
1633 const char *name;
1634 const char *dsc;
1635 const char *ref;
1636 struct lysc_ext_instance *exts;
1637 void *priv;
1638 };
1639 };
1640
1642 struct lysc_when **when;
1643 struct lysc_type *type;
1645 const char *units;
1646 struct lyd_value **dflts;
1649 uint32_t min;
1650 uint32_t max;
1652};
1653
1655 union {
1656 struct lysc_node node;
1658 struct {
1659 uint16_t nodetype;
1660 uint16_t flags;
1661 uint8_t hash[LYS_NODE_HASH_COUNT];
1662 struct lys_module *module;
1663 struct lysc_node *parent;
1664 struct lysc_node *next;
1665 struct lysc_node *prev;
1669 const char *name;
1670 const char *dsc;
1671 const char *ref;
1672 struct lysc_ext_instance *exts;
1673 void *priv;
1674 };
1675 };
1676
1679 struct lysc_when **when;
1684 uint32_t min;
1685 uint32_t max;
1686};
1687
1689 union {
1690 struct lysc_node node;
1692 struct {
1693 uint16_t nodetype;
1694 uint16_t flags;
1695 uint8_t hash[LYS_NODE_HASH_COUNT];
1696 struct lys_module *module;
1697 struct lysc_node *parent;
1698 struct lysc_node *next;
1699 struct lysc_node *prev;
1703 const char *name;
1704 const char *dsc;
1705 const char *ref;
1706 struct lysc_ext_instance *exts;
1707 void *priv;
1708 };
1709 };
1710
1712 struct lysc_when **when;
1713};
1714
1729
1736#define lysc_is_userordered(lysc_node) \
1737 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAFLIST | LYS_LIST)) || !(lysc_node->flags & LYS_ORDBY_USER)) ? 0 : 1)
1738
1745#define lysc_is_key(lysc_node) \
1746 ((!lysc_node || (lysc_node->nodetype != LYS_LEAF) || !(lysc_node->flags & LYS_KEY)) ? 0 : 1)
1747
1754#define lysc_is_np_cont(lysc_node) \
1755 ((!lysc_node || (lysc_node->nodetype != LYS_CONTAINER) || (lysc_node->flags & LYS_PRESENCE)) ? 0 : 1)
1756
1763#define lysc_is_dup_inst_list(lysc_node) \
1764 ((lysc_node && (((lysc_node->nodetype == LYS_LIST) && (lysc_node->flags & LYS_KEYLESS)) || \
1765 ((lysc_node->nodetype == LYS_LEAFLIST) && !(lysc_node->flags & LYS_CONFIG_W)))) ? 1 : 0)
1766
1773LIBYANG_API_DECL const struct lysc_node *lysc_data_node(const struct lysc_node *schema);
1774
1778#define lysc_data_parent(SCHEMA) lysc_data_node((SCHEMA) ? (SCHEMA)->parent : NULL)
1779
1790LIBYANG_API_DECL const struct lysc_when *lysc_has_when(const struct lysc_node *node);
1791
1799LIBYANG_API_DECL const struct lys_module *lysc_owner_module(const struct lysc_node *node);
1800
1807LIBYANG_API_DECL const struct lysp_node_grp *lysp_node_groupings(const struct lysp_node *node);
1808
1815LIBYANG_API_DECL const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
1816
1823LIBYANG_API_DECL const struct lysp_node_action *lysp_node_actions(const struct lysp_node *node);
1824
1831LIBYANG_API_DECL const struct lysp_node_notif *lysp_node_notifs(const struct lysp_node *node);
1832
1839LIBYANG_API_DECL const struct lysp_node *lysp_node_child(const struct lysp_node *node);
1840
1847LIBYANG_API_DECL const struct lysc_node_action *lysc_node_actions(const struct lysc_node *node);
1848
1855LIBYANG_API_DECL const struct lysc_node_notif *lysc_node_notifs(const struct lysc_node *node);
1856
1867LIBYANG_API_DECL const struct lysc_node *lysc_node_child(const struct lysc_node *node);
1868
1876LIBYANG_API_DECL struct lysc_must *lysc_node_musts(const struct lysc_node *node);
1877
1885LIBYANG_API_DECL struct lysc_when **lysc_node_when(const struct lysc_node *node);
1886
1893LIBYANG_API_DECL const struct lysc_node *lysc_node_lref_target(const struct lysc_node *node);
1894
1904typedef LY_ERR (*lysc_dfs_clb)(struct lysc_node *node, void *data, ly_bool *dfs_continue);
1905
1922LIBYANG_API_DECL LY_ERR lysc_tree_dfs_full(const struct lysc_node *root, lysc_dfs_clb dfs_clb, void *data);
1923
1935LIBYANG_API_DECL LY_ERR lysc_module_dfs_full(const struct lys_module *mod, lysc_dfs_clb dfs_clb, void *data);
1936
1945LIBYANG_API_DECL LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff);
1946
1958LIBYANG_API_DECL LY_ERR lys_identity_iffeature_value(const struct lysc_ident *ident);
1959
1968LIBYANG_API_DECL struct lysp_feature *lysp_feature_next(const struct lysp_feature *last, const struct lysp_module *pmod,
1969 uint32_t *idx);
1970
1976#define LYS_FIND_XP_SCHEMA 0x08
1977#define LYS_FIND_XP_OUTPUT 0x10
1978#define LYS_FIND_NO_MATCH_ERROR 0x40
1980#define LYS_FIND_SCHEMAMOUNT 0x0200
1995LIBYANG_API_DECL LY_ERR lys_find_xpath_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
1996 uint32_t options, struct ly_set **set);
1997
2010LIBYANG_API_DECL LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod,
2011 const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set);
2012
2024LIBYANG_API_DECL LY_ERR lys_find_xpath(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
2025 uint32_t options, struct ly_set **set);
2026
2035LIBYANG_API_DECL LY_ERR lys_find_lypath_atoms(const struct ly_path *path, struct ly_set **set);
2036
2047LIBYANG_API_DECL LY_ERR lys_find_path_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path,
2048 ly_bool output, struct ly_set **set);
2049
2059LIBYANG_API_DECL const struct lysc_node *lys_find_path(const struct ly_ctx *ctx, const struct lysc_node *ctx_node,
2060 const char *path, ly_bool output);
2061
2071
2083LIBYANG_API_DECL char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
2084
2089 struct ly_ctx *ctx;
2090 const char *name;
2091 const char *revision;
2092 const char *ns;
2093 const char *prefix;
2094 const char *filepath;
2095 const char *org;
2096 const char *contact;
2097 const char *dsc;
2098 const char *ref;
2119};
2120
2128#define LYS_MOD_LATEST_REV 0x01
2129#define LYS_MOD_LATEST_SEARCHDIRS 0x02
2130#define LYS_MOD_IMPORTED_REV 0x04
2133#define LYS_MOD_LATEST_IMPCLB 0x08
2148LIBYANG_API_DECL LY_ERR lys_feature_value(const struct lys_module *module, const char *feature);
2149
2169LIBYANG_API_DECL const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
2170 const struct lysc_module *module, uint32_t options);
2171
2184LIBYANG_API_DECL const struct lysc_node *lys_getnext_ext(const struct lysc_node *last, const struct lysc_node *parent,
2185 const struct lysc_ext_instance *ext, uint32_t options);
2186
2194#define LYS_GETNEXT_WITHCHOICE 0x01
2195#define LYS_GETNEXT_NOCHOICE 0x02
2196#define LYS_GETNEXT_WITHCASE 0x04
2197#define LYS_GETNEXT_INTONPCONT 0x08
2198#define LYS_GETNEXT_OUTPUT 0x10
2200#define LYS_GETNEXT_WITHSCHEMAMOUNT 0x20
2217LIBYANG_API_DECL const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module,
2218 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
2219
2235LIBYANG_API_DECL LY_ERR lys_set_implemented(struct lys_module *mod, const char **features);
2236
2243LIBYANG_API_DECL const char *lys_nodetype2str(uint16_t nodetype);
2244
2251LIBYANG_API_DECL const char *lyxp_get_expr(const struct lyxp_expr *path);
2252
2255#ifdef __cplusplus
2256}
2257#endif
2258
2259#endif /* LY_TREE_SCHEMA_H_ */
libyang context handler.
LY_ERR
libyang's error codes returned by the libyang functions.
Definition log.h:248
Structure to hold a set of (not necessary somehow connected) objects. Usually used for lyd_node,...
Definition set.h:47
Extension plugin implementing various aspects of a YANG extension.
YANG extension compiled instance.
YANG extension parsed instance.
Hold type-specific functions for various operations with the data values.
struct lysc_node * child
struct lysp_ext_instance * exts
struct lyplg_type * plugin
const char * dsc
struct lyd_value * dflt
struct lysp_node_grp * groupings
struct lysp_node * data
struct lysp_restr * musts
struct lysc_when ** when
const char * ref
struct lysp_tpdf * typedefs
uint16_t flags
const char * ref
const char * cond
struct lysp_when * when
const char * name
const char * ref
struct lysp_ext_instance * exts
struct lysp_node_notif * notifs
struct lysp_tpdf * typedefs
struct lyd_value ** dflts
struct lysp_node_action * actions
uint32_t refcount
struct lysc_ext_instance * exts
struct lysc_must * musts
struct lysc_when ** when
struct lysp_feature * features
struct lysc_node_action * rpcs
struct lysc_ext_instance * exts
char rev[11]
struct lysp_node * child
ly_bool to_compile
struct lysp_restr * musts
struct lysc_node_action_inout output
const char * prefix
struct lysp_restr * musts
const char * ref
const char * dsc
struct lysc_range * range
struct lysp_include * includes
struct lysc_range * range
struct lysc_ext * compiled
struct lysp_node_grp * groupings
struct lysp_ext_instance * exts
const char * ref
const char * units
struct lysc_when ** when
struct lysc_when ** when
struct lysp_revision * revs
struct lysc_node * child
struct lysp_qname * dflts
uint16_t nodetype
struct lys_module ** augmented_by
struct lyplg_type * plugin
LY_DATA_TYPE basetype
const char * name
struct lysp_node_notif * notifs
struct lysp_restr * range
struct lysp_qname * dflts
struct lysc_ext_instance * exts
const char * ref
LY_DATA_TYPE basetype
pcre2_code * code
struct lysp_deviate * next
struct lysp_qname arg
struct lysc_node_action * actions
LY_DATA_TYPE basetype
struct lysp_node * child
struct lysp_deviate * next
const char * units
struct lysp_import * imports
struct lyxp_expr * path
struct lysp_ext_instance * exts
struct lys_module ** deviated_by
struct lysp_qname dflt
uint8_t require_instance
struct lysc_when ** when
const char * units
struct lysp_when * when
const char * eapptag
struct lysp_ext_instance * exts
struct lysp_type type
const char * units
struct lysp_node_notif * notifs
struct lyplg_type * plugin
LY_DATA_TYPE basetype
LY_DATA_TYPE basetype
struct lysc_node_notif * notifs
struct lyxp_expr * cond
uint8_t hash[4]
uint32_t refcount
struct lysp_qname * uniques
const char * name
const char * ref
const char * dsc
const char * prefix
struct lysc_node_notif * notifs
struct lysp_node_notif * notifs
uint16_t nodetype
struct lysc_ext_instance * exts
const char * emsg
uint16_t flags
struct lysc_module * compiled
const char * contact
struct lys_module * module
uint16_t flags
struct lysp_when * when
struct lysc_must * musts
const char * presence
const char * name
const char * nodeid
struct lysp_when * when
struct lysp_tpdf * typedefs
const char * revision
uint8_t is_submod
struct lysc_type * type
const char * name
const char * dsc
struct lysp_node * next
LY_DATA_TYPE basetype
struct lysp_restr * patterns
struct lysp_ext_instance * exts
struct lysp_tpdf * typedefs
struct lysp_type type
struct lysp_node * child
struct lysc_ident * identities
struct lysc_ext_instance * exts
struct lysp_qname * iffeatures
const char * ref
const char * name
LY_DATA_TYPE basetype
struct lysp_node_action * actions
struct lysp_ext_instance * exts
const char * expr
struct lysp_node_augment * augments
uint32_t refcount
struct lysp_node * parent
const char * dsc
struct lysp_ext_instance * exts
const char * emsg
struct lysp_node_action * rpcs
struct lysp_node_action * actions
struct lysp_node_grp * groupings
struct lysp_qname * iffeatures
struct lysp_node_grp * groupings
uint16_t flags
uint16_t flags
struct lysc_ext_instance * exts
struct lysp_node * data
struct lysp_feature ** depfeatures
struct lysc_type_bitenum_item * bits
struct lysp_ext * extensions
const char * presence
struct lyplg_type * plugin
struct lysp_ext_instance * exts
struct lysc_node * parent
uint8_t latest_revision
struct lyplg_type * plugin
struct lys_module * module
const char * name
const struct lys_module * cur_mod
uint32_t refcount
const char * dsc
const char * dsc
struct lysp_type_enum * bits
struct lysc_pattern ** patterns
struct lysp_node_action_inout output
struct lysp_ident * identities
struct lysp_ext_instance * exts
uint8_t * expr
struct lysp_type * types
const char * ref
struct lysc_node * child
const char * argname
struct lysp_ext_instance * exts
struct lysp_qname dflt
struct lysp_node * child
struct lysp_deviation * deviations
struct lys_module * mod
const char * org
struct lysp_qname dflt
struct lysp_node * child
const char * ref
const char * ref
struct lysc_iffeature * iffeatures_c
const struct lysp_module * pmod
const char * dsc
struct lysp_qname * uniques
struct lysp_ext_instance * exts
struct lysp_node_augment * augments
const char * contact
ly_bool implemented
const char * key
const char * name
struct lys_module * mod
uint16_t flags
struct lysc_node_case * cases
const char * ref
uint16_t flags
uint16_t flags
struct lysp_restr * musts
struct lysp_ext_instance * exts
const char * ref
const char * filepath
struct lysc_node_notif * notifs
uint32_t max
const char * dsc
struct lysp_include * includes
struct lysc_must * musts
uint32_t min
struct lysp_deviate * deviates
struct lysc_ext_instance * exts
struct lyplg_type * plugin
ly_bool injected
const char * units
struct lysp_qname dflt
void * priv
struct lysc_node_action * actions
const char * name
struct lysp_tpdf * typedefs
struct lysp_qname * uniques
struct lysp_when * when
struct lysc_range * length
const char * name
struct lysp_restr * length
uint32_t refcount
struct lysc_when ** when
const char * eapptag
struct lysp_ext_instance * exts
struct lysc_type * type
struct lysp_restr * musts
struct lysp_restr * musts
struct lysp_ident * identities
const char * units
struct lyplg_type * plugin
struct lyxp_expr * path
struct lysp_qname * dflts
struct lysc_node * next
const char * dsc
struct lysc_ext_instance * exts
struct lysp_restr * musts
struct lysp_node * child
struct lysp_qname * iffeatures
uint8_t latest_revision
struct lysp_ext_instance * exts
struct lysc_ext_instance * exts
const char * dsc
struct lysp_revision * revs
struct lysc_type * compiled
struct lysc_node * child
uint16_t flags
struct lys_module * module
struct lysc_ext_instance * exts
struct lysp_type * type
struct lysc_node_leaf *** uniques
struct lysp_qname * iffeatures
struct lysp_when * when
const char * name
struct lysp_submodule * submodule
struct lysp_ext_instance * exts
struct lysp_feature * features
struct lysp_qname * dflts
struct lysp_restr * musts
const char * ref
struct lysp_node_action * rpcs
struct lysp_ext_instance * exts
const char ** bases
LY_DATA_TYPE basetype
const char * dsc
const char * name
struct lys_module * mod
struct lysc_node_action_inout input
struct lysp_when * when
const char * dsc
struct lysp_node_action * actions
uint16_t flags
struct lyplg_ext * plugin
struct lysp_deviation * deviations
char date[11]
struct lysc_must * musts
struct lysc_ident ** derived
uint32_t refcount
const char * ref
struct lysc_prefix * prefixes
struct lysc_ext_instance * exts
const char * dsc
const char * ref
struct lysc_type_bitenum_item * enums
const char * dsc
struct lysc_must * musts
struct lysp_node * child
const char * dsc
const char * filepath
struct lysp_node_action_inout input
struct lysp_tpdf * typedefs
struct lysc_when ** when
struct lyplg_type * plugin
struct lysp_when * when
const char * ns
const char * dsc
const char * ref
struct lysp_node_grp * groupings
struct lysc_range * length
struct lysc_prefix * prefixes
struct lysp_tpdf * typedefs
struct lysc_when ** when
struct lyplg_type * plugin
struct lysc_node * child
struct lysp_node_augment * augments
uint32_t refcount
uint32_t refcount
struct lysp_tpdf * typedefs
struct lysc_ext_instance * exts
struct lysp_type_enum * enums
const char * name
struct lysc_type * realtype
const char * eapptag
struct lysc_ext_instance * exts
struct lysp_node_grp * groupings
struct lysp_deviate * next
struct lysc_node * prev
struct lysp_type type
const char * ref
const char * dsc
uint32_t refcount
const char * org
struct lysc_ext_instance * exts
struct lyplg_type * plugin
const char * name
const char * ref
struct lysc_node * data
const char * dsc
const char * emsg
struct lysp_module * parsed
uint32_t refcount
struct lysc_must * musts
struct lysc_ext_instance * exts
struct lyxp_expr * cond
struct lyplg_type * plugin
const char * str
const char * prefix
struct lysp_node_notif * notifs
struct lysc_ext_instance * exts
const char * eapptag
uint8_t parsing
struct lysp_qname * iffeatures
const char * ref
struct lysc_node_case * dflt
const char * units
struct lysc_ext_instance * exts
struct lysp_when * when
struct lysc_type ** types
uint16_t flags
const char * argname
const char ** bases
const char * dsc
struct lysc_ext_instance * exts
struct lysc_ext_instance * exts
struct ly_ctx * ctx
struct lys_module * module
struct lysp_ext * extensions
struct lysp_node_notif * notifs
uint16_t flags
uint32_t inverted
struct lysc_node * context
LY_DATA_TYPE basetype
struct lysp_ext_instance * exts
struct lysc_ext_instance * exts
struct lysc_ext_instance * exts
const char * units
char rev[11]
uint8_t fraction_digits
const char * ref
struct lysp_restr * musts
struct lysc_must * musts
struct lysc_when ** when
struct lysp_import * imports
struct lysp_ext_instance * exts
const struct lysp_module * mod
uint8_t version
LY_DATA_TYPE basetype
struct lysp_restr * musts
struct lysc_ident ** bases
const char * emsg
struct lysp_feature ** features
const char * dsc
const char * nodeid
struct lysp_ext_instance * exts
struct lysc_range::lysc_range_part * parts
struct lysc_prefix * prefixes
struct lysp_node_grp * groupings
struct lysp_deviate * next
struct lysp_node * child
const struct lys_module * mod
struct lysp_node_grp * groupings
struct lysp_refine * refines
uint8_t fraction_digits
LIBYANG_API_DECL LY_ERR lysc_tree_dfs_full(const struct lysc_node *root, lysc_dfs_clb dfs_clb, void *data)
DFS traversal of all the schema nodes in a (sub)tree including any actions and nested notifications.
LIBYANG_API_DECL const struct lysc_when * lysc_has_when(const struct lysc_node *node)
Check whether the schema node data instance existence depends on any when conditions....
LIBYANG_API_DECL const struct lysp_node_action * lysp_node_actions(const struct lysp_node *node)
Get the actions/RPCs linked list of the given (parsed) schema node. Decides the node's type and in ca...
LIBYANG_API_DECL const struct lysc_node * lys_find_child(const struct lysc_node *parent, const struct lys_module *module, const char *name, size_t name_len, uint16_t nodetype, uint32_t options)
Get child node according to the specified criteria.
LY_ERR(* lysc_dfs_clb)(struct lysc_node *node, void *data, ly_bool *dfs_continue)
Callback to be called for every schema node in a DFS traversal.
LIBYANG_API_DECL LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff)
Get how the if-feature statement currently evaluates.
LIBYANG_API_DECL const struct lysc_node_notif * lysc_node_notifs(const struct lysc_node *node)
Get the Notifications linked list of the given (compiled) schema node. Decides the node's type and in...
LIBYANG_API_DECL const struct lysc_node * lysc_node_lref_target(const struct lysc_node *node)
Get the target node of a leafref node.
LIBYANG_API_DECL LY_ERR lys_find_path_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path, ly_bool output, struct ly_set **set)
Get all the schema nodes that are required for path to be evaluated (atoms).
LIBYANG_API_DECL const char * lyxp_get_expr(const struct lyxp_expr *path)
Getter for original XPath expression from a parsed expression.
LIBYANG_API_DECL LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod, const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set)
Get all the schema nodes that are required for expr to be evaluated (atoms).
LIBYANG_API_DECL struct lysc_must * lysc_node_musts(const struct lysc_node *node)
Get the must statements list if present in the node.
LIBYANG_API_DECL const struct lysp_node_notif * lysp_node_notifs(const struct lysp_node *node)
Get the Notifications linked list of the given (parsed) schema node. Decides the node's type and in c...
LIBYANG_API_DECL const struct lysp_node_grp * lysp_node_groupings(const struct lysp_node *node)
Get the groupings linked list of the given (parsed) schema node. Decides the node's type and in case ...
LIBYANG_API_DECL LY_ERR lys_identity_iffeature_value(const struct lysc_ident *ident)
Get how the if-feature statement is evaluated for certain identity.
LIBYANG_API_DECL LY_ERR lys_find_xpath_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath, uint32_t options, struct ly_set **set)
Get all the schema nodes that are required for xpath to be evaluated (atoms).
LIBYANG_API_DECL const char * lys_nodetype2str(uint16_t nodetype)
Stringify schema nodetype.
LIBYANG_API_DECL LY_ERR lys_set_implemented(struct lys_module *mod, const char **features)
Make the specific module implemented.
LIBYANG_API_DECL const struct lysp_tpdf * lysp_node_typedefs(const struct lysp_node *node)
Get the typedefs sized array of the given (parsed) schema node. Decides the node's type and in case i...
LIBYANG_API_DECL const struct lysc_node * lysc_node_child(const struct lysc_node *node)
Get the children linked list of the given (compiled) schema node.
LYSC_PATH_TYPE
Types of the different schema paths.
LIBYANG_API_DECL const struct lysc_node * lys_find_path(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path, ly_bool output)
Get a schema node based on the given data path (JSON format, see XPath Addressing).
LIBYANG_API_DECL const struct lysc_node * lys_getnext_ext(const struct lysc_node *last, const struct lysc_node *parent, const struct lysc_ext_instance *ext, uint32_t options)
Get next schema (sibling) node element in the schema order of an extension that can be instantiated i...
LIBYANG_API_DECL const struct lys_module * lysc_owner_module(const struct lysc_node *node)
Get the owner module of the schema node. It is the module of the top-level node. Generally,...
#define LYS_NODE_HASH_COUNT
Maximum number of hashes stored in a schema node.
LIBYANG_API_DECL char * lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen)
Generate path of the given node in the requested format.
LIBYANG_API_DECL LY_ERR lys_feature_value(const struct lys_module *module, const char *feature)
Get the current real status of the specified feature in the module.
LIBYANG_API_DECL LY_ERR lys_find_lypath_atoms(const struct ly_path *path, struct ly_set **set)
Get all the schema nodes that are required for path to be evaluated (atoms).
LIBYANG_API_DECL LY_ERR lysc_module_dfs_full(const struct lys_module *mod, lysc_dfs_clb dfs_clb, void *data)
DFS traversal of all the schema nodes in a module including RPCs and notifications.
LIBYANG_API_DECL const struct lysc_node_action * lysc_node_actions(const struct lysc_node *node)
Get the actions/RPCs linked list of the given (compiled) schema node. Decides the node's type and in ...
LIBYANG_API_DECL const struct lysp_node * lysp_node_child(const struct lysp_node *node)
Get the children linked list of the given (parsed) schema node. Decides the node's type and in case i...
LIBYANG_API_DECL struct lysp_feature * lysp_feature_next(const struct lysp_feature *last, const struct lysp_module *pmod, uint32_t *idx)
Get the next feature in the module or submodules.
LYS_VERSION
supported YANG schema version values
LIBYANG_API_DECL const struct lysc_node * lys_getnext(const struct lysc_node *last, const struct lysc_node *parent, const struct lysc_module *module, uint32_t options)
Get next schema (sibling) node element in the schema order that can be instantiated in a data tree....
LIBYANG_API_DECL struct lysc_when ** lysc_node_when(const struct lysc_node *node)
Get the when statements list if present in the node.
LIBYANG_API_DECL const struct lysc_node * lysc_data_node(const struct lysc_node *schema)
Get nearest schema parent (including the node itself) that can be instantiated in data.
LIBYANG_API_DECL LY_ERR lys_find_xpath(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath, uint32_t options, struct ly_set **set)
Evaluate an xpath expression on schema nodes.
#define LY_REV_SIZE
@ LYSC_PATH_LOG
@ LYSC_PATH_DATA
@ LYSC_PATH_DATA_PATTERN
@ LYS_VERSION_UNDEF
@ LYS_VERSION_1_0
@ LYS_VERSION_1_1
Available YANG schema tree structures representing YANG module.
Compiled YANG extension-stmt.
YANG identity-stmt.
Compiled YANG if-feature-stmt.
Compiled YANG schema tree structure representing YANG module.
Compiled YANG data node.
Compiled prefix data pair mapping of prefixes to modules. In case the format is LY_VALUE_SCHEMA_RESOL...
Compiled YANG revision statement.
YANG when-stmt.
Generic deviate structure to get type and cast to lysp_deviate_* structure.
YANG extension-stmt.
YANG feature-stmt.
YANG identity-stmt.
YANG import-stmt.
YANG include-stmt.
Printable YANG schema tree structure representing YANG module.
Generic YANG data node.
YANG rpc-stmt and action-stmt.
YANG input-stmt and output-stmt.
YANG uses-augment-stmt and augment-stmt (compatible with struct lysp_node )
Extension structure of the lysp_node for YANG container.
YANG grouping-stmt.
YANG notification-stmt.
Qualified name (optional prefix followed by an identifier).
YANG refine-stmt.
Covers restrictions: range, length, pattern, must.
YANG revision-stmt.
YANG typedef-stmt.
YANG type-stmt.
Enumeration/Bit value definition.
YANG when-stmt.
LY_DATA_TYPE
YANG built-in types.
Definition tree.h:202
Logger manipulation routines and error definitions.
uint8_t ly_bool
Type to indicate boolean value.
Definition log.h:35
libyang generic macros and functions to work with YANG schema or data trees.
YANG data representation.
Definition tree_data.h:560