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
use lib0::any::Any;
use std::collections::HashMap;
use std::ffi::{c_void, CStr, CString};
use std::mem::{forget, ManuallyDrop, MaybeUninit};
use std::os::raw::{c_char, c_float, c_int, c_long, c_uchar, c_ulong};
use std::ptr::null;
use yrs::block::{ItemContent, Prelim};
use yrs::types::{
Branch, BranchRef, Change, EntryChange, Event, PathSegment, TypePtr, Value, TYPE_REFS_ARRAY,
TYPE_REFS_MAP, TYPE_REFS_XML_ELEMENT, TYPE_REFS_XML_TEXT,
};
use yrs::updates::decoder::{Decode, DecoderV1};
use yrs::updates::encoder::{Encode, Encoder, EncoderV1};
use yrs::Xml;
use yrs::{OffsetKind, Update};
use yrs::{Options, StateVector};
/// Flag used by `YInput` and `YOutput` to tag boolean values.
pub const Y_JSON_BOOL: c_char = -8;
/// Flag used by `YInput` and `YOutput` to tag floating point numbers.
pub const Y_JSON_NUM: c_char = -7;
/// Flag used by `YInput` and `YOutput` to tag 64-bit integer numbers.
pub const Y_JSON_INT: c_char = -6;
/// Flag used by `YInput` and `YOutput` to tag strings.
pub const Y_JSON_STR: c_char = -5;
/// Flag used by `YInput` and `YOutput` to tag binary content.
pub const Y_JSON_BUF: c_char = -4;
/// Flag used by `YInput` and `YOutput` to tag embedded JSON-like arrays of values,
/// which themselves are `YInput` and `YOutput` instances respectively.
pub const Y_JSON_ARR: c_char = -3;
/// Flag used by `YInput` and `YOutput` to tag embedded JSON-like maps of key-value pairs,
/// where keys are strings and v
pub const Y_JSON_MAP: c_char = -2;
/// Flag used by `YInput` and `YOutput` to tag JSON-like null values.
pub const Y_JSON_NULL: c_char = -1;
/// Flag used by `YInput` and `YOutput` to tag JSON-like undefined values.
pub const Y_JSON_UNDEF: c_char = 0;
/// Flag used by `YInput` and `YOutput` to tag content, which is an `YArray` shared type.
pub const Y_ARRAY: c_char = 1;
/// Flag used by `YInput` and `YOutput` to tag content, which is an `YMap` shared type.
pub const Y_MAP: c_char = 2;
/// Flag used by `YInput` and `YOutput` to tag content, which is an `YText` shared type.
pub const Y_TEXT: c_char = 3;
/// Flag used by `YInput` and `YOutput` to tag content, which is an `YXmlElement` shared type.
pub const Y_XML_ELEM: c_char = 4;
/// Flag used by `YInput` and `YOutput` to tag content, which is an `YXmlText` shared type.
pub const Y_XML_TEXT: c_char = 5;
/// Flag used to mark a truthy boolean numbers.
pub const Y_TRUE: c_char = 1;
/// Flag used to mark a falsy boolean numbers.
pub const Y_FALSE: c_char = 0;
/// Flag used by `YOptions` to determine, that text operations offsets and length will be counted by
/// the byte number of UTF8-encoded string.
pub const Y_OFFSET_BYTES: c_int = 0;
/// Flag used by `YOptions` to determine, that text operations offsets and length will be counted by
/// UTF-16 chars of encoded string.
pub const Y_OFFSET_UTF16: c_int = 1;
/// Flag used by `YOptions` to determine, that text operations offsets and length will be counted by
/// by UTF-32 chars of encoded string.
pub const Y_OFFSET_UTF32: c_int = 2;
/* pub types below are used by cbindgen for c header generation */
/// A Yrs document type. Documents are most important units of collaborative resources management.
/// All shared collections live within a scope of their corresponding documents. All updates are
/// generated on per document basis (rather than individual shared type). All operations on shared
/// collections happen via `YTransaction`, which lifetime is also bound to a document.
///
/// Document manages so called root types, which are top-level shared types definitions (as opposed
/// to recursively nested types).
pub type Doc = yrs::Doc;
/// Transaction is one of the core types in Yrs. All operations that need to touch a document's
/// contents (a.k.a. block store), need to be executed in scope of a transaction.
pub type Transaction = yrs::Transaction;
/// Collection used to store key-value entries in an unordered manner. Keys are always represented
/// as UTF-8 strings. Values can be any value type supported by Yrs: JSON-like primitives as well as
/// shared data types.
///
/// In terms of conflict resolution, `YMap` uses logical last-write-wins principle, meaning the past
/// updates are automatically overridden and discarded by newer ones, while concurrent updates made
/// by different peers are resolved into a single value using document id seniority to establish
/// order.
pub type Map = yrs::Map;
/// A shared data type used for collaborative text editing. It enables multiple users to add and
/// remove chunks of text in efficient manner. This type is internally represented as a mutable
/// double-linked list of text chunks - an optimization occurs during [ytransaction_commit], which
/// allows to squash multiple consecutively inserted characters together as a single chunk of text
/// even between transaction boundaries in order to preserve more efficient memory model.
///
/// `YText` structure internally uses UTF-8 encoding and its length depends on encoding configured
/// on `YDoc` instance (using UTF-8 byte length by default).
///
/// Like all Yrs shared data types, `YText` is resistant to the problem of interleaving (situation
/// when characters inserted one after another may interleave with other peers concurrent inserts
/// after merging all updates together). In case of Yrs conflict resolution is solved by using
/// unique document id to determine correct and consistent ordering.
pub type Text = yrs::Text;
/// A collection used to store data in an indexed sequence structure. This type is internally
/// implemented as a double linked list, which may squash values inserted directly one after another
/// into single list node upon transaction commit.
///
/// Reading a root-level type as an `YArray` means treating its sequence components as a list, where
/// every countable element becomes an individual entity:
///
/// - JSON-like primitives (booleans, numbers, strings, JSON maps, arrays etc.) are counted
/// individually.
/// - Text chunks inserted by `YText` data structure: each character becomes an element of an
/// array.
/// - Embedded and binary values: they count as a single element even though they correspond of
/// multiple bytes.
///
/// Like all Yrs shared data types, `YArray` is resistant to the problem of interleaving (situation
/// when elements inserted one after another may interleave with other peers concurrent inserts
/// after merging all updates together). In case of Yrs conflict resolution is solved by using
/// unique document id to determine correct and consistent ordering.
pub type Array = yrs::Array;
/// XML element data type. It represents an XML node, which can contain key-value attributes
/// (interpreted as strings) as well as other nested XML elements or rich text (represented by
/// `YXmlText` type).
///
/// In terms of conflict resolution, `YXmlElement` uses following rules:
///
/// - Attribute updates use logical last-write-wins principle, meaning the past updates are
/// automatically overridden and discarded by newer ones, while concurrent updates made by
/// different peers are resolved into a single value using document id seniority to establish
/// an order.
/// - Child node insertion uses sequencing rules from other Yrs collections - elements are inserted
/// using interleave-resistant algorithm, where order of concurrent inserts at the same index
/// is established using peer's document id seniority.
pub type XmlElement = yrs::XmlElement;
/// A shared data type used for collaborative text editing, that can be used in a context of
/// `YXmlElement` nodee. It enables multiple users to add and remove chunks of text in efficient
/// manner. This type is internally represented as a mutable double-linked list of text chunks
/// - an optimization occurs during [ytransaction_commit], which allows to squash multiple
/// consecutively inserted characters together as a single chunk of text even between transaction
/// boundaries in order to preserve more efficient memory model.
///
/// Just like `YXmlElement`, `YXmlText` can be marked with extra metadata in form of attributes.
///
/// `YXmlText` structure internally uses UTF-8 encoding and its length depends on encoding
/// configured on `YDoc` instance (using UTF-8 byte length by default).
///
/// Like all Yrs shared data types, `YXmlText` is resistant to the problem of interleaving (situation
/// when characters inserted one after another may interleave with other peers concurrent inserts
/// after merging all updates together). In case of Yrs conflict resolution is solved by using
/// unique document id to determine correct and consistent ordering.
pub type XmlText = yrs::XmlText;
/// Iterator structure used by shared array data type.
pub type ArrayIter = yrs::types::array::ArrayIter<'static>;
/// Iterator structure used by shared map data type. Map iterators are unordered - there's no
/// specific order in which map entries will be returned during consecutive iterator calls.
pub type MapIter = yrs::types::map::MapIter<'static>;
/// Iterator structure used by XML nodes (elements and text) to iterate over node's attributes.
/// Attribute iterators are unordered - there's no specific order in which map entries will be
/// returned during consecutive iterator calls.
pub type Attributes = yrs::types::xml::Attributes<'static>;
/// Iterator used to traverse over the complex nested tree structure of a XML node. XML node
/// iterator walks only over `YXmlElement` and `YXmlText` nodes. It does so in ordered manner (using
/// the order in which children are ordered within their parent nodes) and using **depth-first**
/// traverse.
pub type TreeWalker = yrs::types::xml::TreeWalker<'static>;
/// Subscription handle returned by observe functions. It can be released via `yobserver_destroy`
/// function in order to cancel subscribed callback.
pub type Observer = yrs::types::Observer;
/// A structure representing single key-value entry of a map output (used by either
/// embedded JSON-like maps or YMaps).
#[repr(C)]
pub struct YMapEntry {
/// Null-terminated string representing an entry's key component. Encoded as UTF-8.
pub key: *const c_char,
/// A `YOutput` value representing containing variadic content that can be stored withing map's
/// entry.
pub value: YOutput,
}
impl YMapEntry {
fn new(key: &str, value: Value) -> Self {
let value = YOutput::from(value);
YMapEntry {
key: CString::new(key).unwrap().into_raw(),
value,
}
}
}
impl Drop for YMapEntry {
fn drop(&mut self) {
unsafe {
drop(CString::from_raw(self.key as *mut c_char));
//self.value.drop();
}
}
}
/// A structure representing single attribute of an either `YXmlElement` or `YXmlText` instance.
/// It consists of attribute name and string, both of which are null-terminated UTF-8 strings.
#[repr(C)]
pub struct YXmlAttr {
pub name: *const c_char,
pub value: *const c_char,
}
impl Drop for YXmlAttr {
fn drop(&mut self) {
unsafe {
drop(CString::from_raw(self.name as *mut _));
drop(CString::from_raw(self.value as *mut _));
}
}
}
/// Configuration object used by `YDoc`.
#[repr(C)]
pub struct YOptions {
/// Globally unique 53-bit integer assigned to corresponding document replica as its identifier.
///
/// If two clients share the same `id` and will perform any updates, it will result in
/// unrecoverable document state corruption. The same thing may happen if the client restored
/// document state from snapshot, that didn't contain all of that clients updates that were sent
/// to other peers.
pub id: c_ulong,
/// Encoding used by text editing operations on this document. It's used to compute
/// `YText`/`YXmlText` insertion offsets and text lengths. Either:
///
/// - `Y_ENCODING_BYTES`
/// - `Y_ENCODING_UTF16`
/// - `Y_ENCODING_UTF32`
pub encoding: c_int,
/// Boolean flag used to determine if deleted blocks should be garbage collected or not
/// during the transaction commits. Setting this value to 0 means GC will be performed.
pub skip_gc: c_int,
}
impl Into<Options> for YOptions {
fn into(self) -> Options {
let encoding = match self.encoding {
Y_OFFSET_BYTES => OffsetKind::Bytes,
Y_OFFSET_UTF16 => OffsetKind::Utf16,
Y_OFFSET_UTF32 => OffsetKind::Utf32,
_ => panic!("Unrecognized YOptions.encoding type"),
};
Options {
client_id: self.id as u64 & 0x3fffffffffffff,
skip_gc: if self.skip_gc == 0 { false } else { true },
offset_kind: encoding,
}
}
}
/// Releases all memory-allocated resources bound to given document.
#[no_mangle]
pub unsafe extern "C" fn ydoc_destroy(value: *mut Doc) {
if !value.is_null() {
drop(Box::from_raw(value));
}
}
/// Releases all memory-allocated resources bound to given `YText` instance. It doesn't remove the
/// `YText` stored inside of a document itself, but rather only parts of it related to a specific
/// pointer that's a subject of being destroyed.
#[no_mangle]
pub unsafe extern "C" fn ytext_destroy(value: *mut Text) {
if !value.is_null() {
drop(Box::from_raw(value));
}
}
/// Releases all memory-allocated resources bound to given `YArray` instance. It doesn't remove the
/// `YArray` stored inside of a document itself, but rather only parts of it related to a specific
/// pointer that's a subject of being destroyed.
#[no_mangle]
pub unsafe extern "C" fn yarray_destroy(value: *mut Array) {
if !value.is_null() {
drop(Box::from_raw(value));
}
}
/// Releases all memory-allocated resources bound to given `YMap` instance. It doesn't remove the
/// `YMap` stored inside of a document itself, but rather only parts of it related to a specific
/// pointer that's a subject of being destroyed.
#[no_mangle]
pub unsafe extern "C" fn ymap_destroy(value: *mut Map) {
if !value.is_null() {
drop(Box::from_raw(value));
}
}
/// Releases all memory-allocated resources bound to given `YXmlElement` instance. It doesn't remove
/// the `YXmlElement` stored inside of a document itself, but rather only parts of it related to
/// a specific pointer that's a subject of being destroyed.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_destroy(value: *mut XmlElement) {
if !value.is_null() {
drop(Box::from_raw(value));
}
}
/// Releases all memory-allocated resources bound to given `YXmlText` instance. It doesn't remove
/// the `YXmlText` stored inside of a document itself, but rather only parts of it related to
/// a specific pointer that's a subject of being destroyed.
#[no_mangle]
pub unsafe extern "C" fn yxmltext_destroy(value: *mut XmlText) {
if !value.is_null() {
drop(Box::from_raw(value));
}
}
/// Frees all memory-allocated resources bound to a given [YMapEntry].
#[no_mangle]
pub unsafe extern "C" fn ymap_entry_destroy(value: *mut YMapEntry) {
if !value.is_null() {
drop(Box::from_raw(value));
}
}
/// Frees all memory-allocated resources bound to a given [YXmlAttr].
#[no_mangle]
pub unsafe extern "C" fn yxmlattr_destroy(attr: *mut YXmlAttr) {
if !attr.is_null() {
drop(Box::from_raw(attr));
}
}
/// Frees all memory-allocated resources bound to a given UTF-8 null-terminated string returned from
/// Yrs document API. Yrs strings don't use libc malloc, so calling `free()` on them will fault.
#[no_mangle]
pub unsafe extern "C" fn ystring_destroy(str: *mut c_char) {
if !str.is_null() {
drop(CString::from_raw(str));
}
}
/// Frees all memory-allocated resources bound to a given binary returned from Yrs document API.
/// Unlike strings binaries are not null-terminated and can contain null characters inside,
/// therefore a size of memory to be released must be explicitly provided.
/// Yrs binaries don't use libc malloc, so calling `free()` on them will fault.
#[no_mangle]
pub unsafe extern "C" fn ybinary_destroy(ptr: *mut c_uchar, len: c_int) {
if !ptr.is_null() {
drop(Vec::from_raw_parts(ptr, len as usize, len as usize));
}
}
/// Creates a new [Doc] instance with a randomized unique client identifier.
///
/// Use [ydoc_destroy] in order to release created [Doc] resources.
#[no_mangle]
pub extern "C" fn ydoc_new() -> *mut Doc {
Box::into_raw(Box::new(Doc::new()))
}
/// Creates a new [Doc] instance with a specified `options`.
///
/// Use [ydoc_destroy] in order to release created [Doc] resources.
#[no_mangle]
pub extern "C" fn ydoc_new_with_options(options: YOptions) -> *mut Doc {
Box::into_raw(Box::new(Doc::with_options(options.into())))
}
/// Returns a unique client identifier of this [Doc] instance.
#[no_mangle]
pub unsafe extern "C" fn ydoc_id(doc: *mut Doc) -> c_ulong {
let doc = doc.as_ref().unwrap();
doc.client_id as c_ulong
}
/// Starts a new read-write transaction on a given document. All other operations happen in context
/// of a transaction. Yrs transactions do not follow ACID rules. Once a set of operations is
/// complete, a transaction can be finished using [ytransaction_commit] function.
#[no_mangle]
pub unsafe extern "C" fn ytransaction_new(doc: *mut Doc) -> *mut Transaction {
assert!(!doc.is_null());
let doc = doc.as_mut().unwrap();
Box::into_raw(Box::new(doc.transact()))
}
/// Commit and dispose provided transaction. This operation releases allocated resources, triggers
/// update events and performs a storage compression over all operations executed in scope of
/// current transaction.
#[no_mangle]
pub unsafe extern "C" fn ytransaction_commit(txn: *mut Transaction) {
assert!(!txn.is_null());
drop(Box::from_raw(txn)); // transaction is auto-committed when dropped
}
/// Gets or creates a new shared `YText` data type instance as a root-level type of a given document.
/// This structure can later be accessed using its `name`, which must be a null-terminated UTF-8
/// compatible string.
///
/// Use [ytext_destroy] in order to release pointer returned that way - keep in mind that this will
/// not remove `YText` instance from the document itself (once created it'll last for the entire
/// lifecycle of a document).
#[no_mangle]
pub unsafe extern "C" fn ytext(txn: *mut Transaction, name: *const c_char) -> *mut Text {
assert!(!txn.is_null());
assert!(!name.is_null());
let name = CStr::from_ptr(name).to_str().unwrap();
let value = txn.as_mut().unwrap().get_text(name);
Box::into_raw(Box::new(value))
}
/// Gets or creates a new shared `YArray` data type instance as a root-level type of a given document.
/// This structure can later be accessed using its `name`, which must be a null-terminated UTF-8
/// compatible string.
///
/// Use [yarray_destroy] in order to release pointer returned that way - keep in mind that this will
/// not remove `YArray` instance from the document itself (once created it'll last for the entire
/// lifecycle of a document).
#[no_mangle]
pub unsafe extern "C" fn yarray(txn: *mut Transaction, name: *const c_char) -> *mut Array {
assert!(!txn.is_null());
assert!(!name.is_null());
let name = CStr::from_ptr(name).to_str().unwrap();
let value = txn.as_mut().unwrap().get_array(name);
Box::into_raw(Box::new(value))
}
/// Gets or creates a new shared `YMap` data type instance as a root-level type of a given document.
/// This structure can later be accessed using its `name`, which must be a null-terminated UTF-8
/// compatible string.
///
/// Use [ymap_destroy] in order to release pointer returned that way - keep in mind that this will
/// not remove `YMap` instance from the document itself (once created it'll last for the entire
/// lifecycle of a document).
#[no_mangle]
pub unsafe extern "C" fn ymap(txn: *mut Transaction, name: *const c_char) -> *mut Map {
assert!(!txn.is_null());
assert!(!name.is_null());
let name = CStr::from_ptr(name).to_str().unwrap();
let value = txn.as_mut().unwrap().get_map(name);
Box::into_raw(Box::new(value))
}
/// Gets or creates a new shared `YXmlElement` data type instance as a root-level type of a given
/// document. This structure can later be accessed using its `name`, which must be a null-terminated
/// UTF-8 compatible string.
///
/// Use [yxmlelem_destroy] in order to release pointer returned that way - keep in mind that this
/// will not remove `YXmlElement` instance from the document itself (once created it'll last for
/// the entire lifecycle of a document).
#[no_mangle]
pub unsafe extern "C" fn yxmlelem(txn: *mut Transaction, name: *const c_char) -> *mut XmlElement {
assert!(!txn.is_null());
assert!(!name.is_null());
let name = CStr::from_ptr(name).to_str().unwrap();
let value = txn.as_mut().unwrap().get_xml_element(name);
Box::into_raw(Box::new(value))
}
/// Gets or creates a new shared `YXmlText` data type instance as a root-level type of a given
/// document. This structure can later be accessed using its `name`, which must be a null-terminated
/// UTF-8 compatible string.
///
/// Use [yxmltext_destroy] in order to release pointer returned that way - keep in mind that this
/// will not remove `YXmlText` instance from the document itself (once created it'll last for
/// the entire lifecycle of a document).
#[no_mangle]
pub unsafe extern "C" fn yxmltext(txn: *mut Transaction, name: *const c_char) -> *mut XmlText {
assert!(!txn.is_null());
assert!(!name.is_null());
let name = CStr::from_ptr(name).to_str().unwrap();
let value = txn.as_mut().unwrap().get_xml_text(name);
Box::into_raw(Box::new(value))
}
/// Returns a state vector of a current transaction's document, serialized using lib0 version 1
/// encoding. Payload created by this function can then be send over the network to a remote peer,
/// where it can be used as a parameter of [ytransaction_state_diff_v1] in order to produce a delta
/// update payload, that can be send back and applied locally in order to efficiently propagate
/// updates from one peer to another.
///
/// The length of a generated binary will be passed within a `len` out parameter.
///
/// Once no longer needed, a returned binary can be disposed using [ybinary_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn ytransaction_state_vector_v1(
txn: *const Transaction,
len: *mut c_int,
) -> *mut c_uchar {
assert!(!txn.is_null());
let state_vector = txn.as_ref().unwrap().state_vector();
let binary = state_vector.encode_v1().into_boxed_slice();
*len = binary.len() as c_int;
Box::into_raw(binary) as *mut c_uchar
}
/// Returns a delta difference between current state of a transaction's document and a state vector
/// `sv` encoded as a binary payload using lib0 version 1 encoding (which could be generated using
/// [ytransaction_state_vector_v1]). Such delta can be send back to the state vector's sender in
/// order to propagate and apply (using [ytransaction_apply]) all updates known to a current
/// document, which remote peer was not aware of.
///
/// If passed `sv` pointer is null, the generated diff will be a snapshot containing entire state of
/// the document.
///
/// A length of an encoded state vector payload must be passed as `sv_len` parameter.
///
/// A length of generated delta diff binary will be passed within a `len` out parameter.
///
/// Once no longer needed, a returned binary can be disposed using [ybinary_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn ytransaction_state_diff_v1(
txn: *const Transaction,
sv: *const c_uchar,
sv_len: c_int,
len: *mut c_int,
) -> *mut c_uchar {
assert!(!txn.is_null());
let sv = {
if sv.is_null() {
StateVector::default()
} else {
let sv_slice = std::slice::from_raw_parts(sv as *const u8, sv_len as usize);
StateVector::decode_v1(sv_slice)
}
};
let mut encoder = EncoderV1::new();
txn.as_ref().unwrap().encode_diff(&sv, &mut encoder);
let binary = encoder.to_vec().into_boxed_slice();
*len = binary.len() as c_int;
Box::into_raw(binary) as *mut c_uchar
}
/// Applies an diff update (generated by [ytransaction_state_diff_v1]) to a local transaction's
/// document.
///
/// A length of generated `diff` binary must be passed within a `diff_len` out parameter.
#[no_mangle]
pub unsafe extern "C" fn ytransaction_apply(
txn: *mut Transaction,
diff: *const c_uchar,
diff_len: c_int,
) {
assert!(!txn.is_null());
assert!(!diff.is_null());
let update = std::slice::from_raw_parts(diff as *const u8, diff_len as usize);
let mut decoder = DecoderV1::from(update);
let update = Update::decode(&mut decoder);
txn.as_mut().unwrap().apply_update(update)
}
/// Returns the length of the `YText` string content in bytes (without the null terminator character)
#[no_mangle]
pub unsafe extern "C" fn ytext_len(txt: *const Text) -> c_int {
assert!(!txt.is_null());
txt.as_ref().unwrap().len() as c_int
}
/// Returns a null-terminated UTF-8 encoded string content of a current `YText` shared data type.
///
/// Generated string resources should be released using [ystring_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn ytext_string(txt: *const Text, txn: *const Transaction) -> *mut c_char {
assert!(!txt.is_null());
assert!(!txn.is_null());
let txn = txn.as_ref().unwrap();
let str = txt.as_ref().unwrap().to_string(txn);
CString::new(str).unwrap().into_raw()
}
/// Inserts a null-terminated UTF-8 encoded string a a given `index`. `index` value must be between
/// 0 and a length of a `YText` (inclusive, accordingly to [ytext_len] return value), otherwise this
/// function will panic.
///
/// A `str` parameter must be a null-terminated UTF-8 encoded string. This function doesn't take
/// ownership over a passed value - it will be copied and therefore a string parameter must be
/// released by the caller.
#[no_mangle]
pub unsafe extern "C" fn ytext_insert(
txt: *const Text,
txn: *mut Transaction,
index: c_int,
value: *const c_char,
) {
assert!(!txt.is_null());
assert!(!txn.is_null());
assert!(!value.is_null());
let chunk = CStr::from_ptr(value).to_str().unwrap();
let txn = txn.as_mut().unwrap();
let txt = txt.as_ref().unwrap();
txt.insert(txn, index as u32, chunk)
}
/// Removes a range of characters, starting a a given `index`. This range must fit within the bounds
/// of a current `YText`, otherwise this function call will fail.
///
/// An `index` value must be between 0 and the length of a `YText` (exclusive, accordingly to
/// [ytext_len] return value).
///
/// A `length` must be lower or equal number of characters (counted as UTF chars depending on the
/// encoding configured by `YDoc`) from `index` position to the end of of the string.
#[no_mangle]
pub unsafe extern "C" fn ytext_remove_range(
txt: *const Text,
txn: *mut Transaction,
index: c_int,
length: c_int,
) {
assert!(!txt.is_null());
assert!(!txn.is_null());
let txn = txn.as_mut().unwrap();
let txt = txt.as_ref().unwrap();
txt.remove_range(txn, index as u32, length as u32)
}
/// Returns a number of elements stored within current instance of `YArray`.
#[no_mangle]
pub unsafe extern "C" fn yarray_len(array: *const Array) -> c_int {
assert!(!array.is_null());
let array = array.as_ref().unwrap();
array.len() as c_int
}
/// Returns a pointer to a `YOutput` value stored at a given `index` of a current `YArray`.
/// If `index` is outside of the bounds of an array, a null pointer will be returned.
///
/// A value returned should be eventually released using [youtput_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn yarray_get(
array: *const Array,
txn: *mut Transaction,
index: c_int,
) -> *mut YOutput {
assert!(!array.is_null());
assert!(!txn.is_null());
let array = array.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
if let Some(val) = array.get(txn, index as u32) {
Box::into_raw(Box::new(YOutput::from(val)))
} else {
std::ptr::null_mut()
}
}
/// Inserts a range of `items` into current `YArray`, starting at given `index`. An `items_len`
/// parameter is used to determine the size of `items` array - it can also be used to insert
/// a single element given its pointer.
///
/// An `index` value must be between 0 and (inclusive) length of a current array (use [yarray_len]
/// to determine its length), otherwise it will panic at runtime.
///
/// `YArray` doesn't take ownership over the inserted `items` data - their contents are being copied
/// into array structure - therefore caller is responsible for freeing all memory associated with
/// input params.
#[no_mangle]
pub unsafe extern "C" fn yarray_insert_range(
array: *const Array,
txn: *mut Transaction,
index: c_int,
items: *const YInput,
items_len: c_int,
) {
assert!(!array.is_null());
assert!(!txn.is_null());
assert!(!items.is_null());
let arr = array.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
let ptr = items;
let mut i = 0;
let mut j = index as u32;
let len = items_len as isize;
while i < len {
let mut vec: Vec<Any> = Vec::default();
// try read as many values a JSON-like primitives and insert them at once
while i < len {
let val = ptr.offset(i).read();
if val.tag <= 0 {
let any = val.into();
vec.push(any);
} else {
break;
}
i += 1;
}
if !vec.is_empty() {
let len = vec.len() as u32;
arr.insert_range(txn, j, vec);
j += len;
} else {
let val = ptr.offset(i).read();
arr.insert(txn, j, val);
i += 1;
j += 1;
}
}
}
/// Removes a `len` of consecutive range of elements from current `array` instance, starting at
/// a given `index`. Range determined by `index` and `len` must fit into boundaries of an array,
/// otherwise it will panic at runtime.
#[no_mangle]
pub unsafe extern "C" fn yarray_remove_range(
array: *const Array,
txn: *mut Transaction,
index: c_int,
len: c_int,
) {
assert!(!array.is_null());
assert!(!txn.is_null());
let array = array.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
array.remove_range(txn, index as u32, len as u32)
}
/// Returns an iterator, which can be used to traverse over all elements of an `array` (`array`'s
/// length can be determined using [yarray_len] function).
///
/// Use [yarray_iter_next] function in order to retrieve a consecutive array elements.
/// Use [yarray_iter_destroy] function in order to close the iterator and release its resources.
#[no_mangle]
pub unsafe extern "C" fn yarray_iter(
array: *const Array,
txn: *const Transaction,
) -> *mut ArrayIter {
assert!(!array.is_null());
assert!(!txn.is_null());
let array = array.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
Box::into_raw(Box::new(array.iter(txn)))
}
/// Releases all of an `YArray` iterator resources created by calling [yarray_iter].
#[no_mangle]
pub unsafe extern "C" fn yarray_iter_destroy(iter: *mut ArrayIter) {
if !iter.is_null() {
drop(Box::from_raw(iter))
}
}
/// Moves current `YArray` iterator over to a next element, returning a pointer to it. If an iterator
/// comes to an end of an array, a null pointer will be returned.
///
/// Returned values should be eventually released using [youtput_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn yarray_iter_next(iterator: *mut ArrayIter) -> *mut YOutput {
assert!(!iterator.is_null());
let iter = iterator.as_mut().unwrap();
if let Some(v) = iter.next() {
Box::into_raw(Box::new(YOutput::from(v)))
} else {
std::ptr::null_mut()
}
}
/// Returns an iterator, which can be used to traverse over all key-value pairs of a `map`.
///
/// Use [ymap_iter_next] function in order to retrieve a consecutive (**unordered**) map entries.
/// Use [ymap_iter_destroy] function in order to close the iterator and release its resources.
#[no_mangle]
pub unsafe extern "C" fn ymap_iter(map: *const Map, txn: *const Transaction) -> *mut MapIter {
assert!(!map.is_null());
assert!(!txn.is_null());
let map = map.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
Box::into_raw(Box::new(map.iter(txn)))
}
/// Releases all of an `YMap` iterator resources created by calling [ymap_iter].
#[no_mangle]
pub unsafe extern "C" fn ymap_iter_destroy(iter: *mut MapIter) {
if !iter.is_null() {
drop(Box::from_raw(iter))
}
}
/// Moves current `YMap` iterator over to a next entry, returning a pointer to it. If an iterator
/// comes to an end of a map, a null pointer will be returned. Yrs maps are unordered and so are
/// their iterators.
///
/// Returned values should be eventually released using [ymap_entry_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn ymap_iter_next(iter: *mut MapIter) -> *mut YMapEntry {
assert!(!iter.is_null());
let iter = iter.as_mut().unwrap();
if let Some((key, value)) = iter.next() {
Box::into_raw(Box::new(YMapEntry::new(key, value)))
} else {
std::ptr::null_mut()
}
}
/// Returns a number of entries stored within a `map`.
#[no_mangle]
pub unsafe extern "C" fn ymap_len(map: *const Map, txn: *const Transaction) -> c_int {
assert!(!map.is_null());
assert!(!txn.is_null());
let map = map.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
map.len(txn) as c_int
}
/// Inserts a new entry (specified as `key`-`value` pair) into a current `map`. If entry under such
/// given `key` already existed, its corresponding value will be replaced.
///
/// A `key` must be a null-terminated UTF-8 encoded string, which contents will be copied into
/// a `map` (therefore it must be freed by the function caller).
///
/// A `value` content is being copied into a `map`, therefore any of its content must be freed by
/// the function caller.
#[no_mangle]
pub unsafe extern "C" fn ymap_insert(
map: *const Map,
txn: *mut Transaction,
key: *const c_char,
value: *const YInput,
) {
assert!(!map.is_null());
assert!(!txn.is_null());
assert!(!key.is_null());
assert!(!value.is_null());
let cstr = CStr::from_ptr(key);
let key = cstr.to_str().unwrap().to_string();
let map = map.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
map.insert(txn, key, value.read());
}
/// Removes a `map` entry, given its `key`. Returns `1` if the corresponding entry was successfully
/// removed or `0` if no entry with a provided `key` has been found inside of a `map`.
///
/// A `key` must be a null-terminated UTF-8 encoded string.
#[no_mangle]
pub unsafe extern "C" fn ymap_remove(
map: *const Map,
txn: *mut Transaction,
key: *const c_char,
) -> c_char {
assert!(!map.is_null());
assert!(!txn.is_null());
assert!(!key.is_null());
let key = CStr::from_ptr(key).to_str().unwrap();
let map = map.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
if let Some(_) = map.remove(txn, key) {
Y_TRUE
} else {
Y_FALSE
}
}
/// Returns a value stored under the provided `key`, or a null pointer if no entry with such `key`
/// has been found in a current `map`. A returned value is allocated by this function and therefore
/// should be eventually released using [youtput_destroy] function.
///
/// A `key` must be a null-terminated UTF-8 encoded string.
#[no_mangle]
pub unsafe extern "C" fn ymap_get(
map: *const Map,
txn: *const Transaction,
key: *const c_char,
) -> *mut YOutput {
assert!(!map.is_null());
assert!(!txn.is_null());
assert!(!key.is_null());
let key = CStr::from_ptr(key).to_str().unwrap();
let map = map.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
if let Some(value) = map.get(txn, key) {
Box::into_raw(Box::new(YOutput::from(value)))
} else {
std::ptr::null_mut()
}
}
/// Removes all entries from a current `map`.
#[no_mangle]
pub unsafe extern "C" fn ymap_remove_all(map: *const Map, txn: *mut Transaction) {
assert!(!map.is_null());
assert!(!txn.is_null());
let map = map.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
map.clear(txn);
}
/// Return a name (or an XML tag) of a current `YXmlElement`. Root-level XML nodes use "UNDEFINED" as
/// their tag names.
///
/// Returned value is a null-terminated UTF-8 string, which must be released using [ystring_destroy]
/// function.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_tag(xml: *const XmlElement) -> *mut c_char {
assert!(!xml.is_null());
let xml = xml.as_ref().unwrap();
let tag = xml.tag();
CString::new(tag).unwrap().into_raw()
}
/// Converts current `YXmlElement` together with its children and attributes into a flat string
/// representation (no padding) eg. `<UNDEFINED><title key="value">sample text</title></UNDEFINED>`.
///
/// Returned value is a null-terminated UTF-8 string, which must be released using [ystring_destroy]
/// function.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_string(
xml: *const XmlElement,
txn: *const Transaction,
) -> *mut c_char {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
let str = xml.to_string(txn);
CString::new(str).unwrap().into_raw()
}
/// Inserts an XML attribute described using `attr_name` and `attr_value`. If another attribute with
/// the same name already existed, its value will be replaced with a provided one.
///
/// Both `attr_name` and `attr_value` must be a null-terminated UTF-8 encoded strings. Their
/// contents are being copied, therefore it's up to a function caller to properly release them.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_insert_attr(
xml: *const XmlElement,
txn: *mut Transaction,
attr_name: *const c_char,
attr_value: *const c_char,
) {
assert!(!xml.is_null());
assert!(!txn.is_null());
assert!(!attr_name.is_null());
assert!(!attr_value.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
let key = CStr::from_ptr(attr_name).to_str().unwrap();
let value = CStr::from_ptr(attr_value).to_str().unwrap();
xml.insert_attribute(txn, key, value);
}
/// Removes an attribute from a current `YXmlElement`, given its name.
///
/// An `attr_name`must be a null-terminated UTF-8 encoded string.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_remove_attr(
xml: *const XmlElement,
txn: *mut Transaction,
attr_name: *const c_char,
) {
assert!(!xml.is_null());
assert!(!txn.is_null());
assert!(!attr_name.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
let key = CStr::from_ptr(attr_name).to_str().unwrap();
xml.remove_attribute(txn, &key);
}
/// Returns the value of a current `YXmlElement`, given its name, or a null pointer if not attribute
/// with such name has been found. Returned pointer is a null-terminated UTF-8 encoded string, which
/// should be released using [ystring_destroy] function.
///
/// An `attr_name` must be a null-terminated UTF-8 encoded string.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_get_attr(
xml: *const XmlElement,
txn: *const Transaction,
attr_name: *const c_char,
) -> *mut c_char {
assert!(!xml.is_null());
assert!(!txn.is_null());
assert!(!attr_name.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
let key = CStr::from_ptr(attr_name).to_str().unwrap();
if let Some(value) = xml.get_attribute(txn, key) {
CString::new(value).unwrap().into_raw()
} else {
std::ptr::null_mut()
}
}
/// Returns an iterator over the `YXmlElement` attributes.
///
/// Use [yxmlattr_iter_next] function in order to retrieve a consecutive (**unordered**) attributes.
/// Use [yxmlattr_iter_destroy] function in order to close the iterator and release its resources.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_attr_iter(
xml: *const XmlElement,
txn: *const Transaction,
) -> *mut Attributes {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
Box::into_raw(Box::new(xml.attributes(txn)))
}
/// Returns an iterator over the `YXmlText` attributes.
///
/// Use [yxmlattr_iter_next] function in order to retrieve a consecutive (**unordered**) attributes.
/// Use [yxmlattr_iter_destroy] function in order to close the iterator and release its resources.
#[no_mangle]
pub unsafe extern "C" fn yxmltext_attr_iter(
xml: *const XmlText,
txn: *const Transaction,
) -> *mut Attributes {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
Box::into_raw(Box::new(xml.attributes(txn)))
}
/// Releases all of attributes iterator resources created by calling [yxmlelem_attr_iter]
/// or [yxmltext_attr_iter].
#[no_mangle]
pub unsafe extern "C" fn yxmlattr_iter_destroy(iterator: *mut Attributes) {
if !iterator.is_null() {
drop(Box::from_raw(iterator))
}
}
/// Returns a next XML attribute from an `iterator`. Attributes are returned in an unordered
/// manner. Once `iterator` reaches the end of attributes collection, a null pointer will be
/// returned.
///
/// Returned value should be eventually released using [yxmlattr_destroy].
#[no_mangle]
pub unsafe extern "C" fn yxmlattr_iter_next(iterator: *mut Attributes) -> *mut YXmlAttr {
assert!(!iterator.is_null());
let iter = iterator.as_mut().unwrap();
if let Some((name, value)) = iter.next() {
Box::into_raw(Box::new(YXmlAttr {
name: CString::new(name).unwrap().into_raw(),
value: CString::new(value).unwrap().into_raw(),
}))
} else {
std::ptr::null_mut()
}
}
/// Returns a next sibling of a current `YXmlElement`, which can be either another `YXmlElement`
/// or a `YXmlText`. Together with [yxmlelem_first_child] it may be used to iterate over the direct
/// children of an XML node (in order to iterate over the nested XML structure use
/// [yxmlelem_tree_walker]).
///
/// If current `YXmlElement` is the last child, this function returns a null pointer.
/// A returned value should be eventually released using [youtput_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_next_sibling(
xml: *const XmlElement,
txn: *const Transaction,
) -> *mut YOutput {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
if let Some(next) = xml.next_sibling(txn) {
match next {
Xml::Element(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlElement(v)))),
Xml::Text(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlText(v)))),
}
} else {
std::ptr::null_mut()
}
}
/// Returns a previous sibling of a current `YXmlElement`, which can be either another `YXmlElement`
/// or a `YXmlText`.
///
/// If current `YXmlElement` is the first child, this function returns a null pointer.
/// A returned value should be eventually released using [youtput_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_prev_sibling(
xml: *const XmlElement,
txn: *const Transaction,
) -> *mut YOutput {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
if let Some(next) = xml.prev_sibling(txn) {
match next {
Xml::Element(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlElement(v)))),
Xml::Text(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlText(v)))),
}
} else {
std::ptr::null_mut()
}
}
/// Returns a next sibling of a current `YXmlText`, which can be either another `YXmlText` or
/// an `YXmlElement`. Together with [yxmlelem_first_child] it may be used to iterate over the direct
/// children of an XML node (in order to iterate over the nested XML structure use
/// [yxmlelem_tree_walker]).
///
/// If current `YXmlText` is the last child, this function returns a null pointer.
/// A returned value should be eventually released using [youtput_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn yxmltext_next_sibling(
xml: *const XmlText,
txn: *const Transaction,
) -> *mut YOutput {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
if let Some(next) = xml.next_sibling(txn) {
match next {
Xml::Element(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlElement(v)))),
Xml::Text(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlText(v)))),
}
} else {
std::ptr::null_mut()
}
}
/// Returns a previous sibling of a current `YXmlText`, which can be either another `YXmlText` or
/// an `YXmlElement`.
///
/// If current `YXmlText` is the first child, this function returns a null pointer.
/// A returned value should be eventually released using [youtput_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn yxmltext_prev_sibling(
xml: *const XmlText,
txn: *const Transaction,
) -> *mut YOutput {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
if let Some(next) = xml.prev_sibling(txn) {
match next {
Xml::Element(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlElement(v)))),
Xml::Text(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlText(v)))),
}
} else {
std::ptr::null_mut()
}
}
/// Returns a parent `YXmlElement` of a current node, or null pointer when current `YXmlElement` is
/// a root-level shared data type.
///
/// A returned value should be eventually released using [youtput_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_parent(
xml: *const XmlElement,
txn: *const Transaction,
) -> *mut XmlElement {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
if let Some(parent) = xml.parent(txn) {
Box::into_raw(Box::new(parent))
} else {
std::ptr::null_mut()
}
}
/// Returns a number of child nodes (both `YXmlElement` and `YXmlText`) living under a current XML
/// element. This function doesn't count a recursive nodes, only direct children of a current node.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_child_len(
xml: *const XmlElement,
txn: *const Transaction,
) -> c_int {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
xml.len(txn) as c_int
}
/// Returns a first child node of a current `YXmlElement`, or null pointer if current XML node is
/// empty. Returned value could be either another `YXmlElement` or `YXmlText`.
///
/// A returned value should be eventually released using [youtput_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_first_child(
xml: *const XmlElement,
txn: *const Transaction,
) -> *mut YOutput {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
if let Some(value) = xml.first_child(txn) {
match value {
Xml::Element(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlElement(v)))),
Xml::Text(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlText(v)))),
}
} else {
std::ptr::null_mut()
}
}
/// Returns an iterator over a nested recursive structure of a current `YXmlElement`, starting from
/// first of its children. Returned values can be either `YXmlElement` or `YXmlText` nodes.
///
/// Use [yxmlelem_tree_walker_next] function in order to iterate over to a next node.
/// Use [yxmlelem_tree_walker_destroy] function to release resources used by the iterator.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_tree_walker(
xml: *const XmlElement,
txn: *const Transaction,
) -> *mut TreeWalker {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
Box::into_raw(Box::new(xml.successors(txn)))
}
/// Releases resources associated with a current XML tree walker iterator.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_tree_walker_destroy(iter: *mut TreeWalker) {
if !iter.is_null() {
drop(Box::from_raw(iter))
}
}
/// Moves current `iterator` to a next value (either `YXmlElement` or `YXmlText`), returning its
/// pointer or a null, if an `iterator` already reached the last successor node.
///
/// Values returned by this function should be eventually released using [youtput_destroy].
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_tree_walker_next(iterator: *mut TreeWalker) -> *mut YOutput {
assert!(!iterator.is_null());
let iter = iterator.as_mut().unwrap();
if let Some(next) = iter.next() {
match next {
Xml::Element(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlElement(v)))),
Xml::Text(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlText(v)))),
}
} else {
std::ptr::null_mut()
}
}
/// Inserts an `YXmlElement` as a child of a current node at the given `index` and returns its
/// pointer. Node created this way will have a given `name` as its tag (eg. `p` for `<p></p>` node).
///
/// An `index` value must be between 0 and (inclusive) length of a current XML element (use
/// [yxmlelem_child_len] function to determine its length).
///
/// A `name` must be a null-terminated UTF-8 encoded string, which will be copied into current
/// document. Therefore `name` should be freed by the function caller.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_insert_elem(
xml: *const XmlElement,
txn: *mut Transaction,
index: c_int,
name: *const c_char,
) -> *mut XmlElement {
assert!(!xml.is_null());
assert!(!txn.is_null());
assert!(!name.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
let name = CStr::from_ptr(name).to_str().unwrap();
let child = xml.insert_elem(txn, index as u32, name);
Box::into_raw(Box::new(child))
}
/// Inserts an `YXmlText` as a child of a current node at the given `index` and returns its
/// pointer.
///
/// An `index` value must be between 0 and (inclusive) length of a current XML element (use
/// [yxmlelem_child_len] function to determine its length).
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_insert_text(
xml: *const XmlElement,
txn: *mut Transaction,
index: c_int,
) -> *mut XmlText {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
let child = xml.insert_text(txn, index as u32);
Box::into_raw(Box::new(child))
}
/// Removes a consecutive range of child elements (of specified length) from the current
/// `YXmlElement`, starting at the given `index`. Specified range must fit into boundaries of current
/// XML node children, otherwise this function will panic at runtime.
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_remove_range(
xml: *const XmlElement,
txn: *mut Transaction,
index: c_int,
len: c_int,
) {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
xml.remove_range(txn, index as u32, len as u32)
}
/// Returns an XML child node (either a `YXmlElement` or `YXmlText`) stored at a given `index` of
/// a current `YXmlElement`. Returns null pointer if `index` was outside of the bound of current XML
/// node children.
///
/// Returned value should be eventually released using [youtput_destroy].
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_get(
xml: *const XmlElement,
txn: *const Transaction,
index: c_int,
) -> *const YOutput {
assert!(!xml.is_null());
assert!(!txn.is_null());
let xml = xml.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
if let Some(child) = xml.get(txn, index as u32) {
match child {
Xml::Element(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlElement(v)))),
Xml::Text(v) => Box::into_raw(Box::new(YOutput::from(Value::YXmlText(v)))),
}
} else {
std::ptr::null()
}
}
/// Returns the length of the `YXmlText` string content in bytes (without the null terminator
/// character)
#[no_mangle]
pub unsafe extern "C" fn yxmltext_len(txt: *const XmlText, txn: *const Transaction) -> c_int {
assert!(!txt.is_null());
assert!(!txn.is_null());
let txt = txt.as_ref().unwrap();
txt.len() as c_int
}
/// Returns a null-terminated UTF-8 encoded string content of a current `YXmlText` shared data type.
///
/// Generated string resources should be released using [ystring_destroy] function.
#[no_mangle]
pub unsafe extern "C" fn yxmltext_string(
txt: *const XmlText,
txn: *const Transaction,
) -> *mut c_char {
assert!(!txt.is_null());
assert!(!txn.is_null());
let txt = txt.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
let str = txt.to_string(txn);
CString::new(str).unwrap().into_raw()
}
/// Inserts a null-terminated UTF-8 encoded string a a given `index`. `index` value must be between
/// 0 and a length of a `YXmlText` (inclusive, accordingly to [yxmltext_len] return value), otherwise
/// this function will panic.
///
/// A `str` parameter must be a null-terminated UTF-8 encoded string. This function doesn't take
/// ownership over a passed value - it will be copied and therefore a string parameter must be
/// released by the caller.
#[no_mangle]
pub unsafe extern "C" fn yxmltext_insert(
txt: *const XmlText,
txn: *mut Transaction,
index: c_int,
str: *const c_char,
) {
assert!(!txt.is_null());
assert!(!txn.is_null());
assert!(!str.is_null());
let txt = txt.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
let chunk = CStr::from_ptr(str).to_str().unwrap();
txt.insert(txn, index as u32, chunk)
}
/// Removes a range of characters, starting a a given `index`. This range must fit within the bounds
/// of a current `YXmlText`, otherwise this function call will fail.
///
/// An `index` value must be between 0 and the length of a `YXmlText` (exclusive, accordingly to
/// [yxmltext_len] return value).
///
/// A `length` must be lower or equal number of characters (counted as UTF chars depending on the
/// encoding configured by `YDoc`) from `index` position to the end of of the string.
#[no_mangle]
pub unsafe extern "C" fn yxmltext_remove_range(
txt: *const XmlText,
txn: *mut Transaction,
idx: c_int,
len: c_int,
) {
assert!(!txt.is_null());
assert!(!txn.is_null());
let txt = txt.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
txt.remove_range(txn, idx as u32, len as u32)
}
/// Inserts an XML attribute described using `attr_name` and `attr_value`. If another attribute with
/// the same name already existed, its value will be replaced with a provided one.
///
/// Both `attr_name` and `attr_value` must be a null-terminated UTF-8 encoded strings. Their
/// contents are being copied, therefore it's up to a function caller to properly release them.
#[no_mangle]
pub unsafe extern "C" fn yxmltext_insert_attr(
txt: *const XmlText,
txn: *mut Transaction,
attr_name: *const c_char,
attr_value: *const c_char,
) {
assert!(!txt.is_null());
assert!(!txn.is_null());
assert!(!attr_name.is_null());
assert!(!attr_value.is_null());
let txt = txt.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
let name = CStr::from_ptr(attr_name).to_str().unwrap();
let value = CStr::from_ptr(attr_value).to_str().unwrap();
txt.insert_attribute(txn, name, value)
}
/// Removes an attribute from a current `YXmlText`, given its name.
///
/// An `attr_name`must be a null-terminated UTF-8 encoded string.
#[no_mangle]
pub unsafe extern "C" fn yxmltext_remove_attr(
txt: *const XmlText,
txn: *mut Transaction,
attr_name: *const c_char,
) {
assert!(!txt.is_null());
assert!(!txn.is_null());
assert!(!attr_name.is_null());
let txt = txt.as_ref().unwrap();
let txn = txn.as_mut().unwrap();
let name = CStr::from_ptr(attr_name).to_str().unwrap();
txt.remove_attribute(txn, name)
}
/// Returns the value of a current `YXmlText`, given its name, or a null pointer if not attribute
/// with such name has been found. Returned pointer is a null-terminated UTF-8 encoded string, which
/// should be released using [ystring_destroy] function.
///
/// An `attr_name` must be a null-terminated UTF-8 encoded string.
#[no_mangle]
pub unsafe extern "C" fn yxmltext_get_attr(
txt: *const XmlText,
txn: *const Transaction,
attr_name: *const c_char,
) -> *mut c_char {
assert!(!txt.is_null());
assert!(!txn.is_null());
assert!(!attr_name.is_null());
let txt = txt.as_ref().unwrap();
let txn = txn.as_ref().unwrap();
let name = CStr::from_ptr(attr_name).to_str().unwrap();
if let Some(value) = txt.get_attribute(txn, name) {
CString::new(value).unwrap().into_raw()
} else {
std::ptr::null_mut()
}
}
/// A data structure that is used to pass input values of various types supported by Yrs into a
/// shared document store.
///
/// `YInput` constructor function don't allocate any resources on their own, neither they take
/// ownership by pointers to memory blocks allocated by user - for this reason once an input cell
/// has been used, its content should be freed by the caller.
#[repr(C)]
pub struct YInput {
/// Tag describing, which `value` type is being stored by this input cell. Can be one of:
///
/// - [Y_JSON_BOOL] for boolean flags.
/// - [Y_JSON_NUM] for 64-bit floating point numbers.
/// - [Y_JSON_INT] for 64-bit signed integers.
/// - [Y_JSON_STR] for null-terminated UTF-8 encoded strings.
/// - [Y_JSON_BUF] for embedded binary data.
/// - [Y_JSON_ARR] for arrays of JSON-like values.
/// - [Y_JSON_MAP] for JSON-like objects build from key-value pairs.
/// - [Y_JSON_NULL] for JSON-like null values.
/// - [Y_JSON_UNDEF] for JSON-like undefined values.
/// - [Y_ARRAY] for cells which contents should be used to initialize a `YArray` shared type.
/// - [Y_MAP] for cells which contents should be used to initialize a `YMap` shared type.
pub tag: c_char,
/// Length of the contents stored by current `YInput` cell.
///
/// For [Y_JSON_NULL] and [Y_JSON_UNDEF] its equal to `0`.
///
/// For [Y_JSON_ARR], [Y_JSON_MAP], [Y_ARRAY] and [Y_MAP] it describes a number of passed
/// elements.
///
/// For other types it's always equal to `1`.
pub len: c_int,
/// Union struct which contains a content corresponding to a provided `tag` field.
value: YInputContent,
}
impl YInput {
fn into(self) -> Any {
let tag = self.tag;
unsafe {
if tag == Y_JSON_STR {
let str: Box<str> = CStr::from_ptr(self.value.str).to_str().unwrap().into();
Any::String(str)
} else if tag == Y_JSON_ARR {
let ptr = self.value.values;
let mut dst: Vec<Any> = Vec::with_capacity(self.len as usize);
let mut i = 0;
while i < self.len as isize {
let value = ptr.offset(i).read();
let any = value.into();
dst.push(any);
i += 1;
}
Any::Array(dst.into_boxed_slice())
} else if tag == Y_JSON_MAP {
let mut dst = HashMap::with_capacity(self.len as usize);
let keys = self.value.map.keys;
let values = self.value.map.values;
let mut i = 0;
while i < self.len as isize {
let key = CStr::from_ptr(keys.offset(i).read())
.to_str()
.unwrap()
.to_owned();
let value = values.offset(i).read().into();
dst.insert(key, value);
i += 1;
}
Any::Map(Box::new(dst))
} else if tag == Y_JSON_NULL {
Any::Null
} else if tag == Y_JSON_UNDEF {
Any::Undefined
} else if tag == Y_JSON_INT {
Any::BigInt(self.value.integer as i64)
} else if tag == Y_JSON_NUM {
Any::Number(self.value.num as f64)
} else if tag == Y_JSON_BOOL {
Any::Bool(if self.value.flag == 0 { false } else { true })
} else if tag == Y_JSON_BUF {
let slice =
std::slice::from_raw_parts(self.value.buf as *mut u8, self.len as usize);
let buf = Box::from(slice);
Any::Buffer(buf)
} else {
panic!("Unrecognized YVal value tag.")
}
}
}
}
#[repr(C)]
union YInputContent {
flag: c_char,
num: c_float,
integer: c_long,
str: *mut c_char,
buf: *mut c_uchar,
values: *mut YInput,
map: ManuallyDrop<YMapInputData>,
}
#[repr(C)]
struct YMapInputData {
keys: *mut *mut c_char,
values: *mut YInput,
}
impl Drop for YInput {
fn drop(&mut self) {}
}
impl Prelim for YInput {
fn into_content(
self,
_txn: &mut yrs::Transaction,
ptr: TypePtr,
) -> (ItemContent, Option<Self>) {
unsafe {
if self.tag <= 0 {
let value = self.into();
(ItemContent::Any(vec![value]), None)
} else {
let type_ref = if self.tag == Y_MAP {
TYPE_REFS_MAP
} else if self.tag == Y_ARRAY {
TYPE_REFS_ARRAY
} else if self.tag == Y_XML_ELEM {
TYPE_REFS_XML_ELEMENT
} else if self.tag == Y_XML_TEXT {
TYPE_REFS_XML_TEXT
} else {
panic!("Unrecognized YVal value tag.")
};
let name = if type_ref == TYPE_REFS_XML_ELEMENT {
let name = CStr::from_ptr(self.value.str).to_str().unwrap().to_owned();
Some(name)
} else {
None
};
let inner = BranchRef::new(Branch::new(ptr, type_ref, name));
(ItemContent::Type(inner), Some(self))
}
}
}
fn integrate(self, txn: &mut yrs::Transaction, inner_ref: BranchRef) {
unsafe {
if self.tag == Y_MAP {
let map = Map::from(inner_ref);
let keys = self.value.map.keys;
let values = self.value.map.values;
let i = 0;
while i < self.len as isize {
let key = CStr::from_ptr(keys.offset(i).read())
.to_str()
.unwrap()
.to_owned();
let value = values.offset(i).read().into();
map.insert(txn, key, value);
}
} else if self.tag == Y_ARRAY {
let array = Array::from(inner_ref);
let ptr = self.value.values;
let len = self.len as isize;
let mut i = 0;
while i < len {
let value = ptr.offset(i).read();
array.push_back(txn, value);
i += 1;
}
} else if self.tag == Y_TEXT {
let text = Text::from(inner_ref);
let init = CStr::from_ptr(self.value.str).to_str().unwrap();
text.push(txn, init);
} else if self.tag == Y_XML_TEXT {
let text = XmlText::from(inner_ref);
let init = CStr::from_ptr(self.value.str).to_str().unwrap();
text.push(txn, init);
};
}
}
}
/// An output value cell returned from yrs API methods. It describes a various types of data
/// supported by yrs shared data types.
///
/// Since `YOutput` instances are always created by calling the corresponding yrs API functions,
/// they eventually should be deallocated using [youtput_destroy] function.
#[repr(C)]
pub struct YOutput {
/// Tag describing, which `value` type is being stored by this input cell. Can be one of:
///
/// - [Y_JSON_BOOL] for boolean flags.
/// - [Y_JSON_NUM] for 64-bit floating point numbers.
/// - [Y_JSON_INT] for 64-bit signed integers.
/// - [Y_JSON_STR] for null-terminated UTF-8 encoded strings.
/// - [Y_JSON_BUF] for embedded binary data.
/// - [Y_JSON_ARR] for arrays of JSON-like values.
/// - [Y_JSON_MAP] for JSON-like objects build from key-value pairs.
/// - [Y_JSON_NULL] for JSON-like null values.
/// - [Y_JSON_UNDEF] for JSON-like undefined values.
/// - [Y_TEXT] for pointers to `YText` data types.
/// - [Y_ARRAY] for pointers to `YArray` data types.
/// - [Y_MAP] for pointers to `YMap` data types.
/// - [Y_XML_ELEM] for pointers to `YXmlElement` data types.
/// - [Y_XML_TEXT] for pointers to `YXmlText` data types.
pub tag: c_char,
/// Length of the contents stored by a current `YOutput` cell.
///
/// For [Y_JSON_NULL] and [Y_JSON_UNDEF] its equal to `0`.
///
/// For [Y_JSON_ARR], [Y_JSON_MAP] it describes a number of passed elements.
///
/// For other types it's always equal to `1`.
pub len: c_int,
/// Union struct which contains a content corresponding to a provided `tag` field.
value: YOutputContent,
}
impl std::fmt::Display for YOutput {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
let tag = self.tag;
unsafe {
if tag == Y_JSON_INT {
write!(f, "{}", self.value.integer)
} else if tag == Y_JSON_NUM {
write!(f, "{}", self.value.num)
} else if tag == Y_JSON_BOOL {
write!(
f,
"{}",
if self.value.flag == 0 {
"false"
} else {
"true"
}
)
} else if tag == Y_JSON_UNDEF {
write!(f, "undefined")
} else if tag == Y_JSON_NULL {
write!(f, "null")
} else if tag == Y_JSON_STR {
write!(f, "{}", CString::from_raw(self.value.str).to_str().unwrap())
} else if tag == Y_MAP {
write!(f, "YMap")
} else if tag == Y_ARRAY {
write!(f, "YArray")
} else if tag == Y_JSON_ARR {
write!(f, "[")?;
let slice = std::slice::from_raw_parts(self.value.array, self.len as usize);
for o in slice {
write!(f, ", {}", o)?;
}
write!(f, "]")
} else if tag == Y_JSON_MAP {
write!(f, "{{")?;
let slice = std::slice::from_raw_parts(self.value.map, self.len as usize);
for e in slice {
write!(
f,
", '{}' => {}",
CStr::from_ptr(e.key).to_str().unwrap(),
e.value
)?;
}
write!(f, "}}")
} else if tag == Y_TEXT {
write!(f, "YText")
} else if tag == Y_XML_TEXT {
write!(f, "YXmlText")
} else if tag == Y_XML_ELEM {
write!(f, "YXmlElement",)
} else if tag == Y_JSON_BUF {
write!(f, "YBinary(len: {})", self.len)
} else {
Ok(())
}
}
}
}
impl Drop for YOutput {
fn drop(&mut self) {
let tag = self.tag;
unsafe {
if tag == Y_JSON_STR {
drop(CString::from_raw(self.value.str));
} else if tag == Y_MAP {
drop(Box::from_raw(self.value.y_map));
} else if tag == Y_ARRAY {
drop(Box::from_raw(self.value.y_array));
} else if tag == Y_JSON_ARR {
drop(Vec::from_raw_parts(
self.value.array,
self.len as usize,
self.len as usize,
));
} else if tag == Y_JSON_MAP {
drop(Vec::from_raw_parts(
self.value.map,
self.len as usize,
self.len as usize,
));
} else if tag == Y_TEXT {
drop(Box::from_raw(self.value.y_text));
} else if tag == Y_XML_TEXT {
drop(Box::from_raw(self.value.y_xmltext));
} else if tag == Y_XML_ELEM {
drop(Box::from_raw(self.value.y_xmlelem));
} else if tag == Y_JSON_BUF {
drop(Vec::from_raw_parts(
self.value.buf,
self.len as usize,
self.len as usize,
));
}
}
}
}
impl From<Value> for YOutput {
fn from(v: Value) -> Self {
match v {
Value::Any(v) => Self::from(v),
Value::YText(v) => Self::from(v),
Value::YArray(v) => Self::from(v),
Value::YMap(v) => Self::from(v),
Value::YXmlElement(v) => Self::from(v),
Value::YXmlText(v) => Self::from(v),
}
}
}
impl From<Any> for YOutput {
fn from(v: Any) -> Self {
unsafe {
match v {
Any::Null => YOutput {
tag: Y_JSON_NULL,
len: 0,
value: MaybeUninit::uninit().assume_init(),
},
Any::Undefined => YOutput {
tag: Y_JSON_UNDEF,
len: 0,
value: MaybeUninit::uninit().assume_init(),
},
Any::Bool(v) => YOutput {
tag: Y_JSON_BOOL,
len: 1,
value: YOutputContent {
flag: if v { Y_TRUE } else { Y_FALSE },
},
},
Any::Number(v) => YOutput {
tag: Y_JSON_NUM,
len: 1,
value: YOutputContent { num: v as _ },
},
Any::BigInt(v) => YOutput {
tag: Y_JSON_INT,
len: 1,
value: YOutputContent { integer: v as _ },
},
Any::String(v) => YOutput {
tag: Y_JSON_STR,
len: v.len() as c_int,
value: YOutputContent {
str: CString::new(v.as_ref()).unwrap().into_raw(),
},
},
Any::Buffer(v) => YOutput {
tag: Y_JSON_BUF,
len: v.len() as c_int,
value: YOutputContent {
buf: Box::into_raw(v.clone()) as *mut _,
},
},
Any::Array(v) => {
let len = v.len() as c_int;
let v = Vec::from(v);
let mut array: Vec<_> = v.into_iter().map(|v| YOutput::from(v)).collect();
array.shrink_to_fit();
let ptr = array.as_mut_ptr();
forget(array);
YOutput {
tag: Y_JSON_ARR,
len,
value: YOutputContent { array: ptr },
}
}
Any::Map(v) => {
let len = v.len() as c_int;
let v = *v;
let mut array: Vec<_> = v
.into_iter()
.map(|(k, v)| YMapEntry::new(k.as_str(), Value::Any(v)))
.collect();
array.shrink_to_fit();
let ptr = array.as_mut_ptr();
forget(array);
YOutput {
tag: Y_JSON_MAP,
len,
value: YOutputContent { map: ptr },
}
}
}
}
}
}
impl From<Text> for YOutput {
fn from(v: Text) -> Self {
YOutput {
tag: Y_TEXT,
len: 1,
value: YOutputContent {
y_text: Box::into_raw(Box::new(v)),
},
}
}
}
impl From<Array> for YOutput {
fn from(v: Array) -> Self {
YOutput {
tag: Y_ARRAY,
len: 1,
value: YOutputContent {
y_array: Box::into_raw(Box::new(v)),
},
}
}
}
impl From<Map> for YOutput {
fn from(v: Map) -> Self {
YOutput {
tag: Y_MAP,
len: 1,
value: YOutputContent {
y_map: Box::into_raw(Box::new(v)),
},
}
}
}
impl From<XmlElement> for YOutput {
fn from(v: XmlElement) -> Self {
YOutput {
tag: Y_XML_ELEM,
len: 1,
value: YOutputContent {
y_xmlelem: Box::into_raw(Box::new(v)),
},
}
}
}
impl From<XmlText> for YOutput {
fn from(v: XmlText) -> Self {
YOutput {
tag: Y_XML_TEXT,
len: 1,
value: YOutputContent {
y_xmltext: Box::into_raw(Box::new(v)),
},
}
}
}
#[repr(C)]
union YOutputContent {
flag: c_char,
num: c_float,
integer: c_long,
str: *mut c_char,
buf: *mut c_uchar,
array: *mut YOutput,
map: *mut YMapEntry,
y_array: *mut Array,
y_map: *mut Map,
y_text: *mut Text,
y_xmlelem: *mut XmlElement,
y_xmltext: *mut XmlText,
}
/// Releases all resources related to a corresponding `YOutput` cell.
#[no_mangle]
pub unsafe extern "C" fn youtput_destroy(val: *mut YOutput) {
if !val.is_null() {
drop(Box::from_raw(val))
}
}
/// Function constructor used to create JSON-like NULL `YInput` cell.
/// This function doesn't allocate any heap resources.
#[no_mangle]
pub unsafe extern "C" fn yinput_null() -> YInput {
YInput {
tag: Y_JSON_NULL,
len: 0,
value: MaybeUninit::uninit().assume_init(),
}
}
/// Function constructor used to create JSON-like undefined `YInput` cell.
/// This function doesn't allocate any heap resources.
#[no_mangle]
pub unsafe extern "C" fn yinput_undefined() -> YInput {
YInput {
tag: Y_JSON_UNDEF,
len: 0,
value: MaybeUninit::uninit().assume_init(),
}
}
/// Function constructor used to create JSON-like boolean `YInput` cell.
/// This function doesn't allocate any heap resources.
#[no_mangle]
pub unsafe extern "C" fn yinput_bool(flag: c_char) -> YInput {
YInput {
tag: Y_JSON_BOOL,
len: 1,
value: YInputContent { flag },
}
}
/// Function constructor used to create JSON-like 64-bit floating point number `YInput` cell.
/// This function doesn't allocate any heap resources.
#[no_mangle]
pub unsafe extern "C" fn yinput_float(num: c_float) -> YInput {
YInput {
tag: Y_JSON_NUM,
len: 1,
value: YInputContent { num },
}
}
/// Function constructor used to create JSON-like 64-bit signed integer `YInput` cell.
/// This function doesn't allocate any heap resources.
#[no_mangle]
pub unsafe extern "C" fn yinput_long(integer: c_long) -> YInput {
YInput {
tag: Y_JSON_INT,
len: 1,
value: YInputContent { integer },
}
}
/// Function constructor used to create a string `YInput` cell. Provided parameter must be
/// a null-terminated UTF-8 encoded string. This function doesn't allocate any heap resources,
/// and doesn't release any on its own, therefore its up to a caller to free resources once
/// a structure is no longer needed.
#[no_mangle]
pub unsafe extern "C" fn yinput_string(str: *const c_char) -> YInput {
YInput {
tag: Y_JSON_STR,
len: 1,
value: YInputContent {
str: str as *mut c_char,
},
}
}
/// Function constructor used to create a binary `YInput` cell of a specified length.
/// This function doesn't allocate any heap resources and doesn't release any on its own, therefore
/// its up to a caller to free resources once a structure is no longer needed.
#[no_mangle]
pub unsafe extern "C" fn yinput_binary(buf: *const u8, len: c_int) -> YInput {
YInput {
tag: Y_JSON_BUF,
len,
value: YInputContent {
buf: buf as *mut u8,
},
}
}
/// Function constructor used to create a JSON-like array `YInput` cell of other JSON-like values of
/// a given length. This function doesn't allocate any heap resources and doesn't release any on its
/// own, therefore its up to a caller to free resources once a structure is no longer needed.
#[no_mangle]
pub unsafe extern "C" fn yinput_json_array(values: *mut YInput, len: c_int) -> YInput {
YInput {
tag: Y_JSON_ARR,
len,
value: YInputContent { values },
}
}
/// Function constructor used to create a JSON-like map `YInput` cell of other JSON-like key-value
/// pairs. These pairs are build from corresponding indexes of `keys` and `values`, which must have
/// the same specified length.
///
/// This function doesn't allocate any heap resources and doesn't release any on its own, therefore
/// its up to a caller to free resources once a structure is no longer needed.
#[no_mangle]
pub unsafe extern "C" fn yinput_json_map(
keys: *mut *mut c_char,
values: *mut YInput,
len: c_int,
) -> YInput {
YInput {
tag: Y_JSON_ARR,
len,
value: YInputContent {
map: ManuallyDrop::new(YMapInputData { keys, values }),
},
}
}
/// Function constructor used to create a nested `YArray` `YInput` cell prefilled with other
/// values of a given length. This function doesn't allocate any heap resources and doesn't release
/// any on its own, therefore its up to a caller to free resources once a structure is no longer
/// needed.
#[no_mangle]
pub unsafe extern "C" fn yinput_yarray(values: *mut YInput, len: c_int) -> YInput {
YInput {
tag: Y_ARRAY,
len,
value: YInputContent { values },
}
}
/// Function constructor used to create a nested `YMap` `YInput` cell prefilled with other key-value
/// pairs. These pairs are build from corresponding indexes of `keys` and `values`, which must have
/// the same specified length.
///
/// This function doesn't allocate any heap resources and doesn't release any on its own, therefore
/// its up to a caller to free resources once a structure is no longer needed.
#[no_mangle]
pub unsafe extern "C" fn yinput_ymap(
keys: *mut *mut c_char,
values: *mut YInput,
len: c_int,
) -> YInput {
YInput {
tag: Y_MAP,
len,
value: YInputContent {
map: ManuallyDrop::new(YMapInputData { keys, values }),
},
}
}
/// Function constructor used to create a nested `YText` `YInput` cell prefilled with a specified
/// string, which must be a null-terminated UTF-8 character pointer.
///
/// This function doesn't allocate any heap resources and doesn't release any on its own, therefore
/// its up to a caller to free resources once a structure is no longer needed.
#[no_mangle]
pub unsafe extern "C" fn yinput_ytext(str: *mut c_char) -> YInput {
YInput {
tag: Y_TEXT,
len: 1,
value: YInputContent { str },
}
}
/// Function constructor used to create a nested `YXmlElement` `YInput` cell with a specified
/// tag name, which must be a null-terminated UTF-8 character pointer.
///
/// This function doesn't allocate any heap resources and doesn't release any on its own, therefore
/// its up to a caller to free resources once a structure is no longer needed.
#[no_mangle]
pub unsafe extern "C" fn yinput_yxmlelem(name: *mut c_char) -> YInput {
YInput {
tag: Y_XML_ELEM,
len: 1,
value: YInputContent { str: name },
}
}
/// Function constructor used to create a nested `YXmlText` `YInput` cell prefilled with a specified
/// string, which must be a null-terminated UTF-8 character pointer.
///
/// This function doesn't allocate any heap resources and doesn't release any on its own, therefore
/// its up to a caller to free resources once a structure is no longer needed.
#[no_mangle]
pub unsafe extern "C" fn yinput_yxmltext(str: *mut c_char) -> YInput {
YInput {
tag: Y_XML_TEXT,
len: 1,
value: YInputContent { str },
}
}
/// Attempts to read the value for a given `YOutput` pointer as a boolean flag, which can be either
/// `1` for truthy case and `0` otherwise. Returns a null pointer in case when a value stored under
/// current `YOutput` cell is not of a boolean type.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_bool(val: *const YOutput) -> *const c_char {
let v = val.as_ref().unwrap();
if v.tag == Y_JSON_BOOL {
&v.value.flag
} else {
std::ptr::null()
}
}
/// Attempts to read the value for a given `YOutput` pointer as a 64-bit floating point number.
///
/// Returns a null pointer in case when a value stored under current `YOutput` cell
/// is not a floating point number.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_float(val: *const YOutput) -> *const c_float {
let v = val.as_ref().unwrap();
if v.tag == Y_JSON_NUM {
&v.value.num
} else {
std::ptr::null()
}
}
/// Attempts to read the value for a given `YOutput` pointer as a 64-bit signed integer.
///
/// Returns a null pointer in case when a value stored under current `YOutput` cell
/// is not a signed integer.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_long(val: *const YOutput) -> *const c_long {
let v = val.as_ref().unwrap();
if v.tag == Y_JSON_INT {
&v.value.integer
} else {
std::ptr::null()
}
}
/// Attempts to read the value for a given `YOutput` pointer as a null-terminated UTF-8 encoded
/// string.
///
/// Returns a null pointer in case when a value stored under current `YOutput` cell
/// is not a string. Underlying string is released automatically as part of [youtput_destroy]
/// destructor.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_string(val: *const YOutput) -> *mut c_char {
let v = val.as_ref().unwrap();
if v.tag == Y_JSON_STR {
v.value.str
} else {
std::ptr::null_mut()
}
}
/// Attempts to read the value for a given `YOutput` pointer as a binary payload (which length is
/// stored within `len` filed of a cell itself).
///
/// Returns a null pointer in case when a value stored under current `YOutput` cell
/// is not a binary type. Underlying binary is released automatically as part of [youtput_destroy]
/// destructor.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_binary(val: *const YOutput) -> *const c_uchar {
let v = val.as_ref().unwrap();
if v.tag == Y_JSON_BUF {
v.value.buf
} else {
std::ptr::null()
}
}
/// Attempts to read the value for a given `YOutput` pointer as a JSON-like array of `YOutput`
/// values (which length is stored within `len` filed of a cell itself).
///
/// Returns a null pointer in case when a value stored under current `YOutput` cell
/// is not a JSON-like array. Underlying heap resources are released automatically as part of
/// [youtput_destroy] destructor.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_json_array(val: *const YOutput) -> *mut YOutput {
let v = val.as_ref().unwrap();
if v.tag == Y_JSON_ARR {
v.value.array
} else {
std::ptr::null_mut()
}
}
/// Attempts to read the value for a given `YOutput` pointer as a JSON-like map of key-value entries
/// (which length is stored within `len` filed of a cell itself).
///
/// Returns a null pointer in case when a value stored under current `YOutput` cell
/// is not a JSON-like map. Underlying heap resources are released automatically as part of
/// [youtput_destroy] destructor.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_json_map(val: *const YOutput) -> *mut YMapEntry {
let v = val.as_ref().unwrap();
if v.tag == Y_JSON_MAP {
v.value.map
} else {
std::ptr::null_mut()
}
}
/// Attempts to read the value for a given `YOutput` pointer as an `YArray`.
///
/// Returns a null pointer in case when a value stored under current `YOutput` cell
/// is not an `YArray`. Underlying heap resources are released automatically as part of
/// [youtput_destroy] destructor.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_yarray(val: *const YOutput) -> *mut Array {
let v = val.as_ref().unwrap();
if v.tag == Y_ARRAY {
v.value.y_array
} else {
std::ptr::null_mut()
}
}
/// Attempts to read the value for a given `YOutput` pointer as an `YXmlElement`.
///
/// Returns a null pointer in case when a value stored under current `YOutput` cell
/// is not an `YXmlElement`. Underlying heap resources are released automatically as part of
/// [youtput_destroy] destructor.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_yxmlelem(val: *const YOutput) -> *mut XmlElement {
let v = val.as_ref().unwrap();
if v.tag == Y_XML_ELEM {
v.value.y_xmlelem
} else {
std::ptr::null_mut()
}
}
/// Attempts to read the value for a given `YOutput` pointer as an `YMap`.
///
/// Returns a null pointer in case when a value stored under current `YOutput` cell
/// is not an `YMap`. Underlying heap resources are released automatically as part of
/// [youtput_destroy] destructor.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_ymap(val: *const YOutput) -> *mut Map {
let v = val.as_ref().unwrap();
if v.tag == Y_MAP {
v.value.y_map
} else {
std::ptr::null_mut()
}
}
/// Attempts to read the value for a given `YOutput` pointer as an `YText`.
///
/// Returns a null pointer in case when a value stored under current `YOutput` cell
/// is not an `YText`. Underlying heap resources are released automatically as part of
/// [youtput_destroy] destructor.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_ytext(val: *const YOutput) -> *mut Text {
let v = val.as_ref().unwrap();
if v.tag == Y_TEXT {
v.value.y_text
} else {
std::ptr::null_mut()
}
}
/// Attempts to read the value for a given `YOutput` pointer as an `YXmlText`.
///
/// Returns a null pointer in case when a value stored under current `YOutput` cell
/// is not an `YXmlText`. Underlying heap resources are released automatically as part of
/// [youtput_destroy] destructor.
#[no_mangle]
pub unsafe extern "C" fn youtput_read_yxmltext(val: *const YOutput) -> *mut XmlText {
let v = val.as_ref().unwrap();
if v.tag == Y_XML_TEXT {
v.value.y_xmltext
} else {
std::ptr::null_mut()
}
}
#[no_mangle]
pub unsafe extern "C" fn ytext_observe(
txt: *const Text,
state: *mut c_void,
cb: extern "C" fn(*mut c_void, *const YEvent),
) -> *mut Observer {
assert!(!txt.is_null());
let txt = txt.as_ref().unwrap();
let observer = txt.observe(move |txn, e| {
let e = YEvent::new(e, txn);
cb(state, &e as *const YEvent);
});
Box::into_raw(Box::new(observer)) as *mut _
}
#[no_mangle]
pub unsafe extern "C" fn ymap_observe(
map: *const Map,
state: *mut c_void,
cb: extern "C" fn(*mut c_void, *const YEvent),
) -> *mut Observer {
assert!(!map.is_null());
let map = map.as_ref().unwrap();
let observer = map.observe(move |txn, e| {
let e = YEvent::new(e, txn);
cb(state, &e as *const YEvent);
});
Box::into_raw(Box::new(observer)) as *mut _
}
#[no_mangle]
pub unsafe extern "C" fn yarray_observe(
array: *const Array,
state: *mut c_void,
cb: extern "C" fn(*mut c_void, *const YEvent),
) -> *mut Observer {
assert!(!array.is_null());
let array = array.as_ref().unwrap();
let observer = array.observe(move |txn, e| {
let e = YEvent::new(e, txn);
cb(state, &e as *const YEvent);
});
Box::into_raw(Box::new(observer)) as *mut _
}
#[no_mangle]
pub unsafe extern "C" fn yxmlelem_observe(
xml: *const XmlElement,
state: *mut c_void,
cb: extern "C" fn(*mut c_void, *const YEvent),
) -> *mut Observer {
assert!(!xml.is_null());
let xml = xml.as_ref().unwrap();
let observer = xml.observe(move |txn, e| {
let e = YEvent::new(e, txn);
cb(state, &e as *const YEvent);
});
Box::into_raw(Box::new(observer)) as *mut _
}
#[no_mangle]
pub unsafe extern "C" fn yxmltext_observe(
xml: *const XmlText,
state: *mut c_void,
cb: extern "C" fn(*mut c_void, *const YEvent),
) -> *mut Observer {
assert!(!xml.is_null());
let xml = xml.as_ref().unwrap();
let observer = xml.observe(move |txn, e| {
let e = YEvent::new(e, txn);
cb(state, &e as *const YEvent);
});
Box::into_raw(Box::new(observer)) as *mut _
}
/// Event passed over to a callbacks subscribed via <shared_type>_observe functions. It enables
/// tracking changes happening over different shared collection types, which can be separated into:
///
/// 1. `yevent_delta` function, which returns changes over a sequence component of shared types,
/// such as `YArray`, `YText`, `YXmlText` and XML nodes added to `YXmlElement`. Data returned this
/// way should be disposed eventually via `yevent_delta_destroy` function.
/// 2. `yevent_keys` function, which returns changes over a map component of shared types, such as
/// `YMap` entries and `YXmlElement`/`YXmlText` attribute changed. Data returned this way should be
/// disposed eventually via `yevent_keys_destroy` function.
#[repr(C)]
pub struct YEvent {
inner: *const Event,
pub txn: *const Transaction,
}
impl YEvent {
fn new(inner: &Event, txn: &Transaction) -> Self {
let inner = inner as *const Event;
let txn = txn as *const Transaction;
YEvent { inner, txn }
}
}
impl YEvent {
unsafe fn inner(&self) -> &Event {
&*self.inner
}
unsafe fn txn(&self) -> &Transaction {
&*self.txn
}
}
/// Releases a callback subscribed via `<shared_type>_observe` function represented by passed
/// observer parameter.
#[no_mangle]
pub unsafe extern "C" fn yobserver_destroy(e: *mut Observer) {
if !e.is_null() {
drop(e.read());
}
}
/// Returns a pointer to a shared collection, which triggered passed event `e`.
#[no_mangle]
pub unsafe extern "C" fn yevent_target(e: *const YEvent) -> *mut YOutput {
assert!(!e.is_null());
let out: YOutput = (&*e).inner().target().into();
Box::into_raw(Box::new(out)) as *mut _
}
/// Returns a path from a root type down to a current shared collection (which can be obtained using
/// `yevent_target` function). It can consist of either integer indexes (used by sequence
/// components) of *char keys (used by map components). `len` output parameter is used to provide
/// information about length of the path.
///
/// Path returned this way should be eventually released using `yevent_path_destroy`.
#[no_mangle]
pub unsafe extern "C" fn yevent_path(e: *const YEvent, len: *mut c_int) -> *mut YPathSegment {
assert!(!e.is_null());
let path: Vec<_> = (&*e)
.inner()
.path((&*e).txn())
.into_iter()
.map(YPathSegment::from)
.collect();
let out = path.into_boxed_slice();
*len = out.len() as c_int;
Box::into_raw(out) as *mut _
}
/// Releases allocated memory used by objects returned from `yevent_path` function.
#[no_mangle]
pub unsafe extern "C" fn yevent_path_destroy(path: *mut YPathSegment, len: c_int) {
if !path.is_null() {
drop(Vec::from_raw_parts(path, len as usize, len as usize));
}
}
/// Returns a sequence of changes produced by sequence component of shared collections (such as
/// `YText`, `YXmlText` and XML nodes added to `YXmlElement`). `len` output parameter is used to
/// provide information about number of changes produced.
///
/// Delta returned from this function should eventually be released using `yevent_delta_destroy`
/// function.
#[no_mangle]
pub unsafe extern "C" fn yevent_delta(e: *const YEvent, len: *mut c_int) -> *mut YEventChange {
assert!(!e.is_null());
let delta: Vec<_> = (&*e)
.inner()
.delta((&*e).txn())
.into_iter()
.map(YEventChange::from)
.collect();
let out = delta.into_boxed_slice();
*len = out.len() as c_int;
Box::into_raw(out) as *mut _
}
/// Releases memory allocated by the object returned from `yevent_delta` function.
#[no_mangle]
pub unsafe extern "C" fn yevent_delta_destroy(delta: *mut YEventChange, len: c_int) {
if !delta.is_null() {
let delta = Vec::from_raw_parts(delta, len as usize, len as usize);
drop(delta);
}
}
/// Returns a sequence of changes produced by map component of shared collections (such as
/// `YMap` and `YXmlText`/`YXmlElement` attribute changes). `len` output parameter is used to
/// provide information about number of changes produced.
///
/// Delta returned from this function should eventually be released using `yevent_keys_destroy`
/// function.
#[no_mangle]
pub unsafe extern "C" fn yevent_keys(e: *const YEvent, len: *mut c_int) -> *mut YEventKeyChange {
assert!(!e.is_null());
let delta: Vec<_> = (&*e)
.inner()
.keys((&*e).txn())
.into_iter()
.map(|(k, v)| YEventKeyChange::new(k.as_ref(), v))
.collect();
let out = delta.into_boxed_slice();
*len = out.len() as c_int;
Box::into_raw(out) as *mut _
}
/// Releases memory allocated by the object returned from `yevent_keys` function.
#[no_mangle]
pub unsafe extern "C" fn yevent_keys_destroy(keys: *mut YEventKeyChange, len: c_int) {
if !keys.is_null() {
drop(Vec::from_raw_parts(keys, len as usize, len as usize));
}
}
/// Tag used to identify `YPathSegment` storing a *char parameter.
pub const Y_EVENT_PATH_KEY: c_char = 1;
/// Tag used to identify `YPathSegment` storing an int parameter.
pub const Y_EVENT_PATH_INDEX: c_char = 2;
/// A single segment of a path returned from `yevent_path` function. It can be one of two cases,
/// recognized by it's `tag` field:
///
/// 1. `Y_EVENT_PATH_KEY` means that segment value can be accessed by `segment.value.key` and is
/// referring to a string key used by map component (eg. `YMap` entry).
/// 2. `Y_EVENT_PATH_INDEX` means that segment value can be accessed by `segment.value.index` and is
/// referring to an int index used by sequence component (eg. `YArray` item or `YXmlElement` child).
#[repr(C)]
pub struct YPathSegment {
/// Tag used to identify which case current segment is referring to:
///
/// 1. `Y_EVENT_PATH_KEY` means that segment value can be accessed by `segment.value.key` and is
/// referring to a string key used by map component (eg. `YMap` entry).
/// 2. `Y_EVENT_PATH_INDEX` means that segment value can be accessed by `segment.value.index`
/// and is referring to an int index used by sequence component (eg. `YArray` item or
/// `YXmlElement` child).
pub tag: c_char,
/// Union field containing either `key` or `index`. A particular case can be recognized by using
/// segment's `tag` field.
pub value: YPathSegmentCase,
}
impl From<PathSegment> for YPathSegment {
fn from(ps: PathSegment) -> Self {
match ps {
PathSegment::Key(key) => {
let key = CString::new(key.as_ref()).unwrap().into_raw() as *const _;
YPathSegment {
tag: Y_EVENT_PATH_KEY,
value: YPathSegmentCase { key },
}
}
PathSegment::Index(index) => YPathSegment {
tag: Y_EVENT_PATH_INDEX,
value: YPathSegmentCase {
index: index as c_int,
},
},
}
}
}
impl Drop for YPathSegment {
fn drop(&mut self) {
if self.tag == Y_EVENT_PATH_KEY {
unsafe {
ystring_destroy(self.value.key as *mut _);
}
}
}
}
#[repr(C)]
pub union YPathSegmentCase {
pub key: *const c_char,
pub index: c_int,
}
/// Tag used to identify `YEventChange` (see: `yevent_delta` function) case, when a new element
/// has been added to an observed collection.
pub const Y_EVENT_CHANGE_ADD: c_char = 1;
/// Tag used to identify `YEventChange` (see: `yevent_delta` function) case, when an existing
/// element has been removed from an observed collection.
pub const Y_EVENT_CHANGE_DELETE: c_char = 2;
/// Tag used to identify `YEventChange` (see: `yevent_delta` function) case, when no changes have
/// been detected for a particular range of observed collection.
pub const Y_EVENT_CHANGE_RETAIN: c_char = 3;
/// A data type representing a single change detected over an observed shared collection. A type
/// of change can be detected using a `tag` field:
///
/// 1. `Y_EVENT_CHANGE_ADD` marks a new elements added to a collection. In this case `values` field
/// contains a pointer to a list of newly inserted values, while `len` field informs about their
/// count.
/// 2. `Y_EVENT_CHANGE_DELETE` marks an existing elements removed from the collection. In this case
/// `len` field informs about number of removed elements.
/// 3. `Y_EVENT_CHANGE_RETAIN` marks a number of elements that have not been changed, counted from
/// the previous element. `len` field informs about number of retained elements.
///
/// A list of changes returned by `yevent_delta` enables to locate a position of all changes within
/// an observed collection by using a combination of added/deleted change structs separated by
/// retained changes (marking eg. number of elements that can be safely skipped, since they
/// remained unchanged).
#[repr(C)]
pub struct YEventChange {
/// Tag field used to identify particular type of change made:
///
/// 1. `Y_EVENT_CHANGE_ADD` marks a new elements added to a collection. In this case `values`
/// field contains a pointer to a list of newly inserted values, while `len` field informs about
/// their count.
/// 2. `Y_EVENT_CHANGE_DELETE` marks an existing elements removed from the collection. In this
/// case `len` field informs about number of removed elements.
/// 3. `Y_EVENT_CHANGE_RETAIN` marks a number of elements that have not been changed, counted
/// from the previous element. `len` field informs about number of retained elements.
pub tag: c_char,
/// Number of element affected by current type of a change. It can refer to a number of
/// inserted `values`, number of deleted element or a number of retained (unchanged) values.
pub len: c_int,
/// Used in case when current change is of `Y_EVENT_CHANGE_ADD` type. Contains a list (of
/// length stored in `len` field) of newly inserted values.
pub values: *const YOutput,
}
impl<'a> From<&'a Change> for YEventChange {
fn from(change: &'a Change) -> Self {
match change {
Change::Added(values) => {
let out: Vec<_> = values
.into_iter()
.map(|v| YOutput::from(v.clone()))
.collect();
let len = out.len() as c_int;
let out = out.into_boxed_slice();
let values = Box::into_raw(out) as *mut _;
YEventChange {
tag: Y_EVENT_CHANGE_ADD,
len,
values,
}
}
Change::Removed(len) => YEventChange {
tag: Y_EVENT_CHANGE_DELETE,
len: *len as c_int,
values: null(),
},
Change::Retain(len) => YEventChange {
tag: Y_EVENT_CHANGE_RETAIN,
len: *len as c_int,
values: null(),
},
}
}
}
impl Drop for YEventChange {
fn drop(&mut self) {
if self.tag == Y_EVENT_CHANGE_ADD {
unsafe {
let len = self.len as usize;
let values = Vec::from_raw_parts(self.values as *mut YOutput, len, len);
drop(values);
}
}
}
}
/// Tag used to identify `YEventKeyChange` (see: `yevent_keys` function) case, when a new entry has
/// been inserted into a map component of shared collection.
pub const Y_EVENT_KEY_CHANGE_ADD: c_char = 4;
/// Tag used to identify `YEventKeyChange` (see: `yevent_keys` function) case, when an existing
/// entry has been removed from a map component of shared collection.
pub const Y_EVENT_KEY_CHANGE_DELETE: c_char = 5;
/// Tag used to identify `YEventKeyChange` (see: `yevent_keys` function) case, when an existing
/// entry has been overridden with a new value within a map component of shared collection.
pub const Y_EVENT_KEY_CHANGE_UPDATE: c_char = 6;
/// A data type representing a single change made over a map component of shared collection types,
/// such as `YMap` entries or `YXmlText`/`YXmlElement` attributes. A `key` field provides a
/// corresponding unique key string of a changed entry, while `tag` field informs about specific
/// type of change being done:
///
/// 1. `Y_EVENT_KEY_CHANGE_ADD` used to identify a newly added entry. In this case an `old_value`
/// field is NULL, while `new_value` field contains an inserted value.
/// 1. `Y_EVENT_KEY_CHANGE_DELETE` used to identify an existing entry being removed. In this case
/// an `old_value` field contains the removed value.
/// 1. `Y_EVENT_KEY_CHANGE_UPDATE` used to identify an existing entry, which value has been changed.
/// In this case `old_value` field contains replaced value, while `new_value` contains a newly
/// inserted one.
#[repr(C)]
pub struct YEventKeyChange {
/// A UTF8-encoded null-terminated string containing a key of a changed entry.
pub key: *const c_char,
/// Tag field informing about type of change current struct refers to:
///
/// 1. `Y_EVENT_KEY_CHANGE_ADD` used to identify a newly added entry. In this case an
/// `old_value` field is NULL, while `new_value` field contains an inserted value.
/// 1. `Y_EVENT_KEY_CHANGE_DELETE` used to identify an existing entry being removed. In this
/// case an `old_value` field contains the removed value.
/// 1. `Y_EVENT_KEY_CHANGE_UPDATE` used to identify an existing entry, which value has been
/// changed. In this case `old_value` field contains replaced value, while `new_value` contains
/// a newly inserted one.
pub tag: c_char,
/// Contains a removed entry's value or replaced value of an updated entry.
pub old_value: *const YOutput,
/// Contains a value of newly inserted entry or an updated entry's new value.
pub new_value: *const YOutput,
}
impl YEventKeyChange {
fn new(key: &str, change: &EntryChange) -> Self {
let key = CString::new(key).unwrap().into_raw() as *const _;
match change {
EntryChange::Inserted(new) => YEventKeyChange {
key,
tag: Y_EVENT_KEY_CHANGE_ADD,
old_value: null(),
new_value: Box::into_raw(Box::new(YOutput::from(new.clone()))),
},
EntryChange::Updated(old, new) => YEventKeyChange {
key,
tag: Y_EVENT_KEY_CHANGE_UPDATE,
old_value: Box::into_raw(Box::new(YOutput::from(old.clone()))),
new_value: Box::into_raw(Box::new(YOutput::from(new.clone()))),
},
EntryChange::Removed(old) => YEventKeyChange {
key,
tag: Y_EVENT_KEY_CHANGE_DELETE,
old_value: Box::into_raw(Box::new(YOutput::from(old.clone()))),
new_value: null(),
},
}
}
}
impl Drop for YEventKeyChange {
fn drop(&mut self) {
unsafe {
ystring_destroy(self.key as *mut _);
youtput_destroy(self.old_value as *mut _);
youtput_destroy(self.new_value as *mut _);
}
}
}
#[cfg(test)]
mod test {
use crate::*;
#[test]
fn yval_preliminary_types() {
unsafe {
let doc = ydoc_new();
let txn = ytransaction_new(doc);
let array_name = CString::new("test").unwrap();
let array = yarray(txn, array_name.as_ptr());
let y_true = yinput_bool(Y_TRUE);
let y_false = yinput_bool(Y_FALSE);
let y_float = yinput_float(0.5);
let y_int = yinput_long(11);
let input = CString::new("hello").unwrap();
let y_str = yinput_string(input.as_ptr());
let values = &[y_true, y_false, y_float, y_int, y_str];
yarray_insert_range(array, txn, 0, values.as_ptr(), 5);
ytransaction_commit(txn);
ydoc_destroy(doc);
}
}
}
