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
|
;;; tex-buf.el --- External commands for AUCTeX.
;; Copyright (C) 1993, 1996, 2001, 2003, 2004,
;; 2005, 2006 Free Software Foundation, Inc.
;; Copyright (C) 1991 Kresten Krab Thorup
;; Maintainer: auctex-devel@gnu.org
;; Keywords: tex, wp
;; This file is part of AUCTeX.
;; AUCTeX is free software; you can redistribute it and/or modify it
;; under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; AUCTeX 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 AUCTeX; see the file COPYING. If not, write to the Free
;; Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
;; 02110-1301, USA.
;;; Commentary:
;; This file provides support for external commands.
;;; Code:
(require 'tex)
;;; Customization:
(defcustom TeX-process-asynchronous (not (eq system-type 'ms-dos))
"*Use asynchronous processes."
:group 'TeX-command
:type 'boolean)
(defcustom TeX-shell
(if (memq system-type '(ms-dos emx windows-nt))
shell-file-name
"/bin/sh")
"Name of shell used to parse TeX commands."
:group 'TeX-command
:type 'file)
(defcustom TeX-shell-command-option
(cond ((memq system-type '(ms-dos emx windows-nt) )
(cond ((boundp 'shell-command-option)
shell-command-option)
((boundp 'shell-command-switch)
shell-command-switch)
(t
"/c")))
(t ;Unix & EMX (Emacs 19 port to OS/2)
"-c"))
"Shell argument indicating that next argument is the command."
:group 'TeX-command
:type 'string)
;;; Interactive Commands
;;
;; The general idea is, that there is one process and process buffer
;; associated with each master file, and one process and process buffer
;; for running TeX on a region. Thus, if you have N master files, you
;; can run N + 1 processes simultaneously.
;;
;; Some user commands operates on ``the'' process. The following
;; algorithm determine what ``the'' process is.
;;
;; IF last process started was on a region
;; THEN ``the'' process is the region process
;; ELSE ``the'' process is the master file (of the current buffer) process
(defun TeX-save-document (name)
"Save all files belonging to the current document.
Return non-nil if document need to be re-TeX'ed."
(interactive (list (TeX-master-file)))
(if (string-equal name "")
(setq name (TeX-master-file)))
(TeX-check-files (concat name "." (TeX-output-extension))
(cons name (TeX-style-list))
TeX-file-extensions))
(defun TeX-command-master (&optional override-confirm)
"Run command on the current document.
If a prefix argument OVERRIDE-CONFIRM is given, confirmation will
depend on it being positive instead of the entry in `TeX-command-list'."
(interactive "P")
(TeX-command (TeX-command-query (TeX-master-file)) 'TeX-master-file
override-confirm))
(defvar TeX-command-region-begin nil)
(defvar TeX-command-region-end nil)
;; Used for marking the last region.
(make-variable-buffer-local 'TeX-command-region-begin)
(make-variable-buffer-local 'TeX-command-region-end)
(defun TeX-current-offset (&optional pos)
"Calculate line offset of POS, or of point if POS is nil."
(save-restriction
(widen)
(save-excursion
(let ((inhibit-point-motion-hooks t)
(inhibit-field-text-motion t))
(if pos (goto-char pos))
(+ (count-lines (point-min) (point))
(if (bolp) 0 -1))))))
(defun TeX-pin-region (begin end)
"Pin the TeX region specified by BEGIN and END.
If BEGIN is nil, the region is unpinned.
In interactive use, a positive prefix arg will pin the region,
a non-positive one will unpin it. Without a prefix arg, if
a region is actively marked, it will get pinned. If not, a
pinned region will get unpinned and vice versa."
(interactive
(if
(if current-prefix-arg
(> (prefix-numeric-value current-prefix-arg) 0)
(or (TeX-active-mark)
(null TeX-command-region-begin)))
(list (region-beginning) (region-end))
'(nil nil)))
(if begin
(progn
(unless (markerp TeX-command-region-begin)
(setq TeX-command-region-begin (make-marker))
(setq TeX-command-region-end (make-marker)))
(set-marker TeX-command-region-begin begin)
(set-marker TeX-command-region-end end)
(message "TeX region pinned."))
(when (markerp TeX-command-region-begin)
(set-marker TeX-command-region-begin nil)
(set-marker TeX-command-region-end nil))
(setq TeX-command-region-begin nil)
(setq TeX-command-region-end nil)
(message "TeX region unpinned.")))
(defun TeX-command-region (&optional override-confirm)
"Run TeX on the current region.
Query the user for a command to run on the temporary file specified by
the variable `TeX-region'. If there is an explicitly active region,
it is stored for later commands. If not, a previously stored region
\(can be also be set with `TeX-pin-region') overrides the current region,
if present.
If a prefix argument OVERRIDE-CONFIRM is given, prompting will
ignore the prompting flag from `TeX-command-list' and instead
will prompt iff the prefix is positive.
If the master file for the document has a header, it is written to the
temporary file before the region itself. The document's header is all
text before TeX-header-end.
If the master file for the document has a trailer, it is written to
the temporary file before the region itself. The document's trailer is
all text after TeX-trailer-start."
(interactive "P")
;; Note that TeX-command-region-begin is not a marker when called
;; from TeX-command-buffer.
(and (or (null TeX-command-region-begin)
(markerp TeX-command-region-begin))
(TeX-active-mark)
(TeX-pin-region (region-beginning) (region-end)))
(let ((begin (or TeX-command-region-begin (region-beginning)))
(end (or TeX-command-region-end (region-end))))
(TeX-region-create (TeX-region-file TeX-default-extension)
(buffer-substring begin end)
(file-name-nondirectory (buffer-file-name))
(TeX-current-offset begin)))
(TeX-command (TeX-command-query (TeX-region-file nil t)) 'TeX-region-file
override-confirm))
(defun TeX-command-buffer (&optional override-confirm)
"Run TeX on the current buffer.
Query the user for a command to run on the temporary file specified by
the variable TeX-region. The region file file be recreated from the
visible part of the buffer.
If a prefix argument OVERRIDE-CONFIRM is given, confirmation will
depend on it being positive instead of the entry in `TeX-command-list'."
(interactive "P")
(let ((TeX-command-region-begin (point-min))
(TeX-command-region-end (point-max)))
(TeX-command-region override-confirm)))
(defun TeX-recenter-output-buffer (line)
"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
at bottom if LINE is nil."
(interactive "P")
(let ((buffer (TeX-active-buffer)))
(if buffer
(let ((old-buffer (current-buffer)))
(pop-to-buffer buffer t)
(bury-buffer buffer)
(goto-char (point-max))
(recenter (if line
(prefix-numeric-value line)
(/ (window-height) 2)))
(pop-to-buffer old-buffer))
(message "No process for this document."))))
(defun TeX-kill-job ()
"Kill the currently running TeX job."
(interactive)
(let ((process (TeX-active-process)))
(if process
(kill-process process)
;; Should test for TeX background process here.
(error "No TeX process to kill"))))
(defun TeX-home-buffer ()
"Go to the buffer where you last issued a TeX command.
If there is no such buffer, or you already are in that buffer, find
the master file."
(interactive)
(if (or (null TeX-command-buffer)
(null (buffer-name TeX-command-buffer))
(eq TeX-command-buffer (current-buffer)))
(find-file (TeX-master-file TeX-default-extension))
(switch-to-buffer TeX-command-buffer)))
(defun TeX-next-error (reparse)
"Find the next error in the TeX output buffer.
Prefix by C-u to start from the beginning of the errors."
(interactive "P")
(if (null (TeX-active-buffer))
(next-error reparse)
(funcall (TeX-process-get-variable (with-current-buffer TeX-command-buffer
(TeX-active-master))
'TeX-parse-function)
reparse)))
(defun TeX-previous-error (arg)
"Find the previous error in the TeX output buffer."
(interactive "P")
(if (null (TeX-active-buffer))
(previous-error arg)
(error "Jumping to previous error not supported")))
;;; Command Query
(defun TeX-command (name file &optional override-confirm)
"Run command NAME on the file returned by calling FILE.
FILE is the symbol of a function returning a file name. The
function has one optional argument, the extension to use on the
file.
Use the information in `TeX-command-list' to determine how to run
the command.
If OVERRIDE-CONFIRM is a prefix argument, confirmation will be
asked if it is positive, and suppressed if it is not."
(cond ((eq file 'TeX-region-file)
(setq TeX-current-process-region-p t))
((eq file 'TeX-master-file)
(setq TeX-current-process-region-p nil)))
(let ((command (TeX-command-expand (nth 1 (assoc name TeX-command-list))
file))
(hook (nth 2 (assoc name TeX-command-list)))
(confirm (if override-confirm
(> (prefix-numeric-value override-confirm) 0)
(nth 3 (assoc name TeX-command-list)))))
;; Verify the expanded command
(if confirm
(setq command
(read-from-minibuffer (concat name " command: ") command
nil nil)))
;; Now start the process
(setq file (funcall file))
(TeX-process-set-variable file 'TeX-command-next TeX-command-Show)
(funcall hook name command file)))
(defun TeX-command-expand (command file &optional list)
"Expand COMMAND for FILE as described in LIST.
LIST default to `TeX-expand-list'. As a special exception,
`%%' can be used to produce a single `%' sign in the output
without further expansion."
(let (pat
pos
entry
case-fold-search string expansion arguments)
(setq list (cons
(list "%%" (lambda nil
(setq pos (1+ pos))
"%"))
(or list TeX-expand-list))
pat (regexp-opt (mapcar #'car list)))
(while (setq pos (string-match pat command pos))
(setq string (match-string 0 command)
entry (assoc string list)
expansion (car (cdr entry)) ;Second element
arguments (cdr (cdr entry)) ;Remaining elements
command (replace-match
(save-match-data
(cond ((TeX-function-p expansion)
(apply expansion arguments))
((boundp expansion)
(apply (eval expansion) arguments))
(t
(error "Nonexpansion %s" expansion))))
t t command))))
command)
(defun TeX-check-files (derived originals extensions)
"Check that DERIVED is newer than any of the ORIGINALS.
Try each original with each member of EXTENSIONS, in all directories
in TeX-check-path."
(let ((found nil)
(regexp (concat "\\`\\("
(mapconcat (lambda (dir)
(regexp-quote
(expand-file-name
(file-name-as-directory dir))))
TeX-check-path "\\|")
"\\).*\\("
(mapconcat 'regexp-quote originals "\\|")
"\\)\\.\\("
(mapconcat 'regexp-quote extensions "\\|")
"\\)\\'"))
(buffers (buffer-list)))
(while buffers
(let* ((buffer (car buffers))
(name (buffer-file-name buffer)))
(setq buffers (cdr buffers))
(if (and name (string-match regexp name))
(progn
(and (buffer-modified-p buffer)
(or (not TeX-save-query)
(y-or-n-p (concat "Save file "
(buffer-file-name buffer)
"? ")))
(save-excursion (set-buffer buffer) (save-buffer)))
(if (file-newer-than-file-p name derived)
(setq found t))))))
found))
(defcustom TeX-save-query t
"*If non-nil, ask user for permission to save files before starting TeX."
:group 'TeX-command
:type 'boolean)
(defvar TeX-command-history nil)
(defun TeX-command-query (name)
"Query the user for what TeX command to use."
(let* ((default (cond ((if (string-equal name TeX-region)
(TeX-check-files (concat name "." (TeX-output-extension))
(list name)
TeX-file-extensions)
(TeX-save-document (TeX-master-file)))
TeX-command-default)
((and (memq major-mode '(doctex-mode latex-mode))
(TeX-check-files (concat name ".bbl")
(mapcar 'car
(LaTeX-bibliography-list))
BibTeX-file-extensions))
;; We should check for bst files here as well.
TeX-command-BibTeX)
((TeX-process-get-variable name
'TeX-command-next
TeX-command-Show))
(TeX-command-Show)))
(completion-ignore-case t)
(answer (or TeX-command-force
(completing-read
(concat "Command: (default " default ") ")
(TeX-mode-specific-command-list major-mode) nil t
nil 'TeX-command-history))))
;; If the answer "latex" it will not be expanded to "LaTeX"
(setq answer (car-safe (TeX-assoc answer TeX-command-list)))
(if (and answer
(not (string-equal answer "")))
answer
default)))
(defvar TeX-command-next nil
"The default command next time TeX-command is invoked.")
(make-variable-buffer-local 'TeX-command-next)
(defun TeX-printer-query (&optional queue)
"Query the user for a printer name.
QUEUE is non-nil when we are checking for the printer queue."
(let (command element printer)
(if queue
(unless (setq element 2 command TeX-queue-command)
(error "Need to customize `TeX-queue-command'"))
(unless (setq element 1 command TeX-print-command)
(error "Need to customize `TeX-print-command'")))
(while (progn
(setq printer (if TeX-printer-list
(let ((completion-ignore-case t))
(completing-read
(concat "Printer: "
(and TeX-printer-default
(concat "(default "
TeX-printer-default ") ")))
TeX-printer-list))
""))
(setq printer (or (car-safe (TeX-assoc printer TeX-printer-list))
printer))
(not (if (or (null printer) (string-equal "" printer))
(setq printer TeX-printer-default)
(setq TeX-printer-default printer)))))
(let ((expansion (let ((entry (assoc printer TeX-printer-list)))
(or (nth element entry)
command))))
(if (string-match "%p" printer)
(error "Don't use %s in printer names" "%p"))
(while (string-match "%p" expansion)
(setq expansion (replace-match printer t t expansion 0)))
expansion)))
(defun TeX-style-check (styles)
"Check STYLES compared to the current style options."
(let ((files (TeX-style-list)))
(while (and styles
(not (TeX-member (car (car styles)) files 'string-match)))
(setq styles (cdr styles))))
(if styles
(nth 1 (car styles))
""))
(defun TeX-output-extension ()
"Get the extension of the current TeX output file"
(if (listp TeX-output-extension)
(car TeX-output-extension)
(or (TeX-process-get-variable (TeX-active-master)
'TeX-output-extension
TeX-output-extension)
TeX-output-extension)))
(defun TeX-view-output-file ()
"Get the name of the current TeX output file"
(TeX-active-master (TeX-output-extension) t))
(defun TeX-view-mouse (event)
"Start `TeX-view' at mouse position."
(interactive "e")
(save-excursion
(set-buffer (window-buffer (posn-window (event-start event))))
(goto-char (posn-point (event-start event)))
(TeX-view)))
(defun TeX-view ()
"Start a viewer without confirmation.
The viewer is started either on region or master file,
depending on the last command issued."
(interactive)
(let ((output-file (TeX-active-master (TeX-output-extension))))
(if (file-exists-p output-file)
(TeX-command "View" 'TeX-active-master 0)
(message "Output file %S does not exist." output-file))))
(defun TeX-output-style-check (styles)
"Check STYLES compared to the current view output file extension and
the current style options."
(let ((ext (TeX-output-extension))
(files (TeX-style-list)))
(while (and
styles
(or
(not (string-match (car (car styles)) ext))
(let ((style (nth 1 (car styles))))
(cond
((listp style)
(while
(and style
(TeX-member (car style) files 'string-match))
(setq style (cdr style)))
style)
((not (TeX-member style files 'string-match)))))))
(setq styles (cdr styles)))
(if styles
(nth 2 (car styles))
"%v")))
;;; Command Hooks
(defvar TeX-after-start-process-function nil
"Hooks to run after starting an asynchronous process.
Used by Japanese TeX to set the coding system.")
(defcustom TeX-show-compilation nil
"*If non-nil, show output of TeX compilation in other window."
:group 'TeX-command
:type 'boolean)
(defun TeX-run-command (name command file)
"Create a process for NAME using COMMAND to process FILE.
Return the new process."
(let ((default TeX-command-default)
(buffer (TeX-process-buffer-name file))
(dir (TeX-master-directory))
(command-buff (current-buffer)))
(TeX-process-check file) ; Check that no process is running
(setq-default TeX-command-buffer command-buff)
(get-buffer-create buffer)
(set-buffer buffer)
(erase-buffer)
(set (make-local-variable 'line-number-display-limit) 0)
(setq TeX-output-extension nil)
(set (make-local-variable 'TeX-command-buffer) command-buff)
(if dir (cd dir))
(insert "Running `" name "' on `" file "' with ``" command "''\n")
(setq mode-name name)
(if TeX-show-compilation
(display-buffer buffer)
(message "Type `C-c C-l' to display results of compilation."))
(setq TeX-parse-function 'TeX-parse-command)
(setq TeX-command-default default)
(setq TeX-sentinel-function
(lambda (process name)
(message (concat name ": done."))))
(if TeX-process-asynchronous
(let ((process (start-process name buffer TeX-shell
TeX-shell-command-option command)))
(if TeX-after-start-process-function
(funcall TeX-after-start-process-function process))
(TeX-command-mode-line process)
(set-process-filter process 'TeX-command-filter)
(set-process-sentinel process 'TeX-command-sentinel)
(set-marker (process-mark process) (point-max))
(setq compilation-in-progress (cons process compilation-in-progress))
process)
(setq mode-line-process ": run")
(set-buffer-modified-p (buffer-modified-p))
(sit-for 0) ; redisplay
(call-process TeX-shell nil buffer nil
TeX-shell-command-option command))))
(defun TeX-run-set-command (name command)
"Remember TeX command to use to NAME and set corresponding output extension"
(setq TeX-command-default name
TeX-output-extension (if TeX-PDF-mode "pdf" "dvi"))
(let ((case-fold-search t)
(lst TeX-command-output-list))
(while lst
(if (string-match (car (car lst)) command)
(setq TeX-output-extension (car (cdr (car lst)))
lst nil)
(setq lst (cdr lst))))))
(defun TeX-run-format (name command file)
"Create a process for NAME using COMMAND to format FILE with TeX."
(TeX-run-set-command name command)
(let ((buffer (TeX-process-buffer-name file))
(process (TeX-run-command name command file)))
;; Hook to TeX debuger.
(save-excursion
(set-buffer buffer)
(TeX-parse-reset)
(setq TeX-parse-function 'TeX-parse-TeX)
(setq TeX-sentinel-function 'TeX-TeX-sentinel)
(if TeX-process-asynchronous
(progn
;; Updating the mode line.
(setq TeX-current-page "[0]")
(TeX-format-mode-line process)
(set-process-filter process 'TeX-format-filter)))
process)))
(defvar TeX-error-report-switches nil
"Reports presence of errors after `TeX-run-TeX'.
To test whether the current buffer has an compile error from last
run of `TeX-run-TeX', use
(plist-get TeX-error-report-switches (intern (TeX-master-file)))")
(defun TeX-run-TeX (name command file)
"Create a process for NAME using COMMAND to format FILE with TeX."
;; Save information in TeX-error-report-switches
;; Initialize error to nil (no error) for current master.
;; Presence of error is reported inside `TeX-TeX-sentinel-check'
(let ((current-master (TeX-master-file)))
;; the current master file is saved because error routines are
;; parsed in other buffers;
(setq TeX-error-report-switches
(plist-put TeX-error-report-switches
'TeX-current-master current-master))
;; reset error to nil (no error)
(setq TeX-error-report-switches
(plist-put TeX-error-report-switches
(intern current-master) nil)))
;; can we assume that TeX-sentinel-function will not be changed
;; during (TeX-run-format ..)? --pg
;; rather use let* ? --pg
(if TeX-interactive-mode
(TeX-run-interactive name command file)
(let ((sentinel-function TeX-sentinel-default-function))
(let ((process (TeX-run-format name command file)))
(setq TeX-sentinel-function sentinel-function)
(if TeX-process-asynchronous
process
(TeX-synchronous-sentinel name file process))))))
;; backward compatibilty
(defalias 'TeX-run-LaTeX 'TeX-run-TeX)
(defun TeX-run-BibTeX (name command file)
"Create a process for NAME using COMMAND to format FILE with BibTeX."
(let ((process (TeX-run-command name command file)))
(setq TeX-sentinel-function 'TeX-BibTeX-sentinel)
(if TeX-process-asynchronous
process
(TeX-synchronous-sentinel name file process))))
(defun TeX-run-compile (name command file)
"Ignore first and third argument, start compile with second argument."
(compile command))
(defun TeX-run-shell (name command file)
"Ignore first and third argument, start shell-command with second argument."
(let ((default-directory (TeX-master-directory)))
(shell-command command)
(if (eq system-type 'ms-dos)
(redraw-display))))
(defun TeX-run-discard (name command file)
"Start process with second argument, discarding its output."
(let ((default-directory (TeX-master-directory)))
(call-process TeX-shell
nil 0 nil
TeX-shell-command-option
command)))
(defun TeX-run-discard-foreground (name command file)
"Call process with second argument in the foreground, discarding its output.
With support for MS-DOS, especially when dviout is used with PC-9801 series."
(if (and (boundp 'dos-machine-type) (eq dos-machine-type 'pc98)) ;if PC-9801
(send-string-to-terminal "\e[2J")) ; clear screen
(call-process TeX-shell (if (eq system-type 'ms-dos) "con") nil nil
TeX-shell-command-option command)
(if (eq system-type 'ms-dos)
(redraw-display)))
(defalias 'TeX-run-dviout 'TeX-run-discard-foreground)
(defun TeX-run-background (name command file)
"Start process with second argument, show output when and if it arrives."
(let ((dir (TeX-master-directory)))
(set-buffer (get-buffer-create "*TeX background*"))
(if dir (cd dir))
(erase-buffer)
(let ((process (start-process (concat name " background")
nil TeX-shell
TeX-shell-command-option command)))
(if TeX-after-start-process-function
(funcall TeX-after-start-process-function process))
(set-process-filter process 'TeX-background-filter)
(process-kill-without-query process))))
(defun TeX-run-silent (name command file)
"Start process with second argument."
(let ((dir (TeX-master-directory)))
(set-buffer (get-buffer-create "*TeX silent*"))
(if dir (cd dir))
(erase-buffer)
(let ((process (start-process (concat name " silent")
nil TeX-shell
TeX-shell-command-option command)))
(if TeX-after-start-process-function
(funcall TeX-after-start-process-function process))
(process-kill-without-query process))))
(defun TeX-run-interactive (name command file)
"Run TeX interactively.
Run command in a buffer (in comint-shell-mode) so that it accepts user
interaction. If you return to the file buffer after the TeX run,
Error parsing on C-x ` should work with a bit of luck."
(TeX-run-set-command name command)
(require 'comint)
(let ((default TeX-command-default)
(buffer (TeX-process-buffer-name file))
(process nil)
(dir (TeX-master-directory))
(command-buff (current-buffer))
(sentinel-function TeX-sentinel-default-function)) ; inherit from major mode
(TeX-process-check file) ; Check that no process is running
(setq-default TeX-command-buffer command-buff)
(with-output-to-temp-buffer buffer)
(set-buffer buffer)
(set (make-local-variable 'TeX-command-buffer) command-buff)
(setq buffer-read-only nil)
(if dir (cd dir))
(insert "Running `" name "' on `" file "' with ``" command "''\n")
(comint-exec buffer name TeX-shell nil
(list TeX-shell-command-option command))
(comint-mode)
(add-hook 'comint-output-filter-functions 'TeX-interactive-goto-prompt)
(setq mode-name name)
(setq TeX-command-default default)
(setq process (get-buffer-process buffer))
(if TeX-after-start-process-function
(funcall TeX-after-start-process-function process))
(TeX-command-mode-line process)
(set-process-sentinel process 'TeX-command-sentinel)
(set-marker (process-mark process) (point-max))
(setq compilation-in-progress (cons process compilation-in-progress))
(TeX-parse-reset)
(setq TeX-parse-function 'TeX-parse-TeX)
;; use the sentinel-function that the major mode sets, not the LaTeX one
(setq TeX-sentinel-function sentinel-function)))
(defun TeX-run-function (name command file)
"Execute Lisp function or function call given as the string COMMAND.
Parameters NAME and FILE are ignored."
(let ((fun (car (read-from-string command))))
(if (functionp fun) (funcall fun) (eval fun))))
(defun TeX-run-ispell-on-document (command ignored name)
"Run ispell on all open files belonging to the current document.
This function is *obsolete* and only here for compatibility
reasons. Use `TeX-run-function' instead."
(interactive)
(TeX-ispell-document ""))
;;; Command Sentinels
(defun TeX-synchronous-sentinel (name file result)
"Process TeX command output buffer after the process dies."
(let* ((buffer (TeX-process-buffer file)))
(save-excursion
(set-buffer buffer)
;; Append post-mortem information to the buffer
(goto-char (point-max))
(insert "\n" mode-name (if (and result (zerop result))
" finished" " exited") " at "
(substring (current-time-string) 0 -5))
(setq mode-line-process ": exit")
;; Do command specific actions.
(setq TeX-command-next TeX-command-Show)
(goto-char (point-min))
(apply TeX-sentinel-function nil name nil)
;; Force mode line redisplay soon
(set-buffer-modified-p (buffer-modified-p)))))
(defun TeX-command-sentinel (process msg)
"Process TeX command output buffer after the process dies."
;; Set `TeX-transient-master' here because `preview-parse-messages'
;; may open files and thereby trigger master file questions which we
;; don't want and need because we already know the master.
(let* ((TeX-transient-master (TeX-active-master))
(buffer (process-buffer process))
(name (process-name process)))
(cond ((null (buffer-name buffer)) ; buffer killed
(set-process-buffer process nil)
(set-process-sentinel process nil))
((memq (process-status process) '(signal exit))
(save-excursion
(set-buffer buffer)
;; Append post-mortem information to the buffer
(goto-char (point-max))
(insert-before-markers "\n" mode-name " " msg)
(forward-char -1)
(insert " at "
(substring (current-time-string) 0 -5))
(forward-char 1)
;; Do command specific actions.
(TeX-command-mode-line process)
(setq TeX-command-next TeX-command-Show)
(goto-char (point-min))
(apply TeX-sentinel-function process name nil)
;; If buffer and mode line will show that the process
;; is dead, we can delete it now. Otherwise it
;; will stay around until M-x list-processes.
(delete-process process)
;; Force mode line redisplay soon
(set-buffer-modified-p (buffer-modified-p))))))
(setq compilation-in-progress (delq process compilation-in-progress)))
(defvar TeX-sentinel-function (lambda (process name))
"Hook to cleanup TeX command buffer after temination of PROCESS.
NAME is the name of the process.")
(make-variable-buffer-local 'TeX-sentinel-function)
(defvar TeX-sentinel-default-function (lambda (process name))
"Default for TeX-sentinel-function. To be set in major mode.
Hook to cleanup TeX command buffer after temination of PROCESS.
NAME is the name of the process.")
(make-variable-buffer-local 'TeX-sentinel-default-function)
(defun TeX-TeX-sentinel (process name)
"Cleanup TeX output buffer after running TeX."
(if (TeX-TeX-sentinel-check process name)
()
(message (concat name ": formatted " (TeX-current-pages)))
(setq TeX-command-next TeX-command-Show)))
(defun TeX-current-pages ()
;; String indictating the number of pages formatted.
(cond ((null TeX-current-page)
"some pages.")
((string-match "[^0-9]1[^0-9]" TeX-current-page)
(concat TeX-current-page " page."))
(t
(concat TeX-current-page " pages."))))
(defun TeX-TeX-sentinel-check (process name)
"Cleanup TeX output buffer after running TeX.
Return nil ifs no errors were found."
(save-excursion
(goto-char (point-max))
(if (re-search-backward "^Output written on \\(.*\\) (\\([0-9]+\\) page"
nil t)
(let ((output-file (TeX-match-buffer 1)))
(setq TeX-current-page (concat "{" (TeX-match-buffer 2) "}"))
(setq TeX-output-extension
(if (string-match "\\.\\([^.]*\\)$" output-file)
(match-string 1 output-file)
"dvi")))))
(if process (TeX-format-mode-line process))
(if (re-search-forward "^\\(!\\|.*:[0-9]+:\\) " nil t)
(progn
(message (concat name " errors in `" (buffer-name)
"'. Use C-c ` to display."))
(setq TeX-command-next TeX-command-default)
;; error reported to TeX-error-report-switches
(setq TeX-error-report-switches
(plist-put TeX-error-report-switches
(intern (plist-get TeX-error-report-switches
'TeX-current-master))
t))
t)
(setq TeX-command-next TeX-command-Show)
nil))
(defun TeX-LaTeX-sentinel-has-warnings ()
"Return non-nil, if the output buffer contains warnings.
Warnings can be indicated by LaTeX or packages."
(save-excursion
(goto-char (point-min))
(re-search-forward
"^\\(LaTeX [A-Za-z]*\\|Package [A-Za-z]+ \\)Warning:" nil t)))
(defun TeX-LaTeX-sentinel-has-bad-boxes ()
"Return non-nil, if LaTeX output indicates overfull or underfull boxes."
(save-excursion
(goto-char (point-min))
(re-search-forward "^\\(Ov\\|Und\\)erfull \\\\" nil t)))
;; should go into latex.el? --pg
(defun TeX-LaTeX-sentinel (process name)
"Cleanup TeX output buffer after running LaTeX."
(cond ((TeX-TeX-sentinel-check process name))
((and (save-excursion
(or
(re-search-forward "^LaTeX Warning: Citation" nil t)
(re-search-forward "^Package natbib Warning: Citation" nil t)))
(with-current-buffer TeX-command-buffer
(and (LaTeX-bibliography-list)
(TeX-check-files (TeX-master-file "bbl")
(TeX-style-list)
(append TeX-file-extensions
BibTeX-file-extensions)))))
(message (concat "You should run BibTeX to get citations right, "
(TeX-current-pages)))
(setq TeX-command-next (with-current-buffer TeX-command-buffer
TeX-command-BibTeX)))
((or
(re-search-forward "^LaTeX Warning: Label(s)" nil t)
(re-search-forward "^Package natbib Warning: Citation(s)" nil t))
(message (concat "You should run LaTeX again "
"to get references right, "
(TeX-current-pages)))
(setq TeX-command-next TeX-command-default))
((re-search-forward "^LaTeX Warning: Reference" nil t)
(message (concat name ": there were unresolved references, "
(TeX-current-pages)))
(setq TeX-command-next TeX-command-Show))
((or
(re-search-forward "^LaTeX Warning: Citation" nil t)
(re-search-forward "^Package natbib Warning:.*undefined citations" nil t))
(message (concat name ": there were unresolved citations, "
(TeX-current-pages)))
(setq TeX-command-next TeX-command-Show))
((re-search-forward
"^\\(\\*\\* \\)?J?I?p?\\(La\\|Sli\\)TeX\\(2e\\)? \\(Version\\|ver\\.\\|<[0-9/]*>\\)" nil t)
(let* ((warnings (and TeX-debug-warnings
(TeX-LaTeX-sentinel-has-warnings)))
(bad-boxes (and TeX-debug-bad-boxes
(TeX-LaTeX-sentinel-has-bad-boxes)))
(add-info (when (or warnings bad-boxes)
(concat " (with "
(when warnings "warnings")
(when (and warnings bad-boxes) " and ")
(when bad-boxes "bad boxes")
")"))))
(message (concat name ": successfully formatted "
(TeX-current-pages) add-info)))
(setq TeX-command-next TeX-command-Show))
(t
(message (concat name ": problems after "
(TeX-current-pages)))
(setq TeX-command-next TeX-command-default))))
;; should go into latex.el? --pg
(defun TeX-BibTeX-sentinel (process name)
"Cleanup TeX output buffer after running BibTeX."
(goto-char (point-max))
(cond
;; Check whether BibTeX reports any warnings or errors.
((re-search-backward (concat
"^(There \\(?:was\\|were\\) \\([0-9]+\\) "
"\\(warnings?\\|error messages?\\))") nil t)
;; Tell the user their number so that she sees whether the
;; situation is getting better or worse.
(message (concat "BibTeX finished with %s %s. "
"Type `C-c C-l' to display output.")
(match-string 1) (match-string 2)))
(t
(message (concat "BibTeX finished successfully. "
"Run LaTeX again to get citations right."))))
(setq TeX-command-next TeX-command-default))
;;; Process Control
;; This variable is chared with `compile.el'.
(defvar compilation-in-progress nil
"List of compilation processes now running.")
(or (assq 'compilation-in-progress minor-mode-alist)
(setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
minor-mode-alist)))
(defun TeX-process-get-variable (name symbol &optional default)
"Return the value in the process buffer for NAME of SYMBOL.
Return DEFAULT if the process buffer does not exist or SYMBOL is not
defined."
(let ((buffer (TeX-process-buffer name)))
(if (and buffer
(local-variable-p symbol buffer))
(save-excursion
(set-buffer buffer)
(symbol-value symbol))
default)))
(defun TeX-process-set-variable (name symbol value)
"Set the variable SYMBOL in the process buffer to VALUE.
Return nil iff no process buffer exist."
(let ((buffer (TeX-process-buffer name)))
(if buffer
(save-excursion
(set-buffer buffer)
(set symbol value)
t)
nil)))
(defun TeX-process-check (name)
"Check if a process for the TeX document NAME already exist.
If so, give the user the choice of aborting the process or the current
command."
(let (process)
(while (and (setq process (TeX-process name))
(eq (process-status process) 'run))
(cond
((yes-or-no-p (concat "Process `"
(process-name process)
"' for document `"
name
"' running, kill it? "))
(delete-process process))
((eq (process-status process) 'run)
(error "Cannot have two processes for the same document"))))))
(defun TeX-process-buffer-name (name)
"Return name of AUCTeX buffer associated with the document NAME."
(concat "*" (abbreviate-file-name (expand-file-name name)) " output*"))
(defun TeX-process-buffer (name)
"Return the AUCTeX buffer associated with the document NAME."
(get-buffer (TeX-process-buffer-name name)))
(defun TeX-process (name)
"Return AUCTeX process associated with the document NAME."
(and TeX-process-asynchronous
(get-buffer-process (TeX-process-buffer name))))
;;; Process Filters
(defun TeX-command-mode-line (process)
"Format the mode line for a buffer containing output from PROCESS."
(setq mode-line-process (concat ": "
(symbol-name (process-status process))))
(set-buffer-modified-p (buffer-modified-p)))
(defun TeX-command-filter (process string)
"Filter to process normal output."
(with-current-buffer (process-buffer process)
(save-excursion
(goto-char (process-mark process))
(insert-before-markers string)
(set-marker (process-mark process) (point)))))
(defvar TeX-current-page nil
"The page number currently being formatted, enclosed in brackets.")
(make-variable-buffer-local 'TeX-current-page)
(defun TeX-format-mode-line (process)
"Format the mode line for a buffer containing TeX output from PROCESS."
(setq mode-line-process (concat " " TeX-current-page ": "
(symbol-name (process-status process))))
(set-buffer-modified-p (buffer-modified-p)))
(defun TeX-format-filter (process string)
"Filter to process TeX output."
(with-current-buffer (process-buffer process)
(let (str pos end (pt (marker-position (process-mark process))))
(save-excursion
(goto-char pt)
(insert-before-markers string)
(set-marker (process-mark process) (point))
(while (and pt
(skip-chars-backward "^]" pt)
(> (point) pt))
(setq end (point))
(backward-char)
(skip-chars-backward "-0-9\n." (max (point-min) (- pt 128)))
(when (and (eq ?\[ (char-before))
(not (eq ?\] (char-after)))
(progn
(setq str (buffer-substring (1- (point)) end)
pos nil)
(while (setq pos (string-match "\n" str pos))
(setq str (replace-match "" t t str)))
(string-match
"\\`\\[-?[0-9]+\\(\\.-?[0-9]+\\)\\{0,9\\}\\]\\'"
str)))
(setq TeX-current-page str
pt nil)
(TeX-format-mode-line process)))))))
(defvar TeX-parse-function nil
"Function to call to parse content of TeX output buffer.")
(make-variable-buffer-local 'TeX-parse-function)
(defun TeX-background-filter (process string)
"Filter to process background output."
(let ((old-window (selected-window))
(pop-up-windows t))
(pop-to-buffer "*TeX background*")
(goto-char (point-max))
(insert string)
(select-window old-window)))
;; Copy and adaption of `comint-postoutput-scroll-to-bottom' from CVS
;; Emacs of 2005-04-24.
(defun TeX-interactive-goto-prompt (string)
"Move point to prompt of an interactive TeX run."
(let* ((selected (selected-window))
(current (current-buffer))
(process (get-buffer-process current)))
(unwind-protect
(when process
(walk-windows
(lambda (window)
(when (eq (window-buffer window) current)
(select-window window)
(when (and (< (point) (process-mark process))
(string-match "^\\? $" string))
(goto-char (process-mark process)))
(select-window selected)))
nil t))
(set-buffer current))))
;;; Active Process
(defvar TeX-current-process-region-p nil
"This variable is set to t iff the last TeX command is on a region.")
(defun TeX-active-process ()
"Return the active process for the current buffer."
(TeX-process (TeX-active-master)))
(defun TeX-active-buffer ()
"Return the buffer of the active process for this buffer."
(TeX-process-buffer (with-current-buffer TeX-command-buffer
(TeX-active-master))))
(defun TeX-active-master (&optional extension nondirectory)
"The master file currently being compiled.
If optional argument EXTENSION is non-nil, add that file extension to
the name. Special value t means use `TeX-default-extension'.
If optional second argument NONDIRECTORY is non-nil, do not include
the directory."
(if TeX-current-process-region-p
(TeX-region-file extension nondirectory)
(TeX-master-file extension nondirectory)))
(defvar TeX-command-buffer nil
"The buffer from where the last TeX command was issued.")
;;; Region File
(defcustom TeX-region-extra ""
"*String to insert in the region file between the header and the text."
:group 'TeX-command
:type 'string)
;; This was "{\\makeatletter\\gdef\\AucTeX@cite#1[#2]#3{[#3#1#2]}\
;; \\gdef\\cite{\\@ifnextchar[{\\AucTeX@cite{, }}\
;; {\\AucTeX@cite{}[]}}}\n"
;; However, that string is inappropriate for plain TeX and ConTeXt.
;; This needs reconsideration.
(defvar TeX-region-hook nil
"List of hooks to run before the region file is saved.
The hooks are run in the region buffer, you may use the variable
`master-buffer' to access the buffer of the master file and
`orig-buffer' to access the buffer where \\[TeX-command-region] or
\\[TeX-command-buffer] is invoked from.")
(defun TeX-quote-filename (file)
"Convert file name into a form acceptable to TeX."
(let (pos)
(while (setq pos (string-match "\\\\" file pos))
(setq file (replace-match "/" t t file 0)
pos (1+ pos)))
(while (setq pos (string-match "[~#]" file pos))
(setq file (replace-match "\\\\string\\&" t nil file 0)
pos (+ pos 8))))
file)
(defun TeX-region-create (file region original offset)
"Create a new file named FILE with the string REGION
The region is taken from ORIGINAL starting at line OFFSET.
The current buffer and master file is searched, in order to ensure
that the TeX header and trailer information is also included.
The OFFSET is used to provide the debugger with information about the
original file."
(let* (;; We shift buffer a lot, so we must keep track of the buffer
;; local variables.
(header-end TeX-header-end)
(trailer-start TeX-trailer-start)
;; We seach for header and trailer in the master file.
(orig-buffer (current-buffer))
(master-name (TeX-master-file TeX-default-extension))
(master-buffer (find-file-noselect master-name))
;; Attempt to disable font lock.
(font-lock-defaults-alist nil)
(font-lock-defaults nil)
(font-lock-maximum-size 0)
(font-lock-mode-hook nil)
(font-lock-auto-fontify nil)
(font-lock-mode-enable-list nil)
;; And insert them into the FILE buffer.
(file-buffer (let ((TeX-transient-master t))
(find-file-noselect file)))
;; But remember original content.
original-content
;; We search for the header from the master file, if it is
;; not present in the region.
(header (if (string-match header-end region)
""
(save-excursion
(save-restriction
(set-buffer master-buffer)
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
;; NOTE: We use the local value of
;; TeX-header-end from the master file.
(if (not (re-search-forward TeX-header-end nil t))
""
(re-search-forward "[\r\n]" nil t)
(buffer-substring (point-min) (point)))))))))
;; We search for the trailer from the master file, if it is
;; not present in the region.
(trailer-offset 0)
(trailer (if (string-match trailer-start region)
""
(save-excursion
(save-restriction
(set-buffer master-buffer)
(save-excursion
(save-restriction
(widen)
(goto-char (point-max))
;; NOTE: We use the local value of
;; TeX-trailer-start from the master file.
(if (not (re-search-backward TeX-trailer-start nil t))
""
;;(beginning-of-line 1)
(re-search-backward "[\r\n]" nil t)
(setq trailer-offset (TeX-current-offset))
(buffer-substring (point) (point-max))))))))))
;; file name should be relative to master
(setq original (TeX-quote-filename (file-relative-name
original (TeX-master-directory)))
master-name (TeX-quote-filename master-name))
(save-excursion
(set-buffer file-buffer)
(setq buffer-undo-list t)
(setq original-content (buffer-string))
(erase-buffer)
(when (boundp 'buffer-file-coding-system)
(setq buffer-file-coding-system
(with-current-buffer master-buffer buffer-file-coding-system)))
(insert "\\message{ !name(" master-name ")}"
header
TeX-region-extra
"\n\\message{ !name(" original ") !offset(")
(insert (int-to-string (- offset
(1+ (TeX-current-offset))))
") }\n"
region
"\n\\message{ !name(" master-name ") !offset(")
(insert (int-to-string (- trailer-offset
(1+ (TeX-current-offset))))
") }\n"
trailer)
(run-hooks 'TeX-region-hook)
(if (string-equal (buffer-string) original-content)
(set-buffer-modified-p nil)
(save-buffer 0)))))
(defun TeX-region-file (&optional extension nondirectory)
"Return TeX-region file name with EXTENSION.
If optional second argument NONDIRECTORY is nil, do not include
the directory."
(concat (if nondirectory "" (TeX-master-directory))
(cond ((eq extension t)
(concat TeX-region "." TeX-default-extension))
(extension
(concat TeX-region "." extension))
(t
TeX-region))))
(defcustom TeX-region "_region_"
"*Base name for temporary file for use with TeX-region."
:group 'TeX-command
:type 'string)
;;; Parsing
;;; - Global Parser Variables
(defvar TeX-error-point nil
"How far we have parsed until now.")
(make-variable-buffer-local 'TeX-error-point)
(defvar TeX-error-file nil
"Stack of files in which errors have occured")
(make-variable-buffer-local 'TeX-error-file)
(defvar TeX-error-offset nil
"Add this to any line numbers from TeX. Stack like TeX-error-file.")
(make-variable-buffer-local 'TeX-error-offset)
(defun TeX-parse-reset ()
"Reset all variables used for parsing TeX output."
(setq TeX-error-point (point-min))
(setq TeX-error-offset nil)
(setq TeX-error-file nil))
;;; - Parsers Hooks
(defun TeX-parse-command (reparse)
"We can't parse anything but TeX."
(error "I cannot parse %s output, sorry"
(if (TeX-active-process)
(process-name (TeX-active-process))
"this")))
(defun TeX-parse-TeX (reparse)
"Find the next error produced by running TeX.
Prefix by C-u to start from the beginning of the errors.
If the file occurs in an included file, the file is loaded (if not
already in an Emacs buffer) and the cursor is placed at the error."
(let ((old-buffer (current-buffer))
(default-major-mode major-mode))
(pop-to-buffer (TeX-active-buffer))
(if reparse
(TeX-parse-reset))
(goto-char TeX-error-point)
(TeX-parse-error old-buffer)))
;;; - Parsing (La)TeX
(defvar TeX-translate-location-hook nil
"List of functions to be called before showing an error or warning.
You might want to examine and modify the free variables `file',
`offset', `line', `string', `error', and `context' from this hook.")
(defun TeX-parse-error (old)
"Goto next error. Pop to OLD buffer if no more errors are found."
(while
(progn
(re-search-forward
(concat "\\("
;; Match regular error indicator "!" as well as
;; file-line-error error indicator "file:line: error".
"^\\(!\\|.*:[0-9]+:\\) \\|"
"(\\|"
")\\|"
"\\'\\|"
"!offset([---0-9]*)\\|"
"!name([^)]*)"
(when TeX-debug-bad-boxes
"\\|^.*erfull \\\\.*[0-9]*--[0-9]*")
(when TeX-debug-warnings
"\\|^\\(LaTeX [A-Za-z]*\\|Package [A-Za-z]+ \\)Warning:.*")
"\\)"))
(let ((string (TeX-match-buffer 1)))
(cond (;; TeX error
(match-end 2)
(TeX-error)
nil)
;; LaTeX warning
((string-match
(concat
"\\("
"^.*erfull \\\\.*[0-9]*--[0-9]*\\|"
;; XXX: Add full support for multi-line warnings like
;; Package hyperref Warning: Token not allowed in a PDFDocEncoded string,
;; (hyperref) removing `math shift' on input line 1453.
"^\\(LaTeX [A-Za-z]*\\|Package [A-Za-z]+ \\)Warning:.*"
"\\)")
string)
(TeX-warning string)
nil)
;; New file -- Push on stack
((string= string "(")
(re-search-forward "\\([^(){}\n \t]*\\)")
(setq TeX-error-file
(cons (TeX-match-buffer 1) TeX-error-file))
(setq TeX-error-offset (cons 0 TeX-error-offset))
t)
;; End of file -- Pop from stack
((string= string ")")
(setq TeX-error-file (cdr TeX-error-file))
(setq TeX-error-offset (cdr TeX-error-offset))
t)
;; Hook to change line numbers
((string-match "!offset(\\([---0-9]*\\))" string)
(rplaca TeX-error-offset
(string-to-int (substring string
(match-beginning 1)
(match-end 1))))
t)
;; Hook to change file name
((string-match "!name(\\([^)]*\\))" string)
(rplaca TeX-error-file (substring string
(match-beginning 1)
(match-end 1)))
t)
;; No more errors.
(t
(message "No more errors.")
(beep)
(pop-to-buffer old)
nil))))))
(defun TeX-error ()
"Display an error."
(let* (;; We need the error message to show the user.
(error (progn
(re-search-forward "\\(.*\\)")
(TeX-match-buffer 1)))
;; And the context for the help window.
(context-start (point))
;; And the line number to position the cursor.
(line (if (re-search-forward "l\\.\\([0-9]+\\)" nil t)
(string-to-int (TeX-match-buffer 1))
1))
;; And a string of the context to search for.
(string (progn
(beginning-of-line)
(re-search-forward " \\(\\([^ \t]*$\\)\\|\\($\\)\\)")
(TeX-match-buffer 1)))
;; And we have now found to the end of the context.
(context (buffer-substring context-start (progn
(forward-line 1)
(end-of-line)
(point))))
;; We may use these in another buffer.
(offset (car TeX-error-offset) )
(file (car TeX-error-file)))
;; Remember where we was.
(setq TeX-error-point (point))
;; Find the error.
(if (null file)
(error "Error occured after last TeX file closed"))
(let ((runbuf (current-buffer))
(master (with-current-buffer
TeX-command-buffer
(expand-file-name (TeX-master-file))))
(command-buffer TeX-command-buffer)
error-file-buffer)
(run-hooks 'TeX-translate-location-hook)
(setq error-file-buffer (find-file-other-window file))
;; Set the value of `TeX-command-buffer' in the next file with an
;; error to be displayed to the value it has in the current buffer.
(with-current-buffer error-file-buffer
(set (make-local-variable 'TeX-command-buffer) command-buffer))
(goto-line (+ offset line))
(if (not (string= string " "))
(search-forward string nil t))
;; Explain the error.
(if TeX-display-help
(TeX-help-error error context runbuf)
(message (concat "! " error))))))
(defun TeX-warning (string)
"Display a warning for STRING."
(let* ((error (concat "** " string))
;; bad-box is nil if this is a "LaTeX Warning"
(bad-box (string-match "^.*erfull \\\\.*[0-9]*--[0-9]*" string))
;; line-string: match 1 is beginning line, match 2 is end line
(line-string (if bad-box " \\([0-9]*\\)--\\([0-9]*\\)"
"on input line \\([0-9]*\\)\\."))
;; word-string: match 1 is the word
(word-string (if bad-box "[][\\W() ---]\\(\\w+\\)[][\\W() ---]*$"
"`\\(\\w+\\)'"))
;; Get error-line (warning)
(line (when (re-search-backward line-string nil t)
(string-to-int (TeX-match-buffer 1))))
(line-end (if bad-box (string-to-int (TeX-match-buffer 2))
line))
;; Find the context
(context-start (progn (if bad-box (end-of-line)
(beginning-of-line))
(point)))
(context (progn
(forward-line 1)
(end-of-line)
(while (equal (current-column) 79)
(forward-line 1)
(end-of-line))
(buffer-substring context-start (point))))
;; This is where we want to be.
(error-point (point))
;; Now find the error word.
(string (when (re-search-backward word-string context-start t)
(TeX-match-buffer 1)))
;; We might use these in another file.
(offset (car TeX-error-offset))
(file (car TeX-error-file)))
;; This is where we start next time.
(goto-char error-point)
(setq TeX-error-point (point))
;; Go back to TeX-buffer
(let ((runbuf (current-buffer))
(master (with-current-buffer
TeX-command-buffer
(expand-file-name (TeX-master-file))))
(command-buffer TeX-command-buffer)
error-file-buffer)
(run-hooks 'TeX-translate-location-hook)
(setq error-file-buffer (find-file-other-window file))
;; Set the value of `TeX-command-buffer' in the next file with an
;; error to be displayed to the value it has in the current buffer.
(with-current-buffer error-file-buffer
(set (make-local-variable 'TeX-command-buffer) command-buffer))
;; Find line and string
(when line
(goto-line (+ offset line))
(beginning-of-line 0)
(let ((start (point)))
(goto-line (+ offset line-end))
(end-of-line)
(when string
(search-backward string start t)
(search-forward string nil t))))
;; Display help
(if TeX-display-help
(TeX-help-error error (if bad-box context (concat "\n" context))
runbuf)
(message (concat "! " error))))))
;;; - Help
(defun TeX-help-error (error output runbuffer)
"Print ERROR in context OUTPUT from RUNBUFFER in another window."
(let ((old-buffer (current-buffer))
(log-file (with-current-buffer runbuffer
(with-current-buffer TeX-command-buffer
(expand-file-name (TeX-active-master "log")))))
(TeX-error-pointer 0))
;; Find help text entry.
(while (not (string-match (car (nth TeX-error-pointer
TeX-error-description-list))
error))
(setq TeX-error-pointer (+ TeX-error-pointer 1)))
(pop-to-buffer (get-buffer-create "*TeX Help*"))
(erase-buffer)
(insert "ERROR: " error
"\n\n--- TeX said ---"
output
"\n--- HELP ---\n"
(save-excursion
(if (and (string= (cdr (nth TeX-error-pointer
TeX-error-description-list))
"No help available")
(let* ((log-buffer (find-buffer-visiting log-file)))
(if log-buffer
(progn
(set-buffer log-buffer)
(revert-buffer t t))
(setq log-buffer
(find-file-noselect log-file))
(set-buffer log-buffer))
(auto-save-mode nil)
(setq buffer-read-only t)
(goto-line (point-min))
(search-forward error nil t 1)))
(progn
(re-search-forward "^l.")
(re-search-forward "^ [^\n]+$")
(forward-char 1)
(let ((start (point)))
(re-search-forward "^$")
(concat "From the .log file...\n\n"
(buffer-substring start (point)))))
(cdr (nth TeX-error-pointer
TeX-error-description-list)))))
(goto-char (point-min))
(pop-to-buffer old-buffer)))
;;; Error Messages
(defcustom TeX-error-description-list
'(("Bad \\\\line or \\\\vector argument.*" .
"The first argument of a \\line or \\vector command, which specifies the
slope, is illegal\.")
("Bad math environment delimiter.*" .
"TeX has found either a math-mode-starting command such as \\[ or \\(
when it is already in math mode, or else a math-mode-ending command
such as \\) or \\] while in LR or paragraph mode. The problem is caused
by either unmatched math mode delimiters or unbalanced braces\.")
("Bad use of \\\\\\\\.*" .
"A \\\\ command appears between paragraphs, where it makes no sense. This
error message occurs when the \\\\ is used in a centering or flushing
environment or else in the scope of a centering or flushing
declaration.")
("\\\\begin{[^ ]*} ended by \\\\end{[^ ]*}." .
"LaTeX has found an \\end command that doesn't match the corresponding
\\begin command. You probably misspelled the environment name in the
\\end command, have an extra \\begin, or else forgot an \\end.")
("Can be used only in preamble." .
"LaTeX has encountered, after the \\begin{document}, one of the
following commands that should appear only in the preamble:
\\documentclass, \\nofiles, \\includeonly, \\makeindex, or
\\makeglossary. The error is also caused by an extra \\begin{document}
command.")
("Command name [^ ]* already used.*" .
"You are using \\newcommand, \\newenvironment, \\newlength, \\newsavebox,
or \\newtheorem to define a command or environment name that is
already defined, or \\newcounter to define a counter that already
exists. (Defining an environment named gnu automatically defines the
command \\gnu.) You'll have to choose a new name or, in the case of
\\newcommand or \\newenvironment, switch to the \\renew ... command.")
("Counter too large." .
"1. Some object that is numbered with letters, probably an item in a
enumerated list, has received a number greater than 26. Either you're
making a very long list or you've been resetting counter values.
2. Footnotes are being ``numbered'' with letters or footnote symbols
and LaTeX has run out of letters or symbols. This is probably caused
by too many \\thanks commands.")
("Environment [^ ]* undefined." .
"LaTeX has encountered a \\begin command for a nonexistent environment.
You probably misspelled the environment name. ")
("Float(s) lost." .
"You put a figure or table environment or a \\marginpar command inside a
parbox---either one made with a minipage environment or \\parbox
command, or one constructed by LaTeX in making a footnote, figure,
etc. This is an outputting error, and the offending environment or
command may be quite a way back from the point where LaTeX discovered
the problem. One or more figures, tables, and/or marginal notes have
been lost, but not necessarily the one that caused the error.")
("Illegal character in array arg." .
"There is an illegal character in the argument of an array or tabular
environment, or in the second argument of a \\multicolumn command.")
("Missing \\\\begin{document}." .
"LaTeX produced printed output before encountering a \\begin{document}
command. Either you forgot the \\begin{document} command or there is
something wrong in the preamble. The problem may be a stray character
or an error in a declaration---for example, omitting the braces around
an argument or forgetting the \\ in a command name.")
("Missing p-arg in array arg.*" .
"There is a p that is not followed by an expression in braces in the
argument of an array or tabular environment, or in the second argument
of a \\multicolumn command.")
("Missing @-exp in array arg." .
"There is an @ character not followed by an @-expression in the
argument of an array or tabular environment, or in the second argument
of a \\multicolumn command.")
("No such counter." .
"You have specified a nonexistent counter in a \\setcounter or
\\addtocounter command. This is probably caused by a simple typing
error. However, if the error occurred while a file with the extension
aux is being read, then you probably used a \\newcounter command
outside the preamble.")
("Not in outer par mode." .
"You had a figure or table environment or a \\marginpar command in math
mode or inside a parbox.")
("\\\\pushtabs and \\\\poptabs don't match." .
"LaTeX found a \\poptabs with no matching \\pushtabs, or has come to the
\\end{tabbing} command with one or more unmatched \\pushtabs commands.")
("Something's wrong--perhaps a missing \\\\item." .
"The most probable cause is an omitted \\item command in a list-making
environment. It is also caused by forgetting the argument of a
thebibliography environment.")
("Tab overflow." .
"A \\= command has exceeded the maximum number of tab stops that LaTeX
permits.")
("There's no line here to end." .
"A \\newline or \\\\ command appears between paragraphs, where it makes no
sense. If you're trying to ``leave a blank line'', use a \\vspace
command.")
("This may be a LaTeX bug." .
"LaTeX has become thoroughly confused. This is probably due to a
previously detected error, but it is possible that you have found an
error in LaTeX itself. If this is the first error message produced by
the input file and you can't find anything wrong, save the file and
contact the person listed in your Local Guide.")
("Too deeply nested." .
"There are too many list-making environments nested within one another.
How many levels of nesting are permitted may depend upon what computer
you are using, but at least four levels are provided, which should be
enough.")
("Too many unprocessed floats." .
"While this error can result from having too many \\marginpar commands
on a page, a more likely cause is forcing LaTeX to save more figures
and tables than it has room for. When typesetting its continuous
scroll, LaTeX saves figures and tables separately and inserts them as
it cuts off pages. This error occurs when LaTeX finds too many figure
and/or table environments before it is time to cut off a page, a
problem that is solved by moving some of the environments farther
towards the end of the input file. The error can also be caused by a
``logjam''---a figure or table that cannot be printed causing others
to pile up behind it, since LaTeX will not print figures or tables out
of order. The jam can be started by a figure or table that either is
too large to fit on a page or won't fit where its optional placement
argument says it must go. This is likely to happen if the argument
does not contain a p option.")
("Undefined tab position." .
"A \\>, \\+, \\-, or \\< command is trying to go to a nonexistent tab
position---one not defined by a \\= command.")
("\\\\< in mid line." .
"A \\< command appears in the middle of a line in a tabbing environment.
This command should come only at the beginning of a line.")
("Double subscript." .
"There are two subscripts in a row in a mathematical
formula---something like x_{2}_{3}, which makes no sense.")
("Double superscript." .
"There are two superscripts in a row in a mathematical
formula---something like x^{2}^{3}, which makes no sense.")
("Extra alignment tab has been changed to \\\\cr." .
"There are too many separate items (column entries) in a single row of
an array or tabular environment. In other words, there were too many &
's before the end of the row. You probably forgot the \\\\ at the end of
the preceding row.")
("Extra \\}, or forgotten \\$." .
"The braces or math mode delimiters don't match properly. You probably
forgot a {, \\[, \\(, or $.")
("Font [^ ]* not loaded: Not enough room left." .
"The document uses more fonts than TeX has room for. If different parts
of the document use different fonts, then you can get around the
problem by processing it in parts.")
("I can't find file `.*'." .
"TeX can't find a file that it needs. If the name of the missing file
has the extension tex, then it is looking for an input file that you
specified---either your main file or another file inserted with an
\\input or \\include command. If the missing file has the extension sty
, then you have specified a nonexistent document style or style
option.")
("Illegal parameter number in definition of .*" .
"This is probably caused by a \\newcommand, \\renewcommand,
\\newenvironment, or \\renewenvironment command in which a # is used
incorrectly. A # character, except as part of the command name \\#,
can be used only to indicate an argument parameter, as in #2, which
denotes the second argument. This error is also caused by nesting one
of the above four commands inside another, or by putting a parameter
like #2 in the last argument of a \\newenvironment or \\renewenvironment
command.")
("Illegal unit of measure ([^ ]* inserted)." .
"If you just got a
! Missing number, treated as zero.
error, then this is part of the same problem. If not, it means that
LaTeX was expecting a length as an argument and found a number
instead. The most common cause of this error is writing 0 instead of
something like 0in for a length of zero, in which case typing return
should result in correct output. However, the error can also be caused
by omitting a command argument.")
("Misplaced alignment tab character \\&." .
"The special character &, which should be used only to separate items
in an array or tabular environment, appeared in ordinary text. You
probably meant to type \\&.")
("Missing control sequence inserted." .
"This is probably caused by a \\newcommand, \\renewcommand, \\newlength,
or \\newsavebox command whose first argument is not a command name.")
("Missing number, treated as zero." .
"This is usually caused by a LaTeX command expecting but not finding
either a number or a length as an argument. You may have omitted an
argument, or a square bracket in the text may have been mistaken for
the beginning of an optional argument. This error is also caused by
putting \\protect in front of either a length command or a command such
as \\value that produces a number.")
("Missing [{}] inserted." .
"TeX has become confused. The position indicated by the error locator
is probably beyond the point where the incorrect input is.")
("Missing \\$ inserted." .
"TeX probably found a command that can be used only in math mode when
it wasn't in math mode. Remember that unless stated otherwise, all
all the commands of Section 3.3 in LaTeX Book (Lamport) can be used
only in math mode. TeX is not in math mode when it begins processing
the argument of a box-making command, even if that command is inside a
math environment. This error also occurs if TeX encounters a blank
line when it is in math mode.")
("Not a letter." .
"Something appears in the argument of a \\hyphenation command that
doesn't belong there.")
("Paragraph ended before [^ ]* was complete." .
"A blank line occurred in a command argument that shouldn't contain
one. You probably forgot the right brace at the end of an argument.")
("\\\\[^ ]*font [^ ]* is undefined .*" .
"These errors occur when an uncommon font is used in math mode---for
example, if you use a \\sc command in a formula inside a footnote,
calling for a footnote-sized small caps font. This problem is solved
by using a \\load command.")
("Font .* not found." .
"You requested a family/series/shape/size combination that is totally
unknown. There are two cases in which this error can occur:
1) You used the \\size macro to select a size that is not available.
2) If you did not do that, go to your local `wizard' and
complain fiercely that the font selection tables are corrupted!")
("TeX capacity exceeded, sorry .*" .
"TeX has just run out of space and aborted its execution. Before you
panic, remember that the least likely cause of this error is TeX not
having the capacity to process your document. It was probably an
error in your input file that caused TeX to run out of room. The
following discussion explains how to decide whether you've really
exceeded TeX's capacity and, if so, what to do. If the problem is an
error in the input, you may have to use the divide and conquer method
described previously to locate it. LaTeX seldom runs out of space on a
short input file, so if running it on the last few pages before the
error indicator's position still produces the error, then there's
almost certainly something wrong in the input file.
The end of the error indicator tells what kind of space TeX ran out
of. The more common ones are listed below, with an explanation of
their probable causes.
buffer size
===========
Can be caused by too long a piece of text as the argument
of a sectioning, \\caption, \\addcontentsline, or \\addtocontents
command. This error will probably occur when the \\end{document} is
being processed, but it could happen when a \\tableofcontents,
\\listoffigures, or \\listoftables command is executed. To solve this
problem, use a shorter optional argument. Even if you're producing a
table of contents or a list of figures or tables, such a long entry
won't help the reader.
exception dictionary
====================
You have used \\hyphenation commands to give TeX
more hyphenation information than it has room for. Remove some of the
less frequently used words from the \\hyphenation commands and insert
\\- commands instead.
hash size
=========
Your input file defines too many command names and/or uses
too many cross-ref- erencing labels.
input stack size
================
This is probably caused by an error in a command
definition. For example, the following command makes a circular
definition, defining \\gnu in terms of itself:
\\newcommand{\\gnu}{a \\gnu} % This is wrong!
When TeX encounters this \\gnu command, it will keep chasing its tail
trying to figure out what \\gnu should produce, and eventually run out
of ``input stack''.
main memory size
================
This is one kind of space that TeX can run out of when processing a
short file. There are three ways you can run TeX out of main memory
space: (1) defining a lot of very long, complicated commands, (2)
making an index or glossary and having too many \\index or \\glossary
commands on a single page, and (3) creating so complicated a page of
output that TeX can't hold all the information needed to generate it.
The solution to the first two problems is obvious: define fewer
commands or use fewer \\index and \\glossary commands. The third problem
is nastier. It can be caused by large tabbing, tabular, array, and
picture environments. TeX's space may also be filled up with figures
and tables waiting for a place to go. To find out if you've really
exceeded TeX's capacity in this way, put a \\clearpage command in your
input file right before the place where TeX ran out of room and try
running it again. If it doesn't run out of room with the \\clearpage
command there, then you did exceed TeX's capacity. If it still runs
out of room, then there's probably an error in your file. If TeX is
really out of room, you must give it some help. Remember that TeX
processes a complete paragraph before deciding whether to cut the
page. Inserting a \\newpage command in the middle of the paragraph,
where TeX should break the page, may save the day by letting TeX write
the current page before processing the rest of the paragraph. (A
\\pagebreak command won't help.) If the problem is caused by
accumulated figures and tables, you can try to prevent them from
accumulating---either by moving them further towards the end of the
document or by trying to get them to come out sooner. If you are
still writing the document, simply add a \\clearpage command and forget
about the problem until you're ready to produce the final version.
Changes to the input file are likely to make the problem go away.
pool size
=========
You probably used too many cross-ref-erencing \\labels and/or defined
too many new command names. More precisely, the labels and command
names that you define have too many characters, so this problem can be
solved by using shorter names. However, the error can also be caused
by omitting the right brace that ends the argument of either a counter
command such as \\setcounter, or a \\newenvironment or \\newtheorem
command.
save size
=========
This occurs when commands, environments, and the scopes of
declarations are nested too deeply---for example, by having the
argument of a \\multiput command contain a picture environment that in
turn has a \\footnotesize declaration whose scope contains a \\multiput
command containing a ....")
("Text line contains an invalid character." .
"The input contains some strange character that it shouldn't. A mistake
when creating the file probably caused your text editor to insert this
character. Exactly what could have happened depends upon what text
editor you used. If examining the input file doesn't reveal the
offending character, consult the Local Guide for suggestions.")
("Undefined control sequence." .
"TeX encountered an unknown command name. You probably misspelled the
name. If this message occurs when a LaTeX command is being processed,
the command is probably in the wrong place---for example, the error
can be produced by an \\item command that's not inside a list-making
environment. The error can also be caused by a missing \\documentclass
command.")
("Use of [^ ]* doesn't match its definition." .
"It's probably one of the picture-drawing commands, and you have used
the wrong syntax for specifying an argument. If it's \\@array that
doesn't match its definition, then there is something wrong in an
@-expression in the argument of an array or tabular
environment---perhaps a fragile command that is not \\protect'ed.")
("You can't use `macro parameter character \\#' in [^ ]* mode." .
"The special character # has appeared in ordinary text. You probably
meant to type \\#.")
("Overfull \\\\hbox .*" .
"Because it couldn't find a good place for a line break, TeX put more
on this line than it should.")
("Overfull \\\\vbox .*" .
"Because it couldn't find a good place for a page break, TeX put more
on the page than it should. ")
("Underfull \\\\hbox .*" .
"Check your output for extra vertical space. If you find some, it was
probably caused by a problem with a \\\\ or \\newline command---for
example, two \\\\ commands in succession. This warning can also be
caused by using the sloppypar environment or \\sloppy declaration, or
by inserting a \\linebreak command.")
("Underfull \\\\vbox .*" .
"TeX could not find a good place to break the page, so it produced a
page without enough text on it. ")
;; New list items should be placed here
;;
;; ("err-regexp" . "context")
;;
;; the err-regexp item should match anything
(".*" . "No help available")) ; end definition
"A list of the form (\"err-regexp\" . \"context\") used by function
\\{TeX-help-error} to display help-text on an error message or warning.
err-regexp should be a regular expression matching the error message
given from TeX/LaTeX, and context should be some lines describing that
error"
:group 'TeX-output
:type '(repeat (cons :tag "Entry"
(regexp :tag "Match")
(string :format "Description:\n%v"))))
(provide 'tex-buf)
;;; tex-buf.el ends here
|