libyang 3.4.2
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 "log.h"
27#include "ly_config.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
266 struct lys_module *module;
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 uint16_t flags;
343};
344
349 const char *name;
351 const char **bases;
352 const char *dsc;
353 const char *ref;
355 uint16_t flags;
356};
357
362#define LYSP_RESTR_PATTERN_ACK 0x06
363#define LYSP_RESTR_PATTERN_NACK 0x15
367 const char *emsg;
368 const char *eapptag;
369 const char *dsc;
370 const char *ref;
372};
373
379 const char *dsc;
380 const char *ref;
382};
383
388 const char *name;
389 const char *dsc;
390 const char *ref;
391 int64_t value;
394 uint16_t flags;
396};
397
403struct lysp_type {
404 const char *name;
410 struct lyxp_expr *path;
411 const char **bases;
412 struct lysp_type *types;
415 const struct lysp_module *pmod;
420 uint16_t flags;
421};
422
426struct lysp_tpdf {
427 const char *name;
428 const char *units;
430 const char *dsc;
431 const char *ref;
434 uint16_t flags;
435};
436
440struct lysp_when {
441 const char *cond;
442 const char *dsc;
443 const char *ref;
445};
446
451 const char *nodeid;
452 const char *dsc;
453 const char *ref;
456 const char *presence;
458 uint32_t min;
459 uint32_t max;
461 uint16_t flags;
462};
463
472#define LYS_DEV_NOT_SUPPORTED 1
473#define LYS_DEV_ADD 2
474#define LYS_DEV_DELETE 3
475#define LYS_DEV_REPLACE 4
482 uint8_t mod;
485};
486
488 uint8_t mod;
491 const char *units;
495 uint16_t flags;
496 uint32_t min;
497 uint32_t max;
498};
499
501 uint8_t mod;
504 const char *units;
508};
509
511 uint8_t mod;
514 struct lysp_type *type;
515 const char *units;
517 uint16_t flags;
518 uint32_t min;
519 uint32_t max;
520};
521
523 const char *nodeid;
524 const char *dsc;
525 const char *ref;
528};
529
653#define LYS_CONFIG_W 0x01
654#define LYS_CONFIG_R 0x02
655#define LYS_CONFIG_MASK 0x03
656#define LYS_STATUS_CURR 0x04
657#define LYS_STATUS_DEPRC 0x08
658#define LYS_STATUS_OBSLT 0x10
659#define LYS_STATUS_MASK 0x1C
660#define LYS_MAND_TRUE 0x20
665#define LYS_MAND_FALSE 0x40
668#define LYS_MAND_MASK 0x60
669#define LYS_PRESENCE 0x80
672#define LYS_UNIQUE 0x80
673#define LYS_KEY 0x0100
674#define LYS_KEYLESS 0x0200
675#define LYS_DISABLED 0x0100
676#define LYS_FENABLED 0x20
677#define LYS_ORDBY_SYSTEM 0x80
679#define LYS_ORDBY_USER 0x40
682#define LYS_ORDBY_MASK 0xC0
683#define LYS_YINELEM_TRUE 0x80
684#define LYS_YINELEM_FALSE 0x0100
685#define LYS_YINELEM_MASK 0x0180
686#define LYS_USED_GRP 0x0400
688#define LYS_SET_VALUE 0x0200
689#define LYS_SET_MIN 0x0200
690#define LYS_SET_MAX 0x0400
692#define LYS_SET_BASE 0x0001
693#define LYS_SET_BIT 0x0002
694#define LYS_SET_ENUM 0x0004
695#define LYS_SET_FRDIGITS 0x0008
696#define LYS_SET_LENGTH 0x0010
697#define LYS_SET_PATH 0x0020
698#define LYS_SET_PATTERN 0x0040
699#define LYS_SET_RANGE 0x0080
700#define LYS_SET_TYPE 0x0100
701#define LYS_SET_REQINST 0x0200
702#define LYS_SET_DFLT 0x0200
707#define LYS_SET_UNITS 0x0400
708#define LYS_SET_CONFIG 0x0800
710#define LYS_SINGLEQUOTED 0x0100
712#define LYS_DOUBLEQUOTED 0x0200
715#define LYS_YIN_ATTR 0x0400
716#define LYS_YIN_ARGUMENT 0x0800
718#define LYS_INTERNAL 0x1000
720#define LYS_IS_ENUM 0x0200
722#define LYS_IS_INPUT 0x1000
724#define LYS_IS_OUTPUT 0x2000
726#define LYS_IS_NOTIF 0x4000
728#define LYS_FLAGS_COMPILED_MASK 0xff
734struct lysp_node {
736 uint16_t nodetype;
737 uint16_t flags;
738 struct lysp_node *next;
739 const char *name;
740 const char *dsc;
741 const char *ref;
745};
746
751 union {
752 struct lysp_node node;
754 struct {
755 struct lysp_node *parent;
756 uint16_t nodetype;
757 uint16_t flags;
758 struct lysp_node *next;
759 const char *name;
760 const char *dsc;
761 const char *ref;
762 struct lysp_qname *iffeatures;
763 struct lysp_ext_instance *exts;
764 };
765 };
767 /* container */
769 struct lysp_when *when;
770 const char *presence;
773 struct lysp_node *child;
776};
777
779 union {
780 struct lysp_node node;
782 struct {
783 struct lysp_node *parent;
784 uint16_t nodetype;
785 uint16_t flags;
786 struct lysp_node *next;
787 const char *name;
788 const char *dsc;
789 const char *ref;
790 struct lysp_qname *iffeatures;
791 struct lysp_ext_instance *exts;
792 };
793 };
795 /* leaf */
797 struct lysp_when *when;
799 const char *units;
801};
802
804 union {
805 struct lysp_node node;
807 struct {
808 struct lysp_node *parent;
809 uint16_t nodetype;
810 uint16_t flags;
811 struct lysp_node *next;
812 const char *name;
813 const char *dsc;
814 const char *ref;
815 struct lysp_qname *iffeatures;
816 struct lysp_ext_instance *exts;
817 };
818 };
820 /* leaf-list */
822 struct lysp_when *when;
824 const char *units;
827 uint32_t min;
828 uint32_t max;
829};
830
832 union {
833 struct lysp_node node;
835 struct {
836 struct lysp_node *parent;
837 uint16_t nodetype;
838 uint16_t flags;
839 struct lysp_node *next;
840 const char *name;
841 const char *dsc;
842 const char *ref;
843 struct lysp_qname *iffeatures;
844 struct lysp_ext_instance *exts;
845 };
846 };
848 /* list */
850 struct lysp_when *when;
851 const char *key;
854 struct lysp_node *child;
858 uint32_t min;
859 uint32_t max;
860};
861
863 union {
864 struct lysp_node node;
866 struct {
867 struct lysp_node *parent;
868 uint16_t nodetype;
869 uint16_t flags;
870 struct lysp_node *next;
871 const char *name;
872 const char *dsc;
873 const char *ref;
874 struct lysp_qname *iffeatures;
875 struct lysp_ext_instance *exts;
876 };
877 };
879 /* choice */
880 struct lysp_node *child;
881 struct lysp_when *when;
883};
884
886 union {
887 struct lysp_node node;
889 struct {
890 struct lysp_node *parent;
891 uint16_t nodetype;
892 uint16_t flags;
893 struct lysp_node *next;
894 const char *name;
895 const char *dsc;
896 const char *ref;
897 struct lysp_qname *iffeatures;
898 struct lysp_ext_instance *exts;
899 };
900 };
902 /* case */
903 struct lysp_node *child;
904 struct lysp_when *when;
905};
906
908 union {
909 struct lysp_node node;
911 struct {
912 struct lysp_node *parent;
913 uint16_t nodetype;
914 uint16_t flags;
915 struct lysp_node *next;
916 const char *name;
917 const char *dsc;
918 const char *ref;
919 struct lysp_qname *iffeatures;
920 struct lysp_ext_instance *exts;
921 };
922 };
924 /* anyxml/anydata */
926 struct lysp_when *when;
927};
928
930 union {
931 struct lysp_node node;
933 struct {
934 struct lysp_node *parent;
935 uint16_t nodetype;
936 uint16_t flags;
937 struct lysp_node *next;
938 const char *name;
939 const char *dsc;
940 const char *ref;
941 struct lysp_qname *iffeatures;
942 struct lysp_ext_instance *exts;
943 };
944 };
946 /* uses */
949 struct lysp_when *when;
950};
951
956 union {
957 struct lysp_node node;
959 struct {
960 struct lysp_node *parent;
961 uint16_t nodetype;
962 uint16_t flags;
963 struct lysp_node *next;
964 const char *name;
965 const char *dsc;
966 const char *ref;
967 struct lysp_qname *iffeatures;
968 struct lysp_ext_instance *exts;
969 };
970 };
972 /* inout */
976 struct lysp_node *child;
977};
978
983 union {
984 struct lysp_node node;
986 struct {
987 struct lysp_node *parent;
988 uint16_t nodetype;
989 uint16_t flags;
990 struct lysp_node_action *next;
991 const char *name;
992 const char *dsc;
993 const char *ref;
994 struct lysp_qname *iffeatures;
995 struct lysp_ext_instance *exts;
996 };
997 };
999 /* action */
1005};
1006
1011 union {
1012 struct lysp_node node;
1014 struct {
1015 struct lysp_node *parent;
1016 uint16_t nodetype;
1017 uint16_t flags;
1018 struct lysp_node_notif *next;
1019 const char *name;
1020 const char *dsc;
1021 const char *ref;
1022 struct lysp_qname *iffeatures;
1023 struct lysp_ext_instance *exts;
1024 };
1025 };
1027 /* notif */
1032};
1033
1038 union {
1039 struct lysp_node node;
1041 struct {
1042 struct lysp_node *parent;
1043 uint16_t nodetype;
1044 uint16_t flags;
1045 struct lysp_node_grp *next;
1046 const char *name;
1047 const char *dsc;
1048 const char *ref;
1049 struct lysp_qname *iffeatures;
1050 struct lysp_ext_instance *exts;
1051 };
1052 };
1054 /* grp */
1060};
1061
1066 union {
1067 struct lysp_node node;
1069 struct {
1070 struct lysp_node *parent;
1071 uint16_t nodetype;
1072 uint16_t flags;
1073 struct lysp_node_augment *next;
1074 const char *nodeid;
1075 const char *dsc;
1076 const char *ref;
1077 struct lysp_qname *iffeatures;
1078 struct lysp_ext_instance *exts;
1079 };
1080 };
1083 struct lysp_when *when;
1086};
1087
1096
1125
1161
1168#define LYSP_MODULE_NAME(PMOD) (PMOD->is_submod ? ((struct lysp_submodule *)PMOD)->name : ((struct lysp_module *)PMOD)->mod->name)
1169
1175 char *prefix;
1176 const struct lys_module *mod;
1177};
1178
1186struct lysc_ext {
1187 const char *name;
1188 const char *argname;
1191 struct lys_module *module;
1192 uint16_t flags;
1193};
1194
1199 struct lyxp_expr *cond;
1202 const char *dsc;
1203 const char *ref;
1205 uint32_t refcount;
1206 uint16_t flags;
1207};
1208
1213 const char *name;
1214 const char *dsc;
1215 const char *ref;
1216 struct lys_module *module;
1220 uint16_t flags;
1221};
1222
1229#define LYS_IFF_NOT 0x00
1230#define LYS_IFF_AND 0x01
1231#define LYS_IFF_OR 0x02
1232#define LYS_IFF_F 0x03
1242
1245 union {
1246 int64_t min_64;
1247 uint64_t min_u64;
1248 };
1249 union {
1250 int64_t max_64;
1251 uint64_t max_u64;
1252 };
1254 const char *dsc;
1255 const char *ref;
1256 const char *emsg;
1257 const char *eapptag;
1259};
1260
1262 const char *expr;
1263 pcre2_code *code;
1264 const char *dsc;
1265 const char *ref;
1266 const char *emsg;
1267 const char *eapptag;
1269 uint32_t inverted : 1;
1270 uint32_t refcount : 31;
1271};
1272
1274 struct lyxp_expr *cond;
1276 const char *dsc;
1277 const char *ref;
1278 const char *emsg;
1279 const char *eapptag;
1281};
1282
1291
1301
1312
1323
1325 const char *name;
1326 const char *dsc;
1327 const char *ref;
1330 union {
1331 int32_t value;
1332 uint32_t position;
1333 };
1334 uint16_t flags;
1336};
1337
1347
1358
1371
1382
1392
1402
1412
1416#define LYS_NODE_HASH_COUNT 4
1417
1422 uint16_t nodetype;
1423 uint16_t flags;
1425 struct lys_module *module;
1427 struct lysc_node *next;
1428 struct lysc_node *prev;
1432 const char *name;
1433 const char *dsc;
1434 const char *ref;
1436 void *priv;
1437};
1438
1440 union {
1441 struct lysc_node node;
1443 struct {
1444 uint16_t nodetype;
1445 uint16_t flags;
1446 uint8_t hash[LYS_NODE_HASH_COUNT];
1447 struct lys_module *module;
1448 struct lysc_node *parent;
1449 struct lysc_node *next;
1450 struct lysc_node *prev;
1451 const char *name;
1452 const char *dsc;
1453 const char *ref;
1454 struct lysc_ext_instance *exts;
1455 void *priv;
1456 };
1457 };
1458
1461};
1462
1464 union {
1465 struct lysc_node node;
1467 struct {
1468 uint16_t nodetype;
1469 uint16_t flags;
1470 uint8_t hash[LYS_NODE_HASH_COUNT];
1471 struct lys_module *module;
1472 struct lysc_node *parent;
1473 struct lysc_node_action *next;
1474 struct lysc_node_action *prev;
1478 const char *name;
1479 const char *dsc;
1480 const char *ref;
1481 struct lysc_ext_instance *exts;
1482 void *priv;
1483 };
1484 };
1485
1486 struct lysc_when **when;
1492};
1493
1495 union {
1496 struct lysc_node node;
1498 struct {
1499 uint16_t nodetype;
1500 uint16_t flags;
1501 uint8_t hash[LYS_NODE_HASH_COUNT];
1502 struct lys_module *module;
1503 struct lysc_node *parent;
1504 struct lysc_node_notif *next;
1505 struct lysc_node_notif *prev;
1509 const char *name;
1510 const char *dsc;
1511 const char *ref;
1512 struct lysc_ext_instance *exts;
1513 void *priv;
1514 };
1515 };
1516
1519 struct lysc_when **when;
1522};
1523
1525 union {
1526 struct lysc_node node;
1528 struct {
1529 uint16_t nodetype;
1530 uint16_t flags;
1531 uint8_t hash[LYS_NODE_HASH_COUNT];
1532 struct lys_module *module;
1533 struct lysc_node *parent;
1534 struct lysc_node *next;
1535 struct lysc_node *prev;
1539 const char *name;
1540 const char *dsc;
1541 const char *ref;
1542 struct lysc_ext_instance *exts;
1543 void *priv;
1544 };
1545 };
1546
1549 struct lysc_when **when;
1552};
1553
1555 union {
1556 struct lysc_node node;
1558 struct {
1559 uint16_t nodetype;
1560 uint16_t flags;
1561 uint8_t hash[LYS_NODE_HASH_COUNT];
1562 struct lys_module *module;
1563 struct lysc_node *parent;
1564 struct lysc_node *next;
1565 struct lysc_node *prev;
1569 const char *name;
1570 const char *dsc;
1571 const char *ref;
1572 struct lysc_ext_instance *exts;
1573 void *priv;
1574 };
1575 };
1576
1579 struct lysc_when **when;
1580};
1581
1583 union {
1584 struct lysc_node node;
1586 struct {
1587 uint16_t nodetype;
1588 uint16_t flags;
1589 uint8_t hash[LYS_NODE_HASH_COUNT];
1590 struct lys_module *module;
1591 struct lysc_node *parent;
1592 struct lysc_node *next;
1593 struct lysc_node *prev;
1597 const char *name;
1598 const char *dsc;
1599 const char *ref;
1600 struct lysc_ext_instance *exts;
1601 void *priv;
1602 };
1603 };
1604
1606 struct lysc_when **when;
1608};
1609
1611 union {
1612 struct lysc_node node;
1614 struct {
1615 uint16_t nodetype;
1616 uint16_t flags;
1617 uint8_t hash[LYS_NODE_HASH_COUNT];
1618 struct lys_module *module;
1619 struct lysc_node *parent;
1620 struct lysc_node *next;
1621 struct lysc_node *prev;
1625 const char *name;
1626 const char *dsc;
1627 const char *ref;
1628 struct lysc_ext_instance *exts;
1629 void *priv;
1630 };
1631 };
1632
1634 struct lysc_when **when;
1635 struct lysc_type *type;
1637 const char *units;
1638 struct lyd_value *dflt;
1639};
1640
1642 union {
1643 struct lysc_node node;
1645 struct {
1646 uint16_t nodetype;
1647 uint16_t flags;
1648 uint8_t hash[LYS_NODE_HASH_COUNT];
1649 struct lys_module *module;
1650 struct lysc_node *parent;
1651 struct lysc_node *next;
1652 struct lysc_node *prev;
1656 const char *name;
1657 const char *dsc;
1658 const char *ref;
1659 struct lysc_ext_instance *exts;
1660 void *priv;
1661 };
1662 };
1663
1665 struct lysc_when **when;
1666 struct lysc_type *type;
1668 const char *units;
1669 struct lyd_value **dflts;
1672 uint32_t min;
1673 uint32_t max;
1675};
1676
1678 union {
1679 struct lysc_node node;
1681 struct {
1682 uint16_t nodetype;
1683 uint16_t flags;
1684 uint8_t hash[LYS_NODE_HASH_COUNT];
1685 struct lys_module *module;
1686 struct lysc_node *parent;
1687 struct lysc_node *next;
1688 struct lysc_node *prev;
1692 const char *name;
1693 const char *dsc;
1694 const char *ref;
1695 struct lysc_ext_instance *exts;
1696 void *priv;
1697 };
1698 };
1699
1702 struct lysc_when **when;
1707 uint32_t min;
1708 uint32_t max;
1709};
1710
1712 union {
1713 struct lysc_node node;
1715 struct {
1716 uint16_t nodetype;
1717 uint16_t flags;
1718 uint8_t hash[LYS_NODE_HASH_COUNT];
1719 struct lys_module *module;
1720 struct lysc_node *parent;
1721 struct lysc_node *next;
1722 struct lysc_node *prev;
1726 const char *name;
1727 const char *dsc;
1728 const char *ref;
1729 struct lysc_ext_instance *exts;
1730 void *priv;
1731 };
1732 };
1733
1735 struct lysc_when **when;
1736};
1737
1752
1759#define lysc_is_userordered(lysc_node) \
1760 ((!lysc_node || !(lysc_node->nodetype & (LYS_LEAFLIST | LYS_LIST)) || !(lysc_node->flags & LYS_ORDBY_USER)) ? 0 : 1)
1761
1768#define lysc_is_key(lysc_node) \
1769 ((!lysc_node || (lysc_node->nodetype != LYS_LEAF) || !(lysc_node->flags & LYS_KEY)) ? 0 : 1)
1770
1777#define lysc_is_np_cont(lysc_node) \
1778 ((!lysc_node || (lysc_node->nodetype != LYS_CONTAINER) || (lysc_node->flags & LYS_PRESENCE)) ? 0 : 1)
1779
1786#define lysc_is_dup_inst_list(lysc_node) \
1787 ((lysc_node && (((lysc_node->nodetype == LYS_LIST) && (lysc_node->flags & LYS_KEYLESS)) || \
1788 ((lysc_node->nodetype == LYS_LEAFLIST) && !(lysc_node->flags & LYS_CONFIG_W)))) ? 1 : 0)
1789
1796LIBYANG_API_DECL const struct lysc_node *lysc_data_node(const struct lysc_node *schema);
1797
1801#define lysc_data_parent(SCHEMA) lysc_data_node((SCHEMA) ? (SCHEMA)->parent : NULL)
1802
1813LIBYANG_API_DECL const struct lysc_when *lysc_has_when(const struct lysc_node *node);
1814
1822LIBYANG_API_DECL const struct lys_module *lysc_owner_module(const struct lysc_node *node);
1823
1830LIBYANG_API_DECL const struct lysp_node_grp *lysp_node_groupings(const struct lysp_node *node);
1831
1838LIBYANG_API_DECL const struct lysp_tpdf *lysp_node_typedefs(const struct lysp_node *node);
1839
1846LIBYANG_API_DECL const struct lysp_node_action *lysp_node_actions(const struct lysp_node *node);
1847
1854LIBYANG_API_DECL const struct lysp_node_notif *lysp_node_notifs(const struct lysp_node *node);
1855
1862LIBYANG_API_DECL const struct lysp_node *lysp_node_child(const struct lysp_node *node);
1863
1870LIBYANG_API_DECL const struct lysc_node_action *lysc_node_actions(const struct lysc_node *node);
1871
1878LIBYANG_API_DECL const struct lysc_node_notif *lysc_node_notifs(const struct lysc_node *node);
1879
1890LIBYANG_API_DECL const struct lysc_node *lysc_node_child(const struct lysc_node *node);
1891
1899LIBYANG_API_DECL struct lysc_must *lysc_node_musts(const struct lysc_node *node);
1900
1908LIBYANG_API_DECL struct lysc_when **lysc_node_when(const struct lysc_node *node);
1909
1916LIBYANG_API_DECL const struct lysc_node *lysc_node_lref_target(const struct lysc_node *node);
1917
1927typedef LY_ERR (*lysc_dfs_clb)(struct lysc_node *node, void *data, ly_bool *dfs_continue);
1928
1945LIBYANG_API_DECL LY_ERR lysc_tree_dfs_full(const struct lysc_node *root, lysc_dfs_clb dfs_clb, void *data);
1946
1958LIBYANG_API_DECL LY_ERR lysc_module_dfs_full(const struct lys_module *mod, lysc_dfs_clb dfs_clb, void *data);
1959
1968LIBYANG_API_DECL LY_ERR lysc_iffeature_value(const struct lysc_iffeature *iff);
1969
1981LIBYANG_API_DECL LY_ERR lys_identity_iffeature_value(const struct lysc_ident *ident);
1982
1991LIBYANG_API_DECL struct lysp_feature *lysp_feature_next(const struct lysp_feature *last, const struct lysp_module *pmod,
1992 uint32_t *idx);
1993
1999#define LYS_FIND_XP_SCHEMA 0x08
2000#define LYS_FIND_XP_OUTPUT 0x10
2001#define LYS_FIND_NO_MATCH_ERROR 0x40
2003#define LYS_FIND_SCHEMAMOUNT 0x0200
2018LIBYANG_API_DECL LY_ERR lys_find_xpath_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
2019 uint32_t options, struct ly_set **set);
2020
2033LIBYANG_API_DECL LY_ERR lys_find_expr_atoms(const struct lysc_node *ctx_node, const struct lys_module *cur_mod,
2034 const struct lyxp_expr *expr, const struct lysc_prefix *prefixes, uint32_t options, struct ly_set **set);
2035
2047LIBYANG_API_DECL LY_ERR lys_find_xpath(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *xpath,
2048 uint32_t options, struct ly_set **set);
2049
2058LIBYANG_API_DECL LY_ERR lys_find_lypath_atoms(const struct ly_path *path, struct ly_set **set);
2059
2070LIBYANG_API_DECL LY_ERR lys_find_path_atoms(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *path,
2071 ly_bool output, struct ly_set **set);
2072
2082LIBYANG_API_DECL const struct lysc_node *lys_find_path(const struct ly_ctx *ctx, const struct lysc_node *ctx_node,
2083 const char *path, ly_bool output);
2084
2094
2106LIBYANG_API_DECL char *lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen);
2107
2112 struct ly_ctx *ctx;
2113 const char *name;
2114 const char *revision;
2115 const char *ns;
2116 const char *prefix;
2117 const char *filepath;
2118 const char *org;
2119 const char *contact;
2120 const char *dsc;
2121 const char *ref;
2142};
2143
2151#define LYS_MOD_LATEST_REV 0x01
2152#define LYS_MOD_LATEST_SEARCHDIRS 0x02
2153#define LYS_MOD_IMPORTED_REV 0x04
2156#define LYS_MOD_LATEST_IMPCLB 0x08
2171LIBYANG_API_DECL LY_ERR lys_feature_value(const struct lys_module *module, const char *feature);
2172
2192LIBYANG_API_DECL const struct lysc_node *lys_getnext(const struct lysc_node *last, const struct lysc_node *parent,
2193 const struct lysc_module *module, uint32_t options);
2194
2207LIBYANG_API_DECL const struct lysc_node *lys_getnext_ext(const struct lysc_node *last, const struct lysc_node *parent,
2208 const struct lysc_ext_instance *ext, uint32_t options);
2209
2217#define LYS_GETNEXT_WITHCHOICE 0x01
2218#define LYS_GETNEXT_NOCHOICE 0x02
2219#define LYS_GETNEXT_WITHCASE 0x04
2220#define LYS_GETNEXT_INTONPCONT 0x08
2221#define LYS_GETNEXT_OUTPUT 0x10
2223#define LYS_GETNEXT_WITHSCHEMAMOUNT 0x20
2240LIBYANG_API_DECL const struct lysc_node *lys_find_child(const struct lysc_node *parent, const struct lys_module *module,
2241 const char *name, size_t name_len, uint16_t nodetype, uint32_t options);
2242
2258LIBYANG_API_DECL LY_ERR lys_set_implemented(struct lys_module *mod, const char **features);
2259
2266LIBYANG_API_DECL const char *lys_nodetype2str(uint16_t nodetype);
2267
2274LIBYANG_API_DECL const char *lyxp_get_expr(const struct lyxp_expr *path);
2275
2278#ifdef __cplusplus
2279}
2280#endif
2281
2282#endif /* LY_TREE_SCHEMA_H_ */
libyang context handler.
LY_ERR
libyang's error codes returned by the libyang functions.
Definition log.h:237
Structure to hold a set of (not necessary somehow connected) objects. Usually used for lyd_node,...
Definition set.h:47
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
const char * name
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
const char * name
struct lysp_qname * uniques
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
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 lys_module *struct lysc_ident ** derived
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
const char * name
LY_DATA_TYPE basetype
const char * name
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
uint8_t latest_revision
struct lyplg_type * plugin
const char * name
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
const char * name
void * priv
const char * name
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
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 lys_module *struct lysc_node * parent
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 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
const char * name
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 * name
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
struct lyplg_ext * plugin
struct lysp_deviation * deviations
char date[11]
struct lysc_must * musts
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
const char * name
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
struct lys_module *uint16_t flags
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 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 lys_module *const char * name
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
uint16_t flags
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:571