/usr/include/yuma/ncx/ncx.h is in libyuma-dev 2.9-1+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 | /*
* Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef _H_ncx
#define _H_ncx
/* FILE: ncx.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
NCX Module Library Utility Functions
Container of Definitions
+-----------------+
| ncx_module_t |
| ncxtypes.h |
+-----------------+
Template/Schema
+-----------------+
| obj_template_t |
| obj.h |
+-----------------+
^ |
| | Value Instances
| | +-----------------+
| +---->| val_value_t |
| | val.h |
| +-----------------+
|
| Data Types
| +--------------------+
+---| typ_template_t |
| typ.h |
+--------------------+
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
29-oct-05 abb Begun
20-jul-08 abb Start YANG rewrite; remove PSD and PS
23-aug-09 abb Update diagram in header
*/
#include <xmlstring.h>
#ifndef _H_dlq
#include "dlq.h"
#endif
#ifndef _H_grp
#include "grp.h"
#endif
#ifndef _H_log
#include "log.h"
#endif
#ifndef _H_ncxconst
#include "ncxconst.h"
#endif
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
#ifndef _H_obj
#include "obj.h"
#endif
#ifndef _H_rpc
#include "rpc.h"
#endif
#ifndef _H_tk
#include "tk.h"
#endif
#ifndef _H_typ
#include "typ.h"
#endif
#ifndef _H_val
#include "val.h"
#endif
#ifndef _H_xmlns
#include "xmlns.h"
#endif
#ifndef _H_yang
#include "yang.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/********************************************************************
* FUNCTION ncx_init
*
* Initialize the NCX module
*
* INPUTS:
* savestr == TRUE if parsed description strings that are
* not needed by the agent at runtime should
* be saved anyway. Converters should use this value.
*
* == FALSE if uneeded strings should not be saved.
* Embedded agents should use this value
*
* dlevel == desired debug output level
* logtstamps == TRUE if log should use timestamps
* FALSE if not; not used unless 'log' is present
* startmsg == log_debug2 message to print before starting;
* NULL if not used;
* argc == CLI argument count for bootstrap CLI
* argv == array of CLI parms for bootstrap CLI
*
* RETURNS:
* status of the initialization procedure
*********************************************************************/
extern status_t
ncx_init (boolean savestr,
log_debug_t dlevel,
boolean logtstamps,
const char *startmsg,
int argc,
char *argv[]);
/********************************************************************
* FUNCTION ncx_cleanup
*
* cleanup NCX module
*********************************************************************/
extern void
ncx_cleanup (void);
/********************************************************************
* FUNCTION ncx_new_module
*
* Malloc and initialize the fields in a ncx_module_t
*
* RETURNS:
* pointer to the malloced and initialized struct or NULL if an error
*********************************************************************/
extern ncx_module_t *
ncx_new_module (void);
/********************************************************************
* FUNCTION ncx_find_module
*
* Find a ncx_module_t in the ncx_modQ
* These are the modules that are already loaded
*
* INPUTS:
* modname == module name
* revision == module revision date
*
* RETURNS:
* module pointer if found or NULL if not
*********************************************************************/
extern ncx_module_t *
ncx_find_module (const xmlChar *modname,
const xmlChar *revision);
/********************************************************************
* FUNCTION ncx_find_module_que
*
* Find a ncx_module_t in the specified Q
* Check the namespace ID
*
* INPUTS:
* modQ == module Q to search
* modname == module name
* revision == module revision date
*
* RETURNS:
* module pointer if found or NULL if not
*********************************************************************/
extern ncx_module_t *
ncx_find_module_que (dlq_hdr_t *modQ,
const xmlChar *modname,
const xmlChar *revision);
/********************************************************************
* FUNCTION ncx_find_module_que_nsid
*
* Find a ncx_module_t in the specified Q
* Check the namespace ID
*
* INPUTS:
* modQ == module Q to search
* nsid == xmlns ID to find
*
* RETURNS:
* module pointer if found or NULL if not
*********************************************************************/
extern ncx_module_t *
ncx_find_module_que_nsid (dlq_hdr_t *modQ,
xmlns_id_t nsid);
/********************************************************************
* FUNCTION ncx_free_module
*
* Scrub the memory in a ncx_module_t by freeing all
* the sub-fields and then freeing the entire struct itself
* use if module was not added to registry
*
* MUST remove this struct from the ncx_modQ before calling
* Does not remove module definitions from the registry
*
* Use the ncx_remove_module function if the module was
* already successfully added to the modQ and definition registry
*
* INPUTS:
* mod == ncx_module_t data structure to free
*********************************************************************/
extern void
ncx_free_module (ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_any_mod_errors
*
* Check if any of the loaded modules are loaded with non-fatal errors
*
* RETURNS:
* TRUE if any modules are loaded with non-fatal errors
* FALSE if all modules present have a status of NO_ERR
*********************************************************************/
extern boolean
ncx_any_mod_errors (void);
/********************************************************************
* FUNCTION ncx_any_dependency_errors
*
* Check if any of the imports that this module relies on
* were loadeds are loaded with non-fatal errors
*
* RETURNS:
* TRUE if any modules are loaded with non-fatal errors
* FALSE if all modules present have a status of NO_ERR
*********************************************************************/
extern boolean
ncx_any_dependency_errors (const ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_find_type
*
* Check if a typ_template_t in the mod->typeQ
*
* INPUTS:
* mod == ncx_module to check
* typname == type name
* useall == TRUE to use all submodules
* FALSE to only use the ones in the mod->includeQ
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern typ_template_t *
ncx_find_type (ncx_module_t *mod,
const xmlChar *typname,
boolean useall);
/********************************************************************
* FUNCTION ncx_find_type_que
*
* Check if a typ_template_t in the mod->typeQ
*
* INPUTS:
* que == type Q to check
* typname == type name
*
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern typ_template_t *
ncx_find_type_que (const dlq_hdr_t *typeQ,
const xmlChar *typname);
/********************************************************************
* FUNCTION ncx_find_grouping
*
* Check if a grp_template_t in the mod->groupingQ
*
* INPUTS:
* mod == ncx_module to check
* grpname == group name
* useall == TRUE to check all existing nodes
* FALSE to only use includes visible to this [sub]mod
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern grp_template_t *
ncx_find_grouping (ncx_module_t *mod,
const xmlChar *grpname,
boolean useall);
/********************************************************************
* FUNCTION ncx_find_grouping_que
*
* Check if a grp_template_t in the specified Q
*
* INPUTS:
* groupingQ == Queue of grp_template_t to check
* grpname == group name
*
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern grp_template_t *
ncx_find_grouping_que (const dlq_hdr_t *groupingQ,
const xmlChar *grpname);
/********************************************************************
* FUNCTION ncx_find_rpc
*
* Check if a rpc_template_t in the mod->rpcQ
*
* INPUTS:
* mod == ncx_module to check
* rpcname == RPC name
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern obj_template_t *
ncx_find_rpc (const ncx_module_t *mod,
const xmlChar *rpcname);
/********************************************************************
* FUNCTION ncx_match_rpc
*
* Check if a rpc_template_t in the mod->rpcQ
*
* INPUTS:
* mod == ncx_module to check
* rpcname == RPC name to match
* retcount == address of return match count
*
* OUTPUTS:
* *retcount == number of matches found
*
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern obj_template_t *
ncx_match_rpc (const ncx_module_t *mod,
const xmlChar *rpcname,
uint32 *retcount);
/********************************************************************
* FUNCTION ncx_match_any_rpc
*
* Check if a rpc_template_t in in any module that
* matches the rpc name string and maybe the owner
*
* INPUTS:
* module == module name to check (NULL == check all)
* rpcname == RPC name to match
* retcount == address of return count of matches
*
* OUTPUTS:
* *retcount == number of matches found
*
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern obj_template_t *
ncx_match_any_rpc (const xmlChar *module,
const xmlChar *rpcname,
uint32 *retcount);
/********************************************************************
* FUNCTION ncx_match_any_rpc_mod
*
* Check if a rpc_template_t is in the specified module
*
* INPUTS:
* mod == module struct to check
* rpcname == RPC name to match
* retcount == address of return count of matches
*
* OUTPUTS:
* *retcount == number of matches found
*
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern obj_template_t *
ncx_match_any_rpc_mod (ncx_module_t *mod,
const xmlChar *rpcname,
uint32 *retcount);
/********************************************************************
* FUNCTION ncx_match_rpc_error
*
* Generate an error for multiple matches
*
* INPUTS:
* mod == module struct to check (may be NULL)
* modname == module name if mod not set
* == NULL to match all modules
* rpcname == RPC name to match
* match == TRUE to match partial command names
* FALSE for exact match only
* firstmsg == TRUE to do the first log_error banner msg
* FALSE to skip this step
*********************************************************************/
extern void
ncx_match_rpc_error (ncx_module_t *mod,
const xmlChar *modname,
const xmlChar *rpcname,
boolean match,
boolean firstmsg);
/********************************************************************
* FUNCTION ncx_find_any_object
*
* Check if an obj_template_t in in any module that
* matches the object name string
*
* INPUTS:
* objname == object name to match
*
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern obj_template_t *
ncx_find_any_object (const xmlChar *objname);
/********************************************************************
* FUNCTION ncx_match_any_object
*
* Check if an obj_template_t in in any module that
* matches the object name string
*
* INPUTS:
* objname == object name to match
* name_match == name match mode enumeration
* alt_names == TRUE if alternate names should be checked
* after regular names; FALSE if not
* retres == address of return status
*
* OUTPUTS:
* if retres not NULL, *retres set to return status
*
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern obj_template_t *
ncx_match_any_object (const xmlChar *objname,
ncx_name_match_t name_match,
boolean alt_names,
status_t *retres);
/********************************************************************
* FUNCTION ncx_find_any_object_que
*
* Check if an obj_template_t in in any module that
* matches the object name string
*
* INPUTS:
* modQ == Q of modules to check
* objname == object name to match
*
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern obj_template_t *
ncx_find_any_object_que (dlq_hdr_t *modQ,
const xmlChar *objname);
/********************************************************************
* FUNCTION ncx_find_object
*
* Find a top level module object
*
* INPUTS:
* mod == ncx_module to check
* typname == type name
* RETURNS:
* pointer to struct if present, NULL otherwise
*********************************************************************/
extern obj_template_t *
ncx_find_object (ncx_module_t *mod,
const xmlChar *objname);
/********************************************************************
* FUNCTION ncx_add_namespace_to_registry
*
* Add the namespace and prefix to the registry
* or retrieve it if already set
*
* INPUTS:
* mod == module to add to registry
* tempmod == TRUE if this is a temporary add mode
* FALSE if this is a real registry add
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_add_namespace_to_registry (ncx_module_t *mod,
boolean tempmod);
/********************************************************************
* FUNCTION ncx_add_to_registry
*
* Add all the definitions stored in an ncx_module_t to the registry
* This step is deferred to keep the registry stable as possible
* and only add modules in an all-or-none fashion.
*
* INPUTS:
* mod == module to add to registry
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_add_to_registry (ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_add_to_modQ
*
* Add module to the current module Q
* Used by yangdiff to bypass add_to_registry to support
* N different module trees
*
* INPUTS:
* mod == module to add to current module Q
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_add_to_modQ (ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_is_duplicate
*
* Search the specific module for the specified definition name.
* This function is for modules in progress which have not been
* added to the registry yet.
*
* INPUTS:
* mod == ncx_module_t to check
* defname == name of definition to find
* RETURNS:
* TRUE if found, FALSE otherwise
*********************************************************************/
extern boolean
ncx_is_duplicate (ncx_module_t *mod,
const xmlChar *defname);
/********************************************************************
* FUNCTION ncx_get_first_module
*
* Get the first module in the ncx_modQ
*
* RETURNS:
* pointer to the first entry or NULL if empty Q
*********************************************************************/
extern ncx_module_t *
ncx_get_first_module (void);
/********************************************************************
* FUNCTION ncx_get_next_module
*
* Get the next module in the ncx_modQ
*
* INPUTS:
* mod == current module to find next
*
* RETURNS:
* pointer to the first entry or NULL if empty Q
*********************************************************************/
extern ncx_module_t *
ncx_get_next_module (const ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_first_session_module
*
* Get the first module in the ncx_sesmodQ
*
* RETURNS:
* pointer to the first entry or NULL if empty Q
*********************************************************************/
extern ncx_module_t *
ncx_get_first_session_module (void);
/********************************************************************
* FUNCTION ncx_get_next_session_module
*
* Get the next module in the ncx_sesmodQ
*
* RETURNS:
* pointer to the first entry or NULL if empty Q
*********************************************************************/
extern ncx_module_t *
ncx_get_next_session_module (const ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_modname
*
* Get the main module name
*
* INPUTS:
* mod == module or submodule to get main module name
*
* RETURNS:
* main module name or NULL if error
*********************************************************************/
extern const xmlChar *
ncx_get_modname (const ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_mod_nsid
*
* Get the main module namespace ID
*
* INPUTS:
* mod == module or submodule to get main module namespace ID
*
* RETURNS:
* namespace id number
*********************************************************************/
extern xmlns_id_t
ncx_get_mod_nsid (const ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_modversion
*
* Get the [sub]module version
* INPUTS:
* mod == module or submodule to get module version
*
* RETURNS:
* module version or NULL if error
*********************************************************************/
extern const xmlChar *
ncx_get_modversion (const ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_modnamespace
*
* Get the module namespace URI
*
* INPUTS:
* mod == module or submodule to get module namespace
*
* RETURNS:
* module namespace or NULL if error
*********************************************************************/
extern const xmlChar *
ncx_get_modnamespace (const ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_modsource
*
* Get the module filespec source string
*
* INPUTS:
* mod == module or submodule to use
*
* RETURNS:
* module filespec source string
*********************************************************************/
extern const xmlChar *
ncx_get_modsource (const ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_mainmod
*
* Get the main module
*
* INPUTS:
* mod == submodule to get main module
*
* RETURNS:
* main module NULL if error
*********************************************************************/
extern ncx_module_t *
ncx_get_mainmod (ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_first_object
*
* Get the first object in the datadefQs for the specified module
* Get any object with a name
*
* INPUTS:
* mod == module to search for the first object
*
* RETURNS:
* pointer to the first object or NULL if empty Q
*********************************************************************/
extern obj_template_t *
ncx_get_first_object (ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_next_object
*
* Get the next object in the specified module
* Get any object with a name
*
* INPUTS:
* mod == module struct to get the next object from
* curobj == pointer to the current object to get the next for
*
* RETURNS:
* pointer to the next object or NULL if none
*********************************************************************/
extern obj_template_t *
ncx_get_next_object (ncx_module_t *mod,
obj_template_t *curobj);
/********************************************************************
* FUNCTION ncx_get_first_data_object
*
* Get the first database object in the datadefQs
* for the specified module
*
* INPUTS:
* mod == module to search for the first object
*
* RETURNS:
* pointer to the first object or NULL if empty Q
*********************************************************************/
extern obj_template_t *
ncx_get_first_data_object (ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_next_data_object
*
* Get the next database object in the specified module
*
* INPUTS:
* mod == pointer to module to get object from
* curobj == pointer to current object to get next from
*
* RETURNS:
* pointer to the next object or NULL if none
*********************************************************************/
extern obj_template_t *
ncx_get_next_data_object (ncx_module_t *mod,
obj_template_t *curobj);
/********************************************************************
* FUNCTION ncx_new_import
*
* Malloc and initialize the fields in a ncx_import_t
*
* RETURNS:
* pointer to the malloced and initialized struct or NULL if an error
*********************************************************************/
extern ncx_import_t *
ncx_new_import (void);
/********************************************************************
* FUNCTION ncx_free_import
*
* Scrub the memory in a ncx_import_t by freeing all
* the sub-fields and then freeing the entire struct itself
* The struct must be removed from any queue it is in before
* this function is called.
*
* INPUTS:
* import == ncx_import_t data structure to free
*********************************************************************/
extern void
ncx_free_import (ncx_import_t *import);
/********************************************************************
* FUNCTION ncx_find_import
*
* Search the importQ for a specified module name
*
* INPUTS:
* mod == module to search (mod->importQ)
* module == module name to find
*
* RETURNS:
* pointer to the node if found, NULL if not found
*********************************************************************/
extern ncx_import_t *
ncx_find_import (const ncx_module_t *mod,
const xmlChar *module);
/********************************************************************
* FUNCTION ncx_find_import_que
*
* Search the specified importQ for a specified module name
*
* INPUTS:
* importQ == Q of ncx_import_t to search
* module == module name to find
*
* RETURNS:
* pointer to the node if found, NULL if not found
*********************************************************************/
extern ncx_import_t *
ncx_find_import_que (const dlq_hdr_t *importQ,
const xmlChar *module);
/********************************************************************
* FUNCTION ncx_find_import_test
*
* Search the importQ for a specified module name
* Do not set used flag
*
* INPUTS:
* mod == module to search (mod->importQ)
* module == module name to find
*
* RETURNS:
* pointer to the node if found, NULL if not found
*********************************************************************/
extern ncx_import_t *
ncx_find_import_test (const ncx_module_t *mod,
const xmlChar *module);
/********************************************************************
* FUNCTION ncx_find_pre_import
*
* Search the importQ for a specified prefix value
*
* INPUTS:
* mod == module to search (mod->importQ)
* prefix == prefix string to find
*
* RETURNS:
* pointer to the node if found, NULL if not found
*********************************************************************/
extern ncx_import_t *
ncx_find_pre_import (const ncx_module_t *mod,
const xmlChar *prefix);
/********************************************************************
* FUNCTION ncx_find_pre_import_que
*
* Search the specified importQ for a specified prefix value
*
* INPUTS:
* importQ == Q of ncx_import_t to search
* prefix == prefix string to find
*
* RETURNS:
* pointer to the node if found, NULL if not found
*********************************************************************/
extern ncx_import_t *
ncx_find_pre_import_que (const dlq_hdr_t *importQ,
const xmlChar *prefix);
/********************************************************************
* FUNCTION ncx_find_pre_import_test
*
* Search the importQ for a specified prefix value
* Test only, do not set used flag
*
* INPUTS:
* mod == module to search (mod->importQ)
* prefix == prefix string to find
*
* RETURNS:
* pointer to the node if found, NULL if not found
*********************************************************************/
extern ncx_import_t *
ncx_find_pre_import_test (const ncx_module_t *mod,
const xmlChar *prefix);
/********************************************************************
* FUNCTION ncx_locate_modqual_import
*
* Search the specific module for the specified definition name.
*
* Okay for YANG or NCX
*
* - typ_template_t (NCX_NT_TYP)
* - grp_template_t (NCX_NT_GRP)
* - obj_template_t (NCX_NT_OBJ)
* - rpc_template_t (NCX_NT_RPC)
* - not_template_t (NCX_NT_NOTIF)
*
* INPUTS:
* pcb == parser control block to use
* imp == NCX import struct to use
* defname == name of definition to find
* *deftyp == specified type or NCX_NT_NONE if any will do
*
* OUTPUTS:
* imp->mod may get set if not already
* *deftyp == type retrieved if NO_ERR
*
* RETURNS:
* pointer to the located definition or NULL if not found
*********************************************************************/
extern void *
ncx_locate_modqual_import (yang_pcb_t *pcb,
ncx_import_t *imp,
const xmlChar *defname,
ncx_node_t *deftyp);
/********************************************************************
* FUNCTION ncx_new_include
*
* Malloc and initialize the fields in a ncx_include_t
*
* RETURNS:
* pointer to the malloced and initialized struct or NULL if an error
*********************************************************************/
extern ncx_include_t *
ncx_new_include (void);
/********************************************************************
* FUNCTION ncx_free_include
*
* Scrub the memory in a ncx_include_t by freeing all
* the sub-fields and then freeing the entire struct itself
* The struct must be removed from any queue it is in before
* this function is called.
*
* INPUTS:
* inc == ncx_include_t data structure to free
*********************************************************************/
extern void
ncx_free_include (ncx_include_t *inc);
/********************************************************************
* FUNCTION ncx_find_include
*
* Search the includeQ for a specified submodule name
*
* INPUTS:
* mod == module to search (mod->includeQ)
* submodule == submodule name to find
*
* RETURNS:
* pointer to the node if found, NULL if not found
*********************************************************************/
extern ncx_include_t *
ncx_find_include (const ncx_module_t *mod,
const xmlChar *submodule);
/********************************************************************
* FUNCTION ncx_new_binary
*
* Malloc and fill in a new ncx_binary_t struct
*
* INPUTS:
* none
* RETURNS:
* pointer to malloced and initialized ncx_binary_t struct
* NULL if malloc error
*********************************************************************/
extern ncx_binary_t *
ncx_new_binary (void);
/********************************************************************
* FUNCTION ncx_init_binary
*
* Init the memory of a ncx_binary_t struct
*
* INPUTS:
* binary == ncx_binary_t struct to init
*********************************************************************/
extern void
ncx_init_binary (ncx_binary_t *binary);
/********************************************************************
* FUNCTION ncx_clean_binary
*
* Scrub the memory of a ncx_binary_t but do not delete it
*
* INPUTS:
* binary == ncx_binary_t struct to clean
*********************************************************************/
extern void
ncx_clean_binary (ncx_binary_t *binary);
/********************************************************************
* FUNCTION ncx_free_binary
*
* Free all the memory in a ncx_binary_t struct
*
* INPUTS:
* binary == struct to clean and free
*
*********************************************************************/
extern void
ncx_free_binary (ncx_binary_t *binary);
/********************************************************************
* FUNCTION ncx_new_identity
*
* Get a new ncx_identity_t struct
*
* INPUTS:
* none
* RETURNS:
* pointer to a malloced ncx_identity_t struct,
* or NULL if malloc error
*********************************************************************/
extern ncx_identity_t *
ncx_new_identity (void);
/********************************************************************
* FUNCTION ncx_free_identity
*
* Free a malloced ncx_identity_t struct
*
* INPUTS:
* identity == struct to free
*
*********************************************************************/
extern void
ncx_free_identity (ncx_identity_t *identity);
/********************************************************************
* FUNCTION ncx_find_identity
*
* Find a ncx_identity_t struct in the module and perhaps
* any of its submodules
*
* INPUTS:
* mod == module to search
* name == identity name to find
* useall == TRUE if all submodules should be checked
* FALSE if only visible included submodules
* should be checked
* RETURNS:
* pointer to found feature or NULL if not found
*********************************************************************/
extern ncx_identity_t *
ncx_find_identity (ncx_module_t *mod,
const xmlChar *name,
boolean useall);
/********************************************************************
* FUNCTION ncx_find_identity_que
*
* Find a ncx_identity_t struct in the specified Q
*
* INPUTS:
* identityQ == Q of ncx_identity_t to search
* name == identity name to find
*
* RETURNS:
* pointer to found identity or NULL if not found
*********************************************************************/
extern ncx_identity_t *
ncx_find_identity_que (dlq_hdr_t *identityQ,
const xmlChar *name);
/********************************************************************
* FUNCTION ncx_new_filptr
*
* Get a new ncx_filptr_t struct
*
* INPUTS:
* none
* RETURNS:
* pointer to a malloced or cached ncx_filptr_t struct,
* or NULL if none available
*********************************************************************/
extern ncx_filptr_t *
ncx_new_filptr (void);
/********************************************************************
* FUNCTION ncx_free_filptr
*
* Free a new ncx_filptr_t struct or add to the cache if room
*
* INPUTS:
* filptr == struct to free
* RETURNS:
* none
*********************************************************************/
extern void
ncx_free_filptr (ncx_filptr_t *filptr);
/********************************************************************
* FUNCTION ncx_new_revhist
*
* Create a revision history entry
*
* RETURNS:
* malloced revision history entry or NULL if malloc error
*********************************************************************/
extern ncx_revhist_t *
ncx_new_revhist (void);
/********************************************************************
* FUNCTION ncx_free_revhist
*
* Free a revision history entry
*
* INPUTS:
* revhist == ncx_revhist_t data structure to free
*********************************************************************/
extern void
ncx_free_revhist (ncx_revhist_t *revhist);
/********************************************************************
* FUNCTION ncx_find_revhist
*
* Search the revhistQ for a specified revision
*
* INPUTS:
* mod == module to search (mod->importQ)
* ver == version string to find
*
* RETURNS:
* pointer to the node if found, NULL if not found
*********************************************************************/
extern ncx_revhist_t *
ncx_find_revhist (const ncx_module_t *mod,
const xmlChar *ver);
/********************************************************************
* FUNCTION ncx_init_enum
*
* Init the memory of a ncx_enum_t
*
* INPUTS:
* enu == ncx_enum_t struct to init
*********************************************************************/
extern void
ncx_init_enum (ncx_enum_t *enu);
/********************************************************************
* FUNCTION ncx_clean_enum
*
* Scrub the memory of a ncx_enum_t but do not delete it
*
* INPUTS:
* enu == ncx_enum_t struct to clean
*********************************************************************/
extern void
ncx_clean_enum (ncx_enum_t *enu);
/********************************************************************
* FUNCTION ncx_compare_enums
*
* Compare 2 enum values
*
* INPUTS:
* enu1 == first ncx_enum_t check
* enu2 == second ncx_enum_t check
*
* RETURNS:
* -1 if enu1 is < enu2
* 0 if enu1 == enu2
* 1 if enu1 is > enu2
*********************************************************************/
extern int32
ncx_compare_enums (const ncx_enum_t *enu1,
const ncx_enum_t *enu2);
/********************************************************************
* FUNCTION ncx_set_enum
*
* Parse an enumerated integer string into an ncx_enum_t
* without matching it against any typdef
*
* Mallocs a copy of the enum name, using the enu->dname field
*
* INPUTS:
* enumval == enum string value to parse
* retenu == pointer to return enuym variable to fill in
*
* OUTPUTS:
* *retenu == enum filled in
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_set_enum (const xmlChar *enumval,
ncx_enum_t *retenu);
/********************************************************************
* FUNCTION ncx_init_bit
*
* Init the memory of a ncx_bit_t
*
* INPUTS:
* bit == ncx_bit_t struct to init
*********************************************************************/
extern void
ncx_init_bit (ncx_bit_t *bit);
/********************************************************************
* FUNCTION ncx_clean_bit
*
* Scrub the memory of a ncx_bit_t but do not delete it
*
* INPUTS:
* bit == ncx_bit_t struct to clean
*********************************************************************/
extern void
ncx_clean_bit (ncx_bit_t *bit);
/********************************************************************
* FUNCTION ncx_compare_bits
*
* Compare 2 bit values by their schema order position
*
* INPUTS:
* bitone == first ncx_bit_t check
* bitone == second ncx_bit_t check
*
* RETURNS:
* -1 if bitone is < bittwo
* 0 if bitone == bittwo
* 1 if bitone is > bittwo
*
*********************************************************************/
extern int32
ncx_compare_bits (const ncx_bit_t *bitone,
const ncx_bit_t *bittwo);
/********************************************************************
* FUNCTION ncx_new_typname
*
* Malloc and init a typname struct
*
* RETURNS:
* malloced struct or NULL if memory error
*********************************************************************/
extern ncx_typname_t *
ncx_new_typname (void);
/********************************************************************
* FUNCTION ncx_free_typname
*
* Free a typname struct
*
* INPUTS:
* typnam == ncx_typname_t struct to free
*
*********************************************************************/
extern void
ncx_free_typname (ncx_typname_t *typnam);
/********************************************************************
* FUNCTION ncx_find_typname
*
* Find a typname struct in the specified Q for a typ pointer
*
* INPUTS:
* que == Q of ncx_typname_t struct to check
* typ == matching type template to find
*
* RETURNS:
* name assigned to this type template
*********************************************************************/
extern const xmlChar *
ncx_find_typname (const typ_template_t *typ,
const dlq_hdr_t *que);
/********************************************************************
* FUNCTION ncx_find_typname_type
*
* Find a typ_template_t pointer in a typename mapping,
* in the specified Q
*
* INPUTS:
* que == Q of ncx_typname_t struct to check
* typname == matching type name to find
*
* RETURNS:
* pointer to the stored typstatus
*********************************************************************/
extern const typ_template_t *
ncx_find_typname_type (const dlq_hdr_t *que,
const xmlChar *typname);
/********************************************************************
* FUNCTION ncx_clean_typnameQ
*
* Delete all the Q entries, of typname mapping structs
*
* INPUTS:
* que == Q of ncx_typname_t struct to delete
*
*********************************************************************/
extern void
ncx_clean_typnameQ (dlq_hdr_t *que);
/********************************************************************
* FUNCTION ncx_get_gen_anyxml
*
* Get the object template for the NCX generic anyxml container
*
* RETURNS:
* pointer to generic anyxml object template
*********************************************************************/
extern obj_template_t *
ncx_get_gen_anyxml (void);
/********************************************************************
* FUNCTION ncx_get_gen_container
*
* Get the object template for the NCX generic container
*
* RETURNS:
* pointer to generic container object template
*********************************************************************/
extern obj_template_t *
ncx_get_gen_container (void);
/********************************************************************
* FUNCTION ncx_get_gen_string
*
* Get the object template for the NCX generic string leaf
*
* RETURNS:
* pointer to generic string object template
*********************************************************************/
extern obj_template_t *
ncx_get_gen_string (void);
/********************************************************************
* FUNCTION ncx_get_gen_empty
*
* Get the object template for the NCX generic empty leaf
*
* RETURNS:
* pointer to generic empty object template
*********************************************************************/
extern obj_template_t *
ncx_get_gen_empty (void);
/********************************************************************
* FUNCTION ncx_get_gen_root
*
* Get the object template for the NCX generic root container
*
* RETURNS:
* pointer to generic root container object template
*********************************************************************/
extern obj_template_t *
ncx_get_gen_root (void);
/********************************************************************
* FUNCTION ncx_get_gen_binary
*
* Get the object template for the NCX generic binary leaf
*
* RETURNS:
* pointer to generic binary object template
*********************************************************************/
extern obj_template_t *
ncx_get_gen_binary (void);
/********************************************************************
* FUNCTION ncx_get_layer
*
* translate ncx_layer_t enum to a string
* Get the ncx_layer_t string
*
* INPUTS:
* layer == ncx_layer_t to convert to a string
*
* RETURNS:
* const pointer to the string value
*********************************************************************/
extern const xmlChar *
ncx_get_layer (ncx_layer_t layer);
/********************************************************************
* FUNCTION ncx_get_name_segment
*
* Get the name string between the dots
*
* INPUTS:
* str == scoped string
* buff == address of return buffer
* buffsize == buffer size
*
* OUTPUTS:
* buff is filled in with the namestring segment
*
* RETURNS:
* current string pointer after operation
*********************************************************************/
extern const xmlChar *
ncx_get_name_segment (const xmlChar *str,
xmlChar *buff,
uint32 buffsize);
/********************************************************************
* FUNCTION ncx_get_cvttyp_enum
*
* Get the enum for the string name of a ncx_cvttyp_t enum
*
* INPUTS:
* str == string name of the enum value
*
* RETURNS:
* enum value
*********************************************************************/
extern ncx_cvttyp_t
ncx_get_cvttyp_enum (const char *str);
/********************************************************************
* FUNCTION ncx_get_status_enum
*
* Get the enum for the string name of a ncx_status_t enum
*
* INPUTS:
* str == string name of the enum value
*
* RETURNS:
* enum value
*********************************************************************/
extern ncx_status_t
ncx_get_status_enum (const xmlChar *str);
/********************************************************************
* FUNCTION ncx_get_status_string
*
* Get the string for the enum value of a ncx_status_t enum
*
* INPUTS:
* status == enum value
*
* RETURNS:
* string name of the enum value
*********************************************************************/
extern const xmlChar *
ncx_get_status_string (ncx_status_t status);
/********************************************************************
* FUNCTION ncx_check_yang_status
*
* Check the backward compatibility of the 2 YANG status fields
*
* INPUTS:
* mystatus == enum value for the node to be tested
* depstatus == status value of the dependency
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_check_yang_status (ncx_status_t mystatus,
ncx_status_t depstatus);
/********************************************************************
* FUNCTION ncx_save_descr
*
* Get the value of the save description strings variable
*
* RETURNS:
* TRUE == descriptive strings should be save
* FALSE == descriptive strings should not be saved
*********************************************************************/
extern boolean
ncx_save_descr (void);
/********************************************************************
* FUNCTION ncx_print_errormsg
*
* Print an parse error message to STDOUT
*
* INPUTS:
* tkc == token chain (may be NULL)
* mod == module in progress (may be NULL)
* res == error status
*
* RETURNS:
* none
*********************************************************************/
extern void
ncx_print_errormsg (tk_chain_t *tkc,
ncx_module_t *mod,
status_t res);
/********************************************************************
* FUNCTION ncx_print_errormsg_ex
*
* Print an parse error message to STDOUT (Extended)
*
* INPUTS:
* tkc == token chain (may be NULL)
* mod == module in progress (may be NULL)
* res == error status
* filename == script finespec
* linenum == script file number
* fineoln == TRUE if finish with a newline, FALSE if not
*
* RETURNS:
* none
*********************************************************************/
extern void
ncx_print_errormsg_ex (tk_chain_t *tkc,
ncx_module_t *mod,
status_t res,
const char *filename,
uint32 linenum,
boolean fineoln);
/********************************************************************
* FUNCTION ncx_conf_exp_err
*
* Print an error for wrong token, expected a different token
*
* INPUTS:
* tkc == token chain
* result == error code
* expstr == expected token description
*
*********************************************************************/
extern void
ncx_conf_exp_err (tk_chain_t *tkc,
status_t result,
const char *expstr);
/********************************************************************
* FUNCTION ncx_mod_exp_err
*
* Print an error for wrong token, expected a different token
*
* INPUTS:
* tkc == token chain
* mod == module in progress
* result == error code
* expstr == expected token description
*
*********************************************************************/
extern void
ncx_mod_exp_err (tk_chain_t *tkc,
ncx_module_t *mod,
status_t result,
const char *expstr);
/********************************************************************
* FUNCTION ncx_mod_missing_err
*
* Print an error for wrong token, mandatory
* sub-statement is missing
*
* INPUTS:
* tkc == token chain
* mod == module in progress
* stmtstr == parent statement
* expstr == expected sub-statement
*
*********************************************************************/
extern void
ncx_mod_missing_err (tk_chain_t *tkc,
ncx_module_t *mod,
const char *stmtstr,
const char *expstr);
/********************************************************************
* FUNCTION ncx_free_node
*
* Delete a node based on its type
*
* INPUTS:
* nodetyp == NCX node type
* node == node top free
*
*********************************************************************/
extern void
ncx_free_node (ncx_node_t nodetyp,
void *node);
/********************************************************************
* FUNCTION ncx_get_data_class_enum
*
* Get the enum for the string name of a ncx_data_class_t enum
*
* INPUTS:
* str == string name of the enum value
*
* RETURNS:
* enum value
*********************************************************************/
extern ncx_data_class_t
ncx_get_data_class_enum (const xmlChar *str);
/********************************************************************
* FUNCTION ncx_get_data_class_str
*
* Get the string value for the ncx_data_class_t enum
*
* INPUTS:
* dataclass == enum value to convert
*
* RETURNS:
* striong value for the enum
*********************************************************************/
extern const xmlChar *
ncx_get_data_class_str (ncx_data_class_t dataclass);
/********************************************************************
* FUNCTION ncx_get_access_str
*
* Get the string name of a ncx_access_t enum
*
* INPUTS:
* access == enum value
*
* RETURNS:
* string value
*********************************************************************/
extern const xmlChar *
ncx_get_access_str (ncx_access_t max_access);
/********************************************************************
* FUNCTION ncx_get_access_enum
*
* Get the enum for the string name of a ncx_access_t enum
*
* INPUTS:
* str == string name of the enum value
*
* RETURNS:
* enum value
*********************************************************************/
extern ncx_access_t
ncx_get_access_enum (const xmlChar *str);
/********************************************************************
* FUNCTION ncx_get_tclass
*
* Get the token class
*
* INPUTS:
* btyp == base type enum
* RETURNS:
* tclass enum
*********************************************************************/
extern ncx_tclass_t
ncx_get_tclass (ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_get_tclass
*
* Get the token class
*
* INPUTS:
* btyp == base type enum
* RETURNS:
* tclass enum
*********************************************************************/
extern boolean
ncx_valid_name_ch (uint32 ch);
/********************************************************************
* FUNCTION ncx_valid_fname_ch
*
* Check if an xmlChar is a valid NCX name string first char
*
* INPUTS:
* ch == xmlChar to check
* RETURNS:
* TRUE if a valid first name char, FALSE otherwise
*********************************************************************/
extern boolean
ncx_valid_fname_ch (uint32 ch);
/********************************************************************
* FUNCTION ncx_valid_name
*
* Check if an xmlChar string is a valid YANG identifier value
*
* INPUTS:
* str == xmlChar string to check
* len == length of the string to check (in case of substr)
* RETURNS:
* TRUE if a valid name string, FALSE otherwise
*********************************************************************/
extern boolean
ncx_valid_name (const xmlChar *str,
uint32 len);
/********************************************************************
* FUNCTION ncx_valid_name2
*
* Check if an xmlChar string is a valid NCX name
*
* INPUTS:
* str == xmlChar string to check (zero-terminated)
* RETURNS:
* TRUE if a valid name string, FALSE otherwise
*********************************************************************/
extern boolean
ncx_valid_name2 (const xmlChar *str);
/********************************************************************
* FUNCTION ncx_parse_name
*
* Check if the next N chars represent a valid NcxName
* Will end on the first non-name char
*
* INPUTS:
* str == xmlChar string to check
* len == address of name length
*
* OUTPUTS:
* *len == 0 if no valid name parsed
* > 0 for the numbers of chars in the NcxName
*
* RETURNS:
* status_t (error if name too long)
*********************************************************************/
extern status_t
ncx_parse_name (const xmlChar *str,
uint32 *len);
/********************************************************************
* FUNCTION ncx_is_true
*
* Check if an xmlChar string is a string OK for XSD boolean
*
* INPUTS:
* str == xmlChar string to check
*
* RETURNS:
* TRUE if a valid boolean value indicating true
* FALSE otherwise
*********************************************************************/
extern boolean
ncx_is_true (const xmlChar *str);
/********************************************************************
* FUNCTION ncx_is_false
*
* Check if an xmlChar string is a string OK for XSD boolean
*
* INPUTS:
* str == xmlChar string to check
*
* RETURNS:
* TRUE if a valid boolean value indicating false
* FALSE otherwise
*********************************************************************/
extern boolean
ncx_is_false (const xmlChar *str);
/********************************************************************
* FUNCTION ncx_consume_tstring
*
* Consume a TK_TT_TSTRING with the specified value
*
* Error messages are printed by this function!!
* Do not duplicate error messages upon error return
*
* INPUTS:
* tkc == token chain
* mod == module in progress (NULL if none)
* name == token name
* opt == TRUE for optional param
* == FALSE for mandatory param
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_consume_tstring (tk_chain_t *tkc,
ncx_module_t *mod,
const xmlChar *name,
ncx_opt_t opt);
/********************************************************************
* FUNCTION ncx_consume_name
*
* Consume a TK_TSTRING that matches the 'name', then
* retrieve the next TK_TSTRING token into the namebuff
* If ctk specified, then consume the specified close token
*
* Store the results in a malloced buffer
*
* Error messages are printed by this function!!
* Do not duplicate error messages upon error return
*
* INPUTS:
* tkc == token chain
* mod == module in progress (NULL if none)
* name == first token name
* namebuff == ptr to output name string
* opt == NCX_OPT for optional param
* == NCX_REQ for mandatory param
* ctyp == close token (use TK_TT_NONE to skip this part)
*
* OUTPUTS:
* *namebuff points at the malloced name string
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_consume_name (tk_chain_t *tkc,
ncx_module_t *mod,
const xmlChar *name,
xmlChar **namebuff,
ncx_opt_t opt,
tk_type_t ctyp);
/********************************************************************
* FUNCTION ncx_consume_token
*
* Consume the next token which should be a 1 or 2 char token
* without any value. However this function does not check the value,
* just the token type.
*
* Error messages are printed by this function!!
* Do not duplicate error messages upon error return
*
* INPUTS:
* tkc == token chain
* mod == module in progress (NULL if none)
* ttyp == token type
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_consume_token (tk_chain_t *tkc,
ncx_module_t *mod,
tk_type_t ttyp);
/********************************************************************
* FUNCTION ncx_new_errinfo
*
* Malloc and init a new ncx_errinfo_t
*
* RETURNS:
* pointer to malloced ncx_errinfo_t, or NULL if memory error
*********************************************************************/
extern ncx_errinfo_t *
ncx_new_errinfo (void);
/********************************************************************
* FUNCTION ncx_init_errinfo
*
* Init the fields in an ncx_errinfo_t struct
*
* INPUTS:
* err == ncx_errinfo_t data structure to init
*********************************************************************/
extern void
ncx_init_errinfo (ncx_errinfo_t *err);
/********************************************************************
* FUNCTION ncx_clean_errinfo
*
* Scrub the memory in a ncx_errinfo_t by freeing all
* the sub-fields
*
* INPUTS:
* err == ncx_errinfo_t data structure to clean
*********************************************************************/
extern void
ncx_clean_errinfo (ncx_errinfo_t *err);
/********************************************************************
* FUNCTION ncx_free_errinfo
*
* Scrub the memory in a ncx_errinfo_t by freeing all
* the sub-fields, then free the errinfo struct
*
* INPUTS:
* err == ncx_errinfo_t data structure to free
*********************************************************************/
extern void
ncx_free_errinfo (ncx_errinfo_t *err);
/********************************************************************
* FUNCTION ncx_errinfo_set
*
* Check if error-app-tag or error-message set
* Check if the errinfo struct is set or empty
* Checks only the error_app_tag and error_message fields
*
* INPUTS:
* errinfo == ncx_errinfo_t struct to check
*
* RETURNS:
* TRUE if at least one field set
* FALSE if the errinfo struct is empty
*********************************************************************/
extern boolean
ncx_errinfo_set (const ncx_errinfo_t *errinfo);
/********************************************************************
* FUNCTION ncx_copy_errinfo
*
* Copy the fields from one errinfo to a blank errinfo
*
* INPUTS:
* src == struct with starting contents
* dest == struct to get copy of src contents
*
* OUTPUTS:
* *dest fields set which are set in src
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_copy_errinfo (const ncx_errinfo_t *src,
ncx_errinfo_t *dest);
/********************************************************************
* FUNCTION ncx_get_source_ex
*
* Get a malloced buffer containing the complete filespec
* for the given input string. If this is a complete dirspec,
* this this will just strdup the value.
*
* This is just a best effort to get the full spec.
* If the full spec is greater than 1500 bytes,
* then a NULL value (error) will be returned
*
* - Change ./ --> cwd/
* - Remove ~/ --> $HOME
* - add trailing '/' if not present
*
* INPUTS:
* fspec == input filespec
* expand_cwd == TRUE if foo should be expanded to /cur/dir/foo
* FALSE if not
* res == address of return status
*
* OUTPUTS:
* *res == return status, NO_ERR if return is non-NULL
*
* RETURNS:
* malloced buffer containing possibly expanded full filespec
*********************************************************************/
extern xmlChar *
ncx_get_source_ex (const xmlChar *fspec,
boolean expand_cwd,
status_t *res);
/********************************************************************
* FUNCTION ncx_get_source
*
* Get a malloced buffer containing the complete filespec
* for the given input string. If this is a complete dirspec,
* this this will just strdup the value.
*
* This is just a best effort to get the full spec.
* If the full spec is greater than 1500 bytes,
* then a NULL value (error) will be returned
*
* This will expand the cwd!
*
* - Change ./ --> cwd/
* - Remove ~/ --> $HOME
* - add trailing '/' if not present
*
* INPUTS:
* fspec == input filespec
* res == address of return status
*
* OUTPUTS:
* *res == return status, NO_ERR if return is non-NULL
*
* RETURNS:
* malloced buffer containing possibly expanded full filespec
*********************************************************************/
extern xmlChar *
ncx_get_source (const xmlChar *fspec,
status_t *res);
/********************************************************************
* FUNCTION ncx_set_cur_modQ
*
* Set the current module Q to an alternate (for yangdiff)
* This will be used for module searches usually in ncx_modQ
*
* INPUTS:
* que == Q of ncx_module_t to use
*********************************************************************/
extern void
ncx_set_cur_modQ (dlq_hdr_t *que);
/********************************************************************
* FUNCTION ncx_reset_modQ
*
* Set the current module Q to the original ncx_modQ
*
*********************************************************************/
extern void
ncx_reset_modQ (void);
/********************************************************************
* FUNCTION ncx_set_session_modQ
*
* !!! THIS HACK IS NEEDED BECAUSE val.c
* !!! USES ncx_find_module sometimes, and
* !!! yangcli sessions are not loaded into the
* !!! main database of modules.
* !!! THIS DOES NOT WORK FOR MULTIPLE CONCURRENT PROCESSES
*
* Set the current session module Q to an alternate (for yangdiff)
* This will be used for module searches usually in ncx_modQ
*
* INPUTS:
* que == Q of ncx_module_t to use
*********************************************************************/
extern void
ncx_set_session_modQ (dlq_hdr_t *que);
/********************************************************************
* FUNCTION ncx_clear_session_modQ
*
* !!! THIS HACK IS NEEDED BECAUSE val.c
* !!! USES ncx_find_module sometimes, and
* !!! yangcli sessions are not loaded into the
* !!! main database of modules.
* !!! THIS DOES NOT WORK FOR MULTIPLE CONCURRENT PROCESSES
*
* Clear the current session module Q
*
*********************************************************************/
extern void
ncx_clear_session_modQ (void);
/********************************************************************
* FUNCTION ncx_set_load_callback
*
* Set the callback function for a load-module event
*
* INPUT:
* cbfn == callback function to use
*
*********************************************************************/
extern void
ncx_set_load_callback (ncx_load_cbfn_t cbfn);
/********************************************************************
* FUNCTION ncx_prefix_different
*
* Check if the specified prefix pair reference different modules
*
* INPUT:
* prefix1 == 1st prefix to check (may be NULL)
* prefix2 == 2nd prefix to check (may be NULL)
* modprefix == module prefix to check (may be NULL)
*
* RETURNS:
* TRUE if prefix1 and prefix2 reference different modules
* FALSE if prefix1 and prefix2 reference the same modules
*********************************************************************/
extern boolean
ncx_prefix_different (const xmlChar *prefix1,
const xmlChar *prefix2,
const xmlChar *modprefix);
/********************************************************************
* FUNCTION ncx_get_baddata_enum
*
* Check if the specified string matches an ncx_baddata_t enum
*
* INPUT:
* valstr == value string to check
*
* RETURNS:
* enum value if OK
* NCX_BAD_DATA_NONE if an error
*********************************************************************/
extern ncx_bad_data_t
ncx_get_baddata_enum (const xmlChar *valstr);
/********************************************************************
* FUNCTION ncx_get_baddata_string
*
* Get the string for the specified enum value
*
* INPUT:
* baddatar == enum value to check
*
* RETURNS:
* string pointer if OK
* NULL if an error
*********************************************************************/
extern const xmlChar *
ncx_get_baddata_string (ncx_bad_data_t baddata);
/********************************************************************
* FUNCTION ncx_get_withdefaults_string
*
* Get the string for the specified enum value
*
* INPUT:
* withdef == enum value to check
*
* RETURNS:
* string pointer if OK
* NULL if an error
*********************************************************************/
extern const xmlChar *
ncx_get_withdefaults_string (ncx_withdefaults_t withdef);
/********************************************************************
* FUNCTION ncx_get_withdefaults_enum
*
* Get the enum for the specified string value
*
* INPUT:
* withdefstr == string value to check
*
* RETURNS:
* enum value for the string
* NCX_WITHDEF_NONE if invalid value
*********************************************************************/
extern ncx_withdefaults_t
ncx_get_withdefaults_enum (const xmlChar *withdefstr);
/********************************************************************
* FUNCTION ncx_get_mod_prefix
*
* Get the module prefix for the specified module
*
* INPUT:
* mod == module to check
*
* RETURNS:
* pointer to module YANG prefix
*********************************************************************/
extern const xmlChar *
ncx_get_mod_prefix (const ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_mod_xmlprefix
*
* Get the module XML prefix for the specified module
*
* INPUT:
* mod == module to check
*
* RETURNS:
* pointer to module XML prefix
*********************************************************************/
extern const xmlChar *
ncx_get_mod_xmlprefix (const ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_display_mode_enum
*
* Get the enum for the specified string value
*
* INPUT:
* dmstr == string value to check
*
* RETURNS:
* enum value for the string
* NCX_DISPLAY_MODE_NONE if invalid value
*********************************************************************/
extern ncx_display_mode_t
ncx_get_display_mode_enum (const xmlChar *dmstr);
/********************************************************************
* FUNCTION ncx_get_display_mode_str
*
* Get the string for the specified enum value
*
* INPUT:
* dmode == enum display mode value to check
*
* RETURNS:
* string value for the enum
* NULL if none found
*********************************************************************/
extern const xmlChar *
ncx_get_display_mode_str (ncx_display_mode_t dmode);
/********************************************************************
* FUNCTION ncx_set_warn_idlen
*
* Set the warning length for identifiers
*
* INPUT:
* warnlen == warning length to use
*
*********************************************************************/
extern void
ncx_set_warn_idlen (uint32 warnlen);
/********************************************************************
* FUNCTION ncx_get_warn_idlen
*
* Get the warning length for identifiers
*
* RETURNS:
* warning length to use
*********************************************************************/
extern uint32
ncx_get_warn_idlen (void);
/********************************************************************
* FUNCTION ncx_set_warn_linelen
*
* Set the warning length for YANG file lines
*
* INPUT:
* warnlen == warning length to use
*
*********************************************************************/
extern void
ncx_set_warn_linelen (uint32 warnlen);
/********************************************************************
* FUNCTION ncx_get_warn_linelen
*
* Get the warning length for YANG file lines
*
* RETURNS:
* warning length to use
*
*********************************************************************/
extern uint32
ncx_get_warn_linelen (void);
/********************************************************************
* FUNCTION ncx_check_warn_idlen
*
* Check if the identifier length is greater than
* the specified amount.
*
* INPUTS:
* tkc == token chain to use (for warning message only)
* mod == module (for warning message only)
* id == identifier string to check; must be Z terminated
*
* OUTPUTS:
* may generate log_warn ouput
*********************************************************************/
extern void
ncx_check_warn_idlen (tk_chain_t *tkc,
ncx_module_t *mod,
const xmlChar *id);
/********************************************************************
* FUNCTION ncx_check_warn_linelen
*
* Check if the line display length is greater than
* the specified amount.
*
* INPUTS:
* tkc == token chain to use
* mod == module (used in warning message only
* linelen == line length to check
*
* OUTPUTS:
* may generate log_warn ouput
*********************************************************************/
extern void
ncx_check_warn_linelen (tk_chain_t *tkc,
ncx_module_t *mod,
const xmlChar *line);
/********************************************************************
* FUNCTION ncx_turn_off_warning
*
* Add ar warning suppression entry
*
* INPUTS:
* res == internal status code to suppress
*
* RETURNS:
* status (duplicates are silently dropped)
*********************************************************************/
extern status_t
ncx_turn_off_warning (status_t res);
/********************************************************************
* FUNCTION ncx_turn_on_warning
*
* Remove a warning suppression entry if it exists
*
* INPUTS:
* res == internal status code to enable
*
* RETURNS:
* status (duplicates are silently dropped)
*********************************************************************/
extern status_t
ncx_turn_on_warning (status_t res);
/********************************************************************
* FUNCTION ncx_warning_enabled
*
* Check if a specific status_t code is enabled
*
* INPUTS:
* res == internal status code to check
*
* RETURNS:
* TRUE if warning is enabled
* FALSE if warning is suppressed
*********************************************************************/
extern boolean
ncx_warning_enabled (status_t res);
/********************************************************************
* FUNCTION ncx_get_version
*
* Get the the Yuma version ID string
*
* INPUT:
* buffer == buffer to hold the version string
* buffsize == number of bytes in buffer
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_get_version (xmlChar *buffer,
uint32 buffsize);
/********************************************************************
* FUNCTION ncx_new_save_deviations
*
* create a deviation save structure
*
* INPUTS:
* devmodule == deviations module name
* devrevision == deviation module revision (optional)
* devnamespace == deviation module namespace URI value
* devprefix == local module prefix (optional)
*
* RETURNS:
* malloced and initialized save_deviations struct,
* or NULL if malloc error
*********************************************************************/
extern ncx_save_deviations_t *
ncx_new_save_deviations (const xmlChar *devmodule,
const xmlChar *devrevision,
const xmlChar *devnamespace,
const xmlChar *devprefix);
/********************************************************************
* FUNCTION ncx_free_save_deviations
*
* free a deviation save struct
*
* INPUT:
* savedev == struct to clean and delete
*********************************************************************/
extern void
ncx_free_save_deviations (ncx_save_deviations_t *savedev);
/********************************************************************
* FUNCTION ncx_clean_save_deviationsQ
*
* clean a Q of deviation save structs
*
* INPUT:
* savedevQ == Q of ncx_save_deviations_t to clean
*********************************************************************/
extern void
ncx_clean_save_deviationsQ (dlq_hdr_t *savedevQ);
/********************************************************************
* FUNCTION ncx_set_error
*
* Set the fields in an ncx_error_t struct
* When called from NACM or <get> internally, there is no
* module or line number info
*
* INPUTS:
* tkerr== address of ncx_error_t struct to set
* mod == [sub]module containing tkerr
* linenum == current linenum
* linepos == current column position on the current line
*
* OUTPUTS:
* *tkerr is filled in
*********************************************************************/
extern void
ncx_set_error (ncx_error_t *tkerr,
ncx_module_t *mod,
uint32 linenum,
uint32 linepos);
/********************************************************************
* FUNCTION ncx_set_temp_modQ
*
* Set the temp_modQ for yangcli session-specific module list
*
* INPUTS:
* modQ == new Q pointer to use
*
*********************************************************************/
extern void
ncx_set_temp_modQ (dlq_hdr_t *modQ);
/********************************************************************
* FUNCTION ncx_get_temp_modQ
*
* Get the temp_modQ for yangcli session-specific module list
*
* RETURNS:
* pointer to the temp modQ, if set
*********************************************************************/
extern dlq_hdr_t *
ncx_get_temp_modQ (void);
/********************************************************************
* FUNCTION ncx_clear_temp_modQ
*
* Clear the temp_modQ for yangcli session-specific module list
*
*********************************************************************/
extern void
ncx_clear_temp_modQ (void);
/********************************************************************
* FUNCTION ncx_get_display_mode
*
* Get the current default display mode
*
* RETURNS:
* the current dispay mode enumeration
*********************************************************************/
extern ncx_display_mode_t
ncx_get_display_mode (void);
/********************************************************************
* FUNCTION ncx_get_confirm_event_str
*
* Get the string for the specified enum value
*
* INPUT:
* event == enum confirm event value to convert
*
* RETURNS:
* string value for the enum
* NULL if none found
*********************************************************************/
extern const xmlChar *
ncx_get_confirm_event_str (ncx_confirm_event_t event);
/********************************************************************
* FUNCTION ncx_mod_revision_count
*
* Find all the ncx_module_t structs in the ncx_modQ
* that have the same module name
*
* INPUTS:
* modname == module name
*
* RETURNS:
* count of modules that have this name (exact match)
*********************************************************************/
extern uint32
ncx_mod_revision_count (const xmlChar *modname);
/********************************************************************
* FUNCTION ncx_mod_revision_count_que
*
* Find all the ncx_module_t structs in the specified queue
* that have the same module name
*
* INPUTS:
* modQ == queue of ncx_module_t structs to check
* modname == module name
*
* RETURNS:
* count of modules that have this name (exact match)
*********************************************************************/
extern uint32
ncx_mod_revision_count_que (dlq_hdr_t *modQ,
const xmlChar *modname);
/********************************************************************
* FUNCTION ncx_get_allincQ
*
* Find the correct Q of yang_node_t for all include files
* that have the same 'belongs-to' value
*
* INPUTS:
* mod == module to check
*
* RETURNS:
* pointer to Q of all include nodes
*********************************************************************/
extern dlq_hdr_t *
ncx_get_allincQ (ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_const_allincQ
*
* Find the correct Q of yang_node_t for all include files
* that have the same 'belongs-to' value (const version)
*
* INPUTS:
* mod == module to check
*
* RETURNS:
* pointer to Q of all include nodes
*********************************************************************/
extern const dlq_hdr_t *
ncx_get_const_allincQ (const ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_parent_mod
*
* Find the correct module by checking mod->parent nodes
*
* INPUTS:
* mod == module to check
*
* RETURNS:
* pointer to parent module (!! not submodule !!)
* NULL if none found
*********************************************************************/
extern ncx_module_t *
ncx_get_parent_mod (ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_vtimeout_value
*
* Get the virtual node cache timeout value
*
* RETURNS:
* number of seconds for the cache timeout; 0 == disabled
*********************************************************************/
extern uint32
ncx_get_vtimeout_value (void);
/********************************************************************
* FUNCTION ncx_compare_base_uris
*
* Compare the base part of 2 URI strings
*
* INPUTS:
* str1 == URI string 1
* str2 == URI string 2
*
* RETURNS:
* compare of base parts (up to '?')
* -1, 0 or 1
*********************************************************************/
extern int32
ncx_compare_base_uris (const xmlChar *str1,
const xmlChar *str2);
/********************************************************************
* FUNCTION ncx_get_useprefix
*
* Get the use_prefix value
*
* RETURNS:
* TRUE if XML prefixes should be used
* FALSE if XML messages should use default namespace (no prefix)
*********************************************************************/
extern boolean
ncx_get_useprefix (void);
/********************************************************************
* FUNCTION ncx_set_useprefix
*
* Set the use_prefix value
*
* INPUTS:
* val ==
* TRUE if XML prefixes should be used
* FALSE if XML messages should use default namespace (no prefix)
*********************************************************************/
extern void
ncx_set_useprefix (boolean val);
/********************************************************************
* FUNCTION ncx_get_system_sorted
*
* Get the system_sorted value
*
* RETURNS:
* TRUE if system ordered objects should be sorted
* FALSE if system ordered objects should not be sorted
*********************************************************************/
extern boolean
ncx_get_system_sorted (void);
/********************************************************************
* FUNCTION ncx_set_system_sorted
*
* Set the system_sorted value
*
* INPUTS:
* val ==
* TRUE if system ordered objects should be sorted
* FALSE if system ordered objects should not be sorted
*********************************************************************/
extern void
ncx_set_system_sorted (boolean val);
/********************************************************************
* FUNCTION ncx_inc_warnings
*
* Increment the module warning count
*
* INPUTS:
* mod == module being parsed
*********************************************************************/
extern void
ncx_inc_warnings (ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_cwd_subdirs
*
* Get the CLI parameter value whether to search for modules
* in subdirs of the CWD by default. Does not affect YUMA_MODPATH
* or other hard-wired searches
*
* RETURNS:
* TRUE if ncxmod should search for modules in subdirs of the CWD
* FALSE if ncxmod should not search for modules in subdirs of the CWD
*********************************************************************/
extern boolean
ncx_get_cwd_subdirs (void);
/********************************************************************
* FUNCTION ncx_protocol_enabled
*
* Check if the specified protocol version is enabled
*
* RETURNS:
* TRUE if protocol enabled
* FALSE if protocol not enabled or error
*********************************************************************/
extern boolean
ncx_protocol_enabled (ncx_protocol_t proto);
/********************************************************************
* FUNCTION ncx_set_protocol_enabled
*
* Set the specified protocol version to be enabled
*
* INPUTS:
* proto == protocol version to enable
*********************************************************************/
extern void
ncx_set_protocol_enabled (ncx_protocol_t proto);
/********************************************************************
* FUNCTION ncx_set_use_deadmodQ
*
* Set the usedeadmodQ flag
*
*********************************************************************/
extern void
ncx_set_use_deadmodQ (void);
/********************************************************************
* FUNCTION ncx_delete_all_obsolete_objects
*
* Go through all the modules and delete the obsolete nodes
*
*********************************************************************/
extern void
ncx_delete_all_obsolete_objects (void);
/********************************************************************
* FUNCTION ncx_delete_mod_obsolete_objects
*
* Go through one module and delete the obsolete nodes
*
* INPUTS:
* mod == module to check
*********************************************************************/
extern void
ncx_delete_mod_obsolete_objects (ncx_module_t *mod);
/********************************************************************
* FUNCTION ncx_get_name_match_enum
*
* Get the enum for the string name of a ncx_name_match_t enum
*
* INPUTS:
* str == string name of the enum value
*
* RETURNS:
* enum value
*********************************************************************/
extern ncx_name_match_t
ncx_get_name_match_enum (const xmlChar *str);
/********************************************************************
* FUNCTION ncx_get_name_match_string
*
* Get the string for the ncx_name_match_t enum
*
* INPUTS:
* match == enum value
*
* RETURNS:
* string value
*********************************************************************/
extern const xmlChar *
ncx_get_name_match_string (ncx_name_match_t match);
/********************************************************************
* FUNCTION ncx_write_tracefile
*
* Write a byte to the tracefile
*
* INPUTS:
* buff == buffer to write
* count == number of chars to write
*********************************************************************/
extern void
ncx_write_tracefile (const char *buff, uint32 count);
/********************************************************************
* FUNCTION ncx_set_top_mandatory_allowed
*
* Allow or disallow modules with top-level mandatory object
* to be loaded; used by the server when agt_running_error is TRUE
*
* INPUTS:
* allowed == value to set T: to allow; F: to disallow
*********************************************************************/
extern void
ncx_set_top_mandatory_allowed (boolean allowed);
/********************************************************************
* FUNCTION ncx_get_top_mandatory_allowed
*
* Check if top-level mandatory objects are allowed or not
*
* RETURNS:
* T: allowed; F: disallowed
*********************************************************************/
extern boolean
ncx_get_top_mandatory_allowed (void);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_ncx */
|