1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763
|
// Copyright 2023 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated for LSP. DO NOT EDIT.
package protocol
// Code generated from protocol/metaModel.json at ref release/protocol/3.17.6-next.1 (hash d2c907f450cb6d3baff74b31b432b90786d2c3b0).
// https://github.com/microsoft/vscode-languageserver-node/blob/release/protocol/3.17.6-next.1/protocol/metaModel.json
// LSP metaData.version = 3.17.0.
import "encoding/json"
// A special text edit with an additional change annotation.
//
// @since 3.16.0.
type AnnotatedTextEdit struct {
// The actual identifier of the change annotation
AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"`
TextEdit
}
// The parameters passed via an apply workspace edit request.
type ApplyWorkspaceEditParams struct {
// An optional label of the workspace edit. This label is
// presented in the user interface for example on an undo
// stack to undo the workspace edit.
Label string `json:"label,omitempty"`
// The edits to apply.
Edit WorkspaceEdit `json:"edit"`
}
// The result returned from the apply workspace edit request.
//
// @since 3.17 renamed from ApplyWorkspaceEditResponse
type ApplyWorkspaceEditResult struct {
// Indicates whether the edit was applied or not.
Applied bool `json:"applied"`
// An optional textual description for why the edit was not applied.
// This may be used by the server for diagnostic logging or to provide
// a suitable error for a request that triggered the edit.
FailureReason string `json:"failureReason,omitempty"`
// Depending on the client's failure handling strategy `failedChange` might
// contain the index of the change that failed. This property is only available
// if the client signals a `failureHandlingStrategy` in its client capabilities.
FailedChange uint32 `json:"failedChange,omitempty"`
}
// A base for all symbol information.
type BaseSymbolInformation struct {
// The name of this symbol.
Name string `json:"name"`
// The kind of this symbol.
Kind SymbolKind `json:"kind"`
// Tags for this symbol.
//
// @since 3.16.0
Tags []SymbolTag `json:"tags,omitempty"`
// The name of the symbol containing this symbol. This information is for
// user interface purposes (e.g. to render a qualifier in the user interface
// if necessary). It can't be used to re-infer a hierarchy for the document
// symbols.
ContainerName string `json:"containerName,omitempty"`
}
// @since 3.16.0
type CallHierarchyClientCapabilities struct {
// Whether implementation supports dynamic registration. If this is set to `true`
// the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
// return value for the corresponding server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// Represents an incoming call, e.g. a caller of a method or constructor.
//
// @since 3.16.0
type CallHierarchyIncomingCall struct {
// The item that makes the call.
From CallHierarchyItem `json:"from"`
// The ranges at which the calls appear. This is relative to the caller
// denoted by {@link CallHierarchyIncomingCall.from `this.from`}.
FromRanges []Range `json:"fromRanges"`
}
// The parameter of a `callHierarchy/incomingCalls` request.
//
// @since 3.16.0
type CallHierarchyIncomingCallsParams struct {
Item CallHierarchyItem `json:"item"`
WorkDoneProgressParams
PartialResultParams
}
// Represents programming constructs like functions or constructors in the context
// of call hierarchy.
//
// @since 3.16.0
type CallHierarchyItem struct {
// The name of this item.
Name string `json:"name"`
// The kind of this item.
Kind SymbolKind `json:"kind"`
// Tags for this item.
Tags []SymbolTag `json:"tags,omitempty"`
// More detail for this item, e.g. the signature of a function.
Detail string `json:"detail,omitempty"`
// The resource identifier of this item.
URI DocumentURI `json:"uri"`
// The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
Range Range `json:"range"`
// The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function.
// Must be contained by the {@link CallHierarchyItem.range `range`}.
SelectionRange Range `json:"selectionRange"`
// A data entry field that is preserved between a call hierarchy prepare and
// incoming calls or outgoing calls requests.
Data interface{} `json:"data,omitempty"`
}
// Call hierarchy options used during static registration.
//
// @since 3.16.0
type CallHierarchyOptions struct {
WorkDoneProgressOptions
}
// Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
//
// @since 3.16.0
type CallHierarchyOutgoingCall struct {
// The item that is called.
To CallHierarchyItem `json:"to"`
// The range at which this item is called. This is the range relative to the caller, e.g the item
// passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`}
// and not {@link CallHierarchyOutgoingCall.to `this.to`}.
FromRanges []Range `json:"fromRanges"`
}
// The parameter of a `callHierarchy/outgoingCalls` request.
//
// @since 3.16.0
type CallHierarchyOutgoingCallsParams struct {
Item CallHierarchyItem `json:"item"`
WorkDoneProgressParams
PartialResultParams
}
// The parameter of a `textDocument/prepareCallHierarchy` request.
//
// @since 3.16.0
type CallHierarchyPrepareParams struct {
TextDocumentPositionParams
WorkDoneProgressParams
}
// Call hierarchy options used during static or dynamic registration.
//
// @since 3.16.0
type CallHierarchyRegistrationOptions struct {
TextDocumentRegistrationOptions
CallHierarchyOptions
StaticRegistrationOptions
}
type CancelParams struct {
// The request id to cancel.
ID interface{} `json:"id"`
}
// Additional information that describes document changes.
//
// @since 3.16.0
type ChangeAnnotation struct {
// A human-readable string describing the actual change. The string
// is rendered prominent in the user interface.
Label string `json:"label"`
// A flag which indicates that user confirmation is needed
// before applying the change.
NeedsConfirmation bool `json:"needsConfirmation,omitempty"`
// A human-readable string which is rendered less prominent in
// the user interface.
Description string `json:"description,omitempty"`
}
// An identifier to refer to a change annotation stored with a workspace edit.
type ChangeAnnotationIdentifier = string // (alias)
// @since 3.18.0
// @proposed
type ChangeAnnotationsSupportOptions struct {
// Whether the client groups edits with equal labels into tree nodes,
// for instance all edits labelled with "Changes in Strings" would
// be a tree node.
GroupsOnLabel bool `json:"groupsOnLabel,omitempty"`
}
// Defines the capabilities provided by the client.
type ClientCapabilities struct {
// Workspace specific client capabilities.
Workspace WorkspaceClientCapabilities `json:"workspace,omitempty"`
// Text document specific client capabilities.
TextDocument TextDocumentClientCapabilities `json:"textDocument,omitempty"`
// Capabilities specific to the notebook document support.
//
// @since 3.17.0
NotebookDocument *NotebookDocumentClientCapabilities `json:"notebookDocument,omitempty"`
// Window specific client capabilities.
Window WindowClientCapabilities `json:"window,omitempty"`
// General client capabilities.
//
// @since 3.16.0
General *GeneralClientCapabilities `json:"general,omitempty"`
// Experimental client capabilities.
Experimental interface{} `json:"experimental,omitempty"`
}
// @since 3.18.0
// @proposed
type ClientCodeActionKindOptions struct {
// The code action kind values the client supports. When this
// property exists the client also guarantees that it will
// handle values outside its set gracefully and falls back
// to a default value when unknown.
ValueSet []CodeActionKind `json:"valueSet"`
}
// @since 3.18.0
// @proposed
type ClientCodeActionLiteralOptions struct {
// The code action kind is support with the following value
// set.
CodeActionKind ClientCodeActionKindOptions `json:"codeActionKind"`
}
// @since 3.18.0
// @proposed
type ClientCodeActionResolveOptions struct {
// The properties that a client can resolve lazily.
Properties []string `json:"properties"`
}
// @since 3.18.0
// @proposed
type ClientCompletionItemInsertTextModeOptions struct {
ValueSet []InsertTextMode `json:"valueSet"`
}
// @since 3.18.0
// @proposed
type ClientCompletionItemOptions struct {
// Client supports snippets as insert text.
//
// A snippet can define tab stops and placeholders with `$1`, `$2`
// and `${3:foo}`. `$0` defines the final tab stop, it defaults to
// the end of the snippet. Placeholders with equal identifiers are linked,
// that is typing in one will update others too.
SnippetSupport bool `json:"snippetSupport,omitempty"`
// Client supports commit characters on a completion item.
CommitCharactersSupport bool `json:"commitCharactersSupport,omitempty"`
// Client supports the following content formats for the documentation
// property. The order describes the preferred format of the client.
DocumentationFormat []MarkupKind `json:"documentationFormat,omitempty"`
// Client supports the deprecated property on a completion item.
DeprecatedSupport bool `json:"deprecatedSupport,omitempty"`
// Client supports the preselect property on a completion item.
PreselectSupport bool `json:"preselectSupport,omitempty"`
// Client supports the tag property on a completion item. Clients supporting
// tags have to handle unknown tags gracefully. Clients especially need to
// preserve unknown tags when sending a completion item back to the server in
// a resolve call.
//
// @since 3.15.0
TagSupport *CompletionItemTagOptions `json:"tagSupport,omitempty"`
// Client support insert replace edit to control different behavior if a
// completion item is inserted in the text or should replace text.
//
// @since 3.16.0
InsertReplaceSupport bool `json:"insertReplaceSupport,omitempty"`
// Indicates which properties a client can resolve lazily on a completion
// item. Before version 3.16.0 only the predefined properties `documentation`
// and `details` could be resolved lazily.
//
// @since 3.16.0
ResolveSupport *ClientCompletionItemResolveOptions `json:"resolveSupport,omitempty"`
// The client supports the `insertTextMode` property on
// a completion item to override the whitespace handling mode
// as defined by the client (see `insertTextMode`).
//
// @since 3.16.0
InsertTextModeSupport *ClientCompletionItemInsertTextModeOptions `json:"insertTextModeSupport,omitempty"`
// The client has support for completion item label
// details (see also `CompletionItemLabelDetails`).
//
// @since 3.17.0
LabelDetailsSupport bool `json:"labelDetailsSupport,omitempty"`
}
// @since 3.18.0
// @proposed
type ClientCompletionItemOptionsKind struct {
// The completion item kind values the client supports. When this
// property exists the client also guarantees that it will
// handle values outside its set gracefully and falls back
// to a default value when unknown.
//
// If this property is not present the client only supports
// the completion items kinds from `Text` to `Reference` as defined in
// the initial version of the protocol.
ValueSet []CompletionItemKind `json:"valueSet,omitempty"`
}
// @since 3.18.0
// @proposed
type ClientCompletionItemResolveOptions struct {
// The properties that a client can resolve lazily.
Properties []string `json:"properties"`
}
// @since 3.18.0
// @proposed
type ClientDiagnosticsTagOptions struct {
// The tags supported by the client.
ValueSet []DiagnosticTag `json:"valueSet"`
}
// @since 3.18.0
// @proposed
type ClientFoldingRangeKindOptions struct {
// The folding range kind values the client supports. When this
// property exists the client also guarantees that it will
// handle values outside its set gracefully and falls back
// to a default value when unknown.
ValueSet []FoldingRangeKind `json:"valueSet,omitempty"`
}
// @since 3.18.0
// @proposed
type ClientFoldingRangeOptions struct {
// If set, the client signals that it supports setting collapsedText on
// folding ranges to display custom labels instead of the default text.
//
// @since 3.17.0
CollapsedText bool `json:"collapsedText,omitempty"`
}
// Information about the client
//
// @since 3.15.0
// @since 3.18.0 ClientInfo type name added.
// @proposed
type ClientInfo struct {
// The name of the client as defined by the client.
Name string `json:"name"`
// The client's version as defined by the client.
Version string `json:"version,omitempty"`
}
// @since 3.18.0
// @proposed
type ClientInlayHintResolveOptions struct {
// The properties that a client can resolve lazily.
Properties []string `json:"properties"`
}
// @since 3.18.0
// @proposed
type ClientSemanticTokensRequestFullDelta struct {
// The client will send the `textDocument/semanticTokens/full/delta` request if
// the server provides a corresponding handler.
Delta bool `json:"delta,omitempty"`
}
// @since 3.18.0
// @proposed
type ClientSemanticTokensRequestOptions struct {
// The client will send the `textDocument/semanticTokens/range` request if
// the server provides a corresponding handler.
Range *Or_ClientSemanticTokensRequestOptions_range `json:"range,omitempty"`
// The client will send the `textDocument/semanticTokens/full` request if
// the server provides a corresponding handler.
Full *Or_ClientSemanticTokensRequestOptions_full `json:"full,omitempty"`
}
// @since 3.18.0
// @proposed
type ClientShowMessageActionItemOptions struct {
// Whether the client supports additional attributes which
// are preserved and send back to the server in the
// request's response.
AdditionalPropertiesSupport bool `json:"additionalPropertiesSupport,omitempty"`
}
// @since 3.18.0
// @proposed
type ClientSignatureInformationOptions struct {
// Client supports the following content formats for the documentation
// property. The order describes the preferred format of the client.
DocumentationFormat []MarkupKind `json:"documentationFormat,omitempty"`
// Client capabilities specific to parameter information.
ParameterInformation *ClientSignatureParameterInformationOptions `json:"parameterInformation,omitempty"`
// The client supports the `activeParameter` property on `SignatureInformation`
// literal.
//
// @since 3.16.0
ActiveParameterSupport bool `json:"activeParameterSupport,omitempty"`
}
// @since 3.18.0
// @proposed
type ClientSignatureParameterInformationOptions struct {
// The client supports processing label offsets instead of a
// simple label string.
//
// @since 3.14.0
LabelOffsetSupport bool `json:"labelOffsetSupport,omitempty"`
}
// @since 3.18.0
// @proposed
type ClientSymbolKindOptions struct {
// The symbol kind values the client supports. When this
// property exists the client also guarantees that it will
// handle values outside its set gracefully and falls back
// to a default value when unknown.
//
// If this property is not present the client only supports
// the symbol kinds from `File` to `Array` as defined in
// the initial version of the protocol.
ValueSet []SymbolKind `json:"valueSet,omitempty"`
}
// @since 3.18.0
// @proposed
type ClientSymbolResolveOptions struct {
// The properties that a client can resolve lazily. Usually
// `location.range`
Properties []string `json:"properties"`
}
// @since 3.18.0
// @proposed
type ClientSymbolTagOptions struct {
// The tags supported by the client.
ValueSet []SymbolTag `json:"valueSet"`
}
// A code action represents a change that can be performed in code, e.g. to fix a problem or
// to refactor code.
//
// A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
type CodeAction struct {
// A short, human-readable, title for this code action.
Title string `json:"title"`
// The kind of the code action.
//
// Used to filter code actions.
Kind CodeActionKind `json:"kind,omitempty"`
// The diagnostics that this code action resolves.
Diagnostics []Diagnostic `json:"diagnostics,omitempty"`
// Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted
// by keybindings.
//
// A quick fix should be marked preferred if it properly addresses the underlying error.
// A refactoring should be marked preferred if it is the most reasonable choice of actions to take.
//
// @since 3.15.0
IsPreferred bool `json:"isPreferred,omitempty"`
// Marks that the code action cannot currently be applied.
//
// Clients should follow the following guidelines regarding disabled code actions:
//
// - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action)
// code action menus.
//
// - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type
// of code action, such as refactorings.
//
// - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions)
// that auto applies a code action and only disabled code actions are returned, the client should show the user an
// error message with `reason` in the editor.
//
// @since 3.16.0
Disabled *CodeActionDisabled `json:"disabled,omitempty"`
// The workspace edit this code action performs.
Edit *WorkspaceEdit `json:"edit,omitempty"`
// A command this code action executes. If a code action
// provides an edit and a command, first the edit is
// executed and then the command.
Command *Command `json:"command,omitempty"`
// A data entry field that is preserved on a code action between
// a `textDocument/codeAction` and a `codeAction/resolve` request.
//
// @since 3.16.0
Data *json.RawMessage `json:"data,omitempty"`
}
// The Client Capabilities of a {@link CodeActionRequest}.
type CodeActionClientCapabilities struct {
// Whether code action supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client support code action literals of type `CodeAction` as a valid
// response of the `textDocument/codeAction` request. If the property is not
// set the request can only return `Command` literals.
//
// @since 3.8.0
CodeActionLiteralSupport ClientCodeActionLiteralOptions `json:"codeActionLiteralSupport,omitempty"`
// Whether code action supports the `isPreferred` property.
//
// @since 3.15.0
IsPreferredSupport bool `json:"isPreferredSupport,omitempty"`
// Whether code action supports the `disabled` property.
//
// @since 3.16.0
DisabledSupport bool `json:"disabledSupport,omitempty"`
// Whether code action supports the `data` property which is
// preserved between a `textDocument/codeAction` and a
// `codeAction/resolve` request.
//
// @since 3.16.0
DataSupport bool `json:"dataSupport,omitempty"`
// Whether the client supports resolving additional code action
// properties via a separate `codeAction/resolve` request.
//
// @since 3.16.0
ResolveSupport *ClientCodeActionResolveOptions `json:"resolveSupport,omitempty"`
// Whether the client honors the change annotations in
// text edits and resource operations returned via the
// `CodeAction#edit` property by for example presenting
// the workspace edit in the user interface and asking
// for confirmation.
//
// @since 3.16.0
HonorsChangeAnnotations bool `json:"honorsChangeAnnotations,omitempty"`
}
// Contains additional diagnostic information about the context in which
// a {@link CodeActionProvider.provideCodeActions code action} is run.
type CodeActionContext struct {
// An array of diagnostics known on the client side overlapping the range provided to the
// `textDocument/codeAction` request. They are provided so that the server knows which
// errors are currently presented to the user for the given range. There is no guarantee
// that these accurately reflect the error state of the resource. The primary parameter
// to compute code actions is the provided range.
Diagnostics []Diagnostic `json:"diagnostics"`
// Requested kind of actions to return.
//
// Actions not of this kind are filtered out by the client before being shown. So servers
// can omit computing them.
Only []CodeActionKind `json:"only,omitempty"`
// The reason why code actions were requested.
//
// @since 3.17.0
TriggerKind *CodeActionTriggerKind `json:"triggerKind,omitempty"`
}
// Captures why the code action is currently disabled.
//
// @since 3.18.0
// @proposed
type CodeActionDisabled struct {
// Human readable description of why the code action is currently disabled.
//
// This is displayed in the code actions UI.
Reason string `json:"reason"`
}
// A set of predefined code action kinds
type CodeActionKind string
// Provider options for a {@link CodeActionRequest}.
type CodeActionOptions struct {
// CodeActionKinds that this server may return.
//
// The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server
// may list out every specific kind they provide.
CodeActionKinds []CodeActionKind `json:"codeActionKinds,omitempty"`
// The server provides support to resolve additional
// information for a code action.
//
// @since 3.16.0
ResolveProvider bool `json:"resolveProvider,omitempty"`
WorkDoneProgressOptions
}
// The parameters of a {@link CodeActionRequest}.
type CodeActionParams struct {
// The document in which the command was invoked.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The range for which the command was invoked.
Range Range `json:"range"`
// Context carrying additional information.
Context CodeActionContext `json:"context"`
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a {@link CodeActionRequest}.
type CodeActionRegistrationOptions struct {
TextDocumentRegistrationOptions
CodeActionOptions
}
// The reason why code actions were requested.
//
// @since 3.17.0
type CodeActionTriggerKind uint32
// Structure to capture a description for an error code.
//
// @since 3.16.0
type CodeDescription struct {
// An URI to open with more information about the diagnostic error.
Href URI `json:"href"`
}
// A code lens represents a {@link Command command} that should be shown along with
// source text, like the number of references, a way to run tests, etc.
//
// A code lens is _unresolved_ when no command is associated to it. For performance
// reasons the creation of a code lens and resolving should be done in two stages.
type CodeLens struct {
// The range in which this code lens is valid. Should only span a single line.
Range Range `json:"range"`
// The command this code lens represents.
Command *Command `json:"command,omitempty"`
// A data entry field that is preserved on a code lens item between
// a {@link CodeLensRequest} and a {@link CodeLensResolveRequest}
Data interface{} `json:"data,omitempty"`
}
// The client capabilities of a {@link CodeLensRequest}.
type CodeLensClientCapabilities struct {
// Whether code lens supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// Code Lens provider options of a {@link CodeLensRequest}.
type CodeLensOptions struct {
// Code lens has a resolve provider as well.
ResolveProvider bool `json:"resolveProvider,omitempty"`
WorkDoneProgressOptions
}
// The parameters of a {@link CodeLensRequest}.
type CodeLensParams struct {
// The document to request code lens for.
TextDocument TextDocumentIdentifier `json:"textDocument"`
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a {@link CodeLensRequest}.
type CodeLensRegistrationOptions struct {
TextDocumentRegistrationOptions
CodeLensOptions
}
// @since 3.16.0
type CodeLensWorkspaceClientCapabilities struct {
// Whether the client implementation supports a refresh request sent from the
// server to the client.
//
// Note that this event is global and will force the client to refresh all
// code lenses currently shown. It should be used with absolute care and is
// useful for situation where a server for example detect a project wide
// change that requires such a calculation.
RefreshSupport bool `json:"refreshSupport,omitempty"`
}
// Represents a color in RGBA space.
type Color struct {
// The red component of this color in the range [0-1].
Red float64 `json:"red"`
// The green component of this color in the range [0-1].
Green float64 `json:"green"`
// The blue component of this color in the range [0-1].
Blue float64 `json:"blue"`
// The alpha component of this color in the range [0-1].
Alpha float64 `json:"alpha"`
}
// Represents a color range from a document.
type ColorInformation struct {
// The range in the document where this color appears.
Range Range `json:"range"`
// The actual color value for this color range.
Color Color `json:"color"`
}
type ColorPresentation struct {
// The label of this color presentation. It will be shown on the color
// picker header. By default this is also the text that is inserted when selecting
// this color presentation.
Label string `json:"label"`
// An {@link TextEdit edit} which is applied to a document when selecting
// this presentation for the color. When `falsy` the {@link ColorPresentation.label label}
// is used.
TextEdit *TextEdit `json:"textEdit,omitempty"`
// An optional array of additional {@link TextEdit text edits} that are applied when
// selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.
AdditionalTextEdits []TextEdit `json:"additionalTextEdits,omitempty"`
}
// Parameters for a {@link ColorPresentationRequest}.
type ColorPresentationParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The color to request presentations for.
Color Color `json:"color"`
// The range where the color would be inserted. Serves as a context.
Range Range `json:"range"`
WorkDoneProgressParams
PartialResultParams
}
// Represents a reference to a command. Provides a title which
// will be used to represent a command in the UI and, optionally,
// an array of arguments which will be passed to the command handler
// function when invoked.
type Command struct {
// Title of the command, like `save`.
Title string `json:"title"`
// The identifier of the actual command handler.
Command string `json:"command"`
// Arguments that the command handler should be
// invoked with.
Arguments []json.RawMessage `json:"arguments,omitempty"`
}
// Completion client capabilities
type CompletionClientCapabilities struct {
// Whether completion supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client supports the following `CompletionItem` specific
// capabilities.
CompletionItem ClientCompletionItemOptions `json:"completionItem,omitempty"`
CompletionItemKind *ClientCompletionItemOptionsKind `json:"completionItemKind,omitempty"`
// Defines how the client handles whitespace and indentation
// when accepting a completion item that uses multi line
// text in either `insertText` or `textEdit`.
//
// @since 3.17.0
InsertTextMode InsertTextMode `json:"insertTextMode,omitempty"`
// The client supports to send additional context information for a
// `textDocument/completion` request.
ContextSupport bool `json:"contextSupport,omitempty"`
// The client supports the following `CompletionList` specific
// capabilities.
//
// @since 3.17.0
CompletionList *CompletionListCapabilities `json:"completionList,omitempty"`
}
// Contains additional information about the context in which a completion request is triggered.
type CompletionContext struct {
// How the completion was triggered.
TriggerKind CompletionTriggerKind `json:"triggerKind"`
// The trigger character (a single character) that has trigger code complete.
// Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
TriggerCharacter string `json:"triggerCharacter,omitempty"`
}
// A completion item represents a text snippet that is
// proposed to complete text that is being typed.
type CompletionItem struct {
// The label of this completion item.
//
// The label property is also by default the text that
// is inserted when selecting this completion.
//
// If label details are provided the label itself should
// be an unqualified name of the completion item.
Label string `json:"label"`
// Additional details for the label
//
// @since 3.17.0
LabelDetails *CompletionItemLabelDetails `json:"labelDetails,omitempty"`
// The kind of this completion item. Based of the kind
// an icon is chosen by the editor.
Kind CompletionItemKind `json:"kind,omitempty"`
// Tags for this completion item.
//
// @since 3.15.0
Tags []CompletionItemTag `json:"tags,omitempty"`
// A human-readable string with additional information
// about this item, like type or symbol information.
Detail string `json:"detail,omitempty"`
// A human-readable string that represents a doc-comment.
Documentation *Or_CompletionItem_documentation `json:"documentation,omitempty"`
// Indicates if this item is deprecated.
// @deprecated Use `tags` instead.
Deprecated bool `json:"deprecated,omitempty"`
// Select this item when showing.
//
// *Note* that only one completion item can be selected and that the
// tool / client decides which item that is. The rule is that the *first*
// item of those that match best is selected.
Preselect bool `json:"preselect,omitempty"`
// A string that should be used when comparing this item
// with other items. When `falsy` the {@link CompletionItem.label label}
// is used.
SortText string `json:"sortText,omitempty"`
// A string that should be used when filtering a set of
// completion items. When `falsy` the {@link CompletionItem.label label}
// is used.
FilterText string `json:"filterText,omitempty"`
// A string that should be inserted into a document when selecting
// this completion. When `falsy` the {@link CompletionItem.label label}
// is used.
//
// The `insertText` is subject to interpretation by the client side.
// Some tools might not take the string literally. For example
// VS Code when code complete is requested in this example
// `con<cursor position>` and a completion item with an `insertText` of
// `console` is provided it will only insert `sole`. Therefore it is
// recommended to use `textEdit` instead since it avoids additional client
// side interpretation.
InsertText string `json:"insertText,omitempty"`
// The format of the insert text. The format applies to both the
// `insertText` property and the `newText` property of a provided
// `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.
//
// Please note that the insertTextFormat doesn't apply to
// `additionalTextEdits`.
InsertTextFormat *InsertTextFormat `json:"insertTextFormat,omitempty"`
// How whitespace and indentation is handled during completion
// item insertion. If not provided the clients default value depends on
// the `textDocument.completion.insertTextMode` client capability.
//
// @since 3.16.0
InsertTextMode *InsertTextMode `json:"insertTextMode,omitempty"`
// An {@link TextEdit edit} which is applied to a document when selecting
// this completion. When an edit is provided the value of
// {@link CompletionItem.insertText insertText} is ignored.
//
// Most editors support two different operations when accepting a completion
// item. One is to insert a completion text and the other is to replace an
// existing text with a completion text. Since this can usually not be
// predetermined by a server it can report both ranges. Clients need to
// signal support for `InsertReplaceEdits` via the
// `textDocument.completion.insertReplaceSupport` client capability
// property.
//
// *Note 1:* The text edit's range as well as both ranges from an insert
// replace edit must be a [single line] and they must contain the position
// at which completion has been requested.
// *Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range
// must be a prefix of the edit's replace range, that means it must be
// contained and starting at the same position.
//
// @since 3.16.0 additional type `InsertReplaceEdit`
TextEdit *TextEdit `json:"textEdit,omitempty"`
// The edit text used if the completion item is part of a CompletionList and
// CompletionList defines an item default for the text edit range.
//
// Clients will only honor this property if they opt into completion list
// item defaults using the capability `completionList.itemDefaults`.
//
// If not provided and a list's default range is provided the label
// property is used as a text.
//
// @since 3.17.0
TextEditText string `json:"textEditText,omitempty"`
// An optional array of additional {@link TextEdit text edits} that are applied when
// selecting this completion. Edits must not overlap (including the same insert position)
// with the main {@link CompletionItem.textEdit edit} nor with themselves.
//
// Additional text edits should be used to change text unrelated to the current cursor position
// (for example adding an import statement at the top of the file if the completion item will
// insert an unqualified type).
AdditionalTextEdits []TextEdit `json:"additionalTextEdits,omitempty"`
// An optional set of characters that when pressed while this completion is active will accept it first and
// then type that character. *Note* that all commit characters should have `length=1` and that superfluous
// characters will be ignored.
CommitCharacters []string `json:"commitCharacters,omitempty"`
// An optional {@link Command command} that is executed *after* inserting this completion. *Note* that
// additional modifications to the current document should be described with the
// {@link CompletionItem.additionalTextEdits additionalTextEdits}-property.
Command *Command `json:"command,omitempty"`
// A data entry field that is preserved on a completion item between a
// {@link CompletionRequest} and a {@link CompletionResolveRequest}.
Data interface{} `json:"data,omitempty"`
}
// In many cases the items of an actual completion result share the same
// value for properties like `commitCharacters` or the range of a text
// edit. A completion list can therefore define item defaults which will
// be used if a completion item itself doesn't specify the value.
//
// If a completion list specifies a default value and a completion item
// also specifies a corresponding value the one from the item is used.
//
// Servers are only allowed to return default values if the client
// signals support for this via the `completionList.itemDefaults`
// capability.
//
// @since 3.17.0
type CompletionItemDefaults struct {
// A default commit character set.
//
// @since 3.17.0
CommitCharacters []string `json:"commitCharacters,omitempty"`
// A default edit range.
//
// @since 3.17.0
EditRange *Or_CompletionItemDefaults_editRange `json:"editRange,omitempty"`
// A default insert text format.
//
// @since 3.17.0
InsertTextFormat *InsertTextFormat `json:"insertTextFormat,omitempty"`
// A default insert text mode.
//
// @since 3.17.0
InsertTextMode *InsertTextMode `json:"insertTextMode,omitempty"`
// A default data value.
//
// @since 3.17.0
Data interface{} `json:"data,omitempty"`
}
// The kind of a completion entry.
type CompletionItemKind uint32
// Additional details for a completion item label.
//
// @since 3.17.0
type CompletionItemLabelDetails struct {
// An optional string which is rendered less prominently directly after {@link CompletionItem.label label},
// without any spacing. Should be used for function signatures and type annotations.
Detail string `json:"detail,omitempty"`
// An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used
// for fully qualified names and file paths.
Description string `json:"description,omitempty"`
}
// Completion item tags are extra annotations that tweak the rendering of a completion
// item.
//
// @since 3.15.0
type CompletionItemTag uint32
// @since 3.18.0
// @proposed
type CompletionItemTagOptions struct {
// The tags supported by the client.
ValueSet []CompletionItemTag `json:"valueSet"`
}
// Represents a collection of {@link CompletionItem completion items} to be presented
// in the editor.
type CompletionList struct {
// This list it not complete. Further typing results in recomputing this list.
//
// Recomputed lists have all their items replaced (not appended) in the
// incomplete completion sessions.
IsIncomplete bool `json:"isIncomplete"`
// In many cases the items of an actual completion result share the same
// value for properties like `commitCharacters` or the range of a text
// edit. A completion list can therefore define item defaults which will
// be used if a completion item itself doesn't specify the value.
//
// If a completion list specifies a default value and a completion item
// also specifies a corresponding value the one from the item is used.
//
// Servers are only allowed to return default values if the client
// signals support for this via the `completionList.itemDefaults`
// capability.
//
// @since 3.17.0
ItemDefaults *CompletionItemDefaults `json:"itemDefaults,omitempty"`
// The completion items.
Items []CompletionItem `json:"items"`
}
// The client supports the following `CompletionList` specific
// capabilities.
//
// @since 3.17.0
type CompletionListCapabilities struct {
// The client supports the following itemDefaults on
// a completion list.
//
// The value lists the supported property names of the
// `CompletionList.itemDefaults` object. If omitted
// no properties are supported.
//
// @since 3.17.0
ItemDefaults []string `json:"itemDefaults,omitempty"`
}
// Completion options.
type CompletionOptions struct {
// Most tools trigger completion request automatically without explicitly requesting
// it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user
// starts to type an identifier. For example if the user types `c` in a JavaScript file
// code complete will automatically pop up present `console` besides others as a
// completion item. Characters that make up identifiers don't need to be listed here.
//
// If code complete should automatically be trigger on characters not being valid inside
// an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
TriggerCharacters []string `json:"triggerCharacters,omitempty"`
// The list of all possible characters that commit a completion. This field can be used
// if clients don't support individual commit characters per completion item. See
// `ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport`
//
// If a server provides both `allCommitCharacters` and commit characters on an individual
// completion item the ones on the completion item win.
//
// @since 3.2.0
AllCommitCharacters []string `json:"allCommitCharacters,omitempty"`
// The server provides support to resolve additional
// information for a completion item.
ResolveProvider bool `json:"resolveProvider,omitempty"`
// The server supports the following `CompletionItem` specific
// capabilities.
//
// @since 3.17.0
CompletionItem *ServerCompletionItemOptions `json:"completionItem,omitempty"`
WorkDoneProgressOptions
}
// Completion parameters
type CompletionParams struct {
// The completion context. This is only available it the client specifies
// to send this using the client capability `textDocument.completion.contextSupport === true`
Context CompletionContext `json:"context,omitempty"`
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a {@link CompletionRequest}.
type CompletionRegistrationOptions struct {
TextDocumentRegistrationOptions
CompletionOptions
}
// How a completion was triggered
type CompletionTriggerKind uint32
type ConfigurationItem struct {
// The scope to get the configuration section for.
ScopeURI *URI `json:"scopeUri,omitempty"`
// The configuration section asked for.
Section string `json:"section,omitempty"`
}
// The parameters of a configuration request.
type ConfigurationParams struct {
Items []ConfigurationItem `json:"items"`
}
// Create file operation.
type CreateFile struct {
// A create
Kind string `json:"kind"`
// The resource to create.
URI DocumentURI `json:"uri"`
// Additional options
Options *CreateFileOptions `json:"options,omitempty"`
ResourceOperation
}
// Options to create a file.
type CreateFileOptions struct {
// Overwrite existing file. Overwrite wins over `ignoreIfExists`
Overwrite bool `json:"overwrite,omitempty"`
// Ignore if exists.
IgnoreIfExists bool `json:"ignoreIfExists,omitempty"`
}
// The parameters sent in notifications/requests for user-initiated creation of
// files.
//
// @since 3.16.0
type CreateFilesParams struct {
// An array of all files/folders created in this operation.
Files []FileCreate `json:"files"`
}
// The declaration of a symbol representation as one or many {@link Location locations}.
type Declaration = []Location // (alias)
// @since 3.14.0
type DeclarationClientCapabilities struct {
// Whether declaration supports dynamic registration. If this is set to `true`
// the client supports the new `DeclarationRegistrationOptions` return value
// for the corresponding server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client supports additional metadata in the form of declaration links.
LinkSupport bool `json:"linkSupport,omitempty"`
}
// Information about where a symbol is declared.
//
// Provides additional metadata over normal {@link Location location} declarations, including the range of
// the declaring symbol.
//
// Servers should prefer returning `DeclarationLink` over `Declaration` if supported
// by the client.
type DeclarationLink = LocationLink // (alias)
type DeclarationOptions struct {
WorkDoneProgressOptions
}
type DeclarationParams struct {
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
type DeclarationRegistrationOptions struct {
DeclarationOptions
TextDocumentRegistrationOptions
StaticRegistrationOptions
}
// The definition of a symbol represented as one or many {@link Location locations}.
// For most programming languages there is only one location at which a symbol is
// defined.
//
// Servers should prefer returning `DefinitionLink` over `Definition` if supported
// by the client.
type Definition = Or_Definition // (alias)
// Client Capabilities for a {@link DefinitionRequest}.
type DefinitionClientCapabilities struct {
// Whether definition supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client supports additional metadata in the form of definition links.
//
// @since 3.14.0
LinkSupport bool `json:"linkSupport,omitempty"`
}
// Information about where a symbol is defined.
//
// Provides additional metadata over normal {@link Location location} definitions, including the range of
// the defining symbol
type DefinitionLink = LocationLink // (alias)
// Server Capabilities for a {@link DefinitionRequest}.
type DefinitionOptions struct {
WorkDoneProgressOptions
}
// Parameters for a {@link DefinitionRequest}.
type DefinitionParams struct {
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a {@link DefinitionRequest}.
type DefinitionRegistrationOptions struct {
TextDocumentRegistrationOptions
DefinitionOptions
}
// Delete file operation
type DeleteFile struct {
// A delete
Kind string `json:"kind"`
// The file to delete.
URI DocumentURI `json:"uri"`
// Delete options.
Options *DeleteFileOptions `json:"options,omitempty"`
ResourceOperation
}
// Delete file options
type DeleteFileOptions struct {
// Delete the content recursively if a folder is denoted.
Recursive bool `json:"recursive,omitempty"`
// Ignore the operation if the file doesn't exist.
IgnoreIfNotExists bool `json:"ignoreIfNotExists,omitempty"`
}
// The parameters sent in notifications/requests for user-initiated deletes of
// files.
//
// @since 3.16.0
type DeleteFilesParams struct {
// An array of all files/folders deleted in this operation.
Files []FileDelete `json:"files"`
}
// Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
// are only valid in the scope of a resource.
type Diagnostic struct {
// The range at which the message applies
Range Range `json:"range"`
// The diagnostic's severity. Can be omitted. If omitted it is up to the
// client to interpret diagnostics as error, warning, info or hint.
Severity DiagnosticSeverity `json:"severity,omitempty"`
// The diagnostic's code, which usually appear in the user interface.
Code interface{} `json:"code,omitempty"`
// An optional property to describe the error code.
// Requires the code field (above) to be present/not null.
//
// @since 3.16.0
CodeDescription *CodeDescription `json:"codeDescription,omitempty"`
// A human-readable string describing the source of this
// diagnostic, e.g. 'typescript' or 'super lint'. It usually
// appears in the user interface.
Source string `json:"source,omitempty"`
// The diagnostic's message. It usually appears in the user interface
Message string `json:"message"`
// Additional metadata about the diagnostic.
//
// @since 3.15.0
Tags []DiagnosticTag `json:"tags,omitempty"`
// An array of related diagnostic information, e.g. when symbol-names within
// a scope collide all definitions can be marked via this property.
RelatedInformation []DiagnosticRelatedInformation `json:"relatedInformation,omitempty"`
// A data entry field that is preserved between a `textDocument/publishDiagnostics`
// notification and `textDocument/codeAction` request.
//
// @since 3.16.0
Data *json.RawMessage `json:"data,omitempty"`
}
// Client capabilities specific to diagnostic pull requests.
//
// @since 3.17.0
type DiagnosticClientCapabilities struct {
// Whether implementation supports dynamic registration. If this is set to `true`
// the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
// return value for the corresponding server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// Whether the clients supports related documents for document diagnostic pulls.
RelatedDocumentSupport bool `json:"relatedDocumentSupport,omitempty"`
}
// Diagnostic options.
//
// @since 3.17.0
type DiagnosticOptions struct {
// An optional identifier under which the diagnostics are
// managed by the client.
Identifier string `json:"identifier,omitempty"`
// Whether the language has inter file dependencies meaning that
// editing code in one file can result in a different diagnostic
// set in another file. Inter file dependencies are common for
// most programming languages and typically uncommon for linters.
InterFileDependencies bool `json:"interFileDependencies"`
// The server provides support for workspace diagnostics as well.
WorkspaceDiagnostics bool `json:"workspaceDiagnostics"`
WorkDoneProgressOptions
}
// Diagnostic registration options.
//
// @since 3.17.0
type DiagnosticRegistrationOptions struct {
TextDocumentRegistrationOptions
DiagnosticOptions
StaticRegistrationOptions
}
// Represents a related message and source code location for a diagnostic. This should be
// used to point to code locations that cause or related to a diagnostics, e.g when duplicating
// a symbol in a scope.
type DiagnosticRelatedInformation struct {
// The location of this related diagnostic information.
Location Location `json:"location"`
// The message of this related diagnostic information.
Message string `json:"message"`
}
// Cancellation data returned from a diagnostic request.
//
// @since 3.17.0
type DiagnosticServerCancellationData struct {
RetriggerRequest bool `json:"retriggerRequest"`
}
// The diagnostic's severity.
type DiagnosticSeverity uint32
// The diagnostic tags.
//
// @since 3.15.0
type DiagnosticTag uint32
// Workspace client capabilities specific to diagnostic pull requests.
//
// @since 3.17.0
type DiagnosticWorkspaceClientCapabilities struct {
// Whether the client implementation supports a refresh request sent from
// the server to the client.
//
// Note that this event is global and will force the client to refresh all
// pulled diagnostics currently shown. It should be used with absolute care and
// is useful for situation where a server for example detects a project wide
// change that requires such a calculation.
RefreshSupport bool `json:"refreshSupport,omitempty"`
}
type DidChangeConfigurationClientCapabilities struct {
// Did change configuration notification supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// The parameters of a change configuration notification.
type DidChangeConfigurationParams struct {
// The actual changed settings
Settings interface{} `json:"settings"`
}
type DidChangeConfigurationRegistrationOptions struct {
Section *OrPSection_workspace_didChangeConfiguration `json:"section,omitempty"`
}
// The params sent in a change notebook document notification.
//
// @since 3.17.0
type DidChangeNotebookDocumentParams struct {
// The notebook document that did change. The version number points
// to the version after all provided changes have been applied. If
// only the text document content of a cell changes the notebook version
// doesn't necessarily have to change.
NotebookDocument VersionedNotebookDocumentIdentifier `json:"notebookDocument"`
// The actual changes to the notebook document.
//
// The changes describe single state changes to the notebook document.
// So if there are two changes c1 (at array index 0) and c2 (at array
// index 1) for a notebook in state S then c1 moves the notebook from
// S to S' and c2 from S' to S''. So c1 is computed on the state S and
// c2 is computed on the state S'.
//
// To mirror the content of a notebook using change events use the following approach:
//
// - start with the same initial content
// - apply the 'notebookDocument/didChange' notifications in the order you receive them.
// - apply the `NotebookChangeEvent`s in a single notification in the order
// you receive them.
Change NotebookDocumentChangeEvent `json:"change"`
}
// The change text document notification's parameters.
type DidChangeTextDocumentParams struct {
// The document that did change. The version number points
// to the version after all provided content changes have
// been applied.
TextDocument VersionedTextDocumentIdentifier `json:"textDocument"`
// The actual content changes. The content changes describe single state changes
// to the document. So if there are two content changes c1 (at array index 0) and
// c2 (at array index 1) for a document in state S then c1 moves the document from
// S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed
// on the state S'.
//
// To mirror the content of a document using change events use the following approach:
//
// - start with the same initial content
// - apply the 'textDocument/didChange' notifications in the order you receive them.
// - apply the `TextDocumentContentChangeEvent`s in a single notification in the order
// you receive them.
ContentChanges []TextDocumentContentChangeEvent `json:"contentChanges"`
}
type DidChangeWatchedFilesClientCapabilities struct {
// Did change watched files notification supports dynamic registration. Please note
// that the current protocol doesn't support static configuration for file changes
// from the server side.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// Whether the client has support for {@link RelativePattern relative pattern}
// or not.
//
// @since 3.17.0
RelativePatternSupport bool `json:"relativePatternSupport,omitempty"`
}
// The watched files change notification's parameters.
type DidChangeWatchedFilesParams struct {
// The actual file events.
Changes []FileEvent `json:"changes"`
}
// Describe options to be used when registered for text document change events.
type DidChangeWatchedFilesRegistrationOptions struct {
// The watchers to register.
Watchers []FileSystemWatcher `json:"watchers"`
}
// The parameters of a `workspace/didChangeWorkspaceFolders` notification.
type DidChangeWorkspaceFoldersParams struct {
// The actual workspace folder change event.
Event WorkspaceFoldersChangeEvent `json:"event"`
}
// The params sent in a close notebook document notification.
//
// @since 3.17.0
type DidCloseNotebookDocumentParams struct {
// The notebook document that got closed.
NotebookDocument NotebookDocumentIdentifier `json:"notebookDocument"`
// The text documents that represent the content
// of a notebook cell that got closed.
CellTextDocuments []TextDocumentIdentifier `json:"cellTextDocuments"`
}
// The parameters sent in a close text document notification
type DidCloseTextDocumentParams struct {
// The document that was closed.
TextDocument TextDocumentIdentifier `json:"textDocument"`
}
// The params sent in an open notebook document notification.
//
// @since 3.17.0
type DidOpenNotebookDocumentParams struct {
// The notebook document that got opened.
NotebookDocument NotebookDocument `json:"notebookDocument"`
// The text documents that represent the content
// of a notebook cell.
CellTextDocuments []TextDocumentItem `json:"cellTextDocuments"`
}
// The parameters sent in an open text document notification
type DidOpenTextDocumentParams struct {
// The document that was opened.
TextDocument TextDocumentItem `json:"textDocument"`
}
// The params sent in a save notebook document notification.
//
// @since 3.17.0
type DidSaveNotebookDocumentParams struct {
// The notebook document that got saved.
NotebookDocument NotebookDocumentIdentifier `json:"notebookDocument"`
}
// The parameters sent in a save text document notification
type DidSaveTextDocumentParams struct {
// The document that was saved.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// Optional the content when saved. Depends on the includeText value
// when the save notification was requested.
Text *string `json:"text,omitempty"`
}
type DocumentColorClientCapabilities struct {
// Whether implementation supports dynamic registration. If this is set to `true`
// the client supports the new `DocumentColorRegistrationOptions` return value
// for the corresponding server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
type DocumentColorOptions struct {
WorkDoneProgressOptions
}
// Parameters for a {@link DocumentColorRequest}.
type DocumentColorParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
WorkDoneProgressParams
PartialResultParams
}
type DocumentColorRegistrationOptions struct {
TextDocumentRegistrationOptions
DocumentColorOptions
StaticRegistrationOptions
}
// Parameters of the document diagnostic request.
//
// @since 3.17.0
type DocumentDiagnosticParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The additional identifier provided during registration.
Identifier string `json:"identifier,omitempty"`
// The result id of a previous response if provided.
PreviousResultID string `json:"previousResultId,omitempty"`
WorkDoneProgressParams
PartialResultParams
}
type DocumentDiagnosticReport = Or_DocumentDiagnosticReport // (alias)
// The document diagnostic report kinds.
//
// @since 3.17.0
type DocumentDiagnosticReportKind string
// A partial result for a document diagnostic report.
//
// @since 3.17.0
type DocumentDiagnosticReportPartialResult struct {
RelatedDocuments map[DocumentURI]interface{} `json:"relatedDocuments"`
}
// A document filter describes a top level text document or
// a notebook cell document.
//
// @since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
type DocumentFilter = Or_DocumentFilter // (alias)
// Client capabilities of a {@link DocumentFormattingRequest}.
type DocumentFormattingClientCapabilities struct {
// Whether formatting supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// Provider options for a {@link DocumentFormattingRequest}.
type DocumentFormattingOptions struct {
WorkDoneProgressOptions
}
// The parameters of a {@link DocumentFormattingRequest}.
type DocumentFormattingParams struct {
// The document to format.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The format options.
Options FormattingOptions `json:"options"`
WorkDoneProgressParams
}
// Registration options for a {@link DocumentFormattingRequest}.
type DocumentFormattingRegistrationOptions struct {
TextDocumentRegistrationOptions
DocumentFormattingOptions
}
// A document highlight is a range inside a text document which deserves
// special attention. Usually a document highlight is visualized by changing
// the background color of its range.
type DocumentHighlight struct {
// The range this highlight applies to.
Range Range `json:"range"`
// The highlight kind, default is {@link DocumentHighlightKind.Text text}.
Kind DocumentHighlightKind `json:"kind,omitempty"`
}
// Client Capabilities for a {@link DocumentHighlightRequest}.
type DocumentHighlightClientCapabilities struct {
// Whether document highlight supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// A document highlight kind.
type DocumentHighlightKind uint32
// Provider options for a {@link DocumentHighlightRequest}.
type DocumentHighlightOptions struct {
WorkDoneProgressOptions
}
// Parameters for a {@link DocumentHighlightRequest}.
type DocumentHighlightParams struct {
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a {@link DocumentHighlightRequest}.
type DocumentHighlightRegistrationOptions struct {
TextDocumentRegistrationOptions
DocumentHighlightOptions
}
// A document link is a range in a text document that links to an internal or external resource, like another
// text document or a web site.
type DocumentLink struct {
// The range this link applies to.
Range Range `json:"range"`
// The uri this link points to. If missing a resolve request is sent later.
Target *URI `json:"target,omitempty"`
// The tooltip text when you hover over this link.
//
// If a tooltip is provided, is will be displayed in a string that includes instructions on how to
// trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,
// user settings, and localization.
//
// @since 3.15.0
Tooltip string `json:"tooltip,omitempty"`
// A data entry field that is preserved on a document link between a
// DocumentLinkRequest and a DocumentLinkResolveRequest.
Data interface{} `json:"data,omitempty"`
}
// The client capabilities of a {@link DocumentLinkRequest}.
type DocumentLinkClientCapabilities struct {
// Whether document link supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// Whether the client supports the `tooltip` property on `DocumentLink`.
//
// @since 3.15.0
TooltipSupport bool `json:"tooltipSupport,omitempty"`
}
// Provider options for a {@link DocumentLinkRequest}.
type DocumentLinkOptions struct {
// Document links have a resolve provider as well.
ResolveProvider bool `json:"resolveProvider,omitempty"`
WorkDoneProgressOptions
}
// The parameters of a {@link DocumentLinkRequest}.
type DocumentLinkParams struct {
// The document to provide document links for.
TextDocument TextDocumentIdentifier `json:"textDocument"`
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a {@link DocumentLinkRequest}.
type DocumentLinkRegistrationOptions struct {
TextDocumentRegistrationOptions
DocumentLinkOptions
}
// Client capabilities of a {@link DocumentOnTypeFormattingRequest}.
type DocumentOnTypeFormattingClientCapabilities struct {
// Whether on type formatting supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// Provider options for a {@link DocumentOnTypeFormattingRequest}.
type DocumentOnTypeFormattingOptions struct {
// A character on which formatting should be triggered, like `{`.
FirstTriggerCharacter string `json:"firstTriggerCharacter"`
// More trigger characters.
MoreTriggerCharacter []string `json:"moreTriggerCharacter,omitempty"`
}
// The parameters of a {@link DocumentOnTypeFormattingRequest}.
type DocumentOnTypeFormattingParams struct {
// The document to format.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The position around which the on type formatting should happen.
// This is not necessarily the exact position where the character denoted
// by the property `ch` got typed.
Position Position `json:"position"`
// The character that has been typed that triggered the formatting
// on type request. That is not necessarily the last character that
// got inserted into the document since the client could auto insert
// characters as well (e.g. like automatic brace completion).
Ch string `json:"ch"`
// The formatting options.
Options FormattingOptions `json:"options"`
}
// Registration options for a {@link DocumentOnTypeFormattingRequest}.
type DocumentOnTypeFormattingRegistrationOptions struct {
TextDocumentRegistrationOptions
DocumentOnTypeFormattingOptions
}
// Client capabilities of a {@link DocumentRangeFormattingRequest}.
type DocumentRangeFormattingClientCapabilities struct {
// Whether range formatting supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// Whether the client supports formatting multiple ranges at once.
//
// @since 3.18.0
// @proposed
RangesSupport bool `json:"rangesSupport,omitempty"`
}
// Provider options for a {@link DocumentRangeFormattingRequest}.
type DocumentRangeFormattingOptions struct {
// Whether the server supports formatting multiple ranges at once.
//
// @since 3.18.0
// @proposed
RangesSupport bool `json:"rangesSupport,omitempty"`
WorkDoneProgressOptions
}
// The parameters of a {@link DocumentRangeFormattingRequest}.
type DocumentRangeFormattingParams struct {
// The document to format.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The range to format
Range Range `json:"range"`
// The format options
Options FormattingOptions `json:"options"`
WorkDoneProgressParams
}
// Registration options for a {@link DocumentRangeFormattingRequest}.
type DocumentRangeFormattingRegistrationOptions struct {
TextDocumentRegistrationOptions
DocumentRangeFormattingOptions
}
// The parameters of a {@link DocumentRangesFormattingRequest}.
//
// @since 3.18.0
// @proposed
type DocumentRangesFormattingParams struct {
// The document to format.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The ranges to format
Ranges []Range `json:"ranges"`
// The format options
Options FormattingOptions `json:"options"`
WorkDoneProgressParams
}
// A document selector is the combination of one or many document filters.
//
// @sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;
//
// The use of a string as a document filter is deprecated @since 3.16.0.
type DocumentSelector = []DocumentFilter // (alias)
// Represents programming constructs like variables, classes, interfaces etc.
// that appear in a document. Document symbols can be hierarchical and they
// have two ranges: one that encloses its definition and one that points to
// its most interesting range, e.g. the range of an identifier.
type DocumentSymbol struct {
// The name of this symbol. Will be displayed in the user interface and therefore must not be
// an empty string or a string only consisting of white spaces.
Name string `json:"name"`
// More detail for this symbol, e.g the signature of a function.
Detail string `json:"detail,omitempty"`
// The kind of this symbol.
Kind SymbolKind `json:"kind"`
// Tags for this document symbol.
//
// @since 3.16.0
Tags []SymbolTag `json:"tags,omitempty"`
// Indicates if this symbol is deprecated.
//
// @deprecated Use tags instead
Deprecated bool `json:"deprecated,omitempty"`
// The range enclosing this symbol not including leading/trailing whitespace but everything else
// like comments. This information is typically used to determine if the clients cursor is
// inside the symbol to reveal in the symbol in the UI.
Range Range `json:"range"`
// The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
// Must be contained by the `range`.
SelectionRange Range `json:"selectionRange"`
// Children of this symbol, e.g. properties of a class.
Children []DocumentSymbol `json:"children,omitempty"`
}
// Client Capabilities for a {@link DocumentSymbolRequest}.
type DocumentSymbolClientCapabilities struct {
// Whether document symbol supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// Specific capabilities for the `SymbolKind` in the
// `textDocument/documentSymbol` request.
SymbolKind *ClientSymbolKindOptions `json:"symbolKind,omitempty"`
// The client supports hierarchical document symbols.
HierarchicalDocumentSymbolSupport bool `json:"hierarchicalDocumentSymbolSupport,omitempty"`
// The client supports tags on `SymbolInformation`. Tags are supported on
// `DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true.
// Clients supporting tags have to handle unknown tags gracefully.
//
// @since 3.16.0
TagSupport *ClientSymbolTagOptions `json:"tagSupport,omitempty"`
// The client supports an additional label presented in the UI when
// registering a document symbol provider.
//
// @since 3.16.0
LabelSupport bool `json:"labelSupport,omitempty"`
}
// Provider options for a {@link DocumentSymbolRequest}.
type DocumentSymbolOptions struct {
// A human-readable string that is shown when multiple outlines trees
// are shown for the same document.
//
// @since 3.16.0
Label string `json:"label,omitempty"`
WorkDoneProgressOptions
}
// Parameters for a {@link DocumentSymbolRequest}.
type DocumentSymbolParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a {@link DocumentSymbolRequest}.
type DocumentSymbolRegistrationOptions struct {
TextDocumentRegistrationOptions
DocumentSymbolOptions
}
// Edit range variant that includes ranges for insert and replace operations.
//
// @since 3.18.0
// @proposed
type EditRangeWithInsertReplace struct {
Insert Range `json:"insert"`
Replace Range `json:"replace"`
}
// Predefined error codes.
type ErrorCodes int32
// The client capabilities of a {@link ExecuteCommandRequest}.
type ExecuteCommandClientCapabilities struct {
// Execute command supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// The server capabilities of a {@link ExecuteCommandRequest}.
type ExecuteCommandOptions struct {
// The commands to be executed on the server
Commands []string `json:"commands"`
WorkDoneProgressOptions
}
// The parameters of a {@link ExecuteCommandRequest}.
type ExecuteCommandParams struct {
// The identifier of the actual command handler.
Command string `json:"command"`
// Arguments that the command should be invoked with.
Arguments []json.RawMessage `json:"arguments,omitempty"`
WorkDoneProgressParams
}
// Registration options for a {@link ExecuteCommandRequest}.
type ExecuteCommandRegistrationOptions struct {
ExecuteCommandOptions
}
type ExecutionSummary struct {
// A strict monotonically increasing value
// indicating the execution order of a cell
// inside a notebook.
ExecutionOrder uint32 `json:"executionOrder"`
// Whether the execution was successful or
// not if known by the client.
Success bool `json:"success,omitempty"`
}
type FailureHandlingKind string
// The file event type
type FileChangeType uint32
// Represents information on a file/folder create.
//
// @since 3.16.0
type FileCreate struct {
// A file:// URI for the location of the file/folder being created.
URI string `json:"uri"`
}
// Represents information on a file/folder delete.
//
// @since 3.16.0
type FileDelete struct {
// A file:// URI for the location of the file/folder being deleted.
URI string `json:"uri"`
}
// An event describing a file change.
type FileEvent struct {
// The file's uri.
URI DocumentURI `json:"uri"`
// The change type.
Type FileChangeType `json:"type"`
}
// Capabilities relating to events from file operations by the user in the client.
//
// These events do not come from the file system, they come from user operations
// like renaming a file in the UI.
//
// @since 3.16.0
type FileOperationClientCapabilities struct {
// Whether the client supports dynamic registration for file requests/notifications.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client has support for sending didCreateFiles notifications.
DidCreate bool `json:"didCreate,omitempty"`
// The client has support for sending willCreateFiles requests.
WillCreate bool `json:"willCreate,omitempty"`
// The client has support for sending didRenameFiles notifications.
DidRename bool `json:"didRename,omitempty"`
// The client has support for sending willRenameFiles requests.
WillRename bool `json:"willRename,omitempty"`
// The client has support for sending didDeleteFiles notifications.
DidDelete bool `json:"didDelete,omitempty"`
// The client has support for sending willDeleteFiles requests.
WillDelete bool `json:"willDelete,omitempty"`
}
// A filter to describe in which file operation requests or notifications
// the server is interested in receiving.
//
// @since 3.16.0
type FileOperationFilter struct {
// A Uri scheme like `file` or `untitled`.
Scheme string `json:"scheme,omitempty"`
// The actual file operation pattern.
Pattern FileOperationPattern `json:"pattern"`
}
// Options for notifications/requests for user operations on files.
//
// @since 3.16.0
type FileOperationOptions struct {
// The server is interested in receiving didCreateFiles notifications.
DidCreate *FileOperationRegistrationOptions `json:"didCreate,omitempty"`
// The server is interested in receiving willCreateFiles requests.
WillCreate *FileOperationRegistrationOptions `json:"willCreate,omitempty"`
// The server is interested in receiving didRenameFiles notifications.
DidRename *FileOperationRegistrationOptions `json:"didRename,omitempty"`
// The server is interested in receiving willRenameFiles requests.
WillRename *FileOperationRegistrationOptions `json:"willRename,omitempty"`
// The server is interested in receiving didDeleteFiles file notifications.
DidDelete *FileOperationRegistrationOptions `json:"didDelete,omitempty"`
// The server is interested in receiving willDeleteFiles file requests.
WillDelete *FileOperationRegistrationOptions `json:"willDelete,omitempty"`
}
// A pattern to describe in which file operation requests or notifications
// the server is interested in receiving.
//
// @since 3.16.0
type FileOperationPattern struct {
// The glob pattern to match. Glob patterns can have the following syntax:
//
// - `*` to match one or more characters in a path segment
// - `?` to match on one character in a path segment
// - `**` to match any number of path segments, including none
// - `{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
// - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
// - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
Glob string `json:"glob"`
// Whether to match files or folders with this pattern.
//
// Matches both if undefined.
Matches *FileOperationPatternKind `json:"matches,omitempty"`
// Additional options used during matching.
Options *FileOperationPatternOptions `json:"options,omitempty"`
}
// A pattern kind describing if a glob pattern matches a file a folder or
// both.
//
// @since 3.16.0
type FileOperationPatternKind string
// Matching options for the file operation pattern.
//
// @since 3.16.0
type FileOperationPatternOptions struct {
// The pattern should be matched ignoring casing.
IgnoreCase bool `json:"ignoreCase,omitempty"`
}
// The options to register for file operations.
//
// @since 3.16.0
type FileOperationRegistrationOptions struct {
// The actual filters.
Filters []FileOperationFilter `json:"filters"`
}
// Represents information on a file/folder rename.
//
// @since 3.16.0
type FileRename struct {
// A file:// URI for the original location of the file/folder being renamed.
OldURI string `json:"oldUri"`
// A file:// URI for the new location of the file/folder being renamed.
NewURI string `json:"newUri"`
}
type FileSystemWatcher struct {
// The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.
//
// @since 3.17.0 support for relative patterns.
GlobPattern GlobPattern `json:"globPattern"`
// The kind of events of interest. If omitted it defaults
// to WatchKind.Create | WatchKind.Change | WatchKind.Delete
// which is 7.
Kind *WatchKind `json:"kind,omitempty"`
}
// Represents a folding range. To be valid, start and end line must be bigger than zero and smaller
// than the number of lines in the document. Clients are free to ignore invalid ranges.
type FoldingRange struct {
// The zero-based start line of the range to fold. The folded area starts after the line's last character.
// To be valid, the end must be zero or larger and smaller than the number of lines in the document.
StartLine uint32 `json:"startLine"`
// The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
StartCharacter uint32 `json:"startCharacter,omitempty"`
// The zero-based end line of the range to fold. The folded area ends with the line's last character.
// To be valid, the end must be zero or larger and smaller than the number of lines in the document.
EndLine uint32 `json:"endLine"`
// The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
EndCharacter uint32 `json:"endCharacter,omitempty"`
// Describes the kind of the folding range such as `comment' or 'region'. The kind
// is used to categorize folding ranges and used by commands like 'Fold all comments'.
// See {@link FoldingRangeKind} for an enumeration of standardized kinds.
Kind string `json:"kind,omitempty"`
// The text that the client should show when the specified range is
// collapsed. If not defined or not supported by the client, a default
// will be chosen by the client.
//
// @since 3.17.0
CollapsedText string `json:"collapsedText,omitempty"`
}
type FoldingRangeClientCapabilities struct {
// Whether implementation supports dynamic registration for folding range
// providers. If this is set to `true` the client supports the new
// `FoldingRangeRegistrationOptions` return value for the corresponding
// server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The maximum number of folding ranges that the client prefers to receive
// per document. The value serves as a hint, servers are free to follow the
// limit.
RangeLimit uint32 `json:"rangeLimit,omitempty"`
// If set, the client signals that it only supports folding complete lines.
// If set, client will ignore specified `startCharacter` and `endCharacter`
// properties in a FoldingRange.
LineFoldingOnly bool `json:"lineFoldingOnly,omitempty"`
// Specific options for the folding range kind.
//
// @since 3.17.0
FoldingRangeKind *ClientFoldingRangeKindOptions `json:"foldingRangeKind,omitempty"`
// Specific options for the folding range.
//
// @since 3.17.0
FoldingRange *ClientFoldingRangeOptions `json:"foldingRange,omitempty"`
}
// A set of predefined range kinds.
type FoldingRangeKind string
type FoldingRangeOptions struct {
WorkDoneProgressOptions
}
// Parameters for a {@link FoldingRangeRequest}.
type FoldingRangeParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
WorkDoneProgressParams
PartialResultParams
}
type FoldingRangeRegistrationOptions struct {
TextDocumentRegistrationOptions
FoldingRangeOptions
StaticRegistrationOptions
}
// Client workspace capabilities specific to folding ranges
//
// @since 3.18.0
// @proposed
type FoldingRangeWorkspaceClientCapabilities struct {
// Whether the client implementation supports a refresh request sent from the
// server to the client.
//
// Note that this event is global and will force the client to refresh all
// folding ranges currently shown. It should be used with absolute care and is
// useful for situation where a server for example detects a project wide
// change that requires such a calculation.
//
// @since 3.18.0
// @proposed
RefreshSupport bool `json:"refreshSupport,omitempty"`
}
// Value-object describing what options formatting should use.
type FormattingOptions struct {
// Size of a tab in spaces.
TabSize uint32 `json:"tabSize"`
// Prefer spaces over tabs.
InsertSpaces bool `json:"insertSpaces"`
// Trim trailing whitespace on a line.
//
// @since 3.15.0
TrimTrailingWhitespace bool `json:"trimTrailingWhitespace,omitempty"`
// Insert a newline character at the end of the file if one does not exist.
//
// @since 3.15.0
InsertFinalNewline bool `json:"insertFinalNewline,omitempty"`
// Trim all newlines after the final newline at the end of the file.
//
// @since 3.15.0
TrimFinalNewlines bool `json:"trimFinalNewlines,omitempty"`
}
// A diagnostic report with a full set of problems.
//
// @since 3.17.0
type FullDocumentDiagnosticReport struct {
// A full document diagnostic report.
Kind string `json:"kind"`
// An optional result id. If provided it will
// be sent on the next diagnostic request for the
// same document.
ResultID string `json:"resultId,omitempty"`
// The actual items.
Items []Diagnostic `json:"items"`
}
// General client capabilities.
//
// @since 3.16.0
type GeneralClientCapabilities struct {
// Client capability that signals how the client
// handles stale requests (e.g. a request
// for which the client will not process the response
// anymore since the information is outdated).
//
// @since 3.17.0
StaleRequestSupport *StaleRequestSupportOptions `json:"staleRequestSupport,omitempty"`
// Client capabilities specific to regular expressions.
//
// @since 3.16.0
RegularExpressions *RegularExpressionsClientCapabilities `json:"regularExpressions,omitempty"`
// Client capabilities specific to the client's markdown parser.
//
// @since 3.16.0
Markdown *MarkdownClientCapabilities `json:"markdown,omitempty"`
// The position encodings supported by the client. Client and server
// have to agree on the same position encoding to ensure that offsets
// (e.g. character position in a line) are interpreted the same on both
// sides.
//
// To keep the protocol backwards compatible the following applies: if
// the value 'utf-16' is missing from the array of position encodings
// servers can assume that the client supports UTF-16. UTF-16 is
// therefore a mandatory encoding.
//
// If omitted it defaults to ['utf-16'].
//
// Implementation considerations: since the conversion from one encoding
// into another requires the content of the file / line the conversion
// is best done where the file is read which is usually on the server
// side.
//
// @since 3.17.0
PositionEncodings []PositionEncodingKind `json:"positionEncodings,omitempty"`
}
// The glob pattern. Either a string pattern or a relative pattern.
//
// @since 3.17.0
type GlobPattern = Or_GlobPattern // (alias)
// The result of a hover request.
type Hover struct {
// The hover's content
Contents MarkupContent `json:"contents"`
// An optional range inside the text document that is used to
// visualize the hover, e.g. by changing the background color.
Range Range `json:"range,omitempty"`
}
type HoverClientCapabilities struct {
// Whether hover supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// Client supports the following content formats for the content
// property. The order describes the preferred format of the client.
ContentFormat []MarkupKind `json:"contentFormat,omitempty"`
}
// Hover options.
type HoverOptions struct {
WorkDoneProgressOptions
}
// Parameters for a {@link HoverRequest}.
type HoverParams struct {
TextDocumentPositionParams
WorkDoneProgressParams
}
// Registration options for a {@link HoverRequest}.
type HoverRegistrationOptions struct {
TextDocumentRegistrationOptions
HoverOptions
}
// @since 3.6.0
type ImplementationClientCapabilities struct {
// Whether implementation supports dynamic registration. If this is set to `true`
// the client supports the new `ImplementationRegistrationOptions` return value
// for the corresponding server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client supports additional metadata in the form of definition links.
//
// @since 3.14.0
LinkSupport bool `json:"linkSupport,omitempty"`
}
type ImplementationOptions struct {
WorkDoneProgressOptions
}
type ImplementationParams struct {
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
type ImplementationRegistrationOptions struct {
TextDocumentRegistrationOptions
ImplementationOptions
StaticRegistrationOptions
}
// The data type of the ResponseError if the
// initialize request fails.
type InitializeError struct {
// Indicates whether the client execute the following retry logic:
// (1) show the message provided by the ResponseError to the user
// (2) user selects retry or cancel
// (3) if user selected retry the initialize method is sent again.
Retry bool `json:"retry"`
}
type InitializeParams struct {
XInitializeParams
WorkspaceFoldersInitializeParams
}
// The result returned from an initialize request.
type InitializeResult struct {
// The capabilities the language server provides.
Capabilities ServerCapabilities `json:"capabilities"`
// Information about the server.
//
// @since 3.15.0
ServerInfo *ServerInfo `json:"serverInfo,omitempty"`
}
type InitializedParams struct {
}
// Inlay hint information.
//
// @since 3.17.0
type InlayHint struct {
// The position of this hint.
Position Position `json:"position"`
// The label of this hint. A human readable string or an array of
// InlayHintLabelPart label parts.
//
// *Note* that neither the string nor the label part can be empty.
Label []InlayHintLabelPart `json:"label"`
// The kind of this hint. Can be omitted in which case the client
// should fall back to a reasonable default.
Kind InlayHintKind `json:"kind,omitempty"`
// Optional text edits that are performed when accepting this inlay hint.
//
// *Note* that edits are expected to change the document so that the inlay
// hint (or its nearest variant) is now part of the document and the inlay
// hint itself is now obsolete.
TextEdits []TextEdit `json:"textEdits,omitempty"`
// The tooltip text when you hover over this item.
Tooltip *OrPTooltip_textDocument_inlayHint `json:"tooltip,omitempty"`
// Render padding before the hint.
//
// Note: Padding should use the editor's background color, not the
// background color of the hint itself. That means padding can be used
// to visually align/separate an inlay hint.
PaddingLeft bool `json:"paddingLeft,omitempty"`
// Render padding after the hint.
//
// Note: Padding should use the editor's background color, not the
// background color of the hint itself. That means padding can be used
// to visually align/separate an inlay hint.
PaddingRight bool `json:"paddingRight,omitempty"`
// A data entry field that is preserved on an inlay hint between
// a `textDocument/inlayHint` and a `inlayHint/resolve` request.
Data interface{} `json:"data,omitempty"`
}
// Inlay hint client capabilities.
//
// @since 3.17.0
type InlayHintClientCapabilities struct {
// Whether inlay hints support dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// Indicates which properties a client can resolve lazily on an inlay
// hint.
ResolveSupport *ClientInlayHintResolveOptions `json:"resolveSupport,omitempty"`
}
// Inlay hint kinds.
//
// @since 3.17.0
type InlayHintKind uint32
// An inlay hint label part allows for interactive and composite labels
// of inlay hints.
//
// @since 3.17.0
type InlayHintLabelPart struct {
// The value of this label part.
Value string `json:"value"`
// The tooltip text when you hover over this label part. Depending on
// the client capability `inlayHint.resolveSupport` clients might resolve
// this property late using the resolve request.
Tooltip *OrPTooltipPLabel `json:"tooltip,omitempty"`
// An optional source code location that represents this
// label part.
//
// The editor will use this location for the hover and for code navigation
// features: This part will become a clickable link that resolves to the
// definition of the symbol at the given location (not necessarily the
// location itself), it shows the hover that shows at the given location,
// and it shows a context menu with further code navigation commands.
//
// Depending on the client capability `inlayHint.resolveSupport` clients
// might resolve this property late using the resolve request.
Location *Location `json:"location,omitempty"`
// An optional command for this label part.
//
// Depending on the client capability `inlayHint.resolveSupport` clients
// might resolve this property late using the resolve request.
Command *Command `json:"command,omitempty"`
}
// Inlay hint options used during static registration.
//
// @since 3.17.0
type InlayHintOptions struct {
// The server provides support to resolve additional
// information for an inlay hint item.
ResolveProvider bool `json:"resolveProvider,omitempty"`
WorkDoneProgressOptions
}
// A parameter literal used in inlay hint requests.
//
// @since 3.17.0
type InlayHintParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The document range for which inlay hints should be computed.
Range Range `json:"range"`
WorkDoneProgressParams
}
// Inlay hint options used during static or dynamic registration.
//
// @since 3.17.0
type InlayHintRegistrationOptions struct {
InlayHintOptions
TextDocumentRegistrationOptions
StaticRegistrationOptions
}
// Client workspace capabilities specific to inlay hints.
//
// @since 3.17.0
type InlayHintWorkspaceClientCapabilities struct {
// Whether the client implementation supports a refresh request sent from
// the server to the client.
//
// Note that this event is global and will force the client to refresh all
// inlay hints currently shown. It should be used with absolute care and
// is useful for situation where a server for example detects a project wide
// change that requires such a calculation.
RefreshSupport bool `json:"refreshSupport,omitempty"`
}
// Client capabilities specific to inline completions.
//
// @since 3.18.0
// @proposed
type InlineCompletionClientCapabilities struct {
// Whether implementation supports dynamic registration for inline completion providers.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// Provides information about the context in which an inline completion was requested.
//
// @since 3.18.0
// @proposed
type InlineCompletionContext struct {
// Describes how the inline completion was triggered.
TriggerKind InlineCompletionTriggerKind `json:"triggerKind"`
// Provides information about the currently selected item in the autocomplete widget if it is visible.
SelectedCompletionInfo *SelectedCompletionInfo `json:"selectedCompletionInfo,omitempty"`
}
// An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
//
// @since 3.18.0
// @proposed
type InlineCompletionItem struct {
// The text to replace the range with. Must be set.
InsertText Or_InlineCompletionItem_insertText `json:"insertText"`
// A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used.
FilterText string `json:"filterText,omitempty"`
// The range to replace. Must begin and end on the same line.
Range *Range `json:"range,omitempty"`
// An optional {@link Command} that is executed *after* inserting this completion.
Command *Command `json:"command,omitempty"`
}
// Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.
//
// @since 3.18.0
// @proposed
type InlineCompletionList struct {
// The inline completion items
Items []InlineCompletionItem `json:"items"`
}
// Inline completion options used during static registration.
//
// @since 3.18.0
// @proposed
type InlineCompletionOptions struct {
WorkDoneProgressOptions
}
// A parameter literal used in inline completion requests.
//
// @since 3.18.0
// @proposed
type InlineCompletionParams struct {
// Additional information about the context in which inline completions were
// requested.
Context InlineCompletionContext `json:"context"`
TextDocumentPositionParams
WorkDoneProgressParams
}
// Inline completion options used during static or dynamic registration.
//
// @since 3.18.0
// @proposed
type InlineCompletionRegistrationOptions struct {
InlineCompletionOptions
TextDocumentRegistrationOptions
StaticRegistrationOptions
}
// Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
//
// @since 3.18.0
// @proposed
type InlineCompletionTriggerKind uint32
// Inline value information can be provided by different means:
//
// - directly as a text value (class InlineValueText).
// - as a name to use for a variable lookup (class InlineValueVariableLookup)
// - as an evaluatable expression (class InlineValueEvaluatableExpression)
//
// The InlineValue types combines all inline value types into one type.
//
// @since 3.17.0
type InlineValue = Or_InlineValue // (alias)
// Client capabilities specific to inline values.
//
// @since 3.17.0
type InlineValueClientCapabilities struct {
// Whether implementation supports dynamic registration for inline value providers.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// @since 3.17.0
type InlineValueContext struct {
// The stack frame (as a DAP Id) where the execution has stopped.
FrameID int32 `json:"frameId"`
// The document range where execution has stopped.
// Typically the end position of the range denotes the line where the inline values are shown.
StoppedLocation Range `json:"stoppedLocation"`
}
// Provide an inline value through an expression evaluation.
// If only a range is specified, the expression will be extracted from the underlying document.
// An optional expression can be used to override the extracted expression.
//
// @since 3.17.0
type InlineValueEvaluatableExpression struct {
// The document range for which the inline value applies.
// The range is used to extract the evaluatable expression from the underlying document.
Range Range `json:"range"`
// If specified the expression overrides the extracted expression.
Expression string `json:"expression,omitempty"`
}
// Inline value options used during static registration.
//
// @since 3.17.0
type InlineValueOptions struct {
WorkDoneProgressOptions
}
// A parameter literal used in inline value requests.
//
// @since 3.17.0
type InlineValueParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The document range for which inline values should be computed.
Range Range `json:"range"`
// Additional information about the context in which inline values were
// requested.
Context InlineValueContext `json:"context"`
WorkDoneProgressParams
}
// Inline value options used during static or dynamic registration.
//
// @since 3.17.0
type InlineValueRegistrationOptions struct {
InlineValueOptions
TextDocumentRegistrationOptions
StaticRegistrationOptions
}
// Provide inline value as text.
//
// @since 3.17.0
type InlineValueText struct {
// The document range for which the inline value applies.
Range Range `json:"range"`
// The text of the inline value.
Text string `json:"text"`
}
// Provide inline value through a variable lookup.
// If only a range is specified, the variable name will be extracted from the underlying document.
// An optional variable name can be used to override the extracted name.
//
// @since 3.17.0
type InlineValueVariableLookup struct {
// The document range for which the inline value applies.
// The range is used to extract the variable name from the underlying document.
Range Range `json:"range"`
// If specified the name of the variable to look up.
VariableName string `json:"variableName,omitempty"`
// How to perform the lookup.
CaseSensitiveLookup bool `json:"caseSensitiveLookup"`
}
// Client workspace capabilities specific to inline values.
//
// @since 3.17.0
type InlineValueWorkspaceClientCapabilities struct {
// Whether the client implementation supports a refresh request sent from the
// server to the client.
//
// Note that this event is global and will force the client to refresh all
// inline values currently shown. It should be used with absolute care and is
// useful for situation where a server for example detects a project wide
// change that requires such a calculation.
RefreshSupport bool `json:"refreshSupport,omitempty"`
}
// A special text edit to provide an insert and a replace operation.
//
// @since 3.16.0
type InsertReplaceEdit struct {
// The string to be inserted.
NewText string `json:"newText"`
// The range if the insert is requested
Insert Range `json:"insert"`
// The range if the replace is requested.
Replace Range `json:"replace"`
}
// Defines whether the insert text in a completion item should be interpreted as
// plain text or a snippet.
type InsertTextFormat uint32
// How whitespace and indentation is handled during completion
// item insertion.
//
// @since 3.16.0
type InsertTextMode uint32
type LSPAny = interface{}
// LSP arrays.
// @since 3.17.0
type LSPArray = []interface{} // (alias)
type LSPErrorCodes int32
// LSP object definition.
// @since 3.17.0
type LSPObject = map[string]LSPAny // (alias)
// Client capabilities for the linked editing range request.
//
// @since 3.16.0
type LinkedEditingRangeClientCapabilities struct {
// Whether implementation supports dynamic registration. If this is set to `true`
// the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
// return value for the corresponding server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
type LinkedEditingRangeOptions struct {
WorkDoneProgressOptions
}
type LinkedEditingRangeParams struct {
TextDocumentPositionParams
WorkDoneProgressParams
}
type LinkedEditingRangeRegistrationOptions struct {
TextDocumentRegistrationOptions
LinkedEditingRangeOptions
StaticRegistrationOptions
}
// The result of a linked editing range request.
//
// @since 3.16.0
type LinkedEditingRanges struct {
// A list of ranges that can be edited together. The ranges must have
// identical length and contain identical text content. The ranges cannot overlap.
Ranges []Range `json:"ranges"`
// An optional word pattern (regular expression) that describes valid contents for
// the given ranges. If no pattern is provided, the client configuration's word
// pattern will be used.
WordPattern string `json:"wordPattern,omitempty"`
}
// created for Literal (Lit_ClientSemanticTokensRequestOptions_range_Item1)
type Lit_ClientSemanticTokensRequestOptions_range_Item1 struct {
}
// Represents a location inside a resource, such as a line
// inside a text file.
type Location struct {
URI DocumentURI `json:"uri"`
Range Range `json:"range"`
}
// Represents the connection of two locations. Provides additional metadata over normal {@link Location locations},
// including an origin range.
type LocationLink struct {
// Span of the origin of this link.
//
// Used as the underlined span for mouse interaction. Defaults to the word range at
// the definition position.
OriginSelectionRange *Range `json:"originSelectionRange,omitempty"`
// The target resource identifier of this link.
TargetURI DocumentURI `json:"targetUri"`
// The full target range of this link. If the target for example is a symbol then target range is the
// range enclosing this symbol not including leading/trailing whitespace but everything else
// like comments. This information is typically used to highlight the range in the editor.
TargetRange Range `json:"targetRange"`
// The range that should be selected and revealed when this link is being followed, e.g the name of a function.
// Must be contained by the `targetRange`. See also `DocumentSymbol#range`
TargetSelectionRange Range `json:"targetSelectionRange"`
}
// Location with only uri and does not include range.
//
// @since 3.18.0
// @proposed
type LocationUriOnly struct {
URI DocumentURI `json:"uri"`
}
// The log message parameters.
type LogMessageParams struct {
// The message type. See {@link MessageType}
Type MessageType `json:"type"`
// The actual message.
Message string `json:"message"`
}
type LogTraceParams struct {
Message string `json:"message"`
Verbose string `json:"verbose,omitempty"`
}
// Client capabilities specific to the used markdown parser.
//
// @since 3.16.0
type MarkdownClientCapabilities struct {
// The name of the parser.
Parser string `json:"parser"`
// The version of the parser.
Version string `json:"version,omitempty"`
// A list of HTML tags that the client allows / supports in
// Markdown.
//
// @since 3.17.0
AllowedTags []string `json:"allowedTags,omitempty"`
}
// MarkedString can be used to render human readable text. It is either a markdown string
// or a code-block that provides a language and a code snippet. The language identifier
// is semantically equal to the optional language identifier in fenced code blocks in GitHub
// issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
//
// The pair of a language and a value is an equivalent to markdown:
// ```${language}
// ${value}
// ```
//
// Note that markdown strings will be sanitized - that means html will be escaped.
// @deprecated use MarkupContent instead.
type MarkedString = Or_MarkedString // (alias)
// @since 3.18.0
// @proposed
// @deprecated use MarkupContent instead.
type MarkedStringWithLanguage struct {
Language string `json:"language"`
Value string `json:"value"`
}
// A `MarkupContent` literal represents a string value which content is interpreted base on its
// kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
//
// If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.
// See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
//
// Here is an example how such a string can be constructed using JavaScript / TypeScript:
// ```ts
//
// let markdown: MarkdownContent = {
// kind: MarkupKind.Markdown,
// value: [
// '# Header',
// 'Some text',
// '```typescript',
// 'someCode();',
// '```'
// ].join('\n')
// };
//
// ```
//
// *Please Note* that clients might sanitize the return markdown. A client could decide to
// remove HTML from the markdown to avoid script execution.
type MarkupContent struct {
// The type of the Markup
Kind MarkupKind `json:"kind"`
// The content itself
Value string `json:"value"`
}
// Describes the content type that a client supports in various
// result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
//
// Please note that `MarkupKinds` must not start with a `$`. This kinds
// are reserved for internal usage.
type MarkupKind string
type MessageActionItem struct {
// A short title like 'Retry', 'Open Log' etc.
Title string `json:"title"`
}
// The message type
type MessageType uint32
// Moniker definition to match LSIF 0.5 moniker definition.
//
// @since 3.16.0
type Moniker struct {
// The scheme of the moniker. For example tsc or .Net
Scheme string `json:"scheme"`
// The identifier of the moniker. The value is opaque in LSIF however
// schema owners are allowed to define the structure if they want.
Identifier string `json:"identifier"`
// The scope in which the moniker is unique
Unique UniquenessLevel `json:"unique"`
// The moniker kind if known.
Kind *MonikerKind `json:"kind,omitempty"`
}
// Client capabilities specific to the moniker request.
//
// @since 3.16.0
type MonikerClientCapabilities struct {
// Whether moniker supports dynamic registration. If this is set to `true`
// the client supports the new `MonikerRegistrationOptions` return value
// for the corresponding server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// The moniker kind.
//
// @since 3.16.0
type MonikerKind string
type MonikerOptions struct {
WorkDoneProgressOptions
}
type MonikerParams struct {
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
type MonikerRegistrationOptions struct {
TextDocumentRegistrationOptions
MonikerOptions
}
// A notebook cell.
//
// A cell's document URI must be unique across ALL notebook
// cells and can therefore be used to uniquely identify a
// notebook cell or the cell's text document.
//
// @since 3.17.0
type NotebookCell struct {
// The cell's kind
Kind NotebookCellKind `json:"kind"`
// The URI of the cell's text document
// content.
Document DocumentURI `json:"document"`
// Additional metadata stored with the cell.
//
// Note: should always be an object literal (e.g. LSPObject)
Metadata *LSPObject `json:"metadata,omitempty"`
// Additional execution summary information
// if supported by the client.
ExecutionSummary *ExecutionSummary `json:"executionSummary,omitempty"`
}
// A change describing how to move a `NotebookCell`
// array from state S to S'.
//
// @since 3.17.0
type NotebookCellArrayChange struct {
// The start oftest of the cell that changed.
Start uint32 `json:"start"`
// The deleted cells
DeleteCount uint32 `json:"deleteCount"`
// The new cells, if any
Cells []NotebookCell `json:"cells,omitempty"`
}
// A notebook cell kind.
//
// @since 3.17.0
type NotebookCellKind uint32
// @since 3.18.0
// @proposed
type NotebookCellLanguage struct {
Language string `json:"language"`
}
// A notebook cell text document filter denotes a cell text
// document by different properties.
//
// @since 3.17.0
type NotebookCellTextDocumentFilter struct {
// A filter that matches against the notebook
// containing the notebook cell. If a string
// value is provided it matches against the
// notebook type. '*' matches every notebook.
Notebook Or_NotebookCellTextDocumentFilter_notebook `json:"notebook"`
// A language id like `python`.
//
// Will be matched against the language id of the
// notebook cell document. '*' matches every language.
Language string `json:"language,omitempty"`
}
// A notebook document.
//
// @since 3.17.0
type NotebookDocument struct {
// The notebook document's uri.
URI URI `json:"uri"`
// The type of the notebook.
NotebookType string `json:"notebookType"`
// The version number of this document (it will increase after each
// change, including undo/redo).
Version int32 `json:"version"`
// Additional metadata stored with the notebook
// document.
//
// Note: should always be an object literal (e.g. LSPObject)
Metadata *LSPObject `json:"metadata,omitempty"`
// The cells of a notebook.
Cells []NotebookCell `json:"cells"`
}
// Structural changes to cells in a notebook document.
//
// @since 3.18.0
// @proposed
type NotebookDocumentCellChangeStructure struct {
// The change to the cell array.
Array NotebookCellArrayChange `json:"array"`
// Additional opened cell text documents.
DidOpen []TextDocumentItem `json:"didOpen,omitempty"`
// Additional closed cell text documents.
DidClose []TextDocumentIdentifier `json:"didClose,omitempty"`
}
// Cell changes to a notebook document.
//
// @since 3.18.0
// @proposed
type NotebookDocumentCellChanges struct {
// Changes to the cell structure to add or
// remove cells.
Structure *NotebookDocumentCellChangeStructure `json:"structure,omitempty"`
// Changes to notebook cells properties like its
// kind, execution summary or metadata.
Data []NotebookCell `json:"data,omitempty"`
// Changes to the text content of notebook cells.
TextContent []NotebookDocumentCellContentChanges `json:"textContent,omitempty"`
}
// Content changes to a cell in a notebook document.
//
// @since 3.18.0
// @proposed
type NotebookDocumentCellContentChanges struct {
Document VersionedTextDocumentIdentifier `json:"document"`
Changes []TextDocumentContentChangeEvent `json:"changes"`
}
// A change event for a notebook document.
//
// @since 3.17.0
type NotebookDocumentChangeEvent struct {
// The changed meta data if any.
//
// Note: should always be an object literal (e.g. LSPObject)
Metadata *LSPObject `json:"metadata,omitempty"`
// Changes to cells
Cells *NotebookDocumentCellChanges `json:"cells,omitempty"`
}
// Capabilities specific to the notebook document support.
//
// @since 3.17.0
type NotebookDocumentClientCapabilities struct {
// Capabilities specific to notebook document synchronization
//
// @since 3.17.0
Synchronization NotebookDocumentSyncClientCapabilities `json:"synchronization"`
}
// A notebook document filter denotes a notebook document by
// different properties. The properties will be match
// against the notebook's URI (same as with documents)
//
// @since 3.17.0
type NotebookDocumentFilter = Or_NotebookDocumentFilter // (alias)
// A notebook document filter where `notebookType` is required field.
//
// @since 3.18.0
// @proposed
type NotebookDocumentFilterNotebookType struct {
// The type of the enclosing notebook.
NotebookType string `json:"notebookType"`
// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
Scheme string `json:"scheme,omitempty"`
// A glob pattern.
Pattern string `json:"pattern,omitempty"`
}
// A notebook document filter where `pattern` is required field.
//
// @since 3.18.0
// @proposed
type NotebookDocumentFilterPattern struct {
// The type of the enclosing notebook.
NotebookType string `json:"notebookType,omitempty"`
// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
Scheme string `json:"scheme,omitempty"`
// A glob pattern.
Pattern string `json:"pattern"`
}
// A notebook document filter where `scheme` is required field.
//
// @since 3.18.0
// @proposed
type NotebookDocumentFilterScheme struct {
// The type of the enclosing notebook.
NotebookType string `json:"notebookType,omitempty"`
// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
Scheme string `json:"scheme"`
// A glob pattern.
Pattern string `json:"pattern,omitempty"`
}
// @since 3.18.0
// @proposed
type NotebookDocumentFilterWithCells struct {
// The notebook to be synced If a string
// value is provided it matches against the
// notebook type. '*' matches every notebook.
Notebook *Or_NotebookDocumentFilterWithCells_notebook `json:"notebook,omitempty"`
// The cells of the matching notebook to be synced.
Cells []NotebookCellLanguage `json:"cells"`
}
// @since 3.18.0
// @proposed
type NotebookDocumentFilterWithNotebook struct {
// The notebook to be synced If a string
// value is provided it matches against the
// notebook type. '*' matches every notebook.
Notebook Or_NotebookDocumentFilterWithNotebook_notebook `json:"notebook"`
// The cells of the matching notebook to be synced.
Cells []NotebookCellLanguage `json:"cells,omitempty"`
}
// A literal to identify a notebook document in the client.
//
// @since 3.17.0
type NotebookDocumentIdentifier struct {
// The notebook document's uri.
URI URI `json:"uri"`
}
// Notebook specific client capabilities.
//
// @since 3.17.0
type NotebookDocumentSyncClientCapabilities struct {
// Whether implementation supports dynamic registration. If this is
// set to `true` the client supports the new
// `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
// return value for the corresponding server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client supports sending execution summary data per cell.
ExecutionSummarySupport bool `json:"executionSummarySupport,omitempty"`
}
// Options specific to a notebook plus its cells
// to be synced to the server.
//
// If a selector provides a notebook document
// filter but no cell selector all cells of a
// matching notebook document will be synced.
//
// If a selector provides no notebook document
// filter but only a cell selector all notebook
// document that contain at least one matching
// cell will be synced.
//
// @since 3.17.0
type NotebookDocumentSyncOptions struct {
// The notebooks to be synced
NotebookSelector []Or_NotebookDocumentSyncOptions_notebookSelector_Elem `json:"notebookSelector"`
// Whether save notification should be forwarded to
// the server. Will only be honored if mode === `notebook`.
Save bool `json:"save,omitempty"`
}
// Registration options specific to a notebook.
//
// @since 3.17.0
type NotebookDocumentSyncRegistrationOptions struct {
NotebookDocumentSyncOptions
StaticRegistrationOptions
}
// A text document identifier to optionally denote a specific version of a text document.
type OptionalVersionedTextDocumentIdentifier struct {
// The version number of this document. If a versioned text document identifier
// is sent from the server to the client and the file is not open in the editor
// (the server has not received an open notification before) the server can send
// `null` to indicate that the version is unknown and the content on disk is the
// truth (as specified with document content ownership).
Version int32 `json:"version"`
TextDocumentIdentifier
}
// created for Or [Location LocationUriOnly]
type OrPLocation_workspace_symbol struct {
Value interface{} `json:"value"`
}
// created for Or [[]string string]
type OrPSection_workspace_didChangeConfiguration struct {
Value interface{} `json:"value"`
}
// created for Or [MarkupContent string]
type OrPTooltipPLabel struct {
Value interface{} `json:"value"`
}
// created for Or [MarkupContent string]
type OrPTooltip_textDocument_inlayHint struct {
Value interface{} `json:"value"`
}
// created for Or [int32 string]
type Or_CancelParams_id struct {
Value interface{} `json:"value"`
}
// created for Or [ClientSemanticTokensRequestFullDelta bool]
type Or_ClientSemanticTokensRequestOptions_full struct {
Value interface{} `json:"value"`
}
// created for Or [Lit_ClientSemanticTokensRequestOptions_range_Item1 bool]
type Or_ClientSemanticTokensRequestOptions_range struct {
Value interface{} `json:"value"`
}
// created for Or [EditRangeWithInsertReplace Range]
type Or_CompletionItemDefaults_editRange struct {
Value interface{} `json:"value"`
}
// created for Or [MarkupContent string]
type Or_CompletionItem_documentation struct {
Value interface{} `json:"value"`
}
// created for Or [InsertReplaceEdit TextEdit]
type Or_CompletionItem_textEdit struct {
Value interface{} `json:"value"`
}
// created for Or [Location []Location]
type Or_Definition struct {
Value interface{} `json:"value"`
}
// created for Or [int32 string]
type Or_Diagnostic_code struct {
Value interface{} `json:"value"`
}
// created for Or [RelatedFullDocumentDiagnosticReport RelatedUnchangedDocumentDiagnosticReport]
type Or_DocumentDiagnosticReport struct {
Value interface{} `json:"value"`
}
// created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport]
type Or_DocumentDiagnosticReportPartialResult_relatedDocuments_Value struct {
Value interface{} `json:"value"`
}
// created for Or [NotebookCellTextDocumentFilter TextDocumentFilter]
type Or_DocumentFilter struct {
Value interface{} `json:"value"`
}
// created for Or [Pattern RelativePattern]
type Or_GlobPattern struct {
Value interface{} `json:"value"`
}
// created for Or [MarkedString MarkupContent []MarkedString]
type Or_Hover_contents struct {
Value interface{} `json:"value"`
}
// created for Or [[]InlayHintLabelPart string]
type Or_InlayHint_label struct {
Value interface{} `json:"value"`
}
// created for Or [StringValue string]
type Or_InlineCompletionItem_insertText struct {
Value interface{} `json:"value"`
}
// created for Or [InlineValueEvaluatableExpression InlineValueText InlineValueVariableLookup]
type Or_InlineValue struct {
Value interface{} `json:"value"`
}
// created for Or [MarkedStringWithLanguage string]
type Or_MarkedString struct {
Value interface{} `json:"value"`
}
// created for Or [NotebookDocumentFilter string]
type Or_NotebookCellTextDocumentFilter_notebook struct {
Value interface{} `json:"value"`
}
// created for Or [NotebookDocumentFilterNotebookType NotebookDocumentFilterPattern NotebookDocumentFilterScheme]
type Or_NotebookDocumentFilter struct {
Value interface{} `json:"value"`
}
// created for Or [NotebookDocumentFilter string]
type Or_NotebookDocumentFilterWithCells_notebook struct {
Value interface{} `json:"value"`
}
// created for Or [NotebookDocumentFilter string]
type Or_NotebookDocumentFilterWithNotebook_notebook struct {
Value interface{} `json:"value"`
}
// created for Or [NotebookDocumentFilterWithCells NotebookDocumentFilterWithNotebook]
type Or_NotebookDocumentSyncOptions_notebookSelector_Elem struct {
Value interface{} `json:"value"`
}
// created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport]
type Or_RelatedFullDocumentDiagnosticReport_relatedDocuments_Value struct {
Value interface{} `json:"value"`
}
// created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport]
type Or_RelatedUnchangedDocumentDiagnosticReport_relatedDocuments_Value struct {
Value interface{} `json:"value"`
}
// created for Or [CodeAction Command]
type Or_Result_textDocument_codeAction_Item0_Elem struct {
Value interface{} `json:"value"`
}
// created for Or [InlineCompletionList []InlineCompletionItem]
type Or_Result_textDocument_inlineCompletion struct {
Value interface{} `json:"value"`
}
// created for Or [SemanticTokensFullDelta bool]
type Or_SemanticTokensOptions_full struct {
Value interface{} `json:"value"`
}
// created for Or [PRangeESemanticTokensOptions bool]
type Or_SemanticTokensOptions_range struct {
Value interface{} `json:"value"`
}
// created for Or [CallHierarchyOptions CallHierarchyRegistrationOptions bool]
type Or_ServerCapabilities_callHierarchyProvider struct {
Value interface{} `json:"value"`
}
// created for Or [CodeActionOptions bool]
type Or_ServerCapabilities_codeActionProvider struct {
Value interface{} `json:"value"`
}
// created for Or [DocumentColorOptions DocumentColorRegistrationOptions bool]
type Or_ServerCapabilities_colorProvider struct {
Value interface{} `json:"value"`
}
// created for Or [DeclarationOptions DeclarationRegistrationOptions bool]
type Or_ServerCapabilities_declarationProvider struct {
Value interface{} `json:"value"`
}
// created for Or [DefinitionOptions bool]
type Or_ServerCapabilities_definitionProvider struct {
Value interface{} `json:"value"`
}
// created for Or [DiagnosticOptions DiagnosticRegistrationOptions]
type Or_ServerCapabilities_diagnosticProvider struct {
Value interface{} `json:"value"`
}
// created for Or [DocumentFormattingOptions bool]
type Or_ServerCapabilities_documentFormattingProvider struct {
Value interface{} `json:"value"`
}
// created for Or [DocumentHighlightOptions bool]
type Or_ServerCapabilities_documentHighlightProvider struct {
Value interface{} `json:"value"`
}
// created for Or [DocumentRangeFormattingOptions bool]
type Or_ServerCapabilities_documentRangeFormattingProvider struct {
Value interface{} `json:"value"`
}
// created for Or [DocumentSymbolOptions bool]
type Or_ServerCapabilities_documentSymbolProvider struct {
Value interface{} `json:"value"`
}
// created for Or [FoldingRangeOptions FoldingRangeRegistrationOptions bool]
type Or_ServerCapabilities_foldingRangeProvider struct {
Value interface{} `json:"value"`
}
// created for Or [HoverOptions bool]
type Or_ServerCapabilities_hoverProvider struct {
Value interface{} `json:"value"`
}
// created for Or [ImplementationOptions ImplementationRegistrationOptions bool]
type Or_ServerCapabilities_implementationProvider struct {
Value interface{} `json:"value"`
}
// created for Or [InlayHintOptions InlayHintRegistrationOptions bool]
type Or_ServerCapabilities_inlayHintProvider struct {
Value interface{} `json:"value"`
}
// created for Or [InlineCompletionOptions bool]
type Or_ServerCapabilities_inlineCompletionProvider struct {
Value interface{} `json:"value"`
}
// created for Or [InlineValueOptions InlineValueRegistrationOptions bool]
type Or_ServerCapabilities_inlineValueProvider struct {
Value interface{} `json:"value"`
}
// created for Or [LinkedEditingRangeOptions LinkedEditingRangeRegistrationOptions bool]
type Or_ServerCapabilities_linkedEditingRangeProvider struct {
Value interface{} `json:"value"`
}
// created for Or [MonikerOptions MonikerRegistrationOptions bool]
type Or_ServerCapabilities_monikerProvider struct {
Value interface{} `json:"value"`
}
// created for Or [NotebookDocumentSyncOptions NotebookDocumentSyncRegistrationOptions]
type Or_ServerCapabilities_notebookDocumentSync struct {
Value interface{} `json:"value"`
}
// created for Or [ReferenceOptions bool]
type Or_ServerCapabilities_referencesProvider struct {
Value interface{} `json:"value"`
}
// created for Or [RenameOptions bool]
type Or_ServerCapabilities_renameProvider struct {
Value interface{} `json:"value"`
}
// created for Or [SelectionRangeOptions SelectionRangeRegistrationOptions bool]
type Or_ServerCapabilities_selectionRangeProvider struct {
Value interface{} `json:"value"`
}
// created for Or [SemanticTokensOptions SemanticTokensRegistrationOptions]
type Or_ServerCapabilities_semanticTokensProvider struct {
Value interface{} `json:"value"`
}
// created for Or [TextDocumentSyncKind TextDocumentSyncOptions]
type Or_ServerCapabilities_textDocumentSync struct {
Value interface{} `json:"value"`
}
// created for Or [TypeDefinitionOptions TypeDefinitionRegistrationOptions bool]
type Or_ServerCapabilities_typeDefinitionProvider struct {
Value interface{} `json:"value"`
}
// created for Or [TypeHierarchyOptions TypeHierarchyRegistrationOptions bool]
type Or_ServerCapabilities_typeHierarchyProvider struct {
Value interface{} `json:"value"`
}
// created for Or [WorkspaceSymbolOptions bool]
type Or_ServerCapabilities_workspaceSymbolProvider struct {
Value interface{} `json:"value"`
}
// created for Or [MarkupContent string]
type Or_SignatureInformation_documentation struct {
Value interface{} `json:"value"`
}
// created for Or [AnnotatedTextEdit TextEdit]
type Or_TextDocumentEdit_edits_Elem struct {
Value interface{} `json:"value"`
}
// created for Or [TextDocumentFilterLanguage TextDocumentFilterPattern TextDocumentFilterScheme]
type Or_TextDocumentFilter struct {
Value interface{} `json:"value"`
}
// created for Or [SaveOptions bool]
type Or_TextDocumentSyncOptions_save struct {
Value interface{} `json:"value"`
}
// created for Or [WorkspaceFullDocumentDiagnosticReport WorkspaceUnchangedDocumentDiagnosticReport]
type Or_WorkspaceDocumentDiagnosticReport struct {
Value interface{} `json:"value"`
}
// created for Or [CreateFile DeleteFile RenameFile TextDocumentEdit]
type Or_WorkspaceEdit_documentChanges_Elem struct {
Value interface{} `json:"value"`
}
// created for Or [Declaration []DeclarationLink]
type Or_textDocument_declaration struct {
Value interface{} `json:"value"`
}
// created for Literal (Lit_SemanticTokensOptions_range_Item1)
type PRangeESemanticTokensOptions struct {
}
// The parameters of a configuration request.
type ParamConfiguration struct {
Items []ConfigurationItem `json:"items"`
}
type ParamInitialize struct {
XInitializeParams
WorkspaceFoldersInitializeParams
}
// Represents a parameter of a callable-signature. A parameter can
// have a label and a doc-comment.
type ParameterInformation struct {
// The label of this parameter information.
//
// Either a string or an inclusive start and exclusive end offsets within its containing
// signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
// string representation as `Position` and `Range` does.
//
// *Note*: a label of type string should be a substring of its containing signature label.
// Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
Label string `json:"label"`
// The human-readable doc-comment of this parameter. Will be shown
// in the UI but can be omitted.
Documentation string `json:"documentation,omitempty"`
}
type PartialResultParams struct {
// An optional token that a server can use to report partial results (e.g. streaming) to
// the client.
PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
}
// The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
//
// - `*` to match one or more characters in a path segment
// - `?` to match on one character in a path segment
// - `**` to match any number of path segments, including none
// - `{}` to group conditions (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
// - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
// - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
//
// @since 3.17.0
type Pattern = string // (alias)
// Position in a text document expressed as zero-based line and character
// offset. Prior to 3.17 the offsets were always based on a UTF-16 string
// representation. So a string of the form `a𐐀b` the character offset of the
// character `a` is 0, the character offset of `𐐀` is 1 and the character
// offset of b is 3 since `𐐀` is represented using two code units in UTF-16.
// Since 3.17 clients and servers can agree on a different string encoding
// representation (e.g. UTF-8). The client announces it's supported encoding
// via the client capability [`general.positionEncodings`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#clientCapabilities).
// The value is an array of position encodings the client supports, with
// decreasing preference (e.g. the encoding at index `0` is the most preferred
// one). To stay backwards compatible the only mandatory encoding is UTF-16
// represented via the string `utf-16`. The server can pick one of the
// encodings offered by the client and signals that encoding back to the
// client via the initialize result's property
// [`capabilities.positionEncoding`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#serverCapabilities). If the string value
// `utf-16` is missing from the client's capability `general.positionEncodings`
// servers can safely assume that the client supports UTF-16. If the server
// omits the position encoding in its initialize result the encoding defaults
// to the string value `utf-16`. Implementation considerations: since the
// conversion from one encoding into another requires the content of the
// file / line the conversion is best done where the file is read which is
// usually on the server side.
//
// Positions are line end character agnostic. So you can not specify a position
// that denotes `\r|\n` or `\n|` where `|` represents the character offset.
//
// @since 3.17.0 - support for negotiated position encoding.
type Position struct {
// Line position in a document (zero-based).
//
// If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document.
// If a line number is negative, it defaults to 0.
Line uint32 `json:"line"`
// Character offset on a line in a document (zero-based).
//
// The meaning of this offset is determined by the negotiated
// `PositionEncodingKind`.
//
// If the character value is greater than the line length it defaults back to the
// line length.
Character uint32 `json:"character"`
}
// A set of predefined position encoding kinds.
//
// @since 3.17.0
type PositionEncodingKind string
// @since 3.18.0
// @proposed
type PrepareRenameDefaultBehavior struct {
DefaultBehavior bool `json:"defaultBehavior"`
}
type PrepareRenameParams struct {
TextDocumentPositionParams
WorkDoneProgressParams
}
// @since 3.18.0
// @proposed
type PrepareRenamePlaceholder struct {
Range Range `json:"range"`
Placeholder string `json:"placeholder"`
}
type PrepareRenameResult = PrepareRenamePlaceholder // (alias)
type PrepareSupportDefaultBehavior uint32
// A previous result id in a workspace pull request.
//
// @since 3.17.0
type PreviousResultID struct {
// The URI for which the client knowns a
// result id.
URI DocumentURI `json:"uri"`
// The value of the previous result id.
Value string `json:"value"`
}
// A previous result id in a workspace pull request.
//
// @since 3.17.0
type PreviousResultId struct {
// The URI for which the client knowns a
// result id.
URI DocumentURI `json:"uri"`
// The value of the previous result id.
Value string `json:"value"`
}
type ProgressParams struct {
// The progress token provided by the client or server.
Token ProgressToken `json:"token"`
// The progress data.
Value interface{} `json:"value"`
}
type ProgressToken = interface{} // (alias)
// The publish diagnostic client capabilities.
type PublishDiagnosticsClientCapabilities struct {
// Whether the clients accepts diagnostics with related information.
RelatedInformation bool `json:"relatedInformation,omitempty"`
// Client supports the tag property to provide meta data about a diagnostic.
// Clients supporting tags have to handle unknown tags gracefully.
//
// @since 3.15.0
TagSupport *ClientDiagnosticsTagOptions `json:"tagSupport,omitempty"`
// Whether the client interprets the version property of the
// `textDocument/publishDiagnostics` notification's parameter.
//
// @since 3.15.0
VersionSupport bool `json:"versionSupport,omitempty"`
// Client supports a codeDescription property
//
// @since 3.16.0
CodeDescriptionSupport bool `json:"codeDescriptionSupport,omitempty"`
// Whether code action supports the `data` property which is
// preserved between a `textDocument/publishDiagnostics` and
// `textDocument/codeAction` request.
//
// @since 3.16.0
DataSupport bool `json:"dataSupport,omitempty"`
}
// The publish diagnostic notification's parameters.
type PublishDiagnosticsParams struct {
// The URI for which diagnostic information is reported.
URI DocumentURI `json:"uri"`
// Optional the version number of the document the diagnostics are published for.
//
// @since 3.15.0
Version int32 `json:"version,omitempty"`
// An array of diagnostic information items.
Diagnostics []Diagnostic `json:"diagnostics"`
}
// A range in a text document expressed as (zero-based) start and end positions.
//
// If you want to specify a range that contains a line including the line ending
// character(s) then use an end position denoting the start of the next line.
// For example:
// ```ts
//
// {
// start: { line: 5, character: 23 }
// end : { line 6, character : 0 }
// }
//
// ```
type Range struct {
// The range's start position.
Start Position `json:"start"`
// The range's end position.
End Position `json:"end"`
}
// Client Capabilities for a {@link ReferencesRequest}.
type ReferenceClientCapabilities struct {
// Whether references supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// Value-object that contains additional information when
// requesting references.
type ReferenceContext struct {
// Include the declaration of the current symbol.
IncludeDeclaration bool `json:"includeDeclaration"`
}
// Reference options.
type ReferenceOptions struct {
WorkDoneProgressOptions
}
// Parameters for a {@link ReferencesRequest}.
type ReferenceParams struct {
Context ReferenceContext `json:"context"`
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a {@link ReferencesRequest}.
type ReferenceRegistrationOptions struct {
TextDocumentRegistrationOptions
ReferenceOptions
}
// General parameters to register for a notification or to register a provider.
type Registration struct {
// The id used to register the request. The id can be used to deregister
// the request again.
ID string `json:"id"`
// The method / capability to register for.
Method string `json:"method"`
// Options necessary for the registration.
RegisterOptions interface{} `json:"registerOptions,omitempty"`
}
type RegistrationParams struct {
Registrations []Registration `json:"registrations"`
}
// Client capabilities specific to regular expressions.
//
// @since 3.16.0
type RegularExpressionsClientCapabilities struct {
// The engine's name.
Engine string `json:"engine"`
// The engine's version.
Version string `json:"version,omitempty"`
}
// A full diagnostic report with a set of related documents.
//
// @since 3.17.0
type RelatedFullDocumentDiagnosticReport struct {
// Diagnostics of related documents. This information is useful
// in programming languages where code in a file A can generate
// diagnostics in a file B which A depends on. An example of
// such a language is C/C++ where marco definitions in a file
// a.cpp and result in errors in a header file b.hpp.
//
// @since 3.17.0
RelatedDocuments map[DocumentURI]interface{} `json:"relatedDocuments,omitempty"`
FullDocumentDiagnosticReport
}
// An unchanged diagnostic report with a set of related documents.
//
// @since 3.17.0
type RelatedUnchangedDocumentDiagnosticReport struct {
// Diagnostics of related documents. This information is useful
// in programming languages where code in a file A can generate
// diagnostics in a file B which A depends on. An example of
// such a language is C/C++ where marco definitions in a file
// a.cpp and result in errors in a header file b.hpp.
//
// @since 3.17.0
RelatedDocuments map[DocumentURI]interface{} `json:"relatedDocuments,omitempty"`
UnchangedDocumentDiagnosticReport
}
// A relative pattern is a helper to construct glob patterns that are matched
// relatively to a base URI. The common value for a `baseUri` is a workspace
// folder root, but it can be another absolute URI as well.
//
// @since 3.17.0
type RelativePattern struct {
// A workspace folder or a base URI to which this pattern will be matched
// against relatively.
BaseURI DocumentURI `json:"baseUri"`
// The actual glob pattern;
Pattern Pattern `json:"pattern"`
}
type RenameClientCapabilities struct {
// Whether rename supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// Client supports testing for validity of rename operations
// before execution.
//
// @since 3.12.0
PrepareSupport bool `json:"prepareSupport,omitempty"`
// Client supports the default behavior result.
//
// The value indicates the default behavior used by the
// client.
//
// @since 3.16.0
PrepareSupportDefaultBehavior *PrepareSupportDefaultBehavior `json:"prepareSupportDefaultBehavior,omitempty"`
// Whether the client honors the change annotations in
// text edits and resource operations returned via the
// rename request's workspace edit by for example presenting
// the workspace edit in the user interface and asking
// for confirmation.
//
// @since 3.16.0
HonorsChangeAnnotations bool `json:"honorsChangeAnnotations,omitempty"`
}
// Rename file operation
type RenameFile struct {
// A rename
Kind string `json:"kind"`
// The old (existing) location.
OldURI DocumentURI `json:"oldUri"`
// The new location.
NewURI DocumentURI `json:"newUri"`
// Rename options.
Options *RenameFileOptions `json:"options,omitempty"`
ResourceOperation
}
// Rename file options
type RenameFileOptions struct {
// Overwrite target if existing. Overwrite wins over `ignoreIfExists`
Overwrite bool `json:"overwrite,omitempty"`
// Ignores if target exists.
IgnoreIfExists bool `json:"ignoreIfExists,omitempty"`
}
// The parameters sent in notifications/requests for user-initiated renames of
// files.
//
// @since 3.16.0
type RenameFilesParams struct {
// An array of all files/folders renamed in this operation. When a folder is renamed, only
// the folder will be included, and not its children.
Files []FileRename `json:"files"`
}
// Provider options for a {@link RenameRequest}.
type RenameOptions struct {
// Renames should be checked and tested before being executed.
//
// @since version 3.12.0
PrepareProvider bool `json:"prepareProvider,omitempty"`
WorkDoneProgressOptions
}
// The parameters of a {@link RenameRequest}.
type RenameParams struct {
// The document to rename.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The position at which this request was sent.
Position Position `json:"position"`
// The new name of the symbol. If the given name is not valid the
// request must return a {@link ResponseError} with an
// appropriate message set.
NewName string `json:"newName"`
WorkDoneProgressParams
}
// Registration options for a {@link RenameRequest}.
type RenameRegistrationOptions struct {
TextDocumentRegistrationOptions
RenameOptions
}
// A generic resource operation.
type ResourceOperation struct {
// The resource operation kind.
Kind string `json:"kind"`
// An optional annotation identifier describing the operation.
//
// @since 3.16.0
AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"`
}
type ResourceOperationKind string
// Save options.
type SaveOptions struct {
// The client is supposed to include the content on save.
IncludeText bool `json:"includeText,omitempty"`
}
// Describes the currently selected completion item.
//
// @since 3.18.0
// @proposed
type SelectedCompletionInfo struct {
// The range that will be replaced if this completion item is accepted.
Range Range `json:"range"`
// The text the range will be replaced with if this completion is accepted.
Text string `json:"text"`
}
// A selection range represents a part of a selection hierarchy. A selection range
// may have a parent selection range that contains it.
type SelectionRange struct {
// The {@link Range range} of this selection range.
Range Range `json:"range"`
// The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.
Parent *SelectionRange `json:"parent,omitempty"`
}
type SelectionRangeClientCapabilities struct {
// Whether implementation supports dynamic registration for selection range providers. If this is set to `true`
// the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server
// capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
type SelectionRangeOptions struct {
WorkDoneProgressOptions
}
// A parameter literal used in selection range requests.
type SelectionRangeParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The positions inside the text document.
Positions []Position `json:"positions"`
WorkDoneProgressParams
PartialResultParams
}
type SelectionRangeRegistrationOptions struct {
SelectionRangeOptions
TextDocumentRegistrationOptions
StaticRegistrationOptions
}
// A set of predefined token modifiers. This set is not fixed
// an clients can specify additional token types via the
// corresponding client capabilities.
//
// @since 3.16.0
type SemanticTokenModifiers string
// A set of predefined token types. This set is not fixed
// an clients can specify additional token types via the
// corresponding client capabilities.
//
// @since 3.16.0
type SemanticTokenTypes string
// @since 3.16.0
type SemanticTokens struct {
// An optional result id. If provided and clients support delta updating
// the client will include the result id in the next semantic token request.
// A server can then instead of computing all semantic tokens again simply
// send a delta.
ResultID string `json:"resultId,omitempty"`
// The actual tokens.
Data []uint32 `json:"data"`
}
// @since 3.16.0
type SemanticTokensClientCapabilities struct {
// Whether implementation supports dynamic registration. If this is set to `true`
// the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
// return value for the corresponding server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// Which requests the client supports and might send to the server
// depending on the server's capability. Please note that clients might not
// show semantic tokens or degrade some of the user experience if a range
// or full request is advertised by the client but not provided by the
// server. If for example the client capability `requests.full` and
// `request.range` are both set to true but the server only provides a
// range provider the client might not render a minimap correctly or might
// even decide to not show any semantic tokens at all.
Requests ClientSemanticTokensRequestOptions `json:"requests"`
// The token types that the client supports.
TokenTypes []string `json:"tokenTypes"`
// The token modifiers that the client supports.
TokenModifiers []string `json:"tokenModifiers"`
// The token formats the clients supports.
Formats []TokenFormat `json:"formats"`
// Whether the client supports tokens that can overlap each other.
OverlappingTokenSupport bool `json:"overlappingTokenSupport,omitempty"`
// Whether the client supports tokens that can span multiple lines.
MultilineTokenSupport bool `json:"multilineTokenSupport,omitempty"`
// Whether the client allows the server to actively cancel a
// semantic token request, e.g. supports returning
// LSPErrorCodes.ServerCancelled. If a server does the client
// needs to retrigger the request.
//
// @since 3.17.0
ServerCancelSupport bool `json:"serverCancelSupport,omitempty"`
// Whether the client uses semantic tokens to augment existing
// syntax tokens. If set to `true` client side created syntax
// tokens and semantic tokens are both used for colorization. If
// set to `false` the client only uses the returned semantic tokens
// for colorization.
//
// If the value is `undefined` then the client behavior is not
// specified.
//
// @since 3.17.0
AugmentsSyntaxTokens bool `json:"augmentsSyntaxTokens,omitempty"`
}
// @since 3.16.0
type SemanticTokensDelta struct {
ResultID string `json:"resultId,omitempty"`
// The semantic token edits to transform a previous result into a new result.
Edits []SemanticTokensEdit `json:"edits"`
}
// @since 3.16.0
type SemanticTokensDeltaParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The result id of a previous response. The result Id can either point to a full response
// or a delta response depending on what was received last.
PreviousResultID string `json:"previousResultId"`
WorkDoneProgressParams
PartialResultParams
}
// @since 3.16.0
type SemanticTokensDeltaPartialResult struct {
Edits []SemanticTokensEdit `json:"edits"`
}
// @since 3.16.0
type SemanticTokensEdit struct {
// The start offset of the edit.
Start uint32 `json:"start"`
// The count of elements to remove.
DeleteCount uint32 `json:"deleteCount"`
// The elements to insert.
Data []uint32 `json:"data,omitempty"`
}
// Semantic tokens options to support deltas for full documents
//
// @since 3.18.0
// @proposed
type SemanticTokensFullDelta struct {
// The server supports deltas for full documents.
Delta bool `json:"delta,omitempty"`
}
// @since 3.16.0
type SemanticTokensLegend struct {
// The token types a server uses.
TokenTypes []string `json:"tokenTypes"`
// The token modifiers a server uses.
TokenModifiers []string `json:"tokenModifiers"`
}
// @since 3.16.0
type SemanticTokensOptions struct {
// The legend used by the server
Legend SemanticTokensLegend `json:"legend"`
// Server supports providing semantic tokens for a specific range
// of a document.
Range *Or_SemanticTokensOptions_range `json:"range,omitempty"`
// Server supports providing semantic tokens for a full document.
Full *Or_SemanticTokensOptions_full `json:"full,omitempty"`
WorkDoneProgressOptions
}
// @since 3.16.0
type SemanticTokensParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
WorkDoneProgressParams
PartialResultParams
}
// @since 3.16.0
type SemanticTokensPartialResult struct {
Data []uint32 `json:"data"`
}
// @since 3.16.0
type SemanticTokensRangeParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The range the semantic tokens are requested for.
Range Range `json:"range"`
WorkDoneProgressParams
PartialResultParams
}
// @since 3.16.0
type SemanticTokensRegistrationOptions struct {
TextDocumentRegistrationOptions
SemanticTokensOptions
StaticRegistrationOptions
}
// @since 3.16.0
type SemanticTokensWorkspaceClientCapabilities struct {
// Whether the client implementation supports a refresh request sent from
// the server to the client.
//
// Note that this event is global and will force the client to refresh all
// semantic tokens currently shown. It should be used with absolute care
// and is useful for situation where a server for example detects a project
// wide change that requires such a calculation.
RefreshSupport bool `json:"refreshSupport,omitempty"`
}
// Defines the capabilities provided by a language
// server.
type ServerCapabilities struct {
// The position encoding the server picked from the encodings offered
// by the client via the client capability `general.positionEncodings`.
//
// If the client didn't provide any position encodings the only valid
// value that a server can return is 'utf-16'.
//
// If omitted it defaults to 'utf-16'.
//
// @since 3.17.0
PositionEncoding *PositionEncodingKind `json:"positionEncoding,omitempty"`
// Defines how text documents are synced. Is either a detailed structure
// defining each notification or for backwards compatibility the
// TextDocumentSyncKind number.
TextDocumentSync interface{} `json:"textDocumentSync,omitempty"`
// Defines how notebook documents are synced.
//
// @since 3.17.0
NotebookDocumentSync *Or_ServerCapabilities_notebookDocumentSync `json:"notebookDocumentSync,omitempty"`
// The server provides completion support.
CompletionProvider *CompletionOptions `json:"completionProvider,omitempty"`
// The server provides hover support.
HoverProvider *Or_ServerCapabilities_hoverProvider `json:"hoverProvider,omitempty"`
// The server provides signature help support.
SignatureHelpProvider *SignatureHelpOptions `json:"signatureHelpProvider,omitempty"`
// The server provides Goto Declaration support.
DeclarationProvider *Or_ServerCapabilities_declarationProvider `json:"declarationProvider,omitempty"`
// The server provides goto definition support.
DefinitionProvider *Or_ServerCapabilities_definitionProvider `json:"definitionProvider,omitempty"`
// The server provides Goto Type Definition support.
TypeDefinitionProvider *Or_ServerCapabilities_typeDefinitionProvider `json:"typeDefinitionProvider,omitempty"`
// The server provides Goto Implementation support.
ImplementationProvider *Or_ServerCapabilities_implementationProvider `json:"implementationProvider,omitempty"`
// The server provides find references support.
ReferencesProvider *Or_ServerCapabilities_referencesProvider `json:"referencesProvider,omitempty"`
// The server provides document highlight support.
DocumentHighlightProvider *Or_ServerCapabilities_documentHighlightProvider `json:"documentHighlightProvider,omitempty"`
// The server provides document symbol support.
DocumentSymbolProvider *Or_ServerCapabilities_documentSymbolProvider `json:"documentSymbolProvider,omitempty"`
// The server provides code actions. CodeActionOptions may only be
// specified if the client states that it supports
// `codeActionLiteralSupport` in its initial `initialize` request.
CodeActionProvider interface{} `json:"codeActionProvider,omitempty"`
// The server provides code lens.
CodeLensProvider *CodeLensOptions `json:"codeLensProvider,omitempty"`
// The server provides document link support.
DocumentLinkProvider *DocumentLinkOptions `json:"documentLinkProvider,omitempty"`
// The server provides color provider support.
ColorProvider *Or_ServerCapabilities_colorProvider `json:"colorProvider,omitempty"`
// The server provides workspace symbol support.
WorkspaceSymbolProvider *Or_ServerCapabilities_workspaceSymbolProvider `json:"workspaceSymbolProvider,omitempty"`
// The server provides document formatting.
DocumentFormattingProvider *Or_ServerCapabilities_documentFormattingProvider `json:"documentFormattingProvider,omitempty"`
// The server provides document range formatting.
DocumentRangeFormattingProvider *Or_ServerCapabilities_documentRangeFormattingProvider `json:"documentRangeFormattingProvider,omitempty"`
// The server provides document formatting on typing.
DocumentOnTypeFormattingProvider *DocumentOnTypeFormattingOptions `json:"documentOnTypeFormattingProvider,omitempty"`
// The server provides rename support. RenameOptions may only be
// specified if the client states that it supports
// `prepareSupport` in its initial `initialize` request.
RenameProvider interface{} `json:"renameProvider,omitempty"`
// The server provides folding provider support.
FoldingRangeProvider *Or_ServerCapabilities_foldingRangeProvider `json:"foldingRangeProvider,omitempty"`
// The server provides selection range support.
SelectionRangeProvider *Or_ServerCapabilities_selectionRangeProvider `json:"selectionRangeProvider,omitempty"`
// The server provides execute command support.
ExecuteCommandProvider *ExecuteCommandOptions `json:"executeCommandProvider,omitempty"`
// The server provides call hierarchy support.
//
// @since 3.16.0
CallHierarchyProvider *Or_ServerCapabilities_callHierarchyProvider `json:"callHierarchyProvider,omitempty"`
// The server provides linked editing range support.
//
// @since 3.16.0
LinkedEditingRangeProvider *Or_ServerCapabilities_linkedEditingRangeProvider `json:"linkedEditingRangeProvider,omitempty"`
// The server provides semantic tokens support.
//
// @since 3.16.0
SemanticTokensProvider interface{} `json:"semanticTokensProvider,omitempty"`
// The server provides moniker support.
//
// @since 3.16.0
MonikerProvider *Or_ServerCapabilities_monikerProvider `json:"monikerProvider,omitempty"`
// The server provides type hierarchy support.
//
// @since 3.17.0
TypeHierarchyProvider *Or_ServerCapabilities_typeHierarchyProvider `json:"typeHierarchyProvider,omitempty"`
// The server provides inline values.
//
// @since 3.17.0
InlineValueProvider *Or_ServerCapabilities_inlineValueProvider `json:"inlineValueProvider,omitempty"`
// The server provides inlay hints.
//
// @since 3.17.0
InlayHintProvider interface{} `json:"inlayHintProvider,omitempty"`
// The server has support for pull model diagnostics.
//
// @since 3.17.0
DiagnosticProvider *Or_ServerCapabilities_diagnosticProvider `json:"diagnosticProvider,omitempty"`
// Inline completion options used during static registration.
//
// @since 3.18.0
// @proposed
InlineCompletionProvider *Or_ServerCapabilities_inlineCompletionProvider `json:"inlineCompletionProvider,omitempty"`
// Workspace specific server capabilities.
Workspace *WorkspaceOptions `json:"workspace,omitempty"`
// Experimental server capabilities.
Experimental interface{} `json:"experimental,omitempty"`
}
// @since 3.18.0
// @proposed
type ServerCompletionItemOptions struct {
// The server has support for completion item label
// details (see also `CompletionItemLabelDetails`) when
// receiving a completion item in a resolve call.
//
// @since 3.17.0
LabelDetailsSupport bool `json:"labelDetailsSupport,omitempty"`
}
// Information about the server
//
// @since 3.15.0
// @since 3.18.0 ServerInfo type name added.
// @proposed
type ServerInfo struct {
// The name of the server as defined by the server.
Name string `json:"name"`
// The server's version as defined by the server.
Version string `json:"version,omitempty"`
}
type SetTraceParams struct {
Value TraceValues `json:"value"`
}
// Client capabilities for the showDocument request.
//
// @since 3.16.0
type ShowDocumentClientCapabilities struct {
// The client has support for the showDocument
// request.
Support bool `json:"support"`
}
// Params to show a resource in the UI.
//
// @since 3.16.0
type ShowDocumentParams struct {
// The uri to show.
URI URI `json:"uri"`
// Indicates to show the resource in an external program.
// To show, for example, `https://code.visualstudio.com/`
// in the default WEB browser set `external` to `true`.
External bool `json:"external,omitempty"`
// An optional property to indicate whether the editor
// showing the document should take focus or not.
// Clients might ignore this property if an external
// program is started.
TakeFocus bool `json:"takeFocus,omitempty"`
// An optional selection range if the document is a text
// document. Clients might ignore the property if an
// external program is started or the file is not a text
// file.
Selection *Range `json:"selection,omitempty"`
}
// The result of a showDocument request.
//
// @since 3.16.0
type ShowDocumentResult struct {
// A boolean indicating if the show was successful.
Success bool `json:"success"`
}
// The parameters of a notification message.
type ShowMessageParams struct {
// The message type. See {@link MessageType}
Type MessageType `json:"type"`
// The actual message.
Message string `json:"message"`
}
// Show message request client capabilities
type ShowMessageRequestClientCapabilities struct {
// Capabilities specific to the `MessageActionItem` type.
MessageActionItem *ClientShowMessageActionItemOptions `json:"messageActionItem,omitempty"`
}
type ShowMessageRequestParams struct {
// The message type. See {@link MessageType}
Type MessageType `json:"type"`
// The actual message.
Message string `json:"message"`
// The message action items to present.
Actions []MessageActionItem `json:"actions,omitempty"`
}
// Signature help represents the signature of something
// callable. There can be multiple signature but only one
// active and only one active parameter.
type SignatureHelp struct {
// One or more signatures.
Signatures []SignatureInformation `json:"signatures"`
// The active signature. If omitted or the value lies outside the
// range of `signatures` the value defaults to zero or is ignored if
// the `SignatureHelp` has no signatures.
//
// Whenever possible implementors should make an active decision about
// the active signature and shouldn't rely on a default value.
//
// In future version of the protocol this property might become
// mandatory to better express this.
ActiveSignature uint32 `json:"activeSignature,omitempty"`
// The active parameter of the active signature. If omitted or the value
// lies outside the range of `signatures[activeSignature].parameters`
// defaults to 0 if the active signature has parameters. If
// the active signature has no parameters it is ignored.
// In future version of the protocol this property might become
// mandatory to better express the active parameter if the
// active signature does have any.
ActiveParameter uint32 `json:"activeParameter,omitempty"`
}
// Client Capabilities for a {@link SignatureHelpRequest}.
type SignatureHelpClientCapabilities struct {
// Whether signature help supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client supports the following `SignatureInformation`
// specific properties.
SignatureInformation *ClientSignatureInformationOptions `json:"signatureInformation,omitempty"`
// The client supports to send additional context information for a
// `textDocument/signatureHelp` request. A client that opts into
// contextSupport will also support the `retriggerCharacters` on
// `SignatureHelpOptions`.
//
// @since 3.15.0
ContextSupport bool `json:"contextSupport,omitempty"`
}
// Additional information about the context in which a signature help request was triggered.
//
// @since 3.15.0
type SignatureHelpContext struct {
// Action that caused signature help to be triggered.
TriggerKind SignatureHelpTriggerKind `json:"triggerKind"`
// Character that caused signature help to be triggered.
//
// This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`
TriggerCharacter string `json:"triggerCharacter,omitempty"`
// `true` if signature help was already showing when it was triggered.
//
// Retriggers occurs when the signature help is already active and can be caused by actions such as
// typing a trigger character, a cursor move, or document content changes.
IsRetrigger bool `json:"isRetrigger"`
// The currently active `SignatureHelp`.
//
// The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on
// the user navigating through available signatures.
ActiveSignatureHelp *SignatureHelp `json:"activeSignatureHelp,omitempty"`
}
// Server Capabilities for a {@link SignatureHelpRequest}.
type SignatureHelpOptions struct {
// List of characters that trigger signature help automatically.
TriggerCharacters []string `json:"triggerCharacters,omitempty"`
// List of characters that re-trigger signature help.
//
// These trigger characters are only active when signature help is already showing. All trigger characters
// are also counted as re-trigger characters.
//
// @since 3.15.0
RetriggerCharacters []string `json:"retriggerCharacters,omitempty"`
WorkDoneProgressOptions
}
// Parameters for a {@link SignatureHelpRequest}.
type SignatureHelpParams struct {
// The signature help context. This is only available if the client specifies
// to send this using the client capability `textDocument.signatureHelp.contextSupport === true`
//
// @since 3.15.0
Context *SignatureHelpContext `json:"context,omitempty"`
TextDocumentPositionParams
WorkDoneProgressParams
}
// Registration options for a {@link SignatureHelpRequest}.
type SignatureHelpRegistrationOptions struct {
TextDocumentRegistrationOptions
SignatureHelpOptions
}
// How a signature help was triggered.
//
// @since 3.15.0
type SignatureHelpTriggerKind uint32
// Represents the signature of something callable. A signature
// can have a label, like a function-name, a doc-comment, and
// a set of parameters.
type SignatureInformation struct {
// The label of this signature. Will be shown in
// the UI.
Label string `json:"label"`
// The human-readable doc-comment of this signature. Will be shown
// in the UI but can be omitted.
Documentation *Or_SignatureInformation_documentation `json:"documentation,omitempty"`
// The parameters of this signature.
Parameters []ParameterInformation `json:"parameters,omitempty"`
// The index of the active parameter.
//
// If provided, this is used in place of `SignatureHelp.activeParameter`.
//
// @since 3.16.0
ActiveParameter uint32 `json:"activeParameter,omitempty"`
}
// @since 3.18.0
// @proposed
type StaleRequestSupportOptions struct {
// The client will actively cancel the request.
Cancel bool `json:"cancel"`
// The list of requests for which the client
// will retry the request if it receives a
// response with error code `ContentModified`
RetryOnContentModified []string `json:"retryOnContentModified"`
}
// Static registration options to be returned in the initialize
// request.
type StaticRegistrationOptions struct {
// The id used to register the request. The id can be used to deregister
// the request again. See also Registration#id.
ID string `json:"id,omitempty"`
}
// A string value used as a snippet is a template which allows to insert text
// and to control the editor cursor when insertion happens.
//
// A snippet can define tab stops and placeholders with `$1`, `$2`
// and `${3:foo}`. `$0` defines the final tab stop, it defaults to
// the end of the snippet. Variables are defined with `$name` and
// `${name:default value}`.
//
// @since 3.18.0
// @proposed
type StringValue struct {
// The kind of string value.
Kind string `json:"kind"`
// The snippet string.
Value string `json:"value"`
}
// Represents information about programming constructs like variables, classes,
// interfaces etc.
type SymbolInformation struct {
// extends BaseSymbolInformation
// Indicates if this symbol is deprecated.
//
// @deprecated Use tags instead
Deprecated bool `json:"deprecated,omitempty"`
// The location of this symbol. The location's range is used by a tool
// to reveal the location in the editor. If the symbol is selected in the
// tool the range's start information is used to position the cursor. So
// the range usually spans more than the actual symbol's name and does
// normally include things like visibility modifiers.
//
// The range doesn't have to denote a node range in the sense of an abstract
// syntax tree. It can therefore not be used to re-construct a hierarchy of
// the symbols.
Location Location `json:"location"`
// The name of this symbol.
Name string `json:"name"`
// The kind of this symbol.
Kind SymbolKind `json:"kind"`
// Tags for this symbol.
//
// @since 3.16.0
Tags []SymbolTag `json:"tags,omitempty"`
// The name of the symbol containing this symbol. This information is for
// user interface purposes (e.g. to render a qualifier in the user interface
// if necessary). It can't be used to re-infer a hierarchy for the document
// symbols.
ContainerName string `json:"containerName,omitempty"`
}
// A symbol kind.
type SymbolKind uint32
// Symbol tags are extra annotations that tweak the rendering of a symbol.
//
// @since 3.16
type SymbolTag uint32
// Describe options to be used when registered for text document change events.
type TextDocumentChangeRegistrationOptions struct {
// How documents are synced to the server.
SyncKind TextDocumentSyncKind `json:"syncKind"`
TextDocumentRegistrationOptions
}
// Text document specific client capabilities.
type TextDocumentClientCapabilities struct {
// Defines which synchronization capabilities the client supports.
Synchronization *TextDocumentSyncClientCapabilities `json:"synchronization,omitempty"`
// Capabilities specific to the `textDocument/completion` request.
Completion CompletionClientCapabilities `json:"completion,omitempty"`
// Capabilities specific to the `textDocument/hover` request.
Hover *HoverClientCapabilities `json:"hover,omitempty"`
// Capabilities specific to the `textDocument/signatureHelp` request.
SignatureHelp *SignatureHelpClientCapabilities `json:"signatureHelp,omitempty"`
// Capabilities specific to the `textDocument/declaration` request.
//
// @since 3.14.0
Declaration *DeclarationClientCapabilities `json:"declaration,omitempty"`
// Capabilities specific to the `textDocument/definition` request.
Definition *DefinitionClientCapabilities `json:"definition,omitempty"`
// Capabilities specific to the `textDocument/typeDefinition` request.
//
// @since 3.6.0
TypeDefinition *TypeDefinitionClientCapabilities `json:"typeDefinition,omitempty"`
// Capabilities specific to the `textDocument/implementation` request.
//
// @since 3.6.0
Implementation *ImplementationClientCapabilities `json:"implementation,omitempty"`
// Capabilities specific to the `textDocument/references` request.
References *ReferenceClientCapabilities `json:"references,omitempty"`
// Capabilities specific to the `textDocument/documentHighlight` request.
DocumentHighlight *DocumentHighlightClientCapabilities `json:"documentHighlight,omitempty"`
// Capabilities specific to the `textDocument/documentSymbol` request.
DocumentSymbol DocumentSymbolClientCapabilities `json:"documentSymbol,omitempty"`
// Capabilities specific to the `textDocument/codeAction` request.
CodeAction CodeActionClientCapabilities `json:"codeAction,omitempty"`
// Capabilities specific to the `textDocument/codeLens` request.
CodeLens *CodeLensClientCapabilities `json:"codeLens,omitempty"`
// Capabilities specific to the `textDocument/documentLink` request.
DocumentLink *DocumentLinkClientCapabilities `json:"documentLink,omitempty"`
// Capabilities specific to the `textDocument/documentColor` and the
// `textDocument/colorPresentation` request.
//
// @since 3.6.0
ColorProvider *DocumentColorClientCapabilities `json:"colorProvider,omitempty"`
// Capabilities specific to the `textDocument/formatting` request.
Formatting *DocumentFormattingClientCapabilities `json:"formatting,omitempty"`
// Capabilities specific to the `textDocument/rangeFormatting` request.
RangeFormatting *DocumentRangeFormattingClientCapabilities `json:"rangeFormatting,omitempty"`
// Capabilities specific to the `textDocument/onTypeFormatting` request.
OnTypeFormatting *DocumentOnTypeFormattingClientCapabilities `json:"onTypeFormatting,omitempty"`
// Capabilities specific to the `textDocument/rename` request.
Rename *RenameClientCapabilities `json:"rename,omitempty"`
// Capabilities specific to the `textDocument/foldingRange` request.
//
// @since 3.10.0
FoldingRange *FoldingRangeClientCapabilities `json:"foldingRange,omitempty"`
// Capabilities specific to the `textDocument/selectionRange` request.
//
// @since 3.15.0
SelectionRange *SelectionRangeClientCapabilities `json:"selectionRange,omitempty"`
// Capabilities specific to the `textDocument/publishDiagnostics` notification.
PublishDiagnostics PublishDiagnosticsClientCapabilities `json:"publishDiagnostics,omitempty"`
// Capabilities specific to the various call hierarchy requests.
//
// @since 3.16.0
CallHierarchy *CallHierarchyClientCapabilities `json:"callHierarchy,omitempty"`
// Capabilities specific to the various semantic token request.
//
// @since 3.16.0
SemanticTokens SemanticTokensClientCapabilities `json:"semanticTokens,omitempty"`
// Capabilities specific to the `textDocument/linkedEditingRange` request.
//
// @since 3.16.0
LinkedEditingRange *LinkedEditingRangeClientCapabilities `json:"linkedEditingRange,omitempty"`
// Client capabilities specific to the `textDocument/moniker` request.
//
// @since 3.16.0
Moniker *MonikerClientCapabilities `json:"moniker,omitempty"`
// Capabilities specific to the various type hierarchy requests.
//
// @since 3.17.0
TypeHierarchy *TypeHierarchyClientCapabilities `json:"typeHierarchy,omitempty"`
// Capabilities specific to the `textDocument/inlineValue` request.
//
// @since 3.17.0
InlineValue *InlineValueClientCapabilities `json:"inlineValue,omitempty"`
// Capabilities specific to the `textDocument/inlayHint` request.
//
// @since 3.17.0
InlayHint *InlayHintClientCapabilities `json:"inlayHint,omitempty"`
// Capabilities specific to the diagnostic pull model.
//
// @since 3.17.0
Diagnostic *DiagnosticClientCapabilities `json:"diagnostic,omitempty"`
// Client capabilities specific to inline completions.
//
// @since 3.18.0
// @proposed
InlineCompletion *InlineCompletionClientCapabilities `json:"inlineCompletion,omitempty"`
}
// An event describing a change to a text document. If only a text is provided
// it is considered to be the full content of the document.
type TextDocumentContentChangeEvent = TextDocumentContentChangePartial // (alias)
// @since 3.18.0
// @proposed
type TextDocumentContentChangePartial struct {
// The range of the document that changed.
Range *Range `json:"range,omitempty"`
// The optional length of the range that got replaced.
//
// @deprecated use range instead.
RangeLength uint32 `json:"rangeLength,omitempty"`
// The new text for the provided range.
Text string `json:"text"`
}
// @since 3.18.0
// @proposed
type TextDocumentContentChangeWholeDocument struct {
// The new text of the whole document.
Text string `json:"text"`
}
// Describes textual changes on a text document. A TextDocumentEdit describes all changes
// on a document version Si and after they are applied move the document to version Si+1.
// So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any
// kind of ordering. However the edits must be non overlapping.
type TextDocumentEdit struct {
// The text document to change.
TextDocument OptionalVersionedTextDocumentIdentifier `json:"textDocument"`
// The edits to be applied.
//
// @since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a
// client capability.
Edits []Or_TextDocumentEdit_edits_Elem `json:"edits"`
}
// A document filter denotes a document by different properties like
// the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of
// its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
//
// Glob patterns can have the following syntax:
//
// - `*` to match one or more characters in a path segment
// - `?` to match on one character in a path segment
// - `**` to match any number of path segments, including none
// - `{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
// - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
// - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
//
// @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
// @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
//
// @since 3.17.0
type TextDocumentFilter = Or_TextDocumentFilter // (alias)
// A document filter where `language` is required field.
//
// @since 3.18.0
// @proposed
type TextDocumentFilterLanguage struct {
// A language id, like `typescript`.
Language string `json:"language"`
// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
Scheme string `json:"scheme,omitempty"`
// A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
Pattern string `json:"pattern,omitempty"`
}
// A document filter where `pattern` is required field.
//
// @since 3.18.0
// @proposed
type TextDocumentFilterPattern struct {
// A language id, like `typescript`.
Language string `json:"language,omitempty"`
// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
Scheme string `json:"scheme,omitempty"`
// A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
Pattern string `json:"pattern"`
}
// A document filter where `scheme` is required field.
//
// @since 3.18.0
// @proposed
type TextDocumentFilterScheme struct {
// A language id, like `typescript`.
Language string `json:"language,omitempty"`
// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
Scheme string `json:"scheme"`
// A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
Pattern string `json:"pattern,omitempty"`
}
// A literal to identify a text document in the client.
type TextDocumentIdentifier struct {
// The text document's uri.
URI DocumentURI `json:"uri"`
}
// An item to transfer a text document from the client to the
// server.
type TextDocumentItem struct {
// The text document's uri.
URI DocumentURI `json:"uri"`
// The text document's language identifier.
LanguageID string `json:"languageId"`
// The version number of this document (it will increase after each
// change, including undo/redo).
Version int32 `json:"version"`
// The content of the opened text document.
Text string `json:"text"`
}
// A parameter literal used in requests to pass a text document and a position inside that
// document.
type TextDocumentPositionParams struct {
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The position inside the text document.
Position Position `json:"position"`
}
// General text document registration options.
type TextDocumentRegistrationOptions struct {
// A document selector to identify the scope of the registration. If set to null
// the document selector provided on the client side will be used.
DocumentSelector DocumentSelector `json:"documentSelector"`
}
// Represents reasons why a text document is saved.
type TextDocumentSaveReason uint32
// Save registration options.
type TextDocumentSaveRegistrationOptions struct {
TextDocumentRegistrationOptions
SaveOptions
}
type TextDocumentSyncClientCapabilities struct {
// Whether text document synchronization supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client supports sending will save notifications.
WillSave bool `json:"willSave,omitempty"`
// The client supports sending a will save request and
// waits for a response providing text edits which will
// be applied to the document before it is saved.
WillSaveWaitUntil bool `json:"willSaveWaitUntil,omitempty"`
// The client supports did save notifications.
DidSave bool `json:"didSave,omitempty"`
}
// Defines how the host (editor) should sync
// document changes to the language server.
type TextDocumentSyncKind uint32
type TextDocumentSyncOptions struct {
// Open and close notifications are sent to the server. If omitted open close notification should not
// be sent.
OpenClose bool `json:"openClose,omitempty"`
// Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
// and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
Change TextDocumentSyncKind `json:"change,omitempty"`
// If present will save notifications are sent to the server. If omitted the notification should not be
// sent.
WillSave bool `json:"willSave,omitempty"`
// If present will save wait until requests are sent to the server. If omitted the request should not be
// sent.
WillSaveWaitUntil bool `json:"willSaveWaitUntil,omitempty"`
// If present save notifications are sent to the server. If omitted the notification should not be
// sent.
Save *SaveOptions `json:"save,omitempty"`
}
// A text edit applicable to a text document.
type TextEdit struct {
// The range of the text document to be manipulated. To insert
// text into a document create a range where start === end.
Range Range `json:"range"`
// The string to be inserted. For delete operations use an
// empty string.
NewText string `json:"newText"`
}
type TokenFormat string
type TraceValues string
// Since 3.6.0
type TypeDefinitionClientCapabilities struct {
// Whether implementation supports dynamic registration. If this is set to `true`
// the client supports the new `TypeDefinitionRegistrationOptions` return value
// for the corresponding server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client supports additional metadata in the form of definition links.
//
// Since 3.14.0
LinkSupport bool `json:"linkSupport,omitempty"`
}
type TypeDefinitionOptions struct {
WorkDoneProgressOptions
}
type TypeDefinitionParams struct {
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
type TypeDefinitionRegistrationOptions struct {
TextDocumentRegistrationOptions
TypeDefinitionOptions
StaticRegistrationOptions
}
// @since 3.17.0
type TypeHierarchyClientCapabilities struct {
// Whether implementation supports dynamic registration. If this is set to `true`
// the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
// return value for the corresponding server capability as well.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// @since 3.17.0
type TypeHierarchyItem struct {
// The name of this item.
Name string `json:"name"`
// The kind of this item.
Kind SymbolKind `json:"kind"`
// Tags for this item.
Tags []SymbolTag `json:"tags,omitempty"`
// More detail for this item, e.g. the signature of a function.
Detail string `json:"detail,omitempty"`
// The resource identifier of this item.
URI DocumentURI `json:"uri"`
// The range enclosing this symbol not including leading/trailing whitespace
// but everything else, e.g. comments and code.
Range Range `json:"range"`
// The range that should be selected and revealed when this symbol is being
// picked, e.g. the name of a function. Must be contained by the
// {@link TypeHierarchyItem.range `range`}.
SelectionRange Range `json:"selectionRange"`
// A data entry field that is preserved between a type hierarchy prepare and
// supertypes or subtypes requests. It could also be used to identify the
// type hierarchy in the server, helping improve the performance on
// resolving supertypes and subtypes.
Data interface{} `json:"data,omitempty"`
}
// Type hierarchy options used during static registration.
//
// @since 3.17.0
type TypeHierarchyOptions struct {
WorkDoneProgressOptions
}
// The parameter of a `textDocument/prepareTypeHierarchy` request.
//
// @since 3.17.0
type TypeHierarchyPrepareParams struct {
TextDocumentPositionParams
WorkDoneProgressParams
}
// Type hierarchy options used during static or dynamic registration.
//
// @since 3.17.0
type TypeHierarchyRegistrationOptions struct {
TextDocumentRegistrationOptions
TypeHierarchyOptions
StaticRegistrationOptions
}
// The parameter of a `typeHierarchy/subtypes` request.
//
// @since 3.17.0
type TypeHierarchySubtypesParams struct {
Item TypeHierarchyItem `json:"item"`
WorkDoneProgressParams
PartialResultParams
}
// The parameter of a `typeHierarchy/supertypes` request.
//
// @since 3.17.0
type TypeHierarchySupertypesParams struct {
Item TypeHierarchyItem `json:"item"`
WorkDoneProgressParams
PartialResultParams
}
// created for Tuple
type UIntCommaUInt struct {
Fld0 uint32 `json:"fld0"`
Fld1 uint32 `json:"fld1"`
}
// A diagnostic report indicating that the last returned
// report is still accurate.
//
// @since 3.17.0
type UnchangedDocumentDiagnosticReport struct {
// A document diagnostic report indicating
// no changes to the last result. A server can
// only return `unchanged` if result ids are
// provided.
Kind string `json:"kind"`
// A result id which will be sent on the next
// diagnostic request for the same document.
ResultID string `json:"resultId"`
}
// Moniker uniqueness level to define scope of the moniker.
//
// @since 3.16.0
type UniquenessLevel string
// General parameters to unregister a request or notification.
type Unregistration struct {
// The id used to unregister the request or notification. Usually an id
// provided during the register request.
ID string `json:"id"`
// The method to unregister for.
Method string `json:"method"`
}
type UnregistrationParams struct {
Unregisterations []Unregistration `json:"unregisterations"`
}
// A versioned notebook document identifier.
//
// @since 3.17.0
type VersionedNotebookDocumentIdentifier struct {
// The version number of this notebook document.
Version int32 `json:"version"`
// The notebook document's uri.
URI URI `json:"uri"`
}
// A text document identifier to denote a specific version of a text document.
type VersionedTextDocumentIdentifier struct {
// The version number of this document.
Version int32 `json:"version"`
TextDocumentIdentifier
}
type WatchKind = uint32 // The parameters sent in a will save text document notification.
type WillSaveTextDocumentParams struct {
// The document that will be saved.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The 'TextDocumentSaveReason'.
Reason TextDocumentSaveReason `json:"reason"`
}
type WindowClientCapabilities struct {
// It indicates whether the client supports server initiated
// progress using the `window/workDoneProgress/create` request.
//
// The capability also controls Whether client supports handling
// of progress notifications. If set servers are allowed to report a
// `workDoneProgress` property in the request specific server
// capabilities.
//
// @since 3.15.0
WorkDoneProgress bool `json:"workDoneProgress,omitempty"`
// Capabilities specific to the showMessage request.
//
// @since 3.16.0
ShowMessage *ShowMessageRequestClientCapabilities `json:"showMessage,omitempty"`
// Capabilities specific to the showDocument request.
//
// @since 3.16.0
ShowDocument *ShowDocumentClientCapabilities `json:"showDocument,omitempty"`
}
type WorkDoneProgressBegin struct {
Kind string `json:"kind"`
// Mandatory title of the progress operation. Used to briefly inform about
// the kind of operation being performed.
//
// Examples: "Indexing" or "Linking dependencies".
Title string `json:"title"`
// Controls if a cancel button should show to allow the user to cancel the
// long running operation. Clients that don't support cancellation are allowed
// to ignore the setting.
Cancellable bool `json:"cancellable,omitempty"`
// Optional, more detailed associated progress message. Contains
// complementary information to the `title`.
//
// Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
// If unset, the previous progress message (if any) is still valid.
Message string `json:"message,omitempty"`
// Optional progress percentage to display (value 100 is considered 100%).
// If not provided infinite progress is assumed and clients are allowed
// to ignore the `percentage` value in subsequent in report notifications.
//
// The value should be steadily rising. Clients are free to ignore values
// that are not following this rule. The value range is [0, 100].
Percentage uint32 `json:"percentage,omitempty"`
}
type WorkDoneProgressCancelParams struct {
// The token to be used to report progress.
Token ProgressToken `json:"token"`
}
type WorkDoneProgressCreateParams struct {
// The token to be used to report progress.
Token ProgressToken `json:"token"`
}
type WorkDoneProgressEnd struct {
Kind string `json:"kind"`
// Optional, a final message indicating to for example indicate the outcome
// of the operation.
Message string `json:"message,omitempty"`
}
type WorkDoneProgressOptions struct {
WorkDoneProgress bool `json:"workDoneProgress,omitempty"`
}
// created for And
type WorkDoneProgressOptionsAndTextDocumentRegistrationOptions struct {
WorkDoneProgressOptions
TextDocumentRegistrationOptions
}
type WorkDoneProgressParams struct {
// An optional token that a server can use to report work done progress.
WorkDoneToken ProgressToken `json:"workDoneToken,omitempty"`
}
type WorkDoneProgressReport struct {
Kind string `json:"kind"`
// Controls enablement state of a cancel button.
//
// Clients that don't support cancellation or don't support controlling the button's
// enablement state are allowed to ignore the property.
Cancellable bool `json:"cancellable,omitempty"`
// Optional, more detailed associated progress message. Contains
// complementary information to the `title`.
//
// Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
// If unset, the previous progress message (if any) is still valid.
Message string `json:"message,omitempty"`
// Optional progress percentage to display (value 100 is considered 100%).
// If not provided infinite progress is assumed and clients are allowed
// to ignore the `percentage` value in subsequent in report notifications.
//
// The value should be steadily rising. Clients are free to ignore values
// that are not following this rule. The value range is [0, 100]
Percentage uint32 `json:"percentage,omitempty"`
}
// Workspace specific client capabilities.
type WorkspaceClientCapabilities struct {
// The client supports applying batch edits
// to the workspace by supporting the request
// 'workspace/applyEdit'
ApplyEdit bool `json:"applyEdit,omitempty"`
// Capabilities specific to `WorkspaceEdit`s.
WorkspaceEdit *WorkspaceEditClientCapabilities `json:"workspaceEdit,omitempty"`
// Capabilities specific to the `workspace/didChangeConfiguration` notification.
DidChangeConfiguration DidChangeConfigurationClientCapabilities `json:"didChangeConfiguration,omitempty"`
// Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
DidChangeWatchedFiles DidChangeWatchedFilesClientCapabilities `json:"didChangeWatchedFiles,omitempty"`
// Capabilities specific to the `workspace/symbol` request.
Symbol *WorkspaceSymbolClientCapabilities `json:"symbol,omitempty"`
// Capabilities specific to the `workspace/executeCommand` request.
ExecuteCommand *ExecuteCommandClientCapabilities `json:"executeCommand,omitempty"`
// The client has support for workspace folders.
//
// @since 3.6.0
WorkspaceFolders bool `json:"workspaceFolders,omitempty"`
// The client supports `workspace/configuration` requests.
//
// @since 3.6.0
Configuration bool `json:"configuration,omitempty"`
// Capabilities specific to the semantic token requests scoped to the
// workspace.
//
// @since 3.16.0.
SemanticTokens *SemanticTokensWorkspaceClientCapabilities `json:"semanticTokens,omitempty"`
// Capabilities specific to the code lens requests scoped to the
// workspace.
//
// @since 3.16.0.
CodeLens *CodeLensWorkspaceClientCapabilities `json:"codeLens,omitempty"`
// The client has support for file notifications/requests for user operations on files.
//
// Since 3.16.0
FileOperations *FileOperationClientCapabilities `json:"fileOperations,omitempty"`
// Capabilities specific to the inline values requests scoped to the
// workspace.
//
// @since 3.17.0.
InlineValue *InlineValueWorkspaceClientCapabilities `json:"inlineValue,omitempty"`
// Capabilities specific to the inlay hint requests scoped to the
// workspace.
//
// @since 3.17.0.
InlayHint *InlayHintWorkspaceClientCapabilities `json:"inlayHint,omitempty"`
// Capabilities specific to the diagnostic requests scoped to the
// workspace.
//
// @since 3.17.0.
Diagnostics *DiagnosticWorkspaceClientCapabilities `json:"diagnostics,omitempty"`
// Capabilities specific to the folding range requests scoped to the workspace.
//
// @since 3.18.0
// @proposed
FoldingRange *FoldingRangeWorkspaceClientCapabilities `json:"foldingRange,omitempty"`
}
// Parameters of the workspace diagnostic request.
//
// @since 3.17.0
type WorkspaceDiagnosticParams struct {
// The additional identifier provided during registration.
Identifier string `json:"identifier,omitempty"`
// The currently known diagnostic reports with their
// previous result ids.
PreviousResultIds []PreviousResultID `json:"previousResultIds"`
WorkDoneProgressParams
PartialResultParams
}
// A workspace diagnostic report.
//
// @since 3.17.0
type WorkspaceDiagnosticReport struct {
Items []WorkspaceDocumentDiagnosticReport `json:"items"`
}
// A partial result for a workspace diagnostic report.
//
// @since 3.17.0
type WorkspaceDiagnosticReportPartialResult struct {
Items []WorkspaceDocumentDiagnosticReport `json:"items"`
}
// A workspace diagnostic document report.
//
// @since 3.17.0
type WorkspaceDocumentDiagnosticReport = Or_WorkspaceDocumentDiagnosticReport // (alias)
// A workspace edit represents changes to many resources managed in the workspace. The edit
// should either provide `changes` or `documentChanges`. If documentChanges are present
// they are preferred over `changes` if the client can handle versioned document edits.
//
// Since version 3.13.0 a workspace edit can contain resource operations as well. If resource
// operations are present clients need to execute the operations in the order in which they
// are provided. So a workspace edit for example can consist of the following two changes:
// (1) a create file a.txt and (2) a text document edit which insert text into file a.txt.
//
// An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will
// cause failure of the operation. How the client recovers from the failure is described by
// the client capability: `workspace.workspaceEdit.failureHandling`
type WorkspaceEdit struct {
// Holds changes to existing resources.
Changes map[DocumentURI][]TextEdit `json:"changes,omitempty"`
// Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes
// are either an array of `TextDocumentEdit`s to express changes to n different text documents
// where each text document edit addresses a specific version of a text document. Or it can contain
// above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations.
//
// Whether a client supports versioned document edits is expressed via
// `workspace.workspaceEdit.documentChanges` client capability.
//
// If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then
// only plain `TextEdit`s using the `changes` property are supported.
DocumentChanges []DocumentChanges `json:"documentChanges,omitempty"`
// A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and
// delete file / folder operations.
//
// Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`.
//
// @since 3.16.0
ChangeAnnotations map[ChangeAnnotationIdentifier]ChangeAnnotation `json:"changeAnnotations,omitempty"`
}
type WorkspaceEditClientCapabilities struct {
// The client supports versioned document changes in `WorkspaceEdit`s
DocumentChanges bool `json:"documentChanges,omitempty"`
// The resource operations the client supports. Clients should at least
// support 'create', 'rename' and 'delete' files and folders.
//
// @since 3.13.0
ResourceOperations []ResourceOperationKind `json:"resourceOperations,omitempty"`
// The failure handling strategy of a client if applying the workspace edit
// fails.
//
// @since 3.13.0
FailureHandling *FailureHandlingKind `json:"failureHandling,omitempty"`
// Whether the client normalizes line endings to the client specific
// setting.
// If set to `true` the client will normalize line ending characters
// in a workspace edit to the client-specified new line
// character.
//
// @since 3.16.0
NormalizesLineEndings bool `json:"normalizesLineEndings,omitempty"`
// Whether the client in general supports change annotations on text edits,
// create file, rename file and delete file changes.
//
// @since 3.16.0
ChangeAnnotationSupport *ChangeAnnotationsSupportOptions `json:"changeAnnotationSupport,omitempty"`
}
// A workspace folder inside a client.
type WorkspaceFolder struct {
// The associated URI for this workspace folder.
URI URI `json:"uri"`
// The name of the workspace folder. Used to refer to this
// workspace folder in the user interface.
Name string `json:"name"`
}
type WorkspaceFolders5Gn struct {
// The server has support for workspace folders
Supported bool `json:"supported,omitempty"`
// Whether the server wants to receive workspace folder
// change notifications.
//
// If a string is provided the string is treated as an ID
// under which the notification is registered on the client
// side. The ID can be used to unregister for these events
// using the `client/unregisterCapability` request.
ChangeNotifications string `json:"changeNotifications,omitempty"`
}
// The workspace folder change event.
type WorkspaceFoldersChangeEvent struct {
// The array of added workspace folders
Added []WorkspaceFolder `json:"added"`
// The array of the removed workspace folders
Removed []WorkspaceFolder `json:"removed"`
}
type WorkspaceFoldersInitializeParams struct {
// The workspace folders configured in the client when the server starts.
//
// This property is only available if the client supports workspace folders.
// It can be `null` if the client supports workspace folders but none are
// configured.
//
// @since 3.6.0
WorkspaceFolders []WorkspaceFolder `json:"workspaceFolders,omitempty"`
}
type WorkspaceFoldersServerCapabilities struct {
// The server has support for workspace folders
Supported bool `json:"supported,omitempty"`
// Whether the server wants to receive workspace folder
// change notifications.
//
// If a string is provided the string is treated as an ID
// under which the notification is registered on the client
// side. The ID can be used to unregister for these events
// using the `client/unregisterCapability` request.
ChangeNotifications string `json:"changeNotifications,omitempty"`
}
// A full document diagnostic report for a workspace diagnostic result.
//
// @since 3.17.0
type WorkspaceFullDocumentDiagnosticReport struct {
// The URI for which diagnostic information is reported.
URI DocumentURI `json:"uri"`
// The version number for which the diagnostics are reported.
// If the document is not marked as open `null` can be provided.
Version int32 `json:"version"`
FullDocumentDiagnosticReport
}
// Defines workspace specific capabilities of the server.
//
// @since 3.18.0
// @proposed
type WorkspaceOptions struct {
// The server supports workspace folder.
//
// @since 3.6.0
WorkspaceFolders *WorkspaceFolders5Gn `json:"workspaceFolders,omitempty"`
// The server is interested in notifications/requests for operations on files.
//
// @since 3.16.0
FileOperations *FileOperationOptions `json:"fileOperations,omitempty"`
}
// A special workspace symbol that supports locations without a range.
//
// See also SymbolInformation.
//
// @since 3.17.0
type WorkspaceSymbol struct {
// The location of the symbol. Whether a server is allowed to
// return a location without a range depends on the client
// capability `workspace.symbol.resolveSupport`.
//
// See SymbolInformation#location for more details.
Location OrPLocation_workspace_symbol `json:"location"`
// A data entry field that is preserved on a workspace symbol between a
// workspace symbol request and a workspace symbol resolve request.
Data interface{} `json:"data,omitempty"`
BaseSymbolInformation
}
// Client capabilities for a {@link WorkspaceSymbolRequest}.
type WorkspaceSymbolClientCapabilities struct {
// Symbol request supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
SymbolKind *ClientSymbolKindOptions `json:"symbolKind,omitempty"`
// The client supports tags on `SymbolInformation`.
// Clients supporting tags have to handle unknown tags gracefully.
//
// @since 3.16.0
TagSupport *ClientSymbolTagOptions `json:"tagSupport,omitempty"`
// The client support partial workspace symbols. The client will send the
// request `workspaceSymbol/resolve` to the server to resolve additional
// properties.
//
// @since 3.17.0
ResolveSupport *ClientSymbolResolveOptions `json:"resolveSupport,omitempty"`
}
// Server capabilities for a {@link WorkspaceSymbolRequest}.
type WorkspaceSymbolOptions struct {
// The server provides support to resolve additional
// information for a workspace symbol.
//
// @since 3.17.0
ResolveProvider bool `json:"resolveProvider,omitempty"`
WorkDoneProgressOptions
}
// The parameters of a {@link WorkspaceSymbolRequest}.
type WorkspaceSymbolParams struct {
// A query string to filter symbols by. Clients may send an empty
// string here to request all symbols.
Query string `json:"query"`
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a {@link WorkspaceSymbolRequest}.
type WorkspaceSymbolRegistrationOptions struct {
WorkspaceSymbolOptions
}
// An unchanged document diagnostic report for a workspace diagnostic result.
//
// @since 3.17.0
type WorkspaceUnchangedDocumentDiagnosticReport struct {
// The URI for which diagnostic information is reported.
URI DocumentURI `json:"uri"`
// The version number for which the diagnostics are reported.
// If the document is not marked as open `null` can be provided.
Version int32 `json:"version"`
UnchangedDocumentDiagnosticReport
}
// The initialize parameters
type XInitializeParams struct {
// The process Id of the parent process that started
// the server.
//
// Is `null` if the process has not been started by another process.
// If the parent process is not alive then the server should exit.
ProcessID int32 `json:"processId"`
// Information about the client
//
// @since 3.15.0
ClientInfo *ClientInfo `json:"clientInfo,omitempty"`
// The locale the client is currently showing the user interface
// in. This must not necessarily be the locale of the operating
// system.
//
// Uses IETF language tags as the value's syntax
// (See https://en.wikipedia.org/wiki/IETF_language_tag)
//
// @since 3.16.0
Locale string `json:"locale,omitempty"`
// The rootPath of the workspace. Is null
// if no folder is open.
//
// @deprecated in favour of rootUri.
RootPath string `json:"rootPath,omitempty"`
// The rootUri of the workspace. Is null if no
// folder is open. If both `rootPath` and `rootUri` are set
// `rootUri` wins.
//
// @deprecated in favour of workspaceFolders.
RootURI DocumentURI `json:"rootUri"`
// The capabilities provided by the client (editor or tool)
Capabilities ClientCapabilities `json:"capabilities"`
// User provided initialization options.
InitializationOptions interface{} `json:"initializationOptions,omitempty"`
// The initial trace setting. If omitted trace is disabled ('off').
Trace *TraceValues `json:"trace,omitempty"`
WorkDoneProgressParams
}
// The initialize parameters
type _InitializeParams struct {
// The process Id of the parent process that started
// the server.
//
// Is `null` if the process has not been started by another process.
// If the parent process is not alive then the server should exit.
ProcessID int32 `json:"processId"`
// Information about the client
//
// @since 3.15.0
ClientInfo *ClientInfo `json:"clientInfo,omitempty"`
// The locale the client is currently showing the user interface
// in. This must not necessarily be the locale of the operating
// system.
//
// Uses IETF language tags as the value's syntax
// (See https://en.wikipedia.org/wiki/IETF_language_tag)
//
// @since 3.16.0
Locale string `json:"locale,omitempty"`
// The rootPath of the workspace. Is null
// if no folder is open.
//
// @deprecated in favour of rootUri.
RootPath string `json:"rootPath,omitempty"`
// The rootUri of the workspace. Is null if no
// folder is open. If both `rootPath` and `rootUri` are set
// `rootUri` wins.
//
// @deprecated in favour of workspaceFolders.
RootURI DocumentURI `json:"rootUri"`
// The capabilities provided by the client (editor or tool)
Capabilities ClientCapabilities `json:"capabilities"`
// User provided initialization options.
InitializationOptions interface{} `json:"initializationOptions,omitempty"`
// The initial trace setting. If omitted trace is disabled ('off').
Trace *TraceValues `json:"trace,omitempty"`
WorkDoneProgressParams
}
const (
// A set of predefined code action kinds
// Empty kind.
Empty CodeActionKind = ""
// Base kind for quickfix actions: 'quickfix'
QuickFix CodeActionKind = "quickfix"
// Base kind for refactoring actions: 'refactor'
Refactor CodeActionKind = "refactor"
// Base kind for refactoring extraction actions: 'refactor.extract'
//
// Example extract actions:
//
//
// - Extract method
// - Extract function
// - Extract variable
// - Extract interface from class
// - ...
RefactorExtract CodeActionKind = "refactor.extract"
// Base kind for refactoring inline actions: 'refactor.inline'
//
// Example inline actions:
//
//
// - Inline function
// - Inline variable
// - Inline constant
// - ...
RefactorInline CodeActionKind = "refactor.inline"
// Base kind for refactoring rewrite actions: 'refactor.rewrite'
//
// Example rewrite actions:
//
//
// - Convert JavaScript function to class
// - Add or remove parameter
// - Encapsulate field
// - Make method static
// - Move method to base class
// - ...
RefactorRewrite CodeActionKind = "refactor.rewrite"
// Base kind for source actions: `source`
//
// Source code actions apply to the entire file.
Source CodeActionKind = "source"
// Base kind for an organize imports source action: `source.organizeImports`
SourceOrganizeImports CodeActionKind = "source.organizeImports"
// Base kind for auto-fix source actions: `source.fixAll`.
//
// Fix all actions automatically fix errors that have a clear fix that do not require user input.
// They should not suppress errors or perform unsafe fixes such as generating new types or classes.
//
// @since 3.15.0
SourceFixAll CodeActionKind = "source.fixAll"
// The reason why code actions were requested.
//
// @since 3.17.0
// Code actions were explicitly requested by the user or by an extension.
CodeActionInvoked CodeActionTriggerKind = 1
// Code actions were requested automatically.
//
// This typically happens when current selection in a file changes, but can
// also be triggered when file content changes.
CodeActionAutomatic CodeActionTriggerKind = 2
// The kind of a completion entry.
TextCompletion CompletionItemKind = 1
MethodCompletion CompletionItemKind = 2
FunctionCompletion CompletionItemKind = 3
ConstructorCompletion CompletionItemKind = 4
FieldCompletion CompletionItemKind = 5
VariableCompletion CompletionItemKind = 6
ClassCompletion CompletionItemKind = 7
InterfaceCompletion CompletionItemKind = 8
ModuleCompletion CompletionItemKind = 9
PropertyCompletion CompletionItemKind = 10
UnitCompletion CompletionItemKind = 11
ValueCompletion CompletionItemKind = 12
EnumCompletion CompletionItemKind = 13
KeywordCompletion CompletionItemKind = 14
SnippetCompletion CompletionItemKind = 15
ColorCompletion CompletionItemKind = 16
FileCompletion CompletionItemKind = 17
ReferenceCompletion CompletionItemKind = 18
FolderCompletion CompletionItemKind = 19
EnumMemberCompletion CompletionItemKind = 20
ConstantCompletion CompletionItemKind = 21
StructCompletion CompletionItemKind = 22
EventCompletion CompletionItemKind = 23
OperatorCompletion CompletionItemKind = 24
TypeParameterCompletion CompletionItemKind = 25
// Completion item tags are extra annotations that tweak the rendering of a completion
// item.
//
// @since 3.15.0
// Render a completion as obsolete, usually using a strike-out.
ComplDeprecated CompletionItemTag = 1
// How a completion was triggered
// Completion was triggered by typing an identifier (24x7 code
// complete), manual invocation (e.g Ctrl+Space) or via API.
Invoked CompletionTriggerKind = 1
// Completion was triggered by a trigger character specified by
// the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
TriggerCharacter CompletionTriggerKind = 2
// Completion was re-triggered as current completion list is incomplete
TriggerForIncompleteCompletions CompletionTriggerKind = 3
// The diagnostic's severity.
// Reports an error.
SeverityError DiagnosticSeverity = 1
// Reports a warning.
SeverityWarning DiagnosticSeverity = 2
// Reports an information.
SeverityInformation DiagnosticSeverity = 3
// Reports a hint.
SeverityHint DiagnosticSeverity = 4
// The diagnostic tags.
//
// @since 3.15.0
// Unused or unnecessary code.
//
// Clients are allowed to render diagnostics with this tag faded out instead of having
// an error squiggle.
Unnecessary DiagnosticTag = 1
// Deprecated or obsolete code.
//
// Clients are allowed to rendered diagnostics with this tag strike through.
Deprecated DiagnosticTag = 2
// The document diagnostic report kinds.
//
// @since 3.17.0
// A diagnostic report with a full
// set of problems.
DiagnosticFull DocumentDiagnosticReportKind = "full"
// A report indicating that the last
// returned report is still accurate.
DiagnosticUnchanged DocumentDiagnosticReportKind = "unchanged"
// A document highlight kind.
// A textual occurrence.
Text DocumentHighlightKind = 1
// Read-access of a symbol, like reading a variable.
Read DocumentHighlightKind = 2
// Write-access of a symbol, like writing to a variable.
Write DocumentHighlightKind = 3
// Predefined error codes.
ParseError ErrorCodes = -32700
InvalidRequest ErrorCodes = -32600
MethodNotFound ErrorCodes = -32601
InvalidParams ErrorCodes = -32602
InternalError ErrorCodes = -32603
// Error code indicating that a server received a notification or
// request before the server has received the `initialize` request.
ServerNotInitialized ErrorCodes = -32002
UnknownErrorCode ErrorCodes = -32001
// Applying the workspace change is simply aborted if one of the changes provided
// fails. All operations executed before the failing operation stay executed.
Abort FailureHandlingKind = "abort"
// All operations are executed transactional. That means they either all
// succeed or no changes at all are applied to the workspace.
Transactional FailureHandlingKind = "transactional"
// If the workspace edit contains only textual file changes they are executed transactional.
// If resource changes (create, rename or delete file) are part of the change the failure
// handling strategy is abort.
TextOnlyTransactional FailureHandlingKind = "textOnlyTransactional"
// The client tries to undo the operations already executed. But there is no
// guarantee that this is succeeding.
Undo FailureHandlingKind = "undo"
// The file event type
// The file got created.
Created FileChangeType = 1
// The file got changed.
Changed FileChangeType = 2
// The file got deleted.
Deleted FileChangeType = 3
// A pattern kind describing if a glob pattern matches a file a folder or
// both.
//
// @since 3.16.0
// The pattern matches a file only.
FilePattern FileOperationPatternKind = "file"
// The pattern matches a folder only.
FolderPattern FileOperationPatternKind = "folder"
// A set of predefined range kinds.
// Folding range for a comment
Comment FoldingRangeKind = "comment"
// Folding range for an import or include
Imports FoldingRangeKind = "imports"
// Folding range for a region (e.g. `#region`)
Region FoldingRangeKind = "region"
// Inlay hint kinds.
//
// @since 3.17.0
// An inlay hint that for a type annotation.
Type InlayHintKind = 1
// An inlay hint that is for a parameter.
Parameter InlayHintKind = 2
// Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
//
// @since 3.18.0
// @proposed
// Completion was triggered explicitly by a user gesture.
InlineInvoked InlineCompletionTriggerKind = 0
// Completion was triggered automatically while editing.
InlineAutomatic InlineCompletionTriggerKind = 1
// Defines whether the insert text in a completion item should be interpreted as
// plain text or a snippet.
// The primary text to be inserted is treated as a plain string.
PlainTextTextFormat InsertTextFormat = 1
// The primary text to be inserted is treated as a snippet.
//
// A snippet can define tab stops and placeholders with `$1`, `$2`
// and `${3:foo}`. `$0` defines the final tab stop, it defaults to
// the end of the snippet. Placeholders with equal identifiers are linked,
// that is typing in one will update others too.
//
// See also: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#snippet_syntax
SnippetTextFormat InsertTextFormat = 2
// How whitespace and indentation is handled during completion
// item insertion.
//
// @since 3.16.0
// The insertion or replace strings is taken as it is. If the
// value is multi line the lines below the cursor will be
// inserted using the indentation defined in the string value.
// The client will not apply any kind of adjustments to the
// string.
AsIs InsertTextMode = 1
// The editor adjusts leading whitespace of new lines so that
// they match the indentation up to the cursor of the line for
// which the item is accepted.
//
// Consider a line like this: <2tabs><cursor><3tabs>foo. Accepting a
// multi line completion item is indented using 2 tabs and all
// following lines inserted will be indented using 2 tabs as well.
AdjustIndentation InsertTextMode = 2
// A request failed but it was syntactically correct, e.g the
// method name was known and the parameters were valid. The error
// message should contain human readable information about why
// the request failed.
//
// @since 3.17.0
RequestFailed LSPErrorCodes = -32803
// The server cancelled the request. This error code should
// only be used for requests that explicitly support being
// server cancellable.
//
// @since 3.17.0
ServerCancelled LSPErrorCodes = -32802
// The server detected that the content of a document got
// modified outside normal conditions. A server should
// NOT send this error code if it detects a content change
// in it unprocessed messages. The result even computed
// on an older state might still be useful for the client.
//
// If a client decides that a result is not of any use anymore
// the client should cancel the request.
ContentModified LSPErrorCodes = -32801
// The client has canceled a request and a server as detected
// the cancel.
RequestCancelled LSPErrorCodes = -32800
// Describes the content type that a client supports in various
// result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
//
// Please note that `MarkupKinds` must not start with a `$`. This kinds
// are reserved for internal usage.
// Plain text is supported as a content format
PlainText MarkupKind = "plaintext"
// Markdown is supported as a content format
Markdown MarkupKind = "markdown"
// The message type
// An error message.
Error MessageType = 1
// A warning message.
Warning MessageType = 2
// An information message.
Info MessageType = 3
// A log message.
Log MessageType = 4
// A debug message.
//
// @since 3.18.0
Debug MessageType = 5
// The moniker kind.
//
// @since 3.16.0
// The moniker represent a symbol that is imported into a project
Import MonikerKind = "import"
// The moniker represents a symbol that is exported from a project
Export MonikerKind = "export"
// The moniker represents a symbol that is local to a project (e.g. a local
// variable of a function, a class not visible outside the project, ...)
Local MonikerKind = "local"
// A notebook cell kind.
//
// @since 3.17.0
// A markup-cell is formatted source that is used for display.
Markup NotebookCellKind = 1
// A code-cell is source code.
Code NotebookCellKind = 2
// A set of predefined position encoding kinds.
//
// @since 3.17.0
// Character offsets count UTF-8 code units (e.g. bytes).
UTF8 PositionEncodingKind = "utf-8"
// Character offsets count UTF-16 code units.
//
// This is the default and must always be supported
// by servers
UTF16 PositionEncodingKind = "utf-16"
// Character offsets count UTF-32 code units.
//
// Implementation note: these are the same as Unicode codepoints,
// so this `PositionEncodingKind` may also be used for an
// encoding-agnostic representation of character offsets.
UTF32 PositionEncodingKind = "utf-32"
// The client's default behavior is to select the identifier
// according the to language's syntax rule.
Identifier PrepareSupportDefaultBehavior = 1
// Supports creating new files and folders.
Create ResourceOperationKind = "create"
// Supports renaming existing files and folders.
Rename ResourceOperationKind = "rename"
// Supports deleting existing files and folders.
Delete ResourceOperationKind = "delete"
// A set of predefined token modifiers. This set is not fixed
// an clients can specify additional token types via the
// corresponding client capabilities.
//
// @since 3.16.0
ModDeclaration SemanticTokenModifiers = "declaration"
ModDefinition SemanticTokenModifiers = "definition"
ModReadonly SemanticTokenModifiers = "readonly"
ModStatic SemanticTokenModifiers = "static"
ModDeprecated SemanticTokenModifiers = "deprecated"
ModAbstract SemanticTokenModifiers = "abstract"
ModAsync SemanticTokenModifiers = "async"
ModModification SemanticTokenModifiers = "modification"
ModDocumentation SemanticTokenModifiers = "documentation"
ModDefaultLibrary SemanticTokenModifiers = "defaultLibrary"
// A set of predefined token types. This set is not fixed
// an clients can specify additional token types via the
// corresponding client capabilities.
//
// @since 3.16.0
NamespaceType SemanticTokenTypes = "namespace"
// Represents a generic type. Acts as a fallback for types which can't be mapped to
// a specific type like class or enum.
TypeType SemanticTokenTypes = "type"
ClassType SemanticTokenTypes = "class"
EnumType SemanticTokenTypes = "enum"
InterfaceType SemanticTokenTypes = "interface"
StructType SemanticTokenTypes = "struct"
TypeParameterType SemanticTokenTypes = "typeParameter"
ParameterType SemanticTokenTypes = "parameter"
VariableType SemanticTokenTypes = "variable"
PropertyType SemanticTokenTypes = "property"
EnumMemberType SemanticTokenTypes = "enumMember"
EventType SemanticTokenTypes = "event"
FunctionType SemanticTokenTypes = "function"
MethodType SemanticTokenTypes = "method"
MacroType SemanticTokenTypes = "macro"
KeywordType SemanticTokenTypes = "keyword"
ModifierType SemanticTokenTypes = "modifier"
CommentType SemanticTokenTypes = "comment"
StringType SemanticTokenTypes = "string"
NumberType SemanticTokenTypes = "number"
RegexpType SemanticTokenTypes = "regexp"
OperatorType SemanticTokenTypes = "operator"
// @since 3.17.0
DecoratorType SemanticTokenTypes = "decorator"
// How a signature help was triggered.
//
// @since 3.15.0
// Signature help was invoked manually by the user or by a command.
SigInvoked SignatureHelpTriggerKind = 1
// Signature help was triggered by a trigger character.
SigTriggerCharacter SignatureHelpTriggerKind = 2
// Signature help was triggered by the cursor moving or by the document content changing.
SigContentChange SignatureHelpTriggerKind = 3
// A symbol kind.
File SymbolKind = 1
Module SymbolKind = 2
Namespace SymbolKind = 3
Package SymbolKind = 4
Class SymbolKind = 5
Method SymbolKind = 6
Property SymbolKind = 7
Field SymbolKind = 8
Constructor SymbolKind = 9
Enum SymbolKind = 10
Interface SymbolKind = 11
Function SymbolKind = 12
Variable SymbolKind = 13
Constant SymbolKind = 14
String SymbolKind = 15
Number SymbolKind = 16
Boolean SymbolKind = 17
Array SymbolKind = 18
Object SymbolKind = 19
Key SymbolKind = 20
Null SymbolKind = 21
EnumMember SymbolKind = 22
Struct SymbolKind = 23
Event SymbolKind = 24
Operator SymbolKind = 25
TypeParameter SymbolKind = 26
// Symbol tags are extra annotations that tweak the rendering of a symbol.
//
// @since 3.16
// Render a symbol as obsolete, usually using a strike-out.
DeprecatedSymbol SymbolTag = 1
// Represents reasons why a text document is saved.
// Manually triggered, e.g. by the user pressing save, by starting debugging,
// or by an API call.
Manual TextDocumentSaveReason = 1
// Automatic after a delay.
AfterDelay TextDocumentSaveReason = 2
// When the editor lost focus.
FocusOut TextDocumentSaveReason = 3
// Defines how the host (editor) should sync
// document changes to the language server.
// Documents should not be synced at all.
None TextDocumentSyncKind = 0
// Documents are synced by always sending the full content
// of the document.
Full TextDocumentSyncKind = 1
// Documents are synced by sending the full content on open.
// After that only incremental updates to the document are
// send.
Incremental TextDocumentSyncKind = 2
Relative TokenFormat = "relative"
// Turn tracing off.
Off TraceValues = "off"
// Trace messages only.
Messages TraceValues = "messages"
// Verbose message tracing.
Verbose TraceValues = "verbose"
// Moniker uniqueness level to define scope of the moniker.
//
// @since 3.16.0
// The moniker is only unique inside a document
Document UniquenessLevel = "document"
// The moniker is unique inside a project for which a dump got created
Project UniquenessLevel = "project"
// The moniker is unique inside the group to which a project belongs
Group UniquenessLevel = "group"
// The moniker is unique inside the moniker scheme.
Scheme UniquenessLevel = "scheme"
// The moniker is globally unique
Global UniquenessLevel = "global"
// Interested in create events.
WatchCreate WatchKind = 1
// Interested in change events
WatchChange WatchKind = 2
// Interested in delete events
WatchDelete WatchKind = 4
)
|