/usr/share/emacs/site-lisp/rst.el is in docutils-common 0.11-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 | ;;; rst.el --- Mode for viewing and editing reStructuredText-documents.
;; Copyright (C) 2003-2012 Free Software Foundation, Inc.
;; Maintainer: Stefan Merten <smerten@oekonux.de>
;; Author: Stefan Merten <smerten@oekonux.de>,
;; Martin Blais <blais@furius.ca>,
;; David Goodger <goodger@python.org>,
;; Wei-Wei Guo <wwguocn@gmail.com>
;; 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 3 of the License, 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. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; This package provides major mode rst-mode, which supports documents marked
;; up using the reStructuredText format. Support includes font locking as well
;; as a lot of convenience functions for editing. It does this by defining a
;; Emacs major mode: rst-mode (ReST). This mode is derived from text-mode.
;; This package also contains:
;;
;; - Functions to automatically adjust and cycle the section underline
;; adornments;
;; - A mode that displays the table of contents and allows you to jump anywhere
;; from it;
;; - Functions to insert and automatically update a TOC in your source
;; document;
;; - Function to insert list, processing item bullets and enumerations
;; automatically;
;; - Font-lock highlighting of most reStructuredText structures;
;; - Indentation and filling according to reStructuredText syntax;
;; - Cursor movement according to reStructuredText syntax;
;; - Some other convenience functions.
;;
;; See the accompanying document in the docutils documentation about
;; the contents of this package and how to use it.
;;
;; For more information about reStructuredText, see
;; http://docutils.sourceforge.net/rst.html
;;
;; For full details on how to use the contents of this file, see
;; http://docutils.sourceforge.net/docs/user/emacs.html
;;
;;
;; There are a number of convenient key bindings provided by rst-mode.
;; For more on bindings, see rst-mode-map below. There are also many variables
;; that can be customized, look for defcustom in this file.
;;
;; If you use the table-of-contents feature, you may want to add a hook to
;; update the TOC automatically every time you adjust a section title::
;;
;; (add-hook 'rst-adjust-hook 'rst-toc-update)
;;
;; Syntax highlighting: font-lock is enabled by default. If you want to turn
;; off syntax highlighting to rst-mode, you can use the following::
;;
;; (setq font-lock-global-modes '(not rst-mode ...))
;;
;;
;;
;; Customization is done by customizable variables contained in customization
;; group "rst" and subgroups. Group "rst" is contained in the "wp" group.
;;
;;; DOWNLOAD
;; The latest release of this file lies in the docutils source code repository:
;; http://docutils.svn.sourceforge.net/svnroot/docutils/trunk/docutils/tools/editors/emacs/rst.el
;;; INSTALLATION
;; Add the following lines to your init file:
;;
;; (require 'rst)
;;
;; If you are using `.txt' as a standard extension for reST files as
;; http://docutils.sourceforge.net/FAQ.html#what-s-the-standard-filename-extension-for-a-restructuredtext-file
;; suggests you may use one of the `Local Variables in Files' mechanism Emacs
;; provides to set the major mode automatically. For instance you may use::
;;
;; .. -*- mode: rst -*-
;;
;; in the very first line of your file. The following code is useful if you
;; want automatically enter rst-mode from any file with compatible extensions:
;;
;; (setq auto-mode-alist
;; (append '(("\\.txt\\'" . rst-mode)
;; ("\\.rst\\'" . rst-mode)
;; ("\\.rest\\'" . rst-mode)) auto-mode-alist))
;;
;;; Code:
;; FIXME: Check through major mode conventions again.
;; FIXME: Add proper ";;;###autoload" comments.
;; FIXME: When 24.1 is common place remove use of `lexical-let' and put "-*-
;; lexical-binding: t -*-" in the first line.
;; FIXME: Use `testcover'.
;; FIXME: The adornment classification often called `ado' should be a
;; `defstruct'.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Support for `testcover'
(when (boundp 'testcover-1value-functions)
;; Below `lambda' is used in a loop with varying parameters and is thus not
;; 1valued.
(setq testcover-1value-functions
(delq 'lambda testcover-1value-functions))
(add-to-list 'testcover-compose-functions 'lambda))
(defun rst-testcover-defcustom ()
"Remove all customized variables from `testcover-module-constants'.
This seems to be a bug in `testcover': `defcustom' variables are
considered constants. Revert it with this function after each `defcustom'."
(when (boundp 'testcover-module-constants)
(setq testcover-module-constants
(delq nil
(mapcar
(lambda (sym)
(if (not (plist-member (symbol-plist sym) 'standard-value))
sym))
testcover-module-constants)))))
(defun rst-testcover-add-compose (fun)
"Add FUN to `testcover-compose-functions'."
(when (boundp 'testcover-compose-functions)
(add-to-list 'testcover-compose-functions fun)))
(defun rst-testcover-add-1value (fun)
"Add FUN to `testcover-1value-functions'."
(when (boundp 'testcover-1value-functions)
(add-to-list 'testcover-1value-functions fun)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Common Lisp stuff
;; Only use of macros is allowed - may be replaced by `cl-lib' some time.
(eval-when-compile
(require 'cl))
;; Redefine some functions from `cl.el' in a proper namespace until they may be
;; used from there.
(defun rst-signum (x)
"Return 1 if X is positive, -1 if negative, 0 if zero."
(cond
((> x 0) 1)
((< x 0) -1)
(t 0)))
(defun rst-some (seq &optional pred)
"Return non-nil if any element of SEQ yields non-nil when PRED is applied.
Apply PRED to each element of list SEQ until the first non-nil
result is yielded and return this result. PRED defaults to
`identity'."
(unless pred
(setq pred 'identity))
(catch 'rst-some
(dolist (elem seq)
(let ((r (funcall pred elem)))
(when r
(throw 'rst-some r))))))
(defun rst-position-if (pred seq)
"Return position of first element satisfying PRED in list SEQ or nil."
(catch 'rst-position-if
(let ((i 0))
(dolist (elem seq)
(when (funcall pred elem)
(throw 'rst-position-if i))
(incf i)))))
(defun rst-position (elem seq)
"Return position of ELEM in list SEQ or nil.
Comparison done with `equal'."
;; Create a closure containing `elem' so the `lambda' always sees our
;; parameter instead of an `elem' which may be in dynamic scope at the time
;; of execution of the `lambda'.
(lexical-let ((elem elem))
(rst-position-if (function (lambda (e)
(equal elem e)))
seq)))
;; FIXME: Embed complicated `defconst's in `eval-when-compile'.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Versions
;; testcover: ok.
(defun rst-extract-version (delim-re head-re re tail-re var &optional default)
"Extract the version from a variable according to the given regexes.
Return the version after regex DELIM-RE and HEAD-RE matching RE
and before TAIL-RE and DELIM-RE in VAR or DEFAULT for no match."
(if (string-match
(concat delim-re head-re "\\(" re "\\)" tail-re delim-re)
var)
(match-string 1 var)
default))
;; Use CVSHeader to really get information from CVS and not other version
;; control systems.
(defconst rst-cvs-header
"$CVSHeader: sm/rst_el/rst.el,v 1.326 2012-09-20 21:28:04 stefan Exp $")
(defconst rst-cvs-rev
(rst-extract-version "\\$" "CVSHeader: \\S + " "[0-9]+\\(?:\\.[0-9]+\\)+"
" .*" rst-cvs-header "0.0")
"The CVS revision of this file. CVS revision is the development revision.")
(defconst rst-cvs-timestamp
(rst-extract-version "\\$" "CVSHeader: \\S + \\S + "
"[0-9]+-[0-9]+-[0-9]+ [0-9]+:[0-9]+:[0-9]+" " .*"
rst-cvs-header "1970-01-01 00:00:00")
"The CVS time stamp of this file.")
;; Use LastChanged... to really get information from SVN.
(defconst rst-svn-rev
(rst-extract-version "\\$" "LastChangedRevision: " "[0-9]+" " "
"$LastChangedRevision: 7515 $")
"The SVN revision of this file.
SVN revision is the upstream (docutils) revision.")
(defconst rst-svn-timestamp
(rst-extract-version "\\$" "LastChangedDate: " ".+?+" " "
"$LastChangedDate: 2012-09-20 23:28:53 +0200 (Thu, 20 Sep 2012) $")
"The SVN time stamp of this file.")
;; Maintained by the release process.
(defconst rst-official-version
(rst-extract-version "%" "OfficialVersion: " "[0-9]+\\(?:\\.[0-9]+\\)+" " "
"%OfficialVersion: 1.4.0 %")
"Official version of the package.")
(defconst rst-official-cvs-rev
(rst-extract-version "[%$]" "Revision: " "[0-9]+\\(?:\\.[0-9]+\\)+" " "
"$Revision: 7515 $")
"CVS revision of this file in the official version.")
(defconst rst-version
(if (equal rst-official-cvs-rev rst-cvs-rev)
rst-official-version
(format "%s (development %s [%s])" rst-official-version
rst-cvs-rev rst-cvs-timestamp))
"The version string.
Starts with the current official version. For developer versions
in parentheses follows the development revision and the time stamp.")
(defconst rst-package-emacs-version-alist
'(("1.0.0" . "24.3")
("1.1.0" . "24.3")
("1.2.0" . "24.3")
("1.2.1" . "24.3")
("1.3.0" . "24.3")
("1.3.1" . "24.3")
("1.4.0" . "24.3")
))
(unless (assoc rst-official-version rst-package-emacs-version-alist)
(error "Version %s not listed in `rst-package-emacs-version-alist'"
rst-version))
(add-to-list 'customize-package-emacs-version-alist
(cons 'ReST rst-package-emacs-version-alist))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Initialize customization
(defgroup rst nil "Support for reStructuredText documents."
:group 'wp
:version "23.1"
:link '(url-link "http://docutils.sourceforge.net/rst.html"))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Facilities for regular expressions used everywhere
;; The trailing numbers in the names give the number of referenceable regex
;; groups contained in the regex.
;; Used to be customizable but really is not customizable but fixed by the reST
;; syntax.
(defconst rst-bullets
;; Sorted so they can form a character class when concatenated.
'(?- ?* ?+ ?\u2022 ?\u2023 ?\u2043)
"List of all possible bullet characters for bulleted lists.")
(defconst rst-uri-schemes
'("acap" "cid" "data" "dav" "fax" "file" "ftp" "gopher" "http" "https" "imap"
"ldap" "mailto" "mid" "modem" "news" "nfs" "nntp" "pop" "prospero" "rtsp"
"service" "sip" "tel" "telnet" "tip" "urn" "vemmi" "wais")
"Supported URI schemes.")
(defconst rst-adornment-chars
;; Sorted so they can form a character class when concatenated.
'(?\]
?! ?\" ?# ?$ ?% ?& ?' ?\( ?\) ?* ?+ ?, ?. ?/ ?: ?\; ?< ?= ?> ?? ?@ ?\[ ?\\
?^ ?_ ?` ?{ ?| ?} ?~
?-)
"Characters which may be used in adornments for sections and transitions.")
(defconst rst-max-inline-length
1000
"Maximum length of inline markup to recognize.")
(defconst rst-re-alist-def
;; `*-beg' matches * at the beginning of a line.
;; `*-end' matches * at the end of a line.
;; `*-prt' matches a part of *.
;; `*-tag' matches *.
;; `*-sta' matches the start of * which may be followed by respective content.
;; `*-pfx' matches the delimiter left of *.
;; `*-sfx' matches the delimiter right of *.
;; `*-hlp' helper for *.
;;
;; A trailing number says how many referenceable groups are contained.
`(
;; Horizontal white space (`hws')
(hws-prt "[\t ]")
(hws-tag hws-prt "*") ; Optional sequence of horizontal white space.
(hws-sta hws-prt "+") ; Mandatory sequence of horizontal white space.
;; Lines (`lin')
(lin-beg "^" hws-tag) ; Beginning of a possibly indented line.
(lin-end hws-tag "$") ; End of a line with optional trailing white space.
(linemp-tag "^" hws-tag "$") ; Empty line with optional white space.
;; Various tags and parts
(ell-tag "\\.\\.\\.") ; Ellipsis
(bul-tag ,(concat "[" rst-bullets "]")) ; A bullet.
(ltr-tag "[a-zA-Z]") ; A letter enumerator tag.
(num-prt "[0-9]") ; A number enumerator part.
(num-tag num-prt "+") ; A number enumerator tag.
(rom-prt "[IVXLCDMivxlcdm]") ; A roman enumerator part.
(rom-tag rom-prt "+") ; A roman enumerator tag.
(aut-tag "#") ; An automatic enumerator tag.
(dcl-tag "::") ; Double colon.
;; Block lead in (`bli')
(bli-sfx (:alt hws-sta "$")) ; Suffix of a block lead-in with *optional*
; immediate content.
;; Various starts
(bul-sta bul-tag bli-sfx) ; Start of a bulleted item.
;; Explicit markup tag (`exm')
(exm-tag "\\.\\.")
(exm-sta exm-tag hws-sta)
(exm-beg lin-beg exm-sta)
;; Counters in enumerations (`cnt')
(cntany-tag (:alt ltr-tag num-tag rom-tag aut-tag)) ; An arbitrary counter.
(cntexp-tag (:alt ltr-tag num-tag rom-tag)) ; An arbitrary explicit counter.
;; Enumerator (`enm')
(enmany-tag (:alt
(:seq cntany-tag "\\.")
(:seq "(?" cntany-tag ")"))) ; An arbitrary enumerator.
(enmexp-tag (:alt
(:seq cntexp-tag "\\.")
(:seq "(?" cntexp-tag ")"))) ; An arbitrary explicit
; enumerator.
(enmaut-tag (:alt
(:seq aut-tag "\\.")
(:seq "(?" aut-tag ")"))) ; An automatic enumerator.
(enmany-sta enmany-tag bli-sfx) ; An arbitrary enumerator start.
(enmexp-sta enmexp-tag bli-sfx) ; An arbitrary explicit enumerator start.
(enmexp-beg lin-beg enmexp-sta) ; An arbitrary explicit enumerator start
; at the beginning of a line.
;; Items may be enumerated or bulleted (`itm')
(itmany-tag (:alt enmany-tag bul-tag)) ; An arbitrary item tag.
(itmany-sta-1 (:grp itmany-tag) bli-sfx) ; An arbitrary item start, group
; is the item tag.
(itmany-beg-1 lin-beg itmany-sta-1) ; An arbitrary item start at the
; beginning of a line, group is the
; item tag.
;; Inline markup (`ilm')
(ilm-pfx (:alt "^" hws-prt "[-'\"([{<\u2018\u201c\u00ab\u2019/:]"))
(ilm-sfx (:alt "$" hws-prt "[]-'\")}>\u2019\u201d\u00bb/:.,;!?\\]"))
;; Inline markup content (`ilc')
(ilcsgl-tag "\\S ") ; A single non-white character.
(ilcast-prt (:alt "[^*\\]" "\\\\.")) ; Part of non-asterisk content.
(ilcbkq-prt (:alt "[^`\\]" "\\\\.")) ; Part of non-backquote content.
(ilcbkqdef-prt (:alt "[^`\\\n]" "\\\\.")) ; Part of non-backquote
; definition.
(ilcbar-prt (:alt "[^|\\]" "\\\\.")) ; Part of non-vertical-bar content.
(ilcbardef-prt (:alt "[^|\\\n]" "\\\\.")) ; Part of non-vertical-bar
; definition.
(ilcast-sfx "[^\t *\\]") ; Suffix of non-asterisk content.
(ilcbkq-sfx "[^\t `\\]") ; Suffix of non-backquote content.
(ilcbar-sfx "[^\t |\\]") ; Suffix of non-vertical-bar content.
(ilcrep-hlp ,(format "\\{0,%d\\}" rst-max-inline-length)) ; Repeat count.
(ilcast-tag (:alt ilcsgl-tag
(:seq ilcsgl-tag
ilcast-prt ilcrep-hlp
ilcast-sfx))) ; Non-asterisk content.
(ilcbkq-tag (:alt ilcsgl-tag
(:seq ilcsgl-tag
ilcbkq-prt ilcrep-hlp
ilcbkq-sfx))) ; Non-backquote content.
(ilcbkqdef-tag (:alt ilcsgl-tag
(:seq ilcsgl-tag
ilcbkqdef-prt ilcrep-hlp
ilcbkq-sfx))) ; Non-backquote definition.
(ilcbar-tag (:alt ilcsgl-tag
(:seq ilcsgl-tag
ilcbar-prt ilcrep-hlp
ilcbar-sfx))) ; Non-vertical-bar content.
(ilcbardef-tag (:alt ilcsgl-tag
(:seq ilcsgl-tag
ilcbardef-prt ilcrep-hlp
ilcbar-sfx))) ; Non-vertical-bar definition.
;; Fields (`fld')
(fldnam-prt (:alt "[^:\n]" "\\\\:")) ; Part of a field name.
(fldnam-tag fldnam-prt "+") ; A field name.
(fld-tag ":" fldnam-tag ":") ; A field marker.
;; Options (`opt')
(optsta-tag (:alt "[-+/]" "--")) ; Start of an option.
(optnam-tag "\\sw" (:alt "-" "\\sw") "*") ; Name of an option.
(optarg-tag (:shy "[ =]\\S +")) ; Option argument.
(optsep-tag (:shy "," hws-prt)) ; Separator between options.
(opt-tag (:shy optsta-tag optnam-tag optarg-tag "?")) ; A complete option.
;; Footnotes and citations (`fnc')
(fncnam-prt "[^\]\n]") ; Part of a footnote or citation name.
(fncnam-tag fncnam-prt "+") ; A footnote or citation name.
(fnc-tag "\\[" fncnam-tag "]") ; A complete footnote or citation tag.
(fncdef-tag-2 (:grp exm-sta)
(:grp fnc-tag)) ; A complete footnote or citation definition
; tag. First group is the explicit markup
; start, second group is the footnote /
; citation tag.
(fnc-sta-2 fncdef-tag-2 bli-sfx) ; Start of a footnote or citation
; definition. First group is the explicit
; markup start, second group is the
; footnote / citation tag.
;; Substitutions (`sub')
(sub-tag "|" ilcbar-tag "|") ; A complete substitution tag.
(subdef-tag "|" ilcbardef-tag "|") ; A complete substitution definition
; tag.
;; Symbol (`sym')
(sym-prt "[-+.:_]") ; Non-word part of a symbol.
(sym-tag (:shy "\\sw+" (:shy sym-prt "\\sw+") "*"))
;; URIs (`uri')
(uri-tag (:alt ,@rst-uri-schemes))
;; Adornment (`ado')
(ado-prt "[" ,(concat rst-adornment-chars) "]")
(adorep3-hlp "\\{3,\\}") ; There must be at least 3 characters because
; otherwise explicit markup start would be
; recognized.
(adorep2-hlp "\\{2,\\}") ; As `adorep3-hlp' but when the first of three
; characters is matched differently.
(ado-tag-1-1 (:grp ado-prt)
"\\1" adorep2-hlp) ; A complete adornment, group is the first
; adornment character and MUST be the FIRST
; group in the whole expression.
(ado-tag-1-2 (:grp ado-prt)
"\\2" adorep2-hlp) ; A complete adornment, group is the first
; adornment character and MUST be the
; SECOND group in the whole expression.
(ado-beg-2-1 "^" (:grp ado-tag-1-2)
lin-end) ; A complete adornment line; first group is the whole
; adornment and MUST be the FIRST group in the whole
; expression; second group is the first adornment
; character.
;; Titles (`ttl')
(ttl-tag "\\S *\\w\\S *") ; A title text.
(ttl-beg lin-beg ttl-tag) ; A title text at the beginning of a line.
;; Directives and substitution definitions (`dir')
(dir-tag-3 (:grp exm-sta)
(:grp (:shy subdef-tag hws-sta) "?")
(:grp sym-tag dcl-tag)) ; A directive or substitution definition
; tag. First group is explicit markup
; start, second group is a possibly
; empty substitution tag, third group is
; the directive tag including the double
; colon.
(dir-sta-3 dir-tag-3 bli-sfx) ; Start of a directive or substitution
; definition. Groups are as in dir-tag-3.
;; Literal block (`lit')
(lit-sta-2 (:grp (:alt "[^.\n]" "\\.[^.\n]") ".*") "?"
(:grp dcl-tag) "$") ; Start of a literal block. First group is
; any text before the double colon tag which
; may not exist, second group is the double
; colon tag.
;; Comments (`cmt')
(cmt-sta-1 (:grp exm-sta) "[^\[|_\n]"
(:alt "[^:\n]" (:seq ":" (:alt "[^:\n]" "$")))
"*$") ; Start of a comment block; first group is explicit markup
; start.
;; Paragraphs (`par')
(par-tag- (:alt itmany-tag fld-tag opt-tag fncdef-tag-2 dir-tag-3 exm-tag)
) ; Tag at the beginning of a paragraph; there may be groups in
; certain cases.
)
"Definition alist of relevant regexes.
Each entry consists of the symbol naming the regex and an
argument list for `rst-re'.")
(defvar rst-re-alist) ; Forward declare to use it in `rst-re'.
;; FIXME: Use `sregex` or `rx` instead of re-inventing the wheel.
(rst-testcover-add-compose 'rst-re)
;; testcover: ok.
(defun rst-re (&rest args)
"Interpret ARGS as regular expressions and return a regex string.
Each element of ARGS may be one of the following:
A string which is inserted unchanged.
A character which is resolved to a quoted regex.
A symbol which is resolved to a string using `rst-re-alist-def'.
A list with a keyword in the car. Each element of the cdr of such
a list is recursively interpreted as ARGS. The results of this
interpretation are concatenated according to the keyword.
For the keyword `:seq' the results are simply concatenated.
For the keyword `:shy' the results are concatenated and
surrounded by a shy-group (\"\\(?:...\\)\").
For the keyword `:alt' the results form an alternative (\"\\|\")
which is shy-grouped (\"\\(?:...\\)\").
For the keyword `:grp' the results are concatenated and form a
referenceable group (\"\\(...\\)\").
After interpretation of ARGS the results are concatenated as for
`:seq'."
(apply 'concat
(mapcar
(lambda (re)
(cond
((stringp re)
re)
((symbolp re)
(cadr (assoc re rst-re-alist)))
((characterp re)
(regexp-quote (char-to-string re)))
((listp re)
(let ((nested
(mapcar (lambda (elt)
(rst-re elt))
(cdr re))))
(cond
((eq (car re) :seq)
(mapconcat 'identity nested ""))
((eq (car re) :shy)
(concat "\\(?:" (mapconcat 'identity nested "") "\\)"))
((eq (car re) :grp)
(concat "\\(" (mapconcat 'identity nested "") "\\)"))
((eq (car re) :alt)
(concat "\\(?:" (mapconcat 'identity nested "\\|") "\\)"))
(t
(error "Unknown list car: %s" (car re))))))
(t
(error "Unknown object type for building regex: %s" re))))
args)))
;; FIXME: Remove circular dependency between `rst-re' and `rst-re-alist'.
(with-no-warnings ; Silence byte-compiler about this construction.
(defconst rst-re-alist
;; Shadow global value we are just defining so we can construct it step by
;; step.
(let (rst-re-alist)
(dolist (re rst-re-alist-def rst-re-alist)
(setq rst-re-alist
(nconc rst-re-alist
(list (list (car re) (apply 'rst-re (cdr re))))))))
"Alist mapping symbols from `rst-re-alist-def' to regex strings."))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Mode definition
;; testcover: ok.
(defun rst-define-key (keymap key def &rest deprecated)
"Bind like `define-key' but add deprecated key definitions.
KEYMAP, KEY, and DEF are as in `define-key'. DEPRECATED key
definitions should be in vector notation. These are defined as
well but give an additional message."
(define-key keymap key def)
(dolist (dep-key deprecated)
(define-key keymap dep-key
`(lambda ()
,(format "Deprecated binding for %s, use \\[%s] instead." def def)
(interactive)
(call-interactively ',def)
(message "[Deprecated use of key %s; use key %s instead]"
(key-description (this-command-keys))
(key-description ,key))))))
;; Key bindings.
(defvar rst-mode-map
(let ((map (make-sparse-keymap)))
;; \C-c is the general keymap.
(rst-define-key map [?\C-c ?\C-h] 'describe-prefix-bindings)
;;
;; Section Adornments
;;
;; The adjustment function that adorns or rotates a section title.
(rst-define-key map [?\C-c ?\C-=] 'rst-adjust [?\C-c ?\C-a t])
(rst-define-key map [?\C-=] 'rst-adjust) ; Does not work on the Mac OSX and
; on consoles.
;; \C-c \C-a is the keymap for adornments.
(rst-define-key map [?\C-c ?\C-a ?\C-h] 'describe-prefix-bindings)
;; Another binding which works with all types of input.
(rst-define-key map [?\C-c ?\C-a ?\C-a] 'rst-adjust)
;; Display the hierarchy of adornments implied by the current document
;; contents.
(rst-define-key map [?\C-c ?\C-a ?\C-d] 'rst-display-adornments-hierarchy)
;; Homogenize the adornments in the document.
(rst-define-key map [?\C-c ?\C-a ?\C-s] 'rst-straighten-adornments
[?\C-c ?\C-s])
;;
;; Section Movement and Selection
;;
;; Mark the subsection where the cursor is.
(rst-define-key map [?\C-\M-h] 'rst-mark-section
;; Same as mark-defun sgml-mark-current-element.
[?\C-c ?\C-m])
;; Move backward/forward between section titles.
;; FIXME: Also bind similar to outline mode.
(rst-define-key map [?\C-\M-a] 'rst-backward-section
;; Same as beginning-of-defun.
[?\C-c ?\C-n])
(rst-define-key map [?\C-\M-e] 'rst-forward-section
;; Same as end-of-defun.
[?\C-c ?\C-p])
;;
;; Operating on regions
;;
;; \C-c \C-r is the keymap for regions.
(rst-define-key map [?\C-c ?\C-r ?\C-h] 'describe-prefix-bindings)
;; Makes region a line-block.
(rst-define-key map [?\C-c ?\C-r ?\C-l] 'rst-line-block-region
[?\C-c ?\C-d])
;; Shift region left or right according to tabs.
(rst-define-key map [?\C-c ?\C-r tab] 'rst-shift-region
[?\C-c ?\C-r t] [?\C-c ?\C-l t])
;;
;; Operating on lists
;;
;; \C-c \C-l is the keymap for lists.
(rst-define-key map [?\C-c ?\C-l ?\C-h] 'describe-prefix-bindings)
;; Makes paragraphs in region as a bullet list.
(rst-define-key map [?\C-c ?\C-l ?\C-b] 'rst-bullet-list-region
[?\C-c ?\C-b])
;; Makes paragraphs in region as a enumeration.
(rst-define-key map [?\C-c ?\C-l ?\C-e] 'rst-enumerate-region
[?\C-c ?\C-e])
;; Converts bullets to an enumeration.
(rst-define-key map [?\C-c ?\C-l ?\C-c] 'rst-convert-bullets-to-enumeration
[?\C-c ?\C-v])
;; Make sure that all the bullets in the region are consistent.
(rst-define-key map [?\C-c ?\C-l ?\C-s] 'rst-straighten-bullets-region
[?\C-c ?\C-w])
;; Insert a list item.
(rst-define-key map [?\C-c ?\C-l ?\C-i] 'rst-insert-list)
;;
;; Table-of-Contents Features
;;
;; \C-c \C-t is the keymap for table of contents.
(rst-define-key map [?\C-c ?\C-t ?\C-h] 'describe-prefix-bindings)
;; Enter a TOC buffer to view and move to a specific section.
(rst-define-key map [?\C-c ?\C-t ?\C-t] 'rst-toc)
;; Insert a TOC here.
(rst-define-key map [?\C-c ?\C-t ?\C-i] 'rst-toc-insert
[?\C-c ?\C-i])
;; Update the document's TOC (without changing the cursor position).
(rst-define-key map [?\C-c ?\C-t ?\C-u] 'rst-toc-update
[?\C-c ?\C-u])
;; Go to the section under the cursor (cursor must be in TOC).
(rst-define-key map [?\C-c ?\C-t ?\C-j] 'rst-goto-section
[?\C-c ?\C-f])
;;
;; Converting Documents from Emacs
;;
;; \C-c \C-c is the keymap for compilation.
(rst-define-key map [?\C-c ?\C-c ?\C-h] 'describe-prefix-bindings)
;; Run one of two pre-configured toolset commands on the document.
(rst-define-key map [?\C-c ?\C-c ?\C-c] 'rst-compile
[?\C-c ?1])
(rst-define-key map [?\C-c ?\C-c ?\C-a] 'rst-compile-alt-toolset
[?\C-c ?2])
;; Convert the active region to pseudo-xml using the docutils tools.
(rst-define-key map [?\C-c ?\C-c ?\C-x] 'rst-compile-pseudo-region
[?\C-c ?3])
;; Convert the current document to PDF and launch a viewer on the results.
(rst-define-key map [?\C-c ?\C-c ?\C-p] 'rst-compile-pdf-preview
[?\C-c ?4])
;; Convert the current document to S5 slides and view in a web browser.
(rst-define-key map [?\C-c ?\C-c ?\C-s] 'rst-compile-slides-preview
[?\C-c ?5])
map)
"Keymap for reStructuredText mode commands.
This inherits from Text mode.")
;; Abbrevs.
(define-abbrev-table 'rst-mode-abbrev-table
(mapcar (lambda (x) (append x '(nil 0 system)))
'(("contents" ".. contents::\n..\n ")
("con" ".. contents::\n..\n ")
("cont" "[...]")
("skip" "\n\n[...]\n\n ")
("seq" "\n\n[...]\n\n ")
;; FIXME: Add footnotes, links, and more.
))
"Abbrev table used while in `rst-mode'.")
;; Syntax table.
(defvar rst-mode-syntax-table
(let ((st (copy-syntax-table text-mode-syntax-table)))
(modify-syntax-entry ?$ "." st)
(modify-syntax-entry ?% "." st)
(modify-syntax-entry ?& "." st)
(modify-syntax-entry ?' "." st)
(modify-syntax-entry ?* "." st)
(modify-syntax-entry ?+ "." st)
(modify-syntax-entry ?- "." st)
(modify-syntax-entry ?/ "." st)
(modify-syntax-entry ?< "." st)
(modify-syntax-entry ?= "." st)
(modify-syntax-entry ?> "." st)
(modify-syntax-entry ?\\ "\\" st)
(modify-syntax-entry ?_ "." st)
(modify-syntax-entry ?| "." st)
(modify-syntax-entry ?\u00ab "." st)
(modify-syntax-entry ?\u00bb "." st)
(modify-syntax-entry ?\u2018 "." st)
(modify-syntax-entry ?\u2019 "." st)
(modify-syntax-entry ?\u201c "." st)
(modify-syntax-entry ?\u201d "." st)
st)
"Syntax table used while in `rst-mode'.")
(defcustom rst-mode-hook nil
"Hook run when `rst-mode' is turned on.
The hook for `text-mode' is run before this one."
:group 'rst
:type '(hook))
(rst-testcover-defcustom)
;; Pull in variable definitions silencing byte-compiler.
(require 'newcomment)
;; Use rst-mode for *.rst and *.rest files. Many ReStructured-Text files
;; use *.txt, but this is too generic to be set as a default.
;;;###autoload (add-to-list 'auto-mode-alist (purecopy '("\\.re?st\\'" . rst-mode)))
;;;###autoload
(define-derived-mode rst-mode text-mode "ReST"
"Major mode for editing reStructuredText documents.
\\<rst-mode-map>
Turning on `rst-mode' calls the normal hooks `text-mode-hook'
and `rst-mode-hook'. This mode also supports font-lock
highlighting.
\\{rst-mode-map}"
:abbrev-table rst-mode-abbrev-table
:syntax-table rst-mode-syntax-table
:group 'rst
;; Paragraph recognition.
(set (make-local-variable 'paragraph-separate)
(rst-re '(:alt
"\f"
lin-end)))
(set (make-local-variable 'paragraph-start)
(rst-re '(:alt
"\f"
lin-end
(:seq hws-tag par-tag- bli-sfx))))
;; Indenting and filling.
(set (make-local-variable 'indent-line-function) 'rst-indent-line)
(set (make-local-variable 'adaptive-fill-mode) t)
(set (make-local-variable 'adaptive-fill-regexp)
(rst-re 'hws-tag 'par-tag- "?" 'hws-tag))
(set (make-local-variable 'adaptive-fill-function) 'rst-adaptive-fill)
(set (make-local-variable 'fill-paragraph-handle-comment) nil)
;; Comments.
(set (make-local-variable 'comment-start) ".. ")
(set (make-local-variable 'comment-start-skip)
(rst-re 'lin-beg 'exm-tag 'bli-sfx))
(set (make-local-variable 'comment-continue) " ")
(set (make-local-variable 'comment-multi-line) t)
(set (make-local-variable 'comment-use-syntax) nil)
;; reStructuredText has not really a comment ender but nil is not really a
;; permissible value.
(set (make-local-variable 'comment-end) "")
(set (make-local-variable 'comment-end-skip) nil)
;; Commenting in reStructuredText is very special so use our own set of
;; functions.
(set (make-local-variable 'comment-line-break-function)
'rst-comment-line-break)
(set (make-local-variable 'comment-indent-function)
'rst-comment-indent)
(set (make-local-variable 'comment-insert-comment-function)
'rst-comment-insert-comment)
(set (make-local-variable 'comment-region-function)
'rst-comment-region)
(set (make-local-variable 'uncomment-region-function)
'rst-uncomment-region)
;; Imenu and which function.
;; FIXME: Check documentation of `which-function' for alternative ways to
;; determine the current function name.
(set (make-local-variable 'imenu-create-index-function)
'rst-imenu-create-index)
;; Font lock.
(set (make-local-variable 'font-lock-defaults)
'(rst-font-lock-keywords
t nil nil nil
(font-lock-multiline . t)
(font-lock-mark-block-function . mark-paragraph)))
(add-hook 'font-lock-extend-region-functions 'rst-font-lock-extend-region t)
;; Text after a changed line may need new fontification.
(set (make-local-variable 'jit-lock-contextually) t))
;;;###autoload
(define-minor-mode rst-minor-mode
"Toggle ReST minor mode.
With a prefix argument ARG, enable ReST minor mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
When ReST minor mode is enabled, the ReST mode keybindings
are installed on top of the major mode bindings. Use this
for modes derived from Text mode, like Mail mode."
;; The initial value.
nil
;; The indicator for the mode line.
" ReST"
;; The minor mode bindings.
rst-mode-map
:group 'rst)
;; FIXME: can I somehow install these too?
;; :abbrev-table rst-mode-abbrev-table
;; :syntax-table rst-mode-syntax-table
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Section Adornment Adjustment
;; ============================
;;
;; The following functions implement a smart automatic title sectioning feature.
;; The idea is that with the cursor sitting on a section title, we try to get as
;; much information from context and try to do the best thing automatically.
;; This function can be invoked many times and/or with prefix argument to rotate
;; between the various sectioning adornments.
;;
;; Definitions: the two forms of sectioning define semantically separate section
;; levels. A sectioning ADORNMENT consists in:
;;
;; - a CHARACTER
;;
;; - a STYLE which can be either of 'simple' or 'over-and-under'.
;;
;; - an INDENT (meaningful for the over-and-under style only) which determines
;; how many characters and over-and-under style is hanging outside of the
;; title at the beginning and ending.
;;
;; Here are two examples of adornments (| represents the window border, column
;; 0):
;;
;; |
;; 1. char: '-' e |Some Title
;; style: simple |----------
;; |
;; 2. char: '=' |==============
;; style: over-and-under | Some Title
;; indent: 2 |==============
;; |
;;
;; Some notes:
;;
;; - The underlining character that is used depends on context. The file is
;; scanned to find other sections and an appropriate character is selected.
;; If the function is invoked on a section that is complete, the character is
;; rotated among the existing section adornments.
;;
;; Note that when rotating the characters, if we come to the end of the
;; hierarchy of adornments, the variable rst-preferred-adornments is
;; consulted to propose a new underline adornment, and if continued, we cycle
;; the adornments all over again. Set this variable to nil if you want to
;; limit the underlining character propositions to the existing adornments in
;; the file.
;;
;; - An underline/overline that is not extended to the column at which it should
;; be hanging is dubbed INCOMPLETE. For example::
;;
;; |Some Title
;; |-------
;;
;; Examples of default invocation:
;;
;; |Some Title ---> |Some Title
;; | |----------
;;
;; |Some Title ---> |Some Title
;; |----- |----------
;;
;; | |------------
;; | Some Title ---> | Some Title
;; | |------------
;;
;; In over-and-under style, when alternating the style, a variable is
;; available to select how much default indent to use (it can be zero). Note
;; that if the current section adornment already has an indent, we don't
;; adjust it to the default, we rather use the current indent that is already
;; there for adjustment (unless we cycle, in which case we use the indent
;; that has been found previously).
(defgroup rst-adjust nil
"Settings for adjustment and cycling of section title adornments."
:group 'rst
:version "21.1")
(define-obsolete-variable-alias
'rst-preferred-decorations 'rst-preferred-adornments "1.0.0")
(defcustom rst-preferred-adornments '((?= over-and-under 1)
(?= simple 0)
(?- simple 0)
(?~ simple 0)
(?+ simple 0)
(?` simple 0)
(?# simple 0)
(?@ simple 0))
"Preferred hierarchy of section title adornments.
A list consisting of lists of the form (CHARACTER STYLE INDENT).
CHARACTER is the character used. STYLE is one of the symbols
OVER-AND-UNDER or SIMPLE. INDENT is an integer giving the wanted
indentation for STYLE OVER-AND-UNDER. CHARACTER and STYLE are
always used when a section adornment is described. In other
places t instead of a list stands for a transition.
This sequence is consulted to offer a new adornment suggestion
when we rotate the underlines at the end of the existing
hierarchy of characters, or when there is no existing section
title in the file.
Set this to an empty list to use only the adornment found in the
file."
:group 'rst-adjust
:type `(repeat
(group :tag "Adornment specification"
(choice :tag "Adornment character"
,@(mapcar (lambda (char)
(list 'const
:tag (char-to-string char) char))
rst-adornment-chars))
(radio :tag "Adornment type"
(const :tag "Overline and underline" over-and-under)
(const :tag "Underline only" simple))
(integer :tag "Indentation for overline and underline type"
:value 0))))
(rst-testcover-defcustom)
(defcustom rst-default-indent 1
"Number of characters to indent the section title.
This is used for when toggling adornment styles, when switching
from a simple adornment style to a over-and-under adornment
style."
:group 'rst-adjust
:type '(integer))
(rst-testcover-defcustom)
(defun rst-compare-adornments (ado1 ado2)
"Compare adornments.
Return true if both ADO1 and ADO2 adornments are equal,
according to restructured text semantics (only the character and
the style are compared, the indentation does not matter)."
(and (eq (car ado1) (car ado2))
(eq (cadr ado1) (cadr ado2))))
(defun rst-get-adornment-match (hier ado)
"Return the index (level) in hierarchy HIER of adornment ADO.
This basically just searches for the item using the appropriate
comparison and returns the index. Return nil if the item is
not found."
(let ((cur hier))
(while (and cur (not (rst-compare-adornments (car cur) ado)))
(setq cur (cdr cur)))
cur))
;; testcover: FIXME: Test with `rst-preferred-adornments' == nil. Add test
;; `rst-adjust-no-preference'.
(defun rst-suggest-new-adornment (allados &optional prev)
"Suggest a new, different adornment from all that have been seen.
ALLADOS is the set of all adornments, including the line numbers.
PREV is the optional previous adornment, in order to suggest a
better match."
;; For all the preferred adornments...
(let* (
;; If 'prev' is given, reorder the list to start searching after the
;; match.
(fplist
(cdr (rst-get-adornment-match rst-preferred-adornments prev)))
;; List of candidates to search.
(curpotential (append fplist rst-preferred-adornments)))
(while
;; For all the adornments...
(let ((cur allados)
found)
(while (and cur (not found))
(if (rst-compare-adornments (car cur) (car curpotential))
;; Found it!
(setq found (car curpotential))
(setq cur (cdr cur))))
found)
(setq curpotential (cdr curpotential)))
(copy-sequence (car curpotential))))
(defun rst-delete-entire-line ()
"Delete the entire current line without using the `kill-ring'."
(delete-region (line-beginning-position)
(line-beginning-position 2)))
(defun rst-update-section (char style &optional indent)
"Unconditionally update the style of a section adornment.
Do this using the given character CHAR, with STYLE 'simple
or 'over-and-under, and with indent INDENT. If the STYLE
is 'simple, whitespace before the title is removed (indent
is always assumed to be 0).
If there are existing overline and/or underline from the
existing adornment, they are removed before adding the
requested adornment."
(end-of-line)
(let ((marker (point-marker))
len)
;; Fixup whitespace at the beginning and end of the line.
(if (or (null indent) (eq style 'simple)) ;; testcover: ok.
(setq indent 0))
(beginning-of-line)
(delete-horizontal-space)
(insert (make-string indent ? ))
(end-of-line)
(delete-horizontal-space)
;; Set the current column, we're at the end of the title line.
(setq len (+ (current-column) indent))
;; Remove previous line if it is an adornment.
(save-excursion
(forward-line -1) ;; testcover: FIXME: Doesn't work when in first line
;; of buffer.
(if (and (looking-at (rst-re 'ado-beg-2-1))
;; Avoid removing the underline of a title right above us.
(save-excursion (forward-line -1)
(not (looking-at (rst-re 'ttl-beg)))))
(rst-delete-entire-line)))
;; Remove following line if it is an adornment.
(save-excursion
(forward-line +1) ;; testcover: FIXME: Doesn't work when in last line
;; of buffer.
(if (looking-at (rst-re 'ado-beg-2-1))
(rst-delete-entire-line))
;; Add a newline if we're at the end of the buffer, for the subsequence
;; inserting of the underline.
(if (= (point) (buffer-end 1))
(newline 1)))
;; Insert overline.
(if (eq style 'over-and-under)
(save-excursion
(beginning-of-line)
(open-line 1)
(insert (make-string len char))))
;; Insert underline.
(1value ;; Line has been inserted above.
(forward-line +1))
(open-line 1)
(insert (make-string len char))
(1value ;; Line has been inserted above.
(forward-line +1))
(goto-char marker)))
(defun rst-classify-adornment (adornment end)
"Classify adornment for section titles and transitions.
ADORNMENT is the complete adornment string as found in the buffer
with optional trailing whitespace. END is the point after the
last character of ADORNMENT.
Return a list. The first entry is t for a transition or a
cons (CHARACTER . STYLE). Check `rst-preferred-adornments' for
the meaning of CHARACTER and STYLE.
The remaining list forms four match groups as returned by
`match-data'. Match group 0 matches the whole construct. Match
group 1 matches the overline adornment if present. Match group 2
matches the section title text or the transition. Match group 3
matches the underline adornment.
Return nil if no syntactically valid adornment is found."
(save-excursion
(save-match-data
(when (string-match (rst-re 'ado-beg-2-1) adornment)
(goto-char end)
(let* ((ado-ch (string-to-char (match-string 2 adornment)))
(ado-re (rst-re ado-ch 'adorep3-hlp))
(end-pnt (point))
(beg-pnt (progn
(1value ;; No lines may be left to move.
(forward-line 0))
(point)))
(nxt-emp ; Next line nonexistent or empty
(save-excursion
(or (not (zerop (forward-line 1)))
;; testcover: FIXME: Add test classifying at the end of
;; buffer.
(looking-at (rst-re 'lin-end)))))
(prv-emp ; Previous line nonexistent or empty
(save-excursion
(or (not (zerop (forward-line -1)))
(looking-at (rst-re 'lin-end)))))
(ttl-blw ; Title found below starting here.
(save-excursion
(and
(zerop (forward-line 1)) ;; testcover: FIXME: Add test
;; classifying at the end of
;; buffer.
(looking-at (rst-re 'ttl-beg))
(point))))
(ttl-abv ; Title found above starting here.
(save-excursion
(and
(zerop (forward-line -1))
(looking-at (rst-re 'ttl-beg))
(point))))
(und-fnd ; Matching underline found starting here.
(save-excursion
(and ttl-blw
(zerop (forward-line 2)) ;; testcover: FIXME: Add test
;; classifying at the end of
;; buffer.
(looking-at (rst-re ado-re 'lin-end))
(point))))
(ovr-fnd ; Matching overline found starting here.
(save-excursion
(and ttl-abv
(zerop (forward-line -2))
(looking-at (rst-re ado-re 'lin-end))
(point))))
key beg-ovr end-ovr beg-txt end-txt beg-und end-und)
(cond
((and nxt-emp prv-emp)
;; A transition.
(setq key t
beg-txt beg-pnt
end-txt end-pnt))
((or und-fnd ovr-fnd)
;; An overline with an underline.
(setq key (cons ado-ch 'over-and-under))
(let (;; Prefer overline match over underline match.
(und-pnt (if ovr-fnd beg-pnt und-fnd))
(ovr-pnt (if ovr-fnd ovr-fnd beg-pnt))
(txt-pnt (if ovr-fnd ttl-abv ttl-blw)))
(goto-char ovr-pnt)
(setq beg-ovr (point)
end-ovr (line-end-position))
(goto-char txt-pnt)
(setq beg-txt (point)
end-txt (line-end-position))
(goto-char und-pnt)
(setq beg-und (point)
end-und (line-end-position))))
(ttl-abv
;; An underline.
(setq key (cons ado-ch 'simple)
beg-und beg-pnt
end-und end-pnt)
(goto-char ttl-abv)
(setq beg-txt (point)
end-txt (line-end-position)))
(t
;; Invalid adornment.
(setq key nil)))
(if key
(list key
(or beg-ovr beg-txt)
(or end-und end-txt)
beg-ovr end-ovr beg-txt end-txt beg-und end-und)))))))
(defun rst-find-title-line ()
"Find a section title line around point and return its characteristics.
If the point is on an adornment line find the respective title
line. If the point is on an empty line check previous or next
line whether it is a suitable title line and use it if so. If
point is on a suitable title line use it.
If no title line is found return nil.
Otherwise return as `rst-classify-adornment' does. However, if
the title line has no syntactically valid adornment STYLE is nil
in the first element. If there is no adornment around the title
CHARACTER is also nil and match groups for overline and underline
are nil."
(save-excursion
(1value ;; No lines may be left to move.
(forward-line 0))
(let ((orig-pnt (point))
(orig-end (line-end-position)))
(cond
((looking-at (rst-re 'ado-beg-2-1))
(let ((char (string-to-char (match-string-no-properties 2)))
(r (rst-classify-adornment (match-string-no-properties 0)
(match-end 0))))
(cond
((not r)
;; Invalid adornment - check whether this is an incomplete overline.
(if (and
(zerop (forward-line 1))
(looking-at (rst-re 'ttl-beg)))
(list (cons char nil) orig-pnt (line-end-position)
orig-pnt orig-end (point) (line-end-position) nil nil)))
((consp (car r))
;; A section title - not a transition.
r))))
((looking-at (rst-re 'lin-end))
(or
(save-excursion
(if (and (zerop (forward-line -1))
(looking-at (rst-re 'ttl-beg)))
(list (cons nil nil) (point) (line-end-position)
nil nil (point) (line-end-position) nil nil)))
(save-excursion
(if (and (zerop (forward-line 1))
(looking-at (rst-re 'ttl-beg)))
(list (cons nil nil) (point) (line-end-position)
nil nil (point) (line-end-position) nil nil)))))
((looking-at (rst-re 'ttl-beg))
;; Try to use the underline.
(let ((r (rst-classify-adornment
(buffer-substring-no-properties
(line-beginning-position 2) (line-end-position 2))
(line-end-position 2))))
(if r
r
;; No valid adornment found.
(list (cons nil nil) (point) (line-end-position)
nil nil (point) (line-end-position) nil nil))))))))
;; The following function and variables are used to maintain information about
;; current section adornment in a buffer local cache. Thus they can be used for
;; font-locking and manipulation commands.
(defvar rst-all-sections nil
"All section adornments in the buffer as found by `rst-find-all-adornments'.
t when no section adornments were found.")
(make-variable-buffer-local 'rst-all-sections)
;; FIXME: If this variable is set to a different value font-locking of section
;; headers is wrong.
(defvar rst-section-hierarchy nil
"Section hierarchy in the buffer as determined by `rst-get-hierarchy'.
t when no section adornments were found. Value depends on
`rst-all-sections'.")
(make-variable-buffer-local 'rst-section-hierarchy)
(rst-testcover-add-1value 'rst-reset-section-caches)
(defun rst-reset-section-caches ()
"Reset all section cache variables.
Should be called by interactive functions which deal with sections."
(setq rst-all-sections nil
rst-section-hierarchy nil))
(defun rst-find-all-adornments ()
"Return all the section adornments in the current buffer.
Return a list of (LINE . ADORNMENT) with ascending LINE where
LINE is the line containing the section title. ADORNMENT consists
of a (CHARACTER STYLE INDENT) triple as described for
`rst-preferred-adornments'.
Uses and sets `rst-all-sections'."
(unless rst-all-sections
(let (positions)
;; Iterate over all the section titles/adornments in the file.
(save-excursion
(goto-char (point-min))
(while (re-search-forward (rst-re 'ado-beg-2-1) nil t)
(let ((ado-data (rst-classify-adornment
(match-string-no-properties 0) (point))))
(when (and ado-data
(consp (car ado-data))) ; Ignore transitions.
(set-match-data (cdr ado-data))
(goto-char (match-beginning 2)) ; Goto the title start.
(push (cons (1+ (count-lines (point-min) (point)))
(list (caar ado-data)
(cdar ado-data)
(current-indentation)))
positions)
(goto-char (match-end 0))))) ; Go beyond the whole thing.
(setq positions (nreverse positions))
(setq rst-all-sections (or positions t)))))
(if (eq rst-all-sections t)
nil
rst-all-sections))
(defun rst-infer-hierarchy (adornments)
"Build a hierarchy of adornments using the list of given ADORNMENTS.
ADORNMENTS is a list of (CHARACTER STYLE INDENT) adornment
specifications, in order that they appear in a file, and will
infer a hierarchy of section levels by removing adornments that
have already been seen in a forward traversal of the adornments,
comparing just CHARACTER and STYLE.
Similarly returns a list of (CHARACTER STYLE INDENT), where each
list element should be unique."
(let (hierarchy-alist)
(dolist (x adornments)
(let ((char (car x))
(style (cadr x)))
(unless (assoc (cons char style) hierarchy-alist)
(push (cons (cons char style) x) hierarchy-alist))))
(mapcar 'cdr (nreverse hierarchy-alist))))
(defun rst-get-hierarchy (&optional ignore)
"Return the hierarchy of section titles in the file.
Return a list of adornments that represents the hierarchy of
section titles in the file. Each element consists of (CHARACTER
STYLE INDENT) as described for `rst-find-all-adornments'. If the
line number in IGNORE is specified, a possibly adornment found on
that line is not taken into account when building the hierarchy.
Uses and sets `rst-section-hierarchy' unless IGNORE is given."
(if (and (not ignore) rst-section-hierarchy)
(if (eq rst-section-hierarchy t)
nil
rst-section-hierarchy)
(let ((r (rst-infer-hierarchy
(mapcar 'cdr
(assq-delete-all
ignore
(rst-find-all-adornments))))))
(setq rst-section-hierarchy
(if ignore
;; Clear cache reflecting that a possible update is not
;; reflected.
nil
(or r t)))
r)))
(defun rst-get-adornments-around ()
"Return the adornments around point.
Return a list of the previous and next adornments."
(let* ((all (rst-find-all-adornments))
(curline (line-number-at-pos))
prev next
(cur all))
;; Search for the adornments around the current line.
(while (and cur (< (caar cur) curline))
(setq prev cur
cur (cdr cur)))
;; 'cur' is the following adornment.
(if (and cur (caar cur))
(setq next (if (= curline (caar cur)) (cdr cur) cur)))
(mapcar 'cdar (list prev next))))
(defun rst-adornment-complete-p (ado)
"Return true if the adornment ADO around point is complete."
;; Note: we assume that the detection of the overline as being the underline
;; of a preceding title has already been detected, and has been eliminated
;; from the adornment that is given to us.
;; There is some sectioning already present, so check if the current
;; sectioning is complete and correct.
(let* ((char (car ado))
(style (cadr ado))
(indent (caddr ado))
(endcol (save-excursion (end-of-line) (current-column))))
(if char
(let ((exps (rst-re "^" char (format "\\{%d\\}" (+ endcol indent)) "$")))
(and
(save-excursion (forward-line +1)
(beginning-of-line)
(looking-at exps))
(or (not (eq style 'over-and-under))
(save-excursion (forward-line -1)
(beginning-of-line)
(looking-at exps))))))))
(defun rst-get-next-adornment
(curado hier &optional suggestion reverse-direction)
"Get the next adornment for CURADO, in given hierarchy HIER.
If suggesting, suggest for new adornment SUGGESTION.
REVERSE-DIRECTION is used to reverse the cycling order."
(let* (
(char (car curado))
(style (cadr curado))
;; Build a new list of adornments for the rotation.
(rotados
(append hier
;; Suggest a new adornment.
(list suggestion
;; If nothing to suggest, use first adornment.
(car hier)))) )
(or
;; Search for next adornment.
(cadr
(let ((cur (if reverse-direction rotados
(reverse rotados))))
(while (and cur
(not (and (eq char (caar cur))
(eq style (cadar cur)))))
(setq cur (cdr cur)))
cur))
;; If not found, take the first of all adornments.
suggestion)))
;; FIXME: A line "``/`` full" is not accepted as a section title.
(defun rst-adjust (pfxarg)
"Auto-adjust the adornment around point.
Adjust/rotate the section adornment for the section title around
point or promote/demote the adornments inside the region,
depending on if the region is active. This function is meant to
be invoked possibly multiple times, and can vary its behavior
with a positive PFXARG (toggle style), or with a negative
PFXARG (alternate behavior).
This function is a bit of a swiss knife. It is meant to adjust
the adornments of a section title in reStructuredText. It tries
to deal with all the possible cases gracefully and to do `the
right thing' in all cases.
See the documentations of `rst-adjust-adornment-work' and
`rst-promote-region' for full details.
Prefix Arguments
================
The method can take either (but not both) of
a. a (non-negative) prefix argument, which means to toggle the
adornment style. Invoke with a prefix argument for example;
b. a negative numerical argument, which generally inverts the
direction of search in the file or hierarchy. Invoke with C--
prefix for example."
(interactive "P")
(let* (;; Save our original position on the current line.
(origpt (point-marker))
(reverse-direction (and pfxarg (< (prefix-numeric-value pfxarg) 0)))
(toggle-style (and pfxarg (not reverse-direction))))
(if (use-region-p)
;; Adjust adornments within region.
(rst-promote-region (and pfxarg t))
;; Adjust adornment around point.
(rst-adjust-adornment-work toggle-style reverse-direction))
;; Run the hooks to run after adjusting.
(run-hooks 'rst-adjust-hook)
;; Make sure to reset the cursor position properly after we're done.
(goto-char origpt)))
(defcustom rst-adjust-hook nil
"Hooks to be run after running `rst-adjust'."
:group 'rst-adjust
:type '(hook)
:package-version '(rst . "1.1.0"))
(rst-testcover-defcustom)
(defcustom rst-new-adornment-down nil
"Controls level of new adornment for section headers."
:group 'rst-adjust
:type '(choice
(const :tag "Same level as previous one" nil)
(const :tag "One level down relative to the previous one" t))
:package-version '(rst . "1.1.0"))
(rst-testcover-defcustom)
(defun rst-adjust-adornment (pfxarg)
"Call `rst-adjust-adornment-work' interactively.
Keep this for compatibility for older bindings (are there any?).
Argument PFXARG has the same meaning as for `rst-adjust'."
(interactive "P")
(let* ((reverse-direction (and pfxarg (< (prefix-numeric-value pfxarg) 0)))
(toggle-style (and pfxarg (not reverse-direction))))
(rst-adjust-adornment-work toggle-style reverse-direction)))
(defun rst-adjust-adornment-work (toggle-style reverse-direction)
"Adjust/rotate the section adornment for the section title around point.
This function is meant to be invoked possibly multiple times, and
can vary its behavior with a true TOGGLE-STYLE argument, or with
a REVERSE-DIRECTION argument.
General Behavior
================
The next action it takes depends on context around the point, and
it is meant to be invoked possibly more than once to rotate among
the various possibilities. Basically, this function deals with:
- adding a adornment if the title does not have one;
- adjusting the length of the underline characters to fit a
modified title;
- rotating the adornment in the set of already existing
sectioning adornments used in the file;
- switching between simple and over-and-under styles.
You should normally not have to read all the following, just
invoke the method and it will do the most obvious thing that you
would expect.
Adornment Definitions
=====================
The adornments consist in
1. a CHARACTER
2. a STYLE which can be either of 'simple' or 'over-and-under'.
3. an INDENT (meaningful for the over-and-under style only)
which determines how many characters and over-and-under
style is hanging outside of the title at the beginning and
ending.
See source code for mode details.
Detailed Behavior Description
=============================
Here are the gory details of the algorithm (it seems quite
complicated, but really, it does the most obvious thing in all
the particular cases):
Before applying the adornment change, the cursor is placed on
the closest line that could contain a section title.
Case 1: No Adornment
--------------------
If the current line has no adornment around it,
- search backwards for the last previous adornment, and apply
the adornment one level lower to the current line. If there
is no defined level below this previous adornment, we suggest
the most appropriate of the `rst-preferred-adornments'.
If REVERSE-DIRECTION is true, we simply use the previous
adornment found directly.
- if there is no adornment found in the given direction, we use
the first of `rst-preferred-adornments'.
TOGGLE-STYLE forces a toggle of the prescribed adornment style.
Case 2: Incomplete Adornment
----------------------------
If the current line does have an existing adornment, but the
adornment is incomplete, that is, the underline/overline does
not extend to exactly the end of the title line (it is either too
short or too long), we simply extend the length of the
underlines/overlines to fit exactly the section title.
If TOGGLE-STYLE we toggle the style of the adornment as well.
REVERSE-DIRECTION has no effect in this case.
Case 3: Complete Existing Adornment
-----------------------------------
If the adornment is complete (i.e. the underline (overline)
length is already adjusted to the end of the title line), we
search/parse the file to establish the hierarchy of all the
adornments (making sure not to include the adornment around
point), and we rotate the current title's adornment from within
that list (by default, going *down* the hierarchy that is present
in the file, i.e. to a lower section level). This is meant to be
used potentially multiple times, until the desired adornment is
found around the title.
If we hit the boundary of the hierarchy, exactly one choice from
the list of preferred adornments is suggested/chosen, the first
of those adornment that has not been seen in the file yet (and
not including the adornment around point), and the next
invocation rolls over to the other end of the hierarchy (i.e. it
cycles). This allows you to avoid having to set which character
to use.
If REVERSE-DIRECTION is true, the effect is to change the
direction of rotation in the hierarchy of adornments, thus
instead going *up* the hierarchy.
However, if TOGGLE-STYLE, we do not rotate the adornment, but
instead simply toggle the style of the current adornment (this
should be the most common way to toggle the style of an existing
complete adornment).
Point Location
==============
The invocation of this function can be carried out anywhere
within the section title line, on an existing underline or
overline, as well as on an empty line following a section title.
This is meant to be as convenient as possible.
Indented Sections
=================
Indented section titles such as ::
My Title
--------
are invalid in reStructuredText and thus not recognized by the
parser. This code will thus not work in a way that would support
indented sections (it would be ambiguous anyway).
Joint Sections
==============
Section titles that are right next to each other may not be
treated well. More work might be needed to support those, and
special conditions on the completeness of existing adornments
might be required to make it non-ambiguous.
For now we assume that the adornments are disjoint, that is,
there is at least a single line between the titles/adornment
lines."
(rst-reset-section-caches)
(let ((ttl-fnd (rst-find-title-line))
(orig-pnt (point)))
(when ttl-fnd
(set-match-data (cdr ttl-fnd))
(goto-char (match-beginning 2))
(let* ((moved (- (line-number-at-pos) (line-number-at-pos orig-pnt)))
(char (caar ttl-fnd))
(style (cdar ttl-fnd))
(indent (current-indentation))
(curado (list char style indent))
char-new style-new indent-new)
(cond
;;-------------------------------------------------------------------
;; Case 1: No valid adornment
((not style)
(let ((prev (car (rst-get-adornments-around)))
cur
(hier (rst-get-hierarchy)))
;; Advance one level down.
(setq cur
(if prev
(if (or (and rst-new-adornment-down reverse-direction)
(and (not rst-new-adornment-down)
(not reverse-direction)))
prev
(or (cadr (rst-get-adornment-match hier prev))
(rst-suggest-new-adornment hier prev)))
(copy-sequence (car rst-preferred-adornments))))
;; Invert the style if requested.
(if toggle-style
(setcar (cdr cur) (if (eq (cadr cur) 'simple)
'over-and-under 'simple)) )
(setq char-new (car cur)
style-new (cadr cur)
indent-new (caddr cur))))
;;-------------------------------------------------------------------
;; Case 2: Incomplete Adornment
((not (rst-adornment-complete-p curado))
;; Invert the style if requested.
(if toggle-style
(setq style (if (eq style 'simple) 'over-and-under 'simple)))
(setq char-new char
style-new style
indent-new indent))
;;-------------------------------------------------------------------
;; Case 3: Complete Existing Adornment
(t
(if toggle-style
;; Simply switch the style of the current adornment.
(setq char-new char
style-new (if (eq style 'simple) 'over-and-under 'simple)
indent-new rst-default-indent)
;; Else, we rotate, ignoring the adornment around the current
;; line...
(let* ((hier (rst-get-hierarchy (line-number-at-pos)))
;; Suggestion, in case we need to come up with something new.
(suggestion (rst-suggest-new-adornment
hier
(car (rst-get-adornments-around))))
(nextado (rst-get-next-adornment
curado hier suggestion reverse-direction)))
;; Indent, if present, always overrides the prescribed indent.
(setq char-new (car nextado)
style-new (cadr nextado)
indent-new (caddr nextado))))))
;; Override indent with present indent!
(setq indent-new (if (> indent 0) indent indent-new))
(if (and char-new style-new)
(rst-update-section char-new style-new indent-new))
;; Correct the position of the cursor to more accurately reflect where
;; it was located when the function was invoked.
(unless (zerop moved)
(forward-line (- moved))
(end-of-line))))))
;; Maintain an alias for compatibility.
(defalias 'rst-adjust-section-title 'rst-adjust)
(defun rst-promote-region (demote)
"Promote the section titles within the region.
With argument DEMOTE or a prefix argument, demote the section
titles instead. The algorithm used at the boundaries of the
hierarchy is similar to that used by `rst-adjust-adornment-work'."
(interactive "P")
(rst-reset-section-caches)
(let* ((cur (rst-find-all-adornments))
(hier (rst-get-hierarchy))
(suggestion (rst-suggest-new-adornment hier))
(region-begin-line (line-number-at-pos (region-beginning)))
(region-end-line (line-number-at-pos (region-end)))
marker-list)
;; Skip the markers that come before the region beginning.
(while (and cur (< (caar cur) region-begin-line))
(setq cur (cdr cur)))
;; Create a list of markers for all the adornments which are found within
;; the region.
(save-excursion
(let (line)
(while (and cur (< (setq line (caar cur)) region-end-line))
(goto-char (point-min))
(forward-line (1- line))
(push (list (point-marker) (cdar cur)) marker-list)
(setq cur (cdr cur)) ))
;; Apply modifications.
(dolist (p marker-list)
;; Go to the adornment to promote.
(goto-char (car p))
;; Update the adornment.
(apply 'rst-update-section
;; Rotate the next adornment.
(rst-get-next-adornment
(cadr p) hier suggestion demote))
;; Clear marker to avoid slowing down the editing after we're done.
(set-marker (car p) nil))
(setq deactivate-mark nil))))
(defun rst-display-adornments-hierarchy (&optional adornments)
"Display the current file's section title adornments hierarchy.
This function expects a list of (CHARACTER STYLE INDENT) triples
in ADORNMENTS."
(interactive)
(rst-reset-section-caches)
(if (not adornments)
(setq adornments (rst-get-hierarchy)))
(with-output-to-temp-buffer "*rest section hierarchy*"
(let ((level 1))
(with-current-buffer standard-output
(dolist (x adornments)
(insert (format "\nSection Level %d" level))
(apply 'rst-update-section x)
(goto-char (point-max))
(insert "\n")
(incf level))))))
(defun rst-straighten-adornments ()
"Redo all the adornments in the current buffer.
This is done using our preferred set of adornments. This can be
used, for example, when using somebody else's copy of a document,
in order to adapt it to our preferred style."
(interactive)
(rst-reset-section-caches)
(save-excursion
(let (;; Get a list of pairs of (level . marker).
(levels-and-markers (mapcar
(lambda (ado)
(cons (rst-position (cdr ado)
(rst-get-hierarchy))
(progn
(goto-char (point-min))
(forward-line (1- (car ado)))
(point-marker))))
(rst-find-all-adornments))))
(dolist (lm levels-and-markers)
;; Go to the appropriate position.
(goto-char (cdr lm))
;; Apply the new style.
(apply 'rst-update-section (nth (car lm) rst-preferred-adornments))
;; Reset the marker to avoid slowing down editing until it gets GC'ed.
(set-marker (cdr lm) nil)))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Insert list items
;; =================
;=================================================
; Borrowed from a2r.el (version 1.3), by Lawrence Mitchell <wence@gmx.li>.
; I needed to make some tiny changes to the functions, so I put it here.
; -- Wei-Wei Guo
(defconst rst-arabic-to-roman
'((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD")
(100 . "C") (90 . "XC") (50 . "L") (40 . "XL")
(10 . "X") (9 . "IX") (5 . "V") (4 . "IV")
(1 . "I"))
"List of maps between Arabic numbers and their Roman numeral equivalents.")
(defun rst-arabic-to-roman (num &optional arg)
"Convert Arabic number NUM to its Roman numeral representation.
Obviously, NUM must be greater than zero. Don't blame me, blame the
Romans, I mean \"what have the Romans ever _done_ for /us/?\" (with
apologies to Monty Python).
If optional prefix ARG is non-nil, insert in current buffer."
(let ((map rst-arabic-to-roman)
res)
(while (and map (> num 0))
(if (or (= num (caar map))
(> num (caar map)))
(setq res (concat res (cdar map))
num (- num (caar map)))
(setq map (cdr map))))
res))
(defun rst-roman-to-arabic (string &optional arg)
"Convert STRING of Roman numerals to an Arabic number.
If STRING contains a letter which isn't a valid Roman numeral, the rest
of the string from that point onwards is ignored.
Hence:
MMD == 2500
and
MMDFLXXVI == 2500.
If optional ARG is non-nil, insert in current buffer."
(let ((res 0)
(map rst-arabic-to-roman))
(while map
(if (string-match (concat "^" (cdar map)) string)
(setq res (+ res (caar map))
string (replace-match "" nil t string))
(setq map (cdr map))))
res))
;=================================================
(defun rst-find-pfx-in-region (beg end pfx-re)
"Find all the positions of prefixes in region between BEG and END.
This is used to find bullets and enumerated list items. PFX-RE is
a regular expression for matching the lines after indentation
with items. Returns a list of cons cells consisting of the point
and the column of the point."
(let ((pfx ()))
(save-excursion
(goto-char beg)
(while (< (point) end)
(back-to-indentation)
(when (and
(looking-at pfx-re) ; pfx found and...
(let ((pfx-col (current-column)))
(save-excursion
(forward-line -1) ; ...previous line is...
(back-to-indentation)
(or (looking-at (rst-re 'lin-end)) ; ...empty,
(> (current-column) pfx-col) ; ...deeper level, or
(and (= (current-column) pfx-col)
(looking-at pfx-re)))))) ; ...pfx at same level.
(push (cons (point) (current-column))
pfx))
(forward-line 1)))
(nreverse pfx)))
(defun rst-insert-list-pos (newitem)
"Arrange relative position of a newly inserted list item of style NEWITEM.
Adding a new list might consider three situations:
(a) Current line is a blank line.
(b) Previous line is a blank line.
(c) Following line is a blank line.
When (a) and (b), just add the new list at current line.
when (a) and not (b), a blank line is added before adding the new list.
When not (a), first forward point to the end of the line, and add two
blank lines, then add the new list.
Other situations are just ignored and left to users themselves."
(if (save-excursion
(beginning-of-line)
(looking-at (rst-re 'lin-end)))
(if (save-excursion
(forward-line -1)
(looking-at (rst-re 'lin-end)))
(insert newitem " ")
(insert "\n" newitem " "))
(end-of-line)
(insert "\n\n" newitem " ")))
;; FIXME: Isn't this a `defconst'?
(defvar rst-initial-enums
(let (vals)
(dolist (fmt '("%s." "(%s)" "%s)"))
(dolist (c '("1" "a" "A" "I" "i"))
(push (format fmt c) vals)))
(cons "#." (nreverse vals)))
"List of initial enumerations.")
;; FIXME: Isn't this a `defconst'?
(defvar rst-initial-items
(append (mapcar 'char-to-string rst-bullets) rst-initial-enums)
"List of initial items. It's collection of bullets and enumerations.")
(defun rst-insert-list-new-item ()
"Insert a new list item.
User is asked to select the item style first, for example (a), i), +. Use TAB
for completion and choices.
If user selects bullets or #, it's just added with position arranged by
`rst-insert-list-pos'.
If user selects enumerations, a further prompt is given. User need to input a
starting item, for example 'e' for 'A)' style. The position is also arranged by
`rst-insert-list-pos'."
(interactive)
;; FIXME: Make this comply to `interactive' standards.
(let* ((itemstyle (completing-read
"Select preferred item style [#.]: "
rst-initial-items nil t nil nil "#."))
(cnt (if (string-match (rst-re 'cntexp-tag) itemstyle)
(match-string 0 itemstyle)))
(no
(save-match-data
;; FIXME: Make this comply to `interactive' standards.
(cond
((equal cnt "a")
(let ((itemno (read-string "Give starting value [a]: "
nil nil "a")))
(downcase (substring itemno 0 1))))
((equal cnt "A")
(let ((itemno (read-string "Give starting value [A]: "
nil nil "A")))
(upcase (substring itemno 0 1))))
((equal cnt "I")
(let ((itemno (read-number "Give starting value [1]: " 1)))
(rst-arabic-to-roman itemno)))
((equal cnt "i")
(let ((itemno (read-number "Give starting value [1]: " 1)))
(downcase (rst-arabic-to-roman itemno))))
((equal cnt "1")
(let ((itemno (read-number "Give starting value [1]: " 1)))
(number-to-string itemno)))))))
(if no
(setq itemstyle (replace-match no t t itemstyle)))
(rst-insert-list-pos itemstyle)))
(defcustom rst-preferred-bullets
'(?* ?- ?+)
"List of favorite bullets."
:group 'rst
:type `(repeat
(choice ,@(mapcar (lambda (char)
(list 'const
:tag (char-to-string char) char))
rst-bullets)))
:package-version '(rst . "1.1.0"))
(rst-testcover-defcustom)
(defun rst-insert-list-continue (curitem prefer-roman)
"Insert a list item with list start CURITEM including its indentation level.
If PREFER-ROMAN roman numbering is preferred over using letters."
(end-of-line)
(insert
"\n" ; FIXME: Separating lines must be possible.
(cond
((string-match (rst-re '(:alt enmaut-tag
bul-tag)) curitem)
curitem)
((string-match (rst-re 'num-tag) curitem)
(replace-match (number-to-string
(1+ (string-to-number (match-string 0 curitem))))
nil nil curitem))
((and (string-match (rst-re 'rom-tag) curitem)
(save-match-data
(if (string-match (rst-re 'ltr-tag) curitem) ; Also a letter tag.
(save-excursion
;; FIXME: Assumes one line list items without separating
;; empty lines.
(if (and (zerop (forward-line -1))
(looking-at (rst-re 'enmexp-beg)))
(string-match
(rst-re 'rom-tag)
(match-string 0)) ; Previous was a roman tag.
prefer-roman)) ; Don't know - use flag.
t))) ; Not a letter tag.
(replace-match
(let* ((old (match-string 0 curitem))
(new (save-match-data
(rst-arabic-to-roman
(1+ (rst-roman-to-arabic
(upcase old)))))))
(if (equal old (upcase old))
(upcase new)
(downcase new)))
t nil curitem))
((string-match (rst-re 'ltr-tag) curitem)
(replace-match (char-to-string
(1+ (string-to-char (match-string 0 curitem))))
nil nil curitem)))))
(defun rst-insert-list (&optional prefer-roman)
"Insert a list item at the current point.
The command can insert a new list or a continuing list. When it is called at a
non-list line, it will promote to insert new list. When it is called at a list
line, it will insert a list with the same list style.
1. When inserting a new list:
User is asked to select the item style first, for example (a), i), +. Use TAB
for completion and choices.
(a) If user selects bullets or #, it's just added.
(b) If user selects enumerations, a further prompt is given. User needs to
input a starting item, for example 'e' for 'A)' style.
The position of the new list is arranged according to whether or not the
current line and the previous line are blank lines.
2. When continuing a list, one thing need to be noticed:
List style alphabetical list, such as 'a.', and roman numerical list, such as
'i.', have some overlapping items, for example 'v.' The function can deal with
the problem elegantly in most situations. But when those overlapped list are
preceded by a blank line, it is hard to determine which type to use
automatically. The function uses alphabetical list by default. If you want
roman numerical list, just use a prefix to set PREFER-ROMAN."
(interactive "P")
(beginning-of-line)
(if (looking-at (rst-re 'itmany-beg-1))
(rst-insert-list-continue (match-string 0) prefer-roman)
(rst-insert-list-new-item)))
(defun rst-straighten-bullets-region (beg end)
"Make all the bulleted list items in the region consistent.
The region is specified between BEG and END. You can use this
after you have merged multiple bulleted lists to make them use
the same/correct/consistent bullet characters.
See variable `rst-preferred-bullets' for the list of bullets to
adjust. If bullets are found on levels beyond the
`rst-preferred-bullets' list, they are not modified."
(interactive "r")
(let ((bullets (rst-find-pfx-in-region beg end (rst-re 'bul-sta)))
(levtable (make-hash-table :size 4)))
;; Create a map of levels to list of positions.
(dolist (x bullets)
(let ((key (cdr x)))
(puthash key
(append (gethash key levtable (list))
(list (car x)))
levtable)))
;; Sort this map and create a new map of prefix char and list of positions.
(let ((poslist ())) ; List of (indent . positions).
(maphash (lambda (x y) (push (cons x y) poslist)) levtable)
(let ((bullets rst-preferred-bullets))
(dolist (x (sort poslist 'car-less-than-car))
(when bullets
;; Apply the characters.
(dolist (pos (cdr x))
(goto-char pos)
(delete-char 1)
(insert (string (car bullets))))
(setq bullets (cdr bullets))))))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Table of contents
;; =================
;; FIXME: Return value should be a `defstruct'.
(defun rst-section-tree ()
"Return the hierarchical tree of section titles.
A tree entry looks like ((TITLE MARKER) CHILD...). TITLE is the
stripped text of the section title. MARKER is a marker for the
beginning of the title text. For the top node or a missing
section level node TITLE is nil and MARKER points to the title
text of the first child. Each CHILD is another tree entry. The
CHILD list may be empty."
(let ((hier (rst-get-hierarchy))
(ch-sty2level (make-hash-table :test 'equal :size 10))
lev-ttl-mrk-l)
(let ((lev 0))
(dolist (ado hier)
;; Compare just the character and indent in the hash table.
(puthash (cons (car ado) (cadr ado)) lev ch-sty2level)
(incf lev)))
;; Create a list that contains (LEVEL TITLE MARKER) for each adornment.
(save-excursion
(setq lev-ttl-mrk-l
(mapcar (lambda (ado)
(goto-char (point-min))
(1value ;; This should really succeed.
(forward-line (1- (car ado))))
(list (gethash (cons (cadr ado) (caddr ado)) ch-sty2level)
;; Get title.
(save-excursion
(if (re-search-forward
(rst-re "\\S .*\\S ") (line-end-position) t)
(buffer-substring-no-properties
(match-beginning 0) (match-end 0))
""))
(point-marker)))
(rst-find-all-adornments))))
(cdr (rst-section-tree-rec lev-ttl-mrk-l -1))))
;; FIXME: Return value should be a `defstruct'.
(defun rst-section-tree-rec (remaining lev)
"Process the first entry of REMAINING expected to be on level LEV.
REMAINING is the remaining list of adornments consisting
of (LEVEL TITLE MARKER) entries.
Return (UNPROCESSED (TITLE MARKER) CHILD...) for the first entry
of REMAINING where TITLE is nil if the expected level is not
matched. UNPROCESSED is the list of still unprocessed entries.
Each CHILD is a child of this entry in the same format but
without UNPROCESSED."
(let ((cur (car remaining))
(unprocessed remaining)
ttl-mrk children)
;; If the current adornment matches expected level.
(when (and cur (= (car cur) lev))
;; Consume the current entry and create the current node with it.
(setq unprocessed (cdr remaining))
(setq ttl-mrk (cdr cur)))
;; Build the child nodes as long as they have deeper level.
(while (and unprocessed (> (caar unprocessed) lev))
(let ((rem-children (rst-section-tree-rec unprocessed (1+ lev))))
(setq children (cons (cdr rem-children) children))
(setq unprocessed (car rem-children))))
(setq children (reverse children))
(cons unprocessed
(cons (or ttl-mrk
;; Node on this level missing - use nil as text and the
;; marker of the first child.
(cons nil (cdaar children)))
children))))
(defun rst-section-tree-point (tree &optional point)
"Return section containing POINT by returning the closest node in TREE.
TREE is a section tree as returned by `rst-section-tree'
consisting of (NODE CHILD...) entries. POINT defaults to the
current point. A NODE must have the structure (IGNORED MARKER
...).
Return (PATH NODE CHILD...). NODE is the node where POINT is in
if any. PATH is a list of nodes from the top of the tree down to
and including NODE. List of CHILD are the children of NODE if
any."
(setq point (or point (point)))
(let ((cur (car tree))
(children (cdr tree)))
;; Point behind current node?
(if (and (cadr cur) (>= point (cadr cur)))
;; Iterate all the children, looking for one that might contain the
;; current section.
(let (found)
(while (and children (>= point (cadaar children)))
(setq found children
children (cdr children)))
(if found
;; Found section containing point in children.
(let ((sub (rst-section-tree-point (car found) point)))
;; Extend path with current node and return NODE CHILD... from
;; sub.
(cons (cons cur (car sub)) (cdr sub)))
;; Point in this section: Start a new path with current node and
;; return current NODE CHILD...
(cons (list cur) tree)))
;; Current node behind point: start a new path with current node and
;; no NODE CHILD...
(list (list cur)))))
(defgroup rst-toc nil
"Settings for reStructuredText table of contents."
:group 'rst
:version "21.1")
(defcustom rst-toc-indent 2
"Indentation for table-of-contents display.
Also used for formatting insertion, when numbering is disabled."
:group 'rst-toc)
(rst-testcover-defcustom)
(defcustom rst-toc-insert-style 'fixed
"Insertion style for table-of-contents.
Set this to one of the following values to determine numbering and
indentation style:
- plain: no numbering (fixed indentation)
- fixed: numbering, but fixed indentation
- aligned: numbering, titles aligned under each other
- listed: numbering, with dashes like list items (EXPERIMENTAL)"
:group 'rst-toc)
(rst-testcover-defcustom)
(defcustom rst-toc-insert-number-separator " "
"Separator that goes between the TOC number and the title."
:group 'rst-toc)
(rst-testcover-defcustom)
;; This is used to avoid having to change the user's mode.
(defvar rst-toc-insert-click-keymap
(let ((map (make-sparse-keymap)))
(define-key map [mouse-1] 'rst-toc-mode-mouse-goto)
map)
"(Internal) What happens when you click on propertized text in the TOC.")
(defcustom rst-toc-insert-max-level nil
"If non-nil, maximum depth of the inserted TOC."
:group 'rst-toc)
(rst-testcover-defcustom)
(defun rst-toc-insert (&optional pfxarg)
"Insert a simple text rendering of the table of contents.
By default the top level is ignored if there is only one, because
we assume that the document will have a single title.
If a numeric prefix argument PFXARG is given, insert the TOC up
to the specified level.
The TOC is inserted indented at the current column."
(interactive "P")
(rst-reset-section-caches)
(let* (;; Check maximum level override.
(rst-toc-insert-max-level
(if (and (integerp pfxarg) (> (prefix-numeric-value pfxarg) 0))
(prefix-numeric-value pfxarg) rst-toc-insert-max-level))
;; Get the section tree for the current cursor point.
(sectree-pair
(rst-section-tree-point
(rst-section-tree)))
;; Figure out initial indent.
(initial-indent (make-string (current-column) ? ))
(init-point (point)))
(when (cddr sectree-pair)
(rst-toc-insert-node (cdr sectree-pair) 0 initial-indent "")
;; Fixup for the first line.
(delete-region init-point (+ init-point (length initial-indent)))
;; Delete the last newline added.
(delete-char -1))))
(defun rst-toc-insert-node (node level indent pfx)
"Insert tree node NODE in table-of-contents.
Recursive function that does printing of the inserted toc.
LEVEL is the depth level of the sections in the tree.
INDENT is the indentation string. PFX is the prefix numbering,
that includes the alignment necessary for all the children of
level to align."
;; Note: we do child numbering from the parent, so we start number the
;; children one level before we print them.
(let ((do-print (> level 0))
(count 1))
(when do-print
(insert indent)
(let ((b (point)))
(unless (equal rst-toc-insert-style 'plain)
(insert pfx rst-toc-insert-number-separator))
(insert (or (caar node) "[missing node]"))
;; Add properties to the text, even though in normal text mode it
;; won't be doing anything for now. Not sure that I want to change
;; mode stuff. At least the highlighting gives the idea that this
;; is generated automatically.
(put-text-property b (point) 'mouse-face 'highlight)
(put-text-property b (point) 'rst-toc-target (cadar node))
(put-text-property b (point) 'keymap rst-toc-insert-click-keymap))
(insert "\n")
;; Prepare indent for children.
(setq indent
(cond
((eq rst-toc-insert-style 'plain)
(concat indent (make-string rst-toc-indent ? )))
((eq rst-toc-insert-style 'fixed)
(concat indent (make-string rst-toc-indent ? )))
((eq rst-toc-insert-style 'aligned)
(concat indent (make-string (+ (length pfx) 2) ? )))
((eq rst-toc-insert-style 'listed)
(concat (substring indent 0 -3)
(concat (make-string (+ (length pfx) 2) ? ) " - "))))))
(if (or (eq rst-toc-insert-max-level nil)
(< level rst-toc-insert-max-level))
(let ((do-child-numbering (>= level 0))
fmt)
(if do-child-numbering
(progn
;; Add a separating dot if there is already a prefix.
(when (> (length pfx) 0)
(string-match (rst-re "[ \t\n]*\\'") pfx)
(setq pfx (concat (replace-match "" t t pfx) ".")))
;; Calculate the amount of space that the prefix will require
;; for the numbers.
(if (cdr node)
(setq fmt (format "%%-%dd"
(1+ (floor (log10 (length
(cdr node))))))))))
(dolist (child (cdr node))
(rst-toc-insert-node child
(1+ level)
indent
(if do-child-numbering
(concat pfx (format fmt count)) pfx))
(incf count))))))
(defun rst-toc-update ()
"Automatically find the contents section of a document and update.
Updates the inserted TOC if present. You can use this in your
file-write hook to always make it up-to-date automatically."
(interactive)
(save-excursion
;; Find and delete an existing comment after the first contents directive.
;; Delete that region.
(goto-char (point-min))
;; We look for the following and the following only (in other words, if your
;; syntax differs, this won't work.).
;;
;; .. contents:: [...anything here...]
;; [:field: value]...
;; ..
;; XXXXXXXX
;; XXXXXXXX
;; [more lines]
(let ((beg (re-search-forward
(rst-re "^" 'exm-sta "contents" 'dcl-tag ".*\n"
"\\(?:" 'hws-sta 'fld-tag ".*\n\\)*" 'exm-tag) nil t))
last-real)
(when beg
;; Look for the first line that starts at the first column.
(forward-line 1)
(while (and
(< (point) (point-max))
(or (if (looking-at
(rst-re 'hws-sta "\\S ")) ; indented content.
(setq last-real (point)))
(looking-at (rst-re 'lin-end)))) ; empty line.
(forward-line 1))
(if last-real
(progn
(goto-char last-real)
(end-of-line)
(delete-region beg (point)))
(goto-char beg))
(insert "\n ")
(rst-toc-insert))))
;; Note: always return nil, because this may be used as a hook.
nil)
;; Note: we cannot bind the TOC update on file write because it messes with
;; undo. If we disable undo, since it adds and removes characters, the
;; positions in the undo list are not making sense anymore. Dunno what to do
;; with this, it would be nice to update when saving.
;;
;; (add-hook 'write-contents-hooks 'rst-toc-update-fun)
;; (defun rst-toc-update-fun ()
;; ;; Disable undo for the write file hook.
;; (let ((buffer-undo-list t)) (rst-toc-update) ))
(defalias 'rst-toc-insert-update 'rst-toc-update) ; backwards compat.
;;------------------------------------------------------------------------------
(defun rst-toc-node (node level)
"Recursive function that does insert NODE at LEVEL in the table-of-contents."
(if (> level 0)
(let ((b (point)))
;; Insert line text.
(insert (make-string (* rst-toc-indent (1- level)) ? ))
(insert (or (caar node) "[missing node]"))
;; Highlight lines.
(put-text-property b (point) 'mouse-face 'highlight)
;; Add link on lines.
(put-text-property b (point) 'rst-toc-target (cadar node))
(insert "\n")))
(dolist (child (cdr node))
(rst-toc-node child (1+ level))))
(defun rst-toc-count-lines (node target-node)
"Count the number of lines from NODE to the TARGET-NODE node.
This recursive function returns a cons of the number of
additional lines that have been counted for its node and
children, and t if the node has been found."
(let ((count 1)
found)
(if (eq node target-node)
(setq found t)
(let ((child (cdr node)))
(while (and child (not found))
(let ((cl (rst-toc-count-lines (car child) target-node)))
(setq count (+ count (car cl))
found (cdr cl)
child (cdr child))))))
(cons count found)))
(defvar rst-toc-buffer-name "*Table of Contents*"
"Name of the Table of Contents buffer.")
(defvar rst-toc-return-wincfg nil
"Window configuration to which to return when leaving the TOC.")
(defun rst-toc ()
"Display a table-of-contents.
Finds all the section titles and their adornments in the
file, and displays a hierarchically-organized list of the
titles, which is essentially a table-of-contents of the
document.
The Emacs buffer can be navigated, and selecting a section
brings the cursor in that section."
(interactive)
(rst-reset-section-caches)
(let* ((curbuf (list (current-window-configuration) (point-marker)))
(sectree (rst-section-tree))
(our-node (cdr (rst-section-tree-point sectree)))
line
;; Create a temporary buffer.
(buf (get-buffer-create rst-toc-buffer-name)))
(with-current-buffer buf
(let ((inhibit-read-only t))
(rst-toc-mode)
(delete-region (point-min) (point-max))
(insert (format "Table of Contents: %s\n" (or (caar sectree) "")))
(put-text-property (point-min) (point)
'face (list '(background-color . "gray")))
(rst-toc-node sectree 0)
;; Count the lines to our found node.
(let ((linefound (rst-toc-count-lines sectree our-node)))
(setq line (if (cdr linefound) (car linefound) 0)))))
(display-buffer buf)
(pop-to-buffer buf)
;; Save the buffer to return to.
(set (make-local-variable 'rst-toc-return-wincfg) curbuf)
;; Move the cursor near the right section in the TOC.
(goto-char (point-min))
(forward-line (1- line))))
(defun rst-toc-mode-find-section ()
"Get the section from text property at point."
(let ((pos (get-text-property (point) 'rst-toc-target)))
(unless pos
(error "No section on this line"))
(unless (buffer-live-p (marker-buffer pos))
(error "Buffer for this section was killed"))
pos))
;; FIXME: Cursor before or behind the list must be handled properly; before the
;; list should jump to the top and behind the list to the last normal
;; paragraph.
(defun rst-goto-section (&optional kill)
"Go to the section the current line describes.
If KILL a toc buffer is destroyed."
(interactive)
(let ((pos (rst-toc-mode-find-section)))
(when kill
;; FIXME: This should rather go to `rst-toc-mode-goto-section'.
(set-window-configuration (car rst-toc-return-wincfg))
(kill-buffer (get-buffer rst-toc-buffer-name)))
(pop-to-buffer (marker-buffer pos))
(goto-char pos)
;; FIXME: make the recentering conditional on scroll.
(recenter 5)))
(defun rst-toc-mode-goto-section ()
"Go to the section the current line describes and kill the TOC buffer."
(interactive)
(rst-goto-section t))
(defun rst-toc-mode-mouse-goto (event)
"In `rst-toc' mode, go to the occurrence whose line you click on.
EVENT is the input event."
(interactive "e")
(let ((pos
(with-current-buffer (window-buffer (posn-window (event-end event)))
(save-excursion
(goto-char (posn-point (event-end event)))
(rst-toc-mode-find-section)))))
(pop-to-buffer (marker-buffer pos))
(goto-char pos)
(recenter 5)))
(defun rst-toc-mode-mouse-goto-kill (event)
"Same as `rst-toc-mode-mouse-goto', but kill TOC buffer as well.
EVENT is the input event."
(interactive "e")
(call-interactively 'rst-toc-mode-mouse-goto event)
(kill-buffer (get-buffer rst-toc-buffer-name)))
(defun rst-toc-quit-window ()
"Leave the current TOC buffer."
(interactive)
(let ((retbuf rst-toc-return-wincfg))
(set-window-configuration (car retbuf))
(goto-char (cadr retbuf))))
(defvar rst-toc-mode-map
(let ((map (make-sparse-keymap)))
(define-key map [mouse-1] 'rst-toc-mode-mouse-goto-kill)
(define-key map [mouse-2] 'rst-toc-mode-mouse-goto)
(define-key map "\C-m" 'rst-toc-mode-goto-section)
(define-key map "f" 'rst-toc-mode-goto-section)
(define-key map "q" 'rst-toc-quit-window)
(define-key map "z" 'kill-this-buffer)
map)
"Keymap for `rst-toc-mode'.")
(put 'rst-toc-mode 'mode-class 'special)
;; Could inherit from the new `special-mode'.
(define-derived-mode rst-toc-mode nil "ReST-TOC"
"Major mode for output from \\[rst-toc], the table-of-contents for the document."
(setq buffer-read-only t))
;; Note: use occur-mode (replace.el) as a good example to complete missing
;; features.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Section movement commands
;; =========================
(defun rst-forward-section (&optional offset)
"Skip to the next reStructuredText section title.
OFFSET specifies how many titles to skip. Use a negative OFFSET to move
backwards in the file (default is to use 1)."
(interactive)
(rst-reset-section-caches)
(let* (;; Default value for offset.
(offset (or offset 1))
;; Get all the adornments in the file, with their line numbers.
(allados (rst-find-all-adornments))
;; Get the current line.
(curline (line-number-at-pos))
(cur allados)
(idx 0))
;; Find the index of the "next" adornment w.r.t. to the current line.
(while (and cur (< (caar cur) curline))
(setq cur (cdr cur))
(incf idx))
;; 'cur' is the adornment on or following the current line.
(if (and (> offset 0) cur (= (caar cur) curline))
(incf idx))
;; Find the final index.
(setq idx (+ idx (if (> offset 0) (- offset 1) offset)))
(setq cur (nth idx allados))
;; If the index is positive, goto the line, otherwise go to the buffer
;; boundaries.
(if (and cur (>= idx 0))
(progn
(goto-char (point-min))
(forward-line (1- (car cur))))
(if (> offset 0) (goto-char (point-max)) (goto-char (point-min))))))
(defun rst-backward-section ()
"Like `rst-forward-section', except move back one title."
(interactive)
(rst-forward-section -1))
;; FIXME: What is `allow-extend' for?
(defun rst-mark-section (&optional count allow-extend)
"Select COUNT sections around point.
Mark following sections for positive COUNT or preceding sections
for negative COUNT."
;; Cloned from mark-paragraph.
(interactive "p\np")
(unless count (setq count 1))
(when (zerop count)
(error "Cannot mark zero sections"))
(cond ((and allow-extend
(or (and (eq last-command this-command) (mark t))
(use-region-p)))
(set-mark
(save-excursion
(goto-char (mark))
(rst-forward-section count)
(point))))
(t
(rst-forward-section count)
(push-mark nil t t)
(rst-forward-section (- count)))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Functions to work on item lists (e.g. indent/dedent, enumerate), which are
;; always 2 or 3 characters apart horizontally with rest.
(defun rst-find-leftmost-column (beg end)
"Return the leftmost column in region BEG to END."
(let (mincol)
(save-excursion
(goto-char beg)
(while (< (point) end)
(back-to-indentation)
(unless (looking-at (rst-re 'lin-end))
(setq mincol (if mincol
(min mincol (current-column))
(current-column))))
(forward-line 1)))
mincol))
;; FIXME: This definition is old and deprecated. We need to move to the newer
;; version below.
(defmacro rst-iterate-leftmost-paragraphs
(beg end first-only body-consequent body-alternative)
;; FIXME: The following comment is pretty useless.
"Call FUN at the beginning of each line, with an argument that
specifies whether we are at the first line of a paragraph that
starts at the leftmost column of the given region BEG and END.
Set FIRST-ONLY to true if you want to callback on the first line
of each paragraph only."
`(save-excursion
(let ((leftcol (rst-find-leftmost-column ,beg ,end))
(endm (copy-marker ,end)))
(do* (;; Iterate lines.
(l (progn (goto-char ,beg) (back-to-indentation))
(progn (forward-line 1) (back-to-indentation)))
(previous nil valid)
(curcol (current-column)
(current-column))
(valid (and (= curcol leftcol)
(not (looking-at (rst-re 'lin-end))))
(and (= curcol leftcol)
(not (looking-at (rst-re 'lin-end))))))
((>= (point) endm))
(if (if ,first-only
(and valid (not previous))
valid)
,body-consequent
,body-alternative)))))
;; FIXME: This needs to be refactored. Probably this is simply a function
;; applying BODY rather than a macro.
(defmacro rst-iterate-leftmost-paragraphs-2 (spec &rest body)
"Evaluate BODY for each line in region defined by BEG END.
LEFTMOST is set to true if the line is one of the leftmost of the
entire paragraph. PARABEGIN is set to true if the line is the
first of a paragraph."
(declare (indent 1) (debug (sexp body)))
(destructuring-bind
(beg end parabegin leftmost isleftmost isempty) spec
`(save-excursion
(let ((,leftmost (rst-find-leftmost-column ,beg ,end))
(endm (copy-marker ,end)))
(do* (;; Iterate lines.
(l (progn (goto-char ,beg) (back-to-indentation))
(progn (forward-line 1) (back-to-indentation)))
(empty-line-previous nil ,isempty)
(,isempty (looking-at (rst-re 'lin-end))
(looking-at (rst-re 'lin-end)))
(,parabegin (not ,isempty)
(and empty-line-previous
(not ,isempty)))
(,isleftmost (and (not ,isempty)
(= (current-column) ,leftmost))
(and (not ,isempty)
(= (current-column) ,leftmost))))
((>= (point) endm))
(progn ,@body))))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Indentation
;; FIXME: At the moment only block comments with leading empty comment line are
;; supported. Comment lines with leading comment markup should be also
;; supported. May be a customizable option could control which style to
;; prefer.
(defgroup rst-indent nil "Settings for indentation in reStructuredText.
In reStructuredText indentation points are usually determined by
preceding lines. Sometimes the syntax allows arbitrary
indentation points such as where to start the first line
following a directive. These indentation widths can be customized
here."
:group 'rst
:package-version '(rst . "1.1.0"))
(define-obsolete-variable-alias
'rst-shift-basic-offset 'rst-indent-width "1.0.0")
(defcustom rst-indent-width 2
"Indentation when there is no more indentation point given."
:group 'rst-indent
:type '(integer))
(rst-testcover-defcustom)
(defcustom rst-indent-field 3
"Indentation for first line after a field or 0 to always indent for content."
:group 'rst-indent
:type '(integer))
(rst-testcover-defcustom)
(defcustom rst-indent-literal-normal 3
"Default indentation for literal block after a markup on an own line."
:group 'rst-indent
:type '(integer))
(rst-testcover-defcustom)
(defcustom rst-indent-literal-minimized 2
"Default indentation for literal block after a minimized markup."
:group 'rst-indent
:type '(integer))
(rst-testcover-defcustom)
(defcustom rst-indent-comment 3
"Default indentation for first line of a comment."
:group 'rst-indent
:type '(integer))
(rst-testcover-defcustom)
;; FIXME: Must consider other tabs:
;; * Line blocks
;; * Definition lists
;; * Option lists
(defun rst-line-tabs ()
"Return tabs of the current line or nil for no tab.
The list is sorted so the tab where writing continues most likely
is the first one. Each tab is of the form (COLUMN . INNER).
COLUMN is the column of the tab. INNER is non-nil if this is an
inner tab. I.e. a tab which does come from the basic indentation
and not from inner alignment points."
(save-excursion
(forward-line 0)
(save-match-data
(unless (looking-at (rst-re 'lin-end))
(back-to-indentation)
;; Current indentation is always the least likely tab.
(let ((tabs (list (list (point) 0 nil)))) ; (POINT OFFSET INNER)
;; Push inner tabs more likely to continue writing.
(cond
;; Item.
((looking-at (rst-re '(:grp itmany-tag hws-sta) '(:grp "\\S ") "?"))
(when (match-string 2)
(push (list (match-beginning 2) 0 t) tabs)))
;; Field.
((looking-at (rst-re '(:grp fld-tag) '(:grp hws-tag)
'(:grp "\\S ") "?"))
(unless (zerop rst-indent-field)
(push (list (match-beginning 1) rst-indent-field t) tabs))
(if (match-string 3)
(push (list (match-beginning 3) 0 t) tabs)
(if (zerop rst-indent-field)
(push (list (match-end 2)
(if (string= (match-string 2) "") 1 0)
t) tabs))))
;; Directive.
((looking-at (rst-re 'dir-sta-3 '(:grp "\\S ") "?"))
(push (list (match-end 1) 0 t) tabs)
(unless (string= (match-string 2) "")
(push (list (match-end 2) 0 t) tabs))
(when (match-string 4)
(push (list (match-beginning 4) 0 t) tabs)))
;; Footnote or citation definition.
((looking-at (rst-re 'fnc-sta-2 '(:grp "\\S ") "?"))
(push (list (match-end 1) 0 t) tabs)
(when (match-string 3)
(push (list (match-beginning 3) 0 t) tabs)))
;; Comment.
((looking-at (rst-re 'cmt-sta-1))
(push (list (point) rst-indent-comment t) tabs)))
;; Start of literal block.
(when (looking-at (rst-re 'lit-sta-2))
(let ((tab0 (first tabs)))
(push (list (first tab0)
(+ (second tab0)
(if (match-string 1)
rst-indent-literal-minimized
rst-indent-literal-normal))
t) tabs)))
(mapcar (lambda (tab)
(goto-char (first tab))
(cons (+ (current-column) (second tab)) (third tab)))
tabs))))))
(defun rst-compute-tabs (pt)
"Build the list of possible tabs for all lines above.
Search backwards from point PT to build the list of possible
tabs. Return a list of tabs sorted by likeliness to continue
writing like `rst-line-tabs'. Nearer lines have generally a
higher likeliness than farther lines. Return nil if no tab is found
in the text above."
(save-excursion
(goto-char pt)
(let (leftmost ; Leftmost column found so far.
innermost ; Leftmost column for inner tab.
tablist)
(while (and (zerop (forward-line -1))
(or (not leftmost)
(> leftmost 0)))
(let* ((tabs (rst-line-tabs))
(leftcol (if tabs (apply 'min (mapcar 'car tabs)))))
(when tabs
;; Consider only lines indented less or same if not INNERMOST.
(when (or (not leftmost)
(< leftcol leftmost)
(and (not innermost) (= leftcol leftmost)))
(dolist (tab tabs)
(let ((inner (cdr tab))
(newcol (car tab)))
(when (and
(or
(and (not inner)
(or (not leftmost)
(< newcol leftmost)))
(and inner
(or (not innermost)
(< newcol innermost))))
(not (memq newcol tablist)))
(push newcol tablist))))
(setq innermost (if (rst-some (mapcar 'cdr tabs)) ; Has inner.
leftcol
innermost))
(setq leftmost leftcol)))))
(nreverse tablist))))
(defun rst-indent-line (&optional dflt)
"Indent current line to next best reStructuredText tab.
The next best tab is taken from the tab list returned by
`rst-compute-tabs' which is used in a cyclic manner. If the
current indentation does not end on a tab use the first one. If
the current indentation is on a tab use the next tab. This allows
a repeated use of \\[indent-for-tab-command] to cycle through all
possible tabs. If no indentation is possible return `noindent' or
use DFLT. Return the indentation indented to. When point is in
indentation it ends up at its end. Otherwise the point is kept
relative to the content."
(let* ((pt (point-marker))
(cur (current-indentation))
(clm (current-column))
(tabs (rst-compute-tabs (point)))
(fnd (rst-position cur tabs))
ind)
(if (and (not tabs) (not dflt))
'noindent
(if (not tabs)
(setq ind dflt)
(if (not fnd)
(setq fnd 0)
(setq fnd (1+ fnd))
(if (>= fnd (length tabs))
(setq fnd 0)))
(setq ind (nth fnd tabs)))
(indent-line-to ind)
(if (> clm cur)
(goto-char pt))
(set-marker pt nil)
ind)))
(defun rst-shift-region (beg end cnt)
"Shift region BEG to END by CNT tabs.
Shift by one tab to the right (CNT > 0) or left (CNT < 0) or
remove all indentation (CNT = 0). A tab is taken from the text
above. If no suitable tab is found `rst-indent-width' is used."
(interactive "r\np")
(let ((tabs (sort (rst-compute-tabs beg) (lambda (x y) (<= x y))))
(leftmostcol (rst-find-leftmost-column beg end)))
(when (or (> leftmostcol 0) (> cnt 0))
;; Apply the indent.
(indent-rigidly
beg end
(if (zerop cnt)
(- leftmostcol)
;; Find the next tab after the leftmost column.
(let* ((cmp (if (> cnt 0) '> '<))
(tabs (if (> cnt 0) tabs (reverse tabs)))
(len (length tabs))
(dir (rst-signum cnt)) ; Direction to take.
(abs (abs cnt)) ; Absolute number of steps to take.
;; Get the position of the first tab beyond leftmostcol.
(fnd (lexical-let ((cmp cmp)
(leftmostcol leftmostcol)) ; Create closure.
(rst-position-if (lambda (elt)
(funcall cmp elt leftmostcol))
tabs)))
;; Virtual position of tab.
(pos (+ (or fnd len) (1- abs)))
(tab (if (< pos len)
;; Tab exists - use it.
(nth pos tabs)
;; Column needs to be computed.
(let ((col (+ (or (car (last tabs)) leftmostcol)
;; Base on last known column.
(* (- pos (1- len)) ; Distance left.
dir ; Direction to take.
rst-indent-width))))
(if (< col 0) 0 col)))))
(- tab leftmostcol)))))))
;; FIXME: A paragraph with an (incorrectly) indented second line is not filled
;; correctly::
;;
;; Some start
;; continued wrong
(defun rst-adaptive-fill ()
"Return fill prefix found at point.
Value for `adaptive-fill-function'."
(let ((fnd (if (looking-at adaptive-fill-regexp)
(match-string-no-properties 0))))
(if (save-match-data
(not (string-match comment-start-skip fnd)))
;; An non-comment prefix is fine.
fnd
;; Matches a comment - return whitespace instead.
(make-string (-
(save-excursion
(goto-char (match-end 0))
(current-column))
(save-excursion
(goto-char (match-beginning 0))
(current-column))) ? ))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Comments
(defun rst-comment-line-break (&optional soft)
"Break line and indent, continuing reStructuredText comment if within one.
Value for `comment-line-break-function'. If SOFT use soft
newlines as mandated by `comment-line-break-function'."
(if soft
(insert-and-inherit ?\n)
(newline 1))
(save-excursion
(forward-char -1)
(delete-horizontal-space))
(delete-horizontal-space)
(let ((tabs (rst-compute-tabs (point))))
(when tabs
(indent-line-to (car tabs)))))
(defun rst-comment-indent ()
"Return indentation for current comment line."
(car (rst-compute-tabs (point))))
(defun rst-comment-insert-comment ()
"Insert a comment in the current line."
(rst-indent-line 0)
(insert comment-start))
(defun rst-comment-region (beg end &optional arg)
"Comment or uncomment the current region.
Region is from from BEG to END. Uncomment if ARG."
(save-excursion
(if (consp arg)
(rst-uncomment-region beg end arg)
(goto-char beg)
(let ((ind (current-indentation))
bol)
(forward-line 0)
(setq bol (point))
(indent-rigidly bol end rst-indent-comment)
(goto-char bol)
(open-line 1)
(indent-line-to ind)
(insert (comment-string-strip comment-start t t))))))
(defun rst-uncomment-region (beg end &optional arg)
"Uncomment the current region.
Region is from BEG to END. ARG is ignored"
(save-excursion
(let (bol eol)
(goto-char beg)
(forward-line 0)
(setq bol (point))
(forward-line 1)
(setq eol (point))
(indent-rigidly eol end (- rst-indent-comment))
(delete-region bol eol))))
;;------------------------------------------------------------------------------
;; FIXME: These next functions should become part of a larger effort to redo
;; the bullets in bulleted lists. The enumerate would just be one of
;; the possible outputs.
;;
;; FIXME: We need to do the enumeration removal as well.
(defun rst-enumerate-region (beg end all)
"Add enumeration to all the leftmost paragraphs in the given region.
The region is specified between BEG and END. With ALL,
do all lines instead of just paragraphs."
(interactive "r\nP")
(let ((count 0)
(last-insert-len nil))
(rst-iterate-leftmost-paragraphs
beg end (not all)
(let ((ins-string (format "%d. " (incf count))))
(setq last-insert-len (length ins-string))
(insert ins-string))
(insert (make-string last-insert-len ?\ )))))
(defun rst-bullet-list-region (beg end all)
"Add bullets to all the leftmost paragraphs in the given region.
The region is specified between BEG and END. With ALL,
do all lines instead of just paragraphs."
(interactive "r\nP")
(rst-iterate-leftmost-paragraphs
beg end (not all)
(insert (car rst-preferred-bullets) " ")
(insert " ")))
;; FIXME: Does not deal with a varying number of digits appropriately.
;; FIXME: Does not deal with multiple levels independently.
;; FIXME: Does not indent a multiline item correctly.
(defun rst-convert-bullets-to-enumeration (beg end)
"Convert the bulleted and enumerated items in the region to enumerated lists.
Renumber as necessary. Region is from BEG to END."
(interactive "r")
(let* (;; Find items and convert the positions to markers.
(items (mapcar
(lambda (x)
(cons (copy-marker (car x))
(cdr x)))
(rst-find-pfx-in-region beg end (rst-re 'itmany-sta-1))))
(count 1))
(save-excursion
(dolist (x items)
(goto-char (car x))
(looking-at (rst-re 'itmany-beg-1))
(replace-match (format "%d." count) nil nil nil 1)
(incf count)))))
;;------------------------------------------------------------------------------
(defun rst-line-block-region (rbeg rend &optional pfxarg)
"Toggle line block prefixes for a region.
Region is from RBEG to REND. With PFXARG set the empty lines too."
(interactive "r\nP")
(let ((comment-start "| ")
(comment-end "")
(comment-start-skip "| ")
(comment-style 'indent)
(force (not (not pfxarg))))
(rst-iterate-leftmost-paragraphs-2
(rbeg rend parbegin leftmost isleft isempty)
(when (or force (not isempty))
(move-to-column leftmost force)
(delete-region (point) (+ (point) (- (current-indentation) leftmost)))
(insert "| ")))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Font lock
;; =========
(require 'font-lock)
;; FIXME: The obsolete variables need to disappear.
;; The following versions have been done inside Emacs and should not be
;; replaced by `:package-version' attributes until a change.
(defgroup rst-faces nil "Faces used in Rst Mode."
:group 'rst
:group 'faces
:version "21.1")
(defface rst-block '((t :inherit font-lock-keyword-face))
"Face used for all syntax marking up a special block."
:version "24.1"
:group 'rst-faces)
(defcustom rst-block-face 'rst-block
"All syntax marking up a special block."
:version "24.1"
:group 'rst-faces
:type '(face))
(rst-testcover-defcustom)
(make-obsolete-variable 'rst-block-face
"customize the face `rst-block' instead."
"24.1")
(defface rst-external '((t :inherit font-lock-type-face))
"Face used for field names and interpreted text."
:version "24.1"
:group 'rst-faces)
(defcustom rst-external-face 'rst-external
"Field names and interpreted text."
:version "24.1"
:group 'rst-faces
:type '(face))
(rst-testcover-defcustom)
(make-obsolete-variable 'rst-external-face
"customize the face `rst-external' instead."
"24.1")
(defface rst-definition '((t :inherit font-lock-function-name-face))
"Face used for all other defining constructs."
:version "24.1"
:group 'rst-faces)
(defcustom rst-definition-face 'rst-definition
"All other defining constructs."
:version "24.1"
:group 'rst-faces
:type '(face))
(rst-testcover-defcustom)
(make-obsolete-variable 'rst-definition-face
"customize the face `rst-definition' instead."
"24.1")
;; XEmacs compatibility (?).
(defface rst-directive (if (boundp 'font-lock-builtin-face)
'((t :inherit font-lock-builtin-face))
'((t :inherit font-lock-preprocessor-face)))
"Face used for directives and roles."
:version "24.1"
:group 'rst-faces)
(defcustom rst-directive-face 'rst-directive
"Directives and roles."
:group 'rst-faces
:type '(face))
(rst-testcover-defcustom)
(make-obsolete-variable 'rst-directive-face
"customize the face `rst-directive' instead."
"24.1")
(defface rst-comment '((t :inherit font-lock-comment-face))
"Face used for comments."
:version "24.1"
:group 'rst-faces)
(defcustom rst-comment-face 'rst-comment
"Comments."
:version "24.1"
:group 'rst-faces
:type '(face))
(rst-testcover-defcustom)
(make-obsolete-variable 'rst-comment-face
"customize the face `rst-comment' instead."
"24.1")
(defface rst-emphasis1 '((t :inherit italic))
"Face used for simple emphasis."
:version "24.1"
:group 'rst-faces)
(defcustom rst-emphasis1-face 'rst-emphasis1
"Simple emphasis."
:version "24.1"
:group 'rst-faces
:type '(face))
(rst-testcover-defcustom)
(make-obsolete-variable 'rst-emphasis1-face
"customize the face `rst-emphasis1' instead."
"24.1")
(defface rst-emphasis2 '((t :inherit bold))
"Face used for double emphasis."
:version "24.1"
:group 'rst-faces)
(defcustom rst-emphasis2-face 'rst-emphasis2
"Double emphasis."
:group 'rst-faces
:type '(face))
(rst-testcover-defcustom)
(make-obsolete-variable 'rst-emphasis2-face
"customize the face `rst-emphasis2' instead."
"24.1")
(defface rst-literal '((t :inherit font-lock-string-face))
"Face used for literal text."
:version "24.1"
:group 'rst-faces)
(defcustom rst-literal-face 'rst-literal
"Literal text."
:version "24.1"
:group 'rst-faces
:type '(face))
(rst-testcover-defcustom)
(make-obsolete-variable 'rst-literal-face
"customize the face `rst-literal' instead."
"24.1")
(defface rst-reference '((t :inherit font-lock-variable-name-face))
"Face used for references to a definition."
:version "24.1"
:group 'rst-faces)
(defcustom rst-reference-face 'rst-reference
"References to a definition."
:version "24.1"
:group 'rst-faces
:type '(face))
(rst-testcover-defcustom)
(make-obsolete-variable 'rst-reference-face
"customize the face `rst-reference' instead."
"24.1")
(defface rst-transition '((t :inherit font-lock-keyword-face))
"Face used for a transition."
:package-version '(rst . "1.3.0")
:group 'rst-faces)
(defface rst-adornment '((t :inherit font-lock-keyword-face))
"Face used for the adornment of a section header."
:package-version '(rst . "1.3.0")
:group 'rst-faces)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(dolist (var '(rst-level-face-max rst-level-face-base-color
rst-level-face-base-light
rst-level-face-format-light
rst-level-face-step-light
rst-level-1-face
rst-level-2-face
rst-level-3-face
rst-level-4-face
rst-level-5-face
rst-level-6-face))
(make-obsolete-variable var "customize the faces `rst-level-*' instead."
"24.3"))
;; Define faces for the first 6 levels. More levels are possible, however.
(defface rst-level-1 '((((background light)) (:background "grey85"))
(((background dark)) (:background "grey15")))
"Default face for section title text at level 1."
:package-version '(rst . "1.4.0"))
(defface rst-level-2 '((((background light)) (:background "grey78"))
(((background dark)) (:background "grey22")))
"Default face for section title text at level 2."
:package-version '(rst . "1.4.0"))
(defface rst-level-3 '((((background light)) (:background "grey71"))
(((background dark)) (:background "grey29")))
"Default face for section title text at level 3."
:package-version '(rst . "1.4.0"))
(defface rst-level-4 '((((background light)) (:background "grey64"))
(((background dark)) (:background "grey36")))
"Default face for section title text at level 4."
:package-version '(rst . "1.4.0"))
(defface rst-level-5 '((((background light)) (:background "grey57"))
(((background dark)) (:background "grey43")))
"Default face for section title text at level 5."
:package-version '(rst . "1.4.0"))
(defface rst-level-6 '((((background light)) (:background "grey50"))
(((background dark)) (:background "grey50")))
"Default face for section title text at level 6."
:package-version '(rst . "1.4.0"))
(defcustom rst-adornment-faces-alist
'((t . rst-transition)
(nil . rst-adornment)
(1 . rst-level-1)
(2 . rst-level-2)
(3 . rst-level-3)
(4 . rst-level-4)
(5 . rst-level-5)
(6 . rst-level-6))
"Faces for the various adornment types.
Key is a number (for the section title text of that level
starting with 1), t (for transitions) or nil (for section title
adornment). if you need levels beyond 6 you have to define faces
of your own."
:group 'rst-faces
:type '(alist
:key-type
(choice
(integer :tag "Section level")
(const :tag "transitions" t)
(const :tag "section title adornment" nil))
:value-type (face)))
(rst-testcover-defcustom)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defvar rst-font-lock-keywords
;; The reST-links in the comments below all relate to sections in
;; http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html.
`(;; FIXME: Block markup is not recognized in blocks after explicit markup
;; start.
;; Simple `Body Elements`_
;; `Bullet Lists`_
;; FIXME: A bullet directly after a field name is not recognized.
(,(rst-re 'lin-beg '(:grp bul-sta))
1 rst-block-face)
;; `Enumerated Lists`_
(,(rst-re 'lin-beg '(:grp enmany-sta))
1 rst-block-face)
;; `Definition Lists`_
;; FIXME: missing.
;; `Field Lists`_
(,(rst-re 'lin-beg '(:grp fld-tag) 'bli-sfx)
1 rst-external-face)
;; `Option Lists`_
(,(rst-re 'lin-beg '(:grp opt-tag (:shy optsep-tag opt-tag) "*")
'(:alt "$" (:seq hws-prt "\\{2\\}")))
1 rst-block-face)
;; `Line Blocks`_
;; Only for lines containing no more bar - to distinguish from tables.
(,(rst-re 'lin-beg '(:grp "|" bli-sfx) "[^|\n]*$")
1 rst-block-face)
;; `Tables`_
;; FIXME: missing
;; All the `Explicit Markup Blocks`_
;; `Footnotes`_ / `Citations`_
(,(rst-re 'lin-beg 'fnc-sta-2)
(1 rst-definition-face)
(2 rst-definition-face))
;; `Directives`_ / `Substitution Definitions`_
(,(rst-re 'lin-beg 'dir-sta-3)
(1 rst-directive-face)
(2 rst-definition-face)
(3 rst-directive-face))
;; `Hyperlink Targets`_
(,(rst-re 'lin-beg
'(:grp exm-sta "_" (:alt
(:seq "`" ilcbkqdef-tag "`")
(:seq (:alt "[^:\\\n]" "\\\\.") "+")) ":")
'bli-sfx)
1 rst-definition-face)
(,(rst-re 'lin-beg '(:grp "__") 'bli-sfx)
1 rst-definition-face)
;; All `Inline Markup`_
;; Most of them may be multiline though this is uninteresting.
;; FIXME: Condition 5 preventing fontification of e.g. "*" not implemented
;; `Strong Emphasis`_.
(,(rst-re 'ilm-pfx '(:grp "\\*\\*" ilcast-tag "\\*\\*") 'ilm-sfx)
1 rst-emphasis2-face)
;; `Emphasis`_
(,(rst-re 'ilm-pfx '(:grp "\\*" ilcast-tag "\\*") 'ilm-sfx)
1 rst-emphasis1-face)
;; `Inline Literals`_
(,(rst-re 'ilm-pfx '(:grp "``" ilcbkq-tag "``") 'ilm-sfx)
1 rst-literal-face)
;; `Inline Internal Targets`_
(,(rst-re 'ilm-pfx '(:grp "_`" ilcbkq-tag "`") 'ilm-sfx)
1 rst-definition-face)
;; `Hyperlink References`_
;; FIXME: `Embedded URIs`_ not considered.
;; FIXME: Directly adjacent marked up words are not fontified correctly
;; unless they are not separated by two spaces: foo_ bar_.
(,(rst-re 'ilm-pfx '(:grp (:alt (:seq "`" ilcbkq-tag "`")
(:seq "\\sw" (:alt "\\sw" "-") "+\\sw"))
"__?") 'ilm-sfx)
1 rst-reference-face)
;; `Interpreted Text`_
(,(rst-re 'ilm-pfx '(:grp (:shy ":" sym-tag ":") "?")
'(:grp "`" ilcbkq-tag "`")
'(:grp (:shy ":" sym-tag ":") "?") 'ilm-sfx)
(1 rst-directive-face)
(2 rst-external-face)
(3 rst-directive-face))
;; `Footnote References`_ / `Citation References`_
(,(rst-re 'ilm-pfx '(:grp fnc-tag "_") 'ilm-sfx)
1 rst-reference-face)
;; `Substitution References`_
;; FIXME: References substitutions like |this|_ or |this|__ are not
;; fontified correctly.
(,(rst-re 'ilm-pfx '(:grp sub-tag) 'ilm-sfx)
1 rst-reference-face)
;; `Standalone Hyperlinks`_
;; FIXME: This takes it easy by using a whitespace as delimiter.
(,(rst-re 'ilm-pfx '(:grp uri-tag ":\\S +") 'ilm-sfx)
1 rst-definition-face)
(,(rst-re 'ilm-pfx '(:grp sym-tag "@" sym-tag ) 'ilm-sfx)
1 rst-definition-face)
;; Do all block fontification as late as possible so 'append works.
;; Sections_ / Transitions_
;; For sections this is multiline.
(,(rst-re 'ado-beg-2-1)
(rst-font-lock-handle-adornment-matcher
(rst-font-lock-handle-adornment-pre-match-form
(match-string-no-properties 1) (match-end 1))
nil
(1 (cdr (assoc nil rst-adornment-faces-alist)) append t)
(2 (cdr (assoc rst-font-lock-adornment-level
rst-adornment-faces-alist)) append t)
(3 (cdr (assoc nil rst-adornment-faces-alist)) append t)))
;; FIXME: FACESPEC could be used instead of ordinary faces to set
;; properties on comments and literal blocks so they are *not*
;; inline fontified. See (elisp)Search-based Fontification.
;; FIXME: And / or use `syntax-propertize` functions as in `octave-mod.el`
;; and other V24 modes. May make `font-lock-extend-region`
;; superfluous.
;; `Comments`_
;; This is multiline.
(,(rst-re 'lin-beg 'cmt-sta-1)
(1 rst-comment-face)
(rst-font-lock-find-unindented-line-match
(rst-font-lock-find-unindented-line-limit (match-end 1))
nil
(0 rst-comment-face append)))
(,(rst-re 'lin-beg '(:grp exm-tag) '(:grp hws-tag) "$")
(1 rst-comment-face)
(2 rst-comment-face)
(rst-font-lock-find-unindented-line-match
(rst-font-lock-find-unindented-line-limit 'next)
nil
(0 rst-comment-face append)))
;; FIXME: This is not rendered as comment::
;; .. .. list-table::
;; :stub-columns: 1
;; :header-rows: 1
;; FIXME: This is rendered wrong::
;;
;; xxx yyy::
;;
;; ----|> KKKKK <|----
;; / \
;; -|> AAAAAAAAAAPPPPPP <|- -|> AAAAAAAAAABBBBBBB <|-
;; | | | |
;; | | | |
;; PPPPPP PPPPPPDDDDDDD BBBBBBB PPPPPPBBBBBBB
;;
;; Indentation needs to be taken from the line with the ``::`` and not from
;; the first content line.
;; `Indented Literal Blocks`_
;; This is multiline.
(,(rst-re 'lin-beg 'lit-sta-2)
(2 rst-block-face)
(rst-font-lock-find-unindented-line-match
(rst-font-lock-find-unindented-line-limit t)
nil
(0 rst-literal-face append)))
;; FIXME: `Quoted Literal Blocks`_ missing.
;; This is multiline.
;; `Doctest Blocks`_
;; FIXME: This is wrong according to the specification:
;;
;; Doctest blocks are text blocks which begin with ">>> ", the Python
;; interactive interpreter main prompt, and end with a blank line.
;; Doctest blocks are treated as a special case of literal blocks,
;; without requiring the literal block syntax. If both are present, the
;; literal block syntax takes priority over Doctest block syntax:
;;
;; This is an ordinary paragraph.
;;
;; >>> print 'this is a Doctest block'
;; this is a Doctest block
;;
;; The following is a literal block::
;;
;; >>> This is not recognized as a doctest block by
;; reStructuredText. It *will* be recognized by the doctest
;; module, though!
;;
;; Indentation is not required for doctest blocks.
(,(rst-re 'lin-beg '(:grp (:alt ">>>" ell-tag)) '(:grp ".+"))
(1 rst-block-face)
(2 rst-literal-face)))
"Keywords to highlight in rst mode.")
(defvar font-lock-beg)
(defvar font-lock-end)
(defun rst-font-lock-extend-region ()
"Extend the font-lock region if it might be in a multi-line construct.
Return non-nil if so. Font-lock region is from `font-lock-beg'
to `font-lock-end'."
(let ((r (rst-font-lock-extend-region-internal font-lock-beg font-lock-end)))
(when r
(setq font-lock-beg (car r))
(setq font-lock-end (cdr r))
t)))
(defun rst-font-lock-extend-region-internal (beg end)
"Check the region BEG / END for being in the middle of a multi-line construct.
Return nil if not or a cons with new values for BEG / END"
(let ((nbeg (rst-font-lock-extend-region-extend beg -1))
(nend (rst-font-lock-extend-region-extend end 1)))
(if (or nbeg nend)
(cons (or nbeg beg) (or nend end)))))
(defun rst-forward-line (&optional n)
"Like `forward-line' but always end up in column 0 and return accordingly.
Move N lines forward just as `forward-line'."
(let ((moved (forward-line n)))
(if (bolp)
moved
(forward-line 0)
(- moved (rst-signum n)))))
;; FIXME: If a single line is made a section header by `rst-adjust' the header
;; is not always fontified immediately.
(defun rst-font-lock-extend-region-extend (pt dir)
"Extend the region starting at point PT and extending in direction DIR.
Return extended point or nil if not moved."
;; There are many potential multiline constructs but there are two groups
;; which are really relevant. The first group consists of
;;
;; * comment lines without leading explicit markup tag and
;;
;; * literal blocks following "::"
;;
;; which are both indented. Thus indentation is the first thing recognized
;; here. The second criteria is an explicit markup tag which may be a comment
;; or a double colon at the end of a line.
;;
;; The second group consists of the adornment cases.
(if (not (get-text-property pt 'font-lock-multiline))
;; Move only if we don't start inside a multiline construct already.
(save-excursion
(let (;; Non-empty non-indented line, explicit markup tag or literal
;; block tag.
(stop-re (rst-re '(:alt "[^ \t\n]"
(:seq hws-tag exm-tag)
(:seq ".*" dcl-tag lin-end)))))
;; The comments below are for dir == -1 / dir == 1.
(goto-char pt)
(forward-line 0)
(setq pt (point))
(while (and (not (looking-at stop-re))
(zerop (rst-forward-line dir)))) ; try previous / next
; line if it exists.
(if (looking-at (rst-re 'ado-beg-2-1)) ; may be an underline /
; overline.
(if (zerop (rst-forward-line dir))
(if (looking-at (rst-re 'ttl-beg)) ; title found, i.e.
; underline / overline
; found.
(if (zerop (rst-forward-line dir))
(if (not
(looking-at (rst-re 'ado-beg-2-1))) ; no
; overline /
; underline.
(rst-forward-line (- dir)))) ; step back to title
; / adornment.
(if (< dir 0) ; keep downward adornment.
(rst-forward-line (- dir))))) ; step back to adornment.
(if (looking-at (rst-re 'ttl-beg)) ; may be a title.
(if (zerop (rst-forward-line dir))
(if (not
(looking-at (rst-re 'ado-beg-2-1))) ; no overline /
; underline.
(rst-forward-line (- dir)))))) ; step back to line.
(if (not (= (point) pt))
(point))))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Indented blocks
(defun rst-forward-indented-block (&optional column limit)
"Move forward across one indented block.
Find the next non-empty line which is not indented at least to COLUMN (defaults
to the column of the point). Moves point to first character of this line or the
first empty line immediately before it and returns that position. If there is
no such line before LIMIT (defaults to the end of the buffer) returns nil and
point is not moved."
(interactive)
(let ((clm (or column (current-column)))
(start (point))
fnd beg cand)
(if (not limit)
(setq limit (point-max)))
(save-match-data
(while (and (not fnd) (< (point) limit))
(forward-line 1)
(when (< (point) limit)
(setq beg (point))
(if (looking-at (rst-re 'lin-end))
(setq cand (or cand beg)) ; An empty line is a candidate.
(move-to-column clm)
;; FIXME: No indentation [(zerop clm)] must be handled in some
;; useful way - though it is not clear what this should mean
;; at all.
(if (string-match
(rst-re 'linemp-tag)
(buffer-substring-no-properties beg (point)))
(setq cand nil) ; An indented line resets a candidate.
(setq fnd (or cand beg)))))))
(goto-char (or fnd start))
fnd))
(defvar rst-font-lock-find-unindented-line-begin nil
"Beginning of the match if `rst-font-lock-find-unindented-line-end'.")
(defvar rst-font-lock-find-unindented-line-end nil
"End of the match as determined by `rst-font-lock-find-unindented-line-limit'.
Also used as a trigger for
`rst-font-lock-find-unindented-line-match'.")
(defun rst-font-lock-find-unindented-line-limit (ind-pnt)
"Find the next unindented line relative to indentation at IND-PNT.
Return this point, the end of the buffer or nil if nothing found.
If IND-PNT is `next' take the indentation from the next line if
this is not empty and indented more than the current one. If
IND-PNT is non-nil but not a number take the indentation from the
next non-empty line if this is indented more than the current
one."
(setq rst-font-lock-find-unindented-line-begin ind-pnt)
(setq rst-font-lock-find-unindented-line-end
(save-excursion
(when (not (numberp ind-pnt))
;; Find indentation point in next line if any.
(setq ind-pnt
;; FIXME: Should be refactored to two different functions
;; giving their result to this function, may be
;; integrated in caller.
(save-match-data
(let ((cur-ind (current-indentation)))
(if (eq ind-pnt 'next)
(when (and (zerop (forward-line 1))
(< (point) (point-max)))
;; Not at EOF.
(setq rst-font-lock-find-unindented-line-begin
(point))
(when (and (not (looking-at (rst-re 'lin-end)))
(> (current-indentation) cur-ind))
;; Use end of indentation if non-empty line.
(looking-at (rst-re 'hws-tag))
(match-end 0)))
;; Skip until non-empty line or EOF.
(while (and (zerop (forward-line 1))
(< (point) (point-max))
(looking-at (rst-re 'lin-end))))
(when (< (point) (point-max))
;; Not at EOF.
(setq rst-font-lock-find-unindented-line-begin
(point))
(when (> (current-indentation) cur-ind)
;; Indentation bigger than line of departure.
(looking-at (rst-re 'hws-tag))
(match-end 0))))))))
(when ind-pnt
(goto-char ind-pnt)
(or (rst-forward-indented-block nil (point-max))
(point-max))))))
(defun rst-font-lock-find-unindented-line-match (limit)
"Set the match found earlier if match were found.
Match has been found by
`rst-font-lock-find-unindented-line-limit' the first time called
or no match is found. Return non-nil if match was found. LIMIT
is not used but mandated by the caller."
(when rst-font-lock-find-unindented-line-end
(set-match-data
(list rst-font-lock-find-unindented-line-begin
rst-font-lock-find-unindented-line-end))
(put-text-property rst-font-lock-find-unindented-line-begin
rst-font-lock-find-unindented-line-end
'font-lock-multiline t)
;; Make sure this is called only once.
(setq rst-font-lock-find-unindented-line-end nil)
t))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Adornments
(defvar rst-font-lock-adornment-level nil
"Storage for `rst-font-lock-handle-adornment-matcher'.
Either section level of the current adornment or t for a transition.")
(defun rst-adornment-level (key)
"Return section level for adornment KEY.
KEY is the first element of the return list of
`rst-classify-adornment'. If KEY is not a cons return it. If KEY is found
in the hierarchy return its level. Otherwise return a level one
beyond the existing hierarchy."
(if (not (consp key))
key
(let* ((hier (rst-get-hierarchy))
(char (car key))
(style (cdr key)))
(1+ (or (lexical-let ((char char)
(style style)
(hier hier)) ; Create closure.
(rst-position-if (lambda (elt)
(and (equal (car elt) char)
(equal (cadr elt) style))) hier))
(length hier))))))
(defvar rst-font-lock-adornment-match nil
"Storage for match for current adornment.
Set by `rst-font-lock-handle-adornment-pre-match-form'. Also used
as a trigger for `rst-font-lock-handle-adornment-matcher'.")
(defun rst-font-lock-handle-adornment-pre-match-form (ado ado-end)
"Determine limit for adornments.
Determine all things necessary for font-locking section titles
and transitions and put the result to
`rst-font-lock-adornment-match' and
`rst-font-lock-adornment-level'. ADO is the complete adornment
matched. ADO-END is the point where ADO ends. Return the point
where the whole adorned construct ends.
Called as a PRE-MATCH-FORM in the sense of `font-lock-keywords'."
(let ((ado-data (rst-classify-adornment ado ado-end)))
(if (not ado-data)
(setq rst-font-lock-adornment-level nil
rst-font-lock-adornment-match nil)
(setq rst-font-lock-adornment-level
(rst-adornment-level (car ado-data)))
(setq rst-font-lock-adornment-match (cdr ado-data))
(goto-char (nth 1 ado-data)) ; Beginning of construct.
(nth 2 ado-data)))) ; End of construct.
(defun rst-font-lock-handle-adornment-matcher (limit)
"Set the match found earlier if match were found.
Match has been found by
`rst-font-lock-handle-adornment-pre-match-form' the first time
called or no match is found. Return non-nil if match was found.
Called as a MATCHER in the sense of `font-lock-keywords'.
LIMIT is not used but mandated by the caller."
(let ((match rst-font-lock-adornment-match))
;; May run only once - enforce this.
(setq rst-font-lock-adornment-match nil)
(when match
(set-match-data match)
(goto-char (match-end 0))
(put-text-property (match-beginning 0) (match-end 0)
'font-lock-multiline t)
t)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Compilation
(defgroup rst-compile nil
"Settings for support of conversion of reStructuredText
document with \\[rst-compile]."
:group 'rst
:version "21.1")
(defcustom rst-compile-toolsets
`((html ,(if (executable-find "rst2html.py") "rst2html.py" "rst2html")
".html" nil)
(latex ,(if (executable-find "rst2latex.py") "rst2latex.py" "rst2latex")
".tex" nil)
(newlatex ,(if (executable-find "rst2newlatex.py") "rst2newlatex.py"
"rst2newlatex")
".tex" nil)
(pseudoxml ,(if (executable-find "rst2pseudoxml.py") "rst2pseudoxml.py"
"rst2pseudoxml")
".xml" nil)
(xml ,(if (executable-find "rst2xml.py") "rst2xml.py" "rst2xml")
".xml" nil)
(pdf ,(if (executable-find "rst2pdf.py") "rst2pdf.py" "rst2pdf")
".pdf" nil)
(s5 ,(if (executable-find "rst2s5.py") "rst2s5.py" "rst2s5")
".html" nil))
"Table describing the command to use for each tool-set.
An association list of the tool-set to a list of the (command to use,
extension of produced filename, options to the tool (nil or a
string)) to be used for converting the document."
;; FIXME: These are not options but symbols which may be referenced by
;; `rst-compile-*-toolset` below. The `:validate' keyword of
;; `defcustom' may help to define this properly in newer Emacs
;; versions (> 23.1).
:type '(alist :options (html latex newlatex pseudoxml xml pdf s5)
:key-type symbol
:value-type (list :tag "Specification"
(file :tag "Command")
(string :tag "File extension")
(choice :tag "Command options"
(const :tag "No options" nil)
(string :tag "Options"))))
:group 'rst
:package-version "1.2.0")
(rst-testcover-defcustom)
;; FIXME: Must be `defcustom`.
(defvar rst-compile-primary-toolset 'html
"The default tool-set for `rst-compile'.")
;; FIXME: Must be `defcustom`.
(defvar rst-compile-secondary-toolset 'latex
"The default tool-set for `rst-compile' with a prefix argument.")
(defun rst-compile-find-conf ()
"Look for the configuration file in the parents of the current path."
(interactive)
(let ((file-name "docutils.conf")
(buffer-file (buffer-file-name)))
;; Move up in the dir hierarchy till we find a change log file.
(let* ((dir (file-name-directory buffer-file))
(prevdir nil))
(while (and (or (not (string= dir prevdir))
(setq dir nil)
nil)
(not (file-exists-p (concat dir file-name))))
;; Move up to the parent dir and try again.
(setq prevdir dir)
(setq dir (expand-file-name (file-name-directory
(directory-file-name
(file-name-directory dir))))))
(or (and dir (concat dir file-name)) nil))))
(require 'compile)
(defun rst-compile (&optional use-alt)
"Compile command to convert reST document into some output file.
Attempts to find configuration file, if it can, overrides the
options. There are two commands to choose from, with USE-ALT,
select the alternative tool-set."
(interactive "P")
;; Note: maybe we want to check if there is a Makefile too and not do anything
;; if that is the case. I dunno.
(let* ((toolset (cdr (assq (if use-alt
rst-compile-secondary-toolset
rst-compile-primary-toolset)
rst-compile-toolsets)))
(command (car toolset))
(extension (cadr toolset))
(options (caddr toolset))
(conffile (rst-compile-find-conf))
(bufname (file-name-nondirectory buffer-file-name))
(outname (file-name-sans-extension bufname)))
;; Set compile-command before invocation of compile.
(set (make-local-variable 'compile-command)
(mapconcat 'identity
(list command
(or options "")
(if conffile
(concat "--config=" (shell-quote-argument conffile))
"")
(shell-quote-argument bufname)
(shell-quote-argument (concat outname extension)))
" "))
;; Invoke the compile command.
(if (or compilation-read-command use-alt)
(call-interactively 'compile)
(compile compile-command))))
(defun rst-compile-alt-toolset ()
"Compile command with the alternative tool-set."
(interactive)
(rst-compile t))
(defun rst-compile-pseudo-region ()
"Show pseudo-XML rendering.
Rendering is done of the current active region, or of the entire
buffer, if the region is not selected."
;; FIXME: The region should be given interactively.
(interactive)
(with-output-to-temp-buffer "*pseudoxml*"
(shell-command-on-region
(if mark-active (region-beginning) (point-min))
(if mark-active (region-end) (point-max))
(cadr (assq 'pseudoxml rst-compile-toolsets))
standard-output)))
;; FIXME: Should be `defcustom`.
(defvar rst-pdf-program "xpdf"
"Program used to preview PDF files.")
(defun rst-compile-pdf-preview ()
"Convert the document to a PDF file and launch a preview program."
(interactive)
(let* ((tmp-filename (make-temp-file "rst_el" nil ".pdf"))
(command (format "%s %s %s && %s %s ; rm %s"
(cadr (assq 'pdf rst-compile-toolsets))
buffer-file-name tmp-filename
rst-pdf-program tmp-filename tmp-filename)))
(start-process-shell-command "rst-pdf-preview" nil command)
;; Note: you could also use (compile command) to view the compilation
;; output.
))
;; FIXME: Should be `defcustom` or use something like `browse-url`.
(defvar rst-slides-program "sensible-browser"
"Program used to preview S5 slides.")
(defun rst-compile-slides-preview ()
"Convert the document to an S5 slide presentation and launch a preview program."
(interactive)
(let* ((tmp-filename (make-temp-file "rst_el" nil ".html"))
(command (format "%s %s %s && %s %s ; rm %s"
(cadr (assq 's5 rst-compile-toolsets))
buffer-file-name tmp-filename
rst-slides-program tmp-filename tmp-filename)))
(start-process-shell-command "rst-slides-preview" nil command)
;; Note: you could also use (compile command) to view the compilation
;; output.
))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Imenu support.
;; FIXME: Integrate this properly. Consider a key binding.
;; Based on code from Masatake YAMATO <yamato@redhat.com>.
(defun rst-imenu-find-adornments-for-position (adornments pos)
"Find adornments cell in ADORNMENTS for position POS."
(let ((a nil))
(while adornments
(if (and (car adornments)
(eq (car (car adornments)) pos))
(setq a adornments
adornments nil)
(setq adornments (cdr adornments))))
a))
(defun rst-imenu-convert-cell (elt adornments)
"Convert a cell ELT in a tree returned from `rst-section-tree' to imenu index.
ADORNMENTS is used as hint information for conversion."
(let* ((kar (car elt))
(kdr (cdr elt))
(title (car kar)))
(if kar
(let* ((p (marker-position (cadr kar)))
(adornments
(rst-imenu-find-adornments-for-position adornments p))
(a (car adornments))
(adornments (cdr adornments))
;; FIXME: Overline adornment characters need to be in front so
;; they become visible even for long title lines. May be
;; an additional level number is also useful.
(title (format "%s%s%s"
(make-string (1+ (nth 3 a)) (nth 1 a))
title
(if (eq (nth 2 a) 'simple)
""
(char-to-string (nth 1 a))))))
(cons title
(if (null kdr)
p
(cons
;; A bit ugly but this make which-func happy.
(cons title p)
(mapcar (lambda (elt0)
(rst-imenu-convert-cell elt0 adornments))
kdr)))))
nil)))
;; FIXME: Document title and subtitle need to be handled properly. They should
;; get an own "Document" top level entry.
(defun rst-imenu-create-index ()
"Create index for imenu.
Return as described for `imenu--index-alist'."
(rst-reset-section-caches)
(let ((tree (rst-section-tree))
;; Translate line notation to point notation.
(adornments (save-excursion
(mapcar (lambda (ln-ado)
(cons (progn
(goto-char (point-min))
(forward-line (1- (car ln-ado)))
;; FIXME: Need to consider
;; `imenu-use-markers' here?
(point))
(cdr ln-ado)))
(rst-find-all-adornments)))))
(delete nil (mapcar (lambda (elt)
(rst-imenu-convert-cell elt adornments))
tree))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Generic text functions that are more convenient than the defaults.
;; FIXME: Unbound command - should be bound or removed.
(defun rst-replace-lines (fromchar tochar)
"Replace flush-left lines of FROMCHAR with equal-length lines of TOCHAR."
(interactive "\
cSearch for flush-left lines of char:
cand replace with char: ")
(save-excursion
(let ((searchre (rst-re "^" fromchar "+\\( *\\)$"))
(found 0))
(while (search-forward-regexp searchre nil t)
(setq found (1+ found))
(goto-char (match-beginning 1))
(let ((width (current-column)))
(rst-delete-entire-line)
(insert-char tochar width)))
(message (format "%d lines replaced." found)))))
;; FIXME: Unbound command - should be bound or removed.
(defun rst-join-paragraph ()
"Join lines in current paragraph into one line, removing end-of-lines."
(interactive)
(let ((fill-column 65000)) ; Some big number.
(call-interactively 'fill-paragraph)))
;; FIXME: Unbound command - should be bound or removed.
(defun rst-force-fill-paragraph ()
"Fill paragraph at point, first joining the paragraph's lines into one.
This is useful for filling list item paragraphs."
(interactive)
(rst-join-paragraph)
(fill-paragraph nil))
;; FIXME: Unbound command - should be bound or removed.
;; Generic character repeater function.
;; For sections, better to use the specialized function above, but this can
;; be useful for creating separators.
(defun rst-repeat-last-character (use-next)
"Fill the current line using the last character on the current line.
Fill up to the length of the preceding line or up to
`fill-column' if preceding line is empty.
If USE-NEXT, use the next line rather than the preceding line.
If the current line is longer than the desired length, shave the characters off
the current line to fit the desired length.
As an added convenience, if the command is repeated immediately, the alternative
column is used (fill-column vs. end of previous/next line)."
(interactive "P")
(let* ((curcol (current-column))
(curline (+ (count-lines (point-min) (point))
(if (zerop curcol) 1 0)))
(lbp (line-beginning-position 0))
(prevcol (if (and (= curline 1) (not use-next))
fill-column
(save-excursion
(forward-line (if use-next 1 -1))
(end-of-line)
(skip-chars-backward " \t" lbp)
(let ((cc (current-column)))
(if (zerop cc) fill-column cc)))))
(rightmost-column
(cond ((equal last-command 'rst-repeat-last-character)
(if (= curcol fill-column) prevcol fill-column))
(t (save-excursion
(if (zerop prevcol) fill-column prevcol))))))
(end-of-line)
(if (> (current-column) rightmost-column)
;; Shave characters off the end.
(delete-region (- (point)
(- (current-column) rightmost-column))
(point))
;; Fill with last characters.
(insert-char (preceding-char)
(- rightmost-column (current-column))))))
;; LocalWords: docutils http sourceforge rst html wp svn svnroot txt reST regex
;; LocalWords: regexes alist seq alt grp keymap abbrev overline overlines toc
;; LocalWords: XML PNT propertized
;; Local Variables:
;; sentence-end-double-space: t
;; End:
(provide 'rst)
;;; rst.el ends here
|