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
// Copyright 2016 Kyle Mayes // // 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. //! A somewhat idiomatic Rust wrapper for libclang. //! //! ## Supported Versions //! //! * 3.5 - [Documentation](https://kylemayes.github.io/clang-rs/3_5/clang) //! * 3.6 - [Documentation](https://kylemayes.github.io/clang-rs/3_6/clang) //! * 3.7 - [Documentation](https://kylemayes.github.io/clang-rs/3_7/clang) //! * 3.8 - [Documentation](https://kylemayes.github.io/clang-rs/3_8/clang) //! * 3.9 - [Documentation](https://kylemayes.github.io/clang-rs/3_9/clang) //! * 4.0 - [Documentation](https://kylemayes.github.io/clang-rs/4_0/clang) //! * 5.0 - [Documentation](https://kylemayes.github.io/clang-rs/5_0/clang) //! * 6.0 - [Documentation](https://kylemayes.github.io/clang-rs/6_0/clang) //! * 7.0 - [Documentation](https://kylemayes.github.io/clang-rs/7_0/clang) //! * 8.0 - [Documentation](https://kylemayes.github.io/clang-rs/8_0/clang) #![warn(missing_copy_implementations, missing_debug_implementations, missing_docs)] #![allow(non_upper_case_globals)] extern crate clang_sys; extern crate libc; #[macro_use] mod utility; pub mod completion; pub mod diagnostic; pub mod documentation; pub mod source; pub mod token; pub mod sonar; use std::cmp; use std::fmt; use std::hash; use std::mem; use std::ptr; use std::slice; use std::collections::{HashMap}; use std::ffi::{CString}; use std::marker::{PhantomData}; use std::path::{Path, PathBuf}; use std::sync::atomic::{self, AtomicBool}; use clang_sys::*; use libc::{c_int, c_uint, c_ulong}; use completion::{Completer, CompletionString}; use diagnostic::{Diagnostic}; use documentation::{Comment}; use source::{File, Module, SourceLocation, SourceRange}; use token::{Token}; use utility::{FromError, Nullable}; mod error; pub use self::error::*; //================================================ // Enums //================================================ // Accessibility _________________________________ /// Indicates the accessibility of a declaration or base class specifier. #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum Accessibility { /// The declaration or base class specifier is private. Private = 3, /// The declaration or base class specifier is protected. Protected = 2, /// The declaration or base class specifier is public. Public = 1, } // Availability __________________________________ /// Indicates the availability of an AST entity. #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum Availability { /// The entity is available. Available = 0, /// The entity is available but has been deprecated and any usage of it will be a warning. Deprecated = 1, /// The entity is available but is not accessible and any usage of it will be an error. Inaccessible = 3, /// The entity is not available and any usage of it will be an error. Unavailable = 2, } // CallingConvention _____________________________ /// Indicates the calling convention specified for a function type. #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum CallingConvention { /// The function type uses a calling convention that is not exposed via this interface. Unexposed = 200, /// The function type uses the x86 `cdecl` calling convention. Cdecl = 1, /// The function type uses the x86 `fastcall` calling convention. Fastcall = 3, /// The function type uses the x86 `pascal` calling convention. Pascal = 5, /// The function type uses the x86 `stdcall` calling convention. Stdcall = 2, /// The function type uses the x86 `thiscall` calling convention. Thiscall = 4, /// The function type uses the x86 `vectorcall` calling convention. /// /// Only produced by `libclang` 3.6 and later. Vectorcall = 12, /// The function type uses the calling convention for the Swift programming language. /// /// Only produced by `libclang` 3.9 and later. Swift = 13, /// The function type uses a calling convention that perserves most registers. /// /// Only produced by `libclang` 3.9 and later. PreserveMost = 14, /// The function type uses a calling convention that preverses nearly all registers. /// /// Only produced by `libclang` 3.9 and later. PreserveAll = 15, /// The function type uses the ARM AACPS calling convention. Aapcs = 6, /// The function type uses the ARM AACPS-VFP calling convention. AapcsVfp = 7, /// The function type uses the calling convention for Intel OpenCL built-ins. IntelOcl = 9, /// The function type uses a calling convention that passes as many values in registers as /// possible. /// /// Only produced by `libclang` 4.0 and later. RegCall = 8, /// The function type uses the x64 C calling convention as specified in the System V ABI. SysV64 = 11, /// The function type uses the x64 C calling convention as implemented on Windows. Win64 = 10, } // EntityKind ____________________________________ /// Indicates the categorization of an AST entity. #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum EntityKind { /// A declaration whose specific type is not exposed via this interface. UnexposedDecl = 1, /// A C or C++ struct. StructDecl = 2, /// A C or C++ union. UnionDecl = 3, /// A C++ class. ClassDecl = 4, /// An enum. EnumDecl = 5, /// A C field or C++ non-static data member in a struct, union, or class. FieldDecl = 6, /// An enum constant. EnumConstantDecl = 7, /// A function. FunctionDecl = 8, /// A variable. VarDecl = 9, /// A parameter. ParmDecl = 10, /// An Objective-C `@interface`. ObjCInterfaceDecl = 11, /// An Objective-C `@interface` for a category. ObjCCategoryDecl = 12, /// An Objective-C `@protocol` declaration. ObjCProtocolDecl = 13, /// An Objective-C `@property` declaration. ObjCPropertyDecl = 14, /// An Objective-C instance variable. ObjCIvarDecl = 15, /// An Objective-C instance method. ObjCInstanceMethodDecl = 16, /// An Objective-C class method. ObjCClassMethodDecl = 17, /// An Objective-C `@implementation`. ObjCImplementationDecl = 18, /// An Objective-C `@implementation` for a category. ObjCCategoryImplDecl = 19, /// A typedef. TypedefDecl = 20, /// A C++ method. Method = 21, /// A C++ namespace. Namespace = 22, /// A linkage specification (e.g., `extern "C"`). LinkageSpec = 23, /// A C++ constructor. Constructor = 24, /// A C++ destructor. Destructor = 25, /// A C++ conversion function. ConversionFunction = 26, /// A C++ template type parameter. TemplateTypeParameter = 27, /// A C++ template non-type parameter. NonTypeTemplateParameter = 28, /// A C++ template template parameter. TemplateTemplateParameter = 29, /// A C++ function template. FunctionTemplate = 30, /// A C++ class template. ClassTemplate = 31, /// A C++ class template partial specialization. ClassTemplatePartialSpecialization = 32, /// A C++ namespace alias declaration. NamespaceAlias = 33, /// A C++ using directive. UsingDirective = 34, /// A C++ using declaration. UsingDeclaration = 35, /// A C++ type alias declaration. TypeAliasDecl = 36, /// An Objective-C `@synthesize` definition. ObjCSynthesizeDecl = 37, /// An Objective-C `@dynamic` definition. ObjCDynamicDecl = 38, /// An access specifier. AccessSpecifier = 39, /// A reference to a super class in Objective-C. ObjCSuperClassRef = 40, /// A reference to a protocol in Objective-C. ObjCProtocolRef = 41, /// A reference to a class in Objective-C. ObjCClassRef = 42, /// A reference to a type declaration. TypeRef = 43, /// A base class specifier. BaseSpecifier = 44, /// A reference to a class template, function template, template template parameter, or class /// template partial specialization. TemplateRef = 45, /// A reference to a namespace or namespace alias. NamespaceRef = 46, /// A reference to a member of a struct, union, or class that occurs in some non-expression /// context. MemberRef = 47, /// A reference to a labeled statement. LabelRef = 48, /// A reference to a set of overloaded functions or function templates that has not yet been /// resolved to a specific function or function template. OverloadedDeclRef = 49, /// A reference to a variable that occurs in some non-expression context. VariableRef = 50, /// An expression whose specific kind is not exposed via this interface. UnexposedExpr = 100, /// An expression that refers to some value declaration, such as a function or enumerator. DeclRefExpr = 101, /// An expression that refers to the member of a struct, union, or class. MemberRefExpr = 102, /// An expression that calls a function. CallExpr = 103, /// An expression that sends a message to an Objective-C object or class. ObjCMessageExpr = 104, /// An expression that represents a block literal. BlockExpr = 105, /// An integer literal. IntegerLiteral = 106, /// A floating point number literal. FloatingLiteral = 107, /// An imaginary number literal. ImaginaryLiteral = 108, /// A string literal. StringLiteral = 109, /// A character literal. CharacterLiteral = 110, /// A parenthesized expression. ParenExpr = 111, /// Any unary expression other than `sizeof` and `alignof`. UnaryOperator = 112, /// An array subscript expression (`[C99 6.5.2.1]`). ArraySubscriptExpr = 113, /// A built-in binary expression (e.g., `x + y`). BinaryOperator = 114, /// A compound assignment expression (e.g., `x += y`). CompoundAssignOperator = 115, /// A ternary expression. ConditionalOperator = 116, /// An explicit cast in C or a C-style cast in C++. CStyleCastExpr = 117, /// A compound literal expression (`[C99 6.5.2.5]`). CompoundLiteralExpr = 118, /// A C or C++ initializer list. InitListExpr = 119, /// A GNU address of label expression. AddrLabelExpr = 120, /// A GNU statement expression. StmtExpr = 121, /// A C11 generic selection expression. GenericSelectionExpr = 122, /// A GNU `__null` expression. GNUNullExpr = 123, /// A C++ `static_cast<>` expression. StaticCastExpr = 124, /// A C++ `dynamic_cast<>` expression. DynamicCastExpr = 125, /// A C++ `reinterpret_cast<>` expression. ReinterpretCastExpr = 126, /// A C++ `const_cast<>` expression. ConstCastExpr = 127, /// A C++ cast that uses "function" notation (e.g., `int(0.5)`). FunctionalCastExpr = 128, /// A C++ `typeid` expression. TypeidExpr = 129, /// A C++ boolean literal. BoolLiteralExpr = 130, /// A C++ `nullptr` expression. NullPtrLiteralExpr = 131, /// A C++ `this` expression. ThisExpr = 132, /// A C++ `throw` expression. ThrowExpr = 133, /// A C++ `new` expression. NewExpr = 134, /// A C++ `delete` expression. DeleteExpr = 135, /// A unary expression. UnaryExpr = 136, /// An Objective-C string literal. ObjCStringLiteral = 137, /// An Objective-C `@encode` expression. ObjCEncodeExpr = 138, /// An Objective-C `@selector` expression. ObjCSelectorExpr = 139, /// An Objective-C `@protocol` expression. ObjCProtocolExpr = 140, /// An Objective-C bridged cast expression. ObjCBridgedCastExpr = 141, /// A C++11 parameter pack expansion expression. PackExpansionExpr = 142, /// A C++11 `sizeof...` expression. SizeOfPackExpr = 143, /// A C++11 lambda expression. LambdaExpr = 144, /// An Objective-C boolean literal. ObjCBoolLiteralExpr = 145, /// An Objective-C `self` expression. ObjCSelfExpr = 146, /// An OpenMP array section expression. /// /// Only produced by `libclang` 3.8 and later. OmpArraySectionExpr = 147, /// An Objective-C availability check expression (e.g., `@available(macos 10.10, *)`). /// /// Only produced by `libclang` 3.9 and later. ObjCAvailabilityCheckExpr = 148, /// A fixed-point literal. /// /// Only produced by `libclang` 7.0 and later. FixedPointLiteral = 149, /// A statement whose specific kind is not exposed via this interface. UnexposedStmt = 200, /// A labelled statement in a function. LabelStmt = 201, /// A group of statements (e.g., a function body). CompoundStmt = 202, /// A `case` statement. CaseStmt = 203, /// A `default` statement. DefaultStmt = 204, /// An `if` statement. IfStmt = 205, /// A `switch` statement. SwitchStmt = 206, /// A `while` statement. WhileStmt = 207, /// A `do` statement. DoStmt = 208, /// A `for` statement. ForStmt = 209, /// A `goto` statement. GotoStmt = 210, /// An indirect `goto` statement. IndirectGotoStmt = 211, /// A `continue` statement. ContinueStmt = 212, /// A `break` statement. BreakStmt = 213, /// A `return` statement. ReturnStmt = 214, /// An inline assembly statement. AsmStmt = 215, /// An Objective-C `@try`-`@catch`-`@finally` statement. ObjCAtTryStmt = 216, /// An Objective-C `@catch` statement. ObjCAtCatchStmt = 217, /// An Objective-C `@finally` statement. ObjCAtFinallyStmt = 218, /// An Objective-C `@throw` statement. ObjCAtThrowStmt = 219, /// An Objective-C `@synchronized` statement. ObjCAtSynchronizedStmt = 220, /// An Objective-C autorelease pool statement. ObjCAutoreleasePoolStmt = 221, /// An Objective-C collection statement. ObjCForCollectionStmt = 222, /// A C++ catch statement. CatchStmt = 223, /// A C++ try statement. TryStmt = 224, /// A C++11 range-based for statement. ForRangeStmt = 225, /// A Windows Structured Exception Handling `__try` statement. SehTryStmt = 226, /// A Windows Structured Exception Handling `__except` statement. SehExceptStmt = 227, /// A Windows Structured Exception Handling `__finally` statement. SehFinallyStmt = 228, /// A Windows Structured Exception Handling `__leave` statement. SehLeaveStmt = 247, /// A Microsoft inline assembly statement. MsAsmStmt = 229, /// A null statement. NullStmt = 230, /// An adaptor for mixing declarations with statements and expressions. DeclStmt = 231, /// An OpenMP parallel directive. OmpParallelDirective = 232, /// An OpenMP SIMD directive. OmpSimdDirective = 233, /// An OpenMP for directive. OmpForDirective = 234, /// An OpenMP sections directive. OmpSectionsDirective = 235, /// An OpenMP section directive. OmpSectionDirective = 236, /// An OpenMP single directive. OmpSingleDirective = 237, /// An OpenMP parallel for directive. OmpParallelForDirective = 238, /// An OpenMP parallel sections directive. OmpParallelSectionsDirective = 239, /// An OpenMP task directive. OmpTaskDirective = 240, /// An OpenMP master directive. OmpMasterDirective = 241, /// An OpenMP critical directive. OmpCriticalDirective = 242, /// An OpenMP taskyield directive. OmpTaskyieldDirective = 243, /// An OpenMP barrier directive. OmpBarrierDirective = 244, /// An OpenMP taskwait directive. OmpTaskwaitDirective = 245, /// An OpenMP flush directive. OmpFlushDirective = 246, /// An OpenMP ordered directive. /// /// Only produced by `libclang` 3.6 and later. OmpOrderedDirective = 248, /// An OpenMP atomic directive. /// /// Only produced by `libclang` 3.6 and later. OmpAtomicDirective = 249, /// An OpenMP for SIMD directive. /// /// Only produced by `libclang` 3.6 and later. OmpForSimdDirective = 250, /// An OpenMP parallel for SIMD directive. /// /// Only produced by `libclang` 3.6 and later. OmpParallelForSimdDirective = 251, /// An OpenMP target directive. /// /// Only produced by `libclang` 3.6 and later. OmpTargetDirective = 252, /// An OpenMP teams directive. /// /// Only produced by `libclang` 3.6 and later. OmpTeamsDirective = 253, /// An OpenMP taskgroup directive. /// /// Only produced by `libclang` 3.7 and later. OmpTaskgroupDirective = 254, /// An OpenMP cancellation point directive. /// /// Only produced by `libclang` 3.7 and later. OmpCancellationPointDirective = 255, /// An OpenMP cancel directive. /// /// Only produced by `libclang` 3.7 and later. OmpCancelDirective = 256, /// An OpenMP target data directive. /// /// Only produced by `libclang` 3.8 and later. OmpTargetDataDirective = 257, /// An OpenMP task loop directive. /// /// Only produced by `libclang` 3.8 and later. OmpTaskLoopDirective = 258, /// An OpenMP task loop SIMD directive. /// /// Only produced by `libclang` 3.8 and later. OmpTaskLoopSimdDirective = 259, /// An OpenMP distribute directive. /// /// Only produced by `libclang` 3.8 and later. OmpDistributeDirective = 260, /// An OpenMP target enter data directive. /// /// Only produced by `libclang` 3.9 and later. OmpTargetEnterDataDirective = 261, /// An OpenMP target exit data directive. /// /// Only produced by `libclang` 3.9 and later. OmpTargetExitDataDirective = 262, /// An OpenMP target parallel directive. /// /// Only produced by `libclang` 3.9 and later. OmpTargetParallelDirective = 263, /// An OpenMP target parallel for directive. /// /// Only produced by `libclang` 3.9 and later. OmpTargetParallelForDirective = 264, /// An OpenMP target update directive. /// /// Only produced by `libclang` 3.9 and later. OmpTargetUpdateDirective = 265, /// An OpenMP distribute parallel for directive. /// /// Only produced by `libclang` 3.9 and later. OmpDistributeParallelForDirective = 266, /// An OpenMP distribute parallel for SIMD directive. /// /// Only produced by `libclang` 3.9 and later. OmpDistributeParallelForSimdDirective = 267, /// An OpenMP distribute SIMD directive. /// /// Only produced by `libclang` 3.9 and later. OmpDistributeSimdDirective = 268, /// An OpenMP target parallel for SIMD directive. /// /// Only produced by `libclang` 3.9 and later. OmpTargetParallelForSimdDirective = 269, /// An OpenMP target SIMD directive. /// /// Only produced by `libclang` 4.0 and later. OmpTargetSimdDirective = 270, /// An OpenMP teams distribute directive. /// /// Only produced by `libclang` 4.0 and later. OmpTeamsDistributeDirective = 271, /// An OpenMP teams distribute SIMD directive. /// /// Only produced by `libclang` 4.0 and later. OmpTeamsDistributeSimdDirective = 272, /// An OpenMP teams distribute parallel for SIMD directive. /// /// Only produced by `libclang` 4.0 and later. OmpTeamsDistributeParallelForSimdDirective = 273, /// An OpenMP teams distribute parallel for directive. /// /// Only produced by `libclang` 4.0 and later. OmpTeamsDistributeParallelForDirective = 274, /// An OpenMP target teams directive. /// /// Only produced by `libclang` 4.0 and later. OmpTargetTeamsDirective = 275, /// An OpenMP target teams distribute directive. /// /// Only produced by `libclang` 4.0 and later. OmpTargetTeamsDistributeDirective = 276, /// An OpenMP target teams distribute parallel for directive. /// /// Only produced by `libclang` 4.0 and later. OmpTargetTeamsDistributeParallelForDirective = 277, /// An OpenMP target teams distribute parallel for SIMD directive. /// /// Only produced by `libclang` 4.0 and later. OmpTargetTeamsDistributeParallelForSimdDirective = 278, /// An OpenMP target teams distribute SIMD directive. /// /// Only produced by `libclang` 4.0 and later. OmpTargetTeamsDistributeSimdDirective = 279, /// The top-level AST entity which acts as the root for the other entitys. TranslationUnit = 300, /// An attribute whose specific kind is not exposed via this interface. UnexposedAttr = 400, /// An attribute applied to an Objective-C IBAction. IbActionAttr = 401, /// An attribute applied to an Objective-C IBOutlet. IbOutletAttr = 402, /// An attribute applied to an Objective-C IBOutletCollection. IbOutletCollectionAttr = 403, /// The `final` attribute. FinalAttr = 404, /// The `override` attribute. OverrideAttr = 405, /// An annotation attribute. AnnotateAttr = 406, /// An ASM label attribute. AsmLabelAttr = 407, /// An attribute that requests for packed records (e.g., `__attribute__ ((__packed__))`). PackedAttr = 408, /// An attribute that asserts a function has no side effects (e.g., `__attribute__((pure))`). PureAttr = 409, /// The `const` attribute. ConstAttr = 410, /// An attribute that allows calls to a function to be duplicated by the optimized /// (e.g., `__attribute__((noduplicate))`). NoDuplicateAttr = 411, /// A CUDA constant attribute. CudaConstantAttr = 412, /// A CUDA device attribute. CudaDeviceAttr = 413, /// A CUDA global attribute. CudaGlobalAttr = 414, /// A CUDA host attribute. CudaHostAttr = 415, /// A CUDA shared attribute. /// /// Only produced by `libclang` 3.6 and later. CudaSharedAttr = 416, /// A linker visibility attribute. /// /// Only produced by `libclang` 3.8 and later. VisibilityAttr = 417, /// A MSVC DLL export attribute. /// /// Only produced by `libclang` 3.8 and later. DllExport = 418, /// A MSVC DLL import attribute. /// /// Only produced by `libclang` 3.8 and later. DllImport = 419, /// `__attribute__((ns_returns_retained))` /// /// Only produced by `libclang` 8.0 and later. NSReturnsRetained = 420, /// `__attribute__((ns_returns_not_retained))` /// /// Only produced by `libclang` 8.0 and later. NSReturnsNotRetained = 421, /// `__attribute__((ns_returns_autoreleased))` /// /// Only produced by `libclang` 8.0 and later. NSReturnsAutoreleased = 422, /// `__attribute__((ns_consumes_self))` /// /// Only produced by `libclang` 8.0 and later. NSConsumesSelf = 423, /// `__attribute__((ns_consumed))` /// /// Only produced by `libclang` 8.0 and later. NSConsumed = 424, /// `__attribute__((objc_exception))` /// /// Only produced by `libclang` 8.0 and later. ObjCException = 425, /// `__attribute__((NSObject))` /// /// Only produced by `libclang` 8.0 and later. ObjCNSObject = 426, /// `__attribute__((objc_independent_class))` /// /// Only produced by `libclang` 8.0 and later. ObjCIndependentClass = 427, /// `__attribute__((objc_precise_lifetime))` /// /// Only produced by `libclang` 8.0 and later. ObjCPreciseLifetime = 428, /// `__attribute__((objc_returns_inner_pointer))` /// /// Only produced by `libclang` 8.0 and later. ObjCReturnsInnerPointer = 429, /// `__attribute__((objc_requires_super))` /// /// Only produced by `libclang` 8.0 and later. ObjCRequiresSuper = 430, /// `__attribute__((objc_root_class))` /// /// Only produced by `libclang` 8.0 and later. ObjCRootClass = 431, /// `__attribute__((objc_subclassing_restricted))` /// /// Only produced by `libclang` 8.0 and later. ObjCSubclassingRestricted = 432, /// `__attribute__((objc_protocol_requires_explicit_implementation))` /// /// Only produced by `libclang` 8.0 and later. ObjCExplicitProtocolImpl = 433, /// `__attribute__((objc_designated_initializer))` /// /// Only produced by `libclang` 8.0 and later. ObjCDesignatedInitializer = 434, /// `__attribute__((objc_runtime_visible))` /// /// Only produced by `libclang` 8.0 and later. ObjCRuntimeVisible = 435, /// `__attribute__((objc_boxable))` /// /// Only produced by `libclang` 8.0 and later. ObjCBoxable = 436, /// `__attribute__((flag_enum))` /// /// Only produced by `libclang` 8.0 and later. FlagEnum = 437, /// A preprocessing directive. PreprocessingDirective = 500, /// A macro definition. MacroDefinition = 501, /// A macro expansion. MacroExpansion = 502, /// An inclusion directive. InclusionDirective = 503, /// A module import declaration. ModuleImportDecl = 600, /// A C++11 alias template declaration (e.g., `template <typename T> using M = std::map<T, T>`). /// /// Only produced by `libclang` 3.8 and later. TypeAliasTemplateDecl = 601, /// A `static_assert` node. /// /// Only produced by `libclang` 3.9 and later. StaticAssert = 602, /// A friend declaration. /// /// Only produced by `libclang` 4.0 and later. FriendDecl = 603, /// A single overload in a set of overloads. /// /// Only produced by `libclang` 3.7 and later. OverloadCandidate = 700, } // EntityVisitResult _____________________________ /// Indicates how a entity visitation should proceed. #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum EntityVisitResult { /// Do not continue visiting entities. Break = 0, /// Continue visiting sibling entities iteratively, skipping child entities. Continue = 1, /// Continue visiting sibling and child entities recursively, children first. Recurse = 2, } // EvaluationResult ______________________________ /// The result of evaluating an expression. #[cfg(feature="gte_clang_3_9")] #[derive(Clone, Debug, PartialEq)] pub enum EvaluationResult { /// An evaluation result whose specific type is not exposed via this interface. Unexposed, /// A signed integer evaluation result. SignedInteger(i64), /// An unsigned integer evaluation result. /// /// Only produced by `libclang` 4.0 and later. Earlier versions will always return /// `SignedInteger` for integers. UnsignedInteger(u64), /// A floating point number evaluation result. Float(f64), /// A string literal evaluation result. String(CString), /// An Objective-C string literal evaluation result. ObjCString(CString), /// An Objective-C `CFString` evaluation result. CFString(CString), /// Any other evaluation result whose value can be represented by a string. Other(CString), } // ExceptionSpecification ________________________ /// Indicates the exception specification of a function. #[cfg(feature="gte_clang_5_0")] #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum ExceptionSpecification { /// The function has a basic `noexcept` specification. BasicNoexcept = 4, /// The function has a computed `noexcept` specification. ComputedNoexcept = 5, /// The function has a `throw(T1, T2)` specification. Dynamic = 2, /// The function has a `throw(...)` specification. DynamicAny = 3, /// The function has a `throw()` specification. DynamicNone = 1, /// The function has an exception specification that has not yet been evaluated. Unevaluated = 6, /// The function has an exception specification that has not yet been instantiated. Uninstantiated = 7, /// The function has an exception specification that has not yet been parsed. Unparsed = 8, } // Language ______________________________________ /// Indicates the language used by a declaration. #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum Language { /// The declaration uses the C programming language. C = 1, /// The declaration uses the C++ programming language. Cpp = 3, /// The declaration uses the Objective-C programming language. ObjectiveC = 2, /// The declaration uses the Swift programming language. /// /// Only produced by `libclang` 5.0 and later. Swift = 4, } // Linkage _______________________________________ /// Indicates the linkage of an AST entity. #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum Linkage { /// The AST entity has automatic storage (e.g., variables or parameters). Automatic = 1, /// The AST entity is a static variable or static function. Internal = 2, /// The AST entity has external linkage. External = 4, /// The AST entity has external linkage and lives in a C++ anonymous namespace. UniqueExternal = 3, } // MemoryUsage ___________________________________ /// Indicates the usage category of a quantity of memory. #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum MemoryUsage { /// Expressions, declarations, and types. Ast = 1, /// Various tables used by the AST. AstSideTables = 6, /// Memory allocated with `malloc` for external AST sources. ExternalAstSourceMalloc = 9, /// Memory allocated with `mmap` for external AST sources. ExternalAstSourceMMap = 10, /// Cached global code completion results. GlobalCodeCompletionResults = 4, /// Identifiers. Identifiers = 2, /// The preprocessing record. PreprocessingRecord = 12, /// Memory allocated with `malloc` for the preprocessor. Preprocessor = 11, /// Header search tables. PreprocessorHeaderSearch = 14, /// Selectors. Selectors = 3, /// The content cache used by the source manager. SourceManagerContentCache = 5, /// Data structures used by the source manager. SourceManagerDataStructures = 13, /// Memory allocated with `malloc` for the source manager. SourceManagerMalloc = 7, /// Memory allocated with `mmap` for the source manager. SourceManagerMMap = 8, } // Nullability ___________________________________ /// Indicates the nullability of a pointer type. #[cfg(feature="gte_clang_8_0")] #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum Nullability { /// Values of this type can never be null. NonNull = 0, /// Values of this type can be null. Nullable = 1, /// Whether values of this type can be null is (explicitly) unspecified. Unspecified = 2, } // PrintingPolicyFlag ____________________________ /// Flags for the printing policy. #[cfg(feature="gte_clang_7_0")] #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum PrintingPolicyFlag { /// Whether to suppress printing specifiers for a given type or declaration. SuppressSpecifiers = 1, /// Whether to suppress printing the tag keyword. SuppressTagKeyword = 2, /// Whether to include the body of a tag definition. IncludeTagDefinition = 3, /// Whether to suppress printing of scope specifiers. SuppressScope = 4, /// Whether to suppress printing the parts of scope specifiers that don't need to be written. SuppressUnwrittenScope = 5, /// Whether to suppress printing of variable initializers. SuppressInitializers = 6, /// Whether to print the size of constant array expressions as written. PrintConstantArraySizeAsWritten = 7, /// Whether to print the location of anonymous tags. PrintAnonymousTagLocations = 8, /// Whether to suppress printing the __strong lifetime qualifier in ARC. SuppressStrongLifetime = 9, /// Whether to suppress printing lifetime qualifiers in ARC. SuppressLifetimeQualifiers = 10, /// Whether to suppress printing template arguments in names of C++ constructors. SuppressTemplateArgsInCXXConstructors = 11, /// Whether to print 'bool' rather than '_Bool'. UseBool = 12, /// Whether to print 'restrict' rather than '__restrict' UseRestrict = 13, /// Whether to print 'alignof' rather than '__alignof' UseAlignof = 14, /// Whether to print '_Alignof' rather than '__alignof' UseUnderscoreAlignof = 15, /// Whether to print '(void)' rather then '()' for a function prototype with zero parameters. UseVoidForZeroParams = 16, /// Whether to print terse output. UseTerseOutput = 17, /// Whether to do certain refinements needed for producing a proper declaration tag. PolishForDeclaration = 18, /// Whether to print 'half' rather than '__fp16' UseHalf = 19, /// Whether to print the built-in wchar_t type as '__wchar_t' UseMsWchar = 20, /// Whether to include newlines after statements. IncludeNewlines = 21, /// Whether to use whitespace and punctuation like MSVC does. UseMsvcFormatting = 22, /// Whether to print constant expressions as written. PrintConstantsAsWritten = 23, /// Whether to suppress printing the implicit 'self' or 'this' expressions. SuppressImplicitBase = 24, /// Whether to print the fully qualified name of function declarations. PrintFullyQualifiedName = 25, } // RefQualifier __________________________________ /// Indicates the ref qualifier of a C++ function or method type. #[cfg_attr(feature="cargo-clippy", allow(enum_variant_names))] #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum RefQualifier { /// The function or method has an l-value ref qualifier (`&`). LValue = 1, /// The function or method has an r-value ref qualifier (`&&`). RValue = 2, } // StorageClass __________________________________ /// Indicates the storage class of a declaration. #[cfg(feature="gte_clang_3_6")] #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum StorageClass { /// The declaration does not specifiy a storage duration and therefore has an automatic storage /// duration. None = 1, /// The declaration specifies an automatic storage duration. Auto = 6, /// The declaration specifies an automatic storage duration and that it should be stored in a /// CPU register Register = 7, /// The declaration specifies a static storage duration and internal linkage. Static = 3, /// The declaration specifies a static storage duration and external linkage. Extern = 2, /// The declaration specifies a static storage duration and external linkage but is not /// accessible outside the containing translation unit. PrivateExtern = 4, /// The declaration specifies a storage duration related to an OpenCL work group. OpenClWorkGroupLocal = 5, } // TemplateArgument ______________________________ /// An argument to a template function specialization. #[cfg(feature="gte_clang_3_6")] #[derive(Copy, Clone, Debug, PartialEq, Eq)] pub enum TemplateArgument<'tu> { /// A declaration for a pointer, reference, or member pointer non-type template parameter. Declaration, /// An expression that has not yet been resolved Expression, /// An empty template argument (e.g., one that has not yet been deduced). Null, /// A null pointer or null member pointer provided for a non-type template parameter. Nullptr, /// A parameter pack. Pack, /// A name for a template provided for a template template parameter. Template, /// A pack expansion of a name for a template provided for a template template parameter. TemplateExpansion, /// An integer. Integral(i64, u64), /// A type. Type(Type<'tu>), } // TlsKind _______________________________________ /// Indicates the thread-local storage (TLS) kind of a declaration. #[cfg(feature="gte_clang_6_0")] #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum TlsKind { /// The declaration uses dynamic TLS. Dynamic = 1, /// The declaration uses static TLS. Static = 2, } // TypeKind ______________________________________ /// Indicates the categorization of a type. #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum TypeKind { /// A type whose specific kind is not exposed via this interface. Unexposed = 1, /// `void` Void = 2, /// `bool` (C++) or `_Bool` (C99) Bool = 3, /// The `char` type when it is signed by default. CharS = 13, /// The `char` type when it is unsigned by default. CharU = 4, /// `signed char` SChar = 14, /// `unsigned char` UChar = 5, /// `wchar_t` WChar = 15, /// `char16_t` Char16 = 6, /// `char32_t` Char32 = 7, /// `short` Short = 16, /// `unsigned short` UShort = 8, /// `int` Int = 17, /// `unsigned int` UInt = 9, /// `long` Long = 18, /// `unsigned long` ULong = 10, /// `long long` LongLong = 19, /// `unsigned long long` ULongLong = 11, /// `__int128_t` Int128 = 20, /// `__uint128_t` UInt128 = 12, /// A half-precision (16-bit) floating point type. /// /// Only produced by `libclang` 5.0 and later. Half = 31, /// A half-precision (16-bit) floating point type. /// /// Only produced by `libclang` 6.0 and later. Float16 = 32, /// `short _Accum` /// /// Only produced by `libclang` 7.0 and later. ShortAccum = 33, /// `_Accum` /// /// Only produced by `libclang` 7.0 and later. Accum = 34, /// `long _Accum` /// /// Only produced by `libclang` 7.0 and later. LongAccum = 35, /// `unsigned short _Accum` /// /// Only produced by `libclang` 7.0 and later. UShortAccum = 36, /// `unsigned _Accum` /// /// Only produced by `libclang` 7.0 and later. UAccum = 37, /// `unsigned long _Accum` /// /// Only produced by `libclang` 7.0 and later. ULongAccum = 38, /// `float` Float = 21, /// `double` Double = 22, /// `long double` LongDouble = 23, /// `nullptr_t` (C++11) Nullptr = 24, /// A C99 complex type (e.g., `_Complex float`). Complex = 100, /// An unknown dependent type. Dependent = 26, /// The type of an unresolved overload set. Overload = 25, /// `id` (Objective-C) ObjCId = 27, /// `Class` (Objective-C) ObjCClass = 28, /// `SEL` (Objective-C) ObjCSel = 29, /// `__float128` /// /// Only produced by `libclang` 3.9 and later. Float128 = 30, /// An Objective-C interface type. ObjCInterface = 108, /// An Objective-C pointer to object type. ObjCObjectPointer = 109, /// A pointer type. Pointer = 101, /// A block pointer type (e.g., `void (^)(int)`). BlockPointer = 102, /// A pointer to a record member type. MemberPointer = 117, /// An l-value reference (e.g. `int&`). LValueReference = 103, /// An r-value reference (e.g. `int&&`). RValueReference = 104, /// An enum type. Enum = 106, /// A record type such as a struct or a class. Record = 105, /// A typedef. Typedef = 107, /// A function prototype with parameter type information (e.g., `void foo(int)`). FunctionPrototype = 111, /// A function prototype without parameter type information (e.g., `void foo()`). FunctionNoPrototype = 110, /// An array type with a specified size that is an integer constant expression. ConstantArray = 112, /// An array type with a specified size that is a dependent value. DependentSizedArray = 116, /// An array type without a specified size. IncompleteArray = 114, /// An array type with a specified size that is not an integer constant expression. VariableArray = 115, /// A GCC generic vector type. Vector = 113, /// A C++11 `decltype(auto)` type. /// /// Only produced by `libclang` 3.8 and later. Auto = 118, /// A type that was referred to using an elaborated type keyword (e.g., `struct S`). /// /// Only produced by `libclang` 3.9 and later. Elaborated = 119, /// An OpenCL pipe type. /// /// Only produced by `libclang` 5.0 and later. Pipe = 120, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage1dRO = 121, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage1dArrayRO = 122, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage1dBufferRO = 123, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dRO = 124, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayRO = 125, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dDepthRO = 126, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayDepthRO = 127, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dMSAARO = 128, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayMSAARO = 129, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dMSAADepthRO = 130, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayMSAADepthRO = 131, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage3dRO = 132, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage1dWO = 133, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage1dArrayWO = 134, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage1dBufferWO = 135, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dWO = 136, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayWO = 137, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dDepthWO = 138, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayDepthWO = 139, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dMSAAWO = 140, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayMSAAWO = 141, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dMSAADepthWO = 142, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayMSAADepthWO = 143, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage3dWO = 144, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage1dRW = 145, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage1dArrayRW = 146, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage1dBufferRW = 147, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dRW = 148, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayRW = 149, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dDepthRW = 150, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayDepthRW = 151, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dMSAARW = 152, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayMSAARW = 153, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dMSAADepthRW = 154, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage2dArrayMSAADepthRW = 155, /// An OpenCL image type. /// /// Only produced by `libclang` 5.0 and later. OCLImage3dRW = 156, /// An OpenCL sampler type. /// /// Only produced by `libclang` 5.0 and later. OCLSampler = 157, /// An OpenCL event type. /// /// Only produced by `libclang` 5.0 and later. OCLEvent = 158, /// An OpenCL queue type. /// /// Only produced by `libclang` 5.0 and later. OCLQueue = 159, /// An OpenCL reserve ID type. /// /// Only produced by `libclang` 5.0 and later. OCLReserveID = 160, /// An Objective-C object type. /// /// Only produced by `libclang` 8.0 and later. ObjCObject = 161, /// An Objective-C type param. /// /// Only produced by `libclang` 8.0 and later. ObjCTypeParam = 162, /// An attributed type. /// /// Only produced by `libclang` 8.0 and later. Attributed = 163, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCMcePayload = 164, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCImePayload = 165, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCRefPayload = 166, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCSicPayload = 167, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCMceResult = 168, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCImeResult = 169, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCRefResult = 170, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCSicResult = 171, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCImeResultSingleRefStreamout = 172, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCImeResultDualRefStreamout = 173, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCImeSingleRefStreamin = 174, /// An Intel OpenCL extension type for the AVC VME media sampler in Intel graphics processors. /// /// Only produced by `libclang` 8.0 and later. OCLIntelSubgroupAVCImeDualRefStreamin = 175, } // Visibility ____________________________________ /// Indicates the linker visibility of an AST element. #[cfg(feature="gte_clang_3_8")] #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub enum Visibility { /// The AST element can be seen by the linker. Default = 3, /// The AST element cannot be seen by the linker. Hidden = 1, /// The AST element can be seen by the linker but resolves to a symbol inside this object. Protected = 2, } //================================================ // Structs //================================================ // Clang _________________________________________ static AVAILABLE: AtomicBool = AtomicBool::new(true); /// An empty type which prevents the use of this library from multiple threads simultaneously. #[derive(Debug)] pub struct Clang; impl Clang { //- Constructors ----------------------------- /// Constructs a new `Clang`. /// /// Only one instance of `Clang` is allowed at a time. /// /// # Failures /// /// * an instance of `Clang` already exists /// * a `libclang` shared library could not be found /// * a `libclang` shared library symbol could not be loaded #[cfg(feature="runtime")] pub fn new() -> Result<Clang, String> { if AVAILABLE.swap(false, atomic::Ordering::SeqCst) { load().map(|_| Clang) } else { Err("an instance of `Clang` already exists".into()) } } /// Constructs a new `Clang`. /// /// Only one instance of `Clang` is allowed at a time. /// /// # Failures /// /// * an instance of `Clang` already exists #[cfg(not(feature="runtime"))] pub fn new() -> Result<Clang, String> { if AVAILABLE.swap(false, atomic::Ordering::SeqCst) { Ok(Clang) } else { Err("an instance of `Clang` already exists".into()) } } } #[cfg(feature="runtime")] impl Drop for Clang { fn drop(&mut self) { unload().unwrap(); AVAILABLE.store(true, atomic::Ordering::SeqCst); } } #[cfg(not(feature="runtime"))] impl Drop for Clang { fn drop(&mut self) { AVAILABLE.store(true, atomic::Ordering::SeqCst); } } // CompilationDatabase ________________________________________ /// A compilation database of all information used to compile files in a project. #[derive(Debug)] pub struct CompilationDatabase { ptr: CXCompilationDatabase, } impl CompilationDatabase { /// Creates a compilation database from the database found in the given directory. pub fn from_directory<P: AsRef<Path>>(path: P) -> Result<CompilationDatabase, ()> { let path = utility::from_path(path); unsafe { let mut error: CXCompilationDatabase_Error = mem::uninitialized(); let ptr = clang_CompilationDatabase_fromDirectory(path.as_ptr(), &mut error); match error { CXCompilationDatabase_NoError => Ok(CompilationDatabase { ptr }), CXCompilationDatabase_CanNotLoadDatabase => Err(()), _ => unreachable!(), } } } /// Get all the compile commands from the database. pub fn get_all_compile_commands(&self) -> CompileCommands { unsafe { CompileCommands::from_ptr(clang_CompilationDatabase_getAllCompileCommands(self.ptr)) } } /// Find the compile commands for the given file. pub fn get_compile_commands<P: AsRef<Path>>(&self, path: P) -> Result<CompileCommands, ()> { // Presumably this returns null if we can't find the given path? // The Clang docs don't specify. let path = utility::from_path(path); let ptr = unsafe { clang_CompilationDatabase_getCompileCommands(self.ptr, path.as_ptr()) }; ptr.map(CompileCommands::from_ptr).ok_or(()) } } impl Drop for CompilationDatabase { fn drop(&mut self) { unsafe { clang_CompilationDatabase_dispose(self.ptr); } } } /// The result of a search in a CompilationDatabase #[derive(Debug)] pub struct CompileCommands { ptr: CXCompileCommands, } impl CompileCommands { fn from_ptr(ptr: CXCompileCommands) -> CompileCommands { assert!(!ptr.is_null()); CompileCommands { ptr } } /// Returns all commands for this search pub fn get_commands(&self) -> Vec<CompileCommand> { iter!( clang_CompileCommands_getSize(self.ptr), clang_CompileCommands_getCommand(self.ptr), ) .map(|p| CompileCommand::from_ptr(self, p)) .collect() } } impl Drop for CompileCommands { fn drop(&mut self) { unsafe { clang_CompileCommands_dispose(self.ptr); } } } /// A compile comand from CompilationDatabase #[derive(Debug, Copy, Clone)] pub struct CompileCommand<'cmds> { ptr: CXCompileCommand, _marker: PhantomData<&'cmds CompileCommands>, } impl<'cmds> CompileCommand<'cmds> { fn from_ptr(_: &'cmds CompileCommands, ptr: CXCompileCommand) -> CompileCommand<'cmds> { assert!(!ptr.is_null()); CompileCommand { ptr, _marker: PhantomData, } } /// Get the working directory where the command was executed. pub fn get_directory(&self) -> PathBuf { utility::to_path(unsafe { clang_CompileCommand_getDirectory(self.ptr) }) } /// Get the filename associated with the command. #[cfg(feature="gte_clang_3_8")] pub fn get_filename(&self) -> PathBuf { utility::to_path(unsafe { clang_CompileCommand_getFilename(self.ptr) }) } /// Get all arguments passed to the command. pub fn get_arguments(&self) -> Vec<String> { iter!( clang_CompileCommand_getNumArgs(self.ptr), clang_CompileCommand_getArg(self.ptr), ) .map(utility::to_string) .collect() } // TODO: Args, mapped source path, mapped sourth context. } // Entity ________________________________________ /// An AST entity. #[derive(Copy, Clone)] pub struct Entity<'tu> { raw: CXCursor, tu: &'tu TranslationUnit<'tu>, } impl<'tu> Entity<'tu> { //- Constructors ----------------------------- fn from_raw(raw: CXCursor, tu: &'tu TranslationUnit<'tu>) -> Entity<'tu> { Entity { raw, tu } } //- Accessors -------------------------------- /// Evaluates this AST entity, if possible. #[cfg(feature="gte_clang_3_9")] pub fn evaluate(&self) -> Option<EvaluationResult> { macro_rules! string { ($eval:expr) => { std::ffi::CStr::from_ptr(clang_EvalResult_getAsStr($eval)).to_owned() }; } #[cfg(feature="gte_clang_4_0")] unsafe fn evaluate_integer(e: CXEvalResult) -> EvaluationResult { if clang_EvalResult_isUnsignedInt(e) != 0 { EvaluationResult::UnsignedInteger(clang_EvalResult_getAsUnsigned(e) as u64) } else { EvaluationResult::SignedInteger(clang_EvalResult_getAsLongLong(e) as i64) } } #[cfg(not(feature="gte_clang_4_0"))] unsafe fn evaluate_integer(e: CXEvalResult) -> EvaluationResult { EvaluationResult::SignedInteger(clang_EvalResult_getAsInt(e) as i64) } unsafe { clang_Cursor_Evaluate(self.raw).map(|e| { assert!(!e.is_null()); let result = match clang_EvalResult_getKind(e) { CXEval_UnExposed => EvaluationResult::Unexposed, CXEval_Int => evaluate_integer(e), CXEval_Float => EvaluationResult::Float(clang_EvalResult_getAsDouble(e) as f64), CXEval_ObjCStrLiteral => EvaluationResult::ObjCString(string!(e)), CXEval_StrLiteral => EvaluationResult::String(string!(e)), CXEval_CFStr => EvaluationResult::CFString(string!(e)), CXEval_Other => EvaluationResult::Other(string!(e)), _ => panic!("unexpected eval result: {:?}", e), }; clang_EvalResult_dispose(e); result }) } } /// Returns the categorization of this AST entity. pub fn get_kind(&self) -> EntityKind { unsafe { mem::transmute(clang_getCursorKind(self.raw)) } } /// Returns the display name of this AST entity, if any. /// /// The display name of an entity contains additional information that helps identify the /// entity. pub fn get_display_name(&self) -> Option<String> { unsafe { utility::to_string_option(clang_getCursorDisplayName(self.raw)) } } #[cfg(feature="gte_clang_7_0")] /// Returns the pretty printer for this declaration. pub fn get_pretty_printer(&self) -> PrettyPrinter { unsafe { PrettyPrinter::from_raw(clang_getCursorPrintingPolicy(self.raw), self) } } /// Returns the source location of this AST entity, if any. pub fn get_location(&self) -> Option<SourceLocation<'tu>> { unsafe { clang_getCursorLocation(self.raw).map(|l| SourceLocation::from_raw(l, self.tu)) } } /// Returns the source range of this AST entity, if any. pub fn get_range(&self) -> Option<SourceRange<'tu>> { unsafe { clang_getCursorExtent(self.raw).map(|r| SourceRange::from_raw(r, self.tu)) } } /// Returns the accessibility of this declaration or base class specifier, if applicable. pub fn get_accessibility(&self) -> Option<Accessibility> { unsafe { match clang_getCXXAccessSpecifier(self.raw) { CX_CXXInvalidAccessSpecifier => None, other => Some(mem::transmute(other)), } } } /// Returns the arguments of this function or method, if applicable. pub fn get_arguments(&self) -> Option<Vec<Entity<'tu>>> { iter_option!( clang_Cursor_getNumArguments(self.raw), clang_Cursor_getArgument(self.raw), ).map(|i| i.map(|a| Entity::from_raw(a, self.tu)).collect()) } /// Returns the availability of this AST entity. pub fn get_availability(&self) -> Availability { unsafe { mem::transmute(clang_getCursorAvailability(self.raw)) } } /// Returns the width of this bit field, if applicable. pub fn get_bit_field_width(&self) -> Option<usize> { unsafe { let width = clang_getFieldDeclBitWidth(self.raw); if width >= 0 { Some(width as usize) } else { None } } } /// Returns the canonical entity for this AST entity. /// /// In the C family of languages, some types of entities can be declared multiple times. When /// there are multiple declarations of the same entity, only one will be considered canonical. pub fn get_canonical_entity(&self) -> Entity<'tu> { unsafe { Entity::from_raw(clang_getCanonicalCursor(self.raw), self.tu) } } /// Returns the comment associated with this AST entity, if any. pub fn get_comment(&self) -> Option<String> { unsafe { utility::to_string_option(clang_Cursor_getRawCommentText(self.raw)) } } /// Returns the parsed comment associated with this declaration, if application. pub fn get_parsed_comment(&self) -> Option<Comment<'tu>> { unsafe { clang_Cursor_getParsedComment(self.raw).map(Comment::from_raw) } } /// Returns the brief of the comment associated with this AST entity, if any. pub fn get_comment_brief(&self) -> Option<String> { unsafe { utility::to_string_option(clang_Cursor_getBriefCommentText(self.raw)) } } /// Returns the source range of the comment associated with this AST entity, if any. pub fn get_comment_range(&self) -> Option<SourceRange<'tu>> { unsafe { clang_Cursor_getCommentRange(self.raw).map(|r| SourceRange::from_raw(r, self.tu)) } } /// Returns a completion string for this declaration or macro definition, if applicable. pub fn get_completion_string(&self) -> Option<CompletionString> { unsafe { clang_getCursorCompletionString(self.raw).map(CompletionString::from_ptr) } } /// Returns the child of this AST entity with the supplied index. pub fn get_child(&self, mut index: usize) -> Option<Entity<'tu>> { let mut child = None; self.visit_children(|c, _| { if index == 0 { child = Some(c); EntityVisitResult::Break } else { index -= 1; EntityVisitResult::Continue } }); child } /// Returns the children of this AST entity. pub fn get_children(&self) -> Vec<Entity<'tu>> { let mut children = vec![]; self.visit_children(|c, _| { children.push(c); EntityVisitResult::Continue }); children } /// Returns the AST entity that describes the definition of this AST entity, if any. pub fn get_definition(&self) -> Option<Entity<'tu>> { unsafe { clang_getCursorDefinition(self.raw).map(|p| Entity::from_raw(p, self.tu)) } } /// Returns the value of this enum constant declaration, if applicable. pub fn get_enum_constant_value(&self) -> Option<(i64, u64)> { unsafe { if self.get_kind() == EntityKind::EnumConstantDecl { let signed = clang_getEnumConstantDeclValue(self.raw); let unsigned = clang_getEnumConstantDeclUnsignedValue(self.raw); Some((signed, unsigned)) } else { None } } } /// Returns the underlying type of this enum declaration, if applicable. pub fn get_enum_underlying_type(&self) -> Option<Type<'tu>> { unsafe { clang_getEnumDeclIntegerType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the exception specification of this AST entity, if applicable. #[cfg(feature="gte_clang_5_0")] pub fn get_exception_specification(&self) -> Option<ExceptionSpecification> { unsafe { match clang_getCursorExceptionSpecificationType(self.raw) { -1 | CXCursor_ExceptionSpecificationKind_None => None, other => Some(mem::transmute(other)), } } } /// Returns the `external_source_symbol` attribute attached to this AST entity, if any. #[cfg(feature="gte_clang_5_0")] pub fn get_external_symbol(&self) -> Option<ExternalSymbol> { unsafe { let mut language: CXString = mem::uninitialized(); let mut defined: CXString = mem::uninitialized(); let mut generated: c_uint = 0; if clang_Cursor_isExternalSymbol(self.raw, &mut language, &mut defined, &mut generated) != 0 { Some(ExternalSymbol { language: utility::to_string(language), defined: utility::to_string(defined), generated: generated != 0 }) } else { None } } } /// Returns the file included by this inclusion directive, if applicable. pub fn get_file(&self) -> Option<File<'tu>> { unsafe { clang_getIncludedFile(self.raw).map(|f| File::from_ptr(f, self.tu)) } } /// Returns the language used by this declaration, if applicable. pub fn get_language(&self) -> Option<Language> { unsafe { match clang_getCursorLanguage(self.raw) { CXLanguage_Invalid => None, other => Some(mem::transmute(other)), } } } /// Returns the lexical parent of this AST entity, if any. pub fn get_lexical_parent(&self) -> Option<Entity<'tu>> { unsafe { clang_getCursorLexicalParent(self.raw).map(|p| Entity::from_raw(p, self.tu)) } } /// Returns the linkage of this AST entity, if any. pub fn get_linkage(&self) -> Option<Linkage> { unsafe { match clang_getCursorLinkage(self.raw) { CXLinkage_Invalid => None, other => Some(mem::transmute(other)), } } } /// Returns the mangled name of this AST entity, if any. #[cfg(feature="gte_clang_3_6")] pub fn get_mangled_name(&self) -> Option<String> { unsafe { utility::to_string_option(clang_Cursor_getMangling(self.raw)) } } /// Returns the mangled names of this C++ constructor or destructor, if applicable. #[cfg(feature="gte_clang_3_8")] pub fn get_mangled_names(&self) -> Option<Vec<String>> { unsafe { utility::to_string_set_option(clang_Cursor_getCXXManglings(self.raw)) } } /// Returns the mangled names of this Objective-C class interface or implementation, if applicable. #[cfg(feature="gte_clang_6_0")] pub fn get_mangled_objc_names(&self) -> Option<Vec<String>> { unsafe { utility::to_string_set_option(clang_Cursor_getObjCManglings(self.raw)) } } /// Returns the module imported by this module import declaration, if applicable. pub fn get_module(&self) -> Option<Module<'tu>> { unsafe { clang_Cursor_getModule(self.raw).map(|m| Module::from_ptr(m, self.tu)) } } /// Returns the name of this AST entity, if any. pub fn get_name(&self) -> Option<String> { unsafe { utility::to_string_option(clang_getCursorSpelling(self.raw)) } } /// Returns the source ranges of the name of this AST entity. pub fn get_name_ranges(&self) -> Vec<SourceRange<'tu>> { unsafe { (0..).map(|i| clang_Cursor_getSpellingNameRange(self.raw, i, 0)).take_while(|r| { if clang_Range_isNull(*r) != 0 { false } else { let range = clang_getRangeStart(*r); let mut file = ptr::null_mut(); let null = ptr::null_mut(); clang_getSpellingLocation(range, &mut file, null, null, null); !file.is_null() } }).map(|r| SourceRange::from_raw(r, self.tu)).collect() } } /// Returns which attributes were applied to this Objective-C property, if applicable. pub fn get_objc_attributes(&self) -> Option<ObjCAttributes> { let attributes = unsafe { clang_Cursor_getObjCPropertyAttributes(self.raw, 0) }; if attributes != 0 { Some(ObjCAttributes::from(attributes)) } else { None } } /// Returns the name of the method implementing the getter for this Objective-C property, if applicable #[cfg(feature="gte_clang_8_0")] pub fn get_objc_getter_name(&self) -> Option<String> { utility::to_string_option(unsafe { clang_Cursor_getObjCPropertyGetterName(self.raw) }) } /// Returns the element type for this Objective-C `iboutletcollection` attribute, if applicable. pub fn get_objc_ib_outlet_collection_type(&self) -> Option<Type<'tu>> { unsafe { clang_getIBOutletCollectionType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the type of the receiver of this Objective-C message, if applicable. pub fn get_objc_receiver_type(&self) -> Option<Type<'tu>> { unsafe { clang_Cursor_getReceiverType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the selector index for this Objective-C selector identifier, if applicable. pub fn get_objc_selector_index(&self) -> Option<usize> { let index = unsafe { clang_Cursor_getObjCSelectorIndex(self.raw) }; if index >= 0 { Some(index as usize) } else { None } } /// Returns the name of the method implementing the setter for this Objective-C property, if applicable #[cfg(feature="gte_clang_8_0")] pub fn get_objc_setter_name(&self) -> Option<String> { utility::to_string_option(unsafe { clang_Cursor_getObjCPropertySetterName(self.raw) }) } /// Returns the type encoding for this Objective-C declaration, if applicable. pub fn get_objc_type_encoding(&self) -> Option<String> { unsafe { utility::to_string_option(clang_getDeclObjCTypeEncoding(self.raw)) } } /// Returns which qualifiers were applied to this Objective-C method return or parameter type, /// if applicable. pub fn get_objc_qualifiers(&self) -> Option<ObjCQualifiers> { let qualifiers = unsafe { clang_Cursor_getObjCDeclQualifiers(self.raw) }; if qualifiers != 0 { Some(ObjCQualifiers::from(qualifiers)) } else { None } } /// Returns the the offset of this field, if applicable. #[cfg(feature="gte_clang_3_7")] pub fn get_offset_of_field(&self) -> Result<usize, OffsetofError> { let offsetof_ = unsafe { clang_Cursor_getOffsetOfField(self.raw) }; OffsetofError::from_error(offsetof_).map(|_| offsetof_ as usize) } /// Returns the overloaded declarations referenced by this overloaded declaration reference, if /// applicable. pub fn get_overloaded_declarations(&self) -> Option<Vec<Entity<'tu>>> { let declarations = iter!( clang_getNumOverloadedDecls(self.raw), clang_getOverloadedDecl(self.raw), ).map(|e| Entity::from_raw(e, self.tu)).collect::<Vec<_>>(); if !declarations.is_empty() { Some(declarations) } else { None } } /// Returns the methods that were overridden by this method, if applicable. pub fn get_overridden_methods(&self) -> Option<Vec<Entity<'tu>>> { unsafe { let (mut raw, mut count) = (ptr::null_mut(), 0); clang_getOverriddenCursors(self.raw, &mut raw, &mut count); if !raw.is_null() { let raws = slice::from_raw_parts(raw, count as usize); let methods = raws.iter().map(|e| Entity::from_raw(*e, self.tu)).collect(); clang_disposeOverriddenCursors(raw); Some(methods) } else { None } } } /// Returns the availability of this declaration on the platforms where it is known, if /// applicable. pub fn get_platform_availability(&self) -> Option<Vec<PlatformAvailability>> { if !self.is_declaration() { return None; } unsafe { let mut buffer: [CXPlatformAvailability; 32] = [CXPlatformAvailability::default(); 32]; let count = clang_getCursorPlatformAvailability( self.raw, ptr::null_mut(), ptr::null_mut(), ptr::null_mut(), ptr::null_mut(), (&mut buffer).as_mut_ptr(), buffer.len() as c_int, ); Some((0..count as usize).map(|i| PlatformAvailability::from_raw(buffer[i])).collect()) } } /// Returns the AST entity referred to by this AST entity, if any. pub fn get_reference(&self) -> Option<Entity<'tu>> { unsafe { clang_getCursorReferenced(self.raw).map(|p| Entity::from_raw(p, self.tu)) } } /// Returns the semantic parent of this AST entity, if any. pub fn get_semantic_parent(&self) -> Option<Entity<'tu>> { let parent = unsafe { clang_getCursorSemanticParent(self.raw) }; parent.map(|p| Entity::from_raw(p, self.tu)) } /// Returns the storage class of this declaration, if applicable. #[cfg(feature="gte_clang_3_6")] pub fn get_storage_class(&self) -> Option<StorageClass> { unsafe { match clang_Cursor_getStorageClass(self.raw) { CX_SC_Invalid => None, other => Some(mem::transmute(other)), } } } /// Returns the template declaration this template specialization was instantiated from, if /// applicable. pub fn get_template(&self) -> Option<Entity<'tu>> { let parent = unsafe { clang_getSpecializedCursorTemplate(self.raw) }; parent.map(|p| Entity::from_raw(p, self.tu)) } /// Returns the template arguments for this template function specialization, if applicable. #[cfg(feature="gte_clang_3_6")] pub fn get_template_arguments(&self) -> Option<Vec<TemplateArgument<'tu>>> { let get_type = &clang_Cursor_getTemplateArgumentType; let get_signed = &clang_Cursor_getTemplateArgumentValue; let get_unsigned = &clang_Cursor_getTemplateArgumentUnsignedValue; iter_option!( clang_Cursor_getNumTemplateArguments(self.raw), clang_Cursor_getTemplateArgumentKind(self.raw), ).map(|i| { i.enumerate().map(|(i, t)| { match t { CXTemplateArgumentKind_Null => TemplateArgument::Null, CXTemplateArgumentKind_Type => { let type_ = unsafe { get_type(self.raw, i as c_uint) }; TemplateArgument::Type(Type::from_raw(type_, self.tu)) }, CXTemplateArgumentKind_Declaration => TemplateArgument::Declaration, CXTemplateArgumentKind_NullPtr => TemplateArgument::Nullptr, CXTemplateArgumentKind_Integral => { let signed = unsafe { get_signed(self.raw, i as c_uint) }; let unsigned = unsafe { get_unsigned(self.raw, i as c_uint) }; TemplateArgument::Integral(signed as i64, unsigned as u64) }, CXTemplateArgumentKind_Template => TemplateArgument::Template, CXTemplateArgumentKind_TemplateExpansion => TemplateArgument::TemplateExpansion, CXTemplateArgumentKind_Expression => TemplateArgument::Expression, CXTemplateArgumentKind_Pack => TemplateArgument::Pack, _ => unreachable!(), } }).collect() }) } /// Returns the categorization of the template specialization that would result from /// instantiating this template declaration, if applicable. pub fn get_template_kind(&self) -> Option<EntityKind> { unsafe { match clang_getTemplateCursorKind(self.raw) { CXCursor_NoDeclFound => None, other => Some(mem::transmute(other)), } } } /// Returns the thread-local storage (TLS) kind of this declaration, if applicable. #[cfg(feature="gte_clang_6_0")] pub fn get_tls_kind(&self) -> Option<TlsKind> { unsafe { match clang_getCursorTLSKind(self.raw) { CXTLS_None => None, other => Some(mem::transmute(other)), } } } /// Returns the translation unit which contains this AST entity. pub fn get_translation_unit(&self) -> &'tu TranslationUnit<'tu> { self.tu } /// Returns the type of this AST entity, if any. pub fn get_type(&self) -> Option<Type<'tu>> { unsafe { clang_getCursorType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the underlying type of this typedef declaration, if applicable. pub fn get_typedef_underlying_type(&self) -> Option<Type<'tu>> { unsafe { clang_getTypedefDeclUnderlyingType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the USR for this AST entity, if any. pub fn get_usr(&self) -> Option<Usr> { unsafe { utility::to_string_option(clang_getCursorUSR(self.raw)).map(Usr) } } /// Returns the linker visibility for this AST entity, if any. #[cfg(feature="gte_clang_3_8")] pub fn get_visibility(&self) -> Option<Visibility> { unsafe { match clang_getCursorVisibility(self.raw) { CXVisibility_Invalid => None, other => Some(mem::transmute(other)), } } } /// Returns the result type of this AST entity, if applicable. pub fn get_result_type(&self) -> Option<Type<'tu>> { unsafe { clang_getCursorResultType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns whether this AST entity has any attached attributes. #[cfg(feature="gte_clang_3_9")] pub fn has_attributes(&self) -> bool { unsafe { clang_Cursor_hasAttrs(self.raw) != 0 } } /// Returns whether this AST entity is an abstract C++ record. #[cfg(feature="gte_clang_6_0")] pub fn is_abstract_record(&self) -> bool { unsafe { clang_CXXRecord_isAbstract(self.raw) != 0 } } /// Returns whether this AST entity is an anonymous record declaration. #[cfg(feature="gte_clang_3_7")] pub fn is_anonymous(&self) -> bool { unsafe { clang_Cursor_isAnonymous(self.raw) != 0 } } /// Returns whether this AST entity is a bit field. pub fn is_bit_field(&self) -> bool { unsafe { clang_Cursor_isBitField(self.raw) != 0 } } /// Returns whether this AST entity is a builtin macro. #[cfg(feature="gte_clang_3_9")] pub fn is_builtin_macro(&self) -> bool { unsafe { clang_Cursor_isMacroBuiltin(self.raw) != 0 } } /// Returns whether this AST entity is a const method. pub fn is_const_method(&self) -> bool { unsafe { clang_CXXMethod_isConst(self.raw) != 0 } } /// Returns whether this AST entity is a C++ converting constructor. #[cfg(feature="gte_clang_3_9")] pub fn is_converting_constructor(&self) -> bool { unsafe { clang_CXXConstructor_isConvertingConstructor(self.raw) != 0 } } /// Returns whether this AST entity is a C++ copy constructor. #[cfg(feature="gte_clang_3_9")] pub fn is_copy_constructor(&self) -> bool { unsafe { clang_CXXConstructor_isCopyConstructor(self.raw) != 0 } } /// Returns whether this AST entity is a C++ default constructor. #[cfg(feature="gte_clang_3_9")] pub fn is_default_constructor(&self) -> bool { unsafe { clang_CXXConstructor_isDefaultConstructor(self.raw) != 0 } } /// Returns whether this AST entity is a C++ defaulted constructor or method. #[cfg(feature="gte_clang_3_9")] pub fn is_defaulted(&self) -> bool { unsafe { clang_CXXMethod_isDefaulted(self.raw) != 0 } } /// Returns whether this AST entity is a declaration and also the definition of that /// declaration. pub fn is_definition(&self) -> bool { unsafe { clang_isCursorDefinition(self.raw) != 0 } } /// Returns whether this AST entity is a dynamic call. /// /// A dynamic call is either a call to a C++ virtual method or an Objective-C message where the /// receiver is an object instance, not `super` or a specific class. pub fn is_dynamic_call(&self) -> bool { unsafe { clang_Cursor_isDynamicCall(self.raw) != 0 } } /// Returns whether this AST entity is a function-like macro. #[cfg(feature="gte_clang_3_9")] pub fn is_function_like_macro(&self) -> bool { unsafe { clang_Cursor_isMacroFunctionLike(self.raw) != 0 } } /// Returns whether this AST entity is an inline function. #[cfg(feature="gte_clang_3_9")] pub fn is_inline_function(&self) -> bool { unsafe { clang_Cursor_isFunctionInlined(self.raw) != 0 } } /// Returns whether this AST entity is an invalid declaration. #[cfg(feature="gte_clang_7_0")] pub fn is_invalid_declaration(&self) -> bool { unsafe { clang_isInvalidDeclaration(self.raw) != 0 } } /// Returns whether this AST entity is a C++ default constructor. #[cfg(feature="gte_clang_3_9")] pub fn is_move_constructor(&self) -> bool { unsafe { clang_CXXConstructor_isMoveConstructor(self.raw) != 0 } } #[cfg(feature="gte_clang_3_8")] /// Returns whether this AST entity is a mutable field in a C++ struct or class. pub fn is_mutable(&self) -> bool { unsafe { clang_CXXField_isMutable(self.raw) != 0 } } /// Returns whether this AST entity is an Objective-C method or property declaration with the /// `@optional` attribute applied to it. pub fn is_objc_optional(&self) -> bool { unsafe { clang_Cursor_isObjCOptional(self.raw) != 0 } } /// Returns whether this AST entity is a pure virtual method. pub fn is_pure_virtual_method(&self) -> bool { unsafe { clang_CXXMethod_isPureVirtual(self.raw) != 0 } } /// Returns whether this AST entity is a scoped enum. #[cfg(feature="gte_clang_5_0")] pub fn is_scoped(&self) -> bool { unsafe { clang_EnumDecl_isScoped(self.raw) != 0 } } /// Returns whether this AST entity is a static method. pub fn is_static_method(&self) -> bool { unsafe { clang_CXXMethod_isStatic(self.raw) != 0 } } /// Returns whether this AST entity is a variadic function or method. pub fn is_variadic(&self) -> bool { unsafe { clang_Cursor_isVariadic(self.raw) != 0 } } /// Returns whether this AST entity is a virtual base class specifier. pub fn is_virtual_base(&self) -> bool { unsafe { clang_isVirtualBase(self.raw) != 0 } } /// Returns whether this AST entity is a virtual method. pub fn is_virtual_method(&self) -> bool { unsafe { clang_CXXMethod_isVirtual(self.raw) != 0 } } /// Visits the children of this AST entity recursively and returns whether visitation was ended /// by the callback returning `EntityVisitResult::Break`. /// /// The first argument of the callback is the AST entity being visited and the second argument /// is the parent of that AST entity. The return value of the callback determines how visitation /// will proceed. pub fn visit_children<F: FnMut(Entity<'tu>, Entity<'tu>) -> EntityVisitResult>( &self, f: F ) -> bool { trait EntityCallback<'tu> { fn call(&mut self, entity: Entity<'tu>, parent: Entity<'tu>) -> EntityVisitResult; } impl<'tu, F: FnMut(Entity<'tu>, Entity<'tu>) -> EntityVisitResult> EntityCallback<'tu> for F { fn call(&mut self, entity: Entity<'tu>, parent: Entity<'tu>) -> EntityVisitResult { self(entity, parent) } } extern fn visit( cursor: CXCursor, parent: CXCursor, data: CXClientData ) -> CXChildVisitResult { unsafe { let &mut (tu, ref mut callback) = &mut *(data as *mut (&TranslationUnit, Box<dyn EntityCallback>)); let entity = Entity::from_raw(cursor, tu); let parent = Entity::from_raw(parent, tu); mem::transmute(callback.call(entity, parent)) } } let mut data = (self.tu, Box::new(f) as Box<dyn EntityCallback>); unsafe { clang_visitChildren(self.raw, visit, utility::addressof(&mut data)) != 0 } } //- Categorization --------------------------- /// Returns whether this AST entity is categorized as an attribute. pub fn is_attribute(&self) -> bool { unsafe { clang_isAttribute(self.raw.kind) != 0 } } /// Returns whether this AST entity is categorized as a declaration. pub fn is_declaration(&self) -> bool { unsafe { clang_isDeclaration(self.raw.kind) != 0 } } /// Returns whether this AST entity is categorized as an expression. pub fn is_expression(&self) -> bool { unsafe { clang_isExpression(self.raw.kind) != 0 } } /// Returns whether this AST entity is categorized as a preprocessing entity. pub fn is_preprocessing(&self) -> bool { unsafe { clang_isPreprocessing(self.raw.kind) != 0 } } /// Returns whether this AST entity is categorized as a reference. pub fn is_reference(&self) -> bool { unsafe { clang_isReference(self.raw.kind) != 0 } } /// Returns whether this AST entity is categorized as a statement. pub fn is_statement(&self) -> bool { unsafe { clang_isStatement(self.raw.kind) != 0 } } /// Returns whether the categorization of this AST entity is unexposed. pub fn is_unexposed(&self) -> bool { unsafe { clang_isUnexposed(self.raw.kind) != 0 } } //- Location --------------------------------- /// Returns whether this AST entity is in a main file. pub fn is_in_main_file(&self) -> bool { self.get_range().map_or(false, |r| r.is_in_main_file()) } /// Returns whether this AST entity is in a system header. pub fn is_in_system_header(&self) -> bool { self.get_range().map_or(false, |r| r.is_in_system_header()) } } impl<'tu> fmt::Debug for Entity<'tu> { fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.debug_struct("Entity") .field("kind", &self.get_kind()) .field("display_name", &self.get_display_name()) .field("location", &self.get_location()) .finish() } } impl<'tu> cmp::PartialEq for Entity<'tu> { fn eq(&self, other: &Entity<'tu>) -> bool { unsafe { clang_equalCursors(self.raw, other.raw) != 0 } } } impl<'tu> cmp::Eq for Entity<'tu> { } impl<'tu> hash::Hash for Entity<'tu> { fn hash<H: hash::Hasher>(&self, hasher: &mut H) { unsafe { let integer = clang_hashCursor(self.raw); let bytes = (&integer as *const c_uint) as *const u8; let slice = slice::from_raw_parts(bytes, mem::size_of_val(&integer)); hasher.write(slice); } } } // ExternalSymbol ________________________________ /// An `external_source_symbol` attribute. #[cfg(feature="gte_clang_5_0")] #[derive(Clone, Debug, PartialEq, Eq, Hash)] pub struct ExternalSymbol { /// The `language` string from this attribute. pub language: String, /// The `definedIn` string from this attribute. pub defined: String, /// Whether `generated_declaration` is set for this attribute. pub generated: bool, } // Index _________________________________________ /// A collection of translation units. pub struct Index<'c> { ptr: CXIndex, _marker: PhantomData<&'c Clang>, } impl<'c> Index<'c> { //- Constructors ----------------------------- fn from_ptr(ptr: CXIndex) -> Index<'c> { assert!(!ptr.is_null()); Index { ptr, _marker: PhantomData } } /// Constructs a new `Index`. /// /// `exclude` determines whether declarations from precompiled headers are excluded and /// `diagnostics` determines whether diagnostics are printed while parsing source files. pub fn new(_: &'c Clang, exclude: bool, diagnostics: bool) -> Index<'c> { unsafe { Index::from_ptr(clang_createIndex(exclude as c_int, diagnostics as c_int)) } } //- Accessors -------------------------------- /// Returns a parser for the supplied file. pub fn parser<F: Into<PathBuf>>(&'c self, f: F) -> Parser<'c> { Parser::new(self, f) } /// Sets the invocation emission path for this index. #[cfg(feature="gte_clang_6_0")] pub fn set_invocation_emission_path<P: AsRef<Path>>(&'c self, path: P) { let path = utility::from_path(path); unsafe { clang_CXIndex_setInvocationEmissionPathOption(self.ptr, path.as_ptr()); } } /// Returns the thread options for this index. pub fn get_thread_options(&self) -> ThreadOptions { unsafe { ThreadOptions::from(clang_CXIndex_getGlobalOptions(self.ptr)) } } //- Mutators --------------------------------- /// Sets the thread options for this index. pub fn set_thread_options(&mut self, options: ThreadOptions) { unsafe { clang_CXIndex_setGlobalOptions(self.ptr, options.into()); } } } impl<'c> Drop for Index<'c> { fn drop(&mut self) { unsafe { clang_disposeIndex(self.ptr); } } } impl<'c> fmt::Debug for Index<'c> { fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.debug_struct("Index") .field("thread_options", &self.get_thread_options()) .finish() } } // ObjCAttributes ________________________________ options! { /// Indicates which attributes were applied to an Objective-C property. options ObjCAttributes: CXObjCPropertyAttrKind { /// Indicates use of the `readonly` attribute. pub readonly: CXObjCPropertyAttr_readonly, /// Indicates use of the `getter` attribute. pub getter: CXObjCPropertyAttr_getter, /// Indicates use of the `assign` attribute. pub assign: CXObjCPropertyAttr_assign, /// Indicates use of the `readwrite` attribute. pub readwrite: CXObjCPropertyAttr_readwrite, /// Indicates use of the `retain` attribute. pub retain: CXObjCPropertyAttr_retain, /// Indicates use of the `copy` attribute. pub copy: CXObjCPropertyAttr_copy, /// Indicates use of the `nonatomic` attribute. pub nonatomic: CXObjCPropertyAttr_nonatomic, /// Indicates use of the `setter` attribute. pub setter: CXObjCPropertyAttr_setter, /// Indicates use of the `atomic` attribute. pub atomic: CXObjCPropertyAttr_atomic, /// Indicates use of the `weak` attribute. pub weak: CXObjCPropertyAttr_weak, /// Indicates use of the `strong` attribute. pub strong: CXObjCPropertyAttr_strong, /// Indicates use of the `unsafe_retained` attribute. pub unsafe_retained: CXObjCPropertyAttr_unsafe_unretained, }, objcattributes: #[feature="gte_clang_3_9"] { /// Indicates use of the `class` attribute. pub class: CXObjCPropertyAttr_class, } } // ObjCQualifiers ________________________________ options! { /// Indicates which qualifiers were applied to an Objective-C method return or parameter type. options ObjCQualifiers: CXObjCDeclQualifierKind { /// Indicates use of the `in` qualifier. pub in_: CXObjCDeclQualifier_In, /// Indicates use of the `inout` qualifier. pub inout: CXObjCDeclQualifier_Inout, /// Indicates use of the `out` qualifier. pub out: CXObjCDeclQualifier_Out, /// Indicates use of the `bycopy` qualifier. pub bycopy: CXObjCDeclQualifier_Bycopy, /// Indicates use of the `byref` qualifier. pub byref: CXObjCDeclQualifier_Byref, /// Indicates use of the `oneway` qualifier. pub oneway: CXObjCDeclQualifier_Oneway, } } // Parser ________________________________________ builder! { /// Parses translation units. builder Parser: CXTranslationUnit_Flags { index: &'tu Index<'tu>, file: PathBuf, arguments: Vec<CString>, unsaved: Vec<Unsaved>; OPTIONS: /// Sets whether certain code completion results will be cached when the translation unit is /// reparsed. /// /// This option increases the time it takes to reparse the translation unit but improves /// code completion performance. pub cache_completion_results: CXTranslationUnit_CacheCompletionResults, /// Sets whether a detailed preprocessing record will be constructed which tracks all macro /// definitions and instantiations. pub detailed_preprocessing_record: CXTranslationUnit_DetailedPreprocessingRecord, /// Sets whether documentation comment briefs will be included in code completion results. pub briefs_in_completion_results: CXTranslationUnit_IncludeBriefCommentsInCodeCompletion, /// Sets whether the translation unit will be considered incomplete. /// /// This option suppresses certain semantic analyses and is typically used when parsing /// headers with the intent of creating a precompiled header. pub incomplete: CXTranslationUnit_Incomplete, /// Sets whether function and method bodies will be skipped. pub skip_function_bodies: CXTranslationUnit_SkipFunctionBodies, /// Sets whether processing will continue after a fatal error is encountered. #[cfg(feature="gte_clang_3_9")] pub keep_going: CXTranslationUnit_KeepGoing, /// Sets whether incremental processing will be used. #[cfg(feature="gte_clang_5_0")] pub single_file_parse: CXTranslationUnit_SingleFileParse, /// Sets whether function bodies will only be skipped in the preamble. /// /// Used in conjunction with `skip_function_bodies`. #[cfg(feature="gte_clang_7_0")] pub limit_skip_function_bodies_to_preamble: CXTranslationUnit_LimitSkipFunctionBodiesToPreamble, /// Sets whether attributed types should be included. #[cfg(feature="gte_clang_8_0")] pub include_attributed_types: CXTranslationUnit_IncludeAttributedTypes, /// Sets whether implicit attributes should be visited. #[cfg(feature="gte_clang_8_0")] pub visit_implicit_attributes: CXTranslationUnit_VisitImplicitAttributes, } } impl<'tu> Parser<'tu> { //- Constructors ----------------------------- fn new<F: Into<PathBuf>>(index: &'tu Index<'tu>, file: F) -> Parser<'tu> { let flags: CXTranslationUnit_Flags = 0; Parser { index, file: file.into(), arguments: vec![], unsaved: vec![], flags } } //- Mutators --------------------------------- /// Sets the compiler arguments to provide to `libclang`. /// /// Any compiler argument that could be supplied to `clang` may be supplied to this /// function. However, the following arguments are ignored: /// /// * `-c` /// * `-emit-ast` /// * `-fsyntax-only` /// * `-o` and the following `<output>` pub fn arguments<S: AsRef<str>>(&mut self, arguments: &[S]) -> &mut Parser<'tu> { self.arguments = arguments.iter().map(utility::from_string).collect(); self } /// Sets the unsaved files to use. pub fn unsaved(&mut self, unsaved: &[Unsaved]) -> &mut Parser<'tu> { self.unsaved = unsaved.into(); self } //- Accessors -------------------------------- /// Parses a translation unit. /// /// # Failures /// /// * an error occurs while deserializing an AST file /// * `libclang` crashes /// * an unknown error occurs pub fn parse(&self) -> Result<TranslationUnit<'tu>, SourceError> { let arguments = self.arguments.iter().map(|a| a.as_ptr()).collect::<Vec<_>>(); let unsaved = self.unsaved.iter().map(|u| u.as_raw()).collect::<Vec<_>>(); unsafe { let mut ptr = ptr::null_mut(); let code = clang_parseTranslationUnit2( self.index.ptr, utility::from_path(&self.file).as_ptr(), arguments.as_ptr(), arguments.len() as c_int, unsaved.as_ptr() as *mut CXUnsavedFile, unsaved.len() as c_uint, self.flags, &mut ptr, ); SourceError::from_error(code).map(|_| TranslationUnit::from_ptr(ptr)) } } } // PlatformAvailability __________________________ /// The availability of an AST entity on a particular platform. #[derive(Clone, Debug, PartialEq, Eq, Hash)] pub struct PlatformAvailability { /// The name of the platform. pub platform: String, /// Whether the AST entity is unavailable on the platform. pub unavailable: bool, /// The version of the platform in which this AST entity was introduced, if any. pub introduced: Option<Version>, /// The version of the platform in which this AST entity was deprecated, if any. pub deprecated: Option<Version>, /// The version of the platform in which this AST entity was obsoleted, if any. pub obsoleted: Option<Version>, /// A message to display to users (e.g., replacement API suggestions). pub message: Option<String>, } impl PlatformAvailability { //- Constructors ----------------------------- fn from_raw(mut raw: CXPlatformAvailability) -> PlatformAvailability { let availability = PlatformAvailability { platform: utility::to_string(raw.Platform), unavailable: raw.Unavailable != 0, introduced: raw.Introduced.map(Version::from_raw), deprecated: raw.Deprecated.map(Version::from_raw), obsoleted: raw.Obsoleted.map(Version::from_raw), message: utility::to_string_option(raw.Message), }; unsafe { clang_disposeCXPlatformAvailability(&mut raw); } availability } } // PrettyPrinter _________________________________ /// Pretty prints declarations. #[cfg(feature="gte_clang_7_0")] #[derive(Debug)] pub struct PrettyPrinter<'e> { ptr: CXPrintingPolicy, entity: &'e Entity<'e>, } #[cfg(feature="gte_clang_7_0")] impl<'e> PrettyPrinter<'e> { //- Constructors ----------------------------- fn from_raw(ptr: CXPrintingPolicy, entity: &'e Entity<'e>) -> Self { assert!(!ptr.is_null()); PrettyPrinter { ptr, entity } } //- Accessors -------------------------------- /// Gets the specified flag value. pub fn get_flag(&self, flag: PrintingPolicyFlag) -> bool { unsafe { clang_PrintingPolicy_getProperty(self.ptr, mem::transmute(flag)) != 0 } } /// Sets the specified flag value. pub fn set_flag(&self, flag: PrintingPolicyFlag, value: bool) -> &Self { let value = if value { 1 } else { 0 }; unsafe { clang_PrintingPolicy_setProperty(self.ptr, mem::transmute(flag), value); } self } /// Gets the number of spaces used to indent each line. pub fn get_indentation_amount(&self) -> u8 { unsafe { clang_PrintingPolicy_getProperty(self.ptr, CXPrintingPolicy_Indentation) as u8 } } /// Sets the number of spaces used to indent each line. pub fn set_indentation_amount(&self, value: u8) -> &Self { unsafe { clang_PrintingPolicy_setProperty(self.ptr, CXPrintingPolicy_Indentation, value.into()); } self } /// Pretty print the declaration. pub fn print(&self) -> String { unsafe { utility::to_string(clang_getCursorPrettyPrinted(self.entity.raw, self.ptr)) } } } #[cfg(feature="gte_clang_7_0")] impl<'e> Drop for PrettyPrinter<'e> { fn drop(&mut self) { unsafe { clang_PrintingPolicy_dispose(self.ptr) } } } // Target ________________________________________ /// Information about the target for a translation unit. #[cfg(feature="gte_clang_5_0")] #[derive(Clone, Debug, PartialEq, Eq, Hash)] pub struct Target { /// The normalized target triple for the target. pub triple: String, /// The width of a pointer in the target in bits. pub pointer_width: usize, } #[cfg(feature="gte_clang_5_0")] impl Target { //- Constructors ----------------------------- fn from_raw(raw: CXTargetInfo) -> Target { unsafe { let target = Target { triple: utility::to_string(clang_TargetInfo_getTriple(raw)), pointer_width: clang_TargetInfo_getPointerWidth(raw) as usize, }; clang_TargetInfo_dispose(raw); target } } } // ThreadOptions _________________________________ options! { /// A set of options that determines which types of threads should use background priority. #[derive(Default)] options ThreadOptions: CXGlobalOptFlags { /// Indicates whether threads creating for editing purposes should use background priority. pub editing: CXGlobalOpt_ThreadBackgroundPriorityForEditing, /// Indicates whether threads creating for indexing purposes should use background priority. pub indexing: CXGlobalOpt_ThreadBackgroundPriorityForIndexing, } } // TranslationUnit _______________________________ /// A preprocessed and parsed source file. pub struct TranslationUnit<'i> { ptr: CXTranslationUnit, _marker: PhantomData<&'i Index<'i>>, } impl<'i> TranslationUnit<'i> { //- Constructors ----------------------------- fn from_ptr(ptr: CXTranslationUnit) -> TranslationUnit<'i> { assert!(!ptr.is_null()); TranslationUnit { ptr, _marker: PhantomData } } /// Constructs a new `TranslationUnit` from an AST file. /// /// # Failures /// /// * an unknown error occurs pub fn from_ast<F: AsRef<Path>>( index: &'i Index, file: F ) -> Result<TranslationUnit<'i>, ()> { let path = utility::from_path(file); let ptr = unsafe { clang_createTranslationUnit(index.ptr, path.as_ptr()) }; ptr.map(TranslationUnit::from_ptr).ok_or(()) } //- Accessors -------------------------------- /// Returns the diagnostics for this translation unit. pub fn get_diagnostics(&'i self) -> Vec<Diagnostic<'i>> { iter!(clang_getNumDiagnostics(self.ptr), clang_getDiagnostic(self.ptr),).map(|d| { Diagnostic::from_ptr(d, self) }).collect() } /// Returns the entity for this translation unit. pub fn get_entity(&'i self) -> Entity<'i> { unsafe { Entity::from_raw(clang_getTranslationUnitCursor(self.ptr), self) } } /// Returns the file at the supplied path in this translation unit, if any. pub fn get_file<F: AsRef<Path>>(&'i self, file: F) -> Option<File<'i>> { let file = unsafe { clang_getFile(self.ptr, utility::from_path(file).as_ptr()) }; file.map(|f| File::from_ptr(f, self)) } /// Returns the memory usage of this translation unit. pub fn get_memory_usage(&self) -> HashMap<MemoryUsage, usize> { unsafe { let raw = clang_getCXTUResourceUsage(self.ptr); let raws = slice::from_raw_parts(raw.entries, raw.numEntries as usize); let usage = raws.iter().map(|u| (mem::transmute(u.kind), u.amount as usize)).collect(); clang_disposeCXTUResourceUsage(raw); usage } } /// Returns the source ranges in this translation unit that were skipped by the preprocessor. /// /// This will always return an empty `Vec` if the translation unit was not constructed with a /// detailed preprocessing record. #[cfg(feature="gte_clang_4_0")] pub fn get_skipped_ranges(&'i self) -> Vec<SourceRange<'i>> { unsafe { let raw = clang_getAllSkippedRanges(self.ptr); let raws = slice::from_raw_parts((*raw).ranges, (*raw).count as usize); let ranges = raws.iter().map(|r| SourceRange::from_raw(*r, self)).collect(); clang_disposeSourceRangeList(raw); ranges } } /// Returns information about the target for this translation unit. #[cfg(feature="gte_clang_5_0")] pub fn get_target(&self) -> Target { unsafe { Target::from_raw(clang_getTranslationUnitTargetInfo(self.ptr)) } } /// Returns the AST entities which correspond to the supplied tokens, if any. pub fn annotate(&'i self, tokens: &[Token<'i>]) -> Vec<Option<Entity<'i>>> { unsafe { let mut raws = vec![CXCursor::default(); tokens.len()]; let ptr = tokens.as_ptr() as *mut CXToken; clang_annotateTokens(self.ptr, ptr, tokens.len() as c_uint, raws.as_mut_ptr()); raws.iter().map(|e| e.map(|e| Entity::from_raw(e, self))).collect() } } /// Returns a completer which runs code completion. pub fn completer<F: Into<PathBuf>>(&self, file: F, line: u32, column: u32) -> Completer { Completer::new(self, file, line, column) } /// Saves this translation unit to an AST file. /// /// # Failures /// /// * errors in the translation unit prevent saving /// * an unknown error occurs pub fn save<F: AsRef<Path>>(&self, file: F) -> Result<(), SaveError> { let file = utility::from_path(file); let flags = CXSaveTranslationUnit_None; let code = unsafe { clang_saveTranslationUnit(self.ptr, file.as_ptr(), flags) }; SaveError::from_error(code) } //- Consumers -------------------------------- /// Consumes this translation unit and reparses the source file it was created from with the /// same compiler arguments that were used originally. /// /// # Failures /// /// * an error occurs while deserializing an AST file /// * `libclang` crashes /// * an unknown error occurs pub fn reparse(self, unsaved: &[Unsaved]) -> Result<TranslationUnit<'i>, SourceError> { let unsaved = unsaved.iter().map(|u| u.as_raw()).collect::<Vec<_>>(); unsafe { let code = clang_reparseTranslationUnit( self.ptr, unsaved.len() as c_uint, unsaved.as_ptr() as *mut CXUnsavedFile, CXReparse_None, ); SourceError::from_error(code).map(|_| self) } } } impl<'i> Drop for TranslationUnit<'i> { fn drop(&mut self) { unsafe { clang_disposeTranslationUnit(self.ptr); } } } impl<'i> fmt::Debug for TranslationUnit<'i> { fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result { let spelling = unsafe { clang_getTranslationUnitSpelling(self.ptr) }; formatter.debug_struct("TranslationUnit") .field("spelling", &utility::to_string(spelling)) .finish() } } // Type __________________________________________ /// The type of an AST entity. #[derive(Copy, Clone)] pub struct Type<'tu> { raw: CXType, tu: &'tu TranslationUnit<'tu>, } impl<'tu> Type<'tu> { //- Constructors ----------------------------- fn from_raw(raw: CXType, tu: &'tu TranslationUnit<'tu>) -> Type<'tu> { Type { raw, tu } } //- Accessors -------------------------------- /// Returns the kind of this type. pub fn get_kind(&self) -> TypeKind { unsafe { mem::transmute(self.raw.kind) } } /// Returns the display name of this type. pub fn get_display_name(&self) -> String { unsafe { utility::to_string(clang_getTypeSpelling(self.raw)) } } /// Returns the alignment of this type in bytes. /// /// # Failures /// /// * this type is a dependent type /// * this type is an incomplete type pub fn get_alignof(&self) -> Result<usize, AlignofError> { let alignof_ = unsafe { clang_Type_getAlignOf(self.raw) }; AlignofError::from_error(alignof_).map(|_| alignof_ as usize) } /// Returns the offset of the field with the supplied name in this record type in bits. /// /// # Failures /// /// * this record type is a dependent type /// * this record record type is an incomplete type /// * this record type does not contain a field with the supplied name pub fn get_offsetof<F: AsRef<str>>(&self, field: F) -> Result<usize, OffsetofError> { let field = utility::from_string(field); let offsetof_ = unsafe { clang_Type_getOffsetOf(self.raw, field.as_ptr()) }; OffsetofError::from_error(offsetof_).map(|_| offsetof_ as usize) } /// Returns the size of this type in bytes. /// /// # Failures /// /// * this type is a dependent type /// * this type is an incomplete type /// * this type is a variable size type pub fn get_sizeof(&self) -> Result<usize, SizeofError> { let sizeof_ = unsafe { clang_Type_getSizeOf(self.raw) }; SizeofError::from_error(sizeof_).map(|_| sizeof_ as usize) } /// Returns the address space of this type. #[cfg(feature="gte_clang_5_0")] pub fn get_address_space(&self) -> usize { unsafe { clang_getAddressSpace(self.raw) as usize } } /// Returns the argument types for this function or method type, if applicable. pub fn get_argument_types(&self) -> Option<Vec<Type<'tu>>> { iter_option!( clang_getNumArgTypes(self.raw), clang_getArgType(self.raw), ).map(|i| i.map(|t| Type::from_raw(t, self.tu)).collect()) } /// Returns the calling convention specified for this function type, if applicable. pub fn get_calling_convention(&self) -> Option<CallingConvention> { unsafe { match clang_getFunctionTypeCallingConv(self.raw) { CXCallingConv_Invalid => None, other => Some(mem::transmute(other)), } } } /// Returns the canonical type for this type. /// /// The canonical type is the underlying type with all "sugar" removed (e.g., typedefs). pub fn get_canonical_type(&self) -> Type<'tu> { unsafe { Type::from_raw(clang_getCanonicalType(self.raw), self.tu) } } /// Returns the class type for this member pointer type, if applicable. pub fn get_class_type(&self) -> Option<Type<'tu>> { unsafe { clang_Type_getClassType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the AST entity that declared this type, if any. pub fn get_declaration(&self) -> Option<Entity<'tu>> { unsafe { clang_getTypeDeclaration(self.raw).map(|e| Entity::from_raw(e, self.tu)) } } /// Returns the type named by this elaborated type, if applicable. #[cfg(feature="gte_clang_3_9")] pub fn get_elaborated_type(&self) -> Option<Type<'tu>> { unsafe { clang_Type_getNamedType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the element type for this array, complex, or vector type, if applicable. pub fn get_element_type(&self) -> Option<Type<'tu>> { unsafe { clang_getElementType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the exception specification of this type, if applicable. #[cfg(feature="gte_clang_5_0")] pub fn get_exception_specification(&self) -> Option<ExceptionSpecification> { unsafe { match clang_getExceptionSpecificationType(self.raw) { -1 | CXCursor_ExceptionSpecificationKind_None => None, other => Some(mem::transmute(other)), } } } /// Returns the fields in this record type, if applicable. #[cfg(feature="gte_clang_3_7")] pub fn get_fields(&self) -> Option<Vec<Entity<'tu>>> { if self.get_kind() == TypeKind::Record { let mut fields = vec![]; self.visit_fields(|e| { fields.push(e); true }); Some(fields) } else { None } } /// Return the type that was modified by this attributed type. #[cfg(feature="gte_clang_8_0")] pub fn get_modified_type(&self) -> Option<Type<'tu>> { unsafe { clang_Type_getModifiedType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the nullability of this pointer type, if applicable. #[cfg(feature="gte_clang_8_0")] pub fn get_nullability(&self) -> Option<Nullability> { unsafe { match clang_Type_getNullability(self.raw) { CXTypeNullability_Invalid => None, other => Some(mem::transmute(other)), } } } /// Returns the encoding of this Objective-C type, if applicable. #[cfg(feature="gte_clang_3_9")] pub fn get_objc_encoding(&self) -> Option<String> { unsafe { utility::to_string_option(clang_Type_getObjCEncoding(self.raw)) } } /// Returns the base type of this Objective-C type, if applicable. #[cfg(feature="gte_clang_8_0")] pub fn get_objc_object_base_type(&self) -> Option<Type> { unsafe { clang_Type_getObjCObjectBaseType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the declarations for all protocol references for this Objective-C type, if applicable. #[cfg(feature="gte_clang_8_0")] pub fn get_objc_protocol_declarations(&self) -> Vec<Entity<'tu>> { iter!( clang_Type_getNumObjCProtocolRefs(self.raw), clang_Type_getObjCProtocolDecl(self.raw), ).map(|c| Entity::from_raw(c, self.tu)).collect() } /// Returns the type arguments for this Objective-C type, if applicable. #[cfg(feature="gte_clang_8_0")] pub fn get_objc_type_arguments(&self) -> Vec<Type<'tu>> { iter!( clang_Type_getNumObjCTypeArgs(self.raw), clang_Type_getObjCTypeArg(self.raw), ).map(|t| Type::from_raw(t, self.tu)).collect() } /// Returns the pointee type for this pointer type, if applicable. pub fn get_pointee_type(&self) -> Option<Type<'tu>> { unsafe { clang_getPointeeType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the ref qualifier for this C++ function or method type, if applicable. pub fn get_ref_qualifier(&self) -> Option<RefQualifier> { unsafe { match clang_Type_getCXXRefQualifier(self.raw) { CXRefQualifier_None => None, other => Some(mem::transmute(other)), } } } /// Returns the result type for this function or method type, if applicable. pub fn get_result_type(&self) -> Option<Type<'tu>> { unsafe { clang_getResultType(self.raw).map(|t| Type::from_raw(t, self.tu)) } } /// Returns the size of this constant array or vector type, if applicable. pub fn get_size(&self) -> Option<usize> { let size = unsafe { clang_getNumElements(self.raw) }; if size >= 0 { Some(size as usize) } else { None } } /// Returns the template argument types for this template class specialization type, if /// applicable. pub fn get_template_argument_types(&self) -> Option<Vec<Option<Type<'tu>>>> { iter_option!( clang_Type_getNumTemplateArguments(self.raw), clang_Type_getTemplateArgumentAsType(self.raw), ).map(|i| i.map(|t| t.map(|t| Type::from_raw(t, self.tu))).collect()) } /// Returns the typedef name of this type, if applicable. #[cfg(feature="gte_clang_5_0")] pub fn get_typedef_name(&self) -> Option<String> { unsafe { utility::to_string_option(clang_getTypedefName(self.raw)) } } /// Returns whether this type is qualified with const. pub fn is_const_qualified(&self) -> bool { unsafe { clang_isConstQualifiedType(self.raw) != 0 } } /// Returns whether this type is an elaborated type, if it can be determined for certain. pub fn is_elaborated(&self) -> Option<bool> { if self.raw.kind == 119 { Some(true) } else if cfg!(feature="gte_clang_3_9") { Some(false) } else { None } } /// Returns whether this type is plain old data (POD). pub fn is_pod(&self) -> bool { unsafe { clang_isPODType(self.raw) != 0 } } /// Returns whether this type is qualified with restrict. pub fn is_restrict_qualified(&self) -> bool { unsafe { clang_isRestrictQualifiedType(self.raw) != 0 } } /// Returns whether this type is a transparent tag typedef. #[cfg(feature="gte_clang_5_0")] pub fn is_transparent_tag(&self) -> bool { unsafe { clang_Type_isTransparentTagTypedef(self.raw) != 0 } } /// Returns whether this type is a variadic function type. pub fn is_variadic(&self) -> bool { unsafe { clang_isFunctionTypeVariadic(self.raw) != 0 } } /// Returns whether this type is qualified with volatile. pub fn is_volatile_qualified(&self) -> bool { unsafe { clang_isVolatileQualifiedType(self.raw) != 0 } } /// Visits the fields in this record type, returning `None` if this type is not a record type /// and returning `Some(b)` otherwise where `b` indicates whether visitation was ended by the /// callback returning `false`. #[cfg(feature="gte_clang_3_7")] pub fn visit_fields<F: FnMut(Entity<'tu>) -> bool>(&self, f: F) -> Option<bool> { if self.get_kind() != TypeKind::Record { return None; } trait Callback<'tu> { fn call(&mut self, field: Entity<'tu>) -> bool; } impl<'tu, F: FnMut(Entity<'tu>) -> bool> Callback<'tu> for F { fn call(&mut self, field: Entity<'tu>) -> bool { self(field) } } extern fn visit(cursor: CXCursor, data: CXClientData) -> CXVisitorResult { unsafe { let &mut (tu, ref mut callback) = &mut *(data as *mut (&TranslationUnit, Box<dyn Callback>)); if callback.call(Entity::from_raw(cursor, tu)) { CXVisit_Continue } else { CXVisit_Break } } } let mut data = (self.tu, Box::new(f) as Box<dyn Callback>); unsafe { let data = utility::addressof(&mut data); Some(clang_Type_visitFields(self.raw, visit, data) == CXVisit_Break) } } //- Categorization --------------------------- /// Returns whether this type is an integer type. pub fn is_integer(&self) -> bool { self.raw.kind >= CXType_Bool && self.raw.kind <= CXType_Int128 } /// Returns whether this type is a signed integer type. pub fn is_signed_integer(&self) -> bool { self.raw.kind >= CXType_Char_S && self.raw.kind <= CXType_Int128 } /// Returns whether this type is an unsigned integer type. pub fn is_unsigned_integer(&self) -> bool { self.raw.kind >= CXType_Bool && self.raw.kind <= CXType_UInt128 } } impl<'tu> fmt::Debug for Type<'tu> { fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.debug_struct("Type") .field("kind", &self.get_kind()) .field("display_name", &self.get_display_name()) .finish() } } impl<'tu> cmp::PartialEq for Type<'tu> { fn eq(&self, other: &Type<'tu>) -> bool { unsafe { clang_equalTypes(self.raw, other.raw) != 0 } } } impl<'tu> cmp::Eq for Type<'tu> { } // Unsaved _______________________________________ /// The path to and unsaved contents of a previously existing file. #[derive(Clone, Debug, PartialEq, Eq, Hash)] pub struct Unsaved { path: CString, contents: CString, } impl Unsaved { //- Constructors ----------------------------- /// Constructs a new `Unsaved`. pub fn new<P: AsRef<Path>, C: AsRef<str>>(path: P, contents: C) -> Unsaved { Unsaved { path: utility::from_path(path), contents: utility::from_string(contents) } } //- Accessors -------------------------------- fn as_raw(&self) -> CXUnsavedFile { CXUnsavedFile { Filename: self.path.as_ptr(), Contents: self.contents.as_ptr(), Length: self.contents.as_bytes().len() as c_ulong, } } } // Usr ___________________________________________ /// A Unified Symbol Resolution (USR). /// /// A USR identifies an AST entity and can be used to compare AST entities from different /// translation units. #[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] pub struct Usr(pub String); impl Usr { //- Constructors ----------------------------- /// Constructs a new `Usr` from an Objective-C category. pub fn from_objc_category<C: AsRef<str>>(class: C, category: C) -> Usr { let class = utility::from_string(class); let category = utility::from_string(category); let raw = unsafe { clang_constructUSR_ObjCCategory(class.as_ptr(), category.as_ptr()) }; Usr(utility::to_string(raw)) } /// Constructs a new `Usr` from an Objective-C class. pub fn from_objc_class<C: AsRef<str>>(class: C) -> Usr { let class = utility::from_string(class); unsafe { Usr(utility::to_string(clang_constructUSR_ObjCClass(class.as_ptr()))) } } /// Constructs a new `Usr` from an Objective-C instance variable. pub fn from_objc_ivar<N: AsRef<str>>(class: &Usr, name: N) -> Usr { utility::with_string(&class.0, |s| { let name = utility::from_string(name); unsafe { Usr(utility::to_string(clang_constructUSR_ObjCIvar(name.as_ptr(), s))) } }) } /// Constructs a new `Usr` from an Objective-C method. pub fn from_objc_method<N: AsRef<str>>(class: &Usr, name: N, instance: bool) -> Usr { utility::with_string(&class.0, |s| { let name = utility::from_string(name); let instance = instance as c_uint; let raw = unsafe { clang_constructUSR_ObjCMethod(name.as_ptr(), instance, s) }; Usr(utility::to_string(raw)) }) } /// Constructs a new `Usr` from an Objective-C property. pub fn from_objc_property<N: AsRef<str>>(class: &Usr, name: N) -> Usr { utility::with_string(&class.0, |s| { let name = utility::from_string(name); unsafe { Usr(utility::to_string(clang_constructUSR_ObjCProperty(name.as_ptr(), s))) } }) } /// Constructs a new `Usr` from an Objective-C protocol. pub fn from_objc_protocol<P: AsRef<str>>(protocol: P) -> Usr { let string = utility::from_string(protocol); unsafe { Usr(utility::to_string(clang_constructUSR_ObjCProtocol(string.as_ptr()))) } } } // Version _______________________________________ /// A version number in the form `x.y.z`. #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] pub struct Version { /// The `x` component of the version number. pub x: i32, /// The `y` component of the version number. pub y: i32, /// The `z` component of the version number. pub z: i32, } impl Version { //- Constructors ----------------------------- fn from_raw(raw: CXVersion) -> Version { Version { x: raw.Major as i32, y: raw.Minor as i32, z: raw.Subminor as i32 } } } //================================================ // Functions //================================================ /// Returns the version string for the version of `libclang` in use. pub fn get_version() -> String { unsafe { utility::to_string(clang_getClangVersion()) } }