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
|
;;; tex-mode.el --- TeX, LaTeX, and SliTeX mode commands -*- lexical-binding:t -*-
;; Copyright (C) 1985-1986, 1989, 1992, 1994-1999, 2001-2025 Free
;; Software Foundation, Inc.
;; Maintainer: emacs-devel@gnu.org
;; Keywords: tex
;; Contributions over the years by William F. Schelter, Dick King,
;; Stephen Gildea, Michael Prange, Jacob Gore, and Edward M. Reingold.
;; 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 <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(eval-when-compile
(require 'compare-w)
(require 'cl-lib)
(require 'skeleton))
(require 'shell)
(require 'compile)
(defgroup tex-file nil
"TeX files and directories."
:prefix "tex-"
:group 'tex)
(defgroup tex-run nil
"Running external commands from TeX mode."
:prefix "tex-"
:group 'tex)
(defgroup tex-view nil
"Viewing and printing TeX files."
:prefix "tex-"
:group 'tex)
(defgroup tex-flymake nil
"Flymake backend for linting TeX files."
:prefix "tex-"
:group 'tex)
;;;###autoload
(defcustom tex-shell-file-name nil
"If non-nil, the shell file name to run in the subshell used to run TeX."
:type '(choice (const :tag "None" nil)
string)
:group 'tex-run)
;;;###autoload
(defcustom tex-directory (purecopy ".")
"Directory in which temporary files are written.
You can make this `/tmp' if your TEXINPUTS has no relative directories in it
and you don't try to apply \\[tex-region] or \\[tex-buffer] when there are
`\\input' commands with relative directories."
:type 'directory
:group 'tex-file)
;;;###autoload
(defcustom tex-first-line-header-regexp nil
"Regexp for matching a first line which `tex-region' should include.
If this is non-nil, it should be a regular expression string;
if it matches the first line of the file,
`tex-region' always includes the first line in the TeX run."
:type '(choice (const :tag "None" nil)
regexp)
:group 'tex-file)
;;;###autoload
(defcustom tex-main-file nil
"The main TeX source file which includes this buffer's file.
The command `tex-file' runs TeX on the file specified by `tex-main-file'
if the variable is non-nil."
:type '(choice (const :tag "None" nil)
file)
:group 'tex-file)
;;;###autoload
(defcustom tex-offer-save t
"If non-nil, ask about saving modified buffers before \\[tex-file] is run."
:type 'boolean
:group 'tex-file)
;;;###autoload
(defcustom tex-run-command (purecopy "tex")
"Command used to run TeX subjob.
TeX Mode sets `tex-command' to this string.
See the documentation of that variable."
:type 'string
:group 'tex-run)
;;;###autoload
(defcustom latex-run-command (purecopy "latex")
"Command used to run LaTeX subjob.
LaTeX Mode sets `tex-command' to this string.
See the documentation of that variable."
:type 'string
:group 'tex-run)
;;;###autoload
(defcustom slitex-run-command (purecopy "slitex")
"Command used to run SliTeX subjob.
SliTeX Mode sets `tex-command' to this string.
See the documentation of that variable."
:type 'string
:group 'tex-run)
;;;###autoload
(defcustom tex-start-options (purecopy "")
"TeX options to use when starting TeX.
These immediately precede the commands in `tex-start-commands'
and the input file name, with no separating space and are not shell-quoted.
If nil, TeX runs with no options. See the documentation of `tex-command'."
:type 'string
:group 'tex-run
:version "22.1")
;;;###autoload
(defcustom tex-start-commands (purecopy "\\nonstopmode\\input")
"TeX commands to use when starting TeX.
They are shell-quoted and precede the input file name, with a separating space.
If nil, no commands are used. See the documentation of `tex-command'."
:type '(radio (const :tag "Interactive (nil)" nil)
(const :tag "Nonstop (\"\\nonstopmode\\input\")"
"\\nonstopmode\\input")
(string :tag "String at your choice"))
:group 'tex-run
:version "22.1")
(defvar latex-standard-block-names
'("abstract" "array" "center" "description"
"displaymath" "document" "enumerate" "eqnarray"
"eqnarray*" "equation" "figure" "figure*"
"flushleft" "flushright" "itemize" "letter"
"list" "minipage" "picture" "quotation"
"quote" "slide" "sloppypar" "tabbing"
"table" "table*" "tabular" "tabular*"
"thebibliography" "theindex*" "titlepage" "trivlist"
"verbatim" "verbatim*" "verse" "math")
"Standard LaTeX block names.")
;;;###autoload
(defcustom latex-block-names nil
"User defined LaTeX block names.
Combined with `latex-standard-block-names' for minibuffer completion."
:type '(repeat string)
:group 'tex-run)
;;;###autoload
(defcustom tex-bibtex-command (purecopy "bibtex")
"Command used by `tex-bibtex-file' to gather bibliographic data.
If this string contains an asterisk (`*'), that is replaced by the file name;
otherwise, the file name, preceded by blank, is added at the end."
:type 'string
:group 'tex-run)
;;;###autoload
(defcustom tex-dvi-print-command (purecopy "lpr -d")
"Command used by \\[tex-print] to print a .dvi file.
If this string contains an asterisk (`*'), that is replaced by the file name;
otherwise, the file name, preceded by blank, is added at the end."
:type 'string
:group 'tex-view)
;;;###autoload
(defcustom tex-alt-dvi-print-command (purecopy "lpr -d")
"Command used by \\[tex-print] with a prefix arg to print a .dvi file.
If this string contains an asterisk (`*'), that is replaced by the file name;
otherwise, the file name, preceded by blank, is added at the end.
If two printers are not enough of a choice, you can set the variable
`tex-alt-dvi-print-command' to an expression that asks what you want;
for example,
(setq tex-alt-dvi-print-command
\\='(format \"lpr -P%s\" (read-string \"Use printer: \")))
would tell \\[tex-print] with a prefix argument to ask you which printer to
use."
:type '(choice (string :tag "Command")
(sexp :tag "Expression"))
:group 'tex-view)
;;;###autoload
(defcustom tex-dvi-view-command
`(cond
((eq window-system 'x) ,(purecopy "xdvi"))
((eq window-system 'w32) ,(purecopy "yap"))
(t ,(purecopy "dvi2tty * | cat -s")))
"Command used by \\[tex-view] to display a `.dvi' file.
If it is a string, that specifies the command directly.
If this string contains an asterisk (`*'), that is replaced by the file name;
otherwise, the file name, preceded by a space, is added at the end.
If the value is a form, it is evaluated to get the command to use."
:type '(choice (const nil) string sexp)
:group 'tex-view)
;;;###autoload
(defcustom tex-show-queue-command (purecopy "lpq")
"Command used by \\[tex-show-print-queue] to show the print queue.
Should show the queue(s) that \\[tex-print] puts jobs on."
:type 'string
:group 'tex-view)
;;;###autoload
(defcustom tex-default-mode #'latex-mode
"Mode to enter for a new file that might be either TeX or LaTeX.
This variable is used when it can't be determined whether the file
is plain TeX or LaTeX or what because the file contains no commands.
Normally set to either `plain-tex-mode' or `latex-mode'."
:type 'function
:group 'tex)
;;;###autoload
(defcustom tex-open-quote (purecopy "``")
"String inserted by typing \\[tex-insert-quote] to open a quotation."
:type 'string
:options '("``" "\"<" "\"`" "<<" "«")
:group 'tex)
;;;###autoload
(defcustom tex-close-quote (purecopy "''")
"String inserted by typing \\[tex-insert-quote] to close a quotation."
:type 'string
:options '("''" "\">" "\"'" ">>" "»")
:group 'tex)
(defcustom tex-fontify-script t
"If non-nil, fontify subscript and superscript strings."
:type 'boolean
:safe #'booleanp
:group 'tex
:version "23.1")
(defcustom tex-font-script-display '(-0.2 0.2)
"How much to lower and raise subscript and superscript content.
This is a list of two floats. The first is negative and
specifies how much subscript is lowered, the second is positive
and specifies how much superscript is raised. Heights are
measured relative to that of the normal text."
:group 'tex
:type '(list (float :tag "Subscript")
(float :tag "Superscript"))
:version "23.1")
(defcustom tex-chktex-program "chktex"
"ChkTeX executable to use for linting TeX files."
:version "26.1"
:type 'string
:link '(url-link "man:chktex(1)")
:group 'tex-flymake)
(defcustom tex-chktex-extra-flags nil
"Extra command line flags for `tex-chktex-program'."
:version "26.1"
:type '(repeat string)
:group 'tex-flymake)
(defvar tex-last-temp-file nil
"Latest temporary file generated by \\[tex-region] and \\[tex-buffer].
Deleted when the \\[tex-region] or \\[tex-buffer] is next run, or when the
tex shell terminates.")
(defvar tex-command "tex"
"Command to run TeX.
If this string contains an asterisk \(`*'), that is replaced by the file name;
otherwise the value of `tex-start-options', the \(shell-quoted)
value of `tex-start-commands', and the file name are added at the end
with blanks as separators.
In TeX, LaTeX, and SliTeX Mode this variable becomes buffer local.")
(defvar tex-trailer nil
"String appended after the end of a region sent to TeX by \\[tex-region].")
(defvar tex-start-of-header nil
"Regular expression used by \\[tex-region] to find start of file's header.")
(defvar tex-end-of-header nil
"Regular expression used by \\[tex-region] to find end of file's header.")
(defvar tex-shell-cd-command "cd"
"Command to give to shell running TeX to change directory.
The value of `tex-directory' is appended to this, separated by a space.")
(defvar tex-zap-file nil
"Temporary file name used for text being sent as input to TeX.
Should be a simple file name with no extension or directory specification.")
(defvar tex-last-buffer-texed nil
"Buffer which was last TeXed.")
(defvar tex-print-file nil
"File name that \\[tex-print] prints.
Set by \\[tex-region], \\[tex-buffer], and \\[tex-file].")
(defvar tex-mode-syntax-table
(let ((st (make-syntax-table)))
(modify-syntax-entry ?% "<" st)
(modify-syntax-entry ?\n ">" st)
(modify-syntax-entry ?\f ">" st)
(modify-syntax-entry ?\C-@ "w" st)
(modify-syntax-entry ?' "w" st)
(modify-syntax-entry ?@ "_" st)
(modify-syntax-entry ?* "_" st)
(modify-syntax-entry ?\t " " st)
;; ~ is printed by TeX as a space, but it's semantics in the syntax
;; of TeX is not `whitespace' (i.e. it's just like \hspace{foo}).
(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)
st)
"Syntax table used while in TeX mode.")
;;;;
;;;; Imenu support
;;;;
(defcustom latex-imenu-indent-string ". "
"String to add repeated in front of nested sectional units for Imenu.
An alternative value is \" . \", if you use a font with a narrow period."
:type 'string
:group 'tex)
(defvar latex-section-alist
'(("part" . 0) ("chapter" . 1)
("section" . 2) ("subsection" . 3)
("subsubsection" . 4)
("paragraph" . 5) ("subparagraph" . 6)))
(defvar latex-metasection-list
'("documentstyle" "documentclass"
"begin{document}" "end{document}"
"appendix" "frontmatter" "mainmatter" "backmatter"))
(defun latex-imenu-create-index ()
"Generate an alist for imenu from a LaTeX buffer."
(let ((section-regexp
(concat "\\\\" (regexp-opt (mapcar #'car latex-section-alist) t)
"\\*?[ \t]*{"))
(metasection-regexp
(concat "\\\\" (regexp-opt latex-metasection-list t)))
i0 menu case-fold-search)
(save-excursion
;; Find the top-most level in this file but don't allow it to be
;; any deeper than "section" (which is top-level in an article).
(goto-char (point-min))
(if (search-forward-regexp "\\\\part\\*?[ \t]*{" nil t)
(setq i0 0)
(if (search-forward-regexp "\\\\chapter\\*?[ \t]*{" nil t)
(setq i0 1)
(setq i0 2)))
;; Look for chapters and sections.
(goto-char (point-min))
(while (search-forward-regexp section-regexp nil t)
(let ((start (match-beginning 0))
(here (point))
(i (cdr (assoc (buffer-substring-no-properties
(match-beginning 1)
(match-end 1))
latex-section-alist))))
(backward-char 1)
(condition-case nil
(progn
;; Using sexps allows some use of matching {...} inside
;; titles.
(forward-sexp 1)
(push (cons (concat (apply #'concat
(make-list
(max 0 (- i i0))
latex-imenu-indent-string))
(buffer-substring-no-properties
here (1- (point))))
start)
menu))
(error nil))))
;; Look for included material.
(goto-char (point-min))
(while (search-forward-regexp
"\\\\\\(include\\|input\\|verbatiminput\\|bibliography\\)\
[ \t]*{\\([^}\n]+\\)}"
nil t)
(push (cons (concat "<<" (buffer-substring-no-properties
(match-beginning 2)
(match-end 2))
(if (= (char-after (match-beginning 1)) ?b)
".bbl"
".tex"))
(match-beginning 0))
menu))
;; Look for \frontmatter, \mainmatter, \backmatter, and \appendix.
(goto-char (point-min))
(while (search-forward-regexp metasection-regexp nil t)
(push (cons "--" (match-beginning 0)) menu))
;; Sort in increasing buffer position order.
(sort menu (lambda (a b) (< (cdr a) (cdr b)))))))
;;;;
;;;; Outline support
;;;;
(defvar latex-outline-regexp
(concat "\\\\"
(regexp-opt (append latex-metasection-list
(mapcar #'car latex-section-alist))
t)))
(defun latex-outline-level ()
(if (looking-at latex-outline-regexp)
(1+ (or (cdr (assoc (match-string 1) latex-section-alist)) -1))
1000))
(defun tex-current-defun-name ()
"Return the name of the TeX section/paragraph/chapter at point, or nil."
(save-excursion
(when (re-search-backward
"\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)"
nil t)
(goto-char (match-beginning 0))
(buffer-substring-no-properties
(1+ (point)) ; without initial backslash
(line-end-position)))))
;;;;
;;;; Font-Lock support
;;;;
;(defvar tex-font-lock-keywords
; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
; 2 font-lock-function-name-face)
; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
; 2 font-lock-constant-face)
; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
; ;; not be able to display those fonts.
; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
; ("^[ \t\n]*\\\\def[\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
; ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
; 2 font-lock-function-name-face)
; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
; 2 font-lock-constant-face)
; ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
; "\\\\\\([a-zA-Z@]+\\|.\\)"
; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
; ;; not be able to display those fonts.
; ;; LaTeX2e: \emph{This is emphasized}.
; ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
; ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
; ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
; 3 (if (match-beginning 2) 'bold 'italic) keep)
; ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
; ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
; 3 (if (match-beginning 2) 'bold 'italic) keep))
;; Rewritten with the help of Alexandra Bac <abac@welcome.disi.unige.it>.
(defconst tex-font-lock-keywords-1
(eval-when-compile
(let* (;; Names of commands whose arg should be fontified as heading, etc.
(headings (regexp-opt
'("title" "begin" "end" "chapter" "part"
"section" "subsection" "subsubsection"
"paragraph" "subparagraph" "subsubparagraph"
"newcommand" "renewcommand" "providecommand"
"newenvironment" "renewenvironment"
"newtheorem" "renewtheorem")
t))
(variables (regexp-opt
'("newcounter" "newcounter*" "setcounter" "addtocounter"
"setlength" "addtolength" "settowidth")
t))
(includes (regexp-opt
'("input" "include" "includeonly" "bibliography"
"epsfig" "psfig" "epsf" "nofiles" "usepackage"
"documentstyle" "documentclass" "verbatiminput"
"includegraphics" "includegraphics*")
t))
(verbish (regexp-opt '("url" "nolinkurl" "path"
"href" "ProvidesFile")
t))
;; Miscellany.
(slash "\\\\")
(opt " *\\(\\[[^]]*\\] *\\)*")
;; This would allow highlighting \newcommand\CMD but requires
;; adapting subgroup numbers below.
;; (arg "\\(?:{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)\\|\\\\[a-z*]+\\)"))
(inbraces-re
(lambda (n) ;; Level of nesting of braces we should support.
(let ((re "[^}]"))
(dotimes (_ n)
(setq re
(concat "\\(?:[^{}\\]\\|\\\\.\\|{" re "*}\\)")))
re)))
(arg (concat "{\\(" (funcall inbraces-re 2) "+\\)")))
`(;; Verbatim-like args.
;; Do it first, because we don't want to highlight them
;; in comments (bug#68827), but we do want to highlight them
;; in $math$.
(,(concat slash verbish opt arg) 3 'tex-verbatim keep)
;; Highlight $$math$$ and $math$.
;; This is done at the very beginning so as to interact with the other
;; keywords in the same way as comments and strings.
(,(concat "\\$\\$?\\(?:[^$\\{}]\\|\\\\.\\|{"
(funcall inbraces-re 6)
"*}\\)+\\$?\\$")
(0 'tex-math keep))
;; Heading args.
(,(concat slash headings "\\*?" opt arg)
;; If ARG ends up matching too much (if the {} don't match, e.g.)
;; jit-lock will do funny things: when updating the buffer
;; the re-highlighting is only done locally so it will just
;; match the local line, but defer-contextually will
;; match more lines at a time, so ARG will end up matching
;; a lot more, which might suddenly include a comment
;; so you get things highlighted bold when you type them
;; but they get turned back to normal a little while later
;; because "there's already a face there".
;; Using `keep' works around this un-intuitive behavior as well
;; as improves the behavior in the very rare case where you do
;; have a comment in ARG.
3 font-lock-function-name-face keep)
(,(concat slash "\\(?:provide\\|\\(?:re\\)?new\\)command\\** *\\(\\\\[A-Za-z@]+\\)")
1 font-lock-function-name-face keep)
;; Variable args.
(,(concat slash variables " *" arg) 2 font-lock-variable-name-face)
;; Include args.
(,(concat slash includes opt arg) 3 font-lock-builtin-face)
;; Definitions. I think.
("^[ \t]*\\\\def *\\\\\\(\\(\\w\\|@\\)+\\)"
1 font-lock-function-name-face))))
"Subdued expressions to highlight in TeX modes.")
(defun tex-font-lock-append-prop (prop)
(unless (memq (get-text-property (match-end 1) 'face)
'(font-lock-comment-face tex-verbatim))
prop))
(defconst tex-font-lock-keywords-2
(append tex-font-lock-keywords-1
(eval-when-compile
(let* (;;
;; Names of commands whose arg should be fontified with fonts.
(bold (regexp-opt '("textbf" "textsc" "textup"
"boldsymbol" "pmb")
t))
(italic (regexp-opt '("textit" "textsl" "emph") t))
;; FIXME: unimplemented yet.
;; (type (regexp-opt '("texttt" "textmd" "textrm" "textsf") t))
;;
;; Names of commands whose arg should be fontified as a citation.
(citations (regexp-opt
'("label" "ref" "pageref" "vref" "eqref"
"cite" "nocite" "index" "glossary" "bibitem"
;; natbib's two variants of \cite:
"citep" "citet"
;; These are text, rather than citations.
;; "caption" "footnote" "footnotemark" "footnotetext"
)
t))
;;
;; Names of commands that should be fontified.
(specials-1 (regexp-opt '("\\" "\\*") t)) ;; "-"
(specials-2 (regexp-opt
'("linebreak" "nolinebreak" "pagebreak" "nopagebreak"
"newline" "newpage" "clearpage" "cleardoublepage"
"displaybreak" "allowdisplaybreaks"
"enlargethispage")
t))
(general "\\([a-zA-Z@]+\\**\\|[^ \t\n]\\)")
;;
;; Miscellany.
(slash "\\\\")
(opt " *\\(\\[[^]]*\\] *\\)*")
(args "\\(\\(?:[^${}&\\]+\\|\\\\.\\|{[^}]*}\\)+\\)")
(arg "{\\(\\(?:[^{}\\]+\\|\\\\.\\|{[^}]*}\\)+\\)"))
(list
;;
;; Citation args.
(list (concat slash citations opt arg) 3 'font-lock-constant-face)
;;
;; Text between `` quotes ''.
(list (concat (regexp-opt '("``" "\"<" "\"`" "<<" "«") t)
"\\(\\(.\\|\n\\)+?\\)"
(regexp-opt `("''" "\">" "\"'" ">>" "»") t))
'(1 'font-lock-keyword-face)
'(2 'font-lock-string-face)
'(4 'font-lock-keyword-face))
;;
;; Command names, special and general.
(cons (concat slash specials-1) 'font-lock-warning-face)
(list (concat "\\(" slash specials-2 "\\)\\([^a-zA-Z@]\\|\\'\\)")
'(1 'font-lock-warning-face))
(concat slash general)
;;
;; Font environments. It seems a bit dubious to use `bold' etc. faces
;; since we might not be able to display those fonts.
(list (concat slash bold " *" arg) 2
'(tex-font-lock-append-prop 'bold) 'append)
(list (concat slash italic " *" arg) 2
'(tex-font-lock-append-prop 'italic) 'append)
;; (list (concat slash type arg) 2 '(quote bold-italic) 'append)
;;
;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
(list (concat "\\\\\\(em\\|it\\|sl\\)\\>" args)
2 '(tex-font-lock-append-prop 'italic) 'append)
;; This is separate from the previous one because of cases like
;; {\em foo {\bf bar} bla} where both match.
(list (concat "\\\\\\(bf\\(series\\)?\\)\\>" args)
3 '(tex-font-lock-append-prop 'bold) 'append)))))
"Gaudy expressions to highlight in TeX modes.")
(defun tex-font-lock-suscript (pos)
(unless (or (memq (get-text-property pos 'face)
'(font-lock-constant-face font-lock-builtin-face
font-lock-comment-face tex-verbatim))
;; Check for backslash quoting
(let ((odd nil)
(pos pos))
(while (eq (char-before pos) ?\\)
(setq pos (1- pos) odd (not odd)))
odd))
(if (eq (char-after pos) ?_)
`(face subscript display (raise ,(car tex-font-script-display)))
`(face superscript display (raise ,(cadr tex-font-script-display))))))
(defun tex-font-lock-match-suscript (limit)
"Match subscript and superscript patterns up to LIMIT."
(when (and tex-fontify-script
(re-search-forward "[_^] *\\([^\n\\{}]\\|\
\\\\\\([a-zA-Z@]+\\|[^ \t\n]\\)\\|\\({\\)\\)" limit t))
(when (match-end 3)
(let ((beg (match-beginning 3))
(end (save-restriction
(narrow-to-region (point-min) limit)
(condition-case nil (scan-lists (point) 1 1) (error nil)))))
(store-match-data (if end
(list (match-beginning 0) end beg end)
(list beg beg beg beg)))))
t))
(defconst tex-font-lock-keywords-3
(append tex-font-lock-keywords-2
'((tex-font-lock-match-suscript
(1 (tex-font-lock-suscript (match-beginning 0)) append))))
"Experimental expressions to highlight in TeX modes.")
(defconst tex-font-lock-keywords tex-font-lock-keywords-1
"Default expressions to highlight in TeX modes.")
(defvar tex-verbatim-environments
'("verbatim" "verbatim*"
"Verbatim" ;; From "fancyvrb"
))
(put 'tex-verbatim-environments 'safe-local-variable
(lambda (x) (not (memq nil (mapcar #'stringp x)))))
(eval-when-compile
(defconst tex-syntax-propertize-rules
(syntax-propertize-precompile-rules
("\\\\verb\\**\\([^a-z@*]\\)"
(1 (prog1 "\""
(tex-font-lock-verb
(match-beginning 0) (char-after (match-beginning 1))))))))
(defconst latex-syntax-propertize-rules
(syntax-propertize-precompile-rules
tex-syntax-propertize-rules
("\\\\\\(?:end\\|begin\\) *\\({[^\n{}]*}\\)"
(1 (ignore
(tex-env-mark (match-beginning 0)
(match-beginning 1) (match-end 1))))))))
(defun tex-env-mark (cmd start end)
(when (= cmd (line-beginning-position))
(let ((arg (buffer-substring-no-properties (1+ start) (1- end))))
(when (member arg tex-verbatim-environments)
(if (eq ?b (char-after (1+ cmd)))
;; \begin
(put-text-property (line-end-position)
(line-beginning-position 2)
'syntax-table (string-to-syntax "< c"))
;; In the case of an empty verbatim env, the \n after the \begin is
;; the same as the \n before the \end. Lucky for us, the "> c"
;; property associated to the \end will be placed afterwards, so it
;; will override the "< c".
(put-text-property (1- cmd) cmd
'syntax-table (string-to-syntax "> c"))
;; The text between \end{verbatim} and \n is ignored, so we'll treat
;; it as a comment.
(put-text-property end (min (1+ end) (line-end-position))
'syntax-table (string-to-syntax "<"))))))
;; Mark env args for possible electric pairing.
(unless (get-char-property (1+ start) 'text-clones) ;Already paired-up.
(put-text-property start end 'latex-env-pair t)))
(define-minor-mode latex-electric-env-pair-mode
"Toggle Latex Electric Env Pair mode.
Latex Electric Env Pair mode is a buffer-local minor mode for use
with `latex-mode'. When enabled, typing a \\begin or \\end tag
automatically inserts its partner."
:lighter "/e"
(if latex-electric-env-pair-mode
(add-hook 'before-change-functions
#'latex-env-before-change nil 'local)
(remove-hook 'before-change-functions
#'latex-env-before-change 'local)))
(defun latex-env-before-change (start end)
(when (get-text-property start 'latex-env-pair)
(condition-case err
(with-silent-modifications
;; Remove properties even if don't find a pair.
(remove-list-of-text-properties
(previous-single-property-change (1+ start) 'latex-env-pair)
(next-single-property-change start 'latex-env-pair)
'(latex-env-pair))
(unless (or (get-char-property start 'text-clones)
(get-char-property (1+ start) 'text-clones)
(save-excursion
(goto-char start)
(not (re-search-backward
"\\\\\\(?:end\\|begi\\(n\\)\\) *{"
(line-beginning-position) t))))
(let ((cmd-start (match-beginning 0))
(type (match-end 1)) ;nil for \end, else \begin.
(arg-start (1- (match-end 0))))
(save-excursion
(goto-char (match-end 0))
(when (and (looking-at "[^\n{}]*}")
(> (match-end 0) end))
(let ((arg-end (match-end 0)))
(if (null type) ;\end
(progn (goto-char arg-end)
(latex-forward-sexp -1)
(forward-word-strictly 1))
(goto-char cmd-start)
(latex-forward-sexp 1)
(let (forward-sexp-function) (backward-sexp)))
(when (looking-at
(regexp-quote (buffer-substring arg-start arg-end)))
(text-clone-create arg-start arg-end))))))))
(scan-error nil)
(error (message "Error in latex-env-before-change: %S" err)))))
(defun tex-font-lock-unfontify-region (beg end)
(font-lock-default-unfontify-region beg end)
(while (< beg end)
(let ((next (next-single-property-change beg 'display nil end))
(prop (get-text-property beg 'display)))
(if (and (eq (car-safe prop) 'raise)
(member (car-safe (cdr prop)) tex-font-script-display)
(null (cddr prop)))
(put-text-property beg next 'display nil))
(setq beg next))))
(defcustom tex-suscript-height-ratio 0.8
"Ratio of subscript/superscript height to that of the preceding text.
In nested subscript/superscript, this factor is applied repeatedly,
subject to the limit set by `tex-suscript-height-minimum'."
:type 'float
:group 'tex
:version "23.1")
(defcustom tex-suscript-height-minimum 0.0
"Integer or float limiting the minimum size of subscript/superscript text.
An integer is an absolute height in units of 1/10 point, a float
is a height relative to that of the default font. Zero means no minimum."
:type '(choice (integer :tag "Integer height in 1/10 point units")
(float :tag "Fraction of default font height"))
:group 'tex
:version "23.1")
(defun tex-suscript-height (height)
"Return the integer height of subscript/superscript font in 1/10 points.
Not smaller than the value set by `tex-suscript-height-minimum'."
(ceiling (max (if (integerp tex-suscript-height-minimum)
tex-suscript-height-minimum
;; For bootstrapping.
(condition-case nil
(* tex-suscript-height-minimum
(face-attribute 'default :height))
(error 0)))
;; NB assumes height is integer.
(* height tex-suscript-height-ratio))))
(defface superscript
'((t :height tex-suscript-height)) ;; :raise 0.2
"Face used for superscripts."
:group 'tex)
(defface subscript
'((t :height tex-suscript-height)) ;; :raise -0.2
"Face used for subscripts."
:group 'tex)
(defface tex-math
'((t :inherit font-lock-string-face))
"Face used to highlight TeX math expressions."
:group 'tex)
(defface tex-verbatim
'((t :inherit fixed-pitch-serif))
"Face used to highlight TeX verbatim environments."
:group 'tex)
(defun tex-font-lock-verb (start delim)
"Place syntax table properties on the \\verb construct.
START is the position of the \\ and DELIM is the delimiter char."
;; Do nothing if the \verb construct is itself inside a comment or
;; verbatim env.
(unless (nth 8 (save-excursion (syntax-ppss start)))
;; Let's find the end and mark it.
(let ((afterdelim (point)))
(skip-chars-forward (string ?^ delim) (line-end-position))
(if (eolp)
;; "LaTeX Error: \verb ended by end of line."
;; Remove the syntax-table property we've just put on the
;; start-delimiter, so it doesn't spill over subsequent lines.
(put-text-property (1- afterdelim) afterdelim
'syntax-table nil)
(when (eq (char-syntax (preceding-char)) ?/)
(put-text-property (1- (point)) (point)
'syntax-table (string-to-syntax ".")))
(put-text-property (point) (1+ (point))
'syntax-table (string-to-syntax "\""))))))
;; Use string syntax but math face for $...$.
(defun tex-font-lock-syntactic-face-function (state)
(let ((char (nth 3 state)))
(cond
((not char)
(if (eq 2 (nth 7 state)) 'tex-verbatim 'font-lock-comment-face))
((eq char ?$) 'tex-math)
;; A \verb element.
(t 'tex-verbatim))))
(defun tex-define-common-keys (keymap)
"Define the keys that we want defined both in TeX mode and in the TeX shell."
(define-key keymap "\C-c\C-k" #'tex-kill-job)
(define-key keymap "\C-c\C-l" #'tex-recenter-output-buffer)
(define-key keymap "\C-c\C-q" #'tex-show-print-queue)
(define-key keymap "\C-c\C-p" #'tex-print)
(define-key keymap "\C-c\C-v" #'tex-view)
(define-key keymap [menu-bar tex] (cons "TeX" (make-sparse-keymap "TeX")))
(define-key keymap [menu-bar tex tex-kill-job]
'(menu-item "Tex Kill" tex-kill-job :enable (tex-shell-running)))
(define-key keymap [menu-bar tex tex-recenter-output-buffer]
'(menu-item "Tex Recenter" tex-recenter-output-buffer
:enable (get-buffer "*tex-shell*")))
(define-key keymap [menu-bar tex tex-show-print-queue]
'("Show Print Queue" . tex-show-print-queue))
(define-key keymap [menu-bar tex tex-alt-print]
'(menu-item "Tex Print (alt printer)" tex-alt-print
:enable (stringp tex-print-file)))
(define-key keymap [menu-bar tex tex-print]
'(menu-item "Tex Print" tex-print :enable (stringp tex-print-file)))
(define-key keymap [menu-bar tex tex-view]
'(menu-item "Tex View" tex-view :enable (stringp tex-print-file))))
(defvar tex-mode-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map text-mode-map)
(tex-define-common-keys map)
(define-key map "\"" #'tex-insert-quote)
(define-key map "\n" #'tex-handle-newline)
(define-key map "\M-\r" #'latex-insert-item)
(define-key map "\C-c}" #'up-list)
(define-key map "\C-c{" #'tex-insert-braces)
(define-key map "\C-c\C-r" #'tex-region)
(define-key map "\C-c\C-b" #'tex-buffer)
(define-key map "\C-c\C-f" #'tex-file)
(define-key map "\C-c\C-c" #'tex-compile)
(define-key map "\C-c\C-i" #'tex-bibtex-file)
(define-key map "\C-c\C-o" #'latex-insert-block)
;; Redundant keybindings, for consistency with SGML mode.
(define-key map "\C-c\C-t" #'latex-insert-block)
(define-key map "\C-c]" #'latex-close-block)
(define-key map "\C-c/" #'latex-close-block)
(define-key map "\C-c\C-e" #'latex-close-block)
(define-key map "\C-c\C-u" #'tex-goto-last-unclosed-latex-block)
(define-key map "\C-c\C-m" #'tex-feed-input)
(define-key map [(control return)] #'tex-feed-input)
(define-key map [menu-bar tex tex-bibtex-file]
'("BibTeX File" . tex-bibtex-file))
(define-key map [menu-bar tex tex-validate-region]
'(menu-item "Validate Region" tex-validate-region :enable mark-active))
(define-key map [menu-bar tex tex-validate-buffer]
'("Validate Buffer" . tex-validate-buffer))
(define-key map [menu-bar tex tex-region]
'(menu-item "TeX Region" tex-region :enable mark-active))
(define-key map [menu-bar tex tex-buffer]
'("TeX Buffer" . tex-buffer))
(define-key map [menu-bar tex tex-file] '("TeX File" . tex-file))
map)
"Keymap shared by TeX modes.")
(defvar latex-mode-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map tex-mode-map)
(define-key map "\C-c\C-s" #'latex-split-block)
map)
"Keymap for `latex-mode'. See also `tex-mode-map'.")
(defvar plain-tex-mode-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map tex-mode-map)
map)
"Keymap for `plain-tex-mode'. See also `tex-mode-map'.")
(defvar tex-shell-map
(let ((m (make-sparse-keymap)))
(set-keymap-parent m shell-mode-map)
(tex-define-common-keys m)
m)
"Keymap for the TeX shell.
Inherits `shell-mode-map' with a few additions.")
(defvar tex-face-alist
'((bold . "{\\bf ")
(italic . "{\\it ")
(bold-italic . "{\\bi ") ; hypothetical
(underline . "\\underline{")
(default . "{\\rm "))
"Alist of face and TeX font name for facemenu.")
(defvar tex-latex-face-alist
`((italic . "{\\em ")
,@tex-face-alist)
"Alist of face and LaTeX font name for facemenu.")
(defun tex-facemenu-add-face-function (face _end)
(or (cdr (assq face tex-face-alist))
(or (and (consp face)
(consp (car face))
(null (cdr face))
(eq major-mode 'latex-mode)
;; This actually requires the `color' LaTeX package.
(cond ((eq (caar face) :foreground)
(format "{\\color{%s} " (cadr (car face))))
((eq (caar face) :background)
(format "\\colorbox{%s}{" (cadr (car face))))))
(error "Face %s not configured for %s mode" face mode-name))))
;; This would be a lot simpler if we just used a regexp search,
;; but then it would be too slow.
(defun tex--guess-mode ()
(let ((mode tex-default-mode) slash comment)
(save-excursion
(goto-char (point-min))
(while (and (setq slash (search-forward "\\" nil t))
(setq comment (let ((search-end (point)))
(save-excursion
(beginning-of-line)
(search-forward "%" search-end t))))))
(if (not (and slash (not comment)))
mode
(if (looking-at
(concat
(regexp-opt '("documentstyle" "documentclass"
"begin" "subsection" "section"
"part" "chapter" "newcommand"
"renewcommand" "RequirePackage")
'words)
"\\|NeedsTeXFormat{LaTeX"))
(if (and (looking-at
"document\\(style\\|class\\)\\(\\[.*\\]\\)?{slides}")
;; SliTeX is almost never used any more nowadays.
(tex-executable-exists-p slitex-run-command))
#'slitex-mode
#'latex-mode)
#'plain-tex-mode)))))
;; `tex-mode' plays two roles: it's the parent of several sub-modes
;; but it's also the function that chooses between those submodes.
;; To tell the difference between those two cases where the function
;; might be called, we check `delay-mode-hooks'.
;;;###autoload
(define-derived-mode tex-mode text-mode "generic-TeX"
"Major mode for editing files of input for TeX, LaTeX, or SliTeX.
This is the shared parent mode of several submodes.
Tries to determine (by looking at the beginning of the file) whether
this file is for plain TeX, LaTeX, or SliTeX and calls `plain-tex-mode',
`latex-mode', or `slitex-mode', accordingly. If it cannot be determined,
such as if there are no commands in the file, the value of `tex-default-mode'
says which mode to use."
(tex-common-initialization))
(advice-add 'tex-mode :around #'tex--redirect-to-submode
;; Give it lower precedence than normal advice, so
;; AUCTeX's advice takes precedence over it.
'((depth . 50)))
(defvar tex-mode--recursing nil)
(defun tex--redirect-to-submode (orig-fun)
"Redirect to one of the submodes when called directly."
;; The file may have "mode: tex" in the local variable
;; block, in which case we'll be called recursively
;; infinitely. Inhibit that.
(let ((tex-mode--recursing tex-mode--recursing))
(funcall (if (or delay-mode-hooks tex-mode--recursing)
;; We're called from one of the children already.
orig-fun
(setq tex-mode--recursing t)
(let ((mode (tex--guess-mode)))
;; `tex--guess-mode' really tries to guess the *type* of file,
;; so we still need to consult `major-mode-remap-alist'
;; to see which mode to use for that type.
(major-mode-remap mode))))))
;; Support files annotated with -*- LaTeX -*- (e.g. because they received
;; them from someone using AUCTeX).
;;;###autoload (add-to-list 'major-mode-remap-defaults '(TeX-mode . tex-mode))
;;;###autoload (add-to-list 'major-mode-remap-defaults '(plain-TeX-mode . plain-tex-mode))
;;;###autoload (add-to-list 'major-mode-remap-defaults '(LaTeX-mode . latex-mode))
;; FIXME: These aliases conflict with AUCTeX, but we still need them
;; because of packages out there which call these functions directly.
;; They should be patched to use `major-mode-remap'.
;; It would be nice to mark them obsolete somehow to encourage using
;; something else, but the obsolete declaration would become invalid
;; and confusing when AUCTeX *is* installed.
;;;###autoload (defalias 'TeX-mode #'tex-mode)
;;;###autoload (defalias 'plain-TeX-mode #'plain-tex-mode)
;;;###autoload (defalias 'LaTeX-mode #'latex-mode)
;;;###autoload
(define-derived-mode plain-tex-mode tex-mode "TeX"
"Major mode for editing files of input for plain TeX.
Makes $ and } display the characters they match.
Makes \" insert \\=`\\=` when it seems to be the beginning of a quotation,
and \\='\\=' when it appears to be the end; it inserts \" only after a \\.
Use \\[tex-region] to run TeX on the current region, plus a \"header\"
copied from the top of the file (containing macro definitions, etc.),
running TeX under a special subshell. \\[tex-buffer] does the whole buffer.
\\[tex-file] saves the buffer and then processes the file.
\\[tex-print] prints the .dvi file made by any of these.
\\[tex-view] previews the .dvi file made by any of these.
\\[tex-bibtex-file] runs bibtex on the file of the current buffer.
Use \\[tex-validate-buffer] to check buffer for paragraphs containing
mismatched $'s or braces.
Special commands:
\\{plain-tex-mode-map}
Mode variables:
tex-run-command
Command string used by \\[tex-region] or \\[tex-buffer].
tex-directory
Directory in which to create temporary files for TeX jobs
run by \\[tex-region] or \\[tex-buffer].
tex-dvi-print-command
Command string used by \\[tex-print] to print a .dvi file.
tex-alt-dvi-print-command
Alternative command string used by \\[tex-print] (when given a prefix
argument) to print a .dvi file.
tex-dvi-view-command
Command string used by \\[tex-view] to preview a .dvi file.
tex-show-queue-command
Command string used by \\[tex-show-print-queue] to show the print
queue that \\[tex-print] put your job on.
Entering Plain-tex mode runs the hook `text-mode-hook', then the hook
`tex-mode-hook', and finally the hook `plain-tex-mode-hook'. When the
special subshell is initiated, the hook `tex-shell-hook' is run."
(setq-local tex-command tex-run-command)
(setq-local tex-start-of-header "%\\*\\*start of header")
(setq-local tex-end-of-header "%\\*\\*end of header")
(setq-local tex-trailer "\\bye\n"))
;;;###autoload
(define-derived-mode latex-mode tex-mode "LaTeX"
"Major mode for editing files of input for LaTeX.
Makes $ and } display the characters they match.
Makes \" insert \\=`\\=` when it seems to be the beginning of a quotation,
and \\='\\=' when it appears to be the end; it inserts \" only after a \\.
Use \\[tex-region] to run LaTeX on the current region, plus the preamble
copied from the top of the file (containing \\documentstyle, etc.),
running LaTeX under a special subshell. \\[tex-buffer] does the whole buffer.
\\[tex-file] saves the buffer and then processes the file.
\\[tex-print] prints the .dvi file made by any of these.
\\[tex-view] previews the .dvi file made by any of these.
\\[tex-bibtex-file] runs bibtex on the file of the current buffer.
Use \\[tex-validate-buffer] to check buffer for paragraphs containing
mismatched $'s or braces.
Special commands:
\\{latex-mode-map}
Mode variables:
latex-run-command
Command string used by \\[tex-region] or \\[tex-buffer].
tex-directory
Directory in which to create temporary files for LaTeX jobs
run by \\[tex-region] or \\[tex-buffer].
tex-dvi-print-command
Command string used by \\[tex-print] to print a .dvi file.
tex-alt-dvi-print-command
Alternative command string used by \\[tex-print] (when given a prefix
argument) to print a .dvi file.
tex-dvi-view-command
Command string used by \\[tex-view] to preview a .dvi file.
tex-show-queue-command
Command string used by \\[tex-show-print-queue] to show the print
queue that \\[tex-print] put your job on.
Entering Latex mode runs the hook `text-mode-hook', then
`tex-mode-hook', and finally `latex-mode-hook'. When the special
subshell is initiated, `tex-shell-hook' is run."
(setq-local tex-command latex-run-command)
(setq-local tex-start-of-header "\\\\document\\(style\\|class\\)")
(setq-local tex-end-of-header "\\\\begin\\s-*{document}")
(setq-local tex-trailer "\\end{document}\n")
;; A line containing just $$ is treated as a paragraph separator.
;; A line starting with $$ starts a paragraph,
;; but does not separate paragraphs if it has more stuff on it.
;; For \pagebreak allow latex optional arg like \pagebreak[2]
(setq paragraph-start
(concat "[ \t]*\\(\\$\\$\\|"
"\\\\[][]\\|"
"\\\\" (regexp-opt (append
(mapcar #'car latex-section-alist)
'("begin" "label" "end"
"item" "bibitem" "newline" "noindent"
"newpage" "footnote" "marginpar"
"parbox" "caption"))
t)
"\\>\\|\\\\[a-z]*" (regexp-opt '("space" "skip" "page") t)
"\\>\\)"))
(setq paragraph-separate
(concat "\\([ \t]*%\\)\\|[\f]\\|[ \t]*\\($\\|"
"\\\\[][]\\|"
"\\\\" (regexp-opt (append
(mapcar #'car latex-section-alist)
'("begin" "label" "end" ))
t)
"\\>\\|\\\\\\(" (regexp-opt '("item" "bibitem" "newline"
"noindent" "newpage" "footnote"
"marginpar" "parbox" "caption"))
"\\|\\$\\$\\|[a-z]*\\(space\\|skip\\|page[a-z]*\\)"
"\\>\\)[][0-9 \t]*\\($\\|%\\)\\)"))
(setq-local imenu-create-index-function #'latex-imenu-create-index)
(setq-local tex-face-alist tex-latex-face-alist)
(add-hook 'fill-nobreak-predicate #'latex-fill-nobreak-predicate nil t)
(setq-local indent-line-function #'latex-indent)
(setq-local fill-indent-according-to-mode t)
(add-hook 'completion-at-point-functions
#'latex-complete-data nil 'local)
(add-hook 'flymake-diagnostic-functions #'tex-chktex nil t)
(setq-local outline-regexp latex-outline-regexp)
(setq-local outline-level #'latex-outline-level)
(setq-local forward-sexp-function #'latex-forward-sexp)
(setq-local skeleton-end-hook nil))
;;;###autoload
(define-derived-mode slitex-mode latex-mode "SliTeX"
"Major mode for editing files of input for SliTeX.
Makes $ and } display the characters they match.
Makes \" insert \\=`\\=` when it seems to be the beginning of a quotation,
and \\='\\=' when it appears to be the end; it inserts \" only after a \\.
Use \\[tex-region] to run SliTeX on the current region, plus the preamble
copied from the top of the file (containing \\documentstyle, etc.),
running SliTeX under a special subshell. \\[tex-buffer] does the whole buffer.
\\[tex-file] saves the buffer and then processes the file.
\\[tex-print] prints the .dvi file made by any of these.
\\[tex-view] previews the .dvi file made by any of these.
\\[tex-bibtex-file] runs bibtex on the file of the current buffer.
Use \\[tex-validate-buffer] to check buffer for paragraphs containing
mismatched $'s or braces.
Special commands:
\\{slitex-mode-map}
Mode variables:
slitex-run-command
Command string used by \\[tex-region] or \\[tex-buffer].
tex-directory
Directory in which to create temporary files for SliTeX jobs
run by \\[tex-region] or \\[tex-buffer].
tex-dvi-print-command
Command string used by \\[tex-print] to print a .dvi file.
tex-alt-dvi-print-command
Alternative command string used by \\[tex-print] (when given a prefix
argument) to print a .dvi file.
tex-dvi-view-command
Command string used by \\[tex-view] to preview a .dvi file.
tex-show-queue-command
Command string used by \\[tex-show-print-queue] to show the print
queue that \\[tex-print] put your job on.
Entering SliTeX mode runs the hook `text-mode-hook', then the hook
`tex-mode-hook', then the hook `latex-mode-hook', and finally the hook
`slitex-mode-hook'. When the special subshell is initiated, the hook
`tex-shell-hook' is run."
(setq tex-command slitex-run-command)
(setq tex-start-of-header "\\\\documentstyle{slides}\\|\\\\documentclass{slides}"))
(defvar tildify-space-string)
(defvar tildify-foreach-region-function)
(declare-function tildify-foreach-ignore-environments
"tildify" (pairs callback _beg end))
(defvar tex--prettify-symbols-alist)
(defun tex-common-initialization ()
;; Regexp isearch should accept newline and formfeed as whitespace.
(setq-local search-whitespace-regexp "[ \t\r\n\f]+")
;; Use tilde as hard-space character in tildify package.
(setq-local tildify-space-string "~")
;; FIXME: Use the fact that we're parsing the document already
;; rather than using regex-based filtering.
(setq-local tildify-foreach-region-function
(apply-partially
#'tildify-foreach-ignore-environments
`(("\\\\\\\\" . "") ; do not remove this
(,(concat "\\\\begin{\\("
(regexp-opt '("verbatim" "math" "displaymath"
"equation" "eqnarray" "eqnarray*"))
"\\)}")
. ("\\\\end{" 1 "}"))
("\\\\verb\\*?\\(.\\)" . (1))
("\\$\\$?" . (0))
("\\\\(" . "\\\\)")
("\\\\[[]" . "\\\\[]]")
("\\\\[a-zA-Z]+\\( +\\|{}\\)[a-zA-Z]*" . "")
("%" . "$"))))
;; A line containing just $$ is treated as a paragraph separator.
(setq-local paragraph-start "[ \t]*$\\|[\f\\%]\\|[ \t]*\\$\\$")
;; A line starting with $$ starts a paragraph,
;; but does not separate paragraphs if it has more stuff on it.
(setq-local paragraph-separate "[ \t]*$\\|[\f\\%]\\|[ \t]*\\$\\$[ \t]*$")
(setq-local add-log-current-defun-function #'tex-current-defun-name)
(setq-local comment-start "%")
(setq-local comment-add 1)
(setq-local comment-start-skip
"\\(\\(^\\|[^\\\n]\\)\\(\\\\\\\\\\)*\\)\\(%+ *\\)")
(setq-local parse-sexp-ignore-comments t)
(setq-local compare-windows-whitespace #'tex-categorize-whitespace)
(setq-local facemenu-add-face-function #'tex-facemenu-add-face-function)
(setq-local facemenu-end-add-face "}")
(setq-local facemenu-remove-face-function t)
(setq-local font-lock-defaults
'(( tex-font-lock-keywords tex-font-lock-keywords-1
tex-font-lock-keywords-2 tex-font-lock-keywords-3)
nil nil nil nil
;; Who ever uses that anyway ???
(font-lock-mark-block-function . mark-paragraph)
(font-lock-syntactic-face-function
. tex-font-lock-syntactic-face-function)
(font-lock-unfontify-region-function
. tex-font-lock-unfontify-region)))
(setq-local prettify-symbols-alist tex--prettify-symbols-alist)
(add-function :override (local 'prettify-symbols-compose-predicate)
#'tex--prettify-symbols-compose-p)
(setq-local syntax-propertize-function
(syntax-propertize-rules latex-syntax-propertize-rules))
;; TABs in verbatim environments don't do what you think.
(setq-local indent-tabs-mode nil)
;; Other vars that should be buffer-local.
(make-local-variable 'tex-command)
(make-local-variable 'tex-start-of-header)
(make-local-variable 'tex-end-of-header)
(make-local-variable 'tex-trailer))
(defun tex-categorize-whitespace (backward-limit)
;; compare-windows-whitespace is set to this.
;; This is basically a finite-state machine.
;; Returns a symbol telling how TeX would treat
;; the whitespace we are looking at: null, space, or par.
(let ((category 'null)
(not-finished t))
(skip-chars-backward " \t\n\f" backward-limit)
(while not-finished
(cond ((looking-at "[ \t]+")
(goto-char (match-end 0))
(if (eq category 'null)
(setq category 'space)))
((looking-at "\n")
(cond ((eq category 'newline)
(setq category 'par)
(setq not-finished nil))
(t
(setq category 'newline) ;a strictly internal state
(goto-char (match-end 0)))))
((looking-at "\f+")
(setq category 'par)
(setq not-finished nil))
(t
(setq not-finished nil))))
(skip-chars-forward " \t\n\f")
(if (eq category 'newline)
'space ;TeX doesn't distinguish
category)))
(defun tex-insert-quote (arg)
"Insert the appropriate quote marks for TeX.
Inserts the value of `tex-open-quote' (normally \\=`\\=`) or `tex-close-quote'
\(normally \\='\\=') depending on the context. With prefix argument, always
inserts \" characters."
(interactive "*P")
;; Discover if we'll be inserting normal double quotes.
;;
(if (or arg (memq (char-syntax (preceding-char)) '(?/ ?\\))
(eq (get-text-property (point) 'face) 'tex-verbatim)
(nth 4 (syntax-ppss)) ; non-nil if point is in a TeX comment
;; Discover if a preceding occurrence of `tex-open-quote'
;; should be morphed to a normal double quote.
;;
(and (>= (point) (+ (point-min) (length tex-open-quote)))
(save-excursion
(backward-char (length tex-open-quote))
(when (or (looking-at (regexp-quote tex-open-quote))
(looking-at (regexp-quote tex-close-quote)))
(delete-char (length tex-open-quote))
(when (looking-at (regexp-quote tex-close-quote))
(delete-char (length tex-close-quote)))
t))))
;; Insert the normal quote (eventually letting
;; `electric-pair-mode' do its thing).
;;
(self-insert-command (prefix-numeric-value arg))
;; We'll be inserting fancy TeX quotes, but consider and imitate
;; `electric-pair-mode''s two behaviors: pair-insertion and
;; region wrapping.
;;
(if (and electric-pair-mode (use-region-p))
(let* ((saved (point-marker)))
(goto-char (mark))
(insert (if (> saved (mark)) tex-open-quote tex-close-quote))
(goto-char saved)
(insert (if (> saved (mark)) tex-close-quote tex-open-quote)))
(if (or (memq (char-syntax (preceding-char)) '(?\( ?> ?\s))
(memq (preceding-char) '(?~ ?')))
;; We're in an "opening" context
;;
(if electric-pair-mode
(if (looking-at (regexp-quote tex-close-quote))
(forward-char (length tex-close-quote))
(insert tex-open-quote)
(insert tex-close-quote)
(backward-char (length tex-close-quote)))
(insert tex-open-quote))
;; We're in a "closing" context.
;;
(if (looking-at (regexp-quote tex-close-quote))
(forward-char (length tex-close-quote))
(insert tex-close-quote))))))
(defun tex-validate-buffer ()
"Check current buffer for paragraphs containing mismatched braces or $s.
Their positions are recorded in the buffer `*Occur*'.
To find a particular invalidity from `*Occur*', switch to that buffer
and type C-c C-c or click with mouse-2
on the line for the invalidity you want to see."
(interactive)
(let ((buffer (current-buffer))
(prevpos (point-min))
(linenum nil)
(num-matches 0))
(with-output-to-temp-buffer "*Occur*"
(princ "Mismatches:\n")
(with-current-buffer standard-output
(occur-mode)
;; This won't actually work...Really, this whole thing should
;; be rewritten instead of being a hack on top of occur.
(setq occur-revert-arguments (list nil 0 (list buffer))))
(save-excursion
(goto-char (point-max))
;; Do a little shimmy to place point at the end of the last
;; "real" paragraph. Need to avoid validating across an \end,
;; because that blows up latex-forward-sexp.
(backward-paragraph)
(forward-paragraph)
(while (not (bobp))
;; Scan the previous paragraph for invalidities.
(backward-paragraph)
(save-excursion
(or (tex-validate-region (point) (save-excursion
(forward-paragraph)
(point)))
(let ((end (line-beginning-position 2))
start tem)
(beginning-of-line)
(setq start (point))
;; Keep track of line number as we scan,
;; in a cumulative fashion.
(if linenum
(setq linenum (- linenum
(count-lines prevpos (point))))
(setq linenum (1+ (count-lines 1 start))))
(setq prevpos (point))
;; Mention this mismatch in *Occur*.
;; Since we scan from end of buffer to beginning,
;; add each mismatch at the beginning of *Occur*.
(save-excursion
(setq tem (point-marker))
(set-buffer standard-output)
(goto-char (point-min))
;; Skip "Mismatches:" header line.
(forward-line 1)
(setq num-matches (1+ num-matches))
(let ((inhibit-read-only t))
(insert-buffer-substring buffer start end)
(let ((text-end (point-marker))
text-beg)
(forward-char (- start end))
(setq text-beg (point-marker))
(insert (format "%3d: " linenum))
(add-text-properties
text-beg (- text-end 1)
'(mouse-face highlight
help-echo
"mouse-2: go to this invalidity"))
(put-text-property (point) (- text-end 1)
'occur-match t)
(put-text-property text-beg text-end
'occur-target tem)))))))))
(with-current-buffer standard-output
(let ((no-matches (zerop num-matches))
(inhibit-read-only t))
(if no-matches
(insert "None!\n"))
(if (called-interactively-p 'interactive)
(message (cond (no-matches "No mismatches found")
((= num-matches 1) "1 mismatch found")
(t "%d mismatches found"))
num-matches)))))))
(defun tex-validate-region (start end)
"Check for mismatched braces or $'s in region.
Returns t if no mismatches. Returns nil and moves point to suspect
area if a mismatch is found."
(interactive "r")
(let ((failure-point nil) (max-possible-sexps (- end start)))
(save-excursion
(condition-case ()
(save-restriction
(narrow-to-region start end)
;; First check that the open and close parens balance in numbers.
(goto-char start)
(while (and (not (eobp))
(<= 0 (setq max-possible-sexps
(1- max-possible-sexps))))
(forward-sexp 1))
;; Now check that like matches like.
(goto-char start)
(while (re-search-forward "\\s(" nil t)
(save-excursion
(let ((pos (match-beginning 0)))
(goto-char pos)
(skip-chars-backward "\\\\") ; escaped parens
(forward-sexp 1)
(or (eq (preceding-char) (cdr (syntax-after pos)))
(eq (char-after pos) (cdr (syntax-after (1- (point)))))
(error "Mismatched parentheses"))))))
(error
(skip-syntax-forward " .>")
(setq failure-point (point)))))
(if failure-point (goto-char failure-point))
(not failure-point)))
(defun tex-handle-newline (inhibit-validation)
"Break a TeX paragraph with two newlines, or continue a comment.
If not in a comment, insert two newlines, breaking a paragraph for TeX,
and check for mismatched braces or $s in the paragraph being terminated
unless prefix arg INHIBIT-VALIDATION is non-nil to inhibit the checking.
Otherwise (in a comment), just insert a single continued comment line."
(interactive "*P")
(if (nth 4 (syntax-ppss)) ; non-nil if point is in a TeX comment
(comment-indent-new-line)
(tex-terminate-paragraph inhibit-validation)))
(defun tex-terminate-paragraph (inhibit-validation)
"Insert two newlines, breaking a paragraph for TeX.
Check for mismatched braces or $s in paragraph being terminated.
A prefix arg inhibits the checking."
(interactive "*P")
(or inhibit-validation
(save-excursion
;; For the purposes of this, a "paragraph" is a block of text
;; wherein all the brackets etc are expected to be balanced. It
;; may start after a blank line (ie a "proper" paragraph), or
;; a begin{} or end{} block, etc.
(tex-validate-region
(save-excursion
(backward-paragraph)
(point))
(point)))
(message "Paragraph being closed appears to contain a mismatch"))
(insert "\n\n"))
(define-skeleton tex-insert-braces
"Make a pair of braces and be poised to type inside of them."
nil
?\{ _ ?})
;; This function is used as the value of fill-nobreak-predicate
;; in LaTeX mode. Its job is to prevent line-breaking inside
;; of a \verb construct.
(defun latex-fill-nobreak-predicate ()
(save-excursion
(skip-chars-backward " ")
;; Don't break after \ since `\ ' has special meaning.
(or (and (not (bobp)) (memq (char-syntax (char-before)) '(?\\ ?/)))
(let ((opoint (point))
inside)
(beginning-of-line)
(while (re-search-forward "\\\\verb\\(.\\)" opoint t)
(unless (re-search-forward (regexp-quote (match-string 1)) opoint t)
(setq inside t)))
inside))))
(defvar latex-block-default "enumerate")
(defvar latex-block-args-alist
'(("array" nil ?\{ (skeleton-read "Format: ") ?\})
("tabular" nil ?\{ (skeleton-read "Format: ") ?\})
("minipage" nil ?\{ (skeleton-read "Size: ") ?\})
("picture" nil ?\( (skeleton-read "SizeX,SizeY: ") ?\))
;; FIXME: This is right for Prosper, but not for seminar.
;; ("slide" nil ?\{ (skeleton-read "Title: ") ?\})
)
"Skeleton element to use for arguments to particular environments.
Every element of the list has the form (NAME . SKEL-ELEM) where NAME is
the name of the environment and SKEL-ELEM is an element to use in
a skeleton (see `skeleton-insert').")
(defvar latex-block-body-alist
'(("enumerate" nil '(latex-insert-item) > _)
("itemize" nil '(latex-insert-item) > _)
("table" nil "\\caption{" > (skeleton-read "Caption: ") "}" > \n
'(if (and (boundp 'reftex-mode) reftex-mode) (reftex-label "table"))
\n _)
("figure" nil > _ \n "\\caption{" > (skeleton-read "Caption: ") "}" > \n
'(if (and (boundp 'reftex-mode) reftex-mode) (reftex-label "figure"))))
"Skeleton element to use for the body of particular environments.
Every element of the list has the form (NAME . SKEL-ELEM) where NAME is
the name of the environment and SKEL-ELEM is an element to use in
a skeleton (see `skeleton-insert').")
;; Like tex-insert-braces, but for LaTeX.
(defalias 'tex-latex-block #'latex-insert-block)
(define-skeleton latex-insert-block
"Create a matching pair of lines \\begin{NAME} and \\end{NAME} at point.
Puts point on a blank line between them."
(let ((choice (completing-read (format "LaTeX block name [%s]: "
latex-block-default)
(latex-complete-envnames)
nil nil nil nil latex-block-default)))
(setq latex-block-default choice)
(unless (or (member choice latex-standard-block-names)
(member choice latex-block-names))
;; Remember new block names for later completion.
(push choice latex-block-names))
choice)
\n "\\begin{" str "}"
(cdr (assoc str latex-block-args-alist))
> \n (or (cdr (assoc str latex-block-body-alist)) '(nil > _))
(unless (bolp) '\n)
"\\end{" str "}" > \n)
(define-skeleton latex-insert-item
"Insert an \\item macro."
nil
\n "\\item " >)
;;;; LaTeX completion.
(defvar latex-complete-bibtex-cache nil)
(defvar bibtex-reference-key)
(declare-function reftex-get-bibfile-list "reftex-cite.el" ())
(defun latex-complete-bibtex-keys ()
(when (bound-and-true-p reftex-mode)
(lambda (key pred action)
(let ((re (concat "^[ \t]*@\\([a-zA-Z]+\\)[ \t\n]*\\([{(][ \t\n]*\\)"
(regexp-quote key)))
(files (reftex-get-bibfile-list))
keys)
(if (and (eq (car latex-complete-bibtex-cache)
(reftex-get-bibfile-list))
(string-prefix-p (nth 1 latex-complete-bibtex-cache)
key))
;; Use the cache.
(setq keys (nth 2 latex-complete-bibtex-cache))
(dolist (file files)
(with-current-buffer (find-file-noselect file)
(goto-char (point-min))
(while (re-search-forward re nil t)
(goto-char (match-end 2))
(when (and (not (member-ignore-case (match-string 1)
'("c" "comment" "string")))
(looking-at bibtex-reference-key))
(push (match-string-no-properties 0) keys)))))
;; Fill the cache.
(setq-local latex-complete-bibtex-cache (list files key keys)))
(complete-with-action action keys key pred)))))
(defun latex-complete-envnames ()
(completion-table-in-turn
(append latex-block-names latex-standard-block-names)
(completion-table-dynamic
(lambda (str)
(with-current-buffer (if (and (minibufferp) (minibuffer-selected-window))
(window-buffer (minibuffer-selected-window))
(current-buffer))
(save-excursion
(let ((comps '())
(pos (point)))
(goto-char (point-min))
(while (re-search-forward (concat "\\\\begin{\\(" str "[^}\n ]*\\)")
nil t)
(unless (and (<= (match-beginning 0) pos)
(>= (match-end 0) pos))
(push (match-string 1) comps)))
comps)))))))
(defun latex-complete-refkeys ()
(when (boundp 'reftex-docstruct-symbol)
(symbol-value reftex-docstruct-symbol)))
(defvar latex-complete-alist
`(("\\`\\\\\\(short\\)?cite\\'" . ,#'latex-complete-bibtex-keys)
("\\`\\\\\\(begin\\|end\\)\\'" . ,#'latex-complete-envnames)
("\\`\\\\[vf]?ref\\'" . ,#'latex-complete-refkeys)))
(defun latex-complete-data ()
"Get completion-data at point."
(save-excursion
(let ((pt (point)))
(skip-chars-backward "^ {}\n\t\\\\")
(pcase (char-before)
((or 'nil ?\s ?\n ?\t ?\}) nil)
(?\\
;; TODO: Complete commands.
nil)
(?\{
;; Complete args to commands.
(let* ((cmd
(save-excursion
(forward-char -1)
(skip-chars-backward " \n")
(buffer-substring (point)
(progn
(skip-chars-backward "a-zA-Z@*")
(let ((n (skip-chars-backward "\\\\")))
(forward-char (* 2 (/ n 2))))
(point)))))
(start (point))
(_ (progn (goto-char pt) (skip-chars-backward "^," start)))
(comp-beg (point))
(_ (progn (goto-char pt) (skip-chars-forward "^, {}\n\t\\\\")))
(comp-end (point))
(table
(funcall
(let ((f (lambda () t)))
(dolist (comp latex-complete-alist)
(if (string-match (car comp) cmd)
(setq f (cdr comp))))
f))))
(if (eq table t)
;; Unknown command.
nil
(list comp-beg comp-end table))))))))
;;;;
;;;; LaTeX syntax navigation
;;;;
(defmacro tex-search-noncomment (&rest body)
"Execute BODY as long as it return non-nil and point is in a comment.
Return the value returned by the last execution of BODY."
(declare (debug t))
(let ((res-sym (make-symbol "result")))
`(let (,res-sym)
(while
(and (setq ,res-sym (progn ,@body))
(save-excursion (skip-chars-backward "^\n%") (not (bolp)))))
,res-sym)))
(defun tex-last-unended-begin ()
"Leave point at the beginning of the last `\\begin{...}' that is unended."
(condition-case nil
(while (and (tex-search-noncomment
(re-search-backward "\\\\\\(begin\\|end\\)\\s *{"))
(looking-at "\\\\end"))
(tex-last-unended-begin))
(search-failed (error "Couldn't find unended \\begin"))))
(defun tex-next-unmatched-end ()
"Leave point at the end of the next `\\end' that is unmatched."
(while (and (tex-search-noncomment
(re-search-forward "\\\\\\(begin\\|end\\)\\s *{[^}]+}"))
(save-excursion (goto-char (match-beginning 0))
(looking-at "\\\\begin")))
(tex-next-unmatched-end)))
(defun tex-next-unmatched-eparen (otype)
"Leave point after the next unmatched escaped closing parenthesis.
The string OTYPE is an opening parenthesis type: `(', `{', or `['."
(condition-case nil
(let ((ctype (char-to-string (cdr (aref (syntax-table)
(string-to-char otype))))))
(while (and (tex-search-noncomment
(re-search-forward (format "\\\\[%s%s]" ctype otype)))
(save-excursion
(goto-char (match-beginning 0))
(looking-at (format "\\\\%s" (regexp-quote otype)))))
(tex-next-unmatched-eparen otype)))
(wrong-type-argument (error "Unknown opening parenthesis type: %s" otype))
(search-failed (error "Couldn't find closing escaped paren"))))
(defun tex-last-unended-eparen (ctype)
"Leave point at the start of the last unended escaped opening parenthesis.
The string CTYPE is a closing parenthesis type: `)', `}', or `]'."
(condition-case nil
(let ((otype (char-to-string (cdr (aref (syntax-table)
(string-to-char ctype))))))
(while (and (tex-search-noncomment
(re-search-backward (format "\\\\[%s%s]" ctype otype)))
(looking-at (format "\\\\%s" (regexp-quote ctype))))
(tex-last-unended-eparen ctype)))
(wrong-type-argument (error "Unknown opening parenthesis type: %s" ctype))
(search-failed (error "Couldn't find unended escaped paren"))))
(defun tex-goto-last-unclosed-latex-block ()
"Move point to the last unclosed \\begin{...}.
Mark is left at original location."
(interactive)
(let ((spot))
(save-excursion
(tex-last-unended-begin)
(setq spot (point)))
(push-mark)
(goto-char spot)))
(defvar latex-handle-escaped-parens t)
;; Don't think this one actually _needs_ (for the purposes of
;; tex-mode) to handle escaped parens.
;; Does not handle escaped parens when latex-handle-escaped-parens is nil.
(defun latex-backward-sexp-1 ()
"Like (backward-sexp 1) but aware of multi-char elements and escaped parens."
(let ((pos (point))
(forward-sexp-function))
(backward-sexp 1)
(cond ((looking-at
(if latex-handle-escaped-parens
"\\\\\\(begin\\>\\|[[({]\\)"
"\\\\begin\\>"))
(signal 'scan-error
(list "Containing expression ends prematurely"
(point) (prog1 (point) (goto-char pos)))))
((and latex-handle-escaped-parens
(looking-at "\\\\\\([])}]\\)"))
(tex-last-unended-eparen (match-string 1)))
((eq (char-after) ?{)
(let ((newpos (point)))
(when (ignore-errors (backward-sexp 1) t)
(if (or (looking-at "\\\\end\\>")
;; In case the \\ ends a verbatim section.
(and (looking-at "end\\>") (eq (char-before) ?\\)))
(tex-last-unended-begin)
(goto-char newpos))))))))
;; Note this does not handle things like mismatched brackets inside
;; begin/end blocks.
;; Needs to handle escaped parens for tex-validate-*.
;; https://lists.gnu.org/r/bug-gnu-emacs/2007-09/msg00038.html
;; Does not handle escaped parens when latex-handle-escaped-parens is nil.
(defun latex-forward-sexp-1 ()
"Like (forward-sexp 1) but aware of multi-char elements and escaped parens."
(let ((pos (point))
(forward-sexp-function))
(forward-sexp 1)
(let ((newpos (point)))
(skip-syntax-backward "/w")
(cond
((looking-at "\\\\end\\>")
(signal 'scan-error
(list "Containing expression ends prematurely"
(point)
(prog1
(progn (ignore-errors (forward-sexp 2)) (point))
(goto-char pos)))))
((looking-at "\\\\begin\\>")
(goto-char (match-end 0))
(tex-next-unmatched-end))
;; A better way to handle this, \( .. \) etc, is probably to
;; temporarily change the syntax of the \ in \( to punctuation.
((and latex-handle-escaped-parens
(looking-back "\\\\[])}]" (- (point) 2)))
(signal 'scan-error
(list "Containing expression ends prematurely"
(- (point) 2) (prog1 (point)
(goto-char pos)))))
((and latex-handle-escaped-parens
(looking-back "\\\\\\([({[]\\)" (- (point) 2)))
(tex-next-unmatched-eparen (match-string 1)))
(t (goto-char newpos))))))
(defun latex-forward-sexp (&optional arg)
"Like `forward-sexp' but aware of multi-char elements and escaped parens."
(interactive "P")
(unless arg (setq arg 1))
(let ((pos (point))
(opoint 0))
(condition-case err
(while (and (/= (point) opoint)
(/= arg 0))
(setq opoint (point))
(setq arg
(if (> arg 0)
(progn (latex-forward-sexp-1) (1- arg))
(progn (latex-backward-sexp-1) (1+ arg)))))
(scan-error
(goto-char pos)
(signal (car err) (cdr err))))))
(defun latex-syntax-after ()
"Like (char-syntax (char-after)) but aware of multi-char elements."
(if (looking-at "\\\\end\\>") ?\) (char-syntax (following-char))))
(defun latex-skip-close-parens ()
"Like (skip-syntax-forward \" )\") but aware of multi-char elements."
(let ((forward-sexp-function nil))
(while (progn (skip-syntax-forward " )")
(looking-at "\\\\end\\>"))
(forward-sexp 2))))
(defun latex-down-list ()
"Like (down-list 1) but aware of multi-char elements."
(forward-comment (point-max))
(let ((forward-sexp-function nil))
(if (not (looking-at "\\\\begin\\>"))
(down-list 1)
(forward-sexp 1)
;; Skip arguments.
(while (looking-at "[ \t]*[[{(]")
(with-syntax-table tex-mode-syntax-table
(forward-sexp))))))
(defalias 'tex-close-latex-block #'latex-close-block)
(define-skeleton latex-close-block
"Create an \\end{...} to match the last unclosed \\begin{...}."
(save-excursion
(tex-last-unended-begin)
(if (not (looking-at "\\\\begin\\(\\s *{[^}\n]*}\\)")) '("{" _ "}")
(match-string 1)))
\n "\\end" str > \n)
(define-skeleton latex-split-block
"Split the enclosing environment by inserting \\end{..}\\begin{..} at point."
(save-excursion
(tex-last-unended-begin)
(if (not (looking-at "\\\\begin\\(\\s *{[^}\n]*}\\)")) '("{" _ "}")
(prog1 (match-string 1)
(goto-char (match-end 1))
(setq v1 (buffer-substring (point)
(progn
(while (looking-at "[ \t]*[[{]")
(forward-sexp 1))
(point)))))))
\n "\\end" str > \n _ \n "\\begin" str v1 > \n)
(defconst tex-discount-args-cmds
'("begin" "end" "input" "special" "cite" "ref" "include" "includeonly"
"documentclass" "usepackage" "label")
"TeX commands whose arguments should not be counted as text.")
(defun tex-count-words (begin end)
"Count the number of words in the buffer."
(interactive
(if (and transient-mark-mode mark-active)
(list (region-beginning) (region-end))
(list (point-min) (point-max))))
;; TODO: skip comments and math and maybe some environments.
(save-excursion
(goto-char begin)
(let ((count 0))
(while (and (< (point) end) (re-search-forward "\\<" end t))
(if (not (eq (char-syntax (preceding-char)) ?/))
(progn
;; Don't count single-char words.
(unless (looking-at ".\\>") (cl-incf count))
(forward-char 1))
(let ((cmd
(buffer-substring-no-properties
(point) (progn (when (zerop (skip-chars-forward "a-zA-Z@"))
(forward-char 1))
(point)))))
(when (member cmd tex-discount-args-cmds)
(skip-chars-forward "*")
(forward-comment (point-max))
(when (looking-at "\\[")
(forward-sexp 1)
(forward-comment (point-max)))
(if (not (looking-at "{"))
(forward-char 1)
(forward-sexp 1))))))
(message "%s words" count))))
;;; Invoking TeX in an inferior shell.
;; Why use a shell instead of running TeX directly? Because if TeX
;; gets stuck, the user can switch to the shell window and type at it.
(defvar tex-error-parse-syntax-table
(let ((st (make-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)
;; Single quotations may appear in errors
(modify-syntax-entry ?\" "_" st)
st)
"Syntax-table used while parsing TeX error messages.")
(defun tex-old-error-file-name ()
;; This is unreliable, partly because we don't try very hard, and
;; partly because TeX's output format is eminently ambiguous and unfriendly
;; to automation.
(save-excursion
(save-match-data
(with-syntax-table tex-error-parse-syntax-table
(beginning-of-line)
(backward-up-list 1)
(skip-syntax-forward "(_")
(while (not (let ((try-filename (thing-at-point 'filename)))
(and try-filename
(not (string= "" try-filename))
(file-readable-p try-filename))))
(skip-syntax-backward "(_")
(backward-up-list 1)
(skip-syntax-forward "(_"))
(thing-at-point 'filename)))))
(defconst tex-error-regexp-alist
;; First alternative handles the newer --file-line-error style:
;; ./test2.tex:14: Too many }'s.
'(gnu
;; Second handles the old-style, which spans two lines but doesn't include
;; any file info:
;; ! Too many }'s.
;; l.396 toto}
("^l\\.\\([1-9][0-9]*\\) \\(?:\\.\\.\\.\\)?\\(.*\\)$"
tex-old-error-file-name 1 nil nil nil
;; Since there's no filename to highlight, let's highlight the message.
(2 compilation-error-face))
;; A few common warning messages.
("^\\(?:Und\\|Ov\\)erfull \\\\[hv]box .* at lines? \\(\\([1-9][0-9]*\\)\\(?:--\\([1-9][0-9]*\\)\\)?\\)$"
tex-old-error-file-name (2 . 3) nil 1 nil
(1 compilation-warning-face))
("^(Font) *\\([^ \n].* on input line \\([1-9][0-9]*\\)\\)\\.$"
tex-old-error-file-name 2 nil 1 1
(2 compilation-warning-face))
;; Included files get output as (<file> ...).
;; FIXME: there tend to be a boatload of them at the beginning of the
;; output which aren't that interesting. Maybe we should filter out
;; all the file name that start with /usr/share?
;; ("(\\.?/\\([^() \n]+\\)" 1 nil nil 0)
))
;; The utility functions:
(define-derived-mode tex-shell shell-mode "TeX-Shell"
(setq-local compilation-error-regexp-alist tex-error-regexp-alist)
(compilation-shell-minor-mode t))
;;;###autoload
(defun tex-start-shell ()
(with-current-buffer
(make-comint
"tex-shell"
(or tex-shell-file-name (getenv "ESHELL") shell-file-name)
nil
;; Specify an interactive shell, to make sure it prompts.
"-i")
(let ((proc (get-process "tex-shell")))
(set-process-sentinel proc #'tex-shell-sentinel)
(set-process-query-on-exit-flag proc nil)
(tex-shell)
(while (zerop (buffer-size))
(sleep-for 1)))))
(defun tex-feed-input ()
"Send input to the tex shell process.
In the tex buffer this can be used to continue an interactive tex run.
In the tex shell buffer this command behaves like `comint-send-input'."
(interactive)
(set-buffer (tex-shell-buf))
(comint-send-input)
(tex-recenter-output-buffer nil))
(defun tex-display-shell ()
"Make the TeX shell buffer visible in a window."
(with-suppressed-warnings ((obsolete display-tex-shell-buffer-action))
(display-buffer (tex-shell-buf) display-tex-shell-buffer-action))
(tex-recenter-output-buffer nil))
(defun tex-shell-sentinel (proc _msg)
(cond ((null (buffer-name (process-buffer proc)))
;; buffer killed
(set-process-buffer proc nil)
(tex-delete-last-temp-files))
((memq (process-status proc) '(signal exit))
(tex-delete-last-temp-files))))
(defun tex-set-buffer-directory (buffer directory)
"Set BUFFER's default directory to be DIRECTORY."
(setq directory (file-name-as-directory (expand-file-name directory)))
(if (not (file-directory-p directory))
(error "%s is not a directory" directory)
(with-current-buffer buffer
(setq default-directory directory))))
(defvar-local tex-send-command-modified-tick 0)
(defun tex-shell-proc ()
(or (tex-shell-running) (error "No TeX subprocess")))
(defun tex-shell-buf ()
(process-buffer (tex-shell-proc)))
(defun tex-shell-buf-no-error ()
(let ((proc (tex-shell-running)))
(and proc (process-buffer proc))))
(defun tex-send-command (command &optional file background)
"Send COMMAND to TeX shell process, substituting optional FILE for *.
Do this in background if optional BACKGROUND is t. If COMMAND has no *,
FILE will be appended, preceded by a blank, to COMMAND. If FILE is nil, no
substitution will be made in COMMAND. COMMAND can be any expression that
evaluates to a command string.
Return the process in which TeX is running."
(save-excursion
(let* ((cmd (eval command t))
(proc (tex-shell-proc))
(buf (process-buffer proc))
(star (string-search "*" cmd))
(string
(concat
(if (null file)
cmd
(if (file-name-absolute-p file)
(setq file (convert-standard-filename file)))
(if star (concat (substring cmd 0 star)
(shell-quote-argument file)
(substring cmd (1+ star)))
(concat cmd " " (shell-quote-argument file))))
(if background "&" ""))))
;; Switch to buffer before checking for subproc output in it.
(set-buffer buf)
;; If text is unchanged since previous tex-send-command,
;; we haven't got any output. So wait for output now.
(if (= (buffer-modified-tick buf) tex-send-command-modified-tick)
(accept-process-output proc))
(goto-char (process-mark proc))
(insert string)
(comint-send-input)
(setq tex-send-command-modified-tick (buffer-modified-tick buf))
proc)))
(defun tex-delete-last-temp-files (&optional not-all)
"Delete any junk files from last temp file.
If NOT-ALL is non-nil, save the `.dvi' file."
(if tex-last-temp-file
(let* ((dir (file-name-directory tex-last-temp-file))
(list (and (file-directory-p dir)
(file-name-all-completions
(file-name-base tex-last-temp-file)
dir))))
(while list
(if not-all
(and
;; If arg is non-nil, don't delete the .dvi file.
(not (string-match "\\.dvi$" (car list)))
(delete-file (concat dir (car list))))
(delete-file (concat dir (car list))))
(setq list (cdr list))))))
(add-hook 'kill-emacs-hook #'tex-delete-last-temp-files)
;;
;; Machinery to guess the command that the user wants to execute.
;;
(defvar tex-compile-history nil)
(defvar tex-input-files-re
(concat "\\." (regexp-opt '("tex" "texi" "texinfo"
"bbl" "ind" "sty" "cls") t)
;; Include files with no dots (for directories).
"\\'\\|\\`[^.]+\\'"))
(defcustom tex-use-reftex t
"If non-nil, use RefTeX's list of files to determine what command to use."
:type 'boolean
:group 'tex)
(defvar tex-compile-commands
`(,@(mapcar (lambda (prefix)
`((concat ,prefix tex-command
" " tex-start-options
" " (if (< 0 (length tex-start-commands))
(shell-quote-argument tex-start-commands))
" %f")
t "%r.pdf"))
'("pdf" "xe" "lua"))
((concat tex-command
" " tex-start-options
" " (if (< 0 (length tex-start-commands))
(shell-quote-argument tex-start-commands))
" %f")
t "%r.dvi")
("xdvi %r &" "%r.dvi")
("\\doc-view \"%r.pdf\"" "%r.pdf")
("xpdf %r.pdf &" "%r.pdf")
("gv %r.ps &" "%r.ps")
("yap %r &" "%r.dvi")
("advi %r &" "%r.dvi")
("gv %r.pdf &" "%r.pdf")
("bibtex %r" "%r.aux" "%r.bbl")
("makeindex %r" "%r.idx" "%r.ind")
("texindex %r.??")
("dvipdfm %r" "%r.dvi" "%r.pdf")
("dvipdf %r" "%r.dvi" "%r.pdf")
("dvips -o %r.ps %r" "%r.dvi" "%r.ps")
("ps2pdf %r.ps" "%r.ps" "%r.pdf")
("lpr %r.ps" "%r.ps"))
"List of commands for `tex-compile'.
Each element should be of the form (FORMAT IN OUT) where
FORMAT is an expression that evaluates to a string that can contain
- `%r' the main file name without extension.
- `%f' the main file name.
IN can be either a string (with the same % escapes in it) indicating
the name of the input file, or t to indicate that the input is all
the TeX files of the document, or nil if we don't know.
OUT describes the output file and is either a %-escaped string
or nil to indicate that there is no output file.")
(defun tex-guess-main-file (&optional all)
"Find a likely `tex-main-file'.
Looks for hints in other buffers in the same directory or in
ALL other buffers. If ALL is `sub' only look at buffers in parent directories
of the current buffer."
(let ((dir default-directory)
(header-re tex-start-of-header))
(catch 'found
;; Look for a buffer with `tex-main-file' set.
(dolist (buf (if (consp all) all (buffer-list)))
(with-current-buffer buf
(when (and (cond
((null all) (equal dir default-directory))
((eq all 'sub) (string-prefix-p default-directory dir))
(t))
(stringp tex-main-file))
(throw 'found (expand-file-name tex-main-file)))))
;; Look for a buffer containing the magic `tex-start-of-header'.
(dolist (buf (if (consp all) all (buffer-list)))
(with-current-buffer buf
(when (and (cond
((null all) (equal dir default-directory))
((eq all 'sub) (string-prefix-p default-directory dir))
(t))
buffer-file-name
;; (or (easy-mmode-derived-mode-p 'latex-mode)
;; (easy-mmode-derived-mode-p 'plain-tex-mode))
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(re-search-forward
header-re (+ (point) 10000) t))))
(throw 'found (expand-file-name buffer-file-name))))))))
(defun tex-main-file ()
"Return the relative name of the main file."
(let* ((file (or tex-main-file
;; Compatibility with AUCTeX.
(with-no-warnings
(when (boundp 'TeX-master)
(cond ((stringp TeX-master)
(setq-local tex-main-file TeX-master))
((and (eq TeX-master t) buffer-file-name)
(file-relative-name buffer-file-name)))))
;; Try to guess the main file.
(if (not buffer-file-name)
(error "Buffer is not associated with any file")
(file-relative-name
(if (save-excursion
(goto-char (point-min))
(re-search-forward tex-start-of-header
(+ (point) 10000) t))
;; This is the main file.
buffer-file-name
;; This isn't the main file, let's try to find better,
(or (tex-guess-main-file)
(tex-guess-main-file 'sub)
;; (tex-guess-main-file t)
buffer-file-name)))))))
(if (or (file-exists-p file) (string-match "\\.tex\\'" file))
file (concat file ".tex"))))
(defun tex-summarize-command (cmd)
(if (not (stringp cmd)) ""
(mapconcat #'identity
(mapcar (lambda (s) (car (split-string s)))
(split-string cmd "\\s-*\\(?:;\\|&&\\)\\s-*"))
"&")))
(defun tex-uptodate-p (file)
"Return non-nil if FILE is not up-to-date w.r.t the document source files.
FILE is typically the output DVI or PDF file."
;; We should check all the files included !!!
(and
;; Clearly, the target must exist.
(file-exists-p file)
;; And the last run must not have asked for a rerun.
;; FIXME: this should check that the last run was done on the same file.
(let ((buf (condition-case nil (tex-shell-buf) (error nil))))
(when buf
(with-current-buffer buf
(save-excursion
(goto-char (point-max))
(and (re-search-backward
(concat "(see the transcript file for additional information)"
"\\|^Output written on .*"
(regexp-quote (file-name-nondirectory file))
" (.*)\\.")
nil t)
(> (save-excursion
;; Usually page numbers are output as [N], but
;; I've already seen things like
;; [N{/var/lib/texmf/fonts/map/pdftex/updmap/pdftex.map}]
;; as well as [N.N] (e.g. with 'acmart' style).
(or (re-search-backward
"\\[[0-9]+\\({[^}]*}\\|\\.[0-9]+\\)?\\]"
nil t)
(point-min)))
(save-excursion
(or (re-search-backward "Rerun" nil t)
(point-min)))))))))
;; And the input files must not have been changed in the meantime.
(let ((files (if (and tex-use-reftex
(fboundp 'reftex-scanning-info-available-p)
(reftex-scanning-info-available-p))
(reftex-all-document-files)
(list (file-name-directory (expand-file-name file)))))
(ignored-dirs-re
(concat
(regexp-opt
(delq nil (mapcar (lambda (s) (if (eq (aref s (1- (length s))) ?/)
(substring s 0 (1- (length s)))))
completion-ignored-extensions))
t) "\\'"))
(uptodate t))
(while (and files uptodate)
(let ((f (pop files)))
(if (and (file-directory-p f)
;; Avoid infinite loops.
(not (file-symlink-p f)))
(unless (string-match ignored-dirs-re f)
(setq files (nconc
(ignore-errors ;Not readable or something.
(directory-files f t tex-input-files-re))
files)))
(when (file-newer-than-file-p f file)
(setq uptodate nil)))))
uptodate)))
(defvar tex-executable-cache nil)
(defun tex-executable-exists-p (name)
"Like `executable-find' but with a cache."
(let ((f (and (string-match "^\\\\\\([^ \t\n]+\\)" name)
(intern-soft (concat "tex-cmd-" (match-string 1 name))))))
(if (fboundp f)
f
(let ((cache (assoc name tex-executable-cache)))
(if cache (cdr cache)
(let ((executable (executable-find name)))
(push (cons name executable) tex-executable-cache)
executable))))))
(defun tex-command-executable (cmd)
(let ((s (if (stringp cmd) cmd (eval (car cmd) t))))
(substring s 0 (string-match "[ \t]\\|\\'" s))))
(defun tex-command-active-p (cmd fspec)
"Return non-nil if the CMD spec might need to be run."
(let ((in (nth 1 cmd))
(out (nth 2 cmd)))
(if (stringp in)
(let ((file (format-spec in fspec)))
(when (file-exists-p file)
(or (not out)
(file-newer-than-file-p
file (format-spec out fspec)))))
(when (and (eq in t) (stringp out))
(not (tex-uptodate-p (format-spec out fspec)))))))
(defcustom tex-cmd-bibtex-args "--min-crossref=100"
"Extra args to pass to `bibtex' by default."
:type 'string
:version "23.1"
:group 'tex-run)
(defun tex--quote-spec (fspec)
(cl-loop for (char . file) in fspec
collect (cons char (shell-quote-argument file))))
(defun tex-format-cmd (format fspec)
"Like `format-spec' but add user-specified args to the command.
Only applies the FSPEC to the args part of FORMAT."
(setq fspec (tex--quote-spec fspec))
(if (not (string-match "\\([^ /\\]+\\) " format))
(format-spec format fspec)
(let* ((prefix (substring format 0 (match-beginning 0)))
(cmd (match-string 1 format))
(args (substring format (match-end 0)))
(sym (intern-soft (format "tex-cmd-%s-args" cmd)))
(extra-args (and sym (symbol-value sym))))
(concat prefix cmd
(if extra-args (concat " " extra-args))
" " (format-spec args fspec)))))
(defun tex-compile-default (fspec)
"Guess a default command given the `format-spec' FSPEC."
;; TODO: Learn to do latex+dvips!
(let ((cmds nil)
(unchanged-in nil))
;; Only consider active commands.
(dolist (cmd tex-compile-commands)
(when (tex-executable-exists-p (tex-command-executable cmd))
(if (tex-command-active-p cmd fspec)
(push cmd cmds)
(push (nth 1 cmd) unchanged-in))))
;; If no command seems to be applicable, arbitrarily pick the first one.
(setq cmds (if cmds (nreverse cmds) (list (car tex-compile-commands))))
;; Remove those commands whose input was considered stable for
;; some other command (typically if (t . "%.pdf") is inactive
;; then we're using pdflatex and the fact that the dvi file
;; is nonexistent doesn't matter).
(let ((tmp nil))
(dolist (cmd cmds)
(unless (member (nth 1 cmd) unchanged-in)
(push cmd tmp)))
;; Only remove if there's something left.
(if tmp (setq cmds (nreverse tmp))))
;; Remove commands whose input is not up-to-date either.
(let ((outs (delq nil (mapcar (lambda (x) (nth 2 x)) cmds)))
(tmp nil))
(dolist (cmd cmds)
(unless (member (nth 1 cmd) outs)
(push cmd tmp)))
;; Only remove if there's something left.
(if tmp (setq cmds (nreverse tmp))))
;; Select which file we're going to operate on (the latest).
(let ((latest (nth 1 (car cmds))))
(dolist (cmd (prog1 (cdr cmds) (setq cmds (list (car cmds)))))
(if (equal latest (nth 1 cmd))
(push cmd cmds)
(unless (eq latest t) ;Can't beat that!
(if (or (not (stringp latest))
(eq (nth 1 cmd) t)
(and (stringp (nth 1 cmd))
(file-newer-than-file-p
(format-spec (nth 1 cmd) fspec)
(format-spec latest fspec))))
(setq latest (nth 1 cmd) cmds (list cmd)))))))
;; Expand the command spec into the actual text.
(dolist (cmd (prog1 cmds (setq cmds nil)))
(push (cons (eval (car cmd) t) (cdr cmd)) cmds))
;; Select the favorite command from the history.
(let ((hist tex-compile-history)
re hist-cmd)
(while hist
(setq hist-cmd (pop hist))
(setq re (concat "\\`"
(regexp-quote (tex-command-executable hist-cmd))
"\\([ \t]\\|\\'\\)"))
(dolist (cmd cmds)
;; If the hist entry uses the same command and applies to a file
;; of the same type (e.g. `gv %r.pdf' vs `gv %r.ps'), select cmd.
(and (string-match re (car cmd))
(or (not (string-match "%[fr]\\([-._[:alnum:]]+\\)" (car cmd)))
(string-match (regexp-quote (match-string 1 (car cmd)))
hist-cmd))
(setq hist nil cmds (list cmd)))))
;; Substitute and return.
(if (and hist-cmd
(string-match (concat "[' \t\"]" (format-spec "%r" fspec)
"\\([;&' \t\"]\\|\\'\\)")
hist-cmd))
;; The history command was already applied to the same file,
;; so just reuse it.
hist-cmd
(if cmds (tex-format-cmd (caar cmds) fspec))))))
(defun tex-cmd-doc-view (file)
(pop-to-buffer (find-file-noselect file)))
(defun tex-compile (dir cmd)
"Run a command CMD on current TeX buffer's file in DIR."
;; FIXME: Use time-stamps on files to decide the next op.
(interactive
(let* ((file (tex-main-file))
(default-directory
(prog1 (file-name-directory (expand-file-name file))
(setq file (file-name-nondirectory file))))
(root (file-name-sans-extension file))
(fspec (list (cons ?r root)
(cons ?f file)))
(default (tex-compile-default fspec)))
(list default-directory
(completing-read
(format-prompt "Command" (tex-summarize-command default))
(mapcar (lambda (x)
(list (tex-format-cmd (eval (car x) t) fspec)))
tex-compile-commands)
nil nil nil 'tex-compile-history default))))
(save-some-buffers (not compilation-ask-about-save) nil)
(let ((f (and (string-match "^\\\\\\([^ \t\n]+\\)" cmd)
(intern-soft (concat "tex-cmd-" (match-string 1 cmd))))))
(if (functionp f)
(condition-case nil
(let ((default-directory dir))
(apply f (split-string-and-unquote
(substring cmd (match-end 0)))))
(wrong-number-of-arguments
(error "Wrong number of arguments to %s"
(substring (symbol-name f) 8))))
(if (tex-shell-running)
(tex-kill-job)
(tex-start-shell))
(tex-send-tex-command cmd dir))))
(defun tex-start-tex (command file &optional dir)
"Start a TeX run, using COMMAND on FILE."
(let* ((star (string-search "*" command))
(compile-command
(if star
(concat (substring command 0 star)
(shell-quote-argument file)
(substring command (1+ star)))
(concat command " "
tex-start-options
(if (< 0 (length tex-start-commands))
(concat
(shell-quote-argument tex-start-commands) " "))
(shell-quote-argument file)))))
(tex-send-tex-command compile-command dir)))
(defun tex-send-tex-command (cmd &optional dir)
(unless (or (equal dir (let ((buf (tex-shell-buf-no-error)))
(and buf (with-current-buffer buf
default-directory))))
(not dir))
(let (shell-dirtrack-verbose)
(tex-send-command tex-shell-cd-command dir)))
(with-current-buffer (process-buffer (tex-send-command cmd))
(setq next-error-last-buffer (current-buffer))
(compilation-forget-errors))
(tex-display-shell)
(setq tex-last-buffer-texed (current-buffer)))
;;; The commands:
(defun tex-region (beg end)
"Run TeX on the current region, via a temporary file.
The file's name comes from the variable `tex-zap-file' and the
variable `tex-directory' says where to put it.
If the buffer has a header, the header is given to TeX before the
region itself. The buffer's header is all lines between the strings
defined by `tex-start-of-header' and `tex-end-of-header' inclusive.
The header must start in the first 100 lines of the buffer.
The value of `tex-trailer' is given to TeX as input after the region.
The value of `tex-command' specifies the command to use to run TeX."
(interactive "r")
(if (tex-shell-running)
(tex-kill-job)
(tex-start-shell))
(or tex-zap-file
(setq tex-zap-file (tex-generate-zap-file-name)))
;; Temp file will be written and TeX will be run in zap-directory.
;; If the TEXINPUTS file has relative directories or if the region has
;; \input of files, this must be the same directory as the file for
;; TeX to access the correct inputs. That's why it's safest if
;; tex-directory is ".".
(let* ((zap-directory
(file-name-as-directory (expand-file-name tex-directory)))
(tex-out-file (expand-file-name (concat tex-zap-file ".tex")
zap-directory))
;; We may be running from an unsaved buffer, in which case
;; there's no point in guessing for a main file name.
(main-file (and buffer-file-name
(expand-file-name (tex-main-file))))
(ismain (string-equal main-file (buffer-file-name)))
already-output)
;; Don't delete temp files if we do the same buffer twice in a row.
(or (eq (current-buffer) tex-last-buffer-texed)
(tex-delete-last-temp-files t))
(let ((default-directory zap-directory)) ; why?
;; We assume the header is fully contained in tex-main-file.
;; We use f-f-ns so we get prompted about any changes on disk.
(if (not main-file)
(setq already-output 0)
(with-current-buffer (find-file-noselect main-file)
(setq already-output (tex-region-header tex-out-file
(and ismain beg)))))
;; Write out the specified region (but don't repeat anything
;; already written in the header).
(write-region (if ismain
(max beg already-output)
beg)
end tex-out-file (not (zerop already-output)))
;; Write the trailer, if any.
;; Precede it with a newline to make sure it
;; is not hidden in a comment.
(if tex-trailer
(write-region (concat "\n" tex-trailer) nil
tex-out-file t)))
;; Record the file name to be deleted afterward.
(setq tex-last-temp-file tex-out-file)
;; Use a relative file name here because (1) the proper dir
;; is already current, and (2) the abs file name is sometimes
;; too long and can make tex crash.
(tex-start-tex tex-command (concat tex-zap-file ".tex") zap-directory)
(setq tex-print-file tex-out-file)))
(defun tex-region-header (file &optional beg)
"If there is a TeX header in the current buffer, write it to FILE.
Return point at the end of the region so written, or zero. If
the optional buffer position BEG is specified, then the region
written out starts at BEG, if this lies before the start of the header.
If the first line matches `tex-first-line-header-regexp', it is
also written out. The variables `tex-start-of-header' and
`tex-end-of-header' are used to locate the header. Note that the
start of the header is required to be within the first 100 lines."
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(let ((search-end (save-excursion
(forward-line 100)
(point)))
(already-output 0)
hbeg hend)
;; Maybe copy first line, such as `\input texinfo', to temp file.
(and tex-first-line-header-regexp
(looking-at tex-first-line-header-regexp)
(write-region (point)
(progn (forward-line 1)
(setq already-output (point)))
file))
;; Write out the header, if there is one, and any of the
;; specified region which extends before it. But don't repeat
;; anything already written.
(and tex-start-of-header
(re-search-forward tex-start-of-header search-end t)
(progn
(beginning-of-line)
(setq hbeg (point)) ; mark beginning of header
(when (re-search-forward tex-end-of-header nil t)
(forward-line 1)
(setq hend (point)) ; mark end of header
(write-region
(max (if beg
(min hbeg beg)
hbeg)
already-output)
hend file (not (zerop already-output)))
(setq already-output hend))))
already-output))))
(defun tex-buffer ()
"Run TeX on current buffer. See \\[tex-region] for more information.
Does not save the buffer, so it's useful for trying experimental versions.
See \\[tex-file] for an alternative."
(interactive)
(tex-region (point-min) (point-max)))
(defun tex-file ()
"Prompt to save all buffers and run TeX (or LaTeX) on current buffer's file.
This function is more useful than \\[tex-buffer] when you need the
`.aux' file of LaTeX to have the correct name."
(interactive)
(when tex-offer-save
(save-some-buffers))
(let* ((source-file (tex-main-file))
(file-dir (file-name-directory (expand-file-name source-file))))
(if (tex-shell-running)
(tex-kill-job)
(tex-start-shell))
(tex-start-tex tex-command source-file file-dir)
(setq tex-print-file (expand-file-name source-file))))
(defun tex-generate-zap-file-name ()
"Generate a unique name suitable for use as a file name."
;; Include the shell process number and host name
;; in case there are multiple shells (for same or different user).
;; Dec 1998: There is a report that some versions of xdvi
;; don't work with file names that start with #.
(format "_TZ_%d-%s"
(process-id (get-buffer-process "*tex-shell*"))
(subst-char-in-string ?. ?- (system-name))))
;; This will perhaps be useful for modifying TEXINPUTS.
;; Expand each file name, separated by colons, in the string S.
(defun tex-expand-files (s)
(let (elts (start 0))
(while (string-match ":" s start)
(setq elts (cons (substring s start (match-beginning 0)) elts))
(setq start (match-end 0)))
(or (= start 0)
(setq elts (cons (substring s start) elts)))
(mapconcat (lambda (elt)
(if (= (length elt) 0) elt (expand-file-name elt)))
(nreverse elts) ":")))
(defun tex-shell-running ()
(let ((proc (get-process "tex-shell")))
(when proc
(if (and (eq (process-status proc) 'run)
(buffer-live-p (process-buffer proc)))
;; return the TeX process on success
proc
;; get rid of the process permanently
;; this should get rid of the annoying w32 problem with
;; dead tex-shell buffer and live process
(delete-process proc)))))
(defun tex-kill-job ()
"Kill the currently running TeX job."
(interactive)
;; `quit-process' leads to core dumps of the tex process (except if
;; coredumpsize has limit 0kb as on many environments). One would
;; like to use (kill-process proc 'lambda), however that construct
;; does not work on some systems and kills the shell itself.
(let ((proc (get-process "tex-shell")))
(when proc (quit-process proc t))))
(defun tex-recenter-output-buffer (linenum)
"Redisplay buffer of TeX job output so that most recent output can be seen.
The last line of the buffer is displayed on
line LINE of the window, or centered if LINE is nil."
(interactive "P")
(let ((tex-shell (get-buffer "*tex-shell*")))
(if (null tex-shell)
(message "No TeX output buffer")
(when-let ((window
(with-suppressed-warnings ((obsolete display-tex-shell-buffer-action))
(display-buffer tex-shell display-tex-shell-buffer-action))))
(with-selected-window window
(bury-buffer tex-shell)
(goto-char (point-max))
(recenter (if linenum
(prefix-numeric-value linenum)
(/ (window-height) 2))))))))
(defcustom tex-print-file-extension ".dvi"
"The TeX-compiled file extension for viewing and printing.
If you use pdflatex instead of latex, set this to \".pdf\" and modify
`tex-dvi-view-command' and `tex-dvi-print-command' appropriately."
:type 'string
:group 'tex-view
:version "25.1")
(defun tex-print (&optional alt)
"Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
Runs the shell command defined by `tex-dvi-print-command'. If prefix argument
is provided, use the alternative command, `tex-alt-dvi-print-command'."
(interactive "P")
(let ((print-file-name-dvi (tex-append tex-print-file
tex-print-file-extension))
test-name)
(if (and (not (equal (current-buffer) tex-last-buffer-texed))
(buffer-file-name)
;; Check that this buffer's printed file is up to date.
(file-newer-than-file-p
(setq test-name (tex-append (buffer-file-name)
tex-print-file-extension))
(buffer-file-name)))
(setq print-file-name-dvi test-name))
(if (not (file-exists-p print-file-name-dvi))
(error "No appropriate `.dvi' file could be found")
(if (tex-shell-running)
(tex-kill-job)
(tex-start-shell))
(tex-send-command
(if alt tex-alt-dvi-print-command tex-dvi-print-command)
print-file-name-dvi
t))))
(defun tex-alt-print ()
"Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
Runs the shell command defined by `tex-alt-dvi-print-command'."
(interactive)
(tex-print t))
(defun tex-view ()
"Preview the last `.dvi' file made by running TeX under Emacs.
This means, made using \\[tex-region], \\[tex-buffer] or \\[tex-file].
The variable `tex-dvi-view-command' specifies the shell command for preview.
You must set that variable yourself before using this command,
because there is no standard value that would generally work."
(interactive)
(or tex-dvi-view-command
(error "You must set `tex-dvi-view-command'"))
;; Restart the TeX shell if necessary.
(or (tex-shell-running)
(tex-start-shell))
(let ((tex-dvi-print-command (eval tex-dvi-view-command t)))
(tex-print)))
(defun tex-append (file-name suffix)
"Append to FILENAME the suffix SUFFIX, using same algorithm TeX uses.
Pascal-based TeX scans for the first period, C TeX uses the last.
No period is retained immediately before SUFFIX,
so normally SUFFIX starts with one."
(if (stringp file-name)
(let ((file (file-name-nondirectory file-name))
trial-name)
;; Try splitting on last period.
;; The first-period split can get fooled when two files
;; named a.tex and a.b.tex are both tex'd;
;; the last-period split must be right if it matches at all.
(setq trial-name
(concat (file-name-directory file-name)
(substring file 0
(string-match "\\.[^.]*$" file))
suffix))
(if (or (file-exists-p trial-name)
(file-exists-p (concat trial-name ".aux"))) ;for BibTeX files
trial-name
;; Not found, so split on first period.
(concat (file-name-directory file-name)
(substring file 0
(string-search "." file))
suffix)))
" "))
(defun tex-show-print-queue ()
"Show the print queue that \\[tex-print] put your job on.
Runs the shell command defined by `tex-show-queue-command'."
(interactive)
(if (tex-shell-running)
(tex-kill-job)
(tex-start-shell))
(tex-send-command tex-show-queue-command)
(tex-display-shell))
(defun tex-bibtex-file ()
"Run BibTeX on the current buffer's file."
(interactive)
(if (tex-shell-running)
(tex-kill-job)
(tex-start-shell))
(let* (shell-dirtrack-verbose
(source-file (expand-file-name (tex-main-file)))
(tex-out-file
(tex-append (file-name-nondirectory source-file) ""))
(file-dir (file-name-directory source-file)))
(tex-send-command tex-shell-cd-command file-dir)
(tex-send-command tex-bibtex-command tex-out-file))
(tex-display-shell))
;;;;
;;;; LaTeX indentation
;;;;
(defvar tex-indent-allhanging t)
(defvar tex-indent-arg 4)
(defvar tex-indent-basic 2)
(defvar tex-indent-item tex-indent-basic)
(defvar tex-indent-item-re "\\\\\\(bib\\)?item\\>")
(defcustom latex-noindent-environments '("document")
"Environments whose content is not indented by `tex-indent-basic'."
:type '(repeat string)
:safe (lambda (x) (not (memq nil (mapcar #'stringp x))))
:group 'tex-file
:version "27.1")
(defcustom latex-noindent-commands '("emph" "footnote")
"Commands for which `tex-indent-basic' should not be used."
:type '(repeat string)
:safe (lambda (x) (not (memq nil (mapcar #'stringp x))))
:group 'tex-file
:version "27.1")
(defvar tex-latex-indent-syntax-table
(let ((st (make-syntax-table tex-mode-syntax-table)))
(modify-syntax-entry ?$ "." st)
(modify-syntax-entry ?\( "." st)
(modify-syntax-entry ?\) "." st)
st)
"Syntax table used while computing indentation.")
(defun latex-indent (&optional _arg)
(if (and (eq (get-text-property (if (and (eobp) (bolp))
(max (point-min) (1- (point)))
(line-beginning-position))
'face)
'tex-verbatim))
'noindent
(with-syntax-table tex-latex-indent-syntax-table
;; TODO: Rather than ignore $, we should try to be more clever about it.
(let ((indent
(save-excursion
(beginning-of-line)
(latex-find-indent))))
(if (< indent 0) (setq indent 0))
(if (<= (current-column) (current-indentation))
(indent-line-to indent)
(save-excursion (indent-line-to indent)))))))
(defcustom latex-indent-within-escaped-parens nil
"Non-nil means add extra indent to text within escaped parens.
When this is non-nil, text within matching pairs of escaped
parens is indented at the column following the open paren. The
default value does not add any extra indent thus providing the
behavior of Emacs 22 and earlier."
:type 'boolean
:group 'tex
:version "23.1")
(defun latex-find-indent (&optional virtual)
"Find the proper indentation of text after point.
VIRTUAL if non-nil indicates that we're only trying to find the indentation
in order to determine the indentation of something else.
There might be text before point."
(let ((latex-handle-escaped-parens latex-indent-within-escaped-parens))
(save-excursion
(skip-chars-forward " \t")
(or
;; Stick the first line at column 0.
(and (= (point-min) (line-beginning-position)) 0)
;; Trust the current indentation, if such info is applicable.
(and virtual (save-excursion (skip-chars-backward " \t&") (bolp))
(current-column))
;; Stick verbatim environments to the left margin.
(and (looking-at "\\\\\\(begin\\|end\\) *{\\([^\n}]+\\)")
(member (match-string 2) tex-verbatim-environments)
0)
;; Put leading close-paren where the matching open paren would be.
(let (escaped)
(and (or (eq (latex-syntax-after) ?\))
;; Try to handle escaped close parens but keep
;; original position if it doesn't work out.
(and latex-handle-escaped-parens
(setq escaped (looking-at "\\\\\\([])}]\\)"))))
(ignore-errors
(save-excursion
(when escaped
(goto-char (match-beginning 1)))
(latex-skip-close-parens)
(latex-backward-sexp-1)
(latex-find-indent 'virtual)))))
;; Default (maybe an argument)
(let ((pos (point))
;; Outdent \item if necessary.
(indent (if (looking-at tex-indent-item-re) (- tex-indent-item) 0))
up-list-pos)
;; Find the previous point which determines our current indentation.
(condition-case err
(progn
(latex-backward-sexp-1)
(while (> (current-column) (current-indentation))
(latex-backward-sexp-1)))
(scan-error
(setq up-list-pos (nth 2 err))))
(cond
((= (point-min) pos) 0) ; We're really just indenting the first line.
((integerp up-list-pos)
;; Have to indent relative to the open-paren.
(goto-char up-list-pos)
(if (and (not tex-indent-allhanging)
(save-excursion
;; Make sure we're an argument to a macro and
;; that the macro is at the beginning of a line.
(condition-case nil
(progn
(while (eq (char-syntax (char-after)) ?\()
(forward-sexp -1))
(and (eq (char-syntax (char-after)) ?/)
(progn (skip-chars-backward " \t&")
(bolp))))
(scan-error nil)))
(> pos (progn (latex-down-list)
(forward-comment (point-max))
(point))))
;; Align with the first element after the open-paren.
(current-column)
;; We're the first element after a hanging brace.
(goto-char up-list-pos)
(+ (if (if (eq (char-after) ?\{)
(save-excursion
(skip-chars-backward " \t")
(let ((end (point)))
(skip-chars-backward "a-zA-Z")
(and (eq (char-before) ?\\)
(member (buffer-substring (point) end)
latex-noindent-commands))))
(and (looking-at "\\\\begin *{\\([^\n}]+\\)")
(member (match-string 1)
latex-noindent-environments)))
0 tex-indent-basic)
indent (latex-find-indent 'virtual))))
;; We're now at the "beginning" of a line.
((not (and (not virtual) (eq (char-after) ?\\)))
;; Nothing particular here: just keep the same indentation.
(+ indent (current-column)))
;; We're now looking at a macro call.
((looking-at tex-indent-item-re)
;; Indenting relative to an item, have to re-add the outdenting.
(+ indent (current-column) tex-indent-item))
(t
(let ((col (current-column)))
(if (or (not (eq (char-syntax (or (char-after pos) ?\s)) ?\())
;; Can't be an arg if there's an empty line in between.
(save-excursion (re-search-forward "^[ \t]*$" pos t)))
;; If the first char was not an open-paren, there's
;; a risk that this is really not an argument to the
;; macro at all.
(+ indent col)
(forward-sexp 1)
(if (< (line-end-position)
(save-excursion (forward-comment (point-max))
(point)))
;; we're indenting the first argument.
(min (current-column) (+ tex-indent-arg col))
(skip-syntax-forward " ")
(current-column)))))))))))
;;; DocTeX support
(defun doctex-font-lock-^^A ()
(if (eq (char-after (line-beginning-position)) ?\%)
(progn
(put-text-property
(1- (match-beginning 1)) (match-beginning 1)
'syntax-table
(string-to-syntax ">"))
(let ((end (line-end-position)))
(if (< end (point-max))
(put-text-property
end (1+ end)
'syntax-table
(string-to-syntax "> b"))))
(string-to-syntax "< b"))))
(defun doctex-font-lock-syntactic-face-function (state)
;; Mark DocTeX documentation, which is parsed as a style A comment
;; starting in column 0.
(if (or (nth 3 state) (nth 7 state)
(not (memq (char-before (nth 8 state))
'(?\n nil))))
;; Anything else is just as for LaTeX.
(tex-font-lock-syntactic-face-function state)
font-lock-doc-face))
(eval-when-compile
(defconst doctex-syntax-propertize-rules
(syntax-propertize-precompile-rules
latex-syntax-propertize-rules
;; For DocTeX comment-in-doc (DocTeX ≥3 also allows ^^X).
;; We make the comment start on the second char because of bug#35140.
("\\^\\(\\^\\)[AX]" (1 (doctex-font-lock-^^A))))))
(defvar doctex-font-lock-keywords
(append tex-font-lock-keywords
'(("^%<[^>]*>" (0 font-lock-preprocessor-face t)))))
;;;###autoload
(define-derived-mode doctex-mode latex-mode "DocTeX"
"Major mode to edit DocTeX files."
(setq font-lock-defaults
(cons (append (car font-lock-defaults) '(doctex-font-lock-keywords))
(mapcar
(lambda (x)
(pcase (car-safe x)
('font-lock-syntactic-face-function
(cons (car x) #'doctex-font-lock-syntactic-face-function))
(_ x)))
(cdr font-lock-defaults))))
(setq-local syntax-propertize-function
(syntax-propertize-rules doctex-syntax-propertize-rules)))
;;; Prettify Symbols Support
(defvar tex--prettify-symbols-alist
'( ;; Lowercase Greek letters.
("\\alpha" . ?α)
("\\beta" . ?β)
("\\gamma" . ?γ)
("\\delta" . ?δ)
("\\epsilon" . ?ϵ)
("\\zeta" . ?ζ)
("\\eta" . ?η)
("\\theta" . ?θ)
("\\iota" . ?ι)
("\\kappa" . ?κ)
("\\lambda" . ?λ)
("\\mu" . ?μ)
("\\nu" . ?ν)
("\\xi" . ?ξ)
;; There is no \omicron because it looks like a latin o.
("\\pi" . ?π)
("\\rho" . ?ρ)
("\\sigma" . ?σ)
("\\tau" . ?τ)
("\\upsilon" . ?υ)
("\\phi" . ?ϕ)
("\\chi" . ?χ)
("\\psi" . ?ψ)
("\\omega" . ?ω)
;; Uppercase Greek letters.
("\\Gamma" . ?Γ)
("\\Delta" . ?Δ)
("\\Lambda" . ?Λ)
("\\Phi" . ?Φ)
("\\Pi" . ?Π)
("\\Psi" . ?Ψ)
("\\Sigma" . ?Σ)
("\\Theta" . ?Θ)
("\\Upsilon" . ?Υ)
("\\Xi" . ?Ξ)
("\\Omega" . ?Ω)
;; Other math symbols (taken from leim/quail/latin-ltx.el).
("\\Box" . ?□)
("\\Bumpeq" . ?≎)
("\\Cap" . ?⋒)
("\\Cup" . ?⋓)
("\\Diamond" . ?◇)
("\\Downarrow" . ?⇓)
("\\H{o}" . ?ő)
("\\Im" . ?ℑ)
("\\Join" . ?⋈)
("\\Leftarrow" . ?⇐)
("\\Leftrightarrow" . ?⇔)
("\\Ll" . ?⋘)
("\\Lleftarrow" . ?⇚)
("\\Longleftarrow" . ?⇐)
("\\Longleftrightarrow" . ?⇔)
("\\Longrightarrow" . ?⇒)
("\\Lsh" . ?↰)
("\\Re" . ?ℜ)
("\\Rightarrow" . ?⇒)
("\\Rrightarrow" . ?⇛)
("\\Rsh" . ?↱)
("\\Subset" . ?⋐)
("\\Supset" . ?⋑)
("\\Uparrow" . ?⇑)
("\\Updownarrow" . ?⇕)
("\\Vdash" . ?⊩)
("\\Vert" . ?‖)
("\\Vvdash" . ?⊪)
("\\aleph" . ?ℵ)
("\\amalg" . ?∐)
("\\angle" . ?∠)
("\\approx" . ?≈)
("\\approxeq" . ?≊)
("\\ast" . ?∗)
("\\asymp" . ?≍)
("\\backcong" . ?≌)
("\\backepsilon" . ?∍)
("\\backprime" . ?‵)
("\\backsim" . ?∽)
("\\backsimeq" . ?⋍)
("\\backslash" . ?\\)
("\\barwedge" . ?⊼)
("\\because" . ?∵)
("\\beth" . ?ℶ)
("\\between" . ?≬)
("\\bigcap" . ?⋂)
("\\bigcirc" . ?◯)
("\\bigcup" . ?⋃)
("\\bigstar" . ?★)
("\\bigtriangledown" . ?▽)
("\\bigtriangleup" . ?△)
("\\bigvee" . ?⋁)
("\\bigwedge" . ?⋀)
("\\blacklozenge" . ?✦)
("\\blacksquare" . ?▪)
("\\blacktriangle" . ?▴)
("\\blacktriangledown" . ?▾)
("\\blacktriangleleft" . ?◂)
("\\blacktriangleright" . ?▸)
("\\bot" . ?⊥)
("\\bowtie" . ?⋈)
("\\boxminus" . ?⊟)
("\\boxplus" . ?⊞)
("\\boxtimes" . ?⊠)
("\\bullet" . ?•)
("\\bumpeq" . ?≏)
("\\cap" . ?∩)
("\\cdots" . ?⋯)
("\\centerdot" . ?·)
("\\checkmark" . ?✓)
("\\chi" . ?χ)
("\\cdot" . ?⋅)
("\\cdots" . ?⋯)
("\\circ" . ?∘)
("\\circeq" . ?≗)
("\\circlearrowleft" . ?↺)
("\\circlearrowright" . ?↻)
("\\circledR" . ?®)
("\\circledS" . ?Ⓢ)
("\\circledast" . ?⊛)
("\\circledcirc" . ?⊚)
("\\circleddash" . ?⊝)
("\\clubsuit" . ?♣)
("\\coloneq" . ?≔)
("\\complement" . ?∁)
("\\cong" . ?≅)
("\\coprod" . ?∐)
("\\cup" . ?∪)
("\\curlyeqprec" . ?⋞)
("\\curlyeqsucc" . ?⋟)
("\\curlypreceq" . ?≼)
("\\curlyvee" . ?⋎)
("\\curlywedge" . ?⋏)
("\\curvearrowleft" . ?↶)
("\\curvearrowright" . ?↷)
("\\dag" . ?†)
("\\dagger" . ?†)
("\\daleth" . ?ℸ)
("\\dashv" . ?⊣)
("\\ddag" . ?‡)
("\\ddagger" . ?‡)
("\\ddots" . ?⋱)
("\\diamond" . ?⋄)
("\\diamondsuit" . ?♢)
("\\divideontimes" . ?⋇)
("\\doteq" . ?≐)
("\\doteqdot" . ?≑)
("\\dotplus" . ?∔)
("\\dotsquare" . ?⊡)
("\\downarrow" . ?↓)
("\\downdownarrows" . ?⇊)
("\\downleftharpoon" . ?⇃)
("\\downrightharpoon" . ?⇂)
("\\ell" . ?ℓ)
("\\emptyset" . ?∅)
("\\eqcirc" . ?≖)
("\\eqcolon" . ?≕)
("\\eqslantgtr" . ?⋝)
("\\eqslantless" . ?⋜)
("\\equiv" . ?≡)
("\\exists" . ?∃)
("\\fallingdotseq" . ?≒)
("\\flat" . ?♭)
("\\forall" . ?∀)
("\\frown" . ?⌢)
("\\ge" . ?≥)
("\\geq" . ?≥)
("\\geqq" . ?≧)
("\\geqslant" . ?≥)
("\\gets" . ?←)
("\\gg" . ?≫)
("\\ggg" . ?⋙)
("\\gimel" . ?ℷ)
("\\gnapprox" . ?⋧)
("\\gneq" . ?≩)
("\\gneqq" . ?≩)
("\\gnsim" . ?⋧)
("\\gtrapprox" . ?≳)
("\\gtrdot" . ?⋗)
("\\gtreqless" . ?⋛)
("\\gtreqqless" . ?⋛)
("\\gtrless" . ?≷)
("\\gtrsim" . ?≳)
("\\gvertneqq" . ?≩)
("\\hbar" . ?ℏ)
("\\heartsuit" . ?♥)
("\\hookleftarrow" . ?↩)
("\\hookrightarrow" . ?↪)
("\\iff" . ?⇔)
("\\imath" . ?ı)
("\\in" . ?∈)
("\\infty" . ?∞)
("\\int" . ?∫)
("\\intercal" . ?⊺)
("\\langle" . 10216) ; Literal ?⟨ breaks indentation.
("\\lbrace" . ?{)
("\\lbrack" . ?\[)
("\\lceil" . ?⌈)
("\\ldots" . ?…)
("\\le" . ?≤)
("\\leadsto" . ?↝)
("\\leftarrow" . ?←)
("\\leftarrowtail" . ?↢)
("\\leftharpoondown" . ?↽)
("\\leftharpoonup" . ?↼)
("\\leftleftarrows" . ?⇇)
;; ("\\leftparengtr" ?〈), see bug#12948.
("\\leftrightarrow" . ?↔)
("\\leftrightarrows" . ?⇆)
("\\leftrightharpoons" . ?⇋)
("\\leftrightsquigarrow" . ?↭)
("\\leftthreetimes" . ?⋋)
("\\leq" . ?≤)
("\\leqq" . ?≦)
("\\leqslant" . ?≤)
("\\lessapprox" . ?≲)
("\\lessdot" . ?⋖)
("\\lesseqgtr" . ?⋚)
("\\lesseqqgtr" . ?⋚)
("\\lessgtr" . ?≶)
("\\lesssim" . ?≲)
("\\lfloor" . ?⌊)
("\\lhd" . ?◁)
("\\rhd" . ?▷)
("\\ll" . ?≪)
("\\llcorner" . ?⌞)
("\\lnapprox" . ?⋦)
("\\lneq" . ?≨)
("\\lneqq" . ?≨)
("\\lnsim" . ?⋦)
("\\longleftarrow" . ?←)
("\\longleftrightarrow" . ?↔)
("\\longmapsto" . ?↦)
("\\longrightarrow" . ?→)
("\\looparrowleft" . ?↫)
("\\looparrowright" . ?↬)
("\\lozenge" . ?✧)
("\\lq" . ?‘)
("\\lrcorner" . ?⌟)
("\\ltimes" . ?⋉)
("\\lvertneqq" . ?≨)
("\\maltese" . ?✠)
("\\mapsto" . ?↦)
("\\measuredangle" . ?∡)
("\\mho" . ?℧)
("\\mid" . ?∣)
("\\models" . ?⊧)
("\\mp" . ?∓)
("\\multimap" . ?⊸)
("\\nLeftarrow" . ?⇍)
("\\nLeftrightarrow" . ?⇎)
("\\nRightarrow" . ?⇏)
("\\nVDash" . ?⊯)
("\\nVdash" . ?⊮)
("\\nabla" . ?∇)
("\\napprox" . ?≉)
("\\natural" . ?♮)
("\\ncong" . ?≇)
("\\ne" . ?≠)
("\\nearrow" . ?↗)
("\\neg" . ?¬)
("\\neq" . ?≠)
("\\nequiv" . ?≢)
("\\newline" . ?
)
("\\nexists" . ?∄)
("\\ngeq" . ?≱)
("\\ngeqq" . ?≱)
("\\ngeqslant" . ?≱)
("\\ngtr" . ?≯)
("\\ni" . ?∋)
("\\nleftarrow" . ?↚)
("\\nleftrightarrow" . ?↮)
("\\nleq" . ?≰)
("\\nleqq" . ?≰)
("\\nleqslant" . ?≰)
("\\nless" . ?≮)
("\\nmid" . ?∤)
;; ("\\not" ?̸) ;FIXME: conflict with "NOT SIGN" ¬.
("\\notin" . ?∉)
("\\nparallel" . ?∦)
("\\nprec" . ?⊀)
("\\npreceq" . ?⋠)
("\\nrightarrow" . ?↛)
("\\nshortmid" . ?∤)
("\\nshortparallel" . ?∦)
("\\nsim" . ?≁)
("\\nsimeq" . ?≄)
("\\nsubset" . ?⊄)
("\\nsubseteq" . ?⊈)
("\\nsubseteqq" . ?⊈)
("\\nsucc" . ?⊁)
("\\nsucceq" . ?⋡)
("\\nsupset" . ?⊅)
("\\nsupseteq" . ?⊉)
("\\nsupseteqq" . ?⊉)
("\\ntriangleleft" . ?⋪)
("\\ntrianglelefteq" . ?⋬)
("\\ntriangleright" . ?⋫)
("\\ntrianglerighteq" . ?⋭)
("\\nvDash" . ?⊭)
("\\nvdash" . ?⊬)
("\\nwarrow" . ?↖)
("\\odot" . ?⊙)
("\\oint" . ?∮)
("\\ominus" . ?⊖)
("\\oplus" . ?⊕)
("\\oslash" . ?⊘)
("\\otimes" . ?⊗)
("\\parallel" . ?∥)
("\\partial" . ?∂)
("\\perp" . ?⊥)
("\\pitchfork" . ?⋔)
("\\prec" . ?≺)
("\\precapprox" . ?≾)
("\\preceq" . ?≼)
("\\precnapprox" . ?⋨)
("\\precnsim" . ?⋨)
("\\precsim" . ?≾)
("\\prime" . ?′)
("\\prod" . ?∏)
("\\propto" . ?∝)
("\\qed" . ?∎)
("\\qquad" . ?⧢)
("\\quad" . ?␣)
("\\rangle" . 10217) ; Literal ?⟩ breaks indentation.
("\\rbrace" . ?})
("\\rbrack" . ?\])
("\\rceil" . ?⌉)
("\\rfloor" . ?⌋)
("\\rightarrow" . ?→)
("\\rightarrowtail" . ?↣)
("\\rightharpoondown" . ?⇁)
("\\rightharpoonup" . ?⇀)
("\\rightleftarrows" . ?⇄)
("\\rightleftharpoons" . ?⇌)
;; ("\\rightparengtr" ?⦔) ;; Was ?〉, see bug#12948.
("\\rightrightarrows" . ?⇉)
("\\rightthreetimes" . ?⋌)
("\\risingdotseq" . ?≓)
("\\rtimes" . ?⋊)
("\\times" . ?×)
("\\sbs" . ?﹨)
("\\searrow" . ?↘)
("\\setminus" . ?∖)
("\\sharp" . ?♯)
("\\shortmid" . ?∣)
("\\shortparallel" . ?∥)
("\\sim" . ?∼)
("\\simeq" . ?≃)
("\\smallamalg" . ?∐)
("\\smallsetminus" . ?∖)
("\\smallsmile" . ?⌣)
("\\smile" . ?⌣)
("\\spadesuit" . ?♠)
("\\sphericalangle" . ?∢)
("\\sqcap" . ?⊓)
("\\sqcup" . ?⊔)
("\\sqsubset" . ?⊏)
("\\sqsubseteq" . ?⊑)
("\\sqsupset" . ?⊐)
("\\sqsupseteq" . ?⊒)
("\\square" . ?□)
("\\squigarrowright" . ?⇝)
("\\star" . ?⋆)
("\\straightphi" . ?φ)
("\\subset" . ?⊂)
("\\subseteq" . ?⊆)
("\\subseteqq" . ?⊆)
("\\subsetneq" . ?⊊)
("\\subsetneqq" . ?⊊)
("\\succ" . ?≻)
("\\succapprox" . ?≿)
("\\succcurlyeq" . ?≽)
("\\succeq" . ?≽)
("\\succnapprox" . ?⋩)
("\\succnsim" . ?⋩)
("\\succsim" . ?≿)
("\\sum" . ?∑)
("\\supset" . ?⊃)
("\\supseteq" . ?⊇)
("\\supseteqq" . ?⊇)
("\\supsetneq" . ?⊋)
("\\supsetneqq" . ?⊋)
("\\surd" . ?√)
("\\swarrow" . ?↙)
("\\therefore" . ?∴)
("\\thickapprox" . ?≈)
("\\thicksim" . ?∼)
("\\to" . ?→)
("\\top" . ?⊤)
("\\triangle" . ?▵)
("\\triangledown" . ?▿)
("\\triangleleft" . ?◃)
("\\trianglelefteq" . ?⊴)
("\\triangleq" . ?≜)
("\\triangleright" . ?▹)
("\\trianglerighteq" . ?⊵)
("\\twoheadleftarrow" . ?↞)
("\\twoheadrightarrow" . ?↠)
("\\ulcorner" . ?⌜)
("\\uparrow" . ?↑)
("\\updownarrow" . ?↕)
("\\upleftharpoon" . ?↿)
("\\uplus" . ?⊎)
("\\uprightharpoon" . ?↾)
("\\upuparrows" . ?⇈)
("\\urcorner" . ?⌝)
("\\u{i}" . ?ĭ)
("\\vDash" . ?⊨)
("\\varepsilon" . ?ε)
("\\varphi" . ?φ)
("\\varprime" . ?′)
("\\varpropto" . ?∝)
("\\varrho" . ?ϱ)
("\\varsigma" . ?ς)
("\\vartriangleleft" . ?⊲)
("\\vartriangleright" . ?⊳)
("\\vdash" . ?⊢)
("\\vdots" . ?⋮)
("\\vee" . ?∨)
("\\veebar" . ?⊻)
("\\vert" . ?|)
("\\wedge" . ?∧)
("\\wp" . ?℘)
("\\wr" . ?≀)
("\\Bbb{N}" . ?ℕ) ; AMS commands for blackboard bold
("\\Bbb{P}" . ?ℙ) ; Also sometimes \mathbb.
("\\Bbb{Q}" . ?ℚ)
("\\Bbb{R}" . ?ℝ)
("\\Bbb{T}" . ?𝕋)
("\\Bbb{Z}" . ?ℤ)
("\\mathbb{N}" . ?ℕ) ; AMS commands for blackboard bold
("\\mathbb{P}" . ?ℙ) ; Also sometimes \mathbb.
("\\mathbb{Q}" . ?ℚ)
("\\mathbb{R}" . ?ℝ)
("\\mathbb{T}" . ?𝕋)
("\\mathbb{Z}" . ?ℤ)
("\\pm" . ?±)
("\\|" . ?‖)
("\\varkappa" . ?ϰ)
;; caligraphic
("\\mathcal{A}" . ?𝒜)
("\\mathcal{B}" . ?ℬ)
("\\mathcal{C}" . ?𝒞)
("\\mathcal{D}" . ?𝒟)
("\\mathcal{E}" . ?ℰ)
("\\mathcal{F}" . ?ℱ)
("\\mathcal{G}" . ?𝒢)
("\\mathcal{H}" . ?ℋ)
("\\mathcal{I}" . ?ℐ)
("\\mathcal{J}" . ?𝒥)
("\\mathcal{K}" . ?𝒦)
("\\mathcal{L}" . ?ℒ)
("\\mathcal{M}" . ?ℳ)
("\\mathcal{N}" . ?𝒩)
("\\mathcal{O}" . ?𝒪)
("\\mathcal{P}" . ?𝒫)
("\\mathcal{Q}" . ?𝒬)
("\\mathcal{R}" . ?ℛ)
("\\mathcal{S}" . ?𝒮)
("\\mathcal{T}" . ?𝒯)
("\\mathcal{U}" . ?𝒰)
("\\mathcal{V}" . ?𝒱)
("\\mathcal{W}" . ?𝒲)
("\\mathcal{X}" . ?𝒳)
("\\mathcal{Y}" . ?𝒴)
("\\mathcal{Z}" . ?𝒵)
;; fractur
("\\mathfrak{A}" . ?𝔄)
("\\mathfrak{B}" . ?𝔅)
("\\mathfrak{C}" . ?ℭ)
("\\mathfrak{D}" . ?𝔇)
("\\mathfrak{E}" . ?𝔈)
("\\mathfrak{F}" . ?𝔉)
("\\mathfrak{G}" . ?𝔊)
("\\mathfrak{H}" . ?ℌ)
("\\mathfrak{I}" . ?ℑ)
("\\mathfrak{J}" . ?𝔍)
("\\mathfrak{K}" . ?𝔎)
("\\mathfrak{L}" . ?𝔏)
("\\mathfrak{M}" . ?𝔐)
("\\mathfrak{N}" . ?𝔑)
("\\mathfrak{O}" . ?𝔒)
("\\mathfrak{P}" . ?𝔓)
("\\mathfrak{Q}" . ?𝔔)
("\\mathfrak{R}" . ?ℜ)
("\\mathfrak{S}" . ?𝔖)
("\\mathfrak{T}" . ?𝔗)
("\\mathfrak{U}" . ?𝔘)
("\\mathfrak{V}" . ?𝔙)
("\\mathfrak{W}" . ?𝔚)
("\\mathfrak{X}" . ?𝔛)
("\\mathfrak{Y}" . ?𝔜)
("\\mathfrak{Z}" . ?ℨ)
("\\mathfrak{a}" . ?𝔞)
("\\mathfrak{b}" . ?𝔟)
("\\mathfrak{c}" . ?𝔠)
("\\mathfrak{d}" . ?𝔡)
("\\mathfrak{e}" . ?𝔢)
("\\mathfrak{f}" . ?𝔣)
("\\mathfrak{g}" . ?𝔤)
("\\mathfrak{h}" . ?𝔥)
("\\mathfrak{i}" . ?𝔦)
("\\mathfrak{j}" . ?𝔧)
("\\mathfrak{k}" . ?𝔨)
("\\mathfrak{l}" . ?𝔩)
("\\mathfrak{m}" . ?𝔪)
("\\mathfrak{n}" . ?𝔫)
("\\mathfrak{o}" . ?𝔬)
("\\mathfrak{p}" . ?𝔭)
("\\mathfrak{q}" . ?𝔮)
("\\mathfrak{r}" . ?𝔯)
("\\mathfrak{s}" . ?𝔰)
("\\mathfrak{t}" . ?𝔱)
("\\mathfrak{u}" . ?𝔲)
("\\mathfrak{v}" . ?𝔳)
("\\mathfrak{w}" . ?𝔴)
("\\mathfrak{x}" . ?𝔵)
("\\mathfrak{y}" . ?𝔶)
("\\mathfrak{z}" . ?𝔷)
("--" . ?–)
("---" . ?—)
("\\ordfeminine" . ?ª)
("\\ordmasculine" . ?º)
("\\lambdabar" . ?ƛ)
("\\celsius" . ?℃)
;; Text symbols formerly part of textcomp package:
("\\textdollar" . ?$)
("\\textborn" . ?*)
("\\textless" . ?<)
("\\textgreater" . ?>)
("\\textbackslash" . ?\\)
("\\textasciicircum" . ?^)
("\\textunderscore" . ?_)
("\\textbraceleft" . ?\{)
("\\textbar" . ?|)
("\\textbraceright" . ?\})
("\\textasciitilde" . ?~)
("\\textexclamdown" . ?¡)
("\\textcent" . ?¢)
("\\textsterling" . ?£)
("\\textcurrency" . ?¤)
("\\textyen" . ?¥)
("\\textbrokenbar" . ?¦)
("\\textsection" . ?§)
("\\textasciidieresis" . ?¨)
("\\textcopyright" . ?©)
("\\textordfeminine" . ?ª)
("\\guillemetleft" . ?«)
("\\guillemotleft" . ?«)
("\\textlnot" . ?¬)
("\\textregistered" . ?®)
("\\textasciimacron" . ?¯)
("\\textdegree" . ?°)
("\\textpm" . ?±)
("\\texttwosuperior" . ?²)
("\\textthreesuperior" . ?³)
("\\textasciiacute" . ?´)
("\\textmu" . ?µ)
("\\textparagraph" . ?¶)
("\\textpilcrow" . ?¶)
("\\textperiodcentered" . ?·)
("\\textonesuperior" . ?¹)
("\\textordmasculine" . ?º)
("\\guillemetright" . ?»)
("\\guillemotright" . ?»)
("\\textonequarter" . ?¼)
("\\textonehalf" . ?½)
("\\textthreequarters" . ?¾)
("\\textquestiondown" . ?¿)
("\\texttimes" . ?×)
("\\textdiv" . ?÷)
("\\textflorin" . ?ƒ)
("\\textasciicaron" . ?ˇ)
("\\textasciibreve" . ?˘)
("\\textacutedbl" . ?˝)
("\\textgravedbl" . 757)
("\\texttildelow" . 759)
("\\textbaht" . ?฿)
("\\textendash" . ?–)
("\\textemdash" . ?—)
("\\textbardbl" . ?‖)
("\\textquoteleft" . 8216)
("\\textquoteright" . 8217)
("\\quotesinglbase" . 8218)
("\\textquotedblleft" . 8220)
("\\textquotedblright" . 8221)
("\\quotedblbase" . 8222)
;; \textdagger and \textdied are replaced with DAGGER (#x2020) and
;; not with LATIN CROSS (#x271d)
("\\textdagger" . ?†)
("\\textdied" . ?†)
("\\textdaggerdbl" . ?‡)
("\\textbullet" . ?•)
("\\textellipsis" . ?…)
("\\textperthousand" . ?‰)
("\\textpertenthousand" . ?‱)
("\\guilsinglleft" . ?‹)
("\\guilsinglright" . ?›)
("\\textreferencemark" . ?※)
("\\textinterrobang" . ?‽)
("\\textfractionsolidus" . ?⁄)
("\\textlquill" . 8261) ; Literal ?⁅ breaks indentation
("\\textrquill" . 8262) ; Literal ?⁆ breaks indentation
("\\textdiscount" . ?⁒)
("\\textcolonmonetary" . ?₡)
("\\textlira" . ?₤)
("\\textnaira" . ?₦)
("\\textwon" . ?₩)
("\\textdong" . ?₫)
("\\texteuro" . ?€)
("\\textpeso" . ?₱)
("\\textguarani" . ?₲)
("\\textcelsius" . ?℃)
("\\textnumero" . ?№)
("\\textcircledP" . ?℗)
("\\textrecipe" . ?℞)
("\\textservicemark" . ?℠)
("\\texttrademark" . ?™)
("\\textohm" . ?Ω)
("\\textmho" . ?℧)
("\\textestimated" . ?℮)
("\\textleftarrow" . ?←)
("\\textuparrow" . ?↑)
("\\textrightarrow" . ?→)
("\\textdownarrow" . ?↓)
("\\textminus" . ?−)
("\\textsurd" . ?√)
("\\textlangle" . 9001) ; Literal ?〈 breaks indentation
("\\textrangle" . 9002) ; Literal ?〉 breaks indentation
("\\textblank" . ?␢)
("\\textvisiblespace" . ?␣)
("\\textopenbullet" . ?◦)
;; \textbigcircle is replaced with LARGE CIRCLE (#x25ef) and not
;; with COMBINING ENCLOSING CIRCLE (#x20dd)
("\\textbigcircle" . ?◯)
("\\textmusicalnote" . ?♪)
("\\textmarried" . ?⚭)
("\\textdivorced" . ?⚮)
("\\textlbrackdbl" . 10214) ; Literal ?⟦ breaks indentation
("\\textrbrackdbl" . 10215) ; Literal ?⟧ breaks indentation
("\\textinterrobangdown" . ?⸘))
"A `prettify-symbols-alist' usable for (La)TeX modes.")
(defun tex--prettify-symbols-compose-p (_start end _match)
(or
;; If the matched symbol doesn't end in a word character, then we
;; simply allow composition. The symbol is probably something like
;; \|, \(, etc.
(not (eq ?w (char-syntax (char-before end))))
;; Else we look at what follows the match in order to decide.
(let* ((after-char (char-after end))
(after-syntax (char-syntax after-char)))
(not (or
;; Don't compose \alpha@foo.
(eq after-char ?@)
;; The \alpha in \alpha2 or \alpha-\beta may be composed but
;; of course \alphax may not.
(and (eq after-syntax ?w)
(not (memq after-char
'(?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?+ ?- ?' ?\"))))
;; Don't compose inside verbatim blocks.
(eq 2 (nth 7 (syntax-ppss))))))))
;;; Flymake support
(defvar-local tex-chktex--process nil)
(defun tex-chktex-command ()
"Return a list of command arguments for invoking ChkTeX."
`(,tex-chktex-program ,@tex-chktex-extra-flags
"--quiet" "--verbosity=0" "--inputfiles"))
(defun tex-chktex (report-fn &rest _args)
"Flymake backend for linting TeX buffers with ChkTeX."
(unless (executable-find tex-chktex-program)
(error "Cannot find a suitable TeX checker"))
(when (process-live-p tex-chktex--process)
(kill-process tex-chktex--process))
(let ((source (current-buffer))
(re "^stdin:\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\):\\(.*\\)$"))
(save-restriction
(widen)
(setq tex-chktex--process
(make-process
:name "tex-chktex"
:buffer (generate-new-buffer "*tex-chktex*")
:command (tex-chktex-command)
:noquery t :connection-type 'pipe
:sentinel
(lambda (process _event)
(when (eq (process-status process) 'exit)
(unwind-protect
(when (eq process
(with-current-buffer source tex-chktex--process))
(with-current-buffer (process-buffer process)
(goto-char (point-min))
(cl-loop
while (search-forward-regexp re nil t)
for msg = (match-string 4)
for line = (string-to-number (match-string 1))
for col = (string-to-number (match-string 2))
for (beg . end) = (flymake-diag-region source line col)
collect (flymake-make-diagnostic source beg end :warning msg)
into diags
finally (funcall report-fn diags))))
(kill-buffer (process-buffer process)))))))
(process-send-region tex-chktex--process (point-min) (point-max))
(process-send-eof tex-chktex--process))))
(make-obsolete-variable 'tex-mode-load-hook
"use `with-eval-after-load' instead." "28.1")
(run-hooks 'tex-mode-load-hook)
(provide 'tex-mode)
;;; tex-mode.el ends here
|