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
|
;;; ada-mode.el --- major-mode for editing Ada sources
;; Copyright (C) 1994, 95, 97, 98, 99, 2000, 2001
;; Free Software Foundation, Inc.
;; Author: Rolf Ebert <ebert@inf.enst.fr>
;; Markus Heritsch <Markus.Heritsch@studbox.uni-stuttgart.de>
;; Emmanuel Briot <briot@gnat.com>
;; Maintainer: Emmanuel Briot <briot@gnat.com>
;; Ada Core Technologies's version: $Revision: 1.43.4.2 $
;; Keywords: languages ada
;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; Commentary:
;;; This mode is a major mode for editing Ada83 and Ada95 source code.
;;; This is a major rewrite of the file packaged with Emacs-20. The
;;; ada-mode is composed of four lisp file, ada-mode.el, ada-xref.el,
;;; ada-prj.el and ada-stmt.el. Only this file (ada-mode.el) is
;;; completely independent from the GNU Ada compiler Gnat, distributed
;;; by Ada Core Technologies. All the other files rely heavily on
;;; features provided only by Gnat.
;;;
;;; Note: this mode will not work with Emacs 19. If you are on a VMS
;;; system, where the latest version of Emacs is 19.28, you will need
;;; another file, called ada-vms.el, that provides some required
;;; functions.
;;; Usage:
;;; Emacs should enter Ada mode automatically when you load an Ada file.
;;; By default, the valid extensions for Ada files are .ads, .adb or .ada
;;; If the ada-mode does not start automatically, then simply type the
;;; following command :
;;; M-x ada-mode
;;;
;;; By default, ada-mode is configured to take full advantage of the GNAT
;;; compiler (the menus will include the cross-referencing features,...).
;;; If you are using another compiler, you might want to set the following
;;; variable in your .emacs (Note: do not set this in the ada-mode-hook, it
;;; won't work) :
;;; (setq ada-which-compiler 'generic)
;;;
;;; This mode requires find-file.el to be present on your system.
;;; History:
;;; The first Ada mode for GNU Emacs was written by V. Broman in
;;; 1985. He based his work on the already existing Modula-2 mode.
;;; This was distributed as ada.el in versions of Emacs prior to 19.29.
;;;
;;; Lynn Slater wrote an extensive Ada mode in 1989. It consisted of
;;; several files with support for dired commands and other nice
;;; things. It is currently available from the PAL
;;; (wuarchive.wustl.edu:/languages/ada) as ada-mode-1.06a.tar.Z.
;;;
;;; The probably very first Ada mode (called electric-ada.el) was
;;; written by Steven D. Litvintchouk and Steven M. Rosen for the
;;; Gosling Emacs. L. Slater based his development on ada.el and
;;; electric-ada.el.
;;;
;;; A complete rewrite by M. Heritsch and R. Ebert has been done.
;;; Some ideas from the Ada mode mailing list have been
;;; added. Some of the functionality of L. Slater's mode has not
;;; (yet) been recoded in this new mode. Perhaps you prefer sticking
;;; to his version.
;;;
;;; A complete rewrite for Emacs-20 / Gnat-3.11 has been done by Ada Core
;;; Technologies. Please send bugs to briot@gnat.com
;;; Credits:
;;; Many thanks to John McCabe <john@assen.demon.co.uk> for sending so
;;; many patches included in this package.
;;; Christian Egli <Christian.Egli@hcsd.hac.com>:
;;; ada-imenu-generic-expression
;;; Many thanks also to the following persons that have contributed one day
;;; to the ada-mode
;;; Philippe Waroquiers (PW) <philippe@cfmu.eurocontrol.be> in particular,
;;; woodruff@stc.llnl.gov (John Woodruff)
;;; jj@ddci.dk (Jesper Joergensen)
;;; gse@ocsystems.com (Scott Evans)
;;; comar@gnat.com (Cyrille Comar)
;;; stephen.leake@gsfc.nasa.gov (Stephen Leake)
;;; and others for their valuable hints.
;;; Code:
;;; Note: Every function in this package is compiler-independent.
;;; The names start with ada-
;;; The variables that the user can edit can all be modified through
;;; the customize mode. They are sorted in alphabetical order in this
;;; file.
;; this function is needed at compile time
(eval-and-compile
(defun ada-check-emacs-version (major minor &optional is-xemacs)
"Returns t if Emacs's version is greater or equal to MAJOR.MINOR.
If IS-XEMACS is non-nil, check for XEmacs instead of Emacs."
(let ((xemacs-running (or (string-match "Lucid" emacs-version)
(string-match "XEmacs" emacs-version))))
(and (or (and is-xemacs xemacs-running)
(not (or is-xemacs xemacs-running)))
(or (> emacs-major-version major)
(and (= emacs-major-version major)
(>= emacs-minor-version minor)))))))
;; We create a constant for that, for efficiency only
;; This should be evaluated both at compile time, only a runtime
(eval-and-compile
(defconst ada-xemacs (and (boundp 'running-xemacs)
(symbol-value 'running-xemacs))
"Return t if we are using XEmacs."))
(unless ada-xemacs
(require 'outline))
(eval-and-compile
(condition-case nil (require 'find-file) (error nil)))
;; This call should not be made in the release that is done for the
;; official FSF Emacs, since it does nothing useful for the latest version
;; (require 'ada-support)
(defvar ada-mode-hook nil
"*List of functions to call when Ada mode is invoked.
This hook is automatically executed after the ada-mode is
fully loaded.
This is a good place to add Ada environment specific bindings.")
(defgroup ada nil
"Major mode for editing Ada source in Emacs."
:group 'languages)
(defcustom ada-auto-case t
"*Non-nil means automatically change case of preceding word while typing.
Casing is done according to `ada-case-keyword', `ada-case-identifier'
and `ada-case-attribute'."
:type 'boolean :group 'ada)
(defcustom ada-broken-decl-indent 0
"*Number of columns to indent a broken declaration.
An example is :
declare
A,
>>>>>B : Integer; -- from ada-broken-decl-indent"
:type 'integer :group 'ada)
(defcustom ada-broken-indent 2
"*Number of columns to indent the continuation of a broken line.
An example is :
My_Var : My_Type := (Field1 =>
>>>>>>>>>Value); -- from ada-broken-indent"
:type 'integer :group 'ada)
(defcustom ada-case-attribute 'ada-capitalize-word
"*Function to call to adjust the case of Ada attributes.
It may be `downcase-word', `upcase-word', `ada-loose-case-word',
`ada-capitalize-word' or `ada-no-auto-case'."
:type '(choice (const downcase-word)
(const upcase-word)
(const ada-capitalize-word)
(const ada-loose-case-word)
(const ada-no-auto-case))
:group 'ada)
(defcustom ada-case-exception-file '("~/.emacs_case_exceptions")
"*List of special casing exceptions dictionaries for identifiers.
The first file is the one where new exceptions will be saved by Emacs
when you call `ada-create-case-exception'.
These files should contain one word per line, that gives the casing
to be used for that word in Ada files. Each line can be terminated by
a comment."
:type '(repeat (file))
:group 'ada)
(defcustom ada-case-keyword 'downcase-word
"*Function to call to adjust the case of an Ada keywords.
It may be `downcase-word', `upcase-word', `ada-loose-case-word' or
`ada-capitalize-word'."
:type '(choice (const downcase-word)
(const upcase-word)
(const ada-capitalize-word)
(const ada-loose-case-word)
(const ada-no-auto-case))
:group 'ada)
(defcustom ada-case-identifier 'ada-loose-case-word
"*Function to call to adjust the case of an Ada identifier.
It may be `downcase-word', `upcase-word', `ada-loose-case-word' or
`ada-capitalize-word'."
:type '(choice (const downcase-word)
(const upcase-word)
(const ada-capitalize-word)
(const ada-loose-case-word)
(const ada-no-auto-case))
:group 'ada)
(defcustom ada-clean-buffer-before-saving t
"*Non-nil means remove trailing spaces and untabify the buffer before saving."
:type 'boolean :group 'ada)
(defcustom ada-indent 3
"*Size of Ada indentation.
An example is :
procedure Foo is
begin
>>>>>>>>>>null; -- from ada-indent"
:type 'integer :group 'ada)
(defcustom ada-indent-after-return t
"*Non-nil means automatically indent after RET or LFD."
:type 'boolean :group 'ada)
(defcustom ada-indent-align-comments t
"*Non-nil means align comments on previous line comments, if any.
If nil, indentation is calculated as usual.
Note that indentation is calculated only if `ada-indent-comment-as-code' is t.
For instance:
A := 1; -- A multi-line comment
-- aligned if ada-indent-align-comments is t"
:type 'boolean :group 'ada)
(defcustom ada-indent-comment-as-code t
"*Non-nil means indent comment lines as code.
Nil means do not auto-indent comments."
:type 'boolean :group 'ada)
(defcustom ada-indent-is-separate t
"*Non-nil means indent 'is separate' or 'is abstract' if on a single line."
:type 'boolean :group 'ada)
(defcustom ada-indent-record-rel-type 3
"*Indentation for 'record' relative to 'type' or 'use'.
An example is:
type A is
>>>>>>>>>>>record -- from ada-indent-record-rel-type"
:type 'integer :group 'ada)
(defcustom ada-indent-renames ada-broken-indent
"*Indentation for renames relative to the matching function statement.
If ada-indent-return is null or negative, the indentation is done relative to
the open parenthesis (if there is no parenthesis, ada-broken-indent is used).
An example is:
function A (B : Integer)
return C; -- from ada-indent-return
>>>renames Foo; -- from ada-indent-renames"
:type 'integer :group 'ada)
(defcustom ada-indent-return 0
"*Indentation for 'return' relative to the matching 'function' statement.
If ada-indent-return is null or negative, the indentation is done relative to
the open parenthesis (if there is no parenthesis, ada-broken-indent is used).
An example is:
function A (B : Integer)
>>>>>return C; -- from ada-indent-return"
:type 'integer :group 'ada)
(defcustom ada-indent-to-open-paren t
"*Non-nil means indent according to the innermost open parenthesis."
:type 'boolean :group 'ada)
(defcustom ada-fill-comment-prefix "-- "
"*Text inserted in the first columns when filling a comment paragraph.
Note: if you modify this variable, you will have to restart the `ada-mode' to
reread this variable."
:type 'string :group 'ada)
(defcustom ada-fill-comment-postfix " --"
"*Text inserted at the end of each line when filling a comment paragraph.
with `ada-fill-comment-paragraph-postfix'."
:type 'string :group 'ada)
(defcustom ada-label-indent -4
"*Number of columns to indent a label.
An example is:
procedure Foo is
begin
>>>>>>>>>>>>Label: -- from ada-label-indent"
:type 'integer :group 'ada)
(defcustom ada-language-version 'ada95
"*Do we program in `ada83' or `ada95'?"
:type '(choice (const ada83) (const ada95)) :group 'ada)
(defcustom ada-move-to-declaration nil
"*Non-nil means `ada-move-to-start' moves point to the subprogram declaration,
not to 'begin'."
:type 'boolean :group 'ada)
(defcustom ada-popup-key '[down-mouse-3]
"*Key used for binding the contextual menu.
If nil, no contextual menu is available."
:type '(restricted-sexp :match-alternatives (stringp vectorp))
:group 'ada)
(defcustom ada-search-directories
'("." "$ADA_INCLUDE_PATH" "/usr/adainclude" "/usr/local/adainclude"
"/opt/gnu/adainclude")
"*List of directories to search for Ada files.
See the description for the `ff-search-directories' variable.
Emacs will automatically add the paths defined in your project file, and if you
are using the GNAT compiler the output of the gnatls command to find where the
runtime really is."
:type '(repeat (choice :tag "Directory"
(const :tag "default" nil)
(directory :format "%v")))
:group 'ada)
(defcustom ada-stmt-end-indent 0
"*Number of columns to indent the end of a statement on a separate line.
An example is:
if A = B
>>>>>>>>>>>then -- from ada-stmt-end-indent"
:type 'integer :group 'ada)
(defcustom ada-tab-policy 'indent-auto
"*Control the behavior of the TAB key.
Must be one of :
`indent-rigidly' : always adds ada-indent blanks at the beginning of the line.
`indent-auto' : use indentation functions in this file.
`always-tab' : do indent-relative."
:type '(choice (const indent-auto)
(const indent-rigidly)
(const always-tab))
:group 'ada)
(defcustom ada-use-indent ada-broken-indent
"*Indentation for the lines in a 'use' statement.
An example is:
use Ada.Text_IO,
>>>>>Ada.Numerics; -- from ada-use-indent"
:type 'integer :group 'ada)
(defcustom ada-when-indent 3
"*Indentation for 'when' relative to 'exception' or 'case'.
An example is:
case A is
>>>>>>>>when B => -- from ada-when-indent"
:type 'integer :group 'ada)
(defcustom ada-with-indent ada-broken-indent
"*Indentation for the lines in a 'with' statement.
An example is:
with Ada.Text_IO,
>>>>>Ada.Numerics; -- from ada-with-indent"
:type 'integer :group 'ada)
(defcustom ada-which-compiler 'gnat
"*Name of the compiler to use.
This will determine what features are made available through the ada-mode.
The possible choices are :
`gnat': Use Ada Core Technologies' Gnat compiler. Add some cross-referencing
features
`generic': Use a generic compiler"
:type '(choice (const gnat)
(const generic))
:group 'ada)
;;; ---- end of user configurable variables
(defvar ada-body-suffixes '(".adb")
"List of possible suffixes for Ada body files.
The extensions should include a `.' if needed.")
(defvar ada-spec-suffixes '(".ads")
"List of possible suffixes for Ada spec files.
The extensions should include a `.' if needed.")
(defvar ada-mode-menu (make-sparse-keymap "Ada")
"Menu for ada-mode.")
(defvar ada-mode-map (make-sparse-keymap)
"Local keymap used for Ada mode.")
(defvar ada-mode-abbrev-table nil
"Local abbrev table for Ada mode.")
(defvar ada-mode-syntax-table nil
"Syntax table to be used for editing Ada source code.")
(defvar ada-mode-symbol-syntax-table nil
"Syntax table for Ada, where `_' is a word constituent.")
(eval-when-compile
(defconst ada-83-string-keywords
'("abort" "abs" "accept" "access" "all" "and" "array" "at" "begin"
"body" "case" "constant" "declare" "delay" "delta" "digits" "do"
"else" "elsif" "end" "entry" "exception" "exit" "for" "function"
"generic" "goto" "if" "in" "is" "limited" "loop" "mod" "new"
"not" "null" "of" "or" "others" "out" "package" "pragma" "private"
"procedure" "raise" "range" "record" "rem" "renames" "return"
"reverse" "select" "separate" "subtype" "task" "terminate" "then"
"type" "use" "when" "while" "with" "xor")
"List of Ada keywords.
This variable is used to define `ada-83-keywords' and `ada-95-keywords'"))
(defvar ada-ret-binding nil
"Variable to save key binding of RET when casing is activated.")
(defvar ada-case-exception '()
"Alist of words (entities) that have special casing.")
(defvar ada-lfd-binding nil
"Variable to save key binding of LFD when casing is activated.")
(defvar ada-other-file-alist nil
"Variable used by find-file to find the name of the other package.
See `ff-other-file-alist'.")
;;; ---- Below are the regexp used in this package for parsing
(defconst ada-83-keywords
(eval-when-compile
(concat "\\<" (regexp-opt ada-83-string-keywords t) "\\>"))
"Regular expression for looking at Ada83 keywords.")
(defconst ada-95-keywords
(eval-when-compile
(concat "\\<" (regexp-opt
(append
'("abstract" "aliased" "protected" "requeue"
"tagged" "until")
ada-83-string-keywords) t) "\\>"))
"Regular expression for looking at Ada95 keywords.")
(defvar ada-keywords ada-95-keywords
"Regular expression for looking at Ada keywords.")
(defconst ada-ident-re
"\\(\\sw\\|[_.]\\)+"
"Regexp matching Ada (qualified) identifiers.")
(defvar ada-procedure-start-regexp
"^[ \t]*\\(procedure\\|function\\|task\\)[ \t\n]+\\(\\(\\sw\\|[_.]\\)+\\)"
"Regexp used to find Ada procedures/functions.")
(defvar ada-package-start-regexp
"^[ \t]*\\(package\\)"
"Regexp used to find Ada packages.")
;;; ---- regexps for indentation functions
(defvar ada-block-start-re
(eval-when-compile
(concat "\\<\\(" (regexp-opt '("begin" "declare" "else"
"exception" "generic" "loop" "or"
"private" "select" ))
"\\|\\(\\(limited\\|abstract\\|tagged\\)[ \t\n]+\\)*record\\)\\>"))
"Regexp for keywords starting Ada blocks.")
(defvar ada-end-stmt-re
(eval-when-compile
(concat "\\("
";" "\\|"
"=>[ \t]*$" "\\|"
"^[ \t]*separate[ \t]*(\\(\\sw\\|[_.]\\)+)" "\\|"
"\\<" (regexp-opt '("begin" "declare" "is" "do" "else" "generic"
"loop" "private" "record" "select"
"then abort" "then") t) "\\>" "\\|"
"^[ \t]*" (regexp-opt '("function" "package" "procedure")
t) "\\>\\(\\sw\\|[ \t_.]\\)+\\<is\\>" "\\|"
"^[ \t]*exception\\>"
"\\)") )
"Regexp of possible ends for a non-broken statement.
A new statement starts after these.")
(defvar ada-matching-start-re
(eval-when-compile
(concat "\\<"
(regexp-opt
'("end" "loop" "select" "begin" "case" "do"
"if" "task" "package" "record" "protected") t)
"\\>"))
"Regexp used in ada-goto-matching-start.")
(defvar ada-matching-decl-start-re
(eval-when-compile
(concat "\\<"
(regexp-opt
'("is" "separate" "end" "declare" "if" "new" "begin" "generic" "when") t)
"\\>"))
"Regexp used in ada-goto-matching-decl-start.")
(defvar ada-loop-start-re
"\\<\\(for\\|while\\|loop\\)\\>"
"Regexp for the start of a loop.")
(defvar ada-subprog-start-re
(eval-when-compile
(concat "\\<" (regexp-opt '("accept" "entry" "function" "package" "procedure"
"protected" "task") t) "\\>"))
"Regexp for the start of a subprogram.")
(defvar ada-named-block-re
"[ \t]*\\(\\sw\\|_\\)+[ \t]*:[^=]"
"Regexp of the name of a block or loop.")
(defvar ada-contextual-menu-on-identifier nil
"Set to true when the right mouse button was clicked on an identifier.")
(defvar ada-contextual-menu-last-point nil
"Position of point just before displaying the menu.
This is a list (point buffer).
Since `ada-popup-menu' moves the point where the user clicked, the region
is modified. Therefore no command from the menu knows what the user selected
before displaying the contextual menu.
To get the original region, restore the point to this position before
calling `region-end' and `region-beginning'.
Modify this variable if you want to restore the point to another position.")
(defvar ada-contextual-menu
(if ada-xemacs
'("Ada"
["Goto Declaration/Body"
(ada-call-from-contextual-menu 'ada-point-and-xref)
:included (and (functionp 'ada-point-and-xref)
ada-contextual-menu-on-identifier)]
["Goto Previous Reference"
(ada-call-from-contextual-menu 'ada-xref-goto-previous-reference)
:included (functionp 'ada-xref-goto-previous-reference)]
["List References" ada-find-references
:included ada-contextual-menu-on-identifier]
["-" nil nil]
["Other File" ff-find-other-file]
["Goto Parent Unit" ada-goto-parent]
)
(let ((map (make-sparse-keymap "Ada")))
;; The identifier part
(if (equal ada-which-compiler 'gnat)
(progn
(define-key-after map [Ref]
'(menu-item "Goto Declaration/Body"
(lambda()(interactive)
(ada-call-from-contextual-menu
'ada-point-and-xref))
:visible
(and (functionp 'ada-point-and-xref)
ada-contextual-menu-on-identifier))
t)
(define-key-after map [Prev]
'(menu-item "Goto Previous Reference"
(lambda()(interactive)
(ada-call-from-contextual-menu
'ada-xref-goto-previous-reference))
:visible
(functionp 'ada-xref-goto-previous-reference))
t)
(define-key-after map [List]
'(menu-item "List References"
ada-find-references
:visible ada-contextual-menu-on-identifier) t)
(define-key-after map [-] '("-" nil) t)
))
(define-key-after map [Other] '("Other file" . ff-find-other-file) t)
(define-key-after map [Parent] '("Goto Parent Unit" . ada-goto-parent)t)
map))
"Defines the menu to use when the user presses the right mouse button.
The variable `ada-contextual-menu-on-identifier' will be set to t before
displaying the menu if point was on an identifier."
)
;;------------------------------------------------------------------
;; Support for imenu (see imenu.el)
;;------------------------------------------------------------------
(defconst ada-imenu-subprogram-menu-re
"^[ \t]*\\(procedure\\|function\\)[ \t\n]+\\(\\(\\sw\\|_\\)+\\)[ \t\n]*\\([ \t\n]\\|([^)]+)\\)[ \t\n]*\\(return[ \t\n]+\\(\\sw\\|[_.]\\)+[ \t\n]*\\)?is[ \t\n]")
(defvar ada-imenu-generic-expression
(list
(list nil ada-imenu-subprogram-menu-re 2)
(list "*Specs*"
(concat
"^[ \t]*\\(procedure\\|function\\)[ \t\n]+\\(\\(\\sw\\|_\\)+\\)"
"\\("
"\\([ \t\n]+\\|[ \t\n]*([^)]+)\\)";; parameter list or simple space
"\\([ \t\n]*return[ \t\n]+\\(\\sw\\|[_.]\\)+[ \t\n]*\\)?"
"\\)?;") 2)
'("*Tasks*" "^[ \t]*task[ \t]+\\(\\(body\\|type\\)[ \t]+\\)?\\(\\(\\sw\\|_\\)+\\)" 3)
'("*Type Defs*" "^[ \t]*\\(sub\\)?type[ \t]+\\(\\(\\sw\\|_\\)+\\)" 2)
'("*Packages*" "^[ \t]*package[ \t]+\\(\\(body[ \t]+\\)?\\(\\sw\\|[_.]\\)+\\)" 1))
"Imenu generic expression for Ada mode.
See `imenu-generic-expression'. This variable will create two submenus, one
for type and subtype definitions, the other for subprograms declarations.
The main menu will reference the bodies of the subprograms.")
;;------------------------------------------------------------
;; Support for compile.el
;;------------------------------------------------------------
(defun ada-compile-mouse-goto-error ()
"Mouse interface for ada-compile-goto-error."
(interactive)
(mouse-set-point last-input-event)
(ada-compile-goto-error (point))
)
(defun ada-compile-goto-error (pos)
"Replaces `compile-goto-error' from compile.el.
If POS is on a file and line location, go to this position. It adds to
compile.el the capacity to go to a reference in an error message.
For instance, on this line:
foo.adb:61:11: [...] in call to size declared at foo.ads:11
both file locations can be clicked on and jumped to."
(interactive "d")
(goto-char pos)
(skip-chars-backward "-a-zA-Z0-9_:./\\")
(cond
;; special case: looking at a filename:line not at the beginning of a line
((and (not (bolp))
(looking-at
"\\([-_.a-zA-Z0-9]+\\):\\([0-9]+\\)\\(:\\([0-9]+\\)\\)?"))
(let ((line (match-string 2))
(error-pos (point-marker))
source)
(save-excursion
(save-restriction
(widen)
;; Use funcall so as to prevent byte-compiler warnings
(set-buffer (funcall (symbol-function 'compilation-find-file)
(point-marker) (match-string 1)
"./"))
(if (stringp line)
(goto-line (string-to-number line)))
(setq source (point-marker))))
(funcall (symbol-function 'compilation-goto-locus)
(cons source error-pos))
))
;; otherwise, default behavior
(t
(funcall (symbol-function 'compile-goto-error)))
)
(recenter))
;;-------------------------------------------------------------------------
;; Grammar related function
;; The functions below work with the syntax class of the characters in an Ada
;; buffer. Two syntax tables are created, depending on whether we want '_'
;; to be considered as part of a word or not.
;; Some characters may have multiple meanings depending on the context:
;; - ' is either the beginning of a constant character or an attribute
;; - # is either part of a based litteral or a gnatprep statement.
;; - " starts a string, but not if inside a constant character.
;; - ( and ) should be ignored if inside a constant character.
;; Thus their syntax property is changed automatically, and we can still use
;; the standard Emacs functions for sexp (see `ada-in-string-p')
;;
;; On Emacs, this is done through the `syntax-table' text property. The
;; modification is done automatically each time the user as typed a new
;; character. This is already done in `font-lock-mode' (in
;; `font-lock-syntactic-keywords', so we take advantage of the existing
;; mechanism. If font-lock-mode is not activated, we do it by hand in
;; `ada-after-change-function', thanks to `ada-deactivate-properties' and
;; `ada-initialize-properties'.
;;
;; on XEmacs, the `syntax-table' property does not exist and we have to use a
;; slow advice to `parse-partial-sexp' to do the same thing.
;; When executing parse-partial-sexp, we simply modify the strings before and
;; after, so that the special constants '"', '(' and ')' do not interact
;; with parse-partial-sexp.
;; Note: this code is slow and needs to be rewritten as soon as something
;; better is available on XEmacs.
;;-------------------------------------------------------------------------
(defun ada-create-syntax-table ()
"Create the two syntax tables use in the Ada mode.
The standard table declares `_' as a symbol constituent, the second one
declares it as a word constituent."
(interactive)
(setq ada-mode-syntax-table (make-syntax-table))
(set-syntax-table ada-mode-syntax-table)
;; define string brackets (`%' is alternative string bracket, but
;; almost never used as such and throws font-lock and indentation
;; off the track.)
(modify-syntax-entry ?% "$" ada-mode-syntax-table)
(modify-syntax-entry ?\" "\"" ada-mode-syntax-table)
(modify-syntax-entry ?: "." ada-mode-syntax-table)
(modify-syntax-entry ?\; "." ada-mode-syntax-table)
(modify-syntax-entry ?& "." ada-mode-syntax-table)
(modify-syntax-entry ?\| "." ada-mode-syntax-table)
(modify-syntax-entry ?+ "." ada-mode-syntax-table)
(modify-syntax-entry ?* "." ada-mode-syntax-table)
(modify-syntax-entry ?/ "." ada-mode-syntax-table)
(modify-syntax-entry ?= "." ada-mode-syntax-table)
(modify-syntax-entry ?< "." ada-mode-syntax-table)
(modify-syntax-entry ?> "." ada-mode-syntax-table)
(modify-syntax-entry ?$ "." ada-mode-syntax-table)
(modify-syntax-entry ?\[ "." ada-mode-syntax-table)
(modify-syntax-entry ?\] "." ada-mode-syntax-table)
(modify-syntax-entry ?\{ "." ada-mode-syntax-table)
(modify-syntax-entry ?\} "." ada-mode-syntax-table)
(modify-syntax-entry ?. "." ada-mode-syntax-table)
(modify-syntax-entry ?\\ "." ada-mode-syntax-table)
(modify-syntax-entry ?\' "." ada-mode-syntax-table)
;; a single hyphen is punctuation, but a double hyphen starts a comment
(modify-syntax-entry ?- ". 12" ada-mode-syntax-table)
;; See the comment above on grammar related function for the special
;; setup for '#'.
(if ada-xemacs
(modify-syntax-entry ?# "<" ada-mode-syntax-table)
(modify-syntax-entry ?# "$" ada-mode-syntax-table))
;; and \f and \n end a comment
(modify-syntax-entry ?\f "> " ada-mode-syntax-table)
(modify-syntax-entry ?\n "> " ada-mode-syntax-table)
;; define what belongs in Ada symbols
(modify-syntax-entry ?_ "_" ada-mode-syntax-table)
;; define parentheses to match
(modify-syntax-entry ?\( "()" ada-mode-syntax-table)
(modify-syntax-entry ?\) ")(" ada-mode-syntax-table)
(setq ada-mode-symbol-syntax-table (copy-syntax-table ada-mode-syntax-table))
(modify-syntax-entry ?_ "w" ada-mode-symbol-syntax-table)
)
;; Support of special characters in XEmacs (see the comments at the beginning
;; of the section on Grammar related functions).
(if ada-xemacs
(defadvice parse-partial-sexp (around parse-partial-sexp-protect-constants)
"Handles special character constants and gnatprep statements."
(let (change)
(if (< to from)
(let ((tmp from))
(setq from to to tmp)))
(save-excursion
(goto-char from)
(while (re-search-forward "'\\([(\")#]\\)'" to t)
(setq change (cons (list (match-beginning 1)
1
(match-string 1))
change))
(replace-match "'A'"))
(goto-char from)
(while (re-search-forward "\\(#[0-9a-fA-F]*#\\)" to t)
(setq change (cons (list (match-beginning 1)
(length (match-string 1))
(match-string 1))
change))
(replace-match (make-string (length (match-string 1)) ?@))))
ad-do-it
(save-excursion
(while change
(goto-char (caar change))
(delete-char (cadar change))
(insert (caddar change))
(setq change (cdr change)))))))
(defun ada-deactivate-properties ()
"Deactivate ada-mode's properties handling.
This would be a duplicate of font-lock if both are used at the same time."
(remove-hook 'after-change-functions 'ada-after-change-function t))
(defun ada-initialize-properties ()
"Initialize some special text properties in the whole buffer.
In particular, character constants are said to be strings, #...# are treated
as numbers instead of gnatprep comments."
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(while (re-search-forward "'.'" nil t)
(add-text-properties (match-beginning 0) (match-end 0)
'(syntax-table ("'" . ?\"))))
(goto-char (point-min))
(while (re-search-forward "^[ \t]*#" nil t)
(add-text-properties (match-beginning 0) (match-end 0)
'(syntax-table (11 . 10))))
(set-buffer-modified-p nil)
;; Setting this only if font-lock is not set won't work
;; if the user activates or deactivates font-lock-mode,
;; but will make things faster most of the time
(make-local-hook 'after-change-functions)
(add-hook 'after-change-functions 'ada-after-change-function nil t)
)))
(defun ada-after-change-function (beg end old-len)
"Called when the region between BEG and END was changed in the buffer.
OLD-LEN indicates what the length of the replaced text was."
(let ((inhibit-point-motion-hooks t)
(eol (point)))
(save-excursion
(save-match-data
(beginning-of-line)
(remove-text-properties (point) eol '(syntax-table nil))
(while (re-search-forward "'.'" eol t)
(add-text-properties (match-beginning 0) (match-end 0)
'(syntax-table ("'" . ?\"))))
(beginning-of-line)
(if (looking-at "^[ \t]*#")
(add-text-properties (match-beginning 0) (match-end 0)
'(syntax-table (11 . 10))))
))))
;;------------------------------------------------------------------
;; Testing the grammatical context
;;------------------------------------------------------------------
(defsubst ada-in-comment-p (&optional parse-result)
"Returns t if inside a comment."
(nth 4 (or parse-result
(parse-partial-sexp
(save-excursion (beginning-of-line) (point)) (point)))))
(defsubst ada-in-string-p (&optional parse-result)
"Returns t if point is inside a string.
If parse-result is non-nil, use is instead of calling parse-partial-sexp."
(nth 3 (or parse-result
(parse-partial-sexp
(save-excursion (beginning-of-line) (point)) (point)))))
(defsubst ada-in-string-or-comment-p (&optional parse-result)
"Returns t if inside a comment or string."
(setq parse-result (or parse-result
(parse-partial-sexp
(save-excursion (beginning-of-line) (point)) (point))))
(or (ada-in-string-p parse-result) (ada-in-comment-p parse-result)))
;;------------------------------------------------------------------
;; Contextual menus
;; The Ada-mode comes with contextual menus, bound by default to the right
;; mouse button.
;; Add items to this menu by modifying `ada-contextual-menu'. Note that the
;; variable `ada-contextual-menu-on-identifier' is set automatically to t
;; if the mouse button was pressed on an identifier.
;;------------------------------------------------------------------
(defun ada-call-from-contextual-menu (function)
"Execute FUNCTION when called from the contextual menu.
It forces Emacs to change the cursor position."
(interactive)
(funcall function)
(setq ada-contextual-menu-last-point
(list (point) (current-buffer))))
(defun ada-popup-menu (position)
"Pops up a contextual menu, depending on where the user clicked.
POSITION is the location the mouse was clicked on.
Sets `ada-contextual-menu-last-point' to the current position before
displaying the menu. When a function from the menu is called, the point is
where the mouse button was clicked."
(interactive "e")
;; declare this as a local variable, so that the function called
;; in the contextual menu does not hide the region in
;; transient-mark-mode.
(let ((deactivate-mark nil))
(setq ada-contextual-menu-last-point
(list (point) (current-buffer)))
(mouse-set-point last-input-event)
(setq ada-contextual-menu-on-identifier
(and (char-after)
(or (= (char-syntax (char-after)) ?w)
(= (char-after) ?_))
(not (ada-in-string-or-comment-p))
(save-excursion (skip-syntax-forward "w")
(not (ada-after-keyword-p)))
))
(let (choice)
(if ada-xemacs
(setq choice (funcall (symbol-function 'popup-menu)
ada-contextual-menu))
(setq choice (x-popup-menu position ada-contextual-menu)))
(if choice
(funcall (lookup-key ada-contextual-menu (vector (car choice))))))
(set-buffer (cadr ada-contextual-menu-last-point))
(goto-char (car ada-contextual-menu-last-point))
))
;;------------------------------------------------------------------
;; Misc functions
;;------------------------------------------------------------------
;;;###autoload
(defun ada-add-extensions (spec body)
"Define SPEC and BODY as being valid extensions for Ada files.
Going from body to spec with `ff-find-other-file' used these
extensions.
SPEC and BODY are two regular expressions that must match against the file
name"
(let* ((reg (concat (regexp-quote body) "$"))
(tmp (assoc reg ada-other-file-alist)))
(if tmp
(setcdr tmp (list (cons spec (cadr tmp))))
(add-to-list 'ada-other-file-alist (list reg (list spec)))))
(let* ((reg (concat (regexp-quote spec) "$"))
(tmp (assoc reg ada-other-file-alist)))
(if tmp
(setcdr tmp (list (cons body (cadr tmp))))
(add-to-list 'ada-other-file-alist (list reg (list body)))))
(add-to-list 'auto-mode-alist
(cons (concat (regexp-quote spec) "\\'") 'ada-mode))
(add-to-list 'auto-mode-alist
(cons (concat (regexp-quote body) "\\'") 'ada-mode))
(add-to-list 'ada-spec-suffixes spec)
(add-to-list 'ada-body-suffixes body)
;; Support for speedbar (Specifies that we want to see these files in
;; speedbar)
(condition-case nil
(progn
(require 'speedbar)
(funcall (symbol-function 'speedbar-add-supported-extension)
spec)
(funcall (symbol-function 'speedbar-add-supported-extension)
body)))
)
;;;###autoload
(defun ada-mode ()
"Ada mode is the major mode for editing Ada code.
Bindings are as follows: (Note: 'LFD' is control-j.)
Indent line '\\[ada-tab]'
Indent line, insert newline and indent the new line. '\\[newline-and-indent]'
Re-format the parameter-list point is in '\\[ada-format-paramlist]'
Indent all lines in region '\\[ada-indent-region]'
Adjust case of identifiers and keywords in region '\\[ada-adjust-case-region]'
Adjust case of identifiers and keywords in buffer '\\[ada-adjust-case-buffer]'
Fill comment paragraph, justify and append postfix '\\[fill-paragraph]'
Next func/proc/task '\\[ada-next-procedure]' Previous func/proc/task '\\[ada-previous-procedure]'
Next package '\\[ada-next-package]' Previous package '\\[ada-previous-package]'
Goto matching start of current 'end ...;' '\\[ada-move-to-start]'
Goto end of current block '\\[ada-move-to-end]'
Comments are handled using standard GNU Emacs conventions, including:
Start a comment '\\[indent-for-comment]'
Comment region '\\[comment-region]'
Uncomment region '\\[ada-uncomment-region]'
Continue comment on next line '\\[indent-new-comment-line]'
If you use imenu.el:
Display index-menu of functions & procedures '\\[imenu]'
If you use find-file.el:
Switch to other file (Body <-> Spec) '\\[ff-find-other-file]'
or '\\[ff-mouse-find-other-file]
Switch to other file in other window '\\[ada-ff-other-window]'
or '\\[ff-mouse-find-other-file-other-window]
If you use this function in a spec and no body is available, it gets created with body stubs.
If you use ada-xref.el:
Goto declaration: '\\[ada-point-and-xref]' on the identifier
or '\\[ada-goto-declaration]' with point on the identifier
Complete identifier: '\\[ada-complete-identifier]'."
(interactive)
(kill-all-local-variables)
(set (make-local-variable 'require-final-newline) t)
(make-local-variable 'comment-start)
(if ada-fill-comment-prefix
(setq comment-start ada-fill-comment-prefix)
(setq comment-start "-- "))
;; Set the paragraph delimiters so that one can select a whole block
;; simply with M-h
(set (make-local-variable 'paragraph-start) "[ \t\n\f]*$")
(set (make-local-variable 'paragraph-separate) "[ \t\n\f]*$")
;; comment end must be set because it may hold a wrong value if
;; this buffer had been in another mode before. RE
(set (make-local-variable 'comment-end) "")
;; used by autofill and indent-new-comment-line
(set (make-local-variable 'comment-start-skip) "---*[ \t]*")
;; used by autofill to break a comment line and continue it on another line.
;; The reason we need this one is that the default behavior does not work
;; correctly with the definition of paragraph-start above when the comment
;; is right after a multi-line subprogram declaration (the comments are
;; aligned under the latest parameter, not under the declaration start).
(set (make-local-variable 'comment-line-break-function)
(lambda (&optional soft) (let ((fill-prefix nil))
(indent-new-comment-line soft))))
(set (make-local-variable 'indent-line-function)
'ada-indent-current-function)
(set (make-local-variable 'comment-column) 40)
;; Emacs 20.3 defines a comment-padding to insert spaces between
;; the comment and the text. We do not want any, this is already
;; included in comment-start
(set (make-local-variable 'comment-padding) 0)
(set (make-local-variable 'parse-sexp-ignore-comments) t)
(set (make-local-variable 'parse-sexp-lookup-properties) t)
(setq case-fold-search t)
(setq imenu-case-fold-search t)
(set (make-local-variable 'fill-paragraph-function)
'ada-fill-comment-paragraph)
(set (make-local-variable 'imenu-generic-expression)
ada-imenu-generic-expression)
;; Support for compile.el
;; We just substitute our own functions to go to the error.
(add-hook 'compilation-mode-hook
(lambda()
(set (make-local-variable 'compile-auto-highlight) 40)
;; FIXME: This has global impact! -stef
(define-key compilation-minor-mode-map [mouse-2]
'ada-compile-mouse-goto-error)
(define-key compilation-minor-mode-map "\C-c\C-c"
'ada-compile-goto-error)
(define-key compilation-minor-mode-map "\C-m"
'ada-compile-goto-error)))
;; font-lock support
(set (make-local-variable 'font-lock-defaults)
'(ada-font-lock-keywords
nil t
((?\_ . "w") (?# . "."))
beginning-of-line
(font-lock-syntactic-keywords . ada-font-lock-syntactic-keywords)))
;; Set up support for find-file.el.
(set (make-local-variable 'ff-other-file-alist)
'ada-other-file-alist)
(set (make-local-variable 'ff-search-directories)
'ada-search-directories)
(setq ff-post-load-hooks 'ada-set-point-accordingly
ff-file-created-hooks 'ada-make-body)
(add-hook 'ff-pre-load-hooks 'ada-which-function-are-we-in)
;; Some special constructs for find-file.el
;; We do not need to add the construction for 'with', which is in the
;; standard find-file.el
(make-local-variable 'ff-special-constructs)
;; Go to the parent package :
(add-to-list 'ff-special-constructs
(cons (eval-when-compile
(concat "^\\(private[ \t]\\)?[ \t]*package[ \t]+"
"\\(body[ \t]+\\)?"
"\\(\\(\\sw\\|[_.]\\)+\\)\\.\\(\\sw\\|_\\)+[ \t\n]+is"))
(lambda ()
(setq fname (ff-get-file
ada-search-directories
(ada-make-filename-from-adaname
(match-string 3))
ada-spec-suffixes)))))
;; Another special construct for find-file.el : when in a separate clause,
;; go to the correct package.
(add-to-list 'ff-special-constructs
(cons "^separate[ \t\n]*(\\(\\(\\sw\\|[_.]\\)+\\))"
(lambda ()
(setq fname (ff-get-file
ada-search-directories
(ada-make-filename-from-adaname
(match-string 1))
ada-spec-suffixes)))))
;; Another special construct, that redefines the one in find-file.el. The
;; old one can handle only one possible type of extension for Ada files
;; remove from the list the standard "with..." that is put by find-file.el,
;; since it uses the old ada-spec-suffix variable
;; This one needs to replace the standard one defined in find-file.el (with
;; Emacs <= 20.4), since that one uses the old variable ada-spec-suffix
(let ((old-construct
(assoc "^with[ \t]+\\([a-zA-Z0-9_\\.]+\\)" ff-special-constructs))
(new-cdr
(lambda ()
(setq fname (ff-get-file
ada-search-directories
(ada-make-filename-from-adaname
(match-string 1))
ada-spec-suffixes)))))
(if old-construct
(setcdr old-construct new-cdr)
(add-to-list 'ff-special-constructs
(cons "^with[ \t]+\\([a-zA-Z0-9_\\.]+\\)"
new-cdr))))
;; Support for outline-minor-mode
(set (make-local-variable 'outline-regexp)
"\\([ \t]*\\(procedure\\|function\\|package\\|if\\|while\\|for\\|declare\\|case\\|end\\|begin\\|loop\\)\\|--\\)")
(set (make-local-variable 'outline-level) 'ada-outline-level)
;; Support for imenu : We want a sorted index
(setq imenu-sort-function 'imenu--sort-by-name)
;; Support for which-function-mode is provided in ada-support (support
;; for nested subprograms)
;; Set up the contextual menu
(if ada-popup-key
(define-key ada-mode-map ada-popup-key 'ada-popup-menu))
;; Support for Abbreviations (the user still need to "M-x abbrev-mode"
(define-abbrev-table 'ada-mode-abbrev-table ())
(setq local-abbrev-table ada-mode-abbrev-table)
;; Support for indent-new-comment-line (Especially for XEmacs)
(setq comment-multi-line nil)
(setq major-mode 'ada-mode)
(setq mode-name "Ada")
(use-local-map ada-mode-map)
(easy-menu-add ada-mode-menu ada-mode-map)
(set-syntax-table ada-mode-syntax-table)
(if ada-clean-buffer-before-saving
(progn
;; remove all spaces at the end of lines in the whole buffer.
(add-hook 'local-write-file-hooks 'delete-trailing-whitespace)
;; convert all tabs to the correct number of spaces.
(add-hook 'local-write-file-hooks
(lambda () (untabify (point-min) (point-max))))))
(run-hooks 'ada-mode-hook)
;; Run this after the hook to give the users a chance to activate
;; font-lock-mode
(unless ada-xemacs
(ada-initialize-properties)
(make-local-hook 'font-lock-mode-hook)
(add-hook 'font-lock-mode-hook 'ada-deactivate-properties nil t))
;; the following has to be done after running the ada-mode-hook
;; because users might want to set the values of these variable
;; inside the hook (MH)
(cond ((eq ada-language-version 'ada83)
(setq ada-keywords ada-83-keywords))
((eq ada-language-version 'ada95)
(setq ada-keywords ada-95-keywords)))
(if ada-auto-case
(ada-activate-keys-for-case)))
;;-----------------------------------------------------------------
;; auto-casing
;; Since Ada is case-insensitive, the Ada-mode provides an extensive set of
;; functions to auto-case identifiers, keywords, ...
;; The basic rules for autocasing are defined through the variables
;; `ada-case-attribute', `ada-case-keyword' and `ada-case-identifier'. These
;; are references to the functions that will do the actual casing.
;;
;; However, in most cases, the user will want to define some exceptions to
;; these casing rules. This is done through a list of files, that contain
;; one word per line. These files are stored in `ada-case-exception-file'.
;; For backward compatibility, this variable can also be a string.
;;-----------------------------------------------------------------
(defun ada-create-case-exception (&optional word)
"Defines WORD as an exception for the casing system.
If WORD is not given, then the current word in the buffer is used instead.
The new words is added to the first file in `ada-case-exception-file'.
The standard casing rules will no longer apply to this word."
(interactive)
(let ((previous-syntax-table (syntax-table))
(exception-list '())
file-name
)
(cond ((stringp ada-case-exception-file)
(setq file-name ada-case-exception-file))
((listp ada-case-exception-file)
(setq file-name (car ada-case-exception-file)))
(t
(error "No exception file specified")))
(set-syntax-table ada-mode-symbol-syntax-table)
(unless word
(save-excursion
(skip-syntax-backward "w")
(setq word (buffer-substring-no-properties
(point) (save-excursion (forward-word 1) (point))))))
;; Reread the exceptions file, in case it was modified by some other,
;; and to keep the end-of-line comments that may exist in it.
(if (file-readable-p (expand-file-name file-name))
(let ((buffer (current-buffer)))
(find-file (expand-file-name file-name))
(set-syntax-table ada-mode-symbol-syntax-table)
(widen)
(goto-char (point-min))
(while (not (eobp))
(add-to-list 'exception-list
(list
(buffer-substring-no-properties
(point) (save-excursion (forward-word 1) (point)))
(buffer-substring-no-properties
(save-excursion (forward-word 1) (point))
(save-excursion (end-of-line) (point)))
t))
(forward-line 1))
(kill-buffer nil)
(set-buffer buffer)))
;; If the word is already in the list, even with a different casing
;; we simply want to replace it.
(if (and (not (equal exception-list '()))
(assoc-ignore-case word exception-list))
(setcar (assoc-ignore-case word exception-list)
word)
(add-to-list 'exception-list (list word "" t))
)
(if (and (not (equal ada-case-exception '()))
(assoc-ignore-case word ada-case-exception))
(setcar (assoc-ignore-case word ada-case-exception)
word)
(add-to-list 'ada-case-exception (cons word t))
)
;; Save the list in the file
(find-file (expand-file-name file-name))
(erase-buffer)
(mapcar (lambda (x) (insert (car x) (nth 1 x) "\n"))
(sort exception-list
(lambda(a b) (string< (car a) (car b)))))
(save-buffer)
(kill-buffer nil)
(set-syntax-table previous-syntax-table)
))
(defun ada-case-read-exceptions-from-file (file-name)
"Read the content of the casing exception file FILE-NAME."
(if (file-readable-p (expand-file-name file-name))
(let ((buffer (current-buffer)))
(find-file (expand-file-name file-name))
(set-syntax-table ada-mode-symbol-syntax-table)
(widen)
(goto-char (point-min))
(while (not (eobp))
;; If the item is already in the list, even with an other casing,
;; do not add it again. This way, the user can easily decide which
;; priority should be applied to each casing exception
(let ((word (buffer-substring-no-properties
(point) (save-excursion (forward-word 1) (point)))))
(unless (assoc-ignore-case word ada-case-exception)
(add-to-list 'ada-case-exception (cons word t))))
(forward-line 1))
(kill-buffer nil)
(set-buffer buffer)))
)
(defun ada-case-read-exceptions ()
"Read all the casing exception files from `ada-case-exception-file'."
(interactive)
;; Reinitialize the casing exception list
(setq ada-case-exception '())
(cond ((stringp ada-case-exception-file)
(ada-case-read-exceptions-from-file ada-case-exception-file))
((listp ada-case-exception-file)
(mapcar 'ada-case-read-exceptions-from-file
ada-case-exception-file))))
(defun ada-adjust-case-identifier ()
"Adjust case of the previous identifier.
The auto-casing is done according to the value of `ada-case-identifier' and
the exceptions defined in `ada-case-exception-file'."
(interactive)
(if (or (equal ada-case-exception '())
(equal (char-after) ?_))
(funcall ada-case-identifier -1)
(progn
(let ((end (point))
(start (save-excursion (skip-syntax-backward "w")
(point)))
match)
;; If we have an exception, replace the word by the correct casing
(if (setq match (assoc-ignore-case (buffer-substring start end)
ada-case-exception))
(progn
(delete-region start end)
(insert (car match)))
;; Else simply re-case the word
(funcall ada-case-identifier -1))))))
(defun ada-after-keyword-p ()
"Returns t if cursor is after a keyword that is not an attribute."
(save-excursion
(forward-word -1)
(and (not (and (char-before)
(or (= (char-before) ?_)
(= (char-before) ?'))));; unless we have a _ or '
(looking-at (concat ada-keywords "[^_]")))))
(defun ada-adjust-case (&optional force-identifier)
"Adjust the case of the word before the just typed character.
If FORCE-IDENTIFIER is non-nil then also adjust keyword as identifier."
(forward-char -1)
(if (and (> (point) 1)
;; or if at the end of a character constant
(not (and (eq (char-after) ?')
(eq (char-before (1- (point))) ?')))
;; or if the previous character was not part of a word
(eq (char-syntax (char-before)) ?w)
;; if in a string or a comment
(not (ada-in-string-or-comment-p))
)
(if (save-excursion
(forward-word -1)
(or (= (point) (point-min))
(backward-char 1))
(= (char-after) ?'))
(funcall ada-case-attribute -1)
(if (and
(not force-identifier) ; (MH)
(ada-after-keyword-p))
(funcall ada-case-keyword -1)
(ada-adjust-case-identifier))))
(forward-char 1)
)
(defun ada-adjust-case-interactive (arg)
"Adjust the case of the previous word, and process the character just typed.
ARG is the prefix the user entered with \C-u."
(interactive "P")
(if ada-auto-case
(let ((lastk last-command-char)
(previous-syntax-table (syntax-table)))
(unwind-protect
(progn
(set-syntax-table ada-mode-symbol-syntax-table)
(cond ((or (eq lastk ?\n)
(eq lastk ?\r))
;; horrible kludge
(insert " ")
(ada-adjust-case)
;; horrible dekludge
(delete-backward-char 1)
;; some special keys and their bindings
(cond
((eq lastk ?\n)
(funcall ada-lfd-binding))
((eq lastk ?\r)
(funcall ada-ret-binding))))
((eq lastk ?\C-i) (ada-tab))
;; Else just insert the character
((self-insert-command (prefix-numeric-value arg))))
;; if there is a keyword in front of the underscore
;; then it should be part of an identifier (MH)
(if (eq lastk ?_)
(ada-adjust-case t)
(ada-adjust-case))
)
;; Restore the syntax table
(set-syntax-table previous-syntax-table))
)
;; Else, no auto-casing
(cond
((eq last-command-char ?\n)
(funcall ada-lfd-binding))
((eq last-command-char ?\r)
(funcall ada-ret-binding))
(t
(self-insert-command (prefix-numeric-value arg))))
))
(defun ada-activate-keys-for-case ()
"Modifies the key bindings for all the keys that should readjust the casing."
(interactive)
;; Save original key-bindings to allow swapping ret/lfd
;; when casing is activated.
;; The 'or ...' is there to be sure that the value will not
;; be changed again when Ada mode is called more than once
(or ada-ret-binding (setq ada-ret-binding (key-binding "\C-M")))
(or ada-lfd-binding (setq ada-lfd-binding (key-binding "\C-j")))
;; Call case modifying function after certain keys.
(mapcar (function (lambda(key) (define-key
ada-mode-map
(char-to-string key)
'ada-adjust-case-interactive)))
'( ?` ?_ ?# ?% ?& ?* ?( ?) ?- ?= ?+
?| ?\; ?: ?' ?\" ?< ?, ?. ?> ?/ ?\n 32 ?\r )))
(defun ada-loose-case-word (&optional arg)
"Upcase first letter and letters following `_' in the following word.
No other letter is modified.
ARG is ignored, and is there for compatibility with `capitalize-word' only."
(interactive)
(save-excursion
(let ((end (save-excursion (skip-syntax-forward "w") (point)))
(first t))
(skip-syntax-backward "w")
(while (and (or first (search-forward "_" end t))
(< (point) end))
(and first
(setq first nil))
(insert-char (upcase (following-char)) 1)
(delete-char 1)))))
(defun ada-no-auto-case (&optional arg)
"Does nothing.
This function can be used for the auto-casing variables in the ada-mode, to
adapt to unusal auto-casing schemes. Since it does nothing, you can for
instance use it for `ada-case-identifier' if you don't want any special
auto-casing for identifiers, whereas keywords have to be lower-cased.
See also `ada-auto-case' to disable auto casing altogether."
)
(defun ada-capitalize-word (&optional arg)
"Upcase first letter and letters following '_', lower case other letters.
ARG is ignored, and is there for compatibility with `capitalize-word' only."
(interactive)
(let ((end (save-excursion (skip-syntax-forward "w") (point)))
(begin (save-excursion (skip-syntax-backward "w") (point))))
(modify-syntax-entry ?_ "_")
(capitalize-region begin end)
(modify-syntax-entry ?_ "w")))
(defun ada-adjust-case-region (from to)
"Adjusts the case of all words in the region between FROM and TO.
Attention: This function might take very long for big regions !"
(interactive "*r")
(let ((begin nil)
(end nil)
(keywordp nil)
(attribp nil)
(previous-syntax-table (syntax-table)))
(message "Adjusting case ...")
(unwind-protect
(save-excursion
(set-syntax-table ada-mode-symbol-syntax-table)
(goto-char to)
;;
;; loop: look for all identifiers, keywords, and attributes
;;
(while (re-search-backward "\\<\\(\\sw+\\)\\>" from t)
(setq end (match-end 1))
(setq attribp
(and (> (point) from)
(save-excursion
(forward-char -1)
(setq attribp (looking-at "'.[^']")))))
(or
;; do nothing if it is a string or comment
(ada-in-string-or-comment-p)
(progn
;;
;; get the identifier or keyword or attribute
;;
(setq begin (point))
(setq keywordp (looking-at ada-keywords))
(goto-char end)
;;
;; casing according to user-option
;;
(if attribp
(funcall ada-case-attribute -1)
(if keywordp
(funcall ada-case-keyword -1)
(ada-adjust-case-identifier)))
(goto-char begin))))
(message "Adjusting case ... Done"))
(set-syntax-table previous-syntax-table))))
(defun ada-adjust-case-buffer ()
"Adjusts the case of all words in the whole buffer.
ATTENTION: This function might take very long for big buffers !"
(interactive "*")
(ada-adjust-case-region (point-min) (point-max)))
;;--------------------------------------------------------------
;; Format Parameter Lists
;; Some special algorithms are provided to indent the parameter lists in
;; subprogram declarations. This is done in two steps:
;; - First parses the parameter list. The returned list has the following
;; format:
;; ( (<Param_Name> in? out? access? <Type_Name> <Default_Expression>)
;; ... )
;; This is done in `ada-scan-paramlist'.
;; - Delete and recreate the parameter list in function
;; `ada-insert-paramlist'.
;; Both steps are called from `ada-format-paramlist'.
;; Note: Comments inside the parameter list are lost.
;; The syntax has to be correct, or the reformating will fail.
;;--------------------------------------------------------------
(defun ada-format-paramlist ()
"Reformats the parameter list point is in."
(interactive)
(let ((begin nil)
(end nil)
(delend nil)
(paramlist nil)
(previous-syntax-table (syntax-table)))
(unwind-protect
(progn
(set-syntax-table ada-mode-symbol-syntax-table)
;; check if really inside parameter list
(or (ada-in-paramlist-p)
(error "not in parameter list"))
;; find start of current parameter-list
(ada-search-ignore-string-comment
(concat ada-subprog-start-re "\\|\\<body\\>" ) t nil)
(down-list 1)
(backward-char 1)
(setq begin (point))
;; find end of parameter-list
(forward-sexp 1)
(setq delend (point))
(delete-char -1)
(insert "\n")
;; find end of last parameter-declaration
(forward-comment -1000)
(setq end (point))
;; build a list of all elements of the parameter-list
(setq paramlist (ada-scan-paramlist (1+ begin) end))
;; delete the original parameter-list
(delete-region begin delend)
;; insert the new parameter-list
(goto-char begin)
(ada-insert-paramlist paramlist))
;; restore syntax-table
(set-syntax-table previous-syntax-table)
)))
(defun ada-scan-paramlist (begin end)
"Scan the parameter list found in between BEGIN and END.
Returns the equivalent internal parameter list."
(let ((paramlist (list))
(param (list))
(notend t)
(apos nil)
(epos nil)
(semipos nil)
(match-cons nil))
(goto-char begin)
;; loop until end of last parameter
(while notend
;; find first character of parameter-declaration
(ada-goto-next-non-ws)
(setq apos (point))
;; find last character of parameter-declaration
(if (setq match-cons
(ada-search-ignore-string-comment "[ \t\n]*;" nil end t))
(progn
(setq epos (car match-cons))
(setq semipos (cdr match-cons)))
(setq epos end))
;; read name(s) of parameter(s)
(goto-char apos)
(looking-at "\\(\\(\\sw\\|[_, \t\n]\\)*\\(\\sw\\|_\\)\\)[ \t\n]*:[^=]")
(setq param (list (match-string 1)))
(ada-search-ignore-string-comment ":" nil epos t 'search-forward)
;; look for 'in'
(setq apos (point))
(setq param
(append param
(list
(consp
(ada-search-ignore-string-comment
"in" nil epos t 'word-search-forward)))))
;; look for 'out'
(goto-char apos)
(setq param
(append param
(list
(consp
(ada-search-ignore-string-comment
"out" nil epos t 'word-search-forward)))))
;; look for 'access'
(goto-char apos)
(setq param
(append param
(list
(consp
(ada-search-ignore-string-comment
"access" nil epos t 'word-search-forward)))))
;; skip 'in'/'out'/'access'
(goto-char apos)
(ada-goto-next-non-ws)
(while (looking-at "\\<\\(in\\|out\\|access\\)\\>")
(forward-word 1)
(ada-goto-next-non-ws))
;; read type of parameter
;; We accept spaces in the name, since some software like Rose
;; generates something like: "A : B 'Class"
(looking-at "\\<\\(\\sw\\|[_.' \t]\\)+\\>")
(setq param
(append param
(list (match-string 0))))
;; read default-expression, if there is one
(goto-char (setq apos (match-end 0)))
(setq param
(append param
(list
(if (setq match-cons
(ada-search-ignore-string-comment
":=" nil epos t 'search-forward))
(buffer-substring (car match-cons) epos)
nil))))
;; add this parameter-declaration to the list
(setq paramlist (append paramlist (list param)))
;; check if it was the last parameter
(if (eq epos end)
(setq notend nil)
(goto-char semipos))
)
(reverse paramlist)))
(defun ada-insert-paramlist (paramlist)
"Inserts a formatted PARAMLIST in the buffer."
(let ((i (length paramlist))
(parlen 0)
(typlen 0)
(inp nil)
(outp nil)
(accessp nil)
(column nil)
(firstcol nil))
;; loop until last parameter
(while (not (zerop i))
(setq i (1- i))
;; get max length of parameter-name
(setq parlen (max parlen (length (nth 0 (nth i paramlist)))))
;; get max length of type-name
(setq typlen (max typlen (length (nth 4 (nth i paramlist)))))
;; is there any 'in' ?
(setq inp (or inp (nth 1 (nth i paramlist))))
;; is there any 'out' ?
(setq outp (or outp (nth 2 (nth i paramlist))))
;; is there any 'access' ?
(setq accessp (or accessp (nth 3 (nth i paramlist))))
)
;; does paramlist already start on a separate line ?
(if (save-excursion
(re-search-backward "^.\\|[^ \t]" nil t)
(looking-at "^."))
;; yes => re-indent it
(progn
(ada-indent-current)
(save-excursion
(if (looking-at "\\(is\\|return\\)")
(replace-match " \\1"))))
;; no => insert it where we are after removing any whitespace
(fixup-whitespace)
(save-excursion
(cond
((looking-at "[ \t]*\\(\n\\|;\\)")
(replace-match "\\1"))
((looking-at "[ \t]*\\(is\\|return\\)")
(replace-match " \\1"))))
(insert " "))
(insert "(")
(ada-indent-current)
(setq firstcol (current-column))
(setq i (length paramlist))
;; loop until last parameter
(while (not (zerop i))
(setq i (1- i))
(setq column firstcol)
;; insert parameter-name, space and colon
(insert (nth 0 (nth i paramlist)))
(indent-to (+ column parlen 1))
(insert ": ")
(setq column (current-column))
;; insert 'in' or space
(if (nth 1 (nth i paramlist))
(insert "in ")
(if (and
(or inp
accessp)
(not (nth 3 (nth i paramlist))))
(insert " ")))
;; insert 'out' or space
(if (nth 2 (nth i paramlist))
(insert "out ")
(if (and
(or outp
accessp)
(not (nth 3 (nth i paramlist))))
(insert " ")))
;; insert 'access'
(if (nth 3 (nth i paramlist))
(insert "access "))
(setq column (current-column))
;; insert type-name and, if necessary, space and default-expression
(insert (nth 4 (nth i paramlist)))
(if (nth 5 (nth i paramlist))
(progn
(indent-to (+ column typlen 1))
(insert (nth 5 (nth i paramlist)))))
;; check if it was the last parameter
(if (zerop i)
(insert ")")
;; no => insert ';' and newline and indent
(insert ";")
(newline)
(indent-to firstcol))
)
;; if anything follows, except semicolon, newline, is or return
;; put it in a new line and indent it
(unless (looking-at "[ \t]*\\(;\\|\n\\|is\\|return\\)")
(ada-indent-newline-indent))
))
;;;----------------------------------------------------------------
;; Indentation Engine
;; All indentations are indicated as a two-element string:
;; - position of reference in the buffer
;; - offset to indent from this position (can also be a symbol or a list
;; that are evaluated)
;; Thus the total indentation for a line is the column number of the reference
;; position plus whatever value the evaluation of the second element provides.
;; This mechanism is used so that the ada-mode can "explain" how the
;; indentation was calculated, by showing which variables were used.
;;
;; The indentation itself is done in only one pass: first we try to guess in
;; what context we are by looking at the following keyword or punctuation
;; sign. If nothing remarkable is found, just try to guess the indentation
;; based on previous lines.
;;
;; The relevant functions for indentation are:
;; - `ada-indent-region': Re-indent a region of text
;; - `ada-justified-indent-current': Re-indent the current line and shows the
;; calculation that were done
;; - `ada-indent-current': Re-indent the current line
;; - `ada-get-current-indent': Calculate the indentation for the current line,
;; based on the context (see above).
;; - `ada-get-indent-*': Calculate the indentation in a specific context.
;; For efficiency, these functions do not check they are in the correct
;; context.
;;;----------------------------------------------------------------
(defun ada-indent-region (beg end)
"Indent the region between BEG end END."
(interactive "*r")
(goto-char beg)
(let ((block-done 0)
(lines-remaining (count-lines beg end))
(msg (format "%%4d out of %4d lines remaining ..."
(count-lines beg end)))
(endmark (copy-marker end)))
;; catch errors while indenting
(while (< (point) endmark)
(if (> block-done 39)
(progn
(setq lines-remaining (- lines-remaining block-done)
block-done 0)
(message msg lines-remaining)))
(if (= (char-after) ?\n) nil
(ada-indent-current))
(forward-line 1)
(setq block-done (1+ block-done)))
(message "indenting ... done")))
(defun ada-indent-newline-indent ()
"Indents the current line, inserts a newline and then indents the new line."
(interactive "*")
(ada-indent-current)
(newline)
(ada-indent-current))
(defun ada-indent-newline-indent-conditional ()
"Insert a newline and indent it.
The original line is indented first if `ada-indent-after-return' is non-nil.
This function is intended to be bound to the \C-m and \C-j keys."
(interactive "*")
(if ada-indent-after-return (ada-indent-current))
(newline)
(ada-indent-current))
(defun ada-justified-indent-current ()
"Indent the current line and explains how the calculation was done."
(interactive)
(let ((cur-indent (ada-indent-current)))
(message nil)
(if (equal (cdr cur-indent) '(0))
(message "same indentation")
(message (mapconcat (lambda(x)
(cond
((symbolp x)
(symbol-name x))
((numberp x)
(number-to-string x))
((listp x)
(concat "- " (symbol-name (cadr x))))
))
(cdr cur-indent)
" + ")))
(save-excursion
(goto-char (car cur-indent))
(sit-for 1))))
(defun ada-batch-reformat ()
"Re-indent and re-case all the files found on the command line.
This function should be used from the Unix/Windows command line, with a
command like:
emacs -batch -l ada-mode -f ada-batch-reformat file1 file2 ..."
(while command-line-args-left
(let ((source (car command-line-args-left)))
(message (concat "formating " source))
(find-file source)
(ada-indent-region (point-min) (point-max))
(ada-adjust-case-buffer)
(write-file source))
(setq command-line-args-left (cdr command-line-args-left)))
(message "Done")
(kill-emacs 0))
(defsubst ada-goto-previous-word ()
"Moves point to the beginning of the previous word of Ada code.
Returns the new position of point or nil if not found."
(ada-goto-next-word t))
(defun ada-indent-current ()
"Indent current line as Ada code.
Returns the calculation that was done, including the reference point and the
offset."
(interactive)
(let ((previous-syntax-table (syntax-table))
(orgpoint (point-marker))
cur-indent tmp-indent
prev-indent)
(unwind-protect
(progn
(set-syntax-table ada-mode-symbol-syntax-table)
;; This need to be done here so that the advice is not always
;; activated (this might interact badly with other modes)
(if ada-xemacs
(ad-activate 'parse-partial-sexp t))
(save-excursion
(setq cur-indent
;; Not First line in the buffer ?
(if (save-excursion (zerop (forward-line -1)))
(progn
(back-to-indentation)
(ada-get-current-indent))
;; first line in the buffer
(list (point-min) 0))))
;; Evaluate the list to get the column to indent to
;; prev-indent contains the column to indent to
(if cur-indent
(setq prev-indent (save-excursion (goto-char (car cur-indent))
(current-column))
tmp-indent (cdr cur-indent))
(setq prev-indent 0 tmp-indent '()))
(while (not (null tmp-indent))
(cond
((numberp (car tmp-indent))
(setq prev-indent (+ prev-indent (car tmp-indent))))
(t
(setq prev-indent (+ prev-indent (eval (car tmp-indent)))))
)
(setq tmp-indent (cdr tmp-indent)))
;; only re-indent if indentation is different then the current
(if (= (save-excursion (back-to-indentation) (current-column)) prev-indent)
nil
(beginning-of-line)
(delete-horizontal-space)
(indent-to prev-indent))
;;
;; restore position of point
;;
(goto-char orgpoint)
(if (< (current-column) (current-indentation))
(back-to-indentation)))
;; restore syntax-table
(set-syntax-table previous-syntax-table)
(if ada-xemacs
(ad-deactivate 'parse-partial-sexp))
)
cur-indent
))
(defun ada-get-current-indent ()
"Return the indentation to use for the current line."
(let (column
pos
match-cons
result
(orgpoint (save-excursion
(beginning-of-line)
(forward-comment -10000)
(forward-line 1)
(point))))
(setq result
(cond
;;-----------------------------
;; in open parenthesis, but not in parameter-list
;;-----------------------------
((and ada-indent-to-open-paren
(not (ada-in-paramlist-p))
(setq column (ada-in-open-paren-p)))
;; check if we have something like this (Table_Component_Type =>
;; Source_File_Record)
(save-excursion
(if (and (skip-chars-backward " \t")
(= (char-before) ?\n)
(not (forward-comment -10000))
(= (char-before) ?>))
;; ??? Could use a different variable
(list column 'ada-broken-indent)
(list column 0))))
;;---------------------------
;; at end of buffer
;;---------------------------
((not (char-after))
(ada-indent-on-previous-lines nil orgpoint orgpoint))
;;---------------------------
;; starting with e
;;---------------------------
((= (char-after) ?e)
(cond
;; ------- end ------
((looking-at "end\\>")
(let ((label 0)
limit)
(save-excursion
(ada-goto-matching-start 1)
;;
;; found 'loop' => skip back to 'while' or 'for'
;; if 'loop' is not on a separate line
;; Stop the search for 'while' and 'for' when a ';' is encountered.
;;
(if (save-excursion
(beginning-of-line)
(looking-at ".+\\<loop\\>"))
(progn
(save-excursion
(setq limit (car (ada-search-ignore-string-comment ";" t))))
(if (save-excursion
(and
(setq match-cons
(ada-search-ignore-string-comment ada-loop-start-re t limit))
(not (looking-at "\\<loop\\>"))))
(progn
(goto-char (car match-cons))
(save-excursion
(beginning-of-line)
(if (looking-at ada-named-block-re)
(setq label (- ada-label-indent))))))))
(list (+ (save-excursion (back-to-indentation) (point)) label) 0))))
;; ------ exception ----
((looking-at "exception\\>")
(save-excursion
(ada-goto-matching-start 1)
(list (save-excursion (back-to-indentation) (point)) 0)))
;; else
((looking-at "else\\>")
(if (save-excursion (ada-goto-previous-word)
(looking-at "\\<or\\>"))
(ada-indent-on-previous-lines nil orgpoint orgpoint)
(save-excursion
(ada-goto-matching-start 1 nil t)
(list (progn (back-to-indentation) (point)) 0))))
;; elsif
((looking-at "elsif\\>")
(save-excursion
(ada-goto-matching-start 1 nil t)
(list (progn (back-to-indentation) (point)) 0)))
))
;;---------------------------
;; starting with w (when)
;;---------------------------
((and (= (char-after) ?w)
(looking-at "when\\>"))
(save-excursion
(ada-goto-matching-start 1)
(list (save-excursion (back-to-indentation) (point))
'ada-when-indent)))
;;---------------------------
;; starting with t (then)
;;---------------------------
((and (= (char-after) ?t)
(looking-at "then\\>"))
(if (save-excursion (ada-goto-previous-word)
(looking-at "and\\>"))
(ada-indent-on-previous-lines nil orgpoint orgpoint)
(save-excursion
;; Select has been added for the statement: "select ... then abort"
(ada-search-ignore-string-comment
"\\<\\(elsif\\|if\\|select\\)\\>" t nil)
(list (progn (back-to-indentation) (point))
'ada-stmt-end-indent))))
;;---------------------------
;; starting with l (loop)
;;---------------------------
((and (= (char-after) ?l)
(looking-at "loop\\>"))
(setq pos (point))
(save-excursion
(goto-char (match-end 0))
(ada-goto-stmt-start)
(if (looking-at "\\<\\(loop\\|if\\)\\>")
(ada-indent-on-previous-lines nil orgpoint orgpoint)
(unless (looking-at ada-loop-start-re)
(ada-search-ignore-string-comment ada-loop-start-re
nil pos))
(if (looking-at "\\<loop\\>")
(ada-indent-on-previous-lines nil orgpoint orgpoint)
(list (progn (back-to-indentation) (point)) 'ada-stmt-end-indent)))))
;;---------------------------
;; starting with b (begin)
;;---------------------------
((and (= (char-after) ?b)
(looking-at "begin\\>"))
(save-excursion
(if (ada-goto-matching-decl-start t)
(list (progn (back-to-indentation) (point)) 0)
(ada-indent-on-previous-lines nil orgpoint orgpoint))))
;;---------------------------
;; starting with i (is)
;;---------------------------
((and (= (char-after) ?i)
(looking-at "is\\>"))
(if (and ada-indent-is-separate
(save-excursion
(goto-char (match-end 0))
(ada-goto-next-non-ws (save-excursion (end-of-line)
(point)))
(looking-at "\\<abstract\\>\\|\\<separate\\>")))
(save-excursion
(ada-goto-stmt-start)
(list (progn (back-to-indentation) (point)) 'ada-indent))
(save-excursion
(ada-goto-stmt-start)
(list (progn (back-to-indentation) (point)) 'ada-stmt-end-indent))))
;;---------------------------
;; starting with r (record, return, renames)
;;---------------------------
((= (char-after) ?r)
(cond
;; ----- record ------
((looking-at "record\\>")
(save-excursion
(ada-search-ignore-string-comment
"\\<\\(type\\|use\\)\\>" t nil)
(if (looking-at "\\<use\\>")
(ada-search-ignore-string-comment "for" t nil nil 'word-search-backward))
(list (progn (back-to-indentation) (point)) 'ada-indent-record-rel-type)))
;; ----- return or renames ------
((looking-at "re\\(turn\\|names\\)\\>")
(save-excursion
(let ((var 'ada-indent-return))
;; If looking at a renames, skip the 'return' statement too
(if (looking-at "renames")
(let (pos)
(save-excursion
(setq pos (ada-search-ignore-string-comment ";\\|return\\>" t)))
(if (and pos
(= (char-after (car pos)) ?r))
(goto-char (car pos)))
(setq var 'ada-indent-renames)))
(forward-comment -1000)
(if (= (char-before) ?\))
(forward-sexp -1)
(forward-word -1))
;; If there is a parameter list, and we have a function declaration
;; or a access to subprogram declaration
(let ((num-back 1))
(if (and (= (char-after) ?\()
(save-excursion
(or (progn
(backward-word 1)
(looking-at "function\\>"))
(progn
(backward-word 1)
(setq num-back 2)
(looking-at "function\\>")))))
;; The indentation depends of the value of ada-indent-return
(if (<= (eval var) 0)
(list (point) (list '- var))
(list (progn (backward-word num-back) (point))
var))
;; Else there is no parameter list, but we have a function
;; Only do something special if the user want to indent
;; relative to the "function" keyword
(if (and (> (eval var) 0)
(save-excursion (forward-word -1)
(looking-at "function\\>")))
(list (progn (forward-word -1) (point)) var)
;; Else...
(ada-indent-on-previous-lines nil orgpoint orgpoint)))))))
))
;;--------------------------------
;; starting with 'o' or 'p'
;; 'or' as statement-start
;; 'private' as statement-start
;;--------------------------------
((and (or (= (char-after) ?o)
(= (char-after) ?p))
(or (ada-looking-at-semi-or)
(ada-looking-at-semi-private)))
(save-excursion
(ada-goto-matching-start 1)
(list (progn (back-to-indentation) (point)) 0)))
;;--------------------------------
;; starting with 'd' (do)
;;--------------------------------
((and (= (char-after) ?d)
(looking-at "do\\>"))
(save-excursion
(ada-goto-stmt-start)
(list (progn (back-to-indentation) (point)) 'ada-stmt-end-indent)))
;;--------------------------------
;; starting with '-' (comment)
;;--------------------------------
((= (char-after) ?-)
(if ada-indent-comment-as-code
;; Indent comments on previous line comments if required
;; We must use a search-forward (even if the code is more complex),
;; since we want to find the beginning of the comment.
(let (pos)
(if (and ada-indent-align-comments
(save-excursion
(forward-line -1)
(beginning-of-line)
(while (and (not pos)
(search-forward "--"
(save-excursion
(end-of-line) (point))
t))
(unless (ada-in-string-p)
(setq pos (point))))
pos))
(list (- pos 2) 0)
;; Else always on previous line
(ada-indent-on-previous-lines nil orgpoint orgpoint)))
;; Else same indentation as the previous line
(list (save-excursion (back-to-indentation) (point)) 0)))
;;--------------------------------
;; starting with '#' (preprocessor line)
;;--------------------------------
((and (= (char-after) ?#)
(equal ada-which-compiler 'gnat)
(looking-at "#[ \t]*\\(if\\|els\\(e\\|if\\)\\|end[ \t]*if\\)"))
(list (save-excursion (beginning-of-line) (point)) 0))
;;--------------------------------
;; starting with ')' (end of a parameter list)
;;--------------------------------
((and (not (eobp)) (= (char-after) ?\)))
(save-excursion
(forward-char 1)
(backward-sexp 1)
(list (point) 0)))
;;---------------------------------
;; new/abstract/separate
;;---------------------------------
((looking-at "\\(new\\|abstract\\|separate\\)\\>")
(ada-indent-on-previous-lines nil orgpoint orgpoint))
;;---------------------------------
;; package/function/procedure
;;---------------------------------
((and (or (= (char-after) ?p) (= (char-after) ?f))
(looking-at "\\<\\(package\\|function\\|procedure\\)\\>"))
(save-excursion
;; Go up until we find either a generic section, or the end of the
;; previous subprogram/package
(let (found)
(while (and (not found)
(ada-search-ignore-string-comment
"\\<\\(generic\\|end\\|begin\\|package\\|procedure\\|function\\)\\>" t))
;; avoid "with procedure"... in generic parts
(save-excursion
(forward-word -1)
(setq found (not (looking-at "with"))))))
(if (looking-at "generic")
(list (progn (back-to-indentation) (point)) 0)
(ada-indent-on-previous-lines nil orgpoint orgpoint))))
;;---------------------------------
;; label
;;---------------------------------
((looking-at "\\(\\sw\\|_\\)+[ \t\n]*:[^=]")
(if (ada-in-decl-p)
(ada-indent-on-previous-lines nil orgpoint orgpoint)
(append (ada-indent-on-previous-lines nil orgpoint orgpoint)
'(ada-label-indent))))
))
;;---------------------------------
;; Other syntaxes
;;---------------------------------
(or result (ada-indent-on-previous-lines nil orgpoint orgpoint))))
(defun ada-indent-on-previous-lines (&optional nomove orgpoint initial-pos)
"Calculate the indentation for the new line after ORGPOINT.
The result list is based on the previous lines in the buffer.
If NOMOVE is nil, moves point to the beginning of the current statement.
if INITIAL-POS is non-nil, moves point to INITIAL-POS before calculation."
(if initial-pos
(goto-char initial-pos))
(let ((oldpoint (point)))
;; Is inside a parameter-list ?
(if (ada-in-paramlist-p)
(ada-get-indent-paramlist)
;; move to beginning of current statement
(unless nomove
(ada-goto-stmt-start))
;; no beginning found => don't change indentation
(if (and (eq oldpoint (point))
(not nomove))
(ada-get-indent-nochange)
(cond
;;
((and
ada-indent-to-open-paren
(ada-in-open-paren-p))
(ada-get-indent-open-paren))
;;
((looking-at "end\\>")
(ada-get-indent-end orgpoint))
;;
((looking-at ada-loop-start-re)
(ada-get-indent-loop orgpoint))
;;
((looking-at ada-subprog-start-re)
(ada-get-indent-subprog orgpoint))
;;
((looking-at ada-block-start-re)
(ada-get-indent-block-start orgpoint))
;;
((looking-at "\\(sub\\)?type\\>")
(ada-get-indent-type orgpoint))
;;
;; "then" has to be included in the case of "select...then abort"
;; statements, since (goto-stmt-start) at the beginning of
;; the current function would leave the cursor on that position
((looking-at "\\(\\(els\\)?if\\>\\)\\|then abort\\\>")
(ada-get-indent-if orgpoint))
;;
((looking-at "case\\>")
(ada-get-indent-case orgpoint))
;;
((looking-at "when\\>")
(ada-get-indent-when orgpoint))
;;
((looking-at "\\(\\sw\\|_\\)+[ \t\n]*:[^=]")
(ada-get-indent-label orgpoint))
;;
((looking-at "separate\\>")
(ada-get-indent-nochange))
;;
((looking-at "with\\>\\|use\\>")
;; Are we still in that statement, or are we in fact looking at
;; the previous one ?
(if (save-excursion (search-forward ";" oldpoint t))
(list (progn (back-to-indentation) (point)) 0)
(list (point) (if (looking-at "with")
'ada-with-indent
'ada-use-indent))))
;;
(t
(ada-get-indent-noindent orgpoint)))))
))
(defun ada-get-indent-open-paren ()
"Calculates the indentation when point is behind an unclosed parenthesis."
(list (ada-in-open-paren-p) 0))
(defun ada-get-indent-nochange ()
"Return the current indentation of the previous line."
(save-excursion
(forward-line -1)
(back-to-indentation)
(list (point) 0)))
(defun ada-get-indent-paramlist ()
"Calculates the indentation when point is inside a parameter list."
(save-excursion
(ada-search-ignore-string-comment "[^ \t\n]" t nil t)
(cond
;; in front of the first parameter
((= (char-after) ?\()
(goto-char (match-end 0))
(list (point) 0))
;; in front of another parameter
((= (char-after) ?\;)
(goto-char (cdr (ada-search-ignore-string-comment "(\\|;" t nil t)))
(ada-goto-next-non-ws)
(list (point) 0))
;; inside a parameter declaration
(t
(goto-char (cdr (ada-search-ignore-string-comment "(\\|;" t nil t)))
(ada-goto-next-non-ws)
(list (point) 'ada-broken-indent)))))
(defun ada-get-indent-end (orgpoint)
"Calculates the indentation when point is just before an end_statement.
ORGPOINT is the limit position used in the calculation."
(let ((defun-name nil)
(indent nil))
;; is the line already terminated by ';' ?
(if (save-excursion
(ada-search-ignore-string-comment ";" nil orgpoint nil
'search-forward))
;; yes, look what's following 'end'
(progn
(forward-word 1)
(ada-goto-next-non-ws)
(cond
((looking-at "\\<\\(loop\\|select\\|if\\|case\\)\\>")
(save-excursion (ada-check-matching-start (match-string 0)))
(list (save-excursion (back-to-indentation) (point)) 0))
;;
;; loop/select/if/case/record/select
;;
((looking-at "\\<record\\>")
(save-excursion
(ada-check-matching-start (match-string 0))
;; we are now looking at the matching "record" statement
(forward-word 1)
(ada-goto-stmt-start)
;; now on the matching type declaration, or use clause
(unless (looking-at "\\(for\\|type\\)\\>")
(ada-search-ignore-string-comment "\\<type\\>" t))
(list (progn (back-to-indentation) (point)) 0)))
;;
;; a named block end
;;
((looking-at ada-ident-re)
(setq defun-name (match-string 0))
(save-excursion
(ada-goto-matching-start 0)
(ada-check-defun-name defun-name))
(list (progn (back-to-indentation) (point)) 0))
;;
;; a block-end without name
;;
((= (char-after) ?\;)
(save-excursion
(ada-goto-matching-start 0)
(if (looking-at "\\<begin\\>")
(progn
(setq indent (list (point) 0))
(if (ada-goto-matching-decl-start t)
(list (progn (back-to-indentation) (point)) 0)
indent)))))
;;
;; anything else - should maybe signal an error ?
;;
(t
(list (save-excursion (back-to-indentation) (point))
'ada-broken-indent))))
(list (save-excursion (back-to-indentation) (point))
'ada-broken-indent))))
(defun ada-get-indent-case (orgpoint)
"Calculates the indentation when point is just before a case statement.
ORGPOINT is the limit position used in the calculation."
(let ((match-cons nil)
(opos (point)))
(cond
;;
;; case..is..when..=>
;;
((save-excursion
(setq match-cons (and
;; the `=>' must be after the keyword `is'.
(ada-search-ignore-string-comment
"is" nil orgpoint nil 'word-search-forward)
(ada-search-ignore-string-comment
"[ \t\n]+=>" nil orgpoint))))
(save-excursion
(goto-char (car match-cons))
(unless (ada-search-ignore-string-comment "when" t opos)
(error "missing 'when' between 'case' and '=>'"))
(list (save-excursion (back-to-indentation) (point)) 'ada-indent)))
;;
;; case..is..when
;;
((save-excursion
(setq match-cons (ada-search-ignore-string-comment
"when" nil orgpoint nil 'word-search-forward)))
(goto-char (cdr match-cons))
(list (save-excursion (back-to-indentation) (point)) 'ada-broken-indent))
;;
;; case..is
;;
((save-excursion
(setq match-cons (ada-search-ignore-string-comment
"is" nil orgpoint nil 'word-search-forward)))
(list (save-excursion (back-to-indentation) (point)) 'ada-when-indent))
;;
;; incomplete case
;;
(t
(list (save-excursion (back-to-indentation) (point))
'ada-broken-indent)))))
(defun ada-get-indent-when (orgpoint)
"Calculates the indentation when point is just before a when statement.
ORGPOINT is the limit position used in the calculation."
(let ((cur-indent (save-excursion (back-to-indentation) (point))))
(if (ada-search-ignore-string-comment "[ \t\n]*=>" nil orgpoint)
(list cur-indent 'ada-indent)
(list cur-indent 'ada-broken-indent))))
(defun ada-get-indent-if (orgpoint)
"Calculates the indentation when point is just before an if statement.
ORGPOINT is the limit position used in the calculation."
(let ((cur-indent (save-excursion (back-to-indentation) (point)))
(match-cons nil))
;;
;; Move to the correct then (ignore all "and then")
;;
(while (and (setq match-cons (ada-search-ignore-string-comment
"\\<\\(then\\|and[ \t]*then\\)\\>"
nil orgpoint))
(= (char-after (car match-cons)) ?a)))
;; If "then" was found (we are looking at it)
(if match-cons
(progn
;;
;; 'then' first in separate line ?
;; => indent according to 'then',
;; => else indent according to 'if'
;;
(if (save-excursion
(back-to-indentation)
(looking-at "\\<then\\>"))
(setq cur-indent (save-excursion (back-to-indentation) (point))))
;; skip 'then'
(forward-word 1)
(list cur-indent 'ada-indent))
(list cur-indent 'ada-broken-indent))))
(defun ada-get-indent-block-start (orgpoint)
"Calculates the indentation when point is at the start of a block.
ORGPOINT is the limit position used in the calculation."
(let ((pos nil))
(cond
((save-excursion
(forward-word 1)
(setq pos (ada-goto-next-non-ws orgpoint)))
(goto-char pos)
(save-excursion
(ada-indent-on-previous-lines t orgpoint)))
;; nothing follows the block-start
(t
(list (save-excursion (back-to-indentation) (point)) 'ada-indent)))))
(defun ada-get-indent-subprog (orgpoint)
"Calculates the indentation when point is just before a subprogram.
ORGPOINT is the limit position used in the calculation."
(let ((match-cons nil)
(cur-indent (save-excursion (back-to-indentation) (point)))
(foundis nil))
;;
;; is there an 'is' in front of point ?
;;
(if (save-excursion
(setq match-cons
(ada-search-ignore-string-comment
"\\<\\(is\\|do\\)\\>" nil orgpoint)))
;;
;; yes, then skip to its end
;;
(progn
(setq foundis t)
(goto-char (cdr match-cons)))
;;
;; no, then goto next non-ws, if there is one in front of point
;;
(progn
(unless (ada-goto-next-non-ws orgpoint)
(goto-char orgpoint))))
(cond
;;
;; nothing follows 'is'
;;
((and
foundis
(save-excursion
(not (ada-search-ignore-string-comment
"[^ \t\n]" nil orgpoint t))))
(list cur-indent 'ada-indent))
;;
;; is abstract/separate/new ...
;;
((and
foundis
(save-excursion
(setq match-cons
(ada-search-ignore-string-comment
"\\<\\(separate\\|new\\|abstract\\)\\>"
nil orgpoint))))
(goto-char (car match-cons))
(ada-search-ignore-string-comment ada-subprog-start-re t)
(ada-get-indent-noindent orgpoint))
;;
;; something follows 'is'
;;
((and
foundis
(save-excursion (setq match-cons (ada-goto-next-non-ws orgpoint)))
(goto-char match-cons)
(ada-indent-on-previous-lines t orgpoint)))
;;
;; no 'is' but ';'
;;
((save-excursion
(ada-search-ignore-string-comment ";" nil orgpoint nil 'search-forward))
(list cur-indent 0))
;;
;; no 'is' or ';'
;;
(t
(list cur-indent 'ada-broken-indent)))))
(defun ada-get-indent-noindent (orgpoint)
"Calculates the indentation when point is just before a 'noindent stmt'.
ORGPOINT is the limit position used in the calculation."
(let ((label 0))
(save-excursion
(beginning-of-line)
(cond
;; This one is called when indenting a line preceded by a multi-line
;; subprogram declaration (in that case, we are at this point inside
;; the parameter declaration list)
((ada-in-paramlist-p)
(ada-previous-procedure)
(list (save-excursion (back-to-indentation) (point)) 0))
;; This one is called when indenting the second line of a multi-line
;; declaration section, in a declare block or a record declaration
((looking-at "[ \t]*\\(\\sw\\|_\\)*[ \t]*,[ \t]*$")
(list (save-excursion (back-to-indentation) (point))
'ada-broken-decl-indent))
;; This one is called in every over case when indenting a line at the
;; top level
(t
(if (looking-at ada-named-block-re)
(setq label (- ada-label-indent))
(let (p)
;; "with private" or "null record" cases
(if (or (save-excursion
(and (ada-search-ignore-string-comment "\\<private\\>" nil orgpoint)
(setq p (point))
(save-excursion (forward-char -7);; skip back "private"
(ada-goto-previous-word)
(looking-at "with"))))
(save-excursion
(and (ada-search-ignore-string-comment "\\<record\\>" nil orgpoint)
(setq p (point))
(save-excursion (forward-char -6);; skip back "record"
(ada-goto-previous-word)
(looking-at "null")))))
(progn
(goto-char p)
(re-search-backward "\\<\\(type\\|subtype\\)\\>" nil t)
(list (save-excursion (back-to-indentation) (point)) 0)))))
(if (save-excursion
(ada-search-ignore-string-comment ";" nil orgpoint nil
'search-forward))
(list (+ (save-excursion (back-to-indentation) (point)) label) 0)
(list (+ (save-excursion (back-to-indentation) (point)) label)
'ada-broken-indent)))))))
(defun ada-get-indent-label (orgpoint)
"Calculates the indentation when before a label or variable declaration.
ORGPOINT is the limit position used in the calculation."
(let ((match-cons nil)
(cur-indent (save-excursion (back-to-indentation) (point))))
(ada-search-ignore-string-comment ":" nil)
(cond
;; loop label
((save-excursion
(setq match-cons (ada-search-ignore-string-comment
ada-loop-start-re nil orgpoint)))
(goto-char (car match-cons))
(ada-get-indent-loop orgpoint))
;; declare label
((save-excursion
(setq match-cons (ada-search-ignore-string-comment
"\\<declare\\|begin\\>" nil orgpoint)))
(goto-char (car match-cons))
(list (save-excursion (back-to-indentation) (point)) 'ada-indent))
;; variable declaration
((ada-in-decl-p)
(if (save-excursion
(ada-search-ignore-string-comment ";" nil orgpoint))
(list cur-indent 0)
(list cur-indent 'ada-broken-indent)))
;; nothing follows colon
(t
(list cur-indent '(- ada-label-indent))))))
(defun ada-get-indent-loop (orgpoint)
"Calculates the indentation when just before a loop or a for ... use.
ORGPOINT is the limit position used in the calculation."
(let ((match-cons nil)
(pos (point))
;; If looking at a named block, skip the label
(label (save-excursion
(beginning-of-line)
(if (looking-at ada-named-block-re)
(- ada-label-indent)
0))))
(cond
;;
;; statement complete
;;
((save-excursion
(ada-search-ignore-string-comment ";" nil orgpoint nil
'search-forward))
(list (+ (save-excursion (back-to-indentation) (point)) label) 0))
;;
;; simple loop
;;
((looking-at "loop\\>")
(setq pos (ada-get-indent-block-start orgpoint))
(if (equal label 0)
pos
(list (+ (car pos) label) (cdr pos))))
;;
;; 'for'- loop (or also a for ... use statement)
;;
((looking-at "for\\>")
(cond
;;
;; for ... use
;;
((save-excursion
(and
(goto-char (match-end 0))
(ada-goto-next-non-ws orgpoint)
(forward-word 1)
(if (= (char-after) ?') (forward-word 1) t)
(ada-goto-next-non-ws orgpoint)
(looking-at "\\<use\\>")
;;
;; check if there is a 'record' before point
;;
(progn
(setq match-cons (ada-search-ignore-string-comment
"record" nil orgpoint nil 'word-search-forward))
t)))
(if match-cons
(goto-char (car match-cons)))
(list (save-excursion (back-to-indentation) (point)) 'ada-indent))
;;
;; for..loop
;;
((save-excursion
(setq match-cons (ada-search-ignore-string-comment
"loop" nil orgpoint nil 'word-search-forward)))
(goto-char (car match-cons))
;;
;; indent according to 'loop', if it's first in the line;
;; otherwise to 'for'
;;
(unless (save-excursion
(back-to-indentation)
(looking-at "\\<loop\\>"))
(goto-char pos))
(list (+ (save-excursion (back-to-indentation) (point)) label)
'ada-indent))
;;
;; for-statement is broken
;;
(t
(list (+ (save-excursion (back-to-indentation) (point)) label)
'ada-broken-indent))))
;;
;; 'while'-loop
;;
((looking-at "while\\>")
;;
;; while..loop ?
;;
(if (save-excursion
(setq match-cons (ada-search-ignore-string-comment
"loop" nil orgpoint nil 'word-search-forward)))
(progn
(goto-char (car match-cons))
;;
;; indent according to 'loop', if it's first in the line;
;; otherwise to 'while'.
;;
(unless (save-excursion
(back-to-indentation)
(looking-at "\\<loop\\>"))
(goto-char pos))
(list (+ (save-excursion (back-to-indentation) (point)) label)
'ada-indent))
(list (+ (save-excursion (back-to-indentation) (point)) label)
'ada-broken-indent))))))
(defun ada-get-indent-type (orgpoint)
"Calculates the indentation when before a type statement.
ORGPOINT is the limit position used in the calculation."
(let ((match-dat nil))
(cond
;;
;; complete record declaration
;;
((save-excursion
(and
(setq match-dat (ada-search-ignore-string-comment
"end" nil orgpoint nil 'word-search-forward))
(ada-goto-next-non-ws)
(looking-at "\\<record\\>")
(forward-word 1)
(ada-goto-next-non-ws)
(= (char-after) ?\;)))
(goto-char (car match-dat))
(list (save-excursion (back-to-indentation) (point)) 0))
;;
;; record type
;;
((save-excursion
(setq match-dat (ada-search-ignore-string-comment
"record" nil orgpoint nil 'word-search-forward)))
(goto-char (car match-dat))
(list (save-excursion (back-to-indentation) (point)) 'ada-indent))
;;
;; complete type declaration
;;
((save-excursion
(ada-search-ignore-string-comment ";" nil orgpoint nil
'search-forward))
(list (save-excursion (back-to-indentation) (point)) 0))
;;
;; "type ... is", but not "type ... is ...", which is broken
;;
((save-excursion
(and
(ada-search-ignore-string-comment "is" nil orgpoint nil
'word-search-forward)
(not (ada-goto-next-non-ws orgpoint))))
(list (save-excursion (back-to-indentation) (point)) 'ada-broken-indent))
;;
;; broken statement
;;
(t
(list (save-excursion (back-to-indentation) (point))
'ada-broken-indent)))))
;; -----------------------------------------------------------
;; -- searching and matching
;; -----------------------------------------------------------
(defun ada-goto-stmt-start ()
"Moves point to the beginning of the statement that point is in or after.
Returns the new position of point.
As a special case, if we are looking at a closing parenthesis, skip to the
open parenthesis."
(let ((match-dat nil)
(orgpoint (point)))
(setq match-dat (ada-search-prev-end-stmt))
(if match-dat
;;
;; found a previous end-statement => check if anything follows
;;
(unless (looking-at "declare")
(progn
(unless (save-excursion
(goto-char (cdr match-dat))
(ada-goto-next-non-ws orgpoint))
;;
;; nothing follows => it's the end-statement directly in
;; front of point => search again
;;
(setq match-dat (ada-search-prev-end-stmt)))
;;
;; if found the correct end-statement => goto next non-ws
;;
(if match-dat
(goto-char (cdr match-dat)))
(ada-goto-next-non-ws)
))
;;
;; no previous end-statement => we are at the beginning of the
;; accessible part of the buffer
;;
(progn
(goto-char (point-min))
;;
;; skip to the very first statement, if there is one
;;
(unless (ada-goto-next-non-ws orgpoint)
(goto-char orgpoint))))
(point)))
(defun ada-search-prev-end-stmt ()
"Moves point to previous end-statement.
Returns a cons cell whose car is the beginning and whose cdr the end of the
match."
(let ((match-dat nil)
(found nil))
;; search until found or beginning-of-buffer
(while
(and
(not found)
(setq match-dat (ada-search-ignore-string-comment
ada-end-stmt-re t)))
(goto-char (car match-dat))
(unless (ada-in-open-paren-p)
(if (and (looking-at
"\\<\\(record\\|loop\\|select\\|else\\|then\\)\\>")
(save-excursion
(ada-goto-previous-word)
(looking-at "\\<\\(end\\|or\\|and\\)\\>[ \t]*[^;]")))
(forward-word -1)
(save-excursion
(goto-char (cdr match-dat))
(ada-goto-next-non-ws)
(looking-at "(")
;; words that can go after an 'is'
(unless (looking-at
(eval-when-compile
(concat "\\<"
(regexp-opt '("separate" "access" "array"
"abstract" "new") t)
"\\>\\|(")))
(setq found t))))
))
(if found
match-dat
nil)))
(defun ada-goto-next-non-ws (&optional limit)
"Skips white spaces, newlines and comments to next non-ws character.
Stop the search at LIMIT.
Do not call this function from within a string."
(unless limit
(setq limit (point-max)))
(while (and (<= (point) limit)
(progn (forward-comment 10000)
(if (and (not (eobp))
(save-excursion (forward-char 1)
(ada-in-string-p)))
(progn (forward-sexp 1) t)))))
(if (< (point) limit)
(point)
nil)
)
(defun ada-goto-stmt-end (&optional limit)
"Moves point to the end of the statement that point is in or before.
Returns the new position of point or nil if not found.
Stop the search at LIMIT."
(if (ada-search-ignore-string-comment ada-end-stmt-re nil limit)
(point)
nil))
(defun ada-goto-next-word (&optional backward)
"Moves point to the beginning of the next word of Ada code.
If BACKWARD is non-nil, jump to the beginning of the previous word.
Returns the new position of point or nil if not found."
(let ((match-cons nil)
(orgpoint (point))
(old-syntax (char-to-string (char-syntax ?_))))
(modify-syntax-entry ?_ "w")
(unless backward
(skip-syntax-forward "w"))
(if (setq match-cons
(if backward
(ada-search-ignore-string-comment "\\w" t nil t)
(ada-search-ignore-string-comment "\\w" nil nil t)))
;;
;; move to the beginning of the word found
;;
(progn
(goto-char (car match-cons))
(skip-syntax-backward "w")
(point))
;;
;; if not found, restore old position of point
;;
(goto-char orgpoint)
'nil)
(modify-syntax-entry ?_ old-syntax))
)
(defun ada-check-matching-start (keyword)
"Signals an error if matching block start is not KEYWORD.
Moves point to the matching block start."
(ada-goto-matching-start 0)
(unless (looking-at (concat "\\<" keyword "\\>"))
(error "matching start is not '%s'" keyword)))
(defun ada-check-defun-name (defun-name)
"Checks if the name of the matching defun really is DEFUN-NAME.
Assumes point to be already positioned by 'ada-goto-matching-start'.
Moves point to the beginning of the declaration."
;; named block without a `declare'
(if (save-excursion
(ada-goto-previous-word)
(looking-at (concat "\\<" defun-name "\\> *:")))
t ; do nothing
;;
;; 'accept' or 'package' ?
;;
(unless (looking-at ada-subprog-start-re)
(ada-goto-matching-decl-start))
;;
;; 'begin' of 'procedure'/'function'/'task' or 'declare'
;;
(save-excursion
;;
;; a named 'declare'-block ?
;;
(if (looking-at "\\<declare\\>")
(ada-goto-stmt-start)
;;
;; no, => 'procedure'/'function'/'task'/'protected'
;;
(progn
(forward-word 2)
(backward-word 1)
;;
;; skip 'body' 'type'
;;
(if (looking-at "\\<\\(body\\|type\\)\\>")
(forward-word 1))
(forward-sexp 1)
(backward-sexp 1)))
;;
;; should be looking-at the correct name
;;
(unless (looking-at (concat "\\<" defun-name "\\>"))
(error "matching defun has different name: %s"
(buffer-substring (point)
(progn (forward-sexp 1) (point))))))))
(defun ada-goto-matching-decl-start (&optional noerror recursive)
"Moves point to the matching declaration start of the current 'begin'.
If NOERROR is non-nil, it only returns nil if no match was found."
(let ((nest-count 1)
(first (not recursive))
(count-generic nil)
(stop-at-when nil)
)
;; Ignore "when" most of the time, except if we are looking at the
;; beginning of a block (structure: case .. is
;; when ... =>
;; begin ...
;; exception ... )
(if (looking-at "begin")
(setq stop-at-when t))
(if (or
(looking-at "\\<\\(package\\|procedure\\|function\\)\\>")
(save-excursion
(ada-search-ignore-string-comment
"\\<\\(package\\|procedure\\|function\\|generic\\)\\>" t)
(looking-at "generic")))
(setq count-generic t))
;; search backward for interesting keywords
(while (and
(not (zerop nest-count))
(ada-search-ignore-string-comment ada-matching-decl-start-re t))
;;
;; calculate nest-depth
;;
(cond
;;
((looking-at "end")
(ada-goto-matching-start 1 noerror)
;; In some case, two begin..end block can follow each other closely,
;; which we have to detect, as in
;; procedure P is
;; procedure Q is
;; begin
;; end;
;; begin -- here we should go to procedure, not begin
;; end
(if (looking-at "begin")
(let ((loop-again t))
(save-excursion
(while loop-again
;; If begin was just there as the beginning of a block
;; (with no declare) then do nothing, otherwise just
;; register that we have to find the statement that
;; required the begin
(ada-search-ignore-string-comment
"\\<\\(declare\\|begin\\|end\\|procedure\\|function\\|task\\|package\\)\\>"
t)
(if (looking-at "end")
(ada-goto-matching-decl-start noerror t)
(setq loop-again nil)
(unless (looking-at "begin")
(setq nest-count (1+ nest-count))))
))
)))
;;
((looking-at "generic")
(if count-generic
(progn
(setq first nil)
(setq nest-count (1- nest-count)))))
;;
((looking-at "if")
(save-excursion
(forward-word -1)
(unless (looking-at "\\<end[ \t\n]*if\\>")
(progn
(setq nest-count (1- nest-count))
(setq first nil)))))
;;
((looking-at "declare\\|generic")
(setq nest-count (1- nest-count))
(setq first nil))
;;
((looking-at "is")
;; check if it is only a type definition, but not a protected
;; type definition, which should be handled like a procedure.
(if (or (looking-at "is[ \t]+<>")
(save-excursion
(forward-comment -10000)
(forward-char -1)
;; Detect if we have a closing parenthesis (Could be
;; either the end of subprogram parameters or (<>)
;; in a type definition
(if (= (char-after) ?\))
(progn
(forward-char 1)
(backward-sexp 1)
(forward-comment -10000)
))
(skip-chars-backward "a-zA-Z0-9_.'")
(ada-goto-previous-word)
(and
(looking-at "\\<\\(sub\\)?type\\>")
(save-match-data
(ada-goto-previous-word)
(not (looking-at "\\<protected\\>"))))
)) ; end of `or'
(goto-char (match-beginning 0))
(progn
(setq nest-count (1- nest-count))
(setq first nil))))
;;
((looking-at "new")
(if (save-excursion
(ada-goto-previous-word)
(looking-at "is"))
(goto-char (match-beginning 0))))
;;
((and first
(looking-at "begin"))
(setq nest-count 0))
;;
((looking-at "when")
(if stop-at-when
(setq nest-count (1- nest-count)))
(setq first nil))
;;
(t
(setq nest-count (1+ nest-count))
(setq first nil)))
);; end of loop
;; check if declaration-start is really found
(if (and
(zerop nest-count)
(if (looking-at "is")
(ada-search-ignore-string-comment ada-subprog-start-re t)
(looking-at "declare\\|generic")))
t
(if noerror nil
(error "no matching proc/func/task/declare/package/protected")))
))
(defun ada-goto-matching-start (&optional nest-level noerror gotothen)
"Moves point to the beginning of a block-start.
Which block depends on the value of NEST-LEVEL, which defaults to zero. If
NOERROR is non-nil, it only returns nil if no matching start was found.
If GOTOTHEN is non-nil, point moves to the 'then' following 'if'."
(let ((nest-count (if nest-level nest-level 0))
(found nil)
(pos nil))
;;
;; search backward for interesting keywords
;;
(while (and
(not found)
(ada-search-ignore-string-comment ada-matching-start-re t))
(unless (and (looking-at "\\<record\\>")
(save-excursion
(forward-word -1)
(looking-at "\\<null\\>")))
(progn
;;
;; calculate nest-depth
;;
(cond
;; found block end => increase nest depth
((looking-at "end")
(setq nest-count (1+ nest-count)))
;; found loop/select/record/case/if => check if it starts or
;; ends a block
((looking-at "loop\\|select\\|record\\|case\\|if")
(setq pos (point))
(save-excursion
;;
;; check if keyword follows 'end'
;;
(ada-goto-previous-word)
(if (looking-at "\\<end\\>[ \t]*[^;]")
;; it ends a block => increase nest depth
(progn
(setq nest-count (1+ nest-count))
(setq pos (point)))
;; it starts a block => decrease nest depth
(setq nest-count (1- nest-count))))
(goto-char pos))
;; found package start => check if it really is a block
((looking-at "package")
(save-excursion
;; ignore if this is just a renames statement
(let ((current (point))
(pos (ada-search-ignore-string-comment
"\\<\\(is\\|renames\\|;\\)\\>" nil)))
(if pos
(goto-char (car pos))
(error (concat
"No matching 'is' or 'renames' for 'package' at"
" line "
(number-to-string (count-lines (point-min)
(1+ current)))))))
(unless (looking-at "renames")
(progn
(forward-word 1)
(ada-goto-next-non-ws)
;; ignore it if it is only a declaration with 'new'
(if (not (looking-at "\\<\\(new\\|separate\\)\\>"))
(setq nest-count (1- nest-count)))))))
;; found task start => check if it has a body
((looking-at "task")
(save-excursion
(forward-word 1)
(ada-goto-next-non-ws)
(cond
((looking-at "\\<body\\>"))
((looking-at "\\<type\\>")
;; In that case, do nothing if there is a "is"
(forward-word 2);; skip "type"
(ada-goto-next-non-ws);; skip type name
;; Do nothing if we are simply looking at a simple
;; "task type name;" statement with no block
(unless (looking-at ";")
(progn
;; Skip the parameters
(if (looking-at "(")
(ada-search-ignore-string-comment ")" nil))
(let ((tmp (ada-search-ignore-string-comment
"\\<\\(is\\|;\\)\\>" nil)))
(if tmp
(progn
(goto-char (car tmp))
(if (looking-at "is")
(setq nest-count (1- nest-count)))))))))
(t
;; Check if that task declaration had a block attached to
;; it (i.e do nothing if we have just "task name;")
(unless (progn (forward-word 1)
(looking-at "[ \t]*;"))
(setq nest-count (1- nest-count)))))))
;; all the other block starts
(t
(setq nest-count (1- nest-count)))) ; end of 'cond'
;; match is found, if nest-depth is zero
;;
(setq found (zerop nest-count))))) ; end of loop
(if found
;;
;; match found => is there anything else to do ?
;;
(progn
(cond
;;
;; found 'if' => skip to 'then', if it's on a separate line
;; and GOTOTHEN is non-nil
;;
((and
gotothen
(looking-at "if")
(save-excursion
(ada-search-ignore-string-comment "then" nil nil nil
'word-search-forward)
(back-to-indentation)
(looking-at "\\<then\\>")))
(goto-char (match-beginning 0)))
;;
;; found 'do' => skip back to 'accept'
;;
((looking-at "do")
(unless (ada-search-ignore-string-comment "accept" t nil nil
'word-search-backward)
(error "missing 'accept' in front of 'do'"))))
(point))
(if noerror
nil
(error "no matching start")))))
(defun ada-goto-matching-end (&optional nest-level noerror)
"Moves point to the end of a block.
Which block depends on the value of NEST-LEVEL, which defaults to zero.
If NOERROR is non-nil, it only returns nil if found no matching start."
(let ((nest-count (if nest-level nest-level 0))
(found nil))
;;
;; search forward for interesting keywords
;;
(while (and
(not found)
(ada-search-ignore-string-comment
(eval-when-compile
(concat "\\<"
(regexp-opt '("end" "loop" "select" "begin" "case"
"if" "task" "package" "record" "do") t)
"\\>")) nil))
;;
;; calculate nest-depth
;;
(backward-word 1)
(cond
;; found block end => decrease nest depth
((looking-at "\\<end\\>")
(setq nest-count (1- nest-count))
;; skip the following keyword
(if (progn
(skip-chars-forward "end")
(ada-goto-next-non-ws)
(looking-at "\\<\\(loop\\|select\\|record\\|case\\|if\\)\\>"))
(forward-word 1)))
;; found package start => check if it really starts a block
((looking-at "\\<package\\>")
(ada-search-ignore-string-comment "is" nil nil nil
'word-search-forward)
(ada-goto-next-non-ws)
;; ignore and skip it if it is only a 'new' package
(if (looking-at "\\<new\\>")
(goto-char (match-end 0))
(setq nest-count (1+ nest-count))))
;; all the other block starts
(t
(setq nest-count (1+ nest-count))
(forward-word 1))) ; end of 'cond'
;; match is found, if nest-depth is zero
;;
(setq found (zerop nest-count))) ; end of loop
(if found
t
(if noerror
nil
(error "no matching end")))
))
(defun ada-search-ignore-string-comment
(search-re &optional backward limit paramlists search-func)
"Regexp-search for SEARCH-RE, ignoring comments, strings.
If PARAMLISTS is nil, ignore parameter lists. Returns a cons cell of
begin and end of match data or nil, if not found.
The search is done using SEARCH-FUNC, which should search backward if
BACKWARD is non-nil, forward otherwise. SEARCH-FUNC can be optimized in case
we are searching for a constant string.
The search stops at pos LIMIT.
Point is moved at the beginning of the search-re."
(let (found
begin
end
parse-result
(previous-syntax-table (syntax-table)))
(unless search-func
(setq search-func (if backward 're-search-backward 're-search-forward)))
;;
;; search until found or end-of-buffer
;; We have to test that we do not look further than limit
;;
(set-syntax-table ada-mode-symbol-syntax-table)
(while (and (not found)
(or (not limit)
(or (and backward (<= limit (point)))
(>= limit (point))))
(funcall search-func search-re limit 1))
(setq begin (match-beginning 0))
(setq end (match-end 0))
(setq parse-result (parse-partial-sexp
(save-excursion (beginning-of-line) (point))
(point)))
(cond
;;
;; If inside a string, skip it (and the following comments)
;;
((ada-in-string-p parse-result)
(if ada-xemacs
(search-backward "\"" nil t)
(goto-char (nth 8 parse-result)))
(unless backward (forward-sexp 1)))
;;
;; If inside a comment, skip it (and the following comments)
;; There is a special code for comments at the end of the file
;;
((ada-in-comment-p parse-result)
(if ada-xemacs
(progn
(forward-line 1)
(beginning-of-line)
(forward-comment -1))
(goto-char (nth 8 parse-result)))
(unless backward
;; at the end of the file, it is not possible to skip a comment
;; so we just go at the end of the line
(if (forward-comment 1)
(progn
(forward-comment 1000)
(beginning-of-line))
(end-of-line))))
;;
;; directly in front of a comment => skip it, if searching forward
;;
((and (= (char-after begin) ?-) (= (char-after (1+ begin)) ?-))
(unless backward (progn (forward-char -1) (forward-comment 1000))))
;;
;; found a parameter-list but should ignore it => skip it
;;
((and (not paramlists) (ada-in-paramlist-p))
(if backward
(search-backward "(" nil t)
(search-forward ")" nil t)))
;;
;; found what we were looking for
;;
(t
(setq found t)))) ; end of loop
(set-syntax-table previous-syntax-table)
(if found
(cons begin end)
nil)))
;; -------------------------------------------------------
;; -- Testing the position of the cursor
;; -------------------------------------------------------
(defun ada-in-decl-p ()
"Returns t if point is inside a declarative part.
Assumes point to be at the end of a statement."
(or (ada-in-paramlist-p)
(save-excursion
(ada-goto-matching-decl-start t))))
(defun ada-looking-at-semi-or ()
"Returns t if looking-at an 'or' following a semicolon."
(save-excursion
(and (looking-at "\\<or\\>")
(progn
(forward-word 1)
(ada-goto-stmt-start)
(looking-at "\\<or\\>")))))
(defun ada-looking-at-semi-private ()
"Returns t if looking at the start of a private section in a package.
Returns nil if the private is part of the package name, as in
'private package A is...' (this can only happen at top level)."
(save-excursion
(and (looking-at "\\<private\\>")
(not (looking-at "\\<private[ \t]*\\(package\\|generic\\)"))
;; Make sure this is the start of a private section (ie after
;; a semicolon or just after the package declaration, but not
;; after a 'type ... is private' or 'is new ... with private'
(progn (forward-comment -1000)
(or (= (char-before) ?\;)
(and (forward-word -3)
(looking-at "\\<package\\>")))))))
(defun ada-in-paramlist-p ()
"Returns t if point is inside a parameter-list."
(save-excursion
(and
(ada-search-ignore-string-comment "(\\|)" t nil t)
;; inside parentheses ?
(= (char-after) ?\()
;; We could be looking at two things here:
;; operator definition: function "." (
;; subprogram definition: procedure .... (
;; Let's skip back over the first one
(progn
(skip-syntax-backward " ")
(if (= (char-before) ?\")
(backward-char 3)
(backward-word 1))
t)
;; and now over the second one
(backward-word 1)
;; We should ignore the case when the reserved keyword is in a
;; comment (for instance, when we have:
;; -- .... package
;; Test (A)
;; we should return nil
(not (ada-in-string-or-comment-p))
;; right keyword two words before parenthesis ?
;; Type is in this list because of discriminants
(looking-at (eval-when-compile
(concat "\\<\\("
"procedure\\|function\\|body\\|"
"task\\|entry\\|accept\\|"
"access[ \t]+procedure\\|"
"access[ \t]+function\\|"
"pragma\\|"
"type\\)\\>"))))))
(defun ada-search-ignore-complex-boolean (regexp backwardp)
"Like `ada-search-ignore-string-comment', except that it also ignores
boolean expressions 'and then' and 'or else'."
(let (result)
(while (and (setq result (ada-search-ignore-string-comment regexp backwardp))
(save-excursion (forward-word -1)
(looking-at "and then\\|or else"))))
result))
(defun ada-in-open-paren-p ()
"Returns the position of the first non-ws behind the last unclosed
parenthesis, or nil."
(save-excursion
(let ((parse (parse-partial-sexp
(point)
(or (car (ada-search-ignore-complex-boolean
"\\<\\(;\\|is\\|then\\|loop\\|begin\\|else\\)\\>"
t))
(point-min)))))
(if (nth 1 parse)
(progn
(goto-char (1+ (nth 1 parse)))
(skip-chars-forward " \t")
(point))))))
;; -----------------------------------------------------------
;; -- Behavior Of TAB Key
;; -----------------------------------------------------------
(defun ada-tab ()
"Do indenting or tabbing according to `ada-tab-policy'.
In Transient Mark mode, if the mark is active, operate on the contents
of the region. Otherwise, operates only on the current line."
(interactive)
(cond ((eq ada-tab-policy 'indent-rigidly) (ada-tab-hard))
((eq ada-tab-policy 'indent-auto)
;; transient-mark-mode and mark-active are not defined in XEmacs
(if (or (and ada-xemacs (funcall (symbol-function 'region-active-p)))
(and (not ada-xemacs)
(symbol-value 'transient-mark-mode)
(symbol-value 'mark-active)))
(ada-indent-region (region-beginning) (region-end))
(ada-indent-current)))
((eq ada-tab-policy 'always-tab) (error "not implemented"))
))
(defun ada-untab (arg)
"Delete leading indenting according to `ada-tab-policy'."
(interactive "P")
(cond ((eq ada-tab-policy 'indent-rigidly) (ada-untab-hard))
((eq ada-tab-policy 'indent-auto) (error "not implemented"))
((eq ada-tab-policy 'always-tab) (error "not implemented"))
))
(defun ada-indent-current-function ()
"Ada mode version of the indent-line-function."
(interactive "*")
(let ((starting-point (point-marker)))
(beginning-of-line)
(ada-tab)
(if (< (point) starting-point)
(goto-char starting-point))
(set-marker starting-point nil)
))
(defun ada-tab-hard ()
"Indent current line to next tab stop."
(interactive)
(save-excursion
(beginning-of-line)
(insert-char ? ada-indent))
(if (save-excursion (= (point) (progn (beginning-of-line) (point))))
(forward-char ada-indent)))
(defun ada-untab-hard ()
"indent current line to previous tab stop."
(interactive)
(let ((bol (save-excursion (progn (beginning-of-line) (point))))
(eol (save-excursion (progn (end-of-line) (point)))))
(indent-rigidly bol eol (- 0 ada-indent))))
;; ------------------------------------------------------------
;; -- Miscellaneous
;; ------------------------------------------------------------
(defun ada-gnat-style ()
"Clean up comments, `(' and `,' for GNAT style checking switch."
(interactive)
(save-excursion
(goto-char (point-min))
(while (re-search-forward "--[ \t]*\\([^-]\\)" nil t)
(replace-match "-- \\1"))
(goto-char (point-min))
(while (re-search-forward "\\>(" nil t)
(replace-match " ("))
(goto-char (point-min))
(while (re-search-forward "([ \t]+" nil t)
(replace-match "("))
(goto-char (point-min))
(while (re-search-forward ")[ \t]+)" nil t)
(replace-match "))"))
(goto-char (point-min))
(while (re-search-forward "\\>:" nil t)
(replace-match " :"))
(goto-char (point-min))
(while (re-search-forward ",\\<" nil t)
(replace-match ", "))
(goto-char (point-min))
(while (re-search-forward "[ \t]*\\.\\.[ \t]*" nil t)
(replace-match " .. "))
(goto-char (point-min))
(while (re-search-forward "[ \t]*\\([-:+*/]\\)[ \t]*" nil t)
(if (not (ada-in-string-or-comment-p))
(progn
(forward-char -1)
(cond
((looking-at "/=")
(replace-match " /= "))
((looking-at ":=")
(replace-match ":= "))
((not (looking-at "--"))
(replace-match " \\1 ")))
(forward-char 2))))
))
;; -------------------------------------------------------------
;; -- Moving To Procedures/Packages/Statements
;; -------------------------------------------------------------
(defun ada-move-to-start ()
"Moves point to the matching start of the current Ada structure."
(interactive)
(let ((pos (point))
(previous-syntax-table (syntax-table)))
(unwind-protect
(progn
(set-syntax-table ada-mode-symbol-syntax-table)
(message "searching for block start ...")
(save-excursion
;;
;; do nothing if in string or comment or not on 'end ...;'
;; or if an error occurs during processing
;;
(or
(ada-in-string-or-comment-p)
(and (progn
(or (looking-at "[ \t]*\\<end\\>")
(backward-word 1))
(or (looking-at "[ \t]*\\<end\\>")
(backward-word 1))
(or (looking-at "[ \t]*\\<end\\>")
(error "not on end ...;")))
(ada-goto-matching-start 1)
(setq pos (point))
;;
;; on 'begin' => go on, according to user option
;;
ada-move-to-declaration
(looking-at "\\<begin\\>")
(ada-goto-matching-decl-start)
(setq pos (point))))
) ; end of save-excursion
;; now really move to the found position
(goto-char pos)
(message "searching for block start ... done"))
;; restore syntax-table
(set-syntax-table previous-syntax-table))))
(defun ada-move-to-end ()
"Moves point to the matching end of the block around point.
Moves to 'begin' if in a declarative part."
(interactive)
(let ((pos (point))
(previous-syntax-table (syntax-table)))
(unwind-protect
(progn
(set-syntax-table ada-mode-symbol-syntax-table)
(message "searching for block end ...")
(save-excursion
(forward-char 1)
(cond
;; directly on 'begin'
((save-excursion
(ada-goto-previous-word)
(looking-at "\\<begin\\>"))
(ada-goto-matching-end 1))
;; on first line of defun declaration
((save-excursion
(and (ada-goto-stmt-start)
(looking-at "\\<function\\>\\|\\<procedure\\>" )))
(ada-search-ignore-string-comment "begin" nil nil nil
'word-search-forward))
;; on first line of task declaration
((save-excursion
(and (ada-goto-stmt-start)
(looking-at "\\<task\\>" )
(forward-word 1)
(ada-goto-next-non-ws)
(looking-at "\\<body\\>")))
(ada-search-ignore-string-comment "begin" nil nil nil
'word-search-forward))
;; accept block start
((save-excursion
(and (ada-goto-stmt-start)
(looking-at "\\<accept\\>" )))
(ada-goto-matching-end 0))
;; package start
((save-excursion
(and (ada-goto-matching-decl-start t)
(looking-at "\\<package\\>")))
(ada-goto-matching-end 1))
;; inside a 'begin' ... 'end' block
((save-excursion
(ada-goto-matching-decl-start t))
(ada-search-ignore-string-comment "begin" nil nil nil
'word-search-forward))
;; (hopefully ;-) everything else
(t
(ada-goto-matching-end 1)))
(setq pos (point))
)
;; now really move to the position found
(goto-char pos)
(message "searching for block end ... done"))
;; restore syntax-table
(set-syntax-table previous-syntax-table))))
(defun ada-next-procedure ()
"Moves point to next procedure."
(interactive)
(end-of-line)
(if (re-search-forward ada-procedure-start-regexp nil t)
(goto-char (match-beginning 1))
(error "No more functions/procedures/tasks")))
(defun ada-previous-procedure ()
"Moves point to previous procedure."
(interactive)
(beginning-of-line)
(if (re-search-backward ada-procedure-start-regexp nil t)
(goto-char (match-beginning 1))
(error "No more functions/procedures/tasks")))
(defun ada-next-package ()
"Moves point to next package."
(interactive)
(end-of-line)
(if (re-search-forward ada-package-start-regexp nil t)
(goto-char (match-beginning 1))
(error "No more packages")))
(defun ada-previous-package ()
"Moves point to previous package."
(interactive)
(beginning-of-line)
(if (re-search-backward ada-package-start-regexp nil t)
(goto-char (match-beginning 1))
(error "No more packages")))
;; ------------------------------------------------------------
;; -- Define keymap and menus for Ada
;; -------------------------------------------------------------
(defun ada-create-keymap ()
"Create the keymap associated with the Ada mode."
;; Indentation and Formatting
(define-key ada-mode-map "\C-j" 'ada-indent-newline-indent-conditional)
(define-key ada-mode-map "\C-m" 'ada-indent-newline-indent-conditional)
(define-key ada-mode-map "\t" 'ada-tab)
(define-key ada-mode-map "\C-c\t" 'ada-justified-indent-current)
(define-key ada-mode-map "\C-c\C-l" 'ada-indent-region)
(define-key ada-mode-map [(shift tab)] 'ada-untab)
(define-key ada-mode-map "\C-c\C-f" 'ada-format-paramlist)
;; We don't want to make meta-characters case-specific.
;; Movement
(define-key ada-mode-map "\M-\C-e" 'ada-next-procedure)
(define-key ada-mode-map "\M-\C-a" 'ada-previous-procedure)
(define-key ada-mode-map "\C-c\C-a" 'ada-move-to-start)
(define-key ada-mode-map "\C-c\C-e" 'ada-move-to-end)
;; Compilation
(unless (lookup-key ada-mode-map "\C-c\C-c")
(define-key ada-mode-map "\C-c\C-c" 'compile))
;; Casing
(define-key ada-mode-map "\C-c\C-b" 'ada-adjust-case-buffer)
(define-key ada-mode-map "\C-c\C-t" 'ada-case-read-exceptions)
(define-key ada-mode-map "\C-c\C-y" 'ada-create-case-exception)
;; On XEmacs, you can easily specify whether DEL should deletes
;; one character forward or one character backward. Take this into
;; account
(if (boundp 'delete-key-deletes-forward)
(define-key ada-mode-map [backspace] 'backward-delete-char-untabify)
(define-key ada-mode-map "\177" 'backward-delete-char-untabify))
;; Make body
(define-key ada-mode-map "\C-c\C-n" 'ada-make-subprogram-body)
;; Use predefined function of Emacs19 for comments (RE)
(define-key ada-mode-map "\C-c;" 'comment-region)
(define-key ada-mode-map "\C-c:" 'ada-uncomment-region)
)
(defun ada-create-menu ()
"Create the ada menu as shown in the menu bar.
This function is designed to be extensible, so that each compiler-specific file
can add its own items."
;; Note that the separators must have different length in the submenus
(autoload 'easy-menu-define "easymenu")
(let ((m '("Ada"
("Help" ["Ada Mode" (info "ada-mode") t])))
(option '(["Auto Casing" (setq ada-auto-case (not ada-auto-case))
:style toggle :selected ada-auto-case]
["Auto Indent After Return"
(setq ada-indent-after-return (not ada-indent-after-return))
:style toggle :selected ada-indent-after-return]))
(goto '(["Next compilation error" next-error t]
["Previous Package" ada-previous-package t]
["Next Package" ada-next-package t]
["Previous Procedure" ada-previous-procedure t]
["Next Procedure" ada-next-procedure t]
["Goto Start Of Statement" ada-move-to-start t]
["Goto End Of Statement" ada-move-to-end t]
["-" nil nil]
["Other File" ff-find-other-file t]
["Other File Other Window" ada-ff-other-window t]))
(edit '(["Indent Line" ada-indent-current-function t]
["Justify Current Indentation" ada-justified-indent-current t]
["Indent Lines in Selection" ada-indent-region t]
["Indent Lines in File" (ada-indent-region (point-min) (point-max)) t]
["Format Parameter List" ada-format-paramlist t]
["-" nil nil]
["Comment Selection" comment-region t]
["Uncomment Selection" ada-uncomment-region t]
["--" nil nil]
["Fill Comment Paragraph" fill-paragraph t]
["Fill Comment Paragraph Justify" ada-fill-comment-paragraph-justify t]
["Fill Comment Paragraph Postfix" ada-fill-comment-paragraph-postfix t]
["---" nil nil]
["Adjust Case Selection" ada-adjust-case-region t]
["Adjust Case Buffer" ada-adjust-case-buffer t]
["Create Case Exception" ada-create-case-exception t]
["Reload Case Exceptions" ada-case-read-exceptions t]
["----" nil nil]
["Make body for subprogram" ada-make-subprogram-body t]))
)
;; Option menu present only if in Ada mode
(setq m (append m (list (append '("Options"
:included (eq major-mode 'ada-mode))
option))))
;; Customize menu always present
(when (fboundp 'customize-group)
(setq m (append m '(["Customize" (customize-group 'ada)]))))
;; Goto and Edit menus present only if in Ada mode
(setq m (append m (list (append '("Goto"
:included (eq major-mode 'ada-mode))
goto)
(append '("Edit"
:included (eq major-mode 'ada-mode))
edit))))
(easy-menu-define ada-mode-menu ada-mode-map "Menu keymap for Ada mode" m)
(easy-menu-add ada-mode-menu ada-mode-map)
(when ada-xemacs
;; This looks bogus to me! -stef
(define-key ada-mode-map [menu-bar] ada-mode-menu)
(setq mode-popup-menu (cons "Ada mode" ada-mode-menu)))))
;; -------------------------------------------------------
;; Commenting/Uncommenting code
;; The following two calls are provided to enhance the standard
;; comment-region function, which only allows uncommenting if the
;; comment is at the beginning of a line. If the line have been re-indented,
;; we are unable to use comment-region, which makes no sense.
;;
;; In addition, we provide an interface to the standard comment handling
;; function for justifying the comments.
;; -------------------------------------------------------
(defadvice comment-region (before ada-uncomment-anywhere)
(if (and arg
(< arg 0)
(string= mode-name "Ada"))
(save-excursion
(let ((cs (concat "^[ \t]*" (regexp-quote comment-start))))
(goto-char beg)
(while (re-search-forward cs end t)
(replace-match comment-start))
))))
(defun ada-uncomment-region (beg end &optional arg)
"Delete `comment-start' at the beginning of a line in the region."
(interactive "r\nP")
;; This advice is not needed anymore with Emacs21. However, for older
;; versions, as well as for XEmacs, we still need to enable it.
(if (or (<= emacs-major-version 20) (boundp 'running-xemacs))
(progn
(ad-activate 'comment-region)
(comment-region beg end (- (or arg 1)))
(ad-deactivate 'comment-region))
(comment-region beg end (list (- (or arg 1))))))
(defun ada-fill-comment-paragraph-justify ()
"Fills current comment paragraph and justifies each line as well."
(interactive)
(ada-fill-comment-paragraph 'full))
(defun ada-fill-comment-paragraph-postfix ()
"Fills current comment paragraph and justifies each line as well.
Adds `ada-fill-comment-postfix' at the end of each line."
(interactive)
(ada-fill-comment-paragraph 'full t))
(defun ada-fill-comment-paragraph (&optional justify postfix)
"Fills the current comment paragraph.
If JUSTIFY is non-nil, each line is justified as well.
If POSTFIX and JUSTIFY are non-nil, `ada-fill-comment-postfix' is appended
to each filled and justified line.
The paragraph is indented on the first line."
(interactive "P")
;; check if inside comment or just in front a comment
(if (and (not (ada-in-comment-p))
(not (looking-at "[ \t]*--")))
(error "not inside comment"))
(let* ((indent)
(from)
(to)
(opos (point-marker))
;; Sets this variable to nil, otherwise it prevents
;; fill-region-as-paragraph to work on Emacs <= 20.2
(parse-sexp-lookup-properties nil)
fill-prefix
(fill-column (current-fill-column)))
;; Find end of paragraph
(back-to-indentation)
(while (and (not (eobp)) (looking-at "--[ \t]*[^ \t\n]"))
(forward-line 1)
;; If we were at the last line in the buffer, create a dummy empty
;; line at the end of the buffer.
(if (eolp)
(insert "\n")
(back-to-indentation)))
(beginning-of-line)
(setq to (point-marker))
(goto-char opos)
;; Find beginning of paragraph
(back-to-indentation)
(while (and (not (bobp)) (looking-at "--[ \t]*[^ \t\n]"))
(forward-line -1)
(back-to-indentation))
;; We want one line to above the first one, unless we are at the beginning
;; of the buffer
(unless (bobp)
(forward-line 1))
(beginning-of-line)
(setq from (point-marker))
;; Calculate the indentation we will need for the paragraph
(back-to-indentation)
(setq indent (current-column))
;; unindent the first line of the paragraph
(delete-region from (point))
;; Remove the old postfixes
(goto-char from)
(while (re-search-forward "--\n" to t)
(replace-match "\n"))
;; Remove the old prefixes (so that the number of spaces after -- is not
;; relevant), except on the first one since `fill-region-as-paragraph'
;; would not put it back on the first line.
(goto-char (+ from 2))
(while (re-search-forward "^-- *" to t)
(replace-match " "))
(goto-char (1- to))
(setq to (point-marker))
;; Indent and justify the paragraph
(setq fill-prefix ada-fill-comment-prefix)
(set-left-margin from to indent)
(if postfix
(setq fill-column (- fill-column (length ada-fill-comment-postfix))))
(fill-region-as-paragraph from to justify)
;; Add the postfixes if required
(if postfix
(save-restriction
(goto-char from)
(narrow-to-region from to)
(while (not (eobp))
(end-of-line)
(insert-char ? (- fill-column (current-column)))
(insert ada-fill-comment-postfix)
(forward-line))
))
;; In Emacs <= 20.2 and XEmacs <=20.4, there is a bug, and a newline is
;; inserted at the end. Delete it
(if (or ada-xemacs
(<= emacs-major-version 19)
(and (= emacs-major-version 20)
(<= emacs-minor-version 2)))
(progn
(goto-char to)
(end-of-line)
(delete-char 1)))
(goto-char opos)))
;; ---------------------------------------------------
;; support for find-file.el
;; These functions are used by find-file to guess the file names from
;; unit names, and to find the other file (spec or body) from the current
;; file (body or spec).
;; It is also used to find in which function we are, so as to put the
;; cursor at the correct position.
;; Standard Ada does not force any relation between unit names and file names,
;; so some of these functions can only be a good approximation. However, they
;; are also overriden in `ada-xref'.el when we know that the user is using
;; GNAT.
;; ---------------------------------------------------
;; Overriden when we work with GNAT, to use gnatkrunch
(defun ada-make-filename-from-adaname (adaname)
"Determine the filename in which ADANAME is found.
This is a generic function, independent from any compiler."
(while (string-match "\\." adaname)
(setq adaname (replace-match "-" t t adaname)))
(downcase adaname)
)
(defun ada-other-file-name ()
"Return the name of the other file.
The name returned is the body if current-buffer is the spec, or the spec
otherwise."
(let ((is-spec nil)
(is-body nil)
(suffixes ada-spec-suffixes)
(name (buffer-file-name)))
;; Guess whether we have a spec or a body, and get the basename of the
;; file. Since the extension may not start with '.', we can not use
;; file-name-extension
(while (and (not is-spec)
suffixes)
(if (string-match (concat "\\(.*\\)" (car suffixes) "$") name)
(setq is-spec t
name (match-string 1 name)))
(setq suffixes (cdr suffixes)))
(if (not is-spec)
(progn
(setq suffixes ada-body-suffixes)
(while (and (not is-body)
suffixes)
(if (string-match (concat "\\(.*\\)" (car suffixes) "$") name)
(setq is-body t
name (match-string 1 name)))
(setq suffixes (cdr suffixes)))))
;; If this wasn't in either list, return name itself
(if (not (or is-spec is-body))
name
;; Else find the other possible names
(if is-spec
(setq suffixes ada-body-suffixes)
(setq suffixes ada-spec-suffixes))
(setq is-spec name)
(while suffixes
(if (file-exists-p (concat name (car suffixes)))
(setq is-spec (concat name (car suffixes))))
(setq suffixes (cdr suffixes)))
is-spec)))
(defun ada-which-function-are-we-in ()
"Return the name of the function whose definition/declaration point is in.
Redefines the function `ff-which-function-are-we-in'."
(setq ff-function-name nil)
(save-excursion
(end-of-line);; make sure we get the complete name
(if (or (re-search-backward ada-procedure-start-regexp nil t)
(re-search-backward ada-package-start-regexp nil t))
(setq ff-function-name (match-string 0)))
))
(defvar ada-last-which-function-line -1
"Last on which ada-which-function was called")
(defvar ada-last-which-function-subprog 0
"Last subprogram name returned by ada-which-function")
(make-variable-buffer-local 'ada-last-which-function-subprog)
(make-variable-buffer-local 'ada-last-which-function-line)
(defun ada-which-function ()
"Returns the name of the function whose body the point is in.
This function works even in the case of nested subprograms, whereas the
standard Emacs function which-function does not.
Note that this function expects subprogram bodies to be terminated by
'end <name>;', not 'end;'.
Since the search can be long, the results are cached."
(let ((line (count-lines (point-min) (point)))
(pos (point))
end-pos
func-name
found)
;; If this is the same line as before, simply return the same result
(if (= line ada-last-which-function-line)
ada-last-which-function-subprog
(save-excursion
;; In case the current line is also the beginning of the body
(end-of-line)
(while (and (ada-in-paramlist-p)
(= (forward-line 1) 0))
(end-of-line))
;; Can't simply do forward-word, in case the "is" is not on the
;; same line as the closing parenthesis
(skip-chars-forward "is \t\n")
;; No look for the closest subprogram body that has not ended yet.
;; Not that we expect all the bodies to be finished by "end <name",
;; not simply "end"
(while (and (not found)
(re-search-backward ada-imenu-subprogram-menu-re nil t))
(setq func-name (match-string 2))
(if (and (not (ada-in-comment-p))
(not (save-excursion
(goto-char (match-end 0))
(looking-at "[ \t\n]*new"))))
(save-excursion
(if (ada-search-ignore-string-comment
(concat "end[ \t]+" func-name "[ \t]*;"))
(setq end-pos (point))
(setq end-pos (point-max)))
(if (>= end-pos pos)
(setq found func-name))))
)
(setq ada-last-which-function-line line
ada-last-which-function-subprog found)
found))))
(defun ada-ff-other-window ()
"Find other file in other window using `ff-find-other-file'."
(interactive)
(and (fboundp 'ff-find-other-file)
(ff-find-other-file t)))
(defun ada-set-point-accordingly ()
"Move to the function declaration that was set by
`ff-which-function-are-we-in'."
(if ff-function-name
(progn
(goto-char (point-min))
(unless (ada-search-ignore-string-comment
(concat ff-function-name "\\b") nil)
(goto-char (point-min))))))
(defun ada-get-body-name (&optional spec-name)
"Returns the file name for the body of SPEC-NAME.
If SPEC-NAME is nil, returns the body for the current package.
Returns nil if no body was found."
(interactive)
(unless spec-name (setq spec-name (buffer-file-name)))
;; If find-file.el was available, use its functions
(if (functionp 'ff-get-file)
(ff-get-file-name ada-search-directories
(ada-make-filename-from-adaname
(file-name-nondirectory
(file-name-sans-extension spec-name)))
ada-body-suffixes)
;; Else emulate it very simply
(concat (ada-make-filename-from-adaname
(file-name-nondirectory
(file-name-sans-extension spec-name)))
".adb")))
;; ---------------------------------------------------
;; support for font-lock.el
;; Strings are a real pain in Ada because a single quote character is
;; overloaded as a string quote and type/instance delimiter. By default, a
;; single quote is given punctuation syntax in `ada-mode-syntax-table'.
;; So, for Font Lock mode purposes, we mark single quotes as having string
;; syntax when the gods that created Ada determine them to be.
;;
;; This only works in Emacs. See the comments before the grammar functions
;; at the beginning of this file for how this is done with XEmacs.
;; ----------------------------------------------------
(defconst ada-font-lock-syntactic-keywords
;; Mark single quotes as having string quote syntax in 'c' instances.
;; As a special case, ''' will not be highlighted, but if we do not
;; set this special case, then the rest of the buffer is highlighted as
;; a string
;; This sets the properties of the characters, so that ada-in-string-p
;; correctly handles '"' too...
'(("\\('\\)[^'\n]\\('\\)" (1 (7 . ?')) (2 (7 . ?')))
("^[ \t]*\\(#\\(if\\|else\\|elsif\\|end\\)\\)" (1 (11 . ?\n)))
))
(defvar ada-font-lock-keywords
(eval-when-compile
(list
;;
;; handle "type T is access function return S;"
(list "\\<\\(function[ \t]+return\\)\\>" '(1 font-lock-keyword-face) )
;; preprocessor line
(list "^[ \t]*\\(#.*\n\\)" '(1 font-lock-type-face t))
;;
;; accept, entry, function, package (body), protected (body|type),
;; pragma, procedure, task (body) plus name.
(list (concat
"\\<\\("
"accept\\|"
"entry\\|"
"function\\|"
"package[ \t]+body\\|"
"package\\|"
"pragma\\|"
"procedure\\|"
"protected[ \t]+body\\|"
"protected[ \t]+type\\|"
"protected\\|"
"task[ \t]+body\\|"
"task[ \t]+type\\|"
"task"
"\\)\\>[ \t]*"
"\\(\\sw+\\(\\.\\sw*\\)*\\)?")
'(1 font-lock-keyword-face) '(2 font-lock-function-name-face nil t))
;;
;; Optional keywords followed by a type name.
(list (concat ; ":[ \t]*"
"\\<\\(access[ \t]+all\\|access\\|constant\\|in[ \t]+out\\|in\\|out\\)\\>"
"[ \t]*"
"\\(\\sw+\\(\\.\\sw*\\)*\\)?")
'(1 font-lock-keyword-face nil t) '(2 font-lock-type-face nil t))
;;
;; Main keywords, except those treated specially below.
(concat "\\<"
(regexp-opt
'("abort" "abs" "abstract" "accept" "access" "aliased" "all"
"and" "array" "at" "begin" "case" "declare" "delay" "delta"
"digits" "do" "else" "elsif" "entry" "exception" "exit" "for"
"generic" "if" "in" "is" "limited" "loop" "mod" "not"
"null" "or" "others" "private" "protected" "raise"
"range" "record" "rem" "renames" "requeue" "return" "reverse"
"select" "separate" "tagged" "task" "terminate" "then" "until"
"when" "while" "xor") t)
"\\>")
;;
;; Anything following end and not already fontified is a body name.
'("\\<\\(end\\)\\>\\([ \t]+\\)?\\(\\(\\sw\\|[_.]\\)+\\)?"
(1 font-lock-keyword-face) (3 font-lock-function-name-face nil t))
;;
;; Keywords followed by a type or function name.
(list (concat "\\<\\("
"new\\|of\\|subtype\\|type"
"\\)\\>[ \t]*\\(\\sw+\\(\\.\\sw*\\)*\\)?[ \t]*\\((\\)?")
'(1 font-lock-keyword-face)
'(2 (if (match-beginning 4)
font-lock-function-name-face
font-lock-type-face) nil t))
;;
;; Keywords followed by a (comma separated list of) reference.
(list (concat "\\<\\(goto\\|raise\\|use\\|with\\)\\>" ; "when" removed
"[ \t\n]*\\(\\(\\sw\\|[_.|, \t\n]\\)+\\)\\W")
'(1 font-lock-keyword-face) '(2 font-lock-reference-face nil t))
;;
;; Goto tags.
'("<<\\(\\sw+\\)>>" 1 font-lock-reference-face)
))
"Default expressions to highlight in Ada mode.")
;; ---------------------------------------------------------
;; Support for outline.el
;; ---------------------------------------------------------
(defun ada-outline-level ()
"This is so that `current-column` DTRT in otherwise-hidden text"
;; patch from Dave Love <fx@gnu.org>
(let (buffer-invisibility-spec)
(save-excursion
(back-to-indentation)
(current-column))))
;; ---------------------------------------------------------
;; Automatic generation of code
;; The Ada-mode has a set of function to automatically generate a subprogram
;; or package body from its spec.
;; These function only use a primary and basic algorithm, this could use a
;; lot of improvement.
;; When the user is using GNAT, we rather use gnatstub to generate an accurate
;; body.
;; ----------------------------------------------------------
(defun ada-gen-treat-proc (match)
"Make dummy body of a procedure/function specification.
MATCH is a cons cell containing the start and end location of the last search
for ada-procedure-start-regexp."
(goto-char (car match))
(let (func-found procname functype)
(cond
((or (looking-at "^[ \t]*procedure")
(setq func-found (looking-at "^[ \t]*function")))
;; treat it as a proc/func
(forward-word 2)
(forward-word -1)
(setq procname (buffer-substring (point) (cdr match))) ; store proc name
;; goto end of procname
(goto-char (cdr match))
;; skip over parameterlist
(unless (looking-at "[ \t\n]*\\(;\\|return\\)")
(forward-sexp))
;; if function, skip over 'return' and result type.
(if func-found
(progn
(forward-word 1)
(skip-chars-forward " \t\n")
(setq functype (buffer-substring (point)
(progn
(skip-chars-forward
"a-zA-Z0-9_\.")
(point))))))
;; look for next non WS
(cond
((looking-at "[ \t]*;")
(delete-region (match-beginning 0) (match-end 0));; delete the ';'
(ada-indent-newline-indent)
(insert "is")
(ada-indent-newline-indent)
(if func-found
(progn
(insert "Result : " functype ";")
(ada-indent-newline-indent)))
(insert "begin")
(ada-indent-newline-indent)
(if func-found
(insert "return Result;")
(insert "null;"))
(ada-indent-newline-indent)
(insert "end " procname ";")
(ada-indent-newline-indent)
)
;; else
((looking-at "[ \t\n]*is")
;; do nothing
)
((looking-at "[ \t\n]*rename")
;; do nothing
)
(t
(message "unknown syntax"))))
(t
(if (looking-at "^[ \t]*task")
(progn
(message "Task conversion is not yet implemented")
(forward-word 2)
(if (looking-at "[ \t]*;")
(forward-line)
(ada-move-to-end))
))))))
(defun ada-make-body ()
"Create an Ada package body in the current buffer.
The potential old buffer contents is deleted first, then we copy the
spec buffer in here and modify it to make it a body.
This function typically is to be hooked into `ff-file-created-hooks'."
(interactive)
(delete-region (point-min) (point-max))
(insert-buffer (car (cdr (buffer-list))))
(ada-mode)
(let (found ada-procedure-or-package-start-regexp)
(if (setq found
(ada-search-ignore-string-comment ada-package-start-regexp nil))
(progn (goto-char (cdr found))
(insert " body")
)
(error "No package"))
(setq ada-procedure-or-package-start-regexp
(concat ada-procedure-start-regexp
"\\|"
ada-package-start-regexp))
(while (setq found
(ada-search-ignore-string-comment
ada-procedure-or-package-start-regexp nil))
(progn
(goto-char (car found))
(if (looking-at ada-package-start-regexp)
(progn (goto-char (cdr found))
(insert " body"))
(ada-gen-treat-proc found))))))
(defun ada-make-subprogram-body ()
"Make one dummy subprogram body from spec surrounding point."
(interactive)
(let* ((found (re-search-backward ada-procedure-start-regexp nil t))
(spec (match-beginning 0))
body-file)
(if found
(progn
(goto-char spec)
(if (and (re-search-forward "(\\|;" nil t)
(= (char-before) ?\())
(progn
(ada-search-ignore-string-comment ")" nil)
(ada-search-ignore-string-comment ";" nil)))
(setq spec (buffer-substring spec (point)))
;; If find-file.el was available, use its functions
(setq body-file (ada-get-body-name))
(if body-file
(find-file body-file)
(error "No body found for the package. Create it first"))
(save-restriction
(widen)
(goto-char (point-max))
(forward-comment -10000)
(re-search-backward "\\<end\\>" nil t)
;; Move to the beginning of the elaboration part, if any
(re-search-backward "^begin" nil t)
(newline)
(forward-char -1)
(insert spec)
(re-search-backward ada-procedure-start-regexp nil t)
(ada-gen-treat-proc (cons (match-beginning 0) (match-end 0)))
))
(error "Not in subprogram spec"))))
;; --------------------------------------------------------
;; Global initializations
;; --------------------------------------------------------
;; Create the keymap once and for all. If we do that in ada-mode,
;; the keys changed in the user's .emacs have to be modified
;; every time
(ada-create-keymap)
(ada-create-menu)
;; Create the syntax tables, but do not activate them
(ada-create-syntax-table)
;; Add the default extensions (and set up speedbar)
(ada-add-extensions ".ads" ".adb")
;; This two files are generated by GNAT when running with -gnatD
(if (equal ada-which-compiler 'gnat)
(ada-add-extensions ".ads.dg" ".adb.dg"))
;; Read the special cases for exceptions
(ada-case-read-exceptions)
;; include the other ada-mode files
(if (equal ada-which-compiler 'gnat)
(progn
;; The order here is important: ada-xref defines the Project
;; submenu, and ada-prj adds to it.
(require 'ada-xref)
(condition-case nil (require 'ada-prj) (error nil))
))
(condition-case nil (require 'ada-stmt) (error nil))
;;; provide ourselves
(provide 'ada-mode)
;;; ada-mode.el ends here
|