/usr/include/cypher-parser.h is in libcypher-parser-dev 0.5.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 | /* vi:set ts=4 sw=4 expandtab:
*
* Copyright 2016, Chris Leishman (http://github.com/cleishm)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file cypher-parser.h
*/
#ifndef CYPHER_PARSER_H
#define CYPHER_PARSER_H
#include <stdlib.h>
#include <stdint.h>
#include <stdarg.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <sys/types.h>
#include <sys/uio.h>
#if __GNUC__ > 3
#define __cypherlang_pure __attribute__((pure))
#define __cypherlang_malloc __attribute__((malloc))
#define __cypherlang_must_check __attribute__((warn_unused_result))
#define __cypherlang_format(string_index, first) \
__attribute__((format (printf, string_index, first)))
#else
#define __cypherlang_pure /*pure*/
#define __cypherlang_malloc /*malloc*/
#define __cypherlang_must_check /*must check*/
#define __cypherlang_format(string_index, first) /*format*/
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma GCC visibility push(default)
/*
* =====================================
* version
* =====================================
*/
/**
* The version string for libcypher-parser.
*/
__cypherlang_pure
const char *libcypher_parser_version(void);
/*
* =====================================
* colorization
* =====================================
*/
struct cypher_parser_colorization
{
const char *normal[2];
const char *error[2];
const char *error_token[2];
const char *error_message[2];
const char *ast_ordinal[2];
const char *ast_range[2];
const char *ast_indent[2];
const char *ast_type[2];
const char *ast_desc[2];
};
/** Colorization rules for uncolorized output. */
extern const struct cypher_parser_colorization *cypher_parser_no_colorization;
/** Colorization rules for ANSI terminal output. */
extern const struct cypher_parser_colorization *cypher_parser_ansi_colorization;
/*
* =====================================
* abstract syntax tree
* =====================================
*/
/**
* An abstract syntax tree node.
*/
typedef struct cypher_astnode cypher_astnode_t;
/**
* A cypher AST node type.
*/
typedef uint8_t cypher_astnode_type_t;
/** Type for an AST statement node. */
extern const cypher_astnode_type_t CYPHER_AST_STATEMENT;
/** Type for an AST statement option node. */
extern const cypher_astnode_type_t CYPHER_AST_STATEMENT_OPTION;
/** Type for an AST `CYPHER` option node. */
extern const cypher_astnode_type_t CYPHER_AST_CYPHER_OPTION;
/** Type for an AST `CYPHER` option parameter node. */
extern const cypher_astnode_type_t CYPHER_AST_CYPHER_OPTION_PARAM;
/** Type for an AST `EXPLAIN` option node. */
extern const cypher_astnode_type_t CYPHER_AST_EXPLAIN_OPTION;
/** Type for an AST `PROFILE` option node. */
extern const cypher_astnode_type_t CYPHER_AST_PROFILE_OPTION;
/** Type for an AST schema command node. */
extern const cypher_astnode_type_t CYPHER_AST_SCHEMA_COMMAND;
/** Type for an AST `CREATE INDEX` node. */
extern const cypher_astnode_type_t CYPHER_AST_CREATE_NODE_PROP_INDEX;
/** Type for an AST `DROP INDEX` node. */
extern const cypher_astnode_type_t CYPHER_AST_DROP_NODE_PROP_INDEX;
/** Type for an AST create node property constraint node. */
extern const cypher_astnode_type_t CYPHER_AST_CREATE_NODE_PROP_CONSTRAINT;
/** Type for an AST drop node property constraint node. */
extern const cypher_astnode_type_t CYPHER_AST_DROP_NODE_PROP_CONSTRAINT;
/** Type for an AST create rel property constraint node. */
extern const cypher_astnode_type_t CYPHER_AST_CREATE_REL_PROP_CONSTRAINT;
/** Type for an AST drop rel property constraint node. */
extern const cypher_astnode_type_t CYPHER_AST_DROP_REL_PROP_CONSTRAINT;
/** Type for an AST query node. */
extern const cypher_astnode_type_t CYPHER_AST_QUERY;
/** Type for an AST query option node. */
extern const cypher_astnode_type_t CYPHER_AST_QUERY_OPTION;
/** Type for an AST `USING PERIODIC COMMIT` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_USING_PERIODIC_COMMIT;
/** Type for an AST query clause node. */
extern const cypher_astnode_type_t CYPHER_AST_QUERY_CLAUSE;
/** Type for an AST `LOAD CSV` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_LOAD_CSV;
/** Type for an AST `START` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_START;
/** Type for an AST start point node. */
extern const cypher_astnode_type_t CYPHER_AST_START_POINT;
/** Type for an AST node-index lookup node. */
extern const cypher_astnode_type_t CYPHER_AST_NODE_INDEX_LOOKUP;
/** Type for an AST node-index query node. */
extern const cypher_astnode_type_t CYPHER_AST_NODE_INDEX_QUERY;
/** Type for an AST node-by-id-lookup node. */
extern const cypher_astnode_type_t CYPHER_AST_NODE_ID_LOOKUP;
/** Type for an AST all-nodes-scan node. */
extern const cypher_astnode_type_t CYPHER_AST_ALL_NODES_SCAN;
/** Type for an AST rel-index lookup node. */
extern const cypher_astnode_type_t CYPHER_AST_REL_INDEX_LOOKUP;
/** Type for an AST rel-index query node. */
extern const cypher_astnode_type_t CYPHER_AST_REL_INDEX_QUERY;
/** Type for an AST rel-by-id-lookup node. */
extern const cypher_astnode_type_t CYPHER_AST_REL_ID_LOOKUP;
/** Type for an AST all-rels-scan node. */
extern const cypher_astnode_type_t CYPHER_AST_ALL_RELS_SCAN;
/** Type for an AST `MATCH` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_MATCH;
/** Type for an AST match hint node. */
extern const cypher_astnode_type_t CYPHER_AST_MATCH_HINT;
/** Type for an AST `USING INDEX` hint node. */
extern const cypher_astnode_type_t CYPHER_AST_USING_INDEX;
/** Type for an AST `USING JOIN ON` hint node. */
extern const cypher_astnode_type_t CYPHER_AST_USING_JOIN;
/** Type for an AST `USING SCAN` hint node. */
extern const cypher_astnode_type_t CYPHER_AST_USING_SCAN;
/** Type for an AST `MERGE` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_MERGE;
/** Type for an AST merge action node. */
extern const cypher_astnode_type_t CYPHER_AST_MERGE_ACTION;
/** Type for an AST `ON MATCH` action node. */
extern const cypher_astnode_type_t CYPHER_AST_ON_MATCH;
/** Type for an AST `ON CREATE` action node. */
extern const cypher_astnode_type_t CYPHER_AST_ON_CREATE;
/** Type for an AST `CREATE` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_CREATE;
/** Type for an AST `SET` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_SET;
/** Type for an AST set item node. */
extern const cypher_astnode_type_t CYPHER_AST_SET_ITEM;
/** Type for an AST set property node. */
extern const cypher_astnode_type_t CYPHER_AST_SET_PROPERTY;
/** Type for an AST set all properties node. */
extern const cypher_astnode_type_t CYPHER_AST_SET_ALL_PROPERTIES;
/** Type for an AST merge properties node. */
extern const cypher_astnode_type_t CYPHER_AST_MERGE_PROPERTIES;
/** Type for an AST set labels node. */
extern const cypher_astnode_type_t CYPHER_AST_SET_LABELS;
/** Type for an AST `DELETE` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_DELETE;
/** Type for an AST `REMOVE` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_REMOVE;
/** Type for an AST remove item node. */
extern const cypher_astnode_type_t CYPHER_AST_REMOVE_ITEM;
/** Type for an AST remove labels node. */
extern const cypher_astnode_type_t CYPHER_AST_REMOVE_LABELS;
/** Type for an AST remove property node. */
extern const cypher_astnode_type_t CYPHER_AST_REMOVE_PROPERTY;
/** Type for an AST `FOREACH` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_FOREACH;
/** Type for an AST `WITH` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_WITH;
/** Type for an AST `UNWIND` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_UNWIND;
/** Type for an AST `CALL` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_CALL;
/** Type for an AST `RETURN` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_RETURN;
/** Type for an AST projection node. */
extern const cypher_astnode_type_t CYPHER_AST_PROJECTION;
/** Type for an AST `ORDER BY` node. */
extern const cypher_astnode_type_t CYPHER_AST_ORDER_BY;
/** Type for an AST sort item node. */
extern const cypher_astnode_type_t CYPHER_AST_SORT_ITEM;
/** Type for an AST `UNION` clause node. */
extern const cypher_astnode_type_t CYPHER_AST_UNION;
/** Type for an AST expression node. */
extern const cypher_astnode_type_t CYPHER_AST_EXPRESSION;
/** Type for an AST unary operator node. */
extern const cypher_astnode_type_t CYPHER_AST_UNARY_OPERATOR;
/** Type for an AST binary operator node. */
extern const cypher_astnode_type_t CYPHER_AST_BINARY_OPERATOR;
/** Type for an AST n-ary comparison operator node. */
extern const cypher_astnode_type_t CYPHER_AST_COMPARISON;
/** Type for an AST apply operator node. */
extern const cypher_astnode_type_t CYPHER_AST_APPLY_OPERATOR;
/** Type for an AST apply * operator node. */
extern const cypher_astnode_type_t CYPHER_AST_APPLY_ALL_OPERATOR;
/** Type for an AST property operator node. */
extern const cypher_astnode_type_t CYPHER_AST_PROPERTY_OPERATOR;
/** Type for an AST subscript operator node. */
extern const cypher_astnode_type_t CYPHER_AST_SUBSCRIPT_OPERATOR;
/** Type for an AST subscript operator node. */
extern const cypher_astnode_type_t CYPHER_AST_SLICE_OPERATOR;
/** Type for an AST label check operator node. */
extern const cypher_astnode_type_t CYPHER_AST_LABELS_OPERATOR;
/** Type for an AST list comprehension node. */
extern const cypher_astnode_type_t CYPHER_AST_LIST_COMPREHENSION;
/** Type for an AST CASE expression node. */
extern const cypher_astnode_type_t CYPHER_AST_CASE;
/** Type for an AST filter expression node. */
extern const cypher_astnode_type_t CYPHER_AST_FILTER;
/** Type for an AST extract expression node. */
extern const cypher_astnode_type_t CYPHER_AST_EXTRACT;
/** Type for an AST reduce expression node. */
extern const cypher_astnode_type_t CYPHER_AST_REDUCE;
/** Type for an AST all predicate node. */
extern const cypher_astnode_type_t CYPHER_AST_ALL;
/** Type for an AST any predicate node. */
extern const cypher_astnode_type_t CYPHER_AST_ANY;
/** Type for an AST single predicate node. */
extern const cypher_astnode_type_t CYPHER_AST_SINGLE;
/** Type for an AST none predicate node. */
extern const cypher_astnode_type_t CYPHER_AST_NONE;
/** Type for an AST collection node. */
extern const cypher_astnode_type_t CYPHER_AST_COLLECTION;
/** Type for an AST literal map node. */
extern const cypher_astnode_type_t CYPHER_AST_MAP;
/** Type for an AST identifier node. */
extern const cypher_astnode_type_t CYPHER_AST_IDENTIFIER;
/** Type for an AST parameter node. */
extern const cypher_astnode_type_t CYPHER_AST_PARAMETER;
/** Type for an AST string literal node. */
extern const cypher_astnode_type_t CYPHER_AST_STRING;
/** Type for an AST integer literal node. */
extern const cypher_astnode_type_t CYPHER_AST_INTEGER;
/** Type for an AST float literal node. */
extern const cypher_astnode_type_t CYPHER_AST_FLOAT;
/** Type for an AST boolean literal node. */
extern const cypher_astnode_type_t CYPHER_AST_BOOLEAN;
/** Type for an AST TRUE literal node. */
extern const cypher_astnode_type_t CYPHER_AST_TRUE;
/** Type for an AST FALSE literal node. */
extern const cypher_astnode_type_t CYPHER_AST_FALSE;
/** Type for an AST NULL literal node. */
extern const cypher_astnode_type_t CYPHER_AST_NULL;
/** Type for an AST label node. */
extern const cypher_astnode_type_t CYPHER_AST_LABEL;
/** Type for an AST reltype node. */
extern const cypher_astnode_type_t CYPHER_AST_RELTYPE;
/** Type for an AST prop name node. */
extern const cypher_astnode_type_t CYPHER_AST_PROP_NAME;
/** Type for an AST function name node. */
extern const cypher_astnode_type_t CYPHER_AST_FUNCTION_NAME;
/** Type for an AST index name node. */
extern const cypher_astnode_type_t CYPHER_AST_INDEX_NAME;
/** Type for an AST procedure name node. */
extern const cypher_astnode_type_t CYPHER_AST_PROC_NAME;
/** Type for an AST pattern node. */
extern const cypher_astnode_type_t CYPHER_AST_PATTERN;
/** Type for an AST named pattern path node. */
extern const cypher_astnode_type_t CYPHER_AST_NAMED_PATH;
/** Type for an AST shortestPath node. */
extern const cypher_astnode_type_t CYPHER_AST_SHORTEST_PATH;
/** Type for an AST pattern path node. */
extern const cypher_astnode_type_t CYPHER_AST_PATTERN_PATH;
/** Type for an AST node pattern node. */
extern const cypher_astnode_type_t CYPHER_AST_NODE_PATTERN;
/** Type for an AST relationship pattern node. */
extern const cypher_astnode_type_t CYPHER_AST_REL_PATTERN;
/** Type for an AST range node. */
extern const cypher_astnode_type_t CYPHER_AST_RANGE;
/** Type for an AST command node. */
extern const cypher_astnode_type_t CYPHER_AST_COMMAND;
/** Type for an AST comment node. */
extern const cypher_astnode_type_t CYPHER_AST_COMMENT;
/** Type for an AST line comment node. */
extern const cypher_astnode_type_t CYPHER_AST_LINE_COMMENT;
/** Type for an AST block comment node. */
extern const cypher_astnode_type_t CYPHER_AST_BLOCK_COMMENT;
/** Type for an AST error node. */
extern const cypher_astnode_type_t CYPHER_AST_ERROR;
/**
* A cypher expression operator.
*/
typedef struct cypher_operator cypher_operator_t;
/** The infix binary `OR` operator. */
extern const cypher_operator_t *CYPHER_OP_OR;
/** The infix binary `XOR` operator. */
extern const cypher_operator_t *CYPHER_OP_XOR;
/** The infix binary `AND` operator. */
extern const cypher_operator_t *CYPHER_OP_AND;
/** The prefix unary `NOT` operator. */
extern const cypher_operator_t *CYPHER_OP_NOT;
/** The infix binary `=` operator. */
extern const cypher_operator_t *CYPHER_OP_EQUAL;
/** The infix binary `<>` operator. */
extern const cypher_operator_t *CYPHER_OP_NEQUAL;
/** The n-ary `<` operator. */
extern const cypher_operator_t *CYPHER_OP_LT;
/** The n-ary `>` operator. */
extern const cypher_operator_t *CYPHER_OP_GT;
/** The n-ary `<=` operator. */
extern const cypher_operator_t *CYPHER_OP_LTE;
/** The n-ary `>=` operator. */
extern const cypher_operator_t *CYPHER_OP_GTE;
/** The infix binary `+` operator. */
extern const cypher_operator_t *CYPHER_OP_PLUS;
/** The infix binary `-` operator. */
extern const cypher_operator_t *CYPHER_OP_MINUS;
/** The infix binary `*` operator. */
extern const cypher_operator_t *CYPHER_OP_MULT;
/** The infix binary `/` operator. */
extern const cypher_operator_t *CYPHER_OP_DIV;
/** The infix binary `%` operator. */
extern const cypher_operator_t *CYPHER_OP_MOD;
/** The infix binary `^` operator. */
extern const cypher_operator_t *CYPHER_OP_POW;
/** The prefix unary `+` operator. */
extern const cypher_operator_t *CYPHER_OP_UNARY_PLUS;
/** The prefix unary `-` operator. */
extern const cypher_operator_t *CYPHER_OP_UNARY_MINUS;
/** The postfix binary subscript (`[exp]`) operator. */
extern const cypher_operator_t *CYPHER_OP_SUBSCRIPT;
/** The infix binary `=~` operator. */
extern const cypher_operator_t *CYPHER_OP_REGEX;
/** The infix binary `IN` operator. */
extern const cypher_operator_t *CYPHER_OP_IN;
/** The infix binary `STARTS WITH` operator. */
extern const cypher_operator_t *CYPHER_OP_STARTS_WITH;
/** The infix binary `CONTAINS` operator. */
extern const cypher_operator_t *CYPHER_OP_CONTAINS;
/** The infix binary `IS NULL` operator. */
extern const cypher_operator_t *CYPHER_OP_IS_NULL;
/** The infix binary `IS NOT NULL` operator. */
extern const cypher_operator_t *CYPHER_OP_IS_NOT_NULL;
/** The infix binary property lookup (`l.r`) operator. */
extern const cypher_operator_t *CYPHER_OP_PROPERTY;
/** The n-ary label check (`l:r`) operator. */
extern const cypher_operator_t *CYPHER_OP_LABEL;
/**
* Get the type of an AST node.
*
* @param [node] The AST node.
* @return The type of the node.
*/
__cypherlang_pure
cypher_astnode_type_t cypher_astnode_type(const cypher_astnode_t *node);
/**
* Check the type of an AST node.
*
* @param [node] The AST node.
* @param [type] The AST node type.
* @return `true` if the node is of the specified type and `false` otherwise.
*/
__cypherlang_pure
bool cypher_astnode_instanceof(const cypher_astnode_t *node,
cypher_astnode_type_t type);
/**
* Get a string description of the AST node type.
*
* @param [type] The AST node type.
* @return A pointer to a null terminated string containing the type name.
*/
__cypherlang_pure
const char *cypher_astnode_typestr(cypher_astnode_type_t type);
/**
* Get the number of children from an AST node.
*
* @param [node] The AST node.
* @return The number of children.
*/
__cypherlang_pure
unsigned int cypher_astnode_nchildren(const cypher_astnode_t *node);
/**
* Get a child from an AST node.
*
* @param [node] The AST node.
* @param [index] The index of the child.
* @return A pointer to the child of the AST node, or `NULL` if there is no
* argument at the specified index.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_astnode_get_child(const cypher_astnode_t *node,
unsigned int index);
/**
* A position in the input.
*/
struct cypher_input_position
{
unsigned int line;
unsigned int column;
size_t offset;
};
extern const struct cypher_input_position cypher_input_position_zero;
/**
* A range in the input.
*/
struct cypher_input_range
{
struct cypher_input_position start;
struct cypher_input_position end;
};
/**
* Get the range of an AST node in the input.
*
* @param [node] The AST node.
* @return The range.
*/
__cypherlang_pure
struct cypher_input_range cypher_astnode_range(const cypher_astnode_t *node);
/**
* The direction of a relationship pattern.
*/
enum cypher_rel_direction
{
CYPHER_REL_INBOUND,
CYPHER_REL_OUTBOUND,
CYPHER_REL_BIDIRECTIONAL
};
/**
* Construct a `CYPHER_AST_STATEMENT` node.
*
* @param [options] Options for the statement, all of type
* `CYPHER_AST_STATEMENT_OPTION`.
* @param [noptions] The number of options (may be zero).
* @param [body] The body of the statement, which must be either an
* `CYPHER_AST_QUERY` or `CYPHER_AST_SCHEMA_COMMAND`.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_statement(cypher_astnode_t * const *options,
unsigned int noptions, const cypher_astnode_t *body,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the number of options in a `CYPHER_AST_STATEMENT` node.
*
* If the node is not an instance of `CYPHER_AST_STATEMENT` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of options.
*/
__cypherlang_pure
unsigned int cypher_ast_statement_noptions(const cypher_astnode_t *node);
/**
* Get an option of a `CYPHER_AST_STATEMENT` node.
*
* If the node is not an instance of `CYPHER_AST_STATEMENT` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the option.
* @return A `CYPHER_AST_STATEMENT_OPTION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_statement_get_option(
const cypher_astnode_t *node, unsigned int index);
/**
* Get the body of a `CYPHER_AST_STATEMENT` node.
*
* If the node is not an instance of `CYPHER_AST_STATEMENT` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_QUERY` or `CYPHER_AST_SCHEMA_COMMAND` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_statement_get_body(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_CYPHER_OPTION` node.
*
* The node will also be an instance of `CYPHER_AST_STATEMENT_OPTION`.
*
* @param [version] A version node of type `CYPHER_AST_STRING`, or
* null.
* @param [params] Parameters for the option, all of type
* `CYPHER_AST_CYPHER_OPTION_PARAM`.
* @param [nparams] The number of parameters (maybe zero).
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_cypher_option(const cypher_astnode_t *version,
cypher_astnode_t * const *params, unsigned int nparams,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the version of a `CYPHER_AST_CYPHER_OPTION` node.
*
* If the node is not an instance of `CYPHER_AST_CYPHER_OPTION` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_STRING` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_cypher_option_get_version(
const cypher_astnode_t *node);
/**
* Get the number of parameters in a `CYPHER_AST_CYPHER_OPTION` node.
*
* If the node is not an instance of `CYPHER_AST_CYPHER_OPTION` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return The number of parameters.
*/
__cypherlang_pure
unsigned int cypher_ast_cypher_option_nparams(const cypher_astnode_t *node);
/**
* Get an option of a `CYPHER_AST_CYPHER_OPTION` node.
*
* If the node is not an instance of `CYPHER_AST_CYPHER_OPTION` then the result
* will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the parameter.
* @return A `CYPHER_AST_CYPHER_OPTION_PARAM` node, or null if no parameter
* is at the specified index.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_cypher_option_get_param(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_CYPHER_OPTION_PARAM` node.
*
* @param [name] A parameter name node, of type `CYPHER_AST_STRING`.
* @param [value] A parameter value node, of type `CYPHER_AST_STRING`.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_cypher_option_param(const cypher_astnode_t *name,
const cypher_astnode_t *value, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get an name of a `CYPHER_AST_CYPHER_OPTION_PARAM` node.
*
* If the node is not an instance of `CYPHER_AST_CYPHER_OPTION_PARAM` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_STRING` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_cypher_option_param_get_name(
const cypher_astnode_t *node);
/**
* Get an value of a `CYPHER_AST_CYPHER_OPTION_PARAM` node.
*
* If the node is not an instance of `CYPHER_AST_CYPHER_OPTION_PARAM` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_STRING` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_cypher_option_param_get_value(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_EXPLAIN_OPTION` node.
*
* The node will also be an instance of `CYPHER_AST_STATEMENT_OPTION`.
*
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_explain_option(cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_PROFILE_OPTION` node.
*
* The node will also be an instance of `CYPHER_AST_STATEMENT_OPTION`.
*
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_profile_option(cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_CREATE_NODE_PROP_INDEX` node.
*
* The node will also be an instance of `CYPHER_AST_SCHEMA_COMMAND`.
*
* @param [label] A label node, of type `CYPHER_AST_LABEL`.
* @param [prop_name] A property name node, of type `CYPHER_AST_PROP_NAME`.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_create_node_prop_index(
const cypher_astnode_t *label, const cypher_astnode_t *prop_name,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the label of a `CYPHER_AST_CREATE_NODE_PROP_INDEX` node.
*
* If the node is not an instance of `CYPHER_AST_CREATE_NODE_PROP_INDEX` then
* the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_LABEL` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_create_node_prop_index_get_label(
const cypher_astnode_t *node);
/**
* Get the property name of a `CYPHER_AST_CREATE_NODE_PROP_INDEX` node.
*
* If the node is not an instance of `CYPHER_AST_CREATE_NODE_PROP_INDEX` then
* the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PROP_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_create_node_prop_index_get_prop_name(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_DROP_NODE_PROP_INDEX` node.
*
* The node will also be an instance of `CYPHER_AST_SCHEMA_COMMAND`.
*
* @param [label] A label node, of type `CYPHER_AST_LABEL`.
* @param [prop_name] A property name node, of type `CYPHER_AST_PROP_NAME`.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_drop_node_prop_index(const cypher_astnode_t *label,
const cypher_astnode_t *prop_name, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the label of a `CYPHER_AST_DROP_NODE_PROP_INDEX` node.
*
* If the node is not an instance of `CYPHER_AST_DROP_NODE_PROP_INDEX` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_LABEL` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_drop_node_prop_index_get_label(
const cypher_astnode_t *node);
/**
* Get the property name of a `CYPHER_AST_DROP_NODE_PROP_INDEX` node.
*
* If the node is not an instance of `CYPHER_AST_DROP_NODE_PROP_INDEX` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PROP_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_drop_node_prop_index_get_prop_name(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_CREATE_NODE_PROP_CONSTRAINT` node.
*
* The node will also be an instance of `CYPHER_AST_SCHEMA_COMMAND`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [label] A `CYPHER_AST_LABEL` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [unique] `true` if the constraint is unique, and `false` otherwise.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_create_node_prop_constraint(
const cypher_astnode_t *identifier, const cypher_astnode_t *label,
const cypher_astnode_t *expression, bool unique,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_CREATE_NODE_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_CREATE_NODE_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_create_node_prop_constraint_get_identifier(
const cypher_astnode_t *node);
/**
* Get the label of a `CYPHER_AST_CREATE_NODE_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_CREATE_NODE_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_LABEL` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_create_node_prop_constraint_get_label(
const cypher_astnode_t *node);
/**
* Get the expression of a `CYPHER_AST_CREATE_NODE_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_CREATE_NODE_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_create_node_prop_constraint_get_expression(
const cypher_astnode_t *node);
/**
* Check if the constraint of a `CYPHER_AST_CREATE_NODE_PROP_CONSTRAINT` node is unique.
*
* If the node is not an instance of `CYPHER_AST_CREATE_NODE_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return `true` if the constraint is unique, and `false` otherwise.
*/
bool cypher_ast_create_node_prop_constraint_is_unique(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_DROP_NODE_PROP_CONSTRAINT` node.
*
* The node will also be an instance of `CYPHER_AST_SCHEMA_COMMAND`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [label] A `CYPHER_AST_LABEL` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [unique] `true` if the constraint is unique, and `false` otherwise.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_drop_node_prop_constraint(
const cypher_astnode_t *identifier, const cypher_astnode_t *label,
const cypher_astnode_t *expression, bool unique,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_DROP_NODE_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_DROP_NODE_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_drop_node_prop_constraint_get_identifier(
const cypher_astnode_t *node);
/**
* Get the label of a `CYPHER_AST_DROP_NODE_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_DROP_NODE_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_LABEL` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_drop_node_prop_constraint_get_label(
const cypher_astnode_t *node);
/**
* Get the expression of a `CYPHER_AST_DROP_NODE_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_DROP_NODE_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_drop_node_prop_constraint_get_expression(
const cypher_astnode_t *node);
/**
* Check if the constraint of a `CYPHER_AST_DROP_NODE_PROP_CONSTRAINT` node is unique.
*
* If the node is not an instance of `CYPHER_AST_DROP_NODE_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return `true` if the constraint is unique, and `false` otherwise.
*/
bool cypher_ast_drop_node_prop_constraint_is_unique(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_CREATE_REL_PROP_CONSTRAINT` node.
*
* The node will also be an instance of `CYPHER_AST_SCHEMA_COMMAND`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [label] A `CYPHER_AST_LABEL` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [unique] `true` if the constraint is unique, and `false` otherwise.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_create_rel_prop_constraint(
const cypher_astnode_t *identifier, const cypher_astnode_t *label,
const cypher_astnode_t *expression, bool unique,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_CREATE_REL_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_CREATE_REL_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_create_rel_prop_constraint_get_identifier(
const cypher_astnode_t *node);
/**
* Get the relationship type of a `CYPHER_AST_CREATE_REL_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_CREATE_REL_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_RELTYPE` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_create_rel_prop_constraint_get_reltype(
const cypher_astnode_t *node);
/**
* Get the expression of a `CYPHER_AST_CREATE_REL_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_CREATE_REL_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_create_rel_prop_constraint_get_expression(
const cypher_astnode_t *node);
/**
* Check if the constraint of a `CYPHER_AST_CREATE_REL_PROP_CONSTRAINT` node is unique.
*
* If the node is not an instance of `CYPHER_AST_CREATE_REL_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return `true` if the constraint is unique, and `false` otherwise.
*/
bool cypher_ast_create_rel_prop_constraint_is_unique(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_DROP_REL_PROP_CONSTRAINT` node.
*
* The node will also be an instance of `CYPHER_AST_SCHEMA_COMMAND`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [label] A `CYPHER_AST_LABEL` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [unique] `true` if the constraint is unique, and `false` otherwise.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_drop_rel_prop_constraint(
const cypher_astnode_t *identifier, const cypher_astnode_t *label,
const cypher_astnode_t *expression, bool unique,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_DROP_REL_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_DROP_REL_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_drop_rel_prop_constraint_get_identifier(
const cypher_astnode_t *node);
/**
* Get the relationship type of a `CYPHER_AST_DROP_REL_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_DROP_REL_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_RELTYPE` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_drop_rel_prop_constraint_get_reltype(
const cypher_astnode_t *node);
/**
* Get the expression of a `CYPHER_AST_DROP_REL_PROP_CONSTRAINT` node.
*
* If the node is not an instance of `CYPHER_AST_DROP_REL_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_drop_rel_prop_constraint_get_expression(
const cypher_astnode_t *node);
/**
* Check if the constraint of a `CYPHER_AST_DROP_REL_PROP_CONSTRAINT` node is unique.
*
* If the node is not an instance of `CYPHER_AST_DROP_REL_PROP_CONSTRAINT`
* then the result will be undefined.
*
* @param [node] The AST node.
* @return `true` if the constraint is unique, and `false` otherwise.
*/
bool cypher_ast_drop_rel_prop_constraint_is_unique(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_QUERY` node.
*
* @param [options] Options for the query, all of type
* `CYPHER_AST_QUERY_OPTION`.
* @param [noptions] The number of options (may be zero).
* @param [clauses] Clauses for the query, all of type
* `CYPHER_AST_QUERY_CLAUSE`.
* @param [nclauses] The number of clauses.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_query(cypher_astnode_t * const *options,
unsigned int noptions, cypher_astnode_t * const *clauses,
unsigned int nclauses, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the number of options in a `CYPHER_AST_QUERY` node.
*
* If the node is not an instance of `CYPHER_AST_QUERY` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of options.
*/
__cypherlang_pure
unsigned int cypher_ast_query_noptions(const cypher_astnode_t *node);
/**
* Get an option of a `CYPHER_AST_QUERY` node.
*
* If the node is not an instance of `CYPHER_AST_QUERY` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the option.
* @return A `CYPHER_AST_QUERY_OPTION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_query_get_option(
const cypher_astnode_t *node, unsigned int index);
/**
* Get the number of clauses in a `CYPHER_AST_QUERY` node.
*
* If the node is not an instance of `CYPHER_AST_QUERY` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of clauses.
*/
__cypherlang_pure
unsigned int cypher_ast_query_nclauses(const cypher_astnode_t *node);
/**
* Get a clause of a `CYPHER_AST_QUERY` node.
*
* If the node is not an instance of `CYPHER_AST_QUERY` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the clause.
* @return A `CYPHER_AST_QUERY_OPTION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_query_get_clause(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_USING_PERIODIC_COMMIT` node.
*
* The node will also be an instance of `CYPHER_AST_QUERY_OPTION`.
*
* @param [limit] A `CYPHER_AST_INTEGER`, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_using_periodic_commit(
const cypher_astnode_t *limit, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the limit of a `CYPHER_AST_USING_PERIODIC_COMMIT` node.
*
* If the node is not an instance of `CYPHER_AST_USING_PERIODIC_COMMIT` then
* the result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_INTEGER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_using_periodic_commit_get_limit(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_LOAD_CSV` node.
*
* The node will also be an instance of `CYPHER_AST_QUERY_CLAUSE`.
*
* @param [with_headers] `true` if the `WITH HEADERS` option is enabled, and
* `false` otherwise.
* @param [url] A `CYPHER_AST_EXPRESSION` node.
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [field_terminator] A `CYPHER_AST_STRING` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_load_csv(bool with_headers,
const cypher_astnode_t *url, const cypher_astnode_t *identifier,
const cypher_astnode_t *field_terminator, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Check the with_headers value of a `CYPHER_AST_LOAD_CSV` node.
*
* If the node is not an instance of `CYPHER_AST_LOAD_CSV` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return `true` if the `WITH HEADERS` option is enabled,
* and `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_load_csv_has_with_headers(const cypher_astnode_t *node);
/**
* Get the url of a `CYPHER_AST_LOAD_CSV` node.
*
* If the node is not an instance of `CYPHER_AST_LOAD_CSV` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_load_csv_get_url(
const cypher_astnode_t *node);
/**
* Get the identifier of a `CYPHER_AST_LOAD_CSV` node.
*
* If the node is not an instance of `CYPHER_AST_LOAD_CSV` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_load_csv_get_identifier(
const cypher_astnode_t *node);
/**
* Get the field terminator of a `CYPHER_AST_LOAD_CSV` node.
*
* If the node is not an instance of `CYPHER_AST_LOAD_CSV` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_STRING` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_load_csv_get_field_terminator(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_START` node.
*
* The node will also be an instance of `CYPHER_AST_QUERY_CLAUSE`.
*
* @param [points] Start points for the statement, all of type
* `CYPHER_AST_START_POINT`.
* @param [npoints] The number of start points.
* @param [predicate] A `CYPHER_AST_EXPRESSION`, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_start(cypher_astnode_t * const *points,
unsigned int npoints, const cypher_astnode_t *predicate,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the number of start points in a `CYPHER_AST_START` node.
*
* If the node is not an instance of `CYPHER_AST_START` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of start points.
*/
__cypherlang_pure
unsigned int cypher_ast_start_npoints(const cypher_astnode_t *node);
/**
* Get a start point of a `CYPHER_AST_START` node.
*
* If the node is not an instance of `CYPHER_AST_START` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the start point.
* @return A `CYPHER_AST_QUERY_OPTION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_start_get_point(
const cypher_astnode_t *node, unsigned int index);
/**
* Get the predicate of a `CYPHER_AST_START` node.
*
* If the node is not an instance of `CYPHER_AST_START` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_start_get_predicate(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_NODE_INDEX_LOOKUP` node.
*
* The node will also be an instance of `CYPHER_AST_START_POINT`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [index_name] A `CYPHER_AST_INDEX_NAME` node.
* @param [prop_name] A `CYPHER_AST_PROP_NAME` node.
* @param [lookup] A `CYPHER_AST_STRING` or `CYPHER_AST_PARAMETER` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_node_index_lookup(
const cypher_astnode_t *identifier, const cypher_astnode_t *index_name,
const cypher_astnode_t *prop_name, const cypher_astnode_t *lookup,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_NODE_INDEX_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_INDEX_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_index_lookup_get_identifier(
const cypher_astnode_t *node);
/**
* Get the index name of a `CYPHER_AST_NODE_INDEX_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_INDEX_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_INDEX_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_index_lookup_get_index_name(
const cypher_astnode_t *node);
/**
* Get the prop name of a `CYPHER_AST_NODE_INDEX_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_INDEX_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PROP_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_index_lookup_get_prop_name(
const cypher_astnode_t *node);
/**
* Get the lookup of a `CYPHER_AST_NODE_INDEX_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_INDEX_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_STRING` or `CYPHER_AST_PARAMETER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_index_lookup_get_lookup(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_NODE_INDEX_QUERY` node.
*
* The node will also be an instance of `CYPHER_AST_START_POINT`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [index_name] A `CYPHER_AST_INDEX_NAME` node.
* @param [query] A `CYPHER_AST_STRING` or `CYPHER_AST_PARAMETER` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_node_index_query(
const cypher_astnode_t *identifier, const cypher_astnode_t *index_name,
const cypher_astnode_t *query, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_NODE_INDEX_QUERY` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_INDEX_QUERY` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_index_query_get_identifier(
const cypher_astnode_t *node);
/**
* Get the index name of a `CYPHER_AST_NODE_INDEX_QUERY` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_INDEX_QUERY` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_INDEX_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_index_query_get_index_name(
const cypher_astnode_t *node);
/**
* Get the query of a `CYPHER_AST_NODE_INDEX_QUERY` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_INDEX_QUERY` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_STRING` or `CYPHER_AST_PARAMETER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_index_query_get_query(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_NODE_ID_LOOKUP` node.
*
* The node will also be an instance of `CYPHER_AST_START_POINT`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [ids] Node IDs for lookup, all of type `CYPHER_AST_INTEGER`.
* @param [nids] The number of node IDs.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_node_id_lookup(const cypher_astnode_t *identifier,
cypher_astnode_t * const *ids, unsigned int nids,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_NODE_ID_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_ID_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_id_lookup_get_identifier(
const cypher_astnode_t *node);
/**
* Get the number of ids in a `CYPHER_AST_NODE_ID_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_ID_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return The number of ids.
*/
__cypherlang_pure
unsigned int cypher_ast_node_id_lookup_nids(const cypher_astnode_t *node);
/**
* Get an id of a `CYPHER_AST_NODE_ID_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_ID_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the id.
* @return A `CYPHER_AST_INTEGER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_id_lookup_get_id(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_ALL_NODES_SCAN` node.
*
* The node will also be an instance of `CYPHER_AST_START_POINT`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_all_nodes_scan(const cypher_astnode_t *identifier,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_ALL_NODES_SCAN` node.
*
* If the node is not an instance of `CYPHER_AST_ALL_NODES_SCAN` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_all_nodes_scan_get_identifier(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_REL_INDEX_LOOKUP` node.
*
* The node will also be an instance of `CYPHER_AST_START_POINT`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [index_name] A `CYPHER_AST_INDEX_NAME` node.
* @param [prop_name] A `CYPHER_AST_PROP_NAME` node.
* @param [lookup] A `CYPHER_AST_STRING` or `CYPHER_AST_PARAMETER` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_rel_index_lookup(
const cypher_astnode_t *identifier, const cypher_astnode_t *index_name,
const cypher_astnode_t *prop_name, const cypher_astnode_t *lookup,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_REL_INDEX_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_REL_INDEX_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_index_lookup_get_identifier(
const cypher_astnode_t *node);
/**
* Get the index name of a `CYPHER_AST_REL_INDEX_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_REL_INDEX_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_INDEX_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_index_lookup_get_index_name(
const cypher_astnode_t *node);
/**
* Get the prop name of a `CYPHER_AST_REL_INDEX_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_REL_INDEX_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PROP_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_index_lookup_get_prop_name(
const cypher_astnode_t *node);
/**
* Get the lookup of a `CYPHER_AST_REL_INDEX_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_REL_INDEX_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_STRING` or `CYPHER_AST_PARAMETER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_index_lookup_get_lookup(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_REL_INDEX_QUERY` node.
*
* The node will also be an instance of `CYPHER_AST_START_POINT`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [index_name] A `CYPHER_AST_INDEX_NAME` node.
* @param [query] A `CYPHER_AST_STRING` or `CYPHER_AST_PARAMETER` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_rel_index_query(
const cypher_astnode_t *identifier, const cypher_astnode_t *index_name,
const cypher_astnode_t *query, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_REL_INDEX_QUERY` node.
*
* If the node is not an instance of `CYPHER_AST_REL_INDEX_QUERY` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_index_query_get_identifier(
const cypher_astnode_t *node);
/**
* Get the index name of a `CYPHER_AST_REL_INDEX_QUERY` node.
*
* If the node is not an instance of `CYPHER_AST_REL_INDEX_QUERY` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_INDEX_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_index_query_get_index_name(
const cypher_astnode_t *node);
/**
* Get the query of a `CYPHER_AST_REL_INDEX_QUERY` node.
*
* If the node is not an instance of `CYPHER_AST_REL_INDEX_QUERY` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_STRING` or `CYPHER_AST_PARAMETER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_index_query_get_query(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_REL_ID_LOOKUP` node.
*
* The node will also be an instance of `CYPHER_AST_START_POINT`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [ids] Node IDs for lookup, all of type `CYPHER_AST_INTEGER`.
* @param [nids] The number of node IDs.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_rel_id_lookup(const cypher_astnode_t *identifier,
cypher_astnode_t * const *ids, unsigned int nids,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_REL_ID_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_REL_ID_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_id_lookup_get_identifier(
const cypher_astnode_t *node);
/**
* Get the number of ids in a `CYPHER_AST_REL_ID_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_REL_ID_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return The number of ids.
*/
__cypherlang_pure
unsigned int cypher_ast_rel_id_lookup_nids(const cypher_astnode_t *node);
/**
* Get an id of a `CYPHER_AST_REL_ID_LOOKUP` node.
*
* If the node is not an instance of `CYPHER_AST_REL_ID_LOOKUP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the id.
* @return A `CYPHER_AST_INTEGER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_id_lookup_get_id(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_ALL_RELS_SCAN` node.
*
* The node will also be an instance of `CYPHER_AST_START_POINT`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_all_rels_scan(const cypher_astnode_t *identifier,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_ALL_RELS_SCAN` node.
*
* If the node is not an instance of `CYPHER_AST_ALL_RELS_SCAN` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_all_rels_scan_get_identifier(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_MATCH` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [optional] `true` if the node represents an `OPTIONAL MATCH`, and
* `false` otherwise.
* @param [pattern] A `CYPHER_AST_PATTERN` node.
* @param [hints] Hints for lookup, all of type `CYPHER_AST_MATCH_HINT`.
* @param [nhints] The number of match hints.
* @param [predicate] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_match(bool optional,
const cypher_astnode_t *pattern, cypher_astnode_t * const *hints,
unsigned int nhints, const cypher_astnode_t *predicate,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Check if the optional value of a `CYPHER_AST_MATCH` node is set.
*
* If the node is not an instance of `CYPHER_AST_MATCH` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return `true` if the `OPTIONAL MATCH` option is enabled,
* and `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_match_is_optional(const cypher_astnode_t *node);
/**
* Get the pattern of a `CYPHER_AST_MATCH` node.
*
* If the node is not an instance of `CYPHER_AST_MATCH` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PATTERN` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_match_get_pattern(
const cypher_astnode_t *node);
/**
* Get the number of hints in a `CYPHER_AST_MATCH` node.
*
* If the node is not an instance of `CYPHER_AST_MATCH` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return The number of hints.
*/
__cypherlang_pure
unsigned int cypher_ast_match_nhints(const cypher_astnode_t *node);
/**
* Get a hint from a `CYPHER_AST_MATCH` node.
*
* If the node is not an instance of `CYPHER_AST_MATCH` then the result will be
* undefined.
*
* @param [node] The AST node.
* @param [index] The index of the hint.
* @return A `CYPHER_AST_MATCH_HINT` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_match_get_hint(
const cypher_astnode_t *node, unsigned int index);
/**
* Get the predicate of a `CYPHER_AST_PREDICATE` node.
*
* If the node is not an instance of `CYPHER_AST_PREDICATE` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PREDICATE` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_match_get_predicate(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_USING_INDEX` node.
*
* The node will also be an instance of `CYPHER_AST_MATCH_HINT`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [label] A `CYPHER_AST_LABEL` node.
* @param [prop_name] A `CYPHER_AST_PROP_NAME` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_using_index(const cypher_astnode_t *identifier,
const cypher_astnode_t *label, const cypher_astnode_t *prop_name,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifer of a `CYPHER_AST_USING_INDEX` node.
*
* If the node is not an instance of `CYPHER_AST_USING_INDEX` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_using_index_get_identifier(
const cypher_astnode_t *node);
/**
* Get the label of a `CYPHER_AST_USING_INDEX` node.
*
* If the node is not an instance of `CYPHER_AST_USING_INDEX` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_using_index_get_label(
const cypher_astnode_t *node);
/**
* Get the label of a `CYPHER_AST_USING_INDEX` node.
*
* If the node is not an instance of `CYPHER_AST_USING_INDEX` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PROP_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_using_index_get_prop_name(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_USING_JOIN` node.
*
* The node will also be an instance of `CYPHER_AST_MATCH_HINT`.
*
* @param [identifiers] Identifiers for the hint, all of type
* `CYPHER_AST_IDENTIFIER`.
* @param [nidentifiers] The number of identifiers
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_using_join(
cypher_astnode_t * const *identifiers, unsigned int nidentifiers,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the number of identifiers in a `CYPHER_AST_USING_JOIN` node.
*
* If the node is not an instance of `CYPHER_AST_USING_JOIN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return The number of identifiers.
*/
__cypherlang_pure
unsigned int cypher_ast_using_join_nidentifiers(const cypher_astnode_t *node);
/**
* Get a identifier from a `CYPHER_AST_USING_JOIN` node.
*
* If the node is not an instance of `CYPHER_AST_USING_JOIN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the identifier.
* @return A `CYPHER_AST_IDENTIFIER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_using_join_get_identifier(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_USING_SCAN` node.
*
* The node will also be an instance of `CYPHER_AST_MATCH_HINT`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [label] A `CYPHER_AST_LABEL` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_using_scan(const cypher_astnode_t *identifier,
const cypher_astnode_t *label, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the identifer of a `CYPHER_AST_USING_SCAN` node.
*
* If the node is not an instance of `CYPHER_AST_USING_SCAN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_using_scan_get_identifier(
const cypher_astnode_t *node);
/**
* Get the label of a `CYPHER_AST_USING_SCAN` node.
*
* If the node is not an instance of `CYPHER_AST_USING_SCAN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_using_scan_get_label(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_MERGE` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [path] A `CYPHER_AST_PATTERN_PATH` node.
* @param [actions] Actions for merge, all of type `CYPHER_AST_MERGE_ACTION`.
* @param [nactions] The number of match actions.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_merge(const cypher_astnode_t *path,
cypher_astnode_t * const *actions, unsigned int nactions,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the pattern path of a `CYPHER_AST_MERGE` node.
*
* If the node is not an instance of `CYPHER_AST_MERGE` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PATTERN_PATH` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_merge_get_pattern_path(
const cypher_astnode_t *node);
/**
* Get the number of actions in a `CYPHER_AST_MERGE` node.
*
* If the node is not an instance of `CYPHER_AST_MERGE` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return The number of actions.
*/
__cypherlang_pure
unsigned int cypher_ast_merge_nactions(const cypher_astnode_t *node);
/**
* Get an action from a `CYPHER_AST_MERGE` node.
*
* If the node is not an instance of `CYPHER_AST_MERGE` then the result will be
* undefined.
*
* @param [node] The AST node.
* @param [index] The index of the action.
* @return A `CYPHER_AST_MERGE_HINT` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_merge_get_action(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_ON_MATCH` node.
*
* The node will also be an instance of `CYPHER_AST_MERGE_ACTION`.
*
* @param [items] Items for `ON MATCH`, all of type `CYPHER_AST_SET_ITEM`.
* @param [nitems] The number of `ON MATCH` items.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_on_match(cypher_astnode_t * const *items,
unsigned int nitems, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the number of items in a `CYPHER_AST_ON_MATCH` node.
*
* If the node is not an instance of `CYPHER_AST_ON_MATCH` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of items.
*/
__cypherlang_pure
unsigned int cypher_ast_on_match_nitems(const cypher_astnode_t *node);
/**
* Get an item from a `CYPHER_AST_ON_MATCH` node.
*
* If the node is not an instance of `CYPHER_AST_ON_MATCH` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the action.
* @return A `CYPHER_AST_SET_ITEM` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_on_match_get_item(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_ON_CREATE` node.
*
* The node will also be an instance of `CYPHER_AST_MERGE_ACTION`.
*
* @param [items] Items for `ON CREATE`, all of type `CYPHER_AST_SET_ITEM`.
* @param [nitems] The number of `ON CREATE` items.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_on_create(cypher_astnode_t * const *items,
unsigned int nitems, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the number of items in a `CYPHER_AST_ON_CREATE` node.
*
* If the node is not an instance of `CYPHER_AST_ON_CREATE` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return The number of items.
*/
__cypherlang_pure
unsigned int cypher_ast_on_create_nitems(const cypher_astnode_t *node);
/**
* Get an item from a `CYPHER_AST_ON_CREATE` node.
*
* If the node is not an instance of `CYPHER_AST_ON_CREATE` then the result
* will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the action.
* @return A `CYPHER_AST_SET_ITEM` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_on_create_get_item(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_CREATE` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [unique] `true` if the create is unique, `false` otherwise.
* @param [pattern] A `CYPHER_AST_PATTERN` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_create(bool unique,
const cypher_astnode_t *pattern, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Check if the unique value of a `CYPHER_AST_CREATE` node is set.
*
* If the node is not an instance of `CYPHER_AST_CREATE` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return `true` if the `UNIQUE` option is enabled, and `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_create_is_unique(const cypher_astnode_t *node);
/**
* Get the pattern of a `CYPHER_AST_CREATE` node.
*
* If the node is not an instance of `CYPHER_AST_CREATE` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PATTERN` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_create_get_pattern(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_SET` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [items] Items for `SET`, all of type `CYPHER_AST_SET_ITEM`.
* @param [nitems] The number of `SET` items.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_set(cypher_astnode_t * const *items,
unsigned int nitems, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the number of items in a `CYPHER_AST_SET` node.
*
* If the node is not an instance of `CYPHER_AST_SET` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return The number of items.
*/
__cypherlang_pure
unsigned int cypher_ast_set_nitems(const cypher_astnode_t *node);
/**
* Get an item from a `CYPHER_AST_SET` node.
*
* If the node is not an instance of `CYPHER_AST_SET` then the result will be
* undefined.
*
* @param [node] The AST node.
* @param [index] The index of the action.
* @return A `CYPHER_AST_SET_ITEM` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_set_get_item(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_SET_PROPERTY` node.
*
* The node will also be an instance of `CYPHER_AST_SET_ITEM`.
*
* @param [property] A `CYPHER_AST_PROPERTY_OPERATOR` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_set_property(const cypher_astnode_t *property,
const cypher_astnode_t *expression, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the property operator of a `CYPHER_AST_SET_PROPERTY` node.
*
* If the node is not an instance of `CYPHER_AST_SET_PROPERTY` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PROPERTY_OPERATOR` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_set_property_get_property(
const cypher_astnode_t *node);
/**
* Get the expression of a `CYPHER_AST_SET_PROPERTY` node.
*
* If the node is not an instance of `CYPHER_AST_SET_PROPERTY` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_set_property_get_expression(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_SET_ALL_PROPERTIES` node.
*
* The node will also be an instance of `CYPHER_AST_SET_ITEM`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_set_all_properties(
const cypher_astnode_t *identifier, const cypher_astnode_t *expression,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_SET_ALL_PROPERTIES` node.
*
* If the node is not an instance of `CYPHER_AST_SET_ALL_PROPERTIES` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_set_all_properties_get_identifier(
const cypher_astnode_t *node);
/**
* Get the expression of a `CYPHER_AST_SET_ALL_PROPERTIES` node.
*
* If the node is not an instance of `CYPHER_AST_SET_ALL_PROPERTIES` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_set_all_properties_get_expression(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_MERGE_PROPERTIES` node.
*
* The node will also be an instance of `CYPHER_AST_SET_ITEM`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_merge_properties(
const cypher_astnode_t *identifier, const cypher_astnode_t *expression,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_MERGE_PROPERTIES` node.
*
* If the node is not an instance of `CYPHER_AST_MERGE_PROPERTIES` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_merge_properties_get_identifier(
const cypher_astnode_t *node);
/**
* Get the expression of a `CYPHER_AST_MERGE_PROPERTIES` node.
*
* If the node is not an instance of `CYPHER_AST_MERGE_PROPERTIES` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_merge_properties_get_expression(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_SET_LABELS` node.
*
* The node will also be an instance of `CYPHER_AST_SET_ITEM`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [labels] The labels to be set, which must all be of type
* `CYPHER_AST_LABEL`.
* @param [nlabels] The number of labels to be set.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_set_labels(const cypher_astnode_t *identifier,
cypher_astnode_t * const *labels, unsigned int nlabels,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_SET_LABELS` node.
*
* If the node is not an instance of `CYPHER_AST_SET_LABELS` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_set_labels_get_identifier(
const cypher_astnode_t *node);
/**
* Get the number of labels in a `CYPHER_AST_SET_LABELS` node.
*
* If the node is not an instance of `CYPHER_AST_SET_LABELS` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return The number of labels.
*/
__cypherlang_pure
unsigned int cypher_ast_set_labels_nlabels(const cypher_astnode_t *node);
/**
* Get a label from a `CYPHER_AST_SET_LABELS` node.
*
* If the node is not an instance of `CYPHER_AST_SET_LABELS` then the result
* will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the label.
* @return A `CYPHER_AST_LABEL` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_set_labels_get_label(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_DELETE` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [detach] `true` if the `DETACH` option is present, `false` otherwise.
* @param [expressions] Expressions for `DELETE`, all of type
* `CYPHER_AST_EXPRESSION`.
* @param [nexpressions] The number of expressions.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_delete(bool detach,
cypher_astnode_t * const *expressions, unsigned int nexpressions,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Check if `DETACH` is present for a `CYPHER_AST_DELETE` node.
*
* If the node is not an instance of `CYPHER_AST_DELETE` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return `true` if `DETACH` is present, `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_delete_has_detach(const cypher_astnode_t *node);
/**
* Get the number of expression in a `CYPHER_AST_DELETE` node.
*
* If the node is not an instance of `CYPHER_AST_DELETE` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of expression.
*/
__cypherlang_pure
unsigned int cypher_ast_delete_nexpressions(const cypher_astnode_t *node);
/**
* Get an expression from a `CYPHER_AST_DELETE` node.
*
* If the node is not an instance of `CYPHER_AST_DELETE` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the expression.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_delete_get_expression(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_REMOVE` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [items] Items for `REMOVE`, all of type `CYPHER_AST_REMOVE_ITEM`.
* @param [nitems] The number of items.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_remove(cypher_astnode_t * const *items,
unsigned int nitems, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the number of items in a `CYPHER_AST_REMOVE` node.
*
* If the node is not an instance of `CYPHER_AST_REMOVE` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of items.
*/
__cypherlang_pure
unsigned int cypher_ast_remove_nitems(const cypher_astnode_t *node);
/**
* Get an item from a `CYPHER_AST_REMOVE` node.
*
* If the node is not an instance of `CYPHER_AST_REMOVE` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the item.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_remove_get_item(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_REMOVE_LABELS` node.
*
* The node will also be an instance of `CYPHER_AST_REMOVE_ITEM`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [labels] Labels to remove, all of type `CYPHER_AST_LABEL`.
* @param [nlabels] The number of labels.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_remove_labels(const cypher_astnode_t *identifier,
cypher_astnode_t * const *labels, unsigned int nlabels,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_REMOVE_LABELS` node.
*
* If the node is not an instance of `CYPHER_AST_REMOVE_LABELS` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_remove_labels_get_identifier(
const cypher_astnode_t *node);
/**
* Get the number of labels in a `CYPHER_AST_REMOVE_LABELS` node.
*
* If the node is not an instance of `CYPHER_AST_REMOVE_LABELS` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return The number of labels.
*/
__cypherlang_pure
unsigned int cypher_ast_remove_labels_nlabels(const cypher_astnode_t *node);
/**
* Get a label from a `CYPHER_AST_REMOVE_LABELS` node.
*
* If the node is not an instance of `CYPHER_AST_REMOVE_LABELS` then the result
* will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the label.
* @return A `CYPHER_AST_LABEL` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_remove_labels_get_label(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_REMOVE_PROPERTY` node.
*
* The node will also be an instance of `CYPHER_AST_REMOVE_ITEM`.
*
* @param [property] A `CYPHER_AST_PROPERTY_OPERATOR` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_remove_property(const cypher_astnode_t *property,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the property operator of a `CYPHER_AST_REMOVE_PROPERTY` node.
*
* If the node is not an instance of `CYPHER_AST_REMOVE_PROPERTY` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PROPERTY_OPERATOR` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_remove_property_get_property(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_FOREACH` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [clauses] Clauses for foreach, all of type `CYPHER_AST_CLAUSE`.
* @param [nclauses] The number of clauses.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_foreach(const cypher_astnode_t *identifier,
const cypher_astnode_t *expression, cypher_astnode_t * const *clauses,
unsigned int nclauses, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_FOREACH` node.
*
* If the node is not an instance of `CYPHER_AST_FOREACH` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_foreach_get_identifier(
const cypher_astnode_t *node);
/**
* Get the expression of a `CYPHER_AST_FOREACH` node.
*
* If the node is not an instance of `CYPHER_AST_FOREACH` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_foreach_get_expression(
const cypher_astnode_t *node);
/**
* Get the number of clauses from a `CYPHER_AST_FOREACH` node.
*
* If the node is not an instance of `CYPHER_AST_FOREACH` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of clauses.
*/
__cypherlang_pure
unsigned int cypher_ast_foreach_nclauses(const cypher_astnode_t *node);
/**
* Get a clause from a `CYPHER_AST_FOREACH` node.
*
* If the node is not an instance of `CYPHER_AST_FOREACH` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the alternative.
* @return A `CYPHER_AST_CLAUSE` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_foreach_get_clause(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_WITH` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [distinct] `true` if the `DISTINCT` keyword is specified.
* @param [include_existing] `true` if including existing identifiers
* (i.e. `WITH *`).
* @param [projections] Projections for with, all of type
* `CYPHER_AST_PROJECTION`.
* @param [nprojections] The number of projections.
* @param [order_by] A `CYPHER_AST_ORDER_BY` node, or null.
* @param [skip] A `CYPHER_AST_INTEGER` node, or null.
* @param [limit] A `CYPHER_AST_INTEGER` node, or null.
* @param [predicate] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_with(bool distinct, bool include_existing,
cypher_astnode_t * const *projections, unsigned int nprojections,
const cypher_astnode_t *order_by, const cypher_astnode_t *skip,
const cypher_astnode_t *limit, const cypher_astnode_t *predicate,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Check if `DISTINCT` is present for a `CYPHER_AST_WITH` node.
*
* If the node is not an instance of `CYPHER_AST_WITH` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return `true` if `DISTINCT` is set, `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_with_is_distinct(const cypher_astnode_t *node);
/**
* Check if including existing identifiers (`*`) in a `CYPHER_AST_WITH` node.
*
* If the node is not an instance of `CYPHER_AST_WITH` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return `true` if including existing identifiers, `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_with_has_include_existing(const cypher_astnode_t *node);
/**
* Get the number of projections in a `CYPHER_AST_WITH` node.
*
* If the node is not an instance of `CYPHER_AST_WITH` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return The number of projections.
*/
__cypherlang_pure
unsigned int cypher_ast_with_nprojections(const cypher_astnode_t *node);
/**
* Get a projection from a `CYPHER_AST_WITH` node.
*
* If the node is not an instance of `CYPHER_AST_WITH` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the identifier.
* @return A `CYPHER_AST_PROJECTION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_with_get_projection(
const cypher_astnode_t *node, unsigned int index);
/**
* Get the "order by" node of a `CYPHER_AST_WITH` node.
*
* If the node is not an instance of `CYPHER_AST_WITH` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_ORDER_BY` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_with_get_order_by(
const cypher_astnode_t *node);
/**
* Get the skip value of a `CYPHER_AST_WITH` node.
*
* If the node is not an instance of `CYPHER_AST_WITH` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_INTEGER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_with_get_skip(
const cypher_astnode_t *node);
/**
* Get the limit value of a `CYPHER_AST_WITH` node.
*
* If the node is not an instance of `CYPHER_AST_WITH` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_INTEGER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_with_get_limit(
const cypher_astnode_t *node);
/**
* Get the predicate of a `CYPHER_AST_WITH` node.
*
* If the node is not an instance of `CYPHER_AST_WITH` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_with_get_predicate(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_UNWIND` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [alias] A `CYPHER_AST_IDENTIFIER` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_unwind(const cypher_astnode_t *expression,
const cypher_astnode_t *alias, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the expression of a `CYPHER_AST_UNWIND` node.
*
* If the node is not an instance of `CYPHER_AST_UNWIND` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_unwind_get_expression(
const cypher_astnode_t *node);
/**
* Get the alias of a `CYPHER_AST_UNWIND` node.
*
* If the node is not an instance of `CYPHER_AST_UNWIND` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_unwind_get_alias(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_CALL` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [proc_name] A `CYPHER_AST_PROC_NAME` node.
* @param [args] An array of `CYPHER_AST_EXPRESSION` nodes.
* @param [nargs] The number of args.
* @param [projections] Projections for with, all of type
* `CYPHER_AST_PROJECTION`.
* @param [nprojections] The number of projections.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_call(const cypher_astnode_t *proc_name,
cypher_astnode_t * const *args, unsigned int nargs,
cypher_astnode_t * const *projections, unsigned int nprojections,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the proc name of a `CYPHER_AST_CALL` node.
*
* If the node is not an instance of `CYPHER_AST_CALL` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PROC_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_call_get_proc_name(
const cypher_astnode_t *node);
/**
* Get the number of arguments of a `CYPHER_AST_CALL` node.
*
* If the node is not an instance of `CYPHER_AST_CALL` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return The number of arguments.
*/
__cypherlang_pure
unsigned int cypher_ast_call_narguments(const cypher_astnode_t *node);
/**
* Get an argument of a `CYPHER_AST_CALL` node.
*
* If the node is not an instance of `CYPHER_AST_CALL` then the result will be
* undefined.
*
* @param [node] The AST node.
* @param [index] The index of the argument.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_call_get_argument(
const cypher_astnode_t *node, unsigned int index);
/**
* Get the number of projections of a `CYPHER_AST_CALL` node.
*
* If the node is not an instance of `CYPHER_AST_CALL` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return The number of projections.
*/
__cypherlang_pure
unsigned int cypher_ast_call_nprojections(const cypher_astnode_t *node);
/**
* Get a projection of a `CYPHER_AST_CALL` node.
*
* If the node is not an instance of `CYPHER_AST_CALL` then the result will be
* undefined.
*
* @param [node] The AST node.
* @param [index] The index of the projection.
* @return A `CYPHER_AST_PROJECTION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_call_get_projection(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_RETURN` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [distinct] `true` if the `DISTINCT` keyword is specified.
* @param [include_existing] `true` if including existing identifiers
* (i.e. `RETURN *`).
* @param [projections] Projections to return, all of type
* `CYPHER_AST_PROJECTION`.
* @param [nprojections] The number of projections.
* @param [order_by] A `CYPHER_AST_ORDER_BY` node, or null.
* @param [skip] A `CYPHER_AST_INTEGER` node, or null.
* @param [limit] A `CYPHER_AST_INTEGER` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_return(bool distinct, bool include_existing,
cypher_astnode_t * const *projections, unsigned int nprojections,
const cypher_astnode_t *order_by, const cypher_astnode_t *skip,
const cypher_astnode_t *limit, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Check if `DISTINCT` is set in a `CYPHER_AST_RETURN` node.
*
* If the node is not an instance of `CYPHER_AST_RETURN` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return `true` if `DISTINCT` is set, `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_return_is_distinct(const cypher_astnode_t *node);
/**
* Check if including existing identifiers (`*`) in a `CYPHER_AST_RETURN` node.
*
* If the node is not an instance of `CYPHER_AST_RETURN` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return `true` if including existing identifiers, `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_return_has_include_existing(const cypher_astnode_t *node);
/**
* Get the number of projections in a `CYPHER_AST_RETURN` node.
*
* If the node is not an instance of `CYPHER_AST_RETURN` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of projections.
*/
__cypherlang_pure
unsigned int cypher_ast_return_nprojections(const cypher_astnode_t *node);
/**
* Get a projection from a `CYPHER_AST_RETURN` node.
*
* If the node is not an instance of `CYPHER_AST_RETURN` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the identifier.
* @return A `CYPHER_AST_PROJECTION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_return_get_projection(
const cypher_astnode_t *node, unsigned int index);
/**
* Get the "order by" node of a `CYPHER_AST_RETURN` node.
*
* If the node is not an instance of `CYPHER_AST_RETURN` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_ORDER_BY` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_return_get_order_by(
const cypher_astnode_t *node);
/**
* Get the skip value of a `CYPHER_AST_RETURN` node.
*
* If the node is not an instance of `CYPHER_AST_RETURN` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_INTEGER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_return_get_skip(
const cypher_astnode_t *node);
/**
* Get the limit value of a `CYPHER_AST_RETURN` node.
*
* If the node is not an instance of `CYPHER_AST_RETURN` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_INTEGER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_return_get_limit(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_PROJECTION` node.
*
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [alias] A `CYPHER_AST_IDENTIFIER` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_projection(const cypher_astnode_t *expression,
const cypher_astnode_t *alias, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the expression from a `CYPHER_AST_PROJECTION` node.
*
* If the node is not an instance of `CYPHER_AST_PROJECTION` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_projection_get_expression(
const cypher_astnode_t *node);
/**
* Get the alias from a `CYPHER_AST_PROJECTION` node.
*
* If the node is not an instance of `CYPHER_AST_PROJECTION` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_projection_get_alias(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_ORDER_BY` node.
*
* @param [items] Items for `ORDER BY`, all of type `CYPHER_AST_SORT_ITEM`.
* @param [nitems] The number of items.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_order_by(cypher_astnode_t * const *items,
unsigned int nitems, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the number of items in a `CYPHER_AST_ORDER_BY` node.
*
* If the node is not an instance of `CYPHER_AST_ORDER_BY` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of items.
*/
__cypherlang_pure
unsigned int cypher_ast_order_by_nitems(const cypher_astnode_t *node);
/**
* Get an item from a `CYPHER_AST_ORDER_BY` node.
*
* If the node is not an instance of `CYPHER_AST_ORDER_BY` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the action.
* @return A `CYPHER_AST_SET_ITEM` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_order_by_get_item(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_SORT_ITEM` node.
*
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [ascending] `true` if the sort item is ascending.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_sort_item(const cypher_astnode_t *expression,
bool ascending, cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the expression from a `CYPHER_AST_SORT_ITEM` node.
*
* If the node is not an instance of `CYPHER_AST_SORT_ITEM` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_sort_item_get_expression(
const cypher_astnode_t *node);
/**
* Check if a `CYPHER_AST_SORT_ITEM` node is using ascending order.
*
* If the node is not an instance of `CYPHER_AST_SORT_ITEM` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return `true` if the sort item is ascending, `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_sort_item_is_ascending(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_UNION` node.
*
* The node will also be an instance of `CYPHER_AST_CLAUSE`.
*
* @param [all] `true` if `ALL` is specified for the union.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_union(bool all, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Check if a `CYPHER_AST_UNION` node has `ALL` specified.
*
* If the node is not an instance of `CYPHER_AST_UNION` then the result will be
* undefined.
*
* @param [node] The AST node.
* @return `true` if `ALL` is specified, `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_union_has_all(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_UNARY_OPERATOR` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [op] The operator.
* @param [arg] The argument to the unary operator, of type
* `CYPHER_AST_EXPRESSION`.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_unary_operator(const cypher_operator_t *op,
const cypher_astnode_t *arg, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the operator of a `CYPHER_AST_UNARY_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_UNARY_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return The operator.
*/
__cypherlang_pure
const cypher_operator_t *cypher_ast_unary_operator_get_operator(
const cypher_astnode_t *node);
/**
* Get the argument of a `CYPHER_AST_UNARY_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_UNARY_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return The argument, of type `CYPHER_AST_EXPRESSION`.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_unary_operator_get_argument(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_BINARY_OPERATOR` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [op] The operator.
* @param [arg1] The first (left) argument to the binary operator, of type
* `CYPHER_AST_EXPRESSION`.
* @param [arg2] The second (right) argument to the binary operator, of type
* `CYPHER_AST_EXPRESSION`.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_binary_operator(const cypher_operator_t *op,
const cypher_astnode_t *arg1, const cypher_astnode_t *arg2,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the operator of a `CYPHER_AST_BINARY_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_BINARY_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return The operator.
*/
__cypherlang_pure
const cypher_operator_t *cypher_ast_binary_operator_get_operator(
const cypher_astnode_t *node);
/**
* Get the first (left) argument of a `CYPHER_AST_BINARY_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_BINARY_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return The argument, of type `CYPHER_AST_EXPRESSION`.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_binary_operator_get_argument1(
const cypher_astnode_t *node);
/**
* Get the second (right) argument of a `CYPHER_AST_BINARY_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_BINARY_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return The argument, of type `CYPHER_AST_EXPRESSION`.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_binary_operator_get_argument2(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_COMPARISON` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [length] The length of the comparison chain.
* @param [ops] The operators in the comparison chain, which must be
* length pointers.
* @param [args] The arguments in the comparison chain, which must be
* length+1 pointers all of type `CYPHER_AST_EXPRESSION`.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_comparison(unsigned int length,
const cypher_operator_t * const *ops, cypher_astnode_t * const *args,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the comparsion chain length of a `CYPHER_AST_COMPARISON` node.
*
* If the node is not an instance of `CYPHER_AST_COMPARISON` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return The length of the chain.
*/
unsigned int cypher_ast_comparison_get_length(const cypher_astnode_t *node);
/**
* Get an operator in the chain of a `CYPHER_AST_COMPARISON` node.
*
* If the node is not an instance of `CYPHER_AST_COMPARISON` then the result
* will be undefined.
*
* @param [node] The AST node.
* @param [pos] The position in the comparison chain.
* @return The operator at the specified position in the chain, or null if
* the position is greater than the chain length.
*/
__cypherlang_pure
const cypher_operator_t *cypher_ast_comparison_get_operator(
const cypher_astnode_t *node, unsigned int pos);
/**
* Get the argument in the chain of a `CYPHER_AST_COMPARISON` node.
*
* If the node is not an instance of `CYPHER_AST_COMPARISON` then the result
* will be undefined.
*
* @param [node] The AST node.
* @param [pos] The position in the comparison chain.
* @return A `CYPHER_AST_EXPRESSION` node at the specified position in the
* chain, or null if the position is greater than the chain length.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_comparison_get_argument(
const cypher_astnode_t *node, unsigned int pos);
/**
* Construct a `CYPHER_AST_APPLY_OPERATOR` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [func_name] A `CYPHER_AST_FUNCTION_NAME` node.
* @param [distinct] `true` if the `DISTINCT` keyword is specified.
* @param [args] An array of `CYPHER_AST_EXPRESSION` nodes.
* @param [nargs] The number of args.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_apply_operator(const cypher_astnode_t *func_name,
bool distinct, cypher_astnode_t * const *args, unsigned int nargs,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the function name of a `CYPHER_AST_APPLY_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_APPLY_OPERATOR` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_FUNCTION_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_apply_operator_get_func_name(
const cypher_astnode_t *node);
/**
* Check if a `CYPHER_AST_APPLY_OPERATOR` node is `DISTINCT`.
*
* If the node is not an instance of `CYPHER_AST_APPLY_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return `true` if `DISTINCT` is specified, and `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_apply_operator_get_distinct(const cypher_astnode_t *node);
/**
* Get the number of arguments of a `CYPHER_AST_APPLY_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_APPLY_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return The number of arguments.
*/
__cypherlang_pure
unsigned int cypher_ast_apply_operator_narguments(const cypher_astnode_t *node);
/**
* Get an argument of a `CYPHER_AST_APPLY_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_APPLY_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the argument.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_apply_operator_get_argument(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_APPLY_ALL_OPERATOR` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [func_name] A `CYPHER_AST_FUNCTION_NAME` node.
* @param [distinct] `true` if the function removes duplicate results.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_apply_all_operator(
const cypher_astnode_t *func_name,
bool distinct, cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the function name of a `CYPHER_AST_APPLY_ALL_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_APPLY_ALL_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_FUNCTION_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_apply_all_operator_get_func_name(
const cypher_astnode_t *node);
/**
* Check if a `CYPHER_AST_APPLY_ALL_OPERATOR` node is `DISTINCT`.
*
* If the node is not an instance of `CYPHER_AST_APPLY_ALL_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return `true` if `DISTINCT` is specified, and `false` otherwise.
*/
__cypherlang_pure
bool cypher_ast_apply_all_operator_get_distinct(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_PROPERTY_OPERATOR` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [prop_name] A `CYPHER_AST_PROP_NAME` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_property_operator(
const cypher_astnode_t *expression, const cypher_astnode_t *prop_name,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the expression of a `CYPHER_AST_PROPERTY_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_PROPERTY_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_property_operator_get_expression(
const cypher_astnode_t *node);
/**
* Get the property name of a `CYPHER_AST_PROPERTY_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_PROPERTY_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PROP_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_property_operator_get_prop_name(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_SUBSCRIPT_OPERATOR` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [subscript] A `CYPHER_AST_EXPRESSION` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_subscript_operator(
const cypher_astnode_t *expression, const cypher_astnode_t *subscript,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the expression of a `CYPHER_AST_SUBSCRIPT_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_SUBSCRIPT_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_subscript_operator_get_expression(
const cypher_astnode_t *node);
/**
* Get the subscript of a `CYPHER_AST_SUBSCRIPT_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_SUBSCRIPT_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_subscript_operator_get_subscript(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_SLICE_OPERATOR` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [start] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [end] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_slice_operator(const cypher_astnode_t *expression,
const cypher_astnode_t *start, const cypher_astnode_t *end,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the expression of a `CYPHER_AST_SLICE_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_SLICE_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_slice_operator_get_expression(
const cypher_astnode_t *node);
/**
* Get the start of a `CYPHER_AST_SLICE_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_SLICE_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_slice_operator_get_start(
const cypher_astnode_t *node);
/**
* Get the end of a `CYPHER_AST_SLICE_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_SLICE_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_slice_operator_get_end(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_LABELS_OPERATOR` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [labels] Labels for the operator, all of type `CYPHER_AST_LABEL`.
* @param [nlabels] The number of labels.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_labels_operator(const cypher_astnode_t *expression,
cypher_astnode_t * const *labels, unsigned int nlabels,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the expression of a `CYPHER_AST_PROPERTY_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_PROPERTY_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_labels_operator_get_expression(
const cypher_astnode_t *node);
/**
* Get the number of labels from a `CYPHER_AST_LABELS_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_LABELS_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return The number of labels.
*/
__cypherlang_pure
unsigned int cypher_ast_labels_operator_nlabels(const cypher_astnode_t *node);
/**
* Get a label from a `CYPHER_AST_LABELS_OPERATOR` node.
*
* If the node is not an instance of `CYPHER_AST_LABELS_OPERATOR` then the
* result will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the label.
* @return A `CYPHER_AST_LABEL` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_labels_operator_get_label(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_LIST_COMPREHENSION` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [predicate] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [eval] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_list_comprehension(
const cypher_astnode_t *identifier, const cypher_astnode_t *expression,
const cypher_astnode_t *predicate, const cypher_astnode_t *eval,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the identifier from a `CYPHER_AST_LIST_COMPREHENSION` node.
*
* If the node is not an instance of `CYPHER_AST_LIST_COMPREHENSION` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_list_comprehension_get_identifier(
const cypher_astnode_t *node);
/**
* Get the expression from a `CYPHER_AST_LIST_COMPREHENSION` node.
*
* If the node is not an instance of `CYPHER_AST_LIST_COMPREHENSION` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_list_comprehension_get_expression(
const cypher_astnode_t *node);
/**
* Get the predicate from a `CYPHER_AST_LIST_COMPREHENSION` node.
*
* If the node is not an instance of `CYPHER_AST_LIST_COMPREHENSION` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_list_comprehension_get_predicate(
const cypher_astnode_t *node);
/**
* Get the evaluation from a `CYPHER_AST_LIST_COMPREHENSION` node.
*
* If the node is not an instance of `CYPHER_AST_LIST_COMPREHENSION` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_list_comprehension_get_eval(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_FILTER` node.
*
* The node will also be an instance of `CYPHER_AST_LIST_COMPREHENSION`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [predicate] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_filter(const cypher_astnode_t *identifier,
const cypher_astnode_t *expression, const cypher_astnode_t *predicate,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_EXTRACT` node.
*
* The node will also be an instance of `CYPHER_AST_LIST_COMPREHENSION`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [eval] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_extract(const cypher_astnode_t *identifier,
const cypher_astnode_t *expression, const cypher_astnode_t *eval,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_ALL` node.
*
* The node will also be an instance of `CYPHER_AST_LIST_COMPREHENSION`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [predicate] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_all(const cypher_astnode_t *identifier,
const cypher_astnode_t *expression, const cypher_astnode_t *predicate,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_ANY` node.
*
* The node will also be an instance of `CYPHER_AST_LIST_COMPREHENSION`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [predicate] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_any(const cypher_astnode_t *identifier,
const cypher_astnode_t *expression, const cypher_astnode_t *predicate,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_SINGLE` node.
*
* The node will also be an instance of `CYPHER_AST_LIST_COMPREHENSION`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [predicate] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_single(const cypher_astnode_t *identifier,
const cypher_astnode_t *expression, const cypher_astnode_t *predicate,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_NONE` node.
*
* The node will also be an instance of `CYPHER_AST_LIST_COMPREHENSION`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [predicate] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_none(const cypher_astnode_t *identifier,
const cypher_astnode_t *expression, const cypher_astnode_t *predicate,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_REDUCE` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [accumulator] A `CYPHER_AST_IDENTIFIER` node.
* @param [init] A `CYPHER_AST_EXPRESSION` node.
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [eval] A `CYPHER_AST_EXPRESSION` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_reduce(const cypher_astnode_t *accumulator,
const cypher_astnode_t *init, const cypher_astnode_t *identifier,
const cypher_astnode_t *expression, const cypher_astnode_t *eval,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the accumulator from a `CYPHER_AST_REDUCE` node.
*
* If the node is not an instance of `CYPHER_AST_REDUCE` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_reduce_get_accumulator(
const cypher_astnode_t *node);
/**
* Get the accumulator init expression from a `CYPHER_AST_REDUCE` node.
*
* If the node is not an instance of `CYPHER_AST_REDUCE` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_reduce_get_init(
const cypher_astnode_t *node);
/**
* Get the identifier from a `CYPHER_AST_REDUCE` node.
*
* If the node is not an instance of `CYPHER_AST_REDUCE` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_reduce_get_identifier(
const cypher_astnode_t *node);
/**
* Get the expression from a `CYPHER_AST_REDUCE` node.
*
* If the node is not an instance of `CYPHER_AST_REDUCE` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_reduce_get_expression(
const cypher_astnode_t *node);
/**
* Get the evaluation from a `CYPHER_AST_REDUCE` node.
*
* If the node is not an instance of `CYPHER_AST_REDUCE` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_reduce_get_eval(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_CASE` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [expression] A `CYPHER_AST_EXPRESSION` node.
* @param [alternatives] An alternating list of predicate expressions and
* values, all of type `CYPHER_AST_EXPRESSION`.
* @param [nalternatives] The number of predicate and result pairs.
* @param [deflt] A `CYPHER_AST_EXPRESSION` node, or `NULL`.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_case(const cypher_astnode_t *expression,
cypher_astnode_t * const *alternatives, unsigned int nalternatives,
const cypher_astnode_t *deflt, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the expression from a `CYPHER_AST_CASE` node.
*
* If the node is not an instance of `CYPHER_AST_CASE` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_case_get_expression(
const cypher_astnode_t *node);
/**
* Get the number of alternatives from a `CYPHER_AST_CASE` node.
*
* If the node is not an instance of `CYPHER_AST_CASE` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return The number of alternatives.
*/
__cypherlang_pure
unsigned int cypher_ast_case_nalternatives(const cypher_astnode_t *node);
/**
* Get a predicate from a `CYPHER_AST_CASE` node.
*
* If the node is not an instance of `CYPHER_AST_CASE` then the
* result will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the alternative.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_case_get_predicate(
const cypher_astnode_t *node, unsigned int index);
/**
* Get a value from a `CYPHER_AST_CASE` node.
*
* If the node is not an instance of `CYPHER_AST_CASE` then the
* result will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the alternative.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_case_get_value(
const cypher_astnode_t *node, unsigned int index);
/**
* Get the default from a `CYPHER_AST_CASE` node.
*
* If the node is not an instance of `CYPHER_AST_CASE` then the
* result will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_EXPRESSION` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_case_get_default(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_COLLECTION` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [elements] The elements for the collection.
* @param [nelements] The number of elements.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_collection(
cypher_astnode_t * const *elements, unsigned int nelements,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the collection length from a `CYPHER_AST_COLLECTION` node.
*
* If the node is not an instance of `CYPHER_AST_COLLECTION` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The length of the collection.
*/
__cypherlang_pure
unsigned int cypher_ast_collection_length(const cypher_astnode_t *node);
/**
* Get an element from a `CYPHER_AST_COLLECTION` node.
*
* If the node is not an instance of `CYPHER_AST_COLLECTION` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the element.
* @return A pointer to the element of the collection, or `NULL` if there is no
* element at the specified index.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_collection_get(const cypher_astnode_t *node,
unsigned int index);
/**
* Construct a `CYPHER_AST_MAP` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [keys] The keys for the map, all of type `CYPHER_AST_PROP_NAME`.
* @param [values] The values for the map, all of type `CYPEHR_AST_EXPRESSION`.
* @param [nentries] The number of keys and values.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
cypher_astnode_t *cypher_ast_map(cypher_astnode_t * const *keys,
cypher_astnode_t * const *values, unsigned int nentries,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_MAP` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [pairs] An alternating list of keys for the map, of type
* `CYPHER_AST_PROP_NAME`, and values for the map, of type
* `CYPHER_AST_EXPRESSION`.
* @param [nentries] The number of pairs (i.e. `pairs` must contain
* `nentries*2` pointers).
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_pair_map(cypher_astnode_t * const *pairs,
unsigned int nentries, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the number of entries in a `CYPHER_AST_MAP` node.
*
* If the node is not an instance of `CYPHER_AST_MAP` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of entries.
*/
__cypherlang_pure
unsigned int cypher_ast_map_nentries(const cypher_astnode_t *node);
/**
* Get a key from a `CYPHER_AST_MAP` node.
*
* If the node is not an instance of `CYPHER_AST_MAP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the entry.
* @return A `CYPHER_AST_PROP_NAME` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_map_get_key(const cypher_astnode_t *node,
unsigned int index);
/**
* Get a value from a `CYPHER_AST_MAP` node.
*
* If the node is not an instance of `CYPHER_AST_MAP` then the
* result will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the entry.
* @return A `CYPHER_AST_EXPRESSION` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_map_get_value(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_IDENTIFIER` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [s] A pointer to a character string containing the identifier name.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_identifier(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get a null terminated name string for a `CYPHER_AST_IDENTIFIER` node.
*
* If the node is not an instance of `CYPHER_AST_IDENTIFIER` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_identifier_get_name(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_PARAMETER` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [s] A pointer to a character string containing the identifier name.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_parameter(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get a null terminated name string for a `CYPHER_AST_PARAMETER` node.
*
* If the node is not an instance of `CYPHER_AST_PARAMETER` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_parameter_get_name(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_STRING` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [s] A pointer to a character string.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_string(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get the null terminated string value from a `CYPHER_AST_STRING` node.
*
* If the node is not an instance of `CYPHER_AST_STRING` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_string_get_value(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_INTEGER` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [s] A pointer to a character string.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_integer(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get the null terminated string value from a `CYPHER_AST_INTEGER` node.
*
* If the node is not an instance of `CYPHER_AST_INTEGER` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_integer_get_valuestr(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_FLOAT` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [s] A pointer to a character string.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_float(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get the null terminated string value from a `CYPHER_AST_FLOAT` node.
*
* If the node is not an instance of `CYPHER_AST_FLOAT` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_float_get_valuestr(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_TRUE` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_true(struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_FALSE` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_false(struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_NULL` node.
*
* The node will also be an instance of `CYPHER_AST_EXPRESSION`.
*
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_null(struct cypher_input_range range);
/**
* Construct a `CYPHER_AST_LABEL` node.
*
* @param [s] A pointer to a character string containing the label name.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_label(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get a null terminated name string for a `CYPHER_AST_LABEL` node.
*
* If the node is not an instance of `CYPHER_AST_LABEL` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_label_get_name(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_RELTYPE` node.
*
* @param [s] A pointer to a character string containing the label name.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_reltype(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get a null terminated name string for a `CYPHER_AST_RELTYPE` node.
*
* If the node is not an instance of `CYPHER_AST_RELTYPE` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_reltype_get_name(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_PROP_NAME` node.
*
* @param [s] A pointer to a character string containing the property name.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_prop_name(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get a null terminated name string for a `CYPHER_AST_PROP_NAME` node.
*
* If the node is not an instance of `CYPHER_AST_PROP_NAME` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_prop_name_get_value(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_FUNCTION_NAME` node.
*
* @param [s] A pointer to a character string containing the function name.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_function_name(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get a null terminated name string for a `CYPHER_AST_FUNCTION_NAME` node.
*
* If the node is not an instance of `CYPHER_AST_FUNCTION_NAME` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_function_name_get_value(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_INDEX_NAME` node.
*
* @param [s] A pointer to a character string containing the index name.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_index_name(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get a null terminated name string for a `CYPHER_AST_INDEX_NAME` node.
*
* If the node is not an instance of `CYPHER_AST_INDEX_NAME` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_index_name_get_value(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_PROC_NAME` node.
*
* @param [s] A pointer to a character string containing the proc name.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_proc_name(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get a null terminated name string for a `CYPHER_AST_PROC_NAME` node.
*
* If the node is not an instance of `CYPHER_AST_PROC_NAME` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_proc_name_get_value(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_PATTERN` node.
*
* @param [paths] The paths in the pattern, which must be all of type
* `CYPHER_AST_PATTERN_PATH`.
* @param [npaths] The number of paths.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_pattern(cypher_astnode_t * const *paths,
unsigned int npaths, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the number of paths in a `CYPHER_AST_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_PATTERN` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of paths.
*/
__cypherlang_pure
unsigned int cypher_ast_pattern_npaths(const cypher_astnode_t *node);
/**
* Get a path from a `CYPHER_AST_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_PATTERN` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the path.
* @return A `CYPHER_AST_PATTERN_PATH` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_pattern_get_path(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_NAMED_PATH` node.
*
* The node will also be an instance of `CYPHER_AST_PATTERN_PATH`.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node.
* @param [path] A `CYPHER_AST_PATTERN_PATH` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_named_path(const cypher_astnode_t *identifier,
const cypher_astnode_t *path, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the identifier from a `CYPHER_AST_NAMED_PATH` node.
*
* If the node is not an instance of `CYPHER_AST_NAMED_PATH` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_named_path_get_identifier(
const cypher_astnode_t *node);
/**
* Get the unnamed pattern path from a `CYPHER_AST_NAMED_PATH` node.
*
* If the node is not an instance of `CYPHER_AST_NAMED_PATH` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PATTERN_PATH` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_named_path_get_path(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_SHORTEST_PATH` node.
*
* The node will also be an instance of `CYPHER_AST_PATTERN_PATH` and
* `CYPHER_AST_EXPRESSION`.
*
* @param [single] true if `shortestPath`, and false if `allShortestPaths`.
* @param [path] A `CYPHER_AST_PATTERN_PATH` node.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_shortest_path(bool single,
const cypher_astnode_t *path, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Check if a `CYPHER_AST_SHORTEST_PATH` node is for a single path.
*
* If the node is not an instance of `CYPHER_AST_SHORTEST_PATH` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return true if `shortestPath`, and false if `allShortestPaths`.
*/
__cypherlang_pure
bool cypher_ast_shortest_path_is_single(const cypher_astnode_t *node);
/**
* Get the unnamed pattern path from a `CYPHER_AST_SHORTEST_PATH` node.
*
* If the node is not an instance of `CYPHER_AST_SHORTEST_PATH` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_PATTERN_PATH` node.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_shortest_path_get_path(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_PATTERN_PATH` node.
*
* @param [elements] The elements in the pattern, which must be of alternating
* types `CYPHER_AST_NODE_PATTERN` and `CYPHER_AST_REL_PATTERN`.
* @param [nelements] The number of elements in the path, which must be odd.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_pattern_path(cypher_astnode_t * const *elements,
unsigned int nelements, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the number of elements in a `CYPHER_AST_PATTERN_PATH` node.
*
* If the node is not an instance of `CYPHER_AST_PATTERN_PATH` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return The number of elements, which will be odd.
*/
__cypherlang_pure
unsigned int cypher_ast_pattern_path_nelements(const cypher_astnode_t *node);
/**
* Get an element from a `CYPHER_AST_PATTERN_PATH` node.
*
* If the node is not an instance of `CYPHER_AST_PATTERN_PATH` then the result
* will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the element.
* @return Either a `CYPHER_AST_NODE_PATTERN` node or a
* `CYPHER_AST_REL_PATTERN` node, depending on whether the index
* is even or odd respectively, or null if the index is larger than the
* number of elements..
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_pattern_path_get_element(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_NODE_PATTERN` node.
*
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node, or null.
* @param [labels] The labels in the pattern, which must all be of type
* `CYPHER_AST_LABEL`.
* @param [nlabels] The number of labels in the pattern.
* @param [properties] A `CYPHER_AST_MAP` node, a `CYPHER_AST_PARAMETER` node,
* or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_node_pattern(const cypher_astnode_t *identifier,
cypher_astnode_t * const *labels, unsigned int nlabels,
const cypher_astnode_t *properties, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the identifier of a `CYPHER_AST_NODE_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_PATTERN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_pattern_get_identifier(
const cypher_astnode_t *node);
/**
* Get the number of labels in a `CYPHER_AST_NODE_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_PATTERN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return The number of labels.
*/
__cypherlang_pure
unsigned int cypher_ast_node_pattern_nlabels(const cypher_astnode_t *node);
/**
* Get a label from a `CYPHER_AST_NODE_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_PATTERN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the label.
* @return A `CYPHER_AST_LABEL` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_pattern_get_label(
const cypher_astnode_t *node, unsigned int index);
/**
* Get the properties of a `CYPHER_AST_NODE_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_NODE_PATTERN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_MAP` node, a `CYPHER_AST_PARAMETER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_node_pattern_get_properties(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_REL_PATTERN` node.
*
* @param [direction] The direction of the relationship.
* @param [identifier] A `CYPHER_AST_IDENTIFIER` node, or null.
* @param [reltypes] The relationship types in the pattern, all of type
* `CYPHER_AST_RELTYPE`.
* @param [nreltypes] The number of relationship types in the pattern.
* @param [properties] A `CYPHER_AST_MAP` node, a `CYPHER_AST_PARAMETER` node,
* or null.
* @param [varlength] A `CYPHER_AST_RANGE` node, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_rel_pattern(enum cypher_rel_direction direction,
const cypher_astnode_t *identifier, cypher_astnode_t * const *reltypes,
unsigned int nreltypes, const cypher_astnode_t *properties,
const cypher_astnode_t *varlength, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the direction of a `CYPHER_AST_REL_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_REL_PATTERN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return The direction of the relationship.
*/
__cypherlang_pure
enum cypher_rel_direction cypher_ast_rel_pattern_get_direction(
const cypher_astnode_t *node);
/**
* Get the identifier of a `CYPHER_AST_REL_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_REL_PATTERN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_IDENTIFIER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_pattern_get_identifier(
const cypher_astnode_t *node);
/**
* Get the number of reltypes in a `CYPHER_AST_REL_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_REL_PATTERN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return The number of reltypes.
*/
__cypherlang_pure
unsigned int cypher_ast_rel_pattern_nreltypes(const cypher_astnode_t *node);
/**
* Get a reltypes from a `CYPHER_AST_REL_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_REL_PATTERN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the reltypes.
* @return A `CYPHER_AST_LABEL` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_pattern_get_reltype(
const cypher_astnode_t *node, unsigned int index);
/**
* Get the varlength range of a `CYPHER_AST_REL_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_REL_PATTERN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_RANGE` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_pattern_get_varlength(
const cypher_astnode_t *node);
/**
* Get the properties of a `CYPHER_AST_REL_PATTERN` node.
*
* If the node is not an instance of `CYPHER_AST_REL_PATTERN` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_MAP` node, a `CYPHER_AST_PARAMETER` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_rel_pattern_get_properties(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_RANGE` node.
*
* @param [start] A `CYPHER_AST_INTEGER`, or null.
* @param [end] A `CYPHER_AST_INTEGER`, or null.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_range(const cypher_astnode_t *start,
const cypher_astnode_t *end, cypher_astnode_t **children,
unsigned int nchildren, struct cypher_input_range range);
/**
* Get the start of a `CYPHER_AST_RANGE` node.
*
* If the node is not an instance of `CYPHER_AST_RANGE` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_RANGE` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_range_get_start(
const cypher_astnode_t *node);
/**
* Get the end of a `CYPHER_AST_RANGE` node.
*
* If the node is not an instance of `CYPHER_AST_RANGE` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A `CYPHER_AST_RANGE` node, or null.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_range_get_end(
const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_COMMAND` node.
*
* @param [name] A `CYPHER_AST_STRING` node.
* @param [args] Arguments for the command, all of type `CYPHER_AST_STRING`.
* @param [nargs] The number of clauses.
* @param [children] The children of the node.
* @param [nchildren] The number of children.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_command(const cypher_astnode_t *name,
cypher_astnode_t * const *args, unsigned int nargs,
cypher_astnode_t **children, unsigned int nchildren,
struct cypher_input_range range);
/**
* Get the name from a CYPHER_AST_COMMAND node.
*
* If the node is not an instance of `CYPHER_AST_COMMAND` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return A pointer to the name of the command, which will be of type
* `CYPHER_AST_STRING`.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_command_get_name(
const cypher_astnode_t *node);
/**
* Get the number of arguments from a CYPHER_AST_COMMAND node.
*
* If the node is not an instance of `CYPHER_AST_COMMAND` then the result will
* be undefined.
*
* @param [node] The AST node.
* @return The number of arguments to the command.
*/
__cypherlang_pure
unsigned int cypher_ast_command_narguments(const cypher_astnode_t *node);
/**
* Get an argument from a CYPHER_AST_COMMAND node.
*
* If the node is not an instance of `CYPHER_AST_COMMAND` then the result will
* be undefined.
*
* @param [node] The AST node.
* @param [index] The index of the argument.
* @return A pointer to the argument of the command, which will be of type
* `CYPHER_AST_STRING`, or `NULL` if there is no argument at the
* specified index.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_ast_command_get_argument(
const cypher_astnode_t *node, unsigned int index);
/**
* Construct a `CYPHER_AST_LINE_COMMENT` node.
*
* The node will also be an instance of `CYPHER_AST_COMMENT`.
*
* @param [s] A pointer to a character string containing the comment.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_line_comment(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get a null terminated string for a `CYPHER_AST_LINE_COMMENT` node.
*
* If the node is not an instance of `CYPHER_AST_LINE_COMMENT` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_line_comment_get_value(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_BLOCK_COMMENT` node.
*
* The node will also be an instance of `CYPHER_AST_COMMENT`.
*
* @param [s] A pointer to a character string containing the comment.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_block_comment(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get a null terminated string for a `CYPHER_AST_BLOCK_COMMENT` node.
*
* If the node is not an instance of `CYPHER_AST_BLOCK_COMMENT` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_block_comment_get_value(const cypher_astnode_t *node);
/**
* Construct a `CYPHER_AST_ERROR` node.
*
* @param [s] A pointer to a character string containing the erroneous input.
* @param [n] The length of the character string.
* @param [range] The input range.
* @return An AST node, or NULL if an error occurs (errno will be set).
*/
__cypherlang_must_check
cypher_astnode_t *cypher_ast_error(const char *s, size_t n,
struct cypher_input_range range);
/**
* Get a null terminated string for a `CYPHER_AST_ERROR` node.
*
* If the node is not an instance of `CYPHER_AST_BLOCK_COMMENT` then the result
* will be undefined.
*
* @param [node] The AST node.
* @return A pointer to the null terminated string.
*/
__cypherlang_pure
const char *cypher_ast_error_get_value(const cypher_astnode_t *node);
/**
* Release an entire AST tree.
*
* @param [ast] The root of the AST tree.
*/
void cypher_ast_free(cypher_astnode_t *ast);
#define CYPHER_AST_RENDER_DEFAULT 0
/**
* Print a represetation of an AST to a stream.
*
* Useful for debugging purposes.
*
* @param [ast] The AST node.
* @param [stream] The stream to print to.
* @param [width] The width to render, which is advisory and may be exceeded.
* A value of 0 implies no restriction on width.
* @param [colorization] A colorization scheme to apply, or null.
* @param [flags] A bitmask of flags to control rendering.
* @return 0 on success, or -1 if an error occurs (errno will be set).
*/
int cypher_ast_fprint(const cypher_astnode_t *ast, FILE *stream,
unsigned int width,
const struct cypher_parser_colorization *colorization,
uint_fast32_t flags);
/*
* =====================================
* parser
* =====================================
*/
/**
* Configuration for a cypher parser.
*/
typedef struct cypher_parser_config cypher_parser_config_t;
/**
* Generate a new parser configuration.
*
* The returned configuration must be later released using
* cypher_parser_config_free().
*
* @return A pointer to a new parser configuration, or `NULL` if an error
* occurs (errno will be set).
*/
__cypherlang_must_check
cypher_parser_config_t *cypher_parser_new_config(void);
/**
* Release a parser configuration.
*
* @param [config] A pointer to a parser configuration. This pointer will
* be invalid after the function returns.
*/
void cypher_parser_config_free(cypher_parser_config_t *config);
/**
* Set the initial input position for parsing.
*
* By default, the initial position is line 1, column 1 (offset 0). By setting
* a different position, all ranges in the AST, and positions in any error
* messages, will be offset by the specified position - as if the input had
* contained unparsed whitespace up until that point.
*
* @param [config] The parser configuration.
* @param [position] The initial input position.
*/
void cypher_parser_config_set_initial_position(cypher_parser_config_t *config,
struct cypher_input_position position);
/**
* Set the initial ordinal for parsing.
*
* All AST nodes parsed will be numbered starting from the specified initial
* ordinal, which is 0 by default. This affects the numbering of AST nodes
* in rendering.
*
* @param [config] The parser configuration.
* @param [n] The initial oridinal.
*/
void cypher_parser_config_set_initial_ordinal(cypher_parser_config_t *config,
unsigned int n);
/**
* Set the colorization scheme for error messages.
*
* @param [config] The parser configuration.
* @param [colorization] The colorization scheme to use.
*/
void cypher_parser_config_set_error_colorization(cypher_parser_config_t *config,
const struct cypher_parser_colorization *colorization);
/**
* A parse segment.
*/
typedef struct cypher_parse_segment cypher_parse_segment_t;
/**
* A parse result.
*/
typedef struct cypher_parse_result cypher_parse_result_t;
/**
* A parse error.
*/
typedef struct cypher_parse_error cypher_parse_error_t;
/**
* A parse callback.
*/
typedef int (*cypher_parser_segment_callback_t)(void *userdata,
cypher_parse_segment_t *segment);
#define CYPHER_PARSE_DEFAULT 0
#define CYPHER_PARSE_SINGLE (1<<0)
#define CYPHER_PARSE_ONLY_STATEMENTS (1<<1)
/**
* @fn int cypher_parse_each(const char *s, cypher_parser_segment_callback_t callback, void *userdata, struct cypher_input_position *last, cypher_parser_config_t *config, uint_fast32_t flags);
* @brief Parse segments from a string.
*
* The provided callback is invoked for every segment of parsed input, where
* each segments is separated by either a newline or semicolon (`;`),
* respectively depending on whether a client command is being parsed or not.
* If the flag CYPHER_PARSE_ONLY_STATEMENTS is set, then only semicolons will
* be used for delimiting segments, and client commands will not be parsed.
*
* The segment will be released after the callback is complete, unless retained
* using cypher_parse_segment_retain().
*
* @param [s] A null terminated string to parse.
* @param [callback] The callback to be invoked for each parsed segment.
* @param [userdata] A pointer that will be provided to the callback.
* @param [last] Either `NULL`, or a pointer to a `struct cypher_input_position`
* that will be set position of the last character consumed from the
* input.
* @param [config] Either `NULL`, or a pointer to configuration for the parser.
* @param [flags] A bitmask of flags to control parsing.
* @return 0 on success, -1 on failure (errno will be set).
*/
#define cypher_parse_each(s,b,d,l,c,f) (cypher_uparse_each(s,strlen(s),b,d,l,c,f))
/**
* @fn cypher_parse_result_t *cypher_parse(const char *s, struct cypher_input_position *last, cypher_parser_config_t *config, uint_fast32_t flags);
* @brief Parse a command or statement from a string.
*
* All statements and/or client commands are parsed from the input string, and
* a result returned. The result must be passed to
* cypher_parse_result_free() to release dynamically allocated memory.
* If the flag CYPHER_PARSE_ONLY_STATEMENTS is set, client commands will not be
* parsed.
*
* @param [s] A null terminated string to parse.
* @param [last] Either `NULL`, or a pointer to a `struct cypher_input_position`
* that will be set position of the last character consumed from the
* input.
* @param [config] Either `NULL`, or a pointer to configuration for the parser.
* @param [flags] A bitmask of flags to control parsing.
* @return A pointer to a `cypher_parse_result_t`, or `NULL` if an error occurs
* (errno will be set).
*/
#define cypher_parse(s,l,c,f) (cypher_uparse(s,strlen(s),l,c,f))
/**
* Parse segments from a string.
*
* The provided callback is invoked for every segment of parsed input, where
* each segments is separated by either a newline or semicolon (`;`),
* respectively depending on whether a client command is being parsed or not.
* If the flag CYPHER_PARSE_ONLY_STATEMENTS is set, then only semicolons will
* be used for delimiting segments, and client commands will not be parsed.
*
* The segment will be released after the callback is complete, unless retained
* using cypher_parse_segment_retain().
*
* @param [s] The string to parse.
* @param [n] The size of the string.
* @param [callback] The callback to be invoked for each parsed segment.
* @param [userdata] A pointer that will be provided to the callback.
* @param [last] Either `NULL`, or a pointer to a `struct cypher_input_position`
* that will be set position of the last character consumed from the
* input.
* @param [config] Either `NULL`, or a pointer to configuration for the parser.
* @param [flags] A bitmask of flags to control parsing.
* @return A pointer to a `cypher_parse_result_t`, or `NULL` if an error occurs
* (errno will be set).
*/
__cypherlang_must_check
int cypher_uparse_each(const char *s, size_t n,
cypher_parser_segment_callback_t callback, void *userdata,
struct cypher_input_position *last, cypher_parser_config_t *config,
uint_fast32_t flags);
/**
* Parse a statement or command from a string.
*
* All statements and/or client commands are parsed from the input string, and
* a result returned. The result must be passed to
* cypher_parse_result_free() to release dynamically allocated memory.
* If the flag CYPHER_PARSE_ONLY_STATEMENTS is set, client commands will not be
* parsed.
*
* @param [s] The string to parse.
* @param [n] The size of the string.
* @param [last] Either `NULL`, or a pointer to a `struct cypher_input_position`
* that will be set position of the last character consumed from the
* input.
* @param [config] Either `NULL`, or a pointer to configuration for the parser.
* @param [flags] A bitmask of flags to control parsing.
* @return A pointer to a `cypher_parse_result_t`, or `NULL` if an error occurs
* (errno will be set).
*/
__cypherlang_must_check
cypher_parse_result_t *cypher_uparse(const char *s, size_t n,
struct cypher_input_position *last, cypher_parser_config_t *config,
uint_fast32_t flags);
/**
* Parse segments from a stream.
*
* The provided callback is invoked for every segment of parsed input, where
* each segments is separated by either a newline or semicolon (`;`),
* respectively depending on whether a client command is being parsed or not.
* If the flag CYPHER_PARSE_ONLY_STATEMENTS is set, then only semicolons will
* be used for delimiting segments, and client commands will not be parsed.
*
* The segment will be released after the callback is complete, unless retained
* using cypher_parse_segment_retain().
*
* @param [stream] The stream to parse.
* @param [callback] The callback to be invoked for each parsed segment.
* @param [userdata] A pointer that will be provided to the callback.
* @param [last] Either `NULL`, or a pointer to a `struct cypher_input_position`
* that will be set position of the last character consumed from the
* input.
* @param [config] Either `NULL`, or a pointer to configuration for the parser.
* @param [flags] A bitmask of flags to control parsing.
* @return A pointer to a `cypher_parse_result_t`, or `NULL` if an error occurs
* (errno will be set).
*/
__cypherlang_must_check
int cypher_fparse_each(FILE *stream, cypher_parser_segment_callback_t callback,
void *userdata, struct cypher_input_position *last,
cypher_parser_config_t *config, uint_fast32_t flags);
/**
* Parse a statement or command from a stream.
*
* All statements and/or client commands are parsed from the input string, and
* a result returned. The result must be passed to
* cypher_parse_result_free() to release dynamically allocated memory.
* If the flag CYPHER_PARSE_ONLY_STATEMENTS is set, client commands will not be
* parsed.
*
* @param [stream] The stream to parse.
* @param [last] Either `NULL`, or a pointer to a `struct cypher_input_position`
* that will be set position of the last character consumed from the
* input.
* @param [config] Either `NULL`, or a pointer to configuration for the parser.
* @param [flags] A bitmask of flags to control parsing.
* @return A pointer to a `cypher_parse_result_t`, or `NULL` if an error occurs
* (errno will be set).
*/
__cypherlang_must_check
cypher_parse_result_t *cypher_fparse(FILE *stream,
struct cypher_input_position *last, cypher_parser_config_t *config,
uint_fast32_t flags);
/**
* Get the range of a parse segment.
*
* @param [segment] The parse segment.
* @return The input range.
*/
__cypherlang_pure
struct cypher_input_range cypher_parse_segment_get_range(
const cypher_parse_segment_t *segment);
/**
* Get the number of errors encountered in a parse segment.
*
* @param [segment] The parse segment.
* @return The number of errors.
*/
__cypherlang_pure
unsigned int cypher_parse_segment_nerrors(
const cypher_parse_segment_t *segment);
/**
* Get an error from a parse segment.
*
* @param [segment] The parse segment.
* @param [index] The error index.
* @return A pointer to the error description, or `NULL` if there is no error
* at the specified index.
*/
__cypherlang_pure
const cypher_parse_error_t *cypher_parse_segment_get_error(
const cypher_parse_segment_t *segment, unsigned int index);
/**
* Get the number of root AST nodes parsed in a segment.
*
* @param [segment] The parse segment.
* @return The number of root AST nodes.
*/
__cypherlang_pure
unsigned int cypher_parse_segment_nroots(const cypher_parse_segment_t *segment);
/**
* Get a root AST node from a parse segment.
*
* @param [segment] The parse segment.
* @param [index] The node index.
* @return A pointer to the AST node, or `NULL` if there is no node at the
* specified index.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_parse_segment_get_root(
const cypher_parse_segment_t *segment, unsigned int index);
/**
* Get the total number of AST nodes parsed in a segment.
*
* Includes all root nodes and their children, at any depth.
*
* @param [segment] The parse segment.
* @return The number of elements.
*/
__cypherlang_pure
unsigned int cypher_parse_segment_nnodes(const cypher_parse_segment_t *segment);
/**
* Get the statement or client command parsed in a segment.
*
* @param [segment] The parse segment.
* @return Either a CYPHER_AST_STATEMENT, a CYPHER_AST_COMMAND node,
* or `NULL` if neither was encountered in the segment.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_parse_segment_get_directive(
const cypher_parse_segment_t *segment);
/**
* Check if the parse encountered the end of the input.
*
* Indicates if the segment was terminated by to the end of the input.
*
* @param [segment] The parse segment.
* @return `true` if the end of input was encountered, `false` if the
* segment was terminated with an expected character.
*/
__cypherlang_pure
bool cypher_parse_segment_is_eof(const cypher_parse_segment_t *segment);
/**
* Print a represetation of the AST from a parse segment to a stream.
*
* Useful for debugging purposes.
*
* @param [segment] The parse segment.
* @param [stream] The stream to print to.
* @param [width] The width to render, which is advisory and may be exceeded.
* A value of 0 implies no restriction on width.
* @param [colorization] A colorization scheme to apply, or null.
* @param [flags] A bitmask of flags to control rendering.
* @return 0 on success, or -1 if an error occurs (errno will be set).
*/
int cypher_parse_segment_fprint_ast(const cypher_parse_segment_t *segment,
FILE *stream, unsigned int width,
const struct cypher_parser_colorization *colorization,
uint_fast32_t flags);
/**
* Retain a reference to a parse segment.
*
* The segment must later be passed to cypher_parse_segment_release().
*
* @param [segment] The parse segment.
*/
void cypher_parse_segment_retain(cypher_parse_segment_t *segment);
/**
* Release a reference to a parse segment.
*
* The segment must have been previously retained using
* cypher_parse_segment_retain().
*
* @param [segment] The parse segment.
*/
void cypher_parse_segment_release(cypher_parse_segment_t *segment);
/**
* Get the number of root AST nodes parsed.
*
* @param [result] The parse result.
* @return The number of root AST nodes.
*/
__cypherlang_pure
unsigned int cypher_parse_result_nroots(const cypher_parse_result_t *result);
/**
* Get a root AST nodes from a parse result.
*
* @param [result] The parse result.
* @param [index] The node index.
* @return A pointer to the AST node, or `NULL` if there is no element at the
* specified index.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_parse_result_get_root(
const cypher_parse_result_t *result, unsigned int index);
/**
* Get the total number of AST nodes parsed.
*
* Includes all children, at any depth, of all result elements.
*
* @param [result] The parse result.
* @return The number of elements.
*/
__cypherlang_pure
unsigned int cypher_parse_result_nnodes(const cypher_parse_result_t *result);
/**
* Get the number of statements or commands parsed.
*
* @param [result] The parse result.
* @return The number of statements or commands parsed.
*/
__cypherlang_pure
unsigned int cypher_parse_result_ndirectives(
const cypher_parse_result_t *result);
/**
* Get the AST for a parsed statement or command from a parse result.
*
* @param [result] The parse result.
* @param [index] The directive index.
* @return Either a CYPHER_AST_STATEMENT, a CYPHER_AST_COMMAND node,
* or `NULL` if there is no directive at the specified index.
*/
__cypherlang_pure
const cypher_astnode_t *cypher_parse_result_get_directive(
const cypher_parse_result_t *result, unsigned int index);
/**
* Get the number of errors encountered during parsing.
*
* @param [result] The parse result.
* @return The number of errors.
*/
__cypherlang_pure
unsigned int cypher_parse_result_nerrors(const cypher_parse_result_t *result);
/**
* Get an error description from a parse result.
*
* @param [result] The parse result.
* @param [index] The error index.
* @return A pointer to the error description, or `NULL` if there is no value
* at the specified index.
*/
__cypherlang_pure
const cypher_parse_error_t *cypher_parse_result_get_error(
const cypher_parse_result_t *result, unsigned int index);
/**
* Check if the parse encountered the end of the input.
*
* Indicates if the last parsed command or statement was terminated
* (with a newline or `;` respectively), or with EOF.
*
* @param [result] The parse result.
* @return `true` if the end of input was encountered, `false` if the
* command or statement was terminated with the expected character.
*/
__cypherlang_pure
bool cypher_parse_result_eof(const cypher_parse_result_t *result);
/**
* Print a represetation of a parse result to a stream.
*
* Useful for debugging purposes.
*
* @param [result] The parse result.
* @param [stream] The stream to print to.
* @param [width] The width to render, which is advisory and may be exceeded.
* A value of 0 implies no restriction on width.
* @param [colorization] A colorization scheme to apply, or null.
* @param [flags] A bitmask of flags to control rendering.
* @return 0 on success, or -1 if an error occurs (errno will be set).
*/
int cypher_parse_result_fprint_ast(const cypher_parse_result_t *result,
FILE *stream, unsigned int width,
const struct cypher_parser_colorization *colorization,
uint_fast32_t flags);
/**
* Free memory associated with a parse result.
*
* The result will no longer be valid after this function is invoked.
*
* @param [result] The parse result.
*/
void cypher_parse_result_free(cypher_parse_result_t *result);
/**
* Get the position of an error.
*
* @param [error] The parse error.
* @return The input position.
*/
__cypherlang_pure
struct cypher_input_position cypher_parse_error_position(
const cypher_parse_error_t *error);
/**
* Get the error message of an error.
*
* @param [error] The parse error.
* @return The message.
*/
__cypherlang_pure
const char *cypher_parse_error_message(const cypher_parse_error_t *error);
/**
* Get the error context of an error.
*
* This returns a pointer to a null-terminated string, which contains a
* section of the input around where the error occurred, that is limited
* in length and suitable for presentation to a user.
*
* @param [error] The parse error.
* @return The context string.
*/
__cypherlang_pure
const char *cypher_parse_error_context(const cypher_parse_error_t *error);
/**
* Get the offset into the context of an error.
*
* Identifies the point of the error within the context string, allowing
* this to be reported to the user, typically with an arrow pointing to the
* invalid character.
*
* @param [error] The parse error.
* @return The offset into the errors context string.
*/
__cypherlang_pure
size_t cypher_parse_error_context_offset(const cypher_parse_error_t *error);
/*
* ====================================
* quick parser
* ====================================
*/
/**
* A quick parse segment.
*/
typedef struct cypher_quick_parse_segment cypher_quick_parse_segment_t;
/**
* A quick parse callback.
*/
typedef int (*cypher_parser_quick_segment_callback_t)(void *userdata,
const cypher_quick_parse_segment_t *segment);
/**
* @fn int cypher_quick_parse(const char *s, cypher_parser_quick_segment_callback_t callback, void *userdata, uint_fast32_t flags);
* @brief Quick parse segments from a string.
*
* The provided callback is invoked for every segment of parsed input, where
* each segments is separated by either a newline or semicolon (`;`),
* respectively depending on whether a client command is being parsed or not.
* If the flag CYPHER_PARSE_ONLY_STATEMENTS is set, then only semicolons will
* be used for delimiting segments, and client commands will not be parsed.
*
* @param [s] The string to parse.
* @param [callback] The callback to be invoked for each parsed segment.
* @param [userdata] A pointer that will be provided to the callback.
* @param [flags] A bitmask of flags to control parsing.
* @return 0 on success, or -1 on failure (errno will be set).
*/
#define cypher_quick_parse(s,c,u,f) (cypher_quick_uparse(s,strlen(s),c,u,f))
/**
* Quick parse segments from a string.
*
* The provided callback is invoked for every segment of parsed input, where
* each segments is separated by either a newline or semicolon (`;`),
* respectively depending on whether a client command is being parsed or not.
* If the flag CYPHER_PARSE_ONLY_STATEMENTS is set, then only semicolons will
* be used for delimiting segments, and client commands will not be parsed.
*
* @param [s] The string to parse.
* @param [n] The size of the string.
* @param [callback] The callback to be invoked for each parsed segment.
* @param [userdata] A pointer that will be provided to the callback.
* @param [flags] A bitmask of flags to control parsing.
* @return 0 on success, or -1 on failure (errno will be set).
*/
__cypherlang_must_check
int cypher_quick_uparse(const char *s, size_t n,
cypher_parser_quick_segment_callback_t callback, void *userdata,
uint_fast32_t flags);
/**
* Quick parse a statement or command from a stream.
*
* The provided callback is invoked for every segment of parsed input, where
* each segments is separated by either a newline or semicolon (`;`),
* respectively depending on whether a client command is being parsed or not.
* If the flag CYPHER_PARSE_ONLY_STATEMENTS is set, then only semicolons will
* be used for delimiting segments, and client commands will not be parsed.
*
* @param [stream] The stream to parse.
* @param [callback] The callback to be invoked for each parsed segment.
* @param [userdata] A pointer that will be provided to the callback.
* @param [flags] A bitmask of flags to control parsing.
* @return 0 on success, or -1 on failure (errno will be set).
*/
int cypher_quick_fparse(FILE *stream,
cypher_parser_quick_segment_callback_t callback, void *userdata,
uint_fast32_t flags);
/**
* Check if the quick parse segment is for a statement.
*
* @param [segment] The quick parse segment.
* @return `true` if the parsed segment was for a statement
* (vs a command), `false` otherwise.
*/
__cypherlang_pure
bool cypher_quick_parse_segment_is_statement(
const cypher_quick_parse_segment_t *segment);
/**
* Check if the quick parse segment is for a command.
*
* @param [segment] The quick parse segment.
* @return `true` if the parsed segment was for a command
* (vs a statement), `false` otherwise.
*/
__cypherlang_pure
bool cypher_quick_parse_segment_is_command(
const cypher_quick_parse_segment_t *segment);
/**
* Get the character string of a segment.
*
* Will include all characters within the parsed statement or command,
* excepting any leading or trailing comments or whitespace.
*
* @param [segment] The quick parse segment.
* @param [n] A `size_t` pointer that will be updated to the length of the
* character string.
* @return A pointer to a character string.
*/
const char *cypher_quick_parse_segment_get_text(
const cypher_quick_parse_segment_t *segment, size_t *n);
/**
* Get the range of a quick parse segment.
*
* @param [segment] The quick parse segment.
* @return The input range.
*/
__cypherlang_pure
struct cypher_input_range cypher_quick_parse_segment_get_range(
const cypher_quick_parse_segment_t *segment);
/**
* Get the next input position that will be parsed.
*
* @param [segment] The parse segment.
* @return The input position.
*/
__cypherlang_pure
struct cypher_input_position cypher_quick_parse_segment_get_next(
const cypher_quick_parse_segment_t *segment);
/**
* Check if the quick parse encountered the end of the input.
*
* Indicates if the segment was terminated by to the end of the input.
*
* @param [segment] The quick parse segment.
* @return `true` if the end of input was encountered, `false` if the
* segment was terminated with an expected character.
*/
__cypherlang_pure
bool cypher_quick_parse_segment_is_eof(
const cypher_quick_parse_segment_t *segment);
#pragma GCC visibility pop
#ifdef __cplusplus
}
#endif
#endif/*CYPHER_PARSER_H*/
|