/usr/include/collection.h is in libcollection-dev 0.4.0-1.
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 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 | /*
COLLECTION LIBRARY
Header file for collection interface.
Copyright (C) Dmitri Pal <dpal@redhat.com> 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef COLLECTION_H
#define COLLECTION_H
#include <stdint.h>
/** @mainpage The COLLECTION interface
* The collection is a set of items of different types.
*
* To better understand how collections work imagine travel bags.
* They usually come in different sizes and one can put a bag in a bag when
* they put away to the shelf in a garage or closet. Collection is such bag
* except that you can put other bags into each other even if they are not
* empty.<br>
* When you put items into a bag you do not see the contents of the bag.
* You just hold the bag. How many other bags inside this bag you do not know.
* But you might know that you put a "wallet" somewhere there.
* You ask the bag you hold: "find my wallet and give it to me".
* get_item function will return you the item that is your "wallet".
* You can then change something or just get information about the item you
* retrieved. But in most cases you do not need the wallet itself. You want to
* get something from the wallet or put something into it. IMO money would
* be an obvious choice. To do this you use update_xxx_property functions.<br>
* There might be a bag somewhere deep and you might want to add something to
* it. add_xxx_property_xxx functions allow you to specify sub collection you
* want the item to be added to. If this sub collection argument is NULL top
* level collection is assumed.<br>
* The search in the collections uses a "x!y!z" notation to refer to an item (or
* property). You can search for "wallet" and it will find any first instance of
* the "wallet" in your luggage. But you might have two wallets. One is yours and
* another is your significant other's. So you might say find "my!wallet".
* It will find wallet in your bag (collection) named "my". This collection can
* be many levels deep inside other collections. You do not need to know the
* full path to get to it. But if you have the full path you can use the fill
* path like this "luggage!newbags!my!wallet".<br>
* It is useful to be able to put bags into bags as well as get them out of each
* other. When the collection is created the header keeps a reference count on
* how many copies of the collection are known to the world. So one can put a
* collection into collection and give up its access to it (embed) or still hold
* to the reference. By embedding the collection the caller effectively gives
* up its responsibility to destroy the collection after it is used.<br>
* By extracting reference from an internal collection the caller gains access
* to the collection directly and thus has responsibility to destroy it after
* use.
*
* Internally collection is implemented as a link list rather than a hash
* table.
* This makes it suitable for small (dozens of items) sets of data for which
* the order is important. Thus the collection properties and sub collections
* can be used to model objects like a book case. Imagine a book case that
* consists of multiple shelves. You can perform operations like "add a new
* shelf after second shelf" or "put a book on the 4th shelf right before
* the book with the red cover."
*
* A bit of terminology:
* - <b>collection</b> - an object implemented as a link list that holds
* properties (attributes).
* - <b>property</b> - a named logical element of the collection.
* - <b>item</b> - physical element of the collection, think about it
* as a node in the link list.
* - <b>value</b> - data associated with the property.
* - <b>type</b> - type of the data associated with a property.
* - <b>length</b> - length of the data associated with the property.
* - <b>sub collection</b> - collection embedded into another collection.
* It is a property with the value of a special
* type. The name of the property that denotes
* a sub collection can be different from the name
* of the collection it refers to.
* - <b>traverse</b> - call a function that will internally iterate
* through a collection and do something with its
* elements.
* - <b>iterate</b> - step through a collection yourselves.
*
* Characters with codes less than space in ASCII table are illegal for
* property names.
* Character '!' also illegal in a property or collection name and
* reserved for "x!y!z" notation.
*
* There is always a header item in any collection that starts the collection.
* Most of the functions in the interface (unless explicitly stated otherwise)
* assume that the collection_item * argument points to the header element.
* Passing in elements extracted from the middle of a collection to functions
* that expect header elements is illegal. There might be not enough checking
* at the moment but this will be enforced in future versions of the library.
*
*/
#ifndef EOK
#define EOK 0
#endif
/**
* @defgroup collection COLLECTION interface
* @{
*/
/**
* @brief Default class for a free form collection.
*/
#define COL_CLASS_DEFAULT 0
/**
* @brief Value indicates that property is not found.
*
* Used in search functions.
*/
#define COL_NOMATCH 0
/**
* @brief Value indicates that property is found.
*
* Used in search functions.
*/
#define COL_MATCH 1
/**
* @defgroup coltypes Type definition constants
* @{
*/
/**
* @brief Indicates that property is of type "string".
*
* For elements of type string the length includes the trailing 0.
*/
#define COL_TYPE_STRING 0x00000001
/** @brief Indicates that property is of type "binary". */
#define COL_TYPE_BINARY 0x00000002
/** @brief Indicates that property is of type "integer". */
#define COL_TYPE_INTEGER 0x00000004
/** @brief Indicates that property is of type "unsigned". */
#define COL_TYPE_UNSIGNED 0x00000008
/** @brief Indicates that property is of type "long". */
#define COL_TYPE_LONG 0x00000010
/** @brief Indicates that property is of type "unsigned long". */
#define COL_TYPE_ULONG 0x00000020
/** @brief Indicates that property is of type "double". */
#define COL_TYPE_DOUBLE 0x00000040
/** @brief Indicates that property is of Boolean type. */
#define COL_TYPE_BOOL 0x00000080
/**
* @brief Indicates that property is of type "collection".
*
* The item of this type denotes that starting element of a
* collection.
*/
#define COL_TYPE_COLLECTION 0x00000100
/**
* @brief Indicates that property is of type "sub collection".
*
* An item of this type is a pointer to an existing external
* collection.
*/
#define COL_TYPE_COLLECTIONREF 0x00000200
/**
* @brief Special type that denotes the end of the collection.
*
* Useful when traversing collections.
*/
#define COL_TYPE_END 0x10000000
/**
* @brief Special type that denotes any property in the collection.
*
* Useful when traversing collection and searching for a property
* of unknown type but known name.
*/
#define COL_TYPE_ANY 0x0FFFFFFF
/**
* @}
*/
/**
* @defgroup addmodes Constants defining add modes
*
* The following constants define how one collection can be added to another.
*
* @{
*/
/** @brief Add a collection into a collection as a reference */
#define COL_ADD_MODE_REFERENCE 0
/**
* @brief Embed the collection into another collection.
*
* The collection will become part of another collection.
* After this operation the handle to the collection being added
* should not be used or freed.
* Embedding a collection can be done only once.
* If the collection is referenced by another collection,
* the operation will fail.
*/
#define COL_ADD_MODE_EMBED 1
/**
* @brief Perform a deep copy.
*
* Perform a deep copy of a collection with
* all its sub collections */
#define COL_ADD_MODE_CLONE 2
/**
* @brief Create a flattened copy.
*
* Create a deep copy of a collection with
* its sub collections flattening and NOT
* resolving duplicates.
*/
#define COL_ADD_MODE_FLAT 3
/**
* @brief Create a flattened copy with constructed names.
*
* Creates a deep copy of a collection with
* its sub collections flattening and NOT
* resolving duplicates. Names are constructed
* in dotted notation.
* For example the sub collection
* named "sub" containing "foo" and
* "bar" will be flattened as:
* "sub.foo", "sub.bar".
*/
#define COL_ADD_MODE_FLATDOT 4
/**
* @}
*/
/**
* @defgroup traverseconst Constants defining traverse modes
*
* The following constants define how a collection can be
* traversed or iterated.
*
* Flags defined below can generally be combined with each other.
*
* \ref COL_TRAVERSE_FLAT, \ref COL_TRAVERSE_SHOWSUB,
* \ref COL_TRAVERSE_ONLYSUB are mutually exclusive flags.
* If combined together results will be unpredictable.<br>
* <b>DO NOT MIX THEM IN ONE ITERATOR.</b>
*
*
* @{
*/
/** @brief Traverse all items in the collection. */
#define COL_TRAVERSE_DEFAULT 0x00000000
/**
* @brief Traverse only the top level.
*
* Traverse only top level
* ignored if the IGNORE flag is
* specified
*/
#define COL_TRAVERSE_ONELEVEL 0x00000001
/**
* @brief Insert end collection marker.
*
* Call the handler once more when the
* end of the collection is reached.
* Specifying this flag would cause a traversing
* function to call a callback once more passing
* in a virtual property of type \ref COL_TYPE_END.
* Good for processing nested collections.
*/
#define COL_TRAVERSE_END 0x00000002
/** @brief Ignore sub collections as if none is present. */
#define COL_TRAVERSE_IGNORE 0x00000004
/**
* @brief Flatten the collection.
*
* Traversing this way would act as if
* all the properties of sub collection are properties
* of the root collection. The referencing properties or
* headers of the referenced collections are skipped.
*
* If we think of the book case example
* this is very useful when one wants to iterate through
* all the books skipping information about
* which shelf they are on.
*/
#define COL_TRAVERSE_FLAT 0x00000008
/**
* @defgroup moreiterflag Additional iterator flags
*
* \note NOTE: These flags ignored by traverse functions and
* can be used only in the iterator.
*
* @{
*/
/**
* @brief Include headers of sub collections.
*
* When one collection is embedded or referenced by another collection
* there are two names we can be interested in. The name of the property
* that defines the reference and the name of the embedded collection.
* It is recommended that they be the same, however there may be cases
* when the name of the referencing property and referenced collection
* should be different. By default only the name of the referencing
* property is returned while iterating through the collection and
* its sub collections. Specifying this flag would cause the names
* of the collection (header elements) be included into the iteration
* process.
*
* Flag is ignored if the \ref COL_TRAVERSE_ONELEVEL flag is
* specified and not ignored.
* Flag is ignored is also ignored if the FLAT flag is specified. */
#define COL_TRAVERSE_SHOWSUB 0x00010000
/**
* @brief Show sub collections.
*
* Show the header of the sub collection instead of the reference.
* Flag is ignored if the \ref COL_TRAVERSE_ONELEVEL flag is
* specified and not ignored.
* Flag is ignored is also ignored if the FLAT flag is specified. */
#define COL_TRAVERSE_ONLYSUB 0x00020000
/**
* @}
*/
/**
* @}
*/
/**
* @defgroup copyconst Constants defining copy modes
*
* The following constants define modes accepted by copy
* collection function(s).
*
* @{
*/
/**
* @brief Perform a deep copy.
*
* Referenced collections of the donor are copied as sub
* collections.
*/
#define COL_COPY_NORMAL 0
/**
* @brief Perform a deep flat copy.
*
* Collection is flattened. No name construction performed.
*/
#define COL_COPY_FLAT 1
/**
* @brief Perform a deep flat copy constructing names.
*
* Collection is flattened. Names are concatenated with dot.
*/
#define COL_COPY_FLATDOT 2
/** @brief Perform a deep copy but leave references as references. */
#define COL_COPY_KEEPREF 3
/** @brief Copy only top level collection. */
#define COL_COPY_TOP 4
/**
* @}
*/
/**
* @defgroup sortconst Constants defining sort order
*
* All flags can be combined in OR operation.
* Flags \ref COL_SORT_ASC and \ref COL_SORT_DESC are
* mutually exclusive. If both specified the
* collection will be sorted in the descending order.
*
* @{
*/
/** @brief Sort in ascending order. */
#define COL_SORT_ASC 0x00000000
/** @brief Sort in descending order. */
#define COL_SORT_DESC 0x00000001
/** @brief Sort all sub collections. */
#define COL_SORT_SUB 0x00000002
/**
* @brief Sort only embedded sub collections.
*
* Ignored if \ref COL_SORT_SUB is not specified.
*/
#define COL_SORT_MYSUB 0x00000004
/**
* @}
*/
/* Public declaration of the private data */
#ifndef COLLECTION_PRIV_H
/**
* @struct collection_item
* @brief Opaque structure that holds one property.
*
* Your implementation can assume that following members
* will always be members of the collection_item.
* but you should use get_item_xxx functions to get them
* and never access internal data directly.
*
* - char *property;
* - int property_len;
* - int type;
* - int length;
* - void *data;
*/
struct collection_item;
/**
* @struct collection_iterator
* @brief Opaque iterator structure.
*
* The iterator structure is used
* when one wants to traverse the collection
* going through its properties and optionally
* sub collections.
*
* Caller should never assume
* anything about internals of this structure.
*/
struct collection_iterator;
#endif /* COLLECTION_PRIV_H */
/**
* @brief Create a collection
*
* The function will create a collection.
* Each collection should have name and class.
*
* @param[out] ci Newly allocated collection object.
* @param[in] name The name is supposed to be a unique identifier of
* the collection. This is useful when the collections
* are stored within other collections or inside other
* aggregation objects. Caller is free to use any name.
* Name should consist of the ASCII characters with codes
* non less than space. Exclamation mark character is
* a special character and can't be used in name of
* collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] cclass Class is used to relate the collection to a specific
* group of the collections of the same structure.
* This is very useful when you try to represent
* objects using collections and you want to check if
* the objects have same structure or not.
* There is no predefined name space for the collection
* classes. Defining classes is left to the application
* developers.<br>
* <b>NOTE:</b>
* If you decide to build an interface using collection
* library pick a range for the classes you are
* going to use and make sure that they do not collide
* with other interfaces built on top of the collection.
*
* @return 0 - Collection was created successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the collection name.
* @return EMSGSIZE - Collection name is too long.
*/
int col_create_collection(struct collection_item **ci,
const char *name,
unsigned cclass);
/**
* @brief Destroy a collection
*
* The function will destroy a collection.
*
* @param[in] ci Collection object.
*
*/
void col_destroy_collection(struct collection_item *ci);
/**
* @brief Cleanup Callback
*
* Signature of the callback that needs to be used when
* the collection is destroyed and a special cleanup operation
* is required for items in the collection.
*
* @param[in] property The name of the property will
* be passed in this parameter.
* @param[in] property_len Length of the property name
* will be passed in this parameter.
* @param[in] type Type of the data will be passed
* in this parameter.
* @param[in] data Pointer to the data will be passed
* in this parameter.
* @param[in] length Length of data will be passed in
* this parameter.
* @param[in] custom_data Custom data will be passed in
* this parameter.
*/
typedef void (*col_item_cleanup_fn)(const char *property,
int property_len,
int type,
void *data,
int length,
void *custom_data);
/**
* @brief Destroy a collection with callback
*
* Execute a provided callback for each item
* in the collection or subcollection immediately
* before freeing item. The callback is executed for each
* element including the collection header.
* It is the responsibility of the callback implementor
* to properly handle gifferent collection elements
* depending upon whether it is a header, reference to
* an embedded or external collection or a normal data
* element.
*
* The function will destroy a collection.
*
* @param[in] ci Collection object.
* @param[in] cb Cleanup callback.
* @param[in] custom_data Application data passed into
* the cleanup callback.
*
*/
void col_destroy_collection_with_cb(struct collection_item *ci,
col_item_cleanup_fn cb,
void *custom_data);
/**
* @brief Copy item callback.
*
* Callback is used by the
* \ref col_copy_collection_with_cb "col_copy_collection_with_cb" function.
* Function is called after the new item is created but not yet
* inserted into the target collection.
* The implementer of the callback can alter the item data
* or indicate to the caller that the item should be skipped.
*
* @param[in] item Newly allocated item that will be inserted
* into the new collection.
* @param[in] ext_data Data the application might want to
* pass to the callback.
* @param[out] skip Pointer to a variable that indicates if the
* item should be skipped or not.
* Set this variable to any nonzero value
* and the item will be skipped.
* @return 0 - Success
* @return Function can return any error code. This code
* will be propagated through the internal functions and
* returned to the application.
*
*/
typedef int (*col_copy_cb)(struct collection_item *item,
void *ext_data,
int *skip);
/**
* @brief Copy collection with data modification.
*
* Function create a deep copy of the current collection.
* Calls caller provided callback before copying each item's data.
* This is useful if the data needs to be resolved in some way.
* The best use is when the template is copied and the values
* in the template are resolved to the actual values.
* The acceptable modes are defined \ref copyconst "here".
*
* @param[out] col_copy Newly created collection object.
* @param[in] col_to_copy Collection object that will be copied.
* @param[in] name_to_use Name of the new collection.
* @param[in] copy_mode How to \ref copyconst "copy".
* @param[in] copy_cb Pointer to a callback \ref col_copy_cb.
* Can be NULL. In this case data is copied
* without modification.
* @param[in] ext_data Data the application might want to
* pass to the callback.
*
* @return 0 - Collection was copied successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return Any error code returned by the callback.
*
*/
int col_copy_collection_with_cb(struct collection_item **col_copy,
struct collection_item *col_to_copy,
const char *name_to_use,
int copy_mode,
col_copy_cb copy_cb,
void *ext_data);
/**
* @brief Copy collection without data modification.
*
* Function creates a deep copy of the current collection.
* It wraps the \ref col_copy_collection_with_cb function.
* The acceptable modes are defined \ref copyconst "here".
*
* @param[out] col_copy Newly created collection object.
* @param[in] col_to_copy Collection object that will be copied.
* @param[in] name_to_use Name of the new collection.
* @param[in] copy_mode How to \ref copyconst "copy".
*
* @return 0 - Collection was copied successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_copy_collection(struct collection_item **col_copy,
struct collection_item *col_to_copy,
const char *name_to_use,
int copy_mode);
/**
* @brief Add collection to collection.
*
* Function adds one collection into another
* depending upon a specified \ref addmodes "mode".
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add collection to. If NULL the collection
* is added to the root collection.
* @param[in] as_property Name of the property that will constitute
* the reference. If NULL the name of
* the collection being added will be used.
* If specified the restrictions to
* the name characters and length apply.
* For more details about the name related
* restrictions see
* \ref addproperty "col_add_xxx_property"
* functions.
* @param[in] ci_to_add Collection to add.
* @param[in] mode Specifies \ref addmodes "how"
* the collection should be added.
*
* @return 0 - Collection was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* The attempt to update a property which is
* a reference to a collection or a collection
* name.
* @return ENOENT - Property to update is not found.
*/
int col_add_collection_to_collection(struct collection_item *ci,
const char *subcollection,
const char *as_property,
struct collection_item *ci_to_add,
int mode);
/**
* @brief Search Callback
*
* Signature of the callback that needs to be used when
* traversing a collection or looking for a specific item.
*
* @param[in] property The name of the property will
* be passed in this parameter.
* @param[in] property_len Length of the property name
* will be passed in this parameter.
* @param[in] type Type of the data will be passed
* in this parameter.
* @param[in] data Pointer to the data will be passed
* in this parameter.
* @param[in] length Length of data will be passed in
* this parameter.
* @param[in] custom_data Custom data will be passed in
* this parameter.
* @param[out] stop Pointer to a variable where the handler
* can put nonzero to stop traversing
* of the collection.
* @return 0 - Success
* @return Function can return any error code. This code
* will be propagated through the internal functions and
* returned to the application.
*/
typedef int (*col_item_fn)(const char *property,
int property_len,
int type,
void *data,
int length,
void *custom_data,
int *stop);
/**
* @brief Traverse collection
*
* Function to traverse the entire collection
* including (optionally) sub collections.
*
* @param[in] ci Collection object to traverse.
* @param[in] mode_flags How to traverse.
* See details \ref traverseconst "here".
* @param[in] item_handler Application supplied callback.
* It will be called for each item
* in the collection including headers.
* @param[in] custom_data Custom data that application
* might want to pass to the callback.
*
* @return 0 - Collection was traversed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return Any error code returned by the callback.
*
*/
int col_traverse_collection(struct collection_item *ci,
int mode_flags,
col_item_fn item_handler,
void *custom_data);
/**
* @brief Search and do function.
*
* Looks up an item in the collection based on the property and type.
* Actually it is a traverse function with special traversing logic.
* It traverses the whole collection but calls the supplied
* callback only for the items that match the search criteria.
* It is the responsibility of the caller to define how the callback
* is going to indicate that the item it was looking for is found.
* Function will not return error if the item is not found.
* It is the responsibility of the calling application to check
* the data passed in custom_data and see if the item was found and
* that the action was performed.
*
* @param[in] ci Collection object to traverse.
* @param[in] property_to_find Name of the property to find.
* Parameter supports "x!y"
* notation.
* @param[in] type Type filter. Only properties
* of the given type will match.
* Can be 0 to indicate that all
* types should be evaluated.
* @param[in] mode_flags How to traverse the collection.
* See details \ref traverseconst "here".
* @param[in] item_handler Function to call when the item is found.
* @param[in] custom_data Custom data passed to the callback.
*
* @return 0 - Operation completed successfully.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - The search criteria is incorrect.
* @return ENOMEM - No memory.
* @return Any error code returned by the callback.
*
*/
int col_get_item_and_do(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags,
col_item_fn item_handler,
void *custom_data);
/**
* @brief Search function to get an item.
*
* Convenience function to get individual item.
* Caller should be aware that this is not a copy of the item
* but the pointer to actual item stored in the collection.
* The returned pointer should never be altered or freed by caller of the function.
* The caller should be sure that the collection does not go out of scope
* while the pointer to its data is in use.
* Working with the internals of the collection item structure directly
* may cause problems in future if the internal implementation changes.
* The caller needs to be aware that function does not return
* error if item is not found. The caller needs to check if
* item is not NULL to determine whether something was found.
* Internally function is a wrapper around the \ref col_get_item_and_do
* function.
*
* Use \ref getitem "item management" functions to work with the item.
*
* @param[in] ci Collection object to traverse.
* @param[in] property_to_find Name of the property to find.
* Parameter supports "x!y"
* notation.
* @param[in] type Type filter. Only properties
* of the given type will match.
* Can be 0 to indicate that all
* types should be evaluated.
* @param[in] mode_flags How to traverse the collection.
* See details \ref traverseconst "here".
* @param[in] item Pointer to found item or NULL
* if item is not found.
*
* @return 0 - No internal errors during search.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - The search criteria is incorrect.
* @return ENOMEM - No memory.
*
*/
int col_get_item(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags,
struct collection_item **item);
/**
* @brief Sort collection.
*
* If the sub collections are included in sorting
* each collection is sorted separately (this is not a global sort).
* It might be dangerous to sort sub collections if
* sub collection is not owned by the current collection.
* If it is a reference to an external collection
* there might be an issue. To skip the collections that
* externally referenced use \ref COL_SORT_MYSUB flag.
* Keep in mind that if a collection is referenced
* more than once by other collection and that collection
* is sorted with sub collections the referenced
* collection will be sorted more than once.
*
* NOTE: Current implementation of the sorting
* function is very simple and alternative
* implementations might be provided later.
*
* @param[in] col Collection to sort.
* @param[in] cmp_flags For more information see
* \ref compflags "comparison flags".
* @param[in] sort_flags For more information see
* \ref sortconst "sort flags".
*
* @return 0 - No internal errors during sorting.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_sort_collection(struct collection_item *col,
unsigned cmp_flags,
unsigned sort_flags);
/**
* @brief Delete property.
*
* Delete property from the collection.
* It is recommended to use a more efficient function
* \ref col_remove_item for the same purpose if
* the property is unique or if the collection
* has a known structure.
* The col_delete_property function has some advantage only
* if it is not known where property
* resides and what is the structure of the collection.
* In this case "foo!bar!baz" notation can be used in
* the property_to_find argument to find and delete
* the property "baz" that is in a sub collection "bar"
* which is in turn a part of a collection "foo".
*
* @param[in] ci Collection to delete property from.
* @param[in] property_to_find Property to delete.
* @param[in] type Use type if names are not unique
* and you know the type of the value
* you want to delete. Otherwise set to 0.
* @param[in] mode_flags The flags define how the collection
* should be searched. For more information
* see \ref traverseconst "traverse constants".
*
* @return 0 - Property was deleted successfully.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOMEM - No memory.
* @return ENOENT - Property not found.
*
*/
int col_delete_property(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags);
/**
* @brief Is property in the collection?
*
* Convenience function to check if the property
* is indeed in the collection.
*
* @param[in] ci Collection to search.
* @param[in] property_to_find Property to find.
* @param[in] type Use type if names are not unique
* and you know the type of the value
* you want to check. Otherwise set to 0.
* @param[in] mode_flags The flags define how the collection
* should be searched. For more information
* see \ref traverseconst "traverse constants".
* @param[out] found The variable that will receive the result
* of the search.
* COL_NOMATCH - if not found
* COL_MATCH if found
*
* @return 0 - Search completed successfully.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOMEM - No memory.
*
*/
int col_is_item_in_collection(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags,
int *found);
/**
* @brief Get a reference to a collection
*
* Get a pointer to a collection included into another collection.
* If the col_to_find is NULL function returns a reference
* to the top level collection.
* Delete extracted collection after use to decrease reference count.
*
* @param[in] ci Collection to search.
* @param[out] acceptor Variable that accepts pointer to
* an extracted collection.
* Use \ref col_destroy_collection to
* free returned object reference after
* use.
* @param[in] col_to_find Collection to find.
* "foo!bar!baz" notation can be used.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOMEM - No memory.
*/
int col_get_collection_reference(struct collection_item *ci,
struct collection_item **acceptor,
const char *col_to_find);
/**
* @brief Get a reference from the item
*
* Get a pointer to a collection from a current item
* if current item is a reference to the collection.
* If current item is not a reference to a collection an error
* will be returned.
* Delete extracted collection after use to decrease reference count.
*
* @param[in] item Item to extract the reference from.
* @param[out] acceptor Variable that accepts pointer to
* an extracted collection.
* Use \ref col_destroy_collection to
* free returned object reference after
* use.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*/
int col_get_reference_from_item(struct collection_item *item,
struct collection_item **acceptor);
/**
* @brief Get collection class.
*
* The classes of the collections can be used to convey information
* about the collection's internal structure.
* Some interfaces built on top of the collection might
* impose restrictions on the collection structure.
* For example the interface can decide that it is going
* to deal with the collections that do not have sub collections
* and elements of the collections are always only strings.
* So the interface will define a class of the collection
* and create a function that would take the strings and create
* such a collection. Then other functions of that interface
* would check if the provided collection is of the specified class.
* If not the interface would reject the collection right away.
* If the collection is of the valid class the interface might
* call the validation function to make sure that this is really
* the case however it needs to validate it only once and lower level
* functions can rely on the class value of the collection
* without performing duplicate validation.
*
* @param[in] ci Collection object.
* @param[out] cclass Variable that will receive
* the value of the class.
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_get_collection_class(struct collection_item *ci,
unsigned *cclass);
/**
* @brief Set collection class.
*
* Sometimes as a result of the collection modification
* the class of the collection can change.
*
* @param[in] ci Collection object.
* @param[in] cclass New class value.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_set_collection_class(struct collection_item *ci,
unsigned cclass);
/**
* @brief Get count of the elements.
*
* It is useful to know how many items are there in the collection.
*
* @param[in] ci Collection object.
* @param[out] count Variable will receive the value
* of the number of the items in
* the collection. Collection
* header or references to external
* collections are counted as well.
* This means that every collection
* has at least one item - the header.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_get_collection_count(struct collection_item *ci,
unsigned *count);
/**
* @brief Check the class of collection.
*
* Convenience function to check if the collection is of the specific class.
* In case of internal error assumes that collection is not of the right class.
*
* @param[in] ci Collection object.
* @param[in] cclass Class value to compare to to.
*
* @return 0 - If any internal error or classes do not match.
* @return 1 - No error and classes do match.
*
*/
int col_is_of_class(struct collection_item *ci,
unsigned cclass);
/**
* @defgroup addproperty Add property functions
*
* Functions in this section add properties to a collection.
*
* All the functions in this section add a property of the specified
* type to the collection object.
* They are convenience wrappers around the col_insert_xxx_property
* functions.
* They always append property to the end of the collection.
*
* Common parameters for these functions are:
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
* @{
*/
/**
* @brief Add a string property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] string Null terminated string to add.
* @param[in] length Length of the string. Should include the length
* of the terminating 0.
* If the length is shorter than the full string
* the string will be truncated. If the length is
* longer than the actual string there might be
* garbage at end of the actual string.
* Library will always properly NULL terminate
* the string at the given position dictated
* by length but in no way will inspect the validity
* of the passed in data. This is left to the calling
* application.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_str_property(struct collection_item *ci,
const char *subcollection,
const char *property,
const char *string,
int length);
/**
* @brief Add a binary property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] binary_data Data to add.
* @param[in] length Length of the data.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_binary_property(struct collection_item *ci,
const char *subcollection,
const char *property,
void *binary_data,
int length);
/**
* @brief Add an integer property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Integer value to add. Value is signed.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_int_property(struct collection_item *ci,
const char *subcollection,
const char *property,
int32_t number);
/**
* @brief Add an unsigned integer property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Unsigned integer value to add.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_unsigned_property(struct collection_item *ci,
const char *subcollection,
const char *property,
uint32_t number);
/**
* @brief Add an long property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Long integer value to add. Value is signed.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_long_property(struct collection_item *ci,
const char *subcollection,
const char *property,
int64_t number);
/**
* @brief Add an unsigned long property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Unsigned long integer value to add.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_ulong_property(struct collection_item *ci,
const char *subcollection,
const char *property,
uint64_t number);
/**
* @brief Add a property of type double to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Floating point value.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_double_property(struct collection_item *ci,
const char *subcollection,
const char *property,
double number);
/**
* @brief Add a Boolean property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] logical Boolean value. 0 - false, nonzero - true.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_bool_property(struct collection_item *ci,
const char *subcollection,
const char *property,
unsigned char logical);
/**
* @brief Add a property of a specified type to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] type See type definitions \ref coltypes "here".
* @param[in] data Data to add.
* @param[in] length Length of the data.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_any_property(struct collection_item *ci,
const char *subcollection,
const char *property,
int type,
void *data,
int length);
/**
* @defgroup addprop_withref Add properties with reference
*
* Family of functions that add properties to a collection
* and return reference to an item that holds
* a newly created property.
*
* All the functions in this section append a property of
* the specified type to the collection object.
*
* Parameters for the functions and return values are the same
* as for the \ref addproperty "col_add_xxx_property" functions.
* The only difference is that these functions have one additional
* argument:
*
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @{
*/
/**
* @brief Add a string property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] string Null terminated string to add.
* @param[in] length Length of the string. Should include the length
* of the terminating 0.
* If the length is shorter than the full string
* the string will be truncated. If the length is
* longer than the actual string there might be
* garbage at end of the actual string.
* Library will always properly NULL terminate
* the string at the given position dictated
* by length but in no way will inspect the validity
* of the passed in data. This is left to the calling
* application.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_str_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
char *string, int length,
struct collection_item **ret_ref);
/**
* @brief Add a binary property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] binary_data Data to add.
* @param[in] length Length of the data.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_binary_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
void *binary_data, int length,
struct collection_item **ret_ref);
/**
* @brief Add an integer property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Integer value to add. Value is signed.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_int_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, int32_t number,
struct collection_item **ret_ref);
/**
* @brief Add an unsigned integer property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Unsigned integer value to add.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_unsigned_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, uint32_t number,
struct collection_item **ret_ref);
/**
* @brief Add an long property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Long integer value to add. Value is signed.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_long_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, int64_t number,
struct collection_item **ret_ref);
/**
* @brief Add an unsigned long property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Unsigned long integer value to add.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_ulong_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, uint64_t number,
struct collection_item **ret_ref);
/**
* @brief Add a property of type double to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Floating point value.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_double_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, double number,
struct collection_item **ret_ref);
/**
* @brief Add a Boolean property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] logical Boolean value. 0 - false, nonzero - true.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_bool_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, unsigned char logical,
struct collection_item **ret_ref);
/**
* @brief Add a property of a specified type to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] type See type definitions \ref coltypes "here".
* @param[in] data Data to add.
* @param[in] length Length of the data.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_any_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
int type, void *data, int length,
struct collection_item **ret_ref);
/**
* @}
*/
/**
* @}
*/
/**
* @defgroup insertproperty Insert property functions
*
* Functions in this section insert properties into a collection
* at a specified position.
*
* Common parameters for these functions are:
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] disposition Defines relation point.
* For more information see
* \ref dispvalues "disposition defines".
* @param[in] refprop Property to relate to
* @param[in] idx Index (see comments below).
* @param[in] flags Flags that control naming issues.
* @param[in] property Name of the property.<br>
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.<br>
* Maximum allowed length is defined at compile time.
* The default value is 64k.
*
*
* Other arguments are the same as the arguments for the
* \ref addproperty "col_add_xxx_property" functions.
*
* @return 0 - Property was insterted successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection or property to relate to is not found.
* @return EEXIST - Property with given name already exists.
* This error is returned if collection
* should hold unique names.
* For more information see description of the
* "flags" argument.
* @return ENOSYS - Flag or disposition value is not implemented.
* @{
*/
/** @brief Insert a string property. */
int col_insert_str_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
const char *string,
int length);
/** @brief Insert a binary property. */
int col_insert_binary_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
void *binary_data,
int length);
/** @brief Insert an integer property. */
int col_insert_int_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int32_t number);
/** @brief Insert an unsigned property. */
int col_insert_unsigned_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint32_t number);
/** @brief Insert a long property. */
int col_insert_long_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int64_t number);
/** @brief Insert an unsigned long property. */
int col_insert_ulong_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint64_t number);
/** @brief Insert a property with a floating point value. */
int col_insert_double_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
double number);
/** @brief Insert a property with a Boolean value. */
int col_insert_bool_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
unsigned char logical);
/** @brief Insert a string property and get back a reference. */
int col_insert_str_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
const char *string,
int length,
struct collection_item **ret_ref);
/** @brief Insert a binary property and get back a reference. */
int col_insert_binary_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
void *binary_data,
int length,
struct collection_item **ret_ref);
/** @brief Insert an integer property and get back a reference. */
int col_insert_int_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int32_t number,
struct collection_item **ret_ref);
/** @brief Insert an unsigned property and get back a reference. */
int col_insert_unsigned_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint32_t number,
struct collection_item **ret_ref);
/** @brief Insert a long property and get back a reference. */
int col_insert_long_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int64_t number,
struct collection_item **ret_ref);
/** @brief Insert an unsigned long property and get back a reference. */
int col_insert_ulong_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint64_t number,
struct collection_item **ret_ref);
/**
* @brief Insert a property with a floating
* point value and get back a reference.
*/
int col_insert_double_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
double number,
struct collection_item **ret_ref);
/** @brief Insert a property with a Boolean value and get back a reference. */
int col_insert_bool_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
unsigned char logical,
struct collection_item **ret_ref);
/** @brief Insert property of any type and get back a reference. */
int col_insert_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int type,
const void *data,
int length,
struct collection_item **ret_ref);
/**
* @}
*/
/**
* @defgroup updateproperty Update property functions
*
* Functions in this section update properties in a collection.
*
* All update functions search the property using the
* internal traverse function.
* Use same "x!y" notation to specify a property.
* For more details about the search logic see
* \ref col_get_item_and_do function.
*
* The existing value of the property is destroyed and lost.
*
* It is not possible to rename the property using these functions.
* To do more advanced modifications see \ref col_modify_item function
* and \ref modwrap "item modification wrappers" .
*
* Common parameters for these functions are:
*
* @param[in] ci Root collection object.
* @param[in] property Name of the property.
* @param[in] mode_flags Specify how the collection
* should to be traversed.
*
* The rest of the arguments specify the new values for
* the property. For more details about these arguments see
* the description of the \ref addproperty "col_add_xxx_property"
* corresponding function.
*
*
* @return 0 - Property was updated successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* The attempt to update a property which is
* a reference to a collection or a collection
* name.
* @return ENOENT - Property to update is not found.
*
* @{
*/
/**
* Update a property with a string value.
* Length should include the terminating 0.
*/
int col_update_str_property(struct collection_item *ci,
const char *property,
int mode_flags,
char *string,
int length);
/**
* Update a property with a binary value.
*/
int col_update_binary_property(struct collection_item *ci,
const char *property,
int mode_flags,
void *binary_data,
int length);
/**
* Update a property with an integer value.
*/
int col_update_int_property(struct collection_item *ci,
const char *property,
int mode_flags,
int32_t number);
/**
* Update a property with an unsigned value.
*/
int col_update_unsigned_property(struct collection_item *ci,
const char *property,
int mode_flags,
uint32_t number);
/**
* Update a property with a long value.
*/
int col_update_long_property(struct collection_item *ci,
const char *property,
int mode_flags,
int64_t number);
/**
* Update a property with an unsigned long value.
*/
int col_update_ulong_property(struct collection_item *ci,
const char *property,
int mode_flags,
uint64_t number);
/**
* Update a property with a floating point value.
*/
int col_update_double_property(struct collection_item *ci,
const char *property,
int mode_flags,
double number);
/**
* Update a property with a Boolean value.
*/
int col_update_bool_property(struct collection_item *ci,
const char *property,
int mode_flags,
unsigned char logical);
/**
* Update a property with a value by specifying type
* and value. See definitions of the type constants
* \ref coltypes "here".
* All other col_update_xxx_property functions are wrappers
* around this one.
*/
int col_update_property(struct collection_item *ci,
const char *property,
int type,
void *new_data,
int length,
int mode_flags);
/**
* @}
*/
/**
* @defgroup getitem Item management
*
* Group of functions that allows retrieving individual elements
* of the \ref collection_item hiding the internal implementation.
*
* @{
*/
/**
* @defgroup compflags Comparison flags
*
* This section describes the flags used in item comparison.
*
* Flags:
* - \ref COL_CMPIN_PROP_EQU
* - \ref COL_CMPIN_PROP_BEG
* - \ref COL_CMPIN_PROP_MID
* - \ref COL_CMPIN_PROP_END
*
* are mutually exclusive.
*
* All other flags can be provided in any combination.
*
* @{
*/
/** @brief Properties should be exactly equal */
#define COL_CMPIN_PROP_EQU 0x000000004
/** @brief Properties should start with the same substring. */
#define COL_CMPIN_PROP_BEG 0x000000005
/** @brief One property should be a substring of another. */
#define COL_CMPIN_PROP_MID 0x000000006
/** @brief Properties should have the same substring at the end. */
#define COL_CMPIN_PROP_END 0x000000007
/**
* @brief Make sure that there is a dot.
*
* Useful with _BEG, _MID and _END flags to check that the there is
* a dot (if present) in the right place (before, after or both).
* For example the first item is named "foo.bar" and the second
* is "bar". Using _END the "bar" will be found but if _DOT flag is
* used too the function will also check if there was a "." before the found
* string in this case.
* Ignored in case of _EQU.
*/
#define COL_CMPIN_PROP_DOT 0x000000008
/** @brief Compare property lengths. */
#define COL_CMPIN_PROP_LEN 0x000000010
/** @brief Compare types. */
#define COL_CMPIN_TYPE 0x000000020
/** @brief Compare data lengths. */
#define COL_CMPIN_DATA_LEN 0x000000040
/**
* @brief Compare data.
*
* Compares data (up to the length of the second one)
* if type is the same. If type is different
* function will assume data is different
* without performing actual comparison.
*/
#define COL_CMPIN_DATA 0x000000080
/**
* @}
*/
/**
* @defgroup outflags Comparison results flags
*
* This section describes the flags set as a result of
* a comparison operation.
*
* @{
*/
/**
* @brief Second item's property is greater.
*
* If _EQU was specified and the property of the second item
* is greater the following bit will be set
*/
#define COL_CMPOUT_PROP_STR 0x00000001
/**
* @brief Second item's property is longer.
*
* If told to compare property lengths
* and the second is longer this bit will be set.
*/
#define COL_CMPOUT_PROP_LEN 0x00000002
/**
* @brief Second item's data is longer.
*
* If told to compare data lengths
* and second is longer this bit will be set
*/
#define COL_CMPOUT_DATA_LEN 0x00000004
/**
* @brief Second item's data is greater.
*
* If told to compare data
* and types are the same, then
* if the second one is greater this bit will
* be set. If data is binary flag is never set.
*/
#define COL_CMPOUT_DATA 0x00000008
/**
* @}
*/
/**
* @defgroup dispvalues Disposition constants
*
* Possible dispositions for insert, extract and delete function(s).
* Not all of these dispositions are implemented day one.
* If disposition is not implemented the function
* will return error ENOSYS.
*
* Other dispositions might be possible in future.
*
* @{
*/
/**
* @brief Relate to the end of the collection
*
* For "insert":
* - Add property to the end of the collection.
*
* For "extract" or "delete":
* - Extract or delete the last property in the collection.
*/
#define COL_DSP_END 0
/**
* @brief Relate to the beginning of the collection
*
* For "insert":
* - Add property to the beginning of the collection right after the header.
*
* For "extract" or "delete":
* - Extract or delete the first property in the collection.
* This is the one right after the header.
*/
#define COL_DSP_FRONT 1
/**
* @brief Before the given property
*
* For "insert":
* - Add property before the referenced property.
*
* For "extract" or "delete":
* - Extract or delete the property that stands
* before the referenced property in the collection.
* If given property is the first in the collection
* ENOENT is returned.
*/
#define COL_DSP_BEFORE 2
/**
* @brief After the given property
*
* For "insert":
* - Add property immediately the referenced property.
*
* For "extract" or "delete":
* - Extract or delete the property that stands
* after the referenced property in the collection.
* If given property is the last in the collection
* ENOENT is returned.
*/
#define COL_DSP_AFTER 3
/**
* @brief Use index
*
* For "insert":
* - The COL_DSP_INDEX adds the item as N-th item after header in the list.
* Index is zero based.
* If there are less than N items in the list the item is added to the end.
* The index value of 0 means that the item will be added immediately
* after the header. Index of 1 will mean that it is added after first data
* item and so on.
*
* For "extract" or "delete":
* - In case of extraction or deletion the N-th item of the collection
* will be extracted or deleted.
* Index is zero based.
* If there are less than N+1 items in the list the function will return ENOENT.
*
*/
#define COL_DSP_INDEX 4
/**
* @brief Use first among duplicates
*
* This mode applies only to the list of duplicate
* properties that are going one after another.
*
* For "insert":
* - Add property as a first dup of the given property.
* The property name is taken from the item
* and the value refprop is ignored.
*
* For "extract" or "delete":
* - Delete or extract first duplicate property.
* The property name is taken from the refprop.
* The property will be extracted or deleted if found
* regardless of whether there are any duplicates or not.
*/
#define COL_DSP_FIRSTDUP 5
/**
* @brief Use last among duplicates
*
* This mode applies only to the list of duplicate
* properties that are going one after another.
*
* For "insert":
* - Add property as the last dup of the given property.
* The property name is taken from the item
* and the value refprop is ignored.
*
* For "extract" or "delete":
* - Delete or extract the last duplicate of the property.
* The property name is taken from the refprop.
* Extracts or deletes last duplicate property in the uninterrupted
* sequence of properties with the same name.
* The property will be extracted or deleted if found
* regardless of whether there are any duplicates or not.
*/
#define COL_DSP_LASTDUP 6
/**
* @brief Use N-th among duplicates
*
* This mode applies only to the list of duplicate
* properties that are going one after another.
*
* For "insert":
* - Add property as a N-th dup of the given property.
* The property name is taken from the item
* and the value refprop is ignored.
* Index is zero based.
* The COL_DSP_NDUP is used in case of the multi value property
* to add a new property with the same name into specific place
* in the list of properties with the same name.
* The index of 0 will mean to add the property before the first
* instance of the property with the same name.
* If the property does not exist ENOENT will be returned.
* If the index is greater than the last property with the same
* name the item will be added immediately after last
* property with the same name.
*
* For "extract" or "delete":
* - Delete or extract N-th duplicate property.
* Index is zero based.
* The property name is taken from the refprop.
* If index is greater than number of duplicate
* properties in the sequence ENOENT is returned.
*
*/
#define COL_DSP_NDUP 7
/**
* @}
*/
/**
* @defgroup insflags Flags used in insert item functions
*
* Flags that can be used with insert functions.
*
* In future can more flags might be added.
*
* <b>NOTE:</b> Use of the duplicate checking flags is costly
* since it requires a forward look up of the whole
* collection before the item is inserted.
* Do not use it until it is absolutely necessary.
*
* @{
*/
/** @brief This is the default mode - no dup checks on insert */
#define COL_INSERT_NOCHECK 0
/**
* @brief Check for duplicate name and overwrite.
* Position arguments are ignored.
*/
#define COL_INSERT_DUPOVER 1
/**
* @brief Check for duplicate name and type and overwrite.
* Position arguments are ignored.
*/
#define COL_INSERT_DUPOVERT 2
/** @brief Return error EEXIST if the entry with the same name exists. */
#define COL_INSERT_DUPERROR 3
/**
* @brief Return error EEXIST if the entry
* with the same name and type exists.
*/
#define COL_INSERT_DUPERRORT 4
/** @brief Check for duplicates, overwrite,
* extract and then move to the position requested.
*/
#define COL_INSERT_DUPMOVE 5
/** @brief Check for duplicate name and type, overwrite,
* extract and then move to the position requested.
*/
#define COL_INSERT_DUPMOVET 6
/**
* @}
*/
/**
* @brief Get item property.
*
* Get name of the property from the item. If the item is a header
* the name of the property is the name of the collection.
* The element that denotes the collection header has
* type \ref COL_TYPE_COLLECTION.
* Optionally the property length can be retrieved too.
*
* @param[in] ci Item to get property from.
* If item is invalid the function
* will cause a segment violation.
* @param[out] property_len If not NULL the variable
* will receive the length
* of the property not counting
* terminating 0.
*
* @return Property name.
*
*/
const char *col_get_item_property(struct collection_item *ci,
int *property_len);
/**
* @brief Get item type.
*
* Get type from the item.
*
* @param[in] ci Item to get type from.
* If item is invalid the function
* will cause a segment violation.
*
* @return Item type.
*
*/
int col_get_item_type(struct collection_item *ci);
/**
* @brief Get value length from the item.
*
* Get value length from the item. For strings this includes
* NULL terminating zero.
*
* @param[in] ci Item to get value length from.
* If item is invalid the function
* will cause a segment violation.
*
* @return Value length.
*
*/
int col_get_item_length(struct collection_item *ci);
/**
* @brief Get value from the item.
*
* Get value from the item.
*
* @param[in] ci Item to get value from.
* If item is invalid the function
* will cause a segment violation.
*
* @return Property value.
*
*/
void *col_get_item_data(struct collection_item *ci);
/**
* @brief Get hash value from the item.
*
* Get hash value from the item. The hash value is
* 64-bit hash created from the property name.
* It is done to optimize the searches.
*
* This function is exposed for some corner cases
* that require low level operations, for example
* for custom search callbacks to take advantage
* of the internal hashes.
*
* @param[in] ci Item to get hash from.
* If item is invalid the function
* will cause a segment violation.
*
* @return Hash value.
*
*/
uint64_t col_get_item_hash(struct collection_item *ci);
/**
* @brief Calculate hash value for a string.
*
* Calculates hash value of the string using internal hashing
* algorithm. Populates "length" with length
* of the string not counting 0.
*
* This function is useful if you want to build a custom
* search or collection sorting function.
*
* @param[in] string String to hash. If NULL hash is 0.
* @param[in] sub_len If it is greater than zero
* it is used to count how many
* characters from string should
* be included into hash calculation.
* If 0 the actual length of the string
* is determined and used.
* @param[out] length Will receive the calculated length
* of the provided string.
* Length argument can be NULL.
*
* @return Hash value.
*/
uint64_t col_make_hash(const char *string, int sub_len, int *length);
/**
* @brief Compare two items.
*
* The second item is evaluated against the first.
* Function returns 0 if two items are the same
* and non-zero otherwise.
* The \ref compflags "in_flags" is a bit mask that
* defines how the items should be compared.
*
* If items are different they might be sorted following
* some order. For example one can order items by name
* but not by type.
* If the result of the function is non-zero
* the \ref outflags "out_flags" (if provided) will be
* set to indicate if the second item is greater
* then the first.
*
* @param[in] first First item to compare.
* @param[in] second Second item to compare.
* @param[in] in_flags See \ref compflags "comparison flags".
* @param[out] out_flags See \ref outflags "output flags".
*
*
* @return 0 if items are the same and nonzero otherwise.
*/
int col_compare_items(struct collection_item *first,
struct collection_item *second,
unsigned in_flags,
unsigned *out_flags);
/**
* @brief Modify any item element.
*
* This function is useful if you want to modify the item that
* you got as a result of \ref iterfunc "iterating" through
* collection or by calling \ref col_get_item.
* Previous type and data of the item is destroyed.
*
* If you want to rename an item provide a new name in the property
* argument otherwise keep it NULL.
*
* If you want the data to remain unchanged use 0 as a length parameter.
*
* If item is a reference or a collection the call will return an error.
*
* The are several convenience function that are wrappers
* around this function. For more information
* see \ref modwrap "item modification wrappers".
*
* @param[in] item Item to modify.
* @param[in] property Property name. Use NULL to leave the property
* unchanged.
* @param[in] type See \ref coltypes "types" for more information.
* @param[in] data New value.
* @param[in] length New value. Use 0 to leave the value and its type
* unchanged.
*
* @return 0 - Item was successfully modified.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* The attempt to modify an item which is
* a reference to a collection or a collection
* name.
*/
int col_modify_item(struct collection_item *item,
const char *property,
int type,
const void *data,
int length);
/**
* @defgroup modwrap Item modification wrappers
*
* The functions in this section are convenience wrappers
* around \ref col_modify_item.
* They return same error codes.
*
* @{
*/
/**
* @brief Modify item property.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It is equivalent to: col_modify_item(item, property, 0, NULL, 0);
*
*/
int col_modify_item_property(struct collection_item *item,
const char *property);
/**
* @brief Modify item value to be a string.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided string.
* If property is not NULL it also renames the property.
* If the length argument is not zero the string will be truncated to
* this length. If the length is 0 the length will be calculated based
* on the length of the actual string.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_str_item(struct collection_item *item,
const char *property,
const char *string,
int length);
/**
* @brief Modify item value to be a binary blob.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided binary buffer.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_binary_item(struct collection_item *item,
const char *property,
void *binary_data,
int length);
/**
* @brief Modify item value to be a Boolean.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided logical value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_bool_item(struct collection_item *item,
const char *property,
unsigned char logical);
/**
* @brief Modify item value to be an integer.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided integer value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_int_item(struct collection_item *item,
const char *property,
int32_t number);
/**
* @brief Modify item value to be a long integer.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided long integer value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_long_item(struct collection_item *item,
const char *property,
int64_t number);
/**
* @brief Modify item value to be an unsigned long.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided unsigned long value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_ulong_item(struct collection_item *item,
const char *property,
uint64_t number);
/**
* @brief Modify item value to be an unsigned integer.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided unsigned integer value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_unsigned_item(struct collection_item *item,
const char *property,
uint32_t number);
/**
* @brief Modify item value to be a floating point.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided floating point value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_double_item(struct collection_item *item,
const char *property,
double number);
/**
* @}
*/
/**
* @brief Extract item from the collection.
*
* Function to find and remove an item from the collection.
* Function does not destroy the item instead it returns a reference
* to the item so it can be used later and inserted back into this or
* other collection.
* The function assumes that the caller knows the collection
* the property is stored in.
* The header of the collection can't be extracted with this function
* but the reference to the collection can.
*
* Function allows specifying relative position of the item in the
* collection. One can specify that he wants to extract an item
* that is first in the collection or last, or after other item
* in the collection. For more details see parameter definitions.
*
* After extracting the item from the collection the caller has to
* either insert it back into some collection using \ref col_insert_item
* or delete it using \ref col_delete_item.
*
*
* @param[in] ci Collection object.
* @param[in] subcollection Name of the sub collection to extract
* item from. If NULL, the top level collection
* is used. One can use "foo!bar!baz"
* notation to identify the sub collection.
* @param[in] disposition Constant that controls how the relative
* position of the item to extract is determined.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should extract next item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to extract.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] type Type filter. Only the item of the matching
* type will be used. It can be a bit mask of
* more than one type. Use 0 if you do not
* need to filter by type.
* @param[out] ret_ref Variable will receive the value of the
* pointer to the extracted item.
*
* @return 0 - Item was successfully extracted.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* extracting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
*/
int col_extract_item(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
int type,
struct collection_item **ret_ref);
/**
* @brief Extract item from the current collection.
*
* Function is similar to the \ref col_extract_item.
* It acts exactly the same as \ref col_extract_item when the
* subcollection parameter of the \ref col_extract_item is set to NULL.
*
* @param[in] ci Collection object.
* @param[in] disposition Constant that controls how the relative
* position of the item to extract is determined.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should extract next item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to extract.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] type Type filter. Only the item of the matching
* type will be used. It can be a bit mask of
* more than one type. Use 0 if you do not
* need to filter by type.
* @param[out] ret_ref Variable will receive the value of the
* pointer to the extracted item.
*
* @return 0 - Item was successfully extracted.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* extracting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
*/
int col_extract_item_from_current(struct collection_item *ci,
int disposition,
const char *refprop,
int idx,
int type,
struct collection_item **ret_ref);
/**
* @brief Remove item from the collection.
*
* Function internally calls \ref col_extract_item and then
* \ref col_delete_item for the extracted item.
*
* Function is similar to \ref col_delete_property function
* but allows more specific information about what item (property)
* to remove.
*
* The header will not be considered for deletion.
*
* @param[in] ci Collection object.
* @param[in] subcollection Name of the sub collection to remove
* item from. If NULL, the top level collection
* is used. One can use "foo!bar!baz"
* notation to identify the sub collection.
* @param[in] disposition Constant that controls how the relative
* position of the item to remove is determined.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should remove next item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to remove.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] type Type filter. Only the item of the matching
* type will be used. It can be a bit mask of
* more than one type. Use 0 if you do not
* need to filter by type.
*
* @return 0 - Item was successfully removed.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* deleting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
*/
int col_remove_item(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
int type);
/**
* @brief Remove item from the current collection.
*
* Function is similar to the \ref col_remove_item.
* It acts exactly the same as \ref col_remove_item when the
* subcollection parameter of the \ref col_remove_item is set to NULL.
*
* @param[in] ci Collection object.
* @param[in] disposition Constant that controls how the relative
* position of the item to remove is determined.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should remove next item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to remove.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] type Type filter. Only the item of the matching
* type will be used. It can be a bit mask of
* more than one type. Use 0 if you do not
* need to filter by type.
*
* @return 0 - Item was successfully removed.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* deleting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
*/
int col_remove_item_from_current(struct collection_item *ci,
int disposition,
const char *refprop,
int idx,
int type);
/**
* @brief Insert item to the collection.
*
* <b>WARNING:</b> Only use this function to insert items
* that were extracted using \ref col_extract_item or
* \ref col_extract_item_from_current.
* <b>NEVER</b> use it with items that were returned by:
* - \ref col_get_item
* - \ref addproperty "add property" functions
* - \ref addprop_withref "add property with reference" functions
* - \ref insertproperty "instert property" functions.
*
* The fundamental difference is that when you extracted item
* using col_extract_item() it stops to be managed by a collection.
* With such item you can:
* - a) Insert this item into another (or same) collection
* - b) Get item information using corresponding item management functions.
* - c) Destroy item using col_delete_item().
*
* You are required to do either a) or c) with such item.
*
* @param[in] ci Collection object.
* @param[in] subcollection Name of the sub collection to insert
* item into. If NULL, the top level collection
* is used. One can use "foo!bar!baz"
* notation to identify the sub collection.
* @param[in] item Item to insert.
* @param[in] disposition Constant that controls where to insert
* the item.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should insert the item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to insert.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] flags Flags that control naming issues.
* See \ref insflags "insert flags"
* for more details.
*
* @return 0 - Item was successfully extracted.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* extracting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
* @return EEXIST If duplicate name/type checking is turned on
* and duplicate name/type is detected.
*
*/
int col_insert_item(struct collection_item *ci,
const char *subcollection,
struct collection_item *item,
int disposition,
const char *refprop,
int idx,
unsigned flags);
/**
* @brief Insert item to the current collection.
*
* Function is equivalent to \ref col_insert_item with
* subcollection parameter equal NULL.
*
* @param[in] ci Collection object.
* @param[in] item Item to insert.
* @param[in] disposition Constant that controls where to insert
* the item.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should insert the item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to insert.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] flags Flags that control naming issues.
* See \ref insflags "insert flags"
* for more details.
*
* @return 0 - Item was successfully extracted.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* extracting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
* @return EEXIST If duplicate name/type checking is turned on
* and duplicate name/type is detected.
*
*/
int col_insert_item_into_current(struct collection_item *ci,
struct collection_item *item,
int disposition,
const char *refprop,
int idx,
unsigned flags);
/**
* @brief Delete extracted item.
*
* <b>NEVER</b> use this function to delete an item
* that was not previously extracted from the collection.
*
* There is currently no function to create an item aside and
* then insert it into the collection so the col_delete_item
* has only one use. In future this may change.
*
* @param[in] item Item to delete.
*
*/
void col_delete_item(struct collection_item *item);
/**
* @}
*/
/**
* @defgroup iterfunc Iterator interface
*
* The functions in this section allow iterating
* through a collection in a loop where the caller
* implements the loop. It is different from the search and
* traverse functions described in other sections because those
* functions implement the loop themselves and call provided
* callback in a specific situation.
*
* @{
*/
/**
* @brief Bind iterator to a collection.
*
* This function creates an iterator object and binds it to the collection.
*
* @param[out] iterator Newly created iterator object.
* @param[in] ci Collection to iterate.
* @param[in] mode_flags Flags define how to traverse the collection.
* For more information see \ref traverseconst
* "constants defining traverse modes".
*
* @return 0 - Iterator was created successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_bind_iterator(struct collection_iterator **iterator,
struct collection_item *ci,
int mode_flags);
/**
* @brief Unbind the iterator from the collection.
*
* @param[in] iterator Iterator object to free.
*/
void col_unbind_iterator(struct collection_iterator *iterator);
/**
* @brief Iterate collection.
*
* Advance to next item in the collection. After the iterator is
* bound it does not point to any item in the collection.
* Use this function in the loop to step through all items
* in the collection. See unit test for code examples.
*
* @param[in] iterator Iterator object to use.
* @param[out] item Pointer to the collection item.
* Do not destroy or alter this pointer
* in any ways. To access the internals
* of the item use \ref getitem "item management"
* functions.
* The value of the item will be set to NULL if
* the end of the collection is reached.
*
* @return 0 - Item was successfully retrieved.
* @return EINVAL - The value of some of the arguments is invalid.
*/
int col_iterate_collection(struct collection_iterator *iterator,
struct collection_item **item);
/**
* @brief Move up
*
* Stop processing this sub collection and move to the next item in the
* collection some levels up.
*
* @param[in] iterator Iterator object to use.
* @param[in] level Indicates how many levels up you want to jump.
* If 0 - call is a no op.
* If the depth is less then requested level
* the iterator will get to the 0 level and
* next call to \ref col_iterate_collection
* will return NULL item.
*
* @return 0 - Iterator was successfully repositioned.
* @return EINVAL - The value of some of the arguments is invalid.
*/
int col_iterate_up(struct collection_iterator *iterator, unsigned level);
/**
* @brief Get current depth
*
* How deep are we relative to the top level?
* This function will report depth that in some cases might look
* misleading. The reason is that traverse flags affect the internal
* level we are on at each moment.
* For example the default traverse behavior is to show
* references to the sub collections.
* So when the item reference is returned the
* depth automatically adjusted to level inside the sub collection.
* So if function is called in this situation the level returned will
* denote the level inside collection.
* Now imagine that this collection is empty so the attempt to read
* element will push you automatically one level up (in absence of the
* \ref COL_TRAVERSE_END flag). If in this situation you encounter another
* collection the reference will be returned and level automatically
* adjusted to level inside the collection.
* The point is that the level is reliable only after
* a data item was returned.
* To avoid this ambiguity another function \ref col_get_item_depth
* was introduced.
*
* @param[in] iterator Iterator object to use.
* @param[in] depth The variable will receive the depth
* the iterator is on. The value is 0
* if the iterator is on the top level.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*/
int col_get_iterator_depth(struct collection_iterator *iterator, int *depth);
/**
* @brief Get depth of the last returned item.
*
* @param[in] iterator Iterator object to use.
* @param[in] depth The variable will receive the depth
* the iterator is on.
* Item from the top level will have
* depth equal to 0. The value of 0
* will also be returned if no item
* was read so far.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*/
int col_get_item_depth(struct collection_iterator *iterator, int *depth);
/**
* @brief Pin iterator
*
* Pins down the iterator to loop around current point.
*
* This feature allows some search optimization.
* The idea is to be able to put a 'pin'
* into a specific place while iterating
* the collection and make this place a new
* "wrap around" place for the collection.
* This means that next time you
* iterate this collection you will start
* iterating from the next item and
* the item you got before setting pin will be
* the last in your iteration cycle.
*
* Here is the example:
*
* Assume you have two collections that you need
* to compare and perform some action on collection
* 1 based on the presence of the item in collection 2.
* - Collection1 = A, B, C, D, E, F
* - Collection2 = A, C, F
*
* The usual approach is to try A from collection 1
* against A, B, C from collection 2. "A" will be found
* right away. But to find "F" it has to be compared
* to "A" and "C" first. The fact that the collections
* are to some extent ordered can in some cases
* help to reduce the number of comparisons.
* If we found "C" in the list we can put a "pin"
* into the collection there causing the iterator
* to warp at this "pin" point. Since "D" and "E"
* are not in the second collection we will have
* to make same amount of comparisons in traditional
* or "pinned" case to not find them.
* To find "F" in pinned case there will be just one
* comparison.
* - Traditional case = 1 + 3 + 2 + 3 + 3 + 3 = 15
* - Pinned case = 1 + 3 + 1 + 3 + 3 + 1 = 12
*
* It is a 20% comparison reduction.
*
* @param[in] iterator Iterator object to use.
*/
void col_pin_iterator(struct collection_iterator *iterator);
/**
* @brief Rewind iterator
*
* Rewinds iterator to the current pin point which is by
* default the beginning of the collection until changed by
* \ref col_pin_iterator function.
*
* @param[in] iterator Iterator object to use.
*/
void col_rewind_iterator(struct collection_iterator *iterator);
/**
* @}
*/
/**
* @}
*/
#endif
|