1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316 13317 13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805 13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911 13912 13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965 13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538 14539 14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653 14654 14655 14656 14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987 14988 14989 14990 14991 14992 14993 14994 14995 14996 14997 14998 14999 15000 15001 15002 15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013 15014 15015 15016 15017 15018 15019 15020 15021 15022 15023 15024 15025 15026 15027 15028 15029 15030 15031 15032 15033 15034 15035 15036 15037 15038 15039 15040 15041 15042 15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 15102 15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142 15143 15144 15145 15146 15147 15148 15149 15150 15151 15152 15153 15154 15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169 15170 15171 15172 15173 15174 15175 15176 15177 15178 15179 15180 15181 15182 15183 15184 15185 15186 15187 15188 15189 15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206 15207 15208 15209 15210 15211 15212 15213 15214 15215 15216 15217 15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258 15259 15260 15261 15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272 15273 15274 15275 15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291 15292 15293 15294 15295 15296 15297 15298 15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314 15315 15316 15317 15318 15319 15320 15321 15322 15323 15324 15325 15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336 15337 15338 15339 15340 15341 15342 15343 15344 15345 15346 15347 15348 15349 15350 15351 15352 15353 15354 15355 15356 15357 15358 15359 15360 15361 15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372 15373 15374 15375 15376 15377 15378 15379 15380 15381 15382 15383 15384 15385 15386 15387 15388 15389 15390 15391 15392 15393 15394 15395 15396 15397 15398 15399 15400 15401 15402 15403 15404 15405 15406 15407 15408 15409 15410 15411 15412 15413 15414 15415 15416 15417 15418 15419 15420 15421 15422 15423 15424 15425 15426 15427 15428 15429 15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442 15443 15444 15445 15446 15447 15448 15449 15450 15451 15452 15453 15454 15455 15456 15457 15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470 15471 15472 15473 15474 15475 15476 15477 15478 15479 15480 15481 15482 15483 15484 15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501 15502 15503 15504 15505 15506 15507 15508 15509 15510 15511 15512 15513 15514 15515 15516 15517 15518 15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530 15531 15532 15533 15534 15535 15536 15537 15538 15539 15540 15541 15542 15543 15544 15545 15546 15547 15548 15549 15550 15551 15552 15553 15554 15555 15556 15557 15558 15559 15560 15561 15562 15563 15564 15565 15566 15567 15568 15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 15589 15590 15591 15592 15593 15594 15595 15596 15597 15598 15599 15600 15601 15602 15603 15604 15605 15606 15607 15608 15609 15610 15611 15612 15613 15614 15615 15616 15617 15618 15619 15620 15621 15622 15623 15624 15625 15626 15627 15628 15629 15630 15631 15632 15633 15634 15635 15636 15637 15638 15639 15640 15641 15642 15643 15644 15645 15646 15647 15648 15649 15650 15651 15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662 15663 15664 15665 15666 15667 15668 15669 15670 15671 15672 15673 15674 15675 15676 15677 15678 15679 15680 15681 15682 15683 15684 15685 15686 15687 15688 15689 15690 15691 15692 15693 15694 15695 15696 15697 15698 15699 15700 15701 15702 15703 15704 15705 15706 15707 15708 15709 15710 15711 15712 15713 15714 15715 15716 15717 15718 15719 15720 15721 15722 15723 15724 15725 15726 15727 15728 15729 15730 15731 15732 15733 15734 15735 15736 15737 15738 15739 15740 15741 15742 15743 15744 15745 15746 15747 15748 15749 15750 15751 15752 15753 15754 15755 15756 15757 15758 15759 15760 15761 15762 15763 15764 15765 15766 15767 15768 15769 15770 15771 15772 15773 15774 15775 15776 15777 15778 15779 15780 15781 15782 15783 15784 15785 15786 15787 15788 15789 15790 15791 15792 15793 15794 15795 15796 15797 15798 15799 15800 15801 15802 15803 15804 15805 15806 15807 15808 15809 15810 15811 15812 15813 15814 15815 15816 15817 15818 15819 15820 15821 15822 15823 15824 15825 15826 15827 15828 15829 15830 15831 15832 15833 15834 15835 15836 15837 15838 15839 15840 15841 15842 15843 15844 15845 15846 15847 15848 15849 15850 15851 15852 15853 15854 15855 15856 15857 15858 15859 15860 15861 15862 15863 15864 15865 15866 15867 15868 15869 15870 15871 15872 15873 15874 15875 15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889 15890 15891 15892 15893 15894 15895 15896 15897 15898 15899 15900 15901 15902 15903 15904 15905 15906 15907 15908 15909 15910 15911 15912 15913 15914 15915 15916 15917 15918 15919 15920 15921 15922 15923 15924 15925 15926 15927 15928 15929 15930 15931 15932 15933 15934 15935 15936 15937 15938 15939 15940 15941 15942 15943 15944 15945 15946 15947 15948 15949 15950 15951 15952 15953 15954 15955 15956 15957 15958 15959 15960 15961 15962 15963 15964 15965 15966 15967 15968 15969 15970 15971 15972 15973 15974 15975 15976 15977 15978 15979 15980 15981 15982 15983 15984 15985 15986 15987 15988 15989 15990 15991 15992 15993 15994 15995 15996 15997 15998 15999 16000 16001 16002 16003 16004 16005 16006 16007 16008 16009 16010 16011 16012 16013 16014 16015 16016 16017 16018 16019 16020 16021 16022 16023 16024 16025 16026 16027 16028 16029 16030 16031 16032 16033 16034 16035 16036 16037 16038 16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052 16053 16054 16055 16056 16057 16058 16059 16060 16061 16062 16063 16064 16065 16066 16067 16068 16069 16070 16071 16072 16073 16074 16075 16076 16077 16078 16079 16080 16081 16082 16083 16084 16085 16086 16087 16088 16089 16090 16091 16092 16093 16094 16095 16096 16097 16098 16099 16100 16101 16102 16103 16104 16105 16106 16107 16108 16109 16110 16111 16112 16113 16114 16115 16116 16117 16118 16119 16120 16121 16122 16123 16124 16125 16126 16127 16128 16129 16130 16131 16132 16133 16134 16135 16136 16137 16138 16139 16140 16141 16142 16143 16144 16145 16146 16147 16148 16149 16150 16151 16152 16153 16154 16155 16156 16157 16158 16159 16160 16161 16162 16163 16164 16165 16166 16167 16168 16169 16170 16171 16172 16173 16174 16175 16176 16177 16178 16179 16180 16181 16182 16183 16184 16185 16186 16187 16188 16189 16190 16191 16192 16193 16194 16195 16196 16197 16198 16199 16200 16201 16202 16203 16204 16205 16206 16207 16208 16209 16210 16211 16212 16213 16214 16215 16216 16217 16218 16219 16220 16221 16222 16223 16224 16225 16226 16227 16228 16229 16230 16231 16232 16233 16234 16235 16236 16237 16238 16239 16240 16241 16242 16243 16244 16245 16246 16247 16248 16249 16250 16251 16252 16253 16254 16255 16256 16257 16258 16259 16260 16261 16262 16263 16264 16265 16266 16267 16268 16269 16270 16271 16272 16273 16274 16275 16276 16277 16278 16279 16280 16281 16282 16283 16284 16285 16286 16287 16288 16289 16290 16291 16292 16293 16294 16295 16296 16297 16298 16299 16300 16301 16302 16303 16304 16305 16306 16307 16308 16309 16310 16311 16312 16313 16314 16315 16316 16317 16318 16319 16320 16321 16322 16323 16324 16325 16326 16327 16328 16329 16330 16331 16332 16333 16334 16335 16336 16337 16338 16339 16340 16341 16342 16343 16344 16345 16346 16347 16348 16349 16350 16351 16352 16353 16354 16355 16356 16357 16358 16359 16360 16361 16362 16363 16364 16365 16366 16367 16368 16369 16370 16371 16372 16373 16374 16375 16376 16377 16378 16379 16380 16381 16382 16383 16384 16385 16386 16387 16388 16389 16390 16391 16392 16393 16394 16395 16396 16397 16398 16399 16400 16401 16402 16403 16404 16405 16406 16407 16408 16409 16410 16411 16412 16413 16414 16415 16416 16417 16418 16419 16420 16421 16422 16423 16424 16425 16426 16427 16428 16429 16430 16431 16432 16433 16434 16435 16436 16437 16438 16439 16440 16441 16442 16443 16444 16445 16446 16447 16448 16449 16450 16451 16452 16453 16454 16455 16456 16457 16458 16459 16460 16461 16462 16463 16464 16465 16466 16467 16468 16469 16470 16471 16472 16473 16474 16475 16476 16477 16478 16479 16480 16481 16482 16483 16484 16485 16486 16487 16488 16489 16490 16491 16492 16493 16494 16495 16496 16497 16498 16499 16500 16501 16502 16503 16504 16505 16506 16507 16508 16509 16510 16511 16512 16513 16514 16515 16516 16517 16518 16519 16520 16521 16522 16523 16524 16525 16526 16527 16528 16529 16530 16531 16532 16533 16534 16535 16536 16537 16538 16539 16540 16541 16542 16543 16544 16545 16546 16547 16548 16549 16550 16551 16552 16553 16554 16555 16556 16557 16558 16559 16560 16561 16562 16563 16564 16565 16566 16567 16568 16569 16570 16571 16572 16573 16574 16575 16576 16577 16578 16579 16580 16581 16582 16583 16584 16585 16586 16587 16588 16589 16590 16591 16592 16593 16594 16595 16596 16597 16598 16599 16600 16601 16602 16603 16604 16605 16606 16607 16608 16609 16610 16611 16612 16613 16614 16615 16616 16617 16618 16619 16620 16621 16622 16623 16624 16625 16626 16627 16628 16629 16630 16631 16632 16633 16634 16635 16636 16637 16638 16639 16640 16641 16642 16643 16644 16645 16646 16647 16648 16649 16650 16651 16652 16653 16654 16655 16656 16657 16658 16659 16660 16661 16662 16663 16664 16665 16666 16667 16668 16669 16670 16671 16672 16673 16674 16675 16676 16677 16678 16679 16680 16681 16682 16683 16684 16685 16686 16687 16688 16689 16690 16691 16692 16693 16694 16695 16696 16697 16698 16699 16700 16701 16702 16703 16704 16705 16706 16707 16708 16709 16710 16711 16712 16713 16714 16715 16716 16717 16718 16719 16720 16721 16722 16723 16724 16725 16726 16727 16728 16729 16730 16731 16732 16733 16734 16735 16736 16737 16738 16739 16740 16741 16742 16743 16744 16745 16746 16747 16748 16749 16750 16751 16752 16753 16754 16755 16756 16757 16758 16759 16760 16761 16762 16763 16764 16765 16766 16767 16768 16769 16770 16771 16772 16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 16787 16788 16789 16790 16791 16792 16793 16794 16795 16796 16797 16798 16799 16800 16801 16802 16803 16804 16805 16806 16807 16808 16809 16810 16811 16812 16813 16814 16815 16816 16817 16818 16819 16820 16821 16822 16823 16824 16825 16826 16827 16828 16829 16830 16831 16832 16833 16834 16835 16836 16837 16838 16839 16840 16841 16842 16843 16844 16845 16846 16847 16848 16849 16850 16851 16852 16853 16854 16855 16856 16857 16858 16859 16860 16861 16862 16863 16864 16865 16866 16867 16868 16869 16870 16871 16872 16873 16874 16875 16876 16877 16878 16879 16880 16881 16882 16883 16884 16885 16886 16887 16888 16889 16890 16891 16892 16893 16894 16895 16896 16897 16898 16899 16900 16901 16902 16903 16904 16905 16906 16907 16908 16909 16910 16911 16912 16913 16914 16915 16916 16917 16918 16919 16920 16921 16922 16923 16924 16925 16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938 16939 16940 16941 16942 16943 16944 16945 16946 16947 16948 16949 16950 16951 16952 16953 16954 16955 16956 16957 16958 16959 16960 16961 16962 16963 16964 16965 16966 16967 16968 16969 16970 16971 16972 16973 16974 16975 16976 16977 16978 16979 16980 16981 16982 16983 16984 16985 16986 16987 16988 16989 16990 16991 16992 16993 16994 16995 16996 16997 16998 16999 17000 17001 17002 17003 17004 17005 17006 17007 17008 17009 17010 17011 17012 17013 17014 17015 17016 17017 17018 17019 17020 17021 17022 17023 17024 17025 17026 17027 17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 17049 17050 17051 17052 17053 17054 17055 17056 17057 17058 17059 17060 17061 17062 17063 17064 17065 17066 17067 17068 17069 17070 17071 17072 17073 17074 17075 17076 17077 17078 17079 17080 17081 17082 17083 17084 17085 17086 17087 17088 17089 17090 17091 17092 17093 17094 17095 17096 17097 17098 17099 17100 17101 17102 17103 17104 17105 17106 17107 17108 17109 17110 17111 17112 17113 17114 17115 17116 17117 17118 17119 17120 17121 17122 17123 17124 17125 17126 17127 17128 17129 17130 17131 17132 17133 17134 17135 17136 17137 17138 17139 17140 17141 17142 17143 17144 17145 17146 17147 17148 17149 17150 17151 17152 17153 17154 17155 17156 17157 17158 17159 17160 17161 17162 17163 17164 17165 17166 17167 17168 17169 17170 17171 17172 17173 17174 17175 17176 17177 17178 17179 17180 17181 17182 17183 17184 17185 17186 17187 17188 17189 17190 17191 17192 17193 17194 17195 17196 17197 17198 17199 17200 17201 17202 17203 17204 17205 17206 17207 17208 17209 17210 17211 17212 17213 17214 17215 17216 17217 17218 17219 17220 17221 17222 17223 17224 17225 17226 17227 17228 17229 17230 17231 17232 17233 17234 17235 17236 17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 17253 17254 17255 17256 17257 17258 17259 17260 17261 17262 17263 17264 17265 17266 17267 17268 17269 17270 17271 17272 17273 17274 17275 17276 17277 17278 17279 17280 17281 17282 17283 17284 17285 17286 17287 17288 17289 17290 17291 17292 17293 17294 17295 17296 17297 17298 17299 17300 17301 17302 17303 17304 17305 17306 17307 17308 17309 17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 17325 17326 17327 17328 17329 17330 17331 17332 17333 17334 17335 17336 17337 17338 17339 17340 17341 17342 17343 17344 17345 17346 17347 17348 17349 17350 17351 17352 17353 17354 17355 17356 17357 17358 17359 17360 17361 17362 17363 17364 17365 17366 17367 17368 17369 17370 17371 17372 17373 17374 17375 17376 17377 17378 17379 17380 17381 17382 17383 17384 17385 17386 17387 17388 17389 17390 17391 17392 17393 17394 17395 17396 17397 17398 17399 17400 17401 17402 17403 17404 17405 17406 17407 17408 17409 17410 17411 17412 17413 17414 17415 17416 17417 17418 17419 17420 17421 17422 17423 17424 17425 17426 17427 17428 17429 17430 17431 17432 17433 17434 17435 17436 17437 17438 17439 17440 17441 17442 17443 17444 17445 17446 17447 17448 17449 17450 17451 17452 17453 17454 17455 17456 17457 17458 17459 17460 17461 17462 17463 17464 17465 17466 17467 17468 17469 17470 17471 17472 17473 17474 17475 17476 17477 17478 17479 17480 17481 17482 17483 17484 17485 17486 17487 17488 17489 17490 17491 17492 17493 17494 17495 17496 17497 17498 17499 17500 17501 17502 17503 17504 17505 17506 17507 17508 17509 17510 17511 17512 17513 17514 17515 17516 17517 17518 17519 17520 17521 17522 17523 17524 17525 17526 17527 17528 17529 17530 17531 17532 17533 17534 17535 17536 17537 17538 17539 17540 17541 17542 17543 17544 17545 17546 17547 17548 17549 17550 17551 17552 17553 17554 17555 17556 17557 17558 17559 17560 17561 17562 17563 17564 17565 17566 17567 17568 17569 17570 17571 17572 17573 17574 17575 17576 17577 17578 17579 17580 17581 17582 17583 17584 17585 17586 17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 17603 17604 17605 17606 17607 17608 17609 17610 17611 17612 17613 17614 17615 17616 17617 17618 17619 17620 17621 17622 17623 17624 17625 17626 17627 17628 17629 17630 17631 17632 17633 17634 17635 17636 17637 17638 17639 17640 17641 17642 17643 17644 17645 17646 17647 17648 17649 17650 17651 17652 17653 17654 17655 17656 17657 17658 17659 17660 17661 17662 17663 17664 17665 17666 17667 17668 17669 17670 17671 17672 17673 17674 17675 17676 17677 17678 17679 17680 17681 17682 17683 17684 17685 17686 17687 17688 17689 17690 17691 17692 17693 17694 17695 17696 17697 17698 17699 17700 17701 17702 17703 17704 17705 17706 17707 17708 17709 17710 17711 17712 17713 17714 17715 17716 17717 17718 17719 17720 17721 17722 17723 17724 17725 17726 17727 17728 17729 17730 17731 17732 17733 17734 17735 17736 17737 17738 17739 17740 17741 17742 17743 17744 17745 17746 17747 17748 17749 17750 17751 17752 17753 17754 17755 17756 17757 17758 17759 17760 17761 17762 17763 17764 17765 17766 17767 17768 17769 17770 17771 17772 17773 17774 17775 17776 17777 17778 17779 17780 17781 17782 17783 17784 17785 17786 17787 17788 17789 17790 17791 17792 17793 17794 17795 17796 17797 17798 17799 17800 17801 17802 17803 17804 17805 17806 17807 17808 17809 17810 17811 17812 17813 17814 17815 17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 17844 17845 17846 17847 17848 17849 17850 17851 17852 17853 17854 17855 17856 17857 17858 17859 17860 17861 17862 17863 17864 17865 17866 17867 17868 17869 17870 17871 17872 17873 17874 17875 17876 17877 17878 17879 17880 17881 17882 17883 17884 17885 17886 17887 17888 17889 17890 17891 17892 17893 17894 17895 17896 17897 17898 17899 17900 17901 17902 17903 17904 17905 17906 17907 17908 17909 17910 17911 17912 17913 17914 17915 17916 17917 17918 17919 17920 17921 17922 17923 17924 17925 17926 17927 17928 17929 17930 17931 17932 17933 17934 17935 17936 17937 17938 17939 17940 17941 17942 17943 17944 17945 17946 17947 17948 17949 17950 17951 17952 17953 17954 17955 17956 17957 17958 17959 17960 17961 17962 17963 17964 17965 17966 17967 17968 17969 17970 17971 17972 17973 17974 17975 17976 17977 17978 17979 17980 17981 17982 17983 17984 17985 17986 17987 17988 17989 17990 17991 17992 17993 17994 17995 17996 17997 17998 17999 18000 18001 18002 18003 18004 18005 18006 18007 18008 18009 18010 18011 18012 18013 18014 18015 18016 18017 18018 18019 18020 18021 18022 18023 18024 18025 18026 18027 18028 18029 18030 18031 18032 18033 18034 18035 18036 18037 18038 18039 18040 18041 18042 18043 18044 18045 18046 18047 18048 18049 18050 18051 18052 18053 18054 18055 18056 18057 18058 18059 18060 18061 18062 18063 18064 18065 18066 18067 18068 18069 18070 18071 18072 18073 18074 18075 18076 18077 18078 18079 18080 18081 18082 18083 18084 18085 18086 18087 18088 18089 18090 18091 18092 18093 18094 18095 18096 18097 18098 18099 18100 18101 18102 18103 18104 18105 18106 18107 18108 18109 18110 18111 18112 18113 18114 18115 18116 18117 18118 18119 18120 18121 18122 18123 18124 18125 18126 18127 18128 18129 18130 18131 18132 18133 18134 18135 18136 18137 18138 18139 18140 18141 18142 18143 18144 18145 18146 18147 18148 18149 18150 18151 18152 18153 18154 18155 18156 18157 18158 18159 18160 18161 18162 18163 18164 18165 18166 18167 18168 18169 18170 18171 18172 18173 18174 18175 18176 18177 18178 18179 18180 18181 18182 18183 18184 18185 18186 18187 18188 18189 18190 18191 18192 18193 18194 18195 18196 18197 18198 18199 18200 18201 18202 18203 18204 18205 18206 18207 18208 18209 18210 18211 18212 18213 18214 18215 18216 18217 18218 18219 18220 18221 18222 18223 18224 18225 18226 18227 18228 18229 18230 18231 18232 18233 18234 18235 18236 18237 18238 18239 18240 18241 18242 18243 18244 18245 18246 18247 18248 18249 18250 18251 18252 18253 18254 18255 18256 18257 18258 18259 18260 18261 18262 18263 18264 18265 18266 18267 18268 18269 18270 18271 18272 18273 18274 18275 18276 18277 18278 18279 18280 18281 18282 18283 18284 18285 18286 18287 18288 18289 18290 18291 18292 18293 18294 18295 18296 18297 18298 18299 18300 18301 18302 18303 18304 18305 18306 18307 18308 18309 18310 18311 18312 18313 18314 18315 18316 18317 18318 18319 18320 18321 18322 18323 18324 18325 18326 18327 18328 18329 18330 18331 18332 18333 18334 18335 18336 18337 18338 18339 18340 18341 18342 18343 18344 18345 18346 18347 18348 18349 18350 18351 18352 18353 18354 18355 18356 18357 18358 18359 18360 18361 18362 18363 18364 18365 18366 18367 18368 18369 18370 18371 18372 18373 18374 18375 18376 18377 18378 18379 18380 18381 18382 18383 18384 18385 18386 18387 18388 18389 18390 18391 18392 18393 18394 18395 18396 18397 18398 18399 18400 18401 18402 18403 18404 18405 18406 18407 18408 18409 18410 18411 18412 18413 18414 18415 18416 18417 18418 18419 18420 18421 18422 18423 18424 18425 18426 18427 18428 18429 18430 18431 18432 18433 18434 18435 18436 18437 18438 18439 18440 18441 18442 18443 18444 18445 18446 18447 18448 18449 18450 18451 18452 18453 18454 18455 18456 18457 18458 18459 18460 18461 18462 18463 18464 18465 18466 18467 18468 18469 18470 18471 18472 18473 18474 18475 18476 18477 18478 18479 18480 18481 18482 18483 18484 18485 18486 18487 18488 18489 18490 18491 18492 18493 18494 18495 18496 18497 18498 18499 18500 18501 18502 18503 18504 18505 18506 18507 18508 18509 18510 18511 18512 18513 18514 18515 18516 18517 18518 18519 18520 18521 18522 18523 18524 18525 18526 18527 18528 18529 18530 18531 18532 18533 18534 18535 18536 18537 18538 18539 18540 18541 18542 18543 18544 18545 18546 18547 18548 18549 18550 18551 18552 18553 18554 18555 18556 18557 18558 18559 18560 18561 18562 18563 18564 18565 18566 18567 18568 18569 18570 18571 18572 18573 18574 18575 18576 18577 18578 18579 18580 18581 18582 18583 18584 18585 18586 18587 18588 18589 18590 18591 18592 18593 18594 18595 18596 18597 18598 18599 18600 18601 18602 18603 18604 18605 18606 18607 18608 18609 18610 18611 18612 18613 18614 18615 18616 18617 18618 18619 18620 18621 18622 18623 18624 18625 18626 18627 18628 18629 18630 18631 18632 18633 18634 18635 18636 18637 18638 18639 18640 18641 18642 18643 18644 18645 18646 18647 18648 18649 18650 18651 18652 18653 18654 18655 18656 18657 18658 18659 18660 18661 18662 18663 18664 18665 18666 18667 18668 18669 18670 18671 18672 18673 18674 18675 18676 18677 18678 18679 18680 18681 18682 18683 18684 18685 18686 18687 18688 18689 18690 18691 18692 18693 18694 18695 18696 18697 18698 18699 18700 18701 18702 18703 18704 18705 18706 18707 18708 18709 18710 18711 18712 18713 18714 18715 18716 18717 18718 18719 18720 18721 18722 18723 18724 18725 18726 18727 18728 18729 18730 18731 18732 18733 18734 18735 18736 18737 18738 18739 18740 18741 18742 18743 18744 18745 18746 18747 18748 18749 18750 18751 18752 18753 18754 18755 18756 18757 18758 18759 18760 18761 18762 18763 18764 18765 18766 18767 18768 18769 18770 18771 18772 18773 18774 18775 18776 18777 18778 18779 18780 18781 18782 18783 18784 18785 18786 18787 18788 18789 18790 18791 18792 18793 18794 18795 18796 18797 18798 18799 18800 18801 18802 18803 18804 18805 18806 18807 18808 18809 18810 18811 18812 18813 18814 18815 18816 18817 18818 18819 18820 18821 18822 18823 18824 18825 18826 18827 18828 18829 18830 18831 18832 18833 18834 18835 18836 18837 18838 18839 18840 18841 18842 18843 18844 18845 18846 18847 18848 18849 18850 18851 18852 18853 18854 18855 18856 18857 18858 18859 18860 18861 18862 18863 18864 18865 18866 18867 18868 18869 18870 18871 18872 18873 18874 18875 18876 18877 18878 18879 18880 18881 18882 18883 18884 18885 18886 18887 18888 18889 18890 18891 18892 18893 18894 18895 18896 18897 18898 18899 18900 18901 18902 18903 18904 18905 18906 18907 18908 18909 18910 18911 18912 18913 18914 18915 18916 18917 18918 18919 18920 18921 18922 18923 18924 18925 18926 18927 18928 18929 18930 18931 18932 18933 18934 18935 18936 18937 18938 18939 18940 18941 18942 18943 18944 18945 18946 18947 18948 18949 18950 18951 18952 18953 18954 18955 18956 18957 18958 18959 18960 18961 18962 18963 18964 18965 18966 18967 18968 18969 18970 18971 18972 18973 18974 18975 18976 18977 18978 18979 18980 18981 18982 18983 18984 18985 18986 18987 18988 18989 18990 18991 18992 18993 18994 18995 18996 18997 18998 18999 19000 19001 19002 19003 19004 19005 19006 19007 19008 19009 19010 19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 19031 19032 19033 19034 19035 19036 19037 19038 19039 19040 19041 19042 19043 19044 19045 19046 19047 19048 19049 19050 19051 19052 19053 19054 19055 19056 19057 19058 19059 19060 19061 19062 19063 19064 19065 19066 19067 19068 19069 19070 19071 19072 19073 19074 19075 19076 19077 19078 19079 19080 19081 19082 19083 19084 19085 19086 19087 19088 19089 19090 19091 19092 19093 19094 19095 19096 19097 19098 19099 19100 19101 19102 19103 19104 19105 19106 19107 19108 19109 19110 19111 19112 19113 19114 19115 19116 19117 19118 19119 19120 19121 19122 19123 19124 19125 19126 19127 19128 19129 19130 19131 19132 19133 19134 19135 19136 19137 19138 19139 19140 19141 19142 19143 19144 19145 19146 19147 19148 19149 19150 19151 19152 19153 19154 19155 19156 19157 19158 19159 19160 19161 19162 19163 19164 19165 19166 19167 19168 19169 19170 19171 19172 19173 19174 19175 19176 19177 19178 19179 19180 19181 19182 19183 19184 19185 19186 19187 19188 19189 19190 19191 19192 19193 19194 19195 19196 19197 19198 19199 19200 19201 19202 19203 19204 19205 19206 19207 19208 19209 19210 19211 19212 19213 19214 19215 19216 19217 19218 19219 19220 19221 19222 19223 19224 19225 19226 19227 19228 19229 19230 19231 19232 19233 19234 19235 19236 19237 19238 19239 19240 19241 19242 19243 19244 19245 19246 19247 19248 19249 19250 19251 19252 19253 19254 19255 19256 19257 19258 19259 19260 19261 19262 19263 19264 19265 19266 19267 19268 19269 19270 19271 19272 19273 19274 19275 19276 19277 19278 19279 19280 19281 19282 19283 19284 19285 19286 19287 19288 19289 19290 19291 19292 19293 19294 19295 19296 19297 19298 19299 19300 19301 19302 19303 19304 19305 19306 19307 19308 19309 19310 19311 19312 19313 19314 19315 19316 19317 19318 19319 19320 19321 19322 19323 19324 19325 19326 19327 19328 19329 19330 19331 19332 19333 19334 19335 19336 19337 19338 19339 19340 19341 19342 19343 19344 19345 19346 19347 19348 19349 19350 19351 19352 19353 19354 19355 19356 19357 19358 19359 19360 19361 19362 19363 19364 19365 19366 19367 19368 19369 19370 19371 19372 19373 19374 19375 19376 19377 19378 19379 19380 19381 19382 19383 19384 19385 19386 19387 19388 19389 19390 19391 19392 19393 19394 19395 19396 19397 19398 19399 19400 19401 19402 19403 19404 19405 19406 19407 19408 19409 19410 19411 19412 19413 19414 19415 19416 19417 19418 19419 19420 19421 19422 19423 19424 19425 19426 19427 19428 19429 19430 19431 19432 19433 19434 19435 19436 19437 19438 19439 19440 19441 19442 19443 19444 19445 19446 19447 19448 19449 19450 19451 19452 19453 19454 19455 19456 19457 19458 19459 19460 19461 19462 19463 19464 19465 19466 19467 19468 19469 19470 19471 19472 19473 19474 19475 19476 19477 19478 19479 19480 19481 19482 19483 19484 19485 19486 19487 19488 19489 19490 19491 19492 19493 19494 19495 19496 19497 19498 19499 19500 19501 19502 19503 19504 19505 19506 19507 19508 19509 19510 19511 19512 19513 19514 19515 19516 19517 19518 19519 19520 19521 19522 19523 19524 19525 19526 19527 19528 19529 19530 19531 19532 19533 19534 19535 19536 19537 19538 19539 19540 19541 19542 19543 19544 19545 19546 19547 19548 19549 19550 19551 19552 19553 19554 19555 19556 19557 19558 19559 19560 19561 19562 19563 19564 19565 19566 19567 19568 19569 19570 19571 19572 19573 19574 19575 19576 19577 19578 19579 19580 19581 19582 19583 19584 19585 19586 19587 19588 19589 19590 19591 19592 19593 19594 19595 19596 19597 19598 19599 19600 19601 19602 19603 19604 19605 19606 19607 19608 19609 19610 19611 19612 19613 19614 19615 19616 19617 19618 19619 19620 19621 19622 19623 19624 19625 19626 19627 19628 19629 19630 19631 19632 19633 19634 19635 19636 19637 19638 19639 19640 19641 19642 19643 19644 19645 19646 19647 19648 19649 19650 19651 19652 19653 19654 19655 19656 19657 19658 19659 19660 19661 19662 19663 19664 19665 19666 19667 19668 19669 19670 19671 19672 19673 19674 19675 19676 19677 19678 19679 19680 19681 19682 19683 19684 19685 19686 19687 19688 19689 19690 19691 19692 19693 19694 19695 19696 19697 19698 19699 19700 19701 19702 19703 19704 19705 19706 19707 19708 19709 19710 19711 19712 19713 19714 19715 19716 19717 19718 19719 19720 19721 19722 19723 19724 19725 19726 19727 19728 19729 19730 19731 19732 19733 19734 19735 19736 19737 19738 19739 19740 19741 19742 19743 19744 19745 19746 19747 19748 19749 19750 19751 19752 19753 19754 19755 19756 19757 19758 19759 19760 19761 19762 19763 19764 19765 19766 19767 19768 19769 19770 19771 19772 19773 19774 19775 19776 19777 19778 19779 19780 19781 19782 19783 19784 19785 19786 19787 19788 19789 19790 19791 19792 19793 19794 19795 19796 19797 19798 19799 19800 19801 19802 19803 19804 19805 19806 19807 19808 19809 19810 19811 19812 19813 19814 19815 19816 19817 19818 19819 19820 19821 19822 19823 19824 19825 19826 19827 19828 19829 19830 19831 19832 19833 19834 19835 19836 19837 19838 19839 19840 19841 19842 19843 19844 19845 19846 19847 19848 19849 19850 19851 19852 19853 19854 19855 19856 19857 19858 19859 19860 19861 19862 19863 19864 19865 19866 19867 19868 19869 19870 19871 19872 19873 19874 19875 19876 19877 19878 19879 19880 19881 19882 19883 19884 19885 19886 19887 19888 19889 19890 19891 19892 19893 19894 19895 19896 19897 19898 19899 19900 19901 19902 19903 19904 19905 19906 19907 19908 19909 19910 19911 19912 19913 19914 19915 19916 19917 19918 19919 19920 19921 19922 19923 19924 19925 19926 19927 19928 19929 19930 19931 19932 19933 19934 19935 19936 19937 19938 19939 19940 19941 19942 19943 19944 19945 19946 19947 19948 19949 19950 19951 19952 19953 19954 19955 19956 19957 19958 19959 19960 19961 19962 19963 19964 19965 19966 19967 19968 19969 19970 19971 19972 19973 19974 19975 19976 19977 19978 19979 19980 19981 19982 19983 19984 19985 19986 19987 19988 19989 19990 19991 19992 19993 19994 19995 19996 19997 19998 19999 20000 20001 20002 20003 20004 20005 20006 20007 20008 20009 20010 20011 20012 20013 20014 20015 20016 20017 20018 20019 20020 20021 20022 20023 20024 20025 20026 20027 20028 20029 20030 20031 20032 20033 20034 20035 20036 20037 20038 20039 20040 20041 20042 20043 20044 20045 20046 20047 20048 20049 20050 20051 20052 20053 20054 20055 20056 20057 20058 20059 20060 20061 20062 20063 20064 20065 20066 20067 20068 20069 20070 20071 20072 20073 20074 20075 20076 20077 20078 20079 20080 20081 20082 20083 20084 20085 20086 20087 20088 20089 20090 20091 20092 20093 20094 20095 20096 20097 20098 20099 20100 20101 20102 20103 20104 20105 20106 20107 20108 20109 20110 20111 20112 20113 20114 20115 20116 20117 20118 20119 20120 20121 20122 20123 20124 20125 20126 20127 20128 20129 20130 20131 20132 20133 20134 20135 20136 20137 20138 20139 20140 20141 20142 20143 20144 20145 20146 20147 20148 20149 20150 20151 20152 20153 20154 20155 20156 20157 20158 20159 20160 20161 20162 20163 20164 20165 20166 20167 20168 20169 20170 20171 20172 20173 20174 20175 20176 20177 20178 20179 20180 20181 20182 20183 20184 20185 20186 20187 20188 20189 20190 20191 20192 20193 20194 20195 20196 20197 20198 20199 20200 20201 20202 20203 20204 20205 20206 20207 20208 20209 20210 20211 20212 20213 20214 20215 20216 20217 20218 20219 20220 20221 20222 20223 20224 20225 20226 20227 20228 20229 20230 20231 20232 20233 20234 20235 20236 20237 20238 20239 20240 20241 20242 20243 20244 20245 20246 20247 20248 20249 20250 20251 20252 20253 20254 20255 20256 20257 20258 20259 20260 20261 20262 20263 20264 20265 20266 20267 20268 20269 20270 20271 20272 20273 20274 20275 20276 20277 20278 20279 20280 20281 20282 20283 20284 20285 20286 20287 20288 20289 20290 20291 20292 20293 20294 20295 20296 20297 20298 20299 20300 20301 20302 20303 20304 20305 20306 20307 20308 20309 20310 20311 20312 20313 20314 20315 20316 20317 20318 20319 20320 20321 20322 20323 20324 20325 20326 20327 20328 20329 20330 20331 20332 20333 20334 20335 20336 20337 20338 20339 20340 20341 20342 20343 20344 20345 20346 20347 20348 20349 20350 20351 20352 20353 20354 20355 20356 20357 20358 20359 20360 20361 20362 20363 20364 20365 20366 20367 20368 20369 20370 20371 20372 20373 20374 20375 20376 20377 20378 20379 20380 20381 20382 20383 20384 20385 20386 20387 20388 20389 20390 20391 20392 20393 20394 20395 20396 20397 20398 20399 20400 20401 20402 20403 20404 20405 20406 20407 20408 20409 20410 20411 20412 20413 20414 20415 20416 20417 20418 20419 20420 20421 20422 20423 20424 20425 20426 20427 20428 20429 20430 20431 20432 20433 20434 20435 20436 20437 20438 20439 20440 20441 20442 20443 20444 20445 20446 20447 20448 20449 20450 20451 20452 20453 20454 20455 20456 20457 20458 20459 20460 20461 20462 20463 20464 20465 20466 20467 20468 20469 20470 20471 20472 20473 20474 20475 20476 20477 20478 20479 20480 20481 20482 20483 20484 20485 20486 20487 20488 20489 20490 20491 20492 20493 20494 20495 20496 20497 20498 20499 20500 20501 20502 20503 20504 20505 20506 20507 20508 20509 20510 20511 20512 20513 20514 20515 20516 20517 20518 20519 20520 20521 20522 20523 20524 20525 20526 20527 20528 20529 20530 20531 20532 20533 20534 20535 20536 20537 20538 20539 20540 20541 20542 20543 20544 20545 20546 20547 20548 20549 20550 20551 20552 20553 20554 20555 20556 20557 20558 20559 20560 20561 20562 20563 20564 20565 20566 20567 20568 20569 20570 20571 20572 20573 20574 20575 20576 20577 20578 20579 20580 20581 20582 20583 20584 20585 20586 20587 20588 20589 20590 20591 20592 20593 20594 20595 20596 20597 20598 20599 20600 20601 20602 20603 20604 20605 20606 20607 20608 20609 20610 20611 20612 20613 20614 20615 20616 20617 20618 20619 20620 20621 20622 20623 20624 20625 20626 20627 20628 20629 20630 20631 20632 20633 20634 20635 20636 20637 20638 20639 20640 20641 20642 20643 20644 20645 20646 20647 20648 20649 20650 20651 20652 20653 20654 20655 20656 20657 20658 20659 20660 20661 20662 20663 20664 20665 20666 20667 20668 20669 20670 20671 20672 20673 20674 20675 20676 20677 20678 20679 20680 20681 20682 20683 20684 20685 20686 20687 20688 20689 20690 20691 20692 20693 20694 20695 20696 20697 20698 20699 20700 20701 20702 20703 20704 20705 20706 20707 20708 20709 20710 20711 20712 20713 20714 20715 20716 20717 20718 20719 20720 20721 20722 20723 20724 20725 20726 20727 20728 20729 20730 20731 20732 20733 20734 20735 20736 20737 20738 20739 20740 20741 20742 20743 20744 20745 20746 20747 20748 20749 20750 20751 20752 20753 20754 20755 20756 20757 20758 20759 20760 20761 20762 20763 20764 20765 20766 20767 20768 20769 20770 20771 20772 20773 20774 20775 20776 20777 20778 20779 20780 20781 20782 20783 20784 20785 20786 20787 20788 20789 20790 20791 20792 20793 20794 20795 20796 20797 20798 20799 20800 20801 20802 20803 20804 20805 20806 20807 20808 20809 20810 20811 20812 20813 20814 20815 20816 20817 20818 20819 20820 20821 20822 20823 20824 20825 20826 20827 20828 20829 20830 20831 20832 20833 20834 20835 20836 20837 20838 20839 20840 20841 20842 20843 20844 20845 20846 20847 20848 20849 20850 20851 20852 20853 20854 20855 20856 20857 20858 20859 20860 20861 20862 20863 20864 20865 20866 20867 20868 20869 20870 20871 20872 20873 20874 20875 20876 20877 20878 20879 20880 20881 20882 20883 20884 20885 20886 20887 20888 20889 20890 20891 20892 20893 20894 20895 20896 20897 20898 20899 20900 20901 20902 20903 20904 20905 20906 20907 20908 20909 20910 20911 20912 20913 20914 20915 20916 20917 20918 20919 20920 20921 20922 20923 20924 20925 20926 20927 20928 20929 20930 20931 20932 20933 20934 20935 20936 20937 20938 20939 20940 20941 20942 20943 20944 20945 20946 20947 20948 20949 20950 20951 20952 20953 20954 20955 20956 20957 20958 20959 20960 20961 20962 20963 20964 20965 20966 20967 20968 20969 20970 20971 20972 20973 20974 20975 20976 20977 20978 20979 20980 20981 20982 20983 20984 20985 20986 20987 20988 20989 20990 20991 20992 20993 20994 20995 20996 20997 20998 20999 21000 21001 21002 21003 21004 21005 21006 21007 21008 21009 21010 21011 21012 21013 21014 21015 21016 21017 21018 21019 21020 21021 21022 21023 21024 21025 21026 21027 21028 21029 21030 21031 21032 21033 21034 21035 21036 21037 21038 21039 21040 21041 21042 21043 21044 21045 21046 21047 21048 21049 21050 21051 21052 21053 21054 21055 21056 21057 21058 21059 21060 21061 21062 21063 21064 21065 21066 21067 21068 21069 21070 21071 21072 21073 21074 21075 21076 21077 21078 21079 21080 21081 21082 21083 21084 21085 21086 21087 21088 21089 21090 21091 21092 21093 21094 21095 21096 21097 21098 21099 21100 21101 21102 21103 21104 21105 21106 21107 21108 21109 21110 21111 21112 21113 21114 21115 21116 21117 21118 21119 21120 21121 21122 21123 21124 21125 21126 21127 21128 21129 21130 21131 21132 21133 21134 21135 21136 21137 21138 21139 21140 21141 21142 21143 21144 21145 21146 21147 21148 21149 21150 21151 21152 21153 21154 21155 21156 21157 21158 21159 21160 21161 21162 21163 21164 21165 21166 21167 21168 21169 21170 21171 21172 21173 21174 21175 21176 21177 21178 21179 21180 21181 21182 21183 21184 21185 21186 21187 21188 21189 21190 21191 21192 21193 21194 21195 21196 21197 21198 21199 21200 21201 21202 21203 21204 21205 21206 21207 21208 21209 21210 21211 21212 21213 21214 21215 21216 21217 21218 21219 21220 21221 21222 21223 21224 21225 21226 21227 21228 21229 21230 21231 21232 21233 21234 21235 21236 21237 21238 21239 21240 21241 21242 21243 21244 21245 21246 21247 21248 21249 21250 21251 21252 21253 21254 21255 21256 21257 21258 21259 21260 21261 21262 21263 21264 21265 21266 21267 21268 21269 21270 21271 21272 21273 21274 21275 21276 21277 21278 21279 21280 21281 21282 21283 21284 21285 21286 21287 21288 21289 21290 21291 21292 21293 21294 21295 21296 21297 21298 21299 21300 21301 21302 21303 21304 21305 21306 21307 21308 21309 21310 21311 21312 21313 21314 21315 21316 21317 21318 21319 21320 21321 21322 21323 21324 21325 21326 21327 21328 21329 21330 21331 21332 21333 21334 21335 21336 21337 21338 21339 21340 21341 21342 21343 21344 21345 21346 21347 21348 21349 21350 21351 21352 21353 21354 21355 21356 21357 21358 21359 21360 21361 21362 21363 21364 21365 21366 21367 21368 21369 21370 21371 21372 21373 21374 21375 21376 21377 21378 21379 21380 21381 21382 21383 21384 21385 21386 21387 21388 21389 21390 21391 21392 21393 21394 21395 21396 21397 21398 21399 21400 21401 21402 21403 21404 21405 21406 21407 21408 21409 21410 21411 21412 21413 21414 21415 21416 21417 21418 21419 21420 21421 21422 21423 21424 21425 21426 21427 21428 21429 21430 21431 21432 21433 21434 21435 21436 21437 21438 21439 21440 21441 21442 21443 21444 21445 21446 21447 21448 21449 21450 21451 21452 21453 21454 21455 21456 21457 21458 21459 21460 21461 21462 21463 21464 21465 21466 21467 21468 21469 21470 21471 21472 21473 21474 21475 21476 21477 21478 21479 21480 21481 21482 21483 21484 21485 21486 21487 21488 21489 21490 21491 21492 21493 21494 21495 21496 21497 21498 21499 21500 21501 21502 21503 21504 21505 21506 21507 21508 21509 21510 21511 21512 21513 21514 21515 21516 21517 21518 21519 21520 21521 21522 21523 21524 21525 21526 21527 21528 21529 21530 21531 21532 21533 21534 21535 21536 21537 21538 21539 21540 21541 21542 21543 21544 21545 21546 21547 21548 21549 21550 21551 21552 21553 21554 21555 21556 21557 21558 21559 21560 21561 21562 21563 21564 21565 21566 21567 21568 21569 21570 21571 21572 21573 21574 21575 21576 21577 21578 21579 21580 21581 21582 21583 21584 21585 21586 21587 21588 21589 21590 21591 21592 21593 21594 21595 21596 21597 21598 21599 21600 21601 21602 21603 21604 21605 21606 21607 21608 21609 21610 21611 21612 21613 21614 21615 21616 21617 21618 21619 21620 21621 21622 21623 21624 21625 21626 21627 21628 21629 21630 21631 21632 21633 21634 21635 21636 21637 21638 21639 21640 21641 21642 21643 21644 21645 21646 21647 21648 21649 21650 21651 21652 21653 21654 21655 21656 21657 21658 21659 21660 21661 21662 21663 21664 21665 21666 21667 21668 21669 21670 21671 21672 21673 21674 21675 21676 21677 21678 21679 21680 21681 21682 21683 21684 21685 21686 21687 21688 21689 21690 21691 21692 21693 21694 21695 21696 21697 21698 21699 21700 21701 21702 21703 21704 21705 21706 21707 21708 21709 21710 21711 21712 21713 21714 21715 21716 21717 21718 21719 21720 21721 21722 21723 21724 21725 21726 21727 21728 21729 21730 21731 21732 21733 21734 21735 21736 21737 21738 21739 21740 21741 21742 21743 21744 21745 21746 21747 21748 21749 21750 21751 21752 21753 21754 21755 21756 21757 21758 21759 21760 21761 21762 21763 21764 21765 21766 21767 21768 21769 21770 21771 21772 21773 21774 21775 21776 21777 21778 21779 21780 21781 21782 21783 21784 21785 21786 21787 21788 21789 21790 21791 21792 21793 21794 21795 21796 21797 21798 21799 21800 21801 21802 21803 21804 21805 21806 21807 21808 21809 21810 21811 21812 21813 21814 21815 21816 21817 21818 21819 21820 21821 21822 21823 21824 21825 21826 21827 21828 21829 21830 21831 21832 21833 21834 21835 21836 21837 21838 21839 21840 21841 21842 21843 21844 21845 21846 21847 21848 21849 21850 21851 21852 21853 21854 21855 21856 21857 21858 21859 21860 21861 21862 21863 21864 21865 21866 21867 21868 21869 21870 21871 21872 21873 21874 21875 21876 21877 21878 21879 21880 21881 21882 21883 21884 21885 21886 21887 21888 21889 21890 21891 21892 21893 21894 21895 21896 21897 21898 21899 21900 21901 21902 21903 21904 21905 21906 21907 21908 21909 21910 21911 21912 21913 21914 21915 21916 21917 21918 21919 21920 21921 21922 21923 21924 21925 21926 21927 21928 21929 21930 21931 21932 21933 21934 21935 21936 21937 21938 21939 21940 21941 21942 21943 21944 21945 21946 21947 21948 21949 21950 21951 21952 21953 21954 21955 21956 21957 21958 21959 21960 21961 21962 21963 21964 21965 21966 21967 21968 21969 21970 21971 21972 21973 21974 21975 21976 21977 21978 21979 21980 21981 21982 21983 21984 21985 21986 21987 21988 21989 21990 21991 21992 21993 21994 21995 21996 21997 21998 21999 22000 22001 22002 22003 22004 22005 22006 22007 22008 22009 22010 22011 22012 22013 22014 22015 22016 22017 22018 22019 22020 22021 22022 22023 22024 22025 22026 22027 22028 22029 22030 22031 22032 22033 22034 22035 22036 22037 22038 22039 22040 22041 22042 22043 22044 22045 22046 22047 22048 22049 22050 22051 22052 22053 22054 22055 22056 22057 22058 22059 22060 22061 22062 22063 22064 22065 22066 22067 22068 22069 22070 22071 22072 22073 22074 22075 22076 22077 22078 22079 22080 22081 22082 22083 22084 22085 22086 22087 22088 22089 22090 22091 22092 22093 22094 22095 22096 22097 22098 22099 22100 22101 22102 22103 22104 22105 22106 22107 22108 22109 22110 22111 22112 22113 22114 22115 22116 22117 22118 22119 22120 22121 22122 22123 22124 22125 22126 22127 22128 22129 22130 22131 22132 22133 22134 22135 22136 22137 22138 22139 22140 22141 22142 22143 22144 22145 22146 22147 22148 22149 22150 22151 22152 22153 22154 22155 22156 22157 22158 22159 22160 22161 22162 22163 22164 22165 22166 22167 22168 22169 22170 22171 22172 22173 22174 22175 22176 22177 22178 22179 22180 22181 22182 22183 22184 22185 22186 22187 22188 22189 22190 22191 22192 22193 22194 22195 22196 22197 22198 22199 22200 22201 22202 22203 22204 22205 22206 22207 22208 22209 22210 22211 22212 22213 22214 22215 22216 22217 22218 22219 22220 22221 22222 22223 22224 22225 22226 22227 22228 22229 22230 22231 22232 22233 22234 22235 22236 22237 22238 22239 22240 22241 22242 22243 22244 22245 22246 22247 22248 22249 22250 22251 22252 22253 22254 22255 22256 22257 22258 22259 22260 22261 22262 22263 22264 22265 22266 22267 22268 22269 22270 22271 22272 22273 22274 22275 22276 22277 22278 22279 22280 22281 22282 22283 22284 22285 22286 22287 22288 22289 22290 22291 22292 22293 22294 22295 22296 22297 22298 22299 22300 22301 22302 22303 22304 22305 22306 22307 22308 22309 22310 22311 22312 22313 22314 22315 22316 22317 22318 22319 22320 22321 22322 22323 22324 22325 22326 22327 22328 22329 22330 22331 22332 22333 22334 22335 22336 22337 22338 22339 22340 22341 22342 22343 22344 22345 22346 22347 22348 22349 22350 22351 22352 22353 22354 22355 22356 22357 22358 22359 22360 22361 22362 22363 22364 22365 22366 22367 22368 22369 22370 22371 22372 22373 22374 22375 22376 22377 22378 22379 22380 22381 22382 22383 22384 22385 22386 22387 22388 22389 22390 22391 22392 22393 22394 22395 22396 22397 22398 22399 22400 22401 22402 22403 22404 22405 22406 22407 22408 22409 22410 22411 22412 22413 22414 22415 22416 22417 22418 22419 22420 22421 22422 22423 22424 22425 22426 22427 22428 22429 22430 22431 22432 22433 22434 22435 22436 22437 22438 22439 22440 22441 22442 22443 22444 22445 22446 22447 22448 22449 22450 22451 22452 22453 22454 22455 22456 22457 22458 22459 22460 22461 22462 22463 22464 22465 22466 22467 22468 22469 22470 22471 22472 22473 22474 22475 22476 22477 22478 22479 22480 22481 22482 22483 22484 22485 22486 22487 22488 22489 22490 22491 22492 22493 22494 22495 22496 22497 22498 22499 22500 22501 22502 22503 22504 22505 22506 22507 22508 22509 22510 22511 22512 22513 22514 22515 22516 22517 22518 22519 22520 22521 22522 22523 22524 22525 22526 22527 22528 22529 22530 22531 22532 22533 22534 22535 22536 22537 22538 22539 22540 22541 22542 22543 22544 22545 22546 22547 22548 22549 22550 22551 22552 22553 22554 22555 22556 22557 22558 22559 22560 22561 22562 22563 22564 22565 22566 22567 22568 22569 22570 22571 22572 22573 22574 22575 22576 22577 22578 22579 22580 22581 22582 22583 22584 22585 22586 22587 22588 22589 22590 22591 22592 22593 22594 22595 22596 22597 22598 22599 22600 22601 22602 22603 22604 22605 22606 22607 22608 22609 22610 22611 22612 22613 22614 22615 22616 22617 22618 22619 22620 22621 22622 22623 22624 22625 22626 22627 22628 22629 22630 22631 22632 22633 22634 22635 22636 22637 22638 22639 22640 22641 22642 22643 22644 22645 22646 22647 22648 22649 22650 22651 22652 22653 22654 22655 22656 22657 22658 22659 22660 22661 22662 22663 22664 22665 22666 22667 22668 22669 22670 22671 22672 22673 22674 22675 22676 22677 22678 22679 22680 22681 22682 22683 22684 22685 22686 22687 22688 22689 22690 22691 22692 22693 22694 22695 22696 22697 22698 22699 22700 22701 22702 22703 22704 22705 22706 22707 22708 22709 22710 22711 22712 22713 22714 22715 22716 22717 22718 22719 22720 22721 22722 22723 22724 22725 22726 22727 22728 22729 22730 22731 22732 22733 22734 22735 22736 22737 22738 22739 22740 22741 22742 22743 22744 22745 22746 22747 22748 22749 22750 22751 22752 22753 22754 22755 22756 22757 22758 22759 22760 22761 22762 22763 22764 22765 22766 22767 22768 22769 22770 22771 22772 22773 22774 22775 22776 22777 22778 22779 22780 22781 22782 22783 22784 22785 22786 22787 22788 22789 22790 22791 22792 22793 22794 22795 22796 22797 22798 22799 22800 22801 22802 22803 22804 22805 22806 22807 22808 22809 22810 22811 22812 22813 22814 22815 22816 22817 22818 22819 22820 22821 22822 22823 22824 22825 22826 22827 22828 22829 22830 22831 22832 22833 22834 22835 22836 22837 22838 22839 22840 22841 22842 22843 22844 22845 22846 22847 22848 22849 22850 22851 22852 22853 22854 22855 22856 22857 22858 22859 22860 22861 22862 22863 22864 22865 22866 22867 22868 22869 22870 22871 22872 22873 22874 22875 22876 22877 22878 22879 22880 22881 22882 22883 22884 22885 22886 22887 22888 22889 22890 22891 22892 22893 22894 22895 22896 22897 22898 22899 22900 22901 22902 22903 22904 22905 22906 22907 22908 22909 22910 22911 22912 22913 22914 22915 22916 22917 22918 22919 22920 22921 22922 22923 22924 22925 22926 22927 22928 22929 22930 22931 22932 22933 22934 22935 22936 22937 22938 22939 22940 22941 22942 22943 22944 22945 22946 22947 22948 22949 22950 22951 22952 22953 22954 22955 22956 22957 22958 22959 22960 22961 22962 22963 22964 22965 22966 22967 22968 22969 22970 22971 22972 22973 22974 22975 22976 22977 22978 22979 22980 22981 22982 22983 22984 22985 22986 22987 22988 22989 22990 22991 22992 22993 22994 22995 22996 22997 22998 22999 23000 23001 23002 23003 23004 23005 23006 23007 23008 23009 23010 23011 23012 23013 23014 23015 23016 23017 23018 23019 23020 23021 23022 23023 23024 23025 23026 23027 23028 23029 23030 23031 23032 23033 23034 23035 23036 23037 23038 23039 23040 23041 23042 23043 23044 23045 23046 23047 23048 23049 23050 23051 23052 23053 23054 23055 23056 23057 23058 23059 23060 23061 23062 23063 23064 23065 23066 23067 23068 23069 23070 23071 23072 23073 23074 23075 23076 23077 23078 23079 23080 23081 23082 23083 23084 23085 23086 23087 23088 23089 23090 23091 23092 23093 23094 23095 23096 23097 23098 23099 23100 23101 23102 23103 23104 23105 23106 23107 23108 23109 23110 23111 23112 23113 23114 23115 23116 23117 23118 23119 23120 23121 23122 23123 23124 23125 23126 23127 23128 23129 23130 23131 23132 23133 23134 23135 23136 23137 23138 23139 23140 23141 23142 23143 23144 23145 23146 23147 23148 23149 23150 23151 23152 23153 23154 23155 23156 23157 23158 23159 23160 23161 23162 23163 23164 23165 23166 23167 23168 23169 23170 23171 23172 23173 23174 23175 23176 23177 23178 23179 23180 23181 23182 23183 23184 23185 23186 23187 23188 23189 23190 23191 23192 23193 23194 23195 23196 23197 23198 23199 23200 23201 23202 23203 23204 23205 23206 23207 23208 23209 23210 23211 23212 23213 23214 23215 23216 23217 23218 23219 23220 23221 23222 23223 23224 23225 23226 23227 23228 23229 23230 23231 23232 23233 23234 23235 23236 23237 23238 23239 23240 23241 23242 23243 23244 23245 23246 23247 23248 23249 23250 23251 23252 23253 23254 23255 23256 23257 23258 23259 23260 23261 23262 23263 23264 23265 23266 23267 23268 23269 23270 23271 23272 23273 23274 23275 23276 23277 23278 23279 23280 23281 23282 23283 23284 23285 23286 23287 23288 23289 23290 23291 23292 23293 23294 23295 23296 23297 23298 23299 23300 23301 23302 23303 23304 23305 23306 23307 23308 23309 23310 23311 23312 23313 23314 23315 23316 23317 23318 23319 23320 23321 23322 23323 23324 23325 23326 23327 23328 23329 23330 23331 23332 23333 23334 23335 23336 23337 23338 23339 23340 23341 23342 23343 23344 23345 23346 23347 23348 23349 23350 23351 23352 23353 23354 23355 23356 23357 23358 23359 23360 23361 23362 23363 23364 23365 23366 23367 23368 23369 23370 23371 23372 23373 23374 23375 23376 23377 23378 23379 23380 23381 23382 23383 23384 23385 23386 23387 23388 23389 23390 23391 23392 23393 23394 23395 23396 23397 23398 23399 23400 23401 23402 23403 23404 23405 23406 23407 23408 23409 23410 23411 23412 23413 23414 23415 23416 23417 23418 23419 23420 23421 23422 23423 23424 23425 23426 23427 23428 23429 23430 23431 23432 23433 23434 23435 23436 23437 23438 23439 23440 23441 23442 23443 23444 23445 23446 23447 23448 23449 23450 23451 23452 23453 23454 23455 23456 23457 23458 23459 23460 23461 23462 23463 23464 23465 23466 23467 23468 23469 23470 23471 23472 23473 23474 23475 23476 23477 23478 23479 23480 23481 23482 23483 23484 23485 23486 23487 23488 23489 23490 23491 23492 23493 23494 23495 23496 23497 23498 23499 23500 23501 23502 23503 23504 23505 23506 23507 23508 23509 23510 23511 23512 23513 23514 23515 23516 23517 23518 23519 23520 23521 23522 23523 23524 23525 23526 23527 23528 23529 23530 23531 23532 23533 23534 23535 23536 23537 23538 23539 23540 23541 23542 23543 23544 23545 23546 23547 23548 23549 23550 23551 23552 23553 23554 23555 23556 23557 23558 23559 23560 23561 23562 23563 23564 23565 23566 23567 23568 23569 23570 23571 23572 23573 23574 23575 23576 23577 23578 23579 23580 23581 23582 23583 23584 23585 23586 23587 23588 23589 23590 23591 23592 23593 23594 23595 23596 23597 23598 23599 23600 23601 23602 23603 23604 23605 23606 23607 23608 23609 23610 23611 23612 23613 23614 23615 23616 23617 23618 23619 23620 23621 23622 23623 23624 23625 23626 23627 23628 23629 23630 23631 23632 23633 23634 23635 23636 23637 23638 23639 23640 23641 23642 23643 23644 23645 23646 23647 23648 23649 23650 23651 23652 23653 23654 23655 23656 23657 23658 23659 23660 23661 23662 23663 23664 23665 23666 23667 23668 23669 23670 23671 23672 23673 23674 23675 23676 23677 23678 23679 23680 23681 23682 23683 23684 23685 23686 23687 23688 23689 23690 23691 23692 23693 23694 23695 23696 23697 23698 23699 23700 23701 23702 23703 23704 23705 23706 23707 23708 23709 23710 23711 23712 23713 23714 23715 23716 23717 23718 23719 23720 23721 23722 23723 23724 23725 23726 23727 23728 23729 23730 23731 23732 23733 23734 23735 23736 23737 23738 23739 23740 23741 23742 23743 23744 23745 23746 23747 23748 23749 23750 23751 23752 23753 23754 23755 23756 23757 23758 23759 23760 23761 23762 23763 23764 23765 23766 23767 23768 23769 23770 23771 23772 23773 23774 23775 23776 23777 23778 23779 23780 23781 23782 23783 23784 23785 23786 23787 23788 23789 23790 23791 23792 23793 23794 23795 23796 23797 23798 23799 23800 23801 23802 23803 23804 23805 23806 23807 23808 23809 23810 23811 23812 23813 23814 23815 23816 23817 23818 23819 23820 23821 23822 23823 23824 23825 23826 23827 23828 23829 23830 23831 23832 23833 23834 23835 23836 23837 23838 23839 23840 23841 23842 23843 23844 23845 23846 23847 23848 23849 23850 23851 23852 23853 23854 23855 23856 23857 23858 23859 23860 23861 23862 23863 23864 23865 23866 23867 23868 23869 23870 23871 23872 23873 23874 23875 23876 23877 23878 23879 23880 23881 23882 23883 23884 23885 23886 23887 23888 23889 23890 23891 23892 23893 23894 23895 23896 23897 23898 23899 23900 23901 23902 23903 23904 23905 23906 23907 23908 23909 23910 23911 23912 23913 23914 23915 23916 23917 23918 23919 23920 23921 23922 23923 23924 23925 23926 23927 23928 23929 23930 23931 23932 23933 23934 23935 23936 23937 23938 23939 23940 23941 23942 23943 23944 23945 23946 23947 23948 23949 23950 23951 23952 23953 23954 23955 23956 23957 23958 23959 23960 23961 23962 23963 23964 23965 23966 23967 23968 23969 23970 23971 23972 23973 23974 23975 23976 23977 23978 23979 23980 23981 23982 23983 23984 23985 23986 23987 23988 23989 23990 23991 23992 23993 23994 23995 23996 23997 23998 23999 24000 24001 24002 24003 24004 24005 24006 24007 24008 24009 24010 24011 24012 24013 24014 24015 24016 24017 24018 24019 24020 24021 24022 24023 24024 24025 24026 24027 24028 24029 24030 24031 24032 24033 24034 24035 24036 24037 24038 24039 24040 24041 24042 24043 24044 24045 24046 24047 24048 24049 24050 24051 24052 24053 24054 24055 24056 24057 24058 24059 24060 24061 24062 24063 24064 24065 24066 24067 24068 24069 24070 24071 24072 24073 24074 24075 24076 24077 24078 24079 24080 24081 24082 24083 24084 24085 24086 24087 24088 24089 24090 24091 24092 24093 24094 24095 24096 24097 24098 24099 24100 24101 24102 24103 24104 24105 24106 24107 24108 24109 24110 24111 24112 24113 24114 24115 24116 24117 24118 24119 24120 24121 24122 24123 24124 24125 24126 24127 24128 24129 24130 24131 24132 24133 24134 24135 24136 24137 24138 24139 24140 24141 24142 24143 24144 24145 24146 24147 24148 24149 24150 24151 24152 24153 24154 24155 24156 24157 24158 24159 24160 24161 24162 24163 24164 24165 24166 24167 24168 24169 24170 24171 24172 24173 24174 24175 24176 24177 24178 24179 24180 24181 24182 24183 24184 24185 24186 24187 24188 24189 24190 24191 24192 24193 24194 24195 24196 24197 24198 24199 24200 24201 24202 24203 24204 24205 24206 24207 24208 24209 24210 24211 24212 24213 24214 24215 24216 24217 24218 24219 24220 24221 24222 24223 24224 24225 24226 24227 24228 24229 24230 24231 24232 24233 24234 24235 24236 24237 24238 24239 24240 24241 24242 24243 24244 24245 24246 24247 24248 24249 24250 24251 24252 24253 24254 24255 24256 24257 24258 24259 24260 24261 24262 24263 24264 24265 24266 24267 24268 24269 24270 24271 24272 24273 24274 24275 24276 24277 24278 24279 24280 24281 24282 24283 24284 24285 24286 24287 24288 24289 24290 24291 24292 24293 24294 24295 24296 24297 24298 24299 24300 24301 24302 24303 24304 24305 24306 24307 24308 24309 24310 24311 24312 24313 24314 24315 24316 24317 24318 24319 24320 24321 24322 24323 24324 24325 24326 24327 24328 24329 24330 24331 24332 24333 24334 24335 24336 24337 24338 24339 24340 24341 24342 24343 24344 24345 24346 24347 24348 24349 24350 24351 24352 24353 24354 24355 24356 24357 24358 24359 24360 24361 24362 24363 24364 24365 24366 24367 24368 24369 24370 24371 24372 24373 24374 24375 24376 24377 24378 24379 24380 24381 24382 24383 24384 24385 24386 24387 24388 24389 24390 24391 24392 24393 24394 24395 24396 24397 24398 24399 24400 24401 24402 24403 24404 24405 24406 24407 24408 24409 24410 24411 24412 24413 24414 24415 24416 24417 24418 24419 24420 24421 24422 24423 24424 24425 24426 24427 24428 24429 24430 24431 24432 24433 24434 24435 24436 24437 24438 24439 24440 24441 24442 24443 24444 24445 24446 24447 24448 24449 24450 24451 24452 24453 24454 24455 24456 24457 24458 24459 24460 24461 24462 24463 24464 24465 24466 24467 24468 24469 24470 24471 24472 24473 24474 24475 24476 24477 24478 24479 24480 24481 24482 24483 24484 24485 24486 24487 24488 24489 24490 24491 24492 24493 24494 24495 24496 24497 24498 24499 24500 24501 24502 24503 24504 24505 24506 24507 24508 24509 24510 24511 24512 24513 24514 24515 24516 24517 24518 24519 24520 24521 24522 24523 24524 24525 24526 24527 24528 24529 24530 24531 24532 24533 24534 24535 24536 24537 24538 24539 24540 24541 24542 24543 24544 24545 24546 24547 24548 24549 24550 24551 24552 24553 24554 24555 24556 24557 24558 24559 24560 24561 24562 24563 24564 24565 24566 24567 24568 24569 24570 24571 24572 24573 24574 24575 24576 24577 24578 24579 24580 24581 24582 24583 24584 24585 24586 24587 24588 24589 24590 24591 24592 24593 24594 24595 24596 24597 24598 24599 24600 24601 24602 24603 24604 24605 24606 24607 24608 24609 24610 24611 24612 24613 24614 24615 24616 24617 24618 24619 24620 24621 24622 24623 24624 24625 24626 24627 24628 24629 24630 24631 24632 24633 24634 24635 24636 24637 24638 24639 24640 24641 24642 24643 24644 24645 24646 24647 24648 24649 24650 24651 24652 24653 24654 24655 24656 24657 24658 24659 24660 24661 24662 24663 24664 24665 24666 24667 24668 24669 24670 24671 24672 24673 24674 24675 24676 24677 24678 24679 24680 24681 24682 24683 24684 24685 24686 24687 24688 24689 24690 24691 24692 24693 24694 24695 24696 24697 24698 24699 24700 24701 24702 24703 24704 24705 24706 24707 24708 24709 24710 24711 24712 24713 24714 24715 24716 24717 24718 24719 24720 24721 24722 24723 24724 24725 24726 24727 24728 24729 24730 24731 24732 24733 24734 24735 24736 24737 24738 24739 24740 24741 24742 24743 24744 24745 24746 24747 24748 24749 24750 24751 24752 24753 24754 24755 24756 24757 24758 24759 24760 24761 24762 24763 24764 24765 24766 24767 24768 24769 24770 24771 24772 24773 24774 24775 24776 24777 24778 24779 24780 24781 24782 24783 24784 24785 24786 24787 24788 24789 24790 24791 24792 24793 24794 24795 24796 24797 24798 24799 24800 24801 24802 24803 24804 24805 24806 24807 24808 24809 24810 24811 24812 24813 24814 24815 24816 24817 24818 24819 24820 24821 24822 24823 24824 24825 24826 24827 24828 24829 24830 24831 24832 24833 24834 24835 24836 24837 24838 24839 24840 24841 24842 24843 24844 24845 24846 24847 24848 24849 24850 24851 24852 24853 24854 24855 24856 24857 24858 24859 24860 24861 24862 24863 24864 24865 24866 24867 24868 24869 24870 24871 24872 24873 24874 24875 24876 24877 24878 24879 24880 24881 24882 24883 24884 24885 24886 24887 24888 24889 24890 24891 24892 24893 24894 24895 24896 24897 24898 24899 24900 24901 24902 24903 24904 24905 24906 24907 24908 24909 24910 24911 24912 24913 24914 24915 24916 24917 24918 24919 24920 24921 24922 24923 24924 24925 24926 24927 24928 24929 24930 24931 24932 24933 24934 24935 24936 24937 24938 24939 24940 24941 24942 24943 24944 24945 24946 24947 24948 24949 24950 24951 24952 24953 24954 24955 24956 24957 24958 24959 24960 24961 24962 24963 24964 24965 24966 24967 24968 24969 24970 24971 24972 24973 24974 24975 24976 24977 24978 24979 24980 24981 24982 24983 24984 24985 24986 24987 24988 24989 24990 24991 24992 24993 24994 24995 24996 24997 24998 24999 25000 25001 25002 25003 25004 25005 25006 25007 25008 25009 25010 25011 25012 25013 25014 25015 25016 25017 25018 25019 25020 25021 25022 25023 25024 25025 25026 25027 25028 25029 25030 25031 25032 25033 25034 25035 25036 25037 25038 25039 25040 25041 25042 25043 25044 25045 25046 25047 25048 25049 25050 25051 25052 25053 25054 25055 25056 25057 25058 25059 25060 25061 25062 25063 25064 25065 25066 25067 25068 25069 25070 25071 25072 25073 25074 25075 25076 25077 25078 25079 25080 25081 25082 25083 25084 25085 25086 25087 25088 25089 25090 25091 25092 25093 25094 25095 25096 25097 25098 25099 25100 25101 25102 25103 25104 25105 25106 25107 25108 25109 25110 25111 25112 25113 25114 25115 25116 25117 25118 25119 25120 25121 25122 25123 25124 25125 25126 25127 25128 25129 25130 25131 25132 25133 25134 25135 25136 25137 25138 25139 25140 25141 25142 25143 25144 25145 25146 25147 25148 25149 25150 25151 25152 25153 25154 25155 25156 25157 25158 25159 25160 25161 25162 25163 25164 25165 25166 25167 25168 25169 25170 25171 25172 25173 25174 25175 25176 25177 25178 25179 25180 25181 25182 25183 25184 25185 25186 25187 25188 25189 25190 25191 25192 25193 25194 25195 25196 25197 25198 25199 25200 25201 25202 25203 25204 25205 25206 25207 25208 25209 25210 25211 25212 25213 25214 25215 25216 25217 25218 25219 25220 25221 25222 25223 25224 25225 25226 25227 25228 25229 25230 25231 25232 25233 25234 25235 25236 25237 25238 25239 25240 25241 25242 25243 25244 25245 25246 25247 25248 25249 25250 25251 25252 25253 25254 25255 25256 25257 25258 25259 25260 25261 25262 25263 25264 25265 25266 25267 25268 25269 25270 25271 25272 25273 25274 25275 25276 25277 25278 25279 25280 25281 25282 25283 25284 25285 25286 25287 25288 25289 25290 25291 25292 25293 25294 25295 25296 25297 25298 25299 25300 25301 25302 25303 25304 25305 25306 25307 25308 25309 25310 25311 25312 25313 25314 25315 25316 25317 25318 25319 25320 25321 25322 25323 25324 25325 25326 25327 25328 25329 25330 25331 25332 25333 25334 25335 25336 25337 25338 25339 25340 25341 25342 25343 25344 25345 25346 25347 25348 25349 25350 25351 25352 25353 25354 25355 25356 25357 25358 25359 25360 25361 25362 25363 25364 25365 25366 25367 25368 25369 25370 25371 25372 25373 25374 25375 25376 25377 25378 25379 25380 25381 25382 25383 25384 25385 25386 25387 25388 25389 25390 25391 25392 25393 25394 25395 25396 25397 25398 25399 25400 25401 25402 25403 25404 25405 25406 25407 25408 25409 25410 25411 25412 25413 25414 25415 25416 25417 25418 25419 25420 25421 25422 25423 25424 25425 25426 25427 25428 25429 25430 25431 25432 25433 25434 25435 25436 25437 25438 25439 25440 25441 25442 25443 25444 25445 25446 25447 25448 25449 25450 25451 25452 25453 25454 25455 25456 25457 25458 25459 25460 25461 25462 25463 25464 25465 25466 25467 25468 25469 25470 25471 25472 25473 25474 25475 25476 25477 25478 25479 25480 25481 25482 25483 25484 25485 25486 25487 25488 25489 25490 25491 25492 25493 25494 25495 25496 25497 25498 25499 25500 25501 25502 25503 25504 25505 25506 25507 25508 25509 25510 25511 25512 25513 25514 25515 25516 25517 25518 25519 25520 25521 25522 25523 25524 25525 25526 25527 25528 25529 25530 25531 25532 25533 25534 25535 25536 25537 25538 25539 25540 25541 25542 25543 25544 25545 25546 25547 25548 25549 25550 25551 25552 25553 25554 25555 25556 25557 25558 25559 25560 25561 25562 25563 25564 25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 25578 25579 25580 25581 25582 25583 25584 25585 25586 25587 25588 25589 25590 25591 25592 25593 25594 25595 25596 25597 25598 25599 25600 25601 25602 25603 25604 25605 25606 25607 25608 25609 25610 25611 25612 25613 25614 25615 25616 25617 25618 25619 25620 25621 25622 25623 25624 25625 25626 25627 25628 25629 25630 25631 25632 25633 25634 25635 25636 25637 25638 25639 25640 25641 25642 25643 25644 25645 25646 25647 25648 25649 25650 25651 25652 25653 25654 25655 25656 25657 25658 25659 25660 25661 25662 25663 25664 25665 25666 25667 25668 25669 25670 25671 25672 25673 25674 25675 25676 25677 25678 25679 25680 25681 25682 25683 25684 25685 25686 25687 25688 25689 25690 25691 25692 25693 25694 25695 25696 25697 25698 25699 25700 25701 25702 25703 25704 25705 25706 25707 25708 25709 25710 25711 25712 25713 25714 25715 25716 25717 25718 25719 25720 25721 25722 25723 25724 25725 25726 25727 25728 25729 25730 25731 25732 25733 25734 25735 25736 25737 25738 25739 25740 25741 25742 25743 25744 25745 25746 25747 25748 25749 25750 25751 25752 25753 25754 25755 25756 25757 25758 25759 25760 25761 25762 25763 25764 25765 25766 25767 25768 25769 25770 25771 25772 25773 25774 25775 25776 25777 25778 25779 25780 25781 25782 25783 25784 25785 25786 25787 25788 25789 25790 25791 25792 25793 25794 25795 25796 25797 25798 25799 25800 25801 25802 25803 25804 25805 25806 25807 25808 25809 25810 25811 25812 25813 25814 25815 25816 25817 25818 25819 25820 25821 25822 25823 25824 25825 25826 25827 25828 25829 25830 25831 25832 25833 25834 25835 25836 25837 25838 25839 25840 25841 25842 25843 25844 25845 25846 25847 25848 25849 25850 25851 25852 25853 25854 25855 25856 25857 25858 25859 25860 25861 25862 25863 25864 25865 25866 25867 25868 25869 25870 25871 25872 25873 25874 25875 25876 25877 25878 25879 25880 25881 25882 25883 25884 25885 25886 25887 25888 25889 25890 25891 25892 25893 25894 25895 25896 25897 25898 25899 25900 25901 25902 25903 25904 25905 25906 25907 25908 25909 25910 25911 25912 25913 25914 25915 25916 25917 25918 25919 25920 25921 25922 25923 25924 25925 25926 25927 25928 25929 25930 25931 25932 25933 25934 25935 25936 25937 25938 25939 25940 25941 25942 25943 25944 25945 25946 25947 25948 25949 25950 25951 25952 25953 25954 25955 25956 25957 25958 25959 25960 25961 25962 25963 25964 25965 25966 25967 25968 25969 25970 25971 25972 25973 25974 25975 25976 25977 25978 25979 25980 25981 25982 25983 25984 25985 25986 25987 25988 25989 25990 25991 25992 25993 25994 25995 25996 25997 25998 25999 26000 26001 26002 26003 26004 26005 26006 26007 26008 26009 26010 26011 26012 26013 26014 26015 26016 26017 26018 26019 26020 26021 26022 26023 26024 26025 26026 26027 26028 26029 26030 26031 26032 26033 26034 26035 26036 26037 26038 26039 26040 26041 26042 26043 26044 26045 26046 26047 26048 26049 26050 26051 26052 26053 26054 26055 26056 26057 26058 26059 26060 26061 26062 26063 26064 26065 26066 26067 26068 26069 26070 26071 26072 26073 26074 26075 26076 26077 26078 26079 26080 26081 26082 26083 26084 26085 26086 26087 26088 26089 26090 26091 26092 26093 26094 26095 26096 26097 26098 26099 26100 26101 26102 26103 26104 26105 26106 26107 26108 26109 26110 26111 26112 26113 26114 26115 26116 26117 26118 26119 26120 26121 26122 26123 26124 26125 26126 26127 26128 26129 26130 26131 26132 26133 26134 26135 26136 26137 26138 26139 26140 26141 26142 26143 26144 26145 26146 26147 26148 26149 26150 26151 26152 26153 26154 26155 26156 26157 26158 26159 26160 26161 26162 26163 26164 26165 26166 26167 26168 26169 26170 26171 26172 26173 26174 26175 26176 26177 26178 26179 26180 26181 26182 26183 26184 26185 26186 26187 26188 26189 26190 26191 26192 26193 26194 26195 26196 26197 26198 26199 26200 26201 26202 26203 26204 26205 26206 26207 26208 26209 26210 26211 26212 26213 26214 26215 26216 26217 26218 26219 26220 26221 26222 26223 26224 26225 26226 26227 26228 26229 26230 26231 26232 26233 26234 26235 26236 26237 26238 26239 26240 26241 26242 26243 26244 26245 26246 26247 26248 26249 26250 26251 26252 26253 26254 26255 26256 26257 26258 26259 26260 26261 26262 26263 26264 26265 26266 26267 26268 26269 26270 26271 26272 26273 26274 26275 26276 26277 26278 26279 26280 26281 26282 26283 26284 26285 26286 26287 26288 26289 26290 26291 26292 26293 26294 26295 26296 26297 26298 26299 26300 26301 26302 26303 26304 26305 26306 26307 26308 26309 26310 26311 26312 26313 26314 26315 26316 26317 26318 26319 26320 26321 26322 26323 26324 26325 26326 26327 26328 26329 26330 26331 26332 26333 26334 26335 26336 26337 26338 26339 26340 26341 26342 26343 26344 26345 26346 26347 26348 26349 26350 26351 26352 26353 26354 26355 26356 26357 26358 26359 26360 26361 26362 26363 26364 26365 26366 26367 26368 26369 26370 26371 26372 26373 26374 26375 26376 26377 26378 26379 26380 26381 26382 26383 26384 26385 26386 26387 26388 26389 26390 26391 26392 26393 26394 26395 26396 26397 26398 26399 26400 26401 26402 26403 26404 26405 26406 26407 26408 26409 26410 26411 26412 26413 26414 26415 26416 26417 26418 26419 26420 26421 26422 26423 26424 26425 26426 26427 26428 26429 26430 26431 26432 26433 26434 26435 26436 26437 26438 26439 26440 26441 26442 26443 26444 26445 26446 26447 26448 26449 26450 26451 26452 26453 26454 26455 26456 26457 26458 26459 26460 26461 26462 26463 26464 26465 26466 26467 26468 26469 26470 26471 26472 26473 26474 26475 26476 26477 26478 26479 26480 26481 26482 26483 26484 26485 26486 26487 26488 26489 26490 26491 26492 26493 26494 26495 26496 26497 26498 26499 26500 26501 26502 26503 26504 26505 26506 26507 26508 26509 26510 26511 26512 26513 26514 26515 26516 26517 26518 26519 26520 26521 26522 26523 26524 26525 26526 26527 26528 26529 26530 26531 26532 26533 26534 26535 26536 26537 26538 26539 26540 26541 26542 26543 26544 26545 26546 26547 26548 26549 26550 26551 26552 26553 26554 26555 26556 26557 26558 26559 26560 26561 26562 26563 26564 26565 26566 26567 26568 26569 26570 26571 26572 26573 26574 26575 26576 26577 26578 26579 26580 26581 26582 26583 26584 26585 26586 26587 26588 26589 26590 26591 26592 26593 26594 26595 26596 26597 26598 26599 26600 26601 26602 26603 26604 26605 26606 26607 26608 26609 26610 26611 26612 26613 26614 26615 26616 26617 26618 26619 26620 26621 26622 26623 26624 26625 26626 26627 26628 26629 26630 26631 26632 26633 26634 26635 26636 26637 26638 26639 26640 26641 26642 26643 26644 26645 26646 26647 26648 26649 26650 26651 26652 26653 26654 26655 26656 26657 26658 26659 26660 26661 26662 26663 26664 26665 26666 26667 26668 26669 26670 26671 26672 26673 26674 26675 26676 26677 26678 26679 26680 26681 26682 26683 26684 26685 26686 26687 26688 26689 26690 26691 26692 26693 26694 26695 26696 26697 26698 26699 26700 26701 26702 26703 26704 26705 26706 26707 26708 26709 26710 26711 26712 26713 26714 26715 26716 26717 26718 26719 26720 26721 26722 26723 26724 26725 26726 26727 26728 26729 26730 26731 26732 26733 26734 26735 26736 26737 26738 26739 26740 26741 26742 26743 26744 26745 26746 26747 26748 26749 26750 26751 26752 26753 26754 26755 26756 26757 26758 26759 26760 26761 26762 26763 26764 26765 26766 26767 26768 26769 26770 26771 26772 26773 26774 26775 26776 26777 26778 26779 26780 26781 26782 26783 26784 26785 26786 26787 26788 26789 26790 26791 26792 26793 26794 26795 26796 26797 26798 26799 26800 26801 26802 26803 26804 26805 26806 26807 26808 26809 26810 26811 26812 26813 26814 26815 26816 26817 26818 26819 26820 26821 26822 26823 26824 26825 26826 26827 26828 26829 26830 26831 26832 26833 26834 26835 26836 26837 26838 26839 26840 26841 26842 26843 26844 26845 26846 26847 26848 26849 26850 26851 26852 26853 26854 26855 26856 26857 26858 26859 26860 26861 26862 26863 26864 26865 26866 26867 26868 26869 26870 26871 26872 26873 26874 26875 26876 26877 26878 26879 26880 26881 26882 26883 26884 26885 26886 26887 26888 26889 26890 26891 26892 26893 26894 26895 26896 26897 26898 26899 26900 26901 26902 26903 26904 26905 26906 26907 26908 26909 26910 26911 26912 26913 26914 26915 26916 26917 26918 26919 26920 26921 26922 26923 26924 26925 26926 26927 26928 26929 26930 26931 26932 26933 26934 26935 26936 26937 26938 26939 26940 26941 26942 26943 26944 26945 26946 26947 26948 26949 26950 26951 26952 26953 26954 26955 26956 26957 26958 26959 26960 26961 26962 26963 26964 26965 26966 26967 26968 26969 26970 26971 26972 26973 26974 26975 26976 26977 26978 26979 26980 26981 26982 26983 26984 26985 26986 26987 26988 26989 26990 26991 26992 26993 26994 26995 26996 26997 26998 26999 27000 27001 27002 27003 27004 27005 27006 27007 27008 27009 27010 27011 27012 27013 27014 27015 27016 27017 27018 27019 27020 27021 27022 27023 27024 27025 27026 27027 27028 27029 27030 27031 27032 27033 27034 27035 27036 27037 27038 27039 27040 27041 27042 27043 27044 27045 27046 27047 27048 27049 27050 27051 27052 27053 27054 27055 27056 27057 27058 27059 27060 27061 27062 27063 27064 27065 27066 27067 27068 27069 27070 27071 27072 27073 27074 27075 27076 27077 27078 27079 27080 27081 27082 27083 27084 27085 27086 27087 27088 27089 27090 27091 27092 27093 27094 27095 27096 27097 27098 27099 27100 27101 27102 27103 27104 27105 27106 27107 27108 27109 27110 27111 27112 27113 27114 27115 27116 27117 27118 27119 27120 27121 27122 27123 27124 27125 27126 27127 27128 27129 27130 27131 27132 27133 27134 27135 27136 27137 27138 27139 27140 27141 27142 27143 27144 27145 27146 27147 27148 27149 27150 27151 27152 27153 27154 27155 27156 27157 27158 27159 27160 27161 27162 27163 27164 27165 27166 27167 27168 27169 27170 27171 27172 27173 27174 27175 27176 27177 27178 27179 27180 27181 27182 27183 27184 27185 27186 27187 27188 27189 27190 27191 27192 27193 27194 27195 27196 27197 27198 27199 27200 27201 27202 27203 27204 27205 27206 27207 27208 27209 27210 27211 27212 27213 27214 27215 27216 27217 27218 27219 27220 27221 27222 27223 27224 27225 27226 27227 27228 27229 27230 27231 27232 27233 27234 27235 27236 27237 27238 27239 27240 27241 27242 27243 27244 27245 27246 27247 27248 27249 27250 27251 27252 27253 27254 27255 27256 27257 27258 27259 27260 27261 27262 27263 27264 27265 27266 27267 27268 27269 27270 27271 27272 27273 27274 27275 27276 27277 27278 27279 27280 27281 27282 27283 27284 27285 27286 27287 27288 27289 27290 27291 27292 27293 27294 27295 27296 27297 27298 27299 27300 27301 27302 27303 27304 27305 27306 27307 27308 27309 27310 27311 27312 27313 27314 27315 27316 27317 27318 27319 27320 27321 27322 27323 27324 27325 27326 27327 27328 27329 27330 27331 27332 27333 27334 27335 27336 27337 27338 27339 27340 27341 27342 27343 27344 27345 27346 27347 27348 27349 27350 27351 27352 27353 27354 27355 27356 27357 27358 27359 27360 27361 27362 27363 27364 27365 27366 27367 27368 27369 27370 27371 27372 27373 27374 27375 27376 27377 27378 27379 27380 27381 27382 27383 27384 27385 27386 27387 27388 27389 27390 27391 27392 27393 27394 27395 27396 27397 27398 27399 27400 27401 27402 27403 27404 27405 27406 27407 27408 27409 27410 27411 27412 27413 27414 27415 27416 27417 27418 27419 27420 27421 27422 27423 27424 27425 27426 27427 27428 27429 27430 27431 27432 27433 27434 27435 27436 27437 27438 27439 27440 27441 27442 27443 27444 27445 27446 27447 27448 27449 27450 27451 27452 27453 27454 27455 27456 27457 27458 27459 27460 27461 27462 27463 27464 27465 27466 27467 27468 27469 27470 27471 27472 27473 27474 27475 27476 27477 27478 27479 27480 27481 27482 27483 27484 27485 27486 27487 27488 27489 27490 27491 27492 27493 27494 27495 27496 27497 27498 27499 27500 27501 27502 27503 27504 27505 27506 27507 27508 27509 27510 27511 27512 27513 27514 27515 27516 27517 27518 27519 27520 27521 27522 27523 27524 27525 27526 27527 27528 27529 27530 27531 27532 27533 27534 27535 27536 27537 27538 27539 27540 27541 27542 27543 27544 27545 27546 27547 27548 27549 27550 27551 27552 27553 27554 27555 27556 27557 27558 27559 27560 27561 27562 27563 27564 27565 27566 27567 27568 27569 27570 27571 27572 27573 27574 27575 27576 27577 27578 27579 27580 27581 27582 27583 27584 27585 27586 27587 27588 27589 27590 27591 27592 27593 27594 27595 27596 27597 27598 27599 27600 27601 27602 27603 27604 27605 27606 27607 27608 27609 27610 27611 27612 27613 27614 27615 27616 27617 27618 27619 27620 27621 27622 27623 27624 27625 27626 27627 27628 27629 27630 27631 27632 27633 27634 27635 27636 27637 27638 27639 27640 27641 27642 27643 27644 27645 27646 27647 27648 27649 27650 27651 27652 27653 27654 27655 27656 27657 27658 27659 27660 27661 27662 27663 27664 27665 27666 27667 27668 27669 27670 27671 27672 27673 27674 27675 27676 27677 27678 27679 27680 27681 27682 27683 27684 27685 27686 27687 27688 27689 27690 27691 27692 27693 27694 27695 27696 27697 27698 27699 27700 27701 27702 27703 27704 27705 27706 27707 27708 27709 27710 27711 27712 27713 27714 27715 27716 27717 27718 27719 27720 27721 27722 27723 27724 27725 27726 27727 27728 27729 27730 27731 27732 27733 27734 27735 27736 27737 27738 27739 27740 27741 27742 27743 27744 27745 27746 27747 27748 27749 27750 27751 27752 27753 27754 27755 27756 27757 27758 27759 27760 27761 27762 27763 27764 27765 27766 27767 27768 27769 27770 27771 27772 27773 27774 27775 27776 27777 27778 27779 27780 27781 27782 27783 27784 27785 27786 27787 27788 27789 27790 27791 27792 27793 27794 27795 27796 27797 27798 27799 27800 27801 27802 27803 27804 27805 27806 27807 27808 27809 27810 27811 27812 27813 27814 27815 27816 27817 27818 27819 27820 27821 27822 27823 27824 27825 27826 27827 27828 27829 27830 27831 27832 27833 27834 27835 27836 27837 27838 27839 27840 27841 27842 27843 27844 27845 27846 27847 27848 27849 27850 27851 27852 27853 27854 27855 27856 27857 27858 27859 27860 27861 27862 27863 27864 27865 27866 27867 27868 27869 27870 27871 27872 27873 27874 27875 27876 27877 27878 27879 27880 27881 27882 27883 27884 27885 27886 27887 27888 27889 27890 27891 27892 27893 27894 27895 27896 27897 27898 27899 27900 27901 27902 27903 27904 27905 27906 27907 27908 27909 27910 27911 27912 27913 27914 27915 27916 27917 27918 27919 27920 27921 27922 27923 27924 27925 27926 27927 27928 27929 27930 27931 27932 27933 27934 27935 27936 27937 27938 27939 27940 27941 27942 27943 27944 27945 27946 27947 27948 27949 27950 27951 27952 27953 27954 27955 27956 27957 27958 27959 27960 27961 27962 27963 27964 27965 27966 27967 27968 27969 27970 27971 27972 27973 27974 27975 27976 27977 27978 27979 27980 27981 27982 27983 27984 27985 27986 27987 27988 27989 27990 27991 27992 27993 27994 27995 27996 27997 27998 27999 28000 28001 28002 28003 28004 28005 28006 28007 28008 28009 28010 28011 28012 28013 28014 28015 28016 28017 28018 28019 28020 28021 28022 28023 28024 28025 28026 28027 28028 28029 28030 28031 28032 28033 28034 28035 28036 28037 28038 28039 28040 28041 28042 28043 28044 28045 28046 28047 28048 28049 28050 28051 28052 28053 28054 28055 28056 28057 28058 28059 28060 28061 28062 28063 28064 28065 28066 28067 28068 28069 28070 28071 28072 28073 28074 28075 28076 28077 28078 28079 28080 28081 28082 28083 28084 28085 28086 28087 28088 28089 28090 28091 28092 28093 28094 28095 28096 28097 28098 28099 28100 28101 28102 28103 28104 28105 28106 28107 28108 28109 28110 28111 28112 28113 28114 28115 28116 28117 28118 28119 28120 28121 28122 28123 28124 28125 28126 28127 28128 28129 28130 28131 28132 28133 28134 28135 28136 28137 28138 28139 28140 28141 28142 28143 28144 28145 28146 28147 28148 28149 28150 28151 28152 28153 28154 28155 28156 28157 28158 28159 28160 28161 28162 28163 28164 28165 28166 28167 28168 28169 28170 28171 28172 28173 28174 28175 28176 28177 28178 28179 28180 28181 28182 28183 28184 28185 28186 28187 28188 28189 28190 28191 28192 28193 28194 28195 28196 28197 28198 28199 28200 28201 28202 28203 28204 28205 28206 28207 28208 28209 28210 28211 28212 28213 28214 28215 28216 28217 28218 28219 28220 28221 28222 28223 28224 28225 28226 28227 28228 28229 28230 28231 28232 28233 28234 28235 28236 28237 28238 28239 28240 28241 28242 28243 28244 28245 28246 28247 28248 28249 28250 28251 28252 28253 28254 28255 28256 28257 28258 28259 28260 28261 28262 28263 28264 28265 28266 28267 28268 28269 28270 28271 28272 28273 28274 28275 28276 28277 28278 28279 28280 28281 28282 28283 28284 28285 28286 28287 28288 28289 28290 28291 28292 28293 28294 28295 28296 28297 28298 28299 28300 28301 28302 28303 28304 28305 28306 28307 28308 28309 28310 28311 28312 28313 28314 28315 28316 28317 28318 28319 28320 28321 28322 28323 28324 28325 28326 28327 28328 28329 28330 28331 28332 28333 28334 28335 28336 28337 28338 28339 28340 28341 28342 28343 28344 28345 28346 28347 28348 28349 28350 28351 28352 28353 28354 28355 28356 28357 28358 28359 28360 28361 28362 28363 28364 28365 28366 28367 28368 28369 28370 28371 28372 28373 28374 28375 28376 28377 28378 28379 28380 28381 28382 28383 28384 28385 28386 28387 28388 28389 28390 28391 28392 28393 28394 28395 28396 28397 28398 28399 28400 28401 28402 28403 28404 28405 28406 28407 28408 28409 28410 28411 28412 28413 28414 28415 28416 28417 28418 28419 28420 28421 28422 28423 28424 28425 28426 28427 28428 28429 28430 28431 28432 28433 28434 28435 28436 28437 28438 28439 28440 28441 28442 28443 28444 28445 28446 28447 28448 28449 28450 28451 28452 28453 28454 28455 28456 28457 28458 28459 28460 28461 28462 28463 28464 28465 28466 28467 28468 28469 28470 28471 28472 28473 28474 28475 28476 28477 28478 28479 28480 28481 28482 28483 28484 28485 28486 28487 28488 28489 28490 28491 28492 28493 28494 28495 28496 28497 28498 28499 28500 28501 28502 28503 28504 28505 28506 28507 28508 28509 28510 28511 28512 28513 28514 28515 28516 28517 28518 28519 28520 28521 28522 28523 28524 28525 28526 28527 28528 28529 28530 28531 28532 28533 28534 28535 28536 28537 28538 28539 28540 28541 28542 28543 28544 28545 28546 28547 28548 28549 28550 28551 28552 28553 28554 28555 28556 28557 28558 28559 28560 28561 28562 28563 28564 28565 28566 28567 28568 28569 28570 28571 28572 28573 28574 28575 28576 28577 28578 28579 28580 28581 28582 28583 28584 28585 28586 28587 28588 28589 28590 28591 28592 28593 28594 28595 28596 28597 28598 28599 28600 28601 28602 28603 28604 28605 28606 28607 28608 28609 28610 28611 28612 28613 28614 28615 28616 28617 28618 28619 28620 28621 28622 28623 28624 28625 28626 28627 28628 28629 28630 28631 28632 28633 28634 28635 28636 28637 28638 28639 28640 28641 28642 28643 28644 28645 28646 28647 28648 28649 28650 28651 28652 28653 28654 28655 28656 28657 28658 28659 28660 28661 28662 28663 28664 28665 28666 28667 28668 28669 28670 28671 28672 28673 28674 28675 28676 28677 28678 28679 28680 28681 28682 28683 28684 28685 28686 28687 28688 28689 28690 28691 28692 28693 28694 28695 28696 28697 28698 28699 28700 28701 28702 28703 28704 28705 28706 28707 28708 28709 28710 28711 28712 28713 28714 28715 28716 28717 28718 28719 28720 28721 28722 28723 28724 28725 28726 28727 28728 28729 28730 28731 28732 28733 28734 28735 28736 28737 28738 28739 28740 28741 28742 28743 28744 28745 28746 28747 28748 28749 28750 28751 28752 28753 28754 28755 28756 28757 28758 28759 28760 28761 28762 28763 28764 28765 28766 28767 28768 28769 28770 28771 28772 28773 28774 28775 28776 28777 28778 28779 28780 28781 28782 28783 28784 28785 28786 28787 28788 28789 28790 28791 28792 28793 28794 28795 28796 28797 28798 28799 28800 28801 28802 28803 28804 28805 28806 28807 28808 28809 28810 28811 28812 28813 28814 28815 28816 28817 28818 28819 28820 28821 28822 28823 28824 28825 28826 28827 28828 28829 28830 28831 28832 28833 28834 28835 28836 28837 28838 28839 28840 28841 28842 28843 28844 28845 28846 28847 28848 28849 28850 28851 28852 28853 28854 28855 28856 28857 28858 28859 28860 28861 28862 28863 28864 28865 28866 28867 28868 28869 28870 28871 28872 28873 28874 28875 28876 28877 28878 28879 28880 28881 28882 28883 28884 28885 28886 28887 28888 28889 28890 28891 28892 28893 28894 28895 28896 28897 28898 28899 28900 28901 28902 28903 28904 28905 28906 28907 28908 28909 28910 28911 28912 28913 28914 28915 28916 28917 28918 28919 28920 28921 28922 28923 28924 28925 28926 28927 28928 28929 28930 28931 28932 28933 28934 28935 28936 28937 28938 28939 28940 28941 28942 28943 28944 28945 28946 28947 28948 28949 28950 28951 28952 28953 28954 28955 28956 28957 28958 28959 28960 28961 28962 28963 28964 28965 28966 28967 28968 28969 28970 28971 28972 28973 28974 28975 28976 28977 28978 28979 28980 28981 28982 28983 28984 28985 28986 28987 28988 28989 28990 28991 28992 28993 28994 28995 28996 28997 28998 28999 29000 29001 29002 29003 29004 29005 29006 29007 29008 29009 29010 29011 29012 29013 29014 29015 29016 29017 29018 29019 29020 29021 29022 29023 29024 29025 29026 29027 29028 29029 29030 29031 29032 29033 29034 29035 29036 29037 29038 29039 29040 29041 29042 29043 29044 29045 29046 29047 29048 29049 29050 29051 29052 29053 29054 29055 29056 29057 29058 29059 29060 29061 29062 29063 29064 29065 29066 29067 29068 29069 29070 29071 29072 29073 29074 29075 29076 29077 29078 29079 29080 29081 29082 29083 29084 29085 29086 29087 29088 29089 29090 29091 29092 29093 29094 29095 29096 29097 29098 29099 29100 29101 29102 29103 29104 29105 29106 29107 29108 29109 29110 29111 29112 29113 29114 29115 29116 29117 29118 29119 29120 29121 29122 29123 29124 29125 29126 29127 29128 29129 29130 29131 29132 29133 29134 29135 29136 29137 29138 29139 29140 29141 29142 29143 29144 29145 29146 29147 29148 29149 29150 29151 29152 29153 29154 29155 29156 29157 29158 29159 29160 29161 29162 29163 29164 29165 29166 29167 29168 29169 29170 29171 29172 29173 29174 29175 29176 29177 29178 29179 29180 29181 29182 29183 29184 29185 29186 29187 29188 29189 29190 29191 29192 29193 29194 29195 29196 29197 29198 29199 29200 29201 29202 29203 29204 29205 29206 29207 29208 29209 29210 29211 29212 29213 29214 29215 29216 29217 29218 29219 29220 29221 29222 29223 29224 29225 29226 29227 29228 29229 29230 29231 29232 29233 29234 29235 29236 29237 29238 29239 29240 29241 29242 29243 29244 29245 29246 29247 29248 29249 29250 29251 29252 29253 29254 29255 29256 29257 29258 29259 29260 29261 29262 29263 29264 29265 29266 29267 29268 29269 29270 29271 29272 29273 29274 29275 29276 29277 29278 29279 29280 29281 29282 29283 29284 29285 29286 29287 29288 29289 29290 29291 29292 29293 29294 29295 29296 29297 29298 29299 29300 29301 29302 29303 29304 29305 29306 29307 29308 29309 29310 29311 29312 29313 29314 29315 29316 29317 29318 29319 29320 29321 29322 29323 29324 29325 29326 29327 29328 29329 29330 29331 29332 29333 29334 29335 29336 29337 29338 29339 29340 29341 29342 29343 29344 29345 29346 29347 29348 29349 29350 29351 29352 29353 29354 29355 29356 29357 29358 29359 29360 29361 29362 29363 29364 29365 29366 29367 29368 29369 29370 29371 29372 29373 29374 29375 29376 29377 29378 29379 29380 29381 29382 29383 29384 29385 29386 29387 29388 29389 29390 29391 29392 29393 29394 29395 29396 29397 29398 29399 29400 29401 29402 29403 29404 29405 29406 29407 29408 29409 29410 29411 29412 29413 29414 29415 29416 29417 29418 29419 29420 29421 29422 29423 29424 29425 29426 29427 29428 29429 29430 29431 29432 29433 29434 29435 29436 29437 29438 29439 29440 29441 29442 29443 29444 29445 29446 29447 29448 29449 29450 29451 29452 29453 29454 29455 29456 29457 29458 29459 29460 29461 29462 29463 29464 29465 29466 29467 29468 29469 29470 29471 29472 29473 29474 29475 29476 29477 29478 29479 29480 29481 29482 29483 29484 29485 29486 29487 29488 29489 29490 29491 29492 29493 29494 29495 29496 29497 29498 29499 29500 29501 29502 29503 29504 29505 29506 29507 29508 29509 29510 29511 29512 29513 29514 29515 29516 29517 29518 29519 29520 29521 29522 29523 29524 29525 29526 29527 29528 29529 29530 29531 29532 29533 29534 29535 29536 29537 29538 29539 29540 29541 29542 29543 29544 29545 29546 29547 29548 29549 29550 29551 29552 29553 29554 29555 29556 29557 29558 29559 29560 29561 29562 29563 29564 29565 29566 29567 29568 29569 29570 29571 29572 29573 29574 29575 29576 29577 29578 29579 29580 29581 29582 29583 29584 29585 29586 29587 29588 29589 29590 29591 29592 29593 29594 29595 29596 29597 29598 29599 29600 29601 29602 29603 29604 29605 29606 29607 29608 29609 29610 29611 29612 29613 29614 29615 29616 29617 29618 29619 29620 29621 29622 29623 29624 29625 29626 29627 29628 29629 29630 29631 29632 29633 29634 29635 29636 29637 29638 29639 29640 29641 29642 29643 29644 29645 29646 29647 29648 29649 29650 29651 29652 29653 29654 29655 29656 29657 29658 29659 29660 29661 29662 29663 29664 29665 29666 29667 29668 29669 29670 29671 29672 29673 29674 29675 29676 29677 29678 29679 29680 29681 29682 29683 29684 29685 29686 29687 29688 29689 29690 29691 29692 29693 29694 29695 29696 29697 29698 29699 29700 29701 29702 29703 29704 29705 29706 29707 29708 29709 29710 29711 29712 29713 29714 29715 29716 29717 29718 29719 29720 29721 29722 29723 29724 29725 29726 29727 29728 29729 29730 29731 29732 29733 29734 29735 29736 29737 29738 29739 29740 29741 29742 29743 29744 29745 29746 29747 29748 29749 29750 29751 29752 29753 29754 29755 29756 29757 29758 29759 29760 29761 29762 29763 29764 29765 29766 29767 29768 29769 29770 29771 29772 29773 29774 29775 29776 29777 29778 29779 29780 29781 29782 29783 29784 29785 29786 29787 29788 29789 29790 29791 29792 29793 29794 29795 29796 29797 29798 29799 29800 29801 29802 29803 29804 29805 29806 29807 29808 29809 29810 29811 29812 29813 29814 29815 29816 29817 29818 29819 29820 29821 29822 29823 29824 29825 29826 29827 29828 29829 29830 29831 29832 29833 29834 29835 29836 29837 29838 29839 29840 29841 29842 29843 29844 29845 29846 29847 29848 29849 29850 29851 29852 29853 29854 29855 29856 29857 29858 29859 29860 29861 29862 29863 29864 29865 29866 29867 29868 29869 29870 29871 29872 29873 29874 29875 29876 29877 29878 29879 29880 29881 29882 29883 29884 29885 29886 29887 29888 29889 29890 29891 29892 29893 29894 29895 29896 29897 29898 29899 29900 29901 29902 29903 29904 29905 29906 29907 29908 29909 29910 29911 29912 29913 29914 29915 29916 29917 29918 29919 29920 29921 29922 29923 29924 29925 29926 29927 29928 29929 29930 29931 29932 29933 29934 29935 29936 29937 29938 29939 29940 29941 29942 29943 29944 29945 29946 29947 29948 29949 29950 29951 29952 29953 29954 29955 29956 29957 29958 29959 29960 29961 29962 29963 29964 29965 29966 29967 29968 29969 29970 29971 29972 29973 29974 29975 29976 29977 29978 29979 29980 29981 29982 29983 29984 29985 29986 29987 29988 29989 29990 29991 29992 29993 29994 29995 29996 29997 29998 29999 30000 30001 30002 30003 30004 30005 30006 30007 30008 30009 30010 30011 30012 30013 30014 30015 30016 30017 30018 30019 30020 30021 30022 30023 30024 30025 30026 30027 30028 30029 30030 30031 30032 30033 30034 30035 30036 30037 30038 30039 30040 30041 30042 30043 30044 30045 30046 30047 30048 30049 30050 30051 30052 30053 30054 30055 30056 30057 30058 30059 30060 30061 30062 30063 30064 30065 30066 30067 30068 30069 30070 30071 30072 30073 30074 30075 30076 30077 30078 30079 30080 30081 30082 30083 30084 30085 30086 30087 30088 30089 30090 30091 30092 30093 30094 30095 30096 30097 30098 30099 30100 30101 30102 30103 30104 30105 30106 30107 30108 30109 30110 30111 30112 30113 30114 30115 30116 30117 30118 30119 30120 30121 30122 30123 30124 30125 30126 30127 30128 30129 30130 30131 30132 30133 30134 30135 30136 30137 30138 30139 30140 30141 30142 30143 30144 30145 30146 30147 30148 30149 30150 30151 30152 30153 30154 30155 30156 30157 30158 30159 30160 30161 30162 30163 30164 30165 30166 30167 30168 30169 30170 30171 30172 30173 30174 30175 30176 30177 30178 30179 30180 30181 30182 30183 30184 30185 30186 30187 30188 30189 30190 30191 30192 30193 30194 30195 30196 30197 30198 30199 30200 30201 30202 30203 30204 30205 30206 30207 30208 30209 30210 30211 30212 30213 30214 30215 30216 30217 30218 30219 30220 30221 30222 30223 30224 30225 30226 30227 30228 30229 30230 30231 30232 30233 30234 30235 30236 30237 30238 30239 30240 30241 30242 30243 30244 30245 30246 30247 30248 30249 30250 30251 30252 30253 30254 30255 30256 30257 30258 30259 30260 30261 30262 30263 30264 30265 30266 30267 30268 30269 30270 30271 30272 30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 30288 30289 30290 30291 30292 30293 30294 30295 30296 30297 30298 30299 30300 30301 30302 30303 30304 30305 30306 30307 30308 30309 30310 30311 30312 30313 30314 30315 30316 30317 30318 30319 30320 30321 30322 30323 30324 30325 30326 30327 30328 30329 30330 30331 30332 30333 30334 30335 30336 30337 30338 30339 30340 30341 30342 30343 30344 30345 30346 30347 30348 30349 30350 30351 30352 30353 30354 30355 30356 30357 30358 30359 30360 30361 30362 30363 30364 30365 30366 30367 30368 30369 30370 30371 30372 30373 30374 30375 30376 30377 30378 30379 30380 30381 30382 30383 30384 30385 30386 30387 30388 30389 30390 30391 30392 30393 30394 30395 30396 30397 30398 30399 30400 30401 30402 30403 30404 30405 30406 30407 30408 30409 30410 30411 30412 30413 30414 30415 30416 30417 30418 30419 30420 30421 30422 30423 30424 30425 30426 30427 30428 30429 30430 30431 30432 30433 30434 30435 30436 30437 30438 30439 30440 30441 30442 30443 30444 30445 30446 30447 30448 30449 30450 30451 30452 30453 30454 30455 30456 30457 30458 30459 30460 30461 30462 30463 30464 30465 30466 30467 30468 30469 30470 30471 30472 30473 30474 30475 30476 30477 30478 30479 30480 30481 30482 30483 30484 30485 30486 30487 30488 30489 30490 30491 30492 30493 30494 30495 30496 30497 30498 30499 30500 30501 30502 30503 30504 30505 30506 30507 30508 30509 30510 30511 30512 30513 30514 30515 30516 30517 30518 30519 30520 30521 30522 30523 30524 30525 30526 30527 30528 30529 30530 30531 30532 30533 30534 30535 30536 30537 30538 30539 30540 30541 30542 30543 30544 30545 30546 30547 30548 30549 30550 30551 30552 30553 30554 30555 30556 30557 30558 30559 30560 30561 30562 30563 30564 30565 30566 30567 30568 30569 30570 30571 30572 30573 30574 30575 30576 30577 30578 30579 30580 30581 30582 30583 30584 30585 30586 30587 30588 30589 30590 30591 30592 30593 30594 30595 30596 30597 30598 30599 30600 30601 30602 30603 30604 30605 30606 30607 30608 30609 30610 30611 30612 30613 30614 30615 30616 30617 30618 30619 30620 30621 30622 30623 30624 30625 30626 30627 30628 30629 30630 30631 30632 30633 30634 30635 30636 30637 30638 30639 30640 30641 30642 30643 30644 30645 30646 30647 30648 30649 30650 30651 30652 30653 30654 30655 30656 30657 30658 30659 30660 30661 30662 30663 30664 30665 30666 30667 30668 30669 30670 30671 30672 30673 30674 30675 30676 30677 30678 30679 30680 30681 30682 30683 30684 30685 30686 30687 30688 30689 30690 30691 30692 30693 30694 30695 30696 30697 30698 30699 30700 30701 30702 30703 30704 30705 30706 30707 30708 30709 30710 30711 30712 30713 30714 30715 30716 30717 30718 30719 30720 30721 30722 30723 30724 30725 30726 30727 30728 30729 30730 30731 30732 30733 30734 30735 30736 30737 30738 30739 30740 30741 30742 30743 30744 30745 30746 30747 30748 30749 30750 30751 30752 30753 30754 30755 30756 30757 30758 30759 30760 30761 30762 30763 30764 30765 30766 30767 30768 30769 30770 30771 30772 30773 30774 30775 30776 30777 30778 30779 30780 30781 30782 30783 30784 30785 30786 30787 30788 30789 30790 30791 30792 30793 30794 30795 30796 30797 30798 30799 30800 30801 30802 30803 30804 30805 30806 30807 30808 30809 30810 30811 30812 30813 30814 30815 30816 30817 30818 30819 30820 30821 30822 30823 30824 30825 30826 30827 30828 30829 30830 30831 30832 30833 30834 30835 30836 30837 30838 30839 30840 30841 30842 30843 30844 30845 30846 30847 30848 30849 30850 30851 30852 30853 30854 30855 30856 30857 30858 30859 30860 30861 30862 30863 30864 30865 30866 30867 30868 30869 30870 30871 30872 30873 30874 30875 30876 30877 30878 30879 30880 30881 30882 30883 30884 30885 30886 30887 30888 30889 30890 30891 30892 30893 30894 30895 30896 30897 30898 30899 30900 30901 30902 30903 30904 30905 30906 30907 30908 30909 30910 30911 30912 30913 30914 30915 30916 30917 30918 30919 30920 30921 30922 30923 30924 30925 30926 30927 30928 30929 30930 30931 30932 30933 30934 30935 30936 30937 30938 30939 30940 30941 30942 30943 30944 30945 30946 30947 30948 30949 30950 30951 30952 30953 30954 30955 30956 30957 30958 30959 30960 30961 30962 30963 30964 30965 30966 30967 30968 30969 30970 30971 30972 30973 30974 30975 30976 30977 30978 30979 30980 30981 30982 30983 30984 30985 30986 30987 30988 30989 30990 30991 30992 30993 30994 30995 30996 30997 30998 30999 31000 31001 31002 31003 31004 31005 31006 31007 31008 31009 31010 31011 31012 31013 31014 31015 31016 31017 31018 31019 31020 31021 31022 31023 31024 31025 31026 31027 31028 31029 31030 31031 31032 31033 31034 31035 31036 31037 31038 31039 31040 31041 31042 31043 31044 31045 31046 31047 31048 31049 31050 31051 31052 31053 31054 31055 31056 31057 31058 31059 31060 31061 31062 31063 31064 31065 31066 31067 31068 31069 31070 31071 31072 31073 31074 31075 31076 31077 31078 31079 31080 31081 31082 31083 31084 31085 31086 31087 31088 31089 31090 31091 31092 31093 31094 31095 31096 31097 31098 31099 31100 31101 31102 31103 31104 31105 31106 31107 31108 31109 31110 31111 31112 31113 31114 31115 31116 31117 31118 31119 31120 31121 31122 31123 31124 31125 31126 31127 31128 31129 31130 31131 31132 31133 31134 31135 31136 31137 31138 31139 31140 31141 31142 31143 31144 31145 31146 31147 31148 31149 31150 31151 31152 31153 31154 31155 31156 31157 31158 31159 31160 31161 31162 31163 31164 31165 31166 31167 31168 31169 31170 31171 31172 31173 31174 31175 31176 31177 31178 31179 31180 31181 31182 31183 31184 31185 31186 31187 31188 31189 31190 31191 31192 31193 31194 31195 31196 31197 31198 31199 31200 31201 31202 31203 31204 31205 31206 31207 31208 31209 31210 31211 31212 31213 31214 31215 31216 31217 31218 31219 31220 31221 31222 31223 31224 31225 31226 31227 31228 31229 31230 31231 31232 31233 31234 31235 31236 31237 31238 31239 31240 31241 31242 31243 31244 31245 31246 31247 31248 31249 31250 31251 31252 31253 31254 31255 31256 31257 31258 31259 31260 31261 31262 31263 31264 31265 31266 31267 31268 31269 31270 31271 31272 31273 31274 31275 31276 31277 31278 31279 31280 31281 31282 31283 31284 31285 31286 31287 31288 31289 31290 31291 31292 31293 31294 31295 31296 31297 31298 31299 31300 31301 31302 31303 31304 31305 31306 31307 31308 31309 31310 31311 31312 31313 31314 31315 31316 31317 31318 31319 31320 31321 31322 31323 31324 31325 31326 31327 31328 31329 31330 31331 31332 31333 31334 31335 31336 31337 31338 31339 31340 31341 31342 31343 31344 31345 31346 31347 31348 31349 31350 31351 31352 31353 31354 31355 31356 31357 31358 31359 31360 31361 31362 31363 31364 31365 31366 31367 31368 31369 31370 31371 31372 31373 31374 31375 31376 31377 31378 31379 31380 31381 31382 31383 31384 31385 31386 31387 31388 31389 31390 31391 31392 31393 31394 31395 31396 31397 31398 31399 31400 31401 31402 31403 31404 31405 31406 31407 31408 31409 31410 31411 31412 31413 31414 31415 31416 31417 31418 31419 31420 31421 31422 31423 31424 31425 31426 31427 31428 31429 31430 31431 31432 31433 31434 31435 31436 31437 31438 31439 31440 31441 31442 31443 31444 31445 31446 31447 31448 31449 31450 31451 31452 31453 31454 31455 31456 31457 31458 31459 31460 31461 31462 31463 31464 31465 31466 31467 31468 31469 31470 31471 31472 31473 31474 31475 31476 31477 31478 31479 31480 31481 31482 31483 31484 31485 31486 31487 31488 31489 31490 31491 31492 31493 31494 31495 31496 31497 31498 31499 31500 31501 31502 31503 31504 31505 31506 31507 31508 31509 31510 31511 31512 31513 31514 31515 31516 31517 31518 31519 31520 31521 31522 31523 31524 31525 31526 31527 31528 31529 31530 31531 31532 31533 31534 31535 31536 31537 31538 31539 31540 31541 31542 31543 31544 31545 31546 31547 31548 31549 31550 31551 31552 31553 31554 31555 31556 31557 31558 31559 31560 31561 31562 31563 31564 31565 31566 31567 31568 31569 31570 31571 31572 31573 31574 31575 31576 31577 31578 31579 31580 31581 31582 31583 31584 31585 31586 31587 31588 31589 31590 31591 31592 31593 31594 31595 31596 31597 31598 31599 31600 31601 31602 31603 31604 31605 31606 31607 31608 31609 31610 31611 31612 31613 31614 31615 31616 31617 31618 31619 31620 31621 31622 31623 31624 31625 31626 31627 31628 31629 31630 31631 31632 31633 31634 31635 31636 31637 31638 31639 31640 31641 31642 31643 31644 31645 31646 31647 31648 31649 31650 31651 31652 31653 31654 31655 31656 31657 31658 31659 31660 31661 31662 31663 31664 31665 31666 31667 31668 31669 31670 31671 31672 31673 31674 31675 31676 31677 31678 31679 31680 31681 31682 31683 31684 31685 31686 31687 31688 31689 31690 31691 31692 31693 31694 31695 31696 31697 31698 31699 31700 31701 31702 31703 31704 31705 31706 31707 31708 31709 31710 31711 31712 31713 31714 31715 31716 31717 31718 31719 31720 31721 31722 31723 31724 31725 31726 31727 31728 31729 31730 31731 31732 31733 31734 31735 31736 31737 31738 31739 31740 31741 31742 31743 31744 31745 31746 31747 31748 31749 31750 31751 31752 31753 31754 31755 31756 31757 31758 31759 31760 31761 31762 31763 31764 31765 31766 31767 31768 31769 31770 31771 31772 31773 31774 31775 31776 31777 31778 31779 31780 31781 31782 31783 31784 31785 31786 31787 31788 31789 31790 31791 31792 31793 31794 31795 31796 31797 31798 31799 31800 31801 31802 31803 31804 31805 31806 31807 31808 31809 31810 31811 31812 31813 31814 31815 31816 31817 31818 31819 31820 31821 31822 31823 31824 31825 31826 31827 31828 31829 31830 31831 31832 31833 31834 31835 31836 31837 31838 31839 31840 31841 31842 31843 31844 31845 31846 31847 31848 31849 31850 31851 31852 31853 31854 31855 31856 31857 31858 31859 31860 31861 31862 31863 31864 31865 31866 31867 31868 31869 31870 31871 31872 31873 31874 31875 31876 31877 31878 31879 31880 31881 31882 31883 31884 31885 31886 31887 31888 31889 31890 31891 31892 31893 31894 31895 31896 31897 31898 31899 31900 31901 31902 31903 31904 31905 31906 31907 31908 31909 31910 31911 31912 31913 31914 31915 31916 31917 31918 31919 31920 31921 31922 31923 31924 31925 31926 31927 31928 31929 31930 31931 31932 31933 31934 31935 31936 31937 31938 31939 31940 31941 31942 31943 31944 31945 31946 31947 31948 31949 31950 31951 31952 31953 31954 31955 31956 31957 31958 31959 31960 31961 31962 31963 31964 31965 31966 31967 31968 31969 31970 31971 31972 31973 31974 31975 31976 31977 31978 31979 31980 31981 31982 31983 31984 31985 31986 31987 31988 31989 31990 31991 31992 31993 31994 31995 31996 31997 31998 31999 32000 32001 32002 32003 32004 32005 32006 32007 32008 32009 32010 32011 32012 32013 32014 32015 32016 32017 32018 32019 32020 32021 32022 32023 32024 32025 32026 32027 32028 32029 32030 32031 32032 32033 32034 32035 32036 32037 32038 32039 32040 32041 32042 32043 32044 32045 32046 32047 32048 32049 32050 32051 32052 32053 32054 32055 32056 32057 32058 32059 32060 32061 32062 32063 32064 32065 32066 32067 32068 32069 32070 32071 32072 32073 32074 32075 32076 32077 32078 32079 32080 32081 32082 32083 32084 32085 32086 32087 32088 32089 32090 32091 32092 32093 32094 32095 32096 32097 32098 32099 32100 32101 32102 32103 32104 32105 32106 32107 32108 32109 32110 32111 32112 32113 32114 32115 32116 32117 32118 32119 32120 32121 32122 32123 32124 32125 32126 32127 32128 32129 32130 32131 32132 32133 32134 32135 32136 32137 32138 32139 32140 32141 32142 32143 32144 32145 32146 32147 32148 32149 32150 32151 32152 32153 32154 32155 32156 32157 32158 32159 32160 32161 32162 32163 32164 32165 32166 32167 32168 32169 32170 32171 32172 32173 32174 32175 32176 32177 32178 32179 32180 32181 32182 32183 32184 32185 32186 32187 32188 32189 32190 32191 32192 32193 32194 32195 32196 32197 32198 32199 32200 32201 32202 32203 32204 32205 32206 32207 32208 32209 32210 32211 32212 32213 32214 32215 32216 32217 32218 32219 32220 32221 32222 32223 32224 32225 32226 32227 32228 32229 32230 32231 32232 32233 32234 32235 32236 32237 32238 32239 32240 32241 32242 32243 32244 32245 32246 32247 32248 32249 32250 32251 32252 32253 32254 32255 32256 32257 32258 32259 32260 32261 32262 32263 32264 32265 32266 32267 32268 32269 32270 32271 32272 32273 32274 32275 32276 32277 32278 32279 32280 32281 32282 32283 32284 32285 32286 32287 32288 32289 32290 32291 32292 32293 32294 32295 32296 32297 32298 32299 32300 32301 32302 32303 32304 32305 32306 32307 32308 32309 32310 32311 32312 32313 32314 32315 32316 32317 32318 32319 32320 32321 32322 32323 32324 32325 32326 32327 32328 32329 32330 32331 32332 32333 32334 32335 32336 32337 32338 32339 32340 32341 32342 32343 32344 32345 32346 32347 32348 32349 32350 32351 32352 32353 32354 32355 32356 32357 32358 32359 32360 32361 32362 32363 32364 32365 32366 32367 32368 32369 32370 32371 32372 32373 32374 32375 32376 32377 32378 32379 32380 32381 32382 32383 32384 32385 32386 32387 32388 32389 32390 32391 32392 32393 32394 32395 32396 32397 32398 32399 32400 32401 32402 32403 32404 32405 32406 32407 32408 32409 32410 32411 32412 32413 32414 32415 32416 32417 32418 32419 32420 32421 32422 32423 32424 32425 32426 32427 32428 32429 32430 32431 32432 32433 32434 32435 32436 32437 32438 32439 32440 32441 32442 32443 32444 32445 32446 32447 32448 32449 32450 32451 32452 32453 32454 32455 32456 32457 32458 32459 32460 32461 32462 32463 32464 32465 32466 32467 32468 32469 32470 32471 32472 32473 32474 32475 32476 32477 32478 32479 32480 32481 32482 32483 32484 32485 32486 32487 32488 32489 32490 32491 32492 32493 32494 32495 32496 32497 32498 32499 32500 32501 32502 32503 32504 32505 32506 32507 32508 32509 32510 32511 32512 32513 32514 32515 32516 32517 32518 32519 32520 32521 32522 32523 32524 32525 32526 32527 32528 32529 32530 32531 32532 32533 32534 32535 32536 32537 32538 32539 32540 32541 32542 32543 32544 32545 32546 32547 32548 32549 32550 32551 32552 32553 32554 32555 32556 32557 32558 32559 32560 32561 32562 32563 32564 32565 32566 32567 32568 32569 32570 32571 32572 32573 32574 32575 32576 32577 32578 32579 32580 32581 32582 32583 32584 32585 32586 32587 32588 32589 32590 32591 32592 32593 32594 32595 32596 32597 32598 32599 32600 32601 32602 32603 32604 32605 32606 32607 32608 32609 32610 32611 32612 32613 32614 32615 32616 32617 32618 32619 32620 32621 32622 32623 32624 32625 32626 32627 32628 32629 32630 32631 32632 32633 32634 32635 32636 32637 32638 32639 32640 32641 32642 32643 32644 32645 32646 32647 32648 32649 32650 32651 32652 32653 32654 32655 32656 32657 32658 32659 32660 32661 32662 32663 32664 32665 32666 32667 32668 32669 32670 32671 32672 32673 32674 32675 32676 32677 32678 32679 32680 32681 32682 32683 32684 32685 32686 32687 32688 32689 32690 32691 32692 32693 32694 32695 32696 32697 32698 32699 32700 32701 32702 32703 32704 32705 32706 32707 32708 32709 32710 32711 32712 32713 32714 32715 32716 32717 32718 32719 32720 32721 32722 32723 32724 32725 32726 32727 32728 32729 32730 32731 32732 32733 32734 32735 32736 32737 32738 32739 32740 32741 32742 32743 32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 32759 32760 32761 32762 32763 32764 32765 32766 32767 32768 32769 32770 32771 32772 32773 32774 32775 32776 32777 32778 32779 32780 32781 32782 32783 32784 32785 32786 32787 32788 32789 32790 32791 32792 32793 32794 32795 32796 32797 32798 32799 32800 32801 32802 32803 32804 32805 32806 32807 32808 32809 32810 32811 32812 32813 32814 32815 32816 32817 32818 32819 32820 32821 32822 32823 32824 32825 32826 32827 32828 32829 32830 32831 32832 32833 32834 32835 32836 32837 32838 32839 32840 32841 32842 32843 32844 32845 32846 32847 32848 32849 32850 32851 32852 32853 32854 32855 32856 32857 32858 32859 32860 32861 32862 32863 32864 32865 32866 32867 32868 32869 32870 32871 32872 32873 32874 32875 32876 32877 32878 32879 32880 32881 32882 32883 32884 32885 32886 32887 32888 32889 32890 32891 32892 32893 32894 32895 32896 32897 32898 32899 32900 32901 32902 32903 32904 32905 32906 32907 32908 32909 32910 32911 32912 32913 32914 32915 32916 32917 32918 32919 32920 32921 32922 32923 32924 32925 32926 32927 32928 32929 32930 32931 32932 32933 32934 32935 32936 32937 32938 32939 32940 32941 32942 32943 32944 32945 32946 32947 32948 32949 32950 32951 32952 32953 32954 32955 32956 32957 32958 32959 32960 32961 32962 32963 32964 32965 32966 32967 32968 32969 32970 32971 32972 32973 32974 32975 32976 32977 32978 32979 32980 32981 32982 32983 32984 32985 32986 32987 32988 32989 32990 32991 32992 32993 32994 32995 32996 32997 32998 32999 33000 33001 33002 33003 33004 33005 33006 33007 33008 33009 33010 33011 33012 33013 33014 33015 33016 33017 33018 33019 33020 33021 33022 33023 33024 33025 33026 33027 33028 33029 33030 33031 33032 33033 33034 33035 33036 33037 33038 33039 33040 33041 33042 33043 33044 33045 33046 33047 33048 33049 33050 33051 33052 33053 33054 33055 33056 33057 33058 33059 33060 33061 33062 33063 33064 33065 33066 33067 33068 33069 33070 33071 33072 33073 33074 33075 33076 33077 33078 33079 33080 33081 33082 33083 33084 33085 33086 33087 33088 33089 33090 33091 33092 33093 33094 33095 33096 33097 33098 33099 33100 33101 33102 33103 33104 33105 33106 33107 33108 33109 33110 33111 33112 33113 33114 33115 33116 33117 33118 33119 33120 33121 33122 33123 33124 33125 33126 33127 33128 33129 33130 33131 33132 33133 33134 33135 33136 33137 33138 33139 33140 33141 33142 33143 33144 33145 33146 33147 33148 33149 33150 33151 33152 33153 33154 33155 33156 33157 33158 33159 33160 33161 33162 33163 33164 33165 33166 33167 33168 33169 33170 33171 33172 33173 33174 33175 33176 33177 33178 33179 33180 33181 33182 33183 33184 33185 33186 33187 33188 33189 33190 33191 33192 33193 33194 33195 33196 33197 33198 33199 33200 33201 33202 33203 33204 33205 33206 33207 33208 33209 33210 33211 33212 33213 33214 33215 33216 33217 33218 33219 33220 33221 33222 33223 33224 33225 33226 33227 33228 33229 33230 33231 33232 33233 33234 33235 33236 33237 33238 33239 33240 33241 33242 33243 33244 33245 33246 33247 33248 33249 33250 33251 33252 33253 33254 33255 33256 33257 33258 33259 33260 33261 33262 33263 33264 33265 33266 33267 33268 33269 33270 33271 33272 33273 33274 33275 33276 33277 33278 33279 33280 33281 33282 33283 33284 33285 33286 33287 33288 33289 33290 33291 33292 33293 33294 33295 33296 33297 33298 33299 33300 33301 33302 33303 33304 33305 33306 33307 33308 33309 33310 33311 33312 33313 33314 33315 33316 33317 33318 33319 33320 33321 33322 33323 33324 33325 33326 33327 33328 33329 33330 33331 33332 33333 33334 33335 33336 33337 33338 33339 33340 33341 33342 33343 33344 33345 33346 33347 33348 33349 33350 33351 33352 33353 33354 33355 33356 33357 33358 33359 33360 33361 33362 33363 33364 33365 33366 33367 33368 33369 33370 33371 33372 33373 33374 33375 33376 33377 33378 33379 33380 33381 33382 33383 33384 33385 33386 33387 33388 33389 33390 33391 33392 33393 33394 33395 33396 33397 33398 33399 33400 33401 33402 33403 33404 33405 33406 33407 33408 33409 33410 33411 33412 33413 33414 33415 33416 33417 33418 33419 33420 33421 33422 33423 33424 33425 33426 33427 33428 33429 33430 33431 33432 33433 33434 33435 33436 33437 33438 33439 33440 33441 33442 33443 33444 33445 33446 33447 33448 33449 33450 33451 33452 33453 33454 33455 33456 33457 33458 33459 33460 33461 33462 33463 33464 33465 33466 33467 33468 33469 33470 33471 33472 33473 33474 33475 33476 33477 33478 33479 33480 33481 33482 33483 33484 33485 33486 33487 33488 33489 33490 33491 33492 33493 33494 33495 33496 33497 33498 33499 33500 33501 33502 33503 33504 33505 33506 33507 33508 33509 33510 33511 33512 33513 33514 33515 33516 33517 33518 33519 33520 33521 33522 33523 33524 33525 33526 33527 33528 33529 33530 33531 33532 33533 33534 33535 33536 33537 33538 33539 33540 33541 33542 33543 33544 33545 33546 33547 33548 33549 33550 33551 33552 33553 33554 33555 33556 33557 33558 33559 33560 33561 33562 33563 33564 33565 33566 33567 33568 33569 33570 33571 33572 33573 33574 33575 33576 33577 33578 33579 33580 33581 33582 33583 33584 33585 33586 33587 33588 33589 33590 33591 33592 33593 33594 33595 33596 33597 33598 33599 33600 33601 33602 33603 33604 33605 33606 33607 33608 33609 33610 33611 33612 33613 33614 33615 33616 33617 33618 33619 33620 33621 33622 33623 33624 33625 33626 33627 33628 33629 33630 33631 33632 33633 33634 33635 33636 33637 33638 33639 33640 33641 33642 33643 33644 33645 33646 33647 33648 33649 33650 33651 33652 33653 33654 33655 33656 33657 33658 33659 33660 33661 33662 33663 33664 33665 33666 33667 33668 33669 33670 33671 33672 33673 33674 33675 33676 33677 33678 33679 33680 33681 33682 33683 33684 33685 33686 33687 33688 33689 33690 33691 33692 33693 33694 33695 33696 33697 33698 33699 33700 33701 33702 33703 33704 33705 33706 33707 33708 33709 33710 33711 33712 33713 33714 33715 33716 33717 33718 33719 33720 33721 33722 33723 33724 33725 33726 33727 33728 33729 33730 33731 33732 33733 33734 33735 33736 33737 33738 33739 33740 33741 33742 33743 33744 33745 33746 33747 33748 33749 33750 33751 33752 33753 33754 33755 33756 33757 33758 33759 33760 33761 33762 33763 33764 33765 33766 33767 33768 33769 33770 33771 33772 33773 33774 33775 33776 33777 33778 33779 33780 33781 33782 33783 33784 33785 33786 33787 33788 33789 33790 33791 33792 33793 33794 33795 33796 33797 33798 33799 33800 33801 33802 33803 33804 33805 33806 33807 33808 33809 33810 33811 33812 33813 33814 33815 33816 33817 33818 33819 33820 33821 33822 33823 33824 33825 33826 33827 33828 33829 33830 33831 33832 33833 33834 33835 33836 33837 33838 33839 33840 33841 33842 33843 33844 33845 33846 33847 33848 33849 33850 33851 33852 33853 33854 33855 33856 33857 33858 33859 33860 33861 33862 33863 33864 33865 33866 33867 33868 33869 33870 33871 33872 33873 33874 33875 33876 33877 33878 33879 33880 33881 33882 33883 33884 33885 33886 33887 33888 33889 33890 33891 33892 33893 33894 33895 33896 33897 33898 33899 33900 33901 33902 33903 33904 33905 33906 33907 33908 33909 33910 33911 33912 33913 33914 33915 33916 33917 33918 33919 33920 33921 33922 33923 33924 33925 33926 33927 33928 33929 33930 33931 33932 33933 33934 33935 33936 33937 33938 33939 33940 33941 33942 33943 33944 33945 33946 33947 33948 33949 33950 33951 33952 33953 33954 33955 33956 33957 33958 33959 33960 33961 33962 33963 33964 33965 33966 33967 33968 33969 33970 33971 33972 33973 33974 33975 33976 33977 33978 33979 33980 33981 33982 33983 33984 33985 33986 33987 33988 33989 33990 33991 33992 33993 33994 33995 33996 33997 33998 33999 34000 34001 34002 34003 34004 34005 34006 34007 34008 34009 34010 34011 34012 34013 34014 34015 34016 34017 34018 34019 34020 34021 34022 34023 34024 34025 34026 34027 34028 34029 34030 34031 34032 34033 34034 34035 34036 34037 34038 34039 34040 34041 34042 34043 34044 34045 34046 34047 34048 34049 34050 34051 34052 34053 34054 34055 34056 34057 34058 34059 34060 34061 34062 34063 34064 34065 34066 34067 34068 34069 34070 34071 34072 34073 34074 34075 34076 34077 34078 34079 34080 34081 34082 34083 34084 34085 34086 34087 34088 34089 34090 34091 34092 34093 34094 34095 34096 34097 34098 34099 34100 34101 34102 34103 34104 34105 34106 34107 34108 34109 34110 34111 34112 34113 34114 34115 34116 34117 34118 34119 34120 34121 34122 34123 34124 34125 34126 34127 34128 34129 34130 34131 34132 34133 34134 34135 34136 34137 34138 34139 34140 34141 34142 34143 34144 34145 34146 34147 34148 34149 34150 34151 34152 34153 34154 34155 34156 34157 34158 34159 34160 34161 34162 34163 34164 34165 34166 34167 34168 34169 34170 34171 34172 34173 34174 34175 34176 34177 34178 34179 34180 34181 34182 34183 34184 34185 34186 34187 34188 34189 34190 34191 34192 34193 34194 34195 34196 34197 34198 34199 34200 34201 34202 34203 34204 34205 34206 34207 34208 34209 34210 34211 34212 34213 34214 34215 34216 34217 34218 34219 34220 34221 34222 34223 34224 34225 34226 34227 34228 34229 34230 34231 34232 34233 34234 34235 34236 34237 34238 34239 34240 34241 34242 34243 34244 34245 34246 34247 34248 34249 34250 34251 34252 34253 34254 34255 34256 34257 34258 34259 34260 34261 34262 34263 34264 34265 34266 34267 34268 34269 34270 34271 34272 34273 34274 34275 34276 34277 34278 34279 34280 34281 34282 34283 34284 34285 34286 34287 34288 34289 34290 34291 34292 34293 34294 34295 34296 34297 34298 34299 34300 34301 34302 34303 34304 34305 34306 34307 34308 34309 34310 34311 34312 34313 34314 34315 34316 34317 34318 34319 34320 34321 34322 34323 34324 34325 34326 34327 34328 34329 34330 34331 34332 34333 34334 34335 34336 34337 34338 34339 34340 34341 34342 34343 34344 34345 34346 34347 34348 34349 34350 34351 34352 34353 34354 34355 34356 34357 34358 34359 34360 34361 34362 34363 34364 34365 34366 34367 34368 34369 34370 34371 34372 34373 34374 34375 34376 34377 34378 34379 34380 34381 34382 34383 34384 34385 34386 34387 34388 34389 34390 34391 34392 34393 34394 34395 34396 34397 34398 34399 34400 34401 34402 34403 34404 34405 34406 34407 34408 34409 34410 34411 34412 34413 34414 34415 34416 34417 34418 34419 34420 34421 34422 34423 34424 34425 34426 34427 34428 34429 34430 34431 34432 34433 34434 34435 34436 34437 34438 34439 34440 34441 34442 34443 34444 34445 34446 34447 34448 34449 34450 34451 34452 34453 34454 34455 34456 34457 34458 34459 34460 34461 34462 34463 34464 34465 34466 34467 34468 34469 34470 34471 34472 34473 34474 34475 34476 34477 34478 34479 34480 34481 34482 34483 34484 34485 34486 34487 34488 34489 34490 34491 34492 34493 34494 34495 34496 34497 34498 34499 34500 34501 34502 34503 34504 34505 34506 34507 34508 34509 34510 34511 34512 34513 34514 34515 34516 34517 34518 34519 34520 34521 34522 34523 34524 34525 34526 34527 34528 34529 34530 34531 34532 34533 34534 34535 34536 34537 34538 34539 34540 34541 34542 34543 34544 34545 34546 34547 34548 34549 34550 34551 34552 34553 34554 34555 34556 34557 34558 34559 34560 34561 34562 34563 34564 34565 34566 34567 34568 34569 34570 34571 34572 34573 34574 34575 34576 34577 34578 34579 34580 34581 34582 34583 34584 34585 34586 34587 34588 34589 34590 34591 34592 34593 34594 34595 34596 34597 34598 34599 34600 34601 34602 34603 34604 34605 34606 34607 34608 34609 34610 34611 34612 34613 34614 34615 34616 34617 34618 34619 34620 34621 34622 34623 34624 34625 34626 34627 34628 34629 34630 34631 34632 34633 34634 34635 34636 34637 34638 34639 34640 34641 34642 34643 34644 34645 34646 34647 34648 34649 34650 34651 34652 34653 34654 34655 34656 34657 34658 34659 34660 34661 34662 34663 34664 34665 34666 34667 34668 34669 34670 34671 34672 34673 34674 34675 34676 34677 34678 34679 34680 34681 34682 34683 34684 34685 34686 34687 34688 34689 34690 34691 34692 34693 34694 34695 34696 34697 34698 34699 34700 34701 34702 34703 34704 34705 34706 34707 34708 34709 34710 34711 34712 34713 34714 34715 34716 34717 34718 34719 34720 34721 34722 34723 34724 34725 34726 34727 34728 34729 34730 34731 34732 34733 34734 34735 34736 34737 34738 34739 34740 34741 34742 34743 34744 34745 34746 34747 34748 34749 34750 34751 34752 34753 34754 34755 34756 34757 34758 34759 34760 34761 34762 34763 34764 34765 34766 34767 34768 34769 34770 34771 34772 34773 34774 34775 34776 34777 34778 34779 34780 34781 34782 34783 34784 34785 34786 34787 34788 34789 34790 34791 34792 34793 34794 34795 34796 34797 34798 34799 34800 34801 34802 34803 34804 34805 34806 34807 34808 34809 34810 34811 34812 34813 34814 34815 34816 34817 34818 34819 34820 34821 34822 34823 34824 34825 34826 34827 34828 34829 34830 34831 34832 34833 34834 34835 34836 34837 34838 34839 34840 34841 34842 34843 34844 34845 34846 34847 34848 34849 34850 34851 34852 34853 34854 34855 34856 34857 34858 34859 34860 34861 34862 34863 34864 34865 34866 34867 34868 34869 34870 34871 34872 34873 34874 34875 34876 34877 34878 34879 34880 34881 34882 34883 34884 34885 34886 34887 34888 34889 34890 34891 34892 34893 34894 34895 34896 34897 34898 34899 34900 34901 34902 34903 34904 34905 34906 34907 34908 34909 34910 34911 34912 34913 34914 34915 34916 34917 34918 34919 34920 34921 34922 34923 34924 34925 34926 34927 34928 34929 34930 34931 34932 34933 34934 34935 34936 34937 34938 34939 34940 34941 34942 34943 34944 34945 34946 34947 34948 34949 34950 34951 34952 34953 34954 34955 34956 34957 34958 34959 34960 34961 34962 34963 34964 34965 34966 34967 34968 34969 34970 34971 34972 34973 34974 34975 34976 34977 34978 34979 34980 34981 34982 34983 34984 34985 34986 34987 34988 34989 34990 34991 34992 34993 34994 34995 34996 34997 34998 34999 35000 35001 35002 35003 35004 35005 35006 35007 35008 35009 35010 35011 35012 35013 35014 35015 35016 35017 35018 35019 35020 35021 35022 35023 35024 35025 35026 35027 35028 35029 35030 35031 35032 35033 35034 35035 35036 35037 35038 35039 35040 35041 35042 35043 35044 35045 35046 35047 35048 35049 35050 35051 35052 35053 35054 35055 35056 35057 35058 35059 35060 35061 35062 35063 35064 35065 35066 35067 35068 35069 35070 35071 35072 35073 35074 35075 35076 35077 35078 35079 35080 35081 35082 35083 35084 35085 35086 35087 35088 35089 35090 35091 35092 35093 35094 35095 35096 35097 35098 35099 35100 35101 35102 35103 35104 35105 35106 35107 35108 35109 35110 35111 35112 35113 35114 35115 35116 35117 35118 35119 35120 35121 35122 35123 35124 35125 35126 35127 35128 35129 35130 35131 35132 35133 35134 35135 35136 35137 35138 35139 35140 35141 35142 35143 35144 35145 35146 35147 35148 35149 35150 35151 35152 35153 35154 35155 35156 35157 35158 35159 35160 35161 35162 35163 35164 35165 35166 35167 35168 35169 35170 35171 35172 35173 35174 35175 35176 35177 35178 35179 35180 35181 35182 35183 35184 35185 35186 35187 35188 35189 35190 35191 35192 35193 35194 35195 35196 35197 35198 35199 35200 35201 35202 35203 35204 35205 35206 35207 35208 35209 35210 35211 35212 35213 35214 35215 35216 35217 35218 35219 35220 35221 35222 35223 35224 35225 35226 35227 35228 35229 35230 35231 35232 35233 35234 35235 35236 35237 35238 35239 35240 35241 35242 35243 35244 35245 35246 35247 35248 35249 35250 35251 35252 35253 35254 35255 35256 35257 35258 35259 35260 35261 35262 35263 35264 35265 35266 35267 35268 35269 35270 35271 35272 35273 35274 35275 35276 35277 35278 35279 35280 35281 35282 35283 35284 35285 35286 35287 35288 35289 35290 35291 35292 35293 35294 35295 35296 35297 35298 35299 35300 35301 35302 35303 35304 35305 35306 35307 35308 35309 35310 35311 35312 35313 35314 35315 35316 35317 35318 35319 35320 35321 35322 35323 35324 35325 35326 35327 35328 35329 35330 35331 35332 35333 35334 35335 35336 35337 35338 35339 35340 35341 35342 35343 35344 35345 35346 35347 35348 35349 35350 35351 35352 35353 35354 35355 35356 35357 35358 35359 35360 35361 35362 35363 35364 35365 35366 35367 35368 35369 35370 35371 35372 35373 35374 35375 35376 35377 35378 35379 35380 35381 35382 35383 35384 35385 35386 35387 35388 35389 35390 35391 35392 35393 35394 35395 35396 35397 35398 35399 35400 35401 35402 35403 35404 35405 35406 35407 35408 35409 35410 35411 35412 35413 35414 35415 35416 35417 35418 35419 35420 35421 35422 35423 35424 35425 35426 35427 35428 35429 35430 35431 35432 35433 35434 35435 35436 35437 35438 35439 35440 35441 35442 35443 35444 35445 35446 35447 35448 35449 35450 35451 35452 35453 35454 35455 35456 35457 35458 35459 35460 35461 35462 35463 35464 35465 35466 35467 35468 35469 35470 35471 35472 35473 35474 35475 35476 35477 35478 35479 35480 35481 35482 35483 35484 35485 35486 35487 35488 35489 35490 35491 35492 35493 35494 35495 35496 35497 35498 35499 35500 35501 35502 35503 35504 35505 35506 35507 35508 35509 35510 35511 35512 35513 35514 35515 35516 35517 35518 35519 35520 35521 35522 35523 35524 35525 35526 35527 35528 35529 35530 35531 35532 35533 35534 35535 35536 35537 35538 35539 35540 35541 35542 35543 35544 35545 35546 35547 35548 35549 35550 35551 35552 35553 35554 35555 35556 35557 35558 35559 35560 35561 35562 35563 35564 35565 35566 35567 35568 35569 35570 35571 35572 35573 35574 35575 35576 35577 35578 35579 35580 35581 35582 35583 35584 35585 35586 35587 35588 35589 35590 35591 35592 35593 35594 35595 35596 35597 35598 35599 35600 35601 35602 35603 35604 35605 35606 35607 35608 35609 35610 35611 35612 35613 35614 35615 35616 35617 35618 35619 35620 35621 35622 35623 35624 35625 35626 35627 35628 35629 35630 35631 35632 35633 35634 35635 35636 35637 35638 35639 35640 35641 35642 35643 35644 35645 35646 35647 35648 35649 35650 35651 35652 35653 35654 35655 35656 35657 35658 35659 35660 35661 35662 35663 35664 35665 35666 35667 35668 35669 35670 35671 35672 35673 35674 35675 35676 35677 35678 35679 35680 35681 35682 35683 35684 35685 35686 35687 35688 35689 35690 35691 35692 35693 35694 35695 35696 35697 35698 35699 35700 35701 35702 35703 35704 35705 35706 35707 35708 35709 35710 35711 35712 35713 35714 35715 35716 35717 35718 35719 35720 35721 35722 35723 35724 35725 35726 35727 35728 35729 35730 35731 35732 35733 35734 35735 35736 35737 35738 35739 35740 35741 35742 35743 35744 35745 35746 35747 35748 35749 35750 35751 35752 35753 35754 35755 35756 35757 35758 35759 35760 35761 35762 35763 35764 35765 35766 35767 35768 35769 35770 35771 35772 35773 35774 35775 35776 35777 35778 35779 35780 35781 35782 35783 35784 35785 35786 35787 35788 35789 35790 35791 35792 35793 35794 35795 35796 35797 35798 35799 35800 35801 35802 35803 35804 35805 35806 35807 35808 35809 35810 35811 35812 35813 35814 35815 35816 35817 35818 35819 35820 35821 35822 35823 35824 35825 35826 35827 35828 35829 35830 35831 35832 35833 35834 35835 35836 35837 35838 35839 35840 35841 35842 35843 35844 35845 35846 35847 35848 35849 35850 35851 35852 35853 35854 35855 35856 35857 35858 35859 35860 35861 35862 35863 35864 35865 35866 35867 35868 35869 35870 35871 35872 35873 35874 35875 35876 35877 35878 35879 35880 35881 35882 35883 35884 35885 35886 35887 35888 35889 35890 35891 35892 35893 35894 35895 35896 35897 35898 35899 35900 35901 35902 35903 35904 35905 35906 35907 35908 35909 35910 35911 35912 35913 35914 35915 35916 35917 35918 35919 35920 35921 35922 35923 35924 35925 35926 35927 35928 35929 35930 35931 35932 35933 35934 35935 35936 35937 35938 35939 35940 35941 35942 35943 35944 35945 35946 35947 35948 35949 35950 35951 35952 35953 35954 35955 35956 35957 35958 35959 35960 35961 35962 35963 35964 35965 35966 35967 35968 35969 35970 35971 35972 35973 35974 35975 35976 35977 35978 35979 35980 35981 35982 35983 35984 35985 35986 35987 35988 35989 35990 35991 35992 35993 35994 35995 35996 35997 35998 35999 36000 36001 36002 36003 36004 36005 36006 36007 36008 36009 36010 36011 36012 36013 36014 36015 36016 36017 36018 36019 36020 36021 36022 36023 36024 36025 36026 36027 36028 36029 36030 36031 36032 36033 36034 36035 36036 36037 36038 36039 36040 36041 36042 36043 36044 36045 36046 36047 36048 36049 36050 36051 36052 36053 36054 36055 36056 36057 36058 36059 36060 36061 36062 36063 36064 36065 36066 36067 36068 36069 36070 36071 36072 36073 36074 36075 36076 36077 36078 36079 36080 36081 36082 36083 36084 36085 36086 36087 36088 36089 36090 36091 36092 36093 36094 36095 36096 36097 36098 36099 36100 36101 36102 36103 36104 36105 36106 36107 36108 36109 36110 36111 36112 36113 36114 36115 36116 36117 36118 36119 36120 36121 36122 36123 36124 36125 36126 36127 36128 36129 36130 36131 36132 36133 36134 36135 36136 36137 36138 36139 36140 36141 36142 36143 36144 36145 36146 36147 36148 36149 36150 36151 36152 36153 36154 36155 36156 36157 36158 36159 36160 36161 36162 36163 36164 36165 36166 36167 36168 36169 36170 36171 36172 36173 36174 36175 36176 36177 36178 36179 36180 36181 36182 36183 36184 36185 36186 36187 36188 36189 36190 36191 36192 36193 36194 36195 36196 36197 36198 36199 36200 36201 36202 36203 36204 36205 36206 36207 36208 36209 36210 36211 36212 36213 36214 36215 36216 36217 36218 36219 36220 36221 36222 36223 36224 36225 36226 36227 36228 36229 36230 36231 36232 36233 36234 36235 36236 36237 36238 36239 36240 36241 36242 36243 36244 36245 36246 36247 36248 36249 36250 36251 36252 36253 36254 36255 36256 36257 36258 36259 36260 36261 36262 36263 36264 36265 36266 36267 36268 36269 36270 36271 36272 36273 36274 36275 36276 36277 36278 36279 36280 36281 36282 36283 36284 36285 36286 36287 36288 36289 36290 36291 36292 36293 36294 36295 36296 36297 36298 36299 36300 36301 36302 36303 36304 36305 36306 36307 36308 36309 36310 36311 36312 36313 36314 36315 36316 36317 36318 36319 36320 36321 36322 36323 36324 36325 36326 36327 36328 36329 36330 36331 36332 36333 36334 36335 36336 36337 36338 36339 36340 36341 36342 36343 36344 36345 36346 36347 36348 36349 36350 36351 36352 36353 36354 36355 36356 36357 36358 36359 36360 36361 36362 36363 36364 36365 36366 36367 36368 36369 36370 36371 36372 36373 36374 36375 36376 36377 36378 36379 36380 36381 36382 36383 36384 36385 36386 36387 36388 36389 36390 36391 36392 36393 36394 36395 36396 36397 36398 36399 36400 36401 36402 36403 36404 36405 36406 36407 36408 36409 36410 36411 36412 36413 36414 36415 36416 36417 36418 36419 36420 36421 36422 36423 36424 36425 36426 36427 36428 36429 36430 36431 36432 36433 36434 36435 36436 36437 36438 36439 36440 36441 36442 36443 36444 36445 36446 36447 36448 36449 36450 36451 36452 36453 36454 36455 36456 36457 36458 36459 36460 36461 36462 36463 36464 36465 36466 36467 36468 36469 36470 36471 36472 36473 36474 36475 36476 36477 36478 36479 36480 36481 36482 36483 36484 36485 36486 36487 36488 36489 36490 36491 36492 36493 36494 36495 36496 36497 36498 36499 36500 36501 36502 36503 36504 36505 36506 36507 36508 36509 36510 36511 36512 36513 36514 36515 36516 36517 36518 36519 36520 36521 36522 36523 36524 36525 36526 36527 36528 36529 36530 36531 36532 36533 36534 36535 36536 36537 36538 36539 36540 36541 36542 36543 36544 36545 36546 36547 36548 36549 36550 36551 36552 36553 36554 36555 36556 36557 36558 36559 36560 36561 36562 36563 36564 36565 36566 36567 36568 36569 36570 36571 36572 36573 36574 36575 36576 36577 36578 36579 36580 36581 36582 36583 36584 36585 36586 36587 36588 36589 36590 36591 36592 36593 36594 36595 36596 36597 36598 36599 36600 36601 36602 36603 36604 36605 36606 36607 36608 36609 36610 36611 36612 36613 36614 36615 36616 36617 36618 36619 36620 36621 36622 36623 36624 36625 36626 36627 36628 36629 36630 36631 36632 36633 36634 36635 36636 36637 36638 36639 36640 36641 36642 36643 36644 36645 36646 36647 36648 36649 36650 36651 36652 36653 36654 36655 36656 36657 36658 36659 36660 36661 36662 36663 36664 36665 36666 36667 36668 36669 36670 36671 36672 36673 36674 36675 36676 36677 36678 36679 36680 36681 36682 36683 36684 36685 36686 36687 36688 36689 36690 36691 36692 36693 36694 36695 36696 36697 36698 36699 36700 36701 36702 36703 36704 36705 36706 36707 36708 36709 36710 36711 36712 36713 36714 36715 36716 36717 36718 36719 36720 36721 36722 36723 36724 36725 36726 36727 36728 36729 36730 36731 36732 36733 36734 36735 36736 36737 36738 36739 36740 36741 36742 36743 36744 36745 36746 36747 36748 36749 36750 36751 36752 36753 36754 36755 36756 36757 36758 36759 36760 36761 36762 36763 36764 36765 36766 36767 36768 36769 36770 36771 36772 36773 36774 36775 36776 36777 36778 36779 36780 36781 36782 36783 36784 36785 36786 36787 36788 36789 36790 36791 36792 36793 36794 36795 36796 36797 36798 36799 36800 36801 36802 36803 36804 36805 36806 36807 36808 36809 36810 36811 36812 36813 36814 36815 36816 36817 36818 36819 36820 36821 36822 36823 36824 36825 36826 36827 36828 36829 36830 36831 36832 36833 36834 36835 36836 36837 36838 36839 36840 36841 36842 36843 36844 36845 36846 36847 36848 36849 36850 36851 36852 36853 36854 36855 36856 36857 36858 36859 36860 36861 36862 36863 36864 36865 36866 36867 36868 36869 36870 36871 36872 36873 36874 36875 36876 36877 36878 36879 36880 36881 36882 36883 36884 36885 36886 36887 36888 36889 36890 36891 36892 36893 36894 36895 36896 36897 36898 36899 36900 36901 36902 36903 36904 36905 36906 36907 36908 36909 36910 36911 36912 36913 36914 36915 36916 36917 36918 36919 36920 36921 36922 36923 36924 36925 36926 36927 36928 36929 36930 36931 36932 36933 36934 36935 36936 36937 36938 36939 36940 36941 36942 36943 36944 36945 36946 36947 36948 36949 36950 36951 36952 36953 36954 36955 36956 36957 36958 36959 36960 36961 36962 36963 36964 36965 36966 36967 36968 36969 36970 36971 36972 36973 36974 36975 36976 36977 36978 36979 36980 36981 36982 36983 36984 36985 36986 36987 36988 36989 36990 36991 36992 36993 36994 36995 36996 36997 36998 36999 37000 37001 37002 37003 37004 37005 37006 37007 37008 37009 37010 37011 37012 37013 37014 37015 37016 37017 37018 37019 37020 37021 37022 37023 37024 37025 37026 37027 37028 37029 37030 37031 37032 37033 37034 37035 37036 37037 37038 37039 37040 37041 37042 37043 37044 37045 37046 37047 37048 37049 37050 37051 37052 37053 37054 37055 37056 37057 37058 37059 37060 37061 37062 37063 37064 37065 37066 37067 37068 37069 37070 37071 37072 37073 37074 37075 37076 37077 37078 37079 37080 37081 37082 37083 37084 37085 37086 37087 37088 37089 37090 37091 37092 37093 37094 37095 37096 37097 37098 37099 37100 37101 37102 37103 37104 37105 37106 37107 37108 37109 37110 37111 37112 37113 37114 37115 37116 37117 37118 37119 37120 37121 37122 37123 37124 37125 37126 37127 37128 37129 37130 37131 37132 37133 37134 37135 37136 37137 37138 37139 37140 37141 37142 37143 37144 37145 37146 37147 37148 37149 37150 37151 37152 37153 37154 37155 37156 37157 37158 37159 37160 37161 37162 37163 37164 37165 37166 37167 37168 37169 37170 37171 37172 37173 37174 37175 37176 37177 37178 37179 37180 37181 37182 37183 37184 37185 37186 37187 37188 37189 37190 37191 37192 37193 37194 37195 37196 37197 37198 37199 37200 37201 37202 37203 37204 37205 37206 37207 37208 37209 37210 37211 37212 37213 37214 37215 37216 37217 37218 37219 37220 37221 37222 37223 37224 37225 37226 37227 37228 37229 37230 37231 37232 37233 37234 37235 37236 37237 37238 37239 37240 37241 37242 37243 37244 37245 37246 37247 37248 37249 37250 37251 37252 37253 37254 37255 37256 37257 37258 37259 37260 37261 37262 37263 37264 37265 37266 37267 37268 37269 37270 37271 37272 37273 37274 37275 37276 37277 37278 37279 37280 37281 37282 37283 37284 37285 37286 37287 37288 37289 37290 37291 37292 37293 37294 37295 37296 37297 37298 37299 37300 37301 37302 37303 37304 37305 37306 37307 37308 37309 37310 37311 37312 37313 37314 37315 37316 37317 37318 37319 37320 37321 37322 37323 37324 37325 37326 37327 37328 37329 37330 37331 37332 37333 37334 37335 37336 37337 37338 37339 37340 37341 37342 37343 37344 37345 37346 37347 37348 37349 37350 37351 37352 37353 37354 37355 37356 37357 37358 37359 37360 37361 37362 37363 37364 37365 37366 37367 37368 37369 37370 37371 37372 37373 37374 37375 37376 37377 37378 37379 37380 37381 37382 37383 37384 37385 37386 37387 37388 37389 37390 37391 37392 37393 37394 37395 37396 37397 37398 37399 37400 37401 37402 37403 37404 37405 37406 37407 37408 37409 37410 37411 37412 37413 37414 37415 37416 37417 37418 37419 37420 37421 37422 37423 37424 37425 37426 37427 37428 37429 37430 37431 37432 37433 37434 37435 37436 37437 37438 37439 37440 37441 37442 37443 37444 37445 37446 37447 37448 37449 37450 37451 37452 37453 37454 37455 37456 37457 37458 37459 37460 37461 37462 37463 37464 37465 37466 37467 37468 37469 37470 37471 37472 37473 37474 37475 37476 37477 37478 37479 37480 37481 37482 37483 37484 37485 37486 37487 37488 37489 37490 37491 37492 37493 37494 37495 37496 37497 37498 37499 37500 37501 37502 37503 37504 37505 37506 37507 37508 37509 37510 37511 37512 37513 37514 37515 37516 37517 37518 37519 37520 37521 37522 37523 37524 37525 37526 37527 37528 37529 37530 37531 37532 37533 37534 37535 37536 37537 37538 37539 37540 37541 37542 37543 37544 37545 37546 37547 37548 37549 37550 37551 37552 37553 37554 37555 37556 37557 37558 37559 37560 37561 37562 37563 37564 37565 37566 37567 37568 37569 37570 37571 37572 37573 37574 37575 37576 37577 37578 37579 37580 37581 37582 37583 37584 37585 37586 37587 37588 37589 37590 37591 37592 37593 37594 37595 37596 37597 37598 37599 37600 37601 37602 37603 37604 37605 37606 37607 37608 37609 37610 37611 37612 37613 37614 37615 37616 37617 37618 37619 37620 37621 37622 37623 37624 37625 37626 37627 37628 37629 37630 37631 37632 37633 37634 37635 37636 37637 37638 37639 37640 37641 37642 37643 37644 37645 37646 37647 37648 37649 37650 37651 37652 37653 37654 37655 37656 37657 37658 37659 37660 37661 37662 37663 37664 37665 37666 37667 37668 37669 37670 37671 37672 37673 37674 37675 37676 37677 37678 37679 37680 37681 37682 37683 37684 37685 37686 37687 37688 37689 37690 37691 37692 37693 37694 37695 37696 37697 37698 37699 37700 37701 37702 37703 37704 37705 37706 37707 37708 37709 37710 37711 37712 37713 37714 37715 37716 37717 37718 37719 37720 37721 37722 37723 37724 37725 37726 37727 37728 37729 37730 37731 37732 37733 37734 37735 37736 37737 37738 37739 37740 37741 37742 37743 37744 37745 37746 37747 37748 37749 37750 37751 37752 37753 37754 37755 37756 37757 37758 37759 37760 37761 37762 37763 37764 37765 37766 37767 37768 37769 37770 37771 37772 37773 37774 37775 37776 37777 37778 37779 37780 37781 37782 37783 37784 37785 37786 37787 37788 37789 37790 37791 37792 37793 37794 37795 37796 37797 37798 37799 37800 37801 37802 37803 37804 37805 37806 37807 37808 37809 37810 37811 37812 37813 37814 37815 37816 37817 37818 37819 37820 37821 37822 37823 37824 37825 37826 37827 37828 37829 37830 37831 37832 37833 37834 37835 37836 37837 37838 37839 37840 37841 37842 37843 37844 37845 37846 37847 37848 37849 37850 37851 37852 37853 37854 37855 37856 37857 37858 37859 37860 37861 37862 37863 37864 37865 37866 37867 37868 37869 37870 37871 37872 37873 37874 37875 37876 37877 37878 37879 37880 37881 37882 37883 37884 37885 37886 37887 37888 37889 37890 37891 37892 37893 37894 37895 37896 37897 37898 37899 37900 37901 37902 37903 37904 37905 37906 37907 37908 37909 37910 37911 37912 37913 37914 37915 37916 37917 37918 37919 37920 37921 37922 37923 37924 37925 37926 37927 37928 37929 37930 37931 37932 37933 37934 37935 37936 37937 37938 37939 37940 37941 37942 37943 37944 37945 37946 37947 37948 37949 37950 37951 37952 37953 37954 37955 37956 37957 37958 37959 37960 37961 37962 37963 37964 37965 37966 37967 37968 37969 37970 37971 37972 37973 37974 37975 37976 37977 37978 37979 37980 37981 37982 37983 37984 37985 37986 37987 37988 37989 37990 37991 37992 37993 37994 37995 37996 37997 37998 37999 38000 38001 38002 38003 38004 38005 38006 38007 38008 38009 38010 38011 38012 38013 38014 38015 38016 38017 38018 38019 38020 38021 38022 38023 38024 38025 38026 38027 38028 38029 38030 38031 38032 38033 38034 38035 38036 38037 38038 38039 38040 38041 38042 38043 38044 38045 38046 38047 38048 38049 38050 38051 38052 38053 38054 38055 38056 38057 38058 38059 38060 38061 38062 38063 38064 38065 38066 38067 38068 38069 38070 38071 38072 38073 38074 38075 38076 38077 38078 38079 38080 38081 38082 38083 38084 38085 38086 38087 38088 38089 38090 38091 38092 38093 38094 38095 38096 38097 38098 38099 38100 38101 38102 38103 38104 38105 38106 38107 38108 38109 38110 38111 38112 38113 38114 38115 38116 38117 38118 38119 38120 38121 38122 38123 38124 38125 38126 38127 38128 38129 38130 38131 38132 38133 38134 38135 38136 38137 38138 38139 38140 38141 38142 38143 38144 38145 38146 38147 38148 38149 38150 38151 38152 38153 38154 38155 38156 38157 38158 38159 38160 38161 38162 38163 38164 38165 38166 38167 38168 38169 38170 38171 38172 38173 38174 38175 38176 38177 38178 38179 38180 38181 38182 38183 38184 38185 38186 38187 38188 38189 38190 38191 38192 38193 38194 38195 38196 38197 38198 38199 38200 38201 38202 38203 38204 38205 38206 38207 38208 38209 38210 38211 38212 38213 38214 38215 38216 38217 38218 38219 38220 38221 38222 38223 38224 38225 38226 38227 38228 38229 38230 38231 38232 38233 38234 38235 38236 38237 38238 38239 38240 38241 38242 38243 38244 38245 38246 38247 38248 38249 38250 38251 38252 38253 38254 38255 38256 38257 38258 38259 38260 38261 38262 38263 38264 38265 38266 38267 38268 38269 38270 38271 38272 38273 38274 38275 38276 38277 38278 38279 38280 38281 38282 38283 38284 38285 38286 38287 38288 38289 38290 38291 38292 38293 38294 38295 38296 38297 38298 38299 38300 38301 38302 38303 38304 38305 38306 38307 38308 38309 38310 38311 38312 38313 38314 38315 38316 38317 38318 38319 38320 38321 38322 38323 38324 38325 38326 38327 38328 38329 38330 38331 38332 38333 38334 38335 38336 38337 38338 38339 38340 38341 38342 38343 38344 38345 38346 38347 38348 38349 38350 38351 38352 38353 38354 38355 38356 38357 38358 38359 38360 38361 38362 38363 38364 38365 38366 38367 38368 38369 38370 38371 38372 38373 38374 38375 38376 38377 38378 38379 38380 38381 38382 38383 38384 38385 38386 38387 38388 38389 38390 38391 38392 38393 38394 38395 38396 38397 38398 38399 38400 38401 38402 38403 38404 38405 38406 38407 38408 38409 38410 38411 38412 38413 38414 38415 38416 38417 38418 38419 38420 38421 38422 38423 38424 38425 38426 38427 38428 38429 38430 38431 38432 38433 38434 38435 38436 38437 38438 38439 38440 38441 38442 38443 38444 38445 38446 38447 38448 38449 38450 38451 38452 38453 38454 38455 38456 38457 38458 38459 38460 38461 38462 38463 38464 38465 38466 38467 38468 38469 38470 38471 38472 38473 38474 38475 38476 38477 38478 38479 38480 38481 38482 38483 38484 38485 38486 38487 38488 38489 38490 38491 38492 38493 38494 38495 38496 38497 38498 38499 38500 38501 38502 38503 38504 38505 38506 38507 38508 38509 38510 38511 38512 38513 38514 38515 38516 38517 38518 38519 38520 38521 38522 38523 38524 38525 38526 38527 38528 38529 38530 38531 38532 38533 38534 38535 38536 38537 38538 38539 38540 38541 38542 38543 38544 38545 38546 38547 38548 38549 38550 38551 38552 38553 38554 38555 38556 38557 38558 38559 38560 38561 38562 38563 38564 38565 38566 38567 38568 38569 38570 38571 38572 38573 38574 38575 38576 38577 38578 38579 38580 38581 38582 38583 38584 38585 38586 38587 38588 38589 38590 38591 38592 38593 38594 38595 38596 38597 38598 38599 38600 38601 38602 38603 38604 38605 38606 38607 38608 38609 38610 38611 38612 38613 38614 38615 38616 38617 38618 38619 38620 38621 38622 38623 38624 38625 38626 38627 38628 38629 38630 38631 38632 38633 38634 38635 38636 38637 38638 38639 38640 38641 38642 38643 38644 38645 38646 38647 38648 38649 38650 38651 38652 38653 38654 38655 38656 38657 38658 38659 38660 38661 38662 38663 38664 38665 38666 38667 38668 38669 38670 38671 38672 38673 38674 38675 38676 38677 38678 38679 38680 38681 38682 38683 38684 38685 38686 38687 38688 38689 38690 38691 38692 38693 38694 38695 38696 38697 38698 38699 38700 38701 38702 38703 38704 38705 38706 38707 38708 38709 38710 38711 38712 38713 38714 38715 38716 38717 38718 38719 38720 38721 38722 38723 38724 38725 38726 38727 38728 38729 38730 38731 38732 38733 38734 38735 38736 38737 38738 38739 38740 38741 38742 38743 38744 38745 38746 38747 38748 38749 38750 38751 38752 38753 38754 38755 38756 38757 38758 38759 38760 38761 38762 38763 38764 38765 38766 38767 38768 38769 38770 38771 38772 38773 38774 38775 38776 38777 38778 38779 38780 38781 38782 38783 38784 38785 38786 38787 38788 38789 38790 38791 38792 38793 38794 38795 38796 38797 38798 38799 38800 38801 38802 38803 38804 38805 38806 38807 38808 38809 38810 38811 38812 38813 38814 38815 38816 38817 38818 38819 38820 38821 38822 38823 38824 38825 38826 38827 38828 38829 38830 38831 38832 38833 38834 38835 38836 38837 38838 38839 38840 38841 38842 38843 38844 38845 38846 38847 38848 38849 38850 38851 38852 38853 38854 38855 38856 38857 38858 38859 38860 38861 38862 38863 38864 38865 38866 38867 38868 38869 38870 38871 38872 38873 38874 38875 38876 38877 38878 38879 38880 38881 38882 38883 38884 38885 38886 38887 38888 38889 38890 38891 38892 38893 38894 38895 38896 38897 38898 38899 38900 38901 38902 38903 38904 38905 38906 38907 38908 38909 38910 38911 38912 38913 38914 38915 38916 38917 38918 38919 38920 38921 38922 38923 38924 38925 38926 38927 38928 38929 38930 38931 38932 38933 38934 38935 38936 38937 38938 38939 38940 38941 38942 38943 38944 38945 38946 38947 38948 38949 38950 38951 38952 38953 38954 38955 38956 38957 38958 38959 38960 38961 38962 38963 38964 38965 38966 38967 38968 38969 38970 38971 38972 38973 38974 38975 38976 38977 38978 38979 38980 38981 38982 38983 38984 38985 38986 38987 38988 38989 38990 38991 38992 38993 38994 38995 38996 38997 38998 38999 39000 39001 39002 39003 39004 39005 39006 39007 39008 39009 39010 39011 39012 39013 39014 39015 39016 39017 39018 39019 39020 39021 39022 39023 39024 39025 39026 39027 39028 39029 39030 39031 39032 39033 39034 39035 39036 39037 39038 39039 39040 39041 39042 39043 39044 39045 39046 39047 39048 39049 39050 39051 39052 39053 39054 39055 39056 39057 39058 39059 39060 39061 39062 39063 39064 39065 39066 39067 39068 39069 39070 39071 39072 39073 39074 39075 39076 39077 39078 39079 39080 39081 39082 39083 39084 39085 39086 39087 39088 39089 39090 39091 39092 39093 39094 39095 39096 39097 39098 39099 39100 39101 39102 39103 39104 39105 39106 39107 39108 39109 39110 39111 39112 39113 39114 39115 39116 39117 39118 39119 39120 39121 39122 39123 39124 39125 39126 39127 39128 39129 39130 39131 39132 39133 39134 39135 39136 39137 39138 39139 39140 39141 39142 39143 39144 39145 39146 39147 39148 39149 39150 39151 39152 39153 39154 39155 39156 39157 39158 39159 39160 39161 39162 39163 39164 39165 39166 39167 39168 39169 39170 39171 39172 39173 39174 39175 39176 39177 39178 39179 39180 39181 39182 39183 39184 39185 39186 39187 39188 39189 39190 39191 39192 39193 39194 39195 39196 39197 39198 39199 39200 39201 39202 39203 39204 39205 39206 39207 39208 39209 39210 39211 39212 39213 39214 39215 39216 39217 39218 39219 39220 39221 39222 39223 39224 39225 39226 39227 39228 39229 39230 39231 39232 39233 39234 39235 39236 39237 39238 39239 39240 39241 39242 39243 39244 39245 39246 39247 39248 39249 39250 39251 39252 39253 39254 39255 39256 39257 39258 39259 39260 39261 39262 39263 39264 39265 39266 39267 39268 39269 39270 39271 39272 39273 39274 39275 39276 39277 39278 39279 39280 39281 39282 39283 39284 39285 39286 39287 39288 39289 39290 39291 39292 39293 39294 39295 39296 39297 39298 39299 39300 39301 39302 39303 39304 39305 39306 39307 39308 39309 39310 39311 39312 39313 39314 39315 39316 39317 39318 39319 39320 39321 39322 39323 39324 39325 39326 39327 39328 39329 39330 39331 39332 39333 39334 39335 39336 39337 39338 39339 39340 39341 39342 39343 39344 39345 39346 39347 39348 39349 39350 39351 39352 39353 39354 39355 39356 39357 39358 39359 39360 39361 39362 39363 39364 39365 39366 39367 39368 39369 39370 39371 39372 39373 39374 39375 39376 39377 39378 39379 39380 39381 39382 39383 39384 39385 39386 39387 39388 39389 39390 39391 39392 39393 39394 39395 39396 39397 39398 39399 39400 39401 39402 39403 39404 39405 39406 39407 39408 39409 39410 39411 39412 39413 39414 39415 39416 39417 39418 39419 39420 39421 39422 39423 39424 39425 39426 39427 39428 39429 39430 39431 39432 39433 39434 39435 39436 39437 39438 39439 39440 39441 39442 39443 39444 39445 39446 39447 39448 39449 39450 39451 39452 39453 39454 39455 39456 39457 39458 39459 39460 39461 39462 39463 39464 39465 39466 39467 39468 39469 39470 39471 39472 39473 39474 39475 39476 39477 39478 39479 39480 39481 39482 39483 39484 39485 39486 39487 39488 39489 39490 39491 39492 39493 39494 39495 39496 39497 39498 39499 39500 39501 39502 39503 39504 39505 39506 39507 39508 39509 39510 39511 39512 39513 39514 39515 39516 39517 39518 39519 39520 39521 39522 39523 39524 39525 39526 39527 39528 39529 39530 39531 39532 39533 39534 39535 39536 39537 39538 39539 39540 39541 39542 39543 39544 39545 39546 39547 39548 39549 39550 39551 39552 39553 39554 39555 39556 39557 39558 39559 39560 39561 39562 39563 39564 39565 39566 39567 39568 39569 39570 39571 39572 39573 39574 39575 39576 39577 39578 39579 39580 39581 39582 39583 39584 39585 39586 39587 39588 39589 39590 39591 39592 39593 39594 39595 39596 39597 39598 39599 39600 39601 39602 39603 39604 39605 39606 39607 39608 39609 39610 39611 39612 39613 39614 39615 39616 39617 39618 39619 39620 39621 39622 39623 39624 39625 39626 39627 39628 39629 39630 39631 39632 39633 39634 39635 39636 39637 39638 39639 39640 39641 39642 39643 39644 39645 39646 39647 39648 39649 39650 39651 39652 39653 39654 39655 39656 39657 39658 39659 39660 39661 39662 39663 39664 39665 39666 39667 39668 39669 39670 39671 39672 39673 39674 39675 39676 39677 39678 39679 39680 39681 39682 39683 39684 39685 39686 39687 39688 39689 39690 39691 39692 39693 39694 39695 39696 39697 39698 39699 39700 39701 39702 39703 39704 39705 39706 39707 39708 39709 39710 39711 39712 39713 39714 39715 39716 39717 39718 39719 39720 39721 39722 39723 39724 39725 39726 39727 39728 39729 39730 39731 39732 39733 39734 39735 39736 39737 39738 39739 39740 39741 39742 39743 39744 39745 39746 39747 39748 39749 39750 39751 39752 39753 39754 39755 39756 39757 39758 39759 39760 39761 39762 39763 39764 39765 39766 39767 39768 39769 39770 39771 39772 39773 39774 39775 39776 39777 39778 39779 39780 39781 39782 39783 39784 39785 39786 39787 39788 39789 39790 39791 39792 39793 39794 39795 39796 39797 39798 39799 39800 39801 39802 39803 39804 39805 39806 39807 39808 39809 39810 39811 39812 39813 39814 39815 39816 39817 39818 39819 39820 39821 39822 39823 39824 39825 39826 39827 39828 39829 39830 39831 39832 39833 39834 39835 39836 39837 39838 39839 39840 39841 39842 39843 39844 39845 39846 39847 39848 39849 39850 39851 39852 39853 39854 39855 39856 39857 39858 39859 39860 39861 39862 39863 39864 39865 39866 39867 39868 39869 39870 39871 39872 39873 39874 39875 39876 39877 39878 39879 39880 39881 39882 39883 39884 39885 39886 39887 39888 39889 39890 39891 39892 39893 39894 39895 39896 39897 39898 39899 39900 39901 39902 39903 39904 39905 39906 39907 39908 39909 39910 39911 39912 39913 39914 39915 39916 39917 39918 39919 39920 39921 39922 39923 39924 39925 39926 39927 39928 39929 39930 39931 39932 39933 39934 39935 39936 39937 39938 39939 39940 39941 39942 39943 39944 39945 39946 39947 39948 39949 39950 39951 39952 39953 39954 39955 39956 39957 39958 39959 39960 39961 39962 39963 39964 39965 39966 39967 39968 39969 39970 39971 39972 39973 39974 39975 39976 39977 39978 39979 39980 39981 39982 39983 39984 39985 39986 39987 39988 39989 39990 39991 39992 39993 39994 39995 39996 39997 39998 39999 40000 40001 40002 40003 40004 40005 40006 40007 40008 40009 40010 40011 40012 40013 40014 40015 40016 40017 40018 40019 40020 40021 40022 40023 40024 40025 40026 40027 40028 40029 40030 40031 40032 40033 40034 40035 40036 40037 40038 40039 40040 40041 40042 40043 40044 40045 40046 40047 40048 40049 40050 40051 40052 40053 40054 40055 40056 40057 40058 40059 40060 40061 40062 40063 40064 40065 40066 40067 40068 40069 40070 40071 40072 40073 40074 40075 40076 40077 40078 40079 40080 40081 40082 40083 40084 40085 40086 40087 40088 40089 40090 40091 40092 40093 40094 40095 40096 40097 40098 40099 40100 40101 40102 40103 40104 40105 40106 40107 40108 40109 40110 40111 40112 40113 40114 40115 40116 40117 40118 40119 40120 40121 40122 40123 40124 40125 40126 40127 40128 40129 40130 40131 40132 40133 40134 40135 40136 40137 40138 40139 40140 40141 40142 40143 40144 40145 40146 40147 40148 40149 40150 40151 40152 40153 40154 40155 40156 40157 40158 40159 40160 40161 40162 40163 40164 40165 40166 40167 40168 40169 40170 40171 40172 40173 40174 40175 40176 40177 40178 40179 40180 40181 40182 40183 40184 40185 40186 40187 40188 40189 40190 40191 40192 40193 40194 40195 40196 40197 40198 40199 40200 40201 40202 40203 40204 40205 40206 40207 40208 40209 40210 40211 40212 40213 40214 40215 40216 40217 40218 40219 40220 40221 40222 40223 40224 40225 40226 40227 40228 40229 40230 40231 40232 40233 40234 40235 40236 40237 40238 40239 40240 40241 40242 40243 40244 40245 40246
|
% Copyright 1996-2023 Han Th\^e\llap{\raise 0.5ex\hbox{\'{}}} Th\`anh,
% <thanh@@pdftex.org>
% This file is part of pdfTeX.
% pdfTeX 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 of the License, or (at your option) any later
% version.
% pdfTeX 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
% this program. If not, see <http://www.gnu.org/licenses/>.
% e-TeX is copyright (C) 1999-2015 by P. Breitenlohner (1994,98 by the NTS
% team); all rights are reserved. Copying of this file is authorized only if
% (1) you are P. Breitenlohner, or if (2) you make absolutely no changes to
% your copy. (Programs such as TIE allow the application of several change
% files to tex.web; the master files tex.web and etex.ch should stay intact.)
% See etex_gen.tex for hints on how to install this program.
% And see etripman.tex for details about how to validate it.
% This program is directly derived from Donald E. Knuth's TeX;
% the change history which follows and the reward offered for finders of
% bugs refer specifically to TeX; they should not be taken as referring
% to e-TeX, although the change history is relevant in that it
% demonstrates the evolutionary path followed. This program is not TeX;
% that name is reserved strictly for the program which is the creation
% and sole responsibility of Professor Knuth.
% Version 0 was released in September 1982 after it passed a variety of tests.
% Version 1 was released in November 1983 after thorough testing.
% Version 1.1 fixed ``disappearing font identifiers'' et alia (July 1984).
% Version 1.2 allowed `0' in response to an error, et alia (October 1984).
% Version 1.3 made memory allocation more flexible and local (November 1984).
% Version 1.4 fixed accents right after line breaks, et alia (April 1985).
% Version 1.5 fixed \the\toks after other expansion in \edefs (August 1985).
% Version 2.0 (almost identical to 1.5) corresponds to "Volume B" (April 1986).
% Version 2.1 corrected anomalies in discretionary breaks (January 1987).
% Version 2.2 corrected "(Please type...)" with null \endlinechar (April 1987).
% Version 2.3 avoided incomplete page in premature termination (August 1987).
% Version 2.4 fixed \noaligned rules in indented displays (August 1987).
% Version 2.5 saved cur_order when expanding tokens (September 1987).
% Version 2.6 added 10sp slop when shipping leaders (November 1987).
% Version 2.7 improved rounding of negative-width characters (November 1987).
% Version 2.8 fixed weird bug if no \patterns are used (December 1987).
% Version 2.9 made \csname\endcsname's "relax" local (December 1987).
% Version 2.91 fixed \outer\def\a0{}\a\a bug (April 1988).
% Version 2.92 fixed \patterns, also file names with complex macros (May 1988).
% Version 2.93 fixed negative halving in allocator when mem_min<0 (June 1988).
% Version 2.94 kept open_log_file from calling fatal_error (November 1988).
% Version 2.95 solved that problem a better way (December 1988).
% Version 2.96 corrected bug in "Infinite shrinkage" recovery (January 1989).
% Version 2.97 corrected blunder in creating 2.95 (February 1989).
% Version 2.98 omitted save_for_after at outer level (March 1989).
% Version 2.99 caught $$\begingroup\halign..$$ (June 1989).
% Version 2.991 caught .5\ifdim.6... (June 1989).
% Version 2.992 introduced major changes for 8-bit extensions (September 1989).
% Version 2.993 fixed a save_stack synchronization bug et alia (December 1989).
% Version 3.0 fixed unusual displays; was more \output robust (March 1990).
% Version 3.1 fixed nullfont, disabled \write{\the\prevgraf} (September 1990).
% Version 3.14 fixed unprintable font names and corrected typos (March 1991).
% Version 3.141 more of same; reconstituted ligatures better (March 1992).
% Version 3.1415 preserved nonexplicit kerns, tidied up (February 1993).
% Version 3.14159 allowed fontmemsize to change; bulletproofing (March 1995).
% Version 3.141592 fixed \xleaders, glueset, weird alignments (December 2002).
% Version 3.1415926 was a general cleanup with minor fixes (February 2008).
% Version 3.14159265 was similar (January 2014).
% Version 3.141592653 was similar but more extensive (January 2021).
% A preliminary version of TeX--XeT was released in April 1992.
% TeX--XeT version 1.0 was released in June 1992,
% version 1.1 prevented arith overflow in glue computation (Oct 1992).
% A preliminary e-TeX version 0.95 was operational in March 1994.
% Version 1.0beta was released in May 1995.
% Version 1.01beta fixed bugs in just_copy and every_eof (December 1995).
% Version 1.02beta allowed 256 mark classes (March 1996).
% Version 1.1 changed \group{type,level} -> \currentgroup{type,level},
% first public release (October 1996).
% Version 2.0 development was started in March 1997;
% fixed a ligature-\beginR bug in January 1998;
% was released in March 1998.
% Version 2.1 fixed a \marks bug (when min_halfword<>0) (January 1999).
% Version 2.2 development was started in Feb 2003; released in Oct 2004.
% fixed a bug in sparse array handling (0=>null), Jun 2002;
% fixed a bug in \lastnodetype (cur_val=>cur_val_level)
% reported by Hartmut Henkel <hartmut_henkel@@gmx.de>,
% fix by Fabrice Popineau <Fabrice.Popineau@@supelec.fr>,
% Jan 2004;
% another bug in sparse array handling (cur_ptr=>cur_chr)
% reported by Taco Hoekwater <taco@@elvenkind.com>, Jul 2004;
% fixed a sparse array reference count bug (\let,\futurelet),
% fix by Bernd Raichle <berd@@dante.de>, Aug 2004;
% reorganized handling of banner, additional token list and
% integer parameters, and similar in order to reduce the
% interference between eTeX, pdfTeX, and web2c change files.
% adapted to tex.web 3.141592, revised glue rounding for mixed
% direction typesetting;
% fixed a bug in the revised glue rounding code, detected by
% Tigran Aivazian <tigran@@aivazian.fsnet.co.uk>, Oct 2004.
% Version 2.3 development was started in Feb 2008; released in Apr 2011.
% fixed a bug in hyph_code handling (\savinghyphcodes)
% reported by Vladimir Volovich <vvv@@vsu.ru>, Feb 2008.
% fixed the error messages for improper use of \protected,
% reported by Heiko Oberdiek
% <heiko.oberdiek@@googlemail.com>, May 2010.
% some rearrangements to reduce interferences between
% e-TeX and pTeX, in part suggested by Hironori Kitagawa
% <h_kitagawa2001@@yahoo.co.jp>, Mar 2011.
% Version 2.4 fixed an uninitialized line number bug, released in May 2012.
% Version 2.5 development was started in Aug 2012; released in Feb 2013.
% better tracing of font definitions, reported by
% Bruno Le Floch <blflatex@@gmail.com>, Jul 2012.
% Version 2.6 development was started in Mar 2013; released in ??? 201?.
% enable hyphenation of text between \beginL and \endL or
% between \beginR and \endR, problem reported by
% Vafa Khalighi <vafalgk@@gmail.com>, Nov 2013.
% better handling of right-to-left text -- to be done.
% Although considerable effort has been expended to make the e-TeX program
% correct and reliable, no warranty is implied; the author disclaims any
% obligation or liability for damages, including but not limited to
% special, indirect, or consequential damages arising out of or in
% connection with the use or performance of this software. This work has
% been a ``labor of love'' and the author hopes that users enjoy it.
% Here is TeX material that gets inserted after \input webmac
\def\hang{\hangindent 3em\noindent\ignorespaces}
\def\hangg#1 {\hang\hbox{#1 }}
\def\textindent#1{\hangindent2.5em\noindent\hbox to2.5em{\hss#1 }\ignorespaces}
\font\ninerm=cmr9
\let\mc=\ninerm % medium caps for names like SAIL
\def\eTeX{$\varepsilon$-\TeX}
\font\revrm=xbmc10 % for right-to-left text
% to generate xbmc10 (i.e., reflected cmbx10) use a file
% xbmc10.mf containing:
%+++++++++++++++++++++++++++++++++++++++++++++++++
% if unknown cmbase: input cmbase fi
% extra_endchar := extra_endchar &
% "currentpicture:=currentpicture " &
% "reflectedabout((.5[l,r],0),(.5[l,r],1));";
% input cmbx10
%+++++++++++++++++++++++++++++++++++++++++++++++++
\ifx\beginL\undefined % this is TeX
\def\XeT{X\kern-.125em\lower.5ex\hbox{E}\kern-.1667emT}
\def\TeXeT{\TeX-\hbox{\revrm \XeT}} % for TeX-XeT
\def\TeXXeT{\TeX-\hbox{\revrm -\XeT}} % for TeX--XeT
\else
\ifx\eTeXversion\undefined % this is \TeXeT
\def\TeXeT{\TeX-{\revrm\beginR\TeX\endR}} % for TeX-XeT
\def\TeXXeT{\TeX-{\revrm\beginR\TeX-\endR}} % for TeX--XeT
\else % this is \eTeX
\def\TeXeT{\TeX-{\TeXXeTstate=1\revrm\beginR\TeX\endR}} % for TeX-XeT
\def\TeXXeT{\TeX-{\TeXXeTstate=1\revrm\beginR\TeX-\endR}} % for TeX--XeT
\fi
\fi
\def\PASCAL{Pascal}
\def\pdfTeX{pdf\TeX}
\def\pdfeTeX{pdf\eTeX}
\def\PDF{PDF}
\def\ph{\hbox{Pascal-H}}
\def\pct!{{\char`\%}} % percent sign in ordinary text
\def\grp{\.{\char'173...\char'175}}
\font\logo=logo10 % font used for the METAFONT logo
\def\MF{{\logo META}\-{\logo FONT}}
\def\<#1>{$\langle#1\rangle$}
\def\section{\mathhexbox278}
\def\(#1){} % this is used to make section names sort themselves better
\def\9#1{} % this is used for sort keys in the index via @@:sort key}{entry@@>
\outer\def\N#1. \[#2]#3.{\MN#1.\vfil\eject % begin starred section
\def\rhead{PART #2:\uppercase{#3}} % define running headline
\message{*\modno} % progress report
\edef\next{\write\cont{\Z{\?#2]#3}{\modno}{\the\pageno}}}\next
\ifon\startsection{\bf\ignorespaces#3.\quad}\ignorespaces}
\let\?=\relax % we want to be able to \write a \?
\def\title{\pdfTeX}
% system dependent redefinitions of \title should come later
% and should use:
% \toks0=\expandafter{\title}
% \edef\title{...\the\toks0...}
\let\maybe=\iftrue % print only changed modules
\def\topofcontents{\hsize 5.5in
\vglue 0pt plus 1fil minus 1.5in
\def\?##1]{\hbox to 1in{\hfil##1.\ }}
}
\def\botofcontents{\vskip 0pt plus 1fil minus 1.5in}
\pageno=3
\def\glob{13} % this should be the section number of "<Global...>"
\def\gglob{20, 26} % this should be the next two sections of "<Global...>"
@* \[1] Introduction.
This is \eTeX, a program derived from and extending the capabilities of
\TeX, a document compiler intended to produce typesetting of high
quality.
The \PASCAL\ program that follows is the definition of \TeX82, a standard
@:PASCAL}{\PASCAL@>
@!@:TeX82}{\TeX82@>
version of \TeX\ that is designed to be highly portable so that identical output
will be obtainable on a great variety of computers.
The main purpose of the following program is to explain the algorithms of \TeX\
as clearly as possible. As a result, the program will not necessarily be very
efficient when a particular \PASCAL\ compiler has translated it into a
particular machine language. However, the program has been written so that it
can be tuned to run efficiently in a wide variety of operating environments
by making comparatively few changes. Such flexibility is possible because
the documentation that follows is written in the \.{WEB} language, which is
at a higher level than \PASCAL; the preprocessing step that converts \.{WEB}
to \PASCAL\ is able to introduce most of the necessary refinements.
Semi-automatic translation to other languages is also feasible, because the
program below does not make extensive use of features that are peculiar to
\PASCAL.
A large piece of software like \TeX\ has inherent complexity that cannot
be reduced below a certain level of difficulty, although each individual
part is fairly simple by itself. The \.{WEB} language is intended to make
the algorithms as readable as possible, by reflecting the way the
individual program pieces fit together and by providing the
cross-references that connect different parts. Detailed comments about
what is going on, and about why things were done in certain ways, have
been liberally sprinkled throughout the program. These comments explain
features of the implementation, but they rarely attempt to explain the
\TeX\ language itself, since the reader is supposed to be familiar with
{\sl The \TeX book}.
@.WEB@>
@:TeXbook}{\sl The \TeX book@>
@ The present implementation has a long ancestry, beginning in the summer
of~1977, when Michael~F. Plass and Frank~M. Liang designed and coded
a prototype
@^Plass, Michael Frederick@>
@^Liang, Franklin Mark@>
@^Knuth, Donald Ervin@>
based on some specifications that the author had made in May of that year.
This original proto\TeX\ included macro definitions and elementary
manipulations on boxes and glue, but it did not have line-breaking,
page-breaking, mathematical formulas, alignment routines, error recovery,
or the present semantic nest; furthermore,
it used character lists instead of token lists, so that a control sequence
like \.{\\halign} was represented by a list of seven characters. A
complete version of \TeX\ was designed and coded by the author in late
1977 and early 1978; that program, like its prototype, was written in the
{\mc SAIL} language, for which an excellent debugging system was
available. Preliminary plans to convert the {\mc SAIL} code into a form
somewhat like the present ``web'' were developed by Luis Trabb~Pardo and
@^Trabb Pardo, Luis Isidoro@>
the author at the beginning of 1979, and a complete implementation was
created by Ignacio~A. Zabala in 1979 and 1980. The \TeX82 program, which
@^Zabala Salelles, Ignacio Andr\'es@>
was written by the author during the latter part of 1981 and the early
part of 1982, also incorporates ideas from the 1979 implementation of
@^Guibas, Leonidas Ioannis@>
@^Sedgewick, Robert@>
@^Wyatt, Douglas Kirk@>
\TeX\ in {\mc MESA} that was written by Leonidas Guibas, Robert Sedgewick,
and Douglas Wyatt at the Xerox Palo Alto Research Center. Several hundred
refinements were introduced into \TeX82 based on the experiences gained with
the original implementations, so that essentially every part of the system
has been substantially improved. After the appearance of ``Version 0'' in
September 1982, this program benefited greatly from the comments of
many other people, notably David~R. Fuchs and Howard~W. Trickey.
A final revision in September 1989 extended the input character set to
eight-bit codes and introduced the ability to hyphenate words from
different languages, based on some ideas of Michael~J. Ferguson.
@^Fuchs, David Raymond@>
@^Trickey, Howard Wellington@>
@^Ferguson, Michael John@>
No doubt there still is plenty of room for improvement, but the author
is firmly committed to keeping \TeX82 ``frozen'' from now on; stability
and reliability are to be its main virtues.
On the other hand, the \.{WEB} description can be extended without changing
the core of \TeX82 itself, and the program has been designed so that such
extensions are not extremely difficult to make.
The |banner| string defined here should be changed whenever \TeX\
undergoes any modifications, so that it will be clear which version of
\TeX\ might be the guilty party when a problem arises.
@^extensions to \TeX@>
@^system dependencies@>
This program contains code for various features extending \TeX,
therefore this program is called `\eTeX' and not
`\TeX'; the official name `\TeX' by itself is reserved
for software systems that are fully compatible with each other.
A special test suite called the ``\.{TRIP} test'' is available for
helping to determine whether a particular implementation deserves to be
known as `\TeX' [cf.~Stanford Computer Science report CS1027,
November 1984].
A similar test suite called the ``\.{e-TRIP} test'' is available for
helping to determine whether a particular implementation deserves to be
known as `\eTeX'.
@d eTeX_version=2 { \.{\\eTeXversion} }
@d eTeX_revision==".6" { \.{\\eTeXrevision} }
@d eTeX_version_string=='-2.6' {current \eTeX\ version}
@#
@d eTeX_banner=='This is e-TeX, Version 3.141592653',eTeX_version_string
{printed when \eTeX\ starts}
@#
@d pdftex_version==140 { \.{\\pdftexversion} }
@d pdftex_revision=="26" { \.{\\pdftexrevision} }
@d pdftex_version_string=='-1.40.26' {current \pdfTeX\ version}
@#
@d pdfTeX_banner=='This is pdfTeX, Version 3.141592653',eTeX_version_string,pdftex_version_string
{printed when \pdfTeX\ starts}
@#
@d TeX_banner=='This is TeX, Version 3.141592653' {printed when \TeX\ starts}
@#
@d banner==pdfTeX_banner
@#
@d TEX==PDFTEX {change program name into |PDFTEX|}
@#
@d TeXXeT_code=0 {the \TeXXeT\ feature is optional}
@#
@d eTeX_states=1 {number of \eTeX\ state variables in |eqtb|}
@ Different \PASCAL s have slightly different conventions, and the present
@!@:PASCAL H}{\ph@>
program expresses \TeX\ in terms of the \PASCAL\ that was
available to the author in 1982. Constructions that apply to
this particular compiler, which we shall call \ph, should help the
reader see how to make an appropriate interface for other systems
if necessary. (\ph\ is Charles Hedrick's modification of a compiler
@^Hedrick, Charles Locke@>
for the DECsystem-10 that was originally developed at the University of
Hamburg; cf.\ {\sl Software---Practice and Experience \bf6} (1976),
29--42. The \TeX\ program below is intended to be adaptable, without
extensive changes, to most other versions of \PASCAL, so it does not fully
use the admirable features of \ph. Indeed, a conscious effort has been
made here to avoid using several idiosyncratic features of standard
\PASCAL\ itself, so that most of the code can be translated mechanically
into other high-level languages. For example, the `\&{with}' and `\\{new}'
features are not used, nor are pointer types, set types, or enumerated
scalar types; there are no `\&{var}' parameters, except in the case of files
--- \eTeX, however, does use `\&{var}' parameters for the |reverse| function;
there are no tag fields on variant records; there are no assignments
|real:=integer|; no procedures are declared local to other procedures.)
The portions of this program that involve system-dependent code, where
changes might be necessary because of differences between \PASCAL\ compilers
and/or differences between
operating systems, can be identified by looking at the sections whose
numbers are listed under `system dependencies' in the index. Furthermore,
the index entries for `dirty \PASCAL' list all places where the restrictions
of \PASCAL\ have not been followed perfectly, for one reason or another.
@!@^system dependencies@>
@!@^dirty \PASCAL@>
Incidentally, \PASCAL's standard |round| function can be problematical,
because it disagrees with the IEEE floating-point standard.
Many implementors have
therefore chosen to substitute their own home-grown rounding procedure.
@ The program begins with a normal \PASCAL\ program heading, whose
components will be filled in later, using the conventions of \.{WEB}.
@.WEB@>
For example, the portion of the program called `\X\glob:Global
variables\X' below will be replaced by a sequence of variable declarations
that starts in $\section\glob$ of this documentation. In this way, we are able
to define each individual global variable when we are prepared to
understand what it means; we do not have to define all of the globals at
once. Cross references in $\section\glob$, where it says ``See also
sections \gglob, \dots,'' also make it possible to look at the set of
all global variables, if desired. Similar remarks apply to the other
portions of the program heading.
Actually the heading shown here is not quite normal: The |program| line
does not mention any |output| file, because \ph\ would ask the \TeX\ user
to specify a file name if |output| were specified here.
@:PASCAL H}{\ph@>
@^system dependencies@>
@d mtype==t@&y@&p@&e {this is a \.{WEB} coding trick:}
@f mtype==type {`\&{mtype}' will be equivalent to `\&{type}'}
@f type==true {but `|type|' will not be treated as a reserved word}
@p @t\4@>@<Compiler directives@>@/
program TEX; {all file names are defined dynamically}
label @<Labels in the outer block@>@/
const @<Constants in the outer block@>@/
mtype @<Types in the outer block@>@/
var @<Global variables@>@/
@#
procedure initialize; {this procedure gets things started properly}
var @<Local variables for initialization@>@/
begin @<Initialize whatever \TeX\ might access@>@;
end;@#
@t\4@>@<Basic printing procedures@>@/
@t\4@>@<Error handling procedures@>@/
@ The overall \TeX\ program begins with the heading just shown, after which
comes a bunch of procedure declarations and function declarations.
Finally we will get to the main program, which begins with the
comment `|start_here|'. If you want to skip down to the
main program now, you can look up `|start_here|' in the index.
But the author suggests that the best way to understand this program
is to follow pretty much the order of \TeX's components as they appear in the
\.{WEB} description you are now reading, since the present ordering is
intended to combine the advantages of the ``bottom up'' and ``top down''
approaches to the problem of understanding a somewhat complicated system.
@ Three labels must be declared in the main program, so we give them
symbolic names.
@d start_of_TEX=1 {go here when \TeX's variables are initialized}
@d end_of_TEX=9998 {go here to close files and terminate gracefully}
@d final_end=9999 {this label marks the ending of the program}
@<Labels in the out...@>=
start_of_TEX@t\hskip-2pt@>, end_of_TEX@t\hskip-2pt@>,@,final_end;
{key control points}
@ Some of the code below is intended to be used only when diagnosing the
strange behavior that sometimes occurs when \TeX\ is being installed or
when system wizards are fooling around with \TeX\ without quite knowing
what they are doing. Such code will not normally be compiled; it is
delimited by the codewords `$|debug|\ldots|gubed|$', with apologies
to people who wish to preserve the purity of English.
Similarly, there is some conditional code delimited by
`$|stat|\ldots|tats|$' that is intended for use when statistics are to be
kept about \TeX's memory usage. The |stat| $\ldots$ |tats| code also
implements diagnostic information for \.{\\tracingparagraphs},
\.{\\tracingpages}, and \.{\\tracingrestores}.
@^debugging@>
@d debug==@{ {change this to `$\\{debug}\equiv\null$' when debugging}
@d gubed==@t@>@} {change this to `$\\{gubed}\equiv\null$' when debugging}
@f debug==begin
@f gubed==end
@#
@d stat==@{ {change this to `$\\{stat}\equiv\null$' when gathering
usage statistics}
@d tats==@t@>@} {change this to `$\\{tats}\equiv\null$' when gathering
usage statistics}
@f stat==begin
@f tats==end
@ This program has two important variations: (1) There is a long and slow
version called \.{INITEX}, which does the extra calculations needed to
@.INITEX@>
initialize \TeX's internal tables; and (2)~there is a shorter and faster
production version, which cuts the initialization to a bare minimum.
Parts of the program that are needed in (1) but not in (2) are delimited by
the codewords `$|init|\ldots|tini|$'.
@d init== {change this to `$\\{init}\equiv\.{@@\{}$' in the production version}
@d tini== {change this to `$\\{tini}\equiv\.{@@\}}$' in the production version}
@f init==begin
@f tini==end
@<Initialize whatever...@>=
@<Set initial values of key variables@>@/
@!init @<Initialize table entries (done by \.{INITEX} only)@>@;@+tini
@ If the first character of a \PASCAL\ comment is a dollar sign,
\ph\ treats the comment as a list of ``compiler directives'' that will
affect the translation of this program into machine language. The
directives shown below specify full checking and inclusion of the \PASCAL\
debugger when \TeX\ is being debugged, but they cause range checking and other
redundant code to be eliminated when the production system is being generated.
Arithmetic overflow will be detected in all cases.
@:PASCAL H}{\ph@>
@^system dependencies@>
@^overflow in arithmetic@>
@<Compiler directives@>=
@{@&$C-,A+,D-@} {no range check, catch arithmetic overflow, no debug overhead}
@!debug @{@&$C+,D+@}@+ gubed {but turn everything on when debugging}
@ This \TeX\ implementation conforms to the rules of the {\sl Pascal User
@:PASCAL}{\PASCAL@>
@^system dependencies@>
Manual} published by Jensen and Wirth in 1975, except where system-dependent
@^Wirth, Niklaus@>
@^Jensen, Kathleen@>
code is necessary to make a useful system program, and except in another
respect where such conformity would unnecessarily obscure the meaning
and clutter up the code: We assume that |case| statements may include a
default case that applies if no matching label is found. Thus, we shall use
constructions like
$$\vbox{\halign{\ignorespaces#\hfil\cr
|case x of|\cr
1: $\langle\,$code for $x=1\,\rangle$;\cr
3: $\langle\,$code for $x=3\,\rangle$;\cr
|othercases| $\langle\,$code for |x<>1| and |x<>3|$\,\rangle$\cr
|endcases|\cr}}$$
since most \PASCAL\ compilers have plugged this hole in the language by
incorporating some sort of default mechanism. For example, the \ph\
compiler allows `|others|:' as a default label, and other \PASCAL s allow
syntaxes like `\&{else}' or `\&{otherwise}' or `\\{otherwise}:', etc. The
definitions of |othercases| and |endcases| should be changed to agree with
local conventions. Note that no semicolon appears before |endcases| in
this program, so the definition of |endcases| should include a semicolon
if the compiler wants one. (Of course, if no default mechanism is
available, the |case| statements of \TeX\ will have to be laboriously
extended by listing all remaining cases. People who are stuck with such
\PASCAL s have, in fact, done this, successfully but not happily!)
@:PASCAL H}{\ph@>
@d othercases == others: {default for cases not listed explicitly}
@d endcases == @+end {follows the default case in an extended |case| statement}
@f othercases == else
@f endcases == end
@ The following parameters can be changed at compile time to extend or
reduce \TeX's capacity. They may have different values in \.{INITEX} and
in production versions of \TeX.
@.INITEX@>
@^system dependencies@>
@<Constants...@>=
@!mem_max=30000; {greatest index in \TeX's internal |mem| array;
must be strictly less than |max_halfword|;
must be equal to |mem_top| in \.{INITEX}, otherwise |>=mem_top|}
@!mem_min=0; {smallest index in \TeX's internal |mem| array;
must be |min_halfword| or more;
must be equal to |mem_bot| in \.{INITEX}, otherwise |<=mem_bot|}
@!buf_size=500; {maximum number of characters simultaneously present in
current lines of open files and in control sequences between
\.{\\csname} and \.{\\endcsname}; must not exceed |max_halfword|}
@!error_line=72; {width of context lines on terminal error messages}
@!half_error_line=42; {width of first lines of contexts in terminal
error messages; should be between 30 and |error_line-15|}
@!max_print_line=79; {width of longest text lines output; should be at least 60}
@!stack_size=200; {maximum number of simultaneous input sources}
@!max_in_open=6; {maximum number of input files and error insertions that
can be going on simultaneously}
@!font_max=75; {maximum internal font number; must not exceed |max_quarterword|
and must be at most |font_base+256|}
@!font_mem_size=20000; {number of words of |font_info| for all fonts}
@!param_size=60; {maximum number of simultaneous macro parameters}
@!nest_size=40; {maximum number of semantic levels simultaneously active}
@!max_strings=3000; {maximum number of strings; must not exceed |max_halfword|}
@!string_vacancies=8000; {the minimum number of characters that should be
available for the user's control sequences and font names,
after \TeX's own error messages are stored}
@!pool_size=32000; {maximum number of characters in strings, including all
error messages and help texts, and the names of all fonts and
control sequences; must exceed |string_vacancies| by the total
length of \TeX's own strings, which is currently about 23000}
@!save_size=600; {space for saving values outside of current group; must be
at most |max_halfword|}
@!trie_size=8000; {space for hyphenation patterns; should be larger for
\.{INITEX} than it is in production versions of \TeX}
@!trie_op_size=500; {space for ``opcodes'' in the hyphenation patterns}
@!dvi_buf_size=800; {size of the output buffer; must be a multiple of 8}
@!file_name_size=40; {file names shouldn't be longer than this}
@!pool_name='TeXformats:TEX.POOL ';
{string of length |file_name_size|; tells where the string pool appears}
@.TeXformats@>
@ Like the preceding parameters, the following quantities can be changed
at compile time to extend or reduce \TeX's capacity. But if they are changed,
it is necessary to rerun the initialization program \.{INITEX}
@.INITEX@>
to generate new tables for the production \TeX\ program.
One can't simply make helter-skelter changes to the following constants,
since certain rather complex initialization
numbers are computed from them. They are defined here using
\.{WEB} macros, instead of being put into \PASCAL's |const| list, in order to
emphasize this distinction.
@d mem_bot=0 {smallest index in the |mem| array dumped by \.{INITEX};
must not be less than |mem_min|}
@d mem_top==30000 {largest index in the |mem| array dumped by \.{INITEX};
must be substantially larger than |mem_bot|
and not greater than |mem_max|}
@d font_base=0 {smallest internal font number; must not be less
than |min_quarterword|}
@d hash_size=2100 {maximum number of control sequences; it should be at most
about |(mem_max-mem_min)/10|}
@d hash_prime=1777 {a prime number equal to about 85\pct! of |hash_size|}
@d hyph_size=307 {another prime; the number of \.{\\hyphenation} exceptions}
@^system dependencies@>
@ In case somebody has inadvertently made bad settings of the ``constants,''
\TeX\ checks them using a global variable called |bad|.
This is the first of many sections of \TeX\ where global variables are
defined.
@<Glob...@>=
@!bad:integer; {is some ``constant'' wrong?}
@ Later on we will say `\ignorespaces|if mem_max>=max_halfword then bad:=14|',
or something similar. (We can't do that until |max_halfword| has been defined.)
@<Check the ``constant'' values for consistency@>=
bad:=0;
if (half_error_line<30)or(half_error_line>error_line-15) then bad:=1;
if max_print_line<60 then bad:=2;
if dvi_buf_size mod 8<>0 then bad:=3;
if mem_bot+1100>mem_top then bad:=4;
if hash_prime>hash_size then bad:=5;
if max_in_open>=128 then bad:=6;
if mem_top<256+11 then bad:=7; {we will want |null_list>255|}
@ Labels are given symbolic names by the following definitions, so that
occasional |goto| statements will be meaningful. We insert the label
`|exit|' just before the `\ignorespaces|end|\unskip' of a procedure in
which we have used the `|return|' statement defined below; the label
`|restart|' is occasionally used at the very beginning of a procedure; and
the label `|reswitch|' is occasionally used just prior to a |case|
statement in which some cases change the conditions and we wish to branch
to the newly applicable case. Loops that are set up with the |loop|
construction defined below are commonly exited by going to `|done|' or to
`|found|' or to `|not_found|', and they are sometimes repeated by going to
`|continue|'. If two or more parts of a subroutine start differently but
end up the same, the shared code may be gathered together at
`|common_ending|'.
Incidentally, this program never declares a label that isn't actually used,
because some fussy \PASCAL\ compilers will complain about redundant labels.
@d exit=10 {go here to leave a procedure}
@d restart=20 {go here to start a procedure again}
@d reswitch=21 {go here to start a case statement again}
@d continue=22 {go here to resume a loop}
@d done=30 {go here to exit a loop}
@d done1=31 {like |done|, when there is more than one loop}
@d done2=32 {for exiting the second loop in a long block}
@d done3=33 {for exiting the third loop in a very long block}
@d done4=34 {for exiting the fourth loop in an extremely long block}
@d done5=35 {for exiting the fifth loop in an immense block}
@d done6=36 {for exiting the sixth loop in a block}
@d found=40 {go here when you've found it}
@d found1=41 {like |found|, when there's more than one per routine}
@d found2=42 {like |found|, when there's more than two per routine}
@d not_found=45 {go here when you've found nothing}
@d not_found1=46 {like |not_found|, when there's more than one}
@d not_found2=47 {like |not_found|, when there's more than two}
@d not_found3=48 {like |not_found|, when there's more than three}
@d not_found4=49 {like |not_found|, when there's more than four}
@d common_ending=50 {go here when you want to merge with another branch}
@ Here are some macros for common programming idioms.
@d incr(#) == #:=#+1 {increase a variable by unity}
@d decr(#) == #:=#-1 {decrease a variable by unity}
@d negate(#) == #:=-# {change the sign of a variable}
@d loop == @+ while true do@+ {repeat over and over until a |goto| happens}
@f loop == xclause
{\.{WEB}'s |xclause| acts like `\ignorespaces|while true do|\unskip'}
@d do_nothing == {empty statement}
@d return == goto exit {terminate a procedure call}
@f return == nil
@d empty=0 {symbolic name for a null constant}
@* \[2] The character set.
In order to make \TeX\ readily portable to a wide variety of
computers, all of its input text is converted to an internal eight-bit
code that includes standard ASCII, the ``American Standard Code for
Information Interchange.'' This conversion is done immediately when each
character is read in. Conversely, characters are converted from ASCII to
the user's external representation just before they are output to a
text file.
Such an internal code is relevant to users of \TeX\ primarily because it
governs the positions of characters in the fonts. For example, the
character `\.A' has ASCII code $65=@'101$, and when \TeX\ typesets
this letter it specifies character number 65 in the current font.
If that font actually has `\.A' in a different position, \TeX\ doesn't
know what the real position is; the program that does the actual printing from
\TeX's device-independent files is responsible for converting from ASCII to
a particular font encoding.
@^ASCII code@>
\TeX's internal code also defines the value of constants
that begin with a reverse apostrophe; and it provides an index to the
\.{\\catcode}, \.{\\mathcode}, \.{\\uccode}, \.{\\lccode}, and \.{\\delcode}
tables.
@ Characters of text that have been converted to \TeX's internal form
are said to be of type |ASCII_code|, which is a subrange of the integers.
@<Types...@>=
@!ASCII_code=0..255; {eight-bit numbers}
@ The original \PASCAL\ compiler was designed in the late 60s, when six-bit
character sets were common, so it did not make provision for lowercase
letters. Nowadays, of course, we need to deal with both capital and small
letters in a convenient way, especially in a program for typesetting;
so the present specification of \TeX\ has been written under the assumption
that the \PASCAL\ compiler and run-time system permit the use of text files
with more than 64 distinguishable characters. More precisely, we assume that
the character set contains at least the letters and symbols associated
with ASCII codes @'40 through @'176; all of these characters are now
available on most computer terminals.
Since we are dealing with more characters than were present in the first
\PASCAL\ compilers, we have to decide what to call the associated data
type. Some \PASCAL s use the original name |char| for the
characters in text files, even though there now are more than 64 such
characters, while other \PASCAL s consider |char| to be a 64-element
subrange of a larger data type that has some other name.
In order to accommodate this difference, we shall use the name |text_char|
to stand for the data type of the characters that are converted to and
from |ASCII_code| when they are input and output. We shall also assume
that |text_char| consists of the elements |chr(first_text_char)| through
|chr(last_text_char)|, inclusive. The following definitions should be
adjusted if necessary.
@^system dependencies@>
@d text_char == char {the data type of characters in text files}
@d first_text_char=0 {ordinal number of the smallest element of |text_char|}
@d last_text_char=255 {ordinal number of the largest element of |text_char|}
@<Local variables for init...@>=
@!i:integer;
@ The \TeX\ processor converts between ASCII code and
the user's external character set by means of arrays |xord| and |xchr|
that are analogous to \PASCAL's |ord| and |chr| functions.
@<Glob...@>=
@!xord: array [text_char] of ASCII_code;
{specifies conversion of input characters}
@!xchr: array [ASCII_code] of text_char;
{specifies conversion of output characters}
@ Since we are assuming that our \PASCAL\ system is able to read and
write the visible characters of standard ASCII (although not
necessarily using the ASCII codes to represent them), the following
assignment statements initialize the standard part of the |xchr| array
properly, without needing any system-dependent changes. On the other
hand, it is possible to implement \TeX\ with less complete character
sets, and in such cases it will be necessary to change something here.
@^system dependencies@>
@<Set init...@>=
xchr[@'40]:=' ';
xchr[@'41]:='!';
xchr[@'42]:='"';
xchr[@'43]:='#';
xchr[@'44]:='$';
xchr[@'45]:='%';
xchr[@'46]:='&';
xchr[@'47]:='''';@/
xchr[@'50]:='(';
xchr[@'51]:=')';
xchr[@'52]:='*';
xchr[@'53]:='+';
xchr[@'54]:=',';
xchr[@'55]:='-';
xchr[@'56]:='.';
xchr[@'57]:='/';@/
xchr[@'60]:='0';
xchr[@'61]:='1';
xchr[@'62]:='2';
xchr[@'63]:='3';
xchr[@'64]:='4';
xchr[@'65]:='5';
xchr[@'66]:='6';
xchr[@'67]:='7';@/
xchr[@'70]:='8';
xchr[@'71]:='9';
xchr[@'72]:=':';
xchr[@'73]:=';';
xchr[@'74]:='<';
xchr[@'75]:='=';
xchr[@'76]:='>';
xchr[@'77]:='?';@/
xchr[@'100]:='@@';
xchr[@'101]:='A';
xchr[@'102]:='B';
xchr[@'103]:='C';
xchr[@'104]:='D';
xchr[@'105]:='E';
xchr[@'106]:='F';
xchr[@'107]:='G';@/
xchr[@'110]:='H';
xchr[@'111]:='I';
xchr[@'112]:='J';
xchr[@'113]:='K';
xchr[@'114]:='L';
xchr[@'115]:='M';
xchr[@'116]:='N';
xchr[@'117]:='O';@/
xchr[@'120]:='P';
xchr[@'121]:='Q';
xchr[@'122]:='R';
xchr[@'123]:='S';
xchr[@'124]:='T';
xchr[@'125]:='U';
xchr[@'126]:='V';
xchr[@'127]:='W';@/
xchr[@'130]:='X';
xchr[@'131]:='Y';
xchr[@'132]:='Z';
xchr[@'133]:='[';
xchr[@'134]:='\';
xchr[@'135]:=']';
xchr[@'136]:='^';
xchr[@'137]:='_';@/
xchr[@'140]:='`';
xchr[@'141]:='a';
xchr[@'142]:='b';
xchr[@'143]:='c';
xchr[@'144]:='d';
xchr[@'145]:='e';
xchr[@'146]:='f';
xchr[@'147]:='g';@/
xchr[@'150]:='h';
xchr[@'151]:='i';
xchr[@'152]:='j';
xchr[@'153]:='k';
xchr[@'154]:='l';
xchr[@'155]:='m';
xchr[@'156]:='n';
xchr[@'157]:='o';@/
xchr[@'160]:='p';
xchr[@'161]:='q';
xchr[@'162]:='r';
xchr[@'163]:='s';
xchr[@'164]:='t';
xchr[@'165]:='u';
xchr[@'166]:='v';
xchr[@'167]:='w';@/
xchr[@'170]:='x';
xchr[@'171]:='y';
xchr[@'172]:='z';
xchr[@'173]:='{';
xchr[@'174]:='|';
xchr[@'175]:='}';
xchr[@'176]:='~';@/
@ Some of the ASCII codes without visible characters have been given symbolic
names in this program because they are used with a special meaning.
@d null_code=@'0 {ASCII code that might disappear}
@d carriage_return=@'15 {ASCII code used at end of line}
@d invalid_code=@'177 {ASCII code that many systems prohibit in text files}
@ The ASCII code is ``standard'' only to a certain extent, since many
computer installations have found it advantageous to have ready access
to more than 94 printing characters. Appendix~C of {\sl The \TeX book\/}
gives a complete specification of the intended correspondence between
characters and \TeX's internal representation.
@:TeXbook}{\sl The \TeX book@>
If \TeX\ is being used
on a garden-variety \PASCAL\ for which only standard ASCII
codes will appear in the input and output files, it doesn't really matter
what codes are specified in |xchr[0..@'37]|, but the safest policy is to
blank everything out by using the code shown below.
However, other settings of |xchr| will make \TeX\ more friendly on
computers that have an extended character set, so that users can type things
like `\.^^Z' instead of `\.{\\ne}'. People with extended character sets can
assign codes arbitrarily, giving an |xchr| equivalent to whatever
characters the users of \TeX\ are allowed to have in their input files.
It is best to make the codes correspond to the intended interpretations as
shown in Appendix~C whenever possible; but this is not necessary. For
example, in countries with an alphabet of more than 26 letters, it is
usually best to map the additional letters into codes less than~@'40.
To get the most ``permissive'' character set, change |' '| on the
right of these assignment statements to |chr(i)|.
@^character set dependencies@>
@^system dependencies@>
@<Set init...@>=
for i:=0 to @'37 do xchr[i]:=' ';
for i:=@'177 to @'377 do xchr[i]:=' ';
@ The following system-independent code makes the |xord| array contain a
suitable inverse to the information in |xchr|. Note that if |xchr[i]=xchr[j]|
where |i<j<@'177|, the value of |xord[xchr[i]]| will turn out to be
|j| or more; hence, standard ASCII code numbers will be used instead of
codes below @'40 in case there is a coincidence.
@<Set init...@>=
for i:=first_text_char to last_text_char do xord[chr(i)]:=invalid_code;
for i:=@'200 to @'377 do xord[xchr[i]]:=i;
for i:=0 to @'176 do xord[xchr[i]]:=i;
@* \[3] Input and output.
The bane of portability is the fact that different operating systems treat
input and output quite differently, perhaps because computer scientists
have not given sufficient attention to this problem. People have felt somehow
that input and output are not part of ``real'' programming. Well, it is true
that some kinds of programming are more fun than others. With existing
input/output conventions being so diverse and so messy, the only sources of
joy in such parts of the code are the rare occasions when one can find a
way to make the program a little less bad than it might have been. We have
two choices, either to attack I/O now and get it over with, or to postpone
I/O until near the end. Neither prospect is very attractive, so let's
get it over with.
The basic operations we need to do are (1)~inputting and outputting of
text, to or from a file or the user's terminal; (2)~inputting and
outputting of eight-bit bytes, to or from a file; (3)~instructing the
operating system to initiate (``open'') or to terminate (``close'') input or
output from a specified file; (4)~testing whether the end of an input
file has been reached.
\TeX\ needs to deal with two kinds of files.
We shall use the term |alpha_file| for a file that contains textual data,
and the term |byte_file| for a file that contains eight-bit binary information.
These two types turn out to be the same on many computers, but
sometimes there is a significant distinction, so we shall be careful to
distinguish between them. Standard protocols for transferring
such files from computer to computer, via high-speed networks, are
now becoming available to more and more communities of users.
The program actually makes use also of a third kind of file, called a
|word_file|, when dumping and reloading base information for its own
initialization. We shall define a word file later; but it will be possible
for us to specify simple operations on word files before they are defined.
@<Types...@>=
@!eight_bits=0..255; {unsigned one-byte quantity}
@!alpha_file=packed file of text_char; {files that contain textual data}
@!byte_file=packed file of eight_bits; {files that contain binary data}
@ Most of what we need to do with respect to input and output can be handled
by the I/O facilities that are standard in \PASCAL, i.e., the routines
called |get|, |put|, |eof|, and so on. But
standard \PASCAL\ does not allow file variables to be associated with file
names that are determined at run time, so it cannot be used to implement
\TeX; some sort of extension to \PASCAL's ordinary |reset| and |rewrite|
is crucial for our purposes. We shall assume that |name_of_file| is a variable
of an appropriate type such that the \PASCAL\ run-time system being used to
implement \TeX\ can open a file whose external name is specified by
|name_of_file|.
@^system dependencies@>
@<Glob...@>=
@!name_of_file:packed array[1..file_name_size] of char;@;@/
{on some systems this may be a \&{record} variable}
@!name_length:0..file_name_size;@/{this many characters are actually
relevant in |name_of_file| (the rest are blank)}
@ The \ph\ compiler with which the present version of \TeX\ was prepared has
extended the rules of \PASCAL\ in a very convenient way. To open file~|f|,
we can write
$$\vbox{\halign{#\hfil\qquad&#\hfil\cr
|reset(f,@t\\{name}@>,'/O')|&for input;\cr
|rewrite(f,@t\\{name}@>,'/O')|&for output.\cr}}$$
The `\\{name}' parameter, which is of type `{\bf packed array
$[\langle\\{any}\rangle]$ of \\{char}}', stands for the name of
the external file that is being opened for input or output.
Blank spaces that might appear in \\{name} are ignored.
The `\.{/O}' parameter tells the operating system not to issue its own
error messages if something goes wrong. If a file of the specified name
cannot be found, or if such a file cannot be opened for some other reason
(e.g., someone may already be trying to write the same file), we will have
|@!erstat(f)<>0| after an unsuccessful |reset| or |rewrite|. This allows
\TeX\ to undertake appropriate corrective action.
@:PASCAL H}{\ph@>
@^system dependencies@>
\TeX's file-opening procedures return |false| if no file identified by
|name_of_file| could be opened.
@d reset_OK(#)==erstat(#)=0
@d rewrite_OK(#)==erstat(#)=0
@p function a_open_in(var f:alpha_file):boolean;
{open a text file for input}
begin reset(f,name_of_file,'/O'); a_open_in:=reset_OK(f);
end;
@#
function a_open_out(var f:alpha_file):boolean;
{open a text file for output}
begin rewrite(f,name_of_file,'/O'); a_open_out:=rewrite_OK(f);
end;
@#
function b_open_in(var f:byte_file):boolean;
{open a binary file for input}
begin reset(f,name_of_file,'/O'); b_open_in:=reset_OK(f);
end;
@#
function b_open_out(var f:byte_file):boolean;
{open a binary file for output}
begin rewrite(f,name_of_file,'/O'); b_open_out:=rewrite_OK(f);
end;
@#
function w_open_in(var f:word_file):boolean;
{open a word file for input}
begin reset(f,name_of_file,'/O'); w_open_in:=reset_OK(f);
end;
@#
function w_open_out(var f:word_file):boolean;
{open a word file for output}
begin rewrite(f,name_of_file,'/O'); w_open_out:=rewrite_OK(f);
end;
@ Files can be closed with the \ph\ routine `|close(f)|', which
@:PASCAL H}{\ph@>
@^system dependencies@>
should be used when all input or output with respect to |f| has been completed.
This makes |f| available to be opened again, if desired; and if |f| was used for
output, the |close| operation makes the corresponding external file appear
on the user's area, ready to be read.
These procedures should not generate error messages if a file is
being closed before it has been successfully opened.
@p procedure a_close(var f:alpha_file); {close a text file}
begin close(f);
end;
@#
procedure b_close(var f:byte_file); {close a binary file}
begin close(f);
end;
@#
procedure w_close(var f:word_file); {close a word file}
begin close(f);
end;
@ Binary input and output are done with \PASCAL's ordinary |get| and |put|
procedures, so we don't have to make any other special arrangements for
binary~I/O. Text output is also easy to do with standard \PASCAL\ routines.
The treatment of text input is more difficult, however, because
of the necessary translation to |ASCII_code| values.
\TeX's conventions should be efficient, and they should
blend nicely with the user's operating environment.
@ Input from text files is read one line at a time, using a routine called
|input_ln|. This function is defined in terms of global variables called
|buffer|, |first|, and |last| that will be described in detail later; for
now, it suffices for us to know that |buffer| is an array of |ASCII_code|
values, and that |first| and |last| are indices into this array
representing the beginning and ending of a line of text.
@<Glob...@>=
@!buffer:array[0..buf_size] of ASCII_code; {lines of characters being read}
@!first:0..buf_size; {the first unused position in |buffer|}
@!last:0..buf_size; {end of the line just input to |buffer|}
@!max_buf_stack:0..buf_size; {largest index used in |buffer|}
@ The |input_ln| function brings the next line of input from the specified
file into available positions of the buffer array and returns the value
|true|, unless the file has already been entirely read, in which case it
returns |false| and sets |last:=first|. In general, the |ASCII_code|
numbers that represent the next line of the file are input into
|buffer[first]|, |buffer[first+1]|, \dots, |buffer[last-1]|; and the
global variable |last| is set equal to |first| plus the length of the
line. Trailing blanks are removed from the line; thus, either |last=first|
(in which case the line was entirely blank) or |buffer[last-1]<>" "|.
An overflow error is given, however, if the normal actions of |input_ln|
would make |last>=buf_size|; this is done so that other parts of \TeX\
can safely look at the contents of |buffer[last+1]| without overstepping
the bounds of the |buffer| array. Upon entry to |input_ln|, the condition
|first<buf_size| will always hold, so that there is always room for an
``empty'' line.
The variable |max_buf_stack|, which is used to keep track of how large
the |buf_size| parameter must be to accommodate the present job, is
also kept up to date by |input_ln|.
If the |bypass_eoln| parameter is |true|, |input_ln| will do a |get|
before looking at the first character of the line; this skips over
an |eoln| that was in |f^|. The procedure does not do a |get| when it
reaches the end of the line; therefore it can be used to acquire input
from the user's terminal as well as from ordinary text files.
Standard \PASCAL\ says that a file should have |eoln| immediately
before |eof|, but \TeX\ needs only a weaker restriction: If |eof|
occurs in the middle of a line, the system function |eoln| should return
a |true| result (even though |f^| will be undefined).
Since the inner loop of |input_ln| is part of \TeX's ``inner loop''---each
character of input comes in at this place---it is wise to reduce system
overhead by making use of special routines that read in an entire array
of characters at once, if such routines are available. The following
code uses standard \PASCAL\ to illustrate what needs to be done, but
finer tuning is often possible at well-developed \PASCAL\ sites.
@^inner loop@>
@p function input_ln(var f:alpha_file;@!bypass_eoln:boolean):boolean;
{inputs the next line or returns |false|}
var last_nonblank:0..buf_size; {|last| with trailing blanks removed}
begin if bypass_eoln then if not eof(f) then get(f);
{input the first character of the line into |f^|}
last:=first; {cf.\ Matthew 19\thinspace:\thinspace30}
if eof(f) then input_ln:=false
else begin last_nonblank:=first;
while not eoln(f) do
begin if last>=max_buf_stack then
begin max_buf_stack:=last+1;
if max_buf_stack=buf_size then
@<Report overflow of the input buffer, and abort@>;
end;
buffer[last]:=xord[f^]; get(f); incr(last);
if buffer[last-1]<>" " then last_nonblank:=last;
end;
last:=last_nonblank; input_ln:=true;
end;
end;
@ The user's terminal acts essentially like other files of text, except
that it is used both for input and for output. When the terminal is
considered an input file, the file variable is called |term_in|, and when it
is considered an output file the file variable is |term_out|.
@^system dependencies@>
@<Glob...@>=
@!term_in:alpha_file; {the terminal as an input file}
@!term_out:alpha_file; {the terminal as an output file}
@ Here is how to open the terminal files
in \ph. The `\.{/I}' switch suppresses the first |get|.
@:PASCAL H}{\ph@>
@^system dependencies@>
@d t_open_in==reset(term_in,'TTY:','/O/I') {open the terminal for text input}
@d t_open_out==rewrite(term_out,'TTY:','/O') {open the terminal for text output}
@ Sometimes it is necessary to synchronize the input/output mixture that
happens on the user's terminal, and three system-dependent
procedures are used for this
purpose. The first of these, |update_terminal|, is called when we want
to make sure that everything we have output to the terminal so far has
actually left the computer's internal buffers and been sent.
The second, |clear_terminal|, is called when we wish to cancel any
input that the user may have typed ahead (since we are about to
issue an unexpected error message). The third, |wake_up_terminal|,
is supposed to revive the terminal if the user has disabled it by
some instruction to the operating system. The following macros show how
these operations can be specified in \ph:
@:PASCAL H}{\ph@>
@^system dependencies@>
@d update_terminal == break(term_out) {empty the terminal output buffer}
@d clear_terminal == break_in(term_in,true) {clear the terminal input buffer}
@d wake_up_terminal == do_nothing {cancel the user's cancellation of output}
@ We need a special routine to read the first line of \TeX\ input from
the user's terminal. This line is different because it is read before we
have opened the transcript file; there is sort of a ``chicken and
egg'' problem here. If the user types `\.{\\input paper}' on the first
line, or if some macro invoked by that line does such an \.{\\input},
the transcript file will be named `\.{paper.log}'; but if no \.{\\input}
commands are performed during the first line of terminal input, the transcript
file will acquire its default name `\.{texput.log}'. (The transcript file
will not contain error messages generated by the first line before the
first \.{\\input} command.)
@.texput@>
The first line is even more special if we are lucky enough to have an operating
system that treats \TeX\ differently from a run-of-the-mill \PASCAL\ object
program. It's nice to let the user start running a \TeX\ job by typing
a command line like `\.{tex paper}'; in such a case, \TeX\ will operate
as if the first line of input were `\.{paper}', i.e., the first line will
consist of the remainder of the command line, after the part that invoked
\TeX.
The first line is special also because it may be read before \TeX\ has
input a format file. In such cases, normal error messages cannot yet
be given. The following code uses concepts that will be explained later.
(If the \PASCAL\ compiler does not support non-local |@!goto|\unskip, the
@^system dependencies@>
statement `|goto final_end|' should be replaced by something that
quietly terminates the program.)
@<Report overflow of the input buffer, and abort@>=
if format_ident=0 then
begin write_ln(term_out,'Buffer size exceeded!'); goto final_end;
@.Buffer size exceeded@>
end
else begin cur_input.loc_field:=first; cur_input.limit_field:=last-1;
overflow("buffer size",buf_size);
@:TeX capacity exceeded buffer size}{\quad buffer size@>
end
@ Different systems have different ways to get started. But regardless of
what conventions are adopted, the routine that initializes the terminal
should satisfy the following specifications:
\yskip\textindent{1)}It should open file |term_in| for input from the
terminal. (The file |term_out| will already be open for output to the
terminal.)
\textindent{2)}If the user has given a command line, this line should be
considered the first line of terminal input. Otherwise the
user should be prompted with `\.{**}', and the first line of input
should be whatever is typed in response.
\textindent{3)}The first line of input, which might or might not be a
command line, should appear in locations |first| to |last-1| of the
|buffer| array.
\textindent{4)}The global variable |loc| should be set so that the
character to be read next by \TeX\ is in |buffer[loc]|. This
character should not be blank, and we should have |loc<last|.
\yskip\noindent(It may be necessary to prompt the user several times
before a non-blank line comes in. The prompt is `\.{**}' instead of the
later `\.*' because the meaning is slightly different: `\.{\\input}' need
not be typed immediately after~`\.{**}'.)
@d loc==cur_input.loc_field {location of first unread character in |buffer|}
@ The following program does the required initialization
without retrieving a possible command line.
It should be clear how to modify this routine to deal with command lines,
if the system permits them.
@^system dependencies@>
@p function init_terminal:boolean; {gets the terminal input started}
label exit;
begin t_open_in;
loop@+begin wake_up_terminal; write(term_out,'**'); update_terminal;
@.**@>
if not input_ln(term_in,true) then {this shouldn't happen}
begin write_ln(term_out);
write(term_out,'! End of file on the terminal... why?');
@.End of file on the terminal@>
init_terminal:=false; return;
end;
loc:=first;
while (loc<last)and(buffer[loc]=" ") do incr(loc);
if loc<last then
begin init_terminal:=true;
return; {return unless the line was all blank}
end;
write_ln(term_out,'Please type the name of your input file.');
end;
exit:end;
@* \[4] String handling.
Control sequence names and diagnostic messages are variable-length strings
of eight-bit characters. Since \PASCAL\ does not have a well-developed string
mechanism, \TeX\ does all of its string processing by homegrown methods.
Elaborate facilities for dynamic strings are not needed, so all of the
necessary operations can be handled with a simple data structure.
The array |str_pool| contains all of the (eight-bit) ASCII codes in all
of the strings, and the array |str_start| contains indices of the starting
points of each string. Strings are referred to by integer numbers, so that
string number |s| comprises the characters |str_pool[j]| for
|str_start[s]<=j<str_start[s+1]|. Additional integer variables
|pool_ptr| and |str_ptr| indicate the number of entries used so far
in |str_pool| and |str_start|, respectively; locations
|str_pool[pool_ptr]| and |str_start[str_ptr]| are
ready for the next string to be allocated.
String numbers 0 to 255 are reserved for strings that correspond to single
ASCII characters. This is in accordance with the conventions of \.{WEB},
@.WEB@>
which converts single-character strings into the ASCII code number of the
single character involved, while it converts other strings into integers
and builds a string pool file. Thus, when the string constant \.{"."} appears
in the program below, \.{WEB} converts it into the integer 46, which is the
ASCII code for a period, while \.{WEB} will convert a string like \.{"hello"}
into some integer greater than~255. String number 46 will presumably be the
single character `\..'; but some ASCII codes have no standard visible
representation, and \TeX\ sometimes needs to be able to print an arbitrary
ASCII character, so the first 256 strings are used to specify exactly what
should be printed for each of the 256 possibilities.
Elements of the |str_pool| array must be ASCII codes that can actually
be printed; i.e., they must have an |xchr| equivalent in the local
character set. (This restriction applies only to preloaded strings,
not to those generated dynamically by the user.)
Some \PASCAL\ compilers won't pack integers into a single byte unless the
integers lie in the range |-128..127|. To accommodate such systems
we access the string pool only via macros that can easily be redefined.
@^system dependencies@>
@d si(#) == # {convert from |ASCII_code| to |packed_ASCII_code|}
@d so(#) == # {convert from |packed_ASCII_code| to |ASCII_code|}
@<Types...@>=
@!pool_pointer = 0..pool_size; {for variables that point into |str_pool|}
@!str_number = 0..max_strings; {for variables that point into |str_start|}
@!packed_ASCII_code = 0..255; {elements of |str_pool| array}
@ @<Glob...@>=
@!str_pool:packed array[pool_pointer] of packed_ASCII_code; {the characters}
@!str_start : array[str_number] of pool_pointer; {the starting pointers}
@!pool_ptr : pool_pointer; {first unused position in |str_pool|}
@!str_ptr : str_number; {number of the current string being created}
@!init_pool_ptr : pool_pointer; {the starting value of |pool_ptr|}
@!init_str_ptr : str_number; {the starting value of |str_ptr|}
@ Several of the elementary string operations are performed using \.{WEB}
macros instead of \PASCAL\ procedures, because many of the
operations are done quite frequently and we want to avoid the
overhead of procedure calls. For example, here is
a simple macro that computes the length of a string.
@.WEB@>
@d length(#)==(str_start[#+1]-str_start[#]) {the number of characters
in string number \#}
@ The length of the current string is called |cur_length|:
@d cur_length == (pool_ptr - str_start[str_ptr])
@ Strings are created by appending character codes to |str_pool|.
The |append_char| macro, defined here, does not check to see if the
value of |pool_ptr| has gotten too high; this test is supposed to be
made before |append_char| is used. There is also a |flush_char|
macro, which erases the last character appended.
To test if there is room to append |l| more characters to |str_pool|,
we shall write |str_room(l)|, which aborts \TeX\ and gives an
apologetic error message if there isn't enough room.
@d append_char(#) == {put |ASCII_code| \# at the end of |str_pool|}
begin str_pool[pool_ptr]:=si(#); incr(pool_ptr);
end
@d flush_char == decr(pool_ptr) {forget the last character in the pool}
@d str_room(#) == {make sure that the pool hasn't overflowed}
begin if pool_ptr+# > pool_size then
overflow("pool size",pool_size-init_pool_ptr);
@:TeX capacity exceeded pool size}{\quad pool size@>
end
@ Once a sequence of characters has been appended to |str_pool|, it
officially becomes a string when the function |make_string| is called.
This function returns the identification number of the new string as its
value.
@p function make_string : str_number; {current string enters the pool}
begin if str_ptr=max_strings then
overflow("number of strings",max_strings-init_str_ptr);
@:TeX capacity exceeded number of strings}{\quad number of strings@>
incr(str_ptr); str_start[str_ptr]:=pool_ptr;
make_string:=str_ptr-1;
end;
@ To destroy the most recently made string, we say |flush_string|.
@d flush_string==begin decr(str_ptr); pool_ptr:=str_start[str_ptr];
end
@ The following subroutine compares string |s| with another string of the
same length that appears in |buffer| starting at position |k|;
the result is |true| if and only if the strings are equal.
Empirical tests indicate that |str_eq_buf| is used in such a way that
it tends to return |true| about 80 percent of the time.
@p function str_eq_buf(@!s:str_number;@!k:integer):boolean;
{test equality of strings}
label not_found; {loop exit}
var j: pool_pointer; {running index}
@!result: boolean; {result of comparison}
begin j:=str_start[s];
while j<str_start[s+1] do
begin if so(str_pool[j])<>buffer[k] then
begin result:=false; goto not_found;
end;
incr(j); incr(k);
end;
result:=true;
not_found: str_eq_buf:=result;
end;
@ Here is a similar routine, but it compares two strings in the string pool,
and it does not assume that they have the same length.
@p function str_eq_str(@!s,@!t:str_number):boolean;
{test equality of strings}
label not_found; {loop exit}
var j,@!k: pool_pointer; {running indices}
@!result: boolean; {result of comparison}
begin result:=false;
if length(s)<>length(t) then goto not_found;
j:=str_start[s]; k:=str_start[t];
while j<str_start[s+1] do
begin if str_pool[j]<>str_pool[k] then goto not_found;
incr(j); incr(k);
end;
result:=true;
not_found: str_eq_str:=result;
end;
@ The initial values of |str_pool|, |str_start|, |pool_ptr|,
and |str_ptr| are computed by the \.{INITEX} program, based in part
on the information that \.{WEB} has output while processing \TeX.
@.INITEX@>
@^string pool@>
@p @!init function get_strings_started:boolean; {initializes the string pool,
but returns |false| if something goes wrong}
label done,exit;
var k,@!l:0..255; {small indices or counters}
@!m,@!n:text_char; {characters input from |pool_file|}
@!g:str_number; {garbage}
@!a:integer; {accumulator for check sum}
@!c:boolean; {check sum has been checked}
begin pool_ptr:=0; str_ptr:=0; str_start[0]:=0;
@<Make the first 256 strings@>;
@<Read the other strings from the \.{TEX.POOL} file and return |true|,
or give an error message and return |false|@>;
exit:end;
tini
@ @d app_lc_hex(#)==l:=#;
if l<10 then append_char(l+"0")@+else append_char(l-10+"a")
@<Make the first 256...@>=
for k:=0 to 255 do
begin if (@<Character |k| cannot be printed@>) then
begin append_char("^"); append_char("^");
if k<@'100 then append_char(k+@'100)
else if k<@'200 then append_char(k-@'100)
else begin app_lc_hex(k div 16); app_lc_hex(k mod 16);
end;
end
else append_char(k);
g:=make_string;
end
@ The first 128 strings will contain 95 standard ASCII characters, and the
other 33 characters will be printed in three-symbol form like `\.{\^\^A}'
unless a system-dependent change is made here. Installations that have
an extended character set, where for example |xchr[@'32]=@t\.{\'^^Z\'}@>|,
would like string @'32 to be the single character @'32 instead of the
three characters @'136, @'136, @'132 (\.{\^\^Z}). On the other hand,
even people with an extended character set will want to represent string
@'15 by \.{\^\^M}, since @'15 is |carriage_return|; the idea is to
produce visible strings instead of tabs or line-feeds or carriage-returns
or bell-rings or characters that are treated anomalously in text files.
Unprintable characters of codes 128--255 are, similarly, rendered
\.{\^\^80}--\.{\^\^ff}.
The boolean expression defined here should be |true| unless \TeX\
internal code number~|k| corresponds to a non-troublesome visible
symbol in the local character set. An appropriate formula for the
extended character set recommended in {\sl The \TeX book\/} would, for
example, be `|k in [0,@'10..@'12,@'14,@'15,@'33,@'177..@'377]|'.
If character |k| cannot be printed, and |k<@'200|, then character |k+@'100| or
|k-@'100| must be printable; moreover, ASCII codes |[@'41..@'46,
@'60..@'71, @'136, @'141..@'146, @'160..@'171]| must be printable.
Thus, at least 80 printable characters are needed.
@:TeXbook}{\sl The \TeX book@>
@^character set dependencies@>
@^system dependencies@>
@<Character |k| cannot be printed@>=
(k<" ")or(k>"~")
@ When the \.{WEB} system program called \.{TANGLE} processes the \.{TEX.WEB}
description that you are now reading, it outputs the \PASCAL\ program
\.{TEX.PAS} and also a string pool file called \.{TEX.POOL}. The \.{INITEX}
@.WEB@>@.INITEX@>
program reads the latter file, where each string appears as a two-digit decimal
length followed by the string itself, and the information is recorded in
\TeX's string memory.
@<Glob...@>=
@!init @!pool_file:alpha_file; {the string-pool file output by \.{TANGLE}}
tini
@ @d bad_pool(#)==begin wake_up_terminal; write_ln(term_out,#);
a_close(pool_file); get_strings_started:=false; return;
end
@<Read the other strings...@>=
name_of_file:=pool_name; {we needn't set |name_length|}
if a_open_in(pool_file) then
begin c:=false;
repeat @<Read one string, but return |false| if the
string memory space is getting too tight for comfort@>;
until c;
a_close(pool_file); get_strings_started:=true;
end
else bad_pool('! I can''t read TEX.POOL.')
@.I can't read TEX.POOL@>
@ @<Read one string...@>=
begin if eof(pool_file) then bad_pool('! TEX.POOL has no check sum.');
@.TEX.POOL has no check sum@>
read(pool_file,m,n); {read two digits of string length}
if m='*' then @<Check the pool check sum@>
else begin if (xord[m]<"0")or(xord[m]>"9")or@|
(xord[n]<"0")or(xord[n]>"9") then
bad_pool('! TEX.POOL line doesn''t begin with two digits.');
@.TEX.POOL line doesn't...@>
l:=xord[m]*10+xord[n]-"0"*11; {compute the length}
if pool_ptr+l+string_vacancies>pool_size then
bad_pool('! You have to increase POOLSIZE.');
@.You have to increase POOLSIZE@>
for k:=1 to l do
begin if eoln(pool_file) then m:=' '@+else read(pool_file,m);
append_char(xord[m]);
end;
read_ln(pool_file); g:=make_string;
end;
end
@ The \.{WEB} operation \.{@@\$} denotes the value that should be at the
end of this \.{TEX.POOL} file; any other value means that the wrong pool
file has been loaded.
@^check sum@>
@<Check the pool check sum@>=
begin a:=0; k:=1;
loop@+ begin if (xord[n]<"0")or(xord[n]>"9") then
bad_pool('! TEX.POOL check sum doesn''t have nine digits.');
@.TEX.POOL check sum...@>
a:=10*a+xord[n]-"0";
if k=9 then goto done;
incr(k); read(pool_file,n);
end;
done: if a<>@$ then bad_pool('! TEX.POOL doesn''t match; TANGLE me again.');
@.TEX.POOL doesn't match@>
c:=true;
end
@* \[5] On-line and off-line printing.
Messages that are sent to a user's terminal and to the transcript-log file
are produced by several `|print|' procedures. These procedures will
direct their output to a variety of places, based on the setting of
the global variable |selector|, which has the following possible
values:
\yskip
\hang |term_and_log|, the normal setting, prints on the terminal and on the
transcript file.
\hang |log_only|, prints only on the transcript file.
\hang |term_only|, prints only on the terminal.
\hang |no_print|, doesn't print at all. This is used only in rare cases
before the transcript file is open.
\hang |pseudo|, puts output into a cyclic buffer that is used
by the |show_context| routine; when we get to that routine we shall discuss
the reasoning behind this curious mode.
\hang |new_string|, appends the output to the current string in the
string pool.
\hang 0 to 15, prints on one of the sixteen files for \.{\\write} output.
\yskip
\noindent The symbolic names `|term_and_log|', etc., have been assigned
numeric codes that satisfy the convenient relations |no_print+1=term_only|,
|no_print+2=log_only|, |term_only+2=log_only+1=term_and_log|.
Three additional global variables, |tally| and |term_offset| and
|file_offset|, record the number of characters that have been printed
since they were most recently cleared to zero. We use |tally| to record
the length of (possibly very long) stretches of printing; |term_offset|
and |file_offset|, on the other hand, keep track of how many characters
have appeared so far on the current line that has been output to the
terminal or to the transcript file, respectively.
@d no_print=16 {|selector| setting that makes data disappear}
@d term_only=17 {printing is destined for the terminal only}
@d log_only=18 {printing is destined for the transcript file only}
@d term_and_log=19 {normal |selector| setting}
@d pseudo=20 {special |selector| setting for |show_context|}
@d new_string=21 {printing is deflected to the string pool}
@d max_selector=21 {highest selector setting}
@<Glob...@>=
@!log_file : alpha_file; {transcript of \TeX\ session}
@!selector : 0..max_selector; {where to print a message}
@!dig : array[0..22] of 0..15; {digits in a number being output}
@!tally : integer; {the number of characters recently printed}
@!term_offset : 0..max_print_line;
{the number of characters on the current terminal line}
@!file_offset : 0..max_print_line;
{the number of characters on the current file line}
@!trick_buf:array[0..error_line] of ASCII_code; {circular buffer for
pseudoprinting}
@!trick_count: integer; {threshold for pseudoprinting, explained later}
@!first_count: integer; {another variable for pseudoprinting}
@ @<Initialize the output routines@>=
selector:=term_only; tally:=0; term_offset:=0; file_offset:=0;
@ Macro abbreviations for output to the terminal and to the log file are
defined here for convenience. Some systems need special conventions
for terminal output, and it is possible to adhere to those conventions
by changing |wterm|, |wterm_ln|, and |wterm_cr| in this section.
@^system dependencies@>
@d wterm(#)==write(term_out,#)
@d wterm_ln(#)==write_ln(term_out,#)
@d wterm_cr==write_ln(term_out)
@d wlog(#)==write(log_file,#)
@d wlog_ln(#)==write_ln(log_file,#)
@d wlog_cr==write_ln(log_file)
@ To end a line of text output, we call |print_ln|.
@<Basic print...@>=
procedure print_ln; {prints an end-of-line}
begin case selector of
term_and_log: begin wterm_cr; wlog_cr;
term_offset:=0; file_offset:=0;
end;
log_only: begin wlog_cr; file_offset:=0;
end;
term_only: begin wterm_cr; term_offset:=0;
end;
no_print,pseudo,new_string: do_nothing;
othercases write_ln(write_file[selector])
endcases;@/
end; {|tally| is not affected}
@ The |print_char| procedure sends one character to the desired destination,
using the |xchr| array to map it into an external character compatible with
|input_ln|. All printing comes through |print_ln| or |print_char|.
@<Basic printing...@>=
procedure print_char(@!s:ASCII_code); {prints a single character}
label exit;
begin if @<Character |s| is the current new-line character@> then
if selector<pseudo then
begin print_ln; return;
end;
case selector of
term_and_log: begin wterm(xchr[s]); wlog(xchr[s]);
incr(term_offset); incr(file_offset);
if term_offset=max_print_line then
begin wterm_cr; term_offset:=0;
end;
if file_offset=max_print_line then
begin wlog_cr; file_offset:=0;
end;
end;
log_only: begin wlog(xchr[s]); incr(file_offset);
if file_offset=max_print_line then print_ln;
end;
term_only: begin wterm(xchr[s]); incr(term_offset);
if term_offset=max_print_line then print_ln;
end;
no_print: do_nothing;
pseudo: if tally<trick_count then trick_buf[tally mod error_line]:=s;
new_string: begin if pool_ptr<pool_size then append_char(s);
end; {we drop characters if the string space is full}
othercases write(write_file[selector],xchr[s])
endcases;@/
incr(tally);
exit:end;
@ An entire string is output by calling |print|. Note that if we are outputting
the single standard ASCII character \.c, we could call |print("c")|, since
|"c"=99| is the number of a single-character string, as explained above. But
|print_char("c")| is quicker, so \TeX\ goes directly to the |print_char|
routine when it knows that this is safe. (The present implementation
assumes that it is always safe to print a visible ASCII character.)
@^system dependencies@>
@<Basic print...@>=
procedure print(@!s:integer); {prints string |s|}
label exit;
var j:pool_pointer; {current character code position}
@!nl:integer; {new-line character to restore}
begin if s>=str_ptr then s:="???" {this can't happen}
@.???@>
else if s<256 then
if s<0 then s:="???" {can't happen}
else begin if selector>pseudo then
begin print_char(s); return; {internal strings are not expanded}
end;
if (@<Character |s| is the current new-line character@>) then
if selector<pseudo then
begin print_ln; return;
end;
nl:=new_line_char; new_line_char:=-1;
{temporarily disable new-line character}
j:=str_start[s];
while j<str_start[s+1] do
begin print_char(so(str_pool[j])); incr(j);
end;
new_line_char:=nl; return;
end;
j:=str_start[s];
while j<str_start[s+1] do
begin print_char(so(str_pool[j])); incr(j);
end;
exit:end;
@ Control sequence names, file names, and strings constructed with
\.{\\string} might contain |ASCII_code| values that can't
be printed using |print_char|. Therefore we use |slow_print| for them:
@<Basic print...@>=
procedure slow_print(@!s:integer); {prints string |s|}
var j:pool_pointer; {current character code position}
begin if (s>=str_ptr) or (s<256) then print(s)
else begin j:=str_start[s];
while j<str_start[s+1] do
begin print(so(str_pool[j])); incr(j);
end;
end;
end;
@ Here is the very first thing that \TeX\ prints: a headline that identifies
the version number and format package. The |term_offset| variable is temporarily
incorrect, but the discrepancy is not serious since we assume that this
part of the program is system dependent.
@^system dependencies@>
@<Initialize the output...@>=
wterm(banner);
if format_ident=0 then wterm_ln(' (no format preloaded)')
else begin slow_print(format_ident); print_ln;
end;
update_terminal;
@ The procedure |print_nl| is like |print|, but it makes sure that the
string appears at the beginning of a new line.
@<Basic print...@>=
procedure print_nl(@!s:str_number); {prints string |s| at beginning of line}
begin if ((term_offset>0)and(odd(selector)))or@|
((file_offset>0)and(selector>=log_only)) then print_ln;
print(s);
end;
@ The procedure |print_esc| prints a string that is preceded by
the user's escape character (which is usually a backslash).
@<Basic print...@>=
procedure print_esc(@!s:str_number); {prints escape character, then |s|}
var c:integer; {the escape character code}
begin @<Set variable |c| to the current escape character@>;
if c>=0 then if c<256 then print(c);
slow_print(s);
end;
@ An array of digits in the range |0..15| is printed by |print_the_digs|.
@<Basic print...@>=
procedure print_the_digs(@!k:eight_bits);
{prints |dig[k-1]|$\,\ldots\,$|dig[0]|}
begin while k>0 do
begin decr(k);
if dig[k]<10 then print_char("0"+dig[k])
else print_char("A"-10+dig[k]);
end;
end;
@ The following procedure, which prints out the decimal representation of a
given integer |n|, has been written carefully so that it works properly
if |n=0| or if |(-n)| would cause overflow. It does not apply |mod| or |div|
to negative arguments, since such operations are not implemented consistently
by all \PASCAL\ compilers.
@<Basic print...@>=
procedure print_int(@!n:longinteger); {prints an integer in decimal form}
var k:0..23; {index to current digit; we assume that $\vert n\vert<10^{23}$}
@!m:longinteger; {used to negate |n| in possibly dangerous cases}
begin k:=0;
if n<0 then
begin print_char("-");
if n>-100000000 then negate(n)
else begin m:=-1-n; n:=m div 10; m:=(m mod 10)+1; k:=1;
if m<10 then dig[0]:=m
else begin dig[0]:=0; incr(n);
end;
end;
end;
repeat dig[k]:=n mod 10; n:=n div 10; incr(k);
until n=0;
print_the_digs(k);
end;
@ Here is a trivial procedure to print two digits; it is usually called with
a parameter in the range |0<=n<=99|.
@p procedure print_two(@!n:integer); {prints two least significant digits}
begin n:=abs(n) mod 100; print_char("0"+(n div 10));
print_char("0"+(n mod 10));
end;
@ Hexadecimal printing of nonnegative integers is accomplished by |print_hex|.
@p procedure print_hex(@!n:integer);
{prints a positive integer in hexadecimal form}
var k:0..22; {index to current digit; we assume that $0\L n<16^{22}$}
begin k:=0; print_char("""");
repeat dig[k]:=n mod 16; n:=n div 16; incr(k);
until n=0;
print_the_digs(k);
end;
@ Old versions of \TeX\ needed a procedure called |print_ASCII| whose function
is now subsumed by |print|. We retain the old name here as a possible aid to
future software arch\ae ologists.
@d print_ASCII == print
@ Roman numerals are produced by the |print_roman_int| routine. Readers
who like puzzles might enjoy trying to figure out how this tricky code
works; therefore no explanation will be given. Notice that 1990 yields
\.{mcmxc}, not \.{mxm}.
@p procedure print_roman_int(@!n:integer);
label exit;
var j,@!k: pool_pointer; {mysterious indices into |str_pool|}
@!u,@!v: nonnegative_integer; {mysterious numbers}
begin j:=str_start["m2d5c2l5x2v5i"]; v:=1000;
loop@+ begin while n>=v do
begin print_char(so(str_pool[j])); n:=n-v;
end;
if n<=0 then return; {nonpositive input produces no output}
k:=j+2; u:=v div (so(str_pool[k-1])-"0");
if str_pool[k-1]=si("2") then
begin k:=k+2; u:=u div (so(str_pool[k-1])-"0");
end;
if n+u>=v then
begin print_char(so(str_pool[k])); n:=n+u;
end
else begin j:=j+2; v:=v div (so(str_pool[j-1])-"0");
end;
end;
exit:end;
@ The |print| subroutine will not print a string that is still being
created. The following procedure will.
@p procedure print_current_string; {prints a yet-unmade string}
var j:pool_pointer; {points to current character code}
begin j:=str_start[str_ptr];
while j<pool_ptr do
begin print_char(so(str_pool[j])); incr(j);
end;
end;
@ Here is a procedure that asks the user to type a line of input,
assuming that the |selector| setting is either |term_only| or |term_and_log|.
The input is placed into locations |first| through |last-1| of the
|buffer| array, and echoed on the transcript file if appropriate.
This procedure is never called when |interaction<scroll_mode|.
@d prompt_input(#)==begin wake_up_terminal; print(#); term_input;
end {prints a string and gets a line of input}
@p procedure term_input; {gets a line from the terminal}
var k:0..buf_size; {index into |buffer|}
begin update_terminal; {now the user sees the prompt for sure}
if not input_ln(term_in,true) then fatal_error("End of file on the terminal!");
@.End of file on the terminal@>
term_offset:=0; {the user's line ended with \<\rm return>}
decr(selector); {prepare to echo the input}
if last<>first then for k:=first to last-1 do print(buffer[k]);
print_ln; incr(selector); {restore previous status}
end;
@* \[6] Reporting errors.
When something anomalous is detected, \TeX\ typically does something like this:
$$\vbox{\halign{#\hfil\cr
|print_err("Something anomalous has been detected");|\cr
|help3("This is the first line of my offer to help.")|\cr
|("This is the second line. I'm trying to")|\cr
|("explain the best way for you to proceed.");|\cr
|error;|\cr}}$$
A two-line help message would be given using |help2|, etc.; these informal
helps should use simple vocabulary that complements the words used in the
official error message that was printed. (Outside the U.S.A., the help
messages should preferably be translated into the local vernacular. Each
line of help is at most 60 characters long, in the present implementation,
so that |max_print_line| will not be exceeded.)
The |print_err| procedure supplies a `\.!' before the official message,
and makes sure that the terminal is awake if a stop is going to occur.
The |error| procedure supplies a `\..' after the official message, then it
shows the location of the error; and if |interaction=error_stop_mode|,
it also enters into a dialog with the user, during which time the help
message may be printed.
@^system dependencies@>
@ The global variable |interaction| has four settings, representing increasing
amounts of user interaction:
@d batch_mode=0 {omits all stops and omits terminal output}
@d nonstop_mode=1 {omits all stops}
@d scroll_mode=2 {omits error stops}
@d error_stop_mode=3 {stops at every opportunity to interact}
@d print_err(#)==begin if interaction=error_stop_mode then wake_up_terminal;
print_nl("! "); print(#);
end
@<Glob...@>=
@!interaction:batch_mode..error_stop_mode; {current level of interaction}
@ @<Set init...@>=interaction:=error_stop_mode;
@ \TeX\ is careful not to call |error| when the print |selector| setting
might be unusual. The only possible values of |selector| at the time of
error messages are
\yskip\hang|no_print| (when |interaction=batch_mode|
and |log_file| not yet open);
\hang|term_only| (when |interaction>batch_mode| and |log_file| not yet open);
\hang|log_only| (when |interaction=batch_mode| and |log_file| is open);
\hang|term_and_log| (when |interaction>batch_mode| and |log_file| is open).
@<Initialize the print |selector| based on |interaction|@>=
if interaction=batch_mode then selector:=no_print@+else selector:=term_only
@ A global variable |deletions_allowed| is set |false| if the |get_next|
routine is active when |error| is called; this ensures that |get_next|
and related routines like |get_token| will never be called recursively.
A similar interlock is provided by |set_box_allowed|.
@^recursion@>
The global variable |history| records the worst level of error that
has been detected. It has four possible values: |spotless|, |warning_issued|,
|error_message_issued|, and |fatal_error_stop|.
Another global variable, |error_count|, is increased by one when an
|error| occurs without an interactive dialog, and it is reset to zero at
the end of every paragraph. If |error_count| reaches 100, \TeX\ decides
that there is no point in continuing further.
@d spotless=0 {|history| value when nothing has been amiss yet}
@d warning_issued=1 {|history| value when |begin_diagnostic| has been called}
@d error_message_issued=2 {|history| value when |error| has been called}
@d fatal_error_stop=3 {|history| value when termination was premature}
@<Glob...@>=
@!deletions_allowed:boolean; {is it safe for |error| to call |get_token|?}
@!set_box_allowed:boolean; {is it safe to do a \.{\\setbox} assignment?}
@!history:spotless..fatal_error_stop; {has the source input been clean so far?}
@!error_count:-1..100; {the number of scrolled errors since the
last paragraph ended}
@ The value of |history| is initially |fatal_error_stop|, but it will
be changed to |spotless| if \TeX\ survives the initialization process.
@<Set init...@>=
deletions_allowed:=true; set_box_allowed:=true;
error_count:=0; {|history| is initialized elsewhere}
@ Since errors can be detected almost anywhere in \TeX, we want to declare the
error procedures near the beginning of the program. But the error procedures
in turn use some other procedures, which need to be declared |forward|
before we get to |error| itself.
It is possible for |error| to be called recursively if some error arises
when |get_token| is being used to delete a token, and/or if some fatal error
occurs while \TeX\ is trying to fix a non-fatal one. But such recursion
@^recursion@>
is never more than two levels deep.
@<Error handling...@>=
procedure@?normalize_selector; forward;@t\2@>@/
procedure@?get_token; forward;@t\2@>@/
procedure@?term_input; forward;@t\2@>@/
procedure@?show_context; forward;@t\2@>@/
procedure@?begin_file_reading; forward;@t\2@>@/
procedure@?open_log_file; forward;@t\2@>@/
procedure@?close_files_and_terminate; forward;@t\2@>@/
procedure@?clear_for_error_prompt; forward;@t\2@>@/
procedure@?give_err_help; forward;@t\2@>@/
@t\4\hskip-\fontdimen2\font@>@;@+@!debug@+procedure@?debug_help;
forward;@;@+gubed
@ Individual lines of help are recorded in the array |help_line|, which
contains entries in positions |0..(help_ptr-1)|. They should be printed
in reverse order, i.e., with |help_line[0]| appearing last.
@d hlp1(#)==help_line[0]:=#;@+end
@d hlp2(#)==help_line[1]:=#; hlp1
@d hlp3(#)==help_line[2]:=#; hlp2
@d hlp4(#)==help_line[3]:=#; hlp3
@d hlp5(#)==help_line[4]:=#; hlp4
@d hlp6(#)==help_line[5]:=#; hlp5
@d help0==help_ptr:=0 {sometimes there might be no help}
@d help1==@+begin help_ptr:=1; hlp1 {use this with one help line}
@d help2==@+begin help_ptr:=2; hlp2 {use this with two help lines}
@d help3==@+begin help_ptr:=3; hlp3 {use this with three help lines}
@d help4==@+begin help_ptr:=4; hlp4 {use this with four help lines}
@d help5==@+begin help_ptr:=5; hlp5 {use this with five help lines}
@d help6==@+begin help_ptr:=6; hlp6 {use this with six help lines}
@<Glob...@>=
@!help_line:array[0..5] of str_number; {helps for the next |error|}
@!help_ptr:0..6; {the number of help lines present}
@!use_err_help:boolean; {should the |err_help| list be shown?}
@ @<Set init...@>=
help_ptr:=0; use_err_help:=false;
@ The |jump_out| procedure just cuts across all active procedure levels and
goes to |end_of_TEX|. This is the only nontrivial |@!goto| statement in the
whole program. It is used when there is no recovery from a particular error.
Some \PASCAL\ compilers do not implement non-local |goto| statements.
@^system dependencies@>
In such cases the body of |jump_out| should simply be
`|close_files_and_terminate|;\thinspace' followed by a call on some system
procedure that quietly terminates the program.
@<Error hand...@>=
procedure jump_out;
begin goto end_of_TEX;
end;
@ Here now is the general |error| routine.
@<Error hand...@>=
procedure error; {completes the job of error reporting}
label continue,exit;
var c:ASCII_code; {what the user types}
@!s1,@!s2,@!s3,@!s4:integer;
{used to save global variables when deleting tokens}
begin if history<error_message_issued then history:=error_message_issued;
print_char("."); show_context;
if interaction=error_stop_mode then
@<Get user's advice and |return|@>;
incr(error_count);
if error_count=100 then
begin print_nl("(That makes 100 errors; please try again.)");
@.That makes 100 errors...@>
history:=fatal_error_stop; jump_out;
end;
@<Put help message on the transcript file@>;
exit:end;
@ @<Get user's advice...@>=
loop@+begin continue: if interaction<>error_stop_mode then return;
clear_for_error_prompt; prompt_input("? ");
@.?\relax@>
if last=first then return;
c:=buffer[first];
if c>="a" then c:=c+"A"-"a"; {convert to uppercase}
@<Interpret code |c| and |return| if done@>;
end
@ It is desirable to provide an `\.E' option here that gives the user
an easy way to return from \TeX\ to the system editor, with the offending
line ready to be edited. But such an extension requires some system
wizardry, so the present implementation simply types out the name of the
file that should be
edited and the relevant line number.
@^system dependencies@>
There is a secret `\.D' option available when the debugging routines haven't
been commented~out.
@^debugging@>
@<Interpret code |c| and |return| if done@>=
case c of
"0","1","2","3","4","5","6","7","8","9": if deletions_allowed then
@<Delete \(c)|c-"0"| tokens and |goto continue|@>;
@t\4\4@>@;@+@!debug "D": begin debug_help; goto continue;@+end;@+gubed@/
"E": if base_ptr>0 then if input_stack[base_ptr].name_field>=256 then
begin print_nl("You want to edit file ");
@.You want to edit file x@>
slow_print(input_stack[base_ptr].name_field);
print(" at line "); print_int(line);
interaction:=scroll_mode; jump_out;
end;
"H": @<Print the help information and |goto continue|@>;
"I":@<Introduce new material from the terminal and |return|@>;
"Q","R","S":@<Change the interaction level and |return|@>;
"X":begin interaction:=scroll_mode; jump_out;
end;
othercases do_nothing
endcases;@/
@<Print the menu of available options@>
@ @<Print the menu...@>=
begin print("Type <return> to proceed, S to scroll future error messages,");@/
@.Type <return> to proceed...@>
print_nl("R to run without stopping, Q to run quietly,");@/
print_nl("I to insert something, ");
if base_ptr>0 then if input_stack[base_ptr].name_field>=256 then
print("E to edit your file,");
if deletions_allowed then
print_nl("1 or ... or 9 to ignore the next 1 to 9 tokens of input,");
print_nl("H for help, X to quit.");
end
@ Here the author of \TeX\ apologizes for making use of the numerical
relation between |"Q"|, |"R"|, |"S"|, and the desired interaction settings
|batch_mode|, |nonstop_mode|, |scroll_mode|.
@^Knuth, Donald Ervin@>
@<Change the interaction...@>=
begin error_count:=0; interaction:=batch_mode+c-"Q";
print("OK, entering ");
case c of
"Q":begin print_esc("batchmode"); decr(selector);
end;
"R":print_esc("nonstopmode");
"S":print_esc("scrollmode");
end; {there are no other cases}
print("..."); print_ln; update_terminal; return;
end
@ When the following code is executed, |buffer[(first+1)..(last-1)]| may
contain the material inserted by the user; otherwise another prompt will
be given. In order to understand this part of the program fully, you need
to be familiar with \TeX's input stacks.
@<Introduce new material...@>=
begin begin_file_reading; {enter a new syntactic level for terminal input}
{now |state=mid_line|, so an initial blank space will count as a blank}
if last>first+1 then
begin loc:=first+1; buffer[first]:=" ";
end
else begin prompt_input("insert>"); loc:=first;
@.insert>@>
end;
first:=last;
cur_input.limit_field:=last-1; {no |end_line_char| ends this line}
return;
end
@ We allow deletion of up to 99 tokens at a time.
@<Delete \(c)|c-"0"| tokens...@>=
begin s1:=cur_tok; s2:=cur_cmd; s3:=cur_chr; s4:=align_state;
align_state:=1000000; OK_to_interrupt:=false;
if (last>first+1) and (buffer[first+1]>="0")and(buffer[first+1]<="9") then
c:=c*10+buffer[first+1]-"0"*11
else c:=c-"0";
while c>0 do
begin get_token; {one-level recursive call of |error| is possible}
decr(c);
end;
cur_tok:=s1; cur_cmd:=s2; cur_chr:=s3; align_state:=s4; OK_to_interrupt:=true;
help2("I have just deleted some text, as you asked.")@/
("You can now delete more, or insert, or whatever.");
show_context; goto continue;
end
@ @<Print the help info...@>=
begin if use_err_help then
begin give_err_help; use_err_help:=false;
end
else begin if help_ptr=0 then
help2("Sorry, I don't know how to help in this situation.")@/
@t\kern1em@>("Maybe you should try asking a human?");
repeat decr(help_ptr); print(help_line[help_ptr]); print_ln;
until help_ptr=0;
end;
help4("Sorry, I already gave what help I could...")@/
("Maybe you should try asking a human?")@/
("An error might have occurred before I noticed any problems.")@/
("``If all else fails, read the instructions.''");@/
goto continue;
end
@ @<Put help message on the transcript file@>=
if interaction>batch_mode then decr(selector); {avoid terminal output}
if use_err_help then
begin print_ln; give_err_help;
end
else while help_ptr>0 do
begin decr(help_ptr); print_nl(help_line[help_ptr]);
end;
print_ln;
if interaction>batch_mode then incr(selector); {re-enable terminal output}
print_ln
@ A dozen or so error messages end with a parenthesized integer, so we
save a teeny bit of program space by declaring the following procedure:
@p procedure int_error(@!n:integer);
begin print(" ("); print_int(n); print_char(")"); error;
end;
@ In anomalous cases, the print selector might be in an unknown state;
the following subroutine is called to fix things just enough to keep
running a bit longer.
@p procedure normalize_selector;
begin if log_opened then selector:=term_and_log
else selector:=term_only;
if job_name=0 then open_log_file;
if interaction=batch_mode then decr(selector);
end;
@ The following procedure prints \TeX's last words before dying.
@d succumb==begin if interaction=error_stop_mode then
interaction:=scroll_mode; {no more interaction}
if log_opened then error;
@!debug if interaction>batch_mode then debug_help;@+gubed@;@/
history:=fatal_error_stop; jump_out; {irrecoverable error}
end
@<Error hand...@>=
procedure fatal_error(@!s:str_number); {prints |s|, and that's it}
begin normalize_selector;@/
print_err("Emergency stop"); help1(s); succumb;
@.Emergency stop@>
end;
@ Here is the most dreaded error message.
@<Error hand...@>=
procedure overflow(@!s:str_number;@!n:integer); {stop due to finiteness}
begin normalize_selector;
print_err("TeX capacity exceeded, sorry [");
@.TeX capacity exceeded ...@>
print(s); print_char("="); print_int(n); print_char("]");
help2("If you really absolutely need more capacity,")@/
("you can ask a wizard to enlarge me.");
succumb;
end;
@ The program might sometime run completely amok, at which point there is
no choice but to stop. If no previous error has been detected, that's bad
news; a message is printed that is really intended for the \TeX\
maintenance person instead of the user (unless the user has been
particularly diabolical). The index entries for `this can't happen' may
help to pinpoint the problem.
@^dry rot@>
@<Error hand...@>=
procedure confusion(@!s:str_number);
{consistency check violated; |s| tells where}
begin normalize_selector;
if history<error_message_issued then
begin print_err("This can't happen ("); print(s); print_char(")");
@.This can't happen@>
help1("I'm broken. Please show this to someone who can fix can fix");
end
else begin print_err("I can't go on meeting you like this");
@.I can't go on...@>
help2("One of your faux pas seems to have wounded me deeply...")@/
("in fact, I'm barely conscious. Please fix it and try again.");
end;
succumb;
end;
@ Users occasionally want to interrupt \TeX\ while it's running.
If the \PASCAL\ runtime system allows this, one can implement
a routine that sets the global variable |interrupt| to some nonzero value
when such an interrupt is signalled. Otherwise there is probably at least
a way to make |interrupt| nonzero using the \PASCAL\ debugger.
@^system dependencies@>
@^debugging@>
@d check_interrupt==begin if interrupt<>0 then pause_for_instructions;
end
@<Global...@>=
@!interrupt:integer; {should \TeX\ pause for instructions?}
@!OK_to_interrupt:boolean; {should interrupts be observed?}
@ @<Set init...@>=
interrupt:=0; OK_to_interrupt:=true;
@ When an interrupt has been detected, the program goes into its
highest interaction level and lets the user have nearly the full flexibility of
the |error| routine. \TeX\ checks for interrupts only at times when it is
safe to do this.
@p procedure pause_for_instructions;
begin if OK_to_interrupt then
begin interaction:=error_stop_mode;
if (selector=log_only)or(selector=no_print) then
incr(selector);
print_err("Interruption");
@.Interruption@>
help3("You rang?")@/
("Try to insert an instruction for me (e.g., `I\showlists'),")@/
("unless you just want to quit by typing `X'.");
deletions_allowed:=false; error; deletions_allowed:=true;
interrupt:=0;
end;
end;
@* \[7] Arithmetic with scaled dimensions.
The principal computations performed by \TeX\ are done entirely in terms of
integers less than $2^{31}$ in magnitude; and divisions are done only when both
dividend and divisor are nonnegative. Thus, the arithmetic specified in this
program can be carried out in exactly the same way on a wide variety of
computers, including some small ones. Why? Because the arithmetic
calculations need to be spelled out precisely in order to guarantee that
\TeX\ will produce identical output on different machines. If some
quantities were rounded differently in different implementations, we would
find that line breaks and even page breaks might occur in different places.
Hence the arithmetic of \TeX\ has been designed with care, and systems that
claim to be implementations of \TeX82 should follow precisely the
@:TeX82}{\TeX82@>
calculations as they appear in the present program.
(Actually there are three places where \TeX\ uses |div| with a possibly negative
numerator. These are harmless; see |div| in the index. Also if the user
sets the \.{\\time} or the \.{\\year} to a negative value, some diagnostic
information will involve negative-numerator division. The same remarks
apply for |mod| as well as for |div|.)
@ Here is a routine that calculates half of an integer, using an
unambiguous convention with respect to signed odd numbers.
@p function half(@!x:integer):integer;
begin if odd(x) then half:=(x+1) div 2
else half:=x @!div 2;
end;
@ Fixed-point arithmetic is done on {\sl scaled integers\/} that are multiples
of $2^{-16}$. In other words, a binary point is assumed to be sixteen bit
positions from the right end of a binary computer word.
@d unity == @'200000 {$2^{16}$, represents 1.00000}
@d two == @'400000 {$2^{17}$, represents 2.00000}
@<Types...@>=
@!scaled = integer; {this type is used for scaled integers}
@!nonnegative_integer=0..@'17777777777; {$0\L x<2^{31}$}
@!small_number=0..63; {this type is self-explanatory}
@ The following function is used to create a scaled integer from a given decimal
fraction $(.d_0d_1\ldots d_{k-1})$, where |0<=k<=17|. The digit $d_i$ is
given in |dig[i]|, and the calculation produces a correctly rounded result.
@p function round_decimals(@!k:small_number) : scaled;
{converts a decimal fraction}
var a:integer; {the accumulator}
begin a:=0;
while k>0 do
begin decr(k); a:=(a+dig[k]*two) div 10;
end;
round_decimals:=(a+1) div 2;
end;
@ Conversely, here is a procedure analogous to |print_int|. If the output
of this procedure is subsequently read by \TeX\ and converted by the
|round_decimals| routine above, it turns out that the original value will
be reproduced exactly; the ``simplest'' such decimal number is output,
but there is always at least one digit following the decimal point.
The invariant relation in the \&{repeat} loop is that a sequence of
decimal digits yet to be printed will yield the original number if and only if
they form a fraction~$f$ in the range $s-\delta\L10\cdot2^{16}f<s$.
We can stop if and only if $f=0$ satisfies this condition; the loop will
terminate before $s$ can possibly become zero.
@p procedure print_scaled(@!s:scaled); {prints scaled real, rounded to five
digits}
var delta:scaled; {amount of allowable inaccuracy}
begin if s<0 then
begin print_char("-"); negate(s); {print the sign, if negative}
end;
print_int(s div unity); {print the integer part}
print_char(".");
s:=10*(s mod unity)+5; delta:=10;
repeat if delta>unity then s:=s+@'100000-50000; {round the last digit}
print_char("0"+(s div unity)); s:=10*(s mod unity); delta:=delta*10;
until s<=delta;
end;
@ Physical sizes that a \TeX\ user specifies for portions of documents are
represented internally as scaled points. Thus, if we define an `sp' (scaled
@^sp@>
point) as a unit equal to $2^{-16}$ printer's points, every dimension
inside of \TeX\ is an integer number of sp. There are exactly
4,736,286.72 sp per inch. Users are not allowed to specify dimensions
larger than $2^{30}-1$ sp, which is a distance of about 18.892 feet (5.7583
meters); two such quantities can be added without overflow on a 32-bit
computer.
The present implementation of \TeX\ does not check for overflow when
@^overflow in arithmetic@>
dimensions are added or subtracted. This could be done by inserting a
few dozen tests of the form `\ignorespaces|if x>=@'10000000000 then
@t\\{report\_overflow}@>|', but the chance of overflow is so remote that
such tests do not seem worthwhile.
\TeX\ needs to do only a few arithmetic operations on scaled quantities,
other than addition and subtraction, and the following subroutines do most of
the work. A single computation might use several subroutine calls, and it is
desirable to avoid producing multiple error messages in case of arithmetic
overflow; so the routines set the global variable |arith_error| to |true|
instead of reporting errors directly to the user. Another global variable,
|remainder|, holds the remainder after a division.
@<Glob...@>=
@!arith_error:boolean; {has arithmetic overflow occurred recently?}
@!remainder:scaled; {amount subtracted to get an exact division}
@ The first arithmetical subroutine we need computes $nx+y$, where |x|
and~|y| are |scaled| and |n| is an integer. We will also use it to
multiply integers.
@d nx_plus_y(#)==mult_and_add(#,@'7777777777)
@d mult_integers(#)==mult_and_add(#,0,@'17777777777)
@p function mult_and_add(@!n:integer;@!x,@!y,@!max_answer:scaled):scaled;
begin if n<0 then
begin negate(x); negate(n);
end;
if n=0 then mult_and_add:=y
else if ((x<=(max_answer-y) div n)and(-x<=(max_answer+y) div n)) then
mult_and_add:=n*x+y
else begin arith_error:=true; mult_and_add:=0;
end;
end;
@ We also need to divide scaled dimensions by integers.
@p function x_over_n(@!x:scaled;@!n:integer):scaled;
var negative:boolean; {should |remainder| be negated?}
begin negative:=false;
if n=0 then
begin arith_error:=true; x_over_n:=0; remainder:=x;
end
else begin if n<0 then
begin negate(x); negate(n); negative:=true;
end;
if x>=0 then
begin x_over_n:=x div n; remainder:=x mod n;
end
else begin x_over_n:=-((-x) div n); remainder:=-((-x) mod n);
end;
end;
if negative then negate(remainder);
end;
@ Then comes the multiplication of a scaled number by a fraction |n/d|,
where |n| and |d| are nonnegative integers |<=@t$2^{16}$@>| and |d| is
positive. It would be too dangerous to multiply by~|n| and then divide
by~|d|, in separate operations, since overflow might well occur; and it
would be too inaccurate to divide by |d| and then multiply by |n|. Hence
this subroutine simulates 1.5-precision arithmetic.
@p function xn_over_d(@!x:scaled; @!n,@!d:integer):scaled;
var positive:boolean; {was |x>=0|?}
@!t,@!u,@!v:nonnegative_integer; {intermediate quantities}
begin if x>=0 then positive:=true
else begin negate(x); positive:=false;
end;
t:=(x mod @'100000)*n;
u:=(x div @'100000)*n+(t div @'100000);
v:=(u mod d)*@'100000 + (t mod @'100000);
if u div d>=@'100000 then arith_error:=true
else u:=@'100000*(u div d) + (v div d);
if positive then
begin xn_over_d:=u; remainder:=v mod d;
end
else begin xn_over_d:=-u; remainder:=-(v mod d);
end;
end;
@ The next subroutine is used to compute the ``badness'' of glue, when a
total~|t| is supposed to be made from amounts that sum to~|s|. According
to {\sl The \TeX book}, the badness of this situation is $100(t/s)^3$;
however, badness is simply a heuristic, so we need not squeeze out the
last drop of accuracy when computing it. All we really want is an
approximation that has similar properties.
@:TeXbook}{\sl The \TeX book@>
The actual method used to compute the badness is easier to read from the
program than to describe in words. It produces an integer value that is a
reasonably close approximation to $100(t/s)^3$, and all implementations
of \TeX\ should use precisely this method. Any badness of $2^{13}$ or more is
treated as infinitely bad, and represented by 10000.
It is not difficult to prove that $$\hbox{|badness(t+1,s)>=badness(t,s)
>=badness(t,s+1)|}.$$ The badness function defined here is capable of
computing at most 1095 distinct values, but that is plenty.
@d inf_bad = 10000 {infinitely bad value}
@p function badness(@!t,@!s:scaled):halfword; {compute badness, given |t>=0|}
var r:integer; {approximation to $\alpha t/s$, where $\alpha^3\approx
100\cdot2^{18}$}
begin if t=0 then badness:=0
else if s<=0 then badness:=inf_bad
else begin if t<=7230584 then r:=(t*297) div s {$297^3=99.94\times2^{18}$}
else if s>=1663497 then r:=t div (s div 297)
else r:=t;
if r>1290 then badness:=inf_bad {$1290^3<2^{31}<1291^3$}
else badness:=(r*r*r+@'400000) div @'1000000;
end; {that was $r^3/2^{18}$, rounded to the nearest integer}
end;
@ When \TeX\ ``packages'' a list into a box, it needs to calculate the
proportionality ratio by which the glue inside the box should stretch
or shrink. This calculation does not affect \TeX's decision making,
so the precise details of rounding, etc., in the glue calculation are not
of critical importance for the consistency of results on different computers.
We shall use the type |glue_ratio| for such proportionality ratios.
A glue ratio should take the same amount of memory as an
|integer| (usually 32 bits) if it is to blend smoothly with \TeX's
other data structures. Thus |glue_ratio| should be equivalent to
|short_real| in some implementations of \PASCAL. Alternatively,
it is possible to deal with glue ratios using nothing but fixed-point
arithmetic; see {\sl TUGboat \bf3},1 (March 1982), 10--27. (But the
routines cited there must be modified to allow negative glue ratios.)
@^system dependencies@>
@d set_glue_ratio_zero(#) == #:=0.0 {store the representation of zero ratio}
@d set_glue_ratio_one(#) == #:=1.0 {store the representation of unit ratio}
@d float(#) == # {convert from |glue_ratio| to type |real|}
@d unfloat(#) == # {convert from |real| to type |glue_ratio|}
@d float_constant(#) == #.0 {convert |integer| constant to |real|}
@<Types...@>=
@!glue_ratio=real; {one-word representation of a glue expansion factor}
@* \[7b] Random numbers.
%
\font\tenlogo=logo10 % font used for the METAFONT logo
\def\MP{{\tenlogo META}\-{\tenlogo POST}}
%
This section is (almost) straight from \MP. I had to change
the types (use |integer| instead of |fraction|), but that should
not have any influence on the actual calculations (the original
comments refer to quantities like |fraction_four| ($2^{30}$), and
that is the same as the numeric representation of |maxdimen|).
I've copied the low-level variables and routines that are needed, but
only those (e.g.~|m_log|), not the accompanying ones like |m_exp|. Most
of the following low-level numeric routines are only needed within the
calculation of |norm_rand|. I've been forced to rename |make_fraction|
to |make_frac| because TeX already has a routine by that name with
a wholly different function (it creates a |fraction_noad| for math
typesetting) -- Taco.
And now let's complete our collection of numeric utility routines
by considering random number generation.
\MP\ generates pseudo-random numbers with the additive scheme recommended
in Section 3.6 of {\sl The Art of Computer Programming}; however, the
results are random fractions between 0 and |fraction_one-1|, inclusive.
There's an auxiliary array |randoms| that contains 55 pseudo-random
fractions. Using the recurrence $x_n=(x_{n-55}-x_{n-31})\bmod 2^{28}$,
we generate batches of 55 new $x_n$'s at a time by calling |new_randoms|.
The global variable |j_random| tells which element has most recently
been consumed.
@<Glob...@>=
@!randoms:array[0..54] of integer; {the last 55 random values generated}
@!j_random:0..54; {the number of unused |randoms|}
@!random_seed:scaled; {the default random seed}
@ A small bit of \MF\ is needed.
@d fraction_half==@'1000000000 {$2^{27}$, represents 0.50000000}
@d fraction_one==@'2000000000 {$2^{28}$, represents 1.00000000}
@d fraction_four==@'10000000000 {$2^{30}$, represents 4.00000000}
@d el_gordo == @'17777777777 {$2^{31}-1$, the largest value that \MP\ likes}
@d halfp(#)==(#) div 2
@d double(#) == #:=#+# {multiply a variable by two}
@ The |make_frac| routine produces the |fraction| equivalent of
|p/q|, given integers |p| and~|q|; it computes the integer
$f=\lfloor2^{28}p/q+{1\over2}\rfloor$, when $p$ and $q$ are
positive. If |p| and |q| are both of the same scaled type |t|,
the ``type relation'' |make_frac(t,t)=fraction| is valid;
and it's also possible to use the subroutine ``backwards,'' using
the relation |make_frac(t,fraction)=t| between scaled types.
If the result would have magnitude $2^{31}$ or more, |make_frac|
sets |arith_error:=true|. Most of \MP's internal computations have
been designed to avoid this sort of error.
If this subroutine were programmed in assembly language on a typical
machine, we could simply compute |(@t$2^{28}$@>*p)div q|, since a
double-precision product can often be input to a fixed-point division
instruction. But when we are restricted to \PASCAL\ arithmetic it
is necessary either to resort to multiple-precision maneuvering
or to use a simple but slow iteration. The multiple-precision technique
would be about three times faster than the code adopted here, but it
would be comparatively long and tricky, involving about sixteen
additional multiplications and divisions.
This operation is part of \MP's ``inner loop''; indeed, it will
consume nearly 10\pct! of the running time (exclusive of input and output)
if the code below is left unchanged. A machine-dependent recoding
will therefore make \MP\ run faster. The present implementation
is highly portable, but slow; it avoids multiplication and division
except in the initial stage. System wizards should be careful to
replace it with a routine that is guaranteed to produce identical
results in all cases.
@^system dependencies@>
As noted below, a few more routines should also be replaced by machine-dependent
code, for efficiency. But when a procedure is not part of the ``inner loop,''
such changes aren't advisable; simplicity and robustness are
preferable to trickery, unless the cost is too high.
@^inner loop@>
@p function make_frac(@!p,@!q:integer):integer;
var @!f:integer; {the fraction bits, with a leading 1 bit}
@!n:integer; {the integer part of $\vert p/q\vert$}
@!negative:boolean; {should the result be negated?}
@!be_careful:integer; {disables certain compiler optimizations}
begin if p>=0 then negative:=false
else begin negate(p); negative:=true;
end;
if q<=0 then
begin debug if q=0 then confusion("/");@;@+gubed@;@/
@:this can't happen /}{\quad \./@>
negate(q); negative:=not negative;
end;
n:=p div q; p:=p mod q;
if n>=8 then
begin arith_error:=true;
if negative then make_frac:=-el_gordo@+else make_frac:=el_gordo;
end
else begin n:=(n-1)*fraction_one;
@<Compute $f=\lfloor 2^{28}(1+p/q)+{1\over2}\rfloor$@>;
if negative then make_frac:=-(f+n)@+else make_frac:=f+n;
end;
end;
@ The |repeat| loop here preserves the following invariant relations
between |f|, |p|, and~|q|:
(i)~|0<=p<q|; (ii)~$fq+p=2^k(q+p_0)$, where $k$ is an integer and
$p_0$ is the original value of~$p$.
Notice that the computation specifies
|(p-q)+p| instead of |(p+p)-q|, because the latter could overflow.
Let us hope that optimizing compilers do not miss this point; a
special variable |be_careful| is used to emphasize the necessary
order of computation. Optimizing compilers should keep |be_careful|
in a register, not store it in memory.
@^inner loop@>
@<Compute $f=\lfloor 2^{28}(1+p/q)+{1\over2}\rfloor$@>=
f:=1;
repeat be_careful:=p-q; p:=be_careful+p;
if p>=0 then f:=f+f+1
else begin double(f); p:=p+q;
end;
until f>=fraction_one;
be_careful:=p-q;
if be_careful+p>=0 then incr(f)
@
@p function take_frac(@!q:integer;@!f:integer):integer;
var @!p:integer; {the fraction so far}
@!negative:boolean; {should the result be negated?}
@!n:integer; {additional multiple of $q$}
@!be_careful:integer; {disables certain compiler optimizations}
begin @<Reduce to the case that |f>=0| and |q>0|@>;
if f<fraction_one then n:=0
else begin n:=f div fraction_one; f:=f mod fraction_one;
if q<=el_gordo div n then n:=n*q
else begin arith_error:=true; n:=el_gordo;
end;
end;
f:=f+fraction_one;
@<Compute $p=\lfloor qf/2^{28}+{1\over2}\rfloor-q$@>;
be_careful:=n-el_gordo;
if be_careful+p>0 then
begin arith_error:=true; n:=el_gordo-p;
end;
if negative then take_frac:=-(n+p)
else take_frac:=n+p;
end;
@ @<Reduce to the case that |f>=0| and |q>0|@>=
if f>=0 then negative:=false
else begin negate(f); negative:=true;
end;
if q<0 then
begin negate(q); negative:=not negative;
end;
@ The invariant relations in this case are (i)~$\lfloor(qf+p)/2^k\rfloor
=\lfloor qf_0/2^{28}+{1\over2}\rfloor$, where $k$ is an integer and
$f_0$ is the original value of~$f$; (ii)~$2^k\L f<2^{k+1}$.
@^inner loop@>
@<Compute $p=\lfloor qf/2^{28}+{1\over2}\rfloor-q$@>=
p:=fraction_half; {that's $2^{27}$; the invariants hold now with $k=28$}
if q<fraction_four then
repeat if odd(f) then p:=halfp(p+q)@+else p:=halfp(p);
f:=halfp(f);
until f=1
else repeat if odd(f) then p:=p+halfp(q-p)@+else p:=halfp(p);
f:=halfp(f);
until f=1
@ The subroutines for logarithm and exponential involve two tables.
The first is simple: |two_to_the[k]| equals $2^k$. The second involves
a bit more calculation, which the author claims to have done correctly:
|spec_log[k]| is $2^{27}$ times $\ln\bigl(1/(1-2^{-k})\bigr)=
2^{-k}+{1\over2}2^{-2k}+{1\over3}2^{-3k}+\cdots\,$, rounded to the
nearest integer.
@<Glob...@>=
@!two_to_the:array[0..30] of integer; {powers of two}
@!spec_log:array[1..28] of integer; {special logarithms}
@ @<Set init...@>=
two_to_the[0]:=1;
for k:=1 to 30 do two_to_the[k]:=2*two_to_the[k-1];
spec_log[1]:=93032640;
spec_log[2]:=38612034;
spec_log[3]:=17922280;
spec_log[4]:=8662214;
spec_log[5]:=4261238;
spec_log[6]:=2113709;
spec_log[7]:=1052693;
spec_log[8]:=525315;
spec_log[9]:=262400;
spec_log[10]:=131136;
spec_log[11]:=65552;
spec_log[12]:=32772;
spec_log[13]:=16385;
for k:=14 to 27 do spec_log[k]:=two_to_the[27-k];
spec_log[28]:=1;
@
@p function m_log(@!x:integer):integer;
var @!y,@!z:integer; {auxiliary registers}
@!k:integer; {iteration counter}
begin if x<=0 then @<Handle non-positive logarithm@>
else begin y:=1302456956+4-100; {$14\times2^{27}\ln2\approx1302456956.421063$}
z:=27595+6553600; {and $2^{16}\times .421063\approx 27595$}
while x<fraction_four do
begin double(x); y:=y-93032639; z:=z-48782;
end; {$2^{27}\ln2\approx 93032639.74436163$
and $2^{16}\times.74436163\approx 48782$}
y:=y+(z div unity); k:=2;
while x>fraction_four+4 do
@<Increase |k| until |x| can be multiplied by a
factor of $2^{-k}$, and adjust $y$ accordingly@>;
m_log:=y div 8;
end;
end;
@ @<Increase |k| until |x| can...@>=
begin z:=((x-1) div two_to_the[k])+1; {$z=\lceil x/2^k\rceil$}
while x<fraction_four+z do
begin z:=halfp(z+1); k:=k+1;
end;
y:=y+spec_log[k]; x:=x-z;
end
@ @<Handle non-positive logarithm@>=
begin print_err("Logarithm of ");
@.Logarithm...replaced by 0@>
print_scaled(x); print(" has been replaced by 0");
help2("Since I don't take logs of non-positive numbers,")@/
("I'm zeroing this one. Proceed, with fingers crossed.");
error; m_log:=0;
end
@ The following somewhat different subroutine tests rigorously if $ab$ is
greater than, equal to, or less than~$cd$,
given integers $(a,b,c,d)$. In most cases a quick decision is reached.
The result is $+1$, 0, or~$-1$ in the three respective cases.
@d return_sign(#)==begin ab_vs_cd:=#; return;
end
@p function ab_vs_cd(@!a,b,c,d:integer):integer;
label exit;
var @!q,@!r:integer; {temporary registers}
begin @<Reduce to the case that |a,c>=0|, |b,d>0|@>;
loop@+ begin q := a div d; r := c div b;
if q<>r then
if q>r then return_sign(1)@+else return_sign(-1);
q := a mod d; r := c mod b;
if r=0 then
if q=0 then return_sign(0)@+else return_sign(1);
if q=0 then return_sign(-1);
a:=b; b:=q; c:=d; d:=r;
end; {now |a>d>0| and |c>b>0|}
exit:end;
@ @<Reduce to the case that |a...@>=
if a<0 then
begin negate(a); negate(b);
end;
if c<0 then
begin negate(c); negate(d);
end;
if d<=0 then
begin if b>=0 then
if ((a=0)or(b=0))and((c=0)or(d=0)) then return_sign(0)
else return_sign(1);
if d=0 then
if a=0 then return_sign(0)@+else return_sign(-1);
q:=a; a:=c; c:=q; q:=-b; b:=-d; d:=q;
end
else if b<=0 then
begin if b<0 then if a>0 then return_sign(-1);
if c=0 then return_sign(0) else return_sign(-1);
end
@ To consume a random integer, the program below will say `|next_random|'
and then it will fetch |randoms[j_random]|.
@d next_random==if j_random=0 then new_randoms
else decr(j_random)
@p procedure new_randoms;
var @!k:0..54; {index into |randoms|}
@!x:integer; {accumulator}
begin for k:=0 to 23 do
begin x:=randoms[k]-randoms[k+31];
if x<0 then x:=x+fraction_one;
randoms[k]:=x;
end;
for k:=24 to 54 do
begin x:=randoms[k]-randoms[k-24];
if x<0 then x:=x+fraction_one;
randoms[k]:=x;
end;
j_random:=54;
end;
@ To initialize the |randoms| table, we call the following routine.
@p procedure init_randoms(@!seed:integer);
var @!j,@!jj,@!k:integer; {more or less random integers}
@!i:0..54; {index into |randoms|}
begin j:=abs(seed);
while j>=fraction_one do j:=halfp(j);
k:=1;
for i:=0 to 54 do
begin jj:=k; k:=j-k; j:=jj;
if k<0 then k:=k+fraction_one;
randoms[(i*21)mod 55]:=j;
end;
new_randoms; new_randoms; new_randoms; {``warm up'' the array}
end;
@ To produce a uniform random number in the range |0<=u<x| or |0>=u>x|
or |0=u=x|, given a |scaled| value~|x|, we proceed as shown here.
Note that the call of |take_frac| will produce the values 0 and~|x|
with about half the probability that it will produce any other particular
values between 0 and~|x|, because it rounds its answers.
@p function unif_rand(@!x:integer):integer;
var @!y:integer; {trial value}
begin next_random; y:=take_frac(abs(x),randoms[j_random]);
if y=abs(x) then unif_rand:=0
else if x>0 then unif_rand:=y
else unif_rand:=-y;
end;
@ Finally, a normal deviate with mean zero and unit standard deviation
can readily be obtained with the ratio method (Algorithm 3.4.1R in
{\sl The Art of Computer Programming\/}).
@p function norm_rand:integer;
var @!x,@!u,@!l:integer; {what the book would call $2^{16}X$, $2^{28}U$,
and $-2^{24}\ln U$}
begin repeat
repeat next_random;
x:=take_frac(112429,randoms[j_random]-fraction_half);
{$2^{16}\sqrt{8/e}\approx 112428.82793$}
next_random; u:=randoms[j_random];
until abs(x)<u;
x:=make_frac(x,u);
l:=139548960-m_log(u); {$2^{24}\cdot12\ln2\approx139548959.6165$}
until ab_vs_cd(1024,l,x,x)>=0;
norm_rand:=x;
end;
@* \[8] Packed data.
In order to make efficient use of storage space, \TeX\ bases its major data
structures on a |memory_word|, which contains either a (signed) integer,
possibly scaled, or a (signed) |glue_ratio|, or a small number of
fields that are one half or one quarter of the size used for storing
integers.
If |x| is a variable of type |memory_word|, it contains up to four
fields that can be referred to as follows:
$$\vbox{\halign{\hfil#&#\hfil&#\hfil\cr
|x|&.|int|&(an |integer|)\cr
|x|&.|sc|\qquad&(a |scaled| integer)\cr
|x|&.|gr|&(a |glue_ratio|)\cr
|x.hh.lh|, |x.hh|&.|rh|&(two halfword fields)\cr
|x.hh.b0|, |x.hh.b1|, |x.hh|&.|rh|&(two quarterword fields, one halfword
field)\cr
|x.qqqq.b0|, |x.qqqq.b1|, |x.qqqq|&.|b2|, |x.qqqq.b3|\hskip-100pt
&\qquad\qquad\qquad(four quarterword fields)\cr}}$$
This is somewhat cumbersome to write, and not very readable either, but
macros will be used to make the notation shorter and more transparent.
The \PASCAL\ code below gives a formal definition of |memory_word| and
its subsidiary types, using packed variant records. \TeX\ makes no
assumptions about the relative positions of the fields within a word.
Since we are assuming 32-bit integers, a halfword must contain at least
16 bits, and a quarterword must contain at least 8 bits.
@^system dependencies@>
But it doesn't hurt to have more bits; for example, with enough 36-bit
words you might be able to have |mem_max| as large as 262142, which is
eight times as much memory as anybody had during the first four years of
\TeX's existence.
N.B.: Valuable memory space will be dreadfully wasted unless \TeX\ is compiled
by a \PASCAL\ that packs all of the |memory_word| variants into
the space of a single integer. This means, for example, that |glue_ratio|
words should be |short_real| instead of |real| on some computers. Some
\PASCAL\ compilers will pack an integer whose subrange is `|0..255|' into
an eight-bit field, but others insist on allocating space for an additional
sign bit; on such systems you can get 256 values into a quarterword only
if the subrange is `|-128..127|'.
The present implementation tries to accommodate as many variations as possible,
so it makes few assumptions. If integers having the subrange
`|min_quarterword..max_quarterword|' can be packed into a quarterword,
and if integers having the subrange `|min_halfword..max_halfword|'
can be packed into a halfword, everything should work satisfactorily.
It is usually most efficient to have |min_quarterword=min_halfword=0|,
so one should try to achieve this unless it causes a severe problem.
The values defined here are recommended for most 32-bit computers.
@d min_quarterword=0 {smallest allowable value in a |quarterword|}
@d max_quarterword=255 {largest allowable value in a |quarterword|}
@d min_halfword==0 {smallest allowable value in a |halfword|}
@d max_halfword==65535 {largest allowable value in a |halfword|}
@ Here are the inequalities that the quarterword and halfword values
must satisfy (or rather, the inequalities that they mustn't satisfy):
@<Check the ``constant''...@>=
init if (mem_min<>mem_bot)or(mem_max<>mem_top) then bad:=10;@+tini@;@/
if (mem_min>mem_bot)or(mem_max<mem_top) then bad:=10;
if (min_quarterword>0)or(max_quarterword<127) then bad:=11;
if (min_halfword>0)or(max_halfword<32767) then bad:=12;
if (min_quarterword<min_halfword)or@|
(max_quarterword>max_halfword) then bad:=13;
if (mem_min<min_halfword)or(mem_max>=max_halfword)or@|
(mem_bot-mem_min>max_halfword+1) then bad:=14;
if (font_base<min_quarterword)or(font_max>max_quarterword) then bad:=15;
if font_max>font_base+256 then bad:=16;
if (save_size>max_halfword)or(max_strings>max_halfword) then bad:=17;
if buf_size>max_halfword then bad:=18;
if max_quarterword-min_quarterword<255 then bad:=19;
@ The operation of adding or subtracting |min_quarterword| occurs quite
frequently in \TeX, so it is convenient to abbreviate this operation
by using the macros |qi| and |qo| for input and output to and from
quarterword format.
The inner loop of \TeX\ will run faster with respect to compilers
that don't optimize expressions like `|x+0|' and `|x-0|', if these
macros are simplified in the obvious way when |min_quarterword=0|.
@^inner loop@>@^system dependencies@>
@d qi(#)==#+min_quarterword
{to put an |eight_bits| item into a quarterword}
@d qo(#)==#-min_quarterword
{to take an |eight_bits| item out of a quarterword}
@d hi(#)==#+min_halfword
{to put a sixteen-bit item into a halfword}
@d ho(#)==#-min_halfword
{to take a sixteen-bit item from a halfword}
@ The reader should study the following definitions closely:
@^system dependencies@>
@d sc==int {|scaled| data is equivalent to |integer|}
@<Types...@>=
@!quarterword = min_quarterword..max_quarterword; {1/4 of a word}
@!halfword=min_halfword..max_halfword; {1/2 of a word}
@!two_choices = 1..2; {used when there are two variants in a record}
@!four_choices = 1..4; {used when there are four variants in a record}
@!two_halves = packed record@;@/
@!rh:halfword;
case two_choices of
1: (@!lh:halfword);
2: (@!b0:quarterword; @!b1:quarterword);
end;
@!four_quarters = packed record@;@/
@!b0:quarterword;
@!b1:quarterword;
@!b2:quarterword;
@!b3:quarterword;
end;
@!memory_word = record@;@/
case four_choices of
1: (@!int:integer);
2: (@!gr:glue_ratio);
3: (@!hh:two_halves);
4: (@!qqqq:four_quarters);
end;
@!word_file = file of memory_word;
@ When debugging, we may want to print a |memory_word| without knowing
what type it is; so we print it in all modes.
@^dirty \PASCAL@>@^debugging@>
@p @!debug procedure print_word(@!w:memory_word);
{prints |w| in all ways}
begin print_int(w.int); print_char(" ");@/
print_scaled(w.sc); print_char(" ");@/
print_scaled(round(unity*float(w.gr))); print_ln;@/
@^real multiplication@>
print_int(w.hh.lh); print_char("="); print_int(w.hh.b0); print_char(":");
print_int(w.hh.b1); print_char(";"); print_int(w.hh.rh); print_char(" ");@/
print_int(w.qqqq.b0); print_char(":"); print_int(w.qqqq.b1); print_char(":");
print_int(w.qqqq.b2); print_char(":"); print_int(w.qqqq.b3);
end;
gubed
@* \[9] Dynamic memory allocation.
The \TeX\ system does nearly all of its own memory allocation, so that it
can readily be transported into environments that do not have automatic
facilities for strings, garbage collection, etc., and so that it can be in
control of what error messages the user receives. The dynamic storage
requirements of \TeX\ are handled by providing a large array |mem| in
which consecutive blocks of words are used as nodes by the \TeX\ routines.
Pointer variables are indices into this array, or into another array
called |eqtb| that will be explained later. A pointer variable might
also be a special flag that lies outside the bounds of |mem|, so we
allow pointers to assume any |halfword| value. The minimum halfword
value represents a null pointer. \TeX\ does not assume that |mem[null]| exists.
@d pointer==halfword {a flag or a location in |mem| or |eqtb|}
@d null==min_halfword {the null pointer}
@<Glob...@>=
@!temp_ptr:pointer; {a pointer variable for occasional emergency use}
@ The |mem| array is divided into two regions that are allocated separately,
but the dividing line between these two regions is not fixed; they grow
together until finding their ``natural'' size in a particular job.
Locations less than or equal to |lo_mem_max| are used for storing
variable-length records consisting of two or more words each. This region
is maintained using an algorithm similar to the one described in exercise
2.5--19 of {\sl The Art of Computer Programming}. However, no size field
appears in the allocated nodes; the program is responsible for knowing the
relevant size when a node is freed. Locations greater than or equal to
|hi_mem_min| are used for storing one-word records; a conventional
\.{AVAIL} stack is used for allocation in this region.
Locations of |mem| between |mem_bot| and |mem_top| may be dumped as part
of preloaded format files, by the \.{INITEX} preprocessor.
@.INITEX@>
Production versions of \TeX\ may extend the memory at both ends in order to
provide more space; locations between |mem_min| and |mem_bot| are always
used for variable-size nodes, and locations between |mem_top| and |mem_max|
are always used for single-word nodes.
The key pointers that govern |mem| allocation have a prescribed order:
$$\advance\thickmuskip-2mu
\hbox{|null<=mem_min<=mem_bot<lo_mem_max<
hi_mem_min<mem_top<=mem_end<=mem_max|.}$$
Empirical tests show that the present implementation of \TeX\ tends to
spend about 9\pct! of its running time allocating nodes, and about 6\pct!
deallocating them after their use.
@<Glob...@>=
@!mem : array[mem_min..mem_max] of memory_word; {the big dynamic storage area}
@!lo_mem_max : pointer; {the largest location of variable-size memory in use}
@!hi_mem_min : pointer; {the smallest location of one-word memory in use}
@ In order to study the memory requirements of particular applications, it
is possible to prepare a version of \TeX\ that keeps track of current and
maximum memory usage. When code between the delimiters |@!stat| $\ldots$
|tats| is not ``commented out,'' \TeX\ will run a bit slower but it will
report these statistics when |tracing_stats| is sufficiently large.
@<Glob...@>=
@!var_used, @!dyn_used : integer; {how much memory is in use}
@ Let's consider the one-word memory region first, since it's the
simplest. The pointer variable |mem_end| holds the highest-numbered location
of |mem| that has ever been used. The free locations of |mem| that
occur between |hi_mem_min| and |mem_end|, inclusive, are of type
|two_halves|, and we write |info(p)| and |link(p)| for the |lh|
and |rh| fields of |mem[p]| when it is of this type. The single-word
free locations form a linked list
$$|avail|,\;\hbox{|link(avail)|},\;\hbox{|link(link(avail))|},\;\ldots$$
terminated by |null|.
@d link(#) == mem[#].hh.rh {the |link| field of a memory word}
@d info(#) == mem[#].hh.lh {the |info| field of a memory word}
@<Glob...@>=
@!avail : pointer; {head of the list of available one-word nodes}
@!mem_end : pointer; {the last one-word node used in |mem|}
@ If memory is exhausted, it might mean that the user has forgotten
a right brace. We will define some procedures later that try to help
pinpoint the trouble.
@p @<Declare the procedure called |show_token_list|@>@/
@<Declare the procedure called |runaway|@>
@ The function |get_avail| returns a pointer to a new one-word node whose
|link| field is null. However, \TeX\ will halt if there is no more room left.
@^inner loop@>
If the available-space list is empty, i.e., if |avail=null|,
we try first to increase |mem_end|. If that cannot be done, i.e., if
|mem_end=mem_max|, we try to decrease |hi_mem_min|. If that cannot be
done, i.e., if |hi_mem_min=lo_mem_max+1|, we have to quit.
@p function get_avail : pointer; {single-word node allocation}
var p:pointer; {the new node being got}
begin p:=avail; {get top location in the |avail| stack}
if p<>null then avail:=link(avail) {and pop it off}
else if mem_end<mem_max then {or go into virgin territory}
begin incr(mem_end); p:=mem_end;
end
else begin decr(hi_mem_min); p:=hi_mem_min;
if hi_mem_min<=lo_mem_max then
begin runaway; {if memory is exhausted, display possible runaway text}
overflow("main memory size",mem_max+1-mem_min);
{quit; all one-word nodes are busy}
@:TeX capacity exceeded main memory size}{\quad main memory size@>
end;
end;
link(p):=null; {provide an oft-desired initialization of the new node}
@!stat incr(dyn_used);@+tats@;{maintain statistics}
get_avail:=p;
end;
@ Conversely, a one-word node is recycled by calling |free_avail|.
This routine is part of \TeX's ``inner loop,'' so we want it to be fast.
@^inner loop@>
@d free_avail(#)== {single-word node liberation}
begin link(#):=avail; avail:=#;
@!stat decr(dyn_used);@+tats@/
end
@ There's also a |fast_get_avail| routine, which saves the procedure-call
overhead at the expense of extra programming. This routine is used in
the places that would otherwise account for the most calls of |get_avail|.
@^inner loop@>
@d fast_get_avail(#)==@t@>@;@/
begin #:=avail; {avoid |get_avail| if possible, to save time}
if #=null then #:=get_avail
else begin avail:=link(#); link(#):=null;
@!stat incr(dyn_used);@+tats@/
end;
end
@ The procedure |flush_list(p)| frees an entire linked list of
one-word nodes that starts at position |p|.
@^inner loop@>
@p procedure flush_list(@!p:pointer); {makes list of single-word nodes
available}
var @!q,@!r:pointer; {list traversers}
begin if p<>null then
begin r:=p;
repeat q:=r; r:=link(r); @!stat decr(dyn_used);@+tats@/
until r=null; {now |q| is the last node on the list}
link(q):=avail; avail:=p;
end;
end;
@ The available-space list that keeps track of the variable-size portion
of |mem| is a nonempty, doubly-linked circular list of empty nodes,
pointed to by the roving pointer |rover|.
Each empty node has size 2 or more; the first word contains the special
value |max_halfword| in its |link| field and the size in its |info| field;
the second word contains the two pointers for double linking.
Each nonempty node also has size 2 or more. Its first word is of type
|two_halves|\kern-1pt, and its |link| field is never equal to |max_halfword|.
Otherwise there is complete flexibility with respect to the contents
of its other fields and its other words.
(We require |mem_max<max_halfword| because terrible things can happen
when |max_halfword| appears in the |link| field of a nonempty node.)
@d empty_flag == max_halfword {the |link| of an empty variable-size node}
@d is_empty(#) == (link(#)=empty_flag) {tests for empty node}
@d node_size == info {the size field in empty variable-size nodes}
@d llink(#) == info(#+1) {left link in doubly-linked list of empty nodes}
@d rlink(#) == link(#+1) {right link in doubly-linked list of empty nodes}
@<Glob...@>=
@!rover : pointer; {points to some node in the list of empties}
@ A call to |get_node| with argument |s| returns a pointer to a new node
of size~|s|, which must be 2~or more. The |link| field of the first word
of this new node is set to null. An overflow stop occurs if no suitable
space exists.
If |get_node| is called with $s=2^{30}$, it simply merges adjacent free
areas and returns the value |max_halfword|.
@p function get_node(@!s:integer):pointer; {variable-size node allocation}
label found,exit,restart;
var p:pointer; {the node currently under inspection}
@!q:pointer; {the node physically after node |p|}
@!r:integer; {the newly allocated node, or a candidate for this honor}
@!t:integer; {temporary register}
begin restart: p:=rover; {start at some free node in the ring}
repeat @<Try to allocate within node |p| and its physical successors,
and |goto found| if allocation was possible@>;
@^inner loop@>
p:=rlink(p); {move to the next node in the ring}
until p=rover; {repeat until the whole list has been traversed}
if s=@'10000000000 then
begin get_node:=max_halfword; return;
end;
if lo_mem_max+2<hi_mem_min then if lo_mem_max+2<=mem_bot+max_halfword then
@<Grow more variable-size memory and |goto restart|@>;
overflow("main memory size",mem_max+1-mem_min);
{sorry, nothing satisfactory is left}
@:TeX capacity exceeded main memory size}{\quad main memory size@>
found: link(r):=null; {this node is now nonempty}
@!stat var_used:=var_used+s; {maintain usage statistics}
tats@;@/
get_node:=r;
exit:end;
@ The lower part of |mem| grows by 1000 words at a time, unless
we are very close to going under. When it grows, we simply link
a new node into the available-space list. This method of controlled
growth helps to keep the |mem| usage consecutive when \TeX\ is
implemented on ``virtual memory'' systems.
@^virtual memory@>
@<Grow more variable-size memory and |goto restart|@>=
begin if hi_mem_min-lo_mem_max>=1998 then t:=lo_mem_max+1000
else t:=lo_mem_max+1+(hi_mem_min-lo_mem_max) div 2;
{|lo_mem_max+2<=t<hi_mem_min|}
p:=llink(rover); q:=lo_mem_max; rlink(p):=q; llink(rover):=q;@/
if t>mem_bot+max_halfword then t:=mem_bot+max_halfword;
rlink(q):=rover; llink(q):=p; link(q):=empty_flag; node_size(q):=t-lo_mem_max;@/
lo_mem_max:=t; link(lo_mem_max):=null; info(lo_mem_max):=null;
rover:=q; goto restart;
end
@ Empirical tests show that the routine in this section performs a
node-merging operation about 0.75 times per allocation, on the average,
after which it finds that |r>p+1| about 95\pct! of the time.
@<Try to allocate...@>=
q:=p+node_size(p); {find the physical successor}
@^inner loop@>
while is_empty(q) do {merge node |p| with node |q|}
begin t:=rlink(q);
if q=rover then rover:=t;
llink(t):=llink(q); rlink(llink(q)):=t;@/
q:=q+node_size(q);
end;
r:=q-s;
if r>p+1 then @<Allocate from the top of node |p| and |goto found|@>;
if r=p then if rlink(p)<>p then
@<Allocate entire node |p| and |goto found|@>;
node_size(p):=q-p {reset the size in case it grew}
@ @<Allocate from the top...@>=
begin node_size(p):=r-p; {store the remaining size}
@^inner loop@>
rover:=p; {start searching here next time}
goto found;
end
@ Here we delete node |p| from the ring, and let |rover| rove around.
@<Allocate entire...@>=
begin rover:=rlink(p); t:=llink(p);
llink(rover):=t; rlink(t):=rover;
goto found;
end
@ Conversely, when some variable-size node |p| of size |s| is no longer needed,
the operation |free_node(p,s)| will make its words available, by inserting
|p| as a new empty node just before where |rover| now points.
@^inner loop@>
@p procedure free_node(@!p:pointer; @!s:halfword); {variable-size node
liberation}
var q:pointer; {|llink(rover)|}
begin node_size(p):=s; link(p):=empty_flag;
q:=llink(rover); llink(p):=q; rlink(p):=rover; {set both links}
llink(rover):=p; rlink(q):=p; {insert |p| into the ring}
@!stat var_used:=var_used-s;@+tats@;{maintain statistics}
end;
@ Just before \.{INITEX} writes out the memory, it sorts the doubly linked
available space list. The list is probably very short at such times, so a
simple insertion sort is used. The smallest available location will be
pointed to by |rover|, the next-smallest by |rlink(rover)|, etc.
@p @!init procedure sort_avail; {sorts the available variable-size nodes
by location}
var p,@!q,@!r: pointer; {indices into |mem|}
@!old_rover:pointer; {initial |rover| setting}
begin p:=get_node(@'10000000000); {merge adjacent free areas}
p:=rlink(rover); rlink(rover):=max_halfword; old_rover:=rover;
while p<>old_rover do @<Sort \(p)|p| into the list starting at |rover|
and advance |p| to |rlink(p)|@>;
p:=rover;
while rlink(p)<>max_halfword do
begin llink(rlink(p)):=p; p:=rlink(p);
end;
rlink(p):=rover; llink(rover):=p;
end;
tini
@ The following |while| loop is guaranteed to
terminate, since the list that starts at
|rover| ends with |max_halfword| during the sorting procedure.
@<Sort \(p)|p|...@>=
if p<rover then
begin q:=p; p:=rlink(q); rlink(q):=rover; rover:=q;
end
else begin q:=rover;
while rlink(q)<p do q:=rlink(q);
r:=rlink(p); rlink(p):=rlink(q); rlink(q):=p; p:=r;
end
@* \[10] Data structures for boxes and their friends.
From the computer's standpoint, \TeX's chief mission is to create
horizontal and vertical lists. We shall now investigate how the elements
of these lists are represented internally as nodes in the dynamic memory.
A horizontal or vertical list is linked together by |link| fields in
the first word of each node. Individual nodes represent boxes, glue,
penalties, or special things like discretionary hyphens; because of this
variety, some nodes are longer than others, and we must distinguish different
kinds of nodes. We do this by putting a `|type|' field in the first word,
together with the link and an optional `|subtype|'.
@d type(#) == mem[#].hh.b0 {identifies what kind of node this is}
@d subtype(#) == mem[#].hh.b1 {secondary identification in some cases}
@ A |@!char_node|, which represents a single character, is the most important
kind of node because it accounts for the vast majority of all boxes.
Special precautions are therefore taken to ensure that a |char_node| does
not take up much memory space. Every such node is one word long, and in fact
it is identifiable by this property, since other kinds of nodes have at least
two words, and they appear in |mem| locations less than |hi_mem_min|.
This makes it possible to omit the |type| field in a |char_node|, leaving
us room for two bytes that identify a |font| and a |character| within
that font.
Note that the format of a |char_node| allows for up to 256 different
fonts and up to 256 characters per font; but most implementations will
probably limit the total number of fonts to fewer than 75 per job,
and most fonts will stick to characters whose codes are
less than 128 (since higher codes
are more difficult to access on most keyboards).
Extensions of \TeX\ intended for oriental languages will need even more
than $256\times256$ possible characters, when we consider different sizes
@^oriental characters@>@^Chinese characters@>@^Japanese characters@>
and styles of type. It is suggested that Chinese and Japanese fonts be
handled by representing such characters in two consecutive |char_node|
entries: The first of these has |font=font_base|, and its |link| points
to the second;
the second identifies the font and the character dimensions.
The saving feature about oriental characters is that most of them have
the same box dimensions. The |character| field of the first |char_node|
is a ``\\{charext}'' that distinguishes between graphic symbols whose
dimensions are identical for typesetting purposes. (See the \MF\ manual.)
Such an extension of \TeX\ would not be difficult; further details are
left to the reader.
In order to make sure that the |character| code fits in a quarterword,
\TeX\ adds the quantity |min_quarterword| to the actual code.
Character nodes appear only in horizontal lists, never in vertical lists.
@d is_char_node(#) == (#>=hi_mem_min)
{does the argument point to a |char_node|?}
@d font == type {the font code in a |char_node|}
@d character == subtype {the character code in a |char_node|}
@ An |hlist_node| stands for a box that was made from a horizontal list.
Each |hlist_node| is seven words long, and contains the following fields
(in addition to the mandatory |type| and |link|, which we shall not
mention explicitly when discussing the other node types): The |height| and
|width| and |depth| are scaled integers denoting the dimensions of the
box. There is also a |shift_amount| field, a scaled integer indicating
how much this box should be lowered (if it appears in a horizontal list),
or how much it should be moved to the right (if it appears in a vertical
list). There is a |list_ptr| field, which points to the beginning of the
list from which this box was fabricated; if |list_ptr| is |null|, the box
is empty. Finally, there are three fields that represent the setting of
the glue: |glue_set(p)| is a word of type |glue_ratio| that represents
the proportionality constant for glue setting; |glue_sign(p)| is
|stretching| or |shrinking| or |normal| depending on whether or not the
glue should stretch or shrink or remain rigid; and |glue_order(p)|
specifies the order of infinity to which glue setting applies (|normal|,
|fil|, |fill|, or |filll|). The |subtype| field is not used in \TeX.
In \eTeX\ the |subtype| field records the box direction mode |box_lr|.
@d hlist_node=0 {|type| of hlist nodes}
@d box_node_size=7 {number of words to allocate for a box node}
@d width_offset=1 {position of |width| field in a box node}
@d depth_offset=2 {position of |depth| field in a box node}
@d height_offset=3 {position of |height| field in a box node}
@d width(#) == mem[#+width_offset].sc {width of the box, in sp}
@d depth(#) == mem[#+depth_offset].sc {depth of the box, in sp}
@d height(#) == mem[#+height_offset].sc {height of the box, in sp}
@d shift_amount(#) == mem[#+4].sc {repositioning distance, in sp}
@d list_offset=5 {position of |list_ptr| field in a box node}
@d list_ptr(#) == link(#+list_offset) {beginning of the list inside the box}
@d glue_order(#) == subtype(#+list_offset) {applicable order of infinity}
@d glue_sign(#) == type(#+list_offset) {stretching or shrinking}
@d normal=0 {the most common case when several cases are named}
@d stretching = 1 {glue setting applies to the stretch components}
@d shrinking = 2 {glue setting applies to the shrink components}
@d glue_offset = 6 {position of |glue_set| in a box node}
@d glue_set(#) == mem[#+glue_offset].gr
{a word of type |glue_ratio| for glue setting}
@ The |new_null_box| function returns a pointer to an |hlist_node| in
which all subfields have the values corresponding to `\.{\\hbox\{\}}'.
(The |subtype| field is set to |min_quarterword|, for historic reasons
that are no longer relevant.)
@p function new_null_box:pointer; {creates a new box node}
var p:pointer; {the new node}
begin p:=get_node(box_node_size); type(p):=hlist_node;
subtype(p):=min_quarterword;
width(p):=0; depth(p):=0; height(p):=0; shift_amount(p):=0; list_ptr(p):=null;
glue_sign(p):=normal; glue_order(p):=normal; set_glue_ratio_zero(glue_set(p));
new_null_box:=p;
end;
@ A |vlist_node| is like an |hlist_node| in all respects except that it
contains a vertical list.
@d vlist_node=1 {|type| of vlist nodes}
@ A |rule_node| stands for a solid black rectangle; it has |width|,
|depth|, and |height| fields just as in an |hlist_node|. However, if
any of these dimensions is $-2^{30}$, the actual value will be determined
by running the rule up to the boundary of the innermost enclosing box.
This is called a ``running dimension.'' The |width| is never running in
an hlist; the |height| and |depth| are never running in a~vlist.
@d rule_node=2 {|type| of rule nodes}
@d rule_node_size=4 {number of words to allocate for a rule node}
@d null_flag==-@'10000000000 {$-2^{30}$, signifies a missing item}
@d is_running(#) == (#=null_flag) {tests for a running dimension}
@ A new rule node is delivered by the |new_rule| function. It
makes all the dimensions ``running,'' so you have to change the
ones that are not allowed to run.
@p function new_rule:pointer;
var p:pointer; {the new node}
begin p:=get_node(rule_node_size); type(p):=rule_node;
subtype(p):=0; {the |subtype| is not used}
width(p):=null_flag; depth(p):=null_flag; height(p):=null_flag;
new_rule:=p;
end;
@ Insertions are represented by |ins_node| records, where the |subtype|
indicates the corresponding box number. For example, `\.{\\insert 250}'
leads to an |ins_node| whose |subtype| is |250+min_quarterword|.
The |height| field of an |ins_node| is slightly misnamed; it actually holds
the natural height plus depth of the vertical list being inserted.
The |depth| field holds the |split_max_depth| to be used in case this
insertion is split, and the |split_top_ptr| points to the corresponding
|split_top_skip|. The |float_cost| field holds the |floating_penalty| that
will be used if this insertion floats to a subsequent page after a
split insertion of the same class. There is one more field, the
|ins_ptr|, which points to the beginning of the vlist for the insertion.
@d ins_node=3 {|type| of insertion nodes}
@d ins_node_size=5 {number of words to allocate for an insertion}
@d float_cost(#)==mem[#+1].int {the |floating_penalty| to be used}
@d ins_ptr(#)==info(#+4) {the vertical list to be inserted}
@d split_top_ptr(#)==link(#+4) {the |split_top_skip| to be used}
@ A |mark_node| has a |mark_ptr| field that points to the reference count
of a token list that contains the user's \.{\\mark} text.
In addition there is a |mark_class| field that contains the mark class.
@d mark_node=4 {|type| of a mark node}
@d small_node_size=2 {number of words to allocate for most node types}
@d mark_ptr(#)==link(#+1) {head of the token list for a mark}
@d mark_class(#)==info(#+1) {the mark class}
@ An |adjust_node|, which occurs only in horizontal lists,
specifies material that will be moved out into the surrounding
vertical list; i.e., it is used to implement \TeX's `\.{\\vadjust}'
operation. The |adjust_ptr| field points to the vlist containing this
material.
@d adjust_node=5 {|type| of an adjust node}
@d adjust_pre == subtype {<>0 => pre-adjustment}
@#{|append_list| is used to append a list to |tail|}
@d append_list(#) == begin link(tail) := link(#); append_list_end
@d append_list_end(#) == tail := #; end
@d adjust_ptr(#)==mem[#+1].int
{vertical list to be moved out of horizontal list}
@ A |ligature_node|, which occurs only in horizontal lists, specifies
a character that was fabricated from the interaction of two or more
actual characters. The second word of the node, which is called the
|lig_char| word, contains |font| and |character| fields just as in a
|char_node|. The characters that generated the ligature have not been
forgotten, since they are needed for diagnostic messages and for
hyphenation; the |lig_ptr| field points to a linked list of character
nodes for all original characters that have been deleted. (This list
might be empty if the characters that generated the ligature were
retained in other nodes.)
The |subtype| field is 0, plus 2 and/or 1 if the original source of the
ligature included implicit left and/or right boundaries.
@d ligature_node=6 {|type| of a ligature node}
@d lig_char(#)==#+1 {the word where the ligature is to be found}
@d lig_ptr(#)==link(lig_char(#)) {the list of characters}
@ The |new_ligature| function creates a ligature node having given
contents of the |font|, |character|, and |lig_ptr| fields. We also have
a |new_lig_item| function, which returns a two-word node having a given
|character| field. Such nodes are used for temporary processing as ligatures
are being created.
@p function new_ligature(@!f,@!c:quarterword; @!q:pointer):pointer;
var p:pointer; {the new node}
begin p:=get_node(small_node_size); type(p):=ligature_node;
font(lig_char(p)):=f; character(lig_char(p)):=c; lig_ptr(p):=q;
subtype(p):=0; new_ligature:=p;
end;
@#
function new_lig_item(@!c:quarterword):pointer;
var p:pointer; {the new node}
begin p:=get_node(small_node_size); character(p):=c; lig_ptr(p):=null;
new_lig_item:=p;
end;
@ A |disc_node|, which occurs only in horizontal lists, specifies a
``dis\-cretion\-ary'' line break. If such a break occurs at node |p|, the text
that starts at |pre_break(p)| will precede the break, the text that starts at
|post_break(p)| will follow the break, and text that appears in the next
|replace_count(p)| nodes will be ignored. For example, an ordinary
discretionary hyphen, indicated by `\.{\\-}', yields a |disc_node| with
|pre_break| pointing to a |char_node| containing a hyphen, |post_break=null|,
and |replace_count=0|. All three of the discretionary texts must be
lists that consist entirely of character, kern, box, rule, and ligature nodes.
If |pre_break(p)=null|, the |ex_hyphen_penalty| will be charged for this
break. Otherwise the |hyphen_penalty| will be charged. The texts will
actually be substituted into the list by the line-breaking algorithm if it
decides to make the break, and the discretionary node will disappear at
that time; thus, the output routine sees only discretionaries that were
not chosen.
@d disc_node=7 {|type| of a discretionary node}
@d replace_count==subtype {how many subsequent nodes to replace}
@d pre_break==llink {text that precedes a discretionary break}
@d post_break==rlink {text that follows a discretionary break}
@p function new_disc:pointer; {creates an empty |disc_node|}
var p:pointer; {the new node}
begin p:=get_node(small_node_size); type(p):=disc_node;
replace_count(p):=0; pre_break(p):=null; post_break(p):=null;
new_disc:=p;
end;
@ A |whatsit_node| is a wild card reserved for extensions to \TeX. The
|subtype| field in its first word says what `\\{whatsit}' it is, and
implicitly determines the node size (which must be 2 or more) and the
format of the remaining words. When a |whatsit_node| is encountered
in a list, special actions are invoked; knowledgeable people who are
careful not to mess up the rest of \TeX\ are able to make \TeX\ do new
things by adding code at the end of the program. For example, there
might be a `\TeX nicolor' extension to specify different colors of ink,
@^extensions to \TeX@>
and the whatsit node might contain the desired parameters.
The present implementation of \TeX\ treats the features associated with
`\.{\\write}' and `\.{\\special}' as if they were extensions, in order to
illustrate how such routines might be coded. We shall defer further
discussion of extensions until the end of this program.
@d whatsit_node=8 {|type| of special extension nodes}
@ A |math_node|, which occurs only in horizontal lists, appears before and
after mathematical formulas. The |subtype| field is |before| before the
formula and |after| after it. There is a |width| field, which represents
the amount of surrounding space inserted by \.{\\mathsurround}.
In addition a |math_node| with |subtype>after| and |width=0| will be
(ab)used to record a regular |math_node| reinserted after being
discarded at a line break or one of the text direction primitives (
\.{\\beginL}, \.{\\endL}, \.{\\beginR}, and \.{\\endR} ).
@d math_node=9 {|type| of a math node}
@d before=0 {|subtype| for math node that introduces a formula}
@d after=1 {|subtype| for math node that winds up a formula}
@#
@d M_code=2
@d begin_M_code=M_code+before {|subtype| for \.{\\beginM} node}
@d end_M_code=M_code+after {|subtype| for \.{\\endM} node}
@d L_code=4
@d begin_L_code=L_code+begin_M_code {|subtype| for \.{\\beginL} node}
@d end_L_code=L_code+end_M_code {|subtype| for \.{\\endL} node}
@d R_code=L_code+L_code
@d begin_R_code=R_code+begin_M_code {|subtype| for \.{\\beginR} node}
@d end_R_code=R_code+end_M_code {|subtype| for \.{\\endR} node}
@#
@d end_LR(#)==odd(subtype(#))
@d end_LR_type(#)==(L_code*(subtype(#) div L_code)+end_M_code)
@d begin_LR_type(#)==(#-after+before)
@p function new_math(@!w:scaled;@!s:small_number):pointer;
var p:pointer; {the new node}
begin p:=get_node(small_node_size); type(p):=math_node;
subtype(p):=s; width(p):=w; new_math:=p;
end;
@ \TeX\ makes use of the fact that |hlist_node|, |vlist_node|,
|rule_node|, |ins_node|, |mark_node|, |adjust_node|, |ligature_node|,
|disc_node|, |whatsit_node|, and |math_node| are at the low end of the
type codes, by permitting a break at glue in a list if and only if the
|type| of the previous node is less than |math_node|. Furthermore, a
node is discarded after a break if its type is |math_node| or~more.
@d precedes_break(#)==(type(#)<math_node)
@d non_discardable(#)==(type(#)<math_node)
@ A |glue_node| represents glue in a list. However, it is really only
a pointer to a separate glue specification, since \TeX\ makes use of the
fact that many essentially identical nodes of glue are usually present.
If |p| points to a |glue_node|, |glue_ptr(p)| points to
another packet of words that specify the stretch and shrink components, etc.
Glue nodes also serve to represent leaders; the |subtype| is used to
distinguish between ordinary glue (which is called |normal|) and the three
kinds of leaders (which are called |a_leaders|, |c_leaders|, and |x_leaders|).
The |leader_ptr| field points to a rule node or to a box node containing the
leaders; it is set to |null| in ordinary glue nodes.
Many kinds of glue are computed from \TeX's ``skip'' parameters, and
it is helpful to know which parameter has led to a particular glue node.
Therefore the |subtype| is set to indicate the source of glue, whenever
it originated as a parameter. We will be defining symbolic names for the
parameter numbers later (e.g., |line_skip_code=0|, |baseline_skip_code=1|,
etc.); it suffices for now to say that the |subtype| of parametric glue
will be the same as the parameter number, plus~one.
In math formulas there are two more possibilities for the |subtype| in a
glue node: |mu_glue| denotes an \.{\\mskip} (where the units are scaled \.{mu}
instead of scaled \.{pt}); and |cond_math_glue| denotes the `\.{\\nonscript}'
feature that cancels the glue node immediately following if it appears
in a subscript.
@d glue_node=10 {|type| of node that points to a glue specification}
@d cond_math_glue=98 {special |subtype| to suppress glue in the next node}
@d mu_glue=99 {|subtype| for math glue}
@d a_leaders=100 {|subtype| for aligned leaders}
@d c_leaders=101 {|subtype| for centered leaders}
@d x_leaders=102 {|subtype| for expanded leaders}
@d glue_ptr==llink {pointer to a glue specification}
@d leader_ptr==rlink {pointer to box or rule node for leaders}
@ A glue specification has a halfword reference count in its first word,
@^reference counts@>
representing |null| plus the number of glue nodes that point to it (less one).
Note that the reference count appears in the same position as
the |link| field in list nodes; this is the field that is initialized
to |null| when a node is allocated, and it is also the field that is flagged
by |empty_flag| in empty nodes.
Glue specifications also contain three |scaled| fields, for the |width|,
|stretch|, and |shrink| dimensions. Finally, there are two one-byte
fields called |stretch_order| and |shrink_order|; these contain the
orders of infinity (|normal|, |fil|, |fill|, or |filll|)
corresponding to the stretch and shrink values.
@d glue_spec_size=4 {number of words to allocate for a glue specification}
@d glue_ref_count(#) == link(#) {reference count of a glue specification}
@d stretch(#) == mem[#+2].sc {the stretchability of this glob of glue}
@d shrink(#) == mem[#+3].sc {the shrinkability of this glob of glue}
@d stretch_order == type {order of infinity for stretching}
@d shrink_order == subtype {order of infinity for shrinking}
@d fil=1 {first-order infinity}
@d fill=2 {second-order infinity}
@d filll=3 {third-order infinity}
@<Types...@>=
@!glue_ord=normal..filll; {infinity to the 0, 1, 2, or 3 power}
@ Here is a function that returns a pointer to a copy of a glue spec.
The reference count in the copy is |null|, because there is assumed
to be exactly one reference to the new specification.
@p function new_spec(@!p:pointer):pointer; {duplicates a glue specification}
var q:pointer; {the new spec}
begin q:=get_node(glue_spec_size);@/
mem[q]:=mem[p]; glue_ref_count(q):=null;@/
width(q):=width(p); stretch(q):=stretch(p); shrink(q):=shrink(p);
new_spec:=q;
end;
@ And here's a function that creates a glue node for a given parameter
identified by its code number; for example,
|new_param_glue(line_skip_code)| returns a pointer to a glue node for the
current \.{\\lineskip}.
@p function new_param_glue(@!n:small_number):pointer;
var p:pointer; {the new node}
@!q:pointer; {the glue specification}
begin p:=get_node(small_node_size); type(p):=glue_node; subtype(p):=n+1;
leader_ptr(p):=null;@/
q:=@<Current |mem| equivalent of glue parameter number |n|@>@t@>;
glue_ptr(p):=q; incr(glue_ref_count(q));
new_param_glue:=p;
end;
@ Glue nodes that are more or less anonymous are created by |new_glue|,
whose argument points to a glue specification.
@p function new_glue(@!q:pointer):pointer;
var p:pointer; {the new node}
begin p:=get_node(small_node_size); type(p):=glue_node; subtype(p):=normal;
leader_ptr(p):=null; glue_ptr(p):=q; incr(glue_ref_count(q));
new_glue:=p;
end;
@ Still another subroutine is needed: This one is sort of a combination
of |new_param_glue| and |new_glue|. It creates a glue node for one of
the current glue parameters, but it makes a fresh copy of the glue
specification, since that specification will probably be subject to change,
while the parameter will stay put. The global variable |temp_ptr| is
set to the address of the new spec.
@p function new_skip_param(@!n:small_number):pointer;
var p:pointer; {the new node}
begin temp_ptr:=new_spec(@<Current |mem| equivalent of glue parameter...@>);
p:=new_glue(temp_ptr); glue_ref_count(temp_ptr):=null; subtype(p):=n+1;
new_skip_param:=p;
end;
@ A |kern_node| has a |width| field to specify a (normally negative)
amount of spacing. This spacing correction appears in horizontal lists
between letters like A and V when the font designer said that it looks
better to move them closer together or further apart. A kern node can
also appear in a vertical list, when its `|width|' denotes additional
spacing in the vertical direction. The |subtype| is either |normal| (for
kerns inserted from font information or math mode calculations) or |explicit|
(for kerns inserted from \.{\\kern} and \.{\\/} commands) or |acc_kern|
(for kerns inserted from non-math accents) or |mu_glue| (for kerns
inserted from \.{\\mkern} specifications in math formulas).
@d kern_node=11 {|type| of a kern node}
@d explicit=1 {|subtype| of kern nodes from \.{\\kern} and \.{\\/}}
@d acc_kern=2 {|subtype| of kern nodes from accents}
@d auto_kern=3 {|subtype| of kern nodes created by |get_auto_kern|}
@# {memory structure for marginal kerns}
@d margin_kern_node = 40
@d margin_kern_node_size = 3
@d margin_char(#) == info(# + 2)
@# {|subtype| of marginal kerns}
@d left_side == 0
@d right_side == 1
@# {base for lp/rp/ef codes starts from 2:
0 for |hyphen_char|,
1 for |skew_char|}
@d lp_code_base == 2
@d rp_code_base == 3
@d ef_code_base == 4
@d tag_code == 5
@d kn_bs_code_base == 7
@d st_bs_code_base == 8
@d sh_bs_code_base == 9
@d kn_bc_code_base == 10
@d kn_ac_code_base == 11
@d no_lig_code == 6
@d max_hlist_stack = 512 {maximum fill level for |hlist_stack|}
{maybe good if larger than |2 * max_quarterword|, so that box nesting level would overflow first}
@ The |new_kern| function creates a kern node having a given width.
@p function new_kern(@!w:scaled):pointer;
var p:pointer; {the new node}
begin p:=get_node(small_node_size); type(p):=kern_node;
subtype(p):=normal;
width(p):=w;
new_kern:=p;
end;
@ A |penalty_node| specifies the penalty associated with line or page
breaking, in its |penalty| field. This field is a fullword integer, but
the full range of integer values is not used: Any penalty |>=10000| is
treated as infinity, and no break will be allowed for such high values.
Similarly, any penalty |<=-10000| is treated as negative infinity, and a
break will be forced.
@d penalty_node=12 {|type| of a penalty node}
@d inf_penalty=inf_bad {``infinite'' penalty value}
@d eject_penalty=-inf_penalty {``negatively infinite'' penalty value}
@d penalty(#) == mem[#+1].int {the added cost of breaking a list here}
@ Anyone who has been reading the last few sections of the program will
be able to guess what comes next.
@p function new_penalty(@!m:integer):pointer;
var p:pointer; {the new node}
begin p:=get_node(small_node_size); type(p):=penalty_node;
subtype(p):=0; {the |subtype| is not used}
penalty(p):=m; new_penalty:=p;
end;
@ You might think that we have introduced enough node types by now. Well,
almost, but there is one more: An |unset_node| has nearly the same format
as an |hlist_node| or |vlist_node|; it is used for entries in \.{\\halign}
or \.{\\valign} that are not yet in their final form, since the box
dimensions are their ``natural'' sizes before any glue adjustment has been
made. The |glue_set| word is not present; instead, we have a |glue_stretch|
field, which contains the total stretch of order |glue_order| that is
present in the hlist or vlist being boxed.
Similarly, the |shift_amount| field is replaced by a |glue_shrink| field,
containing the total shrink of order |glue_sign| that is present.
The |subtype| field is called |span_count|; an unset box typically
contains the data for |qo(span_count)+1| columns.
Unset nodes will be changed to box nodes when alignment is completed.
@d unset_node=13 {|type| for an unset node}
@d glue_stretch(#)==mem[#+glue_offset].sc {total stretch in an unset node}
@d glue_shrink==shift_amount {total shrink in an unset node}
@d span_count==subtype {indicates the number of spanned columns}
@ In fact, there are still more types coming. When we get to math formula
processing we will see that a |style_node| has |type=14|; and a number
of larger type codes will also be defined, for use in math mode only.
@ Warning: If any changes are made to these data structure layouts, such as
changing any of the node sizes or even reordering the words of nodes,
the |copy_node_list| procedure and the memory initialization code
below may have to be changed. Such potentially dangerous parts of the
program are listed in the index under `data structure assumptions'.
@!@^data structure assumptions@>
However, other references to the nodes are made symbolically in terms of
the \.{WEB} macro definitions above, so that format changes will leave
\TeX's other algorithms intact.
@^system dependencies@>
@* \[11] Memory layout.
Some areas of |mem| are dedicated to fixed usage, since static allocation is
more efficient than dynamic allocation when we can get away with it. For
example, locations |mem_bot| to |mem_bot+3| are always used to store the
specification for glue that is `\.{0pt plus 0pt minus 0pt}'. The
following macro definitions accomplish the static allocation by giving
symbolic names to the fixed positions. Static variable-size nodes appear
in locations |mem_bot| through |lo_mem_stat_max|, and static single-word nodes
appear in locations |hi_mem_stat_min| through |mem_top|, inclusive. It is
harmless to let |lig_trick| and |garbage| share the same location of |mem|.
@d zero_glue==mem_bot {specification for \.{0pt plus 0pt minus 0pt}}
@d fil_glue==zero_glue+glue_spec_size {\.{0pt plus 1fil minus 0pt}}
@d fill_glue==fil_glue+glue_spec_size {\.{0pt plus 1fill minus 0pt}}
@d ss_glue==fill_glue+glue_spec_size {\.{0pt plus 1fil minus 1fil}}
@d fil_neg_glue==ss_glue+glue_spec_size {\.{0pt plus -1fil minus 0pt}}
@d lo_mem_stat_max==fil_neg_glue+glue_spec_size-1 {largest statically
allocated word in the variable-size |mem|}
@#
@d page_ins_head==mem_top {list of insertion data for current page}
@d contrib_head==mem_top-1 {vlist of items not yet on current page}
@d page_head==mem_top-2 {vlist for current page}
@d temp_head==mem_top-3 {head of a temporary list of some kind}
@d hold_head==mem_top-4 {head of a temporary list of another kind}
@d adjust_head==mem_top-5 {head of adjustment list returned by |hpack|}
@d active==mem_top-7 {head of active list in |line_break|, needs two words}
@d align_head==mem_top-8 {head of preamble list for alignments}
@d end_span==mem_top-9 {tail of spanned-width lists}
@d omit_template==mem_top-10 {a constant token list}
@d null_list==mem_top-11 {permanently empty list}
@d lig_trick==mem_top-12 {a ligature masquerading as a |char_node|}
@d garbage==mem_top-12 {used for scrap information}
@d backup_head==mem_top-13 {head of token list built by |scan_keyword|}
@d pre_adjust_head==mem_top-14 {head of pre-adjustment list returned by |hpack|}
@d hi_mem_stat_min==mem_top-14 {smallest statically allocated word in
the one-word |mem|}
@d hi_mem_stat_usage=15 {the number of one-word nodes always present}
@ The following code gets |mem| off to a good start, when \TeX\ is
initializing itself the slow~way.
@<Local variables for init...@>=
@!k:integer; {index into |mem|, |eqtb|, etc.}
@ @<Initialize table entries...@>=
for k:=mem_bot+1 to lo_mem_stat_max do mem[k].sc:=0;
{all glue dimensions are zeroed}
@^data structure assumptions@>
k:=mem_bot;@+while k<=lo_mem_stat_max do
{set first words of glue specifications}
begin glue_ref_count(k):=null+1;
stretch_order(k):=normal; shrink_order(k):=normal;
k:=k+glue_spec_size;
end;
stretch(fil_glue):=unity; stretch_order(fil_glue):=fil;@/
stretch(fill_glue):=unity; stretch_order(fill_glue):=fill;@/
stretch(ss_glue):=unity; stretch_order(ss_glue):=fil;@/
shrink(ss_glue):=unity; shrink_order(ss_glue):=fil;@/
stretch(fil_neg_glue):=-unity; stretch_order(fil_neg_glue):=fil;@/
rover:=lo_mem_stat_max+1;
link(rover):=empty_flag; {now initialize the dynamic memory}
node_size(rover):=1000; {which is a 1000-word available node}
llink(rover):=rover; rlink(rover):=rover;@/
lo_mem_max:=rover+1000; link(lo_mem_max):=null; info(lo_mem_max):=null;@/
for k:=hi_mem_stat_min to mem_top do
mem[k]:=mem[lo_mem_max]; {clear list heads}
@<Initialize the special list heads and constant nodes@>;
avail:=null; mem_end:=mem_top;
hi_mem_min:=hi_mem_stat_min; {initialize the one-word memory}
var_used:=lo_mem_stat_max+1-mem_bot; dyn_used:=hi_mem_stat_usage;
{initialize statistics}
@ If \TeX\ is extended improperly, the |mem| array might get screwed up.
For example, some pointers might be wrong, or some ``dead'' nodes might not
have been freed when the last reference to them disappeared. Procedures
|check_mem| and |search_mem| are available to help diagnose such
problems. These procedures make use of two arrays called |free| and
|was_free| that are present only if \TeX's debugging routines have
been included. (You may want to decrease the size of |mem| while you
@^debugging@>
are debugging.)
@<Glob...@>=
@!debug @!free: packed array [mem_min..mem_max] of boolean; {free cells}
@t\hskip10pt@>@!was_free: packed array [mem_min..mem_max] of boolean;
{previously free cells}
@t\hskip10pt@>@!was_mem_end,@!was_lo_max,@!was_hi_min: pointer;
{previous |mem_end|, |lo_mem_max|, and |hi_mem_min|}
@t\hskip10pt@>@!panicking:boolean; {do we want to check memory constantly?}
gubed
@ @<Set initial...@>=
@!debug was_mem_end:=mem_min; {indicate that everything was previously free}
was_lo_max:=mem_min; was_hi_min:=mem_max;
panicking:=false;
gubed
@ Procedure |check_mem| makes sure that the available space lists of
|mem| are well formed, and it optionally prints out all locations
that are reserved now but were free the last time this procedure was called.
@p @!debug procedure check_mem(@!print_locs : boolean);
label done1,done2; {loop exits}
var p,@!q:pointer; {current locations of interest in |mem|}
@!clobbered:boolean; {is something amiss?}
begin for p:=mem_min to lo_mem_max do free[p]:=false; {you can probably
do this faster}
for p:=hi_mem_min to mem_end do free[p]:=false; {ditto}
@<Check single-word |avail| list@>;
@<Check variable-size |avail| list@>;
@<Check flags of unavailable nodes@>;
if print_locs then @<Print newly busy locations@>;
for p:=mem_min to lo_mem_max do was_free[p]:=free[p];
for p:=hi_mem_min to mem_end do was_free[p]:=free[p];
{|was_free:=free| might be faster}
was_mem_end:=mem_end; was_lo_max:=lo_mem_max; was_hi_min:=hi_mem_min;
end;
gubed
@ @<Check single-word...@>=
p:=avail; q:=null; clobbered:=false;
while p<>null do
begin if (p>mem_end)or(p<hi_mem_min) then clobbered:=true
else if free[p] then clobbered:=true;
if clobbered then
begin print_nl("AVAIL list clobbered at ");
@.AVAIL list clobbered...@>
print_int(q); goto done1;
end;
free[p]:=true; q:=p; p:=link(q);
end;
done1:
@ @<Check variable-size...@>=
p:=rover; q:=null; clobbered:=false;
repeat if (p>=lo_mem_max)or(p<mem_min) then clobbered:=true
else if (rlink(p)>=lo_mem_max)or(rlink(p)<mem_min) then clobbered:=true
else if not(is_empty(p))or(node_size(p)<2)or@|
(p+node_size(p)>lo_mem_max)or@| (llink(rlink(p))<>p) then clobbered:=true;
if clobbered then
begin print_nl("Double-AVAIL list clobbered at ");
print_int(q); goto done2;
end;
for q:=p to p+node_size(p)-1 do {mark all locations free}
begin if free[q] then
begin print_nl("Doubly free location at ");
@.Doubly free location...@>
print_int(q); goto done2;
end;
free[q]:=true;
end;
q:=p; p:=rlink(p);
until p=rover;
done2:
@ @<Check flags...@>=
p:=mem_min;
while p<=lo_mem_max do {node |p| should not be empty}
begin if is_empty(p) then
begin print_nl("Bad flag at "); print_int(p);
@.Bad flag...@>
end;
while (p<=lo_mem_max) and not free[p] do incr(p);
while (p<=lo_mem_max) and free[p] do incr(p);
end
@ @<Print newly busy...@>=
begin print_nl("New busy locs:");
for p:=mem_min to lo_mem_max do
if not free[p] and ((p>was_lo_max) or was_free[p]) then
begin print_char(" "); print_int(p);
end;
for p:=hi_mem_min to mem_end do
if not free[p] and
((p<was_hi_min) or (p>was_mem_end) or was_free[p]) then
begin print_char(" "); print_int(p);
end;
end
@ The |search_mem| procedure attempts to answer the question ``Who points
to node~|p|?'' In doing so, it fetches |link| and |info| fields of |mem|
that might not be of type |two_halves|. Strictly speaking, this is
@^dirty \PASCAL@>
undefined in \PASCAL, and it can lead to ``false drops'' (words that seem to
point to |p| purely by coincidence). But for debugging purposes, we want
to rule out the places that do {\sl not\/} point to |p|, so a few false
drops are tolerable.
@p @!debug procedure search_mem(@!p:pointer); {look for pointers to |p|}
var q:integer; {current position being searched}
begin for q:=mem_min to lo_mem_max do
begin if link(q)=p then
begin print_nl("LINK("); print_int(q); print_char(")");
end;
if info(q)=p then
begin print_nl("INFO("); print_int(q); print_char(")");
end;
end;
for q:=hi_mem_min to mem_end do
begin if link(q)=p then
begin print_nl("LINK("); print_int(q); print_char(")");
end;
if info(q)=p then
begin print_nl("INFO("); print_int(q); print_char(")");
end;
end;
@<Search |eqtb| for equivalents equal to |p|@>;
@<Search |save_stack| for equivalents that point to |p|@>;
@<Search |hyph_list| for pointers to |p|@>;
end;
gubed
@<Declare procedures that need to be declared forward for \pdfTeX@>@;
@* \[12] Displaying boxes.
We can reinforce our knowledge of the data structures just introduced
by considering two procedures that display a list in symbolic form.
The first of these, called |short_display|, is used in ``overfull box''
messages to give the top-level description of a list. The other one,
called |show_node_list|, prints a detailed description of exactly what
is in the data structure.
The philosophy of |short_display| is to ignore the fine points about exactly
what is inside boxes, except that ligatures and discretionary breaks are
expanded. As a result, |short_display| is a recursive procedure, but the
recursion is never more than one level deep.
@^recursion@>
A global variable |font_in_short_display| keeps track of the font code that
is assumed to be present when |short_display| begins; deviations from this
font will be printed.
@<Glob...@>=
@!font_in_short_display:integer; {an internal font number}
@ Boxes, rules, inserts, whatsits, marks, and things in general that are
sort of ``complicated'' are indicated only by printing `\.{[]}'.
@p
procedure print_font_identifier(f: internal_font_number);
begin
if pdf_font_blink[f] = null_font then
print_esc(font_id_text(f))
else
print_esc(font_id_text(pdf_font_blink[f]));
if pdf_tracing_fonts > 0 then begin
print(" (");
print(font_name[f]);
if font_size[f] <> font_dsize[f] then begin
print("@@");
print_scaled(font_size[f]);
print("pt");
end;
print(")");
end else
if pdf_font_expand_ratio[f] <> 0 then begin
print(" (");
if pdf_font_expand_ratio[f] > 0 then
print("+");
print_int(pdf_font_expand_ratio[f]);
print(")");
end;
end;
procedure short_display(@!p:integer); {prints highlights of list |p|}
var n:integer; {for replacement counts}
begin while p>mem_min do
begin if is_char_node(p) then
begin if p<=mem_end then
begin if font(p)<>font_in_short_display then
begin if (font(p)<font_base)or(font(p)>font_max) then
print_char("*")
@.*\relax@>
else print_font_identifier(font(p));
print_char(" "); font_in_short_display:=font(p);
end;
print_ASCII(qo(character(p)));
end;
end
else @<Print a short indication of the contents of node |p|@>;
p:=link(p);
end;
end;
@ @<Print a short indication of the contents of node |p|@>=
case type(p) of
hlist_node,vlist_node,ins_node,whatsit_node,mark_node,adjust_node,
unset_node: print("[]");
rule_node: print_char("|");
glue_node: if glue_ptr(p)<>zero_glue then print_char(" ");
math_node: if subtype(p)>=L_code then print("[]")
else print_char("$");
ligature_node: short_display(lig_ptr(p));
disc_node: begin short_display(pre_break(p));
short_display(post_break(p));@/
n:=replace_count(p);
while n>0 do
begin if link(p)<>null then p:=link(p);
decr(n);
end;
end;
othercases do_nothing
endcases
@ The |show_node_list| routine requires some auxiliary subroutines: one to
print a font-and-character combination, one to print a token list without
its reference count, and one to print a rule dimension.
@p procedure print_font_and_char(@!p:integer); {prints |char_node| data}
begin if p>mem_end then print_esc("CLOBBERED.")
else begin if (font(p)<font_base)or(font(p)>font_max) then print_char("*")
@.*\relax@>
else print_font_identifier(font(p));
print_char(" "); print_ASCII(qo(character(p)));
end;
end;
@#
procedure print_mark(@!p:integer); {prints token list data in braces}
begin print_char("{");
if (p<hi_mem_min)or(p>mem_end) then print_esc("CLOBBERED.")
else show_token_list(link(p),null,max_print_line-10);
print_char("}");
end;
@#
procedure print_rule_dimen(@!d:scaled); {prints dimension in rule node}
begin if is_running(d) then print_char("*") else print_scaled(d);
@.*\relax@>
end;
@ Then there is a subroutine that prints glue stretch and shrink, possibly
followed by the name of finite units:
@p procedure print_glue(@!d:scaled;@!order:integer;@!s:str_number);
{prints a glue component}
begin print_scaled(d);
if (order<normal)or(order>filll) then print("foul")
else if order>normal then
begin print("fil");
while order>fil do
begin print_char("l"); decr(order);
end;
end
else if s<>0 then print(s);
end;
@ The next subroutine prints a whole glue specification.
@p procedure print_spec(@!p:integer;@!s:str_number);
{prints a glue specification}
begin if (p<mem_min)or(p>=lo_mem_max) then print_char("*")
@.*\relax@>
else begin print_scaled(width(p));
if s<>0 then print(s);
if stretch(p)<>0 then
begin print(" plus "); print_glue(stretch(p),stretch_order(p),s);
end;
if shrink(p)<>0 then
begin print(" minus "); print_glue(shrink(p),shrink_order(p),s);
end;
end;
end;
@ We also need to declare some procedures that appear later in this
documentation.
@p @<Declare procedures needed for displaying the elements of mlists@>@;
@<Declare the procedure called |print_skip_param|@>
@ Since boxes can be inside of boxes, |show_node_list| is inherently recursive,
@^recursion@>
up to a given maximum number of levels. The history of nesting is indicated
by the current string, which will be printed at the beginning of each line;
the length of this string, namely |cur_length|, is the depth of nesting.
Recursive calls on |show_node_list| therefore use the following pattern:
@d node_list_display(#)==
begin append_char("."); show_node_list(#); flush_char;
end {|str_room| need not be checked; see |show_box| below}
@ A global variable called |depth_threshold| is used to record the maximum
depth of nesting for which |show_node_list| will show information. If we
have |depth_threshold=0|, for example, only the top level information will
be given and no sublists will be traversed. Another global variable, called
|breadth_max|, tells the maximum number of items to show at each level;
|breadth_max| had better be positive, or you won't see anything.
@<Glob...@>=
@!depth_threshold : integer; {maximum nesting depth in box displays}
@!breadth_max : integer; {maximum number of items shown at the same list level}
@ Now we are ready for |show_node_list| itself. This procedure has been
written to be ``extra robust'' in the sense that it should not crash or get
into a loop even if the data structures have been messed up by bugs in
the rest of the program. You can safely call its parent routine
|show_box(p)| for arbitrary values of |p| when you are debugging \TeX.
However, in the presence of bad data, the procedure may
@^dirty \PASCAL@>@^debugging@>
fetch a |memory_word| whose variant is different from the way it was stored;
for example, it might try to read |mem[p].hh| when |mem[p]|
contains a scaled integer, if |p| is a pointer that has been
clobbered or chosen at random.
@p procedure show_node_list(@!p:integer); {prints a node list symbolically}
label exit;
var n:integer; {the number of items already printed at this level}
@!g:real; {a glue ratio, as a floating point number}
begin if cur_length>depth_threshold then
begin if p>null then print(" []");
{indicate that there's been some truncation}
return;
end;
n:=0;
while p>mem_min do
begin print_ln; print_current_string; {display the nesting history}
if p>mem_end then {pointer out of range}
begin print("Bad link, display aborted."); return;
@.Bad link...@>
end;
incr(n); if n>breadth_max then {time to stop}
begin print("etc."); return;
@.etc@>
end;
@<Display node |p|@>;
p:=link(p);
end;
exit:
end;
@ @<Display node |p|@>=
if is_char_node(p) then print_font_and_char(p)
else case type(p) of
hlist_node,vlist_node,unset_node: @<Display box |p|@>;
rule_node: @<Display rule |p|@>;
ins_node: @<Display insertion |p|@>;
whatsit_node: @<Display the whatsit node |p|@>;
glue_node: @<Display glue |p|@>;
margin_kern_node: begin
print_esc("kern");
print_scaled(width(p));
if subtype(p) = left_side then
print(" (left margin)")
else
print(" (right margin)");
end;
kern_node: @<Display kern |p|@>;
math_node: @<Display math node |p|@>;
ligature_node: @<Display ligature |p|@>;
penalty_node: @<Display penalty |p|@>;
disc_node: @<Display discretionary |p|@>;
mark_node: @<Display mark |p|@>;
adjust_node: @<Display adjustment |p|@>;
@t\4@>@<Cases of |show_node_list| that arise in mlists only@>@;
othercases print("Unknown node type!")
endcases
@ @<Display box |p|@>=
begin if type(p)=hlist_node then print_esc("h")
else if type(p)=vlist_node then print_esc("v")
else print_esc("unset");
print("box("); print_scaled(height(p)); print_char("+");
print_scaled(depth(p)); print(")x"); print_scaled(width(p));
if type(p)=unset_node then
@<Display special fields of the unset node |p|@>
else begin @<Display the value of |glue_set(p)|@>;
if shift_amount(p)<>0 then
begin print(", shifted "); print_scaled(shift_amount(p));
end;
if eTeX_ex then @<Display if this box is never to be reversed@>;
end;
node_list_display(list_ptr(p)); {recursive call}
end
@ @<Display special fields of the unset node |p|@>=
begin if span_count(p)<>min_quarterword then
begin print(" ("); print_int(qo(span_count(p))+1);
print(" columns)");
end;
if glue_stretch(p)<>0 then
begin print(", stretch "); print_glue(glue_stretch(p),glue_order(p),0);
end;
if glue_shrink(p)<>0 then
begin print(", shrink "); print_glue(glue_shrink(p),glue_sign(p),0);
end;
end
@ The code will have to change in this place if |glue_ratio| is
a structured type instead of an ordinary |real|. Note that this routine
should avoid arithmetic errors even if the |glue_set| field holds an
arbitrary random value. The following code assumes that a properly
formed nonzero |real| number has absolute value $2^{20}$ or more when
it is regarded as an integer; this precaution was adequate to prevent
floating point underflow on the author's computer.
@^system dependencies@>
@^dirty \PASCAL@>
@<Display the value of |glue_set(p)|@>=
g:=float(glue_set(p));
if (g<>float_constant(0))and(glue_sign(p)<>normal) then
begin print(", glue set ");
if glue_sign(p)=shrinking then print("- ");
if abs(mem[p+glue_offset].int)<@'4000000 then print("?.?")
else if abs(g)>float_constant(20000) then
begin if g>float_constant(0) then print_char(">")
else print("< -");
print_glue(20000*unity,glue_order(p),0);
end
else print_glue(round(unity*g),glue_order(p),0);
@^real multiplication@>
end
@ @<Display rule |p|@>=
begin print_esc("rule("); print_rule_dimen(height(p)); print_char("+");
print_rule_dimen(depth(p)); print(")x"); print_rule_dimen(width(p));
end
@ @<Display insertion |p|@>=
begin print_esc("insert"); print_int(qo(subtype(p)));
print(", natural size "); print_scaled(height(p));
print("; split("); print_spec(split_top_ptr(p),0);
print_char(","); print_scaled(depth(p));
print("); float cost "); print_int(float_cost(p));
node_list_display(ins_ptr(p)); {recursive call}
end
@ @<Display glue |p|@>=
if subtype(p)>=a_leaders then @<Display leaders |p|@>
else begin print_esc("glue");
if subtype(p)<>normal then
begin print_char("(");
if subtype(p)<cond_math_glue then
print_skip_param(subtype(p)-1)
else if subtype(p)=cond_math_glue then print_esc("nonscript")
else print_esc("mskip");
print_char(")");
end;
if subtype(p)<>cond_math_glue then
begin print_char(" ");
if subtype(p)<cond_math_glue then print_spec(glue_ptr(p),0)
else print_spec(glue_ptr(p),"mu");
end;
end
@ @<Display leaders |p|@>=
begin print_esc("");
if subtype(p)=c_leaders then print_char("c")
else if subtype(p)=x_leaders then print_char("x");
print("leaders "); print_spec(glue_ptr(p),0);
node_list_display(leader_ptr(p)); {recursive call}
end
@ An ``explicit'' kern value is indicated implicitly by an explicit space.
@<Display kern |p|@>=
if subtype(p)<>mu_glue then
begin print_esc("kern");
if subtype(p)<>normal then print_char(" ");
print_scaled(width(p));
if subtype(p)=acc_kern then print(" (for accent)");
@.for accent@>
if subtype(p)=auto_kern then print(" (for \pdfprependkern/\pdfappendkern)");
end
else begin print_esc("mkern"); print_scaled(width(p)); print("mu");
end
@ @<Display math node |p|@>=
if subtype(p)>after then
begin if end_LR(p) then print_esc("end")
else print_esc("begin");
if subtype(p)>R_code then print_char("R")
else if subtype(p)>L_code then print_char("L")
else print_char("M");
end else
begin print_esc("math");
if subtype(p)=before then print("on")
else print("off");
if width(p)<>0 then
begin print(", surrounded "); print_scaled(width(p));
end;
end
@ @<Display ligature |p|@>=
begin print_font_and_char(lig_char(p)); print(" (ligature ");
if subtype(p)>1 then print_char("|");
font_in_short_display:=font(lig_char(p)); short_display(lig_ptr(p));
if odd(subtype(p)) then print_char("|");
print_char(")");
end
@ @<Display penalty |p|@>=
begin print_esc("penalty "); print_int(penalty(p));
end
@ The |post_break| list of a discretionary node is indicated by a prefixed
`\.{\char'174}' instead of the `\..' before the |pre_break| list.
@<Display discretionary |p|@>=
begin print_esc("discretionary");
if replace_count(p)>0 then
begin print(" replacing "); print_int(replace_count(p));
end;
node_list_display(pre_break(p)); {recursive call}
append_char("|"); show_node_list(post_break(p)); flush_char; {recursive call}
end
@ @<Display mark |p|@>=
begin print_esc("mark");
if mark_class(p)<>0 then
begin print_char("s"); print_int(mark_class(p));
end;
print_mark(mark_ptr(p));
end
@ @<Display adjustment |p|@>=
begin print_esc("vadjust"); if adjust_pre(p) <> 0 then print(" pre ");
node_list_display(adjust_ptr(p)); {recursive call}
end
@ The recursive machinery is started by calling |show_box|.
@^recursion@>
@p procedure show_box(@!p:pointer);
begin @<Assign the values |depth_threshold:=show_box_depth| and
|breadth_max:=show_box_breadth|@>;
if breadth_max<=0 then breadth_max:=5;
if pool_ptr+depth_threshold>=pool_size then
depth_threshold:=pool_size-pool_ptr-1;
{now there's enough room for prefix string}
show_node_list(p); {the show starts at |p|}
print_ln;
end;
@* \[13] Destroying boxes.
When we are done with a node list, we are obliged to return it to free
storage, including all of its sublists. The recursive procedure
|flush_node_list| does this for us.
@ First, however, we shall consider two non-recursive procedures that do
simpler tasks. The first of these, |delete_token_ref|, is called when
a pointer to a token list's reference count is being removed. This means
that the token list should disappear if the reference count was |null|,
otherwise the count should be decreased by one.
@^reference counts@>
@d token_ref_count(#) == info(#) {reference count preceding a token list}
@p procedure delete_token_ref(@!p:pointer); {|p| points to the reference count
of a token list that is losing one reference}
begin if token_ref_count(p)=null then flush_list(p)
else decr(token_ref_count(p));
end;
@ Similarly, |delete_glue_ref| is called when a pointer to a glue
specification is being withdrawn.
@^reference counts@>
@d fast_delete_glue_ref(#)==@t@>@;@/
begin if glue_ref_count(#)=null then free_node(#,glue_spec_size)
else decr(glue_ref_count(#));
end
@p procedure delete_glue_ref(@!p:pointer); {|p| points to a glue specification}
fast_delete_glue_ref(p);
@ Now we are ready to delete any node list, recursively.
In practice, the nodes deleted are usually charnodes (about 2/3 of the time),
and they are glue nodes in about half of the remaining cases.
@^recursion@>
@p procedure flush_node_list(@!p:pointer); {erase list of nodes starting at |p|}
label done; {go here when node |p| has been freed}
var q:pointer; {successor to node |p|}
begin while p<>null do
@^inner loop@>
begin q:=link(p);
if is_char_node(p) then free_avail(p)
else begin case type(p) of
hlist_node,vlist_node,unset_node: begin flush_node_list(list_ptr(p));
free_node(p,box_node_size); goto done;
end;
rule_node: begin free_node(p,rule_node_size); goto done;
end;
ins_node: begin flush_node_list(ins_ptr(p));
delete_glue_ref(split_top_ptr(p));
free_node(p,ins_node_size); goto done;
end;
whatsit_node: @<Wipe out the whatsit node |p| and |goto done|@>;
glue_node: begin fast_delete_glue_ref(glue_ptr(p));
if leader_ptr(p)<>null then flush_node_list(leader_ptr(p));
end;
kern_node,math_node,penalty_node: do_nothing;
margin_kern_node: begin
free_avail(margin_char(p));
free_node(p, margin_kern_node_size);
goto done;
end;
ligature_node: flush_node_list(lig_ptr(p));
mark_node: delete_token_ref(mark_ptr(p));
disc_node: begin flush_node_list(pre_break(p));
flush_node_list(post_break(p));
end;
adjust_node: flush_node_list(adjust_ptr(p));
@t\4@>@<Cases of |flush_node_list| that arise in mlists only@>@;
othercases confusion("flushing")
@:this can't happen flushing}{\quad flushing@>
endcases;@/
free_node(p,small_node_size);
done:end;
p:=q;
end;
end;
@* \[14] Copying boxes.
Another recursive operation that acts on boxes is sometimes needed: The
procedure |copy_node_list| returns a pointer to another node list that has
the same structure and meaning as the original. Note that since glue
specifications and token lists have reference counts, we need not make
copies of them. Reference counts can never get too large to fit in a
halfword, since each pointer to a node is in a different memory address,
and the total number of memory addresses fits in a halfword.
@^recursion@>
@^reference counts@>
(Well, there actually are also references from outside |mem|; if the
|save_stack| is made arbitrarily large, it would theoretically be possible
to break \TeX\ by overflowing a reference count. But who would want to do that?)
@d add_token_ref(#)==incr(token_ref_count(#)) {new reference to a token list}
@d add_glue_ref(#)==incr(glue_ref_count(#)) {new reference to a glue spec}
@ The copying procedure copies words en masse without bothering
to look at their individual fields. If the node format changes---for
example, if the size is altered, or if some link field is moved to another
relative position---then this code may need to be changed too.
@^data structure assumptions@>
@p function copy_node_list(@!p:pointer):pointer; {makes a duplicate of the
node list that starts at |p| and returns a pointer to the new list}
var h:pointer; {temporary head of copied list}
@!q:pointer; {previous position in new list}
@!r:pointer; {current node being fabricated for new list}
@!words:0..5; {number of words remaining to be copied}
begin h:=get_avail; q:=h;
while p<>null do
begin @<Make a copy of node |p| in node |r|@>;
link(q):=r; q:=r; p:=link(p);
end;
link(q):=null; q:=link(h); free_avail(h);
copy_node_list:=q;
end;
@ @<Make a copy of node |p|...@>=
words:=1; {this setting occurs in more branches than any other}
if is_char_node(p) then r:=get_avail
else @<Case statement to copy different types and set |words| to the number
of initial words not yet copied@>;
while words>0 do
begin decr(words); mem[r+words]:=mem[p+words];
end
@ @<Case statement to copy...@>=
case type(p) of
hlist_node,vlist_node,unset_node: begin r:=get_node(box_node_size);
mem[r+6]:=mem[p+6]; mem[r+5]:=mem[p+5]; {copy the last two words}
list_ptr(r):=copy_node_list(list_ptr(p)); {this affects |mem[r+5]|}
words:=5;
end;
rule_node: begin r:=get_node(rule_node_size); words:=rule_node_size;
end;
ins_node: begin r:=get_node(ins_node_size); mem[r+4]:=mem[p+4];
add_glue_ref(split_top_ptr(p));
ins_ptr(r):=copy_node_list(ins_ptr(p)); {this affects |mem[r+4]|}
words:=ins_node_size-1;
end;
whatsit_node:@<Make a partial copy of the whatsit node |p| and make |r|
point to it; set |words| to the number of initial words not yet copied@>;
glue_node: begin r:=get_node(small_node_size); add_glue_ref(glue_ptr(p));
glue_ptr(r):=glue_ptr(p); leader_ptr(r):=copy_node_list(leader_ptr(p));
end;
kern_node,math_node,penalty_node: begin r:=get_node(small_node_size);
words:=small_node_size;
end;
margin_kern_node: begin
r := get_node(margin_kern_node_size);
fast_get_avail(margin_char(r));
font(margin_char(r)) := font(margin_char(p));
character(margin_char(r)) := character(margin_char(p));
words := small_node_size;
end;
ligature_node: begin r:=get_node(small_node_size);
mem[lig_char(r)]:=mem[lig_char(p)]; {copy |font| and |character|}
lig_ptr(r):=copy_node_list(lig_ptr(p));
end;
disc_node: begin r:=get_node(small_node_size);
pre_break(r):=copy_node_list(pre_break(p));
post_break(r):=copy_node_list(post_break(p));
end;
mark_node: begin r:=get_node(small_node_size); add_token_ref(mark_ptr(p));
words:=small_node_size;
end;
adjust_node: begin r:=get_node(small_node_size);
adjust_ptr(r):=copy_node_list(adjust_ptr(p));
end; {|words=1=small_node_size-1|}
othercases confusion("copying")
@:this can't happen copying}{\quad copying@>
endcases
@* \[15] The command codes.
Before we can go any further, we need to define symbolic names for the internal
code numbers that represent the various commands obeyed by \TeX. These codes
are somewhat arbitrary, but not completely so. For example, the command
codes for character types are fixed by the language, since a user says,
e.g., `\.{\\catcode \`\\\${} = 3}' to make \.{\char'44} a math delimiter,
and the command code |math_shift| is equal to~3. Some other codes have
been made adjacent so that |case| statements in the program need not consider
cases that are widely spaced, or so that |case| statements can be replaced
by |if| statements.
At any rate, here is the list, for future reference. First come the
``catcode'' commands, several of which share their numeric codes with
ordinary commands when the catcode cannot emerge from \TeX's scanning routine.
@d escape=0 {escape delimiter (called \.\\ in {\sl The \TeX book\/})}
@:TeXbook}{\sl The \TeX book@>
@d relax=0 {do nothing ( \.{\\relax} )}
@d left_brace=1 {beginning of a group ( \.\{ )}
@d right_brace=2 {ending of a group ( \.\} )}
@d math_shift=3 {mathematics shift character ( \.\$ )}
@d tab_mark=4 {alignment delimiter ( \.\&, \.{\\span} )}
@d car_ret=5 {end of line ( |carriage_return|, \.{\\cr}, \.{\\crcr} )}
@d out_param=5 {output a macro parameter}
@d mac_param=6 {macro parameter symbol ( \.\# )}
@d sup_mark=7 {superscript ( \.{\char'136} )}
@d sub_mark=8 {subscript ( \.{\char'137} )}
@d ignore=9 {characters to ignore ( \.{\^\^@@} )}
@d endv=9 {end of \<v_j> list in alignment template}
@d spacer=10 {characters equivalent to blank space ( \.{\ } )}
@d letter=11 {characters regarded as letters ( \.{A..Z}, \.{a..z} )}
@d other_char=12 {none of the special character types}
@d active_char=13 {characters that invoke macros ( \.{\char`\~} )}
@d par_end=13 {end of paragraph ( \.{\\par} )}
@d match=13 {match a macro parameter}
@d comment=14 {characters that introduce comments ( \.\% )}
@d end_match=14 {end of parameters to macro}
@d stop=14 {end of job ( \.{\\end}, \.{\\dump} )}
@d invalid_char=15 {characters that shouldn't appear ( \.{\^\^?} )}
@d delim_num=15 {specify delimiter numerically ( \.{\\delimiter} )}
@d max_char_code=15 {largest catcode for individual characters}
@ Next are the ordinary run-of-the-mill command codes. Codes that are
|min_internal| or more represent internal quantities that might be
expanded by `\.{\\the}'.
@d char_num=16 {character specified numerically ( \.{\\char} )}
@d math_char_num=17 {explicit math code ( \.{\\mathchar} )}
@d mark=18 {mark definition ( \.{\\mark} )}
@d xray=19 {peek inside of \TeX\ ( \.{\\show}, \.{\\showbox}, etc.~)}
@d make_box=20 {make a box ( \.{\\box}, \.{\\copy}, \.{\\hbox}, etc.~)}
@d hmove=21 {horizontal motion ( \.{\\moveleft}, \.{\\moveright} )}
@d vmove=22 {vertical motion ( \.{\\raise}, \.{\\lower} )}
@d un_hbox=23 {unglue a box ( \.{\\unhbox}, \.{\\unhcopy} )}
@d un_vbox=24 {unglue a box ( \.{\\unvbox}, \.{\\unvcopy} )}
{( or \.{\\pagediscards}, \.{\\splitdiscards} )}
@d remove_item=25 {nullify last item ( \.{\\unpenalty},
\.{\\unkern}, \.{\\unskip} )}
@d hskip=26 {horizontal glue ( \.{\\hskip}, \.{\\hfil}, etc.~)}
@d vskip=27 {vertical glue ( \.{\\vskip}, \.{\\vfil}, etc.~)}
@d mskip=28 {math glue ( \.{\\mskip} )}
@d kern=29 {fixed space ( \.{\\kern} )}
@d mkern=30 {math kern ( \.{\\mkern} )}
@d leader_ship=31 {use a box ( \.{\\shipout}, \.{\\leaders}, etc.~)}
@d halign=32 {horizontal table alignment ( \.{\\halign} )}
@d valign=33 {vertical table alignment ( \.{\\valign} )}
{or text direction directives ( \.{\\beginL}, etc.~)}
@d no_align=34 {temporary escape from alignment ( \.{\\noalign} )}
@d vrule=35 {vertical rule ( \.{\\vrule} )}
@d hrule=36 {horizontal rule ( \.{\\hrule} )}
@d insert=37 {vlist inserted in box ( \.{\\insert} )}
@d vadjust=38 {vlist inserted in enclosing paragraph ( \.{\\vadjust} )}
@d ignore_spaces=39 {gobble |spacer| tokens ( \.{\\ignorespaces} )}
@d after_assignment=40 {save till assignment is done ( \.{\\afterassignment} )}
@d after_group=41 {save till group is done ( \.{\\aftergroup} )}
@d break_penalty=42 {additional badness ( \.{\\penalty} )}
@d start_par=43 {begin paragraph ( \.{\\indent}, \.{\\noindent} )}
@d ital_corr=44 {italic correction ( \.{\\/} )}
@d accent=45 {attach accent in text ( \.{\\accent} )}
@d math_accent=46 {attach accent in math ( \.{\\mathaccent} )}
@d discretionary=47 {discretionary texts ( \.{\\-}, \.{\\discretionary} )}
@d eq_no=48 {equation number ( \.{\\eqno}, \.{\\leqno} )}
@d left_right=49 {variable delimiter ( \.{\\left}, \.{\\right} )}
{( or \.{\\middle} )}
@d math_comp=50 {component of formula ( \.{\\mathbin}, etc.~)}
@d limit_switch=51 {diddle limit conventions ( \.{\\displaylimits}, etc.~)}
@d above=52 {generalized fraction ( \.{\\above}, \.{\\atop}, etc.~)}
@d math_style=53 {style specification ( \.{\\displaystyle}, etc.~)}
@d math_choice=54 {choice specification ( \.{\\mathchoice} )}
@d non_script=55 {conditional math glue ( \.{\\nonscript} )}
@d vcenter=56 {vertically center a vbox ( \.{\\vcenter} )}
@d case_shift=57 {force specific case ( \.{\\lowercase}, \.{\\uppercase}~)}
@d message=58 {send to user ( \.{\\message}, \.{\\errmessage} )}
@d extension=59 {extensions to \TeX\ ( \.{\\write}, \.{\\special}, etc.~)}
@d in_stream=60 {files for reading ( \.{\\openin}, \.{\\closein} )}
@d begin_group=61 {begin local grouping ( \.{\\begingroup} )}
@d end_group=62 {end local grouping ( \.{\\endgroup} )}
@d omit=63 {omit alignment template ( \.{\\omit} )}
@d ex_space=64 {explicit space ( \.{\\\ } )}
@d no_boundary=65 {suppress boundary ligatures ( \.{\\noboundary} )}
@d radical=66 {square root and similar signs ( \.{\\radical} )}
@d end_cs_name=67 {end control sequence ( \.{\\endcsname} )}
@d min_internal=68 {the smallest code that can follow \.{\\the}}
@d char_given=68 {character code defined by \.{\\chardef}}
@d math_given=69 {math code defined by \.{\\mathchardef}}
@d last_item=70 {most recent item ( \.{\\lastpenalty},
\.{\\lastkern}, \.{\\lastskip} )}
@d max_non_prefixed_command=70 {largest command code that can't be \.{\\global}}
@ The next codes are special; they all relate to mode-independent
assignment of values to \TeX's internal registers or tables.
Codes that are |max_internal| or less represent internal quantities
that might be expanded by `\.{\\the}'.
@d toks_register=71 {token list register ( \.{\\toks} )}
@d assign_toks=72 {special token list ( \.{\\output}, \.{\\everypar}, etc.~)}
@d assign_int=73 {user-defined integer ( \.{\\tolerance}, \.{\\day}, etc.~)}
@d assign_dimen=74 {user-defined length ( \.{\\hsize}, etc.~)}
@d assign_glue=75 {user-defined glue ( \.{\\baselineskip}, etc.~)}
@d assign_mu_glue=76 {user-defined muglue ( \.{\\thinmuskip}, etc.~)}
@d assign_font_dimen=77 {user-defined font dimension ( \.{\\fontdimen} )}
@d assign_font_int=78 {user-defined font integer ( \.{\\hyphenchar},
\.{\\skewchar} )}
@d set_aux=79 {specify state info ( \.{\\spacefactor}, \.{\\prevdepth} )}
@d set_prev_graf=80 {specify state info ( \.{\\prevgraf} )}
@d set_page_dimen=81 {specify state info ( \.{\\pagegoal}, etc.~)}
@d set_page_int=82 {specify state info ( \.{\\deadcycles},
\.{\\insertpenalties} )}
{( or \.{\\interactionmode} )}
@d set_box_dimen=83 {change dimension of box ( \.{\\wd}, \.{\\ht}, \.{\\dp} )}
@d set_shape=84 {specify fancy paragraph shape ( \.{\\parshape} )}
{(or \.{\\interlinepenalties}, etc.~)}
@d def_code=85 {define a character code ( \.{\\catcode}, etc.~)}
@d def_family=86 {declare math fonts ( \.{\\textfont}, etc.~)}
@d set_font=87 {set current font ( font identifiers )}
@d def_font=88 {define a font file ( \.{\\font} )}
@d register=89 {internal register ( \.{\\count}, \.{\\dimen}, etc.~)}
@d max_internal=89 {the largest code that can follow \.{\\the}}
@d advance=90 {advance a register or parameter ( \.{\\advance} )}
@d multiply=91 {multiply a register or parameter ( \.{\\multiply} )}
@d divide=92 {divide a register or parameter ( \.{\\divide} )}
@d prefix=93 {qualify a definition ( \.{\\global}, \.{\\long}, \.{\\outer} )}
{( or \.{\\protected} )}
@d let=94 {assign a command code ( \.{\\let}, \.{\\futurelet} )}
@d shorthand_def=95 {code definition ( \.{\\chardef}, \.{\\countdef}, etc.~)}
@d read_to_cs=96 {read into a control sequence ( \.{\\read} )}
{( or \.{\\readline} )}
@d def=97 {macro definition ( \.{\\def}, \.{\\gdef}, \.{\\xdef}, \.{\\edef} )}
@d set_box=98 {set a box ( \.{\\setbox} )}
@d hyph_data=99 {hyphenation data ( \.{\\hyphenation}, \.{\\patterns} )}
@d set_interaction=100 {define level of interaction ( \.{\\batchmode}, etc.~)}
@d letterspace_font=101 {letterspace a font ( \.{\\letterspacefont} )}
@d pdf_copy_font=102 {create a new font instance ( \.{\\pdfcopyfont} )}
@d max_command=102 {the largest command code seen at |big_switch|}
@ The remaining command codes are extra special, since they cannot get through
\TeX's scanner to the main control routine. They have been given values higher
than |max_command| so that their special nature is easily discernible.
The ``expandable'' commands come first.
@d undefined_cs=max_command+1 {initial state of most |eq_type| fields}
@d expand_after=max_command+2 {special expansion ( \.{\\expandafter} )}
@d no_expand=max_command+3 {special nonexpansion ( \.{\\noexpand} )}
@d input=max_command+4 {input a source file ( \.{\\input}, \.{\\endinput} )}
{( or \.{\\scantokens} )}
@d if_test=max_command+5 {conditional text ( \.{\\if}, \.{\\ifcase}, etc.~)}
@d fi_or_else=max_command+6 {delimiters for conditionals ( \.{\\else}, etc.~)}
@d cs_name=max_command+7 {make a control sequence from tokens ( \.{\\csname} )}
@d convert=max_command+8 {convert to text ( \.{\\number}, \.{\\string}, etc.~)}
@d the=max_command+9 {expand an internal quantity ( \.{\\the} )}
{( or \.{\\unexpanded}, \.{\\detokenize} )}
@d top_bot_mark=max_command+10 {inserted mark ( \.{\\topmark}, etc.~)}
@d call=max_command+11 {non-long, non-outer control sequence}
@d long_call=max_command+12 {long, non-outer control sequence}
@d outer_call=max_command+13 {non-long, outer control sequence}
@d long_outer_call=max_command+14 {long, outer control sequence}
@d end_template=max_command+15 {end of an alignment template}
@d dont_expand=max_command+16 {the following token was marked by \.{\\noexpand}}
@d glue_ref=max_command+17 {the equivalent points to a glue specification}
@d shape_ref=max_command+18 {the equivalent points to a parshape specification}
@d box_ref=max_command+19 {the equivalent points to a box node, or is |null|}
@d data=max_command+20 {the equivalent is simply a halfword number}
@* \[16] The semantic nest.
\TeX\ is typically in the midst of building many lists at once. For example,
when a math formula is being processed, \TeX\ is in math mode and
working on an mlist; this formula has temporarily interrupted \TeX\ from
being in horizontal mode and building the hlist of a paragraph; and this
paragraph has temporarily interrupted \TeX\ from being in vertical mode
and building the vlist for the next page of a document. Similarly, when a
\.{\\vbox} occurs inside of an \.{\\hbox}, \TeX\ is temporarily
interrupted from working in restricted horizontal mode, and it enters
internal vertical mode. The ``semantic nest'' is a stack that
keeps track of what lists and modes are currently suspended.
At each level of processing we are in one of six modes:
\yskip\hang|vmode| stands for vertical mode (the page builder);
\hang|hmode| stands for horizontal mode (the paragraph builder);
\hang|mmode| stands for displayed formula mode;
\hang|-vmode| stands for internal vertical mode (e.g., in a \.{\\vbox});
\hang|-hmode| stands for restricted horizontal mode (e.g., in an \.{\\hbox});
\hang|-mmode| stands for math formula mode (not displayed).
\yskip\noindent The mode is temporarily set to zero while processing \.{\\write}
texts.
Numeric values are assigned to |vmode|, |hmode|, and |mmode| so that
\TeX's ``big semantic switch'' can select the appropriate thing to
do by computing the value |abs(mode)+cur_cmd|, where |mode| is the current
mode and |cur_cmd| is the current command code.
@d vmode=1 {vertical mode}
@d hmode=vmode+max_command+1 {horizontal mode}
@d mmode=hmode+max_command+1 {math mode}
@p procedure print_mode(@!m:integer); {prints the mode represented by |m|}
begin if m>0 then
case m div (max_command+1) of
0:print("vertical");
1:print("horizontal");
2:print("display math");
end
else if m=0 then print("no")
else case (-m) div (max_command+1) of
0:print("internal vertical");
1:print("restricted horizontal");
2:print("math");
end;
print(" mode");
end;
@ The state of affairs at any semantic level can be represented by
five values:
\yskip\hang|mode| is the number representing the semantic mode, as
just explained.
\yskip\hang|head| is a |pointer| to a list head for the list being built;
|link(head)| therefore points to the first element of the list, or
to |null| if the list is empty.
\yskip\hang|tail| is a |pointer| to the final node of the list being
built; thus, |tail=head| if and only if the list is empty.
\yskip\hang|prev_graf| is the number of lines of the current paragraph that
have already been put into the present vertical list.
\yskip\hang|aux| is an auxiliary |memory_word| that gives further information
that is needed to characterize the situation.
\yskip\noindent
In vertical mode, |aux| is also known as |prev_depth|; it is the scaled
value representing the depth of the previous box, for use in baseline
calculations, or it is |<=-1000|pt if the next box on the vertical list is to
be exempt from baseline calculations. In horizontal mode, |aux| is also
known as |space_factor| and |clang|; it holds the current space factor used in
spacing calculations, and the current language used for hyphenation.
(The value of |clang| is undefined in restricted horizontal mode.)
In math mode, |aux| is also known as |incompleat_noad|; if
not |null|, it points to a record that represents the numerator of a
generalized fraction for which the denominator is currently being formed
in the current list.
There is also a sixth quantity, |mode_line|, which correlates
the semantic nest with the user's input; |mode_line| contains the source
line number at which the current level of nesting was entered. The negative
of this line number is the |mode_line| at the level of the
user's output routine.
A seventh quantity, |eTeX_aux|, is used by the extended features \eTeX.
In vertical modes it is known as |LR_save| and holds the LR stack when a
paragraph is interrupted by a displayed formula. In display math mode
it is known as |LR_box| and holds a pointer to a prototype box for the
display. In math mode it is known as |delim_ptr| and points to the most
recent |left_noad| or |middle_noad| of a |math_left_group|.
In horizontal mode, the |prev_graf| field is used for initial language data.
The semantic nest is an array called |nest| that holds the |mode|, |head|,
|tail|, |prev_graf|, |aux|, and |mode_line| values for all semantic levels
below the currently active one. Information about the currently active
level is kept in the global quantities |mode|, |head|, |tail|, |prev_graf|,
|aux|, and |mode_line|, which live in a \PASCAL\ record that is ready to
be pushed onto |nest| if necessary.
@d ignore_depth==-65536000 {magic dimension value to mean `ignore me'}
@<Types...@>=
@!list_state_record=record@!mode_field:-mmode..mmode;@+
@!head_field,@!tail_field: pointer;
@!eTeX_aux_field: pointer;
@!pg_field,@!ml_field: integer;@+
@!aux_field: memory_word;
end;
@ @d mode==cur_list.mode_field {current mode}
@d head==cur_list.head_field {header node of current list}
@d tail==cur_list.tail_field {final node on current list}
@d eTeX_aux==cur_list.eTeX_aux_field {auxiliary data for \eTeX}
@d LR_save==eTeX_aux {LR stack when a paragraph is interrupted}
@d LR_box==eTeX_aux {prototype box for display}
@d delim_ptr==eTeX_aux {most recent left or right noad of a math left group}
@d prev_graf==cur_list.pg_field {number of paragraph lines accumulated}
@d aux==cur_list.aux_field {auxiliary data about the current list}
@d prev_depth==aux.sc {the name of |aux| in vertical mode}
@d space_factor==aux.hh.lh {part of |aux| in horizontal mode}
@d clang==aux.hh.rh {the other part of |aux| in horizontal mode}
@d incompleat_noad==aux.int {the name of |aux| in math mode}
@d mode_line==cur_list.ml_field {source file line number at beginning of list}
@<Glob...@>=
@!nest:array[0..nest_size] of list_state_record;
@!nest_ptr:0..nest_size; {first unused location of |nest|}
@!max_nest_stack:0..nest_size; {maximum of |nest_ptr| when pushing}
@!cur_list:list_state_record; {the ``top'' semantic state}
@!shown_mode:-mmode..mmode; {most recent mode shown by \.{\\tracingcommands}}
@!save_tail: pointer; {save |tail| so we can examine whether we have an auto
kern before a glue}
@!prev_tail: pointer; {value of |tail| before the last call to |tail_append|}
@ Here is a common way to make the current list grow:
@d tail_append(#)==begin prev_tail:=tail; link(tail):=#; tail:=link(tail);
end
@d insert_before_tail(#) == begin
link(prev_tail) := #;
link(#) := tail;
prev_tail := #;
end
@ We will see later that the vertical list at the bottom semantic level is split
into two parts; the ``current page'' runs from |page_head| to |page_tail|,
and the ``contribution list'' runs from |contrib_head| to |tail| of
semantic level zero. The idea is that contributions are first formed in
vertical mode, then ``contributed'' to the current page (during which time
the page-breaking decisions are made). For now, we don't need to know
any more details about the page-building process.
@<Set init...@>=
nest_ptr:=0; max_nest_stack:=0;
mode:=vmode; head:=contrib_head; tail:=contrib_head;
eTeX_aux:=null; save_tail:=null;
prev_depth:=ignore_depth; mode_line:=0;
prev_graf:=0; shown_mode:=0;
@<Start a new current page@>;
@ When \TeX's work on one level is interrupted, the state is saved by
calling |push_nest|. This routine changes |head| and |tail| so that
a new (empty) list is begun; it does not change |mode| or |aux|.
@p procedure push_nest; {enter a new semantic level, save the old}
begin if nest_ptr>max_nest_stack then
begin max_nest_stack:=nest_ptr;
if nest_ptr=nest_size then overflow("semantic nest size",nest_size);
@:TeX capacity exceeded semantic nest size}{\quad semantic nest size@>
end;
nest[nest_ptr]:=cur_list; {stack the record}
incr(nest_ptr); head:=get_avail; tail:=head; prev_graf:=0; mode_line:=line;
eTeX_aux:=null;
end;
@ Conversely, when \TeX\ is finished on the current level, the former
state is restored by calling |pop_nest|. This routine will never be
called at the lowest semantic level, nor will it be called unless |head|
is a node that should be returned to free memory.
@p procedure pop_nest; {leave a semantic level, re-enter the old}
begin free_avail(head); decr(nest_ptr); cur_list:=nest[nest_ptr];
end;
@ Here is a procedure that displays what \TeX\ is working on, at all levels.
@p procedure@?print_totals; forward;@t\2@>
procedure show_activities;
var p:0..nest_size; {index into |nest|}
@!m:-mmode..mmode; {mode}
@!a:memory_word; {auxiliary}
@!q,@!r:pointer; {for showing the current page}
@!t:integer; {ditto}
begin nest[nest_ptr]:=cur_list; {put the top level into the array}
print_nl(""); print_ln;
for p:=nest_ptr downto 0 do
begin m:=nest[p].mode_field; a:=nest[p].aux_field;
print_nl("### "); print_mode(m);
print(" entered at line "); print_int(abs(nest[p].ml_field));
if m=hmode then if nest[p].pg_field <> @'40600000 then
begin print(" (language"); print_int(nest[p].pg_field mod @'200000);
print(":hyphenmin"); print_int(nest[p].pg_field div @'20000000);
print_char(","); print_int((nest[p].pg_field div @'200000) mod @'100);
print_char(")");
end;
if nest[p].ml_field<0 then print(" (\output routine)");
if p=0 then
begin @<Show the status of the current page@>;
if link(contrib_head)<>null then
print_nl("### recent contributions:");
end;
show_box(link(nest[p].head_field));
@<Show the auxiliary field, |a|@>;
end;
end;
@ @<Show the auxiliary...@>=
case abs(m) div (max_command+1) of
0: begin print_nl("prevdepth ");
if a.sc<=pdf_ignored_dimen then print("ignored")
else print_scaled(a.sc);
if nest[p].pg_field<>0 then
begin print(", prevgraf ");
print_int(nest[p].pg_field); print(" line");
if nest[p].pg_field<>1 then print_char("s");
end;
end;
1: begin print_nl("spacefactor "); print_int(a.hh.lh);
if m>0 then@+ if a.hh.rh>0 then
begin print(", current language "); print_int(a.hh.rh);@+
end;
end;
2: if a.int<>null then
begin print("this will begin denominator of:"); show_box(a.int);@+
end;
end {there are no other cases}
@* \[17] The table of equivalents.
Now that we have studied the data structures for \TeX's semantic routines,
we ought to consider the data structures used by its syntactic routines. In
other words, our next concern will be
the tables that \TeX\ looks at when it is scanning
what the user has written.
The biggest and most important such table is called |eqtb|. It holds the
current ``equivalents'' of things; i.e., it explains what things mean
or what their current values are, for all quantities that are subject to
the nesting structure provided by \TeX's grouping mechanism. There are six
parts to |eqtb|:
\yskip\hangg 1) |eqtb[active_base..(hash_base-1)]| holds the current
equivalents of single-character control sequences.
\yskip\hangg 2) |eqtb[hash_base..(glue_base-1)]| holds the current
equivalents of multiletter control sequences.
\yskip\hangg 3) |eqtb[glue_base..(local_base-1)]| holds the current
equivalents of glue parameters like the current baselineskip.
\yskip\hangg 4) |eqtb[local_base..(int_base-1)]| holds the current
equivalents of local halfword quantities like the current box registers,
the current ``catcodes,'' the current font, and a pointer to the current
paragraph shape.
\yskip\hangg 5) |eqtb[int_base..(dimen_base-1)]| holds the current
equivalents of fullword integer parameters like the current hyphenation
penalty.
\yskip\hangg 6) |eqtb[dimen_base..eqtb_size]| holds the current equivalents
of fullword dimension parameters like the current hsize or amount of
hanging indentation.
\yskip\noindent Note that, for example, the current amount of
baselineskip glue is determined by the setting of a particular location
in region~3 of |eqtb|, while the current meaning of the control sequence
`\.{\\baselineskip}' (which might have been changed by \.{\\def} or
\.{\\let}) appears in region~2.
@ Each entry in |eqtb| is a |memory_word|. Most of these words are of type
|two_halves|, and subdivided into three fields:
\yskip\hangg 1) The |eq_level| (a quarterword) is the level of grouping at
which this equivalent was defined. If the level is |level_zero|, the
equivalent has never been defined; |level_one| refers to the outer level
(outside of all groups), and this level is also used for global
definitions that never go away. Higher levels are for equivalents that
will disappear at the end of their group. @^global definitions@>
\yskip\hangg 2) The |eq_type| (another quarterword) specifies what kind of
entry this is. There are many types, since each \TeX\ primitive like
\.{\\hbox}, \.{\\def}, etc., has its own special code. The list of
command codes above includes all possible settings of the |eq_type| field.
\yskip\hangg 3) The |equiv| (a halfword) is the current equivalent value.
This may be a font number, a pointer into |mem|, or a variety of other
things.
@d eq_level_field(#)==#.hh.b1
@d eq_type_field(#)==#.hh.b0
@d equiv_field(#)==#.hh.rh
@d eq_level(#)==eq_level_field(eqtb[#]) {level of definition}
@d eq_type(#)==eq_type_field(eqtb[#]) {command code for equivalent}
@d equiv(#)==equiv_field(eqtb[#]) {equivalent value}
@d level_zero=min_quarterword {level for undefined quantities}
@d level_one=level_zero+1 {outermost level for defined quantities}
@ Many locations in |eqtb| have symbolic names. The purpose of the next
paragraphs is to define these names, and to set up the initial values of the
equivalents.
In the first region we have 256 equivalents for ``active characters'' that
act as control sequences, followed by 256 equivalents for single-character
control sequences.
Then comes region~2, which corresponds to the hash table that we will
define later. The maximum address in this region is used for a dummy
control sequence that is perpetually undefined. There also are several
locations for control sequences that are perpetually defined
(since they are used in error recovery).
@d active_base=1 {beginning of region 1, for active character equivalents}
@d single_base=active_base+256 {equivalents of one-character control sequences}
@d null_cs=single_base+256 {equivalent of \.{\\csname\\endcsname}}
@d hash_base=null_cs+1 {beginning of region 2, for the hash table}
@d frozen_control_sequence=hash_base+hash_size {for error recovery}
@d frozen_protection=frozen_control_sequence {inaccessible but definable}
@d frozen_cr=frozen_control_sequence+1 {permanent `\.{\\cr}'}
@d frozen_end_group=frozen_control_sequence+2 {permanent `\.{\\endgroup}'}
@d frozen_right=frozen_control_sequence+3 {permanent `\.{\\right}'}
@d frozen_fi=frozen_control_sequence+4 {permanent `\.{\\fi}'}
@d frozen_end_template=frozen_control_sequence+5 {permanent `\.{\\endtemplate}'}
@d frozen_endv=frozen_control_sequence+6 {second permanent `\.{\\endtemplate}'}
@d frozen_relax=frozen_control_sequence+7 {permanent `\.{\\relax}'}
@d end_write=frozen_control_sequence+8 {permanent `\.{\\endwrite}'}
@d frozen_dont_expand=frozen_control_sequence+9
{permanent `\.{\\notexpanded:}'}
@d prim_size=2100 {maximum number of primitives }
@d frozen_null_font=frozen_control_sequence+10
{permanent `\.{\\nullfont}'}
@d frozen_primitive=frozen_control_sequence+11
{permanent `\.{\\pdfprimitive}'}
@d prim_eqtb_base=frozen_primitive+1
@d font_id_base=frozen_null_font-font_base
{begins table of 257 permanent font identifiers}
@d undefined_control_sequence=frozen_null_font+257 {dummy location}
@d glue_base=undefined_control_sequence+1 {beginning of region 3}
@<Initialize table entries...@>=
eq_type(undefined_control_sequence):=undefined_cs;
equiv(undefined_control_sequence):=null;
eq_level(undefined_control_sequence):=level_zero;
for k:=active_base to undefined_control_sequence-1 do
eqtb[k]:=eqtb[undefined_control_sequence];
@ Here is a routine that displays the current meaning of an |eqtb| entry
in region 1 or~2. (Similar routines for the other regions will appear
below.)
@<Show equivalent |n|, in region 1 or 2@>=
begin sprint_cs(n); print_char("="); print_cmd_chr(eq_type(n),equiv(n));
if eq_type(n)>=call then
begin print_char(":"); show_token_list(link(equiv(n)),null,32);
end;
end
@ Region 3 of |eqtb| contains the 256 \.{\\skip} registers, as well as the
glue parameters defined here. It is important that the ``muskip''
parameters have larger numbers than the others.
@d line_skip_code=0 {interline glue if |baseline_skip| is infeasible}
@d baseline_skip_code=1 {desired glue between baselines}
@d par_skip_code=2 {extra glue just above a paragraph}
@d above_display_skip_code=3 {extra glue just above displayed math}
@d below_display_skip_code=4 {extra glue just below displayed math}
@d above_display_short_skip_code=5
{glue above displayed math following short lines}
@d below_display_short_skip_code=6
{glue below displayed math following short lines}
@d left_skip_code=7 {glue at left of justified lines}
@d right_skip_code=8 {glue at right of justified lines}
@d top_skip_code=9 {glue at top of main pages}
@d split_top_skip_code=10 {glue at top of split pages}
@d tab_skip_code=11 {glue between aligned entries}
@d space_skip_code=12 {glue between words (if not |zero_glue|)}
@d xspace_skip_code=13 {glue after sentences (if not |zero_glue|)}
@d par_fill_skip_code=14 {glue on last line of paragraph}
@d thin_mu_skip_code=15 {thin space in math formula}
@d med_mu_skip_code=16 {medium space in math formula}
@d thick_mu_skip_code=17 {thick space in math formula}
@d glue_pars=18 {total number of glue parameters}
@d skip_base=glue_base+glue_pars {table of 256 ``skip'' registers}
@d mu_skip_base=skip_base+256 {table of 256 ``muskip'' registers}
@d local_base=mu_skip_base+256 {beginning of region 4}
@#
@d skip(#)==equiv(skip_base+#) {|mem| location of glue specification}
@d mu_skip(#)==equiv(mu_skip_base+#) {|mem| location of math glue spec}
@d glue_par(#)==equiv(glue_base+#) {|mem| location of glue specification}
@d line_skip==glue_par(line_skip_code)
@d baseline_skip==glue_par(baseline_skip_code)
@d par_skip==glue_par(par_skip_code)
@d above_display_skip==glue_par(above_display_skip_code)
@d below_display_skip==glue_par(below_display_skip_code)
@d above_display_short_skip==glue_par(above_display_short_skip_code)
@d below_display_short_skip==glue_par(below_display_short_skip_code)
@d left_skip==glue_par(left_skip_code)
@d right_skip==glue_par(right_skip_code)
@d top_skip==glue_par(top_skip_code)
@d split_top_skip==glue_par(split_top_skip_code)
@d tab_skip==glue_par(tab_skip_code)
@d space_skip==glue_par(space_skip_code)
@d xspace_skip==glue_par(xspace_skip_code)
@d par_fill_skip==glue_par(par_fill_skip_code)
@d thin_mu_skip==glue_par(thin_mu_skip_code)
@d med_mu_skip==glue_par(med_mu_skip_code)
@d thick_mu_skip==glue_par(thick_mu_skip_code)
@<Current |mem| equivalent of glue parameter number |n|@>=glue_par(n)
@ Sometimes we need to convert \TeX's internal code numbers into symbolic
form. The |print_skip_param| routine gives the symbolic name of a glue
parameter.
@<Declare the procedure called |print_skip_param|@>=
procedure print_skip_param(@!n:integer);
begin case n of
line_skip_code: print_esc("lineskip");
baseline_skip_code: print_esc("baselineskip");
par_skip_code: print_esc("parskip");
above_display_skip_code: print_esc("abovedisplayskip");
below_display_skip_code: print_esc("belowdisplayskip");
above_display_short_skip_code: print_esc("abovedisplayshortskip");
below_display_short_skip_code: print_esc("belowdisplayshortskip");
left_skip_code: print_esc("leftskip");
right_skip_code: print_esc("rightskip");
top_skip_code: print_esc("topskip");
split_top_skip_code: print_esc("splittopskip");
tab_skip_code: print_esc("tabskip");
space_skip_code: print_esc("spaceskip");
xspace_skip_code: print_esc("xspaceskip");
par_fill_skip_code: print_esc("parfillskip");
thin_mu_skip_code: print_esc("thinmuskip");
med_mu_skip_code: print_esc("medmuskip");
thick_mu_skip_code: print_esc("thickmuskip");
othercases print("[unknown glue parameter!]")
endcases;
end;
@ The symbolic names for glue parameters are put into \TeX's hash table
by using the routine called |primitive|, defined below. Let us enter them
now, so that we don't have to list all those parameter names anywhere else.
@<Put each of \TeX's primitives into the hash table@>=
primitive("lineskip",assign_glue,glue_base+line_skip_code);@/
@!@:line_skip_}{\.{\\lineskip} primitive@>
primitive("baselineskip",assign_glue,glue_base+baseline_skip_code);@/
@!@:baseline_skip_}{\.{\\baselineskip} primitive@>
primitive("parskip",assign_glue,glue_base+par_skip_code);@/
@!@:par_skip_}{\.{\\parskip} primitive@>
primitive("abovedisplayskip",assign_glue,glue_base+above_display_skip_code);@/
@!@:above_display_skip_}{\.{\\abovedisplayskip} primitive@>
primitive("belowdisplayskip",assign_glue,glue_base+below_display_skip_code);@/
@!@:below_display_skip_}{\.{\\belowdisplayskip} primitive@>
primitive("abovedisplayshortskip",
assign_glue,glue_base+above_display_short_skip_code);@/
@!@:above_display_short_skip_}{\.{\\abovedisplayshortskip} primitive@>
primitive("belowdisplayshortskip",
assign_glue,glue_base+below_display_short_skip_code);@/
@!@:below_display_short_skip_}{\.{\\belowdisplayshortskip} primitive@>
primitive("leftskip",assign_glue,glue_base+left_skip_code);@/
@!@:left_skip_}{\.{\\leftskip} primitive@>
primitive("rightskip",assign_glue,glue_base+right_skip_code);@/
@!@:right_skip_}{\.{\\rightskip} primitive@>
primitive("topskip",assign_glue,glue_base+top_skip_code);@/
@!@:top_skip_}{\.{\\topskip} primitive@>
primitive("splittopskip",assign_glue,glue_base+split_top_skip_code);@/
@!@:split_top_skip_}{\.{\\splittopskip} primitive@>
primitive("tabskip",assign_glue,glue_base+tab_skip_code);@/
@!@:tab_skip_}{\.{\\tabskip} primitive@>
primitive("spaceskip",assign_glue,glue_base+space_skip_code);@/
@!@:space_skip_}{\.{\\spaceskip} primitive@>
primitive("xspaceskip",assign_glue,glue_base+xspace_skip_code);@/
@!@:xspace_skip_}{\.{\\xspaceskip} primitive@>
primitive("parfillskip",assign_glue,glue_base+par_fill_skip_code);@/
@!@:par_fill_skip_}{\.{\\parfillskip} primitive@>
primitive("thinmuskip",assign_mu_glue,glue_base+thin_mu_skip_code);@/
@!@:thin_mu_skip_}{\.{\\thinmuskip} primitive@>
primitive("medmuskip",assign_mu_glue,glue_base+med_mu_skip_code);@/
@!@:med_mu_skip_}{\.{\\medmuskip} primitive@>
primitive("thickmuskip",assign_mu_glue,glue_base+thick_mu_skip_code);@/
@!@:thick_mu_skip_}{\.{\\thickmuskip} primitive@>
@ @<Cases of |print_cmd_chr| for symbolic printing of primitives@>=
assign_glue,assign_mu_glue: if chr_code<skip_base then
print_skip_param(chr_code-glue_base)
else if chr_code<mu_skip_base then
begin print_esc("skip"); print_int(chr_code-skip_base);
end
else begin print_esc("muskip"); print_int(chr_code-mu_skip_base);
end;
@ All glue parameters and registers are initially `\.{0pt plus0pt minus0pt}'.
@<Initialize table entries...@>=
equiv(glue_base):=zero_glue; eq_level(glue_base):=level_one;
eq_type(glue_base):=glue_ref;
for k:=glue_base+1 to local_base-1 do eqtb[k]:=eqtb[glue_base];
glue_ref_count(zero_glue):=glue_ref_count(zero_glue)+local_base-glue_base;
@ @<Show equivalent |n|, in region 3@>=
if n<skip_base then
begin print_skip_param(n-glue_base); print_char("=");
if n<glue_base+thin_mu_skip_code then print_spec(equiv(n),"pt")
else print_spec(equiv(n),"mu");
end
else if n<mu_skip_base then
begin print_esc("skip"); print_int(n-skip_base); print_char("=");
print_spec(equiv(n),"pt");
end
else begin print_esc("muskip"); print_int(n-mu_skip_base); print_char("=");
print_spec(equiv(n),"mu");
end
@ Region 4 of |eqtb| contains the local quantities defined here. The
bulk of this region is taken up by five tables that are indexed by eight-bit
characters; these tables are important to both the syntactic and semantic
portions of \TeX. There are also a bunch of special things like font and
token parameters, as well as the tables of \.{\\toks} and \.{\\box}
registers.
@d par_shape_loc=local_base {specifies paragraph shape}
@d output_routine_loc=local_base+1 {points to token list for \.{\\output}}
@d every_par_loc=local_base+2 {points to token list for \.{\\everypar}}
@d every_math_loc=local_base+3 {points to token list for \.{\\everymath}}
@d every_display_loc=local_base+4 {points to token list for \.{\\everydisplay}}
@d every_hbox_loc=local_base+5 {points to token list for \.{\\everyhbox}}
@d every_vbox_loc=local_base+6 {points to token list for \.{\\everyvbox}}
@d every_job_loc=local_base+7 {points to token list for \.{\\everyjob}}
@d every_cr_loc=local_base+8 {points to token list for \.{\\everycr}}
@d err_help_loc=local_base+9 {points to token list for \.{\\errhelp}}
@d tex_toks=local_base+10 {end of \TeX's token list parameters}
@#
@d pdftex_first_loc = tex_toks {base for \pdfTeX's token list parameters}
@d pdf_pages_attr_loc = pdftex_first_loc + 0 {points to token list for \.{\\pdfpagesattr}}
@d pdf_page_attr_loc = pdftex_first_loc + 1 {points to token list for \.{\\pdfpageattr}}
@d pdf_page_resources_loc = pdftex_first_loc + 2 {points to token list for \.{\\pdfpageresources}}
@d pdf_pk_mode_loc = pdftex_first_loc + 3 {points to token list for \.{\\pdfpkmode}}
@d pdf_toks=pdftex_first_loc+4 {end of \pdfTeX's token list parameters}
@#
@d etex_toks_base=pdf_toks {base for \eTeX's token list parameters}
@d every_eof_loc=etex_toks_base {points to token list for \.{\\everyeof}}
@d etex_toks=etex_toks_base+1 {end of \eTeX's token list parameters}
@#
@d toks_base=etex_toks {table of 256 token list registers}
@#
@d etex_pen_base=toks_base+256 {start of table of \eTeX's penalties}
@d inter_line_penalties_loc=etex_pen_base {additional penalties between lines}
@d club_penalties_loc=etex_pen_base+1 {penalties for creating club lines}
@d widow_penalties_loc=etex_pen_base+2 {penalties for creating widow lines}
@d display_widow_penalties_loc=etex_pen_base+3 {ditto, just before a display}
@d etex_pens=etex_pen_base+4 {end of table of \eTeX's penalties}
@#
@d box_base=etex_pens {table of 256 box registers}
@d cur_font_loc=box_base+256 {internal font number outside math mode}
@d math_font_base=cur_font_loc+1 {table of 48 math font numbers}
@d cat_code_base=math_font_base+48
{table of 256 command codes (the ``catcodes'')}
@d lc_code_base=cat_code_base+256 {table of 256 lowercase mappings}
@d uc_code_base=lc_code_base+256 {table of 256 uppercase mappings}
@d sf_code_base=uc_code_base+256 {table of 256 spacefactor mappings}
@d math_code_base=sf_code_base+256 {table of 256 math mode mappings}
@d int_base=math_code_base+256 {beginning of region 5}
@#
@d par_shape_ptr==equiv(par_shape_loc)
@d output_routine==equiv(output_routine_loc)
@d every_par==equiv(every_par_loc)
@d every_math==equiv(every_math_loc)
@d every_display==equiv(every_display_loc)
@d every_hbox==equiv(every_hbox_loc)
@d every_vbox==equiv(every_vbox_loc)
@d every_job==equiv(every_job_loc)
@d every_cr==equiv(every_cr_loc)
@d err_help==equiv(err_help_loc)
@d pdf_pages_attr==equiv(pdf_pages_attr_loc)
@d pdf_page_attr==equiv(pdf_page_attr_loc)
@d pdf_page_resources==equiv(pdf_page_resources_loc)
@d pdf_pk_mode==equiv(pdf_pk_mode_loc)
@d toks(#)==equiv(toks_base+#)
@d box(#)==equiv(box_base+#)
@d cur_font==equiv(cur_font_loc)
@d fam_fnt(#)==equiv(math_font_base+#)
@d cat_code(#)==equiv(cat_code_base+#)
@d lc_code(#)==equiv(lc_code_base+#)
@d uc_code(#)==equiv(uc_code_base+#)
@d sf_code(#)==equiv(sf_code_base+#)
@d math_code(#)==equiv(math_code_base+#)
{Note: |math_code(c)| is the true math code plus |min_halfword|}
@<Put each...@>=
primitive("output",assign_toks,output_routine_loc);
@!@:output_}{\.{\\output} primitive@>
primitive("everypar",assign_toks,every_par_loc);
@!@:every_par_}{\.{\\everypar} primitive@>
primitive("everymath",assign_toks,every_math_loc);
@!@:every_math_}{\.{\\everymath} primitive@>
primitive("everydisplay",assign_toks,every_display_loc);
@!@:every_display_}{\.{\\everydisplay} primitive@>
primitive("everyhbox",assign_toks,every_hbox_loc);
@!@:every_hbox_}{\.{\\everyhbox} primitive@>
primitive("everyvbox",assign_toks,every_vbox_loc);
@!@:every_vbox_}{\.{\\everyvbox} primitive@>
primitive("everyjob",assign_toks,every_job_loc);
@!@:every_job_}{\.{\\everyjob} primitive@>
primitive("everycr",assign_toks,every_cr_loc);
@!@:every_cr_}{\.{\\everycr} primitive@>
primitive("errhelp",assign_toks,err_help_loc);
@!@:err_help_}{\.{\\errhelp} primitive@>
primitive("pdfpagesattr",assign_toks,pdf_pages_attr_loc);
@!@:pdf_pages_attr_}{\.{\\pdfpagesattr} primitive@>
primitive("pdfpageattr",assign_toks,pdf_page_attr_loc);
@!@:pdf_page_attr_}{\.{\\pdfpageattr} primitive@>
primitive("pdfpageresources",assign_toks,pdf_page_resources_loc);
@!@:pdf_page_resources_}{\.{\\pdfpageresources} primitive@>
primitive("pdfpkmode",assign_toks,pdf_pk_mode_loc);
@!@:pdf_pk_mode_}{\.{\\pdfpkmode} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
assign_toks: if chr_code>=toks_base then
begin print_esc("toks"); print_int(chr_code-toks_base);
end
else case chr_code of
output_routine_loc: print_esc("output");
every_par_loc: print_esc("everypar");
every_math_loc: print_esc("everymath");
every_display_loc: print_esc("everydisplay");
every_hbox_loc: print_esc("everyhbox");
every_vbox_loc: print_esc("everyvbox");
every_job_loc: print_esc("everyjob");
every_cr_loc: print_esc("everycr");
@/@<Cases of |assign_toks| for |print_cmd_chr|@>@/
pdf_pages_attr_loc: print_esc("pdfpagesattr");
pdf_page_attr_loc: print_esc("pdfpageattr");
pdf_page_resources_loc: print_esc("pdfpageresources");
pdf_pk_mode_loc: print_esc("pdfpkmode");
othercases print_esc("errhelp")
endcases;
@ We initialize most things to null or undefined values. An undefined font
is represented by the internal code |font_base|.
However, the character code tables are given initial values based on the
conventional interpretation of ASCII code. These initial values should
not be changed when \TeX\ is adapted for use with non-English languages;
all changes to the initialization conventions should be made in format
packages, not in \TeX\ itself, so that global interchange of formats is
possible.
@d null_font==font_base
@d var_code==@'70000 {math code meaning ``use the current family''}
@<Initialize table entries...@>=
par_shape_ptr:=null; eq_type(par_shape_loc):=shape_ref;
eq_level(par_shape_loc):=level_one;@/
for k:=etex_pen_base to etex_pens-1 do
eqtb[k]:=eqtb[par_shape_loc];
for k:=output_routine_loc to toks_base+255 do
eqtb[k]:=eqtb[undefined_control_sequence];
box(0):=null; eq_type(box_base):=box_ref; eq_level(box_base):=level_one;
for k:=box_base+1 to box_base+255 do eqtb[k]:=eqtb[box_base];
cur_font:=null_font; eq_type(cur_font_loc):=data;
eq_level(cur_font_loc):=level_one;@/
for k:=math_font_base to math_font_base+47 do eqtb[k]:=eqtb[cur_font_loc];
equiv(cat_code_base):=0; eq_type(cat_code_base):=data;
eq_level(cat_code_base):=level_one;@/
for k:=cat_code_base+1 to int_base-1 do eqtb[k]:=eqtb[cat_code_base];
for k:=0 to 255 do
begin cat_code(k):=other_char; math_code(k):=hi(k); sf_code(k):=1000;
end;
cat_code(carriage_return):=car_ret; cat_code(" "):=spacer;
cat_code("\"):=escape; cat_code("%"):=comment;
cat_code(invalid_code):=invalid_char; cat_code(null_code):=ignore;
for k:="0" to "9" do math_code(k):=hi(k+var_code);
for k:="A" to "Z" do
begin cat_code(k):=letter; cat_code(k+"a"-"A"):=letter;@/
math_code(k):=hi(k+var_code+@"100);
math_code(k+"a"-"A"):=hi(k+"a"-"A"+var_code+@"100);@/
lc_code(k):=k+"a"-"A"; lc_code(k+"a"-"A"):=k+"a"-"A";@/
uc_code(k):=k; uc_code(k+"a"-"A"):=k;@/
sf_code(k):=999;
end;
@ @<Show equivalent |n|, in region 4@>=
if (n=par_shape_loc) or ((n>=etex_pen_base) and (n<etex_pens)) then
begin print_cmd_chr(set_shape,n); print_char("=");
if equiv(n)=null then print_char("0")
else if n>par_shape_loc then
begin print_int(penalty(equiv(n))); print_char(" ");
print_int(penalty(equiv(n)+1));
if penalty(equiv(n))>1 then print_esc("ETC.");
end
else print_int(info(par_shape_ptr));
end
else if n<toks_base then
begin print_cmd_chr(assign_toks,n); print_char("=");
if equiv(n)<>null then show_token_list(link(equiv(n)),null,32);
end
else if n<box_base then
begin print_esc("toks"); print_int(n-toks_base); print_char("=");
if equiv(n)<>null then show_token_list(link(equiv(n)),null,32);
end
else if n<cur_font_loc then
begin print_esc("box"); print_int(n-box_base); print_char("=");
if equiv(n)=null then print("void")
else begin depth_threshold:=0; breadth_max:=1; show_node_list(equiv(n));
end;
end
else if n<cat_code_base then @<Show the font identifier in |eqtb[n]|@>
else @<Show the halfword code in |eqtb[n]|@>
@ @<Show the font identifier in |eqtb[n]|@>=
begin if n=cur_font_loc then print("current font")
else if n<math_font_base+16 then
begin print_esc("textfont"); print_int(n-math_font_base);
end
else if n<math_font_base+32 then
begin print_esc("scriptfont"); print_int(n-math_font_base-16);
end
else begin print_esc("scriptscriptfont"); print_int(n-math_font_base-32);
end;
print_char("=");@/
print_esc(hash[font_id_base+equiv(n)].rh);
{that's |font_id_text(equiv(n))|}
end
@ @<Show the halfword code in |eqtb[n]|@>=
if n<math_code_base then
begin if n<lc_code_base then
begin print_esc("catcode"); print_int(n-cat_code_base);
end
else if n<uc_code_base then
begin print_esc("lccode"); print_int(n-lc_code_base);
end
else if n<sf_code_base then
begin print_esc("uccode"); print_int(n-uc_code_base);
end
else begin print_esc("sfcode"); print_int(n-sf_code_base);
end;
print_char("="); print_int(equiv(n));
end
else begin print_esc("mathcode"); print_int(n-math_code_base);
print_char("="); print_int(ho(equiv(n)));
end
@ Region 5 of |eqtb| contains the integer parameters and registers defined
here, as well as the |del_code| table. The latter table differs from the
|cat_code..math_code| tables that precede it, since delimiter codes are
fullword integers while the other kinds of codes occupy at most a
halfword. This is what makes region~5 different from region~4. We will
store the |eq_level| information in an auxiliary array of quarterwords
that will be defined later.
@d pretolerance_code=0 {badness tolerance before hyphenation}
@d tolerance_code=1 {badness tolerance after hyphenation}
@d line_penalty_code=2 {added to the badness of every line}
@d hyphen_penalty_code=3 {penalty for break after discretionary hyphen}
@d ex_hyphen_penalty_code=4 {penalty for break after explicit hyphen}
@d club_penalty_code=5 {penalty for creating a club line}
@d widow_penalty_code=6 {penalty for creating a widow line}
@d display_widow_penalty_code=7 {ditto, just before a display}
@d broken_penalty_code=8 {penalty for breaking a page at a broken line}
@d bin_op_penalty_code=9 {penalty for breaking after a binary operation}
@d rel_penalty_code=10 {penalty for breaking after a relation}
@d pre_display_penalty_code=11
{penalty for breaking just before a displayed formula}
@d post_display_penalty_code=12
{penalty for breaking just after a displayed formula}
@d inter_line_penalty_code=13 {additional penalty between lines}
@d double_hyphen_demerits_code=14 {demerits for double hyphen break}
@d final_hyphen_demerits_code=15 {demerits for final hyphen break}
@d adj_demerits_code=16 {demerits for adjacent incompatible lines}
@d mag_code=17 {magnification ratio}
@d delimiter_factor_code=18 {ratio for variable-size delimiters}
@d looseness_code=19 {change in number of lines for a paragraph}
@d time_code=20 {current time of day}
@d day_code=21 {current day of the month}
@d month_code=22 {current month of the year}
@d year_code=23 {current year of our Lord}
@d show_box_breadth_code=24 {nodes per level in |show_box|}
@d show_box_depth_code=25 {maximum level in |show_box|}
@d hbadness_code=26 {hboxes exceeding this badness will be shown by |hpack|}
@d vbadness_code=27 {vboxes exceeding this badness will be shown by |vpack|}
@d pausing_code=28 {pause after each line is read from a file}
@d tracing_online_code=29 {show diagnostic output on terminal}
@d tracing_macros_code=30 {show macros as they are being expanded}
@d tracing_stats_code=31 {show memory usage if \TeX\ knows it}
@d tracing_paragraphs_code=32 {show line-break calculations}
@d tracing_pages_code=33 {show page-break calculations}
@d tracing_output_code=34 {show boxes when they are shipped out}
@d tracing_lost_chars_code=35 {show characters that aren't in the font}
@d tracing_commands_code=36 {show command codes at |big_switch|}
@d tracing_restores_code=37 {show equivalents when they are restored}
@d uc_hyph_code=38 {hyphenate words beginning with a capital letter}
@d output_penalty_code=39 {penalty found at current page break}
@d max_dead_cycles_code=40 {bound on consecutive dead cycles of output}
@d hang_after_code=41 {hanging indentation changes after this many lines}
@d floating_penalty_code=42 {penalty for insertions held over after a split}
@d global_defs_code=43 {override \.{\\global} specifications}
@d cur_fam_code=44 {current family}
@d escape_char_code=45 {escape character for token output}
@d default_hyphen_char_code=46 {value of \.{\\hyphenchar} when a font is loaded}
@d default_skew_char_code=47 {value of \.{\\skewchar} when a font is loaded}
@d end_line_char_code=48 {character placed at the right end of the buffer}
@d new_line_char_code=49 {character that prints as |print_ln|}
@d language_code=50 {current hyphenation table}
@d left_hyphen_min_code=51 {minimum left hyphenation fragment size}
@d right_hyphen_min_code=52 {minimum right hyphenation fragment size}
@d holding_inserts_code=53 {do not remove insertion nodes from \.{\\box255}}
@d error_context_lines_code=54 {maximum intermediate line pairs shown}
@d tex_int_pars=55 {total number of \TeX's integer parameters}
@#
@d pdftex_first_integer_code = tex_int_pars {base for \pdfTeX's integer parameters}
@d pdf_output_code = pdftex_first_integer_code + 0 {switch on PDF output if positive}
@d pdf_compress_level_code = pdftex_first_integer_code + 1 {compress level of streams}
@d pdf_decimal_digits_code = pdftex_first_integer_code + 2 {digits after the decimal point of numbers}
@d pdf_move_chars_code = pdftex_first_integer_code + 3 {move chars 0..31 to higher area if possible}
@d pdf_image_resolution_code = pdftex_first_integer_code + 4 {default image resolution}
@d pdf_pk_resolution_code = pdftex_first_integer_code + 5 {default resolution of PK font}
@d pdf_unique_resname_code = pdftex_first_integer_code + 6 {generate unique names for resouces}
@d pdf_option_always_use_pdfpagebox_code = pdftex_first_integer_code + 7 {if the PDF inclusion should always use a specific PDF page box}
@d pdf_option_pdf_inclusion_errorlevel_code = pdftex_first_integer_code + 8 {if the PDF inclusion should treat pdfs newer than |pdf_minor_version| as an error}
@d pdf_major_version_code = pdftex_first_integer_code + 9 {integer part of the PDF version produced}
@d pdf_minor_version_code = pdftex_first_integer_code + 10 {fractional part of the PDF version produced}
@d pdf_force_pagebox_code = pdftex_first_integer_code + 11 {if the PDF inclusion should always use a specific PDF page box}
@d pdf_pagebox_code = pdftex_first_integer_code + 12 {default pagebox to use for PDF inclusion}
@d pdf_inclusion_errorlevel_code = pdftex_first_integer_code + 13 {if the PDF inclusion should treat pdfs newer than |pdf_minor_version| as an error}
@d pdf_gamma_code = pdftex_first_integer_code + 14
@d pdf_image_gamma_code = pdftex_first_integer_code + 15
@d pdf_image_hicolor_code = pdftex_first_integer_code + 16
@d pdf_image_apply_gamma_code = pdftex_first_integer_code + 17
@d pdf_adjust_spacing_code = pdftex_first_integer_code + 18 {level of spacing adjusting}
@d pdf_protrude_chars_code = pdftex_first_integer_code + 19 {protrude chars at left/right edge of paragraphs}
@d pdf_tracing_fonts_code = pdftex_first_integer_code + 20 {level of font detail in log}
@d pdf_objcompresslevel_code = pdftex_first_integer_code + 21 {activate object streams}
@d pdf_adjust_interword_glue_code = pdftex_first_integer_code + 22 {adjust interword glue?}
@d pdf_prepend_kern_code = pdftex_first_integer_code + 23 {prepend kern before certain characters?}
@d pdf_append_kern_code = pdftex_first_integer_code + 24 {append kern before certain characters?}
@d pdf_gen_tounicode_code = pdftex_first_integer_code + 25 {generate ToUnicode for fonts?}
@d pdf_draftmode_code = pdftex_first_integer_code + 26 {switch on draftmode if positive}
@d pdf_inclusion_copy_font_code = pdftex_first_integer_code + 27 {generate ToUnicode for fonts?}
@d pdf_suppress_warning_dup_dest_code = pdftex_first_integer_code + 28 {suppress warning about duplicated destinations}
@d pdf_suppress_warning_dup_map_code = pdftex_first_integer_code + 29 {suppress warning about duplicated map lines}
@d pdf_suppress_warning_page_group_code = pdftex_first_integer_code + 30 {suppress warning about multiple pdfs with page group}
@d pdf_info_omit_date_code = pdftex_first_integer_code + 31 {omit generating CreationDate and ModDate}
@d pdf_suppress_ptex_info_code = pdftex_first_integer_code + 32 {suppress /PTEX.* entries in PDF dictionaries}
@d pdf_omit_charset_code = pdftex_first_integer_code + 33 {suppress /PTEX.* entries in PDF dictionaries}
@d pdf_omit_info_dict_code = pdftex_first_integer_code + 34 {suppress /PTEX.* entries in PDF dictionaries}
@d pdf_omit_procset_code = pdftex_first_integer_code + 35 {suppress /PTEX.* entries in PDF dictionaries}
@d pdf_int_pars=pdftex_first_integer_code + 36 {total number of \pdfTeX's integer parameters}
@#
@d etex_int_base=pdf_int_pars {base for \eTeX's integer parameters}
@d tracing_assigns_code=etex_int_base {show assignments}
@d tracing_groups_code=etex_int_base+1 {show save/restore groups}
@d tracing_ifs_code=etex_int_base+2 {show conditionals}
@d tracing_scan_tokens_code=etex_int_base+3 {show pseudo file open and close}
@d tracing_nesting_code=etex_int_base+4 {show incomplete groups and ifs within files}
@d pre_display_direction_code=etex_int_base+5 {text direction preceding a display}
@d last_line_fit_code=etex_int_base+6 {adjustment for last line of paragraph}
@d saving_vdiscards_code=etex_int_base+7 {save items discarded from vlists}
@d saving_hyph_codes_code=etex_int_base+8 {save hyphenation codes for languages}
@d eTeX_state_code=etex_int_base+9 {\eTeX\ state variables}
@d etex_int_pars=eTeX_state_code+eTeX_states {total number of \eTeX's integer parameters}
@#
@d int_pars=etex_int_pars {total number of integer parameters}
@d count_base=int_base+int_pars {256 user \.{\\count} registers}
@d del_code_base=count_base+256 {256 delimiter code mappings}
@d dimen_base=del_code_base+256 {beginning of region 6}
@#
@d del_code(#)==eqtb[del_code_base+#].int
@d count(#)==eqtb[count_base+#].int
@d int_par(#)==eqtb[int_base+#].int {an integer parameter}
@d pretolerance==int_par(pretolerance_code)
@d tolerance==int_par(tolerance_code)
@d line_penalty==int_par(line_penalty_code)
@d hyphen_penalty==int_par(hyphen_penalty_code)
@d ex_hyphen_penalty==int_par(ex_hyphen_penalty_code)
@d club_penalty==int_par(club_penalty_code)
@d widow_penalty==int_par(widow_penalty_code)
@d display_widow_penalty==int_par(display_widow_penalty_code)
@d broken_penalty==int_par(broken_penalty_code)
@d bin_op_penalty==int_par(bin_op_penalty_code)
@d rel_penalty==int_par(rel_penalty_code)
@d pre_display_penalty==int_par(pre_display_penalty_code)
@d post_display_penalty==int_par(post_display_penalty_code)
@d inter_line_penalty==int_par(inter_line_penalty_code)
@d double_hyphen_demerits==int_par(double_hyphen_demerits_code)
@d final_hyphen_demerits==int_par(final_hyphen_demerits_code)
@d adj_demerits==int_par(adj_demerits_code)
@d mag==int_par(mag_code)
@d delimiter_factor==int_par(delimiter_factor_code)
@d looseness==int_par(looseness_code)
@d time==int_par(time_code)
@d day==int_par(day_code)
@d month==int_par(month_code)
@d year==int_par(year_code)
@d show_box_breadth==int_par(show_box_breadth_code)
@d show_box_depth==int_par(show_box_depth_code)
@d hbadness==int_par(hbadness_code)
@d vbadness==int_par(vbadness_code)
@d pausing==int_par(pausing_code)
@d tracing_online==int_par(tracing_online_code)
@d tracing_macros==int_par(tracing_macros_code)
@d tracing_stats==int_par(tracing_stats_code)
@d tracing_paragraphs==int_par(tracing_paragraphs_code)
@d tracing_pages==int_par(tracing_pages_code)
@d tracing_output==int_par(tracing_output_code)
@d tracing_lost_chars==int_par(tracing_lost_chars_code)
@d tracing_commands==int_par(tracing_commands_code)
@d tracing_restores==int_par(tracing_restores_code)
@d uc_hyph==int_par(uc_hyph_code)
@d output_penalty==int_par(output_penalty_code)
@d max_dead_cycles==int_par(max_dead_cycles_code)
@d hang_after==int_par(hang_after_code)
@d floating_penalty==int_par(floating_penalty_code)
@d global_defs==int_par(global_defs_code)
@d cur_fam==int_par(cur_fam_code)
@d escape_char==int_par(escape_char_code)
@d default_hyphen_char==int_par(default_hyphen_char_code)
@d default_skew_char==int_par(default_skew_char_code)
@d end_line_char==int_par(end_line_char_code)
@d new_line_char==int_par(new_line_char_code)
@d language==int_par(language_code)
@d left_hyphen_min==int_par(left_hyphen_min_code)
@d right_hyphen_min==int_par(right_hyphen_min_code)
@d holding_inserts==int_par(holding_inserts_code)
@d error_context_lines==int_par(error_context_lines_code)
@#
@d pdf_adjust_spacing == int_par(pdf_adjust_spacing_code)
@d pdf_protrude_chars == int_par(pdf_protrude_chars_code)
@d pdf_tracing_fonts == int_par(pdf_tracing_fonts_code)
@d pdf_adjust_interword_glue == int_par(pdf_adjust_interword_glue_code)
@d pdf_prepend_kern == int_par(pdf_prepend_kern_code)
@d pdf_append_kern == int_par(pdf_append_kern_code)
@d pdf_gen_tounicode == int_par(pdf_gen_tounicode_code)
@d pdf_output == int_par(pdf_output_code)
@d pdf_compress_level == int_par(pdf_compress_level_code)
@d pdf_objcompresslevel == int_par(pdf_objcompresslevel_code)
@d pdf_decimal_digits == int_par(pdf_decimal_digits_code)
@d pdf_move_chars == int_par(pdf_move_chars_code)
@d pdf_image_resolution == int_par(pdf_image_resolution_code)
@d pdf_pk_resolution == int_par(pdf_pk_resolution_code)
@d pdf_unique_resname == int_par(pdf_unique_resname_code)
@d pdf_option_always_use_pdfpagebox == int_par(pdf_option_always_use_pdfpagebox_code)
@d pdf_option_pdf_inclusion_errorlevel == int_par(pdf_option_pdf_inclusion_errorlevel_code)
@d pdf_major_version == int_par(pdf_major_version_code)
@d pdf_minor_version == int_par(pdf_minor_version_code)
@d pdf_force_pagebox == int_par(pdf_force_pagebox_code)
@d pdf_pagebox == int_par(pdf_pagebox_code)
@d pdf_inclusion_errorlevel == int_par(pdf_inclusion_errorlevel_code)
@d pdf_gamma == int_par(pdf_gamma_code)
@d pdf_image_gamma == int_par(pdf_image_gamma_code)
@d pdf_image_hicolor == int_par(pdf_image_hicolor_code)
@d pdf_image_apply_gamma == int_par(pdf_image_apply_gamma_code)
@d pdf_draftmode == int_par(pdf_draftmode_code)
@d pdf_inclusion_copy_font == int_par(pdf_inclusion_copy_font_code)
@d pdf_suppress_warning_dup_dest == int_par(pdf_suppress_warning_dup_dest_code)
@d pdf_suppress_warning_dup_map == int_par(pdf_suppress_warning_dup_map_code)
@d pdf_suppress_warning_page_group == int_par(pdf_suppress_warning_page_group_code)
@d pdf_info_omit_date == int_par(pdf_info_omit_date_code)
@d pdf_suppress_ptex_info == int_par(pdf_suppress_ptex_info_code)
@d pdf_omit_charset == int_par(pdf_omit_charset_code)
@d pdf_omit_info_dict == int_par(pdf_omit_info_dict_code)
@d pdf_omit_procset == int_par(pdf_omit_procset_code)
@#
@d tracing_assigns==int_par(tracing_assigns_code)
@d tracing_groups==int_par(tracing_groups_code)
@d tracing_ifs==int_par(tracing_ifs_code)
@d tracing_scan_tokens==int_par(tracing_scan_tokens_code)
@d tracing_nesting==int_par(tracing_nesting_code)
@d pre_display_direction==int_par(pre_display_direction_code)
@d last_line_fit==int_par(last_line_fit_code)
@d saving_vdiscards==int_par(saving_vdiscards_code)
@d saving_hyph_codes==int_par(saving_hyph_codes_code)
@<Assign the values |depth_threshold:=show_box_depth|...@>=
depth_threshold:=show_box_depth;
breadth_max:=show_box_breadth
@ We can print the symbolic name of an integer parameter as follows.
@p procedure print_param(@!n:integer);
begin case n of
pretolerance_code:print_esc("pretolerance");
tolerance_code:print_esc("tolerance");
line_penalty_code:print_esc("linepenalty");
hyphen_penalty_code:print_esc("hyphenpenalty");
ex_hyphen_penalty_code:print_esc("exhyphenpenalty");
club_penalty_code:print_esc("clubpenalty");
widow_penalty_code:print_esc("widowpenalty");
display_widow_penalty_code:print_esc("displaywidowpenalty");
broken_penalty_code:print_esc("brokenpenalty");
bin_op_penalty_code:print_esc("binoppenalty");
rel_penalty_code:print_esc("relpenalty");
pre_display_penalty_code:print_esc("predisplaypenalty");
post_display_penalty_code:print_esc("postdisplaypenalty");
inter_line_penalty_code:print_esc("interlinepenalty");
double_hyphen_demerits_code:print_esc("doublehyphendemerits");
final_hyphen_demerits_code:print_esc("finalhyphendemerits");
adj_demerits_code:print_esc("adjdemerits");
mag_code:print_esc("mag");
delimiter_factor_code:print_esc("delimiterfactor");
looseness_code:print_esc("looseness");
time_code:print_esc("time");
day_code:print_esc("day");
month_code:print_esc("month");
year_code:print_esc("year");
show_box_breadth_code:print_esc("showboxbreadth");
show_box_depth_code:print_esc("showboxdepth");
hbadness_code:print_esc("hbadness");
vbadness_code:print_esc("vbadness");
pausing_code:print_esc("pausing");
tracing_online_code:print_esc("tracingonline");
tracing_macros_code:print_esc("tracingmacros");
tracing_stats_code:print_esc("tracingstats");
tracing_paragraphs_code:print_esc("tracingparagraphs");
tracing_pages_code:print_esc("tracingpages");
tracing_output_code:print_esc("tracingoutput");
tracing_lost_chars_code:print_esc("tracinglostchars");
tracing_commands_code:print_esc("tracingcommands");
tracing_restores_code:print_esc("tracingrestores");
uc_hyph_code:print_esc("uchyph");
output_penalty_code:print_esc("outputpenalty");
max_dead_cycles_code:print_esc("maxdeadcycles");
hang_after_code:print_esc("hangafter");
floating_penalty_code:print_esc("floatingpenalty");
global_defs_code:print_esc("globaldefs");
cur_fam_code:print_esc("fam");
escape_char_code:print_esc("escapechar");
default_hyphen_char_code:print_esc("defaulthyphenchar");
default_skew_char_code:print_esc("defaultskewchar");
end_line_char_code:print_esc("endlinechar");
new_line_char_code:print_esc("newlinechar");
language_code:print_esc("language");
left_hyphen_min_code:print_esc("lefthyphenmin");
right_hyphen_min_code:print_esc("righthyphenmin");
holding_inserts_code:print_esc("holdinginserts");
error_context_lines_code:print_esc("errorcontextlines");
@#
pdf_output_code: print_esc("pdfoutput");
pdf_compress_level_code: print_esc("pdfcompresslevel");
pdf_objcompresslevel_code: print_esc("pdfobjcompresslevel");
pdf_decimal_digits_code: print_esc("pdfdecimaldigits");
pdf_move_chars_code: print_esc("pdfmovechars");
pdf_image_resolution_code: print_esc("pdfimageresolution");
pdf_pk_resolution_code: print_esc("pdfpkresolution");
pdf_unique_resname_code: print_esc("pdfuniqueresname");
pdf_option_always_use_pdfpagebox_code: print_esc("pdfoptionalwaysusepdfpagebox");
pdf_option_pdf_inclusion_errorlevel_code: print_esc("pdfoptionpdfinclusionerrorlevel");
pdf_major_version_code: print_esc("pdfmajorversion");
pdf_minor_version_code: print_esc("pdfminorversion");
pdf_force_pagebox_code: print_esc("pdfforcepagebox");
pdf_pagebox_code: print_esc("pdfpagebox");
pdf_inclusion_errorlevel_code: print_esc("pdfinclusionerrorlevel");
pdf_gamma_code: print_esc("pdfgamma");
pdf_image_gamma_code: print_esc("pdfimagegamma");
pdf_image_hicolor_code: print_esc("pdfimagehicolor");
pdf_image_apply_gamma_code: print_esc("pdfimageapplygamma");
pdf_adjust_spacing_code: print_esc("pdfadjustspacing");
pdf_protrude_chars_code: print_esc("pdfprotrudechars");
pdf_tracing_fonts_code: print_esc("pdftracingfonts");
pdf_adjust_interword_glue_code: print_esc("pdfadjustinterwordglue");
pdf_prepend_kern_code: print_esc("pdfprependkern");
pdf_append_kern_code: print_esc("pdfappendkern");
pdf_gen_tounicode_code: print_esc("pdfgentounicode");
pdf_draftmode_code: print_esc("pdfdraftmode");
pdf_inclusion_copy_font_code: print_esc("pdfinclusioncopyfonts");
pdf_suppress_warning_dup_dest_code: print_esc("pdfsuppresswarningdupdest");
pdf_suppress_warning_dup_map_code: print_esc("pdfsuppresswarningdupmap");
pdf_suppress_warning_page_group_code:print_esc("pdfsuppresswarningpagegroup");
pdf_info_omit_date_code:print_esc("pdfinfoomitdate");
pdf_suppress_ptex_info_code: print_esc("pdfsuppressptexinfo");
pdf_omit_charset_code: print_esc("pdfomitcharset");
pdf_omit_info_dict_code: print_esc("pdfomitinfodict");
pdf_omit_procset_code: print_esc("pdfomitprocset");
@/@<Cases for |print_param|@>@/
othercases print("[unknown integer parameter!]")
endcases;
end;
@ The integer parameter names must be entered into the hash table.
@<Put each...@>=
primitive("pretolerance",assign_int,int_base+pretolerance_code);@/
@!@:pretolerance_}{\.{\\pretolerance} primitive@>
primitive("tolerance",assign_int,int_base+tolerance_code);@/
@!@:tolerance_}{\.{\\tolerance} primitive@>
primitive("linepenalty",assign_int,int_base+line_penalty_code);@/
@!@:line_penalty_}{\.{\\linepenalty} primitive@>
primitive("hyphenpenalty",assign_int,int_base+hyphen_penalty_code);@/
@!@:hyphen_penalty_}{\.{\\hyphenpenalty} primitive@>
primitive("exhyphenpenalty",assign_int,int_base+ex_hyphen_penalty_code);@/
@!@:ex_hyphen_penalty_}{\.{\\exhyphenpenalty} primitive@>
primitive("clubpenalty",assign_int,int_base+club_penalty_code);@/
@!@:club_penalty_}{\.{\\clubpenalty} primitive@>
primitive("widowpenalty",assign_int,int_base+widow_penalty_code);@/
@!@:widow_penalty_}{\.{\\widowpenalty} primitive@>
primitive("displaywidowpenalty",
assign_int,int_base+display_widow_penalty_code);@/
@!@:display_widow_penalty_}{\.{\\displaywidowpenalty} primitive@>
primitive("brokenpenalty",assign_int,int_base+broken_penalty_code);@/
@!@:broken_penalty_}{\.{\\brokenpenalty} primitive@>
primitive("binoppenalty",assign_int,int_base+bin_op_penalty_code);@/
@!@:bin_op_penalty_}{\.{\\binoppenalty} primitive@>
primitive("relpenalty",assign_int,int_base+rel_penalty_code);@/
@!@:rel_penalty_}{\.{\\relpenalty} primitive@>
primitive("predisplaypenalty",assign_int,int_base+pre_display_penalty_code);@/
@!@:pre_display_penalty_}{\.{\\predisplaypenalty} primitive@>
primitive("postdisplaypenalty",assign_int,int_base+post_display_penalty_code);@/
@!@:post_display_penalty_}{\.{\\postdisplaypenalty} primitive@>
primitive("interlinepenalty",assign_int,int_base+inter_line_penalty_code);@/
@!@:inter_line_penalty_}{\.{\\interlinepenalty} primitive@>
primitive("doublehyphendemerits",
assign_int,int_base+double_hyphen_demerits_code);@/
@!@:double_hyphen_demerits_}{\.{\\doublehyphendemerits} primitive@>
primitive("finalhyphendemerits",
assign_int,int_base+final_hyphen_demerits_code);@/
@!@:final_hyphen_demerits_}{\.{\\finalhyphendemerits} primitive@>
primitive("adjdemerits",assign_int,int_base+adj_demerits_code);@/
@!@:adj_demerits_}{\.{\\adjdemerits} primitive@>
primitive("mag",assign_int,int_base+mag_code);@/
@!@:mag_}{\.{\\mag} primitive@>
primitive("delimiterfactor",assign_int,int_base+delimiter_factor_code);@/
@!@:delimiter_factor_}{\.{\\delimiterfactor} primitive@>
primitive("looseness",assign_int,int_base+looseness_code);@/
@!@:looseness_}{\.{\\looseness} primitive@>
primitive("time",assign_int,int_base+time_code);@/
@!@:time_}{\.{\\time} primitive@>
primitive("day",assign_int,int_base+day_code);@/
@!@:day_}{\.{\\day} primitive@>
primitive("month",assign_int,int_base+month_code);@/
@!@:month_}{\.{\\month} primitive@>
primitive("year",assign_int,int_base+year_code);@/
@!@:year_}{\.{\\year} primitive@>
primitive("showboxbreadth",assign_int,int_base+show_box_breadth_code);@/
@!@:show_box_breadth_}{\.{\\showboxbreadth} primitive@>
primitive("showboxdepth",assign_int,int_base+show_box_depth_code);@/
@!@:show_box_depth_}{\.{\\showboxdepth} primitive@>
primitive("hbadness",assign_int,int_base+hbadness_code);@/
@!@:hbadness_}{\.{\\hbadness} primitive@>
primitive("vbadness",assign_int,int_base+vbadness_code);@/
@!@:vbadness_}{\.{\\vbadness} primitive@>
primitive("pausing",assign_int,int_base+pausing_code);@/
@!@:pausing_}{\.{\\pausing} primitive@>
primitive("tracingonline",assign_int,int_base+tracing_online_code);@/
@!@:tracing_online_}{\.{\\tracingonline} primitive@>
primitive("tracingmacros",assign_int,int_base+tracing_macros_code);@/
@!@:tracing_macros_}{\.{\\tracingmacros} primitive@>
primitive("tracingstats",assign_int,int_base+tracing_stats_code);@/
@!@:tracing_stats_}{\.{\\tracingstats} primitive@>
primitive("tracingparagraphs",assign_int,int_base+tracing_paragraphs_code);@/
@!@:tracing_paragraphs_}{\.{\\tracingparagraphs} primitive@>
primitive("tracingpages",assign_int,int_base+tracing_pages_code);@/
@!@:tracing_pages_}{\.{\\tracingpages} primitive@>
primitive("tracingoutput",assign_int,int_base+tracing_output_code);@/
@!@:tracing_output_}{\.{\\tracingoutput} primitive@>
primitive("tracinglostchars",assign_int,int_base+tracing_lost_chars_code);@/
@!@:tracing_lost_chars_}{\.{\\tracinglostchars} primitive@>
primitive("tracingcommands",assign_int,int_base+tracing_commands_code);@/
@!@:tracing_commands_}{\.{\\tracingcommands} primitive@>
primitive("tracingrestores",assign_int,int_base+tracing_restores_code);@/
@!@:tracing_restores_}{\.{\\tracingrestores} primitive@>
primitive("uchyph",assign_int,int_base+uc_hyph_code);@/
@!@:uc_hyph_}{\.{\\uchyph} primitive@>
primitive("outputpenalty",assign_int,int_base+output_penalty_code);@/
@!@:output_penalty_}{\.{\\outputpenalty} primitive@>
primitive("maxdeadcycles",assign_int,int_base+max_dead_cycles_code);@/
@!@:max_dead_cycles_}{\.{\\maxdeadcycles} primitive@>
primitive("hangafter",assign_int,int_base+hang_after_code);@/
@!@:hang_after_}{\.{\\hangafter} primitive@>
primitive("floatingpenalty",assign_int,int_base+floating_penalty_code);@/
@!@:floating_penalty_}{\.{\\floatingpenalty} primitive@>
primitive("globaldefs",assign_int,int_base+global_defs_code);@/
@!@:global_defs_}{\.{\\globaldefs} primitive@>
primitive("fam",assign_int,int_base+cur_fam_code);@/
@!@:fam_}{\.{\\fam} primitive@>
primitive("escapechar",assign_int,int_base+escape_char_code);@/
@!@:escape_char_}{\.{\\escapechar} primitive@>
primitive("defaulthyphenchar",assign_int,int_base+default_hyphen_char_code);@/
@!@:default_hyphen_char_}{\.{\\defaulthyphenchar} primitive@>
primitive("defaultskewchar",assign_int,int_base+default_skew_char_code);@/
@!@:default_skew_char_}{\.{\\defaultskewchar} primitive@>
primitive("endlinechar",assign_int,int_base+end_line_char_code);@/
@!@:end_line_char_}{\.{\\endlinechar} primitive@>
primitive("newlinechar",assign_int,int_base+new_line_char_code);@/
@!@:new_line_char_}{\.{\\newlinechar} primitive@>
primitive("language",assign_int,int_base+language_code);@/
@!@:language_}{\.{\\language} primitive@>
primitive("lefthyphenmin",assign_int,int_base+left_hyphen_min_code);@/
@!@:left_hyphen_min_}{\.{\\lefthyphenmin} primitive@>
primitive("righthyphenmin",assign_int,int_base+right_hyphen_min_code);@/
@!@:right_hyphen_min_}{\.{\\righthyphenmin} primitive@>
primitive("holdinginserts",assign_int,int_base+holding_inserts_code);@/
@!@:holding_inserts_}{\.{\\holdinginserts} primitive@>
primitive("errorcontextlines",assign_int,int_base+error_context_lines_code);@/
@!@:error_context_lines_}{\.{\\errorcontextlines} primitive@>
primitive("pdfoutput",assign_int,int_base+pdf_output_code);@/
@!@:pdf_output_}{\.{\\pdfoutput} primitive@>
primitive("pdfcompresslevel",assign_int,int_base+pdf_compress_level_code);@/
@!@:pdf_compress_level_}{\.{\\pdfcompresslevel} primitive@>
primitive("pdfobjcompresslevel",assign_int,int_base+pdf_objcompresslevel_code);@/
@!@:pdf_objcompresslevel_}{\.{\\pdfobjcompresslevel} primitive@>
primitive("pdfdecimaldigits",assign_int,int_base+pdf_decimal_digits_code);@/
@!@:pdf_decimal_digits_}{\.{\\pdfdecimaldigits} primitive@>
primitive("pdfmovechars",assign_int,int_base+pdf_move_chars_code);@/
@!@:pdf_move_chars_}{\.{\\pdfmovechars} primitive@>
primitive("pdfimageresolution",assign_int,int_base+pdf_image_resolution_code);@/
@!@:pdf_image_resolution_}{\.{\\pdfimageresolution} primitive@>
primitive("pdfpkresolution",assign_int,int_base+pdf_pk_resolution_code);@/
@!@:pdf_pk_resolution_}{\.{\\pdfpkresolution} primitive@>
primitive("pdfuniqueresname",assign_int,int_base+pdf_unique_resname_code);@/
@!@:pdf_unique_resname_}{\.{\\pdfuniqueresname} primitive@>
primitive("pdfoptionpdfminorversion",assign_int,int_base+pdf_minor_version_code);@/
@!@:pdf_minor_version_}{\.{\\pdfoptionpdfminorversion} primitive@>
primitive("pdfoptionalwaysusepdfpagebox",assign_int,int_base+pdf_option_always_use_pdfpagebox_code);@/
@!@:pdf_option_always_use_pdfpagebox_}{\.{\\pdfoptionalwaysusepdfpagebox} primitive@>
primitive("pdfoptionpdfinclusionerrorlevel",assign_int,int_base+pdf_option_pdf_inclusion_errorlevel_code);@/
@!@:pdf_option_pdf_inclusion_errorlevel_}{\.{\\pdfoptionpdfinclusionerrorlevel} primitive@>
primitive("pdfmajorversion",assign_int,int_base+pdf_major_version_code);@/
@!@:pdf_major_version_}{\.{\\pdfmajorversion} primitive@>
primitive("pdfminorversion",assign_int,int_base+pdf_minor_version_code);@/
@!@:pdf_minor_version_}{\.{\\pdfminorversion} primitive@>
primitive("pdfforcepagebox",assign_int,int_base+pdf_force_pagebox_code);@/
@!@:pdf_force_pagebox_}{\.{\\pdfforcepagebox} primitive@>
primitive("pdfpagebox",assign_int,int_base+pdf_pagebox_code);@/
@!@:pdf_pagebox_}{\.{\\pdfpagebox} primitive@>
primitive("pdfinclusionerrorlevel",assign_int,int_base+pdf_inclusion_errorlevel_code);@/
@!@:pdf_inclusion_errorlevel_}{\.{\\pdfinclusionerrorlevel} primitive@>
primitive("pdfgamma",assign_int,int_base+pdf_gamma_code);@/
@!@:pdf_gamma_}{\.{\\pdfgamma} primitive@>
primitive("pdfimagegamma",assign_int,int_base+pdf_image_gamma_code);@/
@!@:pdf_image_gamma_}{\.{\\pdfimagegamma} primitive@>
primitive("pdfimagehicolor",assign_int,int_base+pdf_image_hicolor_code);@/
@!@:pdf_image_hicolor_}{\.{\\pdfimagehicolor} primitive@>
primitive("pdfimageapplygamma",assign_int,int_base+pdf_image_apply_gamma_code);@/
@!@:pdf_image_apply_gamma_}{\.{\\pdfimageapplygamma} primitive@>
primitive("pdfadjustspacing",assign_int,int_base+pdf_adjust_spacing_code);@/
@!@:pdf_adjust_spacing_}{\.{\\pdfadjustspacing} primitive@>
primitive("pdfprotrudechars",assign_int,int_base+pdf_protrude_chars_code);@/
@!@:pdf_protrude_chars_}{\.{\\pdfprotrudechars} primitive@>
primitive("pdftracingfonts",assign_int,int_base+pdf_tracing_fonts_code);@/
@!@:pdf_tracing_fonts_}{\.{\\pdftracingfonts} primitive@>
primitive("pdfadjustinterwordglue",assign_int,int_base+pdf_adjust_interword_glue_code);@/
@!@:pdf_adjust_interword_glue_}{\.{\\pdfadjustinterwordglue} primitive@>
primitive("pdfprependkern",assign_int,int_base+pdf_prepend_kern_code);@/
@!@:pdf_prepend_kern_}{\.{\\pdfprependkern} primitive@>
primitive("pdfappendkern",assign_int,int_base+pdf_append_kern_code);@/
@!@:pdf_append_kern_}{\.{\\pdfappendkern} primitive@>
primitive("pdfgentounicode",assign_int,int_base+pdf_gen_tounicode_code);@/
@!@:pdf_gen_tounicode_}{\.{\\pdfgentounicode} primitive@>
primitive("pdfdraftmode",assign_int,int_base+pdf_draftmode_code);@/
@!@:pdf_draftmode_}{\.{\\pdfdraftmode} primitive@>
primitive("pdfinclusioncopyfonts",assign_int,int_base+pdf_inclusion_copy_font_code);@/
@!@:pdf_inclusion_copy_font_}{\.{\\pdfinclusioncopyfonts} primitive@>
primitive("pdfsuppresswarningdupdest",assign_int,int_base+pdf_suppress_warning_dup_dest_code);@/
@!@:pdf_suppress_warning_dup_dest_}{\.{\\pdfsuppresswarningdupdest} primitive@>
primitive("pdfsuppresswarningdupmap",assign_int,int_base+pdf_suppress_warning_dup_map_code);@/
@!@:pdf_suppress_warning_dup_map_}{\.{\\pdfsuppresswarningdupmap} primitive@>
primitive("pdfsuppresswarningpagegroup",assign_int,int_base+pdf_suppress_warning_page_group_code);@/
@!@:pdf_suppress_warning_page_group_}{\.{\\pdfsuppresswarningpagegroup} primitive@>
primitive("pdfinfoomitdate",assign_int,int_base+pdf_info_omit_date_code);@/
@!@:pdf_info_omit_date_}{\.{\\pdfinfoomitdate} primitive@>
primitive("pdfsuppressptexinfo",assign_int,int_base+pdf_suppress_ptex_info_code);@/
@!@:pdf_suppress_ptex_info_}{\.{\\pdfsuppressptexinfo} primitive@>
primitive("pdfomitcharset",assign_int,int_base+pdf_omit_charset_code);@/
@!@:pdf_omit_charset}{\.{\\pdfomitcharset} primitive@>
primitive("pdfomitinfodict",assign_int,int_base+pdf_omit_info_dict_code);@/
@!@:pdf_omit_info_dict}{\.{\\pdfomitinfodict} primitive@>
primitive("pdfomitprocset",assign_int,int_base+pdf_omit_procset_code);@/
@!@:pdf_omit_procset}{\.{\\pdfomitprocset} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
assign_int: if chr_code<count_base then print_param(chr_code-int_base)
else begin print_esc("count"); print_int(chr_code-count_base);
end;
@ The integer parameters should really be initialized by a macro package;
the following initialization does the minimum to keep \TeX\ from
complete failure.
@^null delimiter@>
@<Initialize table entries...@>=
for k:=int_base to del_code_base-1 do eqtb[k].int:=0;
mag:=1000; tolerance:=10000; hang_after:=1; max_dead_cycles:=25;
escape_char:="\"; end_line_char:=carriage_return;
for k:=0 to 255 do del_code(k):=-1;
del_code("."):=0; {this null delimiter is used in error recovery}
@ The following procedure, which is called just before \TeX\ initializes its
input and output, establishes the initial values of the date and time.
@^system dependencies@>
Since standard \PASCAL\ cannot provide such information, something special
is needed. The program here simply assumes that suitable values appear in
the global variables \\{sys\_time}, \\{sys\_day}, \\{sys\_month}, and
\\{sys\_year} (which are initialized to noon on 4 July 1776,
in case the implementor is careless).
@p procedure fix_date_and_time;
begin sys_time:=12*60;
sys_day:=4; sys_month:=7; sys_year:=1776; {self-evident truths}
time:=sys_time; {minutes since midnight}
day:=sys_day; {day of the month}
month:=sys_month; {month of the year}
year:=sys_year; {Anno Domini}
end;
@ @<Show equivalent |n|, in region 5@>=
begin if n<count_base then print_param(n-int_base)
else if n<del_code_base then
begin print_esc("count"); print_int(n-count_base);
end
else begin print_esc("delcode"); print_int(n-del_code_base);
end;
print_char("="); print_int(eqtb[n].int);
end
@ @<Set variable |c| to the current escape character@>=c:=escape_char
@ @<Character |s| is the current new-line character@>=s=new_line_char
@ \TeX\ is occasionally supposed to print diagnostic information that
goes only into the transcript file, unless |tracing_online| is positive.
Here are two routines that adjust the destination of print commands:
@p procedure begin_diagnostic; {prepare to do some tracing}
begin old_setting:=selector;
if (tracing_online<=0)and(selector=term_and_log) then
begin decr(selector);
if history=spotless then history:=warning_issued;
end;
end;
@#
procedure end_diagnostic(@!blank_line:boolean);
{restore proper conditions after tracing}
begin print_nl("");
if blank_line then print_ln;
selector:=old_setting;
end;
@ Of course we had better declare a few more global variables, if the previous
routines are going to work.
@<Glob...@>=
@!old_setting:0..max_selector;
@!sys_time,@!sys_day,@!sys_month,@!sys_year:integer;
{date and time supplied by external system}
@ The final region of |eqtb| contains the dimension parameters defined
here, and the 256 \.{\\dimen} registers.
@d par_indent_code=0 {indentation of paragraphs}
@d math_surround_code=1 {space around math in text}
@d line_skip_limit_code=2 {threshold for |line_skip| instead of |baseline_skip|}
@d hsize_code=3 {line width in horizontal mode}
@d vsize_code=4 {page height in vertical mode}
@d max_depth_code=5 {maximum depth of boxes on main pages}
@d split_max_depth_code=6 {maximum depth of boxes on split pages}
@d box_max_depth_code=7 {maximum depth of explicit vboxes}
@d hfuzz_code=8 {tolerance for overfull hbox messages}
@d vfuzz_code=9 {tolerance for overfull vbox messages}
@d delimiter_shortfall_code=10 {maximum amount uncovered by variable delimiters}
@d null_delimiter_space_code=11 {blank space in null delimiters}
@d script_space_code=12 {extra space after subscript or superscript}
@d pre_display_size_code=13 {length of text preceding a display}
@d display_width_code=14 {length of line for displayed equation}
@d display_indent_code=15 {indentation of line for displayed equation}
@d overfull_rule_code=16 {width of rule that identifies overfull hboxes}
@d hang_indent_code=17 {amount of hanging indentation}
@d h_offset_code=18 {amount of horizontal offset when shipping pages out}
@d v_offset_code=19 {amount of vertical offset when shipping pages out}
@d emergency_stretch_code=20 {reduces badnesses on final pass of line-breaking}
@d pdftex_first_dimen_code = 21 {first number defined in this section}
@d pdf_h_origin_code = pdftex_first_dimen_code + 0 {horigin of the PDF output}
@d pdf_v_origin_code = pdftex_first_dimen_code + 1 {vorigin of the PDF output}
@d pdf_page_width_code = pdftex_first_dimen_code + 2 {page width of the PDF output}
@d pdf_page_height_code = pdftex_first_dimen_code + 3 {page height of the PDF output}
@d pdf_link_margin_code = pdftex_first_dimen_code + 4 {link margin in the PDF output}
@d pdf_dest_margin_code = pdftex_first_dimen_code + 5 {dest margin in the PDF output}
@d pdf_thread_margin_code = pdftex_first_dimen_code + 6 {thread margin in the PDF output}
@d pdf_first_line_height_code = pdftex_first_dimen_code + 7
@d pdf_last_line_depth_code = pdftex_first_dimen_code + 8
@d pdf_each_line_height_code = pdftex_first_dimen_code + 9
@d pdf_each_line_depth_code = pdftex_first_dimen_code + 10
@d pdf_ignored_dimen_code = pdftex_first_dimen_code + 11
@d pdf_px_dimen_code = pdftex_first_dimen_code + 12
@d pdftex_last_dimen_code = pdftex_first_dimen_code + 12 {last number defined in this section}
@d dimen_pars = pdftex_last_dimen_code + 1 {total number of dimension parameters}
@d scaled_base=dimen_base+dimen_pars
{table of 256 user-defined \.{\\dimen} registers}
@d eqtb_size=scaled_base+255 {largest subscript of |eqtb|}
@#
@d dimen(#)==eqtb[scaled_base+#].sc
@d dimen_par(#)==eqtb[dimen_base+#].sc {a scaled quantity}
@d par_indent==dimen_par(par_indent_code)
@d math_surround==dimen_par(math_surround_code)
@d line_skip_limit==dimen_par(line_skip_limit_code)
@d hsize==dimen_par(hsize_code)
@d vsize==dimen_par(vsize_code)
@d max_depth==dimen_par(max_depth_code)
@d split_max_depth==dimen_par(split_max_depth_code)
@d box_max_depth==dimen_par(box_max_depth_code)
@d hfuzz==dimen_par(hfuzz_code)
@d vfuzz==dimen_par(vfuzz_code)
@d delimiter_shortfall==dimen_par(delimiter_shortfall_code)
@d null_delimiter_space==dimen_par(null_delimiter_space_code)
@d script_space==dimen_par(script_space_code)
@d pre_display_size==dimen_par(pre_display_size_code)
@d display_width==dimen_par(display_width_code)
@d display_indent==dimen_par(display_indent_code)
@d overfull_rule==dimen_par(overfull_rule_code)
@d hang_indent==dimen_par(hang_indent_code)
@d h_offset==dimen_par(h_offset_code)
@d v_offset==dimen_par(v_offset_code)
@d emergency_stretch==dimen_par(emergency_stretch_code)
@d pdf_h_origin == dimen_par(pdf_h_origin_code)
@d pdf_v_origin == dimen_par(pdf_v_origin_code)
@d pdf_page_width == dimen_par(pdf_page_width_code)
@d pdf_page_height == dimen_par(pdf_page_height_code)
@d pdf_link_margin == dimen_par(pdf_link_margin_code)
@d pdf_dest_margin == dimen_par(pdf_dest_margin_code)
@d pdf_thread_margin == dimen_par(pdf_thread_margin_code)
@d pdf_first_line_height == dimen_par(pdf_first_line_height_code)
@d pdf_last_line_depth == dimen_par(pdf_last_line_depth_code)
@d pdf_each_line_height == dimen_par(pdf_each_line_height_code)
@d pdf_each_line_depth == dimen_par(pdf_each_line_depth_code)
@d pdf_ignored_dimen == dimen_par(pdf_ignored_dimen_code)
@d pdf_px_dimen == dimen_par(pdf_px_dimen_code)
@p procedure print_length_param(@!n:integer);
begin case n of
par_indent_code:print_esc("parindent");
math_surround_code:print_esc("mathsurround");
line_skip_limit_code:print_esc("lineskiplimit");
hsize_code:print_esc("hsize");
vsize_code:print_esc("vsize");
max_depth_code:print_esc("maxdepth");
split_max_depth_code:print_esc("splitmaxdepth");
box_max_depth_code:print_esc("boxmaxdepth");
hfuzz_code:print_esc("hfuzz");
vfuzz_code:print_esc("vfuzz");
delimiter_shortfall_code:print_esc("delimitershortfall");
null_delimiter_space_code:print_esc("nulldelimiterspace");
script_space_code:print_esc("scriptspace");
pre_display_size_code:print_esc("predisplaysize");
display_width_code:print_esc("displaywidth");
display_indent_code:print_esc("displayindent");
overfull_rule_code:print_esc("overfullrule");
hang_indent_code:print_esc("hangindent");
h_offset_code:print_esc("hoffset");
v_offset_code:print_esc("voffset");
emergency_stretch_code:print_esc("emergencystretch");
pdf_h_origin_code: print_esc("pdfhorigin");
pdf_v_origin_code: print_esc("pdfvorigin");
pdf_page_width_code: print_esc("pdfpagewidth");
pdf_page_height_code: print_esc("pdfpageheight");
pdf_link_margin_code: print_esc("pdflinkmargin");
pdf_dest_margin_code: print_esc("pdfdestmargin");
pdf_thread_margin_code: print_esc("pdfthreadmargin");
pdf_first_line_height_code: print_esc("pdffirstlineheight");
pdf_last_line_depth_code: print_esc("pdflastlinedepth");
pdf_each_line_height_code: print_esc("pdfeachlineheight");
pdf_each_line_depth_code: print_esc("pdfeachlinedepth");
pdf_ignored_dimen_code: print_esc("pdfignoreddimen");
pdf_px_dimen_code: print_esc("pdfpxdimen");
othercases print("[unknown dimen parameter!]")
endcases;
end;
@ @<Put each...@>=
primitive("parindent",assign_dimen,dimen_base+par_indent_code);@/
@!@:par_indent_}{\.{\\parindent} primitive@>
primitive("mathsurround",assign_dimen,dimen_base+math_surround_code);@/
@!@:math_surround_}{\.{\\mathsurround} primitive@>
primitive("lineskiplimit",assign_dimen,dimen_base+line_skip_limit_code);@/
@!@:line_skip_limit_}{\.{\\lineskiplimit} primitive@>
primitive("hsize",assign_dimen,dimen_base+hsize_code);@/
@!@:hsize_}{\.{\\hsize} primitive@>
primitive("vsize",assign_dimen,dimen_base+vsize_code);@/
@!@:vsize_}{\.{\\vsize} primitive@>
primitive("maxdepth",assign_dimen,dimen_base+max_depth_code);@/
@!@:max_depth_}{\.{\\maxdepth} primitive@>
primitive("splitmaxdepth",assign_dimen,dimen_base+split_max_depth_code);@/
@!@:split_max_depth_}{\.{\\splitmaxdepth} primitive@>
primitive("boxmaxdepth",assign_dimen,dimen_base+box_max_depth_code);@/
@!@:box_max_depth_}{\.{\\boxmaxdepth} primitive@>
primitive("hfuzz",assign_dimen,dimen_base+hfuzz_code);@/
@!@:hfuzz_}{\.{\\hfuzz} primitive@>
primitive("vfuzz",assign_dimen,dimen_base+vfuzz_code);@/
@!@:vfuzz_}{\.{\\vfuzz} primitive@>
primitive("delimitershortfall",
assign_dimen,dimen_base+delimiter_shortfall_code);@/
@!@:delimiter_shortfall_}{\.{\\delimitershortfall} primitive@>
primitive("nulldelimiterspace",
assign_dimen,dimen_base+null_delimiter_space_code);@/
@!@:null_delimiter_space_}{\.{\\nulldelimiterspace} primitive@>
primitive("scriptspace",assign_dimen,dimen_base+script_space_code);@/
@!@:script_space_}{\.{\\scriptspace} primitive@>
primitive("predisplaysize",assign_dimen,dimen_base+pre_display_size_code);@/
@!@:pre_display_size_}{\.{\\predisplaysize} primitive@>
primitive("displaywidth",assign_dimen,dimen_base+display_width_code);@/
@!@:display_width_}{\.{\\displaywidth} primitive@>
primitive("displayindent",assign_dimen,dimen_base+display_indent_code);@/
@!@:display_indent_}{\.{\\displayindent} primitive@>
primitive("overfullrule",assign_dimen,dimen_base+overfull_rule_code);@/
@!@:overfull_rule_}{\.{\\overfullrule} primitive@>
primitive("hangindent",assign_dimen,dimen_base+hang_indent_code);@/
@!@:hang_indent_}{\.{\\hangindent} primitive@>
primitive("hoffset",assign_dimen,dimen_base+h_offset_code);@/
@!@:h_offset_}{\.{\\hoffset} primitive@>
primitive("voffset",assign_dimen,dimen_base+v_offset_code);@/
@!@:v_offset_}{\.{\\voffset} primitive@>
primitive("emergencystretch",assign_dimen,dimen_base+emergency_stretch_code);@/
@!@:emergency_stretch_}{\.{\\emergencystretch} primitive@>
primitive("pdfhorigin",assign_dimen,dimen_base+pdf_h_origin_code);@/
@!@:pdf_h_origin_}{\.{\\pdfhorigin} primitive@>
primitive("pdfvorigin",assign_dimen,dimen_base+pdf_v_origin_code);@/
@!@:pdf_v_origin_}{\.{\\pdfvorigin} primitive@>
primitive("pdfpagewidth",assign_dimen,dimen_base+pdf_page_width_code);@/
@!@:pdf_page_width_}{\.{\\pdfpagewidth} primitive@>
primitive("pdfpageheight",assign_dimen,dimen_base+pdf_page_height_code);@/
@!@:pdf_page_height_}{\.{\\pdfpageheight} primitive@>
primitive("pdflinkmargin",assign_dimen,dimen_base+pdf_link_margin_code);@/
@!@:pdf_link_margin_}{\.{\\pdflinkmargin} primitive@>
primitive("pdfdestmargin",assign_dimen,dimen_base+pdf_dest_margin_code);@/
@!@:pdf_dest_margin_}{\.{\\pdfdestmargin} primitive@>
primitive("pdfthreadmargin",assign_dimen,dimen_base+pdf_thread_margin_code);@/
@!@:pdf_thread_margin_}{\.{\\pdfthreadmargin} primitive@>
primitive("pdffirstlineheight",assign_dimen,dimen_base+pdf_first_line_height_code);@/
@!@:pdf_first_line_height_}{\.{\\pdffirstlineheight} primitive@>
primitive("pdflastlinedepth",assign_dimen,dimen_base+pdf_last_line_depth_code);@/
@!@:pdf_last_line_depth_}{\.{\\pdflastlinedepth} primitive@>
primitive("pdfeachlineheight",assign_dimen,dimen_base+pdf_each_line_height_code);@/
@!@:pdf_each_line_height_}{\.{\\pdfeachlineheight} primitive@>
primitive("pdfeachlinedepth",assign_dimen,dimen_base+pdf_each_line_depth_code);@/
@!@:pdf_each_line_depth_}{\.{\\pdfeachlinedepth} primitive@>
primitive("pdfignoreddimen",assign_dimen,dimen_base+pdf_ignored_dimen_code);@/
@!@:pdf_ignored_dimen_}{\.{\\pdfignoreddimen} primitive@>
primitive("pdfpxdimen",assign_dimen,dimen_base+pdf_px_dimen_code);@/
@!@:pdf_px_dimen_}{\.{\\pdfpxdimen} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
assign_dimen: if chr_code<scaled_base then
print_length_param(chr_code-dimen_base)
else begin print_esc("dimen"); print_int(chr_code-scaled_base);
end;
@ @<Initialize table entries...@>=
for k:=dimen_base to eqtb_size do eqtb[k].sc:=0;
@ @<Show equivalent |n|, in region 6@>=
begin if n<scaled_base then print_length_param(n-dimen_base)
else begin print_esc("dimen"); print_int(n-scaled_base);
end;
print_char("="); print_scaled(eqtb[n].sc); print("pt");
end
@ Here is a procedure that displays the contents of |eqtb[n]|
symbolically.
@p@t\4@>@<Declare the procedure called |print_cmd_chr|@>@;@/
@!stat procedure show_eqtb(@!n:pointer);
begin if n<active_base then print_char("?") {this can't happen}
else if n<glue_base then @<Show equivalent |n|, in region 1 or 2@>
else if n<local_base then @<Show equivalent |n|, in region 3@>
else if n<int_base then @<Show equivalent |n|, in region 4@>
else if n<dimen_base then @<Show equivalent |n|, in region 5@>
else if n<=eqtb_size then @<Show equivalent |n|, in region 6@>
else print_char("?"); {this can't happen either}
end;
tats
@ The last two regions of |eqtb| have fullword values instead of the
three fields |eq_level|, |eq_type|, and |equiv|. An |eq_type| is unnecessary,
but \TeX\ needs to store the |eq_level| information in another array
called |xeq_level|.
@<Glob...@>=
@!eqtb:array[active_base..eqtb_size] of memory_word;
@!xeq_level:array[int_base..eqtb_size] of quarterword;
@ @<Set init...@>=
for k:=int_base to eqtb_size do xeq_level[k]:=level_one;
@ When the debugging routine |search_mem| is looking for pointers having a
given value, it is interested only in regions 1 to~3 of~|eqtb|, and in the
first part of region~4.
@<Search |eqtb| for equivalents equal to |p|@>=
for q:=active_base to box_base+255 do
begin if equiv(q)=p then
begin print_nl("EQUIV("); print_int(q); print_char(")");
end;
end
@* \[18] The hash table.
Control sequences are stored and retrieved by means of a fairly standard hash
table algorithm called the method of ``coalescing lists'' (cf.\ Algorithm 6.4C
in {\sl The Art of Computer Programming\/}). Once a control sequence enters the
table, it is never removed, because there are complicated situations
involving \.{\\gdef} where the removal of a control sequence at the end of
a group would be a mistake preventable only by the introduction of a
complicated reference-count mechanism.
The actual sequence of letters forming a control sequence identifier is
stored in the |str_pool| array together with all the other strings. An
auxiliary array |hash| consists of items with two halfword fields per
word. The first of these, called |next(p)|, points to the next identifier
belonging to the same coalesced list as the identifier corresponding to~|p|;
and the other, called |text(p)|, points to the |str_start| entry for
|p|'s identifier. If position~|p| of the hash table is empty, we have
|text(p)=0|; if position |p| is either empty or the end of a coalesced
hash list, we have |next(p)=0|. An auxiliary pointer variable called
|hash_used| is maintained in such a way that all locations |p>=hash_used|
are nonempty. The global variable |cs_count| tells how many multiletter
control sequences have been defined, if statistics are being kept.
A global boolean variable called |no_new_control_sequence| is set to
|true| during the time that new hash table entries are forbidden.
@d next(#) == hash[#].lh {link for coalesced lists}
@d text(#) == hash[#].rh {string number for control sequence name}
@d hash_is_full == (hash_used=hash_base) {test if all positions are occupied}
@d font_id_text(#) == text(font_id_base+#) {a frozen font identifier's name}
@<Glob...@>=
@!hash: array[hash_base..undefined_control_sequence-1] of two_halves;
{the hash table}
@!hash_used:pointer; {allocation pointer for |hash|}
@!no_new_control_sequence:boolean; {are new identifiers legal?}
@!cs_count:integer; {total number of known identifiers}
@ Primitive support needs a few extra variables and definitions
@d prim_prime=1777 {about 85\pct! of |primitive_size|}
@d prim_base=1
@d prim_next(#) == prim[#].lh {link for coalesced lists}
@d prim_text(#) == prim[#].rh {string number for control sequence name, plus one}
@d prim_is_full == (prim_used=prim_base) {test if all positions are occupied}
@d prim_eq_level_field(#)==#.hh.b1
@d prim_eq_type_field(#)==#.hh.b0
@d prim_equiv_field(#)==#.hh.rh
@d prim_eq_level(#)==prim_eq_level_field(eqtb[prim_eqtb_base+#]) {level of definition}
@d prim_eq_type(#)==prim_eq_type_field(eqtb[prim_eqtb_base+#]) {command code for equivalent}
@d prim_equiv(#)==prim_equiv_field(eqtb[prim_eqtb_base+#]) {equivalent value}
@d undefined_primitive=0
@d biggest_char=255 { 65535 in XeTeX }
@<Glob...@>=
@!prim: array [0..prim_size] of two_halves; {the primitives table}
@!prim_used:pointer; {allocation pointer for |prim|}
@ @<Set init...@>=
no_new_control_sequence:=true; {new identifiers are usually forbidden}
prim_next(0):=0; prim_text(0):=0;
for k:=1 to prim_size do prim[k]:=prim[0];
next(hash_base):=0; text(hash_base):=0;
for k:=hash_base+1 to undefined_control_sequence-1 do hash[k]:=hash[hash_base];
@ @<Initialize table entries...@>=
prim_used:=prim_size; {nothing is used}
hash_used:=frozen_control_sequence; {nothing is used}
cs_count:=0;
eq_type(frozen_dont_expand):=dont_expand;
text(frozen_dont_expand):="notexpanded:";
@.notexpanded:@>
eq_type(frozen_primitive):=ignore_spaces;
equiv(frozen_primitive):=1;
eq_level(frozen_primitive):=level_one;
text(frozen_primitive):="pdfprimitive";
@ Here is the subroutine that searches the hash table for an identifier
that matches a given string of length |l>1| appearing in |buffer[j..
(j+l-1)]|. If the identifier is found, the corresponding hash table address
is returned. Otherwise, if the global variable |no_new_control_sequence|
is |true|, the dummy address |undefined_control_sequence| is returned.
Otherwise the identifier is inserted into the hash table and its location
is returned.
@p function id_lookup(@!j,@!l:integer):pointer; {search the hash table}
label found; {go here if you found it}
var h:integer; {hash code}
@!d:integer; {number of characters in incomplete current string}
@!p:pointer; {index in |hash| array}
@!k:pointer; {index in |buffer| array}
begin @<Compute the hash code |h|@>;
p:=h+hash_base; {we start searching here; note that |0<=h<hash_prime|}
loop@+begin if text(p)>0 then if length(text(p))=l then
if str_eq_buf(text(p),j) then goto found;
if next(p)=0 then
begin if no_new_control_sequence then
p:=undefined_control_sequence
else @<Insert a new control sequence after |p|, then make
|p| point to it@>;
goto found;
end;
p:=next(p);
end;
found: id_lookup:=p;
end;
@ @<Insert a new control...@>=
begin if text(p)>0 then
begin repeat if hash_is_full then overflow("hash size",hash_size);
@:TeX capacity exceeded hash size}{\quad hash size@>
decr(hash_used);
until text(hash_used)=0; {search for an empty location in |hash|}
next(p):=hash_used; p:=hash_used;
end;
str_room(l); d:=cur_length;
while pool_ptr>str_start[str_ptr] do
begin decr(pool_ptr); str_pool[pool_ptr+l]:=str_pool[pool_ptr];
end; {move current string up to make room for another}
for k:=j to j+l-1 do append_char(buffer[k]);
text(p):=make_string; pool_ptr:=pool_ptr+d;
@!stat incr(cs_count);@+tats@;@/
end
@ The value of |hash_prime| should be roughly 85\pct! of |hash_size|, and it
should be a prime number. The theory of hashing tells us to expect fewer
than two table probes, on the average, when the search is successful.
[See J.~S. Vitter, {\sl Journal of the ACM\/ \bf30} (1983), 231--258.]
@^Vitter, Jeffrey Scott@>
@<Compute the hash code |h|@>=
h:=buffer[j];
for k:=j+1 to j+l-1 do
begin h:=h+h+buffer[k];
while h>=hash_prime do h:=h-hash_prime;
end
@ Here is the subroutine that searches the primitive table for an identifier:
@p function prim_lookup(@!s:str_number):pointer; {search the primitives table}
label found; {go here if you found it}
var h:integer; {hash code}
@!p:pointer; {index in |hash| array}
@!k:pointer; {index in string pool}
@!j,@!l:integer;
begin
if s<=biggest_char then begin
if s<0 then begin p:=undefined_primitive; goto found; end
else p:=(s mod prim_prime)+prim_base; {we start searching here}
end
else begin
j:=str_start[s];
if s = str_ptr then l := cur_length else l := length(s);
@<Compute the primitive code |h|@>;
p:=h+prim_base; {we start searching here; note that |0<=h<prim_prime|}
end;
loop@+begin
if prim_text(p)>1+biggest_char then { |p| points a multi-letter primitive }
begin if length(prim_text(p)-1)=l then
if str_eq_str(prim_text(p)-1,s) then goto found;
end
else if prim_text(p)=1+s then goto found; { |p| points a single-letter primitive }
if prim_next(p)=0 then
begin if no_new_control_sequence then
p:=undefined_primitive
else @<Insert a new primitive after |p|, then make
|p| point to it@>;
goto found;
end;
p:=prim_next(p);
end;
found: prim_lookup:=p;
end;
@ @<Insert a new primitive...@>=
begin if prim_text(p)>0 then
begin repeat if prim_is_full then overflow("primitive size",prim_size);
@:TeX capacity exceeded primitive size}{\quad primitive size@>
decr(prim_used);
until prim_text(prim_used)=0; {search for an empty location in |prim|}
prim_next(p):=prim_used; p:=prim_used;
end;
prim_text(p):=s+1;
end
@ The value of |prim_prime| should be roughly 85\pct! of
|prim_size|, and it should be a prime number.
@<Compute the primitive code |h|@>=
h:=str_pool[j];
for k:=j+1 to j+l-1 do
begin h:=h+h+str_pool[k];
while h>=prim_prime do h:=h-prim_prime;
end
@ Single-character control sequences do not need to be looked up in a hash
table, since we can use the character code itself as a direct address.
The procedure |print_cs| prints the name of a control sequence, given
a pointer to its address in |eqtb|. A space is printed after the name
unless it is a single nonletter or an active character. This procedure
might be invoked with invalid data, so it is ``extra robust.'' The
individual characters must be printed one at a time using |print|, since
they may be unprintable.
@<Basic printing...@>=
procedure print_cs(@!p:integer); {prints a purported control sequence}
begin if p<hash_base then {single character}
if p>=single_base then
if p=null_cs then
begin print_esc("csname"); print_esc("endcsname"); print_char(" ");
end
else begin print_esc(p-single_base);
if cat_code(p-single_base)=letter then print_char(" ");
end
else if p<active_base then print_esc("IMPOSSIBLE.")
@.IMPOSSIBLE@>
else print(p-active_base)
else if p>=undefined_control_sequence then print_esc("IMPOSSIBLE.")
else if (text(p)<0)or(text(p)>=str_ptr) then print_esc("NONEXISTENT.")
@.NONEXISTENT@>
else begin
if (p>=prim_eqtb_base)and(p<frozen_null_font) then
print_esc(prim_text(p-prim_eqtb_base)-1) else print_esc(text(p));
print_char(" ");
end;
end;
@ Here is a similar procedure; it avoids the error checks, and it never
prints a space after the control sequence.
@<Basic printing procedures@>=
procedure sprint_cs(@!p:pointer); {prints a control sequence}
begin if p<hash_base then
if p<single_base then print(p-active_base)
else if p<null_cs then print_esc(p-single_base)
else begin print_esc("csname"); print_esc("endcsname");
end
else if (p>=prim_eqtb_base)and(p<frozen_null_font) then
print_esc(prim_text(p-prim_eqtb_base)-1)
else print_esc(text(p));
end;
@ We need to put \TeX's ``primitive'' control sequences into the hash
table, together with their command code (which will be the |eq_type|)
and an operand (which will be the |equiv|). The |primitive| procedure
does this, in a way that no \TeX\ user can. The global value |cur_val|
contains the new |eqtb| pointer after |primitive| has acted.
Until pdf\TeX\ 1.40.19 (released in 2018), a bug in primitive handling
caused, e.g., \.{\\pdfprimitive\\ \\q} to swallow the \.{\\q} instead of
giving an undefined control sequence error. The original report was
posted by Hironori Kitagawa
(\.{tug.org/pipermail/tex-k/2017-October/002816.html}). Largely
quoting from that message:
The cause was |cur_tok| not being set in the ``Cases of |main_control|\dots''
module, because |back_input| unscans the token, but only looks at
|cur_tok|, which represents the internalized \.{\\pdfprimitive} at that
time. So \.{\\pdfprimitive\\vrule\\q} becomes ``(internalized
\.{\\pdfprimitive})''\.{\\q}, hence no error (and \.{\\vrule} disappears).
Hironori's explanation of the previous behavior and fix continues (off-list):
\yskip\textindent{*} |back_input| (and similar routine $\langle\,$Insert token
|p| into \TeX's input$\,\rangle$) only stores |cur_tok| to a token list.
\textindent{*} When \TeX\ gets input from a token list (at module
$\langle\,$Input from token list, |goto restart| \dots$\,\rangle$),
\TeX\ looks at the saved |cur_tok| value $t$, and recover the command
code (|cur_cmd|) and its modifier (|cur_chr|) from it:
{\advance\leftskip by 1.5em
\textindent{--} If |t>=cs_token_flag|, $t$ points to an |eqtb| location
|t - cs_token_flag|.
\textindent{--} If |t<cs_token_flag|, |cur_cmd| and |cur_chr| are set
with |cur_cmd:=t div @'400; cur_chr:=t mod @'400|.
\textindent{--} This $t$ is used to display the token (|show_token_list|).
\par}
\textindent{*} pdf\TeX\ defines |cs_token_flag| as \.{"FFF}. So simply
using |cur_tok:=(cur_cmd*@'400)+cur_chr| by \.{\\pdfprimitive} does not
work correctly with primitives whose command codes |cur_cmd| $\ge16$.
Increasing |cs_token_flag| to \.{"FFFF} or somewhat higher
might suffice for fixing this situation in pdf\TeX.
However, this approach does not seem good, because
\textindent{1)} an (indirect) mapping from |cur_tok| to control sequence
name is needed anyway, for displaying the token, and
\textindent{2)} this does not work in Japanese e-(u)p\TeX.
Thus, we now put |prim_eqtb| entries into the end of region 2 of
|eqtb| (which contains some frozen primitives, such as ``frozen \.{\\fi}''
and ``frozen \.{\\cr}''), thus treating |prim_eqtb| entries as a permanent
location for primitives.
@p @!init procedure primitive(@!s:str_number;@!c:quarterword;@!o:halfword);
var k:pool_pointer; {index into |str_pool|}
@!j:0..buf_size; {index into |buffer|}
@!l:small_number; {length of the string}
@!prim_val:integer; {needed to fill |prim_eqtb|}
begin if s<256 then begin
cur_val:=s+single_base;
prim_val:=prim_lookup(s);
end
else begin k:=str_start[s]; l:=str_start[s+1]-k;
{we will move |s| into the (possibly non-empty) |buffer|}
if first+l>buf_size+1 then
overflow("buffer size",buf_size);
@:TeX capacity exceeded buffer size}{\quad buffer size@>
for j:=0 to l-1 do buffer[first+j]:=so(str_pool[k+j]);
cur_val:=id_lookup(first,l); {|no_new_control_sequence| is |false|}
flush_string; text(cur_val):=s; {we don't want to have the string twice}
prim_val:=prim_lookup(s);
end;
eq_level(cur_val):=level_one; eq_type(cur_val):=c; equiv(cur_val):=o;
prim_eq_level(prim_val):=level_one;
prim_eq_type(prim_val):=c;
prim_equiv(prim_val):=o;
end;
tini
@ Many of \TeX's primitives need no |equiv|, since they are identifiable
by their |eq_type| alone. These primitives are loaded into the hash table
as follows:
@<Put each of \TeX's primitives into the hash table@>=
primitive(" ",ex_space,0);@/
@!@:Single-character primitives /}{\quad\.{\\\ }@>
primitive("/",ital_corr,0);@/
@!@:Single-character primitives /}{\quad\.{\\/}@>
primitive("accent",accent,0);@/
@!@:accent_}{\.{\\accent} primitive@>
primitive("advance",advance,0);@/
@!@:advance_}{\.{\\advance} primitive@>
primitive("afterassignment",after_assignment,0);@/
@!@:after_assignment_}{\.{\\afterassignment} primitive@>
primitive("aftergroup",after_group,0);@/
@!@:after_group_}{\.{\\aftergroup} primitive@>
primitive("begingroup",begin_group,0);@/
@!@:begin_group_}{\.{\\begingroup} primitive@>
primitive("char",char_num,0);@/
@!@:char_}{\.{\\char} primitive@>
primitive("csname",cs_name,0);@/
@!@:cs_name_}{\.{\\csname} primitive@>
primitive("delimiter",delim_num,0);@/
@!@:delimiter_}{\.{\\delimiter} primitive@>
primitive("divide",divide,0);@/
@!@:divide_}{\.{\\divide} primitive@>
primitive("endcsname",end_cs_name,0);@/
@!@:end_cs_name_}{\.{\\endcsname} primitive@>
primitive("endgroup",end_group,0);
@!@:end_group_}{\.{\\endgroup} primitive@>
text(frozen_end_group):="endgroup"; eqtb[frozen_end_group]:=eqtb[cur_val];@/
primitive("expandafter",expand_after,0);@/
@!@:expand_after_}{\.{\\expandafter} primitive@>
primitive("font",def_font,0);@/
@!@:font_}{\.{\\font} primitive@>
primitive("letterspacefont",letterspace_font,0);@/
@!@:letterspace_font_}{\.{\\letterspacefont} primitive@>
primitive("pdfcopyfont",pdf_copy_font,0);@/
@!@:pdf_copy_font_}{\.{\\pdfcopyfont} primitive@>
primitive("fontdimen",assign_font_dimen,0);@/
@!@:font_dimen_}{\.{\\fontdimen} primitive@>
primitive("halign",halign,0);@/
@!@:halign_}{\.{\\halign} primitive@>
primitive("hrule",hrule,0);@/
@!@:hrule_}{\.{\\hrule} primitive@>
primitive("ignorespaces",ignore_spaces,0);@/
@!@:ignore_spaces_}{\.{\\ignorespaces} primitive@>
primitive("insert",insert,0);@/
@!@:insert_}{\.{\\insert} primitive@>
primitive("mark",mark,0);@/
@!@:mark_}{\.{\\mark} primitive@>
primitive("mathaccent",math_accent,0);@/
@!@:math_accent_}{\.{\\mathaccent} primitive@>
primitive("mathchar",math_char_num,0);@/
@!@:math_char_}{\.{\\mathchar} primitive@>
primitive("mathchoice",math_choice,0);@/
@!@:math_choice_}{\.{\\mathchoice} primitive@>
primitive("multiply",multiply,0);@/
@!@:multiply_}{\.{\\multiply} primitive@>
primitive("noalign",no_align,0);@/
@!@:no_align_}{\.{\\noalign} primitive@>
primitive("noboundary",no_boundary,0);@/
@!@:no_boundary_}{\.{\\noboundary} primitive@>
primitive("noexpand",no_expand,0);@/
@!@:no_expand_}{\.{\\noexpand} primitive@>
primitive("pdfprimitive",no_expand,1);@/
@!@:pdfprimitive_}{\.{\\pdfprimitive} primitive@>
primitive("nonscript",non_script,0);@/
@!@:non_script_}{\.{\\nonscript} primitive@>
primitive("omit",omit,0);@/
@!@:omit_}{\.{\\omit} primitive@>
primitive("parshape",set_shape,par_shape_loc);@/
@!@:par_shape_}{\.{\\parshape} primitive@>
primitive("penalty",break_penalty,0);@/
@!@:penalty_}{\.{\\penalty} primitive@>
primitive("prevgraf",set_prev_graf,0);@/
@!@:prev_graf_}{\.{\\prevgraf} primitive@>
primitive("radical",radical,0);@/
@!@:radical_}{\.{\\radical} primitive@>
primitive("read",read_to_cs,0);@/
@!@:read_}{\.{\\read} primitive@>
primitive("relax",relax,256); {cf.\ |scan_file_name|}
@!@:relax_}{\.{\\relax} primitive@>
text(frozen_relax):="relax"; eqtb[frozen_relax]:=eqtb[cur_val];@/
primitive("setbox",set_box,0);@/
@!@:set_box_}{\.{\\setbox} primitive@>
primitive("the",the,0);@/
@!@:the_}{\.{\\the} primitive@>
primitive("toks",toks_register,mem_bot);@/
@!@:toks_}{\.{\\toks} primitive@>
primitive("vadjust",vadjust,0);@/
@!@:vadjust_}{\.{\\vadjust} primitive@>
primitive("valign",valign,0);@/
@!@:valign_}{\.{\\valign} primitive@>
primitive("vcenter",vcenter,0);@/
@!@:vcenter_}{\.{\\vcenter} primitive@>
primitive("vrule",vrule,0);@/
@!@:vrule_}{\.{\\vrule} primitive@>
@ Each primitive has a corresponding inverse, so that it is possible to
display the cryptic numeric contents of |eqtb| in symbolic form.
Every call of |primitive| in this program is therefore accompanied by some
straightforward code that forms part of the |print_cmd_chr| routine
below.
@<Cases of |print_cmd_chr|...@>=
accent: print_esc("accent");
advance: print_esc("advance");
after_assignment: print_esc("afterassignment");
after_group: print_esc("aftergroup");
assign_font_dimen: print_esc("fontdimen");
begin_group: print_esc("begingroup");
break_penalty: print_esc("penalty");
char_num: print_esc("char");
cs_name: print_esc("csname");
def_font: print_esc("font");
letterspace_font: print_esc("letterspacefont");
pdf_copy_font: print_esc("pdfcopyfont");
delim_num: print_esc("delimiter");
divide: print_esc("divide");
end_cs_name: print_esc("endcsname");
end_group: print_esc("endgroup");
ex_space: print_esc(" ");
expand_after: if chr_code=0 then print_esc("expandafter")
@<Cases of |expandafter| for |print_cmd_chr|@>;
halign: print_esc("halign");
hrule: print_esc("hrule");
ignore_spaces: if chr_code=0 then print_esc("ignorespaces") else print_esc("pdfprimitive");
insert: print_esc("insert");
ital_corr: print_esc("/");
mark: begin print_esc("mark");
if chr_code>0 then print_char("s");
end;
math_accent: print_esc("mathaccent");
math_char_num: print_esc("mathchar");
math_choice: print_esc("mathchoice");
multiply: print_esc("multiply");
no_align: print_esc("noalign");
no_boundary:print_esc("noboundary");
no_expand: if chr_code=0 then print_esc("noexpand")
else print_esc("pdfprimitive");
non_script: print_esc("nonscript");
omit: print_esc("omit");
radical: print_esc("radical");
read_to_cs: if chr_code=0 then print_esc("read")
@<Cases of |read| for |print_cmd_chr|@>;
relax: print_esc("relax");
set_box: print_esc("setbox");
set_prev_graf: print_esc("prevgraf");
set_shape: case chr_code of
par_shape_loc: print_esc("parshape");
@<Cases of |set_shape| for |print_cmd_chr|@>@;@/
end; {there are no other cases}
the: if chr_code=0 then print_esc("the")
@<Cases of |the| for |print_cmd_chr|@>;
toks_register: @<Cases of |toks_register| for |print_cmd_chr|@>;
vadjust: print_esc("vadjust");
valign: if chr_code=0 then print_esc("valign")@/
@<Cases of |valign| for |print_cmd_chr|@>;
vcenter: print_esc("vcenter");
vrule: print_esc("vrule");
@ We will deal with the other primitives later, at some point in the program
where their |eq_type| and |equiv| values are more meaningful. For example,
the primitives for math mode will be loaded when we consider the routines
that deal with formulas. It is easy to find where each particular
primitive was treated by looking in the index at the end; for example, the
section where |"radical"| entered |eqtb| is listed under `\.{\\radical}
primitive'. (Primitives consisting of a single nonalphabetic character,
@!like `\.{\\/}', are listed under `Single-character primitives'.)
@!@^Single-character primitives@>
Meanwhile, this is a convenient place to catch up on something we were unable
to do before the hash table was defined:
@* \[19] Saving and restoring equivalents.
The nested structure provided by `$\.{\char'173}\ldots\.{\char'175}$' groups
in \TeX\ means that |eqtb| entries valid in outer groups should be saved
and restored later if they are overridden inside the braces. When a new |eqtb|
value is being assigned, the program therefore checks to see if the previous
entry belongs to an outer level. In such a case, the old value is placed
on the |save_stack| just before the new value enters |eqtb|. At the
end of a grouping level, i.e., when the right brace is sensed, the
|save_stack| is used to restore the outer values, and the inner ones are
destroyed.
Entries on the |save_stack| are of type |memory_word|. The top item on
this stack is |save_stack[p]|, where |p=save_ptr-1|; it contains three
fields called |save_type|, |save_level|, and |save_index|, and it is
interpreted in one of five ways:
\yskip\hangg 1) If |save_type(p)=restore_old_value|, then
|save_index(p)| is a location in |eqtb| whose current value should
be destroyed at the end of the current group and replaced by |save_stack[p-1]|.
Furthermore if |save_index(p)>=int_base|, then |save_level(p)|
should replace the corresponding entry in |xeq_level|.
\yskip\hangg 2) If |save_type(p)=restore_zero|, then |save_index(p)|
is a location in |eqtb| whose current value should be destroyed at the end
of the current group, when it should be
replaced by the value of |eqtb[undefined_control_sequence]|.
\yskip\hangg 3) If |save_type(p)=insert_token|, then |save_index(p)|
is a token that should be inserted into \TeX's input when the current
group ends.
\yskip\hangg 4) If |save_type(p)=level_boundary|, then |save_level(p)|
is a code explaining what kind of group we were previously in, and
|save_index(p)| points to the level boundary word at the bottom of
the entries for that group.
Furthermore, in extended \eTeX\ mode, |save_stack[p-1]| contains the
source line number at which the current level of grouping was entered.
\yskip\hang 5) If |save_type(p)=restore_sa|, then |sa_chain| points to a
chain of sparse array entries to be restored at the end of the current
group. Furthermore |save_index(p)| and |save_level(p)| should replace
the values of |sa_chain| and |sa_level| respectively.
@d save_type(#)==save_stack[#].hh.b0 {classifies a |save_stack| entry}
@d save_level(#)==save_stack[#].hh.b1
{saved level for regions 5 and 6, or group code}
@d save_index(#)==save_stack[#].hh.rh
{|eqtb| location or token or |save_stack| location}
@d restore_old_value=0 {|save_type| when a value should be restored later}
@d restore_zero=1 {|save_type| when an undefined entry should be restored}
@d insert_token=2 {|save_type| when a token is being saved for later use}
@d level_boundary=3 {|save_type| corresponding to beginning of group}
@d restore_sa=4 {|save_type| when sparse array entries should be restored}
@p@t\4@>@<Declare \eTeX\ procedures for tracing and input@>
@ Here are the group codes that are used to discriminate between different
kinds of groups. They allow \TeX\ to decide what special actions, if any,
should be performed when a group ends.
\def\grp{\.{\char'173...\char'175}}
Some groups are not supposed to be ended by right braces. For example,
the `\.\$' that begins a math formula causes a |math_shift_group| to
be started, and this should be terminated by a matching `\.\$'. Similarly,
a group that starts with \.{\\left} should end with \.{\\right}, and
one that starts with \.{\\begingroup} should end with \.{\\endgroup}.
@d bottom_level=0 {group code for the outside world}
@d simple_group=1 {group code for local structure only}
@d hbox_group=2 {code for `\.{\\hbox}\grp'}
@d adjusted_hbox_group=3 {code for `\.{\\hbox}\grp' in vertical mode}
@d vbox_group=4 {code for `\.{\\vbox}\grp'}
@d vtop_group=5 {code for `\.{\\vtop}\grp'}
@d align_group=6 {code for `\.{\\halign}\grp', `\.{\\valign}\grp'}
@d no_align_group=7 {code for `\.{\\noalign}\grp'}
@d output_group=8 {code for output routine}
@d math_group=9 {code for, e.g., `\.{\char'136}\grp'}
@d disc_group=10 {code for `\.{\\discretionary}\grp\grp\grp'}
@d insert_group=11 {code for `\.{\\insert}\grp', `\.{\\vadjust}\grp'}
@d vcenter_group=12 {code for `\.{\\vcenter}\grp'}
@d math_choice_group=13 {code for `\.{\\mathchoice}\grp\grp\grp\grp'}
@d semi_simple_group=14 {code for `\.{\\begingroup...\\endgroup}'}
@d math_shift_group=15 {code for `\.{\$...\$}'}
@d math_left_group=16 {code for `\.{\\left...\\right}'}
@d max_group_code=16
@<Types...@>=
@!group_code=0..max_group_code; {|save_level| for a level boundary}
@ The global variable |cur_group| keeps track of what sort of group we are
currently in. Another global variable, |cur_boundary|, points to the
topmost |level_boundary| word. And |cur_level| is the current depth of
nesting. The routines are designed to preserve the condition that no entry
in the |save_stack| or in |eqtb| ever has a level greater than |cur_level|.
@ @<Glob...@>=
@!save_stack : array[0..save_size] of memory_word;
@!save_ptr : 0..save_size; {first unused entry on |save_stack|}
@!max_save_stack:0..save_size; {maximum usage of save stack}
@!cur_level: quarterword; {current nesting level for groups}
@!cur_group: group_code; {current group type}
@!cur_boundary: 0..save_size; {where the current level begins}
@ At this time it might be a good idea for the reader to review the introduction
to |eqtb| that was given above just before the long lists of parameter names.
Recall that the ``outer level'' of the program is |level_one|, since
undefined control sequences are assumed to be ``defined'' at |level_zero|.
@<Set init...@>=
save_ptr:=0; cur_level:=level_one; cur_group:=bottom_level; cur_boundary:=0;
max_save_stack:=0;
@ The following macro is used to test if there is room for up to seven more
entries on |save_stack|. By making a conservative test like this, we can
get by with testing for overflow in only a few places.
@d check_full_save_stack==if save_ptr>max_save_stack then
begin max_save_stack:=save_ptr;
if max_save_stack>save_size-7 then overflow("save size",save_size);
@:TeX capacity exceeded save size}{\quad save size@>
end
@ Procedure |new_save_level| is called when a group begins. The
argument is a group identification code like `|hbox_group|'. After
calling this routine, it is safe to put five more entries on |save_stack|.
In some cases integer-valued items are placed onto the
|save_stack| just below a |level_boundary| word, because this is a
convenient place to keep information that is supposed to ``pop up'' just
when the group has finished.
For example, when `\.{\\hbox to 100pt}\grp' is being treated, the 100pt
dimension is stored on |save_stack| just before |new_save_level| is
called.
We use the notation |saved(k)| to stand for an integer item that
appears in location |save_ptr+k| of the save stack.
@d saved(#)==save_stack[save_ptr+#].int
@p procedure new_save_level(@!c:group_code); {begin a new level of grouping}
begin check_full_save_stack;
if eTeX_ex then
begin saved(0):=line; incr(save_ptr);
end;
save_type(save_ptr):=level_boundary; save_level(save_ptr):=cur_group;
save_index(save_ptr):=cur_boundary;
if cur_level=max_quarterword then overflow("grouping levels",
@:TeX capacity exceeded grouping levels}{\quad grouping levels@>
max_quarterword-min_quarterword);
{quit if |(cur_level+1)| is too big to be stored in |eqtb|}
cur_boundary:=save_ptr; cur_group:=c;
@!stat if tracing_groups>0 then group_trace(false);@+tats@;@/
incr(cur_level); incr(save_ptr);
end;
@ Just before an entry of |eqtb| is changed, the following procedure should
be called to update the other data structures properly. It is important
to keep in mind that reference counts in |mem| include references from
within |save_stack|, so these counts must be handled carefully.
@^reference counts@>
@p procedure eq_destroy(@!w:memory_word); {gets ready to forget |w|}
var q:pointer; {|equiv| field of |w|}
begin case eq_type_field(w) of
call,long_call,outer_call,long_outer_call: delete_token_ref(equiv_field(w));
glue_ref: delete_glue_ref(equiv_field(w));
shape_ref: begin q:=equiv_field(w); {we need to free a \.{\\parshape} block}
if q<>null then free_node(q,info(q)+info(q)+1);
end; {such a block is |2n+1| words long, where |n=info(q)|}
box_ref: flush_node_list(equiv_field(w));
@/@<Cases for |eq_destroy|@>@/
othercases do_nothing
endcases;
end;
@ To save a value of |eqtb[p]| that was established at level |l|, we
can use the following subroutine.
@p procedure eq_save(@!p:pointer;@!l:quarterword); {saves |eqtb[p]|}
begin check_full_save_stack;
if l=level_zero then save_type(save_ptr):=restore_zero
else begin save_stack[save_ptr]:=eqtb[p]; incr(save_ptr);
save_type(save_ptr):=restore_old_value;
end;
save_level(save_ptr):=l; save_index(save_ptr):=p; incr(save_ptr);
end;
@ The procedure |eq_define| defines an |eqtb| entry having specified
|eq_type| and |equiv| fields, and saves the former value if appropriate.
This procedure is used only for entries in the first four regions of |eqtb|,
i.e., only for entries that have |eq_type| and |equiv| fields.
After calling this routine, it is safe to put four more entries on
|save_stack|, provided that there was room for four more entries before
the call, since |eq_save| makes the necessary test.
@d assign_trace(#)==@!stat if tracing_assigns>0 then restore_trace(#);
tats
@p procedure eq_define(@!p:pointer;@!t:quarterword;@!e:halfword);
{new data for |eqtb|}
label exit;
begin if eTeX_ex and(eq_type(p)=t)and(equiv(p)=e) then
begin assign_trace(p,"reassigning")@;@/
eq_destroy(eqtb[p]); return;
end;
assign_trace(p,"changing")@;@/
if eq_level(p)=cur_level then eq_destroy(eqtb[p])
else if cur_level>level_one then eq_save(p,eq_level(p));
eq_level(p):=cur_level; eq_type(p):=t; equiv(p):=e;
assign_trace(p,"into")@;@/
exit:end;
@ The counterpart of |eq_define| for the remaining (fullword) positions in
|eqtb| is called |eq_word_define|. Since |xeq_level[p]>=level_one| for all
|p|, a `|restore_zero|' will never be used in this case.
@p procedure eq_word_define(@!p:pointer;@!w:integer);
label exit;
begin if eTeX_ex and(eqtb[p].int=w) then
begin assign_trace(p,"reassigning")@;@/
return;
end;
assign_trace(p,"changing")@;@/
if xeq_level[p]<>cur_level then
begin eq_save(p,xeq_level[p]); xeq_level[p]:=cur_level;
end;
eqtb[p].int:=w;
assign_trace(p,"into")@;@/
exit:end;
@ The |eq_define| and |eq_word_define| routines take care of local definitions.
@^global definitions@>
Global definitions are done in almost the same way, but there is no need
to save old values, and the new value is associated with |level_one|.
@p procedure geq_define(@!p:pointer;@!t:quarterword;@!e:halfword);
{global |eq_define|}
begin assign_trace(p,"globally changing")@;@/
begin eq_destroy(eqtb[p]);
eq_level(p):=level_one; eq_type(p):=t; equiv(p):=e;
end;
assign_trace(p,"into")@;@/
end;
@#
procedure geq_word_define(@!p:pointer;@!w:integer); {global |eq_word_define|}
begin assign_trace(p,"globally changing")@;@/
begin eqtb[p].int:=w; xeq_level[p]:=level_one;
end;
assign_trace(p,"into")@;@/
end;
@ Subroutine |save_for_after| puts a token on the stack for save-keeping.
@p procedure save_for_after(@!t:halfword);
begin if cur_level>level_one then
begin check_full_save_stack;
save_type(save_ptr):=insert_token; save_level(save_ptr):=level_zero;
save_index(save_ptr):=t; incr(save_ptr);
end;
end;
@ The |unsave| routine goes the other way, taking items off of |save_stack|.
This routine takes care of restoration when a level ends; everything
belonging to the topmost group is cleared off of the save stack.
@p
procedure@?back_input; forward; @t\2@>
procedure unsave; {pops the top level off the save stack}
label done;
var p:pointer; {position to be restored}
@!l:quarterword; {saved level, if in fullword regions of |eqtb|}
@!t:halfword; {saved value of |cur_tok|}
@!a:boolean; {have we already processed an \.{\\aftergroup} ?}
begin a:=false;
if cur_level>level_one then
begin decr(cur_level);
@<Clear off top level from |save_stack|@>;
end
else confusion("curlevel"); {|unsave| is not used when |cur_group=bottom_level|}
@:this can't happen curlevel}{\quad curlevel@>
end;
@ @<Clear off...@>=
loop@+begin decr(save_ptr);
if save_type(save_ptr)=level_boundary then goto done;
p:=save_index(save_ptr);
if save_type(save_ptr)=insert_token then
@<Insert token |p| into \TeX's input@>
else if save_type(save_ptr)=restore_sa then
begin sa_restore; sa_chain:=p; sa_level:=save_level(save_ptr);
end
else begin if save_type(save_ptr)=restore_old_value then
begin l:=save_level(save_ptr); decr(save_ptr);
end
else save_stack[save_ptr]:=eqtb[undefined_control_sequence];
@<Store \(s)|save_stack[save_ptr]| in |eqtb[p]|, unless
|eqtb[p]| holds a global value@>;
end;
end;
done: @!stat if tracing_groups>0 then group_trace(true);@+tats@;@/
if grp_stack[in_open]=cur_boundary then group_warning;
{groups possibly not properly nested with files}
cur_group:=save_level(save_ptr); cur_boundary:=save_index(save_ptr);
if eTeX_ex then decr(save_ptr)
@ A global definition, which sets the level to |level_one|,
@^global definitions@>
will not be undone by |unsave|. If at least one global definition of
|eqtb[p]| has been carried out within the group that just ended, the
last such definition will therefore survive.
@<Store \(s)|save...@>=
if p<int_base then
if eq_level(p)=level_one then
begin eq_destroy(save_stack[save_ptr]); {destroy the saved value}
@!stat if tracing_restores>0 then restore_trace(p,"retaining");@+tats@;@/
end
else begin eq_destroy(eqtb[p]); {destroy the current value}
eqtb[p]:=save_stack[save_ptr]; {restore the saved value}
@!stat if tracing_restores>0 then restore_trace(p,"restoring");@+tats@;@/
end
else if xeq_level[p]<>level_one then
begin eqtb[p]:=save_stack[save_ptr]; xeq_level[p]:=l;
@!stat if tracing_restores>0 then restore_trace(p,"restoring");@+tats@;@/
end
else begin
@!stat if tracing_restores>0 then restore_trace(p,"retaining");@+tats@;@/
end
@ @<Declare \eTeX\ procedures for tr...@>=
@!stat procedure restore_trace(@!p:pointer;@!s:str_number);
{|eqtb[p]| has just been restored or retained}
begin begin_diagnostic; print_char("{"); print(s); print_char(" ");
show_eqtb(p); print_char("}");
end_diagnostic(false);
end;
tats
@ When looking for possible pointers to a memory location, it is helpful
to look for references from |eqtb| that might be waiting on the
save stack. Of course, we might find spurious pointers too; but this
routine is merely an aid when debugging, and at such times we are
grateful for any scraps of information, even if they prove to be irrelevant.
@^dirty \PASCAL@>
@<Search |save_stack| for equivalents that point to |p|@>=
if save_ptr>0 then for q:=0 to save_ptr-1 do
begin if equiv_field(save_stack[q])=p then
begin print_nl("SAVE("); print_int(q); print_char(")");
end;
end
@ Most of the parameters kept in |eqtb| can be changed freely, but there's
an exception: The magnification should not be used with two different
values during any \TeX\ job, since a single magnification is applied to an
entire run. The global variable |mag_set| is set to the current magnification
whenever it becomes necessary to ``freeze'' it at a particular value.
@<Glob...@>=
@!mag_set:integer; {if nonzero, this magnification should be used henceforth}
@ @<Set init...@>=
mag_set:=0;
@ The |prepare_mag| subroutine is called whenever \TeX\ wants to use |mag|
for magnification.
@p procedure prepare_mag;
begin if (mag_set>0)and(mag<>mag_set) then
begin print_err("Incompatible magnification ("); print_int(mag);
@.Incompatible magnification@>
print(");"); print_nl(" the previous value will be retained");
help2("I can handle only one magnification ratio per job. So I've")@/
("reverted to the magnification you used earlier on this run.");@/
int_error(mag_set);
geq_word_define(int_base+mag_code,mag_set); {|mag:=mag_set|}
end;
if (mag<=0)or(mag>32768) then
begin print_err("Illegal magnification has been changed to 1000");@/
@.Illegal magnification...@>
help1("The magnification ratio must be between 1 and 32768.");
int_error(mag); geq_word_define(int_base+mag_code,1000);
end;
mag_set:=mag;
end;
@* \[20] Token lists.
A \TeX\ token is either a character or a control sequence, and it is
@^token@>
represented internally in one of two ways: (1)~A character whose ASCII
code number is |c| and whose command code is |m| is represented as the
number $2^8m+c$; the command code is in the range |1<=m<=14|. (2)~A control
sequence whose |eqtb| address is |p| is represented as the number
|cs_token_flag+p|. Here |cs_token_flag=@t$2^{12}-1$@>| is larger than
$2^8m+c$, yet it is small enough that |cs_token_flag+p< max_halfword|;
thus, a token fits comfortably in a halfword.
A token |t| represents a |left_brace| command if and only if
|t<left_brace_limit|; it represents a |right_brace| command if and only if
we have |left_brace_limit<=t<right_brace_limit|; and it represents a |match| or
|end_match| command if and only if |match_token<=t<=end_match_token|.
The following definitions take care of these token-oriented constants
and a few others.
@d cs_token_flag==@'7777 {amount added to the |eqtb| location in a
token that stands for a control sequence; is a multiple of~256, less~1}
@d left_brace_token=@'0400 {$2^8\cdot|left_brace|$}
@d left_brace_limit=@'1000 {$2^8\cdot(|left_brace|+1)$}
@d right_brace_token=@'1000 {$2^8\cdot|right_brace|$}
@d right_brace_limit=@'1400 {$2^8\cdot(|right_brace|+1)$}
@d math_shift_token=@'1400 {$2^8\cdot|math_shift|$}
@d tab_token=@'2000 {$2^8\cdot|tab_mark|$}
@d out_param_token=@'2400 {$2^8\cdot|out_param|$}
@d space_token=@'5040 {$2^8\cdot|spacer|+|" "|$}
@d letter_token=@'5400 {$2^8\cdot|letter|$}
@d other_token=@'6000 {$2^8\cdot|other_char|$}
@d match_token=@'6400 {$2^8\cdot|match|$}
@d end_match_token=@'7000 {$2^8\cdot|end_match|$}
@d protected_token=@'7001 {$2^8\cdot|end_match|+1$}
@ @<Check the ``constant''...@>=
if cs_token_flag+undefined_control_sequence>max_halfword then bad:=21;
@ A token list is a singly linked list of one-word nodes in |mem|, where
each word contains a token and a link. Macro definitions, output-routine
definitions, marks, \.{\\write} texts, and a few other things
are remembered by \TeX\ in the form
of token lists, usually preceded by a node with a reference count in its
|token_ref_count| field. The token stored in location |p| is called
|info(p)|.
Three special commands appear in the token lists of macro definitions.
When |m=match|, it means that \TeX\ should scan a parameter
for the current macro; when |m=end_match|, it means that parameter
matching should end and \TeX\ should start reading the macro text; and
when |m=out_param|, it means that \TeX\ should insert parameter
number |c| into the text at this point.
The enclosing \.{\char'173} and \.{\char'175} characters of a macro
definition are omitted, but an output routine
will be enclosed in braces.
Here is an example macro definition that illustrates these conventions.
After \TeX\ processes the text
$$\.{\\def\\mac a\#1\#2 \\b \{\#1\\-a \#\#1\#2 \#2\}}$$
the definition of \.{\\mac} is represented as a token list containing
$$\def\,{\hskip2pt}
\vbox{\halign{\hfil#\hfil\cr
(reference count), |letter|\,\.a, |match|\,\#, |match|\,\#, |spacer|\,\.\ ,
\.{\\b}, |end_match|,\cr
|out_param|\,1, \.{\\-}, |letter|\,\.a, |spacer|\,\.\ , |mac_param|\,\#,
|other_char|\,\.1,\cr
|out_param|\,2, |spacer|\,\.\ , |out_param|\,2.\cr}}$$
The procedure |scan_toks| builds such token lists, and |macro_call|
does the parameter matching.
@^reference counts@>
Examples such as
$$\.{\\def\\m\{\\def\\m\{a\}\ b\}}$$
explain why reference counts would be needed even if \TeX\ had no \.{\\let}
operation: When the token list for \.{\\m} is being read, the redefinition of
\.{\\m} changes the |eqtb| entry before the token list has been fully
consumed, so we dare not simply destroy a token list when its
control sequence is being redefined.
If the parameter-matching part of a definition ends with `\.{\#\{}',
the corresponding token list will have `\.\{' just before the `|end_match|'
and also at the very end. The first `\.\{' is used to delimit the parameter; the
second one keeps the first from disappearing.
@ The procedure |show_token_list|, which prints a symbolic form of
the token list that starts at a given node |p|, illustrates these
conventions. The token list being displayed should not begin with a reference
count. However, the procedure is intended to be robust, so that if the
memory links are awry or if |p| is not really a pointer to a token list,
nothing catastrophic will happen.
An additional parameter |q| is also given; this parameter is either null
or it points to a node in the token list where a certain magic computation
takes place that will be explained later. (Basically, |q| is non-null when
we are printing the two-line context information at the time of an error
message; |q| marks the place corresponding to where the second line
should begin.)
For example, if |p| points to the node containing the first \.a in the
token list above, then |show_token_list| will print the string
$$\hbox{`\.{a\#1\#2\ \\b\ ->\#1\\-a\ \#\#1\#2\ \#2}';}$$
and if |q| points to the node containing the second \.a,
the magic computation will be performed just before the second \.a is printed.
The generation will stop, and `\.{\\ETC.}' will be printed, if the length
of printing exceeds a given limit~|l|. Anomalous entries are printed in the
form of control sequences that are not followed by a blank space, e.g.,
`\.{\\BAD.}'; this cannot be confused with actual control sequences because
a real control sequence named \.{BAD} would come out `\.{\\BAD\ }'.
@<Declare the procedure called |show_token_list|@>=
procedure show_token_list(@!p,@!q:integer;@!l:integer);
label exit;
var m,@!c:integer; {pieces of a token}
@!match_chr:ASCII_code; {character used in a `|match|'}
@!n:ASCII_code; {the highest parameter number, as an ASCII digit}
begin match_chr:="#"; n:="0"; tally:=0;
while (p<>null) and (tally<l) do
begin if p=q then @<Do magic computation@>;
@<Display token |p|, and |return| if there are problems@>;
p:=link(p);
end;
if p<>null then print_esc("ETC.");
@.ETC@>
exit:
end;
@ @<Display token |p|...@>=
if (p<hi_mem_min) or (p>mem_end) then
begin print_esc("CLOBBERED."); return;
@.CLOBBERED@>
end;
if info(p)>=cs_token_flag then print_cs(info(p)-cs_token_flag)
else begin m:=info(p) div @'400; c:=info(p) mod @'400;
if info(p)<0 then print_esc("BAD.")
@.BAD@>
else @<Display the token $(|m|,|c|)$@>;
end
@ The procedure usually ``learns'' the character code used for macro
parameters by seeing one in a |match| command before it runs into any
|out_param| commands.
@<Display the token ...@>=
case m of
left_brace,right_brace,math_shift,tab_mark,sup_mark,sub_mark,spacer,
letter,other_char: print(c);
mac_param: begin print(c); print(c);
end;
out_param: begin print(match_chr);
if c<=9 then print_char(c+"0")
else begin print_char("!"); return;
end;
end;
match: begin match_chr:=c; print(c); incr(n); print_char(n);
if n>"9" then return;
end;
end_match: if c=0 then print("->");
@.->@>
othercases print_esc("BAD.")
@.BAD@>
endcases
@ Here's the way we sometimes want to display a token list, given a pointer
to its reference count; the pointer may be null.
@p procedure token_show(@!p:pointer);
begin if p<>null then show_token_list(link(p),null,10000000);
end;
@ The |print_meaning| subroutine displays |cur_cmd| and |cur_chr| in
symbolic form, including the expansion of a macro or mark.
@p procedure print_meaning;
begin print_cmd_chr(cur_cmd,cur_chr);
if cur_cmd>=call then
begin print_char(":"); print_ln; token_show(cur_chr);
end
else if (cur_cmd=top_bot_mark)and(cur_chr<marks_code) then
begin print_char(":"); print_ln;
token_show(cur_mark[cur_chr]);
end;
end;
@* \[21] Introduction to the syntactic routines.
Let's pause a moment now and try to look at the Big Picture.
The \TeX\ program consists of three main parts: syntactic routines,
semantic routines, and output routines. The chief purpose of the
syntactic routines is to deliver the user's input to the semantic routines,
one token at a time. The semantic routines act as an interpreter
responding to these tokens, which may be regarded as commands. And the
output routines are periodically called on to convert box-and-glue
lists into a compact set of instructions that will be sent
to a typesetter. We have discussed the basic data structures and utility
routines of \TeX, so we are good and ready to plunge into the real activity by
considering the syntactic routines.
Our current goal is to come to grips with the |get_next| procedure,
which is the keystone of \TeX's input mechanism. Each call of |get_next|
sets the value of three variables |cur_cmd|, |cur_chr|, and |cur_cs|,
representing the next input token.
$$\vbox{\halign{#\hfil\cr
\hbox{|cur_cmd| denotes a command code from the long list of codes
given above;}\cr
\hbox{|cur_chr| denotes a character code or other modifier of the command
code;}\cr
\hbox{|cur_cs| is the |eqtb| location of the current control sequence,}\cr
\hbox{\qquad if the current token was a control sequence,
otherwise it's zero.}\cr}}$$
Underlying this external behavior of |get_next| is all the machinery
necessary to convert from character files to tokens. At a given time we
may be only partially finished with the reading of several files (for
which \.{\\input} was specified), and partially finished with the expansion
of some user-defined macros and/or some macro parameters, and partially
finished with the generation of some text in a template for \.{\\halign},
and so on. When reading a character file, special characters must be
classified as math delimiters, etc.; comments and extra blank spaces must
be removed, paragraphs must be recognized, and control sequences must be
found in the hash table. Furthermore there are occasions in which the
scanning routines have looked ahead for a word like `\.{plus}' but only
part of that word was found, hence a few characters must be put back
into the input and scanned again.
To handle these situations, which might all be present simultaneously,
\TeX\ uses various stacks that hold information about the incomplete
activities, and there is a finite state control for each level of the
input mechanism. These stacks record the current state of an implicitly
recursive process, but the |get_next| procedure is not recursive.
Therefore it will not be difficult to translate these algorithms into
low-level languages that do not support recursion.
@<Glob...@>=
@!cur_cmd: eight_bits; {current command set by |get_next|}
@!cur_chr: halfword; {operand of current command}
@!cur_cs: pointer; {control sequence found here, zero if none found}
@!cur_tok: halfword; {packed representative of |cur_cmd| and |cur_chr|}
@ The |print_cmd_chr| routine prints a symbolic interpretation of a
command code and its modifier. This is used in certain `\.{You can\'t}'
error messages, and in the implementation of diagnostic routines like
\.{\\show}.
The body of |print_cmd_chr| is a rather tedious listing of print
commands, and most of it is essentially an inverse to the |primitive|
routine that enters a \TeX\ primitive into |eqtb|. Therefore much of
this procedure appears elsewhere in the program,
together with the corresponding |primitive| calls.
@d chr_cmd(#)==begin print(#); print_ASCII(chr_code);
end
@<Declare the procedure called |print_cmd_chr|@>=
procedure print_cmd_chr(@!cmd:quarterword;@!chr_code:halfword);
var n:integer; {temp variable}
begin case cmd of
left_brace: chr_cmd("begin-group character ");
right_brace: chr_cmd("end-group character ");
math_shift: chr_cmd("math shift character ");
mac_param: chr_cmd("macro parameter character ");
sup_mark: chr_cmd("superscript character ");
sub_mark: chr_cmd("subscript character ");
endv: print("end of alignment template");
spacer: chr_cmd("blank space ");
letter: chr_cmd("the letter ");
other_char: chr_cmd("the character ");
@t\4@>@<Cases of |print_cmd_chr| for symbolic printing of primitives@>@/
othercases print("[unknown command code!]")
endcases;
end;
@ Here is a procedure that displays the current command.
@p procedure show_cur_cmd_chr;
var n:integer; {level of \.{\\if...\\fi} nesting}
@!l:integer; {line where \.{\\if} started}
@!p:pointer;
begin begin_diagnostic; print_nl("{");
if mode<>shown_mode then
begin print_mode(mode); print(": "); shown_mode:=mode;
end;
print_cmd_chr(cur_cmd,cur_chr);
if tracing_ifs>0 then
if cur_cmd>=if_test then if cur_cmd<=fi_or_else then
begin print(": ");
if cur_cmd=fi_or_else then
begin print_cmd_chr(if_test,cur_if); print_char(" ");
n:=0; l:=if_line;
end
else begin n:=1; l:=line;
end;
p:=cond_ptr;
while p<>null do
begin incr(n); p:=link(p);
end;
print("(level "); print_int(n); print_char(")"); print_if_line(l);
end;
print_char("}");
end_diagnostic(false);
end;
@* \[22] Input stacks and states.
This implementation of
\TeX\ uses two different conventions for representing sequential stacks.
@^stack conventions@>@^conventions for representing stacks@>
\yskip\hangg 1) If there is frequent access to the top entry, and if the
stack is essentially never empty, then the top entry is kept in a global
variable (even better would be a machine register), and the other entries
appear in the array $\\{stack}[0\to(\\{ptr}-1)]$. For example, the
semantic stack described above is handled this way, and so is the input
stack that we are about to study.
\yskip\hangg 2) If there is infrequent top access, the entire stack contents
are in the array $\\{stack}[0\to(\\{ptr}-1)]$. For example, the |save_stack|
is treated this way, as we have seen.
\yskip\noindent
The state of \TeX's input mechanism appears in the input stack, whose
entries are records with six fields, called |state|, |index|, |start|, |loc|,
|limit|, and |name|. This stack is maintained with
convention~(1), so it is declared in the following way:
@<Types...@>=
@!in_state_record = record
@!state_field, @!index_field: quarterword;
@!start_field,@!loc_field, @!limit_field, @!name_field: halfword;
end;
@ @<Glob...@>=
@!input_stack : array[0..stack_size] of in_state_record;
@!input_ptr : 0..stack_size; {first unused location of |input_stack|}
@!max_in_stack: 0..stack_size; {largest value of |input_ptr| when pushing}
@!cur_input : in_state_record;
{the ``top'' input state, according to convention (1)}
@ We've already defined the special variable |loc==cur_input.loc_field|
in our discussion of basic input-output routines. The other components of
|cur_input| are defined in the same way:
@d state==cur_input.state_field {current scanner state}
@d index==cur_input.index_field {reference for buffer information}
@d start==cur_input.start_field {starting position in |buffer|}
@d limit==cur_input.limit_field {end of current line in |buffer|}
@d name==cur_input.name_field {name of the current file}
@ Let's look more closely now at the control variables
(|state|,~|index|,~|start|,~|loc|,~|limit|,~|name|),
assuming that \TeX\ is reading a line of characters that have been input
from some file or from the user's terminal. There is an array called
|buffer| that acts as a stack of all lines of characters that are
currently being read from files, including all lines on subsidiary
levels of the input stack that are not yet completed. \TeX\ will return to
the other lines when it is finished with the present input file.
(Incidentally, on a machine with byte-oriented addressing, it might be
appropriate to combine |buffer| with the |str_pool| array,
letting the buffer entries grow downward from the top of the string pool
and checking that these two tables don't bump into each other.)
The line we are currently working on begins in position |start| of the
buffer; the next character we are about to read is |buffer[loc]|; and
|limit| is the location of the last character present. If |loc>limit|,
the line has been completely read. Usually |buffer[limit]| is the
|end_line_char|, denoting the end of a line, but this is not
true if the current line is an insertion that was entered on the user's
terminal in response to an error message.
The |name| variable is a string number that designates the name of
the current file, if we are reading a text file. It is zero if we
are reading from the terminal; it is |n+1| if we are reading from
input stream |n|, where |0<=n<=16|. (Input stream 16 stands for
an invalid stream number; in such cases the input is actually from
the terminal, under control of the procedure |read_toks|.)
Finally |18<=name<=19| indicates that we are reading a pseudo file
created by the \.{\\scantokens} command.
The |state| variable has one of three values, when we are scanning such
files:
$$\baselineskip 15pt\vbox{\halign{#\hfil\cr
1) |state=mid_line| is the normal state.\cr
2) |state=skip_blanks| is like |mid_line|, but blanks are ignored.\cr
3) |state=new_line| is the state at the beginning of a line.\cr}}$$
These state values are assigned numeric codes so that if we add the state
code to the next character's command code, we get distinct values. For
example, `|mid_line+spacer|' stands for the case that a blank
space character occurs in the middle of a line when it is not being
ignored; after this case is processed, the next value of |state| will
be |skip_blanks|.
@d mid_line=1 {|state| code when scanning a line of characters}
@d skip_blanks=2+max_char_code {|state| code when ignoring blanks}
@d new_line=3+max_char_code+max_char_code {|state| code at start of line}
@ Additional information about the current line is available via the
|index| variable, which counts how many lines of characters are present
in the buffer below the current level. We have |index=0| when reading
from the terminal and prompting the user for each line; then if the user types,
e.g., `\.{\\input paper}', we will have |index=1| while reading
the file \.{paper.tex}. However, it does not follow that |index| is the
same as the input stack pointer, since many of the levels on the input
stack may come from token lists. For example, the instruction `\.{\\input
paper}' might occur in a token list.
The global variable |in_open| is equal to the |index|
value of the highest non-token-list level. Thus, the number of partially read
lines in the buffer is |in_open+1|, and we have |in_open=index|
when we are not reading a token list.
If we are not currently reading from the terminal, or from an input
stream, we are reading from the file variable |input_file[index]|. We use
the notation |terminal_input| as a convenient abbreviation for |name=0|,
and |cur_file| as an abbreviation for |input_file[index]|.
The global variable |line| contains the line number in the topmost
open file, for use in error messages. If we are not reading from
the terminal, |line_stack[index]| holds the line number for the
enclosing level, so that |line| can be restored when the current
file has been read. Line numbers should never be negative, since the
negative of the current line number is used to identify the user's output
routine in the |mode_line| field of the semantic nest entries.
If more information about the input state is needed, it can be
included in small arrays like those shown here. For example,
the current page or segment number in the input file might be
put into a variable |@!page|, maintained for enclosing levels in
`\ignorespaces|@!page_stack:array[1..max_in_open] of integer|\unskip'
by analogy with |line_stack|.
@^system dependencies@>
@d terminal_input==(name=0) {are we reading from the terminal?}
@d cur_file==input_file[index] {the current |alpha_file| variable}
@<Glob...@>=
@!in_open : 0..max_in_open; {the number of lines in the buffer, less one}
@!open_parens : 0..max_in_open; {the number of open text files}
@!input_file : array[1..max_in_open] of alpha_file;
@!line : integer; {current line number in the current source file}
@!line_stack : array[1..max_in_open] of integer;
@ Users of \TeX\ sometimes forget to balance left and right braces properly,
and one of the ways \TeX\ tries to spot such errors is by considering an
input file as broken into subfiles by control sequences that
are declared to be \.{\\outer}.
A variable called |scanner_status| tells \TeX\ whether or not to complain
when a subfile ends. This variable has six possible values:
\yskip\hang|normal|, means that a subfile can safely end here without incident.
\yskip\hang|skipping|, means that a subfile can safely end here, but not a file,
because we're reading past some conditional text that was not selected.
\yskip\hang|defining|, means that a subfile shouldn't end now because a
macro is being defined.
\yskip\hang|matching|, means that a subfile shouldn't end now because a
macro is being used and we are searching for the end of its arguments.
\yskip\hang|aligning|, means that a subfile shouldn't end now because we are
not finished with the preamble of an \.{\\halign} or \.{\\valign}.
\yskip\hang|absorbing|, means that a subfile shouldn't end now because we are
reading a balanced token list for \.{\\message}, \.{\\write}, etc.
\yskip\noindent
If the |scanner_status| is not |normal|, the variable |warning_index| points
to the |eqtb| location for the relevant control sequence name to print
in an error message.
@d skipping=1 {|scanner_status| when passing conditional text}
@d defining=2 {|scanner_status| when reading a macro definition}
@d matching=3 {|scanner_status| when reading macro arguments}
@d aligning=4 {|scanner_status| when reading an alignment preamble}
@d absorbing=5 {|scanner_status| when reading a balanced text}
@<Glob...@>=
@!scanner_status : normal..absorbing; {can a subfile end now?}
@!warning_index : pointer; {identifier relevant to non-|normal| scanner status}
@!def_ref : pointer; {reference count of token list being defined}
@ Here is a procedure that uses |scanner_status| to print a warning message
when a subfile has ended, and at certain other crucial times:
@<Declare the procedure called |runaway|@>=
procedure runaway;
var p:pointer; {head of runaway list}
begin if scanner_status>skipping then
begin print_nl("Runaway ");
@.Runaway...@>
case scanner_status of
defining: begin print("definition"); p:=def_ref;
end;
matching: begin print("argument"); p:=temp_head;
end;
aligning: begin print("preamble"); p:=hold_head;
end;
absorbing: begin print("text"); p:=def_ref;
end;
end; {there are no other cases}
print_char("?");print_ln; show_token_list(link(p),null,error_line-10);
end;
end;
@ However, all this discussion about input state really applies only to the
case that we are inputting from a file. There is another important case,
namely when we are currently getting input from a token list. In this case
|state=token_list|, and the conventions about the other state variables
are different:
\yskip\hang|loc| is a pointer to the current node in the token list, i.e.,
the node that will be read next. If |loc=null|, the token list has been
fully read.
\yskip\hang|start| points to the first node of the token list; this node
may or may not contain a reference count, depending on the type of token
list involved.
\yskip\hang|token_type|, which takes the place of |index| in the
discussion above, is a code number that explains what kind of token list
is being scanned.
\yskip\hang|name| points to the |eqtb| address of the control sequence
being expanded, if the current token list is a macro.
\yskip\hang|param_start|, which takes the place of |limit|, tells where
the parameters of the current macro begin in the |param_stack|, if the
current token list is a macro.
\yskip\noindent The |token_type| can take several values, depending on
where the current token list came from:
\yskip\hang|parameter|, if a parameter is being scanned;
\hang|u_template|, if the \<u_j> part of an alignment
template is being scanned;
\hang|v_template|, if the \<v_j> part of an alignment
template is being scanned;
\hang|backed_up|, if the token list being scanned has been inserted as
`to be read again';
\hang|inserted|, if the token list being scanned has been inserted as
the text expansion of a \.{\\count} or similar variable;
\hang|macro|, if a user-defined control sequence is being scanned;
\hang|output_text|, if an \.{\\output} routine is being scanned;
\hang|every_par_text|, if the text of \.{\\everypar} is being scanned;
\hang|every_math_text|, if the text of \.{\\everymath} is being scanned;
\hang|every_display_text|, if the text of \.{\\everydisplay} is being scanned;
\hang|every_hbox_text|, if the text of \.{\\everyhbox} is being scanned;
\hang|every_vbox_text|, if the text of \.{\\everyvbox} is being scanned;
\hang|every_job_text|, if the text of \.{\\everyjob} is being scanned;
\hang|every_cr_text|, if the text of \.{\\everycr} is being scanned;
\hang|mark_text|, if the text of a \.{\\mark} is being scanned;
\hang|write_text|, if the text of a \.{\\write} is being scanned.
\yskip\noindent
The codes for |output_text|, |every_par_text|, etc., are equal to a constant
plus the corresponding codes for token list parameters |output_routine_loc|,
|every_par_loc|, etc. The token list begins with a reference count if and
only if |token_type>=macro|.
@^reference counts@>
Since \eTeX's additional token list parameters precede |toks_base|, the
corresponding token types must precede |write_text|.
@d token_list=0 {|state| code when scanning a token list}
@d token_type==index {type of current token list}
@d param_start==limit {base of macro parameters in |param_stack|}
@d parameter=0 {|token_type| code for parameter}
@d u_template=1 {|token_type| code for \<u_j> template}
@d v_template=2 {|token_type| code for \<v_j> template}
@d backed_up=3 {|token_type| code for text to be reread}
@d inserted=4 {|token_type| code for inserted texts}
@d macro=5 {|token_type| code for defined control sequences}
@d output_text=6 {|token_type| code for output routines}
@d every_par_text=7 {|token_type| code for \.{\\everypar}}
@d every_math_text=8 {|token_type| code for \.{\\everymath}}
@d every_display_text=9 {|token_type| code for \.{\\everydisplay}}
@d every_hbox_text=10 {|token_type| code for \.{\\everyhbox}}
@d every_vbox_text=11 {|token_type| code for \.{\\everyvbox}}
@d every_job_text=12 {|token_type| code for \.{\\everyjob}}
@d every_cr_text=13 {|token_type| code for \.{\\everycr}}
@d mark_text=14 {|token_type| code for \.{\\topmark}, etc.}
@#
@d eTeX_text_offset=output_routine_loc-output_text
@d every_eof_text=every_eof_loc-eTeX_text_offset
{|token_type| code for \.{\\everyeof}}
@#
@d write_text=toks_base-eTeX_text_offset {|token_type| code for \.{\\write}}
@ The |param_stack| is an auxiliary array used to hold pointers to the token
lists for parameters at the current level and subsidiary levels of input.
This stack is maintained with convention (2), and it grows at a different
rate from the others.
@<Glob...@>=
@!param_stack:array [0..param_size] of pointer;
{token list pointers for parameters}
@!param_ptr:0..param_size; {first unused entry in |param_stack|}
@!max_param_stack:integer;
{largest value of |param_ptr|, will be |<=param_size+9|}
@ The input routines must also interact with the processing of
\.{\\halign} and \.{\\valign}, since the appearance of tab marks and
\.{\\cr} in certain places is supposed to trigger the beginning of special
\<v_j> template text in the scanner. This magic is accomplished by an
|align_state| variable that is increased by~1 when a `\.{\char'173}' is
scanned and decreased by~1 when a `\.{\char'175}' is scanned. The |align_state|
is nonzero during the \<u_j> template, after which it is set to zero; the
\<v_j> template begins when a tab mark or \.{\\cr} occurs at a time that
|align_state=0|.
@<Glob...@>=
@!align_state:integer; {group level with respect to current alignment}
@ Thus, the ``current input state'' can be very complicated indeed; there
can be many levels and each level can arise in a variety of ways. The
|show_context| procedure, which is used by \TeX's error-reporting routine to
print out the current input state on all levels down to the most recent
line of characters from an input file, illustrates most of these conventions.
The global variable |base_ptr| contains the lowest level that was
displayed by this procedure.
@<Glob...@>=
@!base_ptr:0..stack_size; {shallowest level shown by |show_context|}
@ The status at each level is indicated by printing two lines, where the first
line indicates what was read so far and the second line shows what remains
to be read. The context is cropped, if necessary, so that the first line
contains at most |half_error_line| characters, and the second contains
at most |error_line|. Non-current input levels whose |token_type| is
`|backed_up|' are shown only if they have not been fully read.
@p procedure show_context; {prints where the scanner is}
label done;
var old_setting:0..max_selector; {saved |selector| setting}
@!nn:integer; {number of contexts shown so far, less one}
@!bottom_line:boolean; {have we reached the final context to be shown?}
@<Local variables for formatting calculations@>@/
begin base_ptr:=input_ptr; input_stack[base_ptr]:=cur_input;
{store current state}
nn:=-1; bottom_line:=false;
loop@+begin cur_input:=input_stack[base_ptr]; {enter into the context}
if (state<>token_list) then
if (name>19) or (base_ptr=0) then bottom_line:=true;
if (base_ptr=input_ptr)or bottom_line or(nn<error_context_lines) then
@<Display the current context@>
else if nn=error_context_lines then
begin print_nl("..."); incr(nn); {omitted if |error_context_lines<0|}
end;
if bottom_line then goto done;
decr(base_ptr);
end;
done: cur_input:=input_stack[input_ptr]; {restore original state}
end;
@ @<Display the current context@>=
begin if (base_ptr=input_ptr) or (state<>token_list) or
(token_type<>backed_up) or (loc<>null) then
{we omit backed-up token lists that have already been read}
begin tally:=0; {get ready to count characters}
old_setting:=selector;
if state<>token_list then
begin @<Print location of current line@>;
@<Pseudoprint the line@>;
end
else begin @<Print type of token list@>;
@<Pseudoprint the token list@>;
end;
selector:=old_setting; {stop pseudoprinting}
@<Print two lines using the tricky pseudoprinted information@>;
incr(nn);
end;
end
@ This routine should be changed, if necessary, to give the best possible
indication of where the current line resides in the input file.
For example, on some systems it is best to print both a page and line number.
@^system dependencies@>
@<Print location of current line@>=
if name<=17 then
if terminal_input then
if base_ptr=0 then print_nl("<*>") else print_nl("<insert> ")
else begin print_nl("<read ");
if name=17 then print_char("*")@+else print_int(name-1);
@.*\relax@>
print_char(">");
end
else begin print_nl("l.");
if index=in_open then print_int(line)
else print_int(line_stack[index+1]); {input from a pseudo file}
end;
print_char(" ")
@ @<Print type of token list@>=
case token_type of
parameter: print_nl("<argument> ");
u_template,v_template: print_nl("<template> ");
backed_up: if loc=null then print_nl("<recently read> ")
else print_nl("<to be read again> ");
inserted: print_nl("<inserted text> ");
macro: begin print_ln; print_cs(name);
end;
output_text: print_nl("<output> ");
every_par_text: print_nl("<everypar> ");
every_math_text: print_nl("<everymath> ");
every_display_text: print_nl("<everydisplay> ");
every_hbox_text: print_nl("<everyhbox> ");
every_vbox_text: print_nl("<everyvbox> ");
every_job_text: print_nl("<everyjob> ");
every_cr_text: print_nl("<everycr> ");
mark_text: print_nl("<mark> ");
every_eof_text: print_nl("<everyeof> ");
write_text: print_nl("<write> ");
othercases print_nl("?") {this should never happen}
endcases
@ Here it is necessary to explain a little trick. We don't want to store a long
string that corresponds to a token list, because that string might take up
lots of memory; and we are printing during a time when an error message is
being given, so we dare not do anything that might overflow one of \TeX's
tables. So `pseudoprinting' is the answer: We enter a mode of printing
that stores characters into a buffer of length |error_line|, where character
$k+1$ is placed into \hbox{|trick_buf[k mod error_line]|} if
|k<trick_count|, otherwise character |k| is dropped. Initially we set
|tally:=0| and |trick_count:=1000000|; then when we reach the
point where transition from line 1 to line 2 should occur, we
set |first_count:=tally| and |trick_count:=@tmax@>(error_line,
tally+1+error_line-half_error_line)|. At the end of the
pseudoprinting, the values of |first_count|, |tally|, and
|trick_count| give us all the information we need to print the two lines,
and all of the necessary text is in |trick_buf|.
Namely, let |l| be the length of the descriptive information that appears
on the first line. The length of the context information gathered for that
line is |k=first_count|, and the length of the context information
gathered for line~2 is $m=\min(|tally|, |trick_count|)-k$. If |l+k<=h|,
where |h=half_error_line|, we print |trick_buf[0..k-1]| after the
descriptive information on line~1, and set |n:=l+k|; here |n| is the
length of line~1. If $l+k>h$, some cropping is necessary, so we set |n:=h|
and print `\.{...}' followed by
$$\hbox{|trick_buf[(l+k-h+3)..k-1]|,}$$
where subscripts of |trick_buf| are circular modulo |error_line|. The
second line consists of |n|~spaces followed by |trick_buf[k..(k+m-1)]|,
unless |n+m>error_line|; in the latter case, further cropping is done.
This is easier to program than to explain.
@<Local variables for formatting...@>=
@!i:0..buf_size; {index into |buffer|}
@!j:0..buf_size; {end of current line in |buffer|}
@!l:0..half_error_line; {length of descriptive information on line 1}
@!m:integer; {context information gathered for line 2}
@!n:0..error_line; {length of line 1}
@!p: integer; {starting or ending place in |trick_buf|}
@!q: integer; {temporary index}
@ The following code sets up the print routines so that they will gather
the desired information.
@d begin_pseudoprint==
begin l:=tally; tally:=0; selector:=pseudo;
trick_count:=1000000;
end
@d set_trick_count==
begin first_count:=tally;
trick_count:=tally+1+error_line-half_error_line;
if trick_count<error_line then trick_count:=error_line;
end
@ And the following code uses the information after it has been gathered.
@<Print two lines using the tricky pseudoprinted information@>=
if trick_count=1000000 then set_trick_count;
{|set_trick_count| must be performed}
if tally<trick_count then m:=tally-first_count
else m:=trick_count-first_count; {context on line 2}
if l+first_count<=half_error_line then
begin p:=0; n:=l+first_count;
end
else begin print("..."); p:=l+first_count-half_error_line+3;
n:=half_error_line;
end;
for q:=p to first_count-1 do print_char(trick_buf[q mod error_line]);
print_ln;
for q:=1 to n do print_char(" "); {print |n| spaces to begin line~2}
if m+n<=error_line then p:=first_count+m else p:=first_count+(error_line-n-3);
for q:=first_count to p-1 do print_char(trick_buf[q mod error_line]);
if m+n>error_line then print("...")
@ But the trick is distracting us from our current goal, which is to
understand the input state. So let's concentrate on the data structures that
are being pseudoprinted as we finish up the |show_context| procedure.
@<Pseudoprint the line@>=
begin_pseudoprint;
if buffer[limit]=end_line_char then j:=limit
else j:=limit+1; {determine the effective end of the line}
if j>0 then for i:=start to j-1 do
begin if i=loc then set_trick_count;
print(buffer[i]);
end
@ @<Pseudoprint the token list@>=
begin_pseudoprint;
if token_type<macro then show_token_list(start,loc,100000)
else show_token_list(link(start),loc,100000) {avoid reference count}
@ Here is the missing piece of |show_token_list| that is activated when the
token beginning line~2 is about to be shown:
@<Do magic computation@>=set_trick_count
@* \[23] Maintaining the input stacks.
The following subroutines change the input status in commonly needed ways.
First comes |push_input|, which stores the current state and creates a
new level (having, initially, the same properties as the old).
@d push_input==@t@> {enter a new input level, save the old}
begin if input_ptr>max_in_stack then
begin max_in_stack:=input_ptr;
if input_ptr=stack_size then overflow("input stack size",stack_size);
@:TeX capacity exceeded input stack size}{\quad input stack size@>
end;
input_stack[input_ptr]:=cur_input; {stack the record}
incr(input_ptr);
end
@ And of course what goes up must come down.
@d pop_input==@t@> {leave an input level, re-enter the old}
begin decr(input_ptr); cur_input:=input_stack[input_ptr];
end
@ Here is a procedure that starts a new level of token-list input, given
a token list |p| and its type |t|. If |t=macro|, the calling routine should
set |name| and |loc|.
@d back_list(#)==begin_token_list(#,backed_up) {backs up a simple token list}
@d ins_list(#)==begin_token_list(#,inserted) {inserts a simple token list}
@p procedure begin_token_list(@!p:pointer;@!t:quarterword);
begin push_input; state:=token_list; start:=p; token_type:=t;
if t>=macro then {the token list starts with a reference count}
begin add_token_ref(p);
if t=macro then param_start:=param_ptr
else begin loc:=link(p);
if tracing_macros>1 then
begin begin_diagnostic; print_nl("");
case t of
mark_text:print_esc("mark");
write_text:print_esc("write");
othercases print_cmd_chr(assign_toks,t-output_text+output_routine_loc)
endcases;@/
print("->"); token_show(p); end_diagnostic(false);
end;
end;
end
else loc:=p;
end;
@ When a token list has been fully scanned, the following computations
should be done as we leave that level of input. The |token_type| tends
to be equal to either |backed_up| or |inserted| about 2/3 of the time.
@^inner loop@>
@p procedure end_token_list; {leave a token-list input level}
begin if token_type>=backed_up then {token list to be deleted}
begin if token_type<=inserted then flush_list(start)
else begin delete_token_ref(start); {update reference count}
if token_type=macro then {parameters must be flushed}
while param_ptr>param_start do
begin decr(param_ptr);
flush_list(param_stack[param_ptr]);
end;
end;
end
else if token_type=u_template then
if align_state>500000 then align_state:=0
else fatal_error("(interwoven alignment preambles are not allowed)");
@.interwoven alignment preambles...@>
pop_input;
check_interrupt;
end;
@ Sometimes \TeX\ has read too far and wants to ``unscan'' what it has
seen. The |back_input| procedure takes care of this by putting the token
just scanned back into the input stream, ready to be read again. This
procedure can be used only if |cur_tok| represents the token to be
replaced. Some applications of \TeX\ use this procedure a lot,
so it has been slightly optimized for speed.
@^inner loop@>
@p procedure back_input; {undoes one token of input}
var p:pointer; {a token list of length one}
begin while (state=token_list)and(loc=null)and(token_type<>v_template) do
end_token_list; {conserve stack space}
p:=get_avail; info(p):=cur_tok;
if cur_tok<right_brace_limit then
if cur_tok<left_brace_limit then decr(align_state)
else incr(align_state);
push_input; state:=token_list; start:=p; token_type:=backed_up;
loc:=p; {that was |back_list(p)|, without procedure overhead}
end;
@ @<Insert token |p| into \TeX's input@>=
begin t:=cur_tok; cur_tok:=p;
if a then
begin p:=get_avail; info(p):=cur_tok; link(p):=loc; loc:=p; start:=p;
if cur_tok<right_brace_limit then
if cur_tok<left_brace_limit then decr(align_state)
else incr(align_state);
end
else begin back_input; a:=eTeX_ex;
end;
cur_tok:=t;
end
@ The |back_error| routine is used when we want to replace an offending token
just before issuing an error message. This routine, like |back_input|,
requires that |cur_tok| has been set. We disable interrupts during the
call of |back_input| so that the help message won't be lost.
@p procedure back_error; {back up one token and call |error|}
begin OK_to_interrupt:=false; back_input; OK_to_interrupt:=true; error;
end;
@#
procedure ins_error; {back up one inserted token and call |error|}
begin OK_to_interrupt:=false; back_input; token_type:=inserted;
OK_to_interrupt:=true; error;
end;
@ The |begin_file_reading| procedure starts a new level of input for lines
of characters to be read from a file, or as an insertion from the
terminal. It does not take care of opening the file, nor does it set |loc|
or |limit| or |line|.
@^system dependencies@>
@p procedure begin_file_reading;
begin if in_open=max_in_open then overflow("text input levels",max_in_open);
@:TeX capacity exceeded text input levels}{\quad text input levels@>
if first=buf_size then overflow("buffer size",buf_size);
@:TeX capacity exceeded buffer size}{\quad buffer size@>
incr(in_open); push_input; index:=in_open;
eof_seen[index]:=false;
grp_stack[index]:=cur_boundary; if_stack[index]:=cond_ptr;
line_stack[index]:=line; start:=first; state:=mid_line;
name:=0; {|terminal_input| is now |true|}
end;
@ Conversely, the variables must be downdated when such a level of input
is finished:
@p procedure end_file_reading;
begin first:=start; line:=line_stack[index];
if (name=18)or(name=19) then pseudo_close else
if name>17 then a_close(cur_file); {forget it}
pop_input; decr(in_open);
end;
@ In order to keep the stack from overflowing during a long sequence of
inserted `\.{\\show}' commands, the following routine removes completed
error-inserted lines from memory.
@p procedure clear_for_error_prompt;
begin while (state<>token_list)and terminal_input and@|
(input_ptr>0)and(loc>limit) do end_file_reading;
print_ln; clear_terminal;
end;
@ To get \TeX's whole input mechanism going, we perform the following
actions.
@<Initialize the input routines@>=
begin input_ptr:=0; max_in_stack:=0;
in_open:=0; open_parens:=0; max_buf_stack:=0;
grp_stack[0]:=0; if_stack[0]:=null;
param_ptr:=0; max_param_stack:=0;
first:=buf_size; repeat buffer[first]:=0; decr(first); until first=0;
scanner_status:=normal; warning_index:=null; first:=1;
state:=new_line; start:=1; index:=0; line:=0; name:=0;
force_eof:=false;
align_state:=1000000;@/
if not init_terminal then goto final_end;
limit:=last; first:=last+1; {|init_terminal| has set |loc| and |last|}
end
@* \[24] Getting the next token.
The heart of \TeX's input mechanism is the |get_next| procedure, which
we shall develop in the next few sections of the program. Perhaps we
shouldn't actually call it the ``heart,'' however, because it really acts
as \TeX's eyes and mouth, reading the source files and gobbling them up.
And it also helps \TeX\ to regurgitate stored token lists that are to be
processed again.
@^eyes and mouth@>
The main duty of |get_next| is to input one token and to set |cur_cmd|
and |cur_chr| to that token's command code and modifier. Furthermore, if
the input token is a control sequence, the |eqtb| location of that control
sequence is stored in |cur_cs|; otherwise |cur_cs| is set to zero.
Underlying this simple description is a certain amount of complexity
because of all the cases that need to be handled.
However, the inner loop of |get_next| is reasonably short and fast.
When |get_next| is asked to get the next token of a \.{\\read} line,
it sets |cur_cmd=cur_chr=cur_cs=0| in the case that no more tokens
appear on that line. (There might not be any tokens at all, if the
|end_line_char| has |ignore| as its catcode.)
@ The value of |par_loc| is the |eqtb| address of `\.{\\par}'. This quantity
is needed because a blank line of input is supposed to be exactly equivalent
to the appearance of \.{\\par}; we must set |cur_cs:=par_loc|
when detecting a blank line.
@<Glob...@>=
@!par_loc:pointer; {location of `\.{\\par}' in |eqtb|}
@!par_token:halfword; {token representing `\.{\\par}'}
@ @<Put each...@>=
primitive("par",par_end,256); {cf.\ |scan_file_name|}
@!@:par_}{\.{\\par} primitive@>
par_loc:=cur_val; par_token:=cs_token_flag+par_loc;
@ @<Cases of |print_cmd_chr|...@>=
par_end:print_esc("par");
@ Before getting into |get_next|, let's consider the subroutine that
is called when an `\.{\\outer}' control sequence has been scanned or
when the end of a file has been reached. These two cases are distinguished
by |cur_cs|, which is zero at the end of a file.
@p procedure check_outer_validity;
var p:pointer; {points to inserted token list}
@!q:pointer; {auxiliary pointer}
begin if scanner_status<>normal then
begin deletions_allowed:=false;
@<Back up an outer control sequence so that it can be reread@>;
if scanner_status>skipping then
@<Tell the user what has run away and try to recover@>
else begin print_err("Incomplete "); print_cmd_chr(if_test,cur_if);
@.Incomplete \\if...@>
print("; all text was ignored after line "); print_int(skip_line);
help3("A forbidden control sequence occurred in skipped text.")@/
("This kind of error happens when you say `\if...' and forget")@/
("the matching `\fi'. I've inserted a `\fi'; this might work.");
if cur_cs<>0 then cur_cs:=0
else help_line[2]:=@|
"The file ended while I was skipping conditional text.";
cur_tok:=cs_token_flag+frozen_fi; ins_error;
end;
deletions_allowed:=true;
end;
end;
@ An outer control sequence that occurs in a \.{\\read} will not be reread,
since the error recovery for \.{\\read} is not very powerful.
@<Back up an outer control sequence so that it can be reread@>=
if cur_cs<>0 then
begin if (state=token_list)or(name<1)or(name>17) then
begin p:=get_avail; info(p):=cs_token_flag+cur_cs;
back_list(p); {prepare to read the control sequence again}
end;
cur_cmd:=spacer; cur_chr:=" "; {replace it by a space}
end
@ @<Tell the user what has run away...@>=
begin runaway; {print a definition, argument, or preamble}
if cur_cs=0 then print_err("File ended")
@.File ended while scanning...@>
else begin cur_cs:=0; print_err("Forbidden control sequence found");
@.Forbidden control sequence...@>
end;
print(" while scanning ");
@<Print either `\.{definition}' or `\.{use}' or `\.{preamble}' or `\.{text}',
and insert tokens that should lead to recovery@>;
print(" of "); sprint_cs(warning_index);
help4("I suspect you have forgotten a `}', causing me")@/
("to read past where you wanted me to stop.")@/
("I'll try to recover; but if the error is serious,")@/
("you'd better type `E' or `X' now and fix your file.");@/
error;
end
@ The recovery procedure can't be fully understood without knowing more
about the \TeX\ routines that should be aborted, but we can sketch the
ideas here: For a runaway definition or a runaway balanced text
we will insert a right brace; for a
runaway preamble, we will insert a special \.{\\cr} token and a right
brace; and for a runaway argument, we will set |long_state| to
|outer_call| and insert \.{\\par}.
@<Print either `\.{definition}' or ...@>=
p:=get_avail;
case scanner_status of
defining:begin print("definition"); info(p):=right_brace_token+"}";
end;
matching:begin print("use"); info(p):=par_token; long_state:=outer_call;
end;
aligning:begin print("preamble"); info(p):=right_brace_token+"}"; q:=p;
p:=get_avail; link(p):=q; info(p):=cs_token_flag+frozen_cr;
align_state:=-1000000;
end;
absorbing:begin print("text"); info(p):=right_brace_token+"}";
end;
end; {there are no other cases}
ins_list(p)
@ We need to mention a procedure here that may be called by |get_next|.
@p procedure@?firm_up_the_line; forward;
@ Now we're ready to take the plunge into |get_next| itself. Parts of
this routine are executed more often than any other instructions of \TeX.
@^mastication@>@^inner loop@>
@d switch=25 {a label in |get_next|}
@d start_cs=26 {another}
@p procedure get_next; {sets |cur_cmd|, |cur_chr|, |cur_cs| to next token}
label restart, {go here to get the next input token}
switch, {go here to eat the next character from a file}
reswitch, {go here to digest it again}
start_cs, {go here to start looking for a control sequence}
found, {go here when a control sequence has been found}
exit; {go here when the next input token has been got}
var k:0..buf_size; {an index into |buffer|}
@!t:halfword; {a token}
@!cat:0..max_char_code; {|cat_code(cur_chr)|, usually}
@!c,@!cc:ASCII_code; {constituents of a possible expanded code}
@!d:2..3; {number of excess characters in an expanded code}
begin restart: cur_cs:=0;
if state<>token_list then
@<Input from external file, |goto restart| if no input found@>
else @<Input from token list, |goto restart| if end of list or
if a parameter needs to be expanded@>;
@<If an alignment entry has just ended, take appropriate action@>;
exit:end;
@ An alignment entry ends when a tab or \.{\\cr} occurs, provided that the
current level of braces is the same as the level that was present at the
beginning of that alignment entry; i.e., provided that |align_state| has
returned to the value it had after the \<u_j> template for that entry.
@^inner loop@>
@<If an alignment entry has just ended, take appropriate action@>=
if cur_cmd<=car_ret then if cur_cmd>=tab_mark then if align_state=0 then
@<Insert the \(v)\<v_j> template and |goto restart|@>
@ @<Input from external file, |goto restart| if no input found@>=
@^inner loop@>
begin switch: if loc<=limit then {current line not yet finished}
begin cur_chr:=buffer[loc]; incr(loc);
reswitch: cur_cmd:=cat_code(cur_chr);
@<Change state if necessary, and |goto switch| if the
current character should be ignored,
or |goto reswitch| if the current character
changes to another@>;
end
else begin state:=new_line;@/
@<Move to next line of file,
or |goto restart| if there is no next line,
or |return| if a \.{\\read} line has finished@>;
check_interrupt;
goto switch;
end;
end
@ The following 48-way switch accomplishes the scanning quickly, assuming
that a decent \PASCAL\ compiler has translated the code. Note that the numeric
values for |mid_line|, |skip_blanks|, and |new_line| are spaced
apart from each other by |max_char_code+1|, so we can add a character's
command code to the state to get a single number that characterizes both.
@d any_state_plus(#) == mid_line+#,skip_blanks+#,new_line+#
@<Change state if necessary...@>=
case state+cur_cmd of
@<Cases where character is ignored@>: goto switch;
any_state_plus(escape): @<Scan a control sequence
and set |state:=skip_blanks| or |mid_line|@>;
any_state_plus(active_char): @<Process an active-character control sequence
and set |state:=mid_line|@>;
any_state_plus(sup_mark): @<If this |sup_mark| starts an expanded character
like~\.{\^\^A} or~\.{\^\^df}, then |goto reswitch|,
otherwise set |state:=mid_line|@>;
any_state_plus(invalid_char): @<Decry the invalid character and
|goto restart|@>;
@t\4@>@<Handle situations involving spaces, braces, changes of state@>@;
othercases do_nothing
endcases
@ @<Cases where character is ignored@>=
any_state_plus(ignore),skip_blanks+spacer,new_line+spacer
@ We go to |restart| instead of to |switch|, because |state| might equal
|token_list| after the error has been dealt with
(cf.\ |clear_for_error_prompt|).
@<Decry the invalid...@>=
begin print_err("Text line contains an invalid character");
@.Text line contains...@>
help2("A funny symbol that I can't read has just been input.")@/
("Continue, and I'll forget that it ever happened.");@/
deletions_allowed:=false; error; deletions_allowed:=true;
goto restart;
end
@ @d add_delims_to(#)==#+math_shift,#+tab_mark,#+mac_param,
#+sub_mark,#+letter,#+other_char
@<Handle situations involving spaces, braces, changes of state@>=
mid_line+spacer:@<Enter |skip_blanks| state, emit a space@>;
mid_line+car_ret:@<Finish line, emit a space@>;
skip_blanks+car_ret,any_state_plus(comment):
@<Finish line, |goto switch|@>;
new_line+car_ret:@<Finish line, emit a \.{\\par}@>;
mid_line+left_brace: incr(align_state);
skip_blanks+left_brace,new_line+left_brace: begin
state:=mid_line; incr(align_state);
end;
mid_line+right_brace: decr(align_state);
skip_blanks+right_brace,new_line+right_brace: begin
state:=mid_line; decr(align_state);
end;
add_delims_to(skip_blanks),add_delims_to(new_line): state:=mid_line;
@ When a character of type |spacer| gets through, its character code is
changed to $\.{"\ "}=@'40$. This means that the ASCII codes for tab and space,
and for the space inserted at the end of a line, will
be treated alike when macro parameters are being matched. We do this
since such characters are indistinguishable on most computer terminal displays.
@<Finish line, emit a space@>=
begin loc:=limit+1; cur_cmd:=spacer; cur_chr:=" ";
end
@ The following code is performed only when |cur_cmd=spacer|.
@<Enter |skip_blanks| state, emit a space@>=
begin state:=skip_blanks; cur_chr:=" ";
end
@ @<Finish line, |goto switch|@>=
begin loc:=limit+1; goto switch;
end
@ @<Finish line, emit a \.{\\par}@>=
begin loc:=limit+1; cur_cs:=par_loc; cur_cmd:=eq_type(cur_cs);
cur_chr:=equiv(cur_cs);
if cur_cmd>=outer_call then check_outer_validity;
end
@ Notice that a code like \.{\^\^8} becomes \.x if not followed by a hex digit.
@d is_hex(#)==(((#>="0")and(#<="9"))or((#>="a")and(#<="f")))
@d hex_to_cur_chr==
if c<="9" then cur_chr:=c-"0" @+else cur_chr:=c-"a"+10;
if cc<="9" then cur_chr:=16*cur_chr+cc-"0"
else cur_chr:=16*cur_chr+cc-"a"+10
@<If this |sup_mark| starts an expanded character...@>=
begin if cur_chr=buffer[loc] then if loc<limit then
begin c:=buffer[loc+1]; @+if c<@'200 then {yes we have an expanded char}
begin loc:=loc+2;
if is_hex(c) then if loc<=limit then
begin cc:=buffer[loc]; @+if is_hex(cc) then
begin incr(loc); hex_to_cur_chr; goto reswitch;
end;
end;
if c<@'100 then cur_chr:=c+@'100 @+else cur_chr:=c-@'100;
goto reswitch;
end;
end;
state:=mid_line;
end
@ @<Process an active-character...@>=
begin cur_cs:=cur_chr+active_base;
cur_cmd:=eq_type(cur_cs); cur_chr:=equiv(cur_cs); state:=mid_line;
if cur_cmd>=outer_call then check_outer_validity;
end
@ Control sequence names are scanned only when they appear in some line of
a file; once they have been scanned the first time, their |eqtb| location
serves as a unique identification, so \TeX\ doesn't need to refer to the
original name any more except when it prints the equivalent in symbolic form.
The program that scans a control sequence has been written carefully
in order to avoid the blowups that might otherwise occur if a malicious
user tried something like `\.{\\catcode\'15=0}'. The algorithm might
look at |buffer[limit+1]|, but it never looks at |buffer[limit+2]|.
If expanded characters like `\.{\^\^A}' or `\.{\^\^df}'
appear in or just following
a control sequence name, they are converted to single characters in the
buffer and the process is repeated, slowly but surely.
@<Scan a control...@>=
begin if loc>limit then cur_cs:=null_cs {|state| is irrelevant in this case}
else begin start_cs: k:=loc; cur_chr:=buffer[k]; cat:=cat_code(cur_chr);
incr(k);
if cat=letter then state:=skip_blanks
else if cat=spacer then state:=skip_blanks
else state:=mid_line;
if (cat=letter)and(k<=limit) then
@<Scan ahead in the buffer until finding a nonletter;
if an expanded code is encountered, reduce it
and |goto start_cs|; otherwise if a multiletter control
sequence is found, adjust |cur_cs| and |loc|, and
|goto found|@>
else @<If an expanded code is present, reduce it and |goto start_cs|@>;
cur_cs:=single_base+buffer[loc]; incr(loc);
end;
found: cur_cmd:=eq_type(cur_cs); cur_chr:=equiv(cur_cs);
if cur_cmd>=outer_call then check_outer_validity;
end
@ Whenever we reach the following piece of code, we will have
|cur_chr=buffer[k-1]| and |k<=limit+1| and |cat=cat_code(cur_chr)|. If an
expanded code like \.{\^\^A} or \.{\^\^df} appears in |buffer[(k-1)..(k+1)]|
or |buffer[(k-1)..(k+2)]|, we
will store the corresponding code in |buffer[k-1]| and shift the rest of
the buffer left two or three places.
@<If an expanded...@>=
begin if buffer[k]=cur_chr then @+if cat=sup_mark then @+if k<limit then
begin c:=buffer[k+1]; @+if c<@'200 then {yes, one is indeed present}
begin d:=2;
if is_hex(c) then @+if k+2<=limit then
begin cc:=buffer[k+2]; @+if is_hex(cc) then incr(d);
end;
if d>2 then
begin hex_to_cur_chr; buffer[k-1]:=cur_chr;
end
else if c<@'100 then buffer[k-1]:=c+@'100
else buffer[k-1]:=c-@'100;
limit:=limit-d; first:=first-d;
while k<=limit do
begin buffer[k]:=buffer[k+d]; incr(k);
end;
goto start_cs;
end;
end;
end
@ @<Scan ahead in the buffer...@>=
begin repeat cur_chr:=buffer[k]; cat:=cat_code(cur_chr); incr(k);
until (cat<>letter)or(k>limit);
@<If an expanded...@>;
if cat<>letter then decr(k);
{now |k| points to first nonletter}
if k>loc+1 then {multiletter control sequence has been scanned}
begin cur_cs:=id_lookup(loc,k-loc); loc:=k; goto found;
end;
end
@ Let's consider now what happens when |get_next| is looking at a token list.
@<Input from token list, |goto restart| if end of list or
if a parameter needs to be expanded@>=
if loc<>null then {list not exhausted}
@^inner loop@>
begin t:=info(loc); loc:=link(loc); {move to next}
if t>=cs_token_flag then {a control sequence token}
begin cur_cs:=t-cs_token_flag;
cur_cmd:=eq_type(cur_cs); cur_chr:=equiv(cur_cs);
if cur_cmd>=outer_call then
if cur_cmd=dont_expand then
@<Get the next token, suppressing expansion@>
else check_outer_validity;
end
else begin cur_cmd:=t div @'400; cur_chr:=t mod @'400;
case cur_cmd of
left_brace: incr(align_state);
right_brace: decr(align_state);
out_param: @<Insert macro parameter and |goto restart|@>;
othercases do_nothing
endcases;
end;
end
else begin {we are done with this token list}
end_token_list; goto restart; {resume previous level}
end
@ The present point in the program is reached only when the |expand|
routine has inserted a special marker into the input. In this special
case, |info(loc)| is known to be a control sequence token, and |link(loc)=null|.
@d no_expand_flag=257 {this characterizes a special variant of |relax|}
@<Get the next token, suppressing expansion@>=
begin cur_cs:=info(loc)-cs_token_flag; loc:=null;@/
cur_cmd:=eq_type(cur_cs); cur_chr:=equiv(cur_cs);
if cur_cmd>max_command then
begin cur_cmd:=relax; cur_chr:=no_expand_flag;
end;
end
@ @<Insert macro parameter...@>=
begin begin_token_list(param_stack[param_start+cur_chr-1],parameter);
goto restart;
end
@ All of the easy branches of |get_next| have now been taken care of.
There is one more branch.
@d end_line_char_inactive == (end_line_char<0)or(end_line_char>255)
@<Move to next line of file, or |goto restart|...@>=
if name>17 then @<Read next line of file into |buffer|, or
|goto restart| if the file has ended@>
else begin if not terminal_input then {\.{\\read} line has ended}
begin cur_cmd:=0; cur_chr:=0; return;
end;
if input_ptr>0 then {text was inserted during error recovery}
begin end_file_reading; goto restart; {resume previous level}
end;
if selector<log_only then open_log_file;
if interaction>nonstop_mode then
begin if end_line_char_inactive then incr(limit);
if limit=start then {previous line was empty}
print_nl("(Please type a command or say `\end')");
@.Please type...@>
print_ln; first:=start;
prompt_input("*"); {input on-line into |buffer|}
@.*\relax@>
limit:=last;
if end_line_char_inactive then decr(limit)
else buffer[limit]:=end_line_char;
first:=limit+1;
loc:=start;
end
else fatal_error("*** (job aborted, no legal \end found)");
@.job aborted@>
{nonstop mode, which is intended for overnight batch processing,
never waits for on-line input}
end
@ The global variable |force_eof| is normally |false|; it is set |true|
by an \.{\\endinput} command.
@<Glob...@>=
@!force_eof:boolean; {should the next \.{\\input} be aborted early?}
@ @<Read next line of file into |buffer|, or
|goto restart| if the file has ended@>=
begin incr(line); first:=start;
if not force_eof then
if name<=19 then
begin if pseudo_input then {not end of file}
firm_up_the_line {this sets |limit|}
else if (every_eof<>null)and not eof_seen[index] then
begin limit:=first-1; eof_seen[index]:=true; {fake one empty line}
begin_token_list(every_eof,every_eof_text); goto restart;
end
else force_eof:=true;
end
else
begin if input_ln(cur_file,true) then {not end of file}
firm_up_the_line {this sets |limit|}
else if (every_eof<>null)and not eof_seen[index] then
begin limit:=first-1; eof_seen[index]:=true; {fake one empty line}
begin_token_list(every_eof,every_eof_text); goto restart;
end
else force_eof:=true;
end;
if force_eof then
begin if tracing_nesting>0 then
if (grp_stack[in_open]<>cur_boundary)or@|
(if_stack[in_open]<>cond_ptr) then file_warning;
{give warning for some unfinished groups and/or conditionals}
if name>=19 then
begin print_char(")"); decr(open_parens);
update_terminal; {show user that file has been read}
end;
force_eof:=false;
end_file_reading; {resume previous level}
check_outer_validity; goto restart;
end;
if end_line_char_inactive then decr(limit)
else buffer[limit]:=end_line_char;
first:=limit+1; loc:=start; {ready to read}
end
@ If the user has set the |pausing| parameter to some positive value,
and if nonstop mode has not been selected, each line of input is displayed
on the terminal and the transcript file, followed by `\.{=>}'.
\TeX\ waits for a response. If the response is simply |carriage_return|, the
line is accepted as it stands, otherwise the line typed is
used instead of the line in the file.
@p procedure firm_up_the_line;
var k:0..buf_size; {an index into |buffer|}
begin limit:=last;
if pausing>0 then if interaction>nonstop_mode then
begin wake_up_terminal; print_ln;
if start<limit then for k:=start to limit-1 do print(buffer[k]);
first:=limit; prompt_input("=>"); {wait for user response}
@.=>@>
if last>first then
begin for k:=first to last-1 do {move line down in buffer}
buffer[k+start-first]:=buffer[k];
limit:=start+last-first;
end;
end;
end;
@ Since |get_next| is used so frequently in \TeX, it is convenient
to define three related procedures that do a little more:
\yskip\hang|get_token| not only sets |cur_cmd| and |cur_chr|, it
also sets |cur_tok|, a packed halfword version of the current token.
\yskip\hang|get_x_token|, meaning ``get an expanded token,'' is like
|get_token|, but if the current token turns out to be a user-defined
control sequence (i.e., a macro call), or a conditional,
or something like \.{\\topmark} or \.{\\expandafter} or \.{\\csname},
it is eliminated from the input by beginning the expansion of the macro
or the evaluation of the conditional.
\yskip\hang|x_token| is like |get_x_token| except that it assumes that
|get_next| has already been called.
\yskip\noindent
In fact, these three procedures account for almost every use of |get_next|.
@ No new control sequences will be defined except during a call of
|get_token|, or when \.{\\csname} compresses a token list, because
|no_new_control_sequence| is always |true| at other times.
@p procedure get_token; {sets |cur_cmd|, |cur_chr|, |cur_tok|}
begin no_new_control_sequence:=false; get_next; no_new_control_sequence:=true;
@^inner loop@>
if cur_cs=0 then cur_tok:=(cur_cmd*@'400)+cur_chr
else cur_tok:=cs_token_flag+cur_cs;
end;
@* \[25] Expanding the next token.
Only a dozen or so command codes |>max_command| can possibly be returned by
|get_next|; in increasing order, they are |undefined_cs|, |expand_after|,
|no_expand|, |input|, |if_test|, |fi_or_else|, |cs_name|, |convert|, |the|,
|top_bot_mark|, |call|, |long_call|, |outer_call|, |long_outer_call|, and
|end_template|.{\emergencystretch=40pt\par}
The |expand| subroutine is used when |cur_cmd>max_command|. It removes a
``call'' or a conditional or one of the other special operations just
listed. It follows that |expand| might invoke itself recursively. In all
cases, |expand| destroys the current token, but it sets things up so that
the next |get_next| will deliver the appropriate next token. The value of
|cur_tok| need not be known when |expand| is called.
Since several of the basic scanning routines communicate via global variables,
their values are saved as local variables of |expand| so that
recursive calls don't invalidate them.
@^recursion@>
@p@t\4@>@<Declare the procedure called |macro_call|@>@;@/
@t\4@>@<Declare the procedure called |insert_relax|@>@;@/
@t\4@>@<Declare \eTeX\ procedures for expanding@>@;@/
procedure@?pass_text; forward;@t\2@>
procedure@?start_input; forward;@t\2@>
procedure@?conditional; forward;@t\2@>
procedure@?get_x_token; forward;@t\2@>
procedure@?conv_toks; forward;@t\2@>
procedure@?ins_the_toks; forward;@t\2@>
procedure expand;
label reswitch;
var t:halfword; {token that is being ``expanded after''}
@!b:boolean; {keep track of nested csnames}
@!p,@!q,@!r:pointer; {for list manipulation}
@!j:0..buf_size; {index into |buffer|}
@!cv_backup:integer; {to save the global quantity |cur_val|}
@!cvl_backup,@!radix_backup,@!co_backup:small_number;
{to save |cur_val_level|, etc.}
@!backup_backup:pointer; {to save |link(backup_head)|}
@!save_scanner_status:small_number; {temporary storage of |scanner_status|}
begin cv_backup:=cur_val; cvl_backup:=cur_val_level; radix_backup:=radix;
co_backup:=cur_order; backup_backup:=link(backup_head);
reswitch:
if cur_cmd<call then @<Expand a nonmacro@>
else if cur_cmd<end_template then macro_call
else @<Insert a token containing |frozen_endv|@>;
cur_val:=cv_backup; cur_val_level:=cvl_backup; radix:=radix_backup;
cur_order:=co_backup; link(backup_head):=backup_backup;
end;
@ @<Glob...@>=
@!is_in_csname: boolean;
@ @<Set init...@>=
is_in_csname := false;
@ @<Expand a nonmacro@>=
begin if tracing_commands>1 then show_cur_cmd_chr;
case cur_cmd of
top_bot_mark:@<Insert the \(a)appropriate mark text into the scanner@>;
expand_after:if cur_chr=0 then @<Expand the token after the next token@>
else @<Negate a boolean conditional and |goto reswitch|@>;
no_expand: if cur_chr=0 then @<Suppress expansion of the next token@>
else @<Implement \.{\\pdfprimitive}@>;
cs_name:@<Manufacture a control sequence name@>;
convert:conv_toks; {this procedure is discussed in Part 27 below}
the:ins_the_toks; {this procedure is discussed in Part 27 below}
if_test:conditional; {this procedure is discussed in Part 28 below}
fi_or_else:@<Terminate the current conditional and skip to \.{\\fi}@>;
input:@<Initiate or terminate input from a file@>;
othercases @<Complain about an undefined macro@>
endcases;
end
@ It takes only a little shuffling to do what \TeX\ calls \.{\\expandafter}.
@<Expand the token after...@>=
begin get_token; t:=cur_tok; get_token;
if cur_cmd>max_command then expand@+else back_input;
cur_tok:=t; back_input;
end
@ The implementation of \.{\\noexpand} is a bit trickier, because it is
necessary to insert a special `|dont_expand|' marker into \TeX's reading
mechanism. This special marker is processed by |get_next|, but it does
not slow down the inner loop.
Since \.{\\outer} macros might arise here, we must also
clear the |scanner_status| temporarily.
@<Suppress expansion...@>=
begin save_scanner_status:=scanner_status; scanner_status:=normal;
get_token; scanner_status:=save_scanner_status; t:=cur_tok;
back_input; {now |start| and |loc| point to the backed-up token |t|}
if t>=cs_token_flag then
begin p:=get_avail; info(p):=cs_token_flag+frozen_dont_expand;
link(p):=loc; start:=p; loc:=p;
end;
end
@ The \.{\\pdfprimitive} handling. If the primitive meaning of the next
token is an expandable command, it suffices to replace the current
token with the primitive one and restart |expand|.
Otherwise, the token we just read has to be pushed back, as well
as a token matching the internal form of \.{\\pdfprimitive}, that is
sneaked in as an alternate form of |ignore_spaces|.
@!@:pdfprimitive_}{\.{\\pdfprimitive} primitive (internalized)@>
Simply pushing back a token that matches the correct internal command
does not work, because approach would not survive roundtripping to a
temporary file.
@<Implement \.{\\pdfprimitive}@>=
begin save_scanner_status := scanner_status; scanner_status:=normal;
get_token; scanner_status:=save_scanner_status;
if cur_cs < hash_base then
cur_cs := prim_lookup(cur_cs-single_base)
else
cur_cs := prim_lookup(text(cur_cs));
if cur_cs<>undefined_primitive then begin
t := prim_eq_type(cur_cs);
if t>max_command then begin
cur_cmd := t;
cur_chr := prim_equiv(cur_cs);
cur_tok := (cur_cmd*@'400)+cur_chr;
cur_cs := 0;
goto reswitch;
end
else begin
back_input; { now |loc| and |start| point to a one-item list }
p:=get_avail; info(p):=cs_token_flag+frozen_primitive;
link(p):=loc; loc:=p; start:=p;
end;
end;
end
@ This block deals with unexpandable \.{\\primitive} appearing at a spot where
an integer or an internal values should have been found. It fetches the
next token then resets |cur_cmd|, |cur_cs|, and |cur_tok|, based on the
primitive value of that token. No expansion takes place, because the
next token may be all sorts of things. This could trigger further
expansion creating new errors.
@<Reset |cur_tok| for unexpandable primitives, goto restart @>=
begin
get_token;
if cur_cs < hash_base then
cur_cs := prim_lookup(cur_cs-single_base)
else
cur_cs := prim_lookup(text(cur_cs));
if cur_cs<>undefined_primitive then begin
cur_cmd := prim_eq_type(cur_cs);
cur_chr := prim_equiv(cur_cs);
cur_cs := prim_eqtb_base+cur_cs;
cur_tok := cs_token_flag+cur_cs;
end
else begin
cur_cmd := relax;
cur_chr := 0;
cur_tok := cs_token_flag+frozen_relax;
cur_cs := frozen_relax;
end;
goto restart;
end
@ @<Complain about an undefined macro@>=
begin print_err("Undefined control sequence");
@.Undefined control sequence@>
help5("The control sequence at the end of the top line")@/
("of your error message was never \def'ed. If you have")@/
("misspelled it (e.g., `\hobx'), type `I' and the correct")@/
("spelling (e.g., `I\hbox'). Otherwise just continue,")@/
("and I'll forget about whatever was undefined.");
error;
end
@ The |expand| procedure and some other routines that construct token
lists find it convenient to use the following macros, which are valid only if
the variables |p| and |q| are reserved for token-list building.
@d store_new_token(#)==begin q:=get_avail; link(p):=q; info(q):=#;
p:=q; {|link(p)| is |null|}
end
@d fast_store_new_token(#)==begin fast_get_avail(q); link(p):=q; info(q):=#;
p:=q; {|link(p)| is |null|}
end
@ @<Manufacture a control...@>=
begin r:=get_avail; p:=r; {head of the list of characters}
b := is_in_csname; is_in_csname := true;
repeat get_x_token;
if cur_cs=0 then store_new_token(cur_tok);
until cur_cs<>0;
if cur_cmd<>end_cs_name then @<Complain about missing \.{\\endcsname}@>;
is_in_csname := b;
@<Look up the characters of list |r| in the hash table, and set |cur_cs|@>;
flush_list(r);
if eq_type(cur_cs)=undefined_cs then
begin eq_define(cur_cs,relax,256); {N.B.: The |save_stack| might change}
end; {the control sequence will now match `\.{\\relax}'}
cur_tok:=cur_cs+cs_token_flag; back_input;
end
@ @<Complain about missing \.{\\endcsname}@>=
begin print_err("Missing "); print_esc("endcsname"); print(" inserted");
@.Missing \\endcsname...@>
help2("The control sequence marked <to be read again> should")@/
("not appear between \csname and \endcsname.");
back_error;
end
@ @<Look up the characters of list |r| in the hash table...@>=
j:=first; p:=link(r);
while p<>null do
begin if j>=max_buf_stack then
begin max_buf_stack:=j+1;
if max_buf_stack=buf_size then
overflow("buffer size",buf_size);
@:TeX capacity exceeded buffer size}{\quad buffer size@>
end;
buffer[j]:=info(p) mod @'400; incr(j); p:=link(p);
end;
if j>first+1 then
begin no_new_control_sequence:=false; cur_cs:=id_lookup(first,j-first);
no_new_control_sequence:=true;
end
else if j=first then cur_cs:=null_cs {the list is empty}
else cur_cs:=single_base+buffer[first] {the list has length one}
@ An |end_template| command is effectively changed to an |endv| command
by the following code. (The reason for this is discussed below; the
|frozen_end_template| at the end of the template has passed the
|check_outer_validity| test, so its mission of error detection has been
accomplished.)
@<Insert a token containing |frozen_endv|@>=
begin cur_tok:=cs_token_flag+frozen_endv; back_input;
end
@ The processing of \.{\\input} involves the |start_input| subroutine,
which will be declared later; the processing of \.{\\endinput} is trivial.
@<Put each...@>=
primitive("input",input,0);@/
@!@:input_}{\.{\\input} primitive@>
primitive("endinput",input,1);@/
@!@:end_input_}{\.{\\endinput} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
input: if chr_code=0 then print_esc("input")
@/@<Cases of |input| for |print_cmd_chr|@>@/
else print_esc("endinput");
@ @<Initiate or terminate input...@>=
if cur_chr=1 then force_eof:=true
@/@<Cases for |input|@>@/
else if name_in_progress then insert_relax
else start_input
@ Sometimes the expansion looks too far ahead, so we want to insert
a harmless \.{\\relax} into the user's input.
@<Declare the procedure called |insert_relax|@>=
procedure insert_relax;
begin cur_tok:=cs_token_flag+cur_cs; back_input;
cur_tok:=cs_token_flag+frozen_relax; back_input; token_type:=inserted;
end;
@ Here is a recursive procedure that is \TeX's usual way to get the
next token of input. It has been slightly optimized to take account of
common cases.
@p procedure get_x_token; {sets |cur_cmd|, |cur_chr|, |cur_tok|,
and expands macros}
label restart,done;
begin restart: get_next;
@^inner loop@>
if cur_cmd<=max_command then goto done;
if cur_cmd>=call then
if cur_cmd<end_template then macro_call
else begin cur_cs:=frozen_endv; cur_cmd:=endv;
goto done; {|cur_chr=null_list|}
end
else expand;
goto restart;
done: if cur_cs=0 then cur_tok:=(cur_cmd*@'400)+cur_chr
else cur_tok:=cs_token_flag+cur_cs;
end;
@ The |get_x_token| procedure is essentially equivalent to two consecutive
procedure calls: |get_next; x_token|.
@p procedure x_token; {|get_x_token| without the initial |get_next|}
begin while cur_cmd>max_command do
begin expand;
get_next;
end;
if cur_cs=0 then cur_tok:=(cur_cmd*@'400)+cur_chr
else cur_tok:=cs_token_flag+cur_cs;
end;
@ A control sequence that has been \.{\\def}'ed by the user is expanded by
\TeX's |macro_call| procedure.
Before we get into the details of |macro_call|, however, let's consider the
treatment of primitives like \.{\\topmark}, since they are essentially
macros without parameters. The token lists for such marks are kept in a
global array of five pointers; we refer to the individual entries of this
array by symbolic names |top_mark|, etc. The value of |top_mark| is either
|null| or a pointer to the reference count of a token list.
@d marks_code==5 {add this for \.{\\topmarks} etc.}
@#
@d top_mark_code=0 {the mark in effect at the previous page break}
@d first_mark_code=1 {the first mark between |top_mark| and |bot_mark|}
@d bot_mark_code=2 {the mark in effect at the current page break}
@d split_first_mark_code=3 {the first mark found by \.{\\vsplit}}
@d split_bot_mark_code=4 {the last mark found by \.{\\vsplit}}
@d top_mark==cur_mark[top_mark_code]
@d first_mark==cur_mark[first_mark_code]
@d bot_mark==cur_mark[bot_mark_code]
@d split_first_mark==cur_mark[split_first_mark_code]
@d split_bot_mark==cur_mark[split_bot_mark_code]
@<Glob...@>=
@!cur_mark:array[top_mark_code..split_bot_mark_code] of pointer;
{token lists for marks}
@ @<Set init...@>=
top_mark:=null; first_mark:=null; bot_mark:=null;
split_first_mark:=null; split_bot_mark:=null;
@ @<Put each...@>=
primitive("topmark",top_bot_mark,top_mark_code);
@!@:top_mark_}{\.{\\topmark} primitive@>
primitive("firstmark",top_bot_mark,first_mark_code);
@!@:first_mark_}{\.{\\firstmark} primitive@>
primitive("botmark",top_bot_mark,bot_mark_code);
@!@:bot_mark_}{\.{\\botmark} primitive@>
primitive("splitfirstmark",top_bot_mark,split_first_mark_code);
@!@:split_first_mark_}{\.{\\splitfirstmark} primitive@>
primitive("splitbotmark",top_bot_mark,split_bot_mark_code);
@!@:split_bot_mark_}{\.{\\splitbotmark} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
top_bot_mark: begin case (chr_code mod marks_code) of
first_mark_code: print_esc("firstmark");
bot_mark_code: print_esc("botmark");
split_first_mark_code: print_esc("splitfirstmark");
split_bot_mark_code: print_esc("splitbotmark");
othercases print_esc("topmark")
endcases;
if chr_code>=marks_code then print_char("s");
end;
@ The following code is activated when |cur_cmd=top_bot_mark| and
when |cur_chr| is a code like |top_mark_code|.
@<Insert the \(a)appropriate mark text into the scanner@>=
begin t:=cur_chr mod marks_code;
if cur_chr>=marks_code then scan_register_num@+else cur_val:=0;
if cur_val=0 then cur_ptr:=cur_mark[t]
else @<Compute the mark pointer for mark type |t| and class |cur_val|@>;
if cur_ptr<>null then begin_token_list(cur_ptr,mark_text);
end
@ Now let's consider |macro_call| itself, which is invoked when \TeX\ is
scanning a control sequence whose |cur_cmd| is either |call|, |long_call|,
|outer_call|, or |long_outer_call|. The control sequence definition
appears in the token list whose reference count is in location |cur_chr|
of |mem|.
The global variable |long_state| will be set to |call| or to |long_call|,
depending on whether or not the control sequence disallows \.{\\par}
in its parameters. The |get_next| routine will set |long_state| to
|outer_call| and emit \.{\\par}, if a file ends or if an \.{\\outer}
control sequence occurs in the midst of an argument.
@<Glob...@>=
@!long_state:call..long_outer_call; {governs the acceptance of \.{\\par}}
@ The parameters, if any, must be scanned before the macro is expanded.
Parameters are token lists without reference counts. They are placed on
an auxiliary stack called |pstack| while they are being scanned, since
the |param_stack| may be losing entries during the matching process.
(Note that |param_stack| can't be gaining entries, since |macro_call| is
the only routine that puts anything onto |param_stack|, and it
is not recursive.)
@<Glob...@>=
@!pstack:array[0..8] of pointer; {arguments supplied to a macro}
@ After parameter scanning is complete, the parameters are moved to the
|param_stack|. Then the macro body is fed to the scanner; in other words,
|macro_call| places the defined text of the control sequence at the
top of\/ \TeX's input stack, so that |get_next| will proceed to read it
next.
The global variable |cur_cs| contains the |eqtb| address of the control sequence
being expanded, when |macro_call| begins. If this control sequence has not been
declared \.{\\long}, i.e., if its command code in the |eq_type| field is
not |long_call| or |long_outer_call|, its parameters are not allowed to contain
the control sequence \.{\\par}. If an illegal \.{\\par} appears, the macro
call is aborted, and the \.{\\par} will be rescanned.
@<Declare the procedure called |macro_call|@>=
procedure macro_call; {invokes a user-defined control sequence}
label exit, continue, done, done1, found;
var r:pointer; {current node in the macro's token list}
@!p:pointer; {current node in parameter token list being built}
@!q:pointer; {new node being put into the token list}
@!s:pointer; {backup pointer for parameter matching}
@!t:pointer; {cycle pointer for backup recovery}
@!u,@!v:pointer; {auxiliary pointers for backup recovery}
@!rbrace_ptr:pointer; {one step before the last |right_brace| token}
@!n:small_number; {the number of parameters scanned}
@!unbalance:halfword; {unmatched left braces in current parameter}
@!m:halfword; {the number of tokens or groups (usually)}
@!ref_count:pointer; {start of the token list}
@!save_scanner_status:small_number; {|scanner_status| upon entry}
@!save_warning_index:pointer; {|warning_index| upon entry}
@!match_chr:ASCII_code; {character used in parameter}
begin save_scanner_status:=scanner_status; save_warning_index:=warning_index;
warning_index:=cur_cs; ref_count:=cur_chr; r:=link(ref_count); n:=0;
if tracing_macros>0 then @<Show the text of the macro being expanded@>;
if info(r)=protected_token then r:=link(r);
if info(r)<>end_match_token then
@<Scan the parameters and make |link(r)| point to the macro body; but
|return| if an illegal \.{\\par} is detected@>;
@<Feed the macro body and its parameters to the scanner@>;
exit:scanner_status:=save_scanner_status; warning_index:=save_warning_index;
end;
@ Before we put a new token list on the input stack, it is wise to clean off
all token lists that have recently been depleted. Then a user macro that ends
with a call to itself will not require unbounded stack space.
@<Feed the macro body and its parameters to the scanner@>=
while (state=token_list)and(loc=null)and(token_type<>v_template) do
end_token_list; {conserve stack space}
begin_token_list(ref_count,macro); name:=warning_index; loc:=link(r);
if n>0 then
begin if param_ptr+n>max_param_stack then
begin max_param_stack:=param_ptr+n;
if max_param_stack>param_size then
overflow("parameter stack size",param_size);
@:TeX capacity exceeded parameter stack size}{\quad parameter stack size@>
end;
for m:=0 to n-1 do param_stack[param_ptr+m]:=pstack[m];
param_ptr:=param_ptr+n;
end
@ At this point, the reader will find it advisable to review the explanation
of token list format that was presented earlier, since many aspects of that
format are of importance chiefly in the |macro_call| routine.
The token list might begin with a string of compulsory tokens before the
first |match| or |end_match|. In that case the macro name is supposed to be
followed by those tokens; the following program will set |s=null| to
represent this restriction. Otherwise |s| will be set to the first token of
a string that will delimit the next parameter.
@<Scan the parameters and make |link(r)| point to the macro body...@>=
begin scanner_status:=matching; unbalance:=0;
long_state:=eq_type(cur_cs);
if long_state>=outer_call then long_state:=long_state-2;
repeat link(temp_head):=null;
if (info(r)>match_token+255)or(info(r)<match_token) then s:=null
else begin match_chr:=info(r)-match_token; s:=link(r); r:=s;
p:=temp_head; m:=0;
end;
@<Scan a parameter until its delimiter string has been found; or, if |s=null|,
simply scan the delimiter string@>;@/
{now |info(r)| is a token whose command code is either |match| or |end_match|}
until info(r)=end_match_token;
end
@ If |info(r)| is a |match| or |end_match| command, it cannot be equal to
any token found by |get_token|. Therefore an undelimited parameter---i.e.,
a |match| that is immediately followed by |match| or |end_match|---will
always fail the test `|cur_tok=info(r)|' in the following algorithm.
@<Scan a parameter until its delimiter string has been found; or, ...@>=
continue: get_token; {set |cur_tok| to the next token of input}
if cur_tok=info(r) then
@<Advance \(r)|r|; |goto found| if the parameter delimiter has been
fully matched, otherwise |goto continue|@>;
@<Contribute the recently matched tokens to the current parameter, and
|goto continue| if a partial match is still in effect;
but abort if |s=null|@>;
if cur_tok=par_token then if long_state<>long_call then
@<Report a runaway argument and abort@>;
if cur_tok<right_brace_limit then
if cur_tok<left_brace_limit then
@<Contribute an entire group to the current parameter@>
else @<Report an extra right brace and |goto continue|@>
else @<Store the current token, but |goto continue| if it is
a blank space that would become an undelimited parameter@>;
incr(m);
if info(r)>end_match_token then goto continue;
if info(r)<match_token then goto continue;
found: if s<>null then @<Tidy up the parameter just scanned, and tuck it away@>
@ @<Store the current token, but |goto continue| if it is...@>=
begin if cur_tok=space_token then
if info(r)<=end_match_token then
if info(r)>=match_token then goto continue;
store_new_token(cur_tok);
end
@ A slightly subtle point arises here: When the parameter delimiter ends
with `\.{\#\{}', the token list will have a left brace both before and
after the |end_match|\kern-.4pt. Only one of these should affect the
|align_state|, but both will be scanned, so we must make a correction.
@<Advance \(r)|r|; |goto found| if the parameter delimiter has been fully...@>=
begin r:=link(r);
if (info(r)>=match_token)and(info(r)<=end_match_token) then
begin if cur_tok<left_brace_limit then decr(align_state);
goto found;
end
else goto continue;
end
@ @<Report an extra right brace and |goto continue|@>=
begin back_input; print_err("Argument of "); sprint_cs(warning_index);
@.Argument of \\x has...@>
print(" has an extra }");
help6("I've run across a `}' that doesn't seem to match anything.")@/
("For example, `\def\a#1{...}' and `\a}' would produce")@/
("this error. If you simply proceed now, the `\par' that")@/
("I've just inserted will cause me to report a runaway")@/
("argument that might be the root of the problem. But if")@/
("your `}' was spurious, just type `2' and it will go away.");
incr(align_state); long_state:=call; cur_tok:=par_token; ins_error;
goto continue;
end {a white lie; the \.{\\par} won't always trigger a runaway}
@ If |long_state=outer_call|, a runaway argument has already been reported.
@<Report a runaway argument and abort@>=
begin if long_state=call then
begin runaway; print_err("Paragraph ended before ");
@.Paragraph ended before...@>
sprint_cs(warning_index); print(" was complete");
help3("I suspect you've forgotten a `}', causing me to apply this")@/
("control sequence to too much text. How can we recover?")@/
("My plan is to forget the whole thing and hope for the best.");
back_error;
end;
pstack[n]:=link(temp_head); align_state:=align_state-unbalance;
for m:=0 to n do flush_list(pstack[m]);
return;
end
@ When the following code becomes active, we have matched tokens from |s| to
the predecessor of |r|, and we have found that |cur_tok<>info(r)|. An
interesting situation now presents itself: If the parameter is to be
delimited by a string such as `\.{ab}', and if we have scanned `\.{aa}',
we want to contribute one `\.a' to the current parameter and resume
looking for a `\.b'. The program must account for such partial matches and
for others that can be quite complex. But most of the time we have |s=r|
and nothing needs to be done.
Incidentally, it is possible for \.{\\par} tokens to sneak in to certain
parameters of non-\.{\\long} macros. For example, consider a case like
`\.{\\def\\a\#1\\par!\{...\}}' where the first \.{\\par} is not followed
by an exclamation point. In such situations it does not seem appropriate
to prohibit the \.{\\par}, so \TeX\ keeps quiet about this bending of
the rules.
@<Contribute the recently matched tokens to the current parameter...@>=
if s<>r then
if s=null then @<Report an improper use of the macro and abort@>
else begin t:=s;
repeat store_new_token(info(t)); incr(m); u:=link(t); v:=s;
loop@+ begin if u=r then
if cur_tok<>info(v) then goto done
else begin r:=link(v); goto continue;
end;
if info(u)<>info(v) then goto done;
u:=link(u); v:=link(v);
end;
done: t:=link(t);
until t=r;
r:=s; {at this point, no tokens are recently matched}
end
@ @<Report an improper use...@>=
begin print_err("Use of "); sprint_cs(warning_index);
@.Use of x doesn't match...@>
print(" doesn't match its definition");
help4("If you say, e.g., `\def\a1{...}', then you must always")@/
("put `1' after `\a', since control sequence names are")@/
("made up of letters only. The macro here has not been")@/
("followed by the required stuff, so I'm ignoring it.");
error; return;
end
@ @<Contribute an entire group to the current parameter@>=
begin unbalance:=1;
@^inner loop@>
loop@+ begin fast_store_new_token(cur_tok); get_token;
if cur_tok=par_token then if long_state<>long_call then
@<Report a runaway argument and abort@>;
if cur_tok<right_brace_limit then
if cur_tok<left_brace_limit then incr(unbalance)
else begin decr(unbalance);
if unbalance=0 then goto done1;
end;
end;
done1: rbrace_ptr:=p; store_new_token(cur_tok);
end
@ If the parameter consists of a single group enclosed in braces, we must
strip off the enclosing braces. That's why |rbrace_ptr| was introduced.
@<Tidy up the parameter just scanned, and tuck it away@>=
begin if (m=1)and(info(p)<right_brace_limit) then
begin link(rbrace_ptr):=null; free_avail(p);
p:=link(temp_head); pstack[n]:=link(p); free_avail(p);
end
else pstack[n]:=link(temp_head);
incr(n);
if tracing_macros>0 then
begin begin_diagnostic; print_nl(match_chr); print_int(n);
print("<-"); show_token_list(pstack[n-1],null,1000);
end_diagnostic(false);
end;
end
@ @<Show the text of the macro being expanded@>=
begin begin_diagnostic; print_ln; print_cs(warning_index);
token_show(ref_count); end_diagnostic(false);
end
@* \[26] Basic scanning subroutines.
Let's turn now to some procedures that \TeX\ calls upon frequently to digest
certain kinds of patterns in the input. Most of these are quite simple;
some are quite elaborate. Almost all of the routines call |get_x_token|,
which can cause them to be invoked recursively.
@^stomach@>
@^recursion@>
@ The |scan_left_brace| routine is called when a left brace is supposed to be
the next non-blank token. (The term ``left brace'' means, more precisely,
a character whose catcode is |left_brace|.) \TeX\ allows \.{\\relax} to
appear before the |left_brace|.
@p procedure scan_left_brace; {reads a mandatory |left_brace|}
begin @<Get the next non-blank non-relax non-call token@>;
if cur_cmd<>left_brace then
begin print_err("Missing { inserted");
@.Missing \{ inserted@>
help4("A left brace was mandatory here, so I've put one in.")@/
("You might want to delete and/or insert some corrections")@/
("so that I will find a matching right brace soon.")@/
("(If you're confused by all this, try typing `I}' now.)");
back_error; cur_tok:=left_brace_token+"{"; cur_cmd:=left_brace;
cur_chr:="{"; incr(align_state);
end;
end;
@ @<Get the next non-blank non-relax non-call token@>=
repeat get_x_token;
until (cur_cmd<>spacer)and(cur_cmd<>relax)
@ The |scan_optional_equals| routine looks for an optional `\.=' sign preceded
by optional spaces; `\.{\\relax}' is not ignored here.
@p procedure scan_optional_equals;
begin @<Get the next non-blank non-call token@>;
if cur_tok<>other_token+"=" then back_input;
end;
@ @<Get the next non-blank non-call token@>=
repeat get_x_token;
until cur_cmd<>spacer
@ In case you are getting bored, here is a slightly less trivial routine:
Given a string of lowercase letters, like `\.{pt}' or `\.{plus}' or
`\.{width}', the |scan_keyword| routine checks to see whether the next
tokens of input match this string. The match must be exact, except that
uppercase letters will match their lowercase counterparts; uppercase
equivalents are determined by subtracting |"a"-"A"|, rather than using the
|uc_code| table, since \TeX\ uses this routine only for its own limited
set of keywords.
If a match is found, the characters are effectively removed from the input
and |true| is returned. Otherwise |false| is returned, and the input
is left essentially unchanged (except for the fact that some macros
may have been expanded, etc.).
@^inner loop@>
@p function scan_keyword(@!s:str_number):boolean; {look for a given string}
label exit;
var p:pointer; {tail of the backup list}
@!q:pointer; {new node being added to the token list via |store_new_token|}
@!k:pool_pointer; {index into |str_pool|}
@!save_cur_cs:pointer; {to save |cur_cs|}
begin p:=backup_head; link(p):=null; k:=str_start[s];
save_cur_cs:=cur_cs;
while k<str_start[s+1] do
begin get_x_token; {recursion is possible here}
@^recursion@>
if (cur_cs=0)and@|
((cur_chr=so(str_pool[k]))or(cur_chr=so(str_pool[k])-"a"+"A")) then
begin store_new_token(cur_tok); incr(k);
end
else if (cur_cmd<>spacer)or(p<>backup_head) then
begin back_input;
if p<>backup_head then back_list(link(backup_head));
cur_cs:=save_cur_cs;
scan_keyword:=false; return;
end;
end;
flush_list(link(backup_head)); scan_keyword:=true;
exit:end;
@ Here is a procedure that sounds an alarm when mu and non-mu units
are being switched.
@p procedure mu_error;
begin print_err("Incompatible glue units");
@.Incompatible glue units@>
help1("I'm going to assume that 1mu=1pt when they're mixed.");
error;
end;
@ The next routine `|scan_something_internal|' is used to fetch internal
numeric quantities like `\.{\\hsize}', and also to handle the `\.{\\the}'
when expanding constructions like `\.{\\the\\toks0}' and
`\.{\\the\\baselineskip}'. Soon we will be considering the |scan_int|
procedure, which calls |scan_something_internal|; on the other hand,
|scan_something_internal| also calls |scan_int|, for constructions like
`\.{\\catcode\`\\\$}' or `\.{\\fontdimen} \.3 \.{\\ff}'. So we
have to declare |scan_int| as a |forward| procedure. A few other
procedures are also declared at this point.
@p procedure@?scan_int; forward; {scans an integer value}
@t\4\4@>@<Declare procedures that scan restricted classes of integers@>@;
@t\4\4@>@<Declare \eTeX\ procedures for scanning@>@;
@t\4\4@>@<Declare procedures that scan font-related stuff@>
@ \TeX\ doesn't know exactly what to expect when |scan_something_internal|
begins. For example, an integer or dimension or glue value could occur
immediately after `\.{\\hskip}'; and one can even say \.{\\the} with
respect to token lists in constructions like
`\.{\\xdef\\o\{\\the\\output\}}'. On the other hand, only integers are
allowed after a construction like `\.{\\count}'. To handle the various
possibilities, |scan_something_internal| has a |level| parameter, which
tells the ``highest'' kind of quantity that |scan_something_internal| is
allowed to produce. Six levels are distinguished, namely |int_val|,
|dimen_val|, |glue_val|, |mu_val|, |ident_val|, and |tok_val|.
The output of |scan_something_internal| (and of the other routines
|scan_int|, |scan_dimen|, and |scan_glue| below) is put into the global
variable |cur_val|, and its level is put into |cur_val_level|. The highest
values of |cur_val_level| are special: |mu_val| is used only when
|cur_val| points to something in a ``muskip'' register, or to one of the
three parameters \.{\\thinmuskip}, \.{\\medmuskip}, \.{\\thickmuskip};
|ident_val| is used only when |cur_val| points to a font identifier;
|tok_val| is used only when |cur_val| points to |null| or to the reference
count of a token list. The last two cases are allowed only when
|scan_something_internal| is called with |level=tok_val|.
If the output is glue, |cur_val| will point to a glue specification, and
the reference count of that glue will have been updated to reflect this
reference; if the output is a nonempty token list, |cur_val| will point to
its reference count, but in this case the count will not have been updated.
Otherwise |cur_val| will contain the integer or scaled value in question.
@d int_val=0 {integer values}
@d dimen_val=1 {dimension values}
@d glue_val=2 {glue specifications}
@d mu_val=3 {math glue specifications}
@d ident_val=4 {font identifier}
@d tok_val=5 {token lists}
@<Glob...@>=
@!cur_val:integer; {value returned by numeric scanners}
@!cur_val_level:int_val..tok_val; {the ``level'' of this value}
@ The hash table is initialized with `\.{\\count}', `\.{\\dimen}', `\.{\\skip}',
and `\.{\\muskip}' all having |register| as their command code; they are
distinguished by the |chr_code|, which is either |int_val|, |dimen_val|,
|glue_val|, or |mu_val| more than |mem_bot| (dynamic variable-size nodes
cannot have these values)
@<Put each...@>=
primitive("count",register,mem_bot+int_val);
@!@:count_}{\.{\\count} primitive@>
primitive("dimen",register,mem_bot+dimen_val);
@!@:dimen_}{\.{\\dimen} primitive@>
primitive("skip",register,mem_bot+glue_val);
@!@:skip_}{\.{\\skip} primitive@>
primitive("muskip",register,mem_bot+mu_val);
@!@:mu_skip_}{\.{\\muskip} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
register: @<Cases of |register| for |print_cmd_chr|@>;
@ OK, we're ready for |scan_something_internal| itself. A second parameter,
|negative|, is set |true| if the value that is found should be negated.
It is assumed that |cur_cmd| and |cur_chr| represent the first token of
the internal quantity to be scanned; an error will be signalled if
|cur_cmd<min_internal| or |cur_cmd>max_internal|.
@d scanned_result_end(#)==cur_val_level:=#;@+end
@d scanned_result(#)==@+begin cur_val:=#;scanned_result_end
@p procedure scan_something_internal(@!level:small_number;@!negative:boolean);
{fetch an internal parameter}
label exit, restart;
var m:halfword; {|chr_code| part of the operand token}
n, k: integer; {accumulators}
@!q,@!r:pointer; {general purpose indices}
@!tx:pointer; {effective tail node}
@!i:four_quarters; {character info}
@!p:0..nest_size; {index into |nest|}
begin restart: m:=cur_chr;
case cur_cmd of
def_code: @<Fetch a character code from some table@>;
toks_register,assign_toks,def_family,set_font,def_font,letterspace_font,pdf_copy_font: @<Fetch a token list or
font identifier, provided that |level=tok_val|@>;
assign_int: scanned_result(eqtb[m].int)(int_val);
assign_dimen: scanned_result(eqtb[m].sc)(dimen_val);
assign_glue: scanned_result(equiv(m))(glue_val);
assign_mu_glue: scanned_result(equiv(m))(mu_val);
set_aux: @<Fetch the |space_factor| or the |prev_depth|@>;
set_prev_graf: @<Fetch the |prev_graf|@>;
set_page_int:@<Fetch the |dead_cycles| or the |insert_penalties|@>;
set_page_dimen: @<Fetch something on the |page_so_far|@>;
set_shape: @<Fetch the |par_shape| size@>;
set_box_dimen: @<Fetch a box dimension@>;
char_given,math_given: scanned_result(cur_chr)(int_val);
assign_font_dimen: @<Fetch a font dimension@>;
assign_font_int: @<Fetch a font integer@>;
register: @<Fetch a register@>;
last_item: @<Fetch an item in the current node, if appropriate@>;
ignore_spaces: {trap unexpandable primitives}
if cur_chr=1 then @<Reset |cur_tok| for unexpandable primitives, goto restart@>;
othercases @<Complain that \.{\\the} can't do this; give zero result@>
endcases;@/
while cur_val_level>level do @<Convert \(c)|cur_val| to a lower level@>;
@<Fix the reference count, if any, and negate |cur_val| if |negative|@>;
exit:end;
@ @<Fetch a character code from some table@>=
begin scan_char_num;
if m=math_code_base then scanned_result(ho(math_code(cur_val)))(int_val)
else if m<math_code_base then scanned_result(equiv(m+cur_val))(int_val)
else scanned_result(eqtb[m+cur_val].int)(int_val);
end
@ @<Fetch a token list...@>=
if level<>tok_val then
begin print_err("Missing number, treated as zero");
@.Missing number...@>
help3("A number should have been here; I inserted `0'.")@/
("(If you can't figure out why I needed to see a number,")@/
("look up `weird error' in the index to The TeXbook.)");
@:TeXbook}{\sl The \TeX book@>
back_error; scanned_result(0)(dimen_val);
end
else if cur_cmd<=assign_toks then
begin if cur_cmd<assign_toks then {|cur_cmd=toks_register|}
if m=mem_bot then
begin scan_register_num;
if cur_val<256 then cur_val:=equiv(toks_base+cur_val)
else begin find_sa_element(tok_val,cur_val,false);
if cur_ptr=null then cur_val:=null
else cur_val:=sa_ptr(cur_ptr);
end;
end
else cur_val:=sa_ptr(m)
else cur_val:=equiv(m);
cur_val_level:=tok_val;
end
else begin back_input; scan_font_ident;
scanned_result(font_id_base+cur_val)(ident_val);
end
@ Users refer to `\.{\\the\\spacefactor}' only in horizontal
mode, and to `\.{\\the\\prevdepth}' only in vertical mode; so we put the
associated mode in the modifier part of the |set_aux| command.
The |set_page_int| command has modifier 0 or 1, for `\.{\\deadcycles}' and
`\.{\\insertpenalties}', respectively. The |set_box_dimen| command is
modified by either |width_offset|, |height_offset|, or |depth_offset|.
And the |last_item| command is modified by either |int_val|, |dimen_val|,
|glue_val|, |input_line_no_code|, or |badness_code|.
\pdfTeX\ adds the codes for its extensions: |pdftex_version_code|, \dots.
\eTeX\ inserts |last_node_type_code| after |glue_val| and adds
the codes for its extensions: |eTeX_version_code|, \dots.
@d last_node_type_code=glue_val+1 {code for \.{\\lastnodetype}}
@d input_line_no_code=glue_val+2 {code for \.{\\inputlineno}}
@d badness_code=input_line_no_code+1 {code for \.{\\badness}}
@#
@d pdftex_first_rint_code = badness_code + 1 {base for \pdfTeX's command codes}
@d pdftex_version_code = pdftex_first_rint_code + 0 {code for \.{\\pdftexversion}}
@d pdf_last_obj_code = pdftex_first_rint_code + 1 {code for \.{\\pdflastobj}}
@d pdf_last_xform_code = pdftex_first_rint_code + 2 {code for \.{\\pdflastxform}}
@d pdf_last_ximage_code = pdftex_first_rint_code + 3 {code for \.{\\pdflastximage}}
@d pdf_last_ximage_pages_code = pdftex_first_rint_code + 4 {code for \.{\\pdflastximagepages}}
@d pdf_last_annot_code = pdftex_first_rint_code + 5 {code for \.{\\pdflastannot}}
@d pdf_last_x_pos_code = pdftex_first_rint_code + 6 {code for \.{\\pdflastxpos}}
@d pdf_last_y_pos_code = pdftex_first_rint_code + 7 {code for \.{\\pdflastypos}}
@d pdf_retval_code = pdftex_first_rint_code + 8 {global multi-purpose return value}
@d pdf_last_ximage_colordepth_code = pdftex_first_rint_code + 9 {code for \.{\\pdflastximagecolordepth}}
@d elapsed_time_code = pdftex_first_rint_code + 10 {code for \.{\\pdfelapsedtime}}
@d pdf_shell_escape_code = pdftex_first_rint_code + 11 {code for \.{\\pdfshellescape}}
@d random_seed_code = pdftex_first_rint_code + 12 {code for \.{\\pdfrandomseed}}
@d pdf_last_link_code = pdftex_first_rint_code + 13 {code for \.{\\pdflastlink}}
@d pdftex_last_item_codes = pdftex_first_rint_code + 13 {end of \pdfTeX's command codes}
@#
@d eTeX_int=pdftex_last_item_codes+1 {first of \eTeX\ codes for integers}
@d eTeX_dim=eTeX_int+8 {first of \eTeX\ codes for dimensions}
@d eTeX_glue=eTeX_dim+9 {first of \eTeX\ codes for glue}
@d eTeX_mu=eTeX_glue+1 {first of \eTeX\ codes for muglue}
@d eTeX_expr=eTeX_mu+1 {first of \eTeX\ codes for expressions}
@<Put each...@>=
primitive("spacefactor",set_aux,hmode);
@!@:space_factor_}{\.{\\spacefactor} primitive@>
primitive("prevdepth",set_aux,vmode);@/
@!@:prev_depth_}{\.{\\prevdepth} primitive@>
primitive("deadcycles",set_page_int,0);
@!@:dead_cycles_}{\.{\\deadcycles} primitive@>
primitive("insertpenalties",set_page_int,1);
@!@:insert_penalties_}{\.{\\insertpenalties} primitive@>
primitive("wd",set_box_dimen,width_offset);
@!@:wd_}{\.{\\wd} primitive@>
primitive("ht",set_box_dimen,height_offset);
@!@:ht_}{\.{\\ht} primitive@>
primitive("dp",set_box_dimen,depth_offset);
@!@:dp_}{\.{\\dp} primitive@>
primitive("lastpenalty",last_item,int_val);
@!@:last_penalty_}{\.{\\lastpenalty} primitive@>
primitive("lastkern",last_item,dimen_val);
@!@:last_kern_}{\.{\\lastkern} primitive@>
primitive("lastskip",last_item,glue_val);
@!@:last_skip_}{\.{\\lastskip} primitive@>
primitive("inputlineno",last_item,input_line_no_code);
@!@:input_line_no_}{\.{\\inputlineno} primitive@>
primitive("badness",last_item,badness_code);
@!@:badness_}{\.{\\badness} primitive@>
primitive("pdftexversion",last_item,pdftex_version_code);@/
@!@:pdftex_version_}{\.{\\pdftexversion} primitive@>
primitive("pdflastobj",last_item,pdf_last_obj_code);@/
@!@:pdf_last_obj_}{\.{\\pdflastobj} primitive@>
primitive("pdflastxform",last_item,pdf_last_xform_code);@/
@!@:pdf_last_xform_}{\.{\\pdflastxform} primitive@>
primitive("pdflastximage",last_item,pdf_last_ximage_code);@/
@!@:pdf_last_ximage_}{\.{\\pdflastximage} primitive@>
primitive("pdflastximagepages",last_item,pdf_last_ximage_pages_code);@/
@!@:pdf_last_ximage_pages_}{\.{\\pdflastximagepages} primitive@>
primitive("pdflastannot",last_item,pdf_last_annot_code);@/
@!@:pdf_last_annot_}{\.{\\pdflastannot} primitive@>
primitive("pdflastxpos",last_item,pdf_last_x_pos_code);@/
@!@:pdf_last_x_pos_}{\.{\\pdflastxpos} primitive@>
primitive("pdflastypos",last_item,pdf_last_y_pos_code);@/
@!@:pdf_last_y_pos_}{\.{\\pdflastypos} primitive@>
primitive("pdfretval",last_item,pdf_retval_code);@/
@!@:pdf_retval_}{\.{\\pdfretval} primitive@>
primitive("pdflastximagecolordepth",last_item,pdf_last_ximage_colordepth_code);@/
@!@:pdf_last_ximage_colordepth_}{\.{\\pdflastximagecolordepth} primitive@>
primitive("pdfelapsedtime",last_item,elapsed_time_code);
@!@:elapsed_time_}{\.{\\pdfelapsedtime} primitive@>
primitive("pdfshellescape",last_item,pdf_shell_escape_code);
@!@:pdf_shell_escape_}{\.{\\pdfshellescape} primitive@>
primitive("pdfrandomseed",last_item,random_seed_code);
@!@:random_seed_}{\.{\\pdfrandomseed} primitive@>
primitive("pdflastlink",last_item,pdf_last_link_code);@/
@!@:pdf_last_link_}{\.{\\pdflastlink} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
set_aux: if chr_code=vmode then print_esc("prevdepth")
@+else print_esc("spacefactor");
set_page_int: if chr_code=0 then print_esc("deadcycles")
@/@<Cases of |set_page_int| for |print_cmd_chr|@>@/
@+else print_esc("insertpenalties");
set_box_dimen: if chr_code=width_offset then print_esc("wd")
else if chr_code=height_offset then print_esc("ht")
else print_esc("dp");
last_item: case chr_code of
int_val: print_esc("lastpenalty");
dimen_val: print_esc("lastkern");
glue_val: print_esc("lastskip");
input_line_no_code: print_esc("inputlineno");
@/@<Cases of |last_item| for |print_cmd_chr|@>@/
pdftex_version_code: print_esc("pdftexversion");
pdf_last_obj_code: print_esc("pdflastobj");
pdf_last_xform_code: print_esc("pdflastxform");
pdf_last_ximage_code: print_esc("pdflastximage");
pdf_last_ximage_pages_code: print_esc("pdflastximagepages");
pdf_last_annot_code: print_esc("pdflastannot");
pdf_last_x_pos_code: print_esc("pdflastxpos");
pdf_last_y_pos_code: print_esc("pdflastypos");
pdf_retval_code: print_esc("pdfretval");
pdf_last_ximage_colordepth_code: print_esc("pdflastximagecolordepth");
elapsed_time_code: print_esc("pdfelapsedtime");
pdf_shell_escape_code: print_esc("pdfshellescape");
random_seed_code: print_esc("pdfrandomseed");
pdf_last_link_code: print_esc("pdflastlink");
othercases print_esc("badness")
endcases;
@ @<Fetch the |space_factor| or the |prev_depth|@>=
if abs(mode)<>m then
begin print_err("Improper "); print_cmd_chr(set_aux,m);
@.Improper \\spacefactor@>
@.Improper \\prevdepth@>
help4("You can refer to \spacefactor only in horizontal mode;")@/
("you can refer to \prevdepth only in vertical mode; and")@/
("neither of these is meaningful inside \write. So")@/
("I'm forgetting what you said and using zero instead.");
error;
if level<>tok_val then scanned_result(0)(dimen_val)
else scanned_result(0)(int_val);
end
else if m=vmode then scanned_result(prev_depth)(dimen_val)
else scanned_result(space_factor)(int_val)
@ @<Fetch the |dead_cycles| or the |insert_penalties|@>=
begin if m=0 then cur_val:=dead_cycles
@/@<Cases for `Fetch the |dead_cycles| or the |insert_penalties|'@>@/
else cur_val:=insert_penalties;
cur_val_level:=int_val;
end
@ @<Fetch a box dimension@>=
begin scan_register_num; fetch_box(q);
if q=null then cur_val:=0 @+else cur_val:=mem[q+m].sc;
cur_val_level:=dimen_val;
end
@ Inside an \.{\\output} routine, a user may wish to look at the page totals
that were present at the moment when output was triggered.
@d max_dimen==@'7777777777 {$2^{30}-1$}
@<Fetch something on the |page_so_far|@>=
begin if (page_contents=empty) and (not output_active) then
if m=0 then cur_val:=max_dimen@+else cur_val:=0
else cur_val:=page_so_far[m];
cur_val_level:=dimen_val;
end
@ @<Fetch the |prev_graf|@>=
if mode=0 then scanned_result(0)(int_val) {|prev_graf=0| within \.{\\write}}
else begin nest[nest_ptr]:=cur_list; p:=nest_ptr;
while abs(nest[p].mode_field)<>vmode do decr(p);
scanned_result(nest[p].pg_field)(int_val);
end
@ @<Fetch the |par_shape| size@>=
begin if m>par_shape_loc then @<Fetch a penalties array element@>
else if par_shape_ptr=null then cur_val:=0
else cur_val:=info(par_shape_ptr);
cur_val_level:=int_val;
end
@ Here is where \.{\\lastpenalty}, \.{\\lastkern}, \.{\\lastskip}, and
\.{\\lastnodetype} are
implemented. The reference count for \.{\\lastskip} will be updated later.
We also handle \.{\\inputlineno} and \.{\\badness} here, because they are
legal in similar contexts.
The macro |find_effective_tail_eTeX| sets |tx| to the last non-\.{\\endM}
node of the current list.
@d find_effective_tail_eTeX==
tx:=tail;
if not is_char_node(tx) then
if (type(tx)=math_node)and(subtype(tx)=end_M_code) then
begin r:=head;
repeat q:=r; r:=link(q);
until r=tx;
tx:=q;
end
@#
@d find_effective_tail==find_effective_tail_eTeX
@<Fetch an item in the current node...@>=
if m>=input_line_no_code then
if m>=eTeX_glue then @<Process an expression and |return|@>@;
else if m>=eTeX_dim then
begin case m of
@/@<Cases for fetching a dimension value@>@/
end; {there are no other cases}
cur_val_level:=dimen_val;
end
else begin case m of
input_line_no_code: cur_val:=line;
badness_code: cur_val:=last_badness;
pdftex_version_code: cur_val := pdftex_version;
pdf_last_obj_code: cur_val := pdf_last_obj;
pdf_last_xform_code: cur_val := pdf_last_xform;
pdf_last_ximage_code: cur_val := pdf_last_ximage;
pdf_last_ximage_pages_code: cur_val := pdf_last_ximage_pages;
pdf_last_annot_code: cur_val := pdf_last_annot;
pdf_last_x_pos_code: cur_val := pdf_last_x_pos;
pdf_last_y_pos_code: cur_val := pdf_last_y_pos;
pdf_retval_code: cur_val := pdf_retval;
pdf_last_ximage_colordepth_code: cur_val := pdf_last_ximage_colordepth;
elapsed_time_code: cur_val := get_microinterval;
random_seed_code: cur_val := random_seed;
pdf_shell_escape_code:
begin
if shellenabledp then begin
if restrictedshell then cur_val :=2
else cur_val := 1;
end
else cur_val := 0;
end;
pdf_last_link_code: cur_val := pdf_last_link;
@/@<Cases for fetching an integer value@>@/
end; {there are no other cases}
cur_val_level:=int_val;
end
else begin if cur_chr=glue_val then cur_val:=zero_glue@+else cur_val:=0;
find_effective_tail;
if cur_chr=last_node_type_code then
begin cur_val_level:=int_val;
if (tx=head)or(mode=0) then cur_val:=-1;
end
else cur_val_level:=cur_chr;
if not is_char_node(tx)and(mode<>0) then
case cur_chr of
int_val: if type(tx)=penalty_node then cur_val:=penalty(tx);
dimen_val: if type(tx)=kern_node then cur_val:=width(tx);
glue_val: if type(tx)=glue_node then
begin cur_val:=glue_ptr(tx);
if subtype(tx)=mu_glue then cur_val_level:=mu_val;
end;
last_node_type_code: if type(tx)<=unset_node then cur_val:=type(tx)+1
else cur_val:=unset_node+2;
end {there are no other cases}
else if (mode=vmode)and(tx=head) then
case cur_chr of
int_val: cur_val:=last_penalty;
dimen_val: cur_val:=last_kern;
glue_val: if last_glue<>max_halfword then cur_val:=last_glue;
last_node_type_code: cur_val:=last_node_type;
end; {there are no other cases}
end
@ @<Fetch a font dimension@>=
begin find_font_dimen(false); font_info[fmem_ptr].sc:=0;
scanned_result(font_info[cur_val].sc)(dimen_val);
end
@ @<Fetch a font integer@>=
begin scan_font_ident;
if m=0 then scanned_result(hyphen_char[cur_val])(int_val)
else if m=1 then scanned_result(skew_char[cur_val])(int_val)
else if m=no_lig_code then scanned_result(test_no_ligatures(cur_val))(int_val)
else begin
n := cur_val;
scan_char_num;
k := cur_val;
case m of
lp_code_base: scanned_result(get_lp_code(n, k))(int_val);
rp_code_base: scanned_result(get_rp_code(n, k))(int_val);
ef_code_base: scanned_result(get_ef_code(n, k))(int_val);
tag_code: scanned_result(get_tag_code(n, k))(int_val);
kn_bs_code_base: scanned_result(get_kn_bs_code(n, k))(int_val);
st_bs_code_base: scanned_result(get_st_bs_code(n, k))(int_val);
sh_bs_code_base: scanned_result(get_sh_bs_code(n, k))(int_val);
kn_bc_code_base: scanned_result(get_kn_bc_code(n, k))(int_val);
kn_ac_code_base: scanned_result(get_kn_ac_code(n, k))(int_val);
end;
end;
end
@ @<Fetch a register@>=
begin if (m<mem_bot)or(m>lo_mem_stat_max) then
begin cur_val_level:=sa_type(m);
if cur_val_level<glue_val then cur_val:=sa_int(m)
else cur_val:=sa_ptr(m);
end
else begin scan_register_num; cur_val_level:=m-mem_bot;
if cur_val>255 then
begin find_sa_element(cur_val_level,cur_val,false);
if cur_ptr=null then
if cur_val_level<glue_val then cur_val:=0
else cur_val:=zero_glue
else if cur_val_level<glue_val then cur_val:=sa_int(cur_ptr)
else cur_val:=sa_ptr(cur_ptr);
end
else
case cur_val_level of
int_val:cur_val:=count(cur_val);
dimen_val:cur_val:=dimen(cur_val);
glue_val: cur_val:=skip(cur_val);
mu_val: cur_val:=mu_skip(cur_val);
end; {there are no other cases}
end;
end
@ @<Complain that \.{\\the} can't do this; give zero result@>=
begin print_err("You can't use `"); print_cmd_chr(cur_cmd,cur_chr);
@.You can't use x after ...@>
print("' after "); print_esc("the");
help1("I'm forgetting what you said and using zero instead.");
error;
if level<>tok_val then scanned_result(0)(dimen_val)
else scanned_result(0)(int_val);
end
@ When a |glue_val| changes to a |dimen_val|, we use the width component
of the glue; there is no need to decrease the reference count, since it
has not yet been increased. When a |dimen_val| changes to an |int_val|,
we use scaled points so that the value doesn't actually change. And when a
|mu_val| changes to a |glue_val|, the value doesn't change either.
@<Convert \(c)|cur_val| to a lower level@>=
begin if cur_val_level=glue_val then cur_val:=width(cur_val)
else if cur_val_level=mu_val then mu_error;
decr(cur_val_level);
end
@ If |cur_val| points to a glue specification at this point, the reference
count for the glue does not yet include the reference by |cur_val|.
If |negative| is |true|, |cur_val_level| is known to be |<=mu_val|.
@<Fix the reference count, if any, ...@>=
if negative then
if cur_val_level>=glue_val then
begin cur_val:=new_spec(cur_val);
@<Negate all three glue components of |cur_val|@>;
end
else negate(cur_val)
else if (cur_val_level>=glue_val)and(cur_val_level<=mu_val) then
add_glue_ref(cur_val)
@ @<Negate all three...@>=
begin negate(width(cur_val));
negate(stretch(cur_val));
negate(shrink(cur_val));
end
@ Our next goal is to write the |scan_int| procedure, which scans anything that
\TeX\ treats as an integer. But first we might as well look at some simple
applications of |scan_int| that have already been made inside of
|scan_something_internal|.
@ @<Declare procedures that scan restricted classes of integers@>=
procedure scan_eight_bit_int;
begin scan_int;
if (cur_val<0)or(cur_val>255) then
begin print_err("Bad register code");
@.Bad register code@>
help2("A register number must be between 0 and 255.")@/
("I changed this one to zero."); int_error(cur_val); cur_val:=0;
end;
end;
@ @<Declare procedures that scan restricted classes of integers@>=
procedure scan_char_num;
begin scan_int;
if (cur_val<0)or(cur_val>255) then
begin print_err("Bad character code");
@.Bad character code@>
help2("A character number must be between 0 and 255.")@/
("I changed this one to zero."); int_error(cur_val); cur_val:=0;
end;
end;
@ While we're at it, we might as well deal with similar routines that
will be needed later.
@<Declare procedures that scan restricted classes of integers@>=
procedure scan_four_bit_int;
begin scan_int;
if (cur_val<0)or(cur_val>15) then
begin print_err("Bad number");
@.Bad number@>
help2("Since I expected to read a number between 0 and 15,")@/
("I changed this one to zero."); int_error(cur_val); cur_val:=0;
end;
end;
@ @<Declare procedures that scan restricted classes of integers@>=
procedure scan_fifteen_bit_int;
begin scan_int;
if (cur_val<0)or(cur_val>@'77777) then
begin print_err("Bad mathchar");
@.Bad mathchar@>
help2("A mathchar number must be between 0 and 32767.")@/
("I changed this one to zero."); int_error(cur_val); cur_val:=0;
end;
end;
@ @<Declare procedures that scan restricted classes of integers@>=
procedure scan_twenty_seven_bit_int;
begin scan_int;
if (cur_val<0)or(cur_val>@'777777777) then
begin print_err("Bad delimiter code");
@.Bad delimiter code@>
help2("A numeric delimiter code must be between 0 and 2^{27}-1.")@/
("I changed this one to zero."); int_error(cur_val); cur_val:=0;
end;
end;
@ An integer number can be preceded by any number of spaces and `\.+' or
`\.-' signs. Then comes either a decimal constant (i.e., radix 10), an
octal constant (i.e., radix 8, preceded by~\.\'), a hexadecimal constant
(radix 16, preceded by~\."), an alphabetic constant (preceded by~\.\`), or
an internal variable. After scanning is complete,
|cur_val| will contain the answer, which must be at most
$2^{31}-1=2147483647$ in absolute value. The value of |radix| is set to
10, 8, or 16 in the cases of decimal, octal, or hexadecimal constants,
otherwise |radix| is set to zero. An optional space follows a constant.
@d octal_token=other_token+"'" {apostrophe, indicates an octal constant}
@d hex_token=other_token+"""" {double quote, indicates a hex constant}
@d alpha_token=other_token+"`" {reverse apostrophe, precedes alpha constants}
@d point_token=other_token+"." {decimal point}
@d continental_point_token=other_token+"," {decimal point, Eurostyle}
@<Glob...@>=
@!radix:small_number; {|scan_int| sets this to 8, 10, 16, or zero}
@ We initialize the following global variables just in case |expand|
comes into action before any of the basic scanning routines has assigned
them a value.
@<Set init...@>=
cur_val:=0; cur_val_level:=int_val; radix:=0; cur_order:=normal;
@ The |scan_int| routine is used also to scan the integer part of a
fraction; for example, the `\.3' in `\.{3.14159}' will be found by
|scan_int|. The |scan_dimen| routine assumes that |cur_tok=point_token|
after the integer part of such a fraction has been scanned by |scan_int|,
and that the decimal point has been backed up to be scanned again.
@p procedure scan_int; {sets |cur_val| to an integer}
label done, restart;
var negative:boolean; {should the answer be negated?}
@!m:integer; {|@t$2^{31}$@> div radix|, the threshold of danger}
@!d:small_number; {the digit just scanned}
@!vacuous:boolean; {have no digits appeared?}
@!OK_so_far:boolean; {has an error message been issued?}
begin radix:=0; OK_so_far:=true;@/
@<Get the next non-blank non-sign token; set |negative| appropriately@>;
restart:
if cur_tok=alpha_token then @<Scan an alphabetic character code into |cur_val|@>
else if cur_tok=cs_token_flag+frozen_primitive then
@<Reset |cur_tok| for unexpandable primitives, goto restart@>
else if (cur_cmd>=min_internal)and(cur_cmd<=max_internal) then
scan_something_internal(int_val,false)
else @<Scan a numeric constant@>;
if negative then negate(cur_val);
end;
@ @<Get the next non-blank non-sign token...@>=
negative:=false;
repeat @<Get the next non-blank non-call token@>;
if cur_tok=other_token+"-" then
begin negative := not negative; cur_tok:=other_token+"+";
end;
until cur_tok<>other_token+"+"
@ A space is ignored after an alphabetic character constant, so that
such constants behave like numeric ones.
@<Scan an alphabetic character code into |cur_val|@>=
begin get_token; {suppress macro expansion}
if cur_tok<cs_token_flag then
begin cur_val:=cur_chr;
if cur_cmd<=right_brace then
if cur_cmd=right_brace then incr(align_state)
else decr(align_state);
end
else if cur_tok<cs_token_flag+single_base then
cur_val:=cur_tok-cs_token_flag-active_base
else cur_val:=cur_tok-cs_token_flag-single_base;
if cur_val>255 then
begin print_err("Improper alphabetic constant");
@.Improper alphabetic constant@>
help2("A one-character control sequence belongs after a ` mark.")@/
("So I'm essentially inserting \0 here.");
cur_val:="0"; back_error;
end
else @<Scan an optional space@>;
end
@ @<Scan an optional space@>=
begin get_x_token; if cur_cmd<>spacer then back_input;
end
@ @<Scan a numeric constant@>=
begin radix:=10; m:=214748364;
if cur_tok=octal_token then
begin radix:=8; m:=@'2000000000; get_x_token;
end
else if cur_tok=hex_token then
begin radix:=16; m:=@'1000000000; get_x_token;
end;
vacuous:=true; cur_val:=0;@/
@<Accumulate the constant until |cur_tok| is not a suitable digit@>;
if vacuous then @<Express astonishment that no number was here@>
else if cur_cmd<>spacer then back_input;
end
@ @d infinity==@'17777777777 {the largest positive value that \TeX\ knows}
@d zero_token=other_token+"0" {zero, the smallest digit}
@d A_token=letter_token+"A" {the smallest special hex digit}
@d other_A_token=other_token+"A" {special hex digit of type |other_char|}
@<Accumulate the constant...@>=
loop@+ begin if (cur_tok<zero_token+radix)and(cur_tok>=zero_token)and
(cur_tok<=zero_token+9) then d:=cur_tok-zero_token
else if radix=16 then
if (cur_tok<=A_token+5)and(cur_tok>=A_token) then d:=cur_tok-A_token+10
else if (cur_tok<=other_A_token+5)and(cur_tok>=other_A_token) then
d:=cur_tok-other_A_token+10
else goto done
else goto done;
vacuous:=false;
if (cur_val>=m)and((cur_val>m)or(d>7)or(radix<>10)) then
begin if OK_so_far then
begin print_err("Number too big");
@.Number too big@>
help2("I can only go up to 2147483647='17777777777=""7FFFFFFF,")@/
("so I'm using that number instead of yours.");
error; cur_val:=infinity; OK_so_far:=false;
end;
end
else cur_val:=cur_val*radix+d;
get_x_token;
end;
done:
@ @<Express astonishment...@>=
begin print_err("Missing number, treated as zero");
@.Missing number...@>
help3("A number should have been here; I inserted `0'.")@/
("(If you can't figure out why I needed to see a number,")@/
("look up `weird error' in the index to The TeXbook.)");
@:TeXbook}{\sl The \TeX book@>
back_error;
end
@ The |scan_dimen| routine is similar to |scan_int|, but it sets |cur_val| to
a |scaled| value, i.e., an integral number of sp. One of its main tasks
is therefore to interpret the abbreviations for various kinds of units and
to convert measurements to scaled points.
There are three parameters: |mu| is |true| if the finite units must be
`\.{mu}', while |mu| is |false| if `\.{mu}' units are disallowed;
|inf| is |true| if the infinite units `\.{fil}', `\.{fill}', `\.{filll}'
are permitted; and |shortcut| is |true| if |cur_val| already contains
an integer and only the units need to be considered.
The order of infinity that was found in the case of infinite glue is returned
in the global variable |cur_order|.
@<Glob...@>=
@!cur_order:glue_ord; {order of infinity found by |scan_dimen|}
@ Constructions like `\.{-\'77 pt}' are legal dimensions, so |scan_dimen|
may begin with |scan_int|. This explains why it is convenient to use
|scan_int| also for the integer part of a decimal fraction.
Several branches of |scan_dimen| work with |cur_val| as an integer and
with an auxiliary fraction |f|, so that the actual quantity of interest is
$|cur_val|+|f|/2^{16}$. At the end of the routine, this ``unpacked''
representation is put into the single word |cur_val|, which suddenly
switches significance from |integer| to |scaled|.
@d attach_fraction=88 {go here to pack |cur_val| and |f| into |cur_val|}
@d attach_sign=89 {go here when |cur_val| is correct except perhaps for sign}
@d scan_normal_dimen==scan_dimen(false,false,false)
@p procedure scan_dimen(@!mu,@!inf,@!shortcut:boolean);
{sets |cur_val| to a dimension}
label done, done1, done2, found, not_found, attach_fraction, attach_sign;
var negative:boolean; {should the answer be negated?}
@!f:integer; {numerator of a fraction whose denominator is $2^{16}$}
@<Local variables for dimension calculations@>@;
begin f:=0; arith_error:=false; cur_order:=normal; negative:=false;
if not shortcut then
begin @<Get the next non-blank non-sign...@>;
if (cur_cmd>=min_internal)and(cur_cmd<=max_internal) then
@<Fetch an internal dimension and |goto attach_sign|,
or fetch an internal integer@>
else begin back_input;
if cur_tok=continental_point_token then cur_tok:=point_token;
if cur_tok<>point_token then scan_int
else begin radix:=10; cur_val:=0;
end;
if cur_tok=continental_point_token then cur_tok:=point_token;
if (radix=10)and(cur_tok=point_token) then @<Scan decimal fraction@>;
end;
end;
if cur_val<0 then {in this case |f=0|}
begin negative := not negative; negate(cur_val);
end;
@<Scan units and set |cur_val| to $x\cdot(|cur_val|+f/2^{16})$, where there
are |x| sp per unit; |goto attach_sign| if the units are internal@>;
@<Scan an optional space@>;
attach_sign: if arith_error or(abs(cur_val)>=@'10000000000) then
@<Report that this dimension is out of range@>;
if negative then negate(cur_val);
end;
@ @<Fetch an internal dimension and |goto attach_sign|...@>=
if mu then
begin scan_something_internal(mu_val,false);
@<Coerce glue to a dimension@>;
if cur_val_level=mu_val then goto attach_sign;
if cur_val_level<>int_val then mu_error;
end
else begin scan_something_internal(dimen_val,false);
if cur_val_level=dimen_val then goto attach_sign;
end
@ @<Local variables for dimension calculations@>=
@!num,@!denom:1..65536; {conversion ratio for the scanned units}
@!k,@!kk:small_number; {number of digits in a decimal fraction}
@!p,@!q:pointer; {top of decimal digit stack}
@!v:scaled; {an internal dimension}
@!save_cur_val:integer; {temporary storage of |cur_val|}
@ The following code is executed when |scan_something_internal| was
called asking for |mu_val|, when we really wanted a ``mudimen'' instead
of ``muglue.''
@<Coerce glue to a dimension@>=
if cur_val_level>=glue_val then
begin v:=width(cur_val); delete_glue_ref(cur_val); cur_val:=v;
end
@ When the following code is executed, we have |cur_tok=point_token|, but this
token has been backed up using |back_input|; we must first discard it.
It turns out that a decimal point all by itself is equivalent to `\.{0.0}'.
Let's hope people don't use that fact.
@<Scan decimal fraction@>=
begin k:=0; p:=null; get_token; {|point_token| is being re-scanned}
loop@+ begin get_x_token;
if (cur_tok>zero_token+9)or(cur_tok<zero_token) then goto done1;
if k<17 then {digits for |k>=17| cannot affect the result}
begin q:=get_avail; link(q):=p; info(q):=cur_tok-zero_token;
p:=q; incr(k);
end;
end;
done1: for kk:=k downto 1 do
begin dig[kk-1]:=info(p); q:=p; p:=link(p); free_avail(q);
end;
f:=round_decimals(k);
if cur_cmd<>spacer then back_input;
end
@ Now comes the harder part: At this point in the program, |cur_val| is a
nonnegative integer and $f/2^{16}$ is a nonnegative fraction less than 1;
we want to multiply the sum of these two quantities by the appropriate
factor, based on the specified units, in order to produce a |scaled|
result, and we want to do the calculation with fixed point arithmetic that
does not overflow.
@<Scan units and set |cur_val| to $x\cdot(|cur_val|+f/2^{16})$...@>=
if inf then @<Scan for \(f)\.{fil} units; |goto attach_fraction| if found@>;
@<Scan for \(u)units that are internal dimensions;
|goto attach_sign| with |cur_val| set if found@>;
if mu then @<Scan for \(m)\.{mu} units and |goto attach_fraction|@>;
if scan_keyword("true") then @<Adjust \(f)for the magnification ratio@>;
@.true@>
if scan_keyword("pt") then goto attach_fraction; {the easy case}
@.pt@>
@<Scan for \(a)all other units and adjust |cur_val| and |f| accordingly;
|goto done| in the case of scaled points@>;
attach_fraction: if cur_val>=@'40000 then arith_error:=true
else cur_val:=cur_val*unity+f;
done:
@ A specification like `\.{filllll}' or `\.{fill L L L}' will lead to two
error messages (one for each additional keyword \.{"l"}).
@<Scan for \(f)\.{fil} units...@>=
if scan_keyword("fil") then
@.fil@>
begin cur_order:=fil;
while scan_keyword("l") do
begin if cur_order=filll then
begin print_err("Illegal unit of measure (");
@.Illegal unit of measure@>
print("replaced by filll)");
help1("I dddon't go any higher than filll."); error;
end
else incr(cur_order);
end;
goto attach_fraction;
end
@ @<Scan for \(u)units that are internal dimensions...@>=
save_cur_val:=cur_val;
@<Get the next non-blank non-call...@>;
if (cur_cmd<min_internal)or(cur_cmd>max_internal) then back_input
else begin if mu then
begin scan_something_internal(mu_val,false); @<Coerce glue...@>;
if cur_val_level<>mu_val then mu_error;
end
else scan_something_internal(dimen_val,false);
v:=cur_val; goto found;
end;
if mu then goto not_found;
if scan_keyword("em") then v:=(@<The em width for |cur_font|@>)
@.em@>
else if scan_keyword("ex") then v:=(@<The x-height for |cur_font|@>)
@.ex@>
else if scan_keyword("px") then v:=pdf_px_dimen
@.px@>
else goto not_found;
@<Scan an optional space@>;
found:cur_val:=nx_plus_y(save_cur_val,v,xn_over_d(v,f,@'200000));
goto attach_sign;
not_found:
@ @<Scan for \(m)\.{mu} units and |goto attach_fraction|@>=
if scan_keyword("mu") then goto attach_fraction
@.mu@>
else begin print_err("Illegal unit of measure ("); print("mu inserted)");
@.Illegal unit of measure@>
help4("The unit of measurement in math glue must be mu.")@/
("To recover gracefully from this error, it's best to")@/
("delete the erroneous units; e.g., type `2' to delete")@/
("two letters. (See Chapter 27 of The TeXbook.)");
@:TeXbook}{\sl The \TeX book@>
error; goto attach_fraction;
end
@ @<Adjust \(f)for the magnification ratio@>=
begin prepare_mag;
if mag<>1000 then
begin cur_val:=xn_over_d(cur_val,1000,mag);
f:=(1000*f+@'200000*remainder) div mag;
cur_val:=cur_val+(f div @'200000); f:=f mod @'200000;
end;
end
@ The necessary conversion factors can all be specified exactly as
fractions whose numerator and denominator sum to 32768 or less.
According to the definitions here, $\rm2660\,dd\approx1000.33297\,mm$;
this agrees well with the value $\rm1000.333\,mm$ cited by Bosshard
@^Bosshard, Hans Rudolf@>
in {\sl Technische Grundlagen zur Satzherstellung\/} (Bern, 1980).
The Didot point has been newly standardized in 1978;
it's now exactly $\rm 1\,nd=0.375\,mm$.
Conversion uses the equation $0.375=21681/20320/72.27\cdot25.4$.
The new Cicero follows the new Didot point; $\rm 1\,nc=12\,nd$.
These would lead to the ratios $21681/20320$ and $65043/5080$,
respectively.
The closest approximations supported by the algorithm would be
$11183/10481$ and $1370/107$. In order to maintain the
relation $\rm 1\,nc=12\,nd$, we pick the ratio $685/642$ for
$\rm nd$, however.
@d set_conversion_end(#)== denom:=#; end
@d set_conversion(#)==@+begin num:=#; set_conversion_end
@<Scan for \(a)all other units and adjust |cur_val| and |f|...@>=
if scan_keyword("in") then set_conversion(7227)(100)
@.in@>
else if scan_keyword("pc") then set_conversion(12)(1)
@.pc@>
else if scan_keyword("cm") then set_conversion(7227)(254)
@.cm@>
else if scan_keyword("mm") then set_conversion(7227)(2540)
@.mm@>
else if scan_keyword("bp") then set_conversion(7227)(7200)
@.bp@>
else if scan_keyword("dd") then set_conversion(1238)(1157)
@.dd@>
else if scan_keyword("cc") then set_conversion(14856)(1157)
@.cc@>
else if scan_keyword("nd") then set_conversion(685)(642)
@.nd@>
else if scan_keyword("nc") then set_conversion(1370)(107)
@.nc@>
else if scan_keyword("sp") then goto done
@.sp@>
else @<Complain about unknown unit and |goto done2|@>;
cur_val:=xn_over_d(cur_val,num,denom);
f:=(num*f+@'200000*remainder) div denom;@/
cur_val:=cur_val+(f div @'200000); f:=f mod @'200000;
done2:
@ @<Complain about unknown unit...@>=
begin print_err("Illegal unit of measure ("); print("pt inserted)");
@.Illegal unit of measure@>
help6("Dimensions can be in units of em, ex, in, pt, pc,")@/
("cm, mm, dd, cc, nd, nc, bp, or sp; but yours is a new one!")@/
("I'll assume that you meant to say pt, for printer's points.")@/
("To recover gracefully from this error, it's best to")@/
("delete the erroneous units; e.g., type `2' to delete")@/
("two letters. (See Chapter 27 of The TeXbook.)");
@:TeXbook}{\sl The \TeX book@>
error; goto done2;
end
@ @<Report that this dimension is out of range@>=
begin print_err("Dimension too large");
@.Dimension too large@>
help2("I can't work with sizes bigger than about 19 feet.")@/
("Continue and I'll use the largest value I can.");@/
error; cur_val:=max_dimen; arith_error:=false;
end
@ The final member of \TeX's value-scanning trio is |scan_glue|, which
makes |cur_val| point to a glue specification. The reference count of that
glue spec will take account of the fact that |cur_val| is pointing to~it.
The |level| parameter should be either |glue_val| or |mu_val|.
Since |scan_dimen| was so much more complex than |scan_int|, we might expect
|scan_glue| to be even worse. But fortunately, it is very simple, since
most of the work has already been done.
@p procedure scan_glue(@!level:small_number);
{sets |cur_val| to a glue spec pointer}
label exit;
var negative:boolean; {should the answer be negated?}
@!q:pointer; {new glue specification}
@!mu:boolean; {does |level=mu_val|?}
begin mu:=(level=mu_val); @<Get the next non-blank non-sign...@>;
if (cur_cmd>=min_internal)and(cur_cmd<=max_internal) then
begin scan_something_internal(level,negative);
if cur_val_level>=glue_val then
begin if cur_val_level<>level then mu_error;
return;
end;
if cur_val_level=int_val then scan_dimen(mu,false,true)
else if level=mu_val then mu_error;
end
else begin back_input; scan_dimen(mu,false,false);
if negative then negate(cur_val);
end;
@<Create a new glue specification whose width is |cur_val|; scan for its
stretch and shrink components@>;
exit:end;
@#
@<Declare procedures needed for expressions@>@;
@ @<Create a new glue specification whose width is |cur_val|...@>=
q:=new_spec(zero_glue); width(q):=cur_val;
if scan_keyword("plus") then
@.plus@>
begin scan_dimen(mu,true,false);
stretch(q):=cur_val; stretch_order(q):=cur_order;
end;
if scan_keyword("minus") then
@.minus@>
begin scan_dimen(mu,true,false);
shrink(q):=cur_val; shrink_order(q):=cur_order;
end;
cur_val:=q
@ Here's a similar procedure that returns a pointer to a rule node. This
routine is called just after \TeX\ has seen \.{\\hrule} or \.{\\vrule};
therefore |cur_cmd| will be either |hrule| or |vrule|. The idea is to store
the default rule dimensions in the node, then to override them if
`\.{height}' or `\.{width}' or `\.{depth}' specifications are
found (in any order).
@d default_rule=26214 {0.4\thinspace pt}
@p function scan_rule_spec:pointer;
label reswitch;
var q:pointer; {the rule node being created}
begin q:=new_rule; {|width|, |depth|, and |height| all equal |null_flag| now}
if cur_cmd=vrule then width(q):=default_rule
else begin height(q):=default_rule; depth(q):=0;
end;
reswitch: if scan_keyword("width") then
@.width@>
begin scan_normal_dimen; width(q):=cur_val; goto reswitch;
end;
if scan_keyword("height") then
@.height@>
begin scan_normal_dimen; height(q):=cur_val; goto reswitch;
end;
if scan_keyword("depth") then
@.depth@>
begin scan_normal_dimen; depth(q):=cur_val; goto reswitch;
end;
scan_rule_spec:=q;
end;
@* \[27] Building token lists.
The token lists for macros and for other things like \.{\\mark} and \.{\\output}
and \.{\\write} are produced by a procedure called |scan_toks|.
Before we get into the details of |scan_toks|, let's consider a much
simpler task, that of converting the current string into a token list.
The |str_toks| function does this; it classifies spaces as type |spacer|
and everything else as type |other_char|.
The token list created by |str_toks| begins at |link(temp_head)| and ends
at the value |p| that is returned. (If |p=temp_head|, the list is empty.)
@p @t\4@>@<Declare \eTeX\ procedures for token lists@>@;@/
function str_toks(@!b:pool_pointer):pointer;
{converts |str_pool[b..pool_ptr-1]| to a token list}
var p:pointer; {tail of the token list}
@!q:pointer; {new node being added to the token list via |store_new_token|}
@!t:halfword; {token being appended}
@!k:pool_pointer; {index into |str_pool|}
begin str_room(1);
p:=temp_head; link(p):=null; k:=b;
while k<pool_ptr do
begin t:=so(str_pool[k]);
if t=" " then t:=space_token
else t:=other_token+t;
fast_store_new_token(t);
incr(k);
end;
pool_ptr:=b; str_toks:=p;
end;
@ The main reason for wanting |str_toks| is the next function,
|the_toks|, which has similar input/output characteristics.
This procedure is supposed to scan something like `\.{\\skip\\count12}',
i.e., whatever can follow `\.{\\the}', and it constructs a token list
containing something like `\.{-3.0pt minus 0.5fill}'.
@p function the_toks:pointer;
label exit;
var old_setting:0..max_selector; {holds |selector| setting}
@!p,@!q,@!r:pointer; {used for copying a token list}
@!b:pool_pointer; {base of temporary string}
@!c:small_number; {value of |cur_chr|}
begin @<Handle \.{\\unexpanded} or \.{\\detokenize} and |return|@>;@/
get_x_token; scan_something_internal(tok_val,false);
if cur_val_level>=ident_val then @<Copy the token list@>
else begin old_setting:=selector; selector:=new_string; b:=pool_ptr;
case cur_val_level of
int_val:print_int(cur_val);
dimen_val:begin print_scaled(cur_val); print("pt");
end;
glue_val: begin print_spec(cur_val,"pt"); delete_glue_ref(cur_val);
end;
mu_val: begin print_spec(cur_val,"mu"); delete_glue_ref(cur_val);
end;
end; {there are no other cases}
selector:=old_setting; the_toks:=str_toks(b);
end;
exit:end;
@ @<Copy the token list@>=
begin p:=temp_head; link(p):=null;
if cur_val_level=ident_val then store_new_token(cs_token_flag+cur_val)
else if cur_val<>null then
begin r:=link(cur_val); {do not copy the reference count}
while r<>null do
begin fast_store_new_token(info(r)); r:=link(r);
end;
end;
the_toks:=p;
end
@ Here's part of the |expand| subroutine that we are now ready to complete:
@p procedure ins_the_toks;
begin link(garbage):=the_toks; ins_list(link(temp_head));
end;
@ The primitives \.{\\number}, \.{\\romannumeral}, \.{\\string}, \.{\\meaning},
\.{\\fontname}, and \.{\\jobname} are defined as follows.
\eTeX\ adds \.{\\eTeXrevision} such that |job_name_code| remains last.
\pdfTeX\ adds \.{\\pdftexrevision}, \.{\\pdftexbanner}, \.{\\pdffontname},
\.{\\pdffontobjnum}, \.{\\pdffontsize}, and \.{\\pdfpageref} such that
|job_name_code| remains last.
@d number_code=0 {command code for \.{\\number}}
@d roman_numeral_code=1 {command code for \.{\\romannumeral}}
@d string_code=2 {command code for \.{\\string}}
@d meaning_code=3 {command code for \.{\\meaning}}
@d font_name_code=4 {command code for \.{\\fontname}}
@d etex_convert_base=5 {base for \eTeX's command codes}
@d eTeX_revision_code=etex_convert_base {command code for \.{\\eTeXrevision}}
@d etex_convert_codes=etex_convert_base+1 {end of \eTeX's command codes}
@d expanded_code = etex_convert_codes {command code for \.{\\expanded}}
@d pdftex_first_expand_code = expanded_code + 1 {base for \pdfTeX's command codes}
@d pdftex_revision_code = pdftex_first_expand_code + 0 {command code for \.{\\pdftexrevision}}
@d pdftex_banner_code = pdftex_first_expand_code + 1 {command code for \.{\\pdftexbanner}}
@d pdf_font_name_code = pdftex_first_expand_code + 2 {command code for \.{\\pdffontname}}
@d pdf_font_objnum_code = pdftex_first_expand_code + 3 {command code for \.{\\pdffontobjnum}}
@d pdf_font_size_code = pdftex_first_expand_code + 4 {command code for \.{\\pdffontsize}}
@d pdf_page_ref_code = pdftex_first_expand_code + 5 {command code for \.{\\pdfpageref}}
@d pdf_xform_name_code = pdftex_first_expand_code + 6 {command code for \.{\\pdfxformname}}
@d pdf_escape_string_code = pdftex_first_expand_code + 7 {command code for \.{\\pdfescapestring}}
@d pdf_escape_name_code = pdftex_first_expand_code + 8 {command code for \.{\\pdfescapename}}
@d left_margin_kern_code = pdftex_first_expand_code + 9 {command code for \.{\\leftmarginkern}}
@d right_margin_kern_code = pdftex_first_expand_code + 10 {command code for \.{\\rightmarginkern}}
@d pdf_strcmp_code = pdftex_first_expand_code + 11 {command code for \.{\\pdfstrcmp}}
@d pdf_colorstack_init_code = pdftex_first_expand_code + 12 {command code for \.{\\pdfcolorstackinit}}
@d pdf_escape_hex_code = pdftex_first_expand_code + 13 {command code for \.{\\pdfescapehex}}
@d pdf_unescape_hex_code = pdftex_first_expand_code + 14 {command code for \.{\\pdfunescapehex}}
@d pdf_creation_date_code = pdftex_first_expand_code + 15 {command code for \.{\\pdfcreationdate}}
@d pdf_file_mod_date_code = pdftex_first_expand_code + 16 {command code for \.{\\pdffilemoddate}}
@d pdf_file_size_code = pdftex_first_expand_code + 17 {command code for \.{\\pdffilesize}}
@d pdf_mdfive_sum_code = pdftex_first_expand_code + 18 {command code for \.{\\pdfmdfivesum}}
@d pdf_file_dump_code = pdftex_first_expand_code + 19 {command code for \.{\\pdffiledump}}
@d pdf_match_code = pdftex_first_expand_code + 20 {command code for \.{\\pdfmatch}}
@d pdf_last_match_code = pdftex_first_expand_code + 21 {command code for \.{\\pdflastmatch}}
@d uniform_deviate_code = pdftex_first_expand_code + 22 {end of \pdfTeX's command codes}
@d normal_deviate_code = pdftex_first_expand_code + 23 {end of \pdfTeX's command codes}
@d pdf_insert_ht_code = pdftex_first_expand_code + 24 {command code for \.{\\pdfinsertht}}
@d pdf_ximage_bbox_code = pdftex_first_expand_code + 25 {command code for \.{\\pdfximagebbox}}
@d pdftex_convert_codes = pdftex_first_expand_code + 26 {end of \pdfTeX's command codes}
@d job_name_code=pdftex_convert_codes {command code for \.{\\jobname}}
@<Put each...@>=
primitive("number",convert,number_code);@/
@!@:number_}{\.{\\number} primitive@>
primitive("romannumeral",convert,roman_numeral_code);@/
@!@:roman_numeral_}{\.{\\romannumeral} primitive@>
primitive("string",convert,string_code);@/
@!@:string_}{\.{\\string} primitive@>
primitive("meaning",convert,meaning_code);@/
@!@:meaning_}{\.{\\meaning} primitive@>
primitive("fontname",convert,font_name_code);@/
@!@:font_name_}{\.{\\fontname} primitive@>
@#
primitive("expanded",convert,expanded_code);@/
@!@:expanded_}{\.{\\expanded} primitive@>
@#
primitive("pdftexrevision",convert,pdftex_revision_code);@/
@!@:pdftex_revision_}{\.{\\pdftexrevision} primitive@>
primitive("pdftexbanner",convert,pdftex_banner_code);@/
@!@:pdftex_banner_}{\.{\\pdftexbanner} primitive@>
primitive("pdffontname",convert,pdf_font_name_code);@/
@!@:pdf_font_name_}{\.{\\pdffontname} primitive@>
primitive("pdffontobjnum",convert,pdf_font_objnum_code);@/
@!@:pdf_font_objnum_}{\.{\\pdffontobjnum} primitive@>
primitive("pdffontsize",convert,pdf_font_size_code);@/
@!@:pdf_font_size_}{\.{\\pdffontsize} primitive@>
primitive("pdfpageref",convert,pdf_page_ref_code);@/
@!@:pdf_page_ref_}{\.{\\pdfpageref} primitive@>
primitive("leftmarginkern",convert,left_margin_kern_code);@/
@!@:left_margin_kern_}{\.{\\leftmarginkern} primitive@>
primitive("rightmarginkern",convert,right_margin_kern_code);@/
@!@:right_margin_kern_}{\.{\\rightmarginkern} primitive@>
primitive("pdfxformname",convert,pdf_xform_name_code);@/
@!@:pdf_xform_name_}{\.{\\pdfxformname} primitive@>
primitive("pdfescapestring",convert,pdf_escape_string_code);@/
@!@:pdf_escape_string_}{\.{\\pdfescapestring} primitive@>
primitive("pdfescapename",convert,pdf_escape_name_code);@/
@!@:pdf_escape_name_}{\.{\\pdfescapename} primitive@>
primitive("pdfescapehex",convert,pdf_escape_hex_code);@/
@!@:pdf_escape_hex_}{\.{\\pdfescapehex} primitive@>
primitive("pdfunescapehex",convert,pdf_unescape_hex_code);@/
@!@:pdf_unescape_hex_}{\.{\\pdfunescapehex} primitive@>
primitive("pdfcreationdate",convert,pdf_creation_date_code);@/
@!@:pdf_creation_date_}{\.{\\pdfcreationdate} primitive@>
primitive("pdffilemoddate",convert,pdf_file_mod_date_code);@/
@!@:pdf_file_mod_date_}{\.{\\pdffilemoddate} primitive@>
primitive("pdffilesize",convert,pdf_file_size_code);@/
@!@:pdf_file_size_}{\.{\\pdffilesize} primitive@>
primitive("pdfmdfivesum",convert,pdf_mdfive_sum_code);@/
@!@:pdf_mdfive_sum_}{\.{\\pdfmdfivesum} primitive@>
primitive("pdffiledump",convert,pdf_file_dump_code);@/
@!@:pdf_file_dump_}{\.{\\pdffiledump} primitive@>
primitive("pdfmatch",convert,pdf_match_code);@/
@!@:pdf_match_}{\.{\\pdfmatch} primitive@>
primitive("pdflastmatch",convert,pdf_last_match_code);@/
@!@:pdf_last_match_}{\.{\\pdflastmatch} primitive@>
primitive("pdfstrcmp",convert,pdf_strcmp_code);@/
@!@:pdf_strcmp_}{\.{\\pdfstrcmp} primitive@>
primitive("pdfcolorstackinit",convert,pdf_colorstack_init_code);@/
@!@:pdf_colorstack_init_}{\.{\\pdfcolorstackinit} primitive@>
primitive("pdfuniformdeviate",convert,uniform_deviate_code);@/
@!@:uniform_deviate_}{\.{\\pdfuniformdeviate} primitive@>
primitive("pdfnormaldeviate",convert,normal_deviate_code);@/
@!@:normal_deviate_}{\.{\\pdfnormaldeviate} primitive@>
@#
primitive("jobname",convert,job_name_code);@/
@!@:job_name_}{\.{\\jobname} primitive@>
primitive("pdfinsertht",convert,pdf_insert_ht_code);@/
@!@:pdf_insert_ht_}{\.{\\pdfinsertht} primitive@>
primitive("pdfximagebbox",convert,pdf_ximage_bbox_code);@/
@!@:pdf_ximage_bbox_}{\.{\\pdfximagebbox} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
convert: case chr_code of
number_code: print_esc("number");
roman_numeral_code: print_esc("romannumeral");
string_code: print_esc("string");
meaning_code: print_esc("meaning");
font_name_code: print_esc("fontname");
eTeX_revision_code: print_esc("eTeXrevision");
expanded_code: print_esc("expanded");
pdftex_revision_code: print_esc("pdftexrevision");
pdftex_banner_code: print_esc("pdftexbanner");
pdf_font_name_code: print_esc("pdffontname");
pdf_font_objnum_code: print_esc("pdffontobjnum");
pdf_font_size_code: print_esc("pdffontsize");
pdf_page_ref_code: print_esc("pdfpageref");
left_margin_kern_code: print_esc("leftmarginkern");
right_margin_kern_code: print_esc("rightmarginkern");
pdf_xform_name_code: print_esc("pdfxformname");
pdf_escape_string_code: print_esc("pdfescapestring");
pdf_escape_name_code: print_esc("pdfescapename");
pdf_escape_hex_code: print_esc("pdfescapehex");
pdf_unescape_hex_code: print_esc("pdfunescapehex");
pdf_creation_date_code: print_esc("pdfcreationdate");
pdf_file_mod_date_code: print_esc("pdffilemoddate");
pdf_file_size_code: print_esc("pdffilesize");
pdf_mdfive_sum_code: print_esc("pdfmdfivesum");
pdf_file_dump_code: print_esc("pdffiledump");
pdf_match_code: print_esc("pdfmatch");
pdf_last_match_code: print_esc("pdflastmatch");
pdf_strcmp_code: print_esc("pdfstrcmp");
pdf_colorstack_init_code: print_esc("pdfcolorstackinit");
uniform_deviate_code: print_esc("pdfuniformdeviate");
normal_deviate_code: print_esc("pdfnormaldeviate");
pdf_insert_ht_code: print_esc("pdfinsertht");
pdf_ximage_bbox_code: print_esc("pdfximagebbox");
othercases print_esc("jobname")
endcases;
@ The procedure |conv_toks| uses |str_toks| to insert the token list
for |convert| functions into the scanner; `\.{\\outer}' control sequences
are allowed to follow `\.{\\string}' and `\.{\\meaning}'.
The extra temp string |u| is needed because |pdf_scan_ext_toks| incorporates
any pending string in its output. In order to save such a pending string,
we have to create a temporary string that is destroyed immediately after.
@d save_cur_string==if str_start[str_ptr]<pool_ptr then u:=make_string
@d restore_cur_string==if u<>0 then begin decr(str_ptr); u:=0; end
@p procedure conv_toks;
label exit;
var old_setting:0..max_selector; {holds |selector| setting}
p, q: pointer;
@!c:number_code..job_name_code; {desired type of conversion}
@!save_scanner_status:small_number; {|scanner_status| upon entry}
@!save_def_ref: pointer; {|def_ref| upon entry, important if inside `\.{\\message}'}
@!save_warning_index: pointer;
@!bool: boolean; {temp boolean}
@!i: integer; {first temp integer}
@!j: integer; {second temp integer}
@!b:pool_pointer; {base of temporary string}
@!s: str_number; {first temp string}
@!t: str_number; {second temp string}
@!u: str_number; {saved current string string}
begin
c:=cur_chr;
u:=0; { will become non-nil if a string is already being built}
@<Scan the argument for command |c|@>;
old_setting:=selector; selector:=new_string; b:=pool_ptr;
@<Print the result of command |c|@>;
selector:=old_setting; link(garbage):=str_toks(b); ins_list(link(temp_head));
exit:end;
@ @<Scan the argument for command |c|@>=
case c of
number_code,roman_numeral_code: scan_int;
string_code, meaning_code: begin save_scanner_status:=scanner_status;
scanner_status:=normal; get_token; scanner_status:=save_scanner_status;
end;
font_name_code: scan_font_ident;
eTeX_revision_code: do_nothing;
expanded_code:
begin
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
scan_pdf_ext_toks;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
ins_list(link(def_ref));
free_avail(def_ref);
def_ref := save_def_ref;
restore_cur_string;
return;
end;
pdftex_revision_code: do_nothing;
pdftex_banner_code: do_nothing;
pdf_font_name_code, pdf_font_objnum_code, pdf_font_size_code: begin
scan_font_ident;
if cur_val = null_font then
pdf_error("font", "invalid font identifier");
if c <> pdf_font_size_code then begin
pdf_check_vf_cur_val;
if not font_used[cur_val] then
pdf_init_font_cur_val;
end;
end;
pdf_page_ref_code: begin
scan_int;
if cur_val <= 0 then
pdf_error("pageref", "invalid page number");
end;
left_margin_kern_code, right_margin_kern_code: begin
scan_register_num;
fetch_box(p);
if (p = null) or (type(p) <> hlist_node) then
pdf_error("marginkern", "a non-empty hbox expected")
end;
pdf_xform_name_code: begin
scan_int;
pdf_check_obj(obj_type_xform, cur_val);
end;
pdf_escape_string_code:
begin
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
def_ref := save_def_ref;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
b := pool_ptr;
escapestring(str_start[s]);
link(garbage) := str_toks(b);
flush_str(s);
ins_list(link(temp_head));
restore_cur_string;
return;
end;
pdf_escape_name_code:
begin
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
def_ref := save_def_ref;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
b := pool_ptr;
escapename(str_start[s]);
link(garbage) := str_toks(b);
flush_str(s);
ins_list(link(temp_head));
restore_cur_string;
return;
end;
pdf_escape_hex_code:
begin
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
def_ref := save_def_ref;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
b := pool_ptr;
escapehex(str_start[s]);
link(garbage) := str_toks(b);
flush_str(s);
ins_list(link(temp_head));
restore_cur_string;
return;
end;
pdf_unescape_hex_code:
begin
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
def_ref := save_def_ref;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
b := pool_ptr;
unescapehex(str_start[s]);
link(garbage) := str_toks(b);
flush_str(s);
ins_list(link(temp_head));
restore_cur_string;
return;
end;
pdf_creation_date_code:
begin
b := pool_ptr;
getcreationdate;
link(garbage) := str_toks(b);
ins_list(link(temp_head));
return;
end;
pdf_file_mod_date_code:
begin
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
def_ref := save_def_ref;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
b := pool_ptr;
getfilemoddate(s);
link(garbage) := str_toks(b);
flush_str(s);
ins_list(link(temp_head));
restore_cur_string;
return;
end;
pdf_file_size_code:
begin
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
def_ref := save_def_ref;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
b := pool_ptr;
getfilesize(s);
link(garbage) := str_toks(b);
flush_str(s);
ins_list(link(temp_head));
restore_cur_string;
return;
end;
pdf_mdfive_sum_code:
begin
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
bool := scan_keyword("file");
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
def_ref := save_def_ref;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
b := pool_ptr;
getmd5sum(s, bool);
link(garbage) := str_toks(b);
flush_str(s);
ins_list(link(temp_head));
restore_cur_string;
return;
end;
pdf_file_dump_code:
begin
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
{scan offset}
cur_val := 0;
if (scan_keyword("offset")) then begin
scan_int;
if (cur_val < 0) then begin
print_err("Bad file offset");
@.Bad file offset@>
help2("A file offset must be between 0 and 2^{31}-1,")@/
("I changed this one to zero.");
int_error(cur_val);
cur_val := 0;
end;
end;
i := cur_val;
{scan length}
cur_val := 0;
if (scan_keyword("length")) then begin
scan_int;
if (cur_val < 0) then begin
print_err("Bad dump length");
@.Bad dump length@>
help2("A dump length must be between 0 and 2^{31}-1,")@/
("I changed this one to zero.");
int_error(cur_val);
cur_val := 0;
end;
end;
j := cur_val;
{scan file name}
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
def_ref := save_def_ref;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
b := pool_ptr;
getfiledump(s, i, j);
link(garbage) := str_toks(b);
flush_str(s);
ins_list(link(temp_head));
restore_cur_string;
return;
end;
pdf_match_code:
begin
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
{scan for icase}
bool := scan_keyword("icase");
{scan for subcount}
i := -1; {default for subcount}
if scan_keyword("subcount") then begin
scan_int;
i := cur_val;
end;
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
scan_pdf_ext_toks;
t := tokens_to_string(def_ref);
delete_token_ref(def_ref);
def_ref := save_def_ref;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
b := pool_ptr;
matchstrings(s, t, i, bool);
link(garbage) := str_toks(b);
flush_str(t);
flush_str(s);
ins_list(link(temp_head));
restore_cur_string;
return;
end;
pdf_last_match_code:
begin
scan_int;
if cur_val < 0 then begin
print_err("Bad match number");
@.Bad match number@>
help2("Since I expected zero or a positive number,")@/
("I changed this one to zero.");
int_error(cur_val);
cur_val := 0;
end;
b := pool_ptr;
getmatch(cur_val);
link(garbage) := str_toks(b);
ins_list(link(temp_head));
return;
end;
pdf_strcmp_code:
begin
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
compare_strings;
def_ref := save_def_ref;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
restore_cur_string;
end;
pdf_colorstack_init_code:
begin
bool := scan_keyword("page");
if scan_keyword("direct") then
cur_val := direct_always
else
if scan_keyword("page") then
cur_val := direct_page
else
cur_val := set_origin;
save_scanner_status := scanner_status;
save_warning_index := warning_index;
save_def_ref := def_ref;
save_cur_string;
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
def_ref := save_def_ref;
warning_index := save_warning_index;
scanner_status := save_scanner_status;
cur_val := newcolorstack(s, cur_val, bool);
flush_str(s);
cur_val_level := int_val;
if cur_val < 0 then begin
print_err("Too many color stacks");
@.Too many color stacks@>
help2("The number of color stacks is limited to 32768.")@/
("I'll use the default color stack 0 here.");
error;
cur_val := 0;
restore_cur_string;
end;
end;
job_name_code: if job_name=0 then open_log_file;
uniform_deviate_code: scan_int;
normal_deviate_code: do_nothing;
pdf_insert_ht_code: scan_register_num;
pdf_ximage_bbox_code: begin
scan_int;
pdf_check_obj(obj_type_ximage, cur_val);
i := obj_ximage_data(cur_val);
scan_int;
j := cur_val;
if (j < 1) or (j > 4) then
pdf_error("pdfximagebbox", "invalid parameter");
end;
end {there are no other cases}
@ @<Print the result of command |c|@>=
case c of
number_code: print_int(cur_val);
roman_numeral_code: print_roman_int(cur_val);
string_code:if cur_cs<>0 then sprint_cs(cur_cs)
else print_char(cur_chr);
meaning_code: print_meaning;
font_name_code: begin print(font_name[cur_val]);
if font_size[cur_val]<>font_dsize[cur_val] then
begin print(" at "); print_scaled(font_size[cur_val]);
print("pt");
end;
end;
eTeX_revision_code: print(eTeX_revision);
pdftex_revision_code: print(pdftex_revision);
pdftex_banner_code: print(pdftex_banner);
pdf_font_name_code, pdf_font_objnum_code: begin
set_ff(cur_val);
if c = pdf_font_name_code then
print_int(obj_info(pdf_font_num[ff]))
else
print_int(pdf_font_num[ff]);
end;
pdf_font_size_code: begin
print_scaled(font_size[cur_val]);
print("pt");
end;
pdf_page_ref_code: print_int(get_obj(obj_type_page, cur_val, false));
left_margin_kern_code: begin
p := list_ptr(p);
while (p <> null) and
(cp_skipable(p) or
((not is_char_node(p)) and (type(p) = glue_node) and (subtype(p) = left_skip_code + 1)))
do
p := link(p);
if (p <> null) and (not is_char_node(p)) and
(type(p) = margin_kern_node) and (subtype(p) = left_side) then
print_scaled(width(p))
else
print("0");
print("pt");
end;
right_margin_kern_code: begin
q := list_ptr(p);
p := prev_rightmost(q, null);
while (p <> null) and
(cp_skipable(p) or
((not is_char_node(p)) and (type(p) = glue_node) and (subtype(p) = right_skip_code + 1)))
do
p := prev_rightmost(q, p);
if (p <> null) and (not is_char_node(p)) and
(type(p) = margin_kern_node) and (subtype(p) = right_side) then
print_scaled(width(p))
else
print("0");
print("pt");
end;
pdf_xform_name_code: print_int(obj_info(cur_val));
pdf_strcmp_code: print_int(cur_val);
pdf_colorstack_init_code: print_int(cur_val);
uniform_deviate_code: print_int(unif_rand(cur_val));
normal_deviate_code: print_int(norm_rand);
pdf_insert_ht_code: begin
i := qi(cur_val);
p := page_ins_head;
while i >= subtype(link(p)) do
p := link(p);
if subtype(p) = i then
print_scaled(height(p))
else
print("0");
print("pt");
end;
pdf_ximage_bbox_code: begin
if is_pdf_image(i) then begin
case j of
1: print_scaled(epdf_orig_x(i));
2: print_scaled(epdf_orig_y(i));
3: print_scaled(epdf_orig_x(i) + image_width(i));
4: print_scaled(epdf_orig_y(i) + image_height(i));
endcases;
end else
print_scaled(0);
print("pt");
end;
job_name_code: print(job_name);
end {there are no other cases}
@ Now we can't postpone the difficulties any longer; we must bravely tackle
|scan_toks|. This function returns a pointer to the tail of a new token
list, and it also makes |def_ref| point to the reference count at the
head of that list.
There are two boolean parameters, |macro_def| and |xpand|. If |macro_def|
is true, the goal is to create the token list for a macro definition;
otherwise the goal is to create the token list for some other \TeX\
primitive: \.{\\mark}, \.{\\output}, \.{\\everypar}, \.{\\lowercase},
\.{\\uppercase}, \.{\\message}, \.{\\errmessage}, \.{\\write}, or
\.{\\special}. In the latter cases a left brace must be scanned next; this
left brace will not be part of the token list, nor will the matching right
brace that comes at the end. If |xpand| is false, the token list will
simply be copied from the input using |get_token|. Otherwise all expandable
tokens will be expanded until unexpandable tokens are left, except that
the results of expanding `\.{\\the}' are not expanded further.
If both |macro_def| and |xpand| are true, the expansion applies
only to the macro body (i.e., to the material following the first
|left_brace| character).
The value of |cur_cs| when |scan_toks| begins should be the |eqtb|
address of the control sequence to display in ``runaway'' error
messages.
@p function scan_toks(@!macro_def,@!xpand:boolean):pointer;
label found,continue,done,done1,done2;
var t:halfword; {token representing the highest parameter number}
@!s:halfword; {saved token}
@!p:pointer; {tail of the token list being built}
@!q:pointer; {new node being added to the token list via |store_new_token|}
@!unbalance:halfword; {number of unmatched left braces}
@!hash_brace:halfword; {possible `\.{\#\{}' token}
begin if macro_def then scanner_status:=defining
@+else scanner_status:=absorbing;
warning_index:=cur_cs; def_ref:=get_avail; token_ref_count(def_ref):=null;
p:=def_ref; hash_brace:=0; t:=zero_token;
if macro_def then @<Scan and build the parameter part of the macro definition@>
else scan_left_brace; {remove the compulsory left brace}
@<Scan and build the body of the token list; |goto found| when finished@>;
found: scanner_status:=normal;
if hash_brace<>0 then store_new_token(hash_brace);
scan_toks:=p;
end;
@ @<Scan and build the parameter part...@>=
begin loop begin continue: get_token; {set |cur_cmd|, |cur_chr|, |cur_tok|}
if cur_tok<right_brace_limit then goto done1;
if cur_cmd=mac_param then
@<If the next character is a parameter number, make |cur_tok|
a |match| token; but if it is a left brace, store
`|left_brace|, |end_match|', set |hash_brace|, and |goto done|@>;
store_new_token(cur_tok);
end;
done1: store_new_token(end_match_token);
if cur_cmd=right_brace then
@<Express shock at the missing left brace; |goto found|@>;
done: end
@ @<Express shock...@>=
begin print_err("Missing { inserted"); incr(align_state);
@.Missing \{ inserted@>
help2("Where was the left brace? You said something like `\def\a}',")@/
("which I'm going to interpret as `\def\a{}'."); error; goto found;
end
@ @<If the next character is a parameter number...@>=
begin s:=match_token+cur_chr; get_token;
if cur_tok<left_brace_limit then
begin hash_brace:=cur_tok;
store_new_token(cur_tok); store_new_token(end_match_token);
goto done;
end;
if t=zero_token+9 then
begin print_err("You already have nine parameters");
@.You already have nine...@>
help2("I'm going to ignore the # sign you just used,")@/
("as well as the token that followed it."); error; goto continue;
end
else begin incr(t);
if cur_tok<>t then
begin print_err("Parameters must be numbered consecutively");
@.Parameters...consecutively@>
help2("I've inserted the digit you should have used after the #.")@/
("Type `1' to delete what you did use."); back_error;
end;
cur_tok:=s;
end;
end
@ @<Scan and build the body of the token list; |goto found| when finished@>=
unbalance:=1;
loop@+ begin if xpand then @<Expand the next part of the input@>
else get_token;
if cur_tok<right_brace_limit then
if cur_cmd<right_brace then incr(unbalance)
else begin decr(unbalance);
if unbalance=0 then goto found;
end
else if cur_cmd=mac_param then
if macro_def then @<Look for parameter number or \.{\#\#}@>;
store_new_token(cur_tok);
end
@ Here we insert an entire token list created by |the_toks| without
expanding it further.
@<Expand the next part of the input@>=
begin loop begin get_next;
if cur_cmd>=call then
if info(link(cur_chr))=protected_token then
begin cur_cmd:=relax; cur_chr:=no_expand_flag;
end;
if cur_cmd<=max_command then goto done2;
if cur_cmd<>the then expand
else begin q:=the_toks;
if link(temp_head)<>null then
begin link(p):=link(temp_head); p:=q;
end;
end;
end;
done2: x_token
end
@ @<Look for parameter number...@>=
begin s:=cur_tok;
if xpand then get_x_token else get_token;
if cur_cmd<>mac_param then
if (cur_tok<=zero_token)or(cur_tok>t) then
begin print_err("Illegal parameter number in definition of ");
@.Illegal parameter number...@>
sprint_cs(warning_index);
help3("You meant to type ## instead of #, right?")@/
("Or maybe a } was forgotten somewhere earlier, and things")@/
("are all screwed up? I'm going to assume that you meant ##.");
back_error; cur_tok:=s;
end
else cur_tok:=out_param_token-"0"+cur_chr;
end
@ Another way to create a token list is via the \.{\\read} command. The
sixteen files potentially usable for reading appear in the following
global variables. The value of |read_open[n]| will be |closed| if
stream number |n| has not been opened or if it has been fully read;
|just_open| if an \.{\\openin} but not a \.{\\read} has been done;
and |normal| if it is open and ready to read the next line.
@d closed=2 {not open, or at end of file}
@d just_open=1 {newly opened, first line not yet read}
@<Glob...@>=
@!read_file:array[0..15] of alpha_file; {used for \.{\\read}}
@!read_open:array[0..16] of normal..closed; {state of |read_file[n]|}
@ @<Set init...@>=
for k:=0 to 16 do read_open[k]:=closed;
@ The |read_toks| procedure constructs a token list like that for any
macro definition, and makes |cur_val| point to it. Parameter |r| points
to the control sequence that will receive this token list.
@p procedure read_toks(@!n:integer;@!r:pointer;@!j:halfword);
label done;
var p:pointer; {tail of the token list}
@!q:pointer; {new node being added to the token list via |store_new_token|}
@!s:integer; {saved value of |align_state|}
@!m:small_number; {stream number}
begin scanner_status:=defining; warning_index:=r;
def_ref:=get_avail; token_ref_count(def_ref):=null;
p:=def_ref; {the reference count}
store_new_token(end_match_token);
if (n<0)or(n>15) then m:=16@+else m:=n;
s:=align_state; align_state:=1000000; {disable tab marks, etc.}
repeat @<Input and store tokens from the next line of the file@>;
until align_state=1000000;
cur_val:=def_ref; scanner_status:=normal; align_state:=s;
end;
@ @<Input and store tokens from the next line of the file@>=
begin_file_reading; name:=m+1;
if read_open[m]=closed then @<Input for \.{\\read} from the terminal@>
else if read_open[m]=just_open then @<Input the first line of |read_file[m]|@>
else @<Input the next line of |read_file[m]|@>;
limit:=last;
if end_line_char_inactive then decr(limit)
else buffer[limit]:=end_line_char;
first:=limit+1; loc:=start; state:=new_line;@/
@<Handle \.{\\readline} and |goto done|@>;@/
loop@+ begin get_token;
if cur_tok=0 then goto done;
{|cur_cmd=cur_chr=0| will occur at the end of the line}
if align_state<1000000 then {unmatched `\.\}' aborts the line}
begin repeat get_token; until cur_tok=0;
align_state:=1000000; goto done;
end;
store_new_token(cur_tok);
end;
done: end_file_reading
@ Here we input on-line into the |buffer| array, prompting the user explicitly
if |n>=0|. The value of |n| is set negative so that additional prompts
will not be given in the case of multi-line input.
@<Input for \.{\\read} from the terminal@>=
if interaction>nonstop_mode then
if n<0 then prompt_input("")
else begin wake_up_terminal;
print_ln; sprint_cs(r); prompt_input("="); n:=-1;
end
else fatal_error("*** (cannot \read from terminal in nonstop modes)")
@.cannot \\read@>
@ The first line of a file must be treated specially, since |input_ln|
must be told not to start with |get|.
@^system dependencies@>
@<Input the first line of |read_file[m]|@>=
if input_ln(read_file[m],false) then read_open[m]:=normal
else begin a_close(read_file[m]); read_open[m]:=closed;
end
@ An empty line is appended at the end of a |read_file|.
@^empty line at end of file@>
@<Input the next line of |read_file[m]|@>=
begin if not input_ln(read_file[m],true) then
begin a_close(read_file[m]); read_open[m]:=closed;
if align_state<>1000000 then
begin runaway;
print_err("File ended within "); print_esc("read");
@.File ended within \\read@>
help1("This \read has unbalanced braces.");
align_state:=1000000; limit:=0; error;
end;
end;
end
@* \[28] Conditional processing.
We consider now the way \TeX\ handles various kinds of \.{\\if} commands.
@d unless_code=32 {amount added for `\.{\\unless}' prefix}
@#
@d if_char_code=0 { `\.{\\if}' }
@d if_cat_code=1 { `\.{\\ifcat}' }
@d if_int_code=2 { `\.{\\ifnum}' }
@d if_dim_code=3 { `\.{\\ifdim}' }
@d if_odd_code=4 { `\.{\\ifodd}' }
@d if_vmode_code=5 { `\.{\\ifvmode}' }
@d if_hmode_code=6 { `\.{\\ifhmode}' }
@d if_mmode_code=7 { `\.{\\ifmmode}' }
@d if_inner_code=8 { `\.{\\ifinner}' }
@d if_void_code=9 { `\.{\\ifvoid}' }
@d if_hbox_code=10 { `\.{\\ifhbox}' }
@d if_vbox_code=11 { `\.{\\ifvbox}' }
@d ifx_code=12 { `\.{\\ifx}' }
@d if_eof_code=13 { `\.{\\ifeof}' }
@d if_true_code=14 { `\.{\\iftrue}' }
@d if_false_code=15 { `\.{\\iffalse}' }
@d if_case_code=16 { `\.{\\ifcase}' }
@d if_pdfprimitive_code=21 { `\.{\\ifpdfprimitive}' }
@<Put each...@>=
primitive("if",if_test,if_char_code);
@!@:if_char_}{\.{\\if} primitive@>
primitive("ifcat",if_test,if_cat_code);
@!@:if_cat_code_}{\.{\\ifcat} primitive@>
primitive("ifnum",if_test,if_int_code);
@!@:if_int_}{\.{\\ifnum} primitive@>
primitive("ifdim",if_test,if_dim_code);
@!@:if_dim_}{\.{\\ifdim} primitive@>
primitive("ifodd",if_test,if_odd_code);
@!@:if_odd_}{\.{\\ifodd} primitive@>
primitive("ifvmode",if_test,if_vmode_code);
@!@:if_vmode_}{\.{\\ifvmode} primitive@>
primitive("ifhmode",if_test,if_hmode_code);
@!@:if_hmode_}{\.{\\ifhmode} primitive@>
primitive("ifmmode",if_test,if_mmode_code);
@!@:if_mmode_}{\.{\\ifmmode} primitive@>
primitive("ifinner",if_test,if_inner_code);
@!@:if_inner_}{\.{\\ifinner} primitive@>
primitive("ifvoid",if_test,if_void_code);
@!@:if_void_}{\.{\\ifvoid} primitive@>
primitive("ifhbox",if_test,if_hbox_code);
@!@:if_hbox_}{\.{\\ifhbox} primitive@>
primitive("ifvbox",if_test,if_vbox_code);
@!@:if_vbox_}{\.{\\ifvbox} primitive@>
primitive("ifx",if_test,ifx_code);
@!@:ifx_}{\.{\\ifx} primitive@>
primitive("ifeof",if_test,if_eof_code);
@!@:if_eof_}{\.{\\ifeof} primitive@>
primitive("iftrue",if_test,if_true_code);
@!@:if_true_}{\.{\\iftrue} primitive@>
primitive("iffalse",if_test,if_false_code);
@!@:if_false_}{\.{\\iffalse} primitive@>
primitive("ifcase",if_test,if_case_code);
@!@:if_case_}{\.{\\ifcase} primitive@>
primitive("ifpdfprimitive",if_test,if_pdfprimitive_code);
@!@:if_pdfprimitive_}{\.{\\ifpdfprimitive} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
if_test: begin if chr_code>=unless_code then print_esc("unless");
case chr_code mod unless_code of
if_cat_code:print_esc("ifcat");
if_int_code:print_esc("ifnum");
if_dim_code:print_esc("ifdim");
if_odd_code:print_esc("ifodd");
if_vmode_code:print_esc("ifvmode");
if_hmode_code:print_esc("ifhmode");
if_mmode_code:print_esc("ifmmode");
if_inner_code:print_esc("ifinner");
if_void_code:print_esc("ifvoid");
if_hbox_code:print_esc("ifhbox");
if_vbox_code:print_esc("ifvbox");
ifx_code:print_esc("ifx");
if_eof_code:print_esc("ifeof");
if_true_code:print_esc("iftrue");
if_false_code:print_esc("iffalse");
if_case_code:print_esc("ifcase");
if_pdfprimitive_code:print_esc("ifpdfprimitive");
@/@<Cases of |if_test| for |print_cmd_chr|@>@/
othercases print_esc("if")
endcases;
end;
@ Conditions can be inside conditions, and this nesting has a stack
that is independent of the |save_stack|.
Four global variables represent the top of the condition stack:
|cond_ptr| points to pushed-down entries, if any; |if_limit| specifies
the largest code of a |fi_or_else| command that is syntactically legal;
|cur_if| is the name of the current type of conditional; and |if_line|
is the line number at which it began.
If no conditions are currently in progress, the condition stack has the
special state |cond_ptr=null|, |if_limit=normal|, |cur_if=0|, |if_line=0|.
Otherwise |cond_ptr| points to a two-word node; the |type|, |subtype|, and
|link| fields of the first word contain |if_limit|, |cur_if|, and
|cond_ptr| at the next level, and the second word contains the
corresponding |if_line|.
@d if_node_size=2 {number of words in stack entry for conditionals}
@d if_line_field(#)==mem[#+1].int
@d if_code=1 {code for \.{\\if...} being evaluated}
@d fi_code=2 {code for \.{\\fi}}
@d else_code=3 {code for \.{\\else}}
@d or_code=4 {code for \.{\\or}}
@<Glob...@>=
@!cond_ptr:pointer; {top of the condition stack}
@!if_limit:normal..or_code; {upper bound on |fi_or_else| codes}
@!cur_if:small_number; {type of conditional being worked on}
@!if_line:integer; {line where that conditional began}
@ @<Set init...@>=
cond_ptr:=null; if_limit:=normal; cur_if:=0; if_line:=0;
@ @<Put each...@>=
primitive("fi",fi_or_else,fi_code);
@!@:fi_}{\.{\\fi} primitive@>
text(frozen_fi):="fi"; eqtb[frozen_fi]:=eqtb[cur_val];
primitive("or",fi_or_else,or_code);
@!@:or_}{\.{\\or} primitive@>
primitive("else",fi_or_else,else_code);
@!@:else_}{\.{\\else} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
fi_or_else: if chr_code=fi_code then print_esc("fi")
else if chr_code=or_code then print_esc("or")
else print_esc("else");
@ When we skip conditional text, we keep track of the line number
where skipping began, for use in error messages.
@<Glob...@>=
@!skip_line:integer; {skipping began here}
@ Here is a procedure that ignores text until coming to an \.{\\or},
\.{\\else}, or \.{\\fi} at the current level of $\.{\\if}\ldots\.{\\fi}$
nesting. After it has acted, |cur_chr| will indicate the token that
was found, but |cur_tok| will not be set (because this makes the
procedure run faster).
@p procedure pass_text;
label done;
var l:integer; {level of $\.{\\if}\ldots\.{\\fi}$ nesting}
@!save_scanner_status:small_number; {|scanner_status| upon entry}
begin save_scanner_status:=scanner_status; scanner_status:=skipping; l:=0;
skip_line:=line;
loop@+ begin get_next;
if cur_cmd=fi_or_else then
begin if l=0 then goto done;
if cur_chr=fi_code then decr(l);
end
else if cur_cmd=if_test then incr(l);
end;
done: scanner_status:=save_scanner_status;
if tracing_ifs>0 then show_cur_cmd_chr;
end;
@ When we begin to process a new \.{\\if}, we set |if_limit:=if_code|; then
if\/ \.{\\or} or \.{\\else} or \.{\\fi} occurs before the current \.{\\if}
condition has been evaluated, \.{\\relax} will be inserted.
For example, a sequence of commands like `\.{\\ifvoid1\\else...\\fi}'
would otherwise require something after the `\.1'.
@<Push the condition stack@>=
begin p:=get_node(if_node_size); link(p):=cond_ptr; type(p):=if_limit;
subtype(p):=cur_if; if_line_field(p):=if_line;
cond_ptr:=p; cur_if:=cur_chr; if_limit:=if_code; if_line:=line;
end
@ @<Pop the condition stack@>=
begin if if_stack[in_open]=cond_ptr then if_warning;
{conditionals possibly not properly nested with files}
p:=cond_ptr; if_line:=if_line_field(p);
cur_if:=subtype(p); if_limit:=type(p); cond_ptr:=link(p);
free_node(p,if_node_size);
end
@ Here's a procedure that changes the |if_limit| code corresponding to
a given value of |cond_ptr|.
@p procedure change_if_limit(@!l:small_number;@!p:pointer);
label exit;
var q:pointer;
begin if p=cond_ptr then if_limit:=l {that's the easy case}
else begin q:=cond_ptr;
loop@+ begin if q=null then confusion("if");
@:this can't happen if}{\quad if@>
if link(q)=p then
begin type(q):=l; return;
end;
q:=link(q);
end;
end;
exit:end;
@ A condition is started when the |expand| procedure encounters
an |if_test| command; in that case |expand| reduces to |conditional|,
which is a recursive procedure.
@^recursion@>
@p procedure conditional;
label exit,common_ending;
var b:boolean; {is the condition true?}
@!e:boolean; {keep track of nested csnames}
@!r:"<"..">"; {relation to be evaluated}
@!m,@!n:integer; {to be tested against the second operand}
@!p,@!q:pointer; {for traversing token lists in \.{\\ifx} tests}
@!save_scanner_status:small_number; {|scanner_status| upon entry}
@!save_cond_ptr:pointer; {|cond_ptr| corresponding to this conditional}
@!this_if:small_number; {type of this conditional}
@!is_unless:boolean; {was this if preceded by `\.{\\unless}' ?}
begin if tracing_ifs>0 then if tracing_commands<=1 then show_cur_cmd_chr;
@<Push the condition stack@>;@+save_cond_ptr:=cond_ptr;
is_unless:=(cur_chr>=unless_code); this_if:=cur_chr mod unless_code;@/
@<Either process \.{\\ifcase} or set |b| to the value of a boolean condition@>;
if is_unless then b:=not b;
if tracing_commands>1 then @<Display the value of |b|@>;
if b then
begin change_if_limit(else_code,save_cond_ptr);
return; {wait for \.{\\else} or \.{\\fi}}
end;
@<Skip to \.{\\else} or \.{\\fi}, then |goto common_ending|@>;
common_ending: if cur_chr=fi_code then @<Pop the condition stack@>
else if_limit:=fi_code; {wait for \.{\\fi}}
exit:end;
@ In a construction like `\.{\\if\\iftrue abc\\else d\\fi}', the first
\.{\\else} that we come to after learning that the \.{\\if} is false is
not the \.{\\else} we're looking for. Hence the following curious
logic is needed.
@ @<Skip to \.{\\else} or \.{\\fi}...@>=
loop@+ begin pass_text;
if cond_ptr=save_cond_ptr then
begin if cur_chr<>or_code then goto common_ending;
print_err("Extra "); print_esc("or");
@.Extra \\or@>
help1("I'm ignoring this; it doesn't match any \if.");
error;
end
else if cur_chr=fi_code then @<Pop the condition stack@>;
end
@ @<Either process \.{\\ifcase} or set |b|...@>=
case this_if of
if_char_code, if_cat_code: @<Test if two characters match@>;
if_int_code, if_dim_code: @<Test relation between integers or dimensions@>;
if_odd_code: @<Test if an integer is odd@>;
if_vmode_code: b:=(abs(mode)=vmode);
if_hmode_code: b:=(abs(mode)=hmode);
if_mmode_code: b:=(abs(mode)=mmode);
if_inner_code: b:=(mode<0);
if_void_code, if_hbox_code, if_vbox_code: @<Test box register status@>;
ifx_code: @<Test if two tokens match@>;
if_eof_code: begin scan_four_bit_int; b:=(read_open[cur_val]=closed);
end;
if_true_code: b:=true;
if_false_code: b:=false;
@/@<Cases for |conditional|@>@/
if_case_code: @<Select the appropriate case
and |return| or |goto common_ending|@>;
if_pdfprimitive_code: begin
save_scanner_status:=scanner_status;
scanner_status:=normal;
get_next;
scanner_status:=save_scanner_status;
if cur_cs < hash_base then
m := prim_lookup(cur_cs-single_base)
else
m := prim_lookup(text(cur_cs));
b :=((cur_cmd<>undefined_cs) and
(m<>undefined_primitive) and
(cur_cmd=prim_eq_type(m)) and
(cur_chr=prim_equiv(m)));
end;
end {there are no other cases}
@ @<Display the value of |b|@>=
begin begin_diagnostic;
if b then print("{true}")@+else print("{false}");
end_diagnostic(false);
end
@ Here we use the fact that |"<"|, |"="|, and |">"| are consecutive ASCII
codes.
@^ASCII code@>
@<Test relation between integers or dimensions@>=
begin if this_if=if_int_code then scan_int@+else scan_normal_dimen;
n:=cur_val; @<Get the next non-blank non-call...@>;
if (cur_tok>=other_token+"<")and(cur_tok<=other_token+">") then
r:=cur_tok-other_token
else begin print_err("Missing = inserted for ");
@.Missing = inserted@>
print_cmd_chr(if_test,this_if);
help1("I was expecting to see `<', `=', or `>'. Didn't.");
back_error; r:="=";
end;
if this_if=if_int_code then scan_int@+else scan_normal_dimen;
case r of
"<": b:=(n<cur_val);
"=": b:=(n=cur_val);
">": b:=(n>cur_val);
end;
end
@ @<Test if an integer is odd@>=
begin scan_int; b:=odd(cur_val);
end
@ @<Test box register status@>=
begin scan_register_num; fetch_box(p);
if this_if=if_void_code then b:=(p=null)
else if p=null then b:=false
else if this_if=if_hbox_code then b:=(type(p)=hlist_node)
else b:=(type(p)=vlist_node);
end
@ An active character will be treated as category 13 following
\.{\\if\\noexpand} or following \.{\\ifcat\\noexpand}. We use the fact that
active characters have the smallest tokens, among all control sequences.
@d get_x_token_or_active_char==@t@>@;
begin get_x_token;
if cur_cmd=relax then if cur_chr=no_expand_flag then
begin cur_cmd:=active_char;
cur_chr:=cur_tok-cs_token_flag-active_base;
end;
end
@<Test if two characters match@>=
begin get_x_token_or_active_char;
if (cur_cmd>active_char)or(cur_chr>255) then {not a character}
begin m:=relax; n:=256;
end
else begin m:=cur_cmd; n:=cur_chr;
end;
get_x_token_or_active_char;
if (cur_cmd>active_char)or(cur_chr>255) then
begin cur_cmd:=relax; cur_chr:=256;
end;
if this_if=if_char_code then b:=(n=cur_chr)@+else b:=(m=cur_cmd);
end
@ Note that `\.{\\ifx}' will declare two macros different if one is \\{long}
or \\{outer} and the other isn't, even though the texts of the macros are
the same.
We need to reset |scanner_status|, since \.{\\outer} control sequences
are allowed, but we might be scanning a macro definition or preamble.
@<Test if two tokens match@>=
begin save_scanner_status:=scanner_status; scanner_status:=normal;
get_next; n:=cur_cs; p:=cur_cmd; q:=cur_chr;
get_next; if cur_cmd<>p then b:=false
else if cur_cmd<call then b:=(cur_chr=q)
else @<Test if two macro texts match@>;
scanner_status:=save_scanner_status;
end
@ Note also that `\.{\\ifx}' decides that macros \.{\\a} and \.{\\b} are
different in examples like this:
$$\vbox{\halign{\.{#}\hfil&\qquad\.{#}\hfil\cr
{}\\def\\a\{\\c\}&
{}\\def\\c\{\}\cr
{}\\def\\b\{\\d\}&
{}\\def\\d\{\}\cr}}$$
@<Test if two macro texts match@>=
begin p:=link(cur_chr); q:=link(equiv(n)); {omit reference counts}
if p=q then b:=true
else begin while (p<>null)and(q<>null) do
if info(p)<>info(q) then p:=null
else begin p:=link(p); q:=link(q);
end;
b:=((p=null)and(q=null));
end;
end
@ @<Select the appropriate case and |return| or |goto common_ending|@>=
begin scan_int; n:=cur_val; {|n| is the number of cases to pass}
if tracing_commands>1 then
begin begin_diagnostic; print("{case "); print_int(n); print_char("}");
end_diagnostic(false);
end;
while n<>0 do
begin pass_text;
if cond_ptr=save_cond_ptr then
if cur_chr=or_code then decr(n)
else goto common_ending
else if cur_chr=fi_code then @<Pop the condition stack@>;
end;
change_if_limit(or_code,save_cond_ptr);
return; {wait for \.{\\or}, \.{\\else}, or \.{\\fi}}
end
@ The processing of conditionals is complete except for the following
code, which is actually part of |expand|. It comes into play when
\.{\\or}, \.{\\else}, or \.{\\fi} is scanned.
@<Terminate the current conditional and skip to \.{\\fi}@>=
begin if tracing_ifs>0 then if tracing_commands<=1 then show_cur_cmd_chr;
if cur_chr>if_limit then
if if_limit=if_code then insert_relax {condition not yet evaluated}
else begin print_err("Extra "); print_cmd_chr(fi_or_else,cur_chr);
@.Extra \\or@>
@.Extra \\else@>
@.Extra \\fi@>
help1("I'm ignoring this; it doesn't match any \if.");
error;
end
else begin while cur_chr<>fi_code do pass_text; {skip to \.{\\fi}}
@<Pop the condition stack@>;
end;
end
@* \[29] File names.
It's time now to fret about file names. Besides the fact that different
operating systems treat files in different ways, we must cope with the
fact that completely different naming conventions are used by different
groups of people. The following programs show what is required for one
particular operating system; similar routines for other systems are not
difficult to devise.
@^fingers@>
@^system dependencies@>
\TeX\ assumes that a file name has three parts: the name proper; its
``extension''; and a ``file area'' where it is found in an external file
system. The extension of an input file or a write file is assumed to be
`\.{.tex}' unless otherwise specified; it is `\.{.log}' on the
transcript file that records each run of \TeX; it is `\.{.tfm}' on the font
metric files that describe characters in the fonts \TeX\ uses; it is
`\.{.dvi}' on the output files that specify typesetting information; and it
is `\.{.fmt}' on the format files written by \.{INITEX} to initialize \TeX.
The file area can be arbitrary on input files, but files are usually
output to the user's current area. If an input file cannot be
found on the specified area, \TeX\ will look for it on a special system
area; this special area is intended for commonly used input files like
\.{webmac.tex}.
Simple uses of \TeX\ refer only to file names that have no explicit
extension or area. For example, a person usually says `\.{\\input} \.{paper}'
or `\.{\\font\\tenrm} \.= \.{helvetica}' instead of `\.{\\input}
\.{paper.new}' or `\.{\\font\\tenrm} \.= \.{<csd.knuth>test}'. Simple file
names are best, because they make the \TeX\ source files portable;
whenever a file name consists entirely of letters and digits, it should be
treated in the same way by all implementations of \TeX. However, users
need the ability to refer to other files in their environment, especially
when responding to error messages concerning unopenable files; therefore
we want to let them use the syntax that appears in their favorite
operating system.
The following procedures don't allow spaces to be part of
file names; but some users seem to like names that are spaced-out.
System-dependent changes to allow such things should probably
be made with reluctance, and only when an entire file name that
includes spaces is ``quoted'' somehow.
@ In order to isolate the system-dependent aspects of file names, the
@^system dependencies@>
system-independent parts of \TeX\ are expressed in terms
of three system-dependent
procedures called |begin_name|, |more_name|, and |end_name|. In
essence, if the user-specified characters of the file name are $c_1\ldots c_n$,
the system-independent driver program does the operations
$$|begin_name|;\,|more_name|(c_1);\,\ldots\,;\,|more_name|(c_n);
\,|end_name|.$$
These three procedures communicate with each other via global variables.
Afterwards the file name will appear in the string pool as three strings
called |cur_name|\penalty10000\hskip-.05em,
|cur_area|, and |cur_ext|; the latter two are null (i.e.,
|""|), unless they were explicitly specified by the user.
Actually the situation is slightly more complicated, because \TeX\ needs
to know when the file name ends. The |more_name| routine is a function
(with side effects) that returns |true| on the calls |more_name|$(c_1)$,
\dots, |more_name|$(c_{n-1})$. The final call |more_name|$(c_n)$
returns |false|; or, it returns |true| and the token following $c_n$ is
something like `\.{\\hbox}' (i.e., not a character). In other words,
|more_name| is supposed to return |true| unless it is sure that the
file name has been completely scanned; and |end_name| is supposed to be able
to finish the assembly of |cur_name|, |cur_area|, and |cur_ext| regardless of
whether $|more_name|(c_n)$ returned |true| or |false|.
@<Glob...@>=
@!cur_name:str_number; {name of file just scanned}
@!cur_area:str_number; {file area just scanned, or \.{""}}
@!cur_ext:str_number; {file extension just scanned, or \.{""}}
@ The file names we shall deal with for illustrative purposes have the
following structure: If the name contains `\.>' or `\.:', the file area
consists of all characters up to and including the final such character;
otherwise the file area is null. If the remaining file name contains
`\..', the file extension consists of all such characters from the first
remaining `\..' to the end, otherwise the file extension is null.
@^system dependencies@>
We can scan such file names easily by using two global variables that keep track
of the occurrences of area and extension delimiters:
@<Glob...@>=
@!area_delimiter:pool_pointer; {the most recent `\.>' or `\.:', if any}
@!ext_delimiter:pool_pointer; {the relevant `\..', if any}
@ Input files that can't be found in the user's area may appear in a standard
system area called |TEX_area|. Font metric files whose areas are not given
explicitly are assumed to appear in a standard system area called
|TEX_font_area|. These system area names will, of course, vary from place
to place.
@^system dependencies@>
@d TEX_area=="TeXinputs:"
@.TeXinputs@>
@d TEX_font_area=="TeXfonts:"
@.TeXfonts@>
@ Here now is the first of the system-dependent routines for file name scanning.
@^system dependencies@>
@p procedure begin_name;
begin area_delimiter:=0; ext_delimiter:=0;
end;
@ And here's the second. The string pool might change as the file name is
being scanned, since a new \.{\\csname} might be entered; therefore we keep
|area_delimiter| and |ext_delimiter| relative to the beginning of the current
string, instead of assigning an absolute address like |pool_ptr| to them.
@^system dependencies@>
@p function more_name(@!c:ASCII_code):boolean;
begin if c=" " then more_name:=false
else begin str_room(1); append_char(c); {contribute |c| to the current string}
if (c=">")or(c=":") then
begin area_delimiter:=cur_length; ext_delimiter:=0;
end
else if (c=".")and(ext_delimiter=0) then ext_delimiter:=cur_length;
more_name:=true;
end;
end;
@ The third.
@^system dependencies@>
@p procedure end_name;
begin if str_ptr+3>max_strings then
overflow("number of strings",max_strings-init_str_ptr);
@:TeX capacity exceeded number of strings}{\quad number of strings@>
if area_delimiter=0 then cur_area:=""
else begin cur_area:=str_ptr;
str_start[str_ptr+1]:=str_start[str_ptr]+area_delimiter; incr(str_ptr);
end;
if ext_delimiter=0 then
begin cur_ext:=""; cur_name:=make_string;
end
else begin cur_name:=str_ptr;
str_start[str_ptr+1]:=str_start[str_ptr]+ext_delimiter-area_delimiter-1;
incr(str_ptr); cur_ext:=make_string;
end;
end;
@ Conversely, here is a routine that takes three strings and prints a file
name that might have produced them. (The routine is system dependent, because
some operating systems put the file area last instead of first.)
@^system dependencies@>
@<Basic printing...@>=
procedure print_file_name(@!n,@!a,@!e:integer);
begin slow_print(a); slow_print(n); slow_print(e);
end;
@ Another system-dependent routine is needed to convert three internal
\TeX\ strings
into the |name_of_file| value that is used to open files. The present code
allows both lowercase and uppercase letters in the file name.
@^system dependencies@>
@d append_to_name(#)==begin c:=#; incr(k);
if k<=file_name_size then name_of_file[k]:=xchr[c];
end
@p procedure pack_file_name(@!n,@!a,@!e:str_number);
var k:integer; {number of positions filled in |name_of_file|}
@!c: ASCII_code; {character being packed}
@!j:pool_pointer; {index into |str_pool|}
begin k:=0;
for j:=str_start[a] to str_start[a+1]-1 do append_to_name(so(str_pool[j]));
for j:=str_start[n] to str_start[n+1]-1 do append_to_name(so(str_pool[j]));
for j:=str_start[e] to str_start[e+1]-1 do append_to_name(so(str_pool[j]));
if k<=file_name_size then name_length:=k@+else name_length:=file_name_size;
for k:=name_length+1 to file_name_size do name_of_file[k]:=' ';
end;
@ A messier routine is also needed, since format file names must be scanned
before \TeX's string mechanism has been initialized. We shall use the
global variable |TEX_format_default| to supply the text for default system areas
and extensions related to format files.
@^system dependencies@>
@d format_default_length=20 {length of the |TEX_format_default| string}
@d format_area_length=11 {length of its area part}
@d format_ext_length=4 {length of its `\.{.fmt}' part}
@d format_extension=".fmt" {the extension, as a \.{WEB} constant}
@<Glob...@>=
@!TEX_format_default:packed array[1..format_default_length] of char;
@ @<Set init...@>=
TEX_format_default:='TeXformats:plain.fmt';
@.TeXformats@>
@.plain@>
@^system dependencies@>
@ @<Check the ``constant'' values for consistency@>=
if format_default_length>file_name_size then bad:=31;
@ Here is the messy routine that was just mentioned. It sets |name_of_file|
from the first |n| characters of |TEX_format_default|, followed by
|buffer[a..b]|, followed by the last |format_ext_length| characters of
|TEX_format_default|.
We dare not give error messages here, since \TeX\ calls this routine before
the |error| routine is ready to roll. Instead, we simply drop excess characters,
since the error will be detected in another way when a strange file name
isn't found.
@^system dependencies@>
@p procedure pack_buffered_name(@!n:small_number;@!a,@!b:integer);
var k:integer; {number of positions filled in |name_of_file|}
@!c: ASCII_code; {character being packed}
@!j:integer; {index into |buffer| or |TEX_format_default|}
begin if n+b-a+1+format_ext_length>file_name_size then
b:=a+file_name_size-n-1-format_ext_length;
k:=0;
for j:=1 to n do append_to_name(xord[TEX_format_default[j]]);
for j:=a to b do append_to_name(buffer[j]);
for j:=format_default_length-format_ext_length+1 to format_default_length do
append_to_name(xord[TEX_format_default[j]]);
if k<=file_name_size then name_length:=k@+else name_length:=file_name_size;
for k:=name_length+1 to file_name_size do name_of_file[k]:=' ';
end;
@ Here is the only place we use |pack_buffered_name|. This part of the program
becomes active when a ``virgin'' \TeX\ is trying to get going, just after
the preliminary initialization, or when the user is substituting another
format file by typing `\.\&' after the initial `\.{**}' prompt. The buffer
contains the first line of input in |buffer[loc..(last-1)]|, where
|loc<last| and |buffer[loc]<>" "|.
@<Declare the function called |open_fmt_file|@>=
function open_fmt_file:boolean;
label found,exit;
var j:0..buf_size; {the first space after the format file name}
begin j:=loc;
if buffer[loc]="&" then
begin incr(loc); j:=loc; buffer[last]:=" ";
while buffer[j]<>" " do incr(j);
pack_buffered_name(0,loc,j-1); {try first without the system file area}
if w_open_in(fmt_file) then goto found;
pack_buffered_name(format_area_length,loc,j-1);
{now try the system format file area}
if w_open_in(fmt_file) then goto found;
wake_up_terminal;
wterm_ln('Sorry, I can''t find that format;',' will try PLAIN.');
@.Sorry, I can't find...@>
update_terminal;
end;
{now pull out all the stops: try for the system \.{plain} file}
pack_buffered_name(format_default_length-format_ext_length,1,0);
if not w_open_in(fmt_file) then
begin wake_up_terminal;
wterm_ln('I can''t find the PLAIN format file!');
@.I can't find PLAIN...@>
@.plain@>
open_fmt_file:=false; return;
end;
found:loc:=j; open_fmt_file:=true;
exit:end;
@ Operating systems often make it possible to determine the exact name (and
possible version number) of a file that has been opened. The following routine,
which simply makes a \TeX\ string from the value of |name_of_file|, should
ideally be changed to deduce the full name of file~|f|, which is the file
most recently opened, if it is possible to do this in a \PASCAL\ program.
@^system dependencies@>
This routine might be called after string memory has overflowed, hence
we dare not use `|str_room|'.
@p function make_name_string:str_number;
var k:1..file_name_size; {index into |name_of_file|}
begin if (pool_ptr+name_length>pool_size)or(str_ptr=max_strings)or
(cur_length>0) then
make_name_string:="?"
else begin for k:=1 to name_length do append_char(xord[name_of_file[k]]);
make_name_string:=make_string;
end;
end;
function a_make_name_string(var f:alpha_file):str_number;
begin a_make_name_string:=make_name_string;
end;
function b_make_name_string(var f:byte_file):str_number;
begin b_make_name_string:=make_name_string;
end;
function w_make_name_string(var f:word_file):str_number;
begin w_make_name_string:=make_name_string;
end;
@ Now let's consider the ``driver''
routines by which \TeX\ deals with file names
in a system-independent manner. First comes a procedure that looks for a
file name in the input by calling |get_x_token| for the information.
@p procedure scan_file_name;
label done;
begin name_in_progress:=true; begin_name;
@<Get the next non-blank non-call...@>;
loop@+begin if (cur_cmd>other_char)or(cur_chr>255) then {not a character}
begin back_input; goto done;
end;
if not more_name(cur_chr) then goto done;
get_x_token;
end;
done: end_name; name_in_progress:=false;
end;
@ The global variable |name_in_progress| is used to prevent recursive
use of |scan_file_name|, since the |begin_name| and other procedures
communicate via global variables. Recursion would arise only by
devious tricks like `\.{\\input\\input f}'; such attempts at sabotage
must be thwarted. Furthermore, |name_in_progress| prevents \.{\\input}
@^recursion@>
from being initiated when a font size specification is being scanned.
Another global variable, |job_name|, contains the file name that was first
\.{\\input} by the user. This name is extended by `\.{.log}' and `\.{.dvi}'
and `\.{.fmt}' in the names of \TeX's output files.
@<Glob...@>=
@!name_in_progress:boolean; {is a file name being scanned?}
@!job_name:str_number; {principal file name}
@!log_opened:boolean; {has the transcript file been opened?}
@ Initially |job_name=0|; it becomes nonzero as soon as the true name is known.
We have |job_name=0| if and only if the `\.{log}' file has not been opened,
except of course for a short time just after |job_name| has become nonzero.
@<Initialize the output...@>=
job_name:=0; name_in_progress:=false; log_opened:=false;
@ Here is a routine that manufactures the output file names, assuming that
|job_name<>0|. It ignores and changes the current settings of |cur_area|
and |cur_ext|.
@d pack_cur_name==pack_file_name(cur_name,cur_area,cur_ext)
@p procedure pack_job_name(@!s:str_number); {|s = ".log"|, |".dvi"|, or
|format_extension|}
begin cur_area:=""; cur_ext:=s;
cur_name:=job_name; pack_cur_name;
end;
@ If some trouble arises when \TeX\ tries to open a file, the following
routine calls upon the user to supply another file name. Parameter~|s|
is used in the error message to identify the type of file; parameter~|e|
is the default extension if none is given. Upon exit from the routine,
variables |cur_name|, |cur_area|, |cur_ext|, and |name_of_file| are
ready for another attempt at file opening.
@p procedure prompt_file_name(@!s,@!e:str_number);
label done;
var k:0..buf_size; {index into |buffer|}
begin if interaction=scroll_mode then wake_up_terminal;
if s="input file name" then print_err("I can't find file `")
@.I can't find file x@>
else print_err("I can't write on file `");
@.I can't write on file x@>
print_file_name(cur_name,cur_area,cur_ext); print("'.");
if e=".tex" then show_context;
print_nl("Please type another "); print(s);
@.Please type...@>
if interaction<scroll_mode then
fatal_error("*** (job aborted, file error in nonstop mode)");
@.job aborted, file error...@>
clear_terminal; prompt_input(": "); @<Scan file name in the buffer@>;
if cur_ext="" then cur_ext:=e;
pack_cur_name;
end;
@ @<Scan file name in the buffer@>=
begin begin_name; k:=first;
while (buffer[k]=" ")and(k<last) do incr(k);
loop@+ begin if k=last then goto done;
if not more_name(buffer[k]) then goto done;
incr(k);
end;
done:end_name;
end
@ Here's an example of how these conventions are used. Whenever it is time to
ship out a box of stuff, we shall use the macro |ensure_dvi_open|.
@d ensure_dvi_open==if output_file_name=0 then
begin if job_name=0 then open_log_file;
pack_job_name(".dvi");
while not b_open_out(dvi_file) do
prompt_file_name("file name for output",".dvi");
output_file_name:=b_make_name_string(dvi_file);
end
@<Glob...@>=
@!dvi_file: byte_file; {the device-independent output goes here}
@!output_file_name: str_number; {full name of the output file}
@!log_name:str_number; {full name of the log file}
@ @<Initialize the output...@>=output_file_name:=0;
@ The |open_log_file| routine is used to open the transcript file and to help
it catch up to what has previously been printed on the terminal.
@p procedure open_log_file;
var old_setting:0..max_selector; {previous |selector| setting}
@!k:0..buf_size; {index into |months| and |buffer|}
@!l:0..buf_size; {end of first input line}
@!months:packed array [1..36] of char; {abbreviations of month names}
begin old_setting:=selector;
if job_name=0 then job_name:="texput";
@.texput@>
pack_job_name(".log");
while not a_open_out(log_file) do @<Try to get a different log file name@>;
log_name:=a_make_name_string(log_file);
selector:=log_only; log_opened:=true;
@<Print the banner line, including the date and time@>;
input_stack[input_ptr]:=cur_input; {make sure bottom level is in memory}
print_nl("**");
@.**@>
l:=input_stack[0].limit_field; {last position of first line}
if buffer[l]=end_line_char then decr(l);
for k:=1 to l do print(buffer[k]);
print_ln; {now the transcript file contains the first line of input}
selector:=old_setting+2; {|log_only| or |term_and_log|}
end;
@ Sometimes |open_log_file| is called at awkward moments when \TeX\ is
unable to print error messages or even to |show_context|.
The |prompt_file_name| routine can result in a |fatal_error|, but the |error|
routine will not be invoked because |log_opened| will be false.
The normal idea of |batch_mode| is that nothing at all should be written
on the terminal. However, in the unusual case that
no log file could be opened, we make an exception and allow
an explanatory message to be seen.
Incidentally, the program always refers to the log file as a `\.{transcript
file}', because some systems cannot use the extension `\.{.log}' for
this file.
@<Try to get a different log file name@>=
begin selector:=term_only;
prompt_file_name("transcript file name",".log");
end
@ @<Print the banner...@>=
begin wlog(banner);
slow_print(format_ident); print(" ");
print_int(sys_day); print_char(" ");
months:='JANFEBMARAPRMAYJUNJULAUGSEPOCTNOVDEC';
for k:=3*sys_month-2 to 3*sys_month do wlog(months[k]);
print_char(" "); print_int(sys_year); print_char(" ");
print_two(sys_time div 60); print_char(":"); print_two(sys_time mod 60);
if eTeX_ex then
begin; wlog_cr; wlog('entering extended mode');
end;
end
@ Let's turn now to the procedure that is used to initiate file reading
when an `\.{\\input}' command is being processed.
Beware: For historic reasons, this code foolishly conserves a tiny bit
of string pool space; but that can confuse the interactive `\.E' option.
@^system dependencies@>
@p procedure start_input; {\TeX\ will \.{\\input} something}
label done;
begin scan_file_name; {set |cur_name| to desired file name}
if cur_ext="" then cur_ext:=".tex";
pack_cur_name;
loop@+ begin begin_file_reading; {set up |cur_file| and new level of input}
if a_open_in(cur_file) then goto done;
if cur_area="" then
begin pack_file_name(cur_name,TEX_area,cur_ext);
if a_open_in(cur_file) then goto done;
end;
end_file_reading; {remove the level that didn't work}
prompt_file_name("input file name",".tex");
end;
done: name:=a_make_name_string(cur_file);
if job_name=0 then
begin job_name:=cur_name; open_log_file;
end; {|open_log_file| doesn't |show_context|, so |limit|
and |loc| needn't be set to meaningful values yet}
if term_offset+length(name)>max_print_line-2 then print_ln
else if (term_offset>0)or(file_offset>0) then print_char(" ");
print_char("("); incr(open_parens); slow_print(name); update_terminal;
state:=new_line;
if name=str_ptr-1 then {conserve string pool space (but see note above)}
begin flush_string; name:=cur_name;
end;
@<Read the first line of the new file@>;
end;
@ Here we have to remember to tell the |input_ln| routine not to
start with a |get|. If the file is empty, it is considered to
contain a single blank line.
@^system dependencies@>
@^empty line at end of file@>
@<Read the first line...@>=
begin line:=1;
if input_ln(cur_file,false) then do_nothing;
firm_up_the_line;
if end_line_char_inactive then decr(limit)
else buffer[limit]:=end_line_char;
first:=limit+1; loc:=start;
end
@* \[30] Font metric data.
\TeX\ gets its knowledge about fonts from font metric files, also called
\.{TFM} files; the `\.T' in `\.{TFM}' stands for \TeX,
but other programs know about them too.
@:TFM files}{\.{TFM} files@>
@^font metric files@>
The information in a \.{TFM} file appears in a sequence of 8-bit bytes.
Since the number of bytes is always a multiple of 4, we could
also regard the file as a sequence of 32-bit words, but \TeX\ uses the
byte interpretation. The format of \.{TFM} files was designed by
Lyle Ramshaw in 1980. The intent is to convey a lot of different kinds
@^Ramshaw, Lyle Harold@>
of information in a compact but useful form.
@<Glob...@>=
@!tfm_file:byte_file;
@ The first 24 bytes (6 words) of a \.{TFM} file contain twelve 16-bit
integers that give the lengths of the various subsequent portions
of the file. These twelve integers are, in order:
$$\vbox{\halign{\hfil#&$\null=\null$#\hfil\cr
|lf|&length of the entire file, in words;\cr
|lh|&length of the header data, in words;\cr
|bc|&smallest character code in the font;\cr
|ec|&largest character code in the font;\cr
|nw|&number of words in the width table;\cr
|nh|&number of words in the height table;\cr
|nd|&number of words in the depth table;\cr
|ni|&number of words in the italic correction table;\cr
|nl|&number of words in the lig/kern table;\cr
|nk|&number of words in the kern table;\cr
|ne|&number of words in the extensible character table;\cr
|np|&number of font parameter words.\cr}}$$
They are all nonnegative and less than $2^{15}$. We must have |bc-1<=ec<=255|,
and
$$\hbox{|lf=6+lh+(ec-bc+1)+nw+nh+nd+ni+nl+nk+ne+np|.}$$
Note that a font may contain as many as 256 characters (if |bc=0| and |ec=255|),
and as few as 0 characters (if |bc=ec+1|).
Incidentally, when two or more 8-bit bytes are combined to form an integer of
16 or more bits, the most significant bytes appear first in the file.
This is called BigEndian order.
@!@^BigEndian order@>
@ The rest of the \.{TFM} file may be regarded as a sequence of ten data
arrays having the informal specification
$$\def\arr$[#1]#2${\&{array} $[#1]$ \&{of} #2}
\vbox{\halign{\hfil\\{#}&$\,:\,$\arr#\hfil\cr
header&|[0..lh-1]@t\\{stuff}@>|\cr
char\_info&|[bc..ec]char_info_word|\cr
width&|[0..nw-1]fix_word|\cr
height&|[0..nh-1]fix_word|\cr
depth&|[0..nd-1]fix_word|\cr
italic&|[0..ni-1]fix_word|\cr
lig\_kern&|[0..nl-1]lig_kern_command|\cr
kern&|[0..nk-1]fix_word|\cr
exten&|[0..ne-1]extensible_recipe|\cr
param&|[1..np]fix_word|\cr}}$$
The most important data type used here is a |@!fix_word|, which is
a 32-bit representation of a binary fraction. A |fix_word| is a signed
quantity, with the two's complement of the entire word used to represent
negation. Of the 32 bits in a |fix_word|, exactly 12 are to the left of the
binary point; thus, the largest |fix_word| value is $2048-2^{-20}$, and
the smallest is $-2048$. We will see below, however, that all but two of
the |fix_word| values must lie between $-16$ and $+16$.
@ The first data array is a block of header information, which contains
general facts about the font. The header must contain at least two words,
|header[0]| and |header[1]|, whose meaning is explained below.
Additional header information of use to other software routines might
also be included, but \TeX82 does not need to know about such details.
For example, 16 more words of header information are in use at the Xerox
Palo Alto Research Center; the first ten specify the character coding
scheme used (e.g., `\.{XEROX text}' or `\.{TeX math symbols}'), the next five
give the font identifier (e.g., `\.{HELVETICA}' or `\.{CMSY}'), and the
last gives the ``face byte.'' The program that converts \.{DVI} files
to Xerox printing format gets this information by looking at the \.{TFM}
file, which it needs to read anyway because of other information that
is not explicitly repeated in \.{DVI}~format.
\yskip\hang|header[0]| is a 32-bit check sum that \TeX\ will copy into
the \.{DVI} output file. Later on when the \.{DVI} file is printed,
possibly on another computer, the actual font that gets used is supposed
to have a check sum that agrees with the one in the \.{TFM} file used by
\TeX. In this way, users will be warned about potential incompatibilities.
(However, if the check sum is zero in either the font file or the \.{TFM}
file, no check is made.) The actual relation between this check sum and
the rest of the \.{TFM} file is not important; the check sum is simply an
identification number with the property that incompatible fonts almost
always have distinct check sums.
@^check sum@>
\yskip\hang|header[1]| is a |fix_word| containing the design size of
the font, in units of \TeX\ points. This number must be at least 1.0; it is
fairly arbitrary, but usually the design size is 10.0 for a ``10 point''
font, i.e., a font that was designed to look best at a 10-point size,
whatever that really means. When a \TeX\ user asks for a font
`\.{at} $\delta$ \.{pt}', the effect is to override the design size
and replace it by $\delta$, and to multiply the $x$ and~$y$ coordinates
of the points in the font image by a factor of $\delta$ divided by the
design size. {\sl All other dimensions in the\/ \.{TFM} file are
|fix_word|\kern-1pt\ numbers in design-size units}, with the exception of
|param[1]| (which denotes the slant ratio). Thus, for example, the value
of |param[6]|, which defines the \.{em} unit, is often the |fix_word| value
$2^{20}=1.0$, since many fonts have a design size equal to one em.
The other dimensions must be less than 16 design-size units in absolute
value; thus, |header[1]| and |param[1]| are the only |fix_word|
entries in the whole \.{TFM} file whose first byte might be something
besides 0 or 255.
@ Next comes the |char_info| array, which contains one |@!char_info_word|
per character. Each word in this part of the file contains six fields
packed into four bytes as follows.
\yskip\hang first byte: |@!width_index| (8 bits)\par
\hang second byte: |@!height_index| (4 bits) times 16, plus |@!depth_index|
(4~bits)\par
\hang third byte: |@!italic_index| (6 bits) times 4, plus |@!tag|
(2~bits)\par
\hang fourth byte: |@!remainder| (8 bits)\par
\yskip\noindent
The actual width of a character is \\{width}|[width_index]|, in design-size
units; this is a device for compressing information, since many characters
have the same width. Since it is quite common for many characters
to have the same height, depth, or italic correction, the \.{TFM} format
imposes a limit of 16 different heights, 16 different depths, and
64 different italic corrections.
@!@^italic correction@>
The italic correction of a character has two different uses.
(a)~In ordinary text, the italic correction is added to the width only if
the \TeX\ user specifies `\.{\\/}' after the character.
(b)~In math formulas, the italic correction is always added to the width,
except with respect to the positioning of subscripts.
Incidentally, the relation $\\{width}[0]=\\{height}[0]=\\{depth}[0]=
\\{italic}[0]=0$ should always hold, so that an index of zero implies a
value of zero. The |width_index| should never be zero unless the
character does not exist in the font, since a character is valid if and
only if it lies between |bc| and |ec| and has a nonzero |width_index|.
@ The |tag| field in a |char_info_word| has four values that explain how to
interpret the |remainder| field.
\yskip\hangg|tag=0| (|no_tag|) means that |remainder| is unused.\par
\hangg|tag=1| (|lig_tag|) means that this character has a ligature/kerning
program starting at position |remainder| in the |lig_kern| array.\par
\hangg|tag=2| (|list_tag|) means that this character is part of a chain of
characters of ascending sizes, and not the largest in the chain. The
|remainder| field gives the character code of the next larger character.\par
\hangg|tag=3| (|ext_tag|) means that this character code represents an
extensible character, i.e., a character that is built up of smaller pieces
so that it can be made arbitrarily large. The pieces are specified in
|@!exten[remainder]|.\par
\yskip\noindent
Characters with |tag=2| and |tag=3| are treated as characters with |tag=0|
unless they are used in special circumstances in math formulas. For example,
the \.{\\sum} operation looks for a |list_tag|, and the \.{\\left}
operation looks for both |list_tag| and |ext_tag|.
@d no_tag=0 {vanilla character}
@d lig_tag=1 {character has a ligature/kerning program}
@d list_tag=2 {character has a successor in a charlist}
@d ext_tag=3 {character is extensible}
@ The |lig_kern| array contains instructions in a simple programming language
that explains what to do for special letter pairs. Each word in this array is a
|@!lig_kern_command| of four bytes.
\yskip\hang first byte: |skip_byte|, indicates that this is the final program
step if the byte is 128 or more, otherwise the next step is obtained by
skipping this number of intervening steps.\par
\hang second byte: |next_char|, ``if |next_char| follows the current character,
then perform the operation and stop, otherwise continue.''\par
\hang third byte: |op_byte|, indicates a ligature step if less than~128,
a kern step otherwise.\par
\hang fourth byte: |remainder|.\par
\yskip\noindent
In a kern step, an
additional space equal to |kern[256*(op_byte-128)+remainder]| is inserted
between the current character and |next_char|. This amount is
often negative, so that the characters are brought closer together
by kerning; but it might be positive.
There are eight kinds of ligature steps, having |op_byte| codes $4a+2b+c$ where
$0\le a\le b+c$ and $0\le b,c\le1$. The character whose code is
|remainder| is inserted between the current character and |next_char|;
then the current character is deleted if $b=0$, and |next_char| is
deleted if $c=0$; then we pass over $a$~characters to reach the next
current character (which may have a ligature/kerning program of its own).
If the very first instruction of the |lig_kern| array has |skip_byte=255|,
the |next_char| byte is the so-called boundary character of this font;
the value of |next_char| need not lie between |bc| and~|ec|.
If the very last instruction of the |lig_kern| array has |skip_byte=255|,
there is a special ligature/kerning program for a boundary character at the
left, beginning at location |256*op_byte+remainder|.
The interpretation is that \TeX\ puts implicit boundary characters
before and after each consecutive string of characters from the same font.
These implicit characters do not appear in the output, but they can affect
ligatures and kerning.
If the very first instruction of a character's |lig_kern| program has
|skip_byte>128|, the program actually begins in location
|256*op_byte+remainder|. This feature allows access to large |lig_kern|
arrays, because the first instruction must otherwise
appear in a location |<=255|.
Any instruction with |skip_byte>128| in the |lig_kern| array must satisfy
the condition
$$\hbox{|256*op_byte+remainder<nl|.}$$
If such an instruction is encountered during
normal program execution, it denotes an unconditional halt; no ligature
or kerning command is performed.
@d stop_flag==qi(128) {value indicating `\.{STOP}' in a lig/kern program}
@d kern_flag==qi(128) {op code for a kern step}
@d skip_byte(#)==#.b0
@d next_char(#)==#.b1
@d op_byte(#)==#.b2
@d rem_byte(#)==#.b3
@ Extensible characters are specified by an |@!extensible_recipe|, which
consists of four bytes called |@!top|, |@!mid|, |@!bot|, and |@!rep| (in this
order). These bytes are the character codes of individual pieces used to
build up a large symbol. If |top|, |mid|, or |bot| are zero, they are not
present in the built-up result. For example, an extensible vertical line is
like an extensible bracket, except that the top and bottom pieces are missing.
Let $T$, $M$, $B$, and $R$ denote the respective pieces, or an empty box
if the piece isn't present. Then the extensible characters have the form
$TR^kMR^kB$ from top to bottom, for some |k>=0|, unless $M$ is absent;
in the latter case we can have $TR^kB$ for both even and odd values of~|k|.
The width of the extensible character is the width of $R$; and the
height-plus-depth is the sum of the individual height-plus-depths of the
components used, since the pieces are butted together in a vertical list.
@d ext_top(#)==#.b0 {|top| piece in a recipe}
@d ext_mid(#)==#.b1 {|mid| piece in a recipe}
@d ext_bot(#)==#.b2 {|bot| piece in a recipe}
@d ext_rep(#)==#.b3 {|rep| piece in a recipe}
@ The final portion of a \.{TFM} file is the |param| array, which is another
sequence of |fix_word| values.
\yskip\hang|param[1]=slant| is the amount of italic slant, which is used
to help position accents. For example, |slant=.25| means that when you go
up one unit, you also go .25 units to the right. The |slant| is a pure
number; it's the only |fix_word| other than the design size itself that is
not scaled by the design size.
\hang|param[2]=space| is the normal spacing between words in text.
Note that character |" "| in the font need not have anything to do with
blank spaces.
\hang|param[3]=space_stretch| is the amount of glue stretching between words.
\hang|param[4]=space_shrink| is the amount of glue shrinking between words.
\hang|param[5]=x_height| is the size of one ex in the font; it is also
the height of letters for which accents don't have to be raised or lowered.
\hang|param[6]=quad| is the size of one em in the font.
\hang|param[7]=extra_space| is the amount added to |param[2]| at the
ends of sentences.
\yskip\noindent
If fewer than seven parameters are present, \TeX\ sets the missing parameters
to zero. Fonts used for math symbols are required to have
additional parameter information, which is explained later.
@d slant_code=1
@d space_code=2
@d space_stretch_code=3
@d space_shrink_code=4
@d x_height_code=5
@d quad_code=6
@d extra_space_code=7
@ So that is what \.{TFM} files hold. Since \TeX\ has to absorb such information
about lots of fonts, it stores most of the data in a large array called
|font_info|. Each item of |font_info| is a |memory_word|; the |fix_word|
data gets converted into |scaled| entries, while everything else goes into
words of type |four_quarters|.
When the user defines \.{\\font\\f}, say, \TeX\ assigns an internal number
to the user's font~\.{\\f}. Adding this number to |font_id_base| gives the
|eqtb| location of a ``frozen'' control sequence that will always select
the font.
@<Types...@>=
@!internal_font_number=font_base..font_max; {|font| in a |char_node|}
@!font_index=0..font_mem_size; {index into |font_info|}
@ Here now is the (rather formidable) array of font arrays.
@d non_char==qi(256) {a |halfword| code that can't match a real character}
@d non_address=0 {a spurious |bchar_label|}
@<Glob...@>=
@!font_info:array[font_index] of memory_word;
{the big collection of font data}
@!fmem_ptr:font_index; {first unused word of |font_info|}
@!font_ptr:internal_font_number; {largest internal font number in use}
@!font_check:array[internal_font_number] of four_quarters; {check sum}
@!font_size:array[internal_font_number] of scaled; {``at'' size}
@!font_dsize:array[internal_font_number] of scaled; {``design'' size}
@!font_params:array[internal_font_number] of font_index; {how many font
parameters are present}
@!font_name:array[internal_font_number] of str_number; {name of the font}
@!font_area:array[internal_font_number] of str_number; {area of the font}
@!font_bc:array[internal_font_number] of eight_bits;
{beginning (smallest) character code}
@!font_ec:array[internal_font_number] of eight_bits;
{ending (largest) character code}
@!font_glue:array[internal_font_number] of pointer;
{glue specification for interword space, |null| if not allocated}
@!font_used:array[internal_font_number] of boolean;
{has a character from this font actually appeared in the output?}
@!hyphen_char:array[internal_font_number] of integer;
{current \.{\\hyphenchar} values}
@!skew_char:array[internal_font_number] of integer;
{current \.{\\skewchar} values}
@!bchar_label:array[internal_font_number] of font_index;
{start of |lig_kern| program for left boundary character,
|non_address| if there is none}
@!font_bchar:array[internal_font_number] of min_quarterword..non_char;
{boundary character, |non_char| if there is none}
@!font_false_bchar:array[internal_font_number] of min_quarterword..non_char;
{|font_bchar| if it doesn't exist in the font, otherwise |non_char|}
@ Besides the arrays just enumerated, we have directory arrays that make it
easy to get at the individual entries in |font_info|. For example, the
|char_info| data for character |c| in font |f| will be in
|font_info[char_base[f]+c].qqqq|; and if |w| is the |width_index|
part of this word (the |b0| field), the width of the character is
|font_info[width_base[f]+w].sc|. (These formulas assume that
|min_quarterword| has already been added to |c| and to |w|, since \TeX\
stores its quarterwords that way.)
@<Glob...@>=
@!char_base:array[internal_font_number] of integer;
{base addresses for |char_info|}
@!width_base:array[internal_font_number] of integer;
{base addresses for widths}
@!height_base:array[internal_font_number] of integer;
{base addresses for heights}
@!depth_base:array[internal_font_number] of integer;
{base addresses for depths}
@!italic_base:array[internal_font_number] of integer;
{base addresses for italic corrections}
@!lig_kern_base:array[internal_font_number] of integer;
{base addresses for ligature/kerning programs}
@!kern_base:array[internal_font_number] of integer;
{base addresses for kerns}
@!exten_base:array[internal_font_number] of integer;
{base addresses for extensible recipes}
@!param_base:array[internal_font_number] of integer;
{base addresses for font parameters}
@ @<Set init...@>=
for k:=font_base to font_max do font_used[k]:=false;
@ \TeX\ always knows at least one font, namely the null font. It has no
characters, and its seven parameters are all equal to zero.
@<Initialize table...@>=
font_ptr:=null_font; fmem_ptr:=7;
font_name[null_font]:="nullfont"; font_area[null_font]:="";
hyphen_char[null_font]:="-"; skew_char[null_font]:=-1;
bchar_label[null_font]:=non_address;
font_bchar[null_font]:=non_char; font_false_bchar[null_font]:=non_char;
font_bc[null_font]:=1; font_ec[null_font]:=0;
font_size[null_font]:=0; font_dsize[null_font]:=0;
char_base[null_font]:=0; width_base[null_font]:=0;
height_base[null_font]:=0; depth_base[null_font]:=0;
italic_base[null_font]:=0; lig_kern_base[null_font]:=0;
kern_base[null_font]:=0; exten_base[null_font]:=0;
font_glue[null_font]:=null; font_params[null_font]:=7;
param_base[null_font]:=-1;
for k:=0 to 6 do font_info[k].sc:=0;
@ @<Put each...@>=
primitive("nullfont",set_font,null_font);
@!@:null_font_}{\.{\\nullfont} primitive@>
text(frozen_null_font):="nullfont"; eqtb[frozen_null_font]:=eqtb[cur_val];
@ Of course we want to define macros that suppress the detail of how font
information is actually packed, so that we don't have to write things like
$$\hbox{|font_info[width_base[f]+font_info[char_base[f]+c].qqqq.b0].sc|}$$
too often. The \.{WEB} definitions here make |char_info(f)(c)| the
|four_quarters| word of font information corresponding to character
|c| of font |f|. If |q| is such a word, |char_width(f)(q)| will be
the character's width; hence the long formula above is at least
abbreviated to
$$\hbox{|char_width(f)(char_info(f)(c))|.}$$
Usually, of course, we will fetch |q| first and look at several of its
fields at the same time.
The italic correction of a character will be denoted by
|char_italic(f)(q)|, so it is analogous to |char_width|. But we will get
at the height and depth in a slightly different way, since we usually want
to compute both height and depth if we want either one. The value of
|height_depth(q)| will be the 8-bit quantity
$$b=|height_index|\times16+|depth_index|,$$ and if |b| is such a byte we
will write |char_height(f)(b)| and |char_depth(f)(b)| for the height and
depth of the character |c| for which |q=char_info(f)(c)|. Got that?
The tag field will be called |char_tag(q)|; the remainder byte will be
called |rem_byte(q)|, using a macro that we have already defined above.
Access to a character's |width|, |height|, |depth|, and |tag| fields is
part of \TeX's inner loop, so we want these macros to produce code that is
as fast as possible under the circumstances.
@^inner loop@>
@d char_info_end(#)==#].qqqq
@d char_info(#)==font_info[char_base[#]+char_info_end
@d char_width_end(#)==#.b0].sc
@d char_width(#)==font_info[width_base[#]+char_width_end
@d char_exists(#)==(#.b0>min_quarterword)
@d char_italic_end(#)==(qo(#.b2)) div 4].sc
@d char_italic(#)==font_info[italic_base[#]+char_italic_end
@d height_depth(#)==qo(#.b1)
@d char_height_end(#)==(#) div 16].sc
@d char_height(#)==font_info[height_base[#]+char_height_end
@d char_depth_end(#)==(#) mod 16].sc
@d char_depth(#)==font_info[depth_base[#]+char_depth_end
@d char_tag(#)==((qo(#.b2)) mod 4)
@ The global variable |null_character| is set up to be a word of
|char_info| for a character that doesn't exist. Such a word provides a
convenient way to deal with erroneous situations.
@<Glob...@>=
@!null_character:four_quarters; {nonexistent character information}
@ @<Set init...@>=
null_character.b0:=min_quarterword; null_character.b1:=min_quarterword;
null_character.b2:=min_quarterword; null_character.b3:=min_quarterword;
@ Here are some macros that help process ligatures and kerns.
We write |char_kern(f)(j)| to find the amount of kerning specified by
kerning command~|j| in font~|f|. If |j| is the |char_info| for a character
with a ligature/kern program, the first instruction of that program is either
|i=font_info[lig_kern_start(f)(j)]| or |font_info[lig_kern_restart(f)(i)]|,
depending on whether or not |skip_byte(i)<=stop_flag|.
The constant |kern_base_offset| should be simplified, for \PASCAL\ compilers
that do not do local optimization.
@^system dependencies@>
@d char_kern_end(#)==256*op_byte(#)+rem_byte(#)].sc
@d char_kern(#)==font_info[kern_base[#]+char_kern_end
@d kern_base_offset==256*(128+min_quarterword)
@d lig_kern_start(#)==lig_kern_base[#]+rem_byte {beginning of lig/kern program}
@d lig_kern_restart_end(#)==256*op_byte(#)+rem_byte(#)+32768-kern_base_offset
@d lig_kern_restart(#)==lig_kern_base[#]+lig_kern_restart_end
@ Font parameters are referred to as |slant(f)|, |space(f)|, etc.
@d param_end(#)==param_base[#]].sc
@d param(#)==font_info[#+param_end
@d slant==param(slant_code) {slant to the right, per unit distance upward}
@d space==param(space_code) {normal space between words}
@d space_stretch==param(space_stretch_code) {stretch between words}
@d space_shrink==param(space_shrink_code) {shrink between words}
@d x_height==param(x_height_code) {one ex}
@d quad==param(quad_code) {one em}
@d extra_space==param(extra_space_code) {additional space at end of sentence}
@<The em width for |cur_font|@>=quad(cur_font)
@ @<The x-height for |cur_font|@>=x_height(cur_font)
@ \TeX\ checks the information of a \.{TFM} file for validity as the
file is being read in, so that no further checks will be needed when
typesetting is going on. The somewhat tedious subroutine that does this
is called |read_font_info|. It has four parameters: the user font
identifier~|u|, the file name and area strings |nom| and |aire|, and the
``at'' size~|s|. If |s|~is negative, it's the negative of a scale factor
to be applied to the design size; |s=-1000| is the normal case.
Otherwise |s| will be substituted for the design size; in this
case, |s| must be positive and less than $2048\rm\,pt$
(i.e., it must be less than $2^{27}$ when considered as an integer).
The subroutine opens and closes a global file variable called |tfm_file|.
It returns the value of the internal font number that was just loaded.
If an error is detected, an error message is issued and no font
information is stored; |null_font| is returned in this case.
@d bad_tfm=11 {label for |read_font_info|}
@d abort==goto bad_tfm {do this when the \.{TFM} data is wrong}
@p function read_font_info(@!u:pointer;@!nom,@!aire:str_number;
@!s:scaled):internal_font_number; {input a \.{TFM} file}
label done,bad_tfm,not_found;
var k:font_index; {index into |font_info|}
@!file_opened:boolean; {was |tfm_file| successfully opened?}
@!lf,@!lh,@!bc,@!ec,@!nw,@!nh,@!nd,@!ni,@!nl,@!nk,@!ne,@!np:halfword;
{sizes of subfiles}
@!f:internal_font_number; {the new font's number}
@!g:internal_font_number; {the number to return}
@!a,@!b,@!c,@!d:eight_bits; {byte variables}
@!qw:four_quarters;@!sw:scaled; {accumulators}
@!bch_label:integer; {left boundary start location, or infinity}
@!bchar:0..256; {boundary character, or 256}
@!z:scaled; {the design size or the ``at'' size}
@!alpha:integer;@!beta:1..16;
{auxiliary quantities used in fixed-point multiplication}
begin g:=null_font;@/
@<Read and check the font data; |abort| if the \.{TFM} file is
malformed; if there's no room for this font, say so and |goto
done|; otherwise |incr(font_ptr)| and |goto done|@>;
bad_tfm: @<Report that the font won't be loaded@>;
done: if file_opened then b_close(tfm_file);
read_font_info:=g;
end;
@ There are programs called \.{TFtoPL} and \.{PLtoTF} that convert
between the \.{TFM} format and a symbolic property-list format
that can be easily edited. These programs contain extensive
diagnostic information, so \TeX\ does not have to bother giving
precise details about why it rejects a particular \.{TFM} file.
@.TFtoPL@> @.PLtoTF@>
@d start_font_error_message==print_err("Font "); sprint_cs(u);
print_char("="); print_file_name(nom,aire,"");
if s>=0 then
begin print(" at "); print_scaled(s); print("pt");
end
else if s<>-1000 then
begin print(" scaled "); print_int(-s);
end
@<Report that the font won't be loaded@>=
start_font_error_message;
@.Font x=xx not loadable...@>
if file_opened then print(" not loadable: Bad metric (TFM) file")
else print(" not loadable: Metric (TFM) file not found");
help5("I wasn't able to read the size data for this font,")@/
("so I will ignore the font specification.")@/
("[Wizards can fix TFM files using TFtoPL/PLtoTF.]")@/
("You might try inserting a different font spec;")@/
("e.g., type `I\font<same font id>=<substitute font name>'.");
error
@ @<Read and check...@>=
@<Open |tfm_file| for input@>;
@<Read the {\.{TFM}} size fields@>;
@<Use size fields to allocate font information@>;
@<Read the {\.{TFM}} header@>;
@<Read character data@>;
@<Read box dimensions@>;
@<Read ligature/kern program@>;
@<Read extensible character recipes@>;
@<Read font parameters@>;
@<Make final adjustments and |goto done|@>
@ @<Open |tfm_file| for input@>=
file_opened:=false;
if aire="" then pack_file_name(nom,TEX_font_area,".tfm")
else pack_file_name(nom,aire,".tfm");
if not b_open_in(tfm_file) then abort;
file_opened:=true
@ Note: A malformed \.{TFM} file might be shorter than it claims to be;
thus |eof(tfm_file)| might be true when |read_font_info| refers to
|tfm_file^| or when it says |get(tfm_file)|. If such circumstances
cause system error messages, you will have to defeat them somehow,
for example by defining |fget| to be `\ignorespaces|begin get(tfm_file);|
|if eof(tfm_file) then abort; end|\unskip'.
@^system dependencies@>
@d fget==get(tfm_file)
@d fbyte==tfm_file^
@d read_sixteen(#)==begin #:=fbyte;
if #>127 then abort;
fget; #:=#*@'400+fbyte;
end
@d store_four_quarters(#)==begin fget; a:=fbyte; qw.b0:=qi(a);
fget; b:=fbyte; qw.b1:=qi(b);
fget; c:=fbyte; qw.b2:=qi(c);
fget; d:=fbyte; qw.b3:=qi(d);
#:=qw;
end
@ @<Read the {\.{TFM}} size fields@>=
begin read_sixteen(lf);
fget; read_sixteen(lh);
fget; read_sixteen(bc);
fget; read_sixteen(ec);
if (bc>ec+1)or(ec>255) then abort;
if bc>255 then {|bc=256| and |ec=255|}
begin bc:=1; ec:=0;
end;
fget; read_sixteen(nw);
fget; read_sixteen(nh);
fget; read_sixteen(nd);
fget; read_sixteen(ni);
fget; read_sixteen(nl);
fget; read_sixteen(nk);
fget; read_sixteen(ne);
fget; read_sixteen(np);
if lf<>6+lh+(ec-bc+1)+nw+nh+nd+ni+nl+nk+ne+np then abort;
if (nw=0)or(nh=0)or(nd=0)or(ni=0) then abort;
end
@ The preliminary settings of the index-offset variables |char_base|,
|width_base|, |lig_kern_base|, |kern_base|, and |exten_base| will be
corrected later by subtracting |min_quarterword| from them; and we will
subtract 1 from |param_base| too. It's best to forget about such anomalies
until later.
@<Use size fields to allocate font information@>=
lf:=lf-6-lh; {|lf| words should be loaded into |font_info|}
if np<7 then lf:=lf+7-np; {at least seven parameters will appear}
if (font_ptr=font_max)or(fmem_ptr+lf>font_mem_size) then
@<Apologize for not loading the font, |goto done|@>;
f:=font_ptr+1;
char_base[f]:=fmem_ptr-bc;
width_base[f]:=char_base[f]+ec+1;
height_base[f]:=width_base[f]+nw;
depth_base[f]:=height_base[f]+nh;
italic_base[f]:=depth_base[f]+nd;
lig_kern_base[f]:=italic_base[f]+ni;
kern_base[f]:=lig_kern_base[f]+nl-kern_base_offset;
exten_base[f]:=kern_base[f]+kern_base_offset+nk;
param_base[f]:=exten_base[f]+ne
@ @<Apologize for not loading...@>=
begin start_font_error_message;
print(" not loaded: Not enough room left");
@.Font x=xx not loaded...@>
help4("I'm afraid I won't be able to make use of this font,")@/
("because my memory for character-size data is too small.")@/
("If you're really stuck, ask a wizard to enlarge me.")@/
("Or maybe try `I\font<same font id>=<name of loaded font>'.");
error; goto done;
end
@ Only the first two words of the header are needed by \TeX82.
@<Read the {\.{TFM}} header@>=
begin if lh<2 then abort;
store_four_quarters(font_check[f]);
fget; read_sixteen(z); {this rejects a negative design size}
fget; z:=z*@'400+fbyte; fget; z:=(z*@'20)+(fbyte div@'20);
if z<unity then abort;
while lh>2 do
begin fget;fget;fget;fget;decr(lh); {ignore the rest of the header}
end;
font_dsize[f]:=z;
if s<>-1000 then
if s>=0 then z:=s
else z:=xn_over_d(z,-s,1000);
font_size[f]:=z;
end
@ @<Read character data@>=
for k:=fmem_ptr to width_base[f]-1 do
begin store_four_quarters(font_info[k].qqqq);
if (a>=nw)or(b div @'20>=nh)or(b mod @'20>=nd)or
(c div 4>=ni) then abort;
case c mod 4 of
lig_tag: if d>=nl then abort;
ext_tag: if d>=ne then abort;
list_tag: @<Check for charlist cycle@>;
othercases do_nothing {|no_tag|}
endcases;
end
@ We want to make sure that there is no cycle of characters linked together
by |list_tag| entries, since such a cycle would get \TeX\ into an endless
loop. If such a cycle exists, the routine here detects it when processing
the largest character code in the cycle.
@d check_byte_range(#)==begin if (#<bc)or(#>ec) then abort@+end
@d current_character_being_worked_on==k+bc-fmem_ptr
@<Check for charlist cycle@>=
begin check_byte_range(d);
while d<current_character_being_worked_on do
begin qw:=char_info(f)(d);
{N.B.: not |qi(d)|, since |char_base[f]| hasn't been adjusted yet}
if char_tag(qw)<>list_tag then goto not_found;
d:=qo(rem_byte(qw)); {next character on the list}
end;
if d=current_character_being_worked_on then abort; {yes, there's a cycle}
not_found:end
@ A |fix_word| whose four bytes are $(a,b,c,d)$ from left to right represents
the number
$$x=\left\{\vcenter{\halign{$#$,\hfil\qquad&if $#$\hfil\cr
b\cdot2^{-4}+c\cdot2^{-12}+d\cdot2^{-20}&a=0;\cr
-16+b\cdot2^{-4}+c\cdot2^{-12}+d\cdot2^{-20}&a=255.\cr}}\right.$$
(No other choices of |a| are allowed, since the magnitude of a number in
design-size units must be less than 16.) We want to multiply this
quantity by the integer~|z|, which is known to be less than $2^{27}$.
If $|z|<2^{23}$, the individual multiplications $b\cdot z$,
$c\cdot z$, $d\cdot z$ cannot overflow; otherwise we will divide |z| by 2,
4, 8, or 16, to obtain a multiplier less than $2^{23}$, and we can
compensate for this later. If |z| has thereby been replaced by
$|z|^\prime=|z|/2^e$, let $\beta=2^{4-e}$; we shall compute
$$\lfloor(b+c\cdot2^{-8}+d\cdot2^{-16})\,z^\prime/\beta\rfloor$$
if $a=0$, or the same quantity minus $\alpha=2^{4+e}z^\prime$ if $a=255$.
This calculation must be done exactly, in order to guarantee portability
of \TeX\ between computers.
@d store_scaled(#)==begin fget; a:=fbyte; fget; b:=fbyte;
fget; c:=fbyte; fget; d:=fbyte;@/
sw:=(((((d*z)div@'400)+(c*z))div@'400)+(b*z))div beta;
if a=0 then #:=sw@+else if a=255 then #:=sw-alpha@+else abort;
end
@p function store_scaled_f(sq, z: scaled): scaled;
var a,b,c,d:eight_bits; sw:scaled;
alpha:integer;
beta:1..16;
begin
alpha:=16;
if z>=@'1000000000 then pdf_error("font", "size is too large");
while z>=@'40000000 do
begin z:=z div 2; alpha:=alpha+alpha;
end;
beta:=256 div alpha; alpha:=alpha*z;
if sq >= 0 then begin
d:=sq mod 256; sq:=sq div 256; {any "mod 256" not really needed, would typecast alone be safe?}
c:=sq mod 256; sq:=sq div 256;
b:=sq mod 256; sq:=sq div 256;
a:=sq mod 256;
end else begin
sq:=(sq+1073741824)+1073741824; {braces for optimizing compiler}
d:=sq mod 256; sq:=sq div 256;
c:=sq mod 256; sq:=sq div 256;
b:=sq mod 256; sq:=sq div 256;
a:=(sq+128) mod 256;
end;
sw:=(((((d*z)div@'400)+(c*z))div@'400)+(b*z))div beta;
if a=0 then store_scaled_f:=sw@+else if a=255 then store_scaled_f:=sw-alpha@+else pdf_error("store_scaled_f", "vf scaling");
end;
@ @<Read box dimensions@>=
begin @<Replace |z| by $|z|^\prime$ and compute $\alpha,\beta$@>;
for k:=width_base[f] to lig_kern_base[f]-1 do
store_scaled(font_info[k].sc);
if font_info[width_base[f]].sc<>0 then abort; {\\{width}[0] must be zero}
if font_info[height_base[f]].sc<>0 then abort; {\\{height}[0] must be zero}
if font_info[depth_base[f]].sc<>0 then abort; {\\{depth}[0] must be zero}
if font_info[italic_base[f]].sc<>0 then abort; {\\{italic}[0] must be zero}
end
@ @<Replace |z|...@>=
begin alpha:=16;
if z>=@'1000000000 then pdf_error("font", "size is too large");
while z>=@'40000000 do
begin z:=z div 2; alpha:=alpha+alpha;
end;
beta:=256 div alpha; alpha:=alpha*z;
end
@ @d check_existence(#)==@t@>@;@/
begin check_byte_range(#);
qw:=char_info(f)(#); {N.B.: not |qi(#)|}
if not char_exists(qw) then abort;
end
@<Read ligature/kern program@>=
bch_label:=@'77777; bchar:=256;
if nl>0 then
begin for k:=lig_kern_base[f] to kern_base[f]+kern_base_offset-1 do
begin store_four_quarters(font_info[k].qqqq);
if a>128 then
begin if 256*c+d>=nl then abort;
if a=255 then if k=lig_kern_base[f] then bchar:=b;
end
else begin if b<>bchar then check_existence(b);
if c<128 then check_existence(d) {check ligature}
else if 256*(c-128)+d>=nk then abort; {check kern}
if a<128 then if k-lig_kern_base[f]+a+1>=nl then abort;
end;
end;
if a=255 then bch_label:=256*c+d;
end;
for k:=kern_base[f]+kern_base_offset to exten_base[f]-1 do
store_scaled(font_info[k].sc);
@ @<Read extensible character recipes@>=
for k:=exten_base[f] to param_base[f]-1 do
begin store_four_quarters(font_info[k].qqqq);
if a<>0 then check_existence(a);
if b<>0 then check_existence(b);
if c<>0 then check_existence(c);
check_existence(d);
end
@ We check to see that the \.{TFM} file doesn't end prematurely; but
no error message is given for files having more than |lf| words.
@<Read font parameters@>=
begin for k:=1 to np do
if k=1 then {the |slant| parameter is a pure number}
begin fget; sw:=fbyte; if sw>127 then sw:=sw-256;
fget; sw:=sw*@'400+fbyte; fget; sw:=sw*@'400+fbyte;
fget; font_info[param_base[f]].sc:=
(sw*@'20)+(fbyte div@'20);
end
else store_scaled(font_info[param_base[f]+k-1].sc);
if eof(tfm_file) then abort;
for k:=np+1 to 7 do font_info[param_base[f]+k-1].sc:=0;
end
@ Now to wrap it up, we have checked all the necessary things about the \.{TFM}
file, and all we need to do is put the finishing touches on the data for
the new font.
@d adjust(#)==#[f]:=qo(#[f])
{correct for the excess |min_quarterword| that was added}
@<Make final adjustments...@>=
if np>=7 then font_params[f]:=np@+else font_params[f]:=7;
hyphen_char[f]:=default_hyphen_char; skew_char[f]:=default_skew_char;
if bch_label<nl then bchar_label[f]:=bch_label+lig_kern_base[f]
else bchar_label[f]:=non_address;
font_bchar[f]:=qi(bchar);
font_false_bchar[f]:=qi(bchar);
if bchar<=ec then if bchar>=bc then
begin qw:=char_info(f)(bchar); {N.B.: not |qi(bchar)|}
if char_exists(qw) then font_false_bchar[f]:=non_char;
end;
font_name[f]:=nom;
font_area[f]:=aire;
font_bc[f]:=bc; font_ec[f]:=ec; font_glue[f]:=null;
adjust(char_base); adjust(width_base); adjust(lig_kern_base);
adjust(kern_base); adjust(exten_base);
decr(param_base[f]);
fmem_ptr:=fmem_ptr+lf; font_ptr:=f; g:=f; goto done
@ Before we forget about the format of these tables, let's deal with two
of \TeX's basic scanning routines related to font information.
@<Declare procedures that scan font-related stuff@>=
function test_no_ligatures(f: internal_font_number): integer;
label exit;
var c:integer;
begin
test_no_ligatures:= 1;
for c := font_bc[f] to font_ec[f] do
if char_exists(orig_char_info(f)(c)) then
if odd(char_tag(orig_char_info(f)(c))) then begin
test_no_ligatures:= 0;
return;
end;
exit:
end;
function get_tag_code(f: internal_font_number; c: eight_bits): integer;
var i:small_number;
begin
if is_valid_char(c) then
begin i := char_tag(char_info(f)(c));
if i = lig_tag then
get_tag_code := 1
else if i = list_tag then
get_tag_code := 2
else if i = ext_tag then
get_tag_code := 4
else
get_tag_code := 0;
end
else
get_tag_code := -1;
end;
procedure scan_font_ident;
var f:internal_font_number;
@!m:halfword;
begin @<Get the next non-blank non-call...@>;
if (cur_cmd=def_font) or (cur_cmd=letterspace_font) or (cur_cmd=pdf_copy_font) then f:=cur_font
else if cur_cmd=set_font then f:=cur_chr
else if cur_cmd=def_family then
begin m:=cur_chr; scan_four_bit_int; f:=equiv(m+cur_val);
end
else begin print_err("Missing font identifier");
@.Missing font identifier@>
help2("I was looking for a control sequence whose")@/
("current meaning has been defined by \font.");
back_error; f:=null_font;
end;
cur_val:=f;
end;
@ The following routine is used to implement `\.{\\fontdimen} |n| |f|'.
The boolean parameter |writing| is set |true| if the calling program
intends to change the parameter value.
@<Declare procedures that scan font-related stuff@>=
procedure find_font_dimen(@!writing:boolean);
{sets |cur_val| to |font_info| location}
var f:internal_font_number;
@!n:integer; {the parameter number}
begin scan_int; n:=cur_val; scan_font_ident; f:=cur_val;
if n<=0 then cur_val:=fmem_ptr
else begin if writing and(n<=space_shrink_code)and@|
(n>=space_code)and(font_glue[f]<>null) then
begin delete_glue_ref(font_glue[f]);
font_glue[f]:=null;
end;
if n>font_params[f] then
if f<font_ptr then cur_val:=fmem_ptr
else @<Increase the number of parameters in the last font@>
else cur_val:=n+param_base[f];
end;
@<Issue an error message if |cur_val=fmem_ptr|@>;
end;
@ @<Issue an error message if |cur_val=fmem_ptr|@>=
if cur_val=fmem_ptr then
begin print_err("Font "); print_esc(font_id_text(f));
print(" has only "); print_int(font_params[f]);
print(" fontdimen parameters");
@.Font x has only...@>
help2("To increase the number of font parameters, you must")@/
("use \fontdimen immediately after the \font is loaded.");
error;
end
@ @<Increase the number of parameters...@>=
begin repeat if fmem_ptr=font_mem_size then
overflow("font memory",font_mem_size);
@:TeX capacity exceeded font memory}{\quad font memory@>
font_info[fmem_ptr].sc:=0; incr(fmem_ptr); incr(font_params[f]);
until n=font_params[f];
cur_val:=fmem_ptr-1; {this equals |param_base[f]+font_params[f]|}
end
@ When \TeX\ wants to typeset a character that doesn't exist, the
character node is not created; thus the output routine can assume
that characters exist when it sees them. The following procedure
prints a warning message unless the user has suppressed it.
@p procedure char_warning(@!f:internal_font_number;@!c:eight_bits);
var old_setting: integer; {saved value of |tracing_online|}
begin if tracing_lost_chars>0 then
begin old_setting:=tracing_online;
if eTeX_ex and(tracing_lost_chars>1) then tracing_online:=1;
begin begin_diagnostic;
print_nl("Missing character: There is no ");
@.Missing character@>
print_ASCII(c); print(" in font ");
slow_print(font_name[f]); print_char("!"); end_diagnostic(false);
end;
tracing_online:=old_setting;
end;
end;
@ Here is a function that returns a pointer to a character node for a
given character in a given font. If that character doesn't exist,
|null| is returned instead.
@p function new_character(@!f:internal_font_number;@!c:eight_bits):pointer;
label exit;
var p:pointer; {newly allocated node}
begin if font_bc[f]<=c then if font_ec[f]>=c then
if char_exists(char_info(f)(qi(c))) then
begin p:=get_avail; font(p):=f; character(p):=qi(c);
new_character:=p; return;
end;
char_warning(f,c);
new_character:=null;
exit:end;
@* \[31] Device-independent file format.
The most important output produced by a run of \TeX\ is the ``device
independent'' (\.{DVI}) file that specifies where characters and rules
are to appear on printed pages. The form of these files was designed by
David R. Fuchs in 1979. Almost any reasonable typesetting device can be
@^Fuchs, David Raymond@>
@:DVI_files}{\.{DVI} files@>
driven by a program that takes \.{DVI} files as input, and dozens of such
\.{DVI}-to-whatever programs have been written. Thus, it is possible to
print the output of \TeX\ on many different kinds of equipment, using \TeX\
as a device-independent ``front end.''
A \.{DVI} file is a stream of 8-bit bytes, which may be regarded as a
series of commands in a machine-like language. The first byte of each command
is the operation code, and this code is followed by zero or more bytes
that provide parameters to the command. The parameters themselves may consist
of several consecutive bytes; for example, the `|set_rule|' command has two
parameters, each of which is four bytes long. Parameters are usually
regarded as nonnegative integers; but four-byte-long parameters,
and shorter parameters that denote distances, can be
either positive or negative. Such parameters are given in two's complement
notation. For example, a two-byte-long distance parameter has a value between
$-2^{15}$ and $2^{15}-1$. As in \.{TFM} files, numbers that occupy
more than one byte position appear in BigEndian order.
A \.{DVI} file consists of a ``preamble,'' followed by a sequence of one
or more ``pages,'' followed by a ``postamble.'' The preamble is simply a
|pre| command, with its parameters that define the dimensions used in the
file; this must come first. Each ``page'' consists of a |bop| command,
followed by any number of other commands that tell where characters are to
be placed on a physical page, followed by an |eop| command. The pages
appear in the order that \TeX\ generated them. If we ignore |nop| commands
and \\{fnt\_def} commands (which are allowed between any two commands in
the file), each |eop| command is immediately followed by a |bop| command,
or by a |post| command; in the latter case, there are no more pages in the
file, and the remaining bytes form the postamble. Further details about
the postamble will be explained later.
Some parameters in \.{DVI} commands are ``pointers.'' These are four-byte
quantities that give the location number of some other byte in the file;
the first byte is number~0, then comes number~1, and so on. For example,
one of the parameters of a |bop| command points to the previous |bop|;
this makes it feasible to read the pages in backwards order, in case the
results are being directed to a device that stacks its output face up.
Suppose the preamble of a \.{DVI} file occupies bytes 0 to 99. Now if the
first page occupies bytes 100 to 999, say, and if the second
page occupies bytes 1000 to 1999, then the |bop| that starts in byte 1000
points to 100 and the |bop| that starts in byte 2000 points to 1000. (The
very first |bop|, i.e., the one starting in byte 100, has a pointer of~$-1$.)
@ The \.{DVI} format is intended to be both compact and easily interpreted
by a machine. Compactness is achieved by making most of the information
implicit instead of explicit. When a \.{DVI}-reading program reads the
commands for a page, it keeps track of several quantities: (a)~The current
font |f| is an integer; this value is changed only
by \\{fnt} and \\{fnt\_num} commands. (b)~The current position on the page
is given by two numbers called the horizontal and vertical coordinates,
|h| and |v|. Both coordinates are zero at the upper left corner of the page;
moving to the right corresponds to increasing the horizontal coordinate, and
moving down corresponds to increasing the vertical coordinate. Thus, the
coordinates are essentially Cartesian, except that vertical directions are
flipped; the Cartesian version of |(h,v)| would be |(h,-v)|. (c)~The
current spacing amounts are given by four numbers |w|, |x|, |y|, and |z|,
where |w| and~|x| are used for horizontal spacing and where |y| and~|z|
are used for vertical spacing. (d)~There is a stack containing
|(h,v,w,x,y,z)| values; the \.{DVI} commands |push| and |pop| are used to
change the current level of operation. Note that the current font~|f| is
not pushed and popped; the stack contains only information about
positioning.
The values of |h|, |v|, |w|, |x|, |y|, and |z| are signed integers having up
to 32 bits, including the sign. Since they represent physical distances,
there is a small unit of measurement such that increasing |h| by~1 means
moving a certain tiny distance to the right. The actual unit of
measurement is variable, as explained below; \TeX\ sets things up so that
its \.{DVI} output is in sp units, i.e., scaled points, in agreement with
all the |scaled| dimensions in \TeX's data structures.
@ Here is a list of all the commands that may appear in a \.{DVI} file. Each
command is specified by its symbolic name (e.g., |bop|), its opcode byte
(e.g., 139), and its parameters (if any). The parameters are followed
by a bracketed number telling how many bytes they occupy; for example,
`|p[4]|' means that parameter |p| is four bytes long.
\yskip\hang|set_char_0| 0. Typeset character number~0 from font~|f|
such that the reference point of the character is at |(h,v)|. Then
increase |h| by the width of that character. Note that a character may
have zero or negative width, so one cannot be sure that |h| will advance
after this command; but |h| usually does increase.
\yskip\hang\\{set\_char\_1} through \\{set\_char\_127} (opcodes 1 to 127).
Do the operations of |set_char_0|; but use the character whose number
matches the opcode, instead of character~0.
\yskip\hang|set1| 128 |c[1]|. Same as |set_char_0|, except that character
number~|c| is typeset. \TeX82 uses this command for characters in the
range |128<=c<256|.
\yskip\hang|@!set2| 129 |c[2]|. Same as |set1|, except that |c|~is two
bytes long, so it is in the range |0<=c<65536|. \TeX82 never uses this
command, but it should come in handy for extensions of \TeX\ that deal
with oriental languages.
@^oriental characters@>@^Chinese characters@>@^Japanese characters@>
\yskip\hang|@!set3| 130 |c[3]|. Same as |set1|, except that |c|~is three
bytes long, so it can be as large as $2^{24}-1$. Not even the Chinese
language has this many characters, but this command might prove useful
in some yet unforeseen extension.
\yskip\hang|@!set4| 131 |c[4]|. Same as |set1|, except that |c|~is four
bytes long. Imagine that.
\yskip\hang|set_rule| 132 |a[4]| |b[4]|. Typeset a solid black rectangle
of height~|a| and width~|b|, with its bottom left corner at |(h,v)|. Then
set |h:=h+b|. If either |a<=0| or |b<=0|, nothing should be typeset. Note
that if |b<0|, the value of |h| will decrease even though nothing else happens.
See below for details about how to typeset rules so that consistency with
\MF\ is guaranteed.
\yskip\hang|@!put1| 133 |c[1]|. Typeset character number~|c| from font~|f|
such that the reference point of the character is at |(h,v)|. (The `put'
commands are exactly like the `set' commands, except that they simply put out a
character or a rule without moving the reference point afterwards.)
\yskip\hang|@!put2| 134 |c[2]|. Same as |set2|, except that |h| is not changed.
\yskip\hang|@!put3| 135 |c[3]|. Same as |set3|, except that |h| is not changed.
\yskip\hang|@!put4| 136 |c[4]|. Same as |set4|, except that |h| is not changed.
\yskip\hang|put_rule| 137 |a[4]| |b[4]|. Same as |set_rule|, except that
|h| is not changed.
\yskip\hang|nop| 138. No operation, do nothing. Any number of |nop|'s
may occur between \.{DVI} commands, but a |nop| cannot be inserted between
a command and its parameters or between two parameters.
\yskip\hang|bop| 139 $c_0[4]$ $c_1[4]$ $\ldots$ $c_9[4]$ $p[4]$. Beginning
of a page: Set |(h,v,w,x,y,z):=(0,0,0,0,0,0)| and set the stack empty. Set
the current font |f| to an undefined value. The ten $c_i$ parameters hold
the values of \.{\\count0} $\ldots$ \.{\\count9} in \TeX\ at the time
\.{\\shipout} was invoked for this page; they can be used to identify
pages, if a user wants to print only part of a \.{DVI} file. The parameter
|p| points to the previous |bop| in the file; the first
|bop| has $p=-1$.
\yskip\hang|eop| 140. End of page: Print what you have read since the
previous |bop|. At this point the stack should be empty. (The \.{DVI}-reading
programs that drive most output devices will have kept a buffer of the
material that appears on the page that has just ended. This material is
largely, but not entirely, in order by |v| coordinate and (for fixed |v|) by
|h|~coordinate; so it usually needs to be sorted into some order that is
appropriate for the device in question.)
\yskip\hang|push| 141. Push the current values of |(h,v,w,x,y,z)| onto the
top of the stack; do not change any of these values. Note that |f| is
not pushed.
\yskip\hang|pop| 142. Pop the top six values off of the stack and assign
them respectively to |(h,v,w,x,y,z)|. The number of pops should never
exceed the number of pushes, since it would be highly embarrassing if the
stack were empty at the time of a |pop| command.
\yskip\hang|right1| 143 |b[1]|. Set |h:=h+b|, i.e., move right |b| units.
The parameter is a signed number in two's complement notation, |-128<=b<128|;
if |b<0|, the reference point moves left.
\yskip\hang|@!right2| 144 |b[2]|. Same as |right1|, except that |b| is a
two-byte quantity in the range |-32768<=b<32768|.
\yskip\hang|@!right3| 145 |b[3]|. Same as |right1|, except that |b| is a
three-byte quantity in the range |@t$-2^{23}$@><=b<@t$2^{23}$@>|.
\yskip\hang|@!right4| 146 |b[4]|. Same as |right1|, except that |b| is a
four-byte quantity in the range |@t$-2^{31}$@><=b<@t$2^{31}$@>|.
\yskip\hang|w0| 147. Set |h:=h+w|; i.e., move right |w| units. With luck,
this parameterless command will usually suffice, because the same kind of motion
will occur several times in succession; the following commands explain how
|w| gets particular values.
\yskip\hang|w1| 148 |b[1]|. Set |w:=b| and |h:=h+b|. The value of |b| is a
signed quantity in two's complement notation, |-128<=b<128|. This command
changes the current |w|~spacing and moves right by |b|.
\yskip\hang|@!w2| 149 |b[2]|. Same as |w1|, but |b| is two bytes long,
|-32768<=b<32768|.
\yskip\hang|@!w3| 150 |b[3]|. Same as |w1|, but |b| is three bytes long,
|@t$-2^{23}$@><=b<@t$2^{23}$@>|.
\yskip\hang|@!w4| 151 |b[4]|. Same as |w1|, but |b| is four bytes long,
|@t$-2^{31}$@><=b<@t$2^{31}$@>|.
\yskip\hang|x0| 152. Set |h:=h+x|; i.e., move right |x| units. The `|x|'
commands are like the `|w|' commands except that they involve |x| instead
of |w|.
\yskip\hang|x1| 153 |b[1]|. Set |x:=b| and |h:=h+b|. The value of |b| is a
signed quantity in two's complement notation, |-128<=b<128|. This command
changes the current |x|~spacing and moves right by |b|.
\yskip\hang|@!x2| 154 |b[2]|. Same as |x1|, but |b| is two bytes long,
|-32768<=b<32768|.
\yskip\hang|@!x3| 155 |b[3]|. Same as |x1|, but |b| is three bytes long,
|@t$-2^{23}$@><=b<@t$2^{23}$@>|.
\yskip\hang|@!x4| 156 |b[4]|. Same as |x1|, but |b| is four bytes long,
|@t$-2^{31}$@><=b<@t$2^{31}$@>|.
\yskip\hang|down1| 157 |a[1]|. Set |v:=v+a|, i.e., move down |a| units.
The parameter is a signed number in two's complement notation, |-128<=a<128|;
if |a<0|, the reference point moves up.
\yskip\hang|@!down2| 158 |a[2]|. Same as |down1|, except that |a| is a
two-byte quantity in the range |-32768<=a<32768|.
\yskip\hang|@!down3| 159 |a[3]|. Same as |down1|, except that |a| is a
three-byte quantity in the range |@t$-2^{23}$@><=a<@t$2^{23}$@>|.
\yskip\hang|@!down4| 160 |a[4]|. Same as |down1|, except that |a| is a
four-byte quantity in the range |@t$-2^{31}$@><=a<@t$2^{31}$@>|.
\yskip\hang|y0| 161. Set |v:=v+y|; i.e., move down |y| units. With luck,
this parameterless command will usually suffice, because the same kind of motion
will occur several times in succession; the following commands explain how
|y| gets particular values.
\yskip\hang|y1| 162 |a[1]|. Set |y:=a| and |v:=v+a|. The value of |a| is a
signed quantity in two's complement notation, |-128<=a<128|. This command
changes the current |y|~spacing and moves down by |a|.
\yskip\hang|@!y2| 163 |a[2]|. Same as |y1|, but |a| is two bytes long,
|-32768<=a<32768|.
\yskip\hang|@!y3| 164 |a[3]|. Same as |y1|, but |a| is three bytes long,
|@t$-2^{23}$@><=a<@t$2^{23}$@>|.
\yskip\hang|@!y4| 165 |a[4]|. Same as |y1|, but |a| is four bytes long,
|@t$-2^{31}$@><=a<@t$2^{31}$@>|.
\yskip\hang|z0| 166. Set |v:=v+z|; i.e., move down |z| units. The `|z|' commands
are like the `|y|' commands except that they involve |z| instead of |y|.
\yskip\hang|z1| 167 |a[1]|. Set |z:=a| and |v:=v+a|. The value of |a| is a
signed quantity in two's complement notation, |-128<=a<128|. This command
changes the current |z|~spacing and moves down by |a|.
\yskip\hang|@!z2| 168 |a[2]|. Same as |z1|, but |a| is two bytes long,
|-32768<=a<32768|.
\yskip\hang|@!z3| 169 |a[3]|. Same as |z1|, but |a| is three bytes long,
|@t$-2^{23}$@><=a<@t$2^{23}$@>|.
\yskip\hang|@!z4| 170 |a[4]|. Same as |z1|, but |a| is four bytes long,
|@t$-2^{31}$@><=a<@t$2^{31}$@>|.
\yskip\hang|fnt_num_0| 171. Set |f:=0|. Font 0 must previously have been
defined by a \\{fnt\_def} instruction, as explained below.
\yskip\hang\\{fnt\_num\_1} through \\{fnt\_num\_63} (opcodes 172 to 234). Set
|f:=1|, \dots, \hbox{|f:=63|}, respectively.
\yskip\hang|fnt1| 235 |k[1]|. Set |f:=k|. \TeX82 uses this command for font
numbers in the range |64<=k<256|.
\yskip\hang|@!fnt2| 236 |k[2]|. Same as |fnt1|, except that |k|~is two
bytes long, so it is in the range |0<=k<65536|. \TeX82 never generates this
command, but large font numbers may prove useful for specifications of
color or texture, or they may be used for special fonts that have fixed
numbers in some external coding scheme.
\yskip\hang|@!fnt3| 237 |k[3]|. Same as |fnt1|, except that |k|~is three
bytes long, so it can be as large as $2^{24}-1$.
\yskip\hang|@!fnt4| 238 |k[4]|. Same as |fnt1|, except that |k|~is four
bytes long; this is for the really big font numbers (and for the negative ones).
\yskip\hang|xxx1| 239 |k[1]| |x[k]|. This command is undefined in
general; it functions as a $(k+2)$-byte |nop| unless special \.{DVI}-reading
programs are being used. \TeX82 generates |xxx1| when a short enough
\.{\\special} appears, setting |k| to the number of bytes being sent. It
is recommended that |x| be a string having the form of a keyword followed
by possible parameters relevant to that keyword.
\yskip\hang|@!xxx2| 240 |k[2]| |x[k]|. Like |xxx1|, but |0<=k<65536|.
\yskip\hang|@!xxx3| 241 |k[3]| |x[k]|. Like |xxx1|, but |0<=k<@t$2^{24}$@>|.
\yskip\hang|xxx4| 242 |k[4]| |x[k]|. Like |xxx1|, but |k| can be ridiculously
large. \TeX82 uses |xxx4| when sending a string of length 256 or more.
\yskip\hang|fnt_def1| 243 |k[1]| |c[4]| |s[4]| |d[4]| |a[1]| |l[1]| |n[a+l]|.
Define font |k|, where |0<=k<256|; font definitions will be explained shortly.
\yskip\hang|@!fnt_def2| 244 |k[2]| |c[4]| |s[4]| |d[4]| |a[1]| |l[1]| |n[a+l]|.
Define font |k|, where |0<=k<65536|.
\yskip\hang|@!fnt_def3| 245 |k[3]| |c[4]| |s[4]| |d[4]| |a[1]| |l[1]| |n[a+l]|.
Define font |k|, where |0<=k<@t$2^{24}$@>|.
\yskip\hang|@!fnt_def4| 246 |k[4]| |c[4]| |s[4]| |d[4]| |a[1]| |l[1]| |n[a+l]|.
Define font |k|, where |@t$-2^{31}$@><=k<@t$2^{31}$@>|.
\yskip\hang|pre| 247 |i[1]| |num[4]| |den[4]| |mag[4]| |k[1]| |x[k]|.
Beginning of the preamble; this must come at the very beginning of the
file. Parameters |i|, |num|, |den|, |mag|, |k|, and |x| are explained below.
\yskip\hang|post| 248. Beginning of the postamble, see below.
\yskip\hang|post_post| 249. Ending of the postamble, see below.
\yskip\noindent Commands 250--255 are undefined at the present time.
@ @d set_char_0=0 {typeset character 0 and move right}
@d set1=128 {typeset a character and move right}
@d set_rule=132 {typeset a rule and move right}
@d put_rule=137 {typeset a rule}
@d nop=138 {no operation}
@d bop=139 {beginning of page}
@d eop=140 {ending of page}
@d push=141 {save the current positions}
@d pop=142 {restore previous positions}
@d right1=143 {move right}
@d w0=147 {move right by |w|}
@d w1=148 {move right and set |w|}
@d x0=152 {move right by |x|}
@d x1=153 {move right and set |x|}
@d down1=157 {move down}
@d y0=161 {move down by |y|}
@d y1=162 {move down and set |y|}
@d z0=166 {move down by |z|}
@d z1=167 {move down and set |z|}
@d fnt_num_0=171 {set current font to 0}
@d fnt1=235 {set current font}
@d xxx1=239 {extension to \.{DVI} primitives}
@d xxx4=242 {potentially long extension to \.{DVI} primitives}
@d fnt_def1=243 {define the meaning of a font number}
@d pre=247 {preamble}
@d post=248 {postamble beginning}
@d post_post=249 {postamble ending}
@ The preamble contains basic information about the file as a whole. As
stated above, there are six parameters:
$$\hbox{|@!i[1]| |@!num[4]| |@!den[4]| |@!mag[4]| |@!k[1]| |@!x[k]|.}$$
The |i| byte identifies \.{DVI} format; currently this byte is always set
to~2. (The value |i=3| is currently used for an extended format that
allows a mixture of right-to-left and left-to-right typesetting.
Some day we will set |i=4|, when \.{DVI} format makes another
incompatible change---perhaps in the year 2048.)
The next two parameters, |num| and |den|, are positive integers that define
the units of measurement; they are the numerator and denominator of a
fraction by which all dimensions in the \.{DVI} file could be multiplied
in order to get lengths in units of $10^{-7}$ meters. Since $\rm 7227{pt} =
254{cm}$, and since \TeX\ works with scaled points where there are $2^{16}$
sp in a point, \TeX\ sets
$|num|/|den|=(254\cdot10^5)/(7227\cdot2^{16})=25400000/473628672$.
@^sp@>
The |mag| parameter is what \TeX\ calls \.{\\mag}, i.e., 1000 times the
desired magnification. The actual fraction by which dimensions are
multiplied is therefore $|mag|\cdot|num|/1000|den|$. Note that if a \TeX\
source document does not call for any `\.{true}' dimensions, and if you
change it only by specifying a different \.{\\mag} setting, the \.{DVI}
file that \TeX\ creates will be completely unchanged except for the value
of |mag| in the preamble and postamble. (Fancy \.{DVI}-reading programs allow
users to override the |mag|~setting when a \.{DVI} file is being printed.)
Finally, |k| and |x| allow the \.{DVI} writer to include a comment, which is not
interpreted further. The length of comment |x| is |k|, where |0<=k<256|.
@d id_byte=2 {identifies the kind of \.{DVI} files described here}
@ Font definitions for a given font number |k| contain further parameters
$$\hbox{|c[4]| |s[4]| |d[4]| |a[1]| |l[1]| |n[a+l]|.}$$
The four-byte value |c| is the check sum that \TeX\ found in the \.{TFM}
file for this font; |c| should match the check sum of the font found by
programs that read this \.{DVI} file.
@^check sum@>
Parameter |s| contains a fixed-point scale factor that is applied to
the character widths in font |k|; font dimensions in \.{TFM} files and
other font files are relative to this quantity, which is called the
``at size'' elsewhere in this documentation. The value of |s| is
always positive and less than $2^{27}$. It is given in the same units
as the other \.{DVI} dimensions, i.e., in sp when \TeX82 has made the
file. Parameter |d| is similar to |s|; it is the ``design size,'' and
(like~|s|) it is given in \.{DVI} units. Thus, font |k| is to be used
at $|mag|\cdot s/1000d$ times its normal size.
The remaining part of a font definition gives the external name of the font,
which is an ASCII string of length |a+l|. The number |a| is the length
of the ``area'' or directory, and |l| is the length of the font name itself;
the standard local system font area is supposed to be used when |a=0|.
The |n| field contains the area in its first |a| bytes.
Font definitions must appear before the first use of a particular font number.
Once font |k| is defined, it must not be defined again; however, we
shall see below that font definitions appear in the postamble as well as
in the pages, so in this sense each font number is defined exactly twice,
if at all. Like |nop| commands, font definitions can
appear before the first |bop|, or between an |eop| and a |bop|.
@ Sometimes it is desirable to make horizontal or vertical rules line up
precisely with certain features in characters of a font. It is possible to
guarantee the correct matching between \.{DVI} output and the characters
generated by \MF\ by adhering to the following principles: (1)~The \MF\
characters should be positioned so that a bottom edge or left edge that is
supposed to line up with the bottom or left edge of a rule appears at the
reference point, i.e., in row~0 and column~0 of the \MF\ raster. This
ensures that the position of the rule will not be rounded differently when
the pixel size is not a perfect multiple of the units of measurement in
the \.{DVI} file. (2)~A typeset rule of height $a>0$ and width $b>0$
should be equivalent to a \MF-generated character having black pixels in
precisely those raster positions whose \MF\ coordinates satisfy
|0<=x<@t$\alpha$@>b| and |0<=y<@t$\alpha$@>a|, where $\alpha$ is the number
of pixels per \.{DVI} unit.
@:METAFONT}{\MF@>
@^alignment of rules with characters@>
@^rules aligning with characters@>
@ The last page in a \.{DVI} file is followed by `|post|'; this command
introduces the postamble, which summarizes important facts that \TeX\ has
accumulated about the file, making it possible to print subsets of the data
with reasonable efficiency. The postamble has the form
$$\vbox{\halign{\hbox{#\hfil}\cr
|post| |p[4]| |num[4]| |den[4]| |mag[4]| |l[4]| |u[4]| |s[2]| |t[2]|\cr
$\langle\,$font definitions$\,\rangle$\cr
|post_post| |q[4]| |i[1]| 223's$[{\G}4]$\cr}}$$
Here |p| is a pointer to the final |bop| in the file. The next three
parameters, |num|, |den|, and |mag|, are duplicates of the quantities that
appeared in the preamble.
Parameters |l| and |u| give respectively the height-plus-depth of the tallest
page and the width of the widest page, in the same units as other dimensions
of the file. These numbers might be used by a \.{DVI}-reading program to
position individual ``pages'' on large sheets of film or paper; however,
the standard convention for output on normal size paper is to position each
page so that the upper left-hand corner is exactly one inch from the left
and the top. Experience has shown that it is unwise to design \.{DVI}-to-printer
software that attempts cleverly to center the output; a fixed position of
the upper left corner is easiest for users to understand and to work with.
Therefore |l| and~|u| are often ignored.
Parameter |s| is the maximum stack depth (i.e., the largest excess of
|push| commands over |pop| commands) needed to process this file. Then
comes |t|, the total number of pages (|bop| commands) present.
The postamble continues with font definitions, which are any number of
\\{fnt\_def} commands as described above, possibly interspersed with |nop|
commands. Each font number that is used in the \.{DVI} file must be defined
exactly twice: Once before it is first selected by a \\{fnt} command, and once
in the postamble.
@ The last part of the postamble, following the |post_post| byte that
signifies the end of the font definitions, contains |q|, a pointer to the
|post| command that started the postamble. An identification byte, |i|,
comes next; this currently equals~2, as in the preamble.
The |i| byte is followed by four or more bytes that are all equal to
the decimal number 223 (i.e., @'337 in octal). \TeX\ puts out four to seven of
these trailing bytes, until the total length of the file is a multiple of
four bytes, since this works out best on machines that pack four bytes per
word; but any number of 223's is allowed, as long as there are at least four
of them. In effect, 223 is a sort of signature that is added at the very end.
@^Fuchs, David Raymond@>
This curious way to finish off a \.{DVI} file makes it feasible for
\.{DVI}-reading programs to find the postamble first, on most computers,
even though \TeX\ wants to write the postamble last. Most operating
systems permit random access to individual words or bytes of a file, so
the \.{DVI} reader can start at the end and skip backwards over the 223's
until finding the identification byte. Then it can back up four bytes, read
|q|, and move to byte |q| of the file. This byte should, of course,
contain the value 248 (|post|); now the postamble can be read, so the
\.{DVI} reader can discover all the information needed for typesetting the
pages. Note that it is also possible to skip through the \.{DVI} file at
reasonably high speed to locate a particular page, if that proves
desirable. This saves a lot of time, since \.{DVI} files used in production
jobs tend to be large.
Unfortunately, however, standard \PASCAL\ does not include the ability to
@^system dependencies@>
access a random position in a file, or even to determine the length of a file.
Almost all systems nowadays provide the necessary capabilities, so \.{DVI}
format has been designed to work most efficiently with modern operating systems.
But if \.{DVI} files have to be processed under the restrictions of standard
\PASCAL, one can simply read them from front to back, since the necessary
header information is present in the preamble and in the font definitions.
(The |l| and |u| and |s| and |t| parameters, which appear only in the
postamble, are ``frills'' that are handy but not absolutely necessary.)
@* \[32] Shipping pages out.
After considering \TeX's eyes and stomach, we come now to the bowels.
@^bowels@>
The |ship_out| procedure is given a pointer to a box; its mission is
to describe that box in \.{DVI} form, outputting a ``page'' to |dvi_file|.
The \.{DVI} coordinates $(h,v)=(0,0)$ should correspond to the upper left
corner of the box being shipped.
Since boxes can be inside of boxes inside of boxes, the main work of
|ship_out| is done by two mutually recursive routines, |hlist_out|
and |vlist_out|, which traverse the hlists and vlists inside of horizontal
and vertical boxes.
As individual pages are being processed, we need to accumulate
information about the entire set of pages, since such statistics must be
reported in the postamble. The global variables |total_pages|, |max_v|,
|max_h|, |max_push|, and |last_bop| are used to record this information.
The variable |doing_leaders| is |true| while leaders are being output.
The variable |dead_cycles| contains the number of times an output routine
has been initiated since the last |ship_out|.
A few additional global variables are also defined here for use in
|vlist_out| and |hlist_out|. They could have been local variables, but
that would waste stack space when boxes are deeply nested, since the
values of these variables are not needed during recursive calls.
@^recursion@>
@<Glob...@>=
@!total_pages:integer; {the number of pages that have been shipped out}
@!max_v:scaled; {maximum height-plus-depth of pages shipped so far}
@!max_h:scaled; {maximum width of pages shipped so far}
@!max_push:integer; {deepest nesting of |push| commands encountered so far}
@!last_bop:integer; {location of previous |bop| in the \.{DVI} output}
@!dead_cycles:integer; {recent outputs that didn't ship anything out}
@!doing_leaders:boolean; {are we inside a leader box?}
@#
@!c,@!f:quarterword; {character and font in current |char_node|}
@!rule_ht,@!rule_dp,@!rule_wd:scaled; {size of current rule being output}
@!g:pointer; {current glue specification}
@!lq,@!lr:integer; {quantities used in calculations for leaders}
@ @<Set init...@>=
total_pages:=0; max_v:=0; max_h:=0; max_push:=0; last_bop:=-1;
doing_leaders:=false; dead_cycles:=0; cur_s:=-1;
@ The \.{DVI} bytes are output to a buffer instead of being written directly
to the output file. This makes it possible to reduce the overhead of
subroutine calls, thereby measurably speeding up the computation, since
output of \.{DVI} bytes is part of \TeX's inner loop. And it has another
advantage as well, since we can change instructions in the buffer in order to
make the output more compact. For example, a `|down2|' command can be
changed to a `|y2|', thereby making a subsequent `|y0|' command possible,
saving two bytes.
The output buffer is divided into two parts of equal size; the bytes found
in |dvi_buf[0..half_buf-1]| constitute the first half, and those in
|dvi_buf[half_buf..dvi_buf_size-1]| constitute the second. The global
variable |dvi_ptr| points to the position that will receive the next
output byte. When |dvi_ptr| reaches |dvi_limit|, which is always equal
to one of the two values |half_buf| or |dvi_buf_size|, the half buffer that
is about to be invaded next is sent to the output and |dvi_limit| is
changed to its other value. Thus, there is always at least a half buffer's
worth of information present, except at the very beginning of the job.
Bytes of the \.{DVI} file are numbered sequentially starting with 0;
the next byte to be generated will be number |dvi_offset+dvi_ptr|.
A byte is present in the buffer only if its number is |>=dvi_gone|.
@<Types...@>=
@!dvi_index=0..dvi_buf_size; {an index into the output buffer}
@ Some systems may find it more efficient to make |dvi_buf| a |packed|
array, since output of four bytes at once may be facilitated.
@^system dependencies@>
@<Glob...@>=
@!dvi_buf:array[dvi_index] of eight_bits; {buffer for \.{DVI} output}
@!half_buf:dvi_index; {half of |dvi_buf_size|}
@!dvi_limit:dvi_index; {end of the current half buffer}
@!dvi_ptr:dvi_index; {the next available buffer address}
@!dvi_offset:integer; {|dvi_buf_size| times the number of times the
output buffer has been fully emptied}
@!dvi_gone:integer; {the number of bytes already output to |dvi_file|}
@ Initially the buffer is all in one piece; we will output half of it only
after it first fills up.
@<Set init...@>=
half_buf:=dvi_buf_size div 2; dvi_limit:=dvi_buf_size; dvi_ptr:=0;
dvi_offset:=0; dvi_gone:=0;
@ The actual output of |dvi_buf[a..b]| to |dvi_file| is performed by calling
|write_dvi(a,b)|. For best results, this procedure should be optimized to
run as fast as possible on each particular system, since it is part of
\TeX's inner loop. It is safe to assume that |a| and |b+1| will both be
multiples of 4 when |write_dvi(a,b)| is called; therefore it is possible on
many machines to use efficient methods to pack four bytes per word and to
output an array of words with one system call.
@^system dependencies@>
@^inner loop@>
@^defecation@>
@p procedure write_dvi(@!a,@!b:dvi_index);
var k:dvi_index;
begin for k:=a to b do write(dvi_file,dvi_buf[k]);
end;
@ To put a byte in the buffer without paying the cost of invoking a procedure
each time, we use the macro |dvi_out|.
@d dvi_out(#)==@+begin dvi_buf[dvi_ptr]:=#; incr(dvi_ptr);
if dvi_ptr=dvi_limit then dvi_swap;
end
@p procedure dvi_swap; {outputs half of the buffer}
begin if dvi_limit=dvi_buf_size then
begin write_dvi(0,half_buf-1); dvi_limit:=half_buf;
dvi_offset:=dvi_offset+dvi_buf_size; dvi_ptr:=0;
end
else begin write_dvi(half_buf,dvi_buf_size-1); dvi_limit:=dvi_buf_size;
end;
dvi_gone:=dvi_gone+half_buf;
end;
@ Here is how we clean out the buffer when \TeX\ is all through; |dvi_ptr|
will be a multiple of~4.
@<Empty the last bytes out of |dvi_buf|@>=
if dvi_limit=half_buf then write_dvi(half_buf,dvi_buf_size-1);
if dvi_ptr>0 then write_dvi(0,dvi_ptr-1)
@ The |dvi_four| procedure outputs four bytes in two's complement notation,
without risking arithmetic overflow.
@p procedure dvi_four(@!x:integer);
begin if x>=0 then dvi_out(x div @'100000000)
else begin x:=x+@'10000000000;
x:=x+@'10000000000;
dvi_out((x div @'100000000) + 128);
end;
x:=x mod @'100000000; dvi_out(x div @'200000);
x:=x mod @'200000; dvi_out(x div @'400);
dvi_out(x mod @'400);
end;
@ A mild optimization of the output is performed by the |dvi_pop|
routine, which issues a |pop| unless it is possible to cancel a
`|push| |pop|' pair. The parameter to |dvi_pop| is the byte address
following the old |push| that matches the new |pop|.
@p procedure dvi_pop(@!l:integer);
begin if (l=dvi_offset+dvi_ptr)and(dvi_ptr>0) then decr(dvi_ptr)
else dvi_out(pop);
end;
@ Here's a procedure that outputs a font definition. Since \TeX82 uses at
most 256 different fonts per job, |fnt_def1| is always used as the command code.
@p procedure dvi_font_def(@!f:internal_font_number);
var k:pool_pointer; {index into |str_pool|}
begin dvi_out(fnt_def1);
dvi_out(f-font_base-1);@/
dvi_out(qo(font_check[f].b0));
dvi_out(qo(font_check[f].b1));
dvi_out(qo(font_check[f].b2));
dvi_out(qo(font_check[f].b3));@/
dvi_four(font_size[f]);
dvi_four(font_dsize[f]);@/
dvi_out(length(font_area[f]));
dvi_out(length(font_name[f]));
@<Output the font name whose internal number is |f|@>;
end;
@ @<Output the font name whose internal number is |f|@>=
for k:=str_start[font_area[f]] to str_start[font_area[f]+1]-1 do
dvi_out(so(str_pool[k]));
for k:=str_start[font_name[f]] to str_start[font_name[f]+1]-1 do
dvi_out(so(str_pool[k]))
@ Versions of \TeX\ intended for small computers might well choose to omit
the ideas in the next few parts of this program, since it is not really
necessary to optimize the \.{DVI} code by making use of the |w0|, |x0|,
|y0|, and |z0| commands. Furthermore, the algorithm that we are about to
describe does not pretend to give an optimum reduction in the length
of the \.{DVI} code; after all, speed is more important than compactness.
But the method is surprisingly effective, and it takes comparatively little
time.
We can best understand the basic idea by first considering a simpler problem
that has the same essential characteristics. Given a sequence of digits,
say $3\,1\,4\,1\,5\,9\,2\,6\,5\,3\,5\,8\,9$, we want to assign subscripts
$d$, $y$, or $z$ to each digit so as to maximize the number of ``$y$-hits''
and ``$z$-hits''; a $y$-hit is an instance of two appearances of the same
digit with the subscript $y$, where no $y$'s intervene between the two
appearances, and a $z$-hit is defined similarly. For example, the sequence
above could be decorated with subscripts as follows:
$$3_z\,1_y\,4_d\,1_y\,5_y\,9_d\,2_d\,6_d\,5_y\,3_z\,5_y\,8_d\,9_d.$$
There are three $y$-hits ($1_y\ldots1_y$ and $5_y\ldots5_y\ldots5_y$) and
one $z$-hit ($3_z\ldots3_z$); there are no $d$-hits, since the two appearances
of $9_d$ have $d$'s between them, but we don't count $d$-hits so it doesn't
matter how many there are. These subscripts are analogous to the \.{DVI}
commands called \\{down}, $y$, and $z$, and the digits are analogous to
different amounts of vertical motion; a $y$-hit or $z$-hit corresponds to
the opportunity to use the one-byte commands |y0| or |z0| in a \.{DVI} file.
\TeX's method of assigning subscripts works like this: Append a new digit,
say $\delta$, to the right of the sequence. Now look back through the
sequence until one of the following things happens: (a)~You see
$\delta_y$ or $\delta_z$, and this was the first time you encountered a
$y$ or $z$ subscript, respectively. Then assign $y$ or $z$ to the new
$\delta$; you have scored a hit. (b)~You see $\delta_d$, and no $y$
subscripts have been encountered so far during this search. Then change
the previous $\delta_d$ to $\delta_y$ (this corresponds to changing a
command in the output buffer), and assign $y$ to the new $\delta$; it's
another hit. (c)~You see $\delta_d$, and a $y$ subscript has been seen
but not a $z$. Change the previous $\delta_d$ to $\delta_z$ and assign
$z$ to the new $\delta$. (d)~You encounter both $y$ and $z$ subscripts
before encountering a suitable $\delta$, or you scan all the way to the
front of the sequence. Assign $d$ to the new $\delta$; this assignment may
be changed later.
The subscripts $3_z\,1_y\,4_d\ldots\,$ in the example above were, in fact,
produced by this procedure, as the reader can verify. (Go ahead and try it.)
@ In order to implement such an idea, \TeX\ maintains a stack of pointers
to the \\{down}, $y$, and $z$ commands that have been generated for the
current page. And there is a similar stack for \\{right}, |w|, and |x|
commands. These stacks are called the down stack and right stack, and their
top elements are maintained in the variables |down_ptr| and |right_ptr|.
Each entry in these stacks contains four fields: The |width| field is
the amount of motion down or to the right; the |location| field is the
byte number of the \.{DVI} command in question (including the appropriate
|dvi_offset|); the |link| field points to the next item below this one
on the stack; and the |info| field encodes the options for possible change
in the \.{DVI} command.
@d movement_node_size=3 {number of words per entry in the down and right stacks}
@d location(#)==mem[#+2].int {\.{DVI} byte number for a movement command}
@<Glob...@>=
@!down_ptr,@!right_ptr:pointer; {heads of the down and right stacks}
@ @<Set init...@>=
down_ptr:=null; right_ptr:=null;
@ Here is a subroutine that produces a \.{DVI} command for some specified
downward or rightward motion. It has two parameters: |w| is the amount
of motion, and |o| is either |down1| or |right1|. We use the fact that
the command codes have convenient arithmetic properties: |y1-down1=w1-right1|
and |z1-down1=x1-right1|.
@p procedure movement(@!w:scaled;@!o:eight_bits);
label exit,found,not_found,2,1;
var mstate:small_number; {have we seen a |y| or |z|?}
@!p,@!q:pointer; {current and top nodes on the stack}
@!k:integer; {index into |dvi_buf|, modulo |dvi_buf_size|}
begin q:=get_node(movement_node_size); {new node for the top of the stack}
width(q):=w; location(q):=dvi_offset+dvi_ptr;
if o=down1 then
begin link(q):=down_ptr; down_ptr:=q;
end
else begin link(q):=right_ptr; right_ptr:=q;
end;
@<Look at the other stack entries until deciding what sort of \.{DVI} command
to generate; |goto found| if node |p| is a ``hit''@>;
@<Generate a |down| or |right| command for |w| and |return|@>;
found: @<Generate a |y0| or |z0| command in order to reuse a previous
appearance of~|w|@>;
exit:end;
@ The |info| fields in the entries of the down stack or the right stack
have six possible settings: |y_here| or |z_here| mean that the \.{DVI}
command refers to |y| or |z|, respectively (or to |w| or |x|, in the
case of horizontal motion); |yz_OK| means that the \.{DVI} command is
\\{down} (or \\{right}) but can be changed to either |y| or |z| (or
to either |w| or |x|); |y_OK| means that it is \\{down} and can be changed
to |y| but not |z|; |z_OK| is similar; and |d_fixed| means it must stay
\\{down}.
The four settings |yz_OK|, |y_OK|, |z_OK|, |d_fixed| would not need to
be distinguished from each other if we were simply solving the
digit-subscripting problem mentioned above. But in \TeX's case there is
a complication because of the nested structure of |push| and |pop|
commands. Suppose we add parentheses to the digit-subscripting problem,
redefining hits so that $\delta_y\ldots \delta_y$ is a hit if all $y$'s between
the $\delta$'s are enclosed in properly nested parentheses, and if the
parenthesis level of the right-hand $\delta_y$ is deeper than or equal to
that of the left-hand one. Thus, `(' and `)' correspond to `|push|'
and `|pop|'. Now if we want to assign a subscript to the final 1 in the
sequence
$$2_y\,7_d\,1_d\,(\,8_z\,2_y\,8_z\,)\,1$$
we cannot change the previous $1_d$ to $1_y$, since that would invalidate
the $2_y\ldots2_y$ hit. But we can change it to $1_z$, scoring a hit
since the intervening $8_z$'s are enclosed in parentheses.
The program below removes movement nodes that are introduced after a |push|,
before it outputs the corresponding |pop|.
@d y_here=1 {|info| when the movement entry points to a |y| command}
@d z_here=2 {|info| when the movement entry points to a |z| command}
@d yz_OK=3 {|info| corresponding to an unconstrained \\{down} command}
@d y_OK=4 {|info| corresponding to a \\{down} that can't become a |z|}
@d z_OK=5 {|info| corresponding to a \\{down} that can't become a |y|}
@d d_fixed=6 {|info| corresponding to a \\{down} that can't change}
@ When the |movement| procedure gets to the label |found|, the value of
|info(p)| will be either |y_here| or |z_here|. If it is, say, |y_here|,
the procedure generates a |y0| command (or a |w0| command), and marks
all |info| fields between |q| and |p| so that |y| is not OK in that range.
@<Generate a |y0| or |z0| command...@>=
info(q):=info(p);
if info(q)=y_here then
begin dvi_out(o+y0-down1); {|y0| or |w0|}
while link(q)<>p do
begin q:=link(q);
case info(q) of
yz_OK: info(q):=z_OK;
y_OK: info(q):=d_fixed;
othercases do_nothing
endcases;
end;
end
else begin dvi_out(o+z0-down1); {|z0| or |x0|}
while link(q)<>p do
begin q:=link(q);
case info(q) of
yz_OK: info(q):=y_OK;
z_OK: info(q):=d_fixed;
othercases do_nothing
endcases;
end;
end
@ @<Generate a |down| or |right|...@>=
info(q):=yz_OK;
if abs(w)>=@'40000000 then
begin dvi_out(o+3); {|down4| or |right4|}
dvi_four(w); return;
end;
if abs(w)>=@'100000 then
begin dvi_out(o+2); {|down3| or |right3|}
if w<0 then w:=w+@'100000000;
dvi_out(w div @'200000); w:=w mod @'200000; goto 2;
end;
if abs(w)>=@'200 then
begin dvi_out(o+1); {|down2| or |right2|}
if w<0 then w:=w+@'200000;
goto 2;
end;
dvi_out(o); {|down1| or |right1|}
if w<0 then w:=w+@'400;
goto 1;
2: dvi_out(w div @'400);
1: dvi_out(w mod @'400); return
@ As we search through the stack, we are in one of three states,
|y_seen|, |z_seen|, or |none_seen|, depending on whether we have
encountered |y_here| or |z_here| nodes. These states are encoded as
multiples of 6, so that they can be added to the |info| fields for quick
decision-making.
@^inner loop@>
@d none_seen=0 {no |y_here| or |z_here| nodes have been encountered yet}
@d y_seen=6 {we have seen |y_here| but not |z_here|}
@d z_seen=12 {we have seen |z_here| but not |y_here|}
@<Look at the other stack entries until deciding...@>=
p:=link(q); mstate:=none_seen;
while p<>null do
begin if width(p)=w then @<Consider a node with matching width;
|goto found| if it's a hit@>
else case mstate+info(p) of
none_seen+y_here: mstate:=y_seen;
none_seen+z_here: mstate:=z_seen;
y_seen+z_here,z_seen+y_here: goto not_found;
othercases do_nothing
endcases;
p:=link(p);
end;
not_found:
@ We might find a valid hit in a |y| or |z| byte that is already gone
from the buffer. But we can't change bytes that are gone forever; ``the
moving finger writes, $\ldots\,\,$.''
@<Consider a node with matching width...@>=
case mstate+info(p) of
none_seen+yz_OK,none_seen+y_OK,z_seen+yz_OK,z_seen+y_OK:@t@>@;@/
if location(p)<dvi_gone then goto not_found
else @<Change buffered instruction to |y| or |w| and |goto found|@>;
none_seen+z_OK,y_seen+yz_OK,y_seen+z_OK:@t@>@;@/
if location(p)<dvi_gone then goto not_found
else @<Change buffered instruction to |z| or |x| and |goto found|@>;
none_seen+y_here,none_seen+z_here,y_seen+z_here,z_seen+y_here: goto found;
othercases do_nothing
endcases
@ @<Change buffered instruction to |y| or |w| and |goto found|@>=
begin k:=location(p)-dvi_offset;
if k<0 then k:=k+dvi_buf_size;
dvi_buf[k]:=dvi_buf[k]+y1-down1;
info(p):=y_here; goto found;
end
@ @<Change buffered instruction to |z| or |x| and |goto found|@>=
begin k:=location(p)-dvi_offset;
if k<0 then k:=k+dvi_buf_size;
dvi_buf[k]:=dvi_buf[k]+z1-down1;
info(p):=z_here; goto found;
end
@ In case you are wondering when all the movement nodes are removed from
\TeX's memory, the answer is that they are recycled just before
|hlist_out| and |vlist_out| finish outputting a box. This restores the
down and right stacks to the state they were in before the box was output,
except that some |info|'s may have become more restrictive.
@p procedure prune_movements(@!l:integer);
{delete movement nodes with |location>=l|}
label done,exit;
var p:pointer; {node being deleted}
begin while down_ptr<>null do
begin if location(down_ptr)<l then goto done;
p:=down_ptr; down_ptr:=link(p); free_node(p,movement_node_size);
end;
done: while right_ptr<>null do
begin if location(right_ptr)<l then return;
p:=right_ptr; right_ptr:=link(p); free_node(p,movement_node_size);
end;
exit:end;
@ The actual distances by which we want to move might be computed as the
sum of several separate movements. For example, there might be several
glue nodes in succession, or we might want to move right by the width of
some box plus some amount of glue. More importantly, the baselineskip
distances are computed in terms of glue together with the depth and
height of adjacent boxes, and we want the \.{DVI} file to lump these
three quantities together into a single motion.
Therefore, \TeX\ maintains two pairs of global variables: |dvi_h| and |dvi_v|
are the |h| and |v| coordinates corresponding to the commands actually
output to the \.{DVI} file, while |cur_h| and |cur_v| are the coordinates
corresponding to the current state of the output routines. Coordinate
changes will accumulate in |cur_h| and |cur_v| without being reflected
in the output, until such a change becomes necessary or desirable; we
can call the |movement| procedure whenever we want to make |dvi_h=cur_h|
or |dvi_v=cur_v|.
The current font reflected in the \.{DVI} output is called |dvi_f|;
there is no need for a `\\{cur\_f}' variable.
The depth of nesting of |hlist_out| and |vlist_out| is called |cur_s|;
this is essentially the depth of |push| commands in the \.{DVI} output.
For mixed direction text (\TeXXeT) the current text direction is called
|cur_dir|. As the box being shipped out will never be used again and
soon be recycled, we can simply reverse any R-text (i.e., right-to-left)
segments of hlist nodes as well as complete hlist nodes embedded in such
segments. Moreover this can be done iteratively rather than recursively.
There are, however, two complications related to leaders that require
some additional bookkeeping: (1)~One and the same hlist node might be
used more than once (but never inside both L- and R-text); and
(2)~leader boxes inside hlists must be aligned with respect to the left
edge of the original hlist.
A math node is changed into a kern node whenever the text direction
remains the same, it is replaced by an |edge_node| if the text direction
changes; the subtype of an an |hlist_node| inside R-text is changed to
|reversed| once its hlist has been reversed.
@!@^data structure assumptions@>
@d reversed=1 {subtype for an |hlist_node| whose hlist has been reversed}
@d dlist=2 {subtype for an |hlist_node| from display math mode}
@d box_lr(#) == (qo(subtype(#))) {direction mode of a box}
@d set_box_lr(#) == subtype(#):=set_box_lr_end
@d set_box_lr_end(#) == qi(#)
@#
@d left_to_right=0
@d right_to_left=1
@d reflected==1-cur_dir {the opposite of |cur_dir|}
@#
@d synch_h==if cur_h<>dvi_h then
begin movement(cur_h-dvi_h,right1); dvi_h:=cur_h;
end
@d synch_v==if cur_v<>dvi_v then
begin movement(cur_v-dvi_v,down1); dvi_v:=cur_v;
end
@<Glob...@>=
@!dvi_h,@!dvi_v:scaled; {a \.{DVI} reader program thinks we are here}
@!cur_h,@!cur_v:scaled; {\TeX\ thinks we are here}
@!dvi_f:internal_font_number; {the current font}
@!cur_s:integer; {current depth of output box nesting, initially $-1$}
@ @<Calculate DVI page dimensions and margins@>=
cur_h_offset := h_offset;
cur_v_offset := v_offset;
if pdf_page_width <> 0 then
cur_page_width := pdf_page_width
else
cur_page_width := width(p) + 2*cur_h_offset + 2*4736286;
{4736286 = 1in, the funny DVI origin offset}
if pdf_page_height <> 0 then
cur_page_height := pdf_page_height
else
cur_page_height := height(p) + depth(p) + 2*cur_v_offset + 2*4736286
{4736286 = 1in, the funny DVI origin offset}
@ @<Initialize variables as |ship_out| begins@>=
dvi_h:=0; dvi_v:=0; cur_h:=h_offset; dvi_f:=null_font;
@<Calculate DVI page dimensions and margins@>;
ensure_dvi_open;
if total_pages=0 then
begin dvi_out(pre); dvi_out(id_byte); {output the preamble}
@^preamble of \.{DVI} file@>
dvi_four(25400000); dvi_four(473628672); {conversion ratio for sp}
prepare_mag; dvi_four(mag); {magnification factor is frozen}
old_setting:=selector; selector:=new_string;
print(" TeX output "); print_int(year); print_char(".");
print_two(month); print_char("."); print_two(day);
print_char(":"); print_two(time div 60);
print_two(time mod 60);
selector:=old_setting; dvi_out(cur_length);
for s:=str_start[str_ptr] to pool_ptr-1 do dvi_out(so(str_pool[s]));
pool_ptr:=str_start[str_ptr]; {flush the current string}
end
@ When |hlist_out| is called, its duty is to output the box represented
by the |hlist_node| pointed to by |temp_ptr|. The reference point of that
box has coordinates |(cur_h,cur_v)|.
Similarly, when |vlist_out| is called, its duty is to output the box represented
by the |vlist_node| pointed to by |temp_ptr|. The reference point of that
box has coordinates |(cur_h,cur_v)|.
@^recursion@>
@p procedure@?vlist_out; forward; {|hlist_out| and |vlist_out| are mutually
recursive}
@ The recursive procedures |hlist_out| and |vlist_out| each have local variables
|save_h| and |save_v| to hold the values of |dvi_h| and |dvi_v| just before
entering a new level of recursion. In effect, the values of |save_h| and
|save_v| on \TeX's run-time stack correspond to the values of |h| and |v|
that a \.{DVI}-reading program will push onto its coordinate stack.
@d move_past=13 {go to this label when advancing past glue or a rule}
@d fin_rule=14 {go to this label to finish processing a rule}
@d next_p=15 {go to this label when finished with node |p|}
@p @t\4@>@<Declare procedures needed in |hlist_out|, |vlist_out|@>@t@>@/
procedure hlist_out; {output an |hlist_node| box}
label reswitch, move_past, fin_rule, next_p;
var base_line: scaled; {the baseline coordinate for this box}
@!left_edge: scaled; {the left coordinate for this box}
@!save_h,@!save_v: scaled; {what |dvi_h| and |dvi_v| should pop to}
@!this_box: pointer; {pointer to containing box}
@!g_order: glue_ord; {applicable order of infinity for glue}
@!g_sign: normal..shrinking; {selects type of glue}
@!p:pointer; {current position in the hlist}
@!save_loc:integer; {\.{DVI} byte location upon entry}
@!leader_box:pointer; {the leader box being replicated}
@!leader_wd:scaled; {width of leader box being replicated}
@!lx:scaled; {extra space between leader boxes}
@!outer_doing_leaders:boolean; {were we doing leaders?}
@!edge:scaled; {right edge of sub-box or leader space}
@!prev_p:pointer; {one step behind |p|}
@!glue_temp:real; {glue value before rounding}
@!cur_glue:real; {glue seen so far}
@!cur_g:scaled; {rounded equivalent of |cur_glue| times the glue ratio}
begin cur_g:=0; cur_glue:=float_constant(0);
this_box:=temp_ptr; g_order:=glue_order(this_box);
g_sign:=glue_sign(this_box); p:=list_ptr(this_box);
incr(cur_s);
if cur_s>0 then dvi_out(push);
if cur_s>max_push then max_push:=cur_s;
save_loc:=dvi_offset+dvi_ptr; base_line:=cur_v;
prev_p:=this_box+list_offset;
@<Initialize |hlist_out| for mixed direction typesetting@>;
left_edge:=cur_h;
while p<>null do @<Output node |p| for |hlist_out| and move to the next node,
maintaining the condition |cur_v=base_line|@>;
@<Finish |hlist_out| for mixed direction typesetting@>;
prune_movements(save_loc);
if cur_s>0 then dvi_pop(save_loc);
decr(cur_s);
end;
@ We ought to give special care to the efficiency of one part of |hlist_out|,
since it belongs to \TeX's inner loop. When a |char_node| is encountered,
we save a little time by processing several nodes in succession until
reaching a non-|char_node|. The program uses the fact that |set_char_0=0|.
@^inner loop@>
@<Output node |p| for |hlist_out|...@>=
reswitch: if is_char_node(p) then
begin synch_h; synch_v;
repeat f:=font(p); c:=character(p);
if f<>dvi_f then @<Change font |dvi_f| to |f|@>;
if c>=qi(128) then dvi_out(set1);
dvi_out(qo(c));@/
cur_h:=cur_h+char_width(f)(char_info(f)(c));
prev_p:=link(prev_p); {N.B.: not |prev_p:=p|, |p| might be |lig_trick|}
p:=link(p);
until not is_char_node(p);
dvi_h:=cur_h;
end
else @<Output the non-|char_node| |p| for |hlist_out|
and move to the next node@>
@ @<Change font |dvi_f| to |f|@>=
begin if not font_used[f] then
begin dvi_font_def(f); font_used[f]:=true;
end;
if f<=64+font_base then dvi_out(f-font_base-1+fnt_num_0)
else begin dvi_out(fnt1); dvi_out(f-font_base-1);
end;
dvi_f:=f;
end
@ @<Output the non-|char_node| |p| for |hlist_out|...@>=
begin case type(p) of
hlist_node,vlist_node:@<Output a box in an hlist@>;
rule_node: begin rule_ht:=height(p); rule_dp:=depth(p); rule_wd:=width(p);
goto fin_rule;
end;
whatsit_node: @<Output the whatsit node |p| in an hlist@>;
glue_node: @<Move right or output leaders@>;
margin_kern_node,
kern_node:cur_h:=cur_h+width(p);
math_node: @<Handle a math node in |hlist_out|@>;
ligature_node: @<Make node |p| look like a |char_node| and |goto reswitch|@>;
@/@<Cases of |hlist_out| that arise in mixed direction text only@>@;
othercases do_nothing
endcases;@/
goto next_p;
fin_rule: @<Output a rule in an hlist@>;
move_past: cur_h:=cur_h+rule_wd;
next_p:prev_p:=p; p:=link(p);
end
@ @<Output a box in an hlist@>=
if list_ptr(p)=null then cur_h:=cur_h+width(p)
else begin save_h:=dvi_h; save_v:=dvi_v;
cur_v:=base_line+shift_amount(p); {shift the box down}
temp_ptr:=p; edge:=cur_h+width(p);
if cur_dir=right_to_left then cur_h:=edge;
if type(p)=vlist_node then vlist_out@+else hlist_out;
dvi_h:=save_h; dvi_v:=save_v;
cur_h:=edge; cur_v:=base_line;
end
@ @<Output a rule in an hlist@>=
if is_running(rule_ht) then rule_ht:=height(this_box);
if is_running(rule_dp) then rule_dp:=depth(this_box);
rule_ht:=rule_ht+rule_dp; {this is the rule thickness}
if (rule_ht>0)and(rule_wd>0) then {we don't output empty rules}
begin synch_h; cur_v:=base_line+rule_dp; synch_v;
dvi_out(set_rule); dvi_four(rule_ht); dvi_four(rule_wd);
cur_v:=base_line; dvi_h:=dvi_h+rule_wd;
end
@ @d billion==float_constant(1000000000)
@d vet_glue(#)== glue_temp:=#;
if glue_temp>billion then
glue_temp:=billion
else if glue_temp<-billion then
glue_temp:=-billion
@#
@d round_glue==g:=glue_ptr(p); rule_wd:=width(g)-cur_g;
if g_sign<>normal then
begin if g_sign=stretching then
begin if stretch_order(g)=g_order then
begin cur_glue:=cur_glue+stretch(g);
vet_glue(float(glue_set(this_box))*cur_glue);
@^real multiplication@>
cur_g:=round(glue_temp);
end;
end
else if shrink_order(g)=g_order then
begin cur_glue:=cur_glue-shrink(g);
vet_glue(float(glue_set(this_box))*cur_glue);
cur_g:=round(glue_temp);
end;
end;
rule_wd:=rule_wd+cur_g
@<Move right or output leaders@>=
begin round_glue;
if eTeX_ex then @<Handle a glue node for mixed direction typesetting@>;
if subtype(p)>=a_leaders then
@<Output leaders in an hlist, |goto fin_rule| if a rule
or to |next_p| if done@>;
goto move_past;
end
@ @<Output leaders in an hlist...@>=
begin leader_box:=leader_ptr(p);
if type(leader_box)=rule_node then
begin rule_ht:=height(leader_box); rule_dp:=depth(leader_box);
goto fin_rule;
end;
leader_wd:=width(leader_box);
if (leader_wd>0)and(rule_wd>0) then
begin rule_wd:=rule_wd+10; {compensate for floating-point rounding}
if cur_dir=right_to_left then cur_h:=cur_h-10;
edge:=cur_h+rule_wd; lx:=0;
@<Let |cur_h| be the position of the first box, and set |leader_wd+lx|
to the spacing between corresponding parts of boxes@>;
while cur_h+leader_wd<=edge do
@<Output a leader box at |cur_h|,
then advance |cur_h| by |leader_wd+lx|@>;
if cur_dir=right_to_left then cur_h:=edge
else cur_h:=edge-10;
goto next_p;
end;
end
@ The calculations related to leaders require a bit of care. First, in the
case of |a_leaders| (aligned leaders), we want to move |cur_h| to
|left_edge| plus the smallest multiple of |leader_wd| for which the result
is not less than the current value of |cur_h|; i.e., |cur_h| should become
$|left_edge|+|leader_wd|\times\lceil
(|cur_h|-|left_edge|)/|leader_wd|\rceil$. The program here should work in
all cases even though some implementations of \PASCAL\ give nonstandard
results for the |div| operation when |cur_h| is less than |left_edge|.
In the case of |c_leaders| (centered leaders), we want to increase |cur_h|
by half of the excess space not occupied by the leaders; and in the
case of |x_leaders| (expanded leaders) we increase |cur_h|
by $1/(q+1)$ of this excess space, where $q$ is the number of times the
leader box will be replicated. Slight inaccuracies in the division might
accumulate; half of this rounding error is placed at each end of the leaders.
@<Let |cur_h| be the position of the first box, ...@>=
if subtype(p)=a_leaders then
begin save_h:=cur_h;
cur_h:=left_edge+leader_wd*((cur_h-left_edge)@!div leader_wd);
if cur_h<save_h then cur_h:=cur_h+leader_wd;
end
else begin lq:=rule_wd div leader_wd; {the number of box copies}
lr:=rule_wd mod leader_wd; {the remaining space}
if subtype(p)=c_leaders then cur_h:=cur_h+(lr div 2)
else begin lx:=lr div (lq+1);
cur_h:=cur_h+((lr-(lq-1)*lx) div 2);
end;
end
@ The `\\{synch}' operations here are intended to decrease the number of
bytes needed to specify horizontal and vertical motion in the \.{DVI} output.
@<Output a leader box at |cur_h|, ...@>=
begin cur_v:=base_line+shift_amount(leader_box); synch_v; save_v:=dvi_v;@/
synch_h; save_h:=dvi_h; temp_ptr:=leader_box;
if cur_dir=right_to_left then cur_h:=cur_h+leader_wd;
outer_doing_leaders:=doing_leaders; doing_leaders:=true;
if type(leader_box)=vlist_node then vlist_out@+else hlist_out;
doing_leaders:=outer_doing_leaders;
dvi_v:=save_v; dvi_h:=save_h; cur_v:=base_line;
cur_h:=save_h+leader_wd+lx;
end
@ The |vlist_out| routine is similar to |hlist_out|, but a bit simpler.
@p procedure vlist_out; {output a |vlist_node| box}
label move_past, fin_rule, next_p;
var left_edge: scaled; {the left coordinate for this box}
@!top_edge: scaled; {the top coordinate for this box}
@!save_h,@!save_v: scaled; {what |dvi_h| and |dvi_v| should pop to}
@!this_box: pointer; {pointer to containing box}
@!g_order: glue_ord; {applicable order of infinity for glue}
@!g_sign: normal..shrinking; {selects type of glue}
@!p:pointer; {current position in the vlist}
@!save_loc:integer; {\.{DVI} byte location upon entry}
@!leader_box:pointer; {the leader box being replicated}
@!leader_ht:scaled; {height of leader box being replicated}
@!lx:scaled; {extra space between leader boxes}
@!outer_doing_leaders:boolean; {were we doing leaders?}
@!edge:scaled; {bottom boundary of leader space}
@!glue_temp:real; {glue value before rounding}
@!cur_glue:real; {glue seen so far}
@!cur_g:scaled; {rounded equivalent of |cur_glue| times the glue ratio}
begin cur_g:=0; cur_glue:=float_constant(0);
this_box:=temp_ptr; g_order:=glue_order(this_box);
g_sign:=glue_sign(this_box); p:=list_ptr(this_box);
incr(cur_s);
if cur_s>0 then dvi_out(push);
if cur_s>max_push then max_push:=cur_s;
save_loc:=dvi_offset+dvi_ptr; left_edge:=cur_h; cur_v:=cur_v-height(this_box);
top_edge:=cur_v;
while p<>null do @<Output node |p| for |vlist_out| and move to the next node,
maintaining the condition |cur_h=left_edge|@>;
prune_movements(save_loc);
if cur_s>0 then dvi_pop(save_loc);
decr(cur_s);
end;
@ @<Output node |p| for |vlist_out|...@>=
begin if is_char_node(p) then confusion("vlistout")
@:this can't happen vlistout}{\quad vlistout@>
else @<Output the non-|char_node| |p| for |vlist_out|@>;
next_p:p:=link(p);
end
@ @<Output the non-|char_node| |p| for |vlist_out|@>=
begin case type(p) of
hlist_node,vlist_node:@<Output a box in a vlist@>;
rule_node: begin rule_ht:=height(p); rule_dp:=depth(p); rule_wd:=width(p);
goto fin_rule;
end;
whatsit_node: @<Output the whatsit node |p| in a vlist@>;
glue_node: @<Move down or output leaders@>;
kern_node:cur_v:=cur_v+width(p);
othercases do_nothing
endcases;@/
goto next_p;
fin_rule: @<Output a rule in a vlist, |goto next_p|@>;
move_past: cur_v:=cur_v+rule_ht;
end
@ The |synch_v| here allows the \.{DVI} output to use one-byte commands
for adjusting |v| in most cases, since the baselineskip distance will
usually be constant.
@<Output a box in a vlist@>=
if list_ptr(p)=null then cur_v:=cur_v+height(p)+depth(p)
else begin cur_v:=cur_v+height(p); synch_v;
save_h:=dvi_h; save_v:=dvi_v;
if cur_dir=right_to_left then cur_h:=left_edge-shift_amount(p)
else cur_h:=left_edge+shift_amount(p); {shift the box right}
temp_ptr:=p;
if type(p)=vlist_node then vlist_out@+else hlist_out;
dvi_h:=save_h; dvi_v:=save_v;
cur_v:=save_v+depth(p); cur_h:=left_edge;
end
@ @<Output a rule in a vlist...@>=
if is_running(rule_wd) then rule_wd:=width(this_box);
rule_ht:=rule_ht+rule_dp; {this is the rule thickness}
cur_v:=cur_v+rule_ht;
if (rule_ht>0)and(rule_wd>0) then {we don't output empty rules}
begin if cur_dir=right_to_left then cur_h:=cur_h-rule_wd;
synch_h; synch_v;
dvi_out(put_rule); dvi_four(rule_ht); dvi_four(rule_wd);
cur_h:=left_edge;
end;
goto next_p
@ @<Move down or output leaders@>=
begin g:=glue_ptr(p); rule_ht:=width(g)-cur_g;
if g_sign<>normal then
begin if g_sign=stretching then
begin if stretch_order(g)=g_order then
begin cur_glue:=cur_glue+stretch(g);
vet_glue(float(glue_set(this_box))*cur_glue);
@^real multiplication@>
cur_g:=round(glue_temp);
end;
end
else if shrink_order(g)=g_order then
begin cur_glue:=cur_glue-shrink(g);
vet_glue(float(glue_set(this_box))*cur_glue);
cur_g:=round(glue_temp);
end;
end;
rule_ht:=rule_ht+cur_g;
if subtype(p)>=a_leaders then
@<Output leaders in a vlist, |goto fin_rule| if a rule
or to |next_p| if done@>;
goto move_past;
end
@ @<Output leaders in a vlist...@>=
begin leader_box:=leader_ptr(p);
if type(leader_box)=rule_node then
begin rule_wd:=width(leader_box); rule_dp:=0;
goto fin_rule;
end;
leader_ht:=height(leader_box)+depth(leader_box);
if (leader_ht>0)and(rule_ht>0) then
begin rule_ht:=rule_ht+10; {compensate for floating-point rounding}
edge:=cur_v+rule_ht; lx:=0;
@<Let |cur_v| be the position of the first box, and set |leader_ht+lx|
to the spacing between corresponding parts of boxes@>;
while cur_v+leader_ht<=edge do
@<Output a leader box at |cur_v|,
then advance |cur_v| by |leader_ht+lx|@>;
cur_v:=edge-10; goto next_p;
end;
end
@ @<Let |cur_v| be the position of the first box, ...@>=
if subtype(p)=a_leaders then
begin save_v:=cur_v;
cur_v:=top_edge+leader_ht*((cur_v-top_edge)@!div leader_ht);
if cur_v<save_v then cur_v:=cur_v+leader_ht;
end
else begin lq:=rule_ht div leader_ht; {the number of box copies}
lr:=rule_ht mod leader_ht; {the remaining space}
if subtype(p)=c_leaders then cur_v:=cur_v+(lr div 2)
else begin lx:=lr div (lq+1);
cur_v:=cur_v+((lr-(lq-1)*lx) div 2);
end;
end
@ When we reach this part of the program, |cur_v| indicates the top of a
leader box, not its baseline.
@<Output a leader box at |cur_v|, ...@>=
begin if cur_dir=right_to_left then
cur_h:=left_edge-shift_amount(leader_box)
else cur_h:=left_edge+shift_amount(leader_box);
synch_h; save_h:=dvi_h;@/
cur_v:=cur_v+height(leader_box); synch_v; save_v:=dvi_v;
temp_ptr:=leader_box;
outer_doing_leaders:=doing_leaders; doing_leaders:=true;
if type(leader_box)=vlist_node then vlist_out@+else hlist_out;
doing_leaders:=outer_doing_leaders;
dvi_v:=save_v; dvi_h:=save_h; cur_h:=left_edge;
cur_v:=save_v-height(leader_box)+leader_ht+lx;
end
@ The |hlist_out| and |vlist_out| procedures are now complete, so we are
ready for the |dvi_ship_out| routine that gets them started in the first place.
@p procedure dvi_ship_out(@!p:pointer); {output the box |p|}
label done;
var page_loc:integer; {location of the current |bop|}
@!j,@!k:0..9; {indices to first ten count registers}
@!s:pool_pointer; {index into |str_pool|}
@!old_setting:0..max_selector; {saved |selector| setting}
begin if tracing_output>0 then
begin print_nl(""); print_ln;
print("Completed box being shipped out");
@.Completed box...@>
end;
if term_offset>max_print_line-9 then print_ln
else if (term_offset>0)or(file_offset>0) then print_char(" ");
print_char("["); j:=9;
while (count(j)=0)and(j>0) do decr(j);
for k:=0 to j do
begin print_int(count(k));
if k<j then print_char(".");
end;
update_terminal;
if tracing_output>0 then
begin print_char("]");
begin_diagnostic; show_box(p); end_diagnostic(true);
end;
@<Ship box |p| out@>;
if eTeX_ex then @<Check for LR anomalies at the end of |ship_out|@>;
if tracing_output<=0 then print_char("]");
dead_cycles:=0;
update_terminal; {progress report}
@<Flush the box from memory, showing statistics if requested@>;
end;
@ @<Flush the box from memory, showing statistics if requested@>=
@!stat if tracing_stats>1 then
begin print_nl("Memory usage before: ");
@.Memory usage...@>
print_int(var_used); print_char("&");
print_int(dyn_used); print_char(";");
end;
tats@/
flush_node_list(p);
@!stat if tracing_stats>1 then
begin print(" after: ");
print_int(var_used); print_char("&");
print_int(dyn_used); print("; still untouched: ");
print_int(hi_mem_min-lo_mem_max-1); print_ln;
end;
tats
@ @<Ship box |p| out@>=
@<Update the values of |max_h| and |max_v|; but if the page is too large,
|goto done|@>;
@<Initialize variables as |ship_out| begins@>;
page_loc:=dvi_offset+dvi_ptr;
dvi_out(bop);
for k:=0 to 9 do dvi_four(count(k));
dvi_four(last_bop); last_bop:=page_loc;
cur_v:=height(p)+v_offset; temp_ptr:=p;
if type(p)=vlist_node then vlist_out@+else hlist_out;
dvi_out(eop); incr(total_pages); cur_s:=-1;
done:
@ Sometimes the user will generate a huge page because other error messages
are being ignored. Such pages are not output to the \.{dvi} file, since they
may confuse the printing software.
@<Update the values of |max_h| and |max_v|; but if the page is too large...@>=
if (height(p)>max_dimen)or@|(depth(p)>max_dimen)or@|
(height(p)+depth(p)+v_offset>max_dimen)or@|
(width(p)+h_offset>max_dimen) then
begin print_err("Huge page cannot be shipped out");
@.Huge page...@>
help2("The page just created is more than 18 feet tall or")@/
("more than 18 feet wide, so I suspect something went wrong.");
error;
if tracing_output<=0 then
begin begin_diagnostic;
print_nl("The following box has been deleted:");
@.The following...deleted@>
show_box(p);
end_diagnostic(true);
end;
goto done;
end;
if height(p)+depth(p)+v_offset>max_v then max_v:=height(p)+depth(p)+v_offset;
if width(p)+h_offset>max_h then max_h:=width(p)+h_offset
@ At the end of the program, we must finish things off by writing the
post\-amble. If |total_pages=0|, the \.{DVI} file was never opened.
If |total_pages>=65536|, the \.{DVI} file will lie. And if
|max_push>=65536|, the user deserves whatever chaos might ensue.
An integer variable |k| will be declared for use by this routine.
@<Finish the \.{DVI} file@>=
while cur_s>-1 do
begin if cur_s>0 then dvi_out(pop)
else begin dvi_out(eop); incr(total_pages);
end;
decr(cur_s);
end;
if total_pages=0 then print_nl("No pages of output.")
@.No pages of output@>
else begin dvi_out(post); {beginning of the postamble}
dvi_four(last_bop); last_bop:=dvi_offset+dvi_ptr-5; {|post| location}
dvi_four(25400000); dvi_four(473628672); {conversion ratio for sp}
prepare_mag; dvi_four(mag); {magnification factor}
dvi_four(max_v); dvi_four(max_h);@/
dvi_out(max_push div 256); dvi_out(max_push mod 256);@/
dvi_out((total_pages div 256) mod 256); dvi_out(total_pages mod 256);@/
@<Output the font definitions for all fonts that were used@>;
dvi_out(post_post); dvi_four(last_bop); dvi_out(id_byte);@/
k:=4+((dvi_buf_size-dvi_ptr) mod 4); {the number of 223's}
while k>0 do
begin dvi_out(223); decr(k);
end;
@<Empty the last bytes out of |dvi_buf|@>;
print_nl("Output written on "); slow_print(output_file_name);
@.Output written on x@>
print(" ("); print_int(total_pages); print(" page");
if total_pages<>1 then print_char("s");
print(", "); print_int(dvi_offset+dvi_ptr); print(" bytes).");
b_close(dvi_file);
end
@ @<Output the font definitions...@>=
while font_ptr>font_base do
begin if font_used[font_ptr] then dvi_font_def(font_ptr);
decr(font_ptr);
end
@* \[32a] \pdfTeX\ basic. Initialize \pdfTeX's parameters to some useful
default value. Helpful in case one forgets to set them during \.{INITEX} run.
@<Initialize table entries...@>=
pdf_h_origin := (one_hundred_inch + 50) div 100;
pdf_v_origin := (one_hundred_inch + 50) div 100;
pdf_compress_level := 9;
pdf_objcompresslevel := 0;
pdf_decimal_digits := 3;
pdf_image_resolution := 72;
pdf_major_version := 1;
pdf_minor_version := 4;
pdf_gamma := 1000;
pdf_image_gamma := 2200;
pdf_image_hicolor := 1;
pdf_image_apply_gamma := 0;
pdf_px_dimen := one_bp;
pdf_draftmode := 0;
@ The subroutines define the corresponding macros so we can use them
in C.
@d flushable(#) == (# = str_ptr - 1)
@d is_valid_char(#)==((font_bc[f] <= #) and (# <= font_ec[f]) and
char_exists(char_info(f)(#)))
@p function get_pdf_compress_level: integer;
begin
get_pdf_compress_level := pdf_compress_level;
end;
function get_pdf_suppress_warning_dup_map: integer;
begin
get_pdf_suppress_warning_dup_map := pdf_suppress_warning_dup_map;
end;
function get_pdf_suppress_warning_page_group: integer;
begin
get_pdf_suppress_warning_page_group := pdf_suppress_warning_page_group;
end;
function get_pdf_suppress_ptex_info: integer;
begin
get_pdf_suppress_ptex_info := pdf_suppress_ptex_info;
end;
function get_pdf_omit_charset: integer;
begin
get_pdf_omit_charset := pdf_omit_charset;
end;
function get_nullfont: internal_font_number;
begin
get_nullfont := null_font;
end;
function get_fontbase: internal_font_number;
begin
get_fontbase := font_base;
end;
function get_nullcs: pointer;
begin
get_nullcs := null_cs;
end;
function get_nullptr: pointer;
begin
get_nullptr := null;
end;
function get_tex_int(code: integer): integer;
begin
get_tex_int := int_par(code);
end;
function get_tex_dimen(code: integer): scaled;
begin
get_tex_dimen := dimen_par(code);
end;
function get_x_height(f: internal_font_number): scaled;
begin
get_x_height := x_height(f);
end;
function get_charwidth(f: internal_font_number; c: eight_bits): scaled;
begin
if is_valid_char(c) then
get_charwidth := char_width(f)(char_info(f)(c))
else
get_charwidth := 0;
end;
function get_charheight(f: internal_font_number; c: eight_bits): scaled;
begin
if is_valid_char(c) then
get_charheight := char_height(f)(height_depth(char_info(f)(c)))
else
get_charheight := 0;
end;
function get_chardepth(f: internal_font_number; c: eight_bits): scaled;
begin
if is_valid_char(c) then
get_chardepth := char_depth(f)(height_depth(char_info(f)(c)))
else
get_chardepth := 0;
end;
function get_quad(f: internal_font_number): scaled;
begin
get_quad := quad(f);
end;
function get_slant(f: internal_font_number): scaled;
begin
get_slant := slant(f);
end;
@ Helper for debugging purposes:
@p procedure short_display_n(@!p, m:integer); {prints highlights of list |p|}
var n:integer; {for replacement counts}
i: integer;
begin
i := 0;
font_in_short_display:=null_font;
if p = null then
return;
while p>mem_min do
begin if is_char_node(p) then
begin if p<=mem_end then
begin if font(p)<>font_in_short_display then
begin if (font(p)<font_base)or(font(p)>font_max) then
print_char("*")
@.*\relax@>
else print_font_identifier(font(p));
print_char(" "); font_in_short_display:=font(p);
end;
print_ASCII(qo(character(p)));
end;
end
else begin
if (type(p) = glue_node) or
(type(p) = disc_node) or
(type(p) = penalty_node) or
((type(p) = kern_node) and (subtype(p) = explicit)) then
incr(i);
if i >= m then
return;
if (type(p) = disc_node) then begin
print("|");
short_display(pre_break(p));
print("|");
short_display(post_break(p));
print("|");
n:=replace_count(p);
while n>0 do
begin if link(p)<>null then p:=link(p);
decr(n);
end;
end
else
@<Print a short indication of the contents of node |p|@>;
end;
p:=link(p);
if p = null then
return;
end;
update_terminal;
end;
@ Sometimes it is necessary to allocate memory for PDF output that cannot
be deallocated then, so we use |pdf_mem| for this purpose.
@<Constants...@>=
@!inf_pdf_mem_size = 10000; {min size of the |pdf_mem| array}
@!sup_pdf_mem_size = 10000000; {max size of the |pdf_mem| array}
@ @<Glob...@>=
@!pdf_mem_size: integer;
@!pdf_mem: ^integer;
@!pdf_mem_ptr: integer;
@ @<Set init...@>=
pdf_mem_ptr := 1; {the first word is not used so we can use zero as a value for testing
whether a pointer to |pdf_mem| is valid}
pdf_mem_size := inf_pdf_mem_size; {allocated size of |pdf_mem| array}
@ We use |pdf_get_mem| to allocate memory in |pdf_mem|.
@p function pdf_get_mem(s: integer): integer; {allocate |s| words in |pdf_mem|}
var a: integer;
begin
if s > sup_pdf_mem_size - pdf_mem_ptr then
overflow("PDF memory size (pdf_mem_size)", pdf_mem_size);
if pdf_mem_ptr + s > pdf_mem_size then begin
a := 0.2 * pdf_mem_size;
if pdf_mem_ptr + s > pdf_mem_size + a then
pdf_mem_size := pdf_mem_ptr + s
else if pdf_mem_size < sup_pdf_mem_size - a then
pdf_mem_size := pdf_mem_size + a
else
pdf_mem_size := sup_pdf_mem_size;
pdf_mem := xrealloc_array(pdf_mem, integer, pdf_mem_size);
end;
pdf_get_mem := pdf_mem_ptr;
pdf_mem_ptr := pdf_mem_ptr + s;
end;
@* \[32b] \pdfTeX\ output low-level subroutines.
We use the similar subroutines to handle the output buffer for
PDF output. When compress is used, the state of writing to buffer
is held in |zip_write_state|. We must write the header of PDF
output file in initialization to ensure that it will be the first
written bytes.
@<Constants...@>=
@!pdf_op_buf_size = 16384; {size of the PDF output buffer}
@!inf_pdf_os_buf_size = 1; {initial value of |pdf_os_buf_size|}
@!sup_pdf_os_buf_size = 5000000; {arbitrary upper hard limit of |pdf_os_buf_size|}
@!pdf_os_max_objs = 100; {maximum number of objects in object stream}
@ The following macros are similar as for \.{DVI} buffer handling:
@d pdf_offset == (pdf_gone + pdf_ptr) {the file offset of last byte in PDF
buffer that |pdf_ptr| points to}
@d no_zip == 0 {no \.{ZIP} compression}
@d zip_writing == 1 {\.{ZIP} compression being used}
@d zip_finish == 2 {finish \.{ZIP} compression}
@d pdf_quick_out(#) == {output a byte to PDF buffer without checking of
overflow}
begin
pdf_buf[pdf_ptr] := #;
incr(pdf_ptr);
end
@d pdf_room(#) == {make sure that there are at least |n| bytes free in PDF buffer}
begin
if pdf_os_mode and (# + pdf_ptr > pdf_buf_size) then
pdf_os_get_os_buf(#)
else if not pdf_os_mode and (# > pdf_buf_size) then
overflow("PDF output buffer", pdf_op_buf_size)
else if not pdf_os_mode and (# + pdf_ptr > pdf_buf_size) then
pdf_flush;
end
@d pdf_out(#) == {do the same as |pdf_quick_out| and flush the PDF
buffer if necessary}
begin
pdf_room(1);
pdf_quick_out(#);
end
@<Glob...@>=
@!pdf_file: byte_file; {the PDF output file}
@!pdf_buf: ^eight_bits; {pointer to the PDF output buffer or PDF object stream buffer}
@!pdf_buf_size: integer; {end of PDF output buffer or PDF object stream buffer}
@!pdf_ptr: integer; {pointer to the first unused byte in the PDF buffer or object stream buffer}
@!pdf_op_buf: ^eight_bits; {the PDF output buffer}
@!pdf_os_buf: ^eight_bits; {the PDF object stream buffer}
@!pdf_os_buf_size: integer; {current size of the PDF object stream buffer, grows dynamically}
@!pdf_os_objnum: ^integer; {array of object numbers within object stream}
@!pdf_os_objoff: ^integer; {array of object offsets within object stream}
@!pdf_os_objidx: pointer; {pointer into |pdf_os_objnum| and |pdf_os_objoff|}
@!pdf_os_cntr: integer; {counter for object stream objects}
@!pdf_op_ptr: integer; {store for PDF buffer |pdf_ptr| while inside object streams}
@!pdf_os_ptr: integer; {store for object stream |pdf_ptr| while outside object streams}
@!pdf_os_mode: boolean; {true if producing object stream}
@!pdf_os_enable: boolean; {true if object streams are globally enabled}
@!pdf_os_cur_objnum: integer; {number of current object stream object}
@!pdf_gone: longinteger; {number of bytes that were flushed to output}
@!pdf_save_offset: longinteger; {to save |pdf_offset|}
@!zip_write_state: integer; {which state of compression we are in}
@!fixed_pdf_major_version: integer; {fixed major part of the PDF version}
@!fixed_pdf_minor_version: integer; {fixed minor part of the PDF version}
@!fixed_pdf_objcompresslevel: integer; {fixed level for activating PDF object streams}
@!pdf_version_written: boolean; {flag if the PDF version has been written}
@!fixed_pdfoutput: integer; {fixed output format}
@!fixed_pdfoutput_set: boolean; {|fixed_pdfoutput| has been set?}
@!fixed_gamma: integer;
@!fixed_image_gamma: integer;
@!fixed_image_hicolor: boolean;
@!fixed_image_apply_gamma: integer;
@!epochseconds: integer;
@!microseconds: integer;
@!fixed_pdf_draftmode: integer; {fixed \\pdfdraftmode}
@!fixed_pdf_draftmode_set: boolean; {|fixed_pdf_draftmode| has been set?}
@!pdf_page_group_val: integer;
@ @<Set init...@>=
pdf_gone := 0;
pdf_os_mode := false;
pdf_ptr := 0;
pdf_op_ptr := 0;
pdf_os_ptr := 0;
pdf_os_cur_objnum := 0;
pdf_os_cntr := 0;
pdf_buf_size := pdf_op_buf_size;
pdf_os_buf_size := inf_pdf_os_buf_size;
pdf_buf := pdf_op_buf;
pdf_seek_write_length := false;
zip_write_state := no_zip;
pdf_version_written := false;
fixed_pdfoutput_set := false;
fixed_pdf_draftmode_set := false;
@ @p
function fix_int(val, min, max: integer): integer;
begin
if val < min then
fix_int := min
else if val > max then
fix_int := max
else
fix_int := val;
end;
@ This ensures that |pdf_major_version| and |pdf_minor_version| are set
to reasonable values before any bytes have been written to the generated
PDF file. We also save their current values in case the user tries to
change them later, along with |pdf_objcompresslevel|,
|pdf_image_hicolor|, and various other parameters that must be fixed
before any PDF output happens.
Here also the PDF file is opened by |ensure_pdf_open| and the PDF header
is written.
@p procedure check_pdfversion;
begin
if not pdf_version_written then begin
pdf_version_written := true;
if pdf_major_version < 1 then begin
print_err("pdfTeX error (invalid pdfmajorversion)");
print_ln;
help2 ("The pdfmajorversion must be 1 or greater.")@/
("I changed this to 1.");
int_error (pdf_major_version);
pdf_major_version := 1;
end;
if (pdf_minor_version < 0) or (pdf_minor_version > 9) then begin
print_err("pdfTeX error (invalid pdfminorversion)");
print_ln;
help2 ("The pdfminorversion must be between 0 and 9.")@/
("I changed this to 4.");
int_error (pdf_minor_version);
pdf_minor_version := 4;
end;
fixed_pdf_major_version := pdf_major_version;
fixed_pdf_minor_version := pdf_minor_version;
fixed_gamma := fix_int(pdf_gamma, 0, 1000000);
fixed_image_gamma := fix_int(pdf_image_gamma, 0, 1000000);
fixed_image_hicolor := fix_int(pdf_image_hicolor, 0, 1);
fixed_image_apply_gamma := fix_int(pdf_image_apply_gamma, 0, 1);
fixed_pdf_objcompresslevel := fix_int(pdf_objcompresslevel, 0, 3);
fixed_pdf_draftmode := fix_int(pdf_draftmode, 0, 1);
fixed_inclusion_copy_font := fix_int(pdf_inclusion_copy_font, 0, 1);
if ((fixed_pdf_major_version > 1) or (fixed_pdf_minor_version >= 5))
and (fixed_pdf_objcompresslevel > 0) then
pdf_os_enable := true
else begin
if fixed_pdf_objcompresslevel > 0 then begin
pdf_warning("Object streams", "\pdfobjcompresslevel > 0 requires PDF-1.5 or greater. Object streams disabled now.", true, true);
fixed_pdf_objcompresslevel := 0;
end;
pdf_os_enable := false;
end;
ensure_pdf_open;
fix_pdfoutput;
pdf_print("%PDF-");
pdf_print_int(fixed_pdf_major_version);
pdf_print(".");
pdf_print_int_ln(fixed_pdf_minor_version);
pdf_print("%");
pdf_out(208); {'P' + 128}
pdf_out(212); {'T' + 128}
pdf_out(197); {'E' + 128}
pdf_out(216); {'X' + 128}
pdf_print_nl;
end
else begin
if (fixed_pdf_minor_version <> pdf_minor_version)
or (fixed_pdf_major_version <> pdf_major_version) then
pdf_error("setup",
"PDF version cannot be changed after data is written to the PDF file");
end;
end;
@ Checks that we have a name for the generated PDF file and that it's open.
@p procedure ensure_pdf_open;
begin
if output_file_name <> 0 then
return;
if job_name = 0 then
open_log_file;
pack_job_name(".pdf");
if fixed_pdf_draftmode = 0 then
while not b_open_out(pdf_file) do
prompt_file_name("file name for output",".pdf");
output_file_name := b_make_name_string(pdf_file);
end;
@ The PDF buffer is flushed by calling |pdf_flush|, which checks the
variable |zip_write_state| and will compress the buffer before flushing if
necessary. We call |pdf_begin_stream| to begin a stream and |pdf_end_stream|
to finish it. The stream contents will be compressed if compression is turn on.
@p procedure pdf_flush; {flush out the |pdf_buf|}
var saved_pdf_gone : longinteger;
begin
if not pdf_os_mode then begin
saved_pdf_gone := pdf_gone;
case zip_write_state of
no_zip: if pdf_ptr > 0 then begin
if fixed_pdf_draftmode = 0 then write_pdf(0, pdf_ptr - 1);
pdf_gone := pdf_gone + pdf_ptr;
pdf_last_byte := pdf_buf[pdf_ptr - 1];
end;
zip_writing:
if fixed_pdf_draftmode = 0 then write_zip(false);
zip_finish: begin
if fixed_pdf_draftmode = 0 then write_zip(true);
zip_write_state := no_zip;
end;
end;
pdf_ptr := 0;
if saved_pdf_gone > pdf_gone then
pdf_error("file size", "File size exceeds architectural limits (pdf_gone wraps around)");
end;
end;
procedure pdf_begin_stream; {begin a stream}
begin
pdf_print_ln("/Length ");
pdf_seek_write_length := true; {fill in length at |pdf_end_stream| call}
pdf_stream_length_offset := pdf_offset - 11;
pdf_stream_length := 0;
pdf_last_byte := 0;
if pdf_compress_level > 0 then begin
pdf_print_ln("/Filter /FlateDecode");
pdf_print_ln(">>");
pdf_print_ln("stream");
pdf_flush;
zip_write_state := zip_writing;
end
else begin
pdf_print_ln(">>");
pdf_print_ln("stream");
pdf_save_offset := pdf_offset;
end;
end;
procedure pdf_end_stream; {end a stream}
begin
if zip_write_state = zip_writing then
zip_write_state := zip_finish
else
pdf_stream_length := pdf_offset - pdf_save_offset;
pdf_flush;
if pdf_seek_write_length then
write_stream_length(pdf_stream_length, pdf_stream_length_offset);
pdf_seek_write_length := false;
pdf_out(pdf_new_line_char);
pdf_print_ln("endstream");
pdf_end_obj;
end;
@ Basic printing procedures for PDF output are very similar to \TeX\ basic
printing ones but the output is going to PDF buffer. Subroutines with
suffix |_ln| append a new-line character to the PDF output.
@d pdf_new_line_char == 10 {new-line character for UNIX platforms}
@d pdf_print_nl == {output a new-line character to PDF buffer}
pdf_out(pdf_new_line_char)
@d pdf_print_ln(#) == {print out a string to PDF buffer followed by
a new-line character}
begin
pdf_print(#);
pdf_print_nl;
end
@d pdf_print_int_ln(#) == {print out an integer to PDF buffer followed by
a new-line character}
begin
pdf_print_int(#);
pdf_print_nl;
end
@<Declare procedures that need to be declared forward for \pdfTeX@>=
procedure pdf_error(t, p: str_number);
begin
normalize_selector;
print_err("pdfTeX error");
if t <> 0 then begin
print(" (");
print(t);
print(")");
end;
print(": "); print(p);
succumb;
end;
procedure pdf_warning(t, p: str_number; prepend_nl, append_nl: boolean);
begin
if interaction = error_stop_mode then
wake_up_terminal;
if prepend_nl then
print_ln;
print("pdfTeX warning");
if t <> 0 then begin
print(" (");
print(t);
print(")");
end;
print(": "); print(p);
if append_nl then
print_ln;
if history=spotless then history:=warning_issued;
end;
procedure pdf_os_get_os_buf(s: integer); {check that |s| bytes more
fit into |pdf_os_buf|; increase it if required}
var a: integer;
begin
if s > sup_pdf_os_buf_size - pdf_ptr then
overflow("PDF object stream buffer", pdf_os_buf_size);
if pdf_ptr + s > pdf_os_buf_size then begin
a := 0.2 * pdf_os_buf_size;
if pdf_ptr + s > pdf_os_buf_size + a then
pdf_os_buf_size := pdf_ptr + s
else if pdf_os_buf_size < sup_pdf_os_buf_size - a then
pdf_os_buf_size := pdf_os_buf_size + a
else
pdf_os_buf_size := sup_pdf_os_buf_size;
pdf_os_buf := xrealloc_array(pdf_os_buf, eight_bits, pdf_os_buf_size);
pdf_buf := pdf_os_buf;
pdf_buf_size := pdf_os_buf_size;
end;
end;
procedure remove_last_space;
begin
if (pdf_ptr > 0) and (pdf_buf[pdf_ptr - 1] = 32) then
decr(pdf_ptr);
end;
procedure pdf_print_octal(n: integer); {prints an integer in octal form to
PDF buffer}
var k:0..23; {index to current digit; we assume that $|n|<10^{23}$}
begin
k:=0;
repeat dig[k]:=n mod 8; n:=n div 8; incr(k);
until n=0;
if k = 1 then begin
pdf_out("0");
pdf_out("0");
end;
if k = 2 then
pdf_out("0");
while k>0 do begin
decr(k);
pdf_out("0"+dig[k]);
end;
end;
procedure pdf_print_char(f: internal_font_number; c: integer);
{ print out a character to PDF buffer; the character will be printed in octal
form in the following cases: chars <= 32, backslash (92), left parenthesis
(40) and right parenthesis (41) }
begin
pdf_mark_char(f, c);
if (c <= 32) or (c = 92) or (c = 40) or (c = 41) or (c > 127) then begin
pdf_out(92); {output a backslash}
pdf_print_octal(c);
end
else
pdf_out(c);
end;
procedure pdf_print(s: str_number); {print out a string to PDF buffer}
var j: pool_pointer; {current character code position}
c: integer;
begin
j := str_start[s];
while j < str_start[s + 1] do begin
c := str_pool[j];
pdf_out(c);
incr(j);
end;
end;
function str_in_str(s, r: str_number; i: integer): boolean;
{test equality of strings}
label not_found; {loop exit}
var j, k: pool_pointer; {running indices}
begin
str_in_str := false;
if length(s) < i + length(r) then
return;
j := i + str_start[s];
k := str_start[r];
while (j < str_start[s + 1]) and (k < str_start[r + 1]) do begin
if str_pool[j] <> str_pool[k] then
return;
incr(j);
incr(k);
end;
str_in_str := true;
end;
procedure pdf_print_int(n:longinteger); {print out a integer to PDF buffer}
var k:integer; {index to current digit ($0\le k\le23$); we assume that $|n|<10^{23}$}
m:longinteger; {used to negate |n| in possibly dangerous cases}
begin
k:=0;
if n<0 then
begin pdf_out("-");
if n>-100000000 then negate(n)
else begin m:=-1-n; n:=m div 10; m:=(m mod 10)+1; k:=1;
if m<10 then dig[0]:=m
else begin dig[0]:=0; incr(n);
end;
end;
end;
repeat dig[k]:=n mod 10; n:=n div 10; incr(k);
until n=0;
pdf_room(k);
while k>0 do begin
decr(k);
pdf_quick_out("0"+dig[k]);
end;
end;
procedure pdf_print_two(n:integer); {prints two least significant digits in
decimal form to PDF buffer}
begin n:=abs(n) mod 100; pdf_out("0"+(n div 10));
pdf_out("0"+(n mod 10));
end;
function tokens_to_string(p: pointer): str_number; {return a string from tokens
list}
begin
if selector = new_string then
pdf_error("tokens", "tokens_to_string() called while selector = new_string");
old_setting:=selector; selector:=new_string;
show_token_list(link(p),null,pool_size-pool_ptr);
selector:=old_setting;
last_tokens_string := make_string;
tokens_to_string := last_tokens_string;
end;
@ To print |scaled| value to PDF output we need some subroutines to ensure
accuracy.
@d max_integer == @"7FFFFFFF {$2^{31}-1$}
@d call_func(#) == begin if # <> 0 then do_nothing end
@<Glob...@>=
@!one_bp: scaled; {scaled value corresponds to 1bp}
@!one_hundred_bp: scaled; {scaled value corresponds to 100bp}
@!one_hundred_inch: scaled; {scaled value corresponds to 100in}
@!ten_pow: array[0..9] of integer; {$10^0..10^9$}
@!scaled_out: integer; {amount of |scaled| that was taken out in
|divide_scaled|}
@!init_pdf_output: boolean;
@!adv_char_width_s: integer; {to save result of calculation done in |adv_char_width| }
@!adv_char_width_s_out: scaled;
@ @<Set init...@>=
one_bp := 65782; {65781.76}
one_hundred_bp := 6578176;
one_hundred_inch := 473628672;
ten_pow[0] := 1;
for i := 1 to 9 do
ten_pow[i] := 10*ten_pow[i - 1];
init_pdf_output := false;
@ The following function divides |s| by |m|. |dd| is number of decimal digits.
@<Declare procedures that need to be declared forward for \pdfTeX@>=
function divide_scaled(s, m: scaled; dd: integer): scaled;
var q, r: scaled;
sign, i: integer;
begin
sign := 1;
if s < 0 then begin
sign := -sign;
s := -s;
end;
if m < 0 then begin
sign := -sign;
m := -m;
end;
if m = 0 then
pdf_error("arithmetic", "divided by zero")
else if m >= (max_integer div 10) then
pdf_error("arithmetic", "number too big");
q := s div m;
r := s mod m;
for i := 1 to dd do begin
q := 10*q + (10*r) div m;
r := (10*r) mod m;
end;
if 2*r >= m then begin
incr(q);
r := r - m;
end;
scaled_out := sign*(s - (r div ten_pow[dd]));
divide_scaled := sign*q;
end;
function round_xn_over_d(@!x:scaled; @!n,@!d:integer):scaled;
var positive:boolean; {was |x>=0|?}
@!t,@!u,@!v:nonnegative_integer; {intermediate quantities}
begin if x>=0 then positive:=true
else begin negate(x); positive:=false;
end;
t:=(x mod @'100000)*n;
u:=(x div @'100000)*n+(t div @'100000);
v:=(u mod d)*@'100000 + (t mod @'100000);
if u div d>=@'100000 then arith_error:=true
else u:=@'100000*(u div d) + (v div d);
v := v mod d;
if 2*v >= d then
incr(u);
if positive then
round_xn_over_d := u
else
round_xn_over_d := -u;
end;
@ Next subroutines are needed for controlling spacing in PDF page description.
For a given character |c| from a font |f|,
the procedure |adv_char_width| advances |pdf_h|
by {\it about\/} the amount |w|, which is the character width.
But we cannot simply add |w| to |pdf_h|.
Instead we have to bring the required shift into the same raster,
on which also the \.{/Widths} array values,
as they appear in the PDF file, are based.
The |scaled_out| value is the |w| value moved into this raster.
The \.{/Widths} values are used by the PDF reader independently
to update its positions.
So one has to be sure, that calculations are properly synchronized.
Currently the \.{/Widths} array values are output
with one digit after the decimal point,
therefore the raster on which |adv_char_width| is operating
is $1/10000$ of the |pdf_font_size|.
For PK fonts things are more complicated,
as we have to deal with scaling bitmaps as well.
@p
procedure adv_char_width(f: internal_font_number; c: eight_bits; dd: eight_bits);
{update |pdf_delta_h| by character width |w| from font |f|}
var w, s_out: scaled;
s: integer;
begin
w := char_width(f)(char_info(f)(c));
if isscalable(f) then begin
if pdf_cur_Tm_a = 0 then begin
s := divide_scaled(w, pdf_font_size[f], dd);
s_out := scaled_out;
pdf_delta_h := pdf_delta_h + s_out;
end
else begin
s := divide_scaled(round_xn_over_d(w, 1000, 1000 + pdf_cur_Tm_a),
pdf_font_size[f],
dd);
s_out := round_xn_over_d(round_xn_over_d(pdf_font_size[f], abs(s), 10000),
1000 + pdf_cur_Tm_a, 1000);
if s < 0 then
s_out := -s_out;
pdf_delta_h := pdf_delta_h + s_out;
end;
adv_char_width_s := s;
adv_char_width_s_out := s_out;
end else
pdf_delta_h := pdf_delta_h + get_pk_char_width(f, w);
end;
procedure pdf_print_real(m, d: integer); {print $m/10^d$ as real}
begin
if m < 0 then begin
pdf_out("-");
m := -m;
end;
pdf_print_int(m div ten_pow[d]);
m := m mod ten_pow[d];
if m > 0 then begin
pdf_out(".");
decr(d);
while m < ten_pow[d] do begin
pdf_out("0");
decr(d);
end;
while m mod 10 = 0 do
m := m div 10;
pdf_print_int(m);
end;
end;
procedure pdf_print_bp(s: scaled); {print scaled as |bp|}
begin
pdf_print_real(divide_scaled(s, one_hundred_bp, fixed_decimal_digits + 2),
fixed_decimal_digits);
end;
procedure pdf_print_mag_bp(s: scaled); {take |mag| into account}
begin
prepare_mag;
if mag <> 1000 then
s := round_xn_over_d(s, mag, 1000);
pdf_print_bp(s);
end;
@* \[32c] PDF page description.
@d pdf_x(#) == ((#) - pdf_origin_h) {convert $x$-coordinate from \.{DVI} to
PDF}
@d pdf_y(#) == (pdf_origin_v - (#)) {convert $y$-coordinate from \.{DVI} to
PDF}
@d dvi_x(#) == ((#) + pdf_origin_h) {convert $x$-coordinate from \.{PDF} to
DVI}
@d dvi_y(#) == (pdf_origin_v - (#)) {convert $y$-coordinate from \.{PDF} to
DVI}
@<Glob...@>=
@!pdf_f: internal_font_number; {the current font in PDF output page}
@!pdf_h: scaled; {current horizontal coordinate in PDF output page}
@!pdf_v: scaled; {current vertical coordinate in PDF output page}
@!pdf_tj_start_h: scaled; {horizontal coordinate in PDF output page just before \.{TJ} array start}
@!cur_delta_h: scaled; {horizontal |cur_h| offset from |pdf_tj_start_h|}
@!pdf_delta_h: scaled; {horizontal offset from |pdf_tj_start_h|}
@!pdf_origin_h: scaled; {current horizontal origin in PDF output page}
@!pdf_origin_v: scaled; {current vertical origin in PDF output page}
@!pdf_doing_string: boolean; {we are writing string to PDF file?}
@!pdf_doing_text: boolean; {we are writing text section to PDF file?}
@!min_bp_val: scaled;
@!min_font_val: scaled; {(TJ array system)}
@!fixed_pk_resolution: integer;
@!fixed_decimal_digits: integer;
@!fixed_gen_tounicode: integer;
@!fixed_inclusion_copy_font: integer;
@!pk_scale_factor: integer;
@!pdf_output_option: integer;
@!pdf_output_value: integer;
@!pdf_draftmode_option: integer;
@!pdf_draftmode_value: integer;
@!pdf_cur_Tm_a: integer; {|a| value of the current text matrix, i.e., the current
horizontal scaling factor}
@!pdf_last_f: internal_font_number; {last font in PDF output page}
@!pdf_last_fs: internal_font_number; {last font size in PDF output page}
@!pdf_dummy_font: internal_font_number; {font used to insert artificial interword spaces}
@ Following procedures implement low-level subroutines to convert \TeX{}
internal structures to PDF page description.
@p procedure pdf_set_origin(h, v: scaled); {set the origin to |h|, |v|}
begin
if (abs(h - pdf_origin_h) >= min_bp_val) or
(abs(v - pdf_origin_v) >= min_bp_val) then begin
pdf_print("1 0 0 1 ");
pdf_print_bp(h - pdf_origin_h);
pdf_origin_h := pdf_origin_h + scaled_out;
pdf_out(" ");
pdf_print_bp(pdf_origin_v - v);
pdf_origin_v := pdf_origin_v - scaled_out;
pdf_print_ln(" cm");
end;
pdf_h := pdf_origin_h;
pdf_tj_start_h := pdf_h;
pdf_v := pdf_origin_v;
end;
procedure pdf_set_origin_temp(h, v: scaled); {set the origin to |h|, |v| inside group}
begin
if (abs(h - pdf_origin_h) >= min_bp_val) or
(abs(v - pdf_origin_v) >= min_bp_val) then begin
pdf_print("1 0 0 1 ");
pdf_print_bp(h - pdf_origin_h);
pdf_out(" ");
pdf_print_bp(pdf_origin_v - v);
pdf_print_ln(" cm");
end;
end;
procedure pdf_end_string; {end the current string}
begin
if pdf_doing_string then begin
pdf_print(")]TJ");
pdf_doing_string := false;
end;
end;
procedure pdf_end_string_nl; {end the current string, with new-line}
begin
if pdf_doing_string then begin
pdf_print_ln(")]TJ");
pdf_doing_string := false;
end;
end;
procedure pdf_set_textmatrix(v, v_out: scaled; f: internal_font_number);
{set the next starting point to |cur_h|, |cur_v|}
var pdf_new_Tm_a: integer; {|a| value of the new text matrix}
begin
pdf_out(" ");
if f = pdf_f then
pdf_new_Tm_a := pdf_cur_Tm_a
else if not pdf_font_auto_expand[f] then
pdf_new_Tm_a := 0
else
pdf_new_Tm_a := pdf_font_expand_ratio[f];
if (pdf_new_Tm_a <> 0) or
((pdf_new_Tm_a = 0) and (pdf_cur_Tm_a <> 0)) then begin
pdf_print_real(1000 + pdf_new_Tm_a, 3);
pdf_print(" 0 0 1 ");
pdf_print_bp(cur_h - pdf_origin_h);
pdf_h := pdf_origin_h + scaled_out;
pdf_out(" ");
pdf_print_bp(pdf_origin_v - cur_v);
pdf_v := pdf_origin_v - scaled_out;
pdf_print(" Tm");
pdf_cur_Tm_a := pdf_new_Tm_a;
pdfassert(pdf_cur_Tm_a > -1000);
end else begin
pdf_print_bp(cur_h - pdf_tj_start_h); {works only for unexpanded fonts}
pdf_h := pdf_tj_start_h + scaled_out;
pdf_out(" ");
pdf_print_real(v, fixed_decimal_digits); {use |v| and |v_out| to avoid duplicate calculation}
pdf_v := pdf_v - v_out;
pdf_print(" Td");
end;
pdf_tj_start_h := pdf_h;
pdf_delta_h := 0;
end;
procedure pdf_use_font(f: internal_font_number; fontnum: integer);
{mark |f| as a used font; set |font_used[f]|, |pdf_font_size[f]| and |pdf_font_num[f]|}
begin
call_func(divide_scaled(font_size[f], one_hundred_bp, 6));
pdf_font_size[f] := scaled_out;
font_used[f] := true;
pdfassert((fontnum > 0) or ((fontnum < 0) and (pdf_font_num[-fontnum] > 0)));
pdf_font_num[f] := fontnum;
if pdf_move_chars > 0 then begin
pdf_warning(0,"Primitive \pdfmovechars is obsolete.",true, true);
pdf_move_chars := 0; {warn only once}
end;
end;
@ To set PDF font we need to find out fonts with the same name, because \TeX\
can load the same font several times for various sizes. For such fonts we
define only one font resource. The array |pdf_font_num| holds the object
number of font resource. A negative value of an entry of |pdf_font_num|
indicates that the corresponding font shares the font resource with the font.
@d pdf_print_resname_prefix ==
if pdf_resname_prefix <> 0 then
pdf_print(pdf_resname_prefix)
@p procedure pdf_init_font(f: internal_font_number);
{create a font object}
var k, b: internal_font_number;
i: integer;
begin
pdfassert(not font_used[f]);
{if |f| is auto expanded then ensure the base font is initialized}
if pdf_font_auto_expand[f] and (pdf_font_blink[f] <> null_font) then begin
b := pdf_font_blink[f];
if not isscalable(b) then
pdf_error("font expansion", "auto expansion is only possible with scalable fonts");
if not font_used[b] then
pdf_init_font(b);
pdf_font_map[f] := pdf_font_map[b];
end;
{check whether |f| can share the font object with some |k|: we have 2 cases
here: 1) |f| and |k| have the same tfm name (so they have been loaded at
different sizes, e.g., 'cmr10' and 'cmr10 at 11pt'); 2) |f| has been auto
expanded from |k|}
if isscalable(f) then begin
i := head_tab[obj_type_font];
while i <> 0 do begin
k := obj_info(i);
if isscalable(k) and
(pdf_font_map[k] = pdf_font_map[f]) and
(str_eq_str(font_name[k], font_name[f]) or
(pdf_font_auto_expand[f] and
(pdf_font_blink[f] <> null_font) and
str_eq_str(font_name[k], font_name[pdf_font_blink[f]]))) then
begin
pdfassert(pdf_font_num[k] <> 0);
if pdf_font_num[k] < 0 then
pdf_use_font(f, pdf_font_num[k])
else
pdf_use_font(f, -k);
return;
end;
i := obj_link(i);
end;
end;
{create a new font object for |f|}
pdf_create_obj(obj_type_font, f);
pdf_font_has_space_char[f] := hasspacechar(f);
pdf_use_font(f, obj_ptr);
end;
procedure pdf_init_font_cur_val;
begin
pdf_init_font(cur_val);
end;
procedure pdf_set_font(f: internal_font_number);
{set the actual font on PDF page}
label found, found1;
var p: pointer;
k: internal_font_number;
begin
if not font_used[f] then
pdf_init_font(f);
set_ff(f); {set |ff| to the tfm number of the font sharing the font object
with |f|; |ff| is either |f| or some font with the same tfm name
at different size and/or expansion}
k := ff;
p := pdf_font_list;
while p <> null do begin
set_ff(info(p));
if ff = k then
goto found;
p := link(p);
end;
pdf_append_list(f)(pdf_font_list); {|f| not found in |pdf_font_list|, append it now}
found:
if (k = pdf_last_f) and (font_size[f] = pdf_last_fs) then
return;
pdf_print("/F");
pdf_print_int(k);
pdf_print_resname_prefix;
pdf_out(" ");
pdf_print_real(divide_scaled(font_size[f], one_hundred_bp, 6), 4);
pdf_print(" Tf");
pdf_last_f := k;
pdf_last_fs := font_size[f];
end;
procedure pdf_begin_text; {begin a text section}
begin
pdf_set_origin(0, cur_page_height);
pdf_print_ln("BT");
pdf_doing_text := true;
pdf_f := null_font;
pdf_last_f := null_font;
pdf_last_fs := 0;
pdf_doing_string := false;
pdf_cur_Tm_a := 0;
end;
procedure pdf_read_dummy_font;
begin
if pdf_dummy_font = null_font then begin
pdf_dummy_font := read_font_info(null_cs, pdf_space_font_name, "", -1000);
pdfmaplinesp;
pdf_mark_char(pdf_dummy_font, 32);
end;
end;
procedure pdf_insert_interword_space;
{insert an artificial interword space}
begin
pdf_read_dummy_font;
pdf_set_font(pdf_dummy_font);
pdf_print("( )Tj");
end;
procedure pdf_begin_string(f: internal_font_number); {begin to draw a string}
var s_out, v, v_out: scaled;
save_pdf_delta_h: scaled;
s: integer;
must_end_string: boolean; {must we end the current string?}
must_insert_space: boolean; {must we insert an interword space?}
begin
if not pdf_doing_text then
pdf_begin_text;
if f <> pdf_f then begin
pdf_end_string;
pdf_set_font(f);
end;
if pdf_cur_Tm_a = 0 then begin
s := divide_scaled(cur_h - (pdf_tj_start_h + pdf_delta_h), pdf_font_size[f], 3);
s_out := scaled_out;
end
else begin
s := divide_scaled(round_xn_over_d(cur_h - (pdf_tj_start_h + pdf_delta_h), 1000,
1000 + pdf_cur_Tm_a),
pdf_font_size[f],
3);
if abs(s) < @'100000 then begin
s_out := round_xn_over_d(round_xn_over_d(pdf_font_size[f], abs(s), 1000),
1000 + pdf_cur_Tm_a, 1000);
if s < 0 then
s_out := -s_out;
end;
{no need to calculate |s_out| when |abs(s) >= @'100000|, since the text
matrix will be reset below}
end;
if abs(cur_v - pdf_v) >= min_bp_val then begin
v := divide_scaled(pdf_v - cur_v, one_hundred_bp,
fixed_decimal_digits + 2);
v_out := scaled_out;
end
else begin
v := 0;
v_out := 0;
end;
must_insert_space := false;
must_end_string := false;
if (f <> pdf_f) or (v <> 0) or (abs(s) >= @'100000) then begin
must_end_string := true;
end;
if gen_faked_interword_space
and pdf_doing_string
and (not must_end_string)
and (s_out > space(f) - space_shrink(f))
and (v = 0)
then begin
must_insert_space := true;
end;
if (must_insert_space) then begin
{insert a real space char from the font when possible}
if pdf_font_has_space_char[f] then begin
pdf_out(" ");
save_pdf_delta_h := pdf_delta_h;
adv_char_width(f, 32, 3); { to get |adv_char_width_s| and |adv_char_width_s_out|}
s := s - adv_char_width_s;
s_out := s_out - adv_char_width_s_out;
pdf_mark_char(f, 32);
end
else
must_end_string := true;
end;
if must_end_string then begin
pdf_end_string;
{insert a space char from the dummy font if needed}
if (must_insert_space) and (not pdf_font_has_space_char[f]) then begin
pdf_insert_interword_space; {this will change |pdf_f|}
pdf_set_font(f);
end;
pdf_set_textmatrix(v, v_out, f);
pdf_f := f;
s := 0;
end;
if not pdf_doing_string then begin
pdf_print(" [");
if s = 0 then
pdf_out("(");
end;
if s <> 0 then begin
if pdf_doing_string then
pdf_out(")");
pdf_print_int(-s);
pdf_out("(");
pdf_delta_h := pdf_delta_h + s_out;
end;
pdf_doing_string := true;
end;
procedure pdf_insert_fake_space;
var s: integer; {to save |gen_faked_interword_space|}
begin
s := gen_faked_interword_space;
gen_faked_interword_space := 0; {to prevent inserting another fake space in |pdf_begin_string|}
pdf_read_dummy_font;
pdf_begin_string(pdf_dummy_font);
pdf_print(" ");
pdf_end_string_nl;
gen_faked_interword_space := s;
end;
procedure pdf_end_text; {end a text section}
begin
if pdf_doing_text then begin
pdf_end_string_nl;
pdf_print_ln("ET");
pdf_doing_text := false;
end;
end;
procedure pdf_set_rule(x, y, w, h: scaled); {draw a rule}
begin
pdf_end_text;
pdf_print_ln("q");
if h <= one_bp then begin
pdf_set_origin_temp(x, y - (h + 1)/2);
pdf_print("[]0 d 0 J ");
pdf_print_bp(h); pdf_print(" w 0 0 m ");
pdf_print_bp(w); pdf_print_ln(" 0 l S");
end
else if w <= one_bp then begin
pdf_set_origin_temp(x + (w + 1)/2, y);
pdf_print("[]0 d 0 J ");
pdf_print_bp(w); pdf_print(" w 0 0 m 0 ");
pdf_print_bp(h); pdf_print_ln(" l S");
end
else begin
pdf_set_origin_temp(x, y);
pdf_print("0 0 ");
pdf_print_bp(w); pdf_out(" ");
pdf_print_bp(h); pdf_print_ln(" re f");
end;
pdf_print_ln("Q");
end;
procedure pdf_rectangle(left, top, right, bottom: scaled); {output a
rectangle specification to PDF file}
begin
prepare_mag;
pdf_print("/Rect [");
pdf_print_mag_bp(pdf_x(left)); pdf_out(" ");
pdf_print_mag_bp(pdf_y(bottom)); pdf_out(" ");
pdf_print_mag_bp(pdf_x(right)); pdf_out(" ");
pdf_print_mag_bp(pdf_y(top));
pdf_print_ln("]");
end;
{Prints first |len| characters of string |s| (if it's that long).
There must be a better way to print a substring?}
procedure slow_print_substr(@!s,@!max_len:integer);
var j:pool_pointer; {current character code position}
begin if (s>=str_ptr) or (s<256) then print(s)
else begin j:=str_start[s];
while (j<str_start[s+1]) and (j<=str_start[s]+max_len) do
begin print(so(str_pool[j])); incr(j);
end;
end;
if j<str_start[s+1] then print("..."); {indicate truncation}
end;
procedure literal(s: str_number; literal_mode: integer; warn: boolean);
var j: pool_pointer; {current character code position}
begin
j:=str_start[s];
if literal_mode = scan_special then begin
if not (str_in_str(s, "PDF:", 0) or str_in_str(s, "pdf:", 0)) then begin
if warn and not (str_in_str(s, "SRC:", 0)
or str_in_str(s, "src:", 0)
or (length(s) = 0)) then begin
print_nl("Non-PDF special ignored!");
print_nl("<special> ");
slow_print_substr(s, 64);
{length of printed line should be <=78; good enough.}
print_ln;
end;
return;
end;
j := j + length("PDF:");
if str_in_str(s, "direct:", length("PDF:")) then begin
j := j + length("direct:");
literal_mode := direct_always; end
else if str_in_str(s, "page:", length("PDF:")) then begin
j := j + length("page:");
literal_mode := direct_page; end
else
literal_mode := set_origin;
end;
case literal_mode of
set_origin: begin
pdf_end_text;
pdf_set_origin(cur_h, cur_v);
end;
direct_page:
pdf_end_text;
direct_always:
pdf_end_string_nl;
othercases confusion("literal1")
endcases;
while j<str_start[s+1] do begin
pdf_out(str_pool[j]);
incr(j);
end;
pdf_print_nl;
end;
@* \[32d] The cross-reference table. The cross-reference table |obj_tab| is an
array of |obj_tab_size| of |obj_entry|. Each entry contains five integer fields
and represents an object in PDF file whose object number is the index of this
entry in |obj_tab|. Objects in |obj_tab| maybe linked into list; objects in
such a linked list have the same type.
@<Types...@>=
@!obj_entry = record@;@/
int0, int1: integer;
int2: longinteger;
int3, int4: integer;
end;
@ The first field contains information representing identifier of this object.
It is usually a number for most of object types, but it may be a string number
for named destination or named thread.
The second field of |obj_entry| contains link to the next
object in |obj_tab| if this object is linked in a list.
The third field holds the byte offset of the object in the output PDF file,
or its byte offset within an object stream. As long as the object is not
written, this field is used for flags about the write status of the object;
then it has a negative value.
The fourth field holds the object number of the object stream, into which
the object is included.
The last field usually represents the pointer to some auxiliary data
structure depending on the object type; however it may be used as a counter as
well.
@d obj_info(#) == obj_tab[#].int0 {information representing identifier of this object}
@d obj_link(#) == obj_tab[#].int1 {link to the next entry in linked list}
@d obj_offset(#) == obj_tab[#].int2 {negative (flags), or byte offset for this object in PDF output file, or object stream number for this object}
@d obj_os_idx(#) == obj_tab[#].int3 {index of this object in object stream}
@d obj_aux(#) == obj_tab[#].int4 {auxiliary pointer}
@d set_obj_fresh(#) == obj_offset(#) := -2
@d set_obj_scheduled(#) == if obj_offset(#) = -2 then obj_offset(#) := -1
@d is_obj_scheduled(#) == (obj_offset(#) > -2)
@d is_obj_written(#) == (obj_offset(#) > -1)
@# {types of objects}
@d obj_type_others == 0 {objects which are not linked in any list}
@d obj_type_page == 1 {index of linked list of Page objects}
@d obj_type_pages == 2 {index of linked list of Pages objects}
@d obj_type_font == 3 {index of linked list of Fonts objects}
@d obj_type_outline == 4 {index of linked list of outline objects}
@d obj_type_dest == 5 {index of linked list of destination objects}
@d obj_type_struct_dest == 6 {index of linked list of structure destination objects}
@d obj_type_obj == 7 {index of linked list of raw objects}
@d obj_type_xform == 8 {index of linked list of XObject forms}
@d obj_type_ximage == 9 {index of linked list of XObject image}
@d obj_type_thread == 10 {index of linked list of num article threads}
@d head_tab_max == obj_type_thread {max index of |head_tab|}
@# {max number of kids for balanced trees}
@d pages_tree_kids_max == 6 {max number of kids of Pages tree node}
@d name_tree_kids_max == 6 {max number of kids of node of name tree for
name destinations}
@# {when a whatsit node representing annotation is created, words |1..3| are
width, height and depth of this annotation; after shipping out words |1..4|
are rectangle specification of annotation. For whatsit node representing
destination |pdf_left| and |pdf_top| are used for some types of destinations}
@# {coordinates of destinations/threads/annotations (in whatsit node)}
@d pdf_left(#) == mem[# + 1].sc
@d pdf_top(#) == mem[# + 2].sc
@d pdf_right(#) == mem[# + 3].sc
@d pdf_bottom(#) == mem[# + 4].sc
@# {dimension of destinations/threads/annotations (in whatsit node)}
@d pdf_width(#) == mem[# + 1].sc
@d pdf_height(#) == mem[# + 2].sc
@d pdf_depth(#) == mem[# + 3].sc
@# {data structure for \.{\\pdfliteral}}
@d pdf_literal_data(#) == link(#+1) {data}
@d pdf_literal_mode(#) == info(#+1) {mode of resetting the text matrix
while writing data to the page stream}
@# {modes of setting the current transformation matrix (CTM)}
@d set_origin == 0 {end text (ET) if needed, set CTM to current point}
@d direct_page == 1 {end text (ET) if needed, but don't change the CTM}
@d direct_always == 2 {don't end text, don't change the CTM}
@d scan_special == 3 {look into special text}
@# {data structure for \.{\\pdfcolorstack}}
@d pdf_colorstack_node_size == 3
@d pdf_colorstack_setter_node_size == 3
@d pdf_colorstack_getter_node_size == 2
@d pdf_colorstack_stack(#) == link(#+1) {stack number}
@d pdf_colorstack_cmd(#) == info(#+1) {command: set, push, pop, current}
@d pdf_colorstack_data(#) == link(#+2) {data}
@# {color stack commands}
@d colorstack_set == 0
@d colorstack_push == 1
@d colorstack_data == 1 { last value where data field is set }
@d colorstack_pop == 2
@d colorstack_current == 3
@# {data structure for \.{\\pdfsetmatrix}}
@d pdf_setmatrix_node_size == 2
@d pdf_setmatrix_data(#) == link(#+1) {data}
@# {data structure for \.{\\pdfsave}}
@d pdf_save_node_size == 2
@# {data structure for \.{\\pdfrestore}}
@d pdf_restore_node_size == 2
@# {data structure for \.{\\pdfobj} and \.{\\pdfrefobj}}
@d pdf_refobj_node_size == 2 {size of whatsit node representing the raw object}
@d pdf_obj_objnum(#) == info(# + 1) {number of the raw object}
@d obj_data_ptr == obj_aux {pointer to |pdf_mem|}
@d pdfmem_obj_size == 4 {size of memory in |pdf_mem| which
|obj_data_ptr| holds}
@d obj_obj_data(#) == pdf_mem[obj_data_ptr(#) + 0] {object data}
@d obj_obj_is_stream(#) == pdf_mem[obj_data_ptr(#) + 1] {will this object
be written as a stream instead of a dictionary?}
@d obj_obj_stream_attr(#) == pdf_mem[obj_data_ptr(#) + 2] {additional
object attributes for streams}
@d obj_obj_is_file(#) == pdf_mem[obj_data_ptr(#) + 3] {data should be
read from an external file?}
@# {data structure for \.{\\pdfxform} and \.{\\pdfrefxform}}
@d pdf_refxform_node_size == 5 {size of whatsit node for xform; words 1..3 are
form dimensions}
@d pdf_xform_objnum(#) == info(# + 4) {object number}
@d pdfmem_xform_size == 6 {size of memory in |pdf_mem| which
|obj_data_ptr| holds}
@d obj_xform_width(#) == pdf_mem[obj_data_ptr(#) + 0]
@d obj_xform_height(#) == pdf_mem[obj_data_ptr(#) + 1]
@d obj_xform_depth(#) == pdf_mem[obj_data_ptr(#) + 2]
@d obj_xform_box(#) == pdf_mem[obj_data_ptr(#) + 3] {this field holds
pointer to the corresponding box}
@d obj_xform_attr(#) == pdf_mem[obj_data_ptr(#) + 4] {additional xform
attributes}
@d obj_xform_resources(#) == pdf_mem[obj_data_ptr(#) + 5] {additional xform
Resources}
@# {data structure for \.{\\pdfximage} and \.{\\pdfrefximage}}
@d pdf_refximage_node_size == 5 {size of whatsit node for ximage; words 1..3
are image dimensions}
@d pdf_ximage_objnum(#) == info(# + 4) {object number}
@d pdfmem_ximage_size == 5 {size of memory in |pdf_mem| which
|obj_data_ptr| holds}
@d obj_ximage_width(#) == pdf_mem[obj_data_ptr(#) + 0]
@d obj_ximage_height(#) == pdf_mem[obj_data_ptr(#) + 1]
@d obj_ximage_depth(#) == pdf_mem[obj_data_ptr(#) + 2]
@d obj_ximage_attr(#) == pdf_mem[obj_data_ptr(#) + 3] {additional ximage attributes}
@d obj_ximage_data(#) == pdf_mem[obj_data_ptr(#) + 4] {pointer to image data}
@# {data structure of annotations; words 1..4 represent the coordinates of
the annotation}
@d obj_annot_ptr == obj_aux {pointer to corresponding whatsit node}
@d pdf_annot_node_size == 7 {size of whatsit node representing annotation}
@d pdf_annot_data(#) == info(# + 5) {raw data of general annotations}
@d pdf_link_attr(#) == info(# + 5) {attributes of link annotations}
@d pdf_link_action(#) == link(# + 5) {pointer to action structure}
@d pdf_annot_objnum(#) == mem[# + 6].int {object number of corresponding object}
@d pdf_link_objnum(#) == mem[# + 6].int {object number of corresponding object}
@# {types of actions}
@d pdf_action_page == 0 {GoTo action}
@d pdf_action_goto == 1 {GoTo action}
@d pdf_action_thread == 2 {Thread action}
@d pdf_action_user == 3 {user-defined action}
@# {data structure of actions}
@d pdf_action_size == 4 {size of action structure in |mem|}
@d pdf_action_type == type {action type}
@d pdf_action_named_id == subtype {identifier is type of name}
@d pdf_action_id == link {destination/thread name identifier}
@d pdf_action_file(#) == info(# + 1) {file name for external action}
@d pdf_action_new_window(#)== link(# + 1) {open a new window?}
@d pdf_action_page_tokens(#) == info(# + 2) {specification of GoTo page action}
@d pdf_action_user_tokens(#) == info(# + 2) {user-defined action string}
@d pdf_action_refcount(#) == link(# + 2) {counter of references to this action}
@d pdf_action_struct_id(#) == link(# + 3) {structure destination identifier}
@# {data structure of outlines; it's not able to write out outline entries
before all outline entries are defined, so memory allocated for outline
entries can't not be deallocated and will stay in memory. For this reason we
will store data of outline entries in |pdf_mem| instead of |mem|}
@d pdfmem_outline_size == 8 {size of memory in |pdf_mem| which
|obj_outline_ptr| points to}
@d obj_outline_count == obj_info{count of all opened children}
@d obj_outline_ptr == obj_aux {pointer to |pdf_mem|}
@d obj_outline_title(#) == pdf_mem[obj_outline_ptr(#)]
@d obj_outline_parent(#) == pdf_mem[obj_outline_ptr(#) + 1]
@d obj_outline_prev(#) == pdf_mem[obj_outline_ptr(#) + 2]
@d obj_outline_next(#) == pdf_mem[obj_outline_ptr(#) + 3]
@d obj_outline_first(#) == pdf_mem[obj_outline_ptr(#) + 4]
@d obj_outline_last(#) == pdf_mem[obj_outline_ptr(#) + 5]
@d obj_outline_action_objnum(#) == pdf_mem[obj_outline_ptr(#) + 6] {object number of
action}
@d obj_outline_attr(#) == pdf_mem[obj_outline_ptr(#) + 7]
@# {types of destinations}
@d pdf_dest_xyz == 0
@d pdf_dest_fit == 1
@d pdf_dest_fith == 2
@d pdf_dest_fitv == 3
@d pdf_dest_fitb == 4
@d pdf_dest_fitbh == 5
@d pdf_dest_fitbv == 6
@d pdf_dest_fitr == 7
@# {data structure of structure and regular destinations}
@d obj_dest_ptr == obj_aux {pointer to |pdf_dest_node|}
@d pdf_dest_node_size == 7 {size of whatsit node for destination;
words |1..4| hold dest dimensions, word |6| identifier type, subtype
and identifier of destination, word |6| the corresponding object number}
@d pdf_dest_type(#) == type(# + 5) {type of destination}
@d pdf_dest_named_id(#) == subtype(# + 5) {is named identifier?}
@d pdf_dest_id(#) == link(# + 5) {destination identifier}
@d pdf_dest_xyz_zoom(#) == info(# + 6) {zoom factor for |destxyz| destination}
@d pdf_dest_objnum(#) == link(# + 6) {object number of corresponding
object}
@# {data structure of threads; words 1..4 represent the coordinates of the
corners}
@d pdf_thread_node_size == 7
@d pdf_thread_named_id(#) == subtype(# + 5) {is a named identifier}
@d pdf_thread_id(#) == link(# + 5) {thread identifier}
@d pdf_thread_attr(#) == info(# + 6) {attributes of thread}
@d obj_thread_first == obj_aux {pointer to the first bead}
@# {data structure of beads}
@d pdfmem_bead_size == 5 {size of memory in |pdf_mem| which
|obj_bead_ptr| points to}
@d obj_bead_ptr == obj_aux {pointer to |pdf_mem|}
@d obj_bead_rect(#) == pdf_mem[obj_bead_ptr(#)]
@d obj_bead_page(#) == pdf_mem[obj_bead_ptr(#) + 1]
@d obj_bead_next(#) == pdf_mem[obj_bead_ptr(#) + 2]
@d obj_bead_prev(#) == pdf_mem[obj_bead_ptr(#) + 3]
@d obj_bead_attr(#) == pdf_mem[obj_bead_ptr(#) + 4]
@d obj_bead_data == obj_bead_rect {pointer to the corresponding
whatsit node; |obj_bead_rect| is needed only when the bead rectangle has
been written out and after that |obj_bead_data| is not needed any more
so we can use this field for both}
@# {data structure of snap node}
@d snap_node_size == 3
@d snap_glue_ptr(#) == info(# + 1)
@d final_skip(#) == mem[# + 2].sc {the amount to skip}
@# {data structure of snap compensation node}
@d snapy_comp_ratio(#) == mem[# + 1].int
@<Constants...@>=
@!inf_obj_tab_size = 1000; {min size of the cross-reference table for PDF output}
@!sup_obj_tab_size = 8388607; {max size of the cross-reference table for PDF output}
@!inf_dest_names_size = 1000; {min size of the destination names table for PDF output}
@!sup_dest_names_size = 500000; {max size of the destination names table for PDF output}
@!inf_pk_dpi = 72; {min PK pixel density value from \.{texmf.cnf}}
@!sup_pk_dpi = 8000; {max PK pixel density value from \.{texmf.cnf}}
@!pdf_objtype_max = head_tab_max;
@ @<Glob...@>=
@!obj_tab_size:integer;
@!obj_tab:^obj_entry;
@!head_tab: array[1..head_tab_max] of integer;
@!pages_tail: integer;
@!obj_ptr: integer; {user objects counter}
@!sys_obj_ptr: integer; {system objects counter, including object streams}
@!pdf_last_pages: integer; {pointer to most recently generated pages object}
@!pdf_last_page: integer; {pointer to most recently generated page object}
@!pdf_last_stream: integer; {pointer to most recently generated stream}
@!pdf_stream_length: longinteger; {length of most recently generated stream}
@!pdf_stream_length_offset: longinteger; {file offset of the last stream length}
@!pdf_seek_write_length: boolean; {flag whether to seek back and write \.{/Length}}
@!pdf_last_byte: eight_bits; {byte most recently written to PDF file; for \.{endstream} in new line}
@!pdf_append_list_arg: integer; {for use with |pdf_append_list|}
@!ff: integer; {for use with |set_ff|}
@!pdf_box_spec_media: integer;
@!pdf_box_spec_crop: integer;
@!pdf_box_spec_bleed: integer;
@!pdf_box_spec_trim: integer;
@!pdf_box_spec_art: integer;
@ @<Set init...@>=
obj_ptr := 0;
sys_obj_ptr := 0;
obj_tab_size := inf_obj_tab_size; {allocated size of |obj_tab| array}
dest_names_size := inf_dest_names_size; {allocated size of |dest_names| array}
for k := 1 to head_tab_max do
head_tab[k] := 0;
pdf_box_spec_media := 1;
pdf_box_spec_crop := 2;
pdf_box_spec_bleed := 3;
pdf_box_spec_trim := 4;
pdf_box_spec_art := 5;
pdf_dummy_font := null_font;
@ Here we implement subroutines for work with objects and related things.
Some of them are used in former parts too, so we need to declare them
forward.
@d pdf_append_list_end(#) == # := append_ptr(#, pdf_append_list_arg); end
@d pdf_append_list(#) == begin pdf_append_list_arg := #; pdf_append_list_end
@d set_ff(#) == begin
if pdf_font_num[#] < 0 then
ff := -pdf_font_num[#]
else
ff := #;
end
@<Declare procedures that need to be declared forward for \pdfTeX@>=
procedure append_dest_name(s: str_number; n: integer);
var a: integer;
begin
if pdf_dest_names_ptr = sup_dest_names_size then
overflow("number of destination names (dest_names_size)", dest_names_size);
if pdf_dest_names_ptr = dest_names_size then begin
a := 0.2 * dest_names_size;
if dest_names_size < sup_dest_names_size - a then
dest_names_size := dest_names_size + a
else
dest_names_size := sup_dest_names_size;
dest_names := xrealloc_array(dest_names, dest_name_entry, dest_names_size);
end;
dest_names[pdf_dest_names_ptr].objname := s;
dest_names[pdf_dest_names_ptr].objnum := n;
incr(pdf_dest_names_ptr);
end;
procedure pdf_create_obj(t, i: integer); {create an object with type |t| and
identifier |i|}
label done;
var a, p, q: integer;
begin
if sys_obj_ptr = sup_obj_tab_size then
overflow("indirect objects table size", obj_tab_size);
if sys_obj_ptr = obj_tab_size then begin
a := 0.2 * obj_tab_size;
if obj_tab_size < sup_obj_tab_size - a then
obj_tab_size := obj_tab_size + a
else
obj_tab_size := sup_obj_tab_size;
obj_tab := xrealloc_array(obj_tab, obj_entry, obj_tab_size);
end;
incr(sys_obj_ptr);
obj_ptr := sys_obj_ptr;
obj_info(obj_ptr) := i;
set_obj_fresh(obj_ptr);
obj_aux(obj_ptr) := 0;
avl_put_obj(obj_ptr, t);
if t = obj_type_page then begin
p := head_tab[t];
{find the right position to insert newly created object}@/
if (p = 0) or (obj_info(p) < i) then begin
obj_link(obj_ptr) := p;
head_tab[t] := obj_ptr;
end
else begin
while p <> 0 do begin
if obj_info(p) < i then
goto done;
q := p;
p := obj_link(p);
end;
done:
obj_link(q) := obj_ptr;
obj_link(obj_ptr) := p;
end;
end
else if t <> obj_type_others then begin
obj_link(obj_ptr) := head_tab[t];
head_tab[t] := obj_ptr;
if (t = obj_type_dest) and (i < 0) then
append_dest_name(-obj_info(obj_ptr), obj_ptr);
end;
end;
function pdf_new_objnum: integer; {create a new object and return its number}
begin
pdf_create_obj(obj_type_others, 0);
pdf_new_objnum := obj_ptr;
end;
procedure pdf_os_switch(pdf_os: boolean); {switch between PDF stream and object stream mode}
begin
if pdf_os and pdf_os_enable then begin
if not pdf_os_mode then begin {back up PDF stream variables}
pdf_op_ptr := pdf_ptr;
pdf_ptr := pdf_os_ptr;
pdf_buf := pdf_os_buf;
pdf_buf_size := pdf_os_buf_size;
pdf_os_mode := true; {switch to object stream}
end;
end else begin
if pdf_os_mode then begin {back up object stream variables}
pdf_os_ptr := pdf_ptr;
pdf_ptr := pdf_op_ptr;
pdf_buf := pdf_op_buf;
pdf_buf_size := pdf_op_buf_size;
pdf_os_mode := false; {switch to PDF stream}
end;
end;
end;
procedure pdf_os_prepare_obj(i: integer; pdf_os_level: integer); {create new \.{/ObjStm} object
if required, and set up cross reference info}
begin
pdf_os_switch((pdf_os_level > 0) and (fixed_pdf_objcompresslevel >= pdf_os_level));
if pdf_os_mode then begin
if pdf_os_cur_objnum = 0 then begin
pdf_os_cur_objnum := pdf_new_objnum;
decr(obj_ptr); {object stream is not accessible to user}
incr(pdf_os_cntr); {only for statistics}
pdf_os_objidx := 0;
pdf_ptr := 0; {start fresh object stream}
end else
incr(pdf_os_objidx);
obj_os_idx(i) := pdf_os_objidx;
obj_offset(i) := pdf_os_cur_objnum;
pdf_os_objnum[pdf_os_objidx] := i;
pdf_os_objoff[pdf_os_objidx] := pdf_ptr;
end else begin
obj_offset(i) := pdf_offset;
obj_os_idx(i) := -1; {mark it as not included in object stream}
end;
end;
procedure pdf_begin_obj(i: integer; pdf_os_level: integer); {begin a PDF object}
begin
check_pdfversion;
pdf_os_prepare_obj(i, pdf_os_level);
if not pdf_os_mode then begin
pdf_print_int(i);
pdf_print_ln(" 0 obj");
end else if pdf_compress_level = 0 then begin
pdf_print("% "); {debugging help}
pdf_print_int(i);
pdf_print_ln(" 0 obj");
end;
end;
procedure pdf_new_obj(t, i: integer; pdf_os: integer); {begin a new PDF object}
begin
pdf_create_obj(t, i);
pdf_begin_obj(obj_ptr, pdf_os);
end;
procedure pdf_end_obj; {end a PDF object}
begin
if pdf_os_mode then begin
if pdf_os_objidx = pdf_os_max_objs - 1 then
pdf_os_write_objstream;
end else
pdf_print_ln("endobj"); {end a PDF object}
end;
procedure pdf_begin_dict(i: integer; pdf_os_level: integer); {begin a PDF dictionary object}
begin
check_pdfversion;
pdf_os_prepare_obj(i, pdf_os_level);
if not pdf_os_mode then begin
pdf_print_int(i);
pdf_print_ln(" 0 obj");
end else if pdf_compress_level = 0 then begin
pdf_print("% "); {debugging help}
pdf_print_int(i);
pdf_print_ln(" 0 obj");
end;
pdf_print_ln("<<");
end;
procedure pdf_new_dict(t, i: integer; pdf_os: integer); {begin a new PDF dictionary object}
begin
pdf_create_obj(t, i);
pdf_begin_dict(obj_ptr, pdf_os);
end;
procedure pdf_end_dict; {end a PDF dictionary object}
begin
if pdf_os_mode then begin
pdf_print_ln(">>");
if pdf_os_objidx = pdf_os_max_objs - 1 then
pdf_os_write_objstream;
end else begin
pdf_print_ln(">>");
pdf_print_ln("endobj");
end;
end;
@ Write out an accumulated object stream.
First the object number and byte offset pairs are generated
and appended to the ready buffered object stream.
By this the value of \.{/First} can be calculated.
Then a new \.{/ObjStm} object is generated, and everything is
copied to the PDF output buffer, where also compression is done.
When calling this procedure, |pdf_os_mode| must be |true|.
@<Declare procedures that need to be declared forward for \pdfTeX@>=
procedure pdf_os_write_objstream;
var i, j, p, q: pointer;
begin
if pdf_os_cur_objnum = 0 then {no object stream started}
return;
p := pdf_ptr;
i := 0;
j := 0;
while i <= pdf_os_objidx do begin {assemble object number and byte offset pairs}
pdf_print_int(pdf_os_objnum[i]);
pdf_print(" ");
pdf_print_int(pdf_os_objoff[i]);
if j = 9 then begin {print out in groups of ten for better readability}
pdf_out(pdf_new_line_char);
j := 0;
end else begin
pdf_print(" ");
incr(j);
end;
incr(i);
end;
pdf_buf[pdf_ptr - 1] := pdf_new_line_char; {no risk of flush, as we are in |pdf_os_mode|}
q := pdf_ptr;
pdf_begin_dict(pdf_os_cur_objnum, 0); {switch to PDF stream writing}
pdf_print_ln("/Type /ObjStm");
pdf_print("/N ");
pdf_print_int_ln(pdf_os_objidx + 1);
pdf_print("/First ");
pdf_print_int_ln(q - p);
pdf_begin_stream;
pdf_room(q - p); {should always fit into the PDF output buffer}
i := p;
while i < q do begin {write object number and byte offset pairs}
pdf_quick_out(pdf_os_buf[i]);
incr(i);
end;
i := 0;
while i < p do begin
q := i + pdf_buf_size;
if q > p then q := p;
pdf_room(q - i);
while i < q do begin {write the buffered objects}
pdf_quick_out(pdf_os_buf[i]);
incr(i);
end;
end;
pdf_end_stream;
pdf_os_cur_objnum := 0; {to force object stream generation next time}
end;
@ @<Declare procedures that need to be declared forward for \pdfTeX@>=
function append_ptr(p: pointer; i: integer): pointer; {appends a pointer with
info |i| to the end of linked list with head |p|}
var q: pointer;
begin
append_ptr := p;
fast_get_avail(q);
info(q) := i;
link(q) := null;
if p = null then begin
append_ptr := q;
return;
end;
while link(p) <> null do
p := link(p);
link(p) := q;
end;
function pdf_lookup_list(p: pointer; i: integer): pointer; {looks up for pointer
with info |i| in list |p|}
begin
pdf_lookup_list := null;
while p <> null do begin
if info(p) = i then begin
pdf_lookup_list := p;
return;
end;
p := link(p);
end;
end;
@ @<Glob...@>=
@!pdf_image_procset: integer; {collection of image types used in current page/form}
@!pdf_text_procset: boolean; {mask of used ProcSet's in the current page/form}
@ Subroutines to print out various PDF objects:
@d is_hex_char(#) == (((# >= '0') and (# <= '9')) or
((# >= 'A') and (# <= 'F')) or
((# >= 'a') and (# <= 'f')))
@p procedure pdf_print_fw_int(n: longinteger; w: integer); {print out an integer with
fixed width; used for outputting cross-reference table}
var k: integer; {$0\le k\le23$}
begin
k := 0;
repeat dig[k] := n mod 10; n := n div 10; incr(k);
until k = w;
pdf_room(k);
while k > 0 do begin
decr(k);
pdf_quick_out("0" + dig[k]);
end;
end;
procedure pdf_out_bytes(n: longinteger; w: integer); {print out an integer as
a number of bytes; used for outputting \.{/XRef} cross-reference stream}
var k: integer;
byte: array[0..7] of integer; {digits in a number being output}
begin
k := 0;
repeat byte[k] := n mod 256; n := n div 256; incr(k);
until k = w;
pdf_room(k);
while k > 0 do begin
decr(k);
pdf_quick_out(byte[k]);
end;
end;
procedure pdf_int_entry(s: str_number; v: integer); {print out an entry in
dictionary with integer value to PDF buffer}
begin
pdf_out("/");
pdf_print(s);
pdf_out(" ");
pdf_print_int(v);
end;
procedure pdf_int_entry_ln(s: str_number; v: integer);
begin
pdf_int_entry(s, v);
pdf_print_nl;
end;
procedure pdf_indirect(s: str_number; o: integer); {print out an indirect
entry in dictionary}
begin
pdf_out("/");
pdf_print(s);
pdf_out(" ");
pdf_print_int(o);
pdf_print(" 0 R");
end;
procedure pdf_indirect_ln(s: str_number; o: integer);
begin
pdf_indirect(s, o);
pdf_print_nl;
end;
procedure pdf_print_str(s: str_number); {print out |s| as string in PDF
output}
label done;
var i, j: pool_pointer;
is_hex_string: boolean;
begin
i := str_start[s];
j := i + length(s) - 1;
if i > j then begin
pdf_print("()"); {null string}
return;
end;
if (str_pool[i] = '(') and (str_pool[j] = ')') then begin
pdf_print(s);
return;
end;
is_hex_string := false;
if (str_pool[i] <> '<') or (str_pool[j] <> '>') or odd(length(s)) then
goto done;
incr(i);
decr(j);
while i < j do begin
if is_hex_char(str_pool[i]) and is_hex_char(str_pool[i + 1]) then
i := i + 2
else
goto done;
end;
is_hex_string := true;
done:
if is_hex_string then
pdf_print(s)
else begin
pdf_out("(");
pdf_print(s);
pdf_out(")");
end;
end;
procedure pdf_print_str_ln(s: str_number); {print out |s| as string in PDF
output}
begin
pdf_print_str(s);
pdf_print_nl;
end;
procedure pdf_str_entry(s, v: str_number); {print out an entry in
dictionary with string value to PDF buffer}
begin
if v = 0 then
return;
pdf_out("/");
pdf_print(s);
pdf_out(" ");
pdf_print_str(v);
end;
procedure pdf_str_entry_ln(s, v: str_number);
begin
if v = 0 then
return;
pdf_str_entry(s, v);
pdf_print_nl;
end;
@* \[32e] Font processing. As \pdfTeX{} should also act as a back-end driver,
it needs to support virtual fonts too. Information about virtual fonts can be
found in the source of some \.{DVI}-related programs.
Whenever we want to write out a character in a font to PDF output, we
should check whether the used font is a new (has not been used yet),
virtual or real font. The array |pdf_font_type| holds a flag of each used
font. After initialization the flag of each font is set to |new_font_type|.
The first time a character of a font is written out, \pdfTeX{} looks for
the corresponding virtual font. If the corresponding virtual font exists, then
the font type is set to |virtual_font_type|; otherwise it will be set to
|real_font_type|. |subst_font_type| indicates fonts that have been substituted
during adjusting spacing. Such fonts are linked via the |pdf_font_elink| array.
@d new_font_type = 0 {new font (has not been used yet)}
@d virtual_font_type = 1 {virtual font}
@d real_font_type = 2 {real font}
@d subst_font_type = 3 {substituted font}
@<Declare procedures that need to be declared forward for \pdfTeX@>=
procedure pdf_check_vf_cur_val; forward;
procedure pdf_init_font_cur_val; forward;
procedure scan_pdf_ext_toks; forward;
@ @<Glob...@>=
@!pdf_font_type: ^eight_bits; {the type of font}
@!pdf_font_attr: ^str_number; {pointer to additional attributes}
@!pdf_font_nobuiltin_tounicode: ^boolean; {disable generating ToUnicode for this font?}
@ Here come some subroutines to deal with expanded fonts for HZ-algorithm.
@d set_char_and_font(#) ==
if is_char_node(#) then begin
c := character(#);
f := font(#);
end
else if type(#) = ligature_node then begin
c := character(lig_char(#));
f := font(lig_char(#));
end
@d non_existent_path == "///..."
@p
procedure set_tag_code(f: internal_font_number; c: eight_bits; i: integer);
var fixedi:integer;
begin
if is_valid_char(c) then
begin fixedi := abs(fix_int(i,-7,0));
if fixedi >= 4 then begin
if char_tag(char_info(f)(c)) = ext_tag then
op_byte(char_info(f)(c)) := (op_byte(char_info(f)(c))) - ext_tag;
fixedi := fixedi - 4;
end;
if fixedi >= 2 then begin
if char_tag(char_info(f)(c)) = list_tag then
op_byte(char_info(f)(c)) := (op_byte(char_info(f)(c))) - list_tag;
fixedi := fixedi - 2;
end;
if fixedi >= 1 then begin
if char_tag(char_info(f)(c)) = lig_tag then
op_byte(char_info(f)(c)) := (op_byte(char_info(f)(c))) - lig_tag;
end;
end;
end;
procedure set_no_ligatures(f: internal_font_number);
var c:integer;
begin
for c := font_bc[f] to font_ec[f] do
if char_exists(orig_char_info(f)(c)) then
if char_tag(orig_char_info(f)(c))=lig_tag then
op_byte(orig_char_info(f)(c)) := (op_byte(orig_char_info(f)(c))) - lig_tag;
end;
function init_font_base(v: integer): integer;
var i, j: integer;
begin
i := pdf_get_mem(256);
for j := 0 to 255 do
pdf_mem[i + j] := v;
init_font_base := i;
end;
procedure set_lp_code(f: internal_font_number; c: eight_bits; i: integer);
begin
if pdf_font_lp_base[f] = 0 then
pdf_font_lp_base[f] := init_font_base(0);
pdf_mem[pdf_font_lp_base[f] + c] := fix_int(i, -1000, 1000);
end;
procedure set_rp_code(f: internal_font_number; c: eight_bits; i: integer);
begin
if pdf_font_rp_base[f] = 0 then
pdf_font_rp_base[f] := init_font_base(0);
pdf_mem[pdf_font_rp_base[f] + c] := fix_int(i, -1000, 1000);
end;
procedure set_ef_code(f: internal_font_number; c: eight_bits; i: integer);
begin
if pdf_font_ef_base[f] = 0 then
pdf_font_ef_base[f] := init_font_base(1000);
pdf_mem[pdf_font_ef_base[f] + c] := fix_int(i, 0, 1000);
end;
procedure set_kn_bs_code(f: internal_font_number; c: eight_bits; i: integer);
begin
if pdf_font_kn_bs_base[f] = 0 then
pdf_font_kn_bs_base[f] := init_font_base(0);
pdf_mem[pdf_font_kn_bs_base[f] + c] := fix_int(i, -1000, 1000);
end;
procedure set_st_bs_code(f: internal_font_number; c: eight_bits; i: integer);
begin
if pdf_font_st_bs_base[f] = 0 then
pdf_font_st_bs_base[f] := init_font_base(0);
pdf_mem[pdf_font_st_bs_base[f] + c] := fix_int(i, -1000, 1000);
end;
procedure set_sh_bs_code(f: internal_font_number; c: eight_bits; i: integer);
begin
if pdf_font_sh_bs_base[f] = 0 then
pdf_font_sh_bs_base[f] := init_font_base(0);
pdf_mem[pdf_font_sh_bs_base[f] + c] := fix_int(i, -1000, 1000);
end;
procedure set_kn_bc_code(f: internal_font_number; c: eight_bits; i: integer);
begin
if pdf_font_kn_bc_base[f] = 0 then
pdf_font_kn_bc_base[f] := init_font_base(0);
pdf_mem[pdf_font_kn_bc_base[f] + c] := fix_int(i, -1000, 1000);
end;
procedure set_kn_ac_code(f: internal_font_number; c: eight_bits; i: integer);
begin
if pdf_font_kn_ac_base[f] = 0 then
pdf_font_kn_ac_base[f] := init_font_base(0);
pdf_mem[pdf_font_kn_ac_base[f] + c] := fix_int(i, -1000, 1000);
end;
procedure adjust_interword_glue(p, g: pointer); {adjust the interword
glue |g| after a character |p|}
var kn, st, sh: scaled;
q, r: pointer;
c: halfword;
f: internal_font_number;
begin
if not (not is_char_node(g) and type(g) = glue_node) then begin
pdf_warning("adjust_interword_glue", "g is not a glue", true, true);
return;
end;
c := non_char; {no char before interword glue yet}
set_char_and_font(p) {set |f| and |c| if |p| is a char or ligature}
else if (type(p) = kern_node) and
(subtype(p) = auto_kern) and
(save_tail <> null) then
begin
r := save_tail;
while (link(r) <> null) and (link(r) <> p) do
r := link(r);
if (link(r) = p) then
set_char_and_font(r); {set |f| and |c| if |r| is a char or ligature}
end;
if (c = non_char) then
return;
kn := get_kn_bs_code(f, c);
st := get_st_bs_code(f, c);
sh := get_sh_bs_code(f, c);
if (kn <> 0) or (st <> 0) or (sh <> 0) then begin
q := new_spec(glue_ptr(g));
delete_glue_ref(glue_ptr(g));
width(q) := width(q) + round_xn_over_d(quad(f), kn, 1000);
stretch(q) := stretch(q) + round_xn_over_d(quad(f), st, 1000);
shrink(q) := shrink(q) + round_xn_over_d(quad(f), sh, 1000);
glue_ptr(g) := q;
end;
end;
function get_auto_kern(f: internal_font_number; l, r: halfword): pointer;
{return a pointer to an auto kern node, or |null|}
var tmp_w: scaled;
k: integer;
p: pointer;
begin
pdfassert((l >= 0) and (r >= 0));
get_auto_kern := null;
if (pdf_append_kern <= 0) and (pdf_prepend_kern <= 0) then
return;
tmp_w := 0;
if (pdf_append_kern > 0) and (l < non_char) then begin
k := get_kn_ac_code(f, l);
if k <> 0 then
tmp_w := round_xn_over_d(quad(f), k, 1000);
end;
if (pdf_prepend_kern > 0) and (r < non_char) then begin
k := get_kn_bc_code(f, r);
if k <> 0 then
tmp_w := tmp_w + round_xn_over_d(quad(f), k, 1000);
end;
if tmp_w <> 0 then begin
p := new_kern(tmp_w);
subtype(p) := auto_kern;
get_auto_kern := p;
end;
end;
function expand_font_name(f: internal_font_number; e: integer): str_number;
var old_setting:0..max_selector; {holds |selector| setting}
begin
old_setting:=selector; selector:=new_string;
print(font_name[f]);
if e > 0 then
print("+"); {minus sign will be printed by |print_int|}
print_int(e);
selector:=old_setting;
expand_font_name := make_string;
end;
function auto_expand_font(f: internal_font_number; e: integer): internal_font_number;
{creates an expanded font from the base font; doesn't load expanded tfm at all}
var k: internal_font_number;
nw, nk, ni, i: integer;
begin
k := font_ptr + 1;
incr(font_ptr);
if (font_ptr >= font_max) then
overflow("maximum internal font number (font_max)", font_max);
font_name[k] := expand_font_name(f, e);
font_area[k] := font_area[f];
font_id_text(k) := font_id_text(f);
hyphen_char[k] := hyphen_char[f];
skew_char[k] := skew_char[f];
font_bchar[k] := font_bchar[f];
font_false_bchar[k] := font_false_bchar[f];
font_bc[k] := font_bc[f];
font_ec[k] := font_ec[f];
font_size[k] := font_size[f];
font_dsize[k] := font_dsize[f];
font_params[k] := font_params[f];
font_glue[k] := font_glue[f];
bchar_label[k] := bchar_label[f];
char_base[k] := char_base[f];
height_base[k] := height_base[f];
depth_base[k] := depth_base[f];
lig_kern_base[k] := lig_kern_base[f];
exten_base[k] := exten_base[f];
param_base[k] := param_base[f];
nw := height_base[f] - width_base[f];
ni := lig_kern_base[f] - italic_base[f];
nk := exten_base[f] - (kern_base[f] + kern_base_offset);
if (fmem_ptr + nw + ni + nk >= font_mem_size) then
overflow("number of words of font memory (font_mem_size)", font_mem_size);
width_base[k] := fmem_ptr;
italic_base[k] := width_base[k] + nw;
kern_base[k] := italic_base[k] + ni - kern_base_offset;
fmem_ptr := fmem_ptr + nw + ni + nk;
for i := 0 to nw - 1 do
font_info[width_base[k] + i].sc :=
round_xn_over_d(font_info[width_base[f] + i].sc, 1000 + e, 1000);
for i := 0 to ni - 1 do
font_info[italic_base[k] + i].sc :=
round_xn_over_d(font_info[italic_base[f] + i].sc, 1000 + e, 1000);
for i := 0 to nk - 1 do
font_info[kern_base[k] + kern_base_offset + i].sc :=
round_xn_over_d(font_info[kern_base[f] + kern_base_offset + i].sc, 1000 + e, 1000);
auto_expand_font := k;
end;
procedure copy_expand_params(k, f: internal_font_number; e: integer);
{set expansion-related parameters for an expanded font |k|, based on the base
font |f| and the expansion amount |e|}
begin
if pdf_font_rp_base[f] = 0 then
pdf_font_rp_base[f] := init_font_base(0);
if pdf_font_lp_base[f] = 0 then
pdf_font_lp_base[f] := init_font_base(0);
if pdf_font_ef_base[f] = 0 then
pdf_font_ef_base[f] := init_font_base(1000);
pdf_font_expand_ratio[k] := e;
pdf_font_step[k] := pdf_font_step[f];
pdf_font_auto_expand[k] := pdf_font_auto_expand[f];
pdf_font_blink[k] := f;
pdf_font_lp_base[k] := pdf_font_lp_base[f];
pdf_font_rp_base[k] := pdf_font_rp_base[f];
pdf_font_ef_base[k] := pdf_font_ef_base[f];
if pdf_font_kn_bs_base[f] = 0 then
pdf_font_kn_bs_base[f] := init_font_base(0);
if pdf_font_st_bs_base[f] = 0 then
pdf_font_st_bs_base[f] := init_font_base(0);
if pdf_font_sh_bs_base[f] = 0 then
pdf_font_sh_bs_base[f] := init_font_base(0);
if pdf_font_kn_bc_base[f] = 0 then
pdf_font_kn_bc_base[f] := init_font_base(0);
if pdf_font_kn_ac_base[f] = 0 then
pdf_font_kn_ac_base[f] := init_font_base(0);
pdf_font_kn_bs_base[k] := pdf_font_kn_bs_base[f];
pdf_font_st_bs_base[k] := pdf_font_st_bs_base[f];
pdf_font_sh_bs_base[k] := pdf_font_sh_bs_base[f];
pdf_font_kn_bc_base[k] := pdf_font_kn_bc_base[f];
pdf_font_kn_ac_base[k] := pdf_font_kn_ac_base[f];
end;
function tfm_lookup(s: str_number; fs: scaled): internal_font_number;
{looks up for a TFM with name |s| loaded at |fs| size; if found then flushes |s|}
var k: internal_font_number;
begin
if fs <> 0 then begin
for k := font_base + 1 to font_ptr do
if (font_area[k] <> non_existent_path) and
str_eq_str(font_name[k], s) and
(font_size[k] = fs) then
begin
flush_str(s);
tfm_lookup := k;
return;
end;
end
else begin
for k := font_base + 1 to font_ptr do
if (font_area[k] <> non_existent_path) and
str_eq_str(font_name[k], s) then
begin
flush_str(s);
tfm_lookup := k;
return;
end;
end;
tfm_lookup := null_font;
end;
function load_expand_font(f: internal_font_number; e: integer): internal_font_number;
{loads font |f| expanded by |e| thousandths into font memory; |e| is nonzero
and is a multiple of |pdf_font_step[f]|}
label found;
var s: str_number; {font name}
k: internal_font_number;
begin
s := expand_font_name(f, e);
k := tfm_lookup(s, font_size[f]);
if k = null_font then begin
if pdf_font_auto_expand[f] then
k := auto_expand_font(f, e)
else
k := read_font_info(null_cs, s, "", font_size[f]);
end;
if k <> null_font then
copy_expand_params(k, f, e);
load_expand_font := k;
end;
function fix_expand_value(f: internal_font_number; e: integer): integer;
{return the multiple of |pdf_font_step[f]| that is nearest to |e|}
var step: integer;
max_expand: integer;
neg: boolean;
begin
fix_expand_value := 0;
if e = 0 then
return;
if e < 0 then begin
e := -e;
neg := true;
max_expand := -pdf_font_expand_ratio[pdf_font_shrink[f]];
end
else begin
neg := false;
max_expand := pdf_font_expand_ratio[pdf_font_stretch[f]];
end;
if e > max_expand then
e := max_expand
else begin
step := pdf_font_step[f];
if e mod step > 0 then
e := step*round_xn_over_d(e, 1, step);
end;
if neg then
e := -e;
fix_expand_value := e;
end;
function get_expand_font(f: internal_font_number; e: integer): internal_font_number;
{look up and create if not found an expanded version of |f|; |f| is an
expandable font; |e| is nonzero and is a multiple of |pdf_font_step[f]|}
var k: internal_font_number;
begin
k := pdf_font_elink[f];
while k <> null_font do begin
if pdf_font_expand_ratio[k] = e then begin
get_expand_font := k;
return;
end;
k := pdf_font_elink[k];
end;
k := load_expand_font(f, e);
pdf_font_elink[k] := pdf_font_elink[f];
pdf_font_elink[f] := k;
get_expand_font := k;
end;
function expand_font(f: internal_font_number; e: integer): internal_font_number;
{looks up for font |f| expanded by |e| thousandths, |e| is an arbitrary value
between max stretch and max shrink of |f|; if not found then creates it}
begin
expand_font := f;
if e = 0 then
return;
e := fix_expand_value(f, e);
if e = 0 then
return;
if pdf_font_elink[f] = null_font then
pdf_error("font expansion", "uninitialized pdf_font_elink");
expand_font := get_expand_font(f, e);
end;
procedure set_expand_params(f: internal_font_number; auto_expand: boolean;
stretch_limit, shrink_limit, font_step, expand_ratio: integer);
{expand a font with given parameters}
begin
pdf_font_step[f] := font_step;
pdf_font_auto_expand[f] := auto_expand;
if stretch_limit > 0 then
pdf_font_stretch[f] := get_expand_font(f, stretch_limit);
if shrink_limit > 0 then
pdf_font_shrink[f] := get_expand_font(f, -shrink_limit);
if expand_ratio <> 0 then
pdf_font_expand_ratio[f] := expand_ratio;
end;
procedure vf_expand_local_fonts(f: internal_font_number);
var lf: internal_font_number;
k: integer;
begin
pdfassert(pdf_font_type[f] = virtual_font_type);
for k := 0 to vf_local_font_num[f] - 1 do begin
lf := vf_i_fnts[vf_default_font[f] + k];
set_expand_params(lf, pdf_font_auto_expand[f],
pdf_font_expand_ratio[pdf_font_stretch[f]],
-pdf_font_expand_ratio[pdf_font_shrink[f]],
pdf_font_step[f], pdf_font_expand_ratio[f]);
if pdf_font_type[lf] = virtual_font_type then
vf_expand_local_fonts(lf);
end;
end;
procedure read_expand_font; {read font expansion spec and load expanded font}
var shrink_limit, stretch_limit, font_step: integer;
f: internal_font_number;
auto_expand: boolean;
begin
{read font expansion parameters}
scan_font_ident;
f := cur_val;
if f = null_font then
pdf_error("font expansion", "invalid font identifier");
if pdf_font_blink[f] <> null_font then
pdf_error("font expansion", "\pdffontexpand cannot be used this way (the base font has been expanded)");
scan_optional_equals;
scan_int;
stretch_limit := fix_int(cur_val, 0, 1000);
scan_int;
shrink_limit := fix_int(cur_val, 0, 500);
scan_int;
font_step := fix_int(cur_val, 0, 100);
if font_step = 0 then
pdf_error("font expansion", "invalid step");
stretch_limit := stretch_limit - stretch_limit mod font_step;
if stretch_limit < 0 then
stretch_limit := 0;
shrink_limit := shrink_limit - shrink_limit mod font_step;
if shrink_limit < 0 then
shrink_limit := 0;
if (stretch_limit = 0) and (shrink_limit = 0) then
pdf_error("font expansion", "invalid limit(s)");
auto_expand := false;
if scan_keyword("autoexpand") then begin
auto_expand := true;
@<Scan an optional space@>;
end;
{check if the font can be expanded}
if (pdf_font_expand_ratio[f] <> 0) then
pdf_error("font expansion", "this font has been expanded by another font so it cannot be used now");
if (pdf_font_step[f] <> 0) then
{this font has been expanded, ensure the expansion parameters are identical}
begin
if pdf_font_step[f] <> font_step then
pdf_error("font expansion", "font has been expanded with different expansion step");
if ((pdf_font_stretch[f] = null_font) and (stretch_limit <> 0)) or
((pdf_font_stretch[f] <> null_font) and
(pdf_font_expand_ratio[pdf_font_stretch[f]] <> stretch_limit)) then
pdf_error("font expansion", "font has been expanded with different stretch limit");
if ((pdf_font_shrink[f] = null_font) and (shrink_limit <> 0)) or
((pdf_font_shrink[f] <> null_font) and
(-pdf_font_expand_ratio[pdf_font_shrink[f]] <> shrink_limit)) then
pdf_error("font expansion", "font has been expanded with different shrink limit");
if pdf_font_auto_expand[f] <> auto_expand then
pdf_error("font expansion", "font has been expanded with different auto expansion value");
end
else begin
if (pdf_font_type[f] <> new_font_type) and (pdf_font_type[f] <> virtual_font_type) then
pdf_warning("font expansion", "font should be expanded before its first use", true, true);
set_expand_params(f, auto_expand, stretch_limit, shrink_limit, font_step, 0);
if pdf_font_type[f] = virtual_font_type then
vf_expand_local_fonts(f);
end;
end;
@ We implement robust letter spacing using virtual font.
@d vf_replace_z ==
begin
vf_alpha:=16;
while vf_z>=@'40000000 do begin
vf_z:=vf_z div 2;
vf_alpha:=vf_alpha+vf_alpha;
end;
vf_beta:=256 div vf_alpha;
vf_alpha:=vf_alpha*vf_z;
end
@p
function letter_space_font(u: pointer; f: internal_font_number; e: integer): internal_font_number;
var k: internal_font_number;
w, r: scaled;
s: str_number;
i, nw: integer;
old_setting:0..max_selector;
vf_z: integer;
vf_alpha: integer;
vf_beta: 1..16;
begin
{read a new font and expand the character widths}
k := read_font_info(u, font_name[f], "", font_size[f]);
if scan_keyword("nolig") then
set_no_ligatures(k); {disable ligatures for letter-spaced fonts}
nw := height_base[k] - width_base[k];
if (quad(k) = 0) and (quad(f) > 0) then
quad(k) := quad(f);
if quad(k) = 0 then
pdf_warning("\letterspacefont", "font has zero em size (\fontdimen6)", true, true);
for i := 0 to nw - 1 do
font_info[width_base[k] + i].sc :=
font_info[width_base[k] + i].sc + round_xn_over_d(quad(k), e, 1000);
{append, e.g., '+100ls' to font name}
str_room(length(font_name[k]) + 7); {|abs(e) <= 1000|}
old_setting := selector;
selector := new_string;
print(font_name[k]);
if e > 0 then
print("+"); {minus sign will be printed by |print_int|}
print_int(e);
print("ls");
selector := old_setting;
font_name[k] := make_string;
{create the corresponding virtual font}
allocvffnts;
vf_e_fnts[vf_nf] := 0;
vf_i_fnts[vf_nf] := f;
incr(vf_nf);
vf_local_font_num[k] := 1;
vf_default_font[k] := vf_nf - 1;
pdf_font_type[k] := virtual_font_type;
vf_z := font_size[f];
vf_replace_z;
w := round_xn_over_d(quad(f), e, 2000);
if w >= 0 then
tmp_b0 := 0
else begin
tmp_b0 := 255;
w := vf_alpha + w;
end;
r := w*vf_beta;
tmp_b1 := r div vf_z;
r := r mod vf_z;
if r = 0 then
tmp_b2 := 0
else begin
r := r * 256;
tmp_b2 := r div vf_z;
r := r mod vf_z;
end;
if r = 0 then
tmp_b3 := 0
else begin
r := r * 256;
tmp_b3 := r div vf_z;
end;
vf_packet_base[k] := new_vf_packet(k);
for c := font_bc[k] to font_ec[k] do begin
str_room(12);
append_char(right1 + 3);
append_char(tmp_b0);
append_char(tmp_b1);
append_char(tmp_b2);
append_char(tmp_b3);
if c < set1 then
append_char(c)
else begin
append_char(set1);
append_char(c);
end;
append_char(right1 + 3);
append_char(tmp_b0);
append_char(tmp_b1);
append_char(tmp_b2);
append_char(tmp_b3);
s := make_string;
storepacket(k, c, s);
flush_str(s);
end;
letter_space_font := k;
end;
procedure new_letterspaced_font(a: small_number);
{letter-space a font by creating a virtual font}
var u:pointer; {user's font identifier}
@!t:str_number; {name for the frozen font identifier}
@!old_setting:0..max_selector; {holds |selector| setting}
@!f, k:internal_font_number;
begin
get_r_token; u:=cur_cs;
if u>=hash_base then t:=text(u)
else if u>=single_base then
if u=null_cs then t:="FONT"@+else t:=u-single_base
else begin old_setting:=selector; selector:=new_string;
print("FONT"); print(u-active_base); selector:=old_setting;
@.FONTx@>
str_room(1); t:=make_string;
end;
define(u,set_font,null_font); scan_optional_equals; scan_font_ident;
k := cur_val;
scan_int;
f := letter_space_font(u, k, fix_int(cur_val, -1000, 1000));
equiv(u):=f; eqtb[font_id_base+f]:=eqtb[u]; font_id_text(f):=t;
end;
function is_letterspaced_font(f: internal_font_number): boolean;
label done;
var i, j: pool_pointer;
begin
is_letterspaced_font := false;
if pdf_font_type[f] <> virtual_font_type then
return;
i := str_start[font_name[f] + 1] - 1;
j := str_start[font_name[f]];
if (str_pool[i - 1] <> 'l') or (str_pool[i] <> 's') then
return;
i := i - 2;
while i >= j do begin
if (str_pool[i] < '0') or (str_pool[i] > '9') then
goto done;
i := i - 1;
end;
done:
if i < j then
return;
if (str_pool[i] <> '+') and (str_pool[i] <> '-') then
return;
is_letterspaced_font := true;
end;
function copy_font_info(f: internal_font_number): internal_font_number;
{create a copy of |f| in the font mem}
var lf, bc, ec, i: halfword;
k: internal_font_number;
begin
if (pdf_font_expand_ratio[f] <> 0) or (pdf_font_step[f] <> 0) then
pdf_error("\pdfcopyfont", "cannot copy an expanded font");
if is_letterspaced_font(f) then
pdf_error("\pdfcopyfont", "cannot copy a letterspaced font");
k := font_ptr + 1;
incr(font_ptr);
if (font_ptr >= font_max) then
overflow("maximum internal font number (font_max)", font_max);
font_name[k] := font_name[f];
font_area[k] := non_existent_path; {to avoid interferences with |new_font()| and |tfm_lookup()|}
hyphen_char[k] := hyphen_char[f];
skew_char[k] := skew_char[f];
font_bchar[k] := font_bchar[f];
font_false_bchar[k] := font_false_bchar[f];
font_bc[k] := font_bc[f];
font_ec[k] := font_ec[f];
font_size[k] := font_size[f];
font_dsize[k] := font_dsize[f];
font_params[k] := font_params[f];
font_glue[k] := font_glue[f];
bchar_label[k] := bchar_label[f];
{set base addresses}
bc := font_bc[f];
ec := font_ec[f];
char_base[k] := fmem_ptr - bc;
width_base[k] := char_base[k] + ec + 1;
height_base[k] := width_base[k] + (height_base[f] - width_base[f]);
depth_base[k] := height_base[k] + (depth_base[f] - height_base[f]);
italic_base[k] := depth_base[k] + (italic_base[f] - depth_base[f]);
lig_kern_base[k] := italic_base[k] + (lig_kern_base[f] - italic_base[f]);
kern_base[k] := lig_kern_base[k] + (kern_base[f] - lig_kern_base[f]);
exten_base[k] := kern_base[k] + (exten_base[f] - kern_base[f]);
param_base[k] := exten_base[k] + (param_base[f] - exten_base[f]);
{allocate memory for the new font |k| and copy data from |f|}
lf := (param_base[f] - char_base[f]) + font_params[f] + 1;
if (fmem_ptr + lf >= font_mem_size) then
overflow("number of words of font memory (font_mem_size)", font_mem_size);
for i := 0 to lf - 1 do
font_info[char_base[k] + bc + i] := font_info[char_base[f] + bc + i];
fmem_ptr := fmem_ptr + lf;
copy_font_info := k;
end;
procedure make_font_copy(a: small_number);
{make a font copy for further use with font expansion}
var u:pointer; {user's font identifier}
@!t:str_number; {name for the frozen font identifier}
@!old_setting:0..max_selector; {holds |selector| setting}
@!f, k:internal_font_number;
begin
get_r_token; u:=cur_cs;
if u>=hash_base then t:=text(u)
else if u>=single_base then
if u=null_cs then t:="FONT"@+else t:=u-single_base
else begin old_setting:=selector; selector:=new_string;
print("FONT"); print(u-active_base); selector:=old_setting;
@.FONTx@>
str_room(1); t:=make_string;
end;
define(u,set_font,null_font); scan_optional_equals; scan_font_ident;
k := cur_val;
f := copy_font_info(k);
equiv(u):=f; eqtb[font_id_base+f]:=eqtb[u]; font_id_text(f):=t;
end;
@ We need to hold information about used characters in each font for partial
downloading.
@<Types...@>=
char_used_array = array[0..31] of eight_bits;
char_map_array = array[0..32] of eight_bits; {move chars in range 0..32}
fm_entry_ptr = ^integer;
@ @<Glob...@>=
@!pdf_char_used: ^char_used_array; {to mark used chars}
@!pdf_font_size: ^scaled; {used size of font in PDF file}
@!pdf_font_num: ^integer; {mapping between internal font number in \TeX\ and
font name defined in resources in PDF file}
@!pdf_font_map: ^fm_entry_ptr; {pointer into AVL tree of font mappings}
@!pdf_font_list: pointer; {list of used fonts in current page}
@!pdf_resname_prefix: str_number; {global prefix of resources name}
@!last_tokens_string: str_number; {the number of the most recently string
created by |tokens_to_string|}
@ @<Set init...@>=
pdf_resname_prefix := 0;
last_tokens_string := 0;
@ Here we implement reading information from \.{VF} file.
@d vf_max_packet_length = 10000 {max length of character packet in \.{VF} file}
@#
@d do_char = 70 {label to go to typesetting a character of virtual font}
@#
@d long_char = 242 {\.{VF} command for general character packet}
@d vf_id = 202 {identifies \.{VF} files}
@d put1=133 {typeset a character}
@d four_cases(#) == #,#+1,#+2,#+3
@#
@d tmp_b0 == tmp_w.qqqq.b0
@d tmp_b1 == tmp_w.qqqq.b1
@d tmp_b2 == tmp_w.qqqq.b2
@d tmp_b3 == tmp_w.qqqq.b3
@d tmp_int == tmp_w.int
@#
@d bad_vf(#) == vf_error(font_name[f], #) {quit with an error message telling the vf filename}
@<Glob...@>=
@!vf_packet_base: ^integer; {base addresses of character packets from virtual fonts}
@!vf_default_font: ^internal_font_number; {default font in a \.{VF} file}
@!vf_local_font_num: ^internal_font_number; {number of local fonts in a \.{VF} file}
@!vf_packet_length: integer; {length of the current packet}
@!vf_file: byte_file;
@!vf_nf: internal_font_number; {the local fonts counter}
@!vf_e_fnts: ^integer; {external font numbers}
@!vf_i_fnts: ^internal_font_number; {corresponding internal font numbers}
@!tmp_w: memory_word; {accumulator}
@ @<Set init...@>=
vf_nf := 0;
@ The |do_vf| procedure attempts to read the \.{VF} file for a font, and sets
|pdf_font_type| to |real_font_type| if the \.{VF} file could not be found
or loaded, otherwise sets |pdf_font_type| to |virtual_font_type|. To
process font definitions in virtual font we call |vf_def_font|.
@p
procedure vf_error(filename, msg: str_number);
var old_setting:0..max_selector; {holds print |selector|}
s: str_number;
begin
str_room(length(filename) + 3);
old_setting:=selector; selector:=new_string;
print(filename);
print(".vf");
s := make_string;
selector:=old_setting;
pdf_error(s, msg);
end;
function vf_byte: eight_bits; {read a byte from |vf_file|}
var i: integer;
begin
i := getc(vf_file);
if i < 0 then
pdf_error("vf", "unexpected EOF or error");
vf_byte := i;
end;
function vf_read_signed(k: integer): integer;
{read |k| bytes as an signed integer from \.{VF} file}
var i: integer;
begin
pdfassert((k > 0) and (k <= 4));
i := vf_byte;
if i >= 128 then
i := i - 256;
decr(k);
while k > 0 do begin
i := i*256 + vf_byte;
decr(k);
end;
vf_read_signed := i;
end;
function vf_read_unsigned(k: integer): integer;
{read |k| bytes as an unsigned integer from \.{VF} file}
var i: integer;
begin
pdfassert((k > 0) and (k <= 4));
i := vf_byte;
if (k = 4) and (i >= 128) then
bad_vf("number too big");
decr(k);
while k > 0 do begin
i := i*256 + vf_byte;
decr(k);
end;
vf_read_unsigned := i;
end;
procedure vf_local_font_warning(f, k: internal_font_number; s: str_number);
{print a warning message if an error occurs during processing local fonts in
\.{VF} file}
begin
print_nl(s);
print(" in local font ");
print(font_name[k]);
print(" in virtual font ");
print(font_name[f]);
print(".vf ignored.");
end;
function vf_def_font(f: internal_font_number): internal_font_number;
{process a local font in \.{VF} file}
var k: internal_font_number;
s: str_number;
ds, fs: scaled;
cs: four_quarters;
begin
cs.b0 := vf_byte; cs.b1 := vf_byte; cs.b2 := vf_byte; cs.b3 := vf_byte;
fs := store_scaled_f(vf_read_signed(4), font_size[f]);
ds := vf_read_signed(4) div @'20;
tmp_b0 := vf_byte;
tmp_b1 := vf_byte;
while tmp_b0 > 0 do begin
decr(tmp_b0);
call_func(vf_byte); {skip the font path}
end;
str_room(tmp_b1);
while tmp_b1 > 0 do begin
decr(tmp_b1);
append_char(vf_byte);
end;
s := make_string;
k := tfm_lookup(s, fs);
if k = null_font then
k := read_font_info(null_cs, s, "", fs);
if k <> null_font then begin
if ((cs.b0 <> 0) or (cs.b1 <> 0) or (cs.b2 <> 0) or (cs.b3 <> 0)) and
((font_check[k].b0 <> 0) or (font_check[k].b1 <> 0) or
(font_check[k].b2 <> 0) or (font_check[k].b3 <> 0)) and
((cs.b0 <> font_check[k].b0) or (cs.b1 <> font_check[k].b1) or
(cs.b2 <> font_check[k].b2) or (cs.b3 <> font_check[k].b3)) then
vf_local_font_warning(f, k, "checksum mismatch");
if ds <> font_dsize[k] then
vf_local_font_warning(f, k, "design size mismatch");
if (pdf_font_step[f] <> 0) then
set_expand_params(k, pdf_font_auto_expand[f],
pdf_font_expand_ratio[pdf_font_stretch[f]],
-pdf_font_expand_ratio[pdf_font_shrink[f]],
pdf_font_step[f], pdf_font_expand_ratio[f]);
end;
vf_def_font := k;
end;
procedure do_vf(f: internal_font_number); {process \.{VF} file with font internal number |f|}
var cmd, k, n: integer;
cc, cmd_length, packet_length: integer;
tfm_width: scaled;
s: str_number;
stack_level: vf_stack_index;
save_vf_nf: internal_font_number;
begin
pdf_font_type[f] := real_font_type;
if auto_expand_vf(f) then
return; {auto-expanded virtual font}
stack_level := 0;
@<Open |vf_file|, return if not found@>;
@<Process the preamble@>;@/
@<Process the font definitions@>;@/
@<Allocate memory for the new virtual font@>;@/
while cmd <= long_char do begin@/
@<Build a character packet@>;@/
end;
if cmd <> post then
bad_vf("POST command expected");
b_close(vf_file);
pdf_font_type[f] := virtual_font_type;
end;
@ @<Open |vf_file|, return if not found@>=
pack_file_name(font_name[f], "", ".vf");
if not vf_b_open_in(vf_file) then
return
@ @<Process the preamble@>=
if vf_byte <> pre then
bad_vf("PRE command expected");
if vf_byte <> vf_id then
bad_vf("wrong id byte");
cmd_length := vf_byte;
for k := 1 to cmd_length do
call_func(vf_byte); {skip the comment}
tmp_b0 := vf_byte; tmp_b1 := vf_byte; tmp_b2 := vf_byte; tmp_b3 := vf_byte;
if ((tmp_b0 <> 0) or (tmp_b1 <> 0) or (tmp_b2 <> 0) or (tmp_b3 <> 0)) and
((font_check[f].b0 <> 0) or (font_check[f].b1 <> 0) or
(font_check[f].b2 <> 0) or (font_check[f].b3 <> 0)) and
((tmp_b0 <> font_check[f].b0) or (tmp_b1 <> font_check[f].b1) or
(tmp_b2 <> font_check[f].b2) or (tmp_b3 <> font_check[f].b3)) then begin
print_nl("checksum mismatch in font ");
print(font_name[f]);
print(".vf ignored");
end;
if vf_read_signed(4) div @'20 <> font_dsize[f] then begin
print_nl("design size mismatch in font ");
print(font_name[f]);
print(".vf ignored");
end;
update_terminal
@ @<Process the font definitions@>=
cmd := vf_byte;
save_vf_nf := vf_nf;
while (cmd >= fnt_def1) and (cmd <= fnt_def1 + 3) do begin
allocvffnts;
vf_e_fnts[vf_nf] := vf_read_unsigned(cmd - fnt_def1 + 1);
vf_i_fnts[vf_nf] := vf_def_font(f);
incr(vf_nf);
cmd := vf_byte;
end;
vf_default_font[f] := save_vf_nf;
vf_local_font_num[f] := vf_nf - save_vf_nf;
@ @<Allocate memory for the new virtual font@>=
vf_packet_base[f] := new_vf_packet(f)
@ @<Build a character packet@>=
if cmd = long_char then begin
packet_length := vf_read_unsigned(4);
cc := vf_read_unsigned(4);
if not is_valid_char(cc) then
bad_vf("invalid character code");
tfm_width := store_scaled_f(vf_read_signed(4), font_size[f]);
end
else begin
packet_length := cmd;
cc := vf_byte;
if not is_valid_char(cc) then
bad_vf("invalid character code");
tfm_width := store_scaled_f(vf_read_unsigned(3), font_size[f]);
end;
if packet_length < 0 then
bad_vf("negative packet length");
if packet_length > vf_max_packet_length then
bad_vf("packet length too long");
if tfm_width <> char_width(f)(char_info(f)(cc)) then begin
print_nl("character width mismatch in font ");
print(font_name[f]);
print(".vf ignored");
end;
str_room(packet_length);
while packet_length > 0 do begin
cmd := vf_byte;
decr(packet_length);
@<Cases of \.{DVI} commands that can appear in character packet@>;
if cmd <> nop then
append_char(cmd);
packet_length := packet_length - cmd_length;
while cmd_length > 0 do begin
decr(cmd_length);
append_char(vf_byte);
end;
end;
if stack_level <> 0 then
bad_vf("more PUSHs than POPs in character packet");
if packet_length <> 0 then
bad_vf("invalid packet length or DVI command in packet");
@<Store the packet being built@>;
cmd := vf_byte
@ @<Store the packet being built@>=
s := make_string;
storepacket(f, cc, s);
flush_str(s)
@ @<Cases of \.{DVI} commands that can appear in character packet@>=
if (cmd >= set_char_0) and (cmd <= set_char_0 + 127) then
cmd_length := 0
else if ((fnt_num_0 <= cmd) and (cmd <= fnt_num_0 + 63)) or
((fnt1 <= cmd) and (cmd <= fnt1 + 3)) then begin
if cmd >= fnt1 then begin
k := vf_read_unsigned(cmd - fnt1 + 1);
packet_length := packet_length - (cmd - fnt1 + 1);
end
else
k := cmd - fnt_num_0;
if k >= 256 then
bad_vf("too many local fonts");
n := 0;
while (n < vf_local_font_num[f]) and
(vf_e_fnts[vf_default_font[f] + n] <> k) do
incr(n);
if n = vf_local_font_num[f] then
bad_vf("undefined local font");
if k <= 63 then
append_char(fnt_num_0 + k)
else begin
append_char(fnt1);
append_char(k);
end;
cmd_length := 0;
cmd := nop;
end
else case cmd of
set_rule, put_rule: cmd_length := 8;
four_cases(set1): cmd_length := cmd - set1 + 1;
four_cases(put1): cmd_length := cmd - put1 + 1;
four_cases(right1): cmd_length := cmd - right1 + 1;
four_cases(w1): cmd_length := cmd - w1 + 1;
four_cases(x1): cmd_length := cmd - x1 + 1;
four_cases(down1): cmd_length := cmd - down1 + 1;
four_cases(y1): cmd_length := cmd - y1 + 1;
four_cases(z1): cmd_length := cmd - z1 + 1;
four_cases(xxx1): begin
cmd_length := vf_read_unsigned(cmd - xxx1 + 1);
packet_length := packet_length - (cmd - xxx1 + 1);
if cmd_length > vf_max_packet_length then
bad_vf("packet length too long");
if cmd_length < 0 then
bad_vf("string of negative length");
append_char(xxx1);
append_char(cmd_length);
cmd := nop; {|cmd| has been already stored above as |xxx1|}
end;
w0, x0, y0, z0, nop:
cmd_length := 0;
push, pop: begin
cmd_length := 0;
if cmd = push then
if stack_level = vf_stack_size then
overflow("virtual font stack size", vf_stack_size)
else
incr(stack_level)
else
if stack_level = 0 then
bad_vf("more POPs than PUSHs in character")
else
decr(stack_level);
end;
othercases
bad_vf("improver DVI command");
endcases
@ @p
procedure pdf_check_vf_cur_val;
var f: internal_font_number;
begin
f := cur_val;
do_vf(f);
if pdf_font_type[f] = virtual_font_type then
pdf_error("font", "command cannot be used with virtual font");
end;
function auto_expand_vf(f: internal_font_number): boolean;
{check for a virtual auto-expanded font}
var bf, lf: internal_font_number;
e, k: integer;
begin
auto_expand_vf := false;
if (not pdf_font_auto_expand[f]) or (pdf_font_blink[f] = null_font) then
return; {not an auto-expanded font}
bf := pdf_font_blink[f];
if pdf_font_type[bf] = new_font_type then {we must process the base font first}
do_vf(bf);
if pdf_font_type[bf] <> virtual_font_type then
return; {not a virtual font}
e := pdf_font_expand_ratio[f];
for k := 0 to vf_local_font_num[bf] - 1 do begin
lf := vf_default_font[bf] + k;
allocvffnts;
{copy vf local font numbers:}
vf_e_fnts[vf_nf] := vf_e_fnts[lf];
{definition of local vf fonts are expanded from base fonts:}
vf_i_fnts[vf_nf] := auto_expand_font(vf_i_fnts[lf], e);
copy_expand_params(vf_i_fnts[vf_nf], vf_i_fnts[lf], e);
incr(vf_nf);
end;
vf_packet_base[f] := vf_packet_base[bf];
vf_local_font_num[f] := vf_local_font_num[bf];
vf_default_font[f] := vf_nf - vf_local_font_num[f];
pdf_font_type[f] := virtual_font_type;
auto_expand_vf := true;
end;
@ The |do_vf_packet| procedure is called in order to interpret the
character packet for a virtual character. Such a packet may contain the
instruction to typeset a character from the same or an other virtual
font; in such cases |do_vf_packet| calls itself recursively. The
recursion level, i.e., the number of times this has happened, is kept
in the global variable |vf_cur_s| and should not exceed |vf_max_recursion|.
@<Constants...@>=
@!vf_max_recursion=10; {\.{VF} files shouldn't recurse beyond this level}
@!vf_stack_size=100; {\.{DVI} files shouldn't |push| beyond this depth}
@ @<Types...@>=
@!vf_stack_index=0..vf_stack_size; {an index into the stack}
@!vf_stack_record=record
stack_h, stack_v, stack_w, stack_x, stack_y, stack_z: scaled;
end;
@ @<Glob...@>=
@!vf_cur_s: 0..vf_max_recursion; {current recursion level}
@!vf_stack: array [vf_stack_index] of vf_stack_record;
@!vf_stack_ptr: vf_stack_index; {pointer into |vf_stack|}
@ @<Set init...@>=
vf_cur_s := 0;
vf_stack_ptr := 0;
@ Some functions for processing character packets.
@p function packet_read_signed(k: integer): integer;
{read |k| bytes as a signed integer from character packet}
var i: integer;
begin
pdfassert((k > 0) and (k <= 4));
i := packet_byte;
if i >= 128 then
i := i - 256;
decr(k);
while k > 0 do begin
i := i*256 + packet_byte;
decr(k);
end;
packet_read_signed := i;
end;
function packet_read_unsigned(k: integer): integer;
{read |k| bytes as an unsigned integer from character packet}
var i: integer;
begin
pdfassert((k > 0) and (k <= 4));
i := packet_byte;
if (k = 4) and (i >= 128) then
bad_vf("number too big");
decr(k);
while k > 0 do begin
i := i*256 + packet_byte;
decr(k);
end;
packet_read_unsigned := i;
end;
function packet_scaled(k: integer; fs: scaled): scaled;
{get |k| bytes from packet as scaled}
begin
packet_scaled := store_scaled_f(packet_read_signed(k), fs);
end;
procedure do_vf_packet(vf_f: internal_font_number; c: eight_bits); {typeset the
\.{DVI} commands in the character packet for character |c| in current font |f|}
label do_char, continue;
var f, k, n: internal_font_number;
save_cur_h, save_cur_v: scaled;
cmd: integer;
char_move: boolean;
w, x, y, z: scaled;
s: str_number;
begin
incr(vf_cur_s);
if vf_cur_s > vf_max_recursion then
overflow("max level recursion of virtual fonts", vf_max_recursion);
save_cur_v := cur_v;
save_cur_h := cur_h;
push_packet_state; {save pointer and length of the current packet}
start_packet(vf_f, c); {set pointer and length of the new packet}
f := vf_i_fnts[vf_default_font[vf_f]];
w := 0; x := 0; y := 0; z := 0;
while vf_packet_length > 0 do begin
cmd := packet_byte;
@<Do typesetting the \.{DVI} commands in virtual character packet@>;
continue:
end;
pop_packet_state; {restore pointer and length of the previous packet}
cur_v := save_cur_v;
cur_h := save_cur_h;
decr(vf_cur_s);
end;
@ The following code typesets a character to PDF output.
@d output_one_char(#) == begin
if pdf_font_type[f] = new_font_type then
do_vf(f);
if pdf_font_type[f] = virtual_font_type then
do_vf_packet(f, #)
else begin
pdf_begin_string(f);
pdf_print_char(f, #);
adv_char_width(f, #, 4);
end;
end
@<Do typesetting the \.{DVI} commands in virtual character packet@>=
if (cmd >= set_char_0) and (cmd <= set_char_0 + 127) then begin
if not is_valid_char(cmd) then begin
char_warning(f, cmd);
goto continue;
end;
c := cmd;
char_move := true;
goto do_char;
end
else if ((fnt_num_0 <= cmd) and (cmd <= fnt_num_0 + 63)) or (cmd = fnt1) then begin
if cmd = fnt1 then
k := packet_byte
else
k := cmd - fnt_num_0;
n := 0;
while (n < vf_local_font_num[vf_f]) and
(vf_e_fnts[vf_default_font[vf_f] + n] <> k) do
incr(n);
if (n = vf_local_font_num[vf_f]) then
pdf_error("vf", "local font not found")
else
f := vf_i_fnts[vf_default_font[vf_f] + n];
end
else case cmd of
push: begin
vf_stack[vf_stack_ptr].stack_h := cur_h;
vf_stack[vf_stack_ptr].stack_v := cur_v;
vf_stack[vf_stack_ptr].stack_w := w;
vf_stack[vf_stack_ptr].stack_x := x;
vf_stack[vf_stack_ptr].stack_y := y;
vf_stack[vf_stack_ptr].stack_z := z;
incr(vf_stack_ptr);
end;
pop: begin
decr(vf_stack_ptr);
cur_h := vf_stack[vf_stack_ptr].stack_h;
cur_v := vf_stack[vf_stack_ptr].stack_v;
w := vf_stack[vf_stack_ptr].stack_w;
x := vf_stack[vf_stack_ptr].stack_x;
y := vf_stack[vf_stack_ptr].stack_y;
z := vf_stack[vf_stack_ptr].stack_z;
end;
four_cases(set1), four_cases(put1): begin
if (set1 <= cmd) and (cmd <= set1 + 3) then begin
tmp_int := packet_read_unsigned(cmd - set1 + 1);
char_move := true;
end
else begin
tmp_int := packet_read_unsigned(cmd - put1 + 1);
char_move := false;
end;
if not is_valid_char(tmp_int) then begin
char_warning(f, tmp_int);
goto continue;
end;
c := tmp_int;
goto do_char;
end;
set_rule, put_rule: begin
rule_ht := packet_scaled(4, font_size[vf_f]);
rule_wd := packet_scaled(4, font_size[vf_f]);
if (rule_wd > 0) and (rule_ht > 0) then begin
pdf_set_rule(cur_h, cur_v, rule_wd, rule_ht);
if cmd = set_rule then
cur_h := cur_h + rule_wd;
end;
end;
four_cases(right1):
cur_h := cur_h + packet_scaled(cmd - right1 + 1, font_size[vf_f]);
w0, four_cases(w1): begin
if cmd > w0 then
w := packet_scaled(cmd - w0, font_size[vf_f]);
cur_h := cur_h + w;
end;
x0, four_cases(x1): begin
if cmd > x0 then
x := packet_scaled(cmd - x0, font_size[vf_f]);
cur_h := cur_h + x;
end;
four_cases(down1):
cur_v := cur_v + packet_scaled(cmd - down1 + 1, font_size[vf_f]);
y0, four_cases(y1): begin
if cmd > y0 then
y := packet_scaled(cmd - y0, font_size[vf_f]);
cur_v := cur_v + y;
end;
z0, four_cases(z1): begin
if cmd > z0 then
z := packet_scaled(cmd - z0, font_size[vf_f]);
cur_v := cur_v + z;
end;
four_cases(xxx1): begin
tmp_int := packet_read_unsigned(cmd - xxx1 + 1);
str_room(tmp_int);
while tmp_int > 0 do begin
decr(tmp_int);
append_char(packet_byte);
end;
s := make_string;
literal(s, scan_special, false);
flush_str(s);
end;
othercases pdf_error("vf", "invalid DVI command");
endcases;
goto continue;
do_char:
if is_valid_char(c) then
output_one_char(c)
else
char_warning(f, c);
if char_move then
cur_h := cur_h + char_width(f)(char_info(f)(c))
@* \[32f] PDF shipping out.
To ship out a \TeX\ box to PDF page description we need to implement
|pdf_hlist_out|, |pdf_vlist_out| and |pdf_ship_out|, which are equivalent to
the \TeX' original |hlist_out|, |vlist_out| and |ship_out| resp. But first we
need to declare some procedures needed in |pdf_hlist_out| and |pdf_vlist_out|.
@<Declare procedures needed in |pdf_hlist_out|, |pdf_vlist_out|@>=
procedure pdf_out_literal(p:pointer);
var old_setting:0..max_selector; {holds print |selector|}
s: str_number;
h: halfword;
@!q,@!r:pointer; {temporary variables for list manipulation}
@!old_mode:integer; {saved |mode|}
begin
old_setting:=selector;
if subtype(p)=pdf_lateliteral_node then
begin @<Expand macros in the token list
and make |link(def_ref)| point to the result@>;
h:=def_ref;
end
else h:=pdf_literal_data(p);
selector:=new_string;
show_token_list(link(h),null,pool_size-pool_ptr);
selector:=old_setting;
s := make_string;
literal(s, pdf_literal_mode(p), false);
flush_str(s);
if subtype(p)=pdf_lateliteral_node then
flush_list(def_ref);
end;
procedure pdf_out_colorstack(p:pointer);
var old_setting: 0..max_selector; {holds print |selector|}
s: str_number;
cmd: integer;
stack_no: integer;
literal_mode: integer;
begin
cmd := pdf_colorstack_cmd(p);
stack_no := pdf_colorstack_stack(p);
if stack_no >= colorstackused then begin
print_nl("");
print("Color stack ");
print_int(stack_no);
print(" is not initialized for use!");
print_nl("");
return;
end;
case cmd of
colorstack_set, colorstack_push: begin
old_setting:=selector; selector:=new_string;
show_token_list(link(pdf_colorstack_data(p)),null,pool_size-pool_ptr);
selector:=old_setting;
s := make_string;
if cmd = colorstack_set then
literal_mode := colorstackset(stack_no, s)
else
literal_mode := colorstackpush(stack_no, s);
if length(s) > 0 then
literal(s, literal_mode, false);
flush_str(s);
return;
end;
colorstack_pop: literal_mode := colorstackpop(stack_no);
colorstack_current: literal_mode := colorstackcurrent(stack_no);
othercases confusion("pdfcolorstack")
endcases;
if cur_length > 0 then begin
s := make_string;
literal(s, literal_mode, false);
flush_str(s);
end
end;
procedure pdf_out_colorstack_startpage;
var i: integer;
max: integer;
start_status: integer;
literal_mode: integer;
s: str_number;
begin
i := 0;
max := colorstackused;
while i < max do begin
start_status := colorstackskippagestart(i);
if start_status = 0 then begin
literal_mode := colorstackcurrent(i);
if cur_length > 0 then begin
s := make_string;
literal(s, literal_mode, false);
flush_str(s);
end;
end;
incr(i);
end;
end;
procedure pdf_out_setmatrix(p:pointer);
var old_setting:0..max_selector; {holds print |selector|}
s: str_number;
begin
old_setting:=selector; selector:=new_string;
show_token_list(link(pdf_setmatrix_data(p)),null,pool_size-pool_ptr);
selector:=old_setting;
str_room(7);
str_pool[pool_ptr] := 0; { make C string for pdfsetmatrix }
if pdfsetmatrix(str_start[str_ptr], cur_h, cur_page_height - cur_v) = 1 then begin
str_room(7);
append_char(" ");
append_char("0");
append_char(" ");
append_char("0");
append_char(" ");
append_char("c");
append_char("m");
s := make_string;
literal(s, set_origin, false);
end
else begin
pdf_error("\pdfsetmatrix", "Unrecognized format.");
end;
flush_str(s);
end;
procedure pdf_out_save(p:pointer);
begin
checkpdfsave(cur_h, cur_v);
literal("q", set_origin, false);
end;
procedure pdf_out_restore(p:pointer);
begin
checkpdfrestore(cur_h, cur_v);
literal("Q", set_origin, false);
end;
procedure pdf_special(p: pointer);
var old_setting:0..max_selector; {holds print |selector|}
s: str_number;
h: halfword;
@!q,@!r:pointer; {temporary variables for list manipulation}
@!old_mode:integer; {saved |mode|}
begin
old_setting:=selector;
selector:=selector;
if subtype(p)=latespecial_node then
begin @<Expand macros in the token list
and make |link(def_ref)| point to the result@>;
h:=def_ref;
end
else h:=write_tokens(p);
selector:=new_string;
show_token_list(link(h),null,pool_size-pool_ptr);
selector:=old_setting;
s := make_string;
literal(s, scan_special, true);
flush_str(s);
if subtype(p)=latespecial_node then
flush_list(def_ref);
end;
procedure pdf_print_toks(p: pointer); {print tokens list |p|}
var s: str_number;
begin
s := tokens_to_string(p);
if length(s) > 0 then
pdf_print(s);
flush_str(s);
end;
procedure pdf_print_toks_ln(p: pointer); {print tokens list |p|}
var s: str_number;
begin
s := tokens_to_string(p);
if length(s) > 0 then begin
pdf_print_ln(s);
end;
flush_str(s);
end;
@ Similar to |vlist_out|, |pdf_vlist_out| needs to be declared forward.
@p procedure@?pdf_vlist_out; forward;
@ The implementation of procedure |pdf_hlist_out| is similar to |hlist_out|.
@p @t\4@>@<Declare procedures needed in |pdf_hlist_out|, |pdf_vlist_out|@>@t@>@/
procedure pdf_hlist_out; {output an |hlist_node| box}
label reswitch, move_past, fin_rule, next_p;
var base_line: scaled; {the baseline coordinate for this box}
@!left_edge: scaled; {the left coordinate for this box}
@!save_h: scaled; {what |cur_h| should pop to}
@!this_box: pointer; {pointer to containing box}
@!g_order: glue_ord; {applicable order of infinity for glue}
@!g_sign: normal..shrinking; {selects type of glue}
@!p:pointer; {current position in the hlist}
@!leader_box:pointer; {the leader box being replicated}
@!leader_wd:scaled; {width of leader box being replicated}
@!lx:scaled; {extra space between leader boxes}
@!outer_doing_leaders:boolean; {were we doing leaders?}
@!edge:scaled; {right edge of sub-box or leader space}
@!prev_p:pointer; {one step behind |p|}
@!glue_temp:real; {glue value before rounding}
@!cur_glue:real; {glue seen so far}
@!cur_g:scaled; {rounded equivalent of |cur_glue| times the glue ratio}
@!i: small_number; {index to scan |pdf_link_stack|}
begin cur_g:=0; cur_glue:=float_constant(0);
this_box:=temp_ptr; g_order:=glue_order(this_box);
g_sign:=glue_sign(this_box); p:=list_ptr(this_box);
incr(cur_s);
base_line:=cur_v;
prev_p:=this_box+list_offset;
@<Initialize |hlist_out| for mixed...@>;
left_edge:=cur_h;
@<Create link annotations for the current hbox if needed@>;
while p<>null do
@<Output node |p| for |pdf_hlist_out| and move to the next node,
maintaining the condition |cur_v=base_line|@>;
@<Finish |hlist_out| for mixed...@>;
decr(cur_s);
end;
@ @<Create link annotations for the current hbox if needed@>=
for i := 1 to pdf_link_stack_ptr do begin
pdfassert(is_running(pdf_width(pdf_link_stack[i].link_node)));
if (pdf_link_stack[i].nesting_level = cur_s) and gen_running_link then
append_link(this_box, left_edge, base_line, i);
end
@ @<Output node |p| for |pdf_hlist_out|...@>=
reswitch: if is_char_node(p) then
begin
repeat f:=font(p); c:=character(p);
if is_valid_char(c) then
output_one_char(c)
else
char_warning(f, c);
cur_h:=cur_h+char_width(f)(char_info(f)(c));
prev_p:=link(prev_p); {N.B.: not |prev_p:=p|, |p| might be |lig_trick|}
p:=link(p);
until not is_char_node(p);
end
else @<Output the non-|char_node| |p| for |pdf_hlist_out|
and move to the next node@>
@ @<Output the non-|char_node| |p| for |pdf_hlist_out|...@>=
begin case type(p) of
hlist_node,vlist_node:@<(\pdfTeX) Output a box in an hlist@>;
rule_node: begin rule_ht:=height(p); rule_dp:=depth(p); rule_wd:=width(p);
goto fin_rule;
end;
whatsit_node: @<Output the whatsit node |p| in |pdf_hlist_out|@>;
glue_node: @<(\pdfTeX) Move right or output leaders@>;
margin_kern_node,
kern_node:cur_h:=cur_h+width(p);
math_node: @<Handle a math node in |hlist_out|@>;
ligature_node: @<Make node |p| look like a |char_node| and |goto reswitch|@>;
@/@<Cases of |hlist_out| that arise in mixed direction text only@>@;
othercases do_nothing
endcases;@/
goto next_p;
fin_rule: @<(\pdfTeX) Output a rule in an hlist@>;
move_past: cur_h:=cur_h+rule_wd;
next_p:prev_p:=p; p:=link(p);
end
@ @<(\pdfTeX) Output a box in an hlist@>=
if list_ptr(p)=null then cur_h:=cur_h+width(p)
else begin
cur_v:=base_line+shift_amount(p); {shift the box down}
temp_ptr:=p; edge:=cur_h+width(p);
if cur_dir=right_to_left then cur_h:=edge;
if type(p)=vlist_node then pdf_vlist_out@+else pdf_hlist_out;
cur_h:=edge; cur_v:=base_line;
end
@ @<(\pdfTeX) Output a rule in an hlist@>=
if is_running(rule_ht) then rule_ht:=height(this_box);
if is_running(rule_dp) then rule_dp:=depth(this_box);
rule_ht:=rule_ht+rule_dp; {this is the rule thickness}
if (rule_ht>0)and(rule_wd>0) then {we don't output empty rules}
begin cur_v:=base_line+rule_dp;
pdf_set_rule(cur_h, cur_v, rule_wd, rule_ht);
cur_v:=base_line;
end
@ @<(\pdfTeX) Move right or output leaders@>=
begin g:=glue_ptr(p); rule_wd:=width(g)-cur_g;
if g_sign<>normal then
begin if g_sign=stretching then
begin if stretch_order(g)=g_order then
begin cur_glue:=cur_glue+stretch(g);
vet_glue(float(glue_set(this_box))*cur_glue);
@^real multiplication@>
cur_g:=round(glue_temp);
end;
end
else if shrink_order(g)=g_order then
begin cur_glue:=cur_glue-shrink(g);
vet_glue(float(glue_set(this_box))*cur_glue);
cur_g:=round(glue_temp);
end;
end;
rule_wd:=rule_wd+cur_g;
if eTeX_ex then @<Handle a glue node for mixed...@>;
if subtype(p)>=a_leaders then
@<(\pdfTeX) Output leaders in an hlist, |goto fin_rule| if a rule
or to |next_p| if done@>;
goto move_past;
end
@ @<(\pdfTeX) Output leaders in an hlist...@>=
begin leader_box:=leader_ptr(p);
if type(leader_box)=rule_node then
begin rule_ht:=height(leader_box); rule_dp:=depth(leader_box);
goto fin_rule;
end;
leader_wd:=width(leader_box);
if (leader_wd>0)and(rule_wd>0) then
begin rule_wd:=rule_wd+10; {compensate for floating-point rounding}
if cur_dir=right_to_left then cur_h:=cur_h-10;
edge:=cur_h+rule_wd; lx:=0;
@<Let |cur_h| be the position of the first box, and set |leader_wd+lx|
to the spacing between corresponding parts of boxes@>;
while cur_h+leader_wd<=edge do
@<(\pdfTeX) Output a leader box at |cur_h|,
then advance |cur_h| by |leader_wd+lx|@>;
if cur_dir=right_to_left then cur_h:=edge
else cur_h:=edge-10;
goto next_p;
end;
end
@ @<(\pdfTeX) Output a leader box at |cur_h|, ...@>=
begin cur_v:=base_line+shift_amount(leader_box);@/
save_h:=cur_h; temp_ptr:=leader_box;
if cur_dir=right_to_left then cur_h:=cur_h+leader_wd;
outer_doing_leaders:=doing_leaders; doing_leaders:=true;
if type(leader_box)=vlist_node then pdf_vlist_out@+else pdf_hlist_out;
doing_leaders:=outer_doing_leaders;
cur_v:=base_line;
cur_h:=save_h+leader_wd+lx;
end
@ The |pdf_vlist_out| routine is similar to |pdf_hlist_out|, but a bit simpler.
@p procedure pdf_vlist_out; {output a |pdf_vlist_node| box}
label move_past, fin_rule, next_p;
var left_edge: scaled; {the left coordinate for this box}
@!top_edge: scaled; {the top coordinate for this box}
@!save_v: scaled; {what |cur_v| should pop to}
@!this_box: pointer; {pointer to containing box}
@!g_order: glue_ord; {applicable order of infinity for glue}
@!g_sign: normal..shrinking; {selects type of glue}
@!p:pointer; {current position in the vlist}
@!leader_box:pointer; {the leader box being replicated}
@!leader_ht:scaled; {height of leader box being replicated}
@!lx:scaled; {extra space between leader boxes}
@!outer_doing_leaders:boolean; {were we doing leaders?}
@!edge:scaled; {bottom boundary of leader space}
@!glue_temp:real; {glue value before rounding}
@!cur_glue:real; {glue seen so far}
@!cur_g:scaled; {rounded equivalent of |cur_glue| times the glue ratio}
begin cur_g:=0; cur_glue:=float_constant(0);
this_box:=temp_ptr; g_order:=glue_order(this_box);
g_sign:=glue_sign(this_box); p:=list_ptr(this_box);
incr(cur_s);
left_edge:=cur_h; cur_v:=cur_v-height(this_box); top_edge:=cur_v;
@<Create thread for the current vbox if needed@>;
while p<>null do
@<Output node |p| for |pdf_vlist_out| and move to the next node,
maintaining the condition |cur_h=left_edge|@>;
decr(cur_s);
end;
@ @<Create thread for the current vbox if needed@>=
if (last_thread <> null) and is_running(pdf_thread_dp) and
(pdf_thread_level = cur_s) then
append_thread(this_box, left_edge, top_edge + height(this_box))
@ @<Output node |p| for |pdf_vlist_out|...@>=
begin if is_char_node(p) then confusion("pdfvlistout")
@:this can't happen pdfvlistout}{\quad pdfvlistout@>
else @<Output the non-|char_node| |p| for |pdf_vlist_out|@>;
next_p:p:=link(p);
end
@ @<Output the non-|char_node| |p| for |pdf_vlist_out|@>=
begin case type(p) of
hlist_node,vlist_node:@<(\pdfTeX) Output a box in a vlist@>;
rule_node: begin rule_ht:=height(p); rule_dp:=depth(p); rule_wd:=width(p);
goto fin_rule;
end;
whatsit_node: @<Output the whatsit node |p| in |pdf_vlist_out|@>;
glue_node: @<(\pdfTeX) Move down or output leaders@>;
kern_node:cur_v:=cur_v+width(p);
othercases do_nothing
endcases;@/
goto next_p;
fin_rule: @<(\pdfTeX) Output a rule in a vlist, |goto next_p|@>;
move_past: cur_v:=cur_v+rule_ht;
end
@ @<(\pdfTeX) Output a box in a vlist@>=
if list_ptr(p)=null then cur_v:=cur_v+height(p)+depth(p)
else begin cur_v:=cur_v+height(p); save_v:=cur_v;
if cur_dir=right_to_left then cur_h:=left_edge-shift_amount(p)
else cur_h:=left_edge+shift_amount(p); {shift the box right}
temp_ptr:=p;
if type(p)=vlist_node then pdf_vlist_out@+else pdf_hlist_out;
cur_v:=save_v+depth(p); cur_h:=left_edge;
end
@ @<(\pdfTeX) Output a rule in a vlist...@>=
if is_running(rule_wd) then rule_wd:=width(this_box);
rule_ht:=rule_ht+rule_dp; {this is the rule thickness}
cur_v:=cur_v+rule_ht;
if (rule_ht>0)and(rule_wd>0) then {we don't output empty rules}
begin if cur_dir=right_to_left then cur_h:=cur_h-rule_wd;
pdf_set_rule(cur_h, cur_v, rule_wd, rule_ht);
cur_h:=left_edge;
end;
goto next_p
@ @<(\pdfTeX) Move down or output leaders@>=
begin g:=glue_ptr(p); rule_ht:=width(g)-cur_g;
if g_sign<>normal then
begin if g_sign=stretching then
begin if stretch_order(g)=g_order then
begin cur_glue:=cur_glue+stretch(g);
vet_glue(float(glue_set(this_box))*cur_glue);
@^real multiplication@>
cur_g:=round(glue_temp);
end;
end
else if shrink_order(g)=g_order then
begin cur_glue:=cur_glue-shrink(g);
vet_glue(float(glue_set(this_box))*cur_glue);
cur_g:=round(glue_temp);
end;
end;
rule_ht:=rule_ht+cur_g;
if subtype(p)>=a_leaders then
@<(\pdfTeX) Output leaders in a vlist, |goto fin_rule| if a rule
or to |next_p| if done@>;
goto move_past;
end
@ @<(\pdfTeX) Output leaders in a vlist...@>=
begin leader_box:=leader_ptr(p);
if type(leader_box)=rule_node then
begin rule_wd:=width(leader_box); rule_dp:=0;
goto fin_rule;
end;
leader_ht:=height(leader_box)+depth(leader_box);
if (leader_ht>0)and(rule_ht>0) then
begin rule_ht:=rule_ht+10; {compensate for floating-point rounding}
edge:=cur_v+rule_ht; lx:=0;
@<Let |cur_v| be the position of the first box, and set |leader_ht+lx|
to the spacing between corresponding parts of boxes@>;
while cur_v+leader_ht<=edge do
@<(\pdfTeX) Output a leader box at |cur_v|,
then advance |cur_v| by |leader_ht+lx|@>;
cur_v:=edge-10; goto next_p;
end;
end
@ @<(\pdfTeX) Output a leader box at |cur_v|, ...@>=
begin if cur_dir=right_to_left then
cur_h:=left_edge-shift_amount(leader_box)
else cur_h:=left_edge+shift_amount(leader_box);
cur_v:=cur_v+height(leader_box); save_v:=cur_v;
temp_ptr:=leader_box;
outer_doing_leaders:=doing_leaders; doing_leaders:=true;
if type(leader_box)=vlist_node then pdf_vlist_out@+else pdf_hlist_out;
doing_leaders:=outer_doing_leaders;
cur_h:=left_edge;
cur_v:=save_v-height(leader_box)+leader_ht+lx;
end
@ |fix_pdfoutput| freezes |pdfoutput| when something has been written to
the output.
@p procedure fix_pdfoutput;
begin
if not fixed_pdfoutput_set then begin
fixed_pdfoutput := pdf_output;
fixed_pdfoutput_set := true;
end
else if fixed_pdfoutput <> pdf_output then
pdf_error("setup",
"\pdfoutput can only be changed before anything is written to the output");
if fixed_pdfoutput_set then fix_pdf_draftmode;
end;
@ |fix_pdf_draftmode| freezes |pdfdraftmode| when something has been written to
the output and also switches some things off when draftmode is on.
@p procedure fix_pdf_draftmode;
begin
if not fixed_pdf_draftmode_set then begin
fixed_pdf_draftmode := pdf_draftmode;
fixed_pdf_draftmode_set := true;
end
else if fixed_pdf_draftmode <> pdf_draftmode then
pdf_error("setup",
"\pdfdraftmode can only be changed before anything is written to the output");
if fixed_pdf_draftmode_set and fixed_pdf_draftmode > 0 then begin
fixed_pdf_draftmode_set := true;
pdf_compress_level := 0;
fixed_pdf_objcompresslevel := 0;
end;
end;
@ |substr_of_str| is used in |pdf_ship_out| and |pdf_print_info|.
@p function substr_of_str(s, t: str_number):boolean;
label continue,exit;
var j, k, kk: pool_pointer; {running indices}
begin
k:=str_start[t];
while (k < str_start[t+1] - length(s)) do begin
j:=str_start[s];
kk:=k;
while (j < str_start[s+1]) do begin
if str_pool[j] <> str_pool[kk] then
goto continue;
incr(j);
incr(kk);
end;
substr_of_str:=true;
return;
continue: incr(k);
end;
substr_of_str:=false;
end;
@ |pdf_ship_out| is used instead of |ship_out| to shipout a box to PDF
output. If |shipping_page| is not set then the output will be a Form object,
otherwise it will be a Page object.
@p procedure pdf_ship_out(p: pointer; shipping_page: boolean); {output the box |p|}
label done, done1;
var i,j,k:integer; {general purpose accumulators}
s: pool_pointer; {index into |str_pool|}
mediabox_given: boolean;
save_font_list: pointer; {to save |pdf_font_list| during flushing pending forms}
save_obj_list: pointer; {to save |pdf_obj_list|}
save_ximage_list: pointer; {to save |pdf_ximage_list|}
save_xform_list: pointer; {to save |pdf_xform_list|}
save_image_procset: integer; {to save |pdf_image_procset|}
save_text_procset: integer; {to save |pdf_text_procset|}
pdf_last_resources: integer; {pointer to most recently generated Resources object}
begin if tracing_output>0 then
begin print_nl(""); print_ln;
print("Completed box being shipped out");
@.Completed box...@>
end;
if not init_pdf_output then begin
@<Initialize variables for \.{PDF} output@>;
init_pdf_output := true;
end;
is_shipping_page := shipping_page;
if shipping_page then begin
if term_offset>max_print_line-9 then print_ln
else if (term_offset>0)or(file_offset>0) then print_char(" ");
print_char("["); j:=9;
while (count(j)=0)and(j>0) do decr(j);
for k:=0 to j do
begin print_int(count(k));
if k<j then print_char(".");
end;
update_terminal;
end;
if tracing_output>0 then
begin if shipping_page then print_char("]");
begin_diagnostic; show_box(p); end_diagnostic(true);
end;
@<(\pdfTeX) Ship box |p| out@>;
if eTeX_ex then @<Check for LR anomalies at the end of |ship_out|@>;
if (tracing_output<=0) and shipping_page then print_char("]");
dead_cycles:=0;
update_terminal; {progress report}
@<Flush the box from memory, showing statistics if requested@>;
end;
@ @<(\pdfTeX) Ship box |p| out@>=
@<Update the values of |max_h| and |max_v|; but if the page is too large,
|goto done|@>;
@<Initialize variables as |pdf_ship_out| begins@>;
if type(p)=vlist_node then pdf_vlist_out@+else pdf_hlist_out;
if shipping_page then
incr(total_pages);
cur_s:=-1;
@<Finish shipping@>;
done:
@ @<Initialize variables as |pdf_ship_out| begins@>=
fix_pdfoutput;
temp_ptr:=p;
prepare_mag;
pdf_last_resources := pdf_new_objnum;
pdf_page_group_val := 0;
@<Reset resource lists@>;
if not shipping_page then begin
pdf_xform_width := width(p);
pdf_xform_height := height(p);
pdf_xform_depth := depth(p);
pdf_begin_dict(pdf_cur_form, 0);
pdf_last_stream := pdf_cur_form;
cur_v := height(p);
cur_h := 0;
pdf_origin_h := 0;
pdf_origin_v := pdf_xform_height + pdf_xform_depth;
end
else begin
@<Calculate page dimensions and margins@>;
pdf_last_page := get_obj(obj_type_page, total_pages + 1, 0);
obj_aux(pdf_last_page) := 1; {mark that this page has been created}
pdf_new_dict(obj_type_others, 0, 0);
pdf_last_stream := obj_ptr;
cur_h := cur_h_offset;
cur_v := height(p) + cur_v_offset;
pdf_origin_h := 0;
pdf_origin_v := cur_page_height;
@<Reset PDF mark lists@>;
end;
if not shipping_page then begin
@<Write out Form stream header@>;
end;
@<Start stream of page/form contents@>
@ @<Reset resource lists@>=
pdf_font_list := null;
pdf_obj_list := null;
pdf_xform_list := null;
pdf_ximage_list := null;
pdf_text_procset := false;
pdf_image_procset := 0
@ @<Reset PDF mark lists@>=
pdf_annot_list := null;
pdf_link_list := null;
pdf_dest_list := null;
pdf_bead_list := null;
last_thread := null
@ @<Calculate page dimensions and margins@>=
cur_h_offset := pdf_h_origin + h_offset;
cur_v_offset := pdf_v_origin + v_offset;
if pdf_page_width <> 0 then
cur_page_width := pdf_page_width
else
cur_page_width := width(p) + 2*cur_h_offset;
if pdf_page_height <> 0 then
cur_page_height := pdf_page_height
else
cur_page_height := height(p) + depth(p) + 2*cur_v_offset
@ Here we write out the header for Form.
@<Write out Form stream header@>=
pdf_print_ln("/Type /XObject");
pdf_print_ln("/Subtype /Form");
if obj_xform_attr(pdf_cur_form) <> null then begin
pdf_print_toks_ln(obj_xform_attr(pdf_cur_form));
delete_toks(obj_xform_attr(pdf_cur_form));
end;
pdf_print("/BBox [");
pdf_print("0 0 ");
pdf_print_bp(pdf_xform_width); pdf_out(" ");
pdf_print_bp(pdf_xform_height + pdf_xform_depth); pdf_print_ln("]");
pdf_print_ln("/FormType 1");
pdf_print_ln("/Matrix [1 0 0 1 0 0]");
pdf_indirect_ln("Resources", pdf_last_resources)
@ @<Start stream of page/form contents@>=
pdf_begin_stream;
if shipping_page then begin
@<Adjust transformation matrix for the magnification ratio@>;
end;
pdfshipoutbegin(shipping_page);
if shipping_page then
pdf_out_colorstack_startpage;
@ @<Adjust transformation matrix for the magnification ratio@>=
prepare_mag;
if mag <> 1000 then begin
pdf_print_real(mag, 3);
pdf_print(" 0 0 ");
pdf_print_real(mag, 3);
pdf_print_ln(" 0 0 cm");
end
@ @<Finish shipping@>=
@<Finish stream of page/form contents@>;
if shipping_page then begin
@<Write out page object@>;
end;
@<Write out resource lists@>;
if shipping_page then begin
@<Write out pending PDF marks@>;
end;
@<Write out resources dictionary@>;
@<Flush resource lists@>;
if shipping_page then begin
@<Flush PDF mark lists@>;
end
@ @<Finish stream of page/form contents@>=
pdf_end_text;
pdfshipoutend(shipping_page);
pdf_end_stream
@ We need to write forms last, since the recursive call to |ship_out|
would reset global state such as |pdfpagegroupval|, which is needed
while writing images.
@<Write out resource lists@>=
@<Write out pending raw objects@>;
@<Write out pending images@>;
@<Write out pending forms@>
@ @<Write out resources dictionary@>=
pdf_begin_dict(pdf_last_resources, 1);
@<Print additional resources@>;
@<Generate font resources@>;
@<Generate XObject resources@>;
@<Generate ProcSet if desired@>;
pdf_end_dict
@ @<Print additional resources@>=
if shipping_page then begin
if pdf_page_resources <> null then
pdf_print_toks_ln(pdf_page_resources);
end
else begin
if obj_xform_resources(pdf_cur_form) <> null then begin
pdf_print_toks_ln(obj_xform_resources(pdf_cur_form));
delete_toks(obj_xform_resources(pdf_cur_form));
end;
end
@ In the end of shipping out a page we reset all the lists holding objects
have been created during the page shipping.
@d delete_toks(#) == begin delete_token_ref(#); # := null; end
@<Flush resource lists@>=
flush_list(pdf_font_list);
flush_list(pdf_obj_list);
flush_list(pdf_xform_list);
flush_list(pdf_ximage_list)
@ @<Flush PDF mark lists@>=
flush_list(pdf_annot_list);
flush_list(pdf_link_list);
flush_list(pdf_dest_list);
flush_list(pdf_bead_list)
@ @<Generate font resources@>=
if pdf_font_list <> null then begin
pdf_print("/Font << ");
k := pdf_font_list;
while k <> null do begin
pdf_print("/F");
set_ff(info(k));
pdf_print_int(ff);
pdf_print_resname_prefix;
pdf_out(" ");
pdf_print_int(pdf_font_num[ff]);
pdf_print(" 0 R ");
k := link(k);
end;
pdf_print_ln(">>");
pdf_text_procset := true;
end
@ @<Generate XObject resources@>=
if (pdf_xform_list <> null) or (pdf_ximage_list <> null) then begin
pdf_print("/XObject << ");
k := pdf_xform_list;
while k <> null do begin
pdf_print("/Fm");
pdf_print_int(obj_info(info(k)));
pdf_print_resname_prefix;
pdf_out(" ");
pdf_print_int(info(k));
pdf_print(" 0 R ");
k := link(k);
end;
k := pdf_ximage_list;
while k <> null do begin
pdf_print("/Im");
pdf_print_int(obj_info(info(k)));
pdf_print_resname_prefix;
pdf_out(" ");
pdf_print_int(info(k));
pdf_print(" 0 R ");
update_image_procset(obj_ximage_data(info(k)));
k := link(k);
end;
pdf_print_ln(">>");
end
@ @<Generate ProcSet if desired@>=
if (pdf_omit_procset < 0) or
((pdf_omit_procset = 0) and (pdf_major_version < 2)) then
begin
pdf_print("/ProcSet [ /PDF");
if pdf_text_procset then
pdf_print(" /Text");
if check_image_b(pdf_image_procset) then
pdf_print(" /ImageB");
if check_image_c(pdf_image_procset) then
pdf_print(" /ImageC");
if check_image_i(pdf_image_procset) then
pdf_print(" /ImageI");
pdf_print_ln(" ]")
end
@ @<Write out page object@>=
pdf_begin_dict(pdf_last_page, 1);
pdf_print_ln("/Type /Page");
pdf_indirect_ln("Contents", pdf_last_stream);
pdf_indirect_ln("Resources", pdf_last_resources);
mediabox_given:=false;
if pdf_page_attr <> null then begin
s:=tokens_to_string(pdf_page_attr);
mediabox_given:=substr_of_str("/MediaBox", s);
flush_str(s);
end;
if not mediabox_given then begin
pdf_print("/MediaBox [0 0 ");
pdf_print_mag_bp(cur_page_width); pdf_out(" ");
pdf_print_mag_bp(cur_page_height);
pdf_print_ln("]");
end;
if pdf_page_attr <> null then
pdf_print_toks_ln(pdf_page_attr);
@<Generate parent pages object@>;
if pdf_page_group_val > 0 then begin
pdf_print("/Group ");
pdf_print_int(pdf_page_group_val);
pdf_print_ln(" 0 R");
end;
@<Generate array of annotations or beads in page@>;
pdf_end_dict
@ @<Generate parent pages object@>=
if total_pages mod pages_tree_kids_max = 1 then begin
pdf_create_obj(obj_type_pages, pages_tree_kids_max);
pdf_last_pages := obj_ptr;
end;
pdf_indirect_ln("Parent", pdf_last_pages)
@ @<Generate array of annotations or beads in page@>=
if (pdf_annot_list <> null) or (pdf_link_list <> null) then begin
pdf_print("/Annots [ ");
k := pdf_annot_list;
while k <> null do begin
pdf_print_int(info(k));
pdf_print(" 0 R ");
k := link(k);
end;
k := pdf_link_list;
while k <> null do begin
pdf_print_int(info(k));
pdf_print(" 0 R ");
k := link(k);
end;
pdf_print_ln("]");
end;
if pdf_bead_list <> null then begin
k := pdf_bead_list;
pdf_print("/B [ ");
while k <> null do begin
pdf_print_int(info(k));
pdf_print(" 0 R ");
k := link(k);
end;
pdf_print_ln("]");
end
@ @<Declare procedures needed in |pdf_hlist_out|, |pdf_vlist_out|@>=
procedure pdf_write_obj(n: integer); {write a raw PDF object}
var s: str_number;
f: byte_file;
begin
s := tokens_to_string(obj_obj_data(n));
delete_toks(obj_obj_data(n));
if obj_obj_is_stream(n) > 0 then begin
pdf_begin_dict(n, 0);
if obj_obj_stream_attr(n) <> null then begin
pdf_print_toks_ln(obj_obj_stream_attr(n));
delete_toks(obj_obj_stream_attr(n));
end;
pdf_begin_stream;
end
else
pdf_begin_obj(n, 1);
if obj_obj_is_file(n) > 0 then begin
cur_name := s;
cur_area := "";
cur_ext := "";
pack_cur_name;
if not tex_b_openin(f) then begin
print_nl("! "); print(s); print(" not found.");
pdf_error("ext5", "cannot open file for embedding");
end;
print("<<");
print(s);
if not eof(f) then begin {at least one byte available}
while not eof(f) do
pdf_out(getc(f));
if (not obj_obj_is_stream(n)) and (pdf_ptr > 0) and (pdf_buf[pdf_ptr - 1] <> 10) then
pdf_out(10);
end;
print(">>");
b_close(f);
end
else if obj_obj_is_stream(n) > 0 then
pdf_print(s)
else
pdf_print_ln(s);
if obj_obj_is_stream(n) > 0 then
pdf_end_stream
else
pdf_end_obj;
flush_str(s);
end;
procedure flush_whatsit_node(p: pointer; s: small_number);
begin
type(p) := whatsit_node;
subtype(p) := s;
if link(p) <> null then
pdf_error("flush_whatsit_node", "link(p) is not null");
flush_node_list(p);
end;
@ @<Write out pending raw objects@>=
if pdf_obj_list <> null then begin
k := pdf_obj_list;
while k <> null do begin
if not is_obj_written(info(k)) then
pdf_write_obj(info(k));
k := link(k);
end;
end
@ @<Glob...@>=
@!saved_pdf_cur_form: integer;
@ When flushing pending forms we need to save and restore resource lists
(|pdf_font_list|, |pdf_obj_list|, |pdf_xform_list| and |pdf_ximage_list|),
which are also used by page shipping.
@<Write out pending forms@>=
if pdf_xform_list <> null then begin
k := pdf_xform_list;
while k <> null do begin
if not is_obj_written(info(k)) then begin
saved_pdf_cur_form := pdf_cur_form;
pdf_cur_form := info(k);
@<Save resource lists@>;
@<Reset resource lists@>;
pdf_ship_out(obj_xform_box(pdf_cur_form), false);
pdf_cur_form := saved_pdf_cur_form;
@<Restore resource lists@>;
end;
k := link(k);
end;
end
@ @<Save resource lists@>=
save_font_list := pdf_font_list;
save_obj_list := pdf_obj_list;
save_xform_list := pdf_xform_list;
save_ximage_list := pdf_ximage_list;
save_text_procset := pdf_text_procset;
save_image_procset := pdf_image_procset
@ @<Restore resource lists@>=
pdf_font_list := save_font_list;
pdf_obj_list := save_obj_list;
pdf_xform_list := save_xform_list;
pdf_ximage_list := save_ximage_list;
pdf_text_procset := save_text_procset;
pdf_image_procset := save_image_procset
@ @<Declare procedures needed in |pdf_hlist_out|, |pdf_vlist_out|@>=
procedure pdf_write_image(n: integer); {write an image}
begin
pdf_begin_dict(n, 0);
if obj_ximage_attr(n) <> null then begin
pdf_print_toks_ln(obj_ximage_attr(n));
delete_toks(obj_ximage_attr(n));
end;
if fixed_pdf_draftmode = 0 then write_image(obj_ximage_data(n));
delete_image(obj_ximage_data(n));
end;
@ @<Write out pending images@>=
if pdf_ximage_list <> null then begin
k := pdf_ximage_list;
while k <> null do begin
if not is_obj_written(info(k)) then
pdf_write_image(info(k));
k := link(k);
end;
end
@ @<Write out pending PDF marks@>=
pdf_origin_h := 0;
pdf_origin_v := cur_page_height;
@<Write out PDF annotations@>;
@<Write out PDF link annotations@>;
@<Write out PDF mark destinations@>;
@<Write out PDF bead rectangle specifications@>
@ @<Write out PDF annotations@>=
if pdf_annot_list <> null then begin
k := pdf_annot_list;
while k <> null do begin
i := obj_annot_ptr(info(k)); {|i| points to |pdf_annot_node|}
pdf_begin_dict(info(k), 1);
pdf_print_ln("/Type /Annot");
pdf_print_toks_ln(pdf_annot_data(i));
pdf_rectangle(pdf_left(i), pdf_top(i), pdf_right(i), pdf_bottom(i));
pdf_end_dict;
k := link(k);
end;
end
@ @<Write out PDF link annotations@>=
if pdf_link_list <> null then begin
k := pdf_link_list;
while k <> null do begin
i := obj_annot_ptr(info(k));
pdf_begin_dict(info(k), 1);
pdf_print_ln("/Type /Annot");
if pdf_action_type(pdf_link_action(i)) <> pdf_action_user then
pdf_print_ln("/Subtype /Link");
if pdf_link_attr(i) <> null then
pdf_print_toks_ln(pdf_link_attr(i));
pdf_rectangle(pdf_left(i), pdf_top(i), pdf_right(i), pdf_bottom(i));
if pdf_action_type(pdf_link_action(i)) <> pdf_action_user then
pdf_print("/A ");
write_action(pdf_link_action(i));
pdf_end_dict;
k := link(k);
end;
@<Flush |pdf_start_link_node|'s created by |append_link|@>;
end
@ @<Flush |pdf_start_link_node|'s created by |append_link|@>=
k := pdf_link_list;
while k <> null do begin
i := obj_annot_ptr(info(k));
{nodes with |info = max_halfword| were created by |append_link| and
must be flushed here, as they are not linked in any list}
if info(i) = max_halfword then
flush_whatsit_node(i, pdf_start_link_node);
k := link(k);
end
@ @<Write out PDF mark destinations@>=
if pdf_dest_list <> null then begin
k := pdf_dest_list;
while k <> null do begin
if is_obj_written(info(k)) then
pdf_error("ext5",
"destination has been already written (this shouldn't happen)")
else begin
i := obj_dest_ptr(info(k));
if (pdf_dest_named_id(i) > 0) and (pdf_dest_objnum(i) = null) then begin
pdf_begin_dict(info(k), 1);
pdf_print("/D ");
end
else
pdf_begin_obj(info(k), 1);
pdf_out("[");
if pdf_dest_objnum(i) = null then
pdf_print_int(pdf_last_page)
else
pdf_print_int(pdf_dest_objnum(i));
pdf_print(" 0 R ");
case pdf_dest_type(i) of
pdf_dest_xyz: begin
pdf_print("/XYZ ");
pdf_print_mag_bp(pdf_x(pdf_left(i))); pdf_out(" ");
pdf_print_mag_bp(pdf_y(pdf_top(i))); pdf_out(" ");
if pdf_dest_xyz_zoom(i) = null then
pdf_print("null")
else begin
pdf_print_int(pdf_dest_xyz_zoom(i) div 1000);
pdf_out(".");
pdf_print_int((pdf_dest_xyz_zoom(i) mod 1000));
end;
end;
pdf_dest_fit:
pdf_print("/Fit");
pdf_dest_fith: begin
pdf_print("/FitH ");
pdf_print_mag_bp(pdf_y(pdf_top(i)));
end;
pdf_dest_fitv: begin
pdf_print("/FitV ");
pdf_print_mag_bp(pdf_x(pdf_left(i)));
end;
pdf_dest_fitb:
pdf_print("/FitB");
pdf_dest_fitbh: begin
pdf_print("/FitBH ");
pdf_print_mag_bp(pdf_y(pdf_top(i)));
end;
pdf_dest_fitbv: begin
pdf_print("/FitBV ");
pdf_print_mag_bp(pdf_x(pdf_left(i)));
end;
pdf_dest_fitr: begin
pdf_print("/FitR ");
pdf_print_rect_spec(i);
end;
othercases pdf_error("ext5", "unknown dest type");
endcases;
pdf_print_ln("]");
if (pdf_dest_named_id(i) > 0) and (pdf_dest_objnum(i) = null) then
pdf_end_dict
else
pdf_end_obj;
end;
k := link(k);
end;
end
@ @<Declare procedures needed in |pdf_hlist_out|, |pdf_vlist_out|@>=
procedure pdf_print_rect_spec(r: pointer); {prints a rect spec}
begin
pdf_print_mag_bp(pdf_x(pdf_left(r)));
pdf_out(" ");
pdf_print_mag_bp(pdf_y(pdf_bottom(r)));
pdf_out(" ");
pdf_print_mag_bp(pdf_x(pdf_right(r)));
pdf_out(" ");
pdf_print_mag_bp(pdf_y(pdf_top(r)));
end;
@ @<Write out PDF bead rectangle specifications@>=
if pdf_bead_list <> null then begin
k := pdf_bead_list;
while k <> null do begin
pdf_new_obj(obj_type_others, 0, 1);
pdf_out("[");
i := obj_bead_data(info(k)); {pointer to a whatsit or whatsit-like node}
pdf_print_rect_spec(i);
if info(i) = max_halfword then {not a whatsit node, so must be destroyed here}
flush_whatsit_node(i, pdf_start_thread_node);
pdf_print_ln("]");
obj_bead_rect(info(k)) := obj_ptr; {rewrite |obj_bead_data|}
pdf_end_obj;
k := link(k);
end;
end
@ In the end we must flush PDF objects that cannot be written out
immediately after shipping out pages.
@ @<Output outlines@>=
if pdf_first_outline <> 0 then begin
pdf_new_dict(obj_type_others, 0, 1);
outlines := obj_ptr;
l := pdf_first_outline; k := 0;
repeat
incr(k);
a := open_subentries(l);
if obj_outline_count(l) > 0 then
k := k + a;
obj_outline_parent(l) := obj_ptr;
l := obj_outline_next(l);
until l = 0;
pdf_print_ln("/Type /Outlines");
pdf_indirect_ln("First", pdf_first_outline);
pdf_indirect_ln("Last", pdf_last_outline);
pdf_int_entry_ln("Count", k);
pdf_end_dict;
@<Output PDF outline entries@>;
end
else
outlines := 0
@ @<Output PDF outline entries@>=
k := head_tab[obj_type_outline];
while k <> 0 do begin
if obj_outline_parent(k) = pdf_parent_outline then begin
if obj_outline_prev(k) = 0 then
pdf_first_outline := k;
if obj_outline_next(k) = 0 then
pdf_last_outline := k;
end;
pdf_begin_dict(k, 1);
pdf_indirect_ln("Title", obj_outline_title(k));
pdf_indirect_ln("A", obj_outline_action_objnum(k));
if obj_outline_parent(k) <> 0 then
pdf_indirect_ln("Parent", obj_outline_parent(k));
if obj_outline_prev(k) <> 0 then
pdf_indirect_ln("Prev", obj_outline_prev(k));
if obj_outline_next(k) <> 0 then
pdf_indirect_ln("Next", obj_outline_next(k));
if obj_outline_first(k) <> 0 then
pdf_indirect_ln("First", obj_outline_first(k));
if obj_outline_last(k) <> 0 then
pdf_indirect_ln("Last", obj_outline_last(k));
if obj_outline_count(k) <> 0 then
pdf_int_entry_ln("Count", obj_outline_count(k));
if obj_outline_attr(k) <> 0 then begin
pdf_print_toks_ln(obj_outline_attr(k));
delete_toks(obj_outline_attr(k));
end;
pdf_end_dict;
k := obj_link(k);
end
@ @<Output article threads@>=
if head_tab[obj_type_thread] <> 0 then begin
pdf_new_obj(obj_type_others, 0, 1);
threads := obj_ptr;
pdf_out("[");
k := head_tab[obj_type_thread];
while k <> 0 do begin
pdf_print_int(k);
pdf_print(" 0 R ");
k := obj_link(k);
end;
remove_last_space;
pdf_print_ln("]");
pdf_end_obj;
k := head_tab[obj_type_thread];
while k <> 0 do begin
out_thread(k);
k := obj_link(k);
end;
end
else
threads := 0
@ Now we are ready to declare our new procedure |ship_out|. It will call
|pdf_ship_out| if the integer parameter |pdf_output| is positive; otherwise it
will call |dvi_ship_out|, which is the \TeX\ original |ship_out|.
@p procedure ship_out(p:pointer); {output the box |p|}
begin
fix_pdfoutput;
if pdf_output > 0 then
pdf_ship_out(p, true)
else
dvi_ship_out(p);
end;
@ @<Initialize variables for \.{PDF} output@>=
check_pdfversion;
prepare_mag;
fixed_decimal_digits := fix_int(pdf_decimal_digits, 0, 4);
min_bp_val :=
divide_scaled(one_hundred_bp, ten_pow[fixed_decimal_digits + 2], 0);
if pdf_pk_resolution = 0 then {if not set from format file or by user}
pdf_pk_resolution := pk_dpi; {take it from \.{texmf.cnf}}
fixed_pk_resolution := fix_int(pdf_pk_resolution, 72, 8000);
pk_scale_factor :=
divide_scaled(72, fixed_pk_resolution, 5 + fixed_decimal_digits);
if pdf_pk_mode <> null then begin
kpse_init_prog('PDFTEX', fixed_pk_resolution,
make_cstring(tokens_to_string(pdf_pk_mode)), nil);
flush_string;
end else
kpse_init_prog('PDFTEX', fixed_pk_resolution, nil, nil);
kpse_set_program_enabled (kpse_pk_format, 1, kpse_src_compile);
set_job_id(year, month, day, time);
if (pdf_unique_resname > 0) and (pdf_resname_prefix = 0) then
pdf_resname_prefix := get_resname_prefix
@ Finishing the PDF output file.
The following procedures sort the table of destination names.
@d get_next_char(#)==
c@&# := str_pool[j@&#];
incr(j@&#);
if (c@&# = 92) and (j@&# < e@&#) then begin
c@&# := str_pool[j@&#];
incr(j@&#);
if (c@&# >= 48) and (c@&# <= 55) then begin
c@&# := c@&# - 48;
if (j@&# < e@&#) and (str_pool[j@&#] >= 48)
and (str_pool[j@&#] <= 55) then begin
c@&# := 8 * c@&# + str_pool[j@&#] - 48;
incr(j@&#);
if (j@&# < e@&#) and (str_pool[j@&#] >= 48)
and (str_pool[j@&#] <= 55)
and (c@&# < 32) then begin
c@&# := 8 * c@&# + str_pool[j@&#] - 48;
incr(j@&#);
end;
end;
end else begin
case c@&# of
98: c@&# := 8; {`\.b': backspace}
102: c@&# := 12; {`\.f': form feed}
110: c@&# := 10; {`\.n': line feed}
114: c@&# := 13; {`\.r': carriage return}
116: c@&# := 9; {`\.t': horizontal tab}
{nothing to do for `\.{\\}', `\.(', `\.)'}
othercases do_nothing
endcases;
end;
end
@p function str_less_str(s1, s2: str_number): boolean; {compare two pdf strings}
var j1, j2, e1, e2: pool_pointer;
c1, c2: packed_ASCII_code;
begin
{Minimal requirement: output of \.{\\pdfescapestring} must be supported.}
{This implementation also supports all escape sequences}
{listed in the table `Escape sequences in literal strings'}
{of the pdf specification.}
{End-of-line markers are not detected:}
{The marker is not replaced by `\.{\\n}' or removed if it is escaped.}
j1 := str_start[s1];
j2 := str_start[s2];
e1 := j1 + length(s1);
e2 := j2 + length(s2);
while (j1 < e1) and (j2 < e2) do begin
{get next character of first string}
get_next_char(1);
{get next character of second string}
get_next_char(2);
{compare characters}
if c1 < c2 then begin
str_less_str := true;
return;
end
else if c1 > c2 then begin
str_less_str := false;
return;
end;
end;
{compare string lengths}
if (j1 >= e1) and (j2 < e2) then
str_less_str := true
else
str_less_str := false;
exit: end;
procedure sort_dest_names(l, r: integer); {sorts |dest_names| by names}
var i, j: integer;
s: str_number;
e: dest_name_entry;
begin
i := l;
j := r;
s := dest_names[(l + r) div 2].objname;
repeat
while str_less_str(dest_names[i].objname, s) do
incr(i);
while str_less_str(s, dest_names[j].objname) do
decr(j);
if i <= j then begin
e := dest_names[i];
dest_names[i] := dest_names[j];
dest_names[j] := e;
incr(i);
decr(j);
end;
until i > j;
if l < j then
sort_dest_names(l, j);
if i < r then
sort_dest_names(i, r);
end;
@ Now the finish of PDF output file. At this moment all Page objects
are already written completely to PDF output file.
@<Finish the PDF file@>=
if total_pages=0 then begin
print_nl("No pages of output.");
@.No pages of output@>
if pdf_gone > 0 then
garbage_warning;
end
else begin
if fixed_pdf_draftmode = 0 then begin
pdf_flush; {to make sure that the output file name has been already
created}
if total_pages mod pages_tree_kids_max <> 0 then
obj_info(pdf_last_pages) := total_pages mod pages_tree_kids_max;
{last pages object may have less than |pages_tree_kids_max| children}
flush_jbig2_page0_objects; {flush page 0 objects from JBIG2 images, if any}
@<Check for non-existing pages@>;
@<Reverse the linked list of Page and Pages objects@>;
@<Check for non-existing destinations@>;
@<Check for non-existing structure destinations@>;
@<Output fonts definition@>;
@<Output pages tree@>;
@<Output outlines@>;
@<Output name tree@>;
@<Output article threads@>;
@<Output the catalog object@>;
if pdf_omit_info_dict = 0 then pdf_print_info; {last candidate for object stream}
if pdf_os_enable then begin
pdf_os_switch(true);
pdf_os_write_objstream;
pdf_flush;
pdf_os_switch(false);
@<Output the cross-reference stream dictionary@>;
pdf_flush;
end else begin
@<Output the |obj_tab|@>;
end;
@<Output the trailer@>;
pdf_flush;
print_nl("Output written on "); print_file_name(0, output_file_name, 0);
@.Output written on x@>
print(" ("); print_int(total_pages); print(" page");
if total_pages<>1 then print_char("s");
print(", "); print_int(pdf_offset); print(" bytes).");
end;
libpdffinish;
if fixed_pdf_draftmode = 0 then b_close(pdf_file)
else pdf_warning(0, "\pdfdraftmode enabled, not changing output pdf", true, true)
end
@ Destinations that have been referenced but don't exists have
|obj_dest_ptr=null|. Leaving them undefined might cause troubles for
PDF browsers, so we need to fix them.
@p procedure pdf_fix_dest(k: integer);
begin
if obj_dest_ptr(k) <> null then
return;
pdf_warning("dest", "", true, false);
if obj_info(k) < 0 then begin
print("name{");
print(-obj_info(k));
print("}");
end
else begin
print("num");
print_int(obj_info(k));
end;
print(" has been referenced but does not exist, replaced by a fixed one");
print_ln; print_ln;
pdf_begin_obj(k, 1);
pdf_out("[");
pdf_print_int(head_tab[obj_type_page]);
pdf_print_ln(" 0 R /Fit]");
pdf_end_obj;
end;
@ @<Check for non-existing destinations@>=
k := head_tab[obj_type_dest];
while k <> 0 do begin
pdf_fix_dest(k);
k := obj_link(k);
end
@ The same for structure destinations, except that there is no sensible default
object to point to.
@p procedure pdf_fix_struct_dest(k: integer);
begin
if obj_dest_ptr(k) <> null then
return;
pdf_warning("structure dest", "", false, false);
if obj_info(k) < 0 then begin
print("name{");
print(-obj_info(k));
print("}");
end
else begin
print("num");
print_int(obj_info(k));
end;
print(" has been referenced but does not exist");
print_ln; print_ln;
@{pdf_begin_obj(k, 1);
pdf_out("[");
pdf_print_int(head_tab[obj_type_page]);
pdf_print_ln(" 0 R /Fit]");
pdf_end_obj;@}
end;
@ @<Check for non-existing structure destinations@>=
k := head_tab[obj_type_struct_dest];
while k <> 0 do begin
pdf_fix_struct_dest(k);
k := obj_link(k);
end
@ @<Check for non-existing pages@>=
k := head_tab[obj_type_page];
while obj_aux(k) = 0 do begin
pdf_warning("dest", "Page ", true, false);
print_int(obj_info(k));
print(" has been referenced but does not exist!");
print_ln; print_ln;
k := obj_link(k);
end;
head_tab[obj_type_page] := k
@ @<Reverse the linked list of Page and Pages objects@>=
k := head_tab[obj_type_page];
l := 0;
repeat
i := obj_link(k);
obj_link(k) := l;
l := k;
k := i;
until k = 0;
head_tab[obj_type_page] := l;
k := head_tab[obj_type_pages];
pages_tail := k;
l := 0;
repeat
i := obj_link(k);
obj_link(k) := l;
l := k;
k := i;
until k = 0;
head_tab[obj_type_pages] := l
@ @<Output fonts definition@>=
for k := font_base + 1 to font_ptr do
if font_used[k] and hasfmentry(k) and (pdf_font_num[k] < 0) then begin
i := -pdf_font_num[k];
pdfassert(pdf_font_num[i] > 0);
for j := 0 to 255 do
if pdf_char_marked(k, j) then
pdf_mark_char(i, j);
if (length(pdf_font_attr[i]) = 0) and (length(pdf_font_attr[k]) <> 0) then
pdf_font_attr[i] := pdf_font_attr[k]
else if (length(pdf_font_attr[k]) = 0) and (length(pdf_font_attr[i]) <> 0) then
pdf_font_attr[k] := pdf_font_attr[i]
else if (length(pdf_font_attr[i]) <> 0) and (length(pdf_font_attr[k]) <> 0) and
not str_eq_str(pdf_font_attr[i], pdf_font_attr[k]) then begin
pdf_warning("\pdffontattr", "fonts ", true, false);
print_font_identifier(i);
print(" and ");
print_font_identifier(k);
print(" have conflicting attributes; I will ignore the attributes assigned to ");
print_font_identifier(i);
print_ln; print_ln;
end;
end;
fixed_gen_tounicode := pdf_gen_tounicode;
k := head_tab[obj_type_font];
while k <> 0 do begin
f := obj_info(k);
pdfassert(pdf_font_num[f] > 0);
do_pdf_font(k, f);
k := obj_link(k);
end;
write_fontstuff
@ We will generate in each single step the parents of all Pages/Page objects in
the previous level. These new generated Pages object will create a new level of
the Pages tree. We will repeat this until we have only one Pages object. This
one will be the Root object.
@<Output pages tree@>=
a := sys_obj_ptr + 1; {all Pages objects whose children are not Page objects
should have index greater than |a|}
l := head_tab[obj_type_pages]; {|l| is the index of current Pages object
which is being output}
k := head_tab[obj_type_page]; {|k| is the index of current child of |l|}
b := 0;
repeat
i := 0; {counter of Pages object in current level}
c := 0; {first Pages object in previous level}
if obj_link(l) = 0 then
is_root := true {only Pages object; total pages is
not greater than |pages_tree_kids_max|}
else
is_root := false;
repeat
if not is_root then begin
if i mod pages_tree_kids_max = 0 then begin {create a new Pages object
for next level}
pdf_last_pages := pdf_new_objnum;
if c = 0 then
c := pdf_last_pages;
obj_link(pages_tail) := pdf_last_pages;
pages_tail := pdf_last_pages;
obj_link(pdf_last_pages) := 0;
obj_info(pdf_last_pages) := obj_info(l);
end
else
obj_info(pdf_last_pages) := obj_info(pdf_last_pages) +
obj_info(l);
end;
@<Output the current Pages object in this level@>;
incr(i);
l := obj_link(l);
until (l = c);
b := c;
if l = 0 then
goto done;
until false;
done:
@ @<Output the current Pages object in this level@>=
pdf_begin_dict(l, 1);
pdf_print_ln("/Type /Pages");
pdf_int_entry_ln("Count", obj_info(l));
if not is_root then
pdf_indirect_ln("Parent", pdf_last_pages);
pdf_print("/Kids [");
j := 0;
repeat
pdf_print_int(k);
pdf_print(" 0 R ");
k := obj_link(k);
incr(j);
until ((l < a) and (j = obj_info(l))) or
(k = 0) or ((k = b) and (b <> 0)) or
(j = pages_tree_kids_max);
remove_last_space;
pdf_print_ln("]");
if k = 0 then begin
k := head_tab[obj_type_pages];
head_tab[obj_type_pages] := 0;
end;
if is_root and (pdf_pages_attr <> null) then
pdf_print_toks_ln(pdf_pages_attr);
pdf_end_dict;
@ The name tree is very similar to Pages tree so its construction should be
certain from Pages tree construction. For intermediate node |obj_info| will be
the first name and |obj_link| will be the last name in \.{\\Limits} array.
Note that |pdf_dest_names_ptr| will be less than |obj_ptr|, so we test if
|k < pdf_dest_names_ptr| then |k| is index of leaf in |dest_names|; else
|k| will be index in |obj_tab| of some intermediate node.
@<Output name tree@>=
if pdf_dest_names_ptr = 0 then begin
dests := 0;
goto done1;
end;
sort_dest_names(0, pdf_dest_names_ptr - 1);
names_head := 0;
names_tail := 0;
k := 0; {index of current child of |l|; if |k < pdf_dest_names_ptr|
then this is pointer to |dest_names| array;
otherwise it is the pointer to |obj_tab| (object number)}
is_names := true; {flag whether Names or Kids}
b := 0;
repeat
repeat
pdf_create_obj(obj_type_others, 0); {create a new node}
l := obj_ptr;
if b = 0 then
b := l; {first in this level}
if names_head = 0 then begin
names_head := l;
names_tail := l;
end else begin
obj_link(names_tail) := l;
names_tail := l;
end;
obj_link(names_tail) := 0;
@<Output the current node in this level@>;
until b = 0;
if k = l then begin
dests := l;
goto done1;
end;
until false;
done1:
if (dests <> 0) or (pdf_names_toks <> null) then begin
pdf_new_dict(obj_type_others, 0, 1);
if (dests <> 0) then
pdf_indirect_ln("Dests", dests);
if pdf_names_toks <> null then begin
pdf_print_toks_ln(pdf_names_toks);
delete_toks(pdf_names_toks);
end;
pdf_end_dict;
names_tree := obj_ptr;
end
else
names_tree := 0
@ @<Output the current node in this level@>=
pdf_begin_dict(l, 1);
j := 0;
if is_names then begin
obj_info(l) := dest_names[k].objname;
pdf_print("/Names [");
repeat
pdf_print_str(dest_names[k].objname);
pdf_out(" ");
pdf_print_int(dest_names[k].objnum);
pdf_print(" 0 R ");
incr(j);
incr(k);
until (j = name_tree_kids_max) or (k = pdf_dest_names_ptr);
remove_last_space;
pdf_print_ln("]");
obj_aux(l) := dest_names[k - 1].objname;
if k = pdf_dest_names_ptr then begin
is_names := false;
k := names_head;
b := 0;
end;
end
else begin
obj_info(l) := obj_info(k);
pdf_print("/Kids [");
repeat
pdf_print_int(k);
pdf_print(" 0 R ");
incr(j);
obj_aux(l) := obj_aux(k);
k := obj_link(k);
until (j = name_tree_kids_max) or (k = b) or (obj_link(k) = 0);
remove_last_space;
pdf_print_ln("]");
if k = b then
b := 0;
end;
pdf_print("/Limits [");
pdf_print_str(obj_info(l));
pdf_out(" ");
pdf_print_str(obj_aux(l));
pdf_print_ln("]");
pdf_end_dict;
@ @<Output the catalog object@>=
pdf_new_dict(obj_type_others, 0, 1);
root := obj_ptr;
pdf_print_ln("/Type /Catalog");
pdf_indirect_ln("Pages", pdf_last_pages);
if threads <> 0 then
pdf_indirect_ln("Threads", threads);
if outlines <> 0 then
pdf_indirect_ln("Outlines", outlines);
if names_tree <> 0 then
pdf_indirect_ln("Names", names_tree);
if pdf_catalog_toks <> null then begin
pdf_print_toks_ln(pdf_catalog_toks);
delete_toks(pdf_catalog_toks);
end;
if pdf_catalog_openaction <> 0 then
pdf_indirect_ln("OpenAction", pdf_catalog_openaction);
pdf_end_dict
@ If the same keys in a dictionary are given several times, then it is not
defined which value is chosen by an application. Therefore the keys
|/Producer| and |/Creator| are only set if the token list
|pdf_info_toks| converted to a string does not contain these key strings.
@p procedure pdf_print_info; {print info object}
var s: str_number;
creator_given, producer_given, creationdate_given, moddate_given, trapped_given: boolean;
begin
pdf_new_dict(obj_type_others, 0, 3); {keep Info readable unless explicitly forced}
creator_given:=false;
producer_given:=false;
creationdate_given:=false;
moddate_given:=false;
trapped_given:=false;
if pdf_info_toks <> null then begin
s:=tokens_to_string(pdf_info_toks);
creator_given:=substr_of_str("/Creator", s);
producer_given:=substr_of_str("/Producer", s);
creationdate_given:=substr_of_str("/CreationDate", s);
moddate_given:=substr_of_str("/ModDate", s);
trapped_given:=substr_of_str("/Trapped", s);
end;
if not producer_given then begin
@<Print the Producer key@>;
end;
if pdf_info_toks <> null then begin
if length(s) > 0 then begin
pdf_print_ln(s);
end;
flush_str(s);
delete_toks(pdf_info_toks);
end;
if not creator_given then
pdf_str_entry_ln("Creator", "TeX");
if pdf_info_omit_date = 0 then begin
if not creationdate_given then begin
@<Print the CreationDate key@>;
end;
if not moddate_given then begin
@<Print the ModDate key@>;
end;
end;
if not trapped_given then begin
pdf_print_ln("/Trapped /False");
end;
if pdf_suppress_ptex_info mod 2 = 0 then begin
pdf_str_entry_ln("PTEX.Fullbanner", pdftex_banner);
end;
pdf_end_dict;
end;
@ @<Print the Producer key@>=
pdf_print("/Producer (pdfTeX-");
pdf_print_int(pdftex_version div 100);
pdf_out(".");
pdf_print_int(pdftex_version mod 100);
pdf_out(".");
pdf_print(pdftex_revision);
pdf_print_ln(")")
@ @<Print the CreationDate key@>=
print_creation_date;
@ @<Print the ModDate key@>=
print_mod_date;
@ @<Glob...@>=
@!pdftex_banner: str_number; {the complete banner}
@ @<Build a linked list of free objects@>=
l := 0;
set_obj_fresh(l); {null object at begin of list of free objects}
for k := 1 to sys_obj_ptr do
if not is_obj_written(k) then begin
obj_link(l) := k;
l := k;
end;
obj_link(l) := 0
@ @<Output the |obj_tab|@>=
@<Build a linked list of free objects@>;
pdf_save_offset := pdf_offset;
pdf_print_ln("xref");
pdf_print("0 "); pdf_print_int_ln(obj_ptr + 1);
pdf_print_fw_int(obj_link(0), 10);
pdf_print_ln(" 65535 f ");
for k := 1 to obj_ptr do begin
if not is_obj_written(k) then begin
pdf_print_fw_int(obj_link(k), 10);
pdf_print_ln(" 00000 f ");
end
else begin
pdf_print_fw_int(obj_offset(k), 10);
pdf_print_ln(" 00000 n ");
end;
end
@ @<Output the cross-reference stream dictionary@>=
pdf_new_dict(obj_type_others, 0, 0);
if ((obj_offset(sys_obj_ptr)/256) > 16777215) then
xref_offset_width := 5
else if obj_offset(sys_obj_ptr) > 16777215 then
xref_offset_width := 4
else if obj_offset(sys_obj_ptr) > 65535 then
xref_offset_width := 3
else
xref_offset_width := 2;
@<Build a linked list of free objects@>;
pdf_print_ln("/Type /XRef");
pdf_print("/Index [0 ");
pdf_print_int(obj_ptr + 1);
pdf_print_ln("]");
pdf_int_entry_ln("Size", obj_ptr + 1);
pdf_print("/W [1 ");
pdf_print_int(xref_offset_width);
pdf_print_ln(" 1]");
pdf_indirect_ln("Root", root);
if pdf_omit_info_dict = 0 then pdf_indirect_ln("Info", obj_ptr - 1);
if pdf_trailer_toks <> null then begin
pdf_print_toks_ln(pdf_trailer_toks);
delete_toks(pdf_trailer_toks);
end;
if pdf_trailer_id_toks <> null then
print_ID_alt(pdf_trailer_id_toks)
else
print_ID(output_file_name);
pdf_print_nl;
pdf_begin_stream;
for k := 0 to sys_obj_ptr do begin
if not is_obj_written(k) then begin {a free object}
pdf_out(0);
pdf_out_bytes(obj_link(k), xref_offset_width);
pdf_out(255);
end else begin
if obj_os_idx(k) = -1 then begin {object not in object stream}
pdf_out(1);
pdf_out_bytes(obj_offset(k), xref_offset_width);
pdf_out(0);
end else begin {object in object stream}
pdf_out(2);
pdf_out_bytes(obj_offset(k), xref_offset_width);
pdf_out(obj_os_idx(k));
end;
end;
end;
pdf_end_stream;
@ @<Output the trailer@>=
if not pdf_os_enable then begin
pdf_print_ln("trailer");
pdf_print("<< ");
pdf_int_entry_ln("Size", sys_obj_ptr + 1);
pdf_indirect_ln("Root", root);
if pdf_omit_info_dict = 0 then pdf_indirect_ln("Info", sys_obj_ptr);
if pdf_trailer_toks <> null then begin
pdf_print_toks_ln(pdf_trailer_toks);
delete_toks(pdf_trailer_toks);
end;
if pdf_trailer_id_toks <> null then
print_ID_alt(pdf_trailer_id_toks)
else
print_ID(output_file_name);
pdf_print_ln(" >>");
end;
pdf_print_ln("startxref");
if pdf_os_enable then
pdf_print_int_ln(obj_offset(sys_obj_ptr))
else
pdf_print_int_ln(pdf_save_offset);
pdf_print_ln("%%EOF")
@* \[33] Packaging.
We're essentially done with the parts of \TeX\ that are concerned with
the input (|get_next|) and the output (|ship_out|). So it's time to
get heavily into the remaining part, which does the real work of typesetting.
After lists are constructed, \TeX\ wraps them up and puts them into boxes.
Two major subroutines are given the responsibility for this task: |hpack|
applies to horizontal lists (hlists) and |vpack| applies to vertical lists
(vlists). The main duty of |hpack| and |vpack| is to compute the dimensions
of the resulting boxes, and to adjust the glue if one of those dimensions
is pre-specified. The computed sizes normally enclose all of the material
inside the new box; but some items may stick out if negative glue is used,
if the box is overfull, or if a \.{\\vbox} includes other boxes that have
been shifted left.
The subroutine call |hpack(p,w,m)| returns a pointer to an |hlist_node|
for a box containing the hlist that starts at |p|. Parameter |w| specifies
a width; and parameter |m| is either `|exactly|' or `|additional|'. Thus,
|hpack(p,w,exactly)| produces a box whose width is exactly |w|, while
|hpack(p,w,additional)| yields a box whose width is the natural width plus
|w|. It is convenient to define a macro called `|natural|' to cover the
most common case, so that we can say |hpack(p,natural)| to get a box that
has the natural width of list |p|.
Similarly, |vpack(p,w,m)| returns a pointer to a |vlist_node| for a
box containing the vlist that starts at |p|. In this case |w| represents
a height instead of a width; the parameter |m| is interpreted as in |hpack|.
@d exactly=0 {a box dimension is pre-specified}
@d additional=1 {a box dimension is increased from the natural one}
@d natural==0,additional {shorthand for parameters to |hpack| and |vpack|}
@ The parameters to |hpack| and |vpack| correspond to \TeX's primitives
like `\.{\\hbox} \.{to} \.{300pt}', `\.{\\hbox} \.{spread} \.{10pt}'; note
that `\.{\\hbox}' with no dimension following it is equivalent to
`\.{\\hbox} \.{spread} \.{0pt}'. The |scan_spec| subroutine scans such
constructions in the user's input, including the mandatory left brace that
follows them, and it puts the specification onto |save_stack| so that the
desired box can later be obtained by executing the following code:
$$\vbox{\halign{#\hfil\cr
|save_ptr:=save_ptr-2;|\cr
|hpack(p,saved(1),saved(0)).|\cr}}$$
Special care is necessary to ensure that the special |save_stack| codes
are placed just below the new group code, because scanning can change
|save_stack| when \.{\\csname} appears.
@p procedure scan_spec(@!c:group_code;@!three_codes:boolean);
{scans a box specification and left brace}
label found;
var @!s:integer; {temporarily saved value}
@!spec_code:exactly..additional;
begin if three_codes then s:=saved(0);
if scan_keyword("to") then spec_code:=exactly
@.to@>
else if scan_keyword("spread") then spec_code:=additional
@.spread@>
else begin spec_code:=additional; cur_val:=0;
goto found;
end;
scan_normal_dimen;
found: if three_codes then
begin saved(0):=s; incr(save_ptr);
end;
saved(0):=spec_code; saved(1):=cur_val; save_ptr:=save_ptr+2;
new_save_level(c); scan_left_brace;
end;
@ To figure out the glue setting, |hpack| and |vpack| determine how much
stretchability and shrinkability are present, considering all four orders
of infinity. The highest order of infinity that has a nonzero coefficient
is then used as if no other orders were present.
For example, suppose that the given list contains six glue nodes with
the respective stretchabilities 3pt, 8fill, 5fil, 6pt, $-3$fil, $-8$fill.
Then the total is essentially 2fil; and if a total additional space of 6pt
is to be achieved by stretching, the actual amounts of stretch will be
0pt, 0pt, 15pt, 0pt, $-9$pt, and 0pt, since only `fil' glue will be
considered. (The `fill' glue is therefore not really stretching infinitely
with respect to `fil'; nobody would actually want that to happen.)
The arrays |total_stretch| and |total_shrink| are used to determine how much
glue of each kind is present. A global variable |last_badness| is used
to implement \.{\\badness}.
@<Glob...@>=
@!total_stretch, @!total_shrink: array[glue_ord] of scaled;
{glue found by |hpack| or |vpack|}
@!last_badness:integer; {badness of the most recently packaged box}
@ If the global variable |adjust_tail| is non-null, the |hpack| routine
also removes all occurrences of |ins_node|, |mark_node|, and |adjust_node|
items and appends the resulting material onto the list that ends at
location |adjust_tail|.
@<Glob...@>=
@!adjust_tail:pointer; {tail of adjustment list}
@ @<Set init...@>=adjust_tail:=null; last_badness:=0;
@ @<Glob...@>=
@!pdf_font_blink: ^internal_font_number; {link to base font (used for expanded fonts only)}
@!pdf_font_elink: ^internal_font_number; {link to expanded fonts (used for base fonts only)}
@!pdf_font_has_space_char: ^boolean; {has font a real space char?}
@!pdf_font_stretch: ^integer; {link to font expanded by stretch limi}
@!pdf_font_shrink: ^integer; {link to font expanded by shrink limit}
@!pdf_font_step: ^integer; {amount of one step of expansion}
@!pdf_font_expand_ratio: ^integer; {expansion ratio of a particular font}
@!pdf_font_auto_expand: ^boolean; {this font is auto-expanded?}
@!pdf_font_lp_base: ^integer; {base of left-protruding factor}
@!pdf_font_rp_base: ^integer; {base of right-protruding factor}
@!pdf_font_ef_base: ^integer; {base of font expansion factor}
@!pdf_font_kn_bs_base: ^integer; {base of kern before space}
@!pdf_font_st_bs_base: ^integer; {base of stretch before space}
@!pdf_font_sh_bs_base: ^integer; {base of shrink before space}
@!pdf_font_kn_bc_base: ^integer; {base of kern before character}
@!pdf_font_kn_ac_base: ^integer; {base of kern after character}
@!font_expand_ratio: integer; {current expansion ratio}
@!last_leftmost_char: pointer;
@!last_rightmost_char: pointer;
@!hlist_stack:array[0..max_hlist_stack] of pointer; {stack for |find_protchar_left()| and |find_protchar_right()|}
@!hlist_stack_level:0..max_hlist_stack; {fill level for |hlist_stack|}
@ @d cal_margin_kern_var(#) ==
begin
character(cp) := character(#);
font(cp) := font(#);
do_subst_font(cp, 1000);
if font(cp) <> font(#) then
margin_kern_stretch := margin_kern_stretch + left_pw(#) - left_pw(cp);
font(cp) := font(#);
do_subst_font(cp, -1000);
if font(cp) <> font(#) then
margin_kern_shrink := margin_kern_shrink + left_pw(cp) - left_pw(#);
end
@<Calculate variations of marginal kerns@>=
begin
lp := last_leftmost_char;
rp := last_rightmost_char;
fast_get_avail(cp);
if lp <> null then
cal_margin_kern_var(lp);
if rp <> null then
cal_margin_kern_var(rp);
free_avail(cp);
end
@ Here is |hpack|, which is place where we do font substituting when
font expansion is being used. We define some constants used when calling
|hpack| to deal with font expansion.
@d cal_expand_ratio == 2 {calculate amount for font expansion after breaking
paragraph into lines}
@d subst_ex_font == 3 {substitute fonts}
@d substituted = 3 {|subtype| of kern nodes that should be substituted}
@d left_pw(#) == char_pw(#, left_side)
@d right_pw(#) == char_pw(#, right_side)
@p
function check_expand_pars(f: internal_font_number): boolean;
var k: internal_font_number;
begin
check_expand_pars := false;
if (pdf_font_step[f] = 0) or ((pdf_font_stretch[f] = null_font) and
(pdf_font_shrink[f] = null_font)) then
return;
if cur_font_step < 0 then
cur_font_step := pdf_font_step[f]
else if cur_font_step <> pdf_font_step[f] then
pdf_error("font expansion", "using fonts with different step of expansion in one paragraph is not allowed");
k := pdf_font_stretch[f];
if k <> null_font then begin
if max_stretch_ratio < 0 then
max_stretch_ratio := pdf_font_expand_ratio[k]
else if max_stretch_ratio <> pdf_font_expand_ratio[k] then
pdf_error("font expansion", "using fonts with different limit of expansion in one paragraph is not allowed");
end;
k := pdf_font_shrink[f];
if k <> null_font then begin
if max_shrink_ratio < 0 then
max_shrink_ratio := -pdf_font_expand_ratio[k]
else if max_shrink_ratio <> -pdf_font_expand_ratio[k] then
pdf_error("font expansion", "using fonts with different limit of expansion in one paragraph is not allowed");
end;
check_expand_pars := true;
end;
function char_stretch(f: internal_font_number; c: eight_bits): scaled;
var k: internal_font_number;
dw: scaled;
ef: integer;
begin
char_stretch := 0;
k := pdf_font_stretch[f];
ef := get_ef_code(f, c);
if (k <> null_font) and (ef > 0) then begin
dw := char_width(k)(char_info(k)(c)) - char_width(f)(char_info(f)(c));
if dw > 0 then
char_stretch := round_xn_over_d(dw, ef, 1000);
end;
end;
function char_shrink(f: internal_font_number; c: eight_bits): scaled;
var k: internal_font_number;
dw: scaled;
ef: integer;
begin
char_shrink := 0;
k := pdf_font_shrink[f];
ef := get_ef_code(f, c);
if (k <> null_font) and (ef > 0) then begin
dw := char_width(f)(char_info(f)(c)) - char_width(k)(char_info(k)(c));
if dw > 0 then
char_shrink := round_xn_over_d(dw, ef, 1000);
end;
end;
function get_kern(f: internal_font_number; lc, rc: eight_bits): scaled;
label continue;
var i: four_quarters;
j: four_quarters;
k: font_index;
begin
get_kern := 0;
i := char_info(f)(lc);
if char_tag(i) <> lig_tag then
return;
k := lig_kern_start(f)(i);
j := font_info[k].qqqq;
if skip_byte(j) <= stop_flag then
goto continue + 1;
k := lig_kern_restart(f)(j);
continue:
j := font_info[k].qqqq;
continue + 1:
if (next_char(j) = rc) and (skip_byte(j) <= stop_flag) and
(op_byte(j) >= kern_flag)
then begin
get_kern := char_kern(f)(j);
return;
end;
if skip_byte(j) = qi(0) then
incr(k)
else begin
if skip_byte(j) >= stop_flag then
return;
k := k + qo(skip_byte(j)) + 1;
end;
goto continue;
end;
function kern_stretch(p: pointer): scaled;
var l, r: pointer;
d: scaled;
begin
kern_stretch := 0;
if (prev_char_p = null) or (link(prev_char_p) <> p) or (link(p) = null)
then
return;
l := prev_char_p;
r := link(p);
if not is_char_node(l) then
if type(l) = ligature_node then
l := lig_char(l)
else
return;
if not is_char_node(r) then
if type(r) = ligature_node then
r := lig_char(r)
else
return;
if not ((font(l) = font(r)) and
(pdf_font_stretch[font(l)] <> null_font))
then
return;
d := get_kern(pdf_font_stretch[font(l)], character(l), character(r));
kern_stretch := round_xn_over_d(d - width(p),
get_ef_code(font(l), character(l)), 1000);
end;
function kern_shrink(p: pointer): scaled;
var l, r: pointer;
d: scaled;
begin
kern_shrink := 0;
if (prev_char_p = null) or (link(prev_char_p) <> p) or (link(p) = null)
then
return;
l := prev_char_p;
r := link(p);
if not is_char_node(l) then
if type(l) = ligature_node then
l := lig_char(l)
else
return;
if not is_char_node(r) then
if type(r) = ligature_node then
r := lig_char(r)
else
return;
if not ((font(l) = font(r)) and
(pdf_font_shrink[font(l)] <> null_font))
then
return;
d := get_kern(pdf_font_shrink[font(l)], character(l), character(r));
kern_shrink := round_xn_over_d(width(p) - d,
get_ef_code(font(l), character(l)), 1000);
end;
procedure do_subst_font(p: pointer; ex_ratio: integer);
var f, k: internal_font_number;
r: pointer;
ef: integer;
begin
if not is_char_node(p) and (type(p) = disc_node) then begin
r := pre_break(p);
while r <> null do begin
if is_char_node(r) or (type(r) = ligature_node) then
do_subst_font(r, ex_ratio);
r := link(r);
end;
r := post_break(p);
while r <> null do begin
if is_char_node(r) or (type(r) = ligature_node) then
do_subst_font(r, ex_ratio);
r := link(r);
end;
return;
end;
if is_char_node(p) then
r := p
else if type(p) = ligature_node then
r := lig_char(p)
else begin
{|short_display_n(p, 5);|}
pdf_error("font expansion", "invalid node type");
end;
f := font(r);
ef := get_ef_code(f, character(r));
if ef = 0 then
return;
if (pdf_font_stretch[f] <> null_font) and (ex_ratio > 0) then
k := expand_font(f, ext_xn_over_d(ex_ratio*ef,
pdf_font_expand_ratio[pdf_font_stretch[f]],
1000000))
else if (pdf_font_shrink[f] <> null_font) and (ex_ratio < 0) then
k := expand_font(f, ext_xn_over_d(ex_ratio*ef,
-pdf_font_expand_ratio[pdf_font_shrink[f]],
1000000))
else
k := f;
if k <> f then begin
font(r) := k;
if not is_char_node(p) then begin
r := lig_ptr(p);
while r <> null do begin
font(r) := k;
r := link(r);
end;
end;
end;
end;
function char_pw(p: pointer; side: small_number): scaled;
var f: internal_font_number;
c: integer;
begin
char_pw := 0;
if side = left_side then
last_leftmost_char := null
else
last_rightmost_char := null;
if p = null then
return;
if not is_char_node(p) then begin
if type(p) = ligature_node then
p := lig_char(p)
else
return;
end;
f := font(p);
if side = left_side then begin
c := get_lp_code(f, character(p));
last_leftmost_char := p;
end
else begin
c := get_rp_code(f, character(p));
last_rightmost_char := p;
end;
if c = 0 then
return;
char_pw :=
round_xn_over_d(quad(f), c, 1000);
end;
function new_margin_kern(w: scaled; p: pointer; side: small_number): pointer;
var k: pointer;
begin
k := get_node(margin_kern_node_size);
type(k) := margin_kern_node;
subtype(k) := side;
width(k) := w;
if p = null then
pdf_error("margin kerning", "invalid pointer to marginal char node");
fast_get_avail(margin_char(k));
character(margin_char(k)) := character(p);
font(margin_char(k)) := font(p);
new_margin_kern := k;
end;
function hpack(@!p:pointer;@!w:scaled;@!m:small_number):pointer;
label reswitch, common_ending, exit;
var r:pointer; {the box node that will be returned}
@!q:pointer; {trails behind |p|}
@!h,@!d,@!x:scaled; {height, depth, and natural width}
@!s:scaled; {shift amount}
@!g:pointer; {points to a glue specification}
@!o:glue_ord; {order of infinity}
@!f:internal_font_number; {the font in a |char_node|}
@!i:four_quarters; {font information about a |char_node|}
@!hd:eight_bits; {height and depth indices for a character}
font_stretch: scaled;
font_shrink: scaled;
k: scaled;
begin last_badness:=0; r:=get_node(box_node_size); type(r):=hlist_node;
subtype(r):=min_quarterword; shift_amount(r):=0;
q:=r+list_offset; link(q):=p;@/
if m = cal_expand_ratio then begin
prev_char_p := null;
font_stretch := 0;
font_shrink := 0;
font_expand_ratio := 0;
end;
h:=0; @<Clear dimensions to zero@>;
if TeXXeT_en then @<Initialize the LR stack@>;
while p<>null do @<Examine node |p| in the hlist, taking account of its effect
on the dimensions of the new box, or moving it to the adjustment list;
then advance |p| to the next node@>;
if adjust_tail<>null then link(adjust_tail):=null;
if pre_adjust_tail<>null then link(pre_adjust_tail):=null;
height(r):=h; depth(r):=d;@/
@<Determine the value of |width(r)| and the appropriate glue setting;
then |return| or |goto common_ending|@>;
common_ending: @<Finish issuing a diagnostic message
for an overfull or underfull hbox@>;
exit: if TeXXeT_en then @<Check for LR anomalies at the end of |hpack|@>;
if (m = cal_expand_ratio) and (font_expand_ratio <> 0) then begin
font_expand_ratio := fix_int(font_expand_ratio, -1000, 1000);
q := list_ptr(r);
free_node(r, box_node_size);
r := hpack(q, w, subst_ex_font);
end;
hpack:=r;
end;
@ @<Clear dimensions to zero@>=
d:=0; x:=0;
total_stretch[normal]:=0; total_shrink[normal]:=0;
total_stretch[fil]:=0; total_shrink[fil]:=0;
total_stretch[fill]:=0; total_shrink[fill]:=0;
total_stretch[filll]:=0; total_shrink[filll]:=0
@ @<Examine node |p| in the hlist, taking account of its effect...@>=
@^inner loop@>
begin reswitch: while is_char_node(p) do
@<Incorporate character dimensions into the dimensions of
the hbox that will contain~it, then move to the next node@>;
if p<>null then
begin case type(p) of
hlist_node,vlist_node,rule_node,unset_node:
@<Incorporate box dimensions into the dimensions of
the hbox that will contain~it@>;
ins_node,mark_node,adjust_node: if (adjust_tail<>null) or (pre_adjust_tail<> null) then
@<Transfer node |p| to the adjustment list@>;
whatsit_node:@<Incorporate a whatsit node into an hbox@>;
glue_node:@<Incorporate glue into the horizontal totals@>;
margin_kern_node: begin
if m = cal_expand_ratio then begin
f := font(margin_char(p));
do_subst_font(margin_char(p), 1000);
if f <> font(margin_char(p)) then
font_stretch := font_stretch - width(p) -
char_pw(margin_char(p), subtype(p));
font(margin_char(p)) := f;
do_subst_font(margin_char(p), -1000);
if f <> font(margin_char(p)) then
font_shrink := font_shrink - width(p) -
char_pw(margin_char(p), subtype(p));
font(margin_char(p)) := f;
end
else if m = subst_ex_font then begin
do_subst_font(margin_char(p), font_expand_ratio);
width(p) := -char_pw(margin_char(p), subtype(p));
end;
x := x + width(p);
end;
kern_node: begin
if subtype(p) = normal then begin
if m = cal_expand_ratio then begin
font_stretch := font_stretch + kern_stretch(p);
font_shrink := font_shrink + kern_shrink(p);
end
else if m = subst_ex_font then begin
if font_expand_ratio > 0 then
k := kern_stretch(p)
else if font_expand_ratio < 0 then
k := kern_shrink(p)
else
pdfassert(0);
if k <> 0 then begin
if is_char_node(link(p)) then
width(p) := get_kern(font(prev_char_p),
character(prev_char_p),
character(link(p)))
else if type(link(p)) = ligature_node then
width(p) := get_kern(font(prev_char_p),
character(prev_char_p),
character(lig_char(link(p))));
end;
end;
end;
x := x + width(p);
end;
math_node: begin x:=x+width(p);
if TeXXeT_en then @<Adjust \(t)the LR stack for the |hpack| routine@>;
end;
ligature_node: begin
if m = subst_ex_font then
do_subst_font(p, font_expand_ratio);
@<Make node |p| look like a |char_node| and |goto reswitch|@>;
end;
disc_node:
if m = subst_ex_font then
do_subst_font(p, font_expand_ratio);
othercases do_nothing
endcases;@/
p:=link(p);
end;
end
@ @<Make node |p| look like a |char_node| and |goto reswitch|@>=
begin mem[lig_trick]:=mem[lig_char(p)]; link(lig_trick):=link(p);
p:=lig_trick; goto reswitch;
end
@ The code here implicitly uses the fact that running dimensions are
indicated by |null_flag|, which will be ignored in the calculations
because it is a highly negative number.
@<Incorporate box dimensions into the dimensions of the hbox...@>=
begin x:=x+width(p);
if type(p)>=rule_node then s:=0 @+else s:=shift_amount(p);
if height(p)-s>h then h:=height(p)-s;
if depth(p)+s>d then d:=depth(p)+s;
end
@ The following code is part of \TeX's inner loop; i.e., adding another
character of text to the user's input will cause each of these instructions
to be exercised one more time.
@^inner loop@>
@<Incorporate character dimensions into the dimensions of the hbox...@>=
begin
if m >= cal_expand_ratio then begin
prev_char_p := p;
case m of
cal_expand_ratio: begin
f := font(p);
add_char_stretch(font_stretch)(character(p));
add_char_shrink(font_shrink)(character(p));
end;
subst_ex_font:
do_subst_font(p, font_expand_ratio);
endcases;
end;
f:=font(p); i:=char_info(f)(character(p)); hd:=height_depth(i);
x:=x+char_width(f)(i);@/
s:=char_height(f)(hd);@+if s>h then h:=s;
s:=char_depth(f)(hd);@+if s>d then d:=s;
p:=link(p);
end
@ Although node |q| is not necessarily the immediate predecessor of node |p|,
it always points to some node in the list preceding |p|. Thus, we can delete
nodes by moving |q| when necessary. The algorithm takes linear time, and the
extra computation does not intrude on the inner loop unless it is necessary
to make a deletion.
@^inner loop@>
@<Glob...@>=
@!pre_adjust_tail: pointer;
@ @<Set init...@>=
pre_adjust_tail := null;
@ Materials in \.{\\vadjust} used with \.{pre} keyword will be appended to
|pre_adjust_tail| instead of |adjust_tail|.
@d update_adjust_list(#) == begin
if # = null then
confusion("pre vadjust");
link(#) := adjust_ptr(p);
while link(#) <> null do
# := link(#);
end
@<Transfer node |p| to the adjustment list@>=
begin while link(q)<>p do q:=link(q);
if type(p) = adjust_node then begin
if adjust_pre(p) <> 0 then
update_adjust_list(pre_adjust_tail)
else
update_adjust_list(adjust_tail);
p := link(p); free_node(link(q), small_node_size);
end
else begin link(adjust_tail):=p; adjust_tail:=p; p:=link(p);
end;
link(q):=p; p:=q;
end
@ @<Incorporate glue into the horizontal totals@>=
begin g:=glue_ptr(p); x:=x+width(g);@/
o:=stretch_order(g); total_stretch[o]:=total_stretch[o]+stretch(g);
o:=shrink_order(g); total_shrink[o]:=total_shrink[o]+shrink(g);
if subtype(p)>=a_leaders then
begin g:=leader_ptr(p);
if height(g)>h then h:=height(g);
if depth(g)>d then d:=depth(g);
end;
end
@ When we get to the present part of the program, |x| is the natural width
of the box being packaged.
@<Determine the value of |width(r)| and the appropriate glue setting...@>=
if m=additional then w:=x+w;
width(r):=w; x:=w-x; {now |x| is the excess to be made up}
if x=0 then
begin glue_sign(r):=normal; glue_order(r):=normal;
set_glue_ratio_zero(glue_set(r));
return;
end
else if x>0 then @<Determine horizontal glue stretch setting, then |return|
or \hbox{|goto common_ending|}@>
else @<Determine horizontal glue shrink setting, then |return|
or \hbox{|goto common_ending|}@>
@ If |hpack| is called with |m=cal_expand_ratio| we calculate
|font_expand_ratio| and return without checking for overfull or underfull box.
@<Determine horizontal glue stretch setting...@>=
begin @<Determine the stretch order@>;
if (m = cal_expand_ratio) and (o = normal) and (font_stretch > 0) then begin
font_expand_ratio := divide_scaled(x, font_stretch, 3);
return;
end;
glue_order(r):=o; glue_sign(r):=stretching;
if total_stretch[o]<>0 then glue_set(r):=unfloat(x/total_stretch[o])
@^real division@>
else begin glue_sign(r):=normal;
set_glue_ratio_zero(glue_set(r)); {there's nothing to stretch}
end;
if o=normal then if list_ptr(r)<>null then
@<Report an underfull hbox and |goto common_ending|, if this box
is sufficiently bad@>;
return;
end
@ @<Determine the stretch order@>=
if total_stretch[filll]<>0 then o:=filll
else if total_stretch[fill]<>0 then o:=fill
else if total_stretch[fil]<>0 then o:=fil
else o:=normal
@ @<Report an underfull hbox and |goto common_ending|, if...@>=
begin last_badness:=badness(x,total_stretch[normal]);
if last_badness>hbadness then
begin print_ln;
if last_badness>100 then print_nl("Underfull")@+else print_nl("Loose");
print(" \hbox (badness "); print_int(last_badness);
@.Underfull \\hbox...@>
@.Loose \\hbox...@>
goto common_ending;
end;
end
@ In order to provide a decent indication of where an overfull or underfull
box originated, we use a global variable |pack_begin_line| that is
set nonzero only when |hpack| is being called by the paragraph builder
or the alignment finishing routine.
@<Glob...@>=
@!pack_begin_line:integer; {source file line where the current paragraph
or alignment began; a negative value denotes alignment}
@ @<Set init...@>=
pack_begin_line:=0;
@ @<Finish issuing a diagnostic message for an overfull or underfull hbox@>=
if output_active then print(") has occurred while \output is active")
else begin if pack_begin_line<>0 then
begin if pack_begin_line>0 then print(") in paragraph at lines ")
else print(") in alignment at lines ");
print_int(abs(pack_begin_line));
print("--");
end
else print(") detected at line ");
print_int(line);
end;
print_ln;@/
font_in_short_display:=null_font; short_display(list_ptr(r)); print_ln;@/
begin_diagnostic; show_box(r); end_diagnostic(true)
@ @<Determine horizontal glue shrink setting...@>=
begin @<Determine the shrink order@>;
if (m = cal_expand_ratio) and (o = normal) and (font_shrink > 0) then begin
font_expand_ratio := divide_scaled(x, font_shrink, 3);
return;
end;
glue_order(r):=o; glue_sign(r):=shrinking;
if total_shrink[o]<>0 then glue_set(r):=unfloat((-x)/total_shrink[o])
@^real division@>
else begin glue_sign(r):=normal;
set_glue_ratio_zero(glue_set(r)); {there's nothing to shrink}
end;
if (total_shrink[o]<-x)and(o=normal)and(list_ptr(r)<>null) then
begin last_badness:=1000000;
set_glue_ratio_one(glue_set(r)); {use the maximum shrinkage}
@<Report an overfull hbox and |goto common_ending|, if this box
is sufficiently bad@>;
end
else if o=normal then if list_ptr(r)<>null then
@<Report a tight hbox and |goto common_ending|, if this box
is sufficiently bad@>;
return;
end
@ @<Determine the shrink order@>=
if total_shrink[filll]<>0 then o:=filll
else if total_shrink[fill]<>0 then o:=fill
else if total_shrink[fil]<>0 then o:=fil
else o:=normal
@ @<Report an overfull hbox and |goto common_ending|, if...@>=
if (-x-total_shrink[normal]>hfuzz)or(hbadness<100) then
begin if (overfull_rule>0)and(-x-total_shrink[normal]>hfuzz) then
begin while link(q)<>null do q:=link(q);
link(q):=new_rule;
width(link(q)):=overfull_rule;
end;
print_ln; print_nl("Overfull \hbox (");
@.Overfull \\hbox...@>
print_scaled(-x-total_shrink[normal]); print("pt too wide");
goto common_ending;
end
@ @<Report a tight hbox and |goto common_ending|, if...@>=
begin last_badness:=badness(-x,total_shrink[normal]);
if last_badness>hbadness then
begin print_ln; print_nl("Tight \hbox (badness "); print_int(last_badness);
@.Tight \\hbox...@>
goto common_ending;
end;
end
@ The |vpack| subroutine is actually a special case of a slightly more
general routine called |vpackage|, which has four parameters. The fourth
parameter, which is |max_dimen| in the case of |vpack|, specifies the
maximum depth of the page box that is constructed. The depth is first
computed by the normal rules; if it exceeds this limit, the reference
point is simply moved down until the limiting depth is attained.
@d vpack(#)==vpackage(#,max_dimen) {special case of unconstrained depth}
@p function vpackage(@!p:pointer;@!h:scaled;@!m:small_number;@!l:scaled):
pointer;
label common_ending, exit;
var r:pointer; {the box node that will be returned}
@!w,@!d,@!x:scaled; {width, depth, and natural height}
@!s:scaled; {shift amount}
@!g:pointer; {points to a glue specification}
@!o:glue_ord; {order of infinity}
begin last_badness:=0; r:=get_node(box_node_size); type(r):=vlist_node;
subtype(r):=min_quarterword; shift_amount(r):=0;
list_ptr(r):=p;@/
w:=0; @<Clear dimensions to zero@>;
while p<>null do @<Examine node |p| in the vlist, taking account of its effect
on the dimensions of the new box; then advance |p| to the next node@>;
width(r):=w;
if d>l then
begin x:=x+d-l; depth(r):=l;
end
else depth(r):=d;
@<Determine the value of |height(r)| and the appropriate glue setting;
then |return| or |goto common_ending|@>;
common_ending: @<Finish issuing a diagnostic message
for an overfull or underfull vbox@>;
exit: vpackage:=r;
end;
@ @<Examine node |p| in the vlist, taking account of its effect...@>=
begin if is_char_node(p) then confusion("vpack")
@:this can't happen vpack}{\quad vpack@>
else case type(p) of
hlist_node,vlist_node,rule_node,unset_node:
@<Incorporate box dimensions into the dimensions of
the vbox that will contain~it@>;
whatsit_node:@<Incorporate a whatsit node into a vbox@>;
glue_node: @<Incorporate glue into the vertical totals@>;
kern_node: begin x:=x+d+width(p); d:=0;
end;
othercases do_nothing
endcases;
p:=link(p);
end
@ @<Incorporate box dimensions into the dimensions of the vbox...@>=
begin x:=x+d+height(p); d:=depth(p);
if type(p)>=rule_node then s:=0 @+else s:=shift_amount(p);
if width(p)+s>w then w:=width(p)+s;
end
@ @<Incorporate glue into the vertical totals@>=
begin x:=x+d; d:=0;@/
g:=glue_ptr(p); x:=x+width(g);@/
o:=stretch_order(g); total_stretch[o]:=total_stretch[o]+stretch(g);
o:=shrink_order(g); total_shrink[o]:=total_shrink[o]+shrink(g);
if subtype(p)>=a_leaders then
begin g:=leader_ptr(p);
if width(g)>w then w:=width(g);
end;
end
@ When we get to the present part of the program, |x| is the natural height
of the box being packaged.
@<Determine the value of |height(r)| and the appropriate glue setting...@>=
if m=additional then h:=x+h;
height(r):=h; x:=h-x; {now |x| is the excess to be made up}
if x=0 then
begin glue_sign(r):=normal; glue_order(r):=normal;
set_glue_ratio_zero(glue_set(r));
return;
end
else if x>0 then @<Determine vertical glue stretch setting, then |return|
or \hbox{|goto common_ending|}@>
else @<Determine vertical glue shrink setting, then |return|
or \hbox{|goto common_ending|}@>
@ @<Determine vertical glue stretch setting...@>=
begin @<Determine the stretch order@>;
glue_order(r):=o; glue_sign(r):=stretching;
if total_stretch[o]<>0 then glue_set(r):=unfloat(x/total_stretch[o])
@^real division@>
else begin glue_sign(r):=normal;
set_glue_ratio_zero(glue_set(r)); {there's nothing to stretch}
end;
if o=normal then if list_ptr(r)<>null then
@<Report an underfull vbox and |goto common_ending|, if this box
is sufficiently bad@>;
return;
end
@ @<Report an underfull vbox and |goto common_ending|, if...@>=
begin last_badness:=badness(x,total_stretch[normal]);
if last_badness>vbadness then
begin print_ln;
if last_badness>100 then print_nl("Underfull")@+else print_nl("Loose");
print(" \vbox (badness "); print_int(last_badness);
@.Underfull \\vbox...@>
@.Loose \\vbox...@>
goto common_ending;
end;
end
@ @<Finish issuing a diagnostic message for an overfull or underfull vbox@>=
if output_active then print(") has occurred while \output is active")
else begin if pack_begin_line<>0 then {it's actually negative}
begin print(") in alignment at lines ");
print_int(abs(pack_begin_line));
print("--");
end
else print(") detected at line ");
print_int(line);
print_ln;@/
end;
begin_diagnostic; show_box(r); end_diagnostic(true)
@ @<Determine vertical glue shrink setting...@>=
begin @<Determine the shrink order@>;
glue_order(r):=o; glue_sign(r):=shrinking;
if total_shrink[o]<>0 then glue_set(r):=unfloat((-x)/total_shrink[o])
@^real division@>
else begin glue_sign(r):=normal;
set_glue_ratio_zero(glue_set(r)); {there's nothing to shrink}
end;
if (total_shrink[o]<-x)and(o=normal)and(list_ptr(r)<>null) then
begin last_badness:=1000000;
set_glue_ratio_one(glue_set(r)); {use the maximum shrinkage}
@<Report an overfull vbox and |goto common_ending|, if this box
is sufficiently bad@>;
end
else if o=normal then if list_ptr(r)<>null then
@<Report a tight vbox and |goto common_ending|, if this box
is sufficiently bad@>;
return;
end
@ @<Report an overfull vbox and |goto common_ending|, if...@>=
if (-x-total_shrink[normal]>vfuzz)or(vbadness<100) then
begin print_ln; print_nl("Overfull \vbox (");
@.Overfull \\vbox...@>
print_scaled(-x-total_shrink[normal]); print("pt too high");
goto common_ending;
end
@ @<Report a tight vbox and |goto common_ending|, if...@>=
begin last_badness:=badness(-x,total_shrink[normal]);
if last_badness>vbadness then
begin print_ln; print_nl("Tight \vbox (badness "); print_int(last_badness);
@.Tight \\vbox...@>
goto common_ending;
end;
end
@ When a box is being appended to the current vertical list, the
baselineskip calculation is handled by the |append_to_vlist| routine.
@p procedure append_to_vlist(@!b:pointer);
var d:scaled; {deficiency of space between baselines}
@!p:pointer; {a new glue node}
begin if prev_depth>pdf_ignored_dimen then
begin d:=width(baseline_skip)-prev_depth-height(b);
if d<line_skip_limit then p:=new_param_glue(line_skip_code)
else begin p:=new_skip_param(baseline_skip_code);
width(temp_ptr):=d; {|temp_ptr=glue_ptr(p)|}
end;
link(tail):=p; tail:=p;
end;
link(tail):=b; tail:=b; prev_depth:=depth(b);
end;
@* \[34] Data structures for math mode.
When \TeX\ reads a formula that is enclosed between \.\$'s, it constructs an
{\sl mlist}, which is essentially a tree structure representing that
formula. An mlist is a linear sequence of items, but we can regard it as
a tree structure because mlists can appear within mlists. For example, many
of the entries can be subscripted or superscripted, and such ``scripts''
are mlists in their own right.
An entire formula is parsed into such a tree before any of the actual
typesetting is done, because the current style of type is usually not
known until the formula has been fully scanned. For example, when the
formula `\.{\$a+b \\over c+d\$}' is being read, there is no way to tell
that `\.{a+b}' will be in script size until `\.{\\over}' has appeared.
During the scanning process, each element of the mlist being built is
classified as a relation, a binary operator, an open parenthesis, etc.,
or as a construct like `\.{\\sqrt}' that must be built up. This classification
appears in the mlist data structure.
After a formula has been fully scanned, the mlist is converted to an hlist
so that it can be incorporated into the surrounding text. This conversion is
controlled by a recursive procedure that decides all of the appropriate
styles by a ``top-down'' process starting at the outermost level and working
in towards the subformulas. The formula is ultimately pasted together using
combinations of horizontal and vertical boxes, with glue and penalty nodes
inserted as necessary.
An mlist is represented internally as a linked list consisting chiefly
of ``noads'' (pronounced ``no-adds''), to distinguish them from the somewhat
similar ``nodes'' in hlists and vlists. Certain kinds of ordinary nodes are
allowed to appear in mlists together with the noads; \TeX\ tells the difference
by means of the |type| field, since a noad's |type| is always greater than
that of a node. An mlist does not contain character nodes, hlist nodes, vlist
nodes, math nodes, ligature nodes,
or unset nodes; in particular, each mlist item appears in the
variable-size part of |mem|, so the |type| field is always present.
@ Each noad is four or more words long. The first word contains the |type|
and |subtype| and |link| fields that are already so familiar to us; the
second, third, and fourth words are called the noad's |nucleus|, |subscr|,
and |supscr| fields.
Consider, for example, the simple formula `\.{\$x\^2\$}', which would be
parsed into an mlist containing a single element called an |ord_noad|.
The |nucleus| of this noad is a representation of `\.x', the |subscr| is
empty, and the |supscr| is a representation of `\.2'.
The |nucleus|, |subscr|, and |supscr| fields are further broken into
subfields. If |p| points to a noad, and if |q| is one of its principal
fields (e.g., |q=subscr(p)|), there are several possibilities for the
subfields, depending on the |math_type| of |q|.
\yskip\hang|math_type(q)=math_char| means that |fam(q)| refers to one of
the sixteen font families, and |character(q)| is the number of a character
within a font of that family, as in a character node.
\yskip\hang|math_type(q)=math_text_char| is similar, but the character is
unsubscripted and unsuperscripted and it is followed immediately by another
character from the same font. (This |math_type| setting appears only
briefly during the processing; it is used to suppress unwanted italic
corrections.)
\yskip\hang|math_type(q)=empty| indicates a field with no value (the
corresponding attribute of noad |p| is not present).
\yskip\hang|math_type(q)=sub_box| means that |info(q)| points to a box
node (either an |hlist_node| or a |vlist_node|) that should be used as the
value of the field. The |shift_amount| in the subsidiary box node is the
amount by which that box will be shifted downward.
\yskip\hang|math_type(q)=sub_mlist| means that |info(q)| points to
an mlist; the mlist must be converted to an hlist in order to obtain
the value of this field.
\yskip\noindent In the latter case, we might have |info(q)=null|. This
is not the same as |math_type(q)=empty|; for example, `\.{\$P\_\{\}\$}'
and `\.{\$P\$}' produce different results (the former will not have the
``italic correction'' added to the width of |P|, but the ``script skip''
will be added).
The definitions of subfields given here are evidently wasteful of space,
since a halfword is being used for the |math_type| although only three
bits would be needed. However, there are hardly ever many noads present at
once, since they are soon converted to nodes that take up even more space,
so we can afford to represent them in whatever way simplifies the
programming.
@d noad_size=4 {number of words in a normal noad}
@d nucleus(#)==#+1 {the |nucleus| field of a noad}
@d supscr(#)==#+2 {the |supscr| field of a noad}
@d subscr(#)==#+3 {the |subscr| field of a noad}
@d math_type==link {a |halfword| in |mem|}
@d fam==font {a |quarterword| in |mem|}
@d math_char=1 {|math_type| when the attribute is simple}
@d sub_box=2 {|math_type| when the attribute is a box}
@d sub_mlist=3 {|math_type| when the attribute is a formula}
@d math_text_char=4 {|math_type| when italic correction is dubious}
@ Each portion of a formula is classified as Ord, Op, Bin, Rel, Open,
Close, Punct, or Inner, for purposes of spacing and line breaking. An
|ord_noad|, |op_noad|, |bin_noad|, |rel_noad|, |open_noad|, |close_noad|,
|punct_noad|, or |inner_noad| is used to represent portions of the various
types. For example, an `\.=' sign in a formula leads to the creation of a
|rel_noad| whose |nucleus| field is a representation of an equals sign
(usually |fam=0|, |character=@'75|). A formula preceded by \.{\\mathrel}
also results in a |rel_noad|. When a |rel_noad| is followed by an
|op_noad|, say, and possibly separated by one or more ordinary nodes (not
noads), \TeX\ will insert a penalty node (with the current |rel_penalty|)
just after the formula that corresponds to the |rel_noad|, unless there
already was a penalty immediately following; and a ``thick space'' will be
inserted just before the formula that corresponds to the |op_noad|.
A noad of type |ord_noad|, |op_noad|, \dots, |inner_noad| usually
has a |subtype=normal|. The only exception is that an |op_noad| might
have |subtype=limits| or |no_limits|, if the normal positioning of
limits has been overridden for this operator.
@d ord_noad=unset_node+3 {|type| of a noad classified Ord}
@d op_noad=ord_noad+1 {|type| of a noad classified Op}
@d bin_noad=ord_noad+2 {|type| of a noad classified Bin}
@d rel_noad=ord_noad+3 {|type| of a noad classified Rel}
@d open_noad=ord_noad+4 {|type| of a noad classified Open}
@d close_noad=ord_noad+5 {|type| of a noad classified Close}
@d punct_noad=ord_noad+6 {|type| of a noad classified Punct}
@d inner_noad=ord_noad+7 {|type| of a noad classified Inner}
@d limits=1 {|subtype| of |op_noad| whose scripts are to be above, below}
@d no_limits=2 {|subtype| of |op_noad| whose scripts are to be normal}
@ A |radical_noad| is five words long; the fifth word is the |left_delimiter|
field, which usually represents a square root sign.
A |fraction_noad| is six words long; it has a |right_delimiter| field
as well as a |left_delimiter|.
Delimiter fields are of type |four_quarters|, and they have four subfields
called |small_fam|, |small_char|, |large_fam|, |large_char|. These subfields
represent variable-size delimiters by giving the ``small'' and ``large''
starting characters, as explained in Chapter~17 of {\sl The \TeX book}.
@:TeXbook}{\sl The \TeX book@>
A |fraction_noad| is actually quite different from all other noads. Not
only does it have six words, it has |thickness|, |denominator|, and
|numerator| fields instead of |nucleus|, |subscr|, and |supscr|. The
|thickness| is a scaled value that tells how thick to make a fraction
rule; however, the special value |default_code| is used to stand for the
|default_rule_thickness| of the current size. The |numerator| and
|denominator| point to mlists that define a fraction; we always have
$$\hbox{|math_type(numerator)=math_type(denominator)=sub_mlist|}.$$ The
|left_delimiter| and |right_delimiter| fields specify delimiters that will
be placed at the left and right of the fraction. In this way, a
|fraction_noad| is able to represent all of \TeX's operators \.{\\over},
\.{\\atop}, \.{\\above}, \.{\\overwithdelims}, \.{\\atopwithdelims}, and
\.{\\abovewithdelims}.
@d left_delimiter(#)==#+4 {first delimiter field of a noad}
@d right_delimiter(#)==#+5 {second delimiter field of a fraction noad}
@d radical_noad=inner_noad+1 {|type| of a noad for square roots}
@d radical_noad_size=5 {number of |mem| words in a radical noad}
@d fraction_noad=radical_noad+1 {|type| of a noad for generalized fractions}
@d fraction_noad_size=6 {number of |mem| words in a fraction noad}
@d small_fam(#)==mem[#].qqqq.b0 {|fam| for ``small'' delimiter}
@d small_char(#)==mem[#].qqqq.b1 {|character| for ``small'' delimiter}
@d large_fam(#)==mem[#].qqqq.b2 {|fam| for ``large'' delimiter}
@d large_char(#)==mem[#].qqqq.b3 {|character| for ``large'' delimiter}
@d thickness==width {|thickness| field in a fraction noad}
@d default_code==@'10000000000 {denotes |default_rule_thickness|}
@d numerator==supscr {|numerator| field in a fraction noad}
@d denominator==subscr {|denominator| field in a fraction noad}
@ The global variable |empty_field| is set up for initialization of empty
fields in new noads. Similarly, |null_delimiter| is for the initialization
of delimiter fields.
@<Glob...@>=
@!empty_field:two_halves;
@!null_delimiter:four_quarters;
@ @<Set init...@>=
empty_field.rh:=empty; empty_field.lh:=null;@/
null_delimiter.b0:=0; null_delimiter.b1:=min_quarterword;@/
null_delimiter.b2:=0; null_delimiter.b3:=min_quarterword;
@ The |new_noad| function creates an |ord_noad| that is completely null.
@p function new_noad:pointer;
var p:pointer;
begin p:=get_node(noad_size);
type(p):=ord_noad; subtype(p):=normal;
mem[nucleus(p)].hh:=empty_field;
mem[subscr(p)].hh:=empty_field;
mem[supscr(p)].hh:=empty_field;
new_noad:=p;
end;
@ A few more kinds of noads will complete the set: An |under_noad| has its
nucleus underlined; an |over_noad| has it overlined. An |accent_noad| places
an accent over its nucleus; the accent character appears as
|fam(accent_chr(p))| and |character(accent_chr(p))|. A |vcenter_noad|
centers its nucleus vertically with respect to the axis of the formula;
in such noads we always have |math_type(nucleus(p))=sub_box|.
And finally, we have |left_noad| and |right_noad| types, to implement
\TeX's \.{\\left} and \.{\\right} as well as \eTeX's \.{\\middle}.
The |nucleus| of such noads is
replaced by a |delimiter| field; thus, for example, `\.{\\left(}' produces
a |left_noad| such that |delimiter(p)| holds the family and character
codes for all left parentheses. A |left_noad| never appears in an mlist
except as the first element, and a |right_noad| never appears in an mlist
except as the last element; furthermore, we either have both a |left_noad|
and a |right_noad|, or neither one is present. The |subscr| and |supscr|
fields are always |empty| in a |left_noad| and a |right_noad|.
@d under_noad=fraction_noad+1 {|type| of a noad for underlining}
@d over_noad=under_noad+1 {|type| of a noad for overlining}
@d accent_noad=over_noad+1 {|type| of a noad for accented subformulas}
@d accent_noad_size=5 {number of |mem| words in an accent noad}
@d accent_chr(#)==#+4 {the |accent_chr| field of an accent noad}
@d vcenter_noad=accent_noad+1 {|type| of a noad for \.{\\vcenter}}
@d left_noad=vcenter_noad+1 {|type| of a noad for \.{\\left}}
@d right_noad=left_noad+1 {|type| of a noad for \.{\\right}}
@d delimiter==nucleus {|delimiter| field in left and right noads}
@d middle_noad==1 {|subtype| of right noad representing \.{\\middle}}
@d scripts_allowed(#)==(type(#)>=ord_noad)and(type(#)<left_noad)
@ Math formulas can also contain instructions like \.{\\textstyle} that
override \TeX's normal style rules. A |style_node| is inserted into the
data structure to record such instructions; it is three words long, so it
is considered a node instead of a noad. The |subtype| is either |display_style|
or |text_style| or |script_style| or |script_script_style|. The
second and third words of a |style_node| are not used, but they are
present because a |choice_node| is converted to a |style_node|.
\TeX\ uses even numbers 0, 2, 4, 6 to encode the basic styles
|display_style|, \dots, |script_script_style|, and adds~1 to get the
``cramped'' versions of these styles. This gives a numerical order that
is backwards from the convention of Appendix~G in {\sl The \TeX book\/};
i.e., a smaller style has a larger numerical value.
@:TeXbook}{\sl The \TeX book@>
@d style_node=unset_node+1 {|type| of a style node}
@d style_node_size=3 {number of words in a style node}
@d display_style=0 {|subtype| for \.{\\displaystyle}}
@d text_style=2 {|subtype| for \.{\\textstyle}}
@d script_style=4 {|subtype| for \.{\\scriptstyle}}
@d script_script_style=6 {|subtype| for \.{\\scriptscriptstyle}}
@d cramped=1 {add this to an uncramped style if you want to cramp it}
@p function new_style(@!s:small_number):pointer; {create a style node}
var p:pointer; {the new node}
begin p:=get_node(style_node_size); type(p):=style_node;
subtype(p):=s; width(p):=0; depth(p):=0; {the |width| and |depth| are not used}
new_style:=p;
end;
@ Finally, the \.{\\mathchoice} primitive creates a |choice_node|, which
has special subfields |display_mlist|, |text_mlist|, |script_mlist|,
and |script_script_mlist| pointing to the mlists for each style.
@d choice_node=unset_node+2 {|type| of a choice node}
@d display_mlist(#)==info(#+1) {mlist to be used in display style}
@d text_mlist(#)==link(#+1) {mlist to be used in text style}
@d script_mlist(#)==info(#+2) {mlist to be used in script style}
@d script_script_mlist(#)==link(#+2) {mlist to be used in scriptscript style}
@p function new_choice:pointer; {create a choice node}
var p:pointer; {the new node}
begin p:=get_node(style_node_size); type(p):=choice_node;
subtype(p):=0; {the |subtype| is not used}
display_mlist(p):=null; text_mlist(p):=null; script_mlist(p):=null;
script_script_mlist(p):=null;
new_choice:=p;
end;
@ Let's consider now the previously unwritten part of |show_node_list|
that displays the things that can only be present in mlists; this
program illustrates how to access the data structures just defined.
In the context of the following program, |p| points to a node or noad that
should be displayed, and the current string contains the ``recursion history''
that leads to this point. The recursion history consists of a dot for each
outer level in which |p| is subsidiary to some node, or in which |p| is
subsidiary to the |nucleus| field of some noad; the dot is replaced by
`\.\_' or `\.\^' or `\./' or `\.\\' if |p| is descended from the |subscr|
or |supscr| or |denominator| or |numerator| fields of noads. For example,
the current string would be `\.{.\^.\_/}' if |p| points to the |ord_noad| for
|x| in the (ridiculous) formula
`\.{\$\\sqrt\{a\^\{\\mathinner\{b\_\{c\\over x+y\}\}\}\}\$}'.
@<Cases of |show_node_list| that arise...@>=
style_node:print_style(subtype(p));
choice_node:@<Display choice node |p|@>;
ord_noad,op_noad,bin_noad,rel_noad,open_noad,close_noad,punct_noad,inner_noad,
radical_noad,over_noad,under_noad,vcenter_noad,accent_noad,
left_noad,right_noad:@<Display normal noad |p|@>;
fraction_noad:@<Display fraction noad |p|@>;
@ Here are some simple routines used in the display of noads.
@<Declare procedures needed for displaying the elements of mlists@>=
procedure print_fam_and_char(@!p:pointer); {prints family and character}
begin print_esc("fam"); print_int(fam(p)); print_char(" ");
print_ASCII(qo(character(p)));
end;
@#
procedure print_delimiter(@!p:pointer); {prints a delimiter as 24-bit hex value}
var a:integer; {accumulator}
begin a:=small_fam(p)*256+qo(small_char(p));
a:=a*@"1000+large_fam(p)*256+qo(large_char(p));
if a<0 then print_int(a) {this should never happen}
else print_hex(a);
end;
@ The next subroutine will descend to another level of recursion when a
subsidiary mlist needs to be displayed. The parameter |c| indicates what
character is to become part of the recursion history. An empty mlist is
distinguished from a field with |math_type(p)=empty|, because these are
not equivalent (as explained above).
@^recursion@>
@<Declare procedures needed for displaying...@>=
procedure@?show_info; forward;@t\2@>@?{|show_node_list(info(temp_ptr))|}
procedure print_subsidiary_data(@!p:pointer;@!c:ASCII_code);
{display a noad field}
begin if cur_length>=depth_threshold then
begin if math_type(p)<>empty then print(" []");
end
else begin append_char(c); {include |c| in the recursion history}
temp_ptr:=p; {prepare for |show_info| if recursion is needed}
case math_type(p) of
math_char: begin print_ln; print_current_string; print_fam_and_char(p);
end;
sub_box: show_info; {recursive call}
sub_mlist: if info(p)=null then
begin print_ln; print_current_string; print("{}");
end
else show_info; {recursive call}
othercases do_nothing {|empty|}
endcases;@/
flush_char; {remove |c| from the recursion history}
end;
end;
@ The inelegant introduction of |show_info| in the code above seems better
than the alternative of using \PASCAL's strange |forward| declaration for a
procedure with parameters. The \PASCAL\ convention about dropping parameters
from a post-|forward| procedure is, frankly, so intolerable to the author
of \TeX\ that he would rather stoop to communication via a global temporary
variable. (A similar stupidity occurred with respect to |hlist_out| and
|vlist_out| above, and it will occur with respect to |mlist_to_hlist| below.)
@^Knuth, Donald Ervin@>
@:PASCAL}{\PASCAL@>
@p procedure show_info; {the reader will kindly forgive this}
begin show_node_list(info(temp_ptr));
end;
@ @<Declare procedures needed for displaying...@>=
procedure print_style(@!c:integer);
begin case c div 2 of
0: print_esc("displaystyle"); {|display_style=0|}
1: print_esc("textstyle"); {|text_style=2|}
2: print_esc("scriptstyle"); {|script_style=4|}
3: print_esc("scriptscriptstyle"); {|script_script_style=6|}
othercases print("Unknown style!")
endcases;
end;
@ @<Display choice node |p|@>=
begin print_esc("mathchoice");
append_char("D"); show_node_list(display_mlist(p)); flush_char;
append_char("T"); show_node_list(text_mlist(p)); flush_char;
append_char("S"); show_node_list(script_mlist(p)); flush_char;
append_char("s"); show_node_list(script_script_mlist(p)); flush_char;
end
@ @<Display normal noad |p|@>=
begin case type(p) of
ord_noad: print_esc("mathord");
op_noad: print_esc("mathop");
bin_noad: print_esc("mathbin");
rel_noad: print_esc("mathrel");
open_noad: print_esc("mathopen");
close_noad: print_esc("mathclose");
punct_noad: print_esc("mathpunct");
inner_noad: print_esc("mathinner");
over_noad: print_esc("overline");
under_noad: print_esc("underline");
vcenter_noad: print_esc("vcenter");
radical_noad: begin print_esc("radical"); print_delimiter(left_delimiter(p));
end;
accent_noad: begin print_esc("accent"); print_fam_and_char(accent_chr(p));
end;
left_noad: begin print_esc("left"); print_delimiter(delimiter(p));
end;
right_noad: begin if subtype(p)=normal then print_esc("right")
else print_esc("middle");
print_delimiter(delimiter(p));
end;
end;
if type(p)<left_noad then
begin if subtype(p)<>normal then
if subtype(p)=limits then print_esc("limits")
else print_esc("nolimits");
print_subsidiary_data(nucleus(p),".");
end;
print_subsidiary_data(supscr(p),"^");
print_subsidiary_data(subscr(p),"_");
end
@ @<Display fraction noad |p|@>=
begin print_esc("fraction, thickness ");
if thickness(p)=default_code then print("= default")
else print_scaled(thickness(p));
if (small_fam(left_delimiter(p))<>0)or@+
(small_char(left_delimiter(p))<>min_quarterword)or@|
(large_fam(left_delimiter(p))<>0)or@|
(large_char(left_delimiter(p))<>min_quarterword) then
begin print(", left-delimiter "); print_delimiter(left_delimiter(p));
end;
if (small_fam(right_delimiter(p))<>0)or@|
(small_char(right_delimiter(p))<>min_quarterword)or@|
(large_fam(right_delimiter(p))<>0)or@|
(large_char(right_delimiter(p))<>min_quarterword) then
begin print(", right-delimiter "); print_delimiter(right_delimiter(p));
end;
print_subsidiary_data(numerator(p),"\");
print_subsidiary_data(denominator(p),"/");
end
@ That which can be displayed can also be destroyed.
@<Cases of |flush_node_list| that arise...@>=
style_node: begin free_node(p,style_node_size); goto done;
end;
choice_node:begin flush_node_list(display_mlist(p));
flush_node_list(text_mlist(p));
flush_node_list(script_mlist(p));
flush_node_list(script_script_mlist(p));
free_node(p,style_node_size); goto done;
end;
ord_noad,op_noad,bin_noad,rel_noad,open_noad,close_noad,punct_noad,inner_noad,
radical_noad,over_noad,under_noad,vcenter_noad,accent_noad:@t@>@;@/
begin if math_type(nucleus(p))>=sub_box then
flush_node_list(info(nucleus(p)));
if math_type(supscr(p))>=sub_box then
flush_node_list(info(supscr(p)));
if math_type(subscr(p))>=sub_box then
flush_node_list(info(subscr(p)));
if type(p)=radical_noad then free_node(p,radical_noad_size)
else if type(p)=accent_noad then free_node(p,accent_noad_size)
else free_node(p,noad_size);
goto done;
end;
left_noad,right_noad: begin free_node(p,noad_size); goto done;
end;
fraction_noad: begin flush_node_list(info(numerator(p)));
flush_node_list(info(denominator(p)));
free_node(p,fraction_noad_size); goto done;
end;
@* \[35] Subroutines for math mode.
In order to convert mlists to hlists, i.e., noads to nodes, we need several
subroutines that are conveniently dealt with now.
Let us first introduce the macros that make it easy to get at the parameters and
other font information. A size code, which is a multiple of 16, is added to a
family number to get an index into the table of internal font numbers
for each combination of family and size. (Be alert: Size codes get
larger as the type gets smaller.)
@d text_size=0 {size code for the largest size in a family}
@d script_size=16 {size code for the medium size in a family}
@d script_script_size=32 {size code for the smallest size in a family}
@<Basic printing procedures@>=
procedure print_size(@!s:integer);
begin if s=text_size then print_esc("textfont")
else if s=script_size then print_esc("scriptfont")
else print_esc("scriptscriptfont");
end;
@ Before an mlist is converted to an hlist, \TeX\ makes sure that
the fonts in family~2 have enough parameters to be math-symbol
fonts, and that the fonts in family~3 have enough parameters to be
math-extension fonts. The math-symbol parameters are referred to by using the
following macros, which take a size code as their parameter; for example,
|num1(cur_size)| gives the value of the |num1| parameter for the current size.
@^parameters for symbols@>
@^font parameters@>
@d mathsy_end(#)==fam_fnt(2+#)]].sc
@d mathsy(#)==font_info[#+param_base[mathsy_end
@d math_x_height==mathsy(5) {height of `\.x'}
@d math_quad==mathsy(6) {\.{18mu}}
@d num1==mathsy(8) {numerator shift-up in display styles}
@d num2==mathsy(9) {numerator shift-up in non-display, non-\.{\\atop}}
@d num3==mathsy(10) {numerator shift-up in non-display \.{\\atop}}
@d denom1==mathsy(11) {denominator shift-down in display styles}
@d denom2==mathsy(12) {denominator shift-down in non-display styles}
@d sup1==mathsy(13) {superscript shift-up in uncramped display style}
@d sup2==mathsy(14) {superscript shift-up in uncramped non-display}
@d sup3==mathsy(15) {superscript shift-up in cramped styles}
@d sub1==mathsy(16) {subscript shift-down if superscript is absent}
@d sub2==mathsy(17) {subscript shift-down if superscript is present}
@d sup_drop==mathsy(18) {superscript baseline below top of large box}
@d sub_drop==mathsy(19) {subscript baseline below bottom of large box}
@d delim1==mathsy(20) {size of \.{\\atopwithdelims} delimiters
in display styles}
@d delim2==mathsy(21) {size of \.{\\atopwithdelims} delimiters in non-displays}
@d axis_height==mathsy(22) {height of fraction lines above the baseline}
@d total_mathsy_params=22
@ The math-extension parameters have similar macros, but the size code is
omitted (since it is always |cur_size| when we refer to such parameters).
@^parameters for symbols@>
@^font parameters@>
@d mathex(#)==font_info[#+param_base[fam_fnt(3+cur_size)]].sc
@d default_rule_thickness==mathex(8) {thickness of \.{\\over} bars}
@d big_op_spacing1==mathex(9) {minimum clearance above a displayed op}
@d big_op_spacing2==mathex(10) {minimum clearance below a displayed op}
@d big_op_spacing3==mathex(11) {minimum baselineskip above displayed op}
@d big_op_spacing4==mathex(12) {minimum baselineskip below displayed op}
@d big_op_spacing5==mathex(13) {padding above and below displayed limits}
@d total_mathex_params=13
@ We also need to compute the change in style between mlists and their
subsidiaries. The following macros define the subsidiary style for
an overlined nucleus (|cramped_style|), for a subscript or a superscript
(|sub_style| or |sup_style|), or for a numerator or denominator (|num_style|
or |denom_style|).
@d cramped_style(#)==2*(# div 2)+cramped {cramp the style}
@d sub_style(#)==2*(# div 4)+script_style+cramped {smaller and cramped}
@d sup_style(#)==2*(# div 4)+script_style+(# mod 2) {smaller}
@d num_style(#)==#+2-2*(# div 6) {smaller unless already script-script}
@d denom_style(#)==2*(# div 2)+cramped+2-2*(# div 6) {smaller, cramped}
@ When the style changes, the following piece of program computes associated
information:
@<Set up the values of |cur_size| and |cur_mu|, based on |cur_style|@>=
begin if cur_style<script_style then cur_size:=text_size
else cur_size:=16*((cur_style-text_style) div 2);
cur_mu:=x_over_n(math_quad(cur_size),18);
end
@ Here is a function that returns a pointer to a rule node having a given
thickness |t|. The rule will extend horizontally to the boundary of the vlist
that eventually contains it.
@p function fraction_rule(@!t:scaled):pointer;
{construct the bar for a fraction}
var p:pointer; {the new node}
begin p:=new_rule; height(p):=t; depth(p):=0; fraction_rule:=p;
end;
@ The |overbar| function returns a pointer to a vlist box that consists of
a given box |b|, above which has been placed a kern of height |k| under a
fraction rule of thickness |t| under additional space of height |t|.
@p function overbar(@!b:pointer;@!k,@!t:scaled):pointer;
var p,@!q:pointer; {nodes being constructed}
begin p:=new_kern(k); link(p):=b; q:=fraction_rule(t); link(q):=p;
p:=new_kern(t); link(p):=q; overbar:=vpack(p,natural);
end;
@ The |var_delimiter| function, which finds or constructs a sufficiently
large delimiter, is the most interesting of the auxiliary functions that
currently concern us. Given a pointer |d| to a delimiter field in some noad,
together with a size code |s| and a vertical distance |v|, this function
returns a pointer to a box that contains the smallest variant of |d| whose
height plus depth is |v| or more. (And if no variant is large enough, it
returns the largest available variant.) In particular, this routine will
construct arbitrarily large delimiters from extensible components, if
|d| leads to such characters.
The value returned is a box whose |shift_amount| has been set so that
the box is vertically centered with respect to the axis in the given size.
If a built-up symbol is returned, the height of the box before shifting
will be the height of its topmost component.
@p@t\4@>@<Declare subprocedures for |var_delimiter|@>
function var_delimiter(@!d:pointer;@!s:small_number;@!v:scaled):pointer;
label found,continue;
var b:pointer; {the box that will be constructed}
@!f,@!g: internal_font_number; {best-so-far and tentative font codes}
@!c,@!x,@!y: quarterword; {best-so-far and tentative character codes}
@!m,@!n: integer; {the number of extensible pieces}
@!u: scaled; {height-plus-depth of a tentative character}
@!w: scaled; {largest height-plus-depth so far}
@!q: four_quarters; {character info}
@!hd: eight_bits; {height-depth byte}
@!r: four_quarters; {extensible pieces}
@!z: small_number; {runs through font family members}
@!large_attempt: boolean; {are we trying the ``large'' variant?}
begin f:=null_font; w:=0; large_attempt:=false;
z:=small_fam(d); x:=small_char(d);
loop@+ begin @<Look at the variants of |(z,x)|; set |f| and |c| whenever
a better character is found; |goto found| as soon as a
large enough variant is encountered@>;
if large_attempt then goto found; {there were none large enough}
large_attempt:=true; z:=large_fam(d); x:=large_char(d);
end;
found: if f<>null_font then
@<Make variable |b| point to a box for |(f,c)|@>
else begin b:=new_null_box;
width(b):=null_delimiter_space; {use this width if no delimiter was found}
end;
shift_amount(b):=half(height(b)-depth(b)) - axis_height(s);
var_delimiter:=b;
end;
@ The search process is complicated slightly by the facts that some of the
characters might not be present in some of the fonts, and they might not
be probed in increasing order of height.
@<Look at the variants of |(z,x)|; set |f| and |c|...@>=
if (z<>0)or(x<>min_quarterword) then
begin z:=z+s+16;
repeat z:=z-16; g:=fam_fnt(z);
if g<>null_font then
@<Look at the list of characters starting with |x| in
font |g|; set |f| and |c| whenever
a better character is found; |goto found| as soon as a
large enough variant is encountered@>;
until z<16;
end
@ @<Look at the list of characters starting with |x|...@>=
begin y:=x;
if (qo(y)>=font_bc[g])and(qo(y)<=font_ec[g]) then
begin continue: q:=char_info(g)(y);
if char_exists(q) then
begin if char_tag(q)=ext_tag then
begin f:=g; c:=y; goto found;
end;
hd:=height_depth(q);
u:=char_height(g)(hd)+char_depth(g)(hd);
if u>w then
begin f:=g; c:=y; w:=u;
if u>=v then goto found;
end;
if char_tag(q)=list_tag then
begin y:=rem_byte(q); goto continue;
end;
end;
end;
end
@ Here is a subroutine that creates a new box, whose list contains a
single character, and whose width includes the italic correction for
that character. The height or depth of the box will be negative, if
the height or depth of the character is negative; thus, this routine
may deliver a slightly different result than |hpack| would produce.
@<Declare subprocedures for |var_delimiter|@>=
function char_box(@!f:internal_font_number;@!c:quarterword):pointer;
var q:four_quarters;
@!hd:eight_bits; {|height_depth| byte}
@!b,@!p:pointer; {the new box and its character node}
begin q:=char_info(f)(c); hd:=height_depth(q);
b:=new_null_box; width(b):=char_width(f)(q)+char_italic(f)(q);
height(b):=char_height(f)(hd); depth(b):=char_depth(f)(hd);
p:=get_avail; character(p):=c; font(p):=f; list_ptr(b):=p; char_box:=b;
end;
@ When the following code is executed, |char_tag(q)| will be equal to
|ext_tag| if and only if a built-up symbol is supposed to be returned.
@<Make variable |b| point to a box for |(f,c)|@>=
if char_tag(q)=ext_tag then
@<Construct an extensible character in a new box |b|,
using recipe |rem_byte(q)| and font |f|@>
else b:=char_box(f,c)
@ When we build an extensible character, it's handy to have the
following subroutine, which puts a given character on top
of the characters already in box |b|:
@<Declare subprocedures for |var_delimiter|@>=
procedure stack_into_box(@!b:pointer;@!f:internal_font_number;
@!c:quarterword);
var p:pointer; {new node placed into |b|}
begin p:=char_box(f,c); link(p):=list_ptr(b); list_ptr(b):=p;
height(b):=height(p);
end;
@ Another handy subroutine computes the height plus depth of
a given character:
@<Declare subprocedures for |var_delimiter|@>=
function height_plus_depth(@!f:internal_font_number;@!c:quarterword):scaled;
var q:four_quarters;
@!hd:eight_bits; {|height_depth| byte}
begin q:=char_info(f)(c); hd:=height_depth(q);
height_plus_depth:=char_height(f)(hd)+char_depth(f)(hd);
end;
@ @<Construct an extensible...@>=
begin b:=new_null_box;
type(b):=vlist_node;
r:=font_info[exten_base[f]+rem_byte(q)].qqqq;@/
@<Compute the minimum suitable height, |w|, and the corresponding
number of extension steps, |n|; also set |width(b)|@>;
c:=ext_bot(r);
if c<>min_quarterword then stack_into_box(b,f,c);
c:=ext_rep(r);
for m:=1 to n do stack_into_box(b,f,c);
c:=ext_mid(r);
if c<>min_quarterword then
begin stack_into_box(b,f,c); c:=ext_rep(r);
for m:=1 to n do stack_into_box(b,f,c);
end;
c:=ext_top(r);
if c<>min_quarterword then stack_into_box(b,f,c);
depth(b):=w-height(b);
end
@ The width of an extensible character is the width of the repeatable
module. If this module does not have positive height plus depth,
we don't use any copies of it, otherwise we use as few as possible
(in groups of two if there is a middle part).
@<Compute the minimum suitable height, |w|, and...@>=
c:=ext_rep(r); u:=height_plus_depth(f,c);
w:=0; q:=char_info(f)(c); width(b):=char_width(f)(q)+char_italic(f)(q);@/
c:=ext_bot(r);@+if c<>min_quarterword then w:=w+height_plus_depth(f,c);
c:=ext_mid(r);@+if c<>min_quarterword then w:=w+height_plus_depth(f,c);
c:=ext_top(r);@+if c<>min_quarterword then w:=w+height_plus_depth(f,c);
n:=0;
if u>0 then while w<v do
begin w:=w+u; incr(n);
if ext_mid(r)<>min_quarterword then w:=w+u;
end
@ The next subroutine is much simpler; it is used for numerators and
denominators of fractions as well as for displayed operators and
their limits above and below. It takes a given box~|b| and
changes it so that the new box is centered in a box of width~|w|.
The centering is done by putting \.{\\hss} glue at the left and right
of the list inside |b|, then packaging the new box; thus, the
actual box might not really be centered, if it already contains
infinite glue.
The given box might contain a single character whose italic correction
has been added to the width of the box; in this case a compensating
kern is inserted.
@p function rebox(@!b:pointer;@!w:scaled):pointer;
var p:pointer; {temporary register for list manipulation}
@!f:internal_font_number; {font in a one-character box}
@!v:scaled; {width of a character without italic correction}
begin if (width(b)<>w)and(list_ptr(b)<>null) then
begin if type(b)=vlist_node then b:=hpack(b,natural);
p:=list_ptr(b);
if (is_char_node(p))and(link(p)=null) then
begin f:=font(p); v:=char_width(f)(char_info(f)(character(p)));
if v<>width(b) then link(p):=new_kern(width(b)-v);
end;
free_node(b,box_node_size);
b:=new_glue(ss_glue); link(b):=p;
while link(p)<>null do p:=link(p);
link(p):=new_glue(ss_glue);
rebox:=hpack(b,w,exactly);
end
else begin width(b):=w; rebox:=b;
end;
end;
@ Here is a subroutine that creates a new glue specification from another
one that is expressed in `\.{mu}', given the value of the math unit.
@d mu_mult(#)==nx_plus_y(n,#,xn_over_d(#,f,@'200000))
@p function math_glue(@!g:pointer;@!m:scaled):pointer;
var p:pointer; {the new glue specification}
@!n:integer; {integer part of |m|}
@!f:scaled; {fraction part of |m|}
begin n:=x_over_n(m,@'200000); f:=remainder;@/
if f<0 then
begin decr(n); f:=f+@'200000;
end;
p:=get_node(glue_spec_size);
width(p):=mu_mult(width(g)); {convert \.{mu} to \.{pt}}
stretch_order(p):=stretch_order(g);
if stretch_order(p)=normal then stretch(p):=mu_mult(stretch(g))
else stretch(p):=stretch(g);
shrink_order(p):=shrink_order(g);
if shrink_order(p)=normal then shrink(p):=mu_mult(shrink(g))
else shrink(p):=shrink(g);
math_glue:=p;
end;
@ The |math_kern| subroutine removes |mu_glue| from a kern node, given
the value of the math unit.
@p procedure math_kern(@!p:pointer;@!m:scaled);
var @!n:integer; {integer part of |m|}
@!f:scaled; {fraction part of |m|}
begin if subtype(p)=mu_glue then
begin n:=x_over_n(m,@'200000); f:=remainder;@/
if f<0 then
begin decr(n); f:=f+@'200000;
end;
width(p):=mu_mult(width(p)); subtype(p):=explicit;
end;
end;
@ Sometimes it is necessary to destroy an mlist. The following
subroutine empties the current list, assuming that |abs(mode)=mmode|.
@p procedure flush_math;
begin flush_node_list(link(head)); flush_node_list(incompleat_noad);
link(head):=null; tail:=head; incompleat_noad:=null;
end;
@* \[36] Typesetting math formulas.
\TeX's most important routine for dealing with formulas is called
|mlist_to_hlist|. After a formula has been scanned and represented as an
mlist, this routine converts it to an hlist that can be placed into a box
or incorporated into the text of a paragraph. There are three implicit
parameters, passed in global variables: |cur_mlist| points to the first
node or noad in the given mlist (and it might be |null|); |cur_style| is a
style code; and |mlist_penalties| is |true| if penalty nodes for potential
line breaks are to be inserted into the resulting hlist. After
|mlist_to_hlist| has acted, |link(temp_head)| points to the translated hlist.
Since mlists can be inside mlists, the procedure is recursive. And since this
is not part of \TeX's inner loop, the program has been written in a manner
that stresses compactness over efficiency.
@^recursion@>
@<Glob...@>=
@!cur_mlist:pointer; {beginning of mlist to be translated}
@!cur_style:small_number; {style code at current place in the list}
@!cur_size:small_number; {size code corresponding to |cur_style|}
@!cur_mu:scaled; {the math unit width corresponding to |cur_size|}
@!mlist_penalties:boolean; {should |mlist_to_hlist| insert penalties?}
@ The recursion in |mlist_to_hlist| is due primarily to a subroutine
called |clean_box| that puts a given noad field into a box using a given
math style; |mlist_to_hlist| can call |clean_box|, which can call
|mlist_to_hlist|.
@^recursion@>
The box returned by |clean_box| is ``clean'' in the
sense that its |shift_amount| is zero.
@p procedure@?mlist_to_hlist; forward;@t\2@>@/
function clean_box(@!p:pointer;@!s:small_number):pointer;
label found;
var q:pointer; {beginning of a list to be boxed}
@!save_style:small_number; {|cur_style| to be restored}
@!x:pointer; {box to be returned}
@!r:pointer; {temporary pointer}
begin case math_type(p) of
math_char: begin cur_mlist:=new_noad; mem[nucleus(cur_mlist)]:=mem[p];
end;
sub_box: begin q:=info(p); goto found;
end;
sub_mlist: cur_mlist:=info(p);
othercases begin q:=new_null_box; goto found;
end
endcases;@/
save_style:=cur_style; cur_style:=s; mlist_penalties:=false;@/
mlist_to_hlist; q:=link(temp_head); {recursive call}
cur_style:=save_style; {restore the style}
@<Set up the values of |cur_size| and |cur_mu|, based on |cur_style|@>;
found: if is_char_node(q)or(q=null) then x:=hpack(q,natural)
else if (link(q)=null)and(type(q)<=vlist_node)and(shift_amount(q)=0) then
x:=q {it's already clean}
else x:=hpack(q,natural);
@<Simplify a trivial box@>;
clean_box:=x;
end;
@ Here we save memory space in a common case.
@<Simplify a trivial box@>=
q:=list_ptr(x);
if is_char_node(q) then
begin r:=link(q);
if r<>null then if link(r)=null then if not is_char_node(r) then
if type(r)=kern_node then {unneeded italic correction}
begin free_node(r,small_node_size); link(q):=null;
end;
end
@ It is convenient to have a procedure that converts a |math_char|
field to an ``unpacked'' form. The |fetch| routine sets |cur_f|, |cur_c|,
and |cur_i| to the font code, character code, and character information bytes of
a given noad field. It also takes care of issuing error messages for
nonexistent characters; in such cases, |char_exists(cur_i)| will be |false|
after |fetch| has acted, and the field will also have been reset to |empty|.
@p procedure fetch(@!a:pointer); {unpack the |math_char| field |a|}
begin cur_c:=character(a); cur_f:=fam_fnt(fam(a)+cur_size);
if cur_f=null_font then
@<Complain about an undefined family and set |cur_i| null@>
else begin if (qo(cur_c)>=font_bc[cur_f])and(qo(cur_c)<=font_ec[cur_f]) then
cur_i:=char_info(cur_f)(cur_c)
else cur_i:=null_character;
if not(char_exists(cur_i)) then
begin char_warning(cur_f,qo(cur_c));
math_type(a):=empty; cur_i:=null_character;
end;
end;
end;
@ @<Complain about an undefined family...@>=
begin print_err(""); print_size(cur_size); print_char(" ");
print_int(fam(a)); print(" is undefined (character ");
print_ASCII(qo(cur_c)); print_char(")");
help4("Somewhere in the math formula just ended, you used the")@/
("stated character from an undefined font family. For example,")@/
("plain TeX doesn't allow \it or \sl in subscripts. Proceed,")@/
("and I'll try to forget that I needed that character.");
error; cur_i:=null_character; math_type(a):=empty;
end
@ The outputs of |fetch| are placed in global variables.
@<Glob...@>=
@!cur_f:internal_font_number; {the |font| field of a |math_char|}
@!cur_c:quarterword; {the |character| field of a |math_char|}
@!cur_i:four_quarters; {the |char_info| of a |math_char|,
or a lig/kern instruction}
@ We need to do a lot of different things, so |mlist_to_hlist| makes two
passes over the given mlist.
The first pass does most of the processing: It removes ``mu'' spacing from
glue, it recursively evaluates all subsidiary mlists so that only the
top-level mlist remains to be handled, it puts fractions and square roots
and such things into boxes, it attaches subscripts and superscripts, and
it computes the overall height and depth of the top-level mlist so that
the size of delimiters for a |left_noad| and a |right_noad| will be known.
The hlist resulting from each noad is recorded in that noad's |new_hlist|
field, an integer field that replaces the |nucleus| or |thickness|.
@^recursion@>
The second pass eliminates all noads and inserts the correct glue and
penalties between nodes.
@d new_hlist(#)==mem[nucleus(#)].int {the translation of an mlist}
@ Here is the overall plan of |mlist_to_hlist|, and the list of its
local variables.
@d done_with_noad=80 {go here when a noad has been fully translated}
@d done_with_node=81 {go here when a node has been fully converted}
@d check_dimensions=82 {go here to update |max_h| and |max_d|}
@d delete_q=83 {go here to delete |q| and move to the next node}
@p@t\4@>@<Declare math construction procedures@>
procedure mlist_to_hlist;
label reswitch, check_dimensions, done_with_noad, done_with_node, delete_q,
done;
var mlist:pointer; {beginning of the given list}
@!penalties:boolean; {should penalty nodes be inserted?}
@!style:small_number; {the given style}
@!save_style:small_number; {holds |cur_style| during recursion}
@!q:pointer; {runs through the mlist}
@!r:pointer; {the most recent noad preceding |q|}
@!r_type:small_number; {the |type| of noad |r|, or |op_noad| if |r=null|}
@!t:small_number; {the effective |type| of noad |q| during the second pass}
@!p,@!x,@!y,@!z: pointer; {temporary registers for list construction}
@!pen:integer; {a penalty to be inserted}
@!s:small_number; {the size of a noad to be deleted}
@!max_h,@!max_d:scaled; {maximum height and depth of the list translated so far}
@!delta:scaled; {offset between subscript and superscript}
begin mlist:=cur_mlist; penalties:=mlist_penalties;
style:=cur_style; {tuck global parameters away as local variables}
q:=mlist; r:=null; r_type:=op_noad; max_h:=0; max_d:=0;
@<Set up the values of |cur_size| and |cur_mu|, based on |cur_style|@>;
while q<>null do @<Process node-or-noad |q| as much as possible in preparation
for the second pass of |mlist_to_hlist|, then move to the next
item in the mlist@>;
@<Convert \(a)a final |bin_noad| to an |ord_noad|@>;
@<Make a second pass over the mlist, removing all noads and inserting the
proper spacing and penalties@>;
end;
@ We use the fact that no character nodes appear in an mlist, hence
the field |type(q)| is always present.
@<Process node-or-noad...@>=
begin @<Do first-pass processing based on |type(q)|; |goto done_with_noad|
if a noad has been fully processed, |goto check_dimensions| if it
has been translated into |new_hlist(q)|, or |goto done_with_node|
if a node has been fully processed@>;
check_dimensions: z:=hpack(new_hlist(q),natural);
if height(z)>max_h then max_h:=height(z);
if depth(z)>max_d then max_d:=depth(z);
free_node(z,box_node_size);
done_with_noad: r:=q; r_type:=type(r);
if r_type=right_noad then
begin r_type:=left_noad; cur_style:=style; @<Set up the values...@>;
end;
done_with_node: q:=link(q);
end
@ One of the things we must do on the first pass is change a |bin_noad| to
an |ord_noad| if the |bin_noad| is not in the context of a binary operator.
The values of |r| and |r_type| make this fairly easy.
@<Do first-pass processing...@>=
reswitch: delta:=0;
case type(q) of
bin_noad: case r_type of
bin_noad,op_noad,rel_noad,open_noad,punct_noad,left_noad:
begin type(q):=ord_noad; goto reswitch;
end;
othercases do_nothing
endcases;
rel_noad,close_noad,punct_noad,right_noad: begin@t@>@;@/
@<Convert \(a)a final |bin_noad| to an |ord_noad|@>;
if type(q)=right_noad then goto done_with_noad;
end;
@t\4@>@<Cases for noads that can follow a |bin_noad|@>@;
@t\4@>@<Cases for nodes that can appear in an mlist, after which we
|goto done_with_node|@>@;
othercases confusion("mlist1")
@:this can't happen mlist1}{\quad mlist1@>
endcases;@/
@<Convert \(n)|nucleus(q)| to an hlist and attach the sub/superscripts@>
@ @<Convert \(a)a final |bin_noad| to an |ord_noad|@>=
if r_type=bin_noad then type(r):=ord_noad
@ @<Cases for nodes that can appear in an mlist...@>=
style_node: begin cur_style:=subtype(q);
@<Set up the values of |cur_size| and |cur_mu|, based on |cur_style|@>;
goto done_with_node;
end;
choice_node: @<Change this node to a style node followed by the correct choice,
then |goto done_with_node|@>;
ins_node,mark_node,adjust_node,
whatsit_node,penalty_node,disc_node: goto done_with_node;
rule_node: begin if height(q)>max_h then max_h:=height(q);
if depth(q)>max_d then max_d:=depth(q); goto done_with_node;
end;
glue_node: begin @<Convert \(m)math glue to ordinary glue@>;
goto done_with_node;
end;
kern_node: begin math_kern(q,cur_mu); goto done_with_node;
end;
@ @d choose_mlist(#)==begin p:=#(q); #(q):=null;@+end
@<Change this node to a style node...@>=
begin case cur_style div 2 of
0: choose_mlist(display_mlist); {|display_style=0|}
1: choose_mlist(text_mlist); {|text_style=2|}
2: choose_mlist(script_mlist); {|script_style=4|}
3: choose_mlist(script_script_mlist); {|script_script_style=6|}
end; {there are no other cases}
flush_node_list(display_mlist(q));
flush_node_list(text_mlist(q));
flush_node_list(script_mlist(q));
flush_node_list(script_script_mlist(q));@/
type(q):=style_node; subtype(q):=cur_style; width(q):=0; depth(q):=0;
if p<>null then
begin z:=link(q); link(q):=p;
while link(p)<>null do p:=link(p);
link(p):=z;
end;
goto done_with_node;
end
@ Conditional math glue (`\.{\\nonscript}') results in a |glue_node|
pointing to |zero_glue|, with |subtype(q)=cond_math_glue|; in such a case
the node following will be eliminated if it is a glue or kern node and if the
current size is different from |text_size|. Unconditional math glue
(`\.{\\muskip}') is converted to normal glue by multiplying the dimensions
by |cur_mu|.
@!@:non_script_}{\.{\\nonscript} primitive@>
@<Convert \(m)math glue to ordinary glue@>=
if subtype(q)=mu_glue then
begin x:=glue_ptr(q);
y:=math_glue(x,cur_mu); delete_glue_ref(x); glue_ptr(q):=y;
subtype(q):=normal;
end
else if (cur_size<>text_size)and(subtype(q)=cond_math_glue) then
begin p:=link(q);
if p<>null then if (type(p)=glue_node)or(type(p)=kern_node) then
begin link(q):=link(p); link(p):=null; flush_node_list(p);
end;
end
@ @<Cases for noads that can follow a |bin_noad|@>=
left_noad: goto done_with_noad;
fraction_noad: begin make_fraction(q); goto check_dimensions;
end;
op_noad: begin delta:=make_op(q);
if subtype(q)=limits then goto check_dimensions;
end;
ord_noad: make_ord(q);
open_noad,inner_noad: do_nothing;
radical_noad: make_radical(q);
over_noad: make_over(q);
under_noad: make_under(q);
accent_noad: make_math_accent(q);
vcenter_noad: make_vcenter(q);
@ Most of the actual construction work of |mlist_to_hlist| is done
by procedures with names
like |make_fraction|, |make_radical|, etc. To illustrate
the general setup of such procedures, let's begin with a couple of
simple ones.
@<Declare math...@>=
procedure make_over(@!q:pointer);
begin info(nucleus(q)):=@|
overbar(clean_box(nucleus(q),cramped_style(cur_style)),@|
3*default_rule_thickness,default_rule_thickness);
math_type(nucleus(q)):=sub_box;
end;
@ @<Declare math...@>=
procedure make_under(@!q:pointer);
var p,@!x,@!y: pointer; {temporary registers for box construction}
@!delta:scaled; {overall height plus depth}
begin x:=clean_box(nucleus(q),cur_style);
p:=new_kern(3*default_rule_thickness); link(x):=p;
link(p):=fraction_rule(default_rule_thickness);
y:=vpack(x,natural);
delta:=height(y)+depth(y)+default_rule_thickness;
height(y):=height(x); depth(y):=delta-height(y);
info(nucleus(q)):=y; math_type(nucleus(q)):=sub_box;
end;
@ @<Declare math...@>=
procedure make_vcenter(@!q:pointer);
var v:pointer; {the box that should be centered vertically}
@!delta:scaled; {its height plus depth}
begin v:=info(nucleus(q));
if type(v)<>vlist_node then confusion("vcenter");
@:this can't happen vcenter}{\quad vcenter@>
delta:=height(v)+depth(v);
height(v):=axis_height(cur_size)+half(delta);
depth(v):=delta-height(v);
end;
@ According to the rules in the \.{DVI} file specifications, we ensure alignment
@^square roots@>
between a square root sign and the rule above its nucleus by assuming that the
baseline of the square-root symbol is the same as the bottom of the rule. The
height of the square-root symbol will be the thickness of the rule, and the
depth of the square-root symbol should exceed or equal the height-plus-depth
of the nucleus plus a certain minimum clearance~|clr|. The symbol will be
placed so that the actual clearance is |clr| plus half the excess.
@<Declare math...@>=
procedure make_radical(@!q:pointer);
var x,@!y:pointer; {temporary registers for box construction}
@!delta,@!clr:scaled; {dimensions involved in the calculation}
begin x:=clean_box(nucleus(q),cramped_style(cur_style));
if cur_style<text_style then {display style}
clr:=default_rule_thickness+(abs(math_x_height(cur_size)) div 4)
else begin clr:=default_rule_thickness; clr:=clr + (abs(clr) div 4);
end;
y:=var_delimiter(left_delimiter(q),cur_size,height(x)+depth(x)+clr+
default_rule_thickness);
delta:=depth(y)-(height(x)+depth(x)+clr);
if delta>0 then clr:=clr+half(delta); {increase the actual clearance}
shift_amount(y):=-(height(x)+clr);
link(y):=overbar(x,clr,height(y));
info(nucleus(q)):=hpack(y,natural); math_type(nucleus(q)):=sub_box;
end;
@ Slants are not considered when placing accents in math mode. The accenter is
centered over the accentee, and the accent width is treated as zero with
respect to the size of the final box.
@<Declare math...@>=
procedure make_math_accent(@!q:pointer);
label done,done1;
var p,@!x,@!y:pointer; {temporary registers for box construction}
@!a:integer; {address of lig/kern instruction}
@!c:quarterword; {accent character}
@!f:internal_font_number; {its font}
@!i:four_quarters; {its |char_info|}
@!s:scaled; {amount to skew the accent to the right}
@!h:scaled; {height of character being accented}
@!delta:scaled; {space to remove between accent and accentee}
@!w:scaled; {width of the accentee, not including sub/superscripts}
begin fetch(accent_chr(q));
if char_exists(cur_i) then
begin i:=cur_i; c:=cur_c; f:=cur_f;@/
@<Compute the amount of skew@>;
x:=clean_box(nucleus(q),cramped_style(cur_style)); w:=width(x); h:=height(x);
@<Switch to a larger accent if available and appropriate@>;
if h<x_height(f) then delta:=h@+else delta:=x_height(f);
if (math_type(supscr(q))<>empty)or(math_type(subscr(q))<>empty) then
if math_type(nucleus(q))=math_char then
@<Swap the subscript and superscript into box |x|@>;
y:=char_box(f,c);
shift_amount(y):=s+half(w-width(y));
width(y):=0; p:=new_kern(-delta); link(p):=x; link(y):=p;
y:=vpack(y,natural); width(y):=width(x);
if height(y)<h then @<Make the height of box |y| equal to |h|@>;
info(nucleus(q)):=y;
math_type(nucleus(q)):=sub_box;
end;
end;
@ @<Make the height of box |y|...@>=
begin p:=new_kern(h-height(y)); link(p):=list_ptr(y); list_ptr(y):=p;
height(y):=h;
end
@ @<Switch to a larger accent if available and appropriate@>=
loop@+ begin if char_tag(i)<>list_tag then goto done;
y:=rem_byte(i);
i:=char_info(f)(y);
if not char_exists(i) then goto done;
if char_width(f)(i)>w then goto done;
c:=y;
end;
done:
@ @<Compute the amount of skew@>=
s:=0;
if math_type(nucleus(q))=math_char then
begin fetch(nucleus(q));
if char_tag(cur_i)=lig_tag then
begin a:=lig_kern_start(cur_f)(cur_i);
cur_i:=font_info[a].qqqq;
if skip_byte(cur_i)>stop_flag then
begin a:=lig_kern_restart(cur_f)(cur_i);
cur_i:=font_info[a].qqqq;
end;
loop@+ begin if qo(next_char(cur_i))=skew_char[cur_f] then
begin if op_byte(cur_i)>=kern_flag then
if skip_byte(cur_i)<=stop_flag then s:=char_kern(cur_f)(cur_i);
goto done1;
end;
if skip_byte(cur_i)>=stop_flag then goto done1;
a:=a+qo(skip_byte(cur_i))+1;
cur_i:=font_info[a].qqqq;
end;
end;
end;
done1:
@ @<Swap the subscript and superscript into box |x|@>=
begin flush_node_list(x); x:=new_noad;
mem[nucleus(x)]:=mem[nucleus(q)];
mem[supscr(x)]:=mem[supscr(q)];
mem[subscr(x)]:=mem[subscr(q)];@/
mem[supscr(q)].hh:=empty_field;
mem[subscr(q)].hh:=empty_field;@/
math_type(nucleus(q)):=sub_mlist; info(nucleus(q)):=x;
x:=clean_box(nucleus(q),cur_style); delta:=delta+height(x)-h; h:=height(x);
end
@ The |make_fraction| procedure is a bit different because it sets
|new_hlist(q)| directly rather than making a sub-box.
@<Declare math...@>=
procedure make_fraction(@!q:pointer);
var p,@!v,@!x,@!y,@!z:pointer; {temporary registers for box construction}
@!delta,@!delta1,@!delta2,@!shift_up,@!shift_down,@!clr:scaled;
{dimensions for box calculations}
begin if thickness(q)=default_code then thickness(q):=default_rule_thickness;
@<Create equal-width boxes |x| and |z| for the numerator and denominator,
and compute the default amounts |shift_up| and |shift_down| by which they
are displaced from the baseline@>;
if thickness(q)=0 then @<Adjust \(s)|shift_up| and |shift_down| for the case
of no fraction line@>
else @<Adjust \(s)|shift_up| and |shift_down| for the case of a fraction line@>;
@<Construct a vlist box for the fraction, according to |shift_up| and
|shift_down|@>;
@<Put the \(f)fraction into a box with its delimiters, and make |new_hlist(q)|
point to it@>;
end;
@ @<Create equal-width boxes |x| and |z| for the numerator and denom...@>=
x:=clean_box(numerator(q),num_style(cur_style));
z:=clean_box(denominator(q),denom_style(cur_style));
if width(x)<width(z) then x:=rebox(x,width(z))
else z:=rebox(z,width(x));
if cur_style<text_style then {display style}
begin shift_up:=num1(cur_size); shift_down:=denom1(cur_size);
end
else begin shift_down:=denom2(cur_size);
if thickness(q)<>0 then shift_up:=num2(cur_size)
else shift_up:=num3(cur_size);
end
@ The numerator and denominator must be separated by a certain minimum
clearance, called |clr| in the following program. The difference between
|clr| and the actual clearance is twice |delta|.
@<Adjust \(s)|shift_up| and |shift_down| for the case of no fraction line@>=
begin if cur_style<text_style then clr:=7*default_rule_thickness
else clr:=3*default_rule_thickness;
delta:=half(clr-((shift_up-depth(x))-(height(z)-shift_down)));
if delta>0 then
begin shift_up:=shift_up+delta;
shift_down:=shift_down+delta;
end;
end
@ In the case of a fraction line, the minimum clearance depends on the actual
thickness of the line.
@<Adjust \(s)|shift_up| and |shift_down| for the case of a fraction line@>=
begin if cur_style<text_style then clr:=3*thickness(q)
else clr:=thickness(q);
delta:=half(thickness(q));
delta1:=clr-((shift_up-depth(x))-(axis_height(cur_size)+delta));
delta2:=clr-((axis_height(cur_size)-delta)-(height(z)-shift_down));
if delta1>0 then shift_up:=shift_up+delta1;
if delta2>0 then shift_down:=shift_down+delta2;
end
@ @<Construct a vlist box for the fraction...@>=
v:=new_null_box; type(v):=vlist_node;
height(v):=shift_up+height(x); depth(v):=depth(z)+shift_down;
width(v):=width(x); {this also equals |width(z)|}
if thickness(q)=0 then
begin p:=new_kern((shift_up-depth(x))-(height(z)-shift_down));
link(p):=z;
end
else begin y:=fraction_rule(thickness(q));@/
p:=new_kern((axis_height(cur_size)-delta)-@|(height(z)-shift_down));@/
link(y):=p; link(p):=z;@/
p:=new_kern((shift_up-depth(x))-(axis_height(cur_size)+delta));
link(p):=y;
end;
link(x):=p; list_ptr(v):=x
@ @<Put the \(f)fraction into a box with its delimiters...@>=
if cur_style<text_style then delta:=delim1(cur_size)
else delta:=delim2(cur_size);
x:=var_delimiter(left_delimiter(q), cur_size, delta); link(x):=v;@/
z:=var_delimiter(right_delimiter(q), cur_size, delta); link(v):=z;@/
new_hlist(q):=hpack(x,natural)
@ If the nucleus of an |op_noad| is a single character, it is to be
centered vertically with respect to the axis, after first being enlarged
(via a character list in the font) if we are in display style. The normal
convention for placing displayed limits is to put them above and below the
operator in display style.
The italic correction is removed from the character if there is a subscript
and the limits are not being displayed. The |make_op|
routine returns the value that should be used as an offset between
subscript and superscript.
After |make_op| has acted, |subtype(q)| will be |limits| if and only if
the limits have been set above and below the operator. In that case,
|new_hlist(q)| will already contain the desired final box.
@<Declare math...@>=
function make_op(@!q:pointer):scaled;
var delta:scaled; {offset between subscript and superscript}
@!p,@!v,@!x,@!y,@!z:pointer; {temporary registers for box construction}
@!c:quarterword;@+@!i:four_quarters; {registers for character examination}
@!shift_up,@!shift_down:scaled; {dimensions for box calculation}
begin if (subtype(q)=normal)and(cur_style<text_style) then
subtype(q):=limits;
if math_type(nucleus(q))=math_char then
begin fetch(nucleus(q));
if (cur_style<text_style)and(char_tag(cur_i)=list_tag) then {make it larger}
begin c:=rem_byte(cur_i); i:=char_info(cur_f)(c);
if char_exists(i) then
begin cur_c:=c; cur_i:=i; character(nucleus(q)):=c;
end;
end;
delta:=char_italic(cur_f)(cur_i); x:=clean_box(nucleus(q),cur_style);
if (math_type(subscr(q))<>empty)and(subtype(q)<>limits) then
width(x):=width(x)-delta; {remove italic correction}
shift_amount(x):=half(height(x)-depth(x)) - axis_height(cur_size);
{center vertically}
math_type(nucleus(q)):=sub_box; info(nucleus(q)):=x;
end
else delta:=0;
if subtype(q)=limits then
@<Construct a box with limits above and below it, skewed by |delta|@>;
make_op:=delta;
end;
@ The following program builds a vlist box |v| for displayed limits. The
width of the box is not affected by the fact that the limits may be skewed.
@<Construct a box with limits above and below it...@>=
begin x:=clean_box(supscr(q),sup_style(cur_style));
y:=clean_box(nucleus(q),cur_style);
z:=clean_box(subscr(q),sub_style(cur_style));
v:=new_null_box; type(v):=vlist_node; width(v):=width(y);
if width(x)>width(v) then width(v):=width(x);
if width(z)>width(v) then width(v):=width(z);
x:=rebox(x,width(v)); y:=rebox(y,width(v)); z:=rebox(z,width(v));@/
shift_amount(x):=half(delta); shift_amount(z):=-shift_amount(x);
height(v):=height(y); depth(v):=depth(y);
@<Attach the limits to |y| and adjust |height(v)|, |depth(v)| to
account for their presence@>;
new_hlist(q):=v;
end
@ We use |shift_up| and |shift_down| in the following program for the
amount of glue between the displayed operator |y| and its limits |x| and
|z|. The vlist inside box |v| will consist of |x| followed by |y| followed
by |z|, with kern nodes for the spaces between and around them.
@<Attach the limits to |y| and adjust |height(v)|, |depth(v)|...@>=
if math_type(supscr(q))=empty then
begin free_node(x,box_node_size); list_ptr(v):=y;
end
else begin shift_up:=big_op_spacing3-depth(x);
if shift_up<big_op_spacing1 then shift_up:=big_op_spacing1;
p:=new_kern(shift_up); link(p):=y; link(x):=p;@/
p:=new_kern(big_op_spacing5); link(p):=x; list_ptr(v):=p;
height(v):=height(v)+big_op_spacing5+height(x)+depth(x)+shift_up;
end;
if math_type(subscr(q))=empty then free_node(z,box_node_size)
else begin shift_down:=big_op_spacing4-height(z);
if shift_down<big_op_spacing2 then shift_down:=big_op_spacing2;
p:=new_kern(shift_down); link(y):=p; link(p):=z;@/
p:=new_kern(big_op_spacing5); link(z):=p;
depth(v):=depth(v)+big_op_spacing5+height(z)+depth(z)+shift_down;
end
@ A ligature found in a math formula does not create a |ligature_node|, because
there is no question of hyphenation afterwards; the ligature will simply be
stored in an ordinary |char_node|, after residing in an |ord_noad|.
The |math_type| is converted to |math_text_char| here if we would not want to
apply an italic correction to the current character unless it belongs
to a math font (i.e., a font with |space=0|).
No boundary characters enter into these ligatures.
@<Declare math...@>=
procedure make_ord(@!q:pointer);
label restart,exit;
var a:integer; {address of lig/kern instruction}
@!p,@!r:pointer; {temporary registers for list manipulation}
begin restart:@t@>@;@/
if math_type(subscr(q))=empty then if math_type(supscr(q))=empty then
if math_type(nucleus(q))=math_char then
begin p:=link(q);
if p<>null then if (type(p)>=ord_noad)and(type(p)<=punct_noad) then
if math_type(nucleus(p))=math_char then
if fam(nucleus(p))=fam(nucleus(q)) then
begin math_type(nucleus(q)):=math_text_char;
fetch(nucleus(q));
if char_tag(cur_i)=lig_tag then
begin a:=lig_kern_start(cur_f)(cur_i);
cur_c:=character(nucleus(p));
cur_i:=font_info[a].qqqq;
if skip_byte(cur_i)>stop_flag then
begin a:=lig_kern_restart(cur_f)(cur_i);
cur_i:=font_info[a].qqqq;
end;
loop@+ begin @<If instruction |cur_i| is a kern with |cur_c|, attach
the kern after~|q|; or if it is a ligature with |cur_c|, combine
noads |q| and~|p| appropriately; then |return| if the cursor has
moved past a noad, or |goto restart|@>;
if skip_byte(cur_i)>=stop_flag then return;
a:=a+qo(skip_byte(cur_i))+1;
cur_i:=font_info[a].qqqq;
end;
end;
end;
end;
exit:end;
@ Note that a ligature between an |ord_noad| and another kind of noad
is replaced by an |ord_noad|, when the two noads collapse into one.
But we could make a parenthesis (say) change shape when it follows
certain letters. Presumably a font designer will define such
ligatures only when this convention makes sense.
\chardef\?='174 % vertical line to indicate character retention
@<If instruction |cur_i| is a kern with |cur_c|, ...@>=
if next_char(cur_i)=cur_c then if skip_byte(cur_i)<=stop_flag then
if op_byte(cur_i)>=kern_flag then
begin p:=new_kern(char_kern(cur_f)(cur_i));
link(p):=link(q); link(q):=p; return;
end
else begin check_interrupt; {allow a way out of infinite ligature loop}
case op_byte(cur_i) of
qi(1),qi(5): character(nucleus(q)):=rem_byte(cur_i); {\.{=:\?}, \.{=:\?>}}
qi(2),qi(6): character(nucleus(p)):=rem_byte(cur_i); {\.{\?=:}, \.{\?=:>}}
qi(3),qi(7),qi(11):begin r:=new_noad; {\.{\?=:\?}, \.{\?=:\?>}, \.{\?=:\?>>}}
character(nucleus(r)):=rem_byte(cur_i);
fam(nucleus(r)):=fam(nucleus(q));@/
link(q):=r; link(r):=p;
if op_byte(cur_i)<qi(11) then math_type(nucleus(r)):=math_char
else math_type(nucleus(r)):=math_text_char; {prevent combination}
end;
othercases begin link(q):=link(p);
character(nucleus(q)):=rem_byte(cur_i); {\.{=:}}
mem[subscr(q)]:=mem[subscr(p)]; mem[supscr(q)]:=mem[supscr(p)];@/
free_node(p,noad_size);
end
endcases;
if op_byte(cur_i)>qi(3) then return;
math_type(nucleus(q)):=math_char; goto restart;
end
@ When we get to the following part of the program, we have ``fallen through''
from cases that did not lead to |check_dimensions| or |done_with_noad| or
|done_with_node|. Thus, |q|~points to a noad whose nucleus may need to be
converted to an hlist, and whose subscripts and superscripts need to be
appended if they are present.
If |nucleus(q)| is not a |math_char|, the variable |delta| is the amount
by which a superscript should be moved right with respect to a subscript
when both are present.
@^subscripts@>
@^superscripts@>
@<Convert \(n)|nucleus(q)| to an hlist and attach the sub/superscripts@>=
case math_type(nucleus(q)) of
math_char, math_text_char:
@<Create a character node |p| for |nucleus(q)|, possibly followed
by a kern node for the italic correction, and set |delta| to the
italic correction if a subscript is present@>;
empty: p:=null;
sub_box: p:=info(nucleus(q));
sub_mlist: begin cur_mlist:=info(nucleus(q)); save_style:=cur_style;
mlist_penalties:=false; mlist_to_hlist; {recursive call}
@^recursion@>
cur_style:=save_style; @<Set up the values...@>;
p:=hpack(link(temp_head),natural);
end;
othercases confusion("mlist2")
@:this can't happen mlist2}{\quad mlist2@>
endcases;@/
new_hlist(q):=p;
if (math_type(subscr(q))=empty)and(math_type(supscr(q))=empty) then
goto check_dimensions;
make_scripts(q,delta)
@ @<Create a character node |p| for |nucleus(q)|...@>=
begin fetch(nucleus(q));
if char_exists(cur_i) then
begin delta:=char_italic(cur_f)(cur_i); p:=new_character(cur_f,qo(cur_c));
if (math_type(nucleus(q))=math_text_char)and(space(cur_f)<>0) then
delta:=0; {no italic correction in mid-word of text font}
if (math_type(subscr(q))=empty)and(delta<>0) then
begin link(p):=new_kern(delta); delta:=0;
end;
end
else p:=null;
end
@ The purpose of |make_scripts(q,delta)| is to attach the subscript and/or
superscript of noad |q| to the list that starts at |new_hlist(q)|,
given that the subscript and superscript aren't both empty. The superscript
will appear to the right of the subscript by a given distance |delta|.
We set |shift_down| and |shift_up| to the minimum amounts to shift the
baseline of subscripts and superscripts based on the given nucleus.
@<Declare math...@>=
procedure make_scripts(@!q:pointer;@!delta:scaled);
var p,@!x,@!y,@!z:pointer; {temporary registers for box construction}
@!shift_up,@!shift_down,@!clr:scaled; {dimensions in the calculation}
@!t:small_number; {subsidiary size code}
begin p:=new_hlist(q);
if is_char_node(p) then
begin shift_up:=0; shift_down:=0;
end
else begin z:=hpack(p,natural);
if cur_style<script_style then t:=script_size@+else t:=script_script_size;
shift_up:=height(z)-sup_drop(t);
shift_down:=depth(z)+sub_drop(t);
free_node(z,box_node_size);
end;
if math_type(supscr(q))=empty then
@<Construct a subscript box |x| when there is no superscript@>
else begin @<Construct a superscript box |x|@>;
if math_type(subscr(q))=empty then shift_amount(x):=-shift_up
else @<Construct a sub/superscript combination box |x|, with the
superscript offset by |delta|@>;
end;
if new_hlist(q)=null then new_hlist(q):=x
else begin p:=new_hlist(q);
while link(p)<>null do p:=link(p);
link(p):=x;
end;
end;
@ When there is a subscript without a superscript, the top of the subscript
should not exceed the baseline plus four-fifths of the x-height.
@<Construct a subscript box |x| when there is no superscript@>=
begin x:=clean_box(subscr(q),sub_style(cur_style));
width(x):=width(x)+script_space;
if shift_down<sub1(cur_size) then shift_down:=sub1(cur_size);
clr:=height(x)-(abs(math_x_height(cur_size)*4) div 5);
if shift_down<clr then shift_down:=clr;
shift_amount(x):=shift_down;
end
@ The bottom of a superscript should never descend below the baseline plus
one-fourth of the x-height.
@<Construct a superscript box |x|@>=
begin x:=clean_box(supscr(q),sup_style(cur_style));
width(x):=width(x)+script_space;
if odd(cur_style) then clr:=sup3(cur_size)
else if cur_style<text_style then clr:=sup1(cur_size)
else clr:=sup2(cur_size);
if shift_up<clr then shift_up:=clr;
clr:=depth(x)+(abs(math_x_height(cur_size)) div 4);
if shift_up<clr then shift_up:=clr;
end
@ When both subscript and superscript are present, the subscript must be
separated from the superscript by at least four times |default_rule_thickness|.
If this condition would be violated, the subscript moves down, after which
both subscript and superscript move up so that the bottom of the superscript
is at least as high as the baseline plus four-fifths of the x-height.
@<Construct a sub/superscript combination box |x|...@>=
begin y:=clean_box(subscr(q),sub_style(cur_style));
width(y):=width(y)+script_space;
if shift_down<sub2(cur_size) then shift_down:=sub2(cur_size);
clr:=4*default_rule_thickness-
((shift_up-depth(x))-(height(y)-shift_down));
if clr>0 then
begin shift_down:=shift_down+clr;
clr:=(abs(math_x_height(cur_size)*4) div 5)-(shift_up-depth(x));
if clr>0 then
begin shift_up:=shift_up+clr;
shift_down:=shift_down-clr;
end;
end;
shift_amount(x):=delta; {superscript is |delta| to the right of the subscript}
p:=new_kern((shift_up-depth(x))-(height(y)-shift_down)); link(x):=p; link(p):=y;
x:=vpack(x,natural); shift_amount(x):=shift_down;
end
@ We have now tied up all the loose ends of the first pass of |mlist_to_hlist|.
The second pass simply goes through and hooks everything together with the
proper glue and penalties. It also handles the |left_noad| and |right_noad| that
might be present, since |max_h| and |max_d| are now known. Variable |p| points
to a node at the current end of the final hlist.
@<Make a second pass over the mlist, ...@>=
p:=temp_head; link(p):=null; q:=mlist; r_type:=0; cur_style:=style;
@<Set up the values of |cur_size| and |cur_mu|, based on |cur_style|@>;
while q<>null do
begin @<If node |q| is a style node, change the style and |goto delete_q|;
otherwise if it is not a noad, put it into the hlist,
advance |q|, and |goto done|; otherwise set |s| to the size
of noad |q|, set |t| to the associated type (|ord_noad..
inner_noad|), and set |pen| to the associated penalty@>;
@<Append inter-element spacing based on |r_type| and |t|@>;
@<Append any |new_hlist| entries for |q|, and any appropriate penalties@>;
if type(q)=right_noad then t:=open_noad;
r_type:=t;
delete_q: r:=q; q:=link(q); free_node(r,s);
done: end
@ Just before doing the big |case| switch in the second pass, the program
sets up default values so that most of the branches are short.
@<If node |q| is a style node, change the style...@>=
t:=ord_noad; s:=noad_size; pen:=inf_penalty;
case type(q) of
op_noad,open_noad,close_noad,punct_noad,inner_noad: t:=type(q);
bin_noad: begin t:=bin_noad; pen:=bin_op_penalty;
end;
rel_noad: begin t:=rel_noad; pen:=rel_penalty;
end;
ord_noad,vcenter_noad,over_noad,under_noad: do_nothing;
radical_noad: s:=radical_noad_size;
accent_noad: s:=accent_noad_size;
fraction_noad: s:=fraction_noad_size;
left_noad,right_noad: t:=make_left_right(q,style,max_d,max_h);
style_node: @<Change the current style and |goto delete_q|@>;
whatsit_node,penalty_node,rule_node,disc_node,adjust_node,ins_node,mark_node,
glue_node,kern_node:@t@>@;@/
begin link(p):=q; p:=q; q:=link(q); link(p):=null; goto done;
end;
othercases confusion("mlist3")
@:this can't happen mlist3}{\quad mlist3@>
endcases
@ The |make_left_right| function constructs a left or right delimiter of
the required size and returns the value |open_noad| or |close_noad|. The
|right_noad| and |left_noad| will both be based on the original |style|,
so they will have consistent sizes.
We use the fact that |right_noad-left_noad=close_noad-open_noad|.
@<Declare math...@>=
function make_left_right(@!q:pointer;@!style:small_number;
@!max_d,@!max_h:scaled):small_number;
var delta,@!delta1,@!delta2:scaled; {dimensions used in the calculation}
begin cur_style:=style; @<Set up the values...@>;
delta2:=max_d+axis_height(cur_size);
delta1:=max_h+max_d-delta2;
if delta2>delta1 then delta1:=delta2; {|delta1| is max distance from axis}
delta:=(delta1 div 500)*delimiter_factor;
delta2:=delta1+delta1-delimiter_shortfall;
if delta<delta2 then delta:=delta2;
new_hlist(q):=var_delimiter(delimiter(q),cur_size,delta);
make_left_right:=type(q)-(left_noad-open_noad); {|open_noad| or |close_noad|}
end;
@ @<Change the current style and |goto delete_q|@>=
begin cur_style:=subtype(q); s:=style_node_size;
@<Set up the values of |cur_size| and |cur_mu|, based on |cur_style|@>;
goto delete_q;
end
@ The inter-element spacing in math formulas depends on an $8\times8$ table that
\TeX\ preloads as a 64-digit string. The elements of this string have the
following significance:
$$\vbox{\halign{#\hfil\cr
\.0 means no space;\cr
\.1 means a conditional thin space (\.{\\nonscript\\mskip\\thinmuskip});\cr
\.2 means a thin space (\.{\\mskip\\thinmuskip});\cr
\.3 means a conditional medium space
(\.{\\nonscript\\mskip\\medmuskip});\cr
\.4 means a conditional thick space
(\.{\\nonscript\\mskip\\thickmuskip});\cr
\.* means an impossible case.\cr}}$$
This is all pretty cryptic, but {\sl The \TeX book\/} explains what is
supposed to happen, and the string makes it happen.
@:TeXbook}{\sl The \TeX book@>
A global variable |magic_offset| is computed so that if |a| and |b| are
in the range |ord_noad..inner_noad|, then |str_pool[a*8+b+magic_offset]|
is the digit for spacing between noad types |a| and |b|.
If \PASCAL\ had provided a good way to preload constant arrays, this part of
the program would not have been so strange.
@:PASCAL}{\PASCAL@>
@d math_spacing=@;@/
@t\hskip-35pt@>
"0234000122*4000133**3**344*0400400*000000234000111*1111112341011"
@t$ \hskip-35pt$@>
@<Glob...@>=
@!magic_offset:integer; {used to find inter-element spacing}
@ @<Compute the magic offset@>=
magic_offset:=str_start[math_spacing]-9*ord_noad
@ @<Append inter-element spacing based on |r_type| and |t|@>=
if r_type>0 then {not the first noad}
begin case so(str_pool[r_type*8+t+magic_offset]) of
"0": x:=0;
"1": if cur_style<script_style then x:=thin_mu_skip_code@+else x:=0;
"2": x:=thin_mu_skip_code;
"3": if cur_style<script_style then x:=med_mu_skip_code@+else x:=0;
"4": if cur_style<script_style then x:=thick_mu_skip_code@+else x:=0;
othercases confusion("mlist4")
@:this can't happen mlist4}{\quad mlist4@>
endcases;
if x<>0 then
begin y:=math_glue(glue_par(x),cur_mu);
z:=new_glue(y); glue_ref_count(y):=null; link(p):=z; p:=z;@/
subtype(z):=x+1; {store a symbolic subtype}
end;
end
@ We insert a penalty node after the hlist entries of noad |q| if |pen|
is not an ``infinite'' penalty, and if the node immediately following |q|
is not a penalty node or a |rel_noad| or absent entirely.
@<Append any |new_hlist| entries for |q|, and any appropriate penalties@>=
if new_hlist(q)<>null then
begin link(p):=new_hlist(q);
repeat p:=link(p);
until link(p)=null;
end;
if penalties then if link(q)<>null then if pen<inf_penalty then
begin r_type:=type(link(q));
if r_type<>penalty_node then if r_type<>rel_noad then
begin z:=new_penalty(pen); link(p):=z; p:=z;
end;
end
@* \[37] Alignment.
It's sort of a miracle whenever \.{\\halign} and \.{\\valign} work, because
they cut across so many of the control structures of \TeX.
Therefore the
present page is probably not the best place for a beginner to start reading
this program; it is better to master everything else first.
Let us focus our thoughts on an example of what the input might be, in order
to get some idea about how the alignment miracle happens. The example doesn't
do anything useful, but it is sufficiently general to indicate all of the
special cases that must be dealt with; please do not be disturbed by its
apparent complexity and meaninglessness.
$$\vbox{\halign{\.{#}\hfil\cr
{}\\tabskip 2pt plus 3pt\cr
{}\\halign to 300pt\{u1\#v1\&\cr
\hskip 50pt\\tabskip 1pt plus 1fil u2\#v2\&\cr
\hskip 50pt u3\#v3\\cr\cr
\hskip 25pt a1\&\\omit a2\&\\vrule\\cr\cr
\hskip 25pt \\noalign\{\\vskip 3pt\}\cr
\hskip 25pt b1\\span b2\\cr\cr
\hskip 25pt \\omit\&c2\\span\\omit\\cr\}\cr}}$$
Here's what happens:
\yskip
(0) When `\.{\\halign to 300pt\{}' is scanned, the |scan_spec| routine
places the 300pt dimension onto the |save_stack|, and an |align_group|
code is placed above it. This will make it possible to complete the alignment
when the matching `\.\}' is found.
(1) The preamble is scanned next. Macros in the preamble are not expanded,
@^preamble@>
except as part of a tabskip specification. For example, if \.{u2} had been
a macro in the preamble above, it would have been expanded, since \TeX\
must look for `\.{minus...}' as part of the tabskip glue. A ``preamble list''
is constructed based on the user's preamble; in our case it contains the
following seven items:
$$\vbox{\halign{\.{#}\hfil\qquad&(#)\hfil\cr
{}\\glue 2pt plus 3pt&the tabskip preceding column 1\cr
{}\\alignrecord, width $-\infty$&preamble info for column 1\cr
{}\\glue 2pt plus 3pt&the tabskip between columns 1 and 2\cr
{}\\alignrecord, width $-\infty$&preamble info for column 2\cr
{}\\glue 1pt plus 1fil&the tabskip between columns 2 and 3\cr
{}\\alignrecord, width $-\infty$&preamble info for column 3\cr
{}\\glue 1pt plus 1fil&the tabskip following column 3\cr}}$$
These ``alignrecord'' entries have the same size as an |unset_node|,
since they will later be converted into such nodes. However, at the
moment they have no |type| or |subtype| fields; they have |info| fields
instead, and these |info| fields are initially set to the value |end_span|,
for reasons explained below. Furthermore, the alignrecord nodes have no
|height| or |depth| fields; these are renamed |u_part| and |v_part|,
and they point to token lists for the templates of the alignment.
For example, the |u_part| field in the first alignrecord points to the
token list `\.{u1}', i.e., the template preceding the `\.\#' for column~1.
(2) \TeX\ now looks at what follows the \.{\\cr} that ended the preamble.
It is not `\.{\\noalign}' or `\.{\\omit}', so this input is put back to
be read again, and the template `\.{u1}' is fed to the scanner. Just
before reading `\.{u1}', \TeX\ goes into restricted horizontal mode.
Just after reading `\.{u1}', \TeX\ will see `\.{a1}', and then (when the
{\.\&} is sensed) \TeX\ will see `\.{v1}'. Then \TeX\ scans an |endv|
token, indicating the end of a column. At this point an |unset_node| is
created, containing the contents of the current hlist (i.e., `\.{u1a1v1}').
The natural width of this unset node replaces the |width| field of the
alignrecord for column~1; in general, the alignrecords will record the
maximum natural width that has occurred so far in a given column.
(3) Since `\.{\\omit}' follows the `\.\&', the templates for column~2
are now bypassed. Again \TeX\ goes into restricted horizontal mode and
makes an |unset_node| from the resulting hlist; but this time the
hlist contains simply `\.{a2}'. The natural width of the new unset box
is remembered in the |width| field of the alignrecord for column~2.
(4) A third |unset_node| is created for column 3, using essentially the
mechanism that worked for column~1; this unset box contains `\.{u3\\vrule
v3}'. The vertical rule in this case has running dimensions that will later
extend to the height and depth of the whole first row, since each |unset_node|
in a row will eventually inherit the height and depth of its enclosing box.
(5) The first row has now ended; it is made into a single unset box
comprising the following seven items:
$$\vbox{\halign{\hbox to 325pt{\qquad\.{#}\hfil}\cr
{}\\glue 2pt plus 3pt\cr
{}\\unsetbox for 1 column: u1a1v1\cr
{}\\glue 2pt plus 3pt\cr
{}\\unsetbox for 1 column: a2\cr
{}\\glue 1pt plus 1fil\cr
{}\\unsetbox for 1 column: u3\\vrule v3\cr
{}\\glue 1pt plus 1fil\cr}}$$
The width of this unset row is unimportant, but it has the correct height
and depth, so the correct baselineskip glue will be computed as the row
is inserted into a vertical list.
(6) Since `\.{\\noalign}' follows the current \.{\\cr}, \TeX\ appends
additional material (in this case \.{\\vskip 3pt}) to the vertical list.
While processing this material, \TeX\ will be in internal vertical
mode, and |no_align_group| will be on |save_stack|.
(7) The next row produces an unset box that looks like this:
$$\vbox{\halign{\hbox to 325pt{\qquad\.{#}\hfil}\cr
{}\\glue 2pt plus 3pt\cr
{}\\unsetbox for 2 columns: u1b1v1u2b2v2\cr
{}\\glue 1pt plus 1fil\cr
{}\\unsetbox for 1 column: {\rm(empty)}\cr
{}\\glue 1pt plus 1fil\cr}}$$
The natural width of the unset box that spans columns 1~and~2 is stored
in a ``span node,'' which we will explain later; the |info| field of the
alignrecord for column~1 now points to the new span node, and the |info|
of the span node points to |end_span|.
(8) The final row produces the unset box
$$\vbox{\halign{\hbox to 325pt{\qquad\.{#}\hfil}\cr
{}\\glue 2pt plus 3pt\cr
{}\\unsetbox for 1 column: {\rm(empty)}\cr
{}\\glue 2pt plus 3pt\cr
{}\\unsetbox for 2 columns: u2c2v2\cr
{}\\glue 1pt plus 1fil\cr}}$$
A new span node is attached to the alignrecord for column 2.
(9) The last step is to compute the true column widths and to change all the
unset boxes to hboxes, appending the whole works to the vertical list that
encloses the \.{\\halign}. The rules for deciding on the final widths of
each unset column box will be explained below.
\yskip\noindent
Note that as \.{\\halign} is being processed, we fearlessly give up control
to the rest of \TeX. At critical junctures, an alignment routine is
called upon to step in and do some little action, but most of the time
these routines just lurk in the background. It's something like
post-hypnotic suggestion.
@ We have mentioned that alignrecords contain no |height| or |depth| fields.
Their |glue_sign| and |glue_order| are pre-empted as well, since it
is necessary to store information about what to do when a template ends.
This information is called the |extra_info| field.
@d u_part(#)==mem[#+height_offset].int {pointer to \<u_j> token list}
@d v_part(#)==mem[#+depth_offset].int {pointer to \<v_j> token list}
@d extra_info(#)==info(#+list_offset) {info to remember during template}
@ Alignments can occur within alignments, so a small stack is used to access
the alignrecord information. At each level we have a |preamble| pointer,
indicating the beginning of the preamble list; a |cur_align| pointer,
indicating the current position in the preamble list; a |cur_span| pointer,
indicating the value of |cur_align| at the beginning of a sequence of
spanned columns; a |cur_loop| pointer, indicating the tabskip glue before
an alignrecord that should be copied next if the current list is extended;
and the |align_state| variable, which indicates the nesting of braces so
that \.{\\cr} and \.{\\span} and tab marks are properly intercepted.
There also are pointers |cur_head| and |cur_tail| to the head and tail
of a list of adjustments being moved out from horizontal mode to
vertical~mode.
The current values of these seven quantities appear in global variables;
when they have to be pushed down, they are stored in 5-word nodes, and
|align_ptr| points to the topmost such node.
@d preamble==link(align_head) {the current preamble list}
@d align_stack_node_size=6 {number of |mem| words to save alignment states}
@<Glob...@>=
@!cur_align:pointer; {current position in preamble list}
@!cur_span:pointer; {start of currently spanned columns in preamble list}
@!cur_loop:pointer; {place to copy when extending a periodic preamble}
@!align_ptr:pointer; {most recently pushed-down alignment stack node}
@!cur_head,@!cur_tail:pointer; {adjustment list pointers}
@!cur_pre_head,@!cur_pre_tail:pointer; {pre-adjustment list pointers}
@ The |align_state| and |preamble| variables are initialized elsewhere.
@<Set init...@>=
align_ptr:=null; cur_align:=null; cur_span:=null; cur_loop:=null;
cur_head:=null; cur_tail:=null;
cur_pre_head:=null; cur_pre_tail:=null;
@ Alignment stack maintenance is handled by a pair of trivial routines
called |push_alignment| and |pop_alignment|.
@p procedure push_alignment;
var p:pointer; {the new alignment stack node}
begin p:=get_node(align_stack_node_size);
link(p):=align_ptr; info(p):=cur_align;
llink(p):=preamble; rlink(p):=cur_span;
mem[p+2].int:=cur_loop; mem[p+3].int:=align_state;
info(p+4):=cur_head; link(p+4):=cur_tail;
info(p+5):=cur_pre_head; link(p+5):=cur_pre_tail;
align_ptr:=p;
cur_head:=get_avail;
cur_pre_head:=get_avail;
end;
@#
procedure pop_alignment;
var p:pointer; {the top alignment stack node}
begin free_avail(cur_head);
free_avail(cur_pre_head);
p:=align_ptr;
cur_tail:=link(p+4); cur_head:=info(p+4);
cur_pre_tail:=link(p+5); cur_pre_head:=info(p+5);
align_state:=mem[p+3].int; cur_loop:=mem[p+2].int;
cur_span:=rlink(p); preamble:=llink(p);
cur_align:=info(p); align_ptr:=link(p);
free_node(p,align_stack_node_size);
end;
@ \TeX\ has eight procedures that govern alignments: |init_align| and
|fin_align| are used at the very beginning and the very end; |init_row| and
|fin_row| are used at the beginning and end of individual rows; |init_span|
is used at the beginning of a sequence of spanned columns (possibly involving
only one column); |init_col| and |fin_col| are used at the beginning and
end of individual columns; and |align_peek| is used after \.{\\cr} to see
whether the next item is \.{\\noalign}.
We shall consider these routines in the order they are first used during
the course of a complete \.{\\halign}, namely |init_align|, |align_peek|,
|init_row|, |init_span|, |init_col|, |fin_col|, |fin_row|, |fin_align|.
@ When \.{\\halign} or \.{\\valign} has been scanned in an appropriate
mode, \TeX\ calls |init_align|, whose task is to get everything off to a
good start. This mostly involves scanning the preamble and putting its
information into the preamble list.
@^preamble@>
@p @t\4@>@<Declare the procedure called |get_preamble_token|@>@t@>@/
procedure@?align_peek; forward;@t\2@>@/
procedure@?normal_paragraph; forward;@t\2@>@/
procedure init_align;
label done, done1, done2, continue;
var save_cs_ptr:pointer; {|warning_index| value for error messages}
@!p:pointer; {for short-term temporary use}
begin save_cs_ptr:=cur_cs; {\.{\\halign} or \.{\\valign}, usually}
push_alignment; align_state:=-1000000; {enter a new alignment level}
@<Check for improper alignment in displayed math@>;
push_nest; {enter a new semantic level}
@<Change current mode to |-vmode| for \.{\\halign}, |-hmode| for \.{\\valign}@>;
scan_spec(align_group,false);@/
@<Scan the preamble and record it in the |preamble| list@>;
new_save_level(align_group);
if every_cr<>null then begin_token_list(every_cr,every_cr_text);
align_peek; {look for \.{\\noalign} or \.{\\omit}}
end;
@ In vertical modes, |prev_depth| already has the correct value. But
if we are in |mmode| (displayed formula mode), we reach out to the
enclosing vertical mode for the |prev_depth| value that produces the
correct baseline calculations.
@<Change current mode...@>=
if mode=mmode then
begin mode:=-vmode; prev_depth:=nest[nest_ptr-2].aux_field.sc;
end
else if mode>0 then negate(mode)
@ When \.{\\halign} is used as a displayed formula, there should be
no other pieces of mlists present.
@<Check for improper alignment in displayed math@>=
if (mode=mmode)and((tail<>head)or(incompleat_noad<>null)) then
begin print_err("Improper "); print_esc("halign"); print(" inside $$'s");
@.Improper \\halign...@>
help3("Displays can use special alignments (like \eqalignno)")@/
("only if nothing but the alignment itself is between $$'s.")@/
("So I've deleted the formulas that preceded this alignment.");
error; flush_math;
end
@ @<Scan the preamble and record it in the |preamble| list@>=
preamble:=null; cur_align:=align_head; cur_loop:=null; scanner_status:=aligning;
warning_index:=save_cs_ptr; align_state:=-1000000;
{at this point, |cur_cmd=left_brace|}
loop@+ begin @<Append the current tabskip glue to the preamble list@>;
if cur_cmd=car_ret then goto done; {\.{\\cr} ends the preamble}
@<Scan preamble text until |cur_cmd| is |tab_mark| or |car_ret|,
looking for changes in the tabskip glue; append an
alignrecord to the preamble list@>;
end;
done: scanner_status:=normal
@ @<Append the current tabskip glue to the preamble list@>=
link(cur_align):=new_param_glue(tab_skip_code);
cur_align:=link(cur_align)
@ @<Scan preamble text until |cur_cmd| is |tab_mark| or |car_ret|...@>=
@<Scan the template \<u_j>, putting the resulting token list in |hold_head|@>;
link(cur_align):=new_null_box; cur_align:=link(cur_align); {a new alignrecord}
info(cur_align):=end_span; width(cur_align):=null_flag;
u_part(cur_align):=link(hold_head);
@<Scan the template \<v_j>, putting the resulting token list in |hold_head|@>;
v_part(cur_align):=link(hold_head)
@ We enter `\.{\\span}' into |eqtb| with |tab_mark| as its command code,
and with |span_code| as the command modifier. This makes \TeX\ interpret it
essentially the same as an alignment delimiter like `\.\&', yet it is
recognizably different when we need to distinguish it from a normal delimiter.
It also turns out to be useful to give a special |cr_code| to `\.{\\cr}',
and an even larger |cr_cr_code| to `\.{\\crcr}'.
The end of a template is represented by two ``frozen'' control sequences
called \.{\\endtemplate}. The first has the command code |end_template|, which
is |>outer_call|, so it will not easily disappear in the presence of errors.
The |get_x_token| routine converts the first into the second, which has |endv|
as its command code.
@d span_code=256 {distinct from any character}
@d cr_code=257 {distinct from |span_code| and from any character}
@d cr_cr_code=cr_code+1 {this distinguishes \.{\\crcr} from \.{\\cr}}
@d end_template_token==cs_token_flag+frozen_end_template
@<Put each of \TeX's primitives into the hash table@>=
primitive("span",tab_mark,span_code);@/
@!@:span_}{\.{\\span} primitive@>
primitive("cr",car_ret,cr_code);
@!@:cr_}{\.{\\cr} primitive@>
text(frozen_cr):="cr"; eqtb[frozen_cr]:=eqtb[cur_val];@/
primitive("crcr",car_ret,cr_cr_code);
@!@:cr_cr_}{\.{\\crcr} primitive@>
text(frozen_end_template):="endtemplate"; text(frozen_endv):="endtemplate";
@.endtemplate@>
eq_type(frozen_endv):=endv; equiv(frozen_endv):=null_list;
eq_level(frozen_endv):=level_one;@/
eqtb[frozen_end_template]:=eqtb[frozen_endv];
eq_type(frozen_end_template):=end_template;
@ @<Cases of |print_cmd_chr|...@>=
tab_mark: if chr_code=span_code then print_esc("span")
else chr_cmd("alignment tab character ");
car_ret: if chr_code=cr_code then print_esc("cr")
else print_esc("crcr");
@ The preamble is copied directly, except that \.{\\tabskip} causes a change
to the tabskip glue, thereby possibly expanding macros that immediately
follow it. An appearance of \.{\\span} also causes such an expansion.
Note that if the preamble contains `\.{\\global\\tabskip}', the `\.{\\global}'
token survives in the preamble and the `\.{\\tabskip}' defines new
tabskip glue (locally).
@<Declare the procedure called |get_preamble_token|@>=
procedure get_preamble_token;
label restart;
begin restart: get_token;
while (cur_chr=span_code)and(cur_cmd=tab_mark) do
begin get_token; {this token will be expanded once}
if cur_cmd>max_command then
begin expand; get_token;
end;
end;
if cur_cmd=endv then
fatal_error("(interwoven alignment preambles are not allowed)");
@.interwoven alignment preambles...@>
if (cur_cmd=assign_glue)and(cur_chr=glue_base+tab_skip_code) then
begin scan_optional_equals; scan_glue(glue_val);
if global_defs>0 then geq_define(glue_base+tab_skip_code,glue_ref,cur_val)
else eq_define(glue_base+tab_skip_code,glue_ref,cur_val);
goto restart;
end;
end;
@ Spaces are eliminated from the beginning of a template.
@<Scan the template \<u_j>...@>=
p:=hold_head; link(p):=null;
loop@+ begin get_preamble_token;
if cur_cmd=mac_param then goto done1;
if (cur_cmd<=car_ret)and(cur_cmd>=tab_mark)and(align_state=-1000000) then
if (p=hold_head)and(cur_loop=null)and(cur_cmd=tab_mark)
then cur_loop:=cur_align
else begin print_err("Missing # inserted in alignment preamble");
@.Missing \# inserted...@>
help3("There should be exactly one # between &'s, when an")@/
("\halign or \valign is being set up. In this case you had")@/
("none, so I've put one in; maybe that will work.");
back_error; goto done1;
end
else if (cur_cmd<>spacer)or(p<>hold_head) then
begin link(p):=get_avail; p:=link(p); info(p):=cur_tok;
end;
end;
done1:
@ @<Scan the template \<v_j>...@>=
p:=hold_head; link(p):=null;
loop@+ begin continue: get_preamble_token;
if (cur_cmd<=car_ret)and(cur_cmd>=tab_mark)and(align_state=-1000000) then
goto done2;
if cur_cmd=mac_param then
begin print_err("Only one # is allowed per tab");
@.Only one \# is allowed...@>
help3("There should be exactly one # between &'s, when an")@/
("\halign or \valign is being set up. In this case you had")@/
("more than one, so I'm ignoring all but the first.");
error; goto continue;
end;
link(p):=get_avail; p:=link(p); info(p):=cur_tok;
end;
done2: link(p):=get_avail; p:=link(p);
info(p):=end_template_token {put \.{\\endtemplate} at the end}
@ The tricky part about alignments is getting the templates into the
scanner at the right time, and recovering control when a row or column
is finished.
We usually begin a row after each \.{\\cr} has been sensed, unless that
\.{\\cr} is followed by \.{\\noalign} or by the right brace that terminates
the alignment. The |align_peek| routine is used to look ahead and do
the right thing; it either gets a new row started, or gets a \.{\\noalign}
started, or finishes off the alignment.
@<Declare the procedure called |align_peek|@>=
procedure align_peek;
label restart;
begin restart: align_state:=1000000;
repeat get_x_or_protected;
until cur_cmd<>spacer;
if cur_cmd=no_align then
begin scan_left_brace; new_save_level(no_align_group);
if mode=-vmode then normal_paragraph;
end
else if cur_cmd=right_brace then fin_align
else if (cur_cmd=car_ret)and(cur_chr=cr_cr_code) then
goto restart {ignore \.{\\crcr}}
else begin init_row; {start a new row}
init_col; {start a new column and replace what we peeked at}
end;
end;
@ To start a row (i.e., a `row' that rhymes with `dough' but not with `bough'),
we enter a new semantic level, copy the first tabskip glue, and change
from internal vertical mode to restricted horizontal mode or vice versa.
The |space_factor| and |prev_depth| are not used on this semantic level,
but we clear them to zero just to be tidy.
@p @t\4@>@<Declare the procedure called |init_span|@>@t@>@/
procedure init_row;
begin push_nest; mode:=(-hmode-vmode)-mode;
if mode=-hmode then space_factor:=0 @+else prev_depth:=0;
tail_append(new_glue(glue_ptr(preamble)));
subtype(tail):=tab_skip_code+1;@/
cur_align:=link(preamble); cur_tail:=cur_head; cur_pre_tail:=cur_pre_head;
init_span(cur_align);
end;
@ The parameter to |init_span| is a pointer to the alignrecord where the
next column or group of columns will begin. A new semantic level is
entered, so that the columns will generate a list for subsequent packaging.
@<Declare the procedure called |init_span|@>=
procedure init_span(@!p:pointer);
begin push_nest;
if mode=-hmode then space_factor:=1000
else begin prev_depth:=pdf_ignored_dimen; normal_paragraph;
end;
cur_span:=p;
end;
@ When a column begins, we assume that |cur_cmd| is either |omit| or else
the current token should be put back into the input until the \<u_j>
template has been scanned. (Note that |cur_cmd| might be |tab_mark| or
|car_ret|.) We also assume that |align_state| is approximately 1000000 at
this time. We remain in the same mode, and start the template if it is
called for.
@p procedure init_col;
begin extra_info(cur_align):=cur_cmd;
if cur_cmd=omit then align_state:=0
else begin back_input; begin_token_list(u_part(cur_align),u_template);
end; {now |align_state=1000000|}
end;
@ The scanner sets |align_state| to zero when the \<u_j> template ends. When
a subsequent \.{\\cr} or \.{\\span} or tab mark occurs with |align_state=0|,
the scanner activates the following code, which fires up the \<v_j> template.
We need to remember the |cur_chr|, which is either |cr_cr_code|, |cr_code|,
|span_code|, or a character code, depending on how the column text has ended.
This part of the program had better not be activated when the preamble
to another alignment is being scanned, or when no alignment preamble is active.
@<Insert the \(v)\<v_j>...@>=
begin if (scanner_status=aligning) or (cur_align=null) then
fatal_error("(interwoven alignment preambles are not allowed)");
@.interwoven alignment preambles...@>
cur_cmd:=extra_info(cur_align); extra_info(cur_align):=cur_chr;
if cur_cmd=omit then begin_token_list(omit_template,v_template)
else begin_token_list(v_part(cur_align),v_template);
align_state:=1000000; goto restart;
end
@ The token list |omit_template| just referred to is a constant token
list that contains the special control sequence \.{\\endtemplate} only.
@<Initialize the special...@>=
info(omit_template):=end_template_token; {|link(omit_template)=null|}
@ When the |endv| command at the end of a \<v_j> template comes through the
scanner, things really start to happen; and it is the |fin_col| routine
that makes them happen. This routine returns |true| if a row as well as a
column has been finished.
@p function fin_col:boolean;
label exit;
var p:pointer; {the alignrecord after the current one}
@!q,@!r:pointer; {temporary pointers for list manipulation}
@!s:pointer; {a new span node}
@!u:pointer; {a new unset box}
@!w:scaled; {natural width}
@!o:glue_ord; {order of infinity}
@!n:halfword; {span counter}
begin if cur_align=null then confusion("endv");
q:=link(cur_align);@+if q=null then confusion("endv");
@:this can't happen endv}{\quad endv@>
if align_state<500000 then
fatal_error("(interwoven alignment preambles are not allowed)");
@.interwoven alignment preambles...@>
p:=link(q);
@<If the preamble list has been traversed, check that the row has ended@>;
if extra_info(cur_align)<>span_code then
begin unsave; new_save_level(align_group);@/
@<Package an unset box for the current column and record its width@>;
@<Copy the tabskip glue between columns@>;
if extra_info(cur_align)>=cr_code then
begin fin_col:=true; return;
end;
init_span(p);
end;
align_state:=1000000;
repeat get_x_or_protected;
until cur_cmd<>spacer;
cur_align:=p;
init_col; fin_col:=false;
exit: end;
@ @<If the preamble list has been traversed, check that the row has ended@>=
if (p=null)and(extra_info(cur_align)<cr_code) then
if cur_loop<>null then @<Lengthen the preamble periodically@>
else begin print_err("Extra alignment tab has been changed to ");
@.Extra alignment tab...@>
print_esc("cr");
help3("You have given more \span or & marks than there were")@/
("in the preamble to the \halign or \valign now in progress.")@/
("So I'll assume that you meant to type \cr instead.");
extra_info(cur_align):=cr_code; error;
end
@ @<Lengthen the preamble...@>=
begin link(q):=new_null_box; p:=link(q); {a new alignrecord}
info(p):=end_span; width(p):=null_flag; cur_loop:=link(cur_loop);
@<Copy the templates from node |cur_loop| into node |p|@>;
cur_loop:=link(cur_loop);
link(p):=new_glue(glue_ptr(cur_loop));
subtype(link(p)):=tab_skip_code+1;
end
@ @<Copy the templates from node |cur_loop| into node |p|@>=
q:=hold_head; r:=u_part(cur_loop);
while r<>null do
begin link(q):=get_avail; q:=link(q); info(q):=info(r); r:=link(r);
end;
link(q):=null; u_part(p):=link(hold_head);
q:=hold_head; r:=v_part(cur_loop);
while r<>null do
begin link(q):=get_avail; q:=link(q); info(q):=info(r); r:=link(r);
end;
link(q):=null; v_part(p):=link(hold_head)
@ @<Copy the tabskip glue...@>=
tail_append(new_glue(glue_ptr(link(cur_align))));
subtype(tail):=tab_skip_code+1
@ @<Package an unset...@>=
begin if mode=-hmode then
begin adjust_tail:=cur_tail; pre_adjust_tail:=cur_pre_tail;
u:=hpack(link(head),natural); w:=width(u);
cur_tail:=adjust_tail; adjust_tail:=null;
cur_pre_tail:=pre_adjust_tail; pre_adjust_tail:=null;
end
else begin u:=vpackage(link(head),natural,0); w:=height(u);
end;
n:=min_quarterword; {this represents a span count of 1}
if cur_span<>cur_align then @<Update width entry for spanned columns@>
else if w>width(cur_align) then width(cur_align):=w;
type(u):=unset_node; span_count(u):=n;@/
@<Determine the stretch order@>;
glue_order(u):=o; glue_stretch(u):=total_stretch[o];@/
@<Determine the shrink order@>;
glue_sign(u):=o; glue_shrink(u):=total_shrink[o];@/
pop_nest; link(tail):=u; tail:=u;
end
@ A span node is a 2-word record containing |width|, |info|, and |link|
fields. The |link| field is not really a link, it indicates the number of
spanned columns; the |info| field points to a span node for the same
starting column, having a greater extent of spanning, or to |end_span|,
which has the largest possible |link| field; the |width| field holds the
largest natural width corresponding to a particular set of spanned columns.
A list of the maximum widths so far, for spanned columns starting at a
given column, begins with the |info| field of the alignrecord for that
column.
@d span_node_size=2 {number of |mem| words for a span node}
@<Initialize the special list heads...@>=
link(end_span):=max_quarterword+1; info(end_span):=null;
@ @<Update width entry for spanned columns@>=
begin q:=cur_span;
repeat incr(n); q:=link(link(q));
until q=cur_align;
if n>max_quarterword then confusion("256 spans"); {this can happen, but won't}
@^system dependencies@>
@:this can't happen 256 spans}{\quad 256 spans@>
q:=cur_span; while link(info(q))<n do q:=info(q);
if link(info(q))>n then
begin s:=get_node(span_node_size); info(s):=info(q); link(s):=n;
info(q):=s; width(s):=w;
end
else if width(info(q))<w then width(info(q)):=w;
end
@ At the end of a row, we append an unset box to the current vlist (for
\.{\\halign}) or the current hlist (for \.{\\valign}). This unset box
contains the unset boxes for the columns, separated by the tabskip glue.
Everything will be set later.
@p procedure fin_row;
var p:pointer; {the new unset box}
begin if mode=-hmode then
begin p:=hpack(link(head),natural);
pop_nest;
if cur_pre_head <> cur_pre_tail then
append_list(cur_pre_head)(cur_pre_tail);
append_to_vlist(p);
if cur_head <> cur_tail then
append_list(cur_head)(cur_tail);
end
else begin p:=vpack(link(head),natural); pop_nest;
link(tail):=p; tail:=p; space_factor:=1000;
end;
type(p):=unset_node; glue_stretch(p):=0;
if every_cr<>null then begin_token_list(every_cr,every_cr_text);
align_peek;
end; {note that |glue_shrink(p)=0| since |glue_shrink==shift_amount|}
@ Finally, we will reach the end of the alignment, and we can breathe a
sigh of relief that memory hasn't overflowed. All the unset boxes will now be
set so that the columns line up, taking due account of spanned columns.
@p procedure@?do_assignments; forward;@t\2@>@/
procedure@?resume_after_display; forward;@t\2@>@/
procedure@?build_page; forward;@t\2@>@/
procedure fin_align;
var @!p,@!q,@!r,@!s,@!u,@!v: pointer; {registers for the list operations}
@!t,@!w:scaled; {width of column}
@!o:scaled; {shift offset for unset boxes}
@!n:halfword; {matching span amount}
@!rule_save:scaled; {temporary storage for |overfull_rule|}
@!aux_save:memory_word; {temporary storage for |aux|}
begin if cur_group<>align_group then confusion("align1");
@:this can't happen align}{\quad align@>
unsave; {that |align_group| was for individual entries}
if cur_group<>align_group then confusion("align0");
unsave; {that |align_group| was for the whole alignment}
if nest[nest_ptr-1].mode_field=mmode then o:=display_indent
else o:=0;
@<Go through the preamble list, determining the column widths and
changing the alignrecords to dummy unset boxes@>;
@<Package the preamble list, to determine the actual tabskip glue amounts,
and let |p| point to this prototype box@>;
@<Set the glue in all the unset boxes of the current list@>;
flush_node_list(p); pop_alignment;
@<Insert the \(c)current list into its environment@>;
end;@/
@t\4@>@<Declare the procedure called |align_peek|@>
@ It's time now to dismantle the preamble list and to compute the column
widths. Let $w_{ij}$ be the maximum of the natural widths of all entries
that span columns $i$ through $j$, inclusive. The alignrecord for column~$i$
contains $w_{ii}$ in its |width| field, and there is also a linked list of
the nonzero $w_{ij}$ for increasing $j$, accessible via the |info| field;
these span nodes contain the value $j-i+|min_quarterword|$ in their
|link| fields. The values of $w_{ii}$ were initialized to |null_flag|, which
we regard as $-\infty$.
The final column widths are defined by the formula
$$w_j=\max_{1\L i\L j}\biggl( w_{ij}-\sum_{i\L k<j}(t_k+w_k)\biggr),$$
where $t_k$ is the natural width of the tabskip glue between columns
$k$ and~$k+1$. However, if $w_{ij}=-\infty$ for all |i| in the range
|1<=i<=j| (i.e., if every entry that involved column~|j| also involved
column~|j+1|), we let $w_j=0$, and we zero out the tabskip glue after
column~|j|.
\TeX\ computes these values by using the following scheme: First $w_1=w_{11}$.
Then replace $w_{2j}$ by $\max(w_{2j},w_{1j}-t_1-w_1)$, for all $j>1$.
Then $w_2=w_{22}$. Then replace $w_{3j}$ by $\max(w_{3j},w_{2j}-t_2-w_2)$
for all $j>2$; and so on. If any $w_j$ turns out to be $-\infty$, its
value is changed to zero and so is the next tabskip.
@<Go through the preamble list,...@>=
q:=link(preamble);
repeat flush_list(u_part(q)); flush_list(v_part(q));
p:=link(link(q));
if width(q)=null_flag then
@<Nullify |width(q)| and the tabskip glue following this column@>;
if info(q)<>end_span then
@<Merge the widths in the span nodes of |q| with those of |p|,
destroying the span nodes of |q|@>;
type(q):=unset_node; span_count(q):=min_quarterword; height(q):=0;
depth(q):=0; glue_order(q):=normal; glue_sign(q):=normal;
glue_stretch(q):=0; glue_shrink(q):=0; q:=p;
until q=null
@ @<Nullify |width(q)| and the tabskip glue following this column@>=
begin width(q):=0; r:=link(q); s:=glue_ptr(r);
if s<>zero_glue then
begin add_glue_ref(zero_glue); delete_glue_ref(s);
glue_ptr(r):=zero_glue;
end;
end
@ Merging of two span-node lists is a typical exercise in the manipulation of
linearly linked data structures. The essential invariant in the following
|repeat| loop is that we want to dispense with node |r|, in |q|'s list,
and |u| is its successor; all nodes of |p|'s list up to and including |s|
have been processed, and the successor of |s| matches |r| or precedes |r|
or follows |r|, according as |link(r)=n| or |link(r)>n| or |link(r)<n|.
@<Merge the widths...@>=
begin t:=width(q)+width(glue_ptr(link(q)));
r:=info(q); s:=end_span; info(s):=p; n:=min_quarterword+1;
repeat width(r):=width(r)-t; u:=info(r);
while link(r)>n do
begin s:=info(s); n:=link(info(s))+1;
end;
if link(r)<n then
begin info(r):=info(s); info(s):=r; decr(link(r)); s:=r;
end
else begin if width(r)>width(info(s)) then width(info(s)):=width(r);
free_node(r,span_node_size);
end;
r:=u;
until r=end_span;
end
@ Now the preamble list has been converted to a list of alternating unset
boxes and tabskip glue, where the box widths are equal to the final
column sizes. In case of \.{\\valign}, we change the widths to heights,
so that a correct error message will be produced if the alignment is
overfull or underfull.
@<Package the preamble list...@>=
save_ptr:=save_ptr-2; pack_begin_line:=-mode_line;
if mode=-vmode then
begin rule_save:=overfull_rule;
overfull_rule:=0; {prevent rule from being packaged}
p:=hpack(preamble,saved(1),saved(0)); overfull_rule:=rule_save;
end
else begin q:=link(preamble);
repeat height(q):=width(q); width(q):=0; q:=link(link(q));
until q=null;
p:=vpack(preamble,saved(1),saved(0));
q:=link(preamble);
repeat width(q):=height(q); height(q):=0; q:=link(link(q));
until q=null;
end;
pack_begin_line:=0
@ @<Set the glue in all the unset...@>=
q:=link(head); s:=head;
while q<>null do
begin if not is_char_node(q) then
if type(q)=unset_node then
@<Set the unset box |q| and the unset boxes in it@>
else if type(q)=rule_node then
@<Make the running dimensions in rule |q| extend to the
boundaries of the alignment@>;
s:=q; q:=link(q);
end
@ @<Make the running dimensions in rule |q| extend...@>=
begin if is_running(width(q)) then width(q):=width(p);
if is_running(height(q)) then height(q):=height(p);
if is_running(depth(q)) then depth(q):=depth(p);
if o<>0 then
begin r:=link(q); link(q):=null; q:=hpack(q,natural);
shift_amount(q):=o; link(q):=r; link(s):=q;
end;
end
@ The unset box |q| represents a row that contains one or more unset boxes,
depending on how soon \.{\\cr} occurred in that row.
@<Set the unset box |q| and the unset boxes in it@>=
begin if mode=-vmode then
begin type(q):=hlist_node; width(q):=width(p);
if nest[nest_ptr-1].mode_field=mmode then set_box_lr(q)(dlist); {for |ship_out|}
end
else begin type(q):=vlist_node; height(q):=height(p);
end;
glue_order(q):=glue_order(p); glue_sign(q):=glue_sign(p);
glue_set(q):=glue_set(p); shift_amount(q):=o;
r:=link(list_ptr(q)); s:=link(list_ptr(p));
repeat @<Set the glue in node |r| and change it from an unset node@>;
r:=link(link(r)); s:=link(link(s));
until r=null;
end
@ A box made from spanned columns will be followed by tabskip glue nodes and
by empty boxes as if there were no spanning. This permits perfect alignment
of subsequent entries, and it prevents values that depend on floating point
arithmetic from entering into the dimensions of any boxes.
@<Set the glue in node |r|...@>=
n:=span_count(r); t:=width(s); w:=t; u:=hold_head;
set_box_lr(r)(0); {for |ship_out|}
while n>min_quarterword do
begin decr(n);
@<Append tabskip glue and an empty box to list |u|,
and update |s| and |t| as the prototype nodes are passed@>;
end;
if mode=-vmode then
@<Make the unset node |r| into an |hlist_node| of width |w|,
setting the glue as if the width were |t|@>
else @<Make the unset node |r| into a |vlist_node| of height |w|,
setting the glue as if the height were |t|@>;
shift_amount(r):=0;
if u<>hold_head then {append blank boxes to account for spanned nodes}
begin link(u):=link(r); link(r):=link(hold_head); r:=u;
end
@ @<Append tabskip glue and an empty box to list |u|...@>=
s:=link(s); v:=glue_ptr(s); link(u):=new_glue(v); u:=link(u);
subtype(u):=tab_skip_code+1; t:=t+width(v);
if glue_sign(p)=stretching then
begin if stretch_order(v)=glue_order(p) then
t:=t+round(float(glue_set(p))*stretch(v));
@^real multiplication@>
end
else if glue_sign(p)=shrinking then
begin if shrink_order(v)=glue_order(p) then
t:=t-round(float(glue_set(p))*shrink(v));
end;
s:=link(s); link(u):=new_null_box; u:=link(u); t:=t+width(s);
if mode=-vmode then width(u):=width(s)@+else
begin type(u):=vlist_node; height(u):=width(s);
end
@ @<Make the unset node |r| into an |hlist_node| of width |w|...@>=
begin height(r):=height(q); depth(r):=depth(q);
if t=width(r) then
begin glue_sign(r):=normal; glue_order(r):=normal;
set_glue_ratio_zero(glue_set(r));
end
else if t>width(r) then
begin glue_sign(r):=stretching;
if glue_stretch(r)=0 then set_glue_ratio_zero(glue_set(r))
else glue_set(r):=unfloat((t-width(r))/glue_stretch(r));
@^real division@>
end
else begin glue_order(r):=glue_sign(r); glue_sign(r):=shrinking;
if glue_shrink(r)=0 then set_glue_ratio_zero(glue_set(r))
else if (glue_order(r)=normal)and(width(r)-t>glue_shrink(r)) then
set_glue_ratio_one(glue_set(r))
else glue_set(r):=unfloat((width(r)-t)/glue_shrink(r));
end;
width(r):=w; type(r):=hlist_node;
end
@ @<Make the unset node |r| into a |vlist_node| of height |w|...@>=
begin width(r):=width(q);
if t=height(r) then
begin glue_sign(r):=normal; glue_order(r):=normal;
set_glue_ratio_zero(glue_set(r));
end
else if t>height(r) then
begin glue_sign(r):=stretching;
if glue_stretch(r)=0 then set_glue_ratio_zero(glue_set(r))
else glue_set(r):=unfloat((t-height(r))/glue_stretch(r));
@^real division@>
end
else begin glue_order(r):=glue_sign(r); glue_sign(r):=shrinking;
if glue_shrink(r)=0 then set_glue_ratio_zero(glue_set(r))
else if (glue_order(r)=normal)and(height(r)-t>glue_shrink(r)) then
set_glue_ratio_one(glue_set(r))
else glue_set(r):=unfloat((height(r)-t)/glue_shrink(r));
end;
height(r):=w; type(r):=vlist_node;
end
@ We now have a completed alignment, in the list that starts at |head|
and ends at |tail|. This list will be merged with the one that encloses
it. (In case the enclosing mode is |mmode|, for displayed formulas,
we will need to insert glue before and after the display; that part of the
program will be deferred until we're more familiar with such operations.)
In restricted horizontal mode, the |clang| part of |aux| is undefined;
an over-cautious \PASCAL\ runtime system may complain about this.
@^dirty \PASCAL@>
@<Insert the \(c)current list into its environment@>=
aux_save:=aux; p:=link(head); q:=tail; pop_nest;
if mode=mmode then @<Finish an alignment in a display@>
else begin aux:=aux_save; link(tail):=p;
if p<>null then tail:=q;
if mode=vmode then build_page;
end
@* \[38] Breaking paragraphs into lines.
We come now to what is probably the most interesting algorithm of \TeX:
the mechanism for choosing the ``best possible'' breakpoints that yield
the individual lines of a paragraph. \TeX's line-breaking algorithm takes
a given horizontal list and converts it to a sequence of boxes that are
appended to the current vertical list. In the course of doing this, it
creates a special data structure containing three kinds of records that are
not used elsewhere in \TeX. Such nodes are created while a paragraph is
being processed, and they are destroyed afterwards; thus, the other parts
of \TeX\ do not need to know anything about how line-breaking is done.
The method used here is based on an approach devised by Michael F. Plass and
@^Plass, Michael Frederick@>
@^Knuth, Donald Ervin@>
the author in 1977, subsequently generalized and improved by the same two
people in 1980. A detailed discussion appears in {\sl Software---Practice
and Experience \bf11} (1981), 1119--1184, where it is shown that the
line-breaking problem can be regarded as a special case of the problem of
computing the shortest path in an acyclic network. The cited paper includes
numerous examples and describes the history of line breaking as it has been
practiced by printers through the ages. The present implementation adds two
new ideas to the algorithm of 1980: Memory space requirements are considerably
reduced by using smaller records for inactive nodes than for active ones,
and arithmetic overflow is avoided by using ``delta distances'' instead of
keeping track of the total distance from the beginning of the paragraph to the
current point.
@ The |line_break| procedure should be invoked only in horizontal mode; it
leaves that mode and places its output into the current vlist of the
enclosing vertical mode (or internal vertical mode).
There is one explicit parameter: |d| is true for partial paragraphs
preceding display math mode; in this case the amount of additional
penalty inserted before the final line is |display_widow_penalty|
instead of |widow_penalty|.
There are also a number of implicit parameters: The hlist to be broken
starts at |link(head)|, and it is nonempty. The value of |prev_graf| in the
enclosing semantic level tells where the paragraph should begin in the
sequence of line numbers, in case hanging indentation or \.{\\parshape}
is in use; |prev_graf| is zero unless this paragraph is being continued
after a displayed formula. Other implicit parameters, such as the
|par_shape_ptr| and various penalties to use for hyphenation, etc., appear
in |eqtb|.
After |line_break| has acted, it will have updated the current vlist and the
value of |prev_graf|. Furthermore, the global variable |just_box| will
point to the final box created by |line_break|, so that the width of this
line can be ascertained when it is necessary to decide whether to use
|above_display_skip| or |above_display_short_skip| before a displayed formula.
@<Glob...@>=
@!just_box:pointer; {the |hlist_node| for the last line of the new paragraph}
@ Since |line_break| is a rather lengthy procedure---sort of a small world unto
itself---we must build it up little by little, somewhat more cautiously
than we have done with the simpler procedures of \TeX. Here is the
general outline.
@p@t\4@>@<Declare subprocedures for |line_break|@>
procedure line_break(@!d:boolean);
label done,done1,done2,done3,done4,done5,continue;
var @<Local variables for line breaking@>@;
begin pack_begin_line:=mode_line; {this is for over/underfull box messages}
@<Get ready to start line breaking@>;
@<Find optimal breakpoints@>;
@<Break the paragraph at the chosen breakpoints, justify the resulting lines
to the correct widths, and append them to the current vertical list@>;
@<Clean up the memory by removing the break nodes@>;
pack_begin_line:=0;
end;
@#
@t\4@>@<Declare \eTeX\ procedures for use by |main_control|@>
@ The first task is to move the list from |head| to |temp_head| and go
into the enclosing semantic level. We also append the \.{\\parfillskip}
glue to the end of the paragraph, removing a space (or other glue node) if
it was there, since spaces usually precede blank lines and instances of
`\.{\$\$}'. The |par_fill_skip| is preceded by an infinite penalty, so
it will never be considered as a potential breakpoint.
This code assumes that a |glue_node| and a |penalty_node| occupy the
same number of |mem|~words.
@^data structure assumptions@>
@<Get ready to start...@>=
link(temp_head):=link(head);
if is_char_node(tail) then tail_append(new_penalty(inf_penalty))
else if type(tail)<>glue_node then tail_append(new_penalty(inf_penalty))
else begin type(tail):=penalty_node; delete_glue_ref(glue_ptr(tail));
flush_node_list(leader_ptr(tail)); penalty(tail):=inf_penalty;
end;
link(tail):=new_param_glue(par_fill_skip_code);
last_line_fill:=link(tail);
init_cur_lang:=prev_graf mod @'200000;
init_l_hyf:=prev_graf div @'20000000;
init_r_hyf:=(prev_graf div @'200000) mod @'100;
pop_nest;
@ When looking for optimal line breaks, \TeX\ creates a ``break node'' for
each break that is {\sl feasible}, in the sense that there is a way to end
a line at the given place without requiring any line to stretch more than
a given tolerance. A break node is characterized by three things: the position
of the break (which is a pointer to a |glue_node|, |math_node|, |penalty_node|,
or |disc_node|); the ordinal number of the line that will follow this
breakpoint; and the fitness classification of the line that has just
ended, i.e., |tight_fit|, |decent_fit|, |loose_fit|, or |very_loose_fit|.
@d tight_fit=3 {fitness classification for lines shrinking 0.5 to 1.0 of their
shrinkability}
@d loose_fit=1 {fitness classification for lines stretching 0.5 to 1.0 of their
stretchability}
@d very_loose_fit=0 {fitness classification for lines stretching more than
their stretchability}
@d decent_fit=2 {fitness classification for all other lines}
@ The algorithm essentially determines the best possible way to achieve
each feasible combination of position, line, and fitness. Thus, it answers
questions like, ``What is the best way to break the opening part of the
paragraph so that the fourth line is a tight line ending at such-and-such
a place?'' However, the fact that all lines are to be the same length
after a certain point makes it possible to regard all sufficiently large
line numbers as equivalent, when the looseness parameter is zero, and this
makes it possible for the algorithm to save space and time.
An ``active node'' and a ``passive node'' are created in |mem| for each
feasible breakpoint that needs to be considered. Active nodes are three
words long and passive nodes are two words long. We need active nodes only
for breakpoints near the place in the paragraph that is currently being
examined, so they are recycled within a comparatively short time after
they are created.
@ An active node for a given breakpoint contains six fields:
\yskip\hang|link| points to the next node in the list of active nodes; the
last active node has |link=last_active|.
\yskip\hang|break_node| points to the passive node associated with this
breakpoint.
\yskip\hang|line_number| is the number of the line that follows this
breakpoint.
\yskip\hang|fitness| is the fitness classification of the line ending at this
breakpoint.
\yskip\hang|type| is either |hyphenated| or |unhyphenated|, depending on
whether this breakpoint is a |disc_node|.
\yskip\hang|total_demerits| is the minimum possible sum of demerits over all
lines leading from the beginning of the paragraph to this breakpoint.
\yskip\noindent
The value of |link(active)| points to the first active node on a linked list
of all currently active nodes. This list is in order by |line_number|,
except that nodes with |line_number>easy_line| may be in any order relative
to each other.
@d active_node_size_normal=3 {number of words in normal active nodes}
@d fitness==subtype {|very_loose_fit..tight_fit| on final line for this break}
@d break_node==rlink {pointer to the corresponding passive node}
@d line_number==llink {line that begins at this breakpoint}
@d total_demerits(#)==mem[#+2].int {the quantity that \TeX\ minimizes}
@d unhyphenated=0 {the |type| of a normal active break node}
@d hyphenated=1 {the |type| of an active node that breaks at a |disc_node|}
@d last_active==active {the active list ends where it begins}
@ @<Initialize the special list heads...@>=
type(last_active):=hyphenated; line_number(last_active):=max_halfword;
subtype(last_active):=0; {the |subtype| is never examined by the algorithm}
@ The passive node for a given breakpoint contains only four fields:
\yskip\hang|link| points to the passive node created just before this one,
if any, otherwise it is |null|.
\yskip\hang|cur_break| points to the position of this breakpoint in the
horizontal list for the paragraph being broken.
\yskip\hang|prev_break| points to the passive node that should precede this
one in an optimal path to this breakpoint.
\yskip\hang|serial| is equal to |n| if this passive node is the |n|th
one created during the current pass. (This field is used only when
printing out detailed statistics about the line-breaking calculations.)
\yskip\noindent
There is a global variable called |passive| that points to the most
recently created passive node. Another global variable, |printed_node|,
is used to help print out the paragraph when detailed information about
the line-breaking computation is being displayed.
@d passive_node_size=2 {number of words in passive nodes}
@d cur_break==rlink {in passive node, points to position of this breakpoint}
@d prev_break==llink {points to passive node that should precede this one}
@d serial==info {serial number for symbolic identification}
@<Glob...@>=
@!passive:pointer; {most recent node on passive list}
@!printed_node:pointer; {most recent node that has been printed}
@!pass_number:halfword; {the number of passive nodes allocated on this pass}
@ The active list also contains ``delta'' nodes that help the algorithm
compute the badness of individual lines. Such nodes appear only between two
active nodes, and they have |type=delta_node|. If |p| and |r| are active nodes
and if |q| is a delta node between them, so that |link(p)=q| and |link(q)=r|,
then |q| tells the space difference between lines in the horizontal list that
start after breakpoint |p| and lines that start after breakpoint |r|. In
other words, if we know the length of the line that starts after |p| and
ends at our current position, then the corresponding length of the line that
starts after |r| is obtained by adding the amounts in node~|q|. A delta node
contains six scaled numbers, since it must record the net change in glue
stretchability with respect to all orders of infinity. The natural width
difference appears in |mem[q+1].sc|; the stretch differences in units of
pt, fil, fill, and filll appear in |mem[q+2..q+5].sc|; and the shrink difference
appears in |mem[q+6].sc|. The |subtype| field of a delta node is not used.
@d delta_node_size=9 {number of words in a delta node}
@d delta_node=2 {|type| field in a delta node}
@ As the algorithm runs, it maintains a set of six delta-like registers
for the length of the line following the first active breakpoint to the
current position in the given hlist. When it makes a pass through the
active list, it also maintains a similar set of six registers for the
length following the active breakpoint of current interest. A third set
holds the length of an empty line (namely, the sum of \.{\\leftskip} and
\.{\\rightskip}); and a fourth set is used to create new delta nodes.
When we pass a delta node we want to do operations like
$$\hbox{\ignorespaces|for
k:=1 to 6 do cur_active_width[k]:=cur_active_width[k]+mem[q+k].sc|};$$ and we
want to do this without the overhead of |for| loops. The |do_all_six|
macro makes such six-tuples convenient.
@d do_all_six(#)==#(1);#(2);#(3);#(4);#(5);#(6)
@d do_seven_eight(#) == if pdf_adjust_spacing > 1 then begin #(7);#(8); end
@d do_all_eight(#) == do_all_six(#); do_seven_eight(#)
@d do_one_seven_eight(#) == #(1); do_seven_eight(#)
@d total_font_stretch == cur_active_width[7]
@d total_font_shrink == cur_active_width[8]
@d save_active_width(#) == prev_active_width[#] := active_width[#]
@d restore_active_width(#) == active_width[#] := prev_active_width[#]
@<Glob...@>=
@!active_width:array[1..8] of scaled;
{distance from first active node to~|cur_p|}
@!cur_active_width:array[1..8] of scaled; {distance from current active node}
@!background:array[1..8] of scaled; {length of an ``empty'' line}
@!break_width:array[1..8] of scaled; {length being computed after current break}
@#
@!auto_breaking: boolean; {make |auto_breaking| accessible out of |line_break|}
@!prev_p: pointer; {make |prev_p| accessible out of |line_break|}
@!first_p: pointer; {to access the first node of the paragraph}
@!prev_char_p: pointer; {pointer to the previous char of an implicit kern}
@!next_char_p: pointer; {pointer to the next char of an implicit kern}
@#
@!try_prev_break: boolean; {force break at the previous legal breakpoint?}
@!prev_legal: pointer; {the previous legal breakpoint}
@!prev_prev_legal: pointer; {to save |prev_p| corresponding to |prev_legal|}
@!prev_auto_breaking: boolean; {to save |auto_breaking| corresponding to |prev_legal|}
@!prev_active_width: array[1..8] of scaled; {to save |active_width| corresponding to |prev_legal|}
@!rejected_cur_p: pointer; {the last |cur_p| that has been rejected}
@!before_rejected_cur_p: boolean; {|cur_p| is still before |rejected_cur_p|?}
@#
@!max_stretch_ratio: integer; {maximal stretch ratio of expanded fonts}
@!max_shrink_ratio: integer; {maximal shrink ratio of expanded fonts}
@!cur_font_step: integer; {the current step of expanded fonts}
@ Let's state the principles of the delta nodes more precisely and concisely,
so that the following programs will be less obscure. For each legal
breakpoint~|p| in the paragraph, we define two quantities $\alpha(p)$ and
$\beta(p)$ such that the length of material in a line from breakpoint~|p|
to breakpoint~|q| is $\gamma+\beta(q)-\alpha(p)$, for some fixed $\gamma$.
Intuitively, $\alpha(p)$ and $\beta(q)$ are the total length of material from
the beginning of the paragraph to a point ``after'' a break at |p| and to a
point ``before'' a break at |q|; and $\gamma$ is the width of an empty line,
namely the length contributed by \.{\\leftskip} and \.{\\rightskip}.
Suppose, for example, that the paragraph consists entirely of alternating
boxes and glue skips; let the boxes have widths $x_1\ldots x_n$ and
let the skips have widths $y_1\ldots y_n$, so that the paragraph can be
represented by $x_1y_1\ldots x_ny_n$. Let $p_i$ be the legal breakpoint
at $y_i$; then $\alpha(p_i)=x_1+y_1+\cdots+x_i+y_i$, and $\beta(p_i)=
x_1+y_1+\cdots+x_i$. To check this, note that the length of material from
$p_2$ to $p_5$, say, is $\gamma+x_3+y_3+x_4+y_4+x_5=\gamma+\beta(p_5)
-\alpha(p_2)$.
The quantities $\alpha$, $\beta$, $\gamma$ involve glue stretchability and
shrinkability as well as a natural width. If we were to compute $\alpha(p)$
and $\beta(p)$ for each |p|, we would need multiple precision arithmetic, and
the multiprecise numbers would have to be kept in the active nodes.
\TeX\ avoids this problem by working entirely with relative differences
or ``deltas.'' Suppose, for example, that the active list contains
$a_1\,\delta_1\,a_2\,\delta_2\,a_3$, where the |a|'s are active breakpoints
and the $\delta$'s are delta nodes. Then $\delta_1=\alpha(a_1)-\alpha(a_2)$
and $\delta_2=\alpha(a_2)-\alpha(a_3)$. If the line breaking algorithm is
currently positioned at some other breakpoint |p|, the |active_width| array
contains the value $\gamma+\beta(p)-\alpha(a_1)$. If we are scanning through
the list of active nodes and considering a tentative line that runs from
$a_2$ to~|p|, say, the |cur_active_width| array will contain the value
$\gamma+\beta(p)-\alpha(a_2)$. Thus, when we move from $a_2$ to $a_3$,
we want to add $\alpha(a_2)-\alpha(a_3)$ to |cur_active_width|; and this
is just $\delta_2$, which appears in the active list between $a_2$ and
$a_3$. The |background| array contains $\gamma$. The |break_width| array
will be used to calculate values of new delta nodes when the active
list is being updated.
@ Glue nodes in a horizontal list that is being paragraphed are not supposed to
include ``infinite'' shrinkability; that is why the algorithm maintains
four registers for stretching but only one for shrinking. If the user tries to
introduce infinite shrinkability, the shrinkability will be reset to finite
and an error message will be issued. A boolean variable |no_shrink_error_yet|
prevents this error message from appearing more than once per paragraph.
@d check_shrinkage(#)==if (shrink_order(#)<>normal)and(shrink(#)<>0) then
begin #:=finite_shrink(#);
end
@<Glob...@>=
@!no_shrink_error_yet:boolean; {have we complained about infinite shrinkage?}
@ @<Declare subprocedures for |line_break|@>=
function finite_shrink(@!p:pointer):pointer; {recovers from infinite shrinkage}
var q:pointer; {new glue specification}
begin if no_shrink_error_yet then
begin no_shrink_error_yet:=false;
@!stat if tracing_paragraphs>0 then end_diagnostic(true);@+tats@;
print_err("Infinite glue shrinkage found in a paragraph");
@.Infinite glue shrinkage...@>
help5("The paragraph just ended includes some glue that has")@/
("infinite shrinkability, e.g., `\hskip 0pt minus 1fil'.")@/
("Such glue doesn't belong there---it allows a paragraph")@/
("of any length to fit on one line. But it's safe to proceed,")@/
("since the offensive shrinkability has been made finite.");
error;
@!stat if tracing_paragraphs>0 then begin_diagnostic;@+tats@;
end;
q:=new_spec(p); shrink_order(q):=normal;
delete_glue_ref(p); finite_shrink:=q;
end;
@ @<Get ready to start...@>=
no_shrink_error_yet:=true;@/
check_shrinkage(left_skip); check_shrinkage(right_skip);@/
q:=left_skip; r:=right_skip; background[1]:=width(q)+width(r);@/
background[2]:=0; background[3]:=0; background[4]:=0; background[5]:=0;@/
background[2+stretch_order(q)]:=stretch(q);@/
background[2+stretch_order(r)]:=@|background[2+stretch_order(r)]+stretch(r);@/
background[6]:=shrink(q)+shrink(r);
if pdf_adjust_spacing > 1 then begin
background[7] := 0;
background[8] := 0;
max_stretch_ratio := -1;
max_shrink_ratio := -1;
cur_font_step := -1;
prev_char_p := null;
end;
@<Check for special treatment of last line of paragraph@>;
@ A pointer variable |cur_p| runs through the given horizontal list as we look
for breakpoints. This variable is global, since it is used both by |line_break|
and by its subprocedure |try_break|.
Another global variable called |threshold| is used to determine the feasibility
of individual lines: Breakpoints are feasible if there is a way to reach
them without creating lines whose badness exceeds |threshold|. (The
badness is compared to |threshold| before penalties are added, so that
penalty values do not affect the feasibility of breakpoints, except that
no break is allowed when the penalty is 10000 or more.) If |threshold|
is 10000 or more, all legal breaks are considered feasible, since the
|badness| function specified above never returns a value greater than~10000.
Up to three passes might be made through the paragraph in an attempt to find at
least one set of feasible breakpoints. On the first pass, we have
|threshold=pretolerance| and |second_pass=final_pass=false|.
If this pass fails to find a
feasible solution, |threshold| is set to |tolerance|, |second_pass| is set
|true|, and an attempt is made to hyphenate as many words as possible.
If that fails too, we add |emergency_stretch| to the background
stretchability and set |final_pass=true|.
@<Glob...@>=
@!cur_p:pointer; {the current breakpoint under consideration}
@!second_pass:boolean; {is this our second attempt to break this paragraph?}
@!final_pass:boolean; {is this our final attempt to break this paragraph?}
@!threshold:integer; {maximum badness on feasible lines}
@ The heart of the line-breaking procedure is `|try_break|', a subroutine
that tests if the current breakpoint |cur_p| is feasible, by running
through the active list to see what lines of text can be made from active
nodes to~|cur_p|. If feasible breaks are possible, new break nodes are
created. If |cur_p| is too far from an active node, that node is
deactivated.
The parameter |pi| to |try_break| is the penalty associated
with a break at |cur_p|; we have |pi=eject_penalty| if the break is forced,
and |pi=inf_penalty| if the break is illegal.
The other parameter, |break_type|, is set to |hyphenated| or |unhyphenated|,
depending on whether or not the current break is at a |disc_node|. The
end of a paragraph is also regarded as `|hyphenated|'; this case is
distinguishable by the condition |cur_p=null|.
@d copy_to_cur_active(#)==cur_active_width[#]:=active_width[#]
@d deactivate=60 {go here when node |r| should be deactivated}
@d cp_skipable(#) == {skipable nodes at the margins during character protrusion}
(
not is_char_node(#) and
(
(type(#) = ins_node)
or (type(#) = mark_node)
or (type(#) = adjust_node)
or (type(#) = penalty_node)
or ((type(#) = whatsit_node) and
(subtype(#) <> pdf_refximage_node) and
(subtype(#) <> pdf_refxform_node)) {reference to an image or XObject form}
or ((type(#) = disc_node) and
(pre_break(#) = null) and
(post_break(#) = null) and
(replace_count(#) = 0)) {an empty |disc_node|}
or ((type(#) = math_node) and (width(#) = 0))
or ((type(#) = kern_node) and
((width(#) = 0) or (subtype(#) = normal)
or (subtype(#) = auto_kern)))
or ((type(#) = glue_node) and (glue_ptr(#) = zero_glue))
or ((type(#) = hlist_node) and (width(#) = 0) and (height(#) = 0) and
(depth(#) = 0) and (list_ptr(#) = null))
)
)
@<Declare subprocedures for |line_break|@>=
procedure push_node(p: pointer);
begin
if hlist_stack_level > max_hlist_stack then
pdf_error("push_node", "stack overflow");
hlist_stack[hlist_stack_level] := p;
hlist_stack_level := hlist_stack_level + 1;
end;
function pop_node: pointer;
begin
hlist_stack_level := hlist_stack_level - 1;
if hlist_stack_level < 0 then {would point to some bug}
pdf_error("pop_node", "stack underflow (internal error)");
pop_node := hlist_stack[hlist_stack_level];
end;
function find_protchar_left(l: pointer; d: boolean): pointer;
{searches left to right from list head |l|, returns 1st non-skipable item}
var t: pointer;
run: boolean;
begin
if (link(l) <> null) and (type(l) = hlist_node) and (width(l) = 0)
and (height(l) = 0) and (depth(l) = 0) and (list_ptr(l) = null) then
l := link(l) {for paragraph start with \.{\\parindent = 0pt}}
else if d then
while (link(l) <> null) and (not (is_char_node(l) or non_discardable(l))) do
l := link(l); {std.\ discardables at line break, \TeX book, p 95}
hlist_stack_level := 0;
run := true;
repeat
t := l;
while run and (type(l) = hlist_node) and (list_ptr(l) <> null) do begin
push_node(l);
l := list_ptr(l);
end;
while run and cp_skipable(l) do begin
while (link(l) = null) and (hlist_stack_level > 0) do begin
l := pop_node; {don't visit this node again}
end;
if link(l) <> null then
l := link(l)
else if hlist_stack_level = 0 then run := false
end;
until t = l;
find_protchar_left := l;
end;
function find_protchar_right(l, r: pointer): pointer;
{searches right to left from list tail |r| to head |l|, returns 1st non-skipable item}
var t: pointer;
run: boolean;
begin
find_protchar_right := null;
if r = null then return;
hlist_stack_level := 0;
run := true;
repeat
t := r;
while run and (type(r) = hlist_node) and (list_ptr(r) <> null) do begin
push_node(l);
push_node(r);
l := list_ptr(r);
r := l;
while link(r) <> null do
r := link(r);
end;
while run and cp_skipable(r) do begin
while (r = l) and (hlist_stack_level > 0) do begin
r := pop_node; {don't visit this node again}
l := pop_node;
end;
if (r <> l) and (r <> null) then
r := prev_rightmost(l, r)
else if (r = l) and (hlist_stack_level = 0) then run := false
end;
until t = r;
find_protchar_right := r;
end;
function total_pw(q, p: pointer): scaled;
{returns the total width of character protrusion of a line;
|cur_break(break_node(q))| and |p| is the leftmost resp. rightmost node in the
horizontal list representing the actual line}
var l, r: pointer;
n: integer;
begin
if break_node(q) = null then
l := first_p
else
l := cur_break(break_node(q));
r := prev_rightmost(prev_p, p); {get |link(r)=p|}
{let's look at the right margin first}
@{
short_display_n(r, 2);
print("&");
short_display_n(p, 2);
print_ln;
@}
if (p <> null) and (type(p) = disc_node) and (pre_break(p) <> null) then
{a |disc_node| with non-empty |pre_break|, protrude the last char of |pre_break|}
begin
r := pre_break(p);
while link(r) <> null do
r := link(r);
end else r := find_protchar_right(l, r);
{now the left margin}
@{
short_display_n(l, 2);
print_ln;
breadth_max := 10;
depth_threshold := 2;
show_node_list(l);
print_ln;
@}
if (l <> null) and (type(l) = disc_node) then begin
if post_break(l) <> null then begin
l := post_break(l); {protrude the first char}
goto done;
end else {discard |replace_count(l)| nodes}
begin
n := replace_count(l);
l := link(l);
while n > 0 do begin
if link(l) <> null then
l := link(l);
decr(n);
end;
end;
end;
l := find_protchar_left(l, true);
done:
total_pw := left_pw(l) + right_pw(r);
end;
procedure try_break(@!pi:integer;@!break_type:small_number);
label exit,done,done1,continue,deactivate,found,not_found;
var r:pointer; {runs through the active list}
@!margin_kern_stretch: scaled;
@!margin_kern_shrink: scaled;
@!lp, rp, cp: pointer;
@!prev_r:pointer; {stays a step behind |r|}
@!old_l:halfword; {maximum line number in current equivalence class of lines}
@!no_break_yet:boolean; {have we found a feasible break at |cur_p|?}
@<Other local variables for |try_break|@>@;
begin @<Make sure that |pi| is in the proper range@>;
no_break_yet:=true; prev_r:=active; old_l:=0;
do_all_eight(copy_to_cur_active);
loop@+ begin continue: r:=link(prev_r);
@<If node |r| is of type |delta_node|, update |cur_active_width|,
set |prev_r| and |prev_prev_r|, then |goto continue|@>;
@<If a line number class has ended, create new active nodes for
the best feasible breaks in that class; then |return|
if |r=last_active|, otherwise compute the new |line_width|@>;
@<Consider the demerits for a line from |r| to |cur_p|;
deactivate node |r| if it should no longer be active;
then |goto continue| if a line from |r| to |cur_p| is infeasible,
otherwise record a new feasible break@>;
end;
exit: @!stat @<Update the value of |printed_node| for
symbolic displays@>@+tats@;
end;
@ @<Other local variables for |try_break|@>=
@!prev_prev_r:pointer; {a step behind |prev_r|, if |type(prev_r)=delta_node|}
@!s:pointer; {runs through nodes ahead of |cur_p|}
@!q:pointer; {points to a new node being created}
@!v:pointer; {points to a glue specification or a node ahead of |cur_p|}
@!t:integer; {node count, if |cur_p| is a discretionary node}
@!f:internal_font_number; {used in character width calculation}
@!l:halfword; {line number of current active node}
@!node_r_stays_active:boolean; {should node |r| remain in the active list?}
@!line_width:scaled; {the current line will be justified to this width}
@!fit_class:very_loose_fit..tight_fit; {possible fitness class of test line}
@!b:halfword; {badness of test line}
@!d:integer; {demerits of test line}
@!artificial_demerits:boolean; {has |d| been forced to zero?}
@!save_link:pointer; {temporarily holds value of |link(cur_p)|}
@!shortfall:scaled; {used in badness calculations}
@ @<Make sure that |pi| is in the proper range@>=
if abs(pi)>=inf_penalty then
if pi>0 then return {this breakpoint is inhibited by infinite penalty}
else pi:=eject_penalty {this breakpoint will be forced}
@ The following code uses the fact that |type(last_active)<>delta_node|.
@d update_width(#)==@|
cur_active_width[#]:=cur_active_width[#]+mem[r+#].sc
@<If node |r|...@>=
@^inner loop@>
if type(r)=delta_node then
begin do_all_eight(update_width);
prev_prev_r:=prev_r; prev_r:=r; goto continue;
end
@ As we consider various ways to end a line at |cur_p|, in a given line number
class, we keep track of the best total demerits known, in an array with
one entry for each of the fitness classifications. For example,
|minimal_demerits[tight_fit]| contains the fewest total demerits of feasible
line breaks ending at |cur_p| with a |tight_fit| line; |best_place[tight_fit]|
points to the passive node for the break before~|cur_p| that achieves such
an optimum; and |best_pl_line[tight_fit]| is the |line_number| field in the
active node corresponding to |best_place[tight_fit]|. When no feasible break
sequence is known, the |minimal_demerits| entries will be equal to
|awful_bad|, which is $2^{30}-1$. Another variable, |minimum_demerits|,
keeps track of the smallest value in the |minimal_demerits| array.
@d awful_bad==@'7777777777 {more than a billion demerits}
@<Global...@>=
@!minimal_demerits:array[very_loose_fit..tight_fit] of integer; {best total
demerits known for current line class and position, given the fitness}
@!minimum_demerits:integer; {best total demerits known for current line class
and position}
@!best_place:array[very_loose_fit..tight_fit] of pointer; {how to achieve
|minimal_demerits|}
@!best_pl_line:array[very_loose_fit..tight_fit] of halfword; {corresponding
line number}
@ @<Get ready to start...@>=
minimum_demerits:=awful_bad;
minimal_demerits[tight_fit]:=awful_bad;
minimal_demerits[decent_fit]:=awful_bad;
minimal_demerits[loose_fit]:=awful_bad;
minimal_demerits[very_loose_fit]:=awful_bad;
@ The first part of the following code is part of \TeX's inner loop, so
we don't want to waste any time. The current active node, namely node |r|,
contains the line number that will be considered next. At the end of the
list we have arranged the data structure so that |r=last_active| and
|line_number(last_active)>old_l|.
@^inner loop@>
@<If a line number class...@>=
begin l:=line_number(r);
if l>old_l then
begin {now we are no longer in the inner loop}
if (minimum_demerits<awful_bad)and@|
((old_l<>easy_line)or(r=last_active)) then
@<Create new active nodes for the best feasible breaks
just found@>;
if r=last_active then return;
@<Compute the new line width@>;
end;
end
@ It is not necessary to create new active nodes having |minimal_demerits|
greater than
|minimum_demerits+abs(adj_demerits)|, since such active nodes will never
be chosen in the final paragraph breaks. This observation allows us to
omit a substantial number of feasible breakpoints from further consideration.
@<Create new active nodes...@>=
begin if no_break_yet then @<Compute the values of |break_width|@>;
@<Insert a delta node to prepare for breaks at |cur_p|@>;
if abs(adj_demerits)>=awful_bad-minimum_demerits then
minimum_demerits:=awful_bad-1
else minimum_demerits:=minimum_demerits+abs(adj_demerits);
for fit_class:=very_loose_fit to tight_fit do
begin if minimal_demerits[fit_class]<=minimum_demerits then
@<Insert a new active node
from |best_place[fit_class]| to |cur_p|@>;
minimal_demerits[fit_class]:=awful_bad;
end;
minimum_demerits:=awful_bad;
@<Insert a delta node to prepare for the next active node@>;
end
@ When we insert a new active node for a break at |cur_p|, suppose this
new node is to be placed just before active node |a|; then we essentially
want to insert `$\delta\,|cur_p|\,\delta^\prime$' before |a|, where
$\delta=\alpha(a)-\alpha(|cur_p|)$ and $\delta^\prime=\alpha(|cur_p|)-\alpha(a)$
in the notation explained above. The |cur_active_width| array now holds
$\gamma+\beta(|cur_p|)-\alpha(a)$; so $\delta$ can be obtained by
subtracting |cur_active_width| from the quantity $\gamma+\beta(|cur_p|)-
\alpha(|cur_p|)$. The latter quantity can be regarded as the length of a
line ``from |cur_p| to |cur_p|''; we call it the |break_width| at |cur_p|.
The |break_width| is usually negative, since it consists of the background
(which is normally zero) minus the width of nodes following~|cur_p| that are
eliminated after a break. If, for example, node |cur_p| is a glue node, the
width of this glue is subtracted from the background; and we also look
ahead to eliminate all subsequent glue and penalty and kern and math
nodes, subtracting their widths as well.
Kern nodes do not disappear at a line break unless they are |explicit|.
@d set_break_width_to_background(#)==break_width[#]:=background[#]
@<Compute the values of |break...@>=
begin no_break_yet:=false; do_all_eight(set_break_width_to_background);
s:=cur_p;
if break_type>unhyphenated then if cur_p<>null then
@<Compute the discretionary |break_width| values@>;
while s<>null do
begin if is_char_node(s) then goto done;
case type(s) of
glue_node:@<Subtract glue from |break_width|@>;
penalty_node: do_nothing;
math_node: break_width[1]:=break_width[1]-width(s);
kern_node: if subtype(s)<>explicit then goto done
else break_width[1]:=break_width[1]-width(s);
othercases goto done
endcases;@/
s:=link(s);
end;
done: end
@ @<Subtract glue from |break...@>=
begin v:=glue_ptr(s); break_width[1]:=break_width[1]-width(v);
break_width[2+stretch_order(v)]:=break_width[2+stretch_order(v)]-stretch(v);
break_width[6]:=break_width[6]-shrink(v);
end
@ When |cur_p| is a discretionary break, the length of a line ``from |cur_p| to
|cur_p|'' has to be defined properly so that the other calculations work out.
Suppose that the pre-break text at |cur_p| has length $l_0$, the post-break
text has length $l_1$, and the replacement text has length |l|. Suppose
also that |q| is the node following the replacement text. Then length of a
line from |cur_p| to |q| will be computed as $\gamma+\beta(q)-\alpha(|cur_p|)$,
where $\beta(q)=\beta(|cur_p|)-l_0+l$. The actual length will be the background
plus $l_1$, so the length from |cur_p| to |cur_p| should be $\gamma+l_0+l_1-l$.
If the post-break text of the discretionary is empty, a break may also
discard~|q|; in that unusual case we subtract the length of~|q| and any
other nodes that will be discarded after the discretionary break.
The value of $l_0$ need not be computed, since |line_break| will put
it into the global variable |disc_width| before calling |try_break|.
@d reset_disc_width(#) == disc_width[#] := 0
@d add_disc_width_to_break_width(#) ==
break_width[#] := break_width[#] + disc_width[#]
@d add_disc_width_to_active_width(#) ==
active_width[#] := active_width[#] + disc_width[#]
@d sub_disc_width_from_active_width(#) ==
active_width[#] := active_width[#] - disc_width[#]
@d add_char_stretch_end(#) == char_stretch(f, #)
@d add_char_stretch(#) == # := # + add_char_stretch_end
@d add_char_shrink_end(#) == char_shrink(f, #)
@d add_char_shrink(#) == # := # + add_char_shrink_end
@d sub_char_stretch_end(#) == char_stretch(f, #)
@d sub_char_stretch(#) == # := # - sub_char_stretch_end
@d sub_char_shrink_end(#) == char_shrink(f, #)
@d sub_char_shrink(#) == # := # - sub_char_shrink_end
@d add_kern_stretch_end(#) == kern_stretch(#)
@d add_kern_stretch(#) == # := # + add_kern_stretch_end
@d add_kern_shrink_end(#) == kern_shrink(#)
@d add_kern_shrink(#) == # := # + add_kern_shrink_end
@d sub_kern_stretch_end(#) == kern_stretch(#)
@d sub_kern_stretch(#) == # := # - sub_kern_stretch_end
@d sub_kern_shrink_end(#) == kern_shrink(#)
@d sub_kern_shrink(#) == # := # - sub_kern_shrink_end
@<Glob...@>=
@!disc_width: array[1..8] of scaled; {the length of discretionary material preceding a break}
@ @<Compute the discretionary |break...@>=
begin t:=replace_count(cur_p); v:=cur_p; s:=post_break(cur_p);
while t>0 do
begin decr(t); v:=link(v);
@<Subtract the width of node |v| from |break_width|@>;
end;
while s<>null do
begin @<Add the width of node |s| to |break_width|@>;
s:=link(s);
end;
do_one_seven_eight(add_disc_width_to_break_width);
if post_break(cur_p)=null then s:=link(v);
{nodes may be discardable after the break}
end
@ Replacement texts and discretionary texts are supposed to contain
only character nodes, kern nodes, ligature nodes, and box or rule nodes.
@<Subtract the width of node |v|...@>=
if is_char_node(v) then
begin f:=font(v);
break_width[1]:=break_width[1]-char_width(f)(char_info(f)(character(v)));
if (pdf_adjust_spacing > 1) and check_expand_pars(f) then begin
prev_char_p := v;
sub_char_stretch(break_width[7])(character(v));
sub_char_shrink(break_width[8])(character(v));
end;
end
else case type(v) of
ligature_node: begin f:=font(lig_char(v));@/
break_width[1]:=@|break_width[1]-
char_width(f)(char_info(f)(character(lig_char(v))));
if (pdf_adjust_spacing > 1) and check_expand_pars(f) then begin
prev_char_p := v;
sub_char_stretch(break_width[7])(character(lig_char(v)));
sub_char_shrink(break_width[8])(character(lig_char(v)));
end;
end;
hlist_node,vlist_node,rule_node,kern_node: begin
break_width[1]:=break_width[1]-width(v);
if (type(v) = kern_node) and
(pdf_adjust_spacing > 1) and (subtype(v) = normal)
then begin
sub_kern_stretch(break_width[7])(v);
sub_kern_shrink(break_width[8])(v);
end;
end;
othercases confusion("disc1")
@:this can't happen disc1}{\quad disc1@>
endcases
@ @<Add the width of node |s| to |b...@>=
if is_char_node(s) then
begin f:=font(s);
break_width[1]:=@|break_width[1]+char_width(f)(char_info(f)(character(s)));
if (pdf_adjust_spacing > 1) and check_expand_pars(f) then begin
prev_char_p := s;
add_char_stretch(break_width[7])(character(s));
add_char_shrink(break_width[8])(character(s));
end;
end
else case type(s) of
ligature_node: begin f:=font(lig_char(s));
break_width[1]:=break_width[1]+
char_width(f)(char_info(f)(character(lig_char(s))));
if (pdf_adjust_spacing > 1) and check_expand_pars(f) then begin
prev_char_p := s;
add_char_stretch(break_width[7])(character(lig_char(s)));
add_char_shrink(break_width[8])(character(lig_char(s)));
end;
end;
hlist_node,vlist_node,rule_node,kern_node: begin
break_width[1]:=break_width[1]+width(s);
if (type(s) = kern_node) and
(pdf_adjust_spacing > 1) and (subtype(s) = normal)
then begin
add_kern_stretch(break_width[7])(s);
add_kern_shrink(break_width[8])(s);
end;
end;
othercases confusion("disc2")
@:this can't happen disc2}{\quad disc2@>
endcases
@ We use the fact that |type(active)<>delta_node|.
@d convert_to_break_width(#)==@|
mem[prev_r+#].sc:=@|@t\hskip10pt@>mem[prev_r+#].sc
-cur_active_width[#]+break_width[#]
@d store_break_width(#)==active_width[#]:=break_width[#]
@d new_delta_to_break_width(#)==@|
mem[q+#].sc:=break_width[#]-cur_active_width[#]
@<Insert a delta node to prepare for breaks at |cur_p|@>=
if type(prev_r)=delta_node then {modify an existing delta node}
begin do_all_eight(convert_to_break_width);
end
else if prev_r=active then {no delta node needed at the beginning}
begin do_all_eight(store_break_width);
end
else begin q:=get_node(delta_node_size); link(q):=r; type(q):=delta_node;@/
subtype(q):=0; {the |subtype| is not used}
do_all_eight(new_delta_to_break_width);
link(prev_r):=q; prev_prev_r:=prev_r; prev_r:=q;
end
@ When the following code is performed, we will have just inserted at
least one active node before |r|, so |type(prev_r)<>delta_node|.
@d new_delta_from_break_width(#)==@|mem[q+#].sc:=
cur_active_width[#]-break_width[#]
@<Insert a delta node to prepare for the next active node@>=
if r<>last_active then
begin q:=get_node(delta_node_size); link(q):=r; type(q):=delta_node;@/
subtype(q):=0; {the |subtype| is not used}
do_all_eight(new_delta_from_break_width);
link(prev_r):=q; prev_prev_r:=prev_r; prev_r:=q;
end
@ When we create an active node, we also create the corresponding
passive node.
@<Insert a new active node from |best_place[fit_class]| to |cur_p|@>=
begin q:=get_node(passive_node_size);
link(q):=passive; passive:=q; cur_break(q):=cur_p;
@!stat incr(pass_number); serial(q):=pass_number;@+tats@;@/
prev_break(q):=best_place[fit_class];@/
q:=get_node(active_node_size); break_node(q):=passive;
line_number(q):=best_pl_line[fit_class]+1;
fitness(q):=fit_class; type(q):=break_type;
total_demerits(q):=minimal_demerits[fit_class];
if do_last_line_fit then
@<Store \(a)additional data in the new active node@>;
link(q):=r; link(prev_r):=q; prev_r:=q;
@!stat if tracing_paragraphs>0 then
@<Print a symbolic description of the new break node@>;
tats@;@/
end
@ @<Print a symbolic description of the new break node@>=
begin print_nl("@@@@"); print_int(serial(passive));
@.\AT!\AT!@>
print(": line "); print_int(line_number(q)-1);
print_char("."); print_int(fit_class);
if break_type=hyphenated then print_char("-");
print(" t="); print_int(total_demerits(q));
if do_last_line_fit then @<Print additional data in the new active node@>;
print(" -> @@@@");
if prev_break(passive)=null then print_char("0")
else print_int(serial(prev_break(passive)));
end
@ The length of lines depends on whether the user has specified
\.{\\parshape} or \.{\\hangindent}. If |par_shape_ptr| is not null, it
points to a $(2n+1)$-word record in |mem|, where the |info| in the first
word contains the value of |n|, and the other $2n$ words contain the left
margins and line lengths for the first |n| lines of the paragraph; the
specifications for line |n| apply to all subsequent lines. If
|par_shape_ptr=null|, the shape of the paragraph depends on the value of
|n=hang_after|; if |n>=0|, hanging indentation takes place on lines |n+1|,
|n+2|, \dots, otherwise it takes place on lines 1, \dots, $\vert
n\vert$. When hanging indentation is active, the left margin is
|hang_indent|, if |hang_indent>=0|, else it is 0; the line length is
$|hsize|-\vert|hang_indent|\vert$. The normal setting is
|par_shape_ptr=null|, |hang_after=1|, and |hang_indent=0|.
Note that if |hang_indent=0|, the value of |hang_after| is irrelevant.
@^length of lines@> @^hanging indentation@>
@<Glob...@>=
@!easy_line:halfword; {line numbers |>easy_line| are equivalent in break nodes}
@!last_special_line:halfword; {line numbers |>last_special_line| all have
the same width}
@!first_width:scaled; {the width of all lines |<=last_special_line|, if
no \.{\\parshape} has been specified}
@!second_width:scaled; {the width of all lines |>last_special_line|}
@!first_indent:scaled; {left margin to go with |first_width|}
@!second_indent:scaled; {left margin to go with |second_width|}
@ We compute the values of |easy_line| and the other local variables relating
to line length when the |line_break| procedure is initializing itself.
@<Get ready to start...@>=
if par_shape_ptr=null then
if hang_indent=0 then
begin last_special_line:=0; second_width:=hsize;
second_indent:=0;
end
else @<Set line length parameters in preparation for hanging indentation@>
else begin last_special_line:=info(par_shape_ptr)-1;
second_width:=mem[par_shape_ptr+2*(last_special_line+1)].sc;
second_indent:=mem[par_shape_ptr+2*last_special_line+1].sc;
end;
if looseness=0 then easy_line:=last_special_line
else easy_line:=max_halfword
@ @<Set line length parameters in preparation for hanging indentation@>=
begin last_special_line:=abs(hang_after);
if hang_after<0 then
begin first_width:=hsize-abs(hang_indent);
if hang_indent>=0 then first_indent:=hang_indent
else first_indent:=0;
second_width:=hsize; second_indent:=0;
end
else begin first_width:=hsize; first_indent:=0;
second_width:=hsize-abs(hang_indent);
if hang_indent>=0 then second_indent:=hang_indent
else second_indent:=0;
end;
end
@ When we come to the following code, we have just encountered the first
active node~|r| whose |line_number| field contains |l|. Thus we want to
compute the length of the $l\mskip1mu$th line of the current paragraph. Furthermore,
we want to set |old_l| to the last number in the class of line numbers
equivalent to~|l|.
@<Compute the new line width@>=
if l>easy_line then
begin line_width:=second_width; old_l:=max_halfword-1;
end
else begin old_l:=l;
if l>last_special_line then line_width:=second_width
else if par_shape_ptr=null then line_width:=first_width
else line_width:=mem[par_shape_ptr+2*l@,].sc;
end
@ The remaining part of |try_break| deals with the calculation of
demerits for a break from |r| to |cur_p|.
The first thing to do is calculate the badness, |b|. This value will always
be between zero and |inf_bad+1|; the latter value occurs only in the
case of lines from |r| to |cur_p| that cannot shrink enough to fit the necessary
width. In such cases, node |r| will be deactivated.
We also deactivate node~|r| when a break at~|cur_p| is forced, since future
breaks must go through a forced break.
@<Consider the demerits for a line from |r| to |cur_p|...@>=
begin artificial_demerits:=false;@/
@^inner loop@>
shortfall:=line_width-cur_active_width[1]; {we're this much too short}
@{
if pdf_output > 2 then begin
print_ln;
if (r <> null) and (break_node(r) <> null) then
short_display_n(cur_break(break_node(r)), 5);
print_ln;
short_display_n(cur_p, 5);
print_ln;
end;
@}
if pdf_protrude_chars > 1 then
shortfall := shortfall + total_pw(r, cur_p);
if (pdf_adjust_spacing > 1) and (shortfall <> 0) then begin
margin_kern_stretch := 0;
margin_kern_shrink := 0;
if pdf_protrude_chars > 1 then
@<Calculate variations of marginal kerns@>;
if (shortfall > 0) and ((total_font_stretch + margin_kern_stretch) > 0)
then begin
if (total_font_stretch + margin_kern_stretch) > shortfall then
shortfall := ((total_font_stretch + margin_kern_stretch) div
(max_stretch_ratio div cur_font_step)) div 2
else
shortfall := shortfall - (total_font_stretch + margin_kern_stretch);
end
else if (shortfall < 0) and ((total_font_shrink + margin_kern_shrink) > 0)
then begin
if (total_font_shrink + margin_kern_shrink) > -shortfall then
shortfall := -((total_font_shrink + margin_kern_shrink) div
(max_shrink_ratio div cur_font_step)) div 2
else
shortfall := shortfall + (total_font_shrink + margin_kern_shrink);
end;
end;
if shortfall>0 then
@<Set the value of |b| to the badness for stretching the line,
and compute the corresponding |fit_class|@>
else @<Set the value of |b| to the badness for shrinking the line,
and compute the corresponding |fit_class|@>;
if do_last_line_fit then @<Adjust \(t)the additional data for last line@>;
found:
if (b>inf_bad)or(pi=eject_penalty) then
@<Prepare to deactivate node~|r|, and |goto deactivate| unless
there is a reason to consider lines of text from |r| to |cur_p|@>
else begin prev_r:=r;
if b>threshold then goto continue;
node_r_stays_active:=true;
end;
@<Record a new feasible break@>;
if node_r_stays_active then goto continue; {|prev_r| has been set to |r|}
deactivate: @<Deactivate node |r|@>;
end
@ When a line must stretch, the available stretchability can be found in the
subarray |cur_active_width[2..5]|, in units of points, fil, fill, and filll.
The present section is part of \TeX's inner loop, and it is most often performed
when the badness is infinite; therefore it is worth while to make a quick
test for large width excess and small stretchability, before calling the
|badness| subroutine.
@^inner loop@>
@<Set the value of |b| to the badness for stretching...@>=
if (cur_active_width[3]<>0)or(cur_active_width[4]<>0)or@|
(cur_active_width[5]<>0) then
begin if do_last_line_fit then
begin if cur_p=null then {the last line of a paragraph}
@<Perform computations for last line and |goto found|@>;
shortfall:=0;
end;
b:=0; fit_class:=decent_fit; {infinite stretch}
end
else begin if shortfall>7230584 then if cur_active_width[2]<1663497 then
begin b:=inf_bad; fit_class:=very_loose_fit; goto done1;
end;
b:=badness(shortfall,cur_active_width[2]);
if b>12 then
if b>99 then fit_class:=very_loose_fit
else fit_class:=loose_fit
else fit_class:=decent_fit;
done1:
end
@ Shrinkability is never infinite in a paragraph;
we can shrink the line from |r| to |cur_p| by at most |cur_active_width[6]|.
@<Set the value of |b| to the badness for shrinking...@>=
begin if -shortfall>cur_active_width[6] then b:=inf_bad+1
else b:=badness(-shortfall,cur_active_width[6]);
if b>12 then fit_class:=tight_fit@+else fit_class:=decent_fit;
end
@ During the final pass, we dare not lose all active nodes, lest we lose
touch with the line breaks already found. The code shown here makes sure
that such a catastrophe does not happen, by permitting overfull boxes as
a last resort. This particular part of \TeX\ was a source of several subtle
bugs before the correct program logic was finally discovered; readers
who seek to ``improve'' \TeX\ should therefore think thrice before daring
to make any changes here.
@^overfull boxes@>
@<Prepare to deactivate node~|r|, and |goto deactivate| unless...@>=
begin if final_pass and (minimum_demerits=awful_bad) and@|
(link(r)=last_active) and
(prev_r=active) then
artificial_demerits:=true {set demerits zero, this break is forced}
else if b>threshold then goto deactivate;
node_r_stays_active:=false;
end
@ When we get to this part of the code, the line from |r| to |cur_p| is
feasible, its badness is~|b|, and its fitness classification is |fit_class|.
We don't want to make an active node for this break yet, but we will
compute the total demerits and record them in the |minimal_demerits| array,
if such a break is the current champion among all ways to get to |cur_p|
in a given line-number class and fitness class.
@<Record a new feasible break@>=
if artificial_demerits then d:=0
else @<Compute the demerits, |d|, from |r| to |cur_p|@>;
@!stat if tracing_paragraphs>0 then
@<Print a symbolic description of this feasible break@>;
tats@;@/
d:=d+total_demerits(r); {this is the minimum total demerits
from the beginning to |cur_p| via |r|}
if d<=minimal_demerits[fit_class] then
begin minimal_demerits[fit_class]:=d;
best_place[fit_class]:=break_node(r); best_pl_line[fit_class]:=l;
if do_last_line_fit then
@<Store \(a)additional data for this feasible break@>;
if d<minimum_demerits then minimum_demerits:=d;
end
@ @<Print a symbolic description of this feasible break@>=
begin if printed_node<>cur_p then
@<Print the list between |printed_node| and |cur_p|,
then set |printed_node:=cur_p|@>;
print_nl("@@");
@.\AT!@>
if cur_p=null then print_esc("par")
else if type(cur_p)<>glue_node then
begin if type(cur_p)=penalty_node then print_esc("penalty")
else if type(cur_p)=disc_node then print_esc("discretionary")
else if type(cur_p)=kern_node then print_esc("kern")
else print_esc("math");
end;
print(" via @@@@");
if break_node(r)=null then print_char("0")
else print_int(serial(break_node(r)));
print(" b=");
if b>inf_bad then print_char("*")@+else print_int(b);
@.*\relax@>
print(" p="); print_int(pi); print(" d=");
if artificial_demerits then print_char("*")@+else print_int(d);
end
@ @<Print the list between |printed_node| and |cur_p|...@>=
begin print_nl("");
if cur_p=null then short_display(link(printed_node))
else begin save_link:=link(cur_p);
link(cur_p):=null; print_nl(""); short_display(link(printed_node));
link(cur_p):=save_link;
end;
printed_node:=cur_p;
end
@ When the data for a discretionary break is being displayed, we will have
printed the |pre_break| and |post_break| lists; we want to skip over the
third list, so that the discretionary data will not appear twice. The
following code is performed at the very end of |try_break|.
@<Update the value of |printed_node|...@>=
if cur_p=printed_node then if cur_p<>null then if type(cur_p)=disc_node then
begin t:=replace_count(cur_p);
while t>0 do
begin decr(t); printed_node:=link(printed_node);
end;
end
@ @<Compute the demerits, |d|, from |r| to |cur_p|@>=
begin d:=line_penalty+b;
if abs(d)>=10000 then d:=100000000@+else d:=d*d;
if pi<>0 then
if pi>0 then d:=d+pi*pi
else if pi>eject_penalty then d:=d-pi*pi;
if (break_type=hyphenated)and(type(r)=hyphenated) then
if cur_p<>null then d:=d+double_hyphen_demerits
else d:=d+final_hyphen_demerits;
if abs(fit_class-fitness(r))>1 then d:=d+adj_demerits;
end
@ When an active node disappears, we must delete an adjacent delta node if the
active node was at the beginning or the end of the active list, or if it
was surrounded by delta nodes. We also must preserve the property that
|cur_active_width| represents the length of material from |link(prev_r)|
to~|cur_p|.
@d combine_two_deltas(#)==@|mem[prev_r+#].sc:=mem[prev_r+#].sc+mem[r+#].sc
@d downdate_width(#)==@|cur_active_width[#]:=cur_active_width[#]-
mem[prev_r+#].sc
@<Deactivate node |r|@>=
link(prev_r):=link(r); free_node(r,active_node_size);
if prev_r=active then @<Update the active widths, since the first active
node has been deleted@>
else if type(prev_r)=delta_node then
begin r:=link(prev_r);
if r=last_active then
begin do_all_eight(downdate_width);
link(prev_prev_r):=last_active;
free_node(prev_r,delta_node_size); prev_r:=prev_prev_r;
end
else if type(r)=delta_node then
begin do_all_eight(update_width);
do_all_eight(combine_two_deltas);
link(prev_r):=link(r); free_node(r,delta_node_size);
end;
end
@ The following code uses the fact that |type(last_active)<>delta_node|. If the
active list has just become empty, we do not need to update the
|active_width| array, since it will be initialized when an active
node is next inserted.
@d update_active(#)==active_width[#]:=active_width[#]+mem[r+#].sc
@<Update the active widths,...@>=
begin r:=link(active);
if type(r)=delta_node then
begin do_all_eight(update_active);
do_all_eight(copy_to_cur_active);
link(active):=link(r); free_node(r,delta_node_size);
end;
end
@* \[39] Breaking paragraphs into lines, continued.
So far we have gotten a little way into the |line_break| routine, having
covered its important |try_break| subroutine. Now let's consider the
rest of the process.
The main loop of |line_break| traverses the given hlist,
starting at |link(temp_head)|, and calls |try_break| at each legal
breakpoint. A variable called |auto_breaking| is set to true except
within math formulas, since glue nodes are not legal breakpoints when
they appear in formulas.
The current node of interest in the hlist is pointed to by |cur_p|. Another
variable, |prev_p|, is usually one step behind |cur_p|, but the real
meaning of |prev_p| is this: If |type(cur_p)=glue_node| then |cur_p| is a legal
breakpoint if and only if |auto_breaking| is true and |prev_p| does not
point to a glue node, penalty node, explicit kern node, or math node.
The following declarations provide for a few other local variables that are
used in special calculations.
@<Local variables for line breaking@>=
@!q,@!r,@!s,@!prev_s:pointer; {miscellaneous nodes of temporary interest}
@!f:internal_font_number; {used when calculating character widths}
@ The `\ignorespaces|loop|\unskip' in the following code is performed at most
thrice per call of |line_break|, since it is actually a pass over the
entire paragraph.
@<Find optimal breakpoints@>=
threshold:=pretolerance;
if threshold>=0 then
begin @!stat if tracing_paragraphs>0 then
begin begin_diagnostic; print_nl("@@firstpass");@+end;@;@+tats@;@/
second_pass:=false; final_pass:=false;
end
else begin threshold:=tolerance; second_pass:=true;
final_pass:=(emergency_stretch<=0);
@!stat if tracing_paragraphs>0 then begin_diagnostic;@+tats@;
end;
loop@+ begin if threshold>inf_bad then threshold:=inf_bad;
if second_pass then @<Initialize for hyphenating a paragraph@>;
@<Create an active breakpoint representing the beginning of the paragraph@>;
cur_p:=link(temp_head); auto_breaking:=true;@/
prev_p:=cur_p; {glue at beginning is not a legal breakpoint}
prev_char_p := null;
prev_legal := null;
rejected_cur_p := null;
try_prev_break := false;
before_rejected_cur_p := false;
first_p := cur_p; {to access the first node of paragraph as the first active
node has |break_node=null|}
while (cur_p<>null)and(link(active)<>last_active) do
@<Call |try_break| if |cur_p| is a legal breakpoint;
on the second pass, also try to hyphenate the next
word, if |cur_p| is a glue node;
then advance |cur_p| to the next node of the paragraph
that could possibly be a legal breakpoint@>;
if cur_p=null then
@<Try the final line break at the end of the paragraph,
and |goto done| if the desired breakpoints have been found@>;
@<Clean up the memory by removing the break nodes@>;
if not second_pass then
begin@!stat if tracing_paragraphs>0 then print_nl("@@secondpass");@;@+tats@/
threshold:=tolerance; second_pass:=true; final_pass:=(emergency_stretch<=0);
end {if at first you don't succeed, \dots}
else begin @!stat if tracing_paragraphs>0 then
print_nl("@@emergencypass");@;@+tats@/
background[2]:=background[2]+emergency_stretch; final_pass:=true;
end;
end;
done: @!stat if tracing_paragraphs>0 then
begin end_diagnostic(true); normalize_selector;
end;@+tats@/
if do_last_line_fit then @<Adjust \(t)the final line of the paragraph@>;
@ The active node that represents the starting point does not need a
corresponding passive node.
@d store_background(#)==active_width[#]:=background[#]
@<Create an active breakpoint representing the beginning of the paragraph@>=
q:=get_node(active_node_size);
type(q):=unhyphenated; fitness(q):=decent_fit;
link(q):=last_active; break_node(q):=null;
line_number(q):=prev_graf+1; total_demerits(q):=0; link(active):=q;
if do_last_line_fit then
@<Initialize additional fields of the first active node@>;
do_all_eight(store_background);@/
passive:=null; printed_node:=temp_head; pass_number:=0;
font_in_short_display:=null_font
@ @<Clean...@>=
q:=link(active);
while q<>last_active do
begin cur_p:=link(q);
if type(q)=delta_node then free_node(q,delta_node_size)
else free_node(q,active_node_size);
q:=cur_p;
end;
q:=passive;
while q<>null do
begin cur_p:=link(q);
free_node(q,passive_node_size);
q:=cur_p;
end
@ Here is the main switch in the |line_break| routine, where legal breaks
are determined. As we move through the hlist, we need to keep the |active_width|
array up to date, so that the badness of individual lines is readily calculated
by |try_break|. It is convenient to use the short name |act_width| for
the component of active width that represents real width as opposed to glue.
@d act_width==active_width[1] {length from first active node to current node}
@d kern_break==begin if not is_char_node(link(cur_p)) and auto_breaking then
if type(link(cur_p))=glue_node then try_break(0,unhyphenated);
act_width:=act_width+width(cur_p);
end
@<Call |try_break| if |cur_p| is a legal breakpoint...@>=
begin if is_char_node(cur_p) then
@<Advance \(c)|cur_p| to the node following the present
string of characters@>;
case type(cur_p) of
hlist_node,vlist_node,rule_node: act_width:=act_width+width(cur_p);
whatsit_node: @<Advance \(p)past a whatsit node in the \(l)|line_break| loop@>;
glue_node: begin @<If node |cur_p| is a legal breakpoint, call |try_break|;
then update the active widths by including the glue in |glue_ptr(cur_p)|@>;
if second_pass and auto_breaking then
@<Try to hyphenate the following word@>;
end;
kern_node: if subtype(cur_p)=explicit then kern_break
else begin
act_width:=act_width+width(cur_p);
if (pdf_adjust_spacing > 1) and (subtype(cur_p) = normal) then begin
add_kern_stretch(active_width[7])(cur_p);
add_kern_shrink(active_width[8])(cur_p);
end;
end;
ligature_node: begin f:=font(lig_char(cur_p));
act_width:=act_width+char_width(f)(char_info(f)(character(lig_char(cur_p))));
if (pdf_adjust_spacing > 1) and check_expand_pars(f) then begin
prev_char_p := cur_p;
add_char_stretch(active_width[7])(character(lig_char(cur_p)));
add_char_shrink(active_width[8])(character(lig_char(cur_p)));
end;
end;
disc_node: @<Try to break after a discretionary fragment, then |goto done5|@>;
math_node: begin if subtype(cur_p)<L_code then auto_breaking:=odd(subtype(cur_p));
kern_break;
end;
penalty_node: try_break(penalty(cur_p),unhyphenated);
mark_node,ins_node,adjust_node: do_nothing;
othercases confusion("paragraph")
@:this can't happen paragraph}{\quad paragraph@>
endcases;@/
prev_p:=cur_p; cur_p:=link(cur_p);
done5:end
@ The code that passes over the characters of words in a paragraph is
part of \TeX's inner loop, so it has been streamlined for speed. We use
the fact that `\.{\\parfillskip}' glue appears at the end of each paragraph;
it is therefore unnecessary to check if |link(cur_p)=null| when |cur_p| is a
character node.
@^inner loop@>
@<Advance \(c)|cur_p| to the node following the present string...@>=
begin prev_p:=cur_p;
repeat f:=font(cur_p);
act_width:=act_width+char_width(f)(char_info(f)(character(cur_p)));
if (pdf_adjust_spacing > 1) and check_expand_pars(f) then begin
prev_char_p := cur_p;
add_char_stretch(active_width[7])(character(cur_p));
add_char_shrink(active_width[8])(character(cur_p));
end;
cur_p:=link(cur_p);
until not is_char_node(cur_p);
end
@ When node |cur_p| is a glue node, we look at |prev_p| to see whether or not
a breakpoint is legal at |cur_p|, as explained above.
@<If node |cur_p| is a legal breakpoint, call...@>=
if auto_breaking then
begin if is_char_node(prev_p) then try_break(0,unhyphenated)
else if precedes_break(prev_p) then try_break(0,unhyphenated)
else if (type(prev_p)=kern_node)and(subtype(prev_p)<>explicit) then
try_break(0,unhyphenated);
end;
check_shrinkage(glue_ptr(cur_p)); q:=glue_ptr(cur_p);
act_width:=act_width+width(q);@|
active_width[2+stretch_order(q)]:=@|
active_width[2+stretch_order(q)]+stretch(q);@/
active_width[6]:=active_width[6]+shrink(q)
@ The following code knows that discretionary texts contain
only character nodes, kern nodes, box nodes, rule nodes, and ligature nodes.
@<Try to break after a discretionary fragment...@>=
begin s:=pre_break(cur_p);
do_one_seven_eight(reset_disc_width);
if s=null then try_break(ex_hyphen_penalty,hyphenated)
else begin repeat @<Add the width of node |s| to |disc_width|@>;
s:=link(s);
until s=null;
do_one_seven_eight(add_disc_width_to_active_width);
try_break(hyphen_penalty,hyphenated);
do_one_seven_eight(sub_disc_width_from_active_width);
end;
r:=replace_count(cur_p); s:=link(cur_p);
while r>0 do
begin @<Add the width of node |s| to |act_width|@>;
decr(r); s:=link(s);
end;
prev_p:=cur_p; cur_p:=s; goto done5;
end
@ @<Add the width of node |s| to |disc_width|@>=
if is_char_node(s) then
begin f:=font(s);
disc_width[1]:=disc_width[1]+char_width(f)(char_info(f)(character(s)));
if (pdf_adjust_spacing > 1) and check_expand_pars(f) then begin
prev_char_p := s;
add_char_stretch(disc_width[7])(character(s));
add_char_shrink(disc_width[8])(character(s));
end;
end
else case type(s) of
ligature_node: begin f:=font(lig_char(s));
disc_width[1]:=disc_width[1]+
char_width(f)(char_info(f)(character(lig_char(s))));
if (pdf_adjust_spacing > 1) and check_expand_pars(f) then begin
prev_char_p := s;
add_char_stretch(disc_width[7])(character(lig_char(s)));
add_char_shrink(disc_width[8])(character(lig_char(s)));
end;
end;
hlist_node,vlist_node,rule_node,kern_node: begin
disc_width[1]:=disc_width[1]+width(s);
if (type(s) = kern_node) and
(pdf_adjust_spacing > 1) and (subtype(s) = normal)
then begin
add_kern_stretch(disc_width[7])(s);
add_kern_shrink(disc_width[8])(s);
end;
end;
othercases confusion("disc3")
@:this can't happen disc3}{\quad disc3@>
endcases
@ @<Add the width of node |s| to |act_width|@>=
if is_char_node(s) then
begin f:=font(s);
act_width:=act_width+char_width(f)(char_info(f)(character(s)));
if (pdf_adjust_spacing > 1) and check_expand_pars(f) then begin
prev_char_p := s;
add_char_stretch(active_width[7])(character(s));
add_char_shrink(active_width[8])(character(s));
end;
end
else case type(s) of
ligature_node: begin f:=font(lig_char(s));
act_width:=act_width+
char_width(f)(char_info(f)(character(lig_char(s))));
if (pdf_adjust_spacing > 1) and check_expand_pars(f) then begin
prev_char_p := s;
add_char_stretch(active_width[7])(character(lig_char(s)));
add_char_shrink(active_width[8])(character(lig_char(s)));
end;
end;
hlist_node,vlist_node,rule_node,kern_node: begin
act_width:=act_width+width(s);
if (type(s) = kern_node) and
(pdf_adjust_spacing > 1) and (subtype(s) = normal)
then begin
add_kern_stretch(active_width[7])(s);
add_kern_shrink(active_width[8])(s);
end;
end;
othercases confusion("disc4")
@:this can't happen disc4}{\quad disc4@>
endcases
@ The forced line break at the paragraph's end will reduce the list of
breakpoints so that all active nodes represent breaks at |cur_p=null|.
On the first pass, we insist on finding an active node that has the
correct ``looseness.'' On the final pass, there will be at least one active
node, and we will match the desired looseness as well as we can.
The global variable |best_bet| will be set to the active node for the best
way to break the paragraph, and a few other variables are used to
help determine what is best.
@<Glob...@>=
@!best_bet:pointer; {use this passive node and its predecessors}
@!fewest_demerits:integer; {the demerits associated with |best_bet|}
@!best_line:halfword; {line number following the last line of the new paragraph}
@!actual_looseness:integer; {the difference between |line_number(best_bet)|
and the optimum |best_line|}
@!line_diff:integer; {the difference between the current line number and
the optimum |best_line|}
@ @<Try the final line break at the end of the paragraph...@>=
begin try_break(eject_penalty,hyphenated);
if link(active)<>last_active then
begin @<Find an active node with fewest demerits@>;
if looseness=0 then goto done;
@<Find the best active node for the desired looseness@>;
if (actual_looseness=looseness)or final_pass then goto done;
end;
end
@ @<Find an active node...@>=
r:=link(active); fewest_demerits:=awful_bad;
repeat if type(r)<>delta_node then if total_demerits(r)<fewest_demerits then
begin fewest_demerits:=total_demerits(r); best_bet:=r;
end;
r:=link(r);
until r=last_active;
best_line:=line_number(best_bet)
@ The adjustment for a desired looseness is a slightly more complicated
version of the loop just considered. Note that if a paragraph is broken
into segments by displayed equations, each segment will be subject to the
looseness calculation, independently of the other segments.
@<Find the best active node...@>=
begin r:=link(active); actual_looseness:=0;
repeat if type(r)<>delta_node then
begin line_diff:=line_number(r)-best_line;
if ((line_diff<actual_looseness)and(looseness<=line_diff))or@|
((line_diff>actual_looseness)and(looseness>=line_diff)) then
begin best_bet:=r; actual_looseness:=line_diff;
fewest_demerits:=total_demerits(r);
end
else if (line_diff=actual_looseness)and@|
(total_demerits(r)<fewest_demerits) then
begin best_bet:=r; fewest_demerits:=total_demerits(r);
end;
end;
r:=link(r);
until r=last_active;
best_line:=line_number(best_bet);
end
@ Once the best sequence of breakpoints has been found (hurray), we call on the
procedure |post_line_break| to finish the remainder of the work.
(By introducing this subprocedure, we are able to keep |line_break|
from getting extremely long.)
@<Break the paragraph at the chosen...@>=
post_line_break(d)
@ The total number of lines that will be set by |post_line_break|
is |best_line-prev_graf-1|. The last breakpoint is specified by
|break_node(best_bet)|, and this passive node points to the other breakpoints
via the |prev_break| links. The finishing-up phase starts by linking the
relevant passive nodes in forward order, changing |prev_break| to
|next_break|. (The |next_break| fields actually reside in the same memory
space as the |prev_break| fields did, but we give them a new name because
of their new significance.) Then the lines are justified, one by one.
@d next_break==prev_break {new name for |prev_break| after links are reversed}
@<Declare subprocedures for |line_break|@>=
procedure post_line_break(@!d:boolean);
label done,done1;
var q,@!r,@!s:pointer; {temporary registers for list manipulation}
p, k: pointer;
w: scaled;
glue_break: boolean; {was a break at glue?}
ptmp: pointer;
@!disc_break:boolean; {was the current break at a discretionary node?}
@!post_disc_break:boolean; {and did it have a nonempty post-break part?}
@!cur_width:scaled; {width of line number |cur_line|}
@!cur_indent:scaled; {left margin of line number |cur_line|}
@!t:quarterword; {used for replacement counts in discretionary nodes}
@!pen:integer; {use when calculating penalties between lines}
@!cur_line: halfword; {the current line number being justified}
@!LR_ptr:pointer; {stack of LR codes}
begin LR_ptr:=LR_save;
@<Reverse the links of the relevant passive nodes, setting |cur_p| to the
first breakpoint@>;
cur_line:=prev_graf+1;
repeat @<Justify the line ending at breakpoint |cur_p|, and append it to the
current vertical list, together with associated penalties and other
insertions@>;
incr(cur_line); cur_p:=next_break(cur_p);
if cur_p<>null then if not post_disc_break then
@<Prune unwanted nodes at the beginning of the next line@>;
until cur_p=null;
if (cur_line<>best_line)or(link(temp_head)<>null) then
confusion("line breaking");
@:this can't happen line breaking}{\quad line breaking@>
prev_graf:=best_line-1;
LR_save:=LR_ptr;
end;
@ The job of reversing links in a list is conveniently regarded as the job
of taking items off one stack and putting them on another. In this case we
take them off a stack pointed to by |q| and having |prev_break| fields;
we put them on a stack pointed to by |cur_p| and having |next_break| fields.
Node |r| is the passive node being moved from stack to stack.
@<Reverse the links of the relevant passive nodes...@>=
q:=break_node(best_bet); cur_p:=null;
repeat r:=q; q:=prev_break(q); next_break(r):=cur_p; cur_p:=r;
until q=null
@ Glue and penalty and kern and math nodes are deleted at the beginning of
a line, except in the anomalous case that the node to be deleted is actually
one of the chosen breakpoints. Otherwise
the pruning done here is designed to match
the lookahead computation in |try_break|, where the |break_width| values
are computed for non-discretionary breakpoints.
@<Prune unwanted nodes at the beginning of the next line@>=
begin r:=temp_head;
loop@+ begin q:=link(r);
if q=cur_break(cur_p) then goto done1;
{|cur_break(cur_p)| is the next breakpoint}
{now |q| cannot be |null|}
if is_char_node(q) then goto done1;
if non_discardable(q) then goto done1;
if type(q)=kern_node then if subtype(q)<>explicit then goto done1;
r:=q; {now |type(q)=glue_node|, |kern_node|, |math_node|, or |penalty_node|}
if type(q)=math_node then if TeXXeT_en then
@<Adjust \(t)the LR stack for the |post_line_break| routine@>;
end;
done1: if r<>temp_head then
begin link(r):=null; flush_node_list(link(temp_head));
link(temp_head):=q;
end;
end
@ The current line to be justified appears in a horizontal list starting
at |link(temp_head)| and ending at |cur_break(cur_p)|. If |cur_break(cur_p)| is
a glue node, we reset the glue to equal the |right_skip| glue; otherwise
we append the |right_skip| glue at the right. If |cur_break(cur_p)| is a
discretionary node, we modify the list so that the discretionary break
is compulsory, and we set |disc_break| to |true|. We also append
the |left_skip| glue at the left of the line, unless it is zero.
@<Justify the line ending at breakpoint |cur_p|, and append it...@>=
if TeXXeT_en then
@<Insert LR nodes at the beginning of the current line and adjust
the LR stack based on LR nodes in this line@>;
@<Modify the end of the line to reflect the nature of the break and to include
\.{\\rightskip}; also set the proper value of |disc_break|@>;
if TeXXeT_en then @<Insert LR nodes at the end of the current line@>;
@<Put the \(l)\.{\\leftskip} glue at the left and detach this line@>;
@<Call the packaging subroutine, setting |just_box| to the justified box@>;
@<Append the new box to the current vertical list, followed by the list of
special nodes taken out of the box by the packager@>;
@<Append a penalty node, if a nonzero penalty is appropriate@>
@ At the end of the following code, |q| will point to the final node on the
list about to be justified.
@<Modify the end of the line...@>=
q:=cur_break(cur_p); disc_break:=false; post_disc_break:=false;
glue_break := false;
if q<>null then {|q| cannot be a |char_node|}
if type(q)=glue_node then
begin delete_glue_ref(glue_ptr(q));
glue_ptr(q):=right_skip;
subtype(q):=right_skip_code+1; add_glue_ref(right_skip);
glue_break := true;
goto done;
end
else begin if type(q)=disc_node then
@<Change discretionary to compulsory and set
|disc_break:=true|@>
else if type(q)=kern_node then width(q):=0
else if type(q)=math_node then
begin width(q):=0;
if TeXXeT_en then @<Adjust \(t)the LR stack for the |p...@>;
end;
end
else begin q:=temp_head;
while link(q)<>null do q:=link(q);
end;
done:
{at this point |q| is the rightmost breakpoint; the only exception is the case
of a discretionary break with non-empty |pre_break|, then |q| has been changed
to the last node of the |pre_break| list}
if pdf_protrude_chars > 0 then begin
if disc_break and (is_char_node(q) or (type(q) <> disc_node))
{|q| has been reset to the last node of |pre_break|}
then begin
p := q;
ptmp := p;
end else begin
p := prev_rightmost(link(temp_head), q); {get |link(p) = q|}
ptmp := p;
p := find_protchar_right(link(temp_head), p);
end;
@{
short_display_n(p, 1);
print_ln;
@}
w := right_pw(p);
if w <> 0 then {we have found a marginal kern, append it after |ptmp|}
begin
k := new_margin_kern(-w, last_rightmost_char, right_side);
link(k) := link(ptmp);
link(ptmp) := k;
if (ptmp = q) then
q := link(q);
end;
end;
{if |q| was not a breakpoint at glue and has been reset to |rightskip| then
we append |rightskip| after |q| now}
if not glue_break then begin
@<Put the \(r)\.{\\rightskip} glue after node |q|@>;
end;
@ @<Change discretionary to compulsory...@>=
begin t:=replace_count(q);
@<Destroy the |t| nodes following |q|, and
make |r| point to the following node@>;
if post_break(q)<>null then @<Transplant the post-break list@>;
if pre_break(q)<>null then @<Transplant the pre-break list@>;
link(q):=r; disc_break:=true;
end
@ @<Destroy the |t| nodes following |q|...@>=
if t=0 then r:=link(q)
else begin r:=q;
while t>1 do
begin r:=link(r); decr(t);
end;
s:=link(r);
r:=link(s); link(s):=null;
flush_node_list(link(q)); replace_count(q):=0;
end
@ We move the post-break list from inside node |q| to the main list by
re\-attaching it just before the present node |r|, then resetting |r|.
@<Transplant the post-break list@>=
begin s:=post_break(q);
while link(s)<>null do s:=link(s);
link(s):=r; r:=post_break(q); post_break(q):=null; post_disc_break:=true;
end
@ We move the pre-break list from inside node |q| to the main list by
re\-attaching it just after the present node |q|, then resetting |q|.
@<Transplant the pre-break list@>=
begin s:=pre_break(q); link(q):=s;
while link(s)<>null do s:=link(s);
pre_break(q):=null; q:=s;
end
@ @<Put the \(r)\.{\\rightskip} glue after node |q|@>=
r:=new_param_glue(right_skip_code); link(r):=link(q); link(q):=r; q:=r
@ The following code begins with |q| at the end of the list to be
justified. It ends with |q| at the beginning of that list, and with
|link(temp_head)| pointing to the remainder of the paragraph, if any.
@<Put the \(l)\.{\\leftskip} glue at the left...@>=
r:=link(q); link(q):=null; q:=link(temp_head); link(temp_head):=r;
{at this point |q| is the leftmost node; all discardable nodes have been discarded}
if pdf_protrude_chars > 0 then begin
p := q;
p := find_protchar_left(p, false); {no more discardables}
w := left_pw(p);
if w <> 0 then begin
k := new_margin_kern(-w, last_leftmost_char, left_side);
link(k) := q;
q := k;
end;
end;
if left_skip<>zero_glue then
begin r:=new_param_glue(left_skip_code);
link(r):=q; q:=r;
end
@ @<Initialize table entries...@>=
pdf_ignored_dimen := ignore_depth;
pdf_each_line_height := pdf_ignored_dimen;
pdf_each_line_depth := pdf_ignored_dimen;
pdf_first_line_height := pdf_ignored_dimen;
pdf_last_line_depth := pdf_ignored_dimen;
@ @<Append the new box to the current vertical list...@>=
if pdf_each_line_height <> pdf_ignored_dimen then
height(just_box) := pdf_each_line_height;
if pdf_each_line_depth <> pdf_ignored_dimen then
depth(just_box) := pdf_each_line_depth;
if (pdf_first_line_height <> pdf_ignored_dimen) and (cur_line = prev_graf + 1) then
height(just_box) := pdf_first_line_height;
if (pdf_last_line_depth <> pdf_ignored_dimen) and (cur_line + 1 = best_line) then
depth(just_box) := pdf_last_line_depth;
if pre_adjust_head <> pre_adjust_tail then
append_list(pre_adjust_head)(pre_adjust_tail);
pre_adjust_tail := null;
append_to_vlist(just_box);
if adjust_head <> adjust_tail then
append_list(adjust_head)(adjust_tail);
adjust_tail := null
@ Now |q| points to the hlist that represents the current line of the
paragraph. We need to compute the appropriate line width, pack the
line into a box of this size, and shift the box by the appropriate
amount of indentation.
@<Call the packaging subroutine...@>=
if cur_line>last_special_line then
begin cur_width:=second_width; cur_indent:=second_indent;
end
else if par_shape_ptr=null then
begin cur_width:=first_width; cur_indent:=first_indent;
end
else begin cur_width:=mem[par_shape_ptr+2*cur_line].sc;
cur_indent:=mem[par_shape_ptr+2*cur_line-1].sc;
end;
adjust_tail:=adjust_head;
pre_adjust_tail := pre_adjust_head;
if pdf_adjust_spacing > 0 then
just_box := hpack(q, cur_width, cal_expand_ratio)
else
just_box := hpack(q, cur_width, exactly);
shift_amount(just_box):=cur_indent
@ Penalties between the lines of a paragraph come from club and widow lines,
from the |inter_line_penalty| parameter, and from lines that end at
discretionary breaks. Breaking between lines of a two-line paragraph gets
both club-line and widow-line penalties. The local variable |pen| will
be set to the sum of all relevant penalties for the current line, except
that the final line is never penalized.
@<Append a penalty node, if a nonzero penalty is appropriate@>=
if cur_line+1<>best_line then
begin q:=inter_line_penalties_ptr;
if q<>null then
begin r:=cur_line;
if r>penalty(q) then r:=penalty(q);
pen:=penalty(q+r);
end
else pen:=inter_line_penalty;
q:=club_penalties_ptr;
if q<>null then
begin r:=cur_line-prev_graf;
if r>penalty(q) then r:=penalty(q);
pen:=pen+penalty(q+r);
end
else if cur_line=prev_graf+1 then pen:=pen+club_penalty;
if d then q:=display_widow_penalties_ptr
else q:=widow_penalties_ptr;
if q<>null then
begin r:=best_line-cur_line-1;
if r>penalty(q) then r:=penalty(q);
pen:=pen+penalty(q+r);
end
else if cur_line+2=best_line then
if d then pen:=pen+display_widow_penalty
else pen:=pen+widow_penalty;
if disc_break then pen:=pen+broken_penalty;
if pen<>0 then
begin r:=new_penalty(pen);
link(tail):=r; tail:=r;
end;
end
@* \[40] Pre-hyphenation.
When the line-breaking routine is unable to find a feasible sequence of
breakpoints, it makes a second pass over the paragraph, attempting to
hyphenate the hyphenatable words. The goal of hyphenation is to insert
discretionary material into the paragraph so that there are more
potential places to break.
The general rules for hyphenation are somewhat complex and technical,
because we want to be able to hyphenate words that are preceded or
followed by punctuation marks, and because we want the rules to work
for languages other than English. We also must contend with the fact
that hyphens might radically alter the ligature and kerning structure
of a word.
A sequence of characters will be considered for hyphenation only if it
belongs to a ``potentially hyphenatable part'' of the current paragraph.
This is a sequence of nodes $p_0p_1\ldots p_m$ where $p_0$ is a glue node,
$p_1\ldots p_{m-1}$ are either character or ligature or whatsit or
implicit kern or text direction nodes, and $p_m$ is a glue or penalty or
insertion or adjust
or mark or whatsit or explicit kern node. (Therefore hyphenation is
disabled by boxes, math formulas, and discretionary nodes already inserted
by the user.) The ligature nodes among $p_1\ldots p_{m-1}$ are effectively
expanded into the original non-ligature characters; the kern nodes and
whatsits are ignored. Each character |c| is now classified as either a
nonletter (if |lc_code(c)=0|), a lowercase letter (if
|lc_code(c)=c|), or an uppercase letter (otherwise); an uppercase letter
is treated as if it were |lc_code(c)| for purposes of hyphenation. The
characters generated by $p_1\ldots p_{m-1}$ may begin with nonletters; let
$c_1$ be the first letter that is not in the middle of a ligature. Whatsit
nodes preceding $c_1$ are ignored; a whatsit found after $c_1$ will be the
terminating node $p_m$. All characters that do not have the same font as
$c_1$ will be treated as nonletters. The |hyphen_char| for that font
must be between 0 and 255, otherwise hyphenation will not be attempted.
\TeX\ looks ahead for as many consecutive letters $c_1\ldots c_n$ as
possible; however, |n| must be less than 64, so a character that would
otherwise be $c_{64}$ is effectively not a letter. Furthermore $c_n$ must
not be in the middle of a ligature. In this way we obtain a string of
letters $c_1\ldots c_n$ that are generated by nodes $p_a\ldots p_b$, where
|1<=a<=b+1<=m|. If |n>=l_hyf+r_hyf|, this string qualifies for hyphenation;
however, |uc_hyph| must be positive, if $c_1$ is uppercase.
The hyphenation process takes place in three stages. First, the candidate
sequence $c_1\ldots c_n$ is found; then potential positions for hyphens
are determined by referring to hyphenation tables; and finally, the nodes
$p_a\ldots p_b$ are replaced by a new sequence of nodes that includes the
discretionary breaks found.
Fortunately, we do not have to do all this calculation very often, because
of the way it has been taken out of \TeX's inner loop. For example, when
the second edition of the author's 700-page book {\sl Seminumerical
Algorithms} was typeset by \TeX, only about 1.2 hyphenations needed to be
@^Knuth, Donald Ervin@>
tried per paragraph, since the line breaking algorithm needed to use two
passes on only about 5 per cent of the paragraphs.
@<Initialize for hyphenating...@>=
begin @!init if trie_not_ready then init_trie;@+tini@;@/
cur_lang:=init_cur_lang; l_hyf:=init_l_hyf; r_hyf:=init_r_hyf;
set_hyph_index;
end
@ The letters $c_1\ldots c_n$ that are candidates for hyphenation are placed
into an array called |hc|; the number |n| is placed into |hn|; pointers to
nodes $p_{a-1}$ and~$p_b$ in the description above are placed into variables
|ha| and |hb|; and the font number is placed into |hf|.
@<Glob...@>=
@!hc:array[0..65] of 0..256; {word to be hyphenated}
@!hn:0..64; {the number of positions occupied in |hc|;
not always a |small_number|}
@!ha,@!hb:pointer; {nodes |ha..hb| should be replaced by the hyphenated result}
@!hf:internal_font_number; {font number of the letters in |hc|}
@!hu:array[0..63] of 0..256; {like |hc|, before conversion to lowercase}
@!hyf_char:integer; {hyphen character of the relevant font}
@!cur_lang,@!init_cur_lang:ASCII_code; {current hyphenation table of interest}
@!l_hyf,@!r_hyf,@!init_l_hyf,@!init_r_hyf:integer; {limits on fragment sizes}
@!hyf_bchar:halfword; {boundary character after $c_n$}
@ Hyphenation routines need a few more local variables.
@<Local variables for line...@>=
@!j:small_number; {an index into |hc| or |hu|}
@!c:0..255; {character being considered for hyphenation}
@ When the following code is activated, the |line_break| procedure is in its
second pass, and |cur_p| points to a glue node.
@<Try to hyphenate...@>=
begin prev_s:=cur_p; s:=link(prev_s);
if s<>null then
begin @<Skip to node |ha|, or |goto done1| if no hyphenation
should be attempted@>;
if l_hyf+r_hyf>63 then goto done1;
@<Skip to node |hb|, putting letters into |hu| and |hc|@>;
@<Check that the nodes following |hb| permit hyphenation and that at least
|l_hyf+r_hyf| letters have been found, otherwise |goto done1|@>;
hyphenate;
end;
done1: end
@ @<Declare subprocedures for |line_break|@>=
@t\4@>@<Declare the function called |reconstitute|@>
procedure hyphenate;
label common_ending,done,found,found1,found2,not_found,exit;
var @<Local variables for hyphenation@>@;
begin @<Find hyphen locations for the word in |hc|, or |return|@>;
@<If no hyphens were found, |return|@>;
@<Replace nodes |ha..hb| by a sequence of nodes that includes
the discretionary hyphens@>;
exit:end;
@ The first thing we need to do is find the node |ha| just before the
first letter.
@<Skip to node |ha|, or |goto done1|...@>=
loop@+ begin if is_char_node(s) then
begin c:=qo(character(s)); hf:=font(s);
end
else if type(s)=ligature_node then
if lig_ptr(s)=null then goto continue
else begin q:=lig_ptr(s); c:=qo(character(q)); hf:=font(q);
end
else if (type(s)=kern_node)and(subtype(s)=normal) then goto continue
else if (type(s)=math_node)and(subtype(s)>=L_code) then goto continue
else if type(s)=whatsit_node then
begin @<Advance \(p)past a whatsit node in the \(p)pre-hyphenation loop@>;
goto continue;
end
else goto done1;
set_lc_code(c);
if hc[0]<>0 then
if (hc[0]=c)or(uc_hyph>0) then goto done2
else goto done1;
continue: prev_s:=s; s:=link(prev_s);
end;
done2: hyf_char:=hyphen_char[hf];
if hyf_char<0 then goto done1;
if hyf_char>255 then goto done1;
ha:=prev_s
@ The word to be hyphenated is now moved to the |hu| and |hc| arrays.
@<Skip to node |hb|, putting letters...@>=
hn:=0;
loop@+ begin if is_char_node(s) then
begin if font(s)<>hf then goto done3;
hyf_bchar:=character(s); c:=qo(hyf_bchar);
set_lc_code(c);
if hc[0]=0 then goto done3;
if hn=63 then goto done3;
hb:=s; incr(hn); hu[hn]:=c; hc[hn]:=hc[0]; hyf_bchar:=non_char;
end
else if type(s)=ligature_node then
@<Move the characters of a ligature node to |hu| and |hc|;
but |goto done3| if they are not all letters@>
else if (type(s)=kern_node)and(subtype(s)=normal) then
begin hb:=s;
hyf_bchar:=font_bchar[hf];
end
else goto done3;
s:=link(s);
end;
done3:
@ We let |j| be the index of the character being stored when a ligature node
is being expanded, since we do not want to advance |hn| until we are sure
that the entire ligature consists of letters. Note that it is possible
to get to |done3| with |hn=0| and |hb| not set to any value.
@<Move the characters of a ligature node to |hu| and |hc|...@>=
begin if font(lig_char(s))<>hf then goto done3;
j:=hn; q:=lig_ptr(s);@+if q>null then hyf_bchar:=character(q);
while q>null do
begin c:=qo(character(q));
set_lc_code(c);
if hc[0]=0 then goto done3;
if j=63 then goto done3;
incr(j); hu[j]:=c; hc[j]:=hc[0];@/
q:=link(q);
end;
hb:=s; hn:=j;
if odd(subtype(s)) then hyf_bchar:=font_bchar[hf]@+else hyf_bchar:=non_char;
end
@ @<Check that the nodes following |hb| permit hyphenation...@>=
if hn<l_hyf+r_hyf then goto done1; {|l_hyf| and |r_hyf| are |>=1|}
loop@+ begin if not(is_char_node(s)) then
case type(s) of
ligature_node: do_nothing;
kern_node: if subtype(s)<>normal then goto done4;
whatsit_node,glue_node,penalty_node,ins_node,adjust_node,mark_node:
goto done4;
math_node: if subtype(s)>=L_code then goto done4@+else goto done1;
othercases goto done1
endcases;
s:=link(s);
end;
done4:
@* \[41] Post-hyphenation.
If a hyphen may be inserted between |hc[j]| and |hc[j+1]|, the hyphenation
procedure will set |hyf[j]| to some small odd number. But before we look
at \TeX's hyphenation procedure, which is independent of the rest of the
line-breaking algorithm, let us consider what we will do with the hyphens
it finds, since it is better to work on this part of the program before
forgetting what |ha| and |hb|, etc., are all about.
@<Glob...@>=
@!hyf:array [0..64] of 0..9; {odd values indicate discretionary hyphens}
@!init_list:pointer; {list of punctuation characters preceding the word}
@!init_lig:boolean; {does |init_list| represent a ligature?}
@!init_lft:boolean; {if so, did the ligature involve a left boundary?}
@ @<Local variables for hyphenation@>=
@!i,@!j,@!l:0..65; {indices into |hc| or |hu|}
@!q,@!r,@!s:pointer; {temporary registers for list manipulation}
@!bchar:halfword; {boundary character of hyphenated word, or |non_char|}
@ \TeX\ will never insert a hyphen that has fewer than
\.{\\lefthyphenmin} letters before it or fewer than
\.{\\righthyphenmin} after it; hence, a short word has
comparatively little chance of being hyphenated. If no hyphens have
been found, we can save time by not having to make any changes to the
paragraph.
@<If no hyphens were found, |return|@>=
for j:=l_hyf to hn-r_hyf do if odd(hyf[j]) then goto found1;
return;
found1:
@ If hyphens are in fact going to be inserted, \TeX\ first deletes the
subsequence of nodes between |ha| and~|hb|. An attempt is made to
preserve the effect that implicit boundary characters and punctuation marks
had on ligatures inside the hyphenated word, by storing a left boundary or
preceding character in |hu[0]| and by storing a possible right boundary
in |bchar|. We set |j:=0| if |hu[0]| is to be part of the reconstruction;
otherwise |j:=1|.
The variable |s| will point to the tail of the current hlist, and
|q| will point to the node following |hb|, so that
things can be hooked up after we reconstitute the hyphenated word.
@<Replace nodes |ha..hb| by a sequence of nodes...@>=
q:=link(hb); link(hb):=null; r:=link(ha); link(ha):=null; bchar:=hyf_bchar;
if is_char_node(ha) then
if font(ha)<>hf then goto found2
else begin init_list:=ha; init_lig:=false; hu[0]:=qo(character(ha));
end
else if type(ha)=ligature_node then
if font(lig_char(ha))<>hf then goto found2
else begin init_list:=lig_ptr(ha); init_lig:=true; init_lft:=(subtype(ha)>1);
hu[0]:=qo(character(lig_char(ha)));
if init_list=null then if init_lft then
begin hu[0]:=256; init_lig:=false;
end; {in this case a ligature will be reconstructed from scratch}
free_node(ha,small_node_size);
end
else begin {no punctuation found; look for left boundary}
if not is_char_node(r) then if type(r)=ligature_node then
if subtype(r)>1 then goto found2;
j:=1; s:=ha; init_list:=null; goto common_ending;
end;
s:=cur_p; {we have |cur_p<>ha| because |type(cur_p)=glue_node|}
while link(s)<>ha do s:=link(s);
j:=0; goto common_ending;
found2: s:=ha; j:=0; hu[0]:=256; init_lig:=false; init_list:=null;
common_ending: flush_node_list(r);
@<Reconstitute nodes for the hyphenated word, inserting discretionary hyphens@>;
flush_list(init_list)
@ We must now face the fact that the battle is not over, even though the
{\def\!{\kern-1pt}%
hyphens have been found: The process of reconstituting a word can be nontrivial
because ligatures might change when a hyphen is present. {\sl The \TeX book\/}
discusses the difficulties of the word ``difficult'', and
the discretionary material surrounding a
hyphen can be considerably more complex than that. Suppose
\.{abcdef} is a word in a font for which the only ligatures are \.{b\!c},
\.{c\!d}, \.{d\!e}, and \.{e\!f}. If this word permits hyphenation
between \.b and \.c, the two patterns with and without hyphenation are
$\.a\,\.b\,\.-\,\.{c\!d}\,\.{e\!f}$ and $\.a\,\.{b\!c}\,\.{d\!e}\,\.f$.
Thus the insertion of a hyphen might cause effects to ripple arbitrarily
far into the rest of the word. A further complication arises if additional
hyphens appear together with such rippling, e.g., if the word in the
example just given could also be hyphenated between \.c and \.d; \TeX\
avoids this by simply ignoring the additional hyphens in such weird cases.}
Still further complications arise in the presence of ligatures that do not
delete the original characters. When punctuation precedes the word being
hyphenated, \TeX's method is not perfect under all possible scenarios,
because punctuation marks and letters can propagate information back and forth.
For example, suppose the original pre-hyphenation pair
\.{*a} changes to \.{*y} via a \.{\?=:} ligature, which changes to \.{xy}
via a \.{=:\?} ligature; if $p_{a-1}=\.x$ and $p_a=\.y$, the reconstitution
procedure isn't smart enough to obtain \.{xy} again. In such cases the
font designer should include a ligature that goes from \.{xa} to \.{xy}.
@ The processing is facilitated by a subroutine called |reconstitute|. Given
a string of characters $x_j\ldots x_n$, there is a smallest index $m\ge j$
such that the ``translation'' of $x_j\ldots x_n$ by ligatures and kerning
has the form $y_1\ldots y_t$ followed by the translation of $x_{m+1}\ldots x_n$,
where $y_1\ldots y_t$ is some nonempty sequence of character, ligature, and
kern nodes. We call $x_j\ldots x_m$ a ``cut prefix'' of $x_j\ldots x_n$.
For example, if $x_1x_2x_3=\.{fly}$, and if the font contains `fl' as a
ligature and a kern between `fl' and `y', then $m=2$, $t=2$, and $y_1$ will
be a ligature node for `fl' followed by an appropriate kern node~$y_2$.
In the most common case, $x_j$~forms no ligature with $x_{j+1}$ and we
simply have $m=j$, $y_1=x_j$. If $m<n$ we can repeat the procedure on
$x_{m+1}\ldots x_n$ until the entire translation has been found.
The |reconstitute| function returns the integer $m$ and puts the nodes
$y_1\ldots y_t$ into a linked list starting at |link(hold_head)|,
getting the input $x_j\ldots x_n$ from the |hu| array. If $x_j=256$,
we consider $x_j$ to be an implicit left boundary character; in this
case |j| must be strictly less than~|n|. There is a
parameter |bchar|, which is either 256 or an implicit right boundary character
assumed to be present just following~$x_n$. (The value |hu[n+1]| is never
explicitly examined, but the algorithm imagines that |bchar| is there.)
If there exists an index |k| in the range $j\le k\le m$ such that |hyf[k]|
is odd and such that the result of |reconstitute| would have been different
if $x_{k+1}$ had been |hchar|, then |reconstitute| sets |hyphen_passed|
to the smallest such~|k|. Otherwise it sets |hyphen_passed| to zero.
A special convention is used in the case |j=0|: Then we assume that the
translation of |hu[0]| appears in a special list of charnodes starting at
|init_list|; moreover, if |init_lig| is |true|, then |hu[0]| will be
a ligature character, involving a left boundary if |init_lft| is |true|.
This facility is provided for cases when a hyphenated
word is preceded by punctuation (like single or double quotes) that might
affect the translation of the beginning of the word.
@<Glob...@>=
@!hyphen_passed:small_number; {first hyphen in a ligature, if any}
@ @<Declare the function called |reconstitute|@>=
function reconstitute(@!j,@!n:small_number;@!bchar,@!hchar:halfword):
small_number;
label continue,done;
var @!p:pointer; {temporary register for list manipulation}
@!t:pointer; {a node being appended to}
@!q:four_quarters; {character information or a lig/kern instruction}
@!cur_rh:halfword; {hyphen character for ligature testing}
@!test_char:halfword; {hyphen or other character for ligature testing}
@!w:scaled; {amount of kerning}
@!k:font_index; {position of current lig/kern instruction}
begin hyphen_passed:=0; t:=hold_head; w:=0; link(hold_head):=null;
{at this point |ligature_present=lft_hit=rt_hit=false|}
@<Set up data structures with the cursor following position |j|@>;
continue:@<If there's a ligature or kern at the cursor position, update the data
structures, possibly advancing~|j|; continue until the cursor moves@>;
@<Append a ligature and/or kern to the translation;
|goto continue| if the stack of inserted ligatures is nonempty@>;
reconstitute:=j;
end;
@ The reconstitution procedure shares many of the global data structures
by which \TeX\ has processed the words before they were hyphenated.
There is an implied ``cursor'' between characters |cur_l| and |cur_r|;
these characters will be tested for possible ligature activity. If
|ligature_present| then |cur_l| is a ligature character formed from the
original characters following |cur_q| in the current translation list.
There is a ``ligature stack'' between the cursor and character |j+1|,
consisting of pseudo-ligature nodes linked together by their |link| fields.
This stack is normally empty unless a ligature command has created a new
character that will need to be processed later. A pseudo-ligature is
a special node having a |character| field that represents a potential
ligature and a |lig_ptr| field that points to a |char_node| or is |null|.
We have
$$|cur_r|=\cases{|character(lig_stack)|,&if |lig_stack>null|;\cr
|qi(hu[j+1])|,&if |lig_stack=null| and |j<n|;\cr
bchar,&if |lig_stack=null| and |j=n|.\cr}$$
@<Glob...@>=
@!cur_l,@!cur_r:halfword; {characters before and after the cursor}
@!cur_q:pointer; {where a ligature should be detached}
@!lig_stack:pointer; {unfinished business to the right of the cursor}
@!ligature_present:boolean; {should a ligature node be made for |cur_l|?}
@!lft_hit,@!rt_hit:boolean; {did we hit a ligature with a boundary character?}
@ @d append_charnode_to_t(#)== begin link(t):=get_avail; t:=link(t);
font(t):=hf; character(t):=#;
end
@d set_cur_r==begin if j<n then cur_r:=qi(hu[j+1])@+else cur_r:=bchar;
if odd(hyf[j]) then cur_rh:=hchar@+else cur_rh:=non_char;
end
@<Set up data structures with the cursor following position |j|@>=
cur_l:=qi(hu[j]); cur_q:=t;
if j=0 then
begin ligature_present:=init_lig; p:=init_list;
if ligature_present then lft_hit:=init_lft;
while p>null do
begin append_charnode_to_t(character(p)); p:=link(p);
end;
end
else if cur_l<non_char then append_charnode_to_t(cur_l);
lig_stack:=null; set_cur_r
@ We may want to look at the lig/kern program twice, once for a hyphen
and once for a normal letter. (The hyphen might appear after the letter
in the program, so we'd better not try to look for both at once.)
@<If there's a ligature or kern at the cursor position, update...@>=
if cur_l=non_char then
begin k:=bchar_label[hf];
if k=non_address then goto done@+else q:=font_info[k].qqqq;
end
else begin q:=char_info(hf)(cur_l);
if char_tag(q)<>lig_tag then goto done;
k:=lig_kern_start(hf)(q); q:=font_info[k].qqqq;
if skip_byte(q)>stop_flag then
begin k:=lig_kern_restart(hf)(q); q:=font_info[k].qqqq;
end;
end; {now |k| is the starting address of the lig/kern program}
if cur_rh<non_char then test_char:=cur_rh@+else test_char:=cur_r;
loop@+begin if next_char(q)=test_char then if skip_byte(q)<=stop_flag then
if cur_rh<non_char then
begin hyphen_passed:=j; hchar:=non_char; cur_rh:=non_char;
goto continue;
end
else begin if hchar<non_char then if odd(hyf[j]) then
begin hyphen_passed:=j; hchar:=non_char;
end;
if op_byte(q)<kern_flag then
@<Carry out a ligature replacement, updating the cursor structure
and possibly advancing~|j|; |goto continue| if the cursor doesn't
advance, otherwise |goto done|@>;
w:=char_kern(hf)(q); goto done; {this kern will be inserted below}
end;
if skip_byte(q)>=stop_flag then
if cur_rh=non_char then goto done
else begin cur_rh:=non_char; goto continue;
end;
k:=k+qo(skip_byte(q))+1; q:=font_info[k].qqqq;
end;
done:
@ @d wrap_lig(#)==if ligature_present then
begin p:=new_ligature(hf,cur_l,link(cur_q));
if lft_hit then
begin subtype(p):=2; lft_hit:=false;
end;
if # then if lig_stack=null then
begin incr(subtype(p)); rt_hit:=false;
end;
link(cur_q):=p; t:=p; ligature_present:=false;
end
@d pop_lig_stack==begin if lig_ptr(lig_stack)>null then
begin link(t):=lig_ptr(lig_stack); {this is a charnode for |hu[j+1]|}
t:=link(t); incr(j);
end;
p:=lig_stack; lig_stack:=link(p); free_node(p,small_node_size);
if lig_stack=null then set_cur_r@+else cur_r:=character(lig_stack);
end {if |lig_stack| isn't |null| we have |cur_rh=non_char|}
@<Append a ligature and/or kern to the translation...@>=
wrap_lig(rt_hit);
if w<>0 then
begin link(t):=new_kern(w); t:=link(t); w:=0;
end;
if lig_stack>null then
begin cur_q:=t; cur_l:=character(lig_stack); ligature_present:=true;
pop_lig_stack; goto continue;
end
@ @<Carry out a ligature replacement, updating the cursor structure...@>=
begin if cur_l=non_char then lft_hit:=true;
if j=n then if lig_stack=null then rt_hit:=true;
check_interrupt; {allow a way out in case there's an infinite ligature loop}
case op_byte(q) of
qi(1),qi(5):begin cur_l:=rem_byte(q); {\.{=:\?}, \.{=:\?>}}
ligature_present:=true;
end;
qi(2),qi(6):begin cur_r:=rem_byte(q); {\.{\?=:}, \.{\?=:>}}
if lig_stack>null then character(lig_stack):=cur_r
else begin lig_stack:=new_lig_item(cur_r);
if j=n then bchar:=non_char
else begin p:=get_avail; lig_ptr(lig_stack):=p;
character(p):=qi(hu[j+1]); font(p):=hf;
end;
end;
end;
qi(3):begin cur_r:=rem_byte(q); {\.{\?=:\?}}
p:=lig_stack; lig_stack:=new_lig_item(cur_r); link(lig_stack):=p;
end;
qi(7),qi(11):begin wrap_lig(false); {\.{\?=:\?>}, \.{\?=:\?>>}}
cur_q:=t; cur_l:=rem_byte(q); ligature_present:=true;
end;
othercases begin cur_l:=rem_byte(q); ligature_present:=true; {\.{=:}}
if lig_stack>null then pop_lig_stack
else if j=n then goto done
else begin append_charnode_to_t(cur_r); incr(j); set_cur_r;
end;
end
endcases;
if op_byte(q)>qi(4) then if op_byte(q)<>qi(7) then goto done;
goto continue;
end
@ Okay, we're ready to insert the potential hyphenations that were found.
When the following program is executed, we want to append the word
|hu[1..hn]| after node |ha|, and node |q| should be appended to the result.
During this process, the variable |i| will be a temporary
index into |hu|; the variable |j| will be an index to our current position
in |hu|; the variable |l| will be the counterpart of |j|, in a discretionary
branch; the variable |r| will point to new nodes being created; and
we need a few new local variables:
@<Local variables for hyph...@>=
@!major_tail,@!minor_tail:pointer; {the end of lists in the main and
discretionary branches being reconstructed}
@!c:ASCII_code; {character temporarily replaced by a hyphen}
@!c_loc:0..63; {where that character came from}
@!r_count:integer; {replacement count for discretionary}
@!hyf_node:pointer; {the hyphen, if it exists}
@ When the following code is performed, |hyf[0]| and |hyf[hn]| will be zero.
@<Reconstitute nodes for the hyphenated word...@>=
repeat l:=j; j:=reconstitute(j,hn,bchar,qi(hyf_char))+1;
if hyphen_passed=0 then
begin link(s):=link(hold_head);
while link(s)>null do s:=link(s);
if odd(hyf[j-1]) then
begin l:=j; hyphen_passed:=j-1; link(hold_head):=null;
end;
end;
if hyphen_passed>0 then
@<Create and append a discretionary node as an alternative to the
unhyphenated word, and continue to develop both branches until they
become equivalent@>;
until j>hn;
link(s):=q
@ In this repeat loop we will insert another discretionary if |hyf[j-1]| is
odd, when both branches of the previous discretionary end at position |j-1|.
Strictly speaking, we aren't justified in doing this, because we don't know
that a hyphen after |j-1| is truly independent of those branches. But in almost
all applications we would rather not lose a potentially valuable hyphenation
point. (Consider the word `difficult', where the letter `c' is in position |j|.)
@d advance_major_tail==begin major_tail:=link(major_tail); incr(r_count);
end
@<Create and append a discretionary node as an alternative...@>=
repeat r:=get_node(small_node_size);
link(r):=link(hold_head); type(r):=disc_node;
major_tail:=r; r_count:=0;
while link(major_tail)>null do advance_major_tail;
i:=hyphen_passed; hyf[i]:=0;
@<Put the \(c)characters |hu[l..i]| and a hyphen into |pre_break(r)|@>;
@<Put the \(c)characters |hu[i+1..@,]| into |post_break(r)|, appending to this
list and to |major_tail| until synchronization has been achieved@>;
@<Move pointer |s| to the end of the current list, and set |replace_count(r)|
appropriately@>;
hyphen_passed:=j-1; link(hold_head):=null;
until not odd(hyf[j-1])
@ The new hyphen might combine with the previous character via ligature
or kern. At this point we have |l-1<=i<j| and |i<hn|.
@<Put the \(c)characters |hu[l..i]| and a hyphen into |pre_break(r)|@>=
minor_tail:=null; pre_break(r):=null; hyf_node:=new_character(hf,hyf_char);
if hyf_node<>null then
begin incr(i); c:=hu[i]; hu[i]:=hyf_char; free_avail(hyf_node);
end;
while l<=i do
begin l:=reconstitute(l,i,font_bchar[hf],non_char)+1;
if link(hold_head)>null then
begin if minor_tail=null then pre_break(r):=link(hold_head)
else link(minor_tail):=link(hold_head);
minor_tail:=link(hold_head);
while link(minor_tail)>null do minor_tail:=link(minor_tail);
end;
end;
if hyf_node<>null then
begin hu[i]:=c; {restore the character in the hyphen position}
l:=i; decr(i);
end
@ The synchronization algorithm begins with |l=i+1<=j|.
@<Put the \(c)characters |hu[i+1..@,]| into |post_break(r)|...@>=
minor_tail:=null; post_break(r):=null; c_loc:=0;
if bchar_label[hf]<>non_address then {put left boundary at beginning of new line}
begin decr(l); c:=hu[l]; c_loc:=l; hu[l]:=256;
end;
while l<j do
begin repeat l:=reconstitute(l,hn,bchar,non_char)+1;
if c_loc>0 then
begin hu[c_loc]:=c; c_loc:=0;
end;
if link(hold_head)>null then
begin if minor_tail=null then post_break(r):=link(hold_head)
else link(minor_tail):=link(hold_head);
minor_tail:=link(hold_head);
while link(minor_tail)>null do minor_tail:=link(minor_tail);
end;
until l>=j;
while l>j do
@<Append characters of |hu[j..@,]| to |major_tail|, advancing~|j|@>;
end
@ @<Append characters of |hu[j..@,]|...@>=
begin j:=reconstitute(j,hn,bchar,non_char)+1;
link(major_tail):=link(hold_head);
while link(major_tail)>null do advance_major_tail;
end
@ Ligature insertion can cause a word to grow exponentially in size. Therefore
we must test the size of |r_count| here, even though the hyphenated text
was at most 63 characters long.
@<Move pointer |s| to the end of the current list...@>=
if r_count>127 then {we have to forget the discretionary hyphen}
begin link(s):=link(r); link(r):=null; flush_node_list(r);
end
else begin link(s):=r; replace_count(r):=r_count;
end;
s:=major_tail
@* \[42] Hyphenation.
When a word |hc[1..hn]| has been set up to contain a candidate for hyphenation,
\TeX\ first looks to see if it is in the user's exception dictionary. If not,
hyphens are inserted based on patterns that appear within the given word,
using an algorithm due to Frank~M. Liang.
@^Liang, Franklin Mark@>
Let's consider Liang's method first, since it is much more interesting than the
exception-lookup routine. The algorithm begins by setting |hyf[j]| to zero
for all |j|, and invalid characters are inserted into |hc[0]|
and |hc[hn+1]| to serve as delimiters. Then a reasonably fast method is
used to see which of a given set of patterns occurs in the word
|hc[0..(hn+1)]|. Each pattern $p_1\ldots p_k$ of length |k| has an associated
sequence of |k+1| numbers $n_0\ldots n_k$; and if the pattern occurs in
|hc[(j+1)..(j+k)]|, \TeX\ will set |hyf[j+i]:=@tmax@>(hyf[j+i],@t$n_i$@>)| for
|0<=i<=k|. After this has been done for each pattern that occurs, a
discretionary hyphen will be inserted between |hc[j]| and |hc[j+1]| when
|hyf[j]| is odd, as we have already seen.
The set of patterns $p_1\ldots p_k$ and associated numbers $n_0\ldots n_k$
depends, of course, on the language whose words are being hyphenated, and
on the degree of hyphenation that is desired. A method for finding
appropriate |p|'s and |n|'s, from a given dictionary of words and acceptable
hyphenations, is discussed in Liang's Ph.D. thesis (Stanford University,
1983); \TeX\ simply starts with the patterns and works from there.
@ The patterns are stored in a compact table that is also efficient for
retrieval, using a variant of ``trie memory'' [cf.\ {\sl The Art of
Computer Programming \bf3} (1973), 481--505]. We can find each pattern
$p_1\ldots p_k$ by letting $z_0$ be one greater than the relevant language
index and then, for |1<=i<=k|,
setting |@t$z_i$@>:=trie_link@t$(z_{i-1})+p_i$@>|; the pattern will be
identified by the number $z_k$. Since all the pattern information is
packed together into a single |trie_link| array, it is necessary to
prevent confusion between the data from inequivalent patterns, so another
table is provided such that |trie_char@t$(z_i)=p_i$@>| for all |i|. There
is also a table |trie_op|$(z_k)$ to identify the numbers $n_0\ldots n_k$
associated with $p_1\ldots p_k$.
Comparatively few different number sequences $n_0\ldots n_k$ actually occur,
since most of the |n|'s are generally zero. Therefore the number sequences
are encoded in such a way that |trie_op|$(z_k)$ is only one byte long.
If |trie_op(@t$z_k$@>)<>min_quarterword|, when $p_1\ldots p_k$ has matched
the letters in |hc[(l-k+1)..l@,]| of language |t|,
we perform all of the required operations
for this pattern by carrying out the following little program: Set
|v:=trie_op(@t$z_k$@>)|. Then set |v:=v+op_start[t]|,
|hyf[l-hyf_distance[v]]:=@tmax@>(hyf[l-hyf_distance[v]], hyf_num[v])|,
and |v:=hyf_next[v]|; repeat, if necessary, until |v=min_quarterword|.
@<Types...@>=
@!trie_pointer=0..trie_size; {an index into |trie|}
@ @d trie_link(#)==trie[#].rh {``downward'' link in a trie}
@d trie_char(#)==trie[#].b1 {character matched at this trie location}
@d trie_op(#)==trie[#].b0 {program for hyphenation at this trie location}
@<Glob...@>=
@!trie:array[trie_pointer] of two_halves; {|trie_link|, |trie_char|, |trie_op|}
@!hyf_distance:array[1..trie_op_size] of small_number; {position |k-j| of $n_j$}
@!hyf_num:array[1..trie_op_size] of small_number; {value of $n_j$}
@!hyf_next:array[1..trie_op_size] of quarterword; {continuation code}
@!op_start:array[ASCII_code] of 0..trie_op_size; {offset for current language}
@ @<Local variables for hyph...@>=
@!z:trie_pointer; {an index into |trie|}
@!v:integer; {an index into |hyf_distance|, etc.}
@ Assuming that these auxiliary tables have been set up properly, the
hyphenation algorithm is quite short. In the following code we set |hc[hn+2]|
to the impossible value 256, in order to guarantee that |hc[hn+3]| will
never be fetched.
@<Find hyphen locations for the word in |hc|...@>=
for j:=0 to hn do hyf[j]:=0;
@<Look for the word |hc[1..hn]| in the exception table, and |goto found| (with
|hyf| containing the hyphens) if an entry is found@>;
if trie_char(cur_lang+1)<>qi(cur_lang) then return; {no patterns for |cur_lang|}
hc[0]:=0; hc[hn+1]:=0; hc[hn+2]:=256; {insert delimiters}
for j:=0 to hn-r_hyf+1 do
begin z:=trie_link(cur_lang+1)+hc[j]; l:=j;
while hc[l]=qo(trie_char(z)) do
begin if trie_op(z)<>min_quarterword then
@<Store \(m)maximum values in the |hyf| table@>;
incr(l); z:=trie_link(z)+hc[l];
end;
end;
found: for j:=0 to l_hyf-1 do hyf[j]:=0;
for j:=0 to r_hyf-1 do hyf[hn-j]:=0
@ @<Store \(m)maximum values in the |hyf| table@>=
begin v:=trie_op(z);
repeat v:=v+op_start[cur_lang]; i:=l-hyf_distance[v];
if hyf_num[v]>hyf[i] then hyf[i]:=hyf_num[v];
v:=hyf_next[v];
until v=min_quarterword;
end
@ The exception table that is built by \TeX's \.{\\hyphenation} primitive is
organized as an ordered hash table [cf.\ Amble and Knuth, {\sl The Computer
@^Amble, Ole@> @^Knuth, Donald Ervin@>
Journal\/ \bf17} (1974), 135--142] using linear probing. If $\alpha$ and
$\beta$ are words, we will say that $\alpha<\beta$ if $\vert\alpha\vert<
\vert\beta\vert$ or if $\vert\alpha\vert=\vert\beta\vert$ and
$\alpha$ is lexicographically smaller than $\beta$. (The notation $\vert
\alpha\vert$ stands for the length of $\alpha$.) The idea of ordered hashing
is to arrange the table so that a given word $\alpha$ can be sought by computing
a hash address $h=h(\alpha)$ and then looking in table positions |h|, |h-1|,
\dots, until encountering the first word $\L\alpha$. If this word is
different from $\alpha$, we can conclude that $\alpha$ is not in the table.
The words in the table point to lists in |mem| that specify hyphen positions
in their |info| fields. The list for $c_1\ldots c_n$ contains the number |k| if
the word $c_1\ldots c_n$ has a discretionary hyphen between $c_k$ and
$c_{k+1}$.
@<Types...@>=
@!hyph_pointer=0..hyph_size; {an index into the ordered hash table}
@ @<Glob...@>=
@!hyph_word:array[hyph_pointer] of str_number; {exception words}
@!hyph_list:array[hyph_pointer] of pointer; {lists of hyphen positions}
@!hyph_count:hyph_pointer; {the number of words in the exception dictionary}
@ @<Local variables for init...@>=
@!z:hyph_pointer; {runs through the exception dictionary}
@ @<Set init...@>=
for z:=0 to hyph_size do
begin hyph_word[z]:=0; hyph_list[z]:=null;
end;
hyph_count:=0;
@ The algorithm for exception lookup is quite simple, as soon as we have
a few more local variables to work with.
@<Local variables for hyph...@>=
@!h:hyph_pointer; {an index into |hyph_word| and |hyph_list|}
@!k:str_number; {an index into |str_start|}
@!u:pool_pointer; {an index into |str_pool|}
@ First we compute the hash code |h|, then we search until we either
find the word or we don't. Words from different languages are kept
separate by appending the language code to the string.
@<Look for the word |hc[1...@>=
h:=hc[1]; incr(hn); hc[hn]:=cur_lang;
for j:=2 to hn do h:=(h+h+hc[j]) mod hyph_size;
loop@+ begin @<If the string |hyph_word[h]| is less than \(hc)|hc[1..hn]|,
|goto not_found|; but if the two strings are equal,
set |hyf| to the hyphen positions and |goto found|@>;
if h>0 then decr(h)@+else h:=hyph_size;
end;
not_found: decr(hn)
@ @<If the string |hyph_word[h]| is less than \(hc)...@>=
k:=hyph_word[h]; if k=0 then goto not_found;
if length(k)<hn then goto not_found;
if length(k)=hn then
begin j:=1; u:=str_start[k];
repeat if so(str_pool[u])<hc[j] then goto not_found;
if so(str_pool[u])>hc[j] then goto done;
incr(j); incr(u);
until j>hn;
@<Insert hyphens as specified in |hyph_list[h]|@>;
decr(hn); goto found;
end;
done:
@ @<Insert hyphens as specified...@>=
s:=hyph_list[h];
while s<>null do
begin hyf[info(s)]:=1; s:=link(s);
end
@ @<Search |hyph_list| for pointers to |p|@>=
for q:=0 to hyph_size do
begin if hyph_list[q]=p then
begin print_nl("HYPH("); print_int(q); print_char(")");
end;
end
@ We have now completed the hyphenation routine, so the |line_break| procedure
is finished at last. Since the hyphenation exception table is fresh in our
minds, it's a good time to deal with the routine that adds new entries to it.
When \TeX\ has scanned `\.{\\hyphenation}', it calls on a procedure named
|new_hyph_exceptions| to do the right thing.
@d set_cur_lang==if language<=0 then cur_lang:=0
else if language>255 then cur_lang:=0
else cur_lang:=language
@p procedure new_hyph_exceptions; {enters new exceptions}
label reswitch, exit, found, not_found, not_found1;
var n:0..64; {length of current word; not always a |small_number|}
@!j:0..64; {an index into |hc|}
@!h:hyph_pointer; {an index into |hyph_word| and |hyph_list|}
@!k:str_number; {an index into |str_start|}
@!p:pointer; {head of a list of hyphen positions}
@!q:pointer; {used when creating a new node for list |p|}
@!s,@!t:str_number; {strings being compared or stored}
@!u,@!v:pool_pointer; {indices into |str_pool|}
begin scan_left_brace; {a left brace must follow \.{\\hyphenation}}
set_cur_lang;
@!init if trie_not_ready then
begin hyph_index:=0; goto not_found1;
end;
tini@/
set_hyph_index;
not_found1:
@<Enter as many hyphenation exceptions as are listed,
until coming to a right brace; then |return|@>;
exit:end;
@ @<Enter as many...@>=
n:=0; p:=null;
loop@+ begin get_x_token;
reswitch: case cur_cmd of
letter,other_char,char_given:@<Append a new letter or hyphen@>;
char_num: begin scan_char_num; cur_chr:=cur_val; cur_cmd:=char_given;
goto reswitch;
end;
spacer,right_brace: begin if n>1 then @<Enter a hyphenation exception@>;
if cur_cmd=right_brace then return;
n:=0; p:=null;
end;
othercases @<Give improper \.{\\hyphenation} error@>
endcases;
end
@ @<Give improper \.{\\hyph...@>=
begin print_err("Improper "); print_esc("hyphenation");
@.Improper \\hyphenation...@>
print(" will be flushed");
help2("Hyphenation exceptions must contain only letters")@/
("and hyphens. But continue; I'll forgive and forget.");
error;
end
@ @<Append a new letter or hyphen@>=
if cur_chr="-" then @<Append the value |n| to list |p|@>
else begin set_lc_code(cur_chr);
if hc[0]=0 then
begin print_err("Not a letter");
@.Not a letter@>
help2("Letters in \hyphenation words must have \lccode>0.")@/
("Proceed; I'll ignore the character I just read.");
error;
end
else if n<63 then
begin incr(n); hc[n]:=hc[0];
end;
end
@ @<Append the value |n| to list |p|@>=
begin if n<63 then
begin q:=get_avail; link(q):=p; info(q):=n; p:=q;
end;
end
@ @<Enter a hyphenation exception@>=
begin incr(n); hc[n]:=cur_lang; str_room(n); h:=0;
for j:=1 to n do
begin h:=(h+h+hc[j]) mod hyph_size;
append_char(hc[j]);
end;
s:=make_string;
@<Insert the \(p)pair |(s,p)| into the exception table@>;
end
@ @<Insert the \(p)pair |(s,p)|...@>=
if hyph_count=hyph_size then overflow("exception dictionary",hyph_size);
@:TeX capacity exceeded exception dictionary}{\quad exception dictionary@>
incr(hyph_count);
while hyph_word[h]<>0 do
begin @<If the string |hyph_word[h]| is less than \(or)or equal to
|s|, interchange |(hyph_word[h],hyph_list[h])| with |(s,p)|@>;
if h>0 then decr(h)@+else h:=hyph_size;
end;
hyph_word[h]:=s; hyph_list[h]:=p
@ @<If the string |hyph_word[h]| is less than \(or)...@>=
k:=hyph_word[h];
if length(k)<length(s) then goto found;
if length(k)>length(s) then goto not_found;
u:=str_start[k]; v:=str_start[s];
repeat if str_pool[u]<str_pool[v] then goto found;
if str_pool[u]>str_pool[v] then goto not_found;
incr(u); incr(v);
until u=str_start[k+1];
found:q:=hyph_list[h]; hyph_list[h]:=p; p:=q;@/
t:=hyph_word[h]; hyph_word[h]:=s; s:=t;
not_found:
@* \[43] Initializing the hyphenation tables.
The trie for \TeX's hyphenation algorithm is built from a sequence of
patterns following a \.{\\patterns} specification. Such a specification
is allowed only in \.{INITEX}, since the extra memory for auxiliary tables
and for the initialization program itself would only clutter up the
production version of \TeX\ with a lot of deadwood.
The first step is to build a trie that is linked, instead of packed
into sequential storage, so that insertions are readily made.
After all patterns have been processed, \.{INITEX}
compresses the linked trie by identifying common subtries. Finally the
trie is packed into the efficient sequential form that the hyphenation
algorithm actually uses.
@<Declare subprocedures for |line_break|@>=
@!init @<Declare procedures for preprocessing hyphenation patterns@>@;
tini
@ Before we discuss trie building in detail, let's consider the simpler
problem of creating the |hyf_distance|, |hyf_num|, and |hyf_next| arrays.
Suppose, for example, that \TeX\ reads the pattern `\.{ab2cde1}'. This is
a pattern of length 5, with $n_0\ldots n_5=0\,0\,2\,0\,0\,1$ in the
notation above. We want the corresponding |trie_op| code |v| to have
|hyf_distance[v]=3|, |hyf_num[v]=2|, and |hyf_next[v]=@t$v^\prime$@>|,
where the auxiliary |trie_op| code $v^\prime$ has
|hyf_distance[@t$v^\prime$@>]=0|, |hyf_num[@t$v^\prime$@>]=1|, and
|hyf_next[@t$v^\prime$@>]=min_quarterword|.
\TeX\ computes an appropriate value |v| with the |new_trie_op| subroutine
below, by setting
$$\hbox{|@t$v^\prime$@>:=new_trie_op(0,1,min_quarterword)|,\qquad
|v:=new_trie_op(3,2,@t$v^\prime$@>)|.}$$
This subroutine looks up its three
parameters in a special hash table, assigning a new value only if these
three have not appeared before for the current language.
The hash table is called |trie_op_hash|, and the number of entries it contains
is |trie_op_ptr|.
@<Glob...@>=
@!init @!trie_op_hash:array[-trie_op_size..trie_op_size] of 0..trie_op_size;
{trie op codes for quadruples}
@!trie_used:array[ASCII_code] of quarterword;
{largest opcode used so far for this language}
@!trie_op_lang:array[1..trie_op_size] of ASCII_code;
{language part of a hashed quadruple}
@!trie_op_val:array[1..trie_op_size] of quarterword;
{opcode corresponding to a hashed quadruple}
@!trie_op_ptr:0..trie_op_size; {number of stored ops so far}
tini
@ It's tempting to remove the |overflow| stops in the following procedure;
|new_trie_op| could return |min_quarterword| (thereby simply ignoring
part of a hyphenation pattern) instead of aborting the job. However, that would
lead to different hyphenation results on different installations of \TeX\
using the same patterns. The |overflow| stops are necessary for portability
of patterns.
@<Declare procedures for preprocessing hyph...@>=
function new_trie_op(@!d,@!n:small_number;@!v:quarterword):quarterword;
label exit;
var h:-trie_op_size..trie_op_size; {trial hash location}
@!u:quarterword; {trial op code}
@!l:0..trie_op_size; {pointer to stored data}
begin h:=abs(n+313*d+361*v+1009*cur_lang) mod (trie_op_size+trie_op_size)
- trie_op_size;
loop@+ begin l:=trie_op_hash[h];
if l=0 then {empty position found for a new op}
begin if trie_op_ptr=trie_op_size then
overflow("pattern memory ops",trie_op_size);
u:=trie_used[cur_lang];
if u=max_quarterword then
overflow("pattern memory ops per language",
max_quarterword-min_quarterword);
incr(trie_op_ptr); incr(u); trie_used[cur_lang]:=u;
hyf_distance[trie_op_ptr]:=d;
hyf_num[trie_op_ptr]:=n; hyf_next[trie_op_ptr]:=v;
trie_op_lang[trie_op_ptr]:=cur_lang; trie_op_hash[h]:=trie_op_ptr;
trie_op_val[trie_op_ptr]:=u; new_trie_op:=u; return;
end;
if (hyf_distance[l]=d)and(hyf_num[l]=n)and(hyf_next[l]=v)
and(trie_op_lang[l]=cur_lang) then
begin new_trie_op:=trie_op_val[l]; return;
end;
if h>-trie_op_size then decr(h)@+else h:=trie_op_size;
end;
exit:end;
@ After |new_trie_op| has compressed the necessary opcode information,
plenty of information is available to unscramble the data into the
final form needed by our hyphenation algorithm.
@<Sort \(t)the hyphenation op tables into proper order@>=
op_start[0]:=-min_quarterword;
for j:=1 to 255 do op_start[j]:=op_start[j-1]+qo(trie_used[j-1]);
for j:=1 to trie_op_ptr do
trie_op_hash[j]:=op_start[trie_op_lang[j]]+trie_op_val[j]; {destination}
for j:=1 to trie_op_ptr do while trie_op_hash[j]>j do
begin k:=trie_op_hash[j];@/
t:=hyf_distance[k]; hyf_distance[k]:=hyf_distance[j]; hyf_distance[j]:=t;@/
t:=hyf_num[k]; hyf_num[k]:=hyf_num[j]; hyf_num[j]:=t;@/
t:=hyf_next[k]; hyf_next[k]:=hyf_next[j]; hyf_next[j]:=t;@/
trie_op_hash[j]:=trie_op_hash[k]; trie_op_hash[k]:=k;
end
@ Before we forget how to initialize the data structures that have been
mentioned so far, let's write down the code that gets them started.
@<Initialize table entries...@>=
for k:=-trie_op_size to trie_op_size do trie_op_hash[k]:=0;
for k:=0 to 255 do trie_used[k]:=min_quarterword;
trie_op_ptr:=0;
@ The linked trie that is used to preprocess hyphenation patterns appears
in several global arrays. Each node represents an instruction of the form
``if you see character |c|, then perform operation |o|, move to the
next character, and go to node |l|; otherwise go to node |r|.''
The four quantities |c|, |o|, |l|, and |r| are stored in four arrays
|trie_c|, |trie_o|, |trie_l|, and |trie_r|. The root of the trie
is |trie_l[0]|, and the number of nodes is |trie_ptr|. Null trie
pointers are represented by zero. To initialize the trie, we simply
set |trie_l[0]| and |trie_ptr| to zero. We also set |trie_c[0]| to some
arbitrary value, since the algorithm may access it.
The algorithms maintain the condition
$$\hbox{|trie_c[trie_r[z]]>trie_c[z]|\qquad
whenever |z<>0| and |trie_r[z]<>0|};$$ in other words, sibling nodes are
ordered by their |c| fields.
@d trie_root==trie_l[0] {root of the linked trie}
@<Glob...@>=
@!init @!trie_c:packed array[trie_pointer] of packed_ASCII_code;
{characters to match}
@t\hskip10pt@>@!trie_o:packed array[trie_pointer] of quarterword;
{operations to perform}
@t\hskip10pt@>@!trie_l:packed array[trie_pointer] of trie_pointer;
{left subtrie links}
@t\hskip10pt@>@!trie_r:packed array[trie_pointer] of trie_pointer;
{right subtrie links}
@t\hskip10pt@>@!trie_ptr:trie_pointer; {the number of nodes in the trie}
@t\hskip10pt@>@!trie_hash:packed array[trie_pointer] of trie_pointer;
{used to identify equivalent subtries}
tini
@ Let us suppose that a linked trie has already been constructed.
Experience shows that we can often reduce its size by recognizing common
subtries; therefore another hash table is introduced for this purpose,
somewhat similar to |trie_op_hash|. The new hash table will be
initialized to zero.
The function |trie_node(p)| returns |p| if |p| is distinct from other nodes
that it has seen, otherwise it returns the number of the first equivalent
node that it has seen.
Notice that we might make subtries equivalent even if they correspond to
patterns for different languages, in which the trie ops might mean quite
different things. That's perfectly all right.
@<Declare procedures for preprocessing hyph...@>=
function trie_node(@!p:trie_pointer):trie_pointer; {converts
to a canonical form}
label exit;
var h:trie_pointer; {trial hash location}
@!q:trie_pointer; {trial trie node}
begin h:=abs(trie_c[p]+1009*trie_o[p]+@|
2718*trie_l[p]+3142*trie_r[p]) mod trie_size;
loop@+ begin q:=trie_hash[h];
if q=0 then
begin trie_hash[h]:=p; trie_node:=p; return;
end;
if (trie_c[q]=trie_c[p])and(trie_o[q]=trie_o[p])and@|
(trie_l[q]=trie_l[p])and(trie_r[q]=trie_r[p]) then
begin trie_node:=q; return;
end;
if h>0 then decr(h)@+else h:=trie_size;
end;
exit:end;
@ A neat recursive procedure is now able to compress a trie by
traversing it and applying |trie_node| to its nodes in ``bottom up''
fashion. We will compress the entire trie by clearing |trie_hash| to
zero and then saying `|trie_root:=compress_trie(trie_root)|'.
@^recursion@>
@<Declare procedures for preprocessing hyph...@>=
function compress_trie(@!p:trie_pointer):trie_pointer;
begin if p=0 then compress_trie:=0
else begin trie_l[p]:=compress_trie(trie_l[p]);
trie_r[p]:=compress_trie(trie_r[p]);
compress_trie:=trie_node(p);
end;
end;
@ The compressed trie will be packed into the |trie| array using a
``top-down first-fit'' procedure. This is a little tricky, so the reader
should pay close attention: The |trie_hash| array is cleared to zero
again and renamed |trie_ref| for this phase of the operation; later on,
|trie_ref[p]| will be nonzero only if the linked trie node |p| is the
smallest character
in a family and if the characters |c| of that family have been allocated to
locations |trie_ref[p]+c| in the |trie| array. Locations of |trie| that
are in use will have |trie_link=0|, while the unused holes in |trie|
will be doubly linked with |trie_link| pointing to the next larger vacant
location and |trie_back| pointing to the next smaller one. This double
linking will have been carried out only as far as |trie_max|, where
|trie_max| is the largest index of |trie| that will be needed.
To save time at the low end of the trie, we maintain array entries
|trie_min[c]| pointing to the smallest hole that is greater than~|c|.
Another array |trie_taken| tells whether or not a given location is
equal to |trie_ref[p]| for some |p|; this array is used to ensure that
distinct nodes in the compressed trie will have distinct |trie_ref|
entries.
@d trie_ref==trie_hash {where linked trie families go into |trie|}
@d trie_back(#)==trie[#].lh {backward links in |trie| holes}
@<Glob...@>=
@!init @!trie_taken:packed array[1..trie_size] of boolean;
{does a family start here?}
@t\hskip10pt@>@!trie_min:array[ASCII_code] of trie_pointer;
{the first possible slot for each character}
@t\hskip10pt@>@!trie_max:trie_pointer; {largest location used in |trie|}
@t\hskip10pt@>@!trie_not_ready:boolean; {is the trie still in linked form?}
tini
@ Each time \.{\\patterns} appears, it contributes further patterns to
the future trie, which will be built only when hyphenation is attempted or
when a format file is dumped. The boolean variable |trie_not_ready|
will change to |false| when the trie is compressed; this will disable
further patterns.
@<Initialize table entries...@>=
trie_not_ready:=true; trie_root:=0; trie_c[0]:=si(0); trie_ptr:=0;
@ Here is how the trie-compression data structures are initialized.
If storage is tight, it would be possible to overlap |trie_op_hash|,
|trie_op_lang|, and |trie_op_val| with |trie|, |trie_hash|, and |trie_taken|,
because we finish with the former just before we need the latter.
@<Get ready to compress the trie@>=
@<Sort \(t)the hyphenation...@>;
for p:=0 to trie_size do trie_hash[p]:=0;
hyph_root:=compress_trie(hyph_root);
trie_root:=compress_trie(trie_root); {identify equivalent subtries}
for p:=0 to trie_ptr do trie_ref[p]:=0;
for p:=0 to 255 do trie_min[p]:=p+1;
trie_link(0):=1; trie_max:=0
@ The |first_fit| procedure finds the smallest hole |z| in |trie| such that
a trie family starting at a given node |p| will fit into vacant positions
starting at |z|. If |c=trie_c[p]|, this means that location |z-c| must
not already be taken by some other family, and that |z-c+@t$c^\prime$@>|
must be vacant for all characters $c^\prime$ in the family. The procedure
sets |trie_ref[p]| to |z-c| when the first fit has been found.
@<Declare procedures for preprocessing hyph...@>=
procedure first_fit(@!p:trie_pointer); {packs a family into |trie|}
label not_found,found;
var h:trie_pointer; {candidate for |trie_ref[p]|}
@!z:trie_pointer; {runs through holes}
@!q:trie_pointer; {runs through the family starting at |p|}
@!c:ASCII_code; {smallest character in the family}
@!l,@!r:trie_pointer; {left and right neighbors}
@!ll:1..256; {upper limit of |trie_min| updating}
begin c:=so(trie_c[p]);
z:=trie_min[c]; {get the first conceivably good hole}
loop@+ begin h:=z-c;@/
@<Ensure that |trie_max>=h+256|@>;
if trie_taken[h] then goto not_found;
@<If all characters of the family fit relative to |h|, then
|goto found|,\30\ otherwise |goto not_found|@>;
not_found: z:=trie_link(z); {move to the next hole}
end;
found: @<Pack the family into |trie| relative to |h|@>;
end;
@ By making sure that |trie_max| is at least |h+256|, we can be sure that
|trie_max>z|, since |h=z-c|. It follows that location |trie_max| will
never be occupied in |trie|, and we will have |trie_max>=trie_link(z)|.
@<Ensure that |trie_max>=h+256|@>=
if trie_max<h+256 then
begin if trie_size<=h+256 then overflow("pattern memory",trie_size);
@:TeX capacity exceeded pattern memory}{\quad pattern memory@>
repeat incr(trie_max); trie_taken[trie_max]:=false;
trie_link(trie_max):=trie_max+1; trie_back(trie_max):=trie_max-1;
until trie_max=h+256;
end
@ @<If all characters of the family fit relative to |h|...@>=
q:=trie_r[p];
while q>0 do
begin if trie_link(h+so(trie_c[q]))=0 then goto not_found;
q:=trie_r[q];
end;
goto found
@ @<Pack the family into |trie| relative to |h|@>=
trie_taken[h]:=true; trie_ref[p]:=h; q:=p;
repeat z:=h+so(trie_c[q]); l:=trie_back(z); r:=trie_link(z);
trie_back(r):=l; trie_link(l):=r; trie_link(z):=0;
if l<256 then
begin if z<256 then ll:=z @+else ll:=256;
repeat trie_min[l]:=r; incr(l);
until l=ll;
end;
q:=trie_r[q];
until q=0
@ To pack the entire linked trie, we use the following recursive procedure.
@^recursion@>
@<Declare procedures for preprocessing hyph...@>=
procedure trie_pack(@!p:trie_pointer); {pack subtries of a family}
var q:trie_pointer; {a local variable that need not be saved on recursive calls}
begin repeat q:=trie_l[p];
if (q>0)and(trie_ref[q]=0) then
begin first_fit(q); trie_pack(q);
end;
p:=trie_r[p];
until p=0;
end;
@ When the whole trie has been allocated into the sequential table, we
must go through it once again so that |trie| contains the correct
information. Null pointers in the linked trie will be represented by the
value~0, which properly implements an ``empty'' family.
@<Move the data into |trie|@>=
h.rh:=0; h.b0:=min_quarterword; h.b1:=min_quarterword; {|trie_link:=0|,
|trie_op:=min_quarterword|, |trie_char:=qi(0)|}
if trie_max=0 then {no patterns were given}
begin for r:=0 to 256 do trie[r]:=h;
trie_max:=256;
end
else begin if hyph_root>0 then trie_fix(hyph_root);
if trie_root>0 then trie_fix(trie_root); {this fixes the non-holes in |trie|}
r:=0; {now we will zero out all the holes}
repeat s:=trie_link(r); trie[r]:=h; r:=s;
until r>trie_max;
end;
trie_char(0):=qi("?"); {make |trie_char(c)<>c| for all |c|}
@ The fixing-up procedure is, of course, recursive. Since the linked trie
usually has overlapping subtries, the same data may be moved several
times; but that causes no harm, and at most as much work is done as it
took to build the uncompressed trie.
@^recursion@>
@<Declare procedures for preprocessing hyph...@>=
procedure trie_fix(@!p:trie_pointer); {moves |p| and its siblings into |trie|}
var q:trie_pointer; {a local variable that need not be saved on recursive calls}
@!c:ASCII_code; {another one that need not be saved}
@!z:trie_pointer; {|trie| reference; this local variable must be saved}
begin z:=trie_ref[p];
repeat q:=trie_l[p]; c:=so(trie_c[p]);
trie_link(z+c):=trie_ref[q]; trie_char(z+c):=qi(c); trie_op(z+c):=trie_o[p];
if q>0 then trie_fix(q);
p:=trie_r[p];
until p=0;
end;
@ Now let's go back to the easier problem, of building the linked
trie. When \.{INITEX} has scanned the `\.{\\patterns}' control
sequence, it calls on |new_patterns| to do the right thing.
@<Declare procedures for preprocessing hyph...@>=
procedure new_patterns; {initializes the hyphenation pattern data}
label done, done1;
var k,@!l:0..64; {indices into |hc| and |hyf|;
not always in |small_number| range}
@!digit_sensed:boolean; {should the next digit be treated as a letter?}
@!v:quarterword; {trie op code}
@!p,@!q:trie_pointer; {nodes of trie traversed during insertion}
@!first_child:boolean; {is |p=trie_l[q]|?}
@!c:ASCII_code; {character being inserted}
begin if trie_not_ready then
begin set_cur_lang; scan_left_brace; {a left brace must follow \.{\\patterns}}
@<Enter all of the patterns into a linked trie, until coming to a right
brace@>;
if saving_hyph_codes>0 then
@<Store hyphenation codes for current language@>;
end
else begin print_err("Too late for "); print_esc("patterns");
help1("All patterns must be given before typesetting begins.");
error; link(garbage):=scan_toks(false,false); flush_list(def_ref);
end;
end;
@ Novices are not supposed to be using \.{\\patterns}, so the error
messages are terse. (Note that all error messages appear in \TeX's string
pool, even if they are used only by \.{INITEX}.)
@<Enter all of the patterns into a linked trie...@>=
k:=0; hyf[0]:=0; digit_sensed:=false;
loop@+ begin get_x_token;
case cur_cmd of
letter,other_char:@<Append a new letter or a hyphen level@>;
spacer,right_brace: begin if k>0 then
@<Insert a new pattern into the linked trie@>;
if cur_cmd=right_brace then goto done;
k:=0; hyf[0]:=0; digit_sensed:=false;
end;
othercases begin print_err("Bad "); print_esc("patterns");
@.Bad \\patterns@>
help1("(See Appendix H.)"); error;
end
endcases;
end;
done:
@ @<Append a new letter or a hyphen level@>=
if digit_sensed or(cur_chr<"0")or(cur_chr>"9") then
begin if cur_chr="." then cur_chr:=0 {edge-of-word delimiter}
else begin cur_chr:=lc_code(cur_chr);
if cur_chr=0 then
begin print_err("Nonletter");
@.Nonletter@>
help1("(See Appendix H.)"); error;
end;
end;
if k<63 then
begin incr(k); hc[k]:=cur_chr; hyf[k]:=0; digit_sensed:=false;
end;
end
else if k<63 then
begin hyf[k]:=cur_chr-"0"; digit_sensed:=true;
end
@ When the following code comes into play, the pattern $p_1\ldots p_k$
appears in |hc[1..k]|, and the corresponding sequence of numbers $n_0\ldots
n_k$ appears in |hyf[0..k]|.
@<Insert a new pattern into the linked trie@>=
begin @<Compute the trie op code, |v|, and set |l:=0|@>;
q:=0; hc[0]:=cur_lang;
while l<=k do
begin c:=hc[l]; incr(l); p:=trie_l[q]; first_child:=true;
while (p>0)and(c>so(trie_c[p])) do
begin q:=p; p:=trie_r[q]; first_child:=false;
end;
if (p=0)or(c<so(trie_c[p])) then
@<Insert a new trie node between |q| and |p|, and
make |p| point to it@>;
q:=p; {now node |q| represents $p_1\ldots p_{l-1}$}
end;
if trie_o[q]<>min_quarterword then
begin print_err("Duplicate pattern");
@.Duplicate pattern@>
help1("(See Appendix H.)"); error;
end;
trie_o[q]:=v;
end
@ @<Insert a new trie node between |q| and |p|...@>=
begin if trie_ptr=trie_size then overflow("pattern memory",trie_size);
@:TeX capacity exceeded pattern memory}{\quad pattern memory@>
incr(trie_ptr); trie_r[trie_ptr]:=p; p:=trie_ptr; trie_l[p]:=0;
if first_child then trie_l[q]:=p@+else trie_r[q]:=p;
trie_c[p]:=si(c); trie_o[p]:=min_quarterword;
end
@ @<Compute the trie op code, |v|...@>=
if hc[1]=0 then hyf[0]:=0;
if hc[k]=0 then hyf[k]:=0;
l:=k; v:=min_quarterword;
loop@+ begin if hyf[l]<>0 then v:=new_trie_op(k-l,hyf[l],v);
if l>0 then decr(l)@+else goto done1;
end;
done1:
@ Finally we put everything together: Here is how the trie gets to its
final, efficient form.
The following packing routine is rigged so that the root of the linked
tree gets mapped into location 1 of |trie|, as required by the hyphenation
algorithm. This happens because the first call of |first_fit| will
``take'' location~1.
@<Declare procedures for preprocessing hyphenation patterns@>=
procedure init_trie;
var @!p:trie_pointer; {pointer for initialization}
@!j,@!k,@!t:integer; {all-purpose registers for initialization}
@!r,@!s:trie_pointer; {used to clean up the packed |trie|}
@!h:two_halves; {template used to zero out |trie|'s holes}
begin @<Get ready to compress the trie@>;
if trie_root<>0 then
begin first_fit(trie_root); trie_pack(trie_root);
end;
if hyph_root<>0 then @<Pack all stored |hyph_codes|@>;
@<Move the data into |trie|@>;
trie_not_ready:=false;
end;
@* \[44] Breaking vertical lists into pages.
The |vsplit| procedure, which implements \TeX's \.{\\vsplit} operation,
is considerably simpler than |line_break| because it doesn't have to
worry about hyphenation, and because its mission is to discover a single
break instead of an optimum sequence of breakpoints. But before we get
into the details of |vsplit|, we need to consider a few more basic things.
@ A subroutine called |prune_page_top| takes a pointer to a vlist and
returns a pointer to a modified vlist in which all glue, kern, and penalty nodes
have been deleted before the first box or rule node. However, the first
box or rule is actually preceded by a newly created glue node designed so that
the topmost baseline will be at distance |split_top_skip| from the top,
whenever this is possible without backspacing.
When the second argument |s| is |false| the deleted nodes are destroyed,
otherwise they are collected in a list starting at |split_disc|.
In this routine and those that follow, we make use of the fact that a
vertical list contains no character nodes, hence the |type| field exists
for each node in the list.
@^data structure assumptions@>
@d discard_or_move = 60
@p function prune_page_top(@!p:pointer;@!s:boolean):pointer;
label discard_or_move;
{adjust top after page break}
var prev_p:pointer; {lags one step behind |p|}
@!q,@!r:pointer; {temporary variables for list manipulation}
begin prev_p:=temp_head; link(temp_head):=p;
while p<>null do
case type(p) of
hlist_node,vlist_node,rule_node:@<Insert glue for |split_top_skip|
and set~|p:=null|@>;
whatsit_node,mark_node,ins_node: begin
if (type(p) = whatsit_node) and
((subtype(p) = pdf_snapy_node) or
(subtype(p) = pdf_snapy_comp_node)) then
begin
print("snap node being discarded");
goto discard_or_move;
end;
prev_p:=p; p:=link(prev_p);
end;
glue_node,kern_node,penalty_node: begin
discard_or_move:
@{
print("discard_or_move: ");
show_node_list(p);
print_ln;
@}
q:=p; p:=link(q); link(q):=null;
link(prev_p):=p;
if s then
begin if split_disc=null then split_disc:=q@+else link(r):=q;
r:=q;
end
else flush_node_list(q);
end;
othercases confusion("pruning")
@:this can't happen pruning}{\quad pruning@>
endcases;
prune_page_top:=link(temp_head);
end;
@ @<Insert glue for |split_top_skip|...@>=
begin q:=new_skip_param(split_top_skip_code); link(prev_p):=q; link(q):=p;
{now |temp_ptr=glue_ptr(q)|}
if width(temp_ptr)>height(p) then width(temp_ptr):=width(temp_ptr)-height(p)
else width(temp_ptr):=0;
p:=null;
end
@ The next subroutine finds the best place to break a given vertical list
so as to obtain a box of height~|h|, with maximum depth~|d|.
A pointer to the beginning of the vertical list is given,
and a pointer to the optimum breakpoint is returned. The list is effectively
followed by a forced break, i.e., a penalty node with the |eject_penalty|;
if the best break occurs at this artificial node, the value |null| is returned.
An array of six |scaled| distances is used to keep track of the height
from the beginning of the list to the current place, just as in |line_break|.
In fact, we use one of the same arrays, only changing its name to reflect
its new significance.
@d active_height==active_width {new name for the six distance variables}
@d cur_height==active_height[1] {the natural height}
@d set_height_zero(#)==active_height[#]:=0 {initialize the height to zero}
@#
@d update_heights=90 {go here to record glue in the |active_height| table}
@p function vert_break(@!p:pointer; @!h,@!d:scaled):pointer;
{finds optimum page break}
label done,not_found,update_heights;
var prev_p:pointer; {if |p| is a glue node, |type(prev_p)| determines
whether |p| is a legal breakpoint}
@!q,@!r:pointer; {glue specifications}
@!pi:integer; {penalty value}
@!b:integer; {badness at a trial breakpoint}
@!least_cost:integer; {the smallest badness plus penalties found so far}
@!best_place:pointer; {the most recent break that leads to |least_cost|}
@!prev_dp:scaled; {depth of previous box in the list}
@!t:small_number; {|type| of the node following a kern}
begin prev_p:=p; {an initial glue node is not a legal breakpoint}
least_cost:=awful_bad; do_all_six(set_height_zero); prev_dp:=0;
loop@+ begin @<If node |p| is a legal breakpoint, check if this break is
the best known, and |goto done| if |p| is null or
if the page-so-far is already too full to accept more stuff@>;
prev_p:=p; p:=link(prev_p);
end;
done: vert_break:=best_place;
end;
@ A global variable |best_height_plus_depth| will be set to the natural size
of the box that corresponds to the optimum breakpoint found by |vert_break|.
(This value is used by the insertion-splitting algorithm of the page builder.)
@<Glob...@>=
@!best_height_plus_depth:scaled; {height of the best box, without stretching or
shrinking}
@ A subtle point to be noted here is that the maximum depth~|d| might be
negative, so |cur_height| and |prev_dp| might need to be corrected even
after a glue or kern node.
@<If node |p| is a legal breakpoint, check...@>=
if p=null then pi:=eject_penalty
else @<Use node |p| to update the current height and depth measurements;
if this node is not a legal breakpoint, |goto not_found|
or |update_heights|,
otherwise set |pi| to the associated penalty at the break@>;
@<Check if node |p| is a new champion breakpoint; then \(go)|goto done|
if |p| is a forced break or if the page-so-far is already too full@>;
if (type(p)<glue_node)or(type(p)>kern_node) then goto not_found;
update_heights: @<Update the current height and depth measurements with
respect to a glue or kern node~|p|@>;
not_found: if prev_dp>d then
begin cur_height:=cur_height+prev_dp-d;
prev_dp:=d;
end;
@ @<Use node |p| to update the current height and depth measurements...@>=
case type(p) of
hlist_node,vlist_node,rule_node: begin@t@>@;@/
cur_height:=cur_height+prev_dp+height(p); prev_dp:=depth(p);
goto not_found;
end;
whatsit_node:@<Process whatsit |p| in |vert_break| loop, |goto not_found|@>;
glue_node: if precedes_break(prev_p) then pi:=0
else goto update_heights;
kern_node: begin if link(p)=null then t:=penalty_node
else t:=type(link(p));
if t=glue_node then pi:=0@+else goto update_heights;
end;
penalty_node: pi:=penalty(p);
mark_node,ins_node: goto not_found;
othercases confusion("vertbreak")
@:this can't happen vertbreak}{\quad vertbreak@>
endcases
@ @d deplorable==100000 {more than |inf_bad|, but less than |awful_bad|}
@<Check if node |p| is a new champion breakpoint; then \(go)...@>=
if pi<inf_penalty then
begin @<Compute the badness, |b|, using |awful_bad|
if the box is too full@>;
if b<awful_bad then
if pi<=eject_penalty then b:=pi
else if b<inf_bad then b:=b+pi
else b:=deplorable;
if b<=least_cost then
begin best_place:=p; least_cost:=b;
best_height_plus_depth:=cur_height+prev_dp;
end;
if (b=awful_bad)or(pi<=eject_penalty) then goto done;
end
@ @<Compute the badness, |b|, using |awful_bad| if the box is too full@>=
if cur_height<h then
if (active_height[3]<>0) or (active_height[4]<>0) or
(active_height[5]<>0) then b:=0
else b:=badness(h-cur_height,active_height[2])
else if cur_height-h>active_height[6] then b:=awful_bad
else b:=badness(cur_height-h,active_height[6])
@ Vertical lists that are subject to the |vert_break| procedure should not
contain infinite shrinkability, since that would permit any amount of
information to ``fit'' on one page.
@<Update the current height and depth measurements with...@>=
if type(p)=kern_node then q:=p
else begin q:=glue_ptr(p);
active_height[2+stretch_order(q)]:=@|
active_height[2+stretch_order(q)]+stretch(q);@/
active_height[6]:=active_height[6]+shrink(q);
if (shrink_order(q)<>normal)and(shrink(q)<>0) then
begin@t@>@;@/
print_err("Infinite glue shrinkage found in box being split");@/
@.Infinite glue shrinkage...@>
help4("The box you are \vsplitting contains some infinitely")@/
("shrinkable glue, e.g., `\vss' or `\vskip 0pt minus 1fil'.")@/
("Such glue doesn't belong there; but you can safely proceed,")@/
("since the offensive shrinkability has been made finite.");
error; r:=new_spec(q); shrink_order(r):=normal; delete_glue_ref(q);
glue_ptr(p):=r; q:=r;
end;
end;
cur_height:=cur_height+prev_dp+width(q); prev_dp:=0
@ Now we are ready to consider |vsplit| itself. Most of
its work is accomplished by the two subroutines that we have just considered.
Given the number of a vlist box |n|, and given a desired page height |h|,
the |vsplit| function finds the best initial segment of the vlist and
returns a box for a page of height~|h|. The remainder of the vlist, if
any, replaces the original box, after removing glue and penalties and
adjusting for |split_top_skip|. Mark nodes in the split-off box are used to
set the values of |split_first_mark| and |split_bot_mark|; we use the
fact that |split_first_mark=null| if and only if |split_bot_mark=null|.
The original box becomes ``void'' if and only if it has been entirely
extracted. The extracted box is ``void'' if and only if the original
box was void (or if it was, erroneously, an hlist box).
@p @t\4@>@<Declare the function called |do_marks|@>@;
function vsplit(@!n:halfword; @!h:scaled):pointer;
{extracts a page of height |h| from box |n|}
label exit,done;
var v:pointer; {the box to be split}
p:pointer; {runs through the vlist}
q:pointer; {points to where the break occurs}
begin cur_val:=n; fetch_box(v);
flush_node_list(split_disc); split_disc:=null;
if sa_mark<>null then
if do_marks(vsplit_init,0,sa_mark) then sa_mark:=null;
if split_first_mark<>null then
begin delete_token_ref(split_first_mark); split_first_mark:=null;
delete_token_ref(split_bot_mark); split_bot_mark:=null;
end;
@<Dispense with trivial cases of void or bad boxes@>;
q:=vert_break(list_ptr(v),h,split_max_depth);
@<Look at all the marks in nodes before the break, and set the final
link to |null| at the break@>;
q:=prune_page_top(q,saving_vdiscards>0);
p:=list_ptr(v); free_node(v,box_node_size);
if q<>null then q:=vpack(q,natural);
change_box(q); {the |eq_level| of the box stays the same}
vsplit:=vpackage(p,h,exactly,split_max_depth);
exit: end;
@ @<Dispense with trivial cases of void or bad boxes@>=
if v=null then
begin vsplit:=null; return;
end;
if type(v)<>vlist_node then
begin print_err(""); print_esc("vsplit"); print(" needs a ");
print_esc("vbox");
@:vsplit_}{\.{\\vsplit needs a \\vbox}@>
help2("The box you are trying to split is an \hbox.")@/
("I can't split such a box, so I'll leave it alone.");
error; vsplit:=null; return;
end
@ It's possible that the box begins with a penalty node that is the
``best'' break, so we must be careful to handle this special case correctly.
@<Look at all the marks...@>=
p:=list_ptr(v);
if p=q then list_ptr(v):=null
else loop@+begin if type(p)=mark_node then
if mark_class(p)<>0 then @<Update the current marks for |vsplit|@>
else if split_first_mark=null then
begin split_first_mark:=mark_ptr(p);
split_bot_mark:=split_first_mark;
token_ref_count(split_first_mark):=@|
token_ref_count(split_first_mark)+2;
end
else begin delete_token_ref(split_bot_mark);
split_bot_mark:=mark_ptr(p);
add_token_ref(split_bot_mark);
end;
if link(p)=q then
begin link(p):=null; goto done;
end;
p:=link(p);
end;
done:
@* \[45] The page builder.
When \TeX\ appends new material to its main vlist in vertical mode, it uses
a method something like |vsplit| to decide where a page ends, except that
the calculations are done ``on line'' as new items come in.
The main complication in this process is that insertions must be put
into their boxes and removed from the vlist, in a more-or-less optimum manner.
We shall use the term ``current page'' for that part of the main vlist that
is being considered as a candidate for being broken off and sent to the
user's output routine. The current page starts at |link(page_head)|, and
it ends at |page_tail|. We have |page_head=page_tail| if this list is empty.
@^current page@>
Utter chaos would reign if the user kept changing page specifications
while a page is being constructed, so the page builder keeps the pertinent
specifications frozen as soon as the page receives its first box or
insertion. The global variable |page_contents| is |empty| when the
current page contains only mark nodes and content-less whatsit nodes; it
is |inserts_only| if the page contains only insertion nodes in addition to
marks and whatsits. Glue nodes, kern nodes, and penalty nodes are
discarded until a box or rule node appears, at which time |page_contents|
changes to |box_there|. As soon as |page_contents| becomes non-|empty|,
the current |vsize| and |max_depth| are squirreled away into |page_goal|
and |page_max_depth|; the latter values will be used until the page has
been forwarded to the user's output routine. The \.{\\topskip} adjustment
is made when |page_contents| changes to |box_there|.
Although |page_goal| starts out equal to |vsize|, it is decreased by the
scaled natural height-plus-depth of the insertions considered so far, and by
the \.{\\skip} corrections for those insertions. Therefore it represents
the size into which the non-inserted material should fit, assuming that
all insertions in the current page have been made.
The global variables |best_page_break| and |least_page_cost| correspond
respectively to the local variables |best_place| and |least_cost| in the
|vert_break| routine that we have already studied; i.e., they record the
location and value of the best place currently known for breaking the
current page. The value of |page_goal| at the time of the best break is
stored in |best_size|.
@d inserts_only=1
{|page_contents| when an insert node has been contributed, but no boxes}
@d box_there=2 {|page_contents| when a box or rule has been contributed}
@<Glob...@>=
@!page_tail:pointer; {the final node on the current page}
@!page_contents:empty..box_there; {what is on the current page so far?}
@!page_max_depth:scaled; {maximum box depth on page being built}
@!best_page_break:pointer; {break here to get the best page known so far}
@!least_page_cost:integer; {the score for this currently best page}
@!best_size:scaled; {its |page_goal|}
@ The page builder has another data structure to keep track of insertions.
This is a list of four-word nodes, starting and ending at |page_ins_head|.
That is, the first element of the list is node |r@t$_1$@>=link(page_ins_head)|;
node $r_j$ is followed by |r@t$_{j+1}$@>=link(r@t$_j$@>)|; and if there are
|n| items we have |r@t$_{n+1}$@>=page_ins_head|. The |subtype| field of
each node in this list refers to an insertion number; for example, `\.{\\insert
250}' would correspond to a node whose |subtype| is |qi(250)|
(the same as the |subtype| field of the relevant |ins_node|). These |subtype|
fields are in increasing order, and |subtype(page_ins_head)=
qi(255)|, so |page_ins_head| serves as a convenient sentinel
at the end of the list. A record is present for each insertion number that
appears in the current page.
The |type| field in these nodes distinguishes two possibilities that
might occur as we look ahead before deciding on the optimum page break.
If |type(r)=inserting|, then |height(r)| contains the total of the
height-plus-depth dimensions of the box and all its inserts seen so far.
If |type(r)=split_up|, then no more insertions will be made into this box,
because at least one previous insertion was too big to fit on the current
page; |broken_ptr(r)| points to the node where that insertion will be
split, if \TeX\ decides to split it, |broken_ins(r)| points to the
insertion node that was tentatively split, and |height(r)| includes also the
natural height plus depth of the part that would be split off.
In both cases, |last_ins_ptr(r)| points to the last |ins_node|
encountered for box |qo(subtype(r))| that would be at least partially
inserted on the next page; and |best_ins_ptr(r)| points to the last
such |ins_node| that should actually be inserted, to get the page with
minimum badness among all page breaks considered so far. We have
|best_ins_ptr(r)=null| if and only if no insertion for this box should
be made to produce this optimum page.
The data structure definitions here use the fact that the |@!height| field
appears in the fourth word of a box node.
@^data structure assumptions@>
@d page_ins_node_size=4 {number of words for a page insertion node}
@d inserting=0 {an insertion class that has not yet overflowed}
@d split_up=1 {an overflowed insertion class}
@d broken_ptr(#)==link(#+1)
{an insertion for this class will break here if anywhere}
@d broken_ins(#)==info(#+1) {this insertion might break at |broken_ptr|}
@d last_ins_ptr(#)==link(#+2) {the most recent insertion for this |subtype|}
@d best_ins_ptr(#)==info(#+2) {the optimum most recent insertion}
@<Initialize the special list heads...@>=
subtype(page_ins_head):=qi(255);
type(page_ins_head):=split_up; link(page_ins_head):=page_ins_head;
@ An array |page_so_far| records the heights and depths of everything
on the current page. This array contains six |scaled| numbers, like the
similar arrays already considered in |line_break| and |vert_break|; and it
also contains |page_goal| and |page_depth|, since these values are
all accessible to the user via |set_page_dimen| commands. The
value of |page_so_far[1]| is also called |page_total|. The stretch
and shrink components of the \.{\\skip} corrections for each insertion are
included in |page_so_far|, but the natural space components of these
corrections are not, since they have been subtracted from |page_goal|.
The variable |page_depth| records the depth of the current page; it has been
adjusted so that it is at most |page_max_depth|. The variable
|last_glue| points to the glue specification of the most recent node
contributed from the contribution list, if this was a glue node; otherwise
|last_glue=max_halfword|. (If the contribution list is nonempty,
however, the value of |last_glue| is not necessarily accurate.)
The variables |last_penalty|, |last_kern|, and |last_node_type|
are similar. And
finally, |insert_penalties| holds the sum of the penalties associated with
all split and floating insertions.
@d page_goal==page_so_far[0] {desired height of information on page being built}
@d page_total==page_so_far[1] {height of the current page}
@d page_shrink==page_so_far[6] {shrinkability of the current page}
@d page_depth==page_so_far[7] {depth of the current page}
@<Glob...@>=
@!page_so_far:array [0..7] of scaled; {height and glue of the current page}
@!last_glue:pointer; {used to implement \.{\\lastskip}}
@!last_penalty:integer; {used to implement \.{\\lastpenalty}}
@!last_kern:scaled; {used to implement \.{\\lastkern}}
@!last_node_type:integer; {used to implement \.{\\lastnodetype}}
@!insert_penalties:integer; {sum of the penalties for insertions
that were held over}
@ @<Put each...@>=
primitive("pagegoal",set_page_dimen,0);
@!@:page_goal_}{\.{\\pagegoal} primitive@>
primitive("pagetotal",set_page_dimen,1);
@!@:page_total_}{\.{\\pagetotal} primitive@>
primitive("pagestretch",set_page_dimen,2);
@!@:page_stretch_}{\.{\\pagestretch} primitive@>
primitive("pagefilstretch",set_page_dimen,3);
@!@:page_fil_stretch_}{\.{\\pagefilstretch} primitive@>
primitive("pagefillstretch",set_page_dimen,4);
@!@:page_fill_stretch_}{\.{\\pagefillstretch} primitive@>
primitive("pagefilllstretch",set_page_dimen,5);
@!@:page_filll_stretch_}{\.{\\pagefilllstretch} primitive@>
primitive("pageshrink",set_page_dimen,6);
@!@:page_shrink_}{\.{\\pageshrink} primitive@>
primitive("pagedepth",set_page_dimen,7);
@!@:page_depth_}{\.{\\pagedepth} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
set_page_dimen: case chr_code of
0: print_esc("pagegoal");
1: print_esc("pagetotal");
2: print_esc("pagestretch");
3: print_esc("pagefilstretch");
4: print_esc("pagefillstretch");
5: print_esc("pagefilllstretch");
6: print_esc("pageshrink");
othercases print_esc("pagedepth")
endcases;
@ @d print_plus_end(#)==print(#);@+end
@d print_plus(#)==if page_so_far[#]<>0 then
begin print(" plus "); print_scaled(page_so_far[#]); print_plus_end
@p procedure print_totals;
begin print_scaled(page_total);
print_plus(2)("");
print_plus(3)("fil");
print_plus(4)("fill");
print_plus(5)("filll");
if page_shrink<>0 then
begin print(" minus "); print_scaled(page_shrink);
end;
end;
@ @<Show the status of the current page@>=
if page_head<>page_tail then
begin print_nl("### current page:");
if output_active then print(" (held over for next output)");
@.held over for next output@>
show_box(link(page_head));
if page_contents>empty then
begin print_nl("total height "); print_totals;
@:total_height}{\.{total height}@>
print_nl(" goal height "); print_scaled(page_goal);
@.goal height@>
r:=link(page_ins_head);
while r<>page_ins_head do
begin print_ln; print_esc("insert"); t:=qo(subtype(r));
print_int(t); print(" adds ");
if count(t)=1000 then t:=height(r)
else t:=x_over_n(height(r),1000)*count(t);
print_scaled(t);
if type(r)=split_up then
begin q:=page_head; t:=0;
repeat q:=link(q);
if (type(q)=ins_node)and(subtype(q)=subtype(r)) then incr(t);
until q=broken_ins(r);
print(", #"); print_int(t); print(" might split");
end;
r:=link(r);
end;
end;
end
@ Here is a procedure that is called when the |page_contents| is changing
from |empty| to |inserts_only| or |box_there|.
@d set_page_so_far_zero(#)==page_so_far[#]:=0
@p procedure freeze_page_specs(@!s:small_number);
begin page_contents:=s;
page_goal:=vsize; page_max_depth:=max_depth;
page_depth:=0; do_all_six(set_page_so_far_zero);
least_page_cost:=awful_bad;
@!stat if tracing_pages>0 then
begin begin_diagnostic;
print_nl("%% goal height="); print_scaled(page_goal);
@.goal height@>
print(", max depth="); print_scaled(page_max_depth);
end_diagnostic(false);
end;@;@+tats@;@/
end;
@ Pages are built by appending nodes to the current list in \TeX's
vertical mode, which is at the outermost level of the semantic nest. This
vlist is split into two parts; the ``current page'' that we have been
talking so much about already, and the ``contribution list'' that receives
new nodes as they are created. The current page contains everything that
the page builder has accounted for in its data structures, as described
above, while the contribution list contains other things that have been
generated by other parts of \TeX\ but have not yet been
seen by the page builder.
The contribution list starts at |link(contrib_head)|, and it ends at the
current node in \TeX's vertical mode.
When \TeX\ has appended new material in vertical mode, it calls the procedure
|build_page|, which tries to catch up by moving nodes from the contribution
list to the current page. This procedure will succeed in its goal of
emptying the contribution list, unless a page break is discovered, i.e.,
unless the current page has grown to the point where the optimum next
page break has been determined. In the latter case, the nodes after the
optimum break will go back onto the contribution list, and control will
effectively pass to the user's output routine.
We make |type(page_head)=glue_node|, so that an initial glue node on
the current page will not be considered a valid breakpoint.
@<Initialize the special list...@>=
type(page_head):=glue_node; subtype(page_head):=normal;
@ The global variable |output_active| is true during the time the
user's output routine is driving \TeX.
@<Glob...@>=
@!output_active:boolean; {are we in the midst of an output routine?}
@ @<Set init...@>=
output_active:=false; insert_penalties:=0;
@ The page builder is ready to start a fresh page if we initialize
the following state variables. (However, the page insertion list is initialized
elsewhere.)
@<Start a new current page@>=
page_contents:=empty; page_tail:=page_head; link(page_head):=null;@/
last_glue:=max_halfword; last_penalty:=0; last_kern:=0;
last_node_type:=-1;
page_depth:=0; page_max_depth:=0
@ At certain times box 255 is supposed to be void (i.e., |null|),
or an insertion box is supposed to be ready to accept a vertical list.
If not, an error message is printed, and the following subroutine
flushes the unwanted contents, reporting them to the user.
@p procedure box_error(@!n:eight_bits);
begin error; begin_diagnostic;
print_nl("The following box has been deleted:");
@.The following...deleted@>
show_box(box(n)); end_diagnostic(true);
flush_node_list(box(n)); box(n):=null;
end;
@ The following procedure guarantees that a given box register
does not contain an \.{\\hbox}.
@p procedure ensure_vbox(@!n:eight_bits);
var p:pointer; {the box register contents}
begin p:=box(n);
if p<>null then if type(p)=hlist_node then
begin print_err("Insertions can only be added to a vbox");
@.Insertions can only...@>
help3("Tut tut: You're trying to \insert into a")@/
("\box register that now contains an \hbox.")@/
("Proceed, and I'll discard its present contents.");
box_error(n);
end;
end;
@ \TeX\ is not always in vertical mode at the time |build_page|
is called; the current mode reflects what \TeX\ should return to, after
the contribution list has been emptied. A call on |build_page| should
be immediately followed by `|goto big_switch|', which is \TeX's central
control point.
@d contribute=80 {go here to link a node into the current page}
@p @t\4@>@<Declare the procedure called |fire_up|@>@;@/
procedure build_page; {append contributions to the current page}
label exit,done,done1,continue,contribute,update_heights;
var p:pointer; {the node being appended}
@!q,@!r:pointer; {nodes being examined}
@!b,@!c:integer; {badness and cost of current page}
@!pi:integer; {penalty to be added to the badness}
@!n:min_quarterword..255; {insertion box number}
@!delta,@!h,@!w:scaled; {sizes used for insertion calculations}
begin if (link(contrib_head)=null)or output_active then return;
repeat continue: p:=link(contrib_head);@/
@<Update the values of |last_glue|, |last_penalty|, and |last_kern|@>;
@<Move node |p| to the current page; if it is time for a page break,
put the nodes following the break back onto the contribution list,
and |return| to the user's output routine if there is one@>;
until link(contrib_head)=null;
@<Make the contribution list empty by setting its tail to |contrib_head|@>;
exit:end;
@ @d contrib_tail==nest[0].tail_field {tail of the contribution list}
@<Make the contribution list empty...@>=
if nest_ptr=0 then tail:=contrib_head {vertical mode}
else contrib_tail:=contrib_head {other modes}
@ @<Update the values of |last_glue|...@>=
if last_glue<>max_halfword then delete_glue_ref(last_glue);
last_penalty:=0; last_kern:=0;
last_node_type:=type(p)+1;
if type(p)=glue_node then
begin last_glue:=glue_ptr(p); add_glue_ref(last_glue);
end
else begin last_glue:=max_halfword;
if type(p)=penalty_node then last_penalty:=penalty(p)
else if type(p)=kern_node then last_kern:=width(p);
end
@ The code here is an example of a many-way switch into routines that
merge together in different places. Some people call this unstructured
programming, but the author doesn't see much wrong with it, as long as
@^Knuth, Donald Ervin@>
the various labels have a well-understood meaning.
@<Move node |p| to the current page; ...@>=
@<If the current page is empty and node |p| is to be deleted, |goto done1|;
otherwise use node |p| to update the state of the current page;
if this node is an insertion, |goto contribute|; otherwise if this node
is not a legal breakpoint, |goto contribute| or |update_heights|;
otherwise set |pi| to the penalty associated with this breakpoint@>;
@<Check if node |p| is a new champion breakpoint; then \(if)if it is time for
a page break, prepare for output, and either fire up the user's
output routine and |return| or ship out the page and |goto done|@>;
if (type(p)<glue_node)or(type(p)>kern_node) then goto contribute;
update_heights:@<Update the current page measurements with respect to the
glue or kern specified by node~|p|@>;
contribute: @<Make sure that |page_max_depth| is not exceeded@>;
@<Link node |p| into the current page and |goto done|@>;
done1:@<Recycle node |p|@>;
done:
@ @<Link node |p| into the current page and |goto done|@>=
link(page_tail):=p; page_tail:=p;
link(contrib_head):=link(p); link(p):=null; goto done
@ @<Recycle node |p|@>=
link(contrib_head):=link(p); link(p):=null;
if saving_vdiscards>0 then
begin if page_disc=null then page_disc:=p@+else link(tail_page_disc):=p;
tail_page_disc:=p;
end
else flush_node_list(p)
@ The title of this section is already so long, it seems best to avoid
making it more accurate but still longer, by mentioning the fact that a
kern node at the end of the contribution list will not be contributed until
we know its successor.
@<If the current page is empty...@>=
case type(p) of
hlist_node,vlist_node,rule_node: if page_contents<box_there then
@<Initialize the current page, insert the \.{\\topskip} glue
ahead of |p|, and |goto continue|@>
else @<Prepare to move a box or rule node to the current page,
then |goto contribute|@>;
whatsit_node: if (page_contents < box_there) and
((subtype(p) = pdf_snapy_node) or
(subtype(p) = pdf_snapy_comp_node)) then
begin
print("snap node being discarded");
goto done1;
end
else @<Prepare to move whatsit |p| to the current page,
then |goto contribute|@>;
glue_node: if page_contents<box_there then goto done1
else if precedes_break(page_tail) then pi:=0
else goto update_heights;
kern_node: if page_contents<box_there then goto done1
else if link(p)=null then return
else if type(link(p))=glue_node then pi:=0
else goto update_heights;
penalty_node: if page_contents<box_there then goto done1@+else pi:=penalty(p);
mark_node: goto contribute;
ins_node: @<Append an insertion to the current page and |goto contribute|@>;
othercases confusion("page")
@:this can't happen page}{\quad page@>
endcases
@ @<Initialize the current page, insert the \.{\\topskip} glue...@>=
begin if page_contents=empty then freeze_page_specs(box_there)
else page_contents:=box_there;
q:=new_skip_param(top_skip_code); {now |temp_ptr=glue_ptr(q)|}
if width(temp_ptr)>height(p) then width(temp_ptr):=width(temp_ptr)-height(p)
else width(temp_ptr):=0;
link(q):=p; link(contrib_head):=q; goto continue;
end
@ @<Prepare to move a box or rule node to the current page...@>=
begin page_total:=page_total+page_depth+height(p);
page_depth:=depth(p);
goto contribute;
end
@ @<Make sure that |page_max_depth| is not exceeded@>=
if page_depth>page_max_depth then
begin page_total:=@|
page_total+page_depth-page_max_depth;@/
page_depth:=page_max_depth;
end;
@ @<Update the current page measurements with respect to the glue...@>=
if type(p)=kern_node then q:=p
else begin q:=glue_ptr(p);
page_so_far[2+stretch_order(q)]:=@|
page_so_far[2+stretch_order(q)]+stretch(q);@/
page_shrink:=page_shrink+shrink(q);
if (shrink_order(q)<>normal)and(shrink(q)<>0) then
begin@t@>@;@/
print_err("Infinite glue shrinkage found on current page");@/
@.Infinite glue shrinkage...@>
help4("The page about to be output contains some infinitely")@/
("shrinkable glue, e.g., `\vss' or `\vskip 0pt minus 1fil'.")@/
("Such glue doesn't belong there; but you can safely proceed,")@/
("since the offensive shrinkability has been made finite.");
error;
r:=new_spec(q); shrink_order(r):=normal; delete_glue_ref(q);
glue_ptr(p):=r; q:=r;
end;
end;
page_total:=page_total+page_depth+width(q); page_depth:=0
@ @<Check if node |p| is a new champion breakpoint; then \(if)...@>=
if pi<inf_penalty then
begin @<Compute the badness, |b|, of the current page,
using |awful_bad| if the box is too full@>;
if b<awful_bad then
if pi<=eject_penalty then c:=pi
else if b<inf_bad then c:=b+pi+insert_penalties
else c:=deplorable
else c:=b;
if insert_penalties>=10000 then c:=awful_bad;
@!stat if tracing_pages>0 then @<Display the page break cost@>;@+tats@;@/
if c<=least_page_cost then
begin best_page_break:=p; best_size:=page_goal;
least_page_cost:=c;
r:=link(page_ins_head);
while r<>page_ins_head do
begin best_ins_ptr(r):=last_ins_ptr(r);
r:=link(r);
end;
end;
if (c=awful_bad)or(pi<=eject_penalty) then
begin fire_up(p); {output the current page at the best place}
if output_active then return; {user's output routine will act}
goto done; {the page has been shipped out by default output routine}
end;
end
@ @<Display the page break cost@>=
begin begin_diagnostic; print_nl("%");
print(" t="); print_totals;@/
print(" g="); print_scaled(page_goal);@/
print(" b=");
if b=awful_bad then print_char("*")@+else print_int(b);
@.*\relax@>
print(" p="); print_int(pi);
print(" c=");
if c=awful_bad then print_char("*")@+else print_int(c);
if c<=least_page_cost then print_char("#");
end_diagnostic(false);
end
@ @<Compute the badness, |b|, of the current page...@>=
if page_total<page_goal then
if (page_so_far[3]<>0) or (page_so_far[4]<>0) or@|
(page_so_far[5]<>0) then b:=0
else b:=badness(page_goal-page_total,page_so_far[2])
else if page_total-page_goal>page_shrink then b:=awful_bad
else b:=badness(page_total-page_goal,page_shrink)
@ @<Append an insertion to the current page and |goto contribute|@>=
begin if page_contents=empty then freeze_page_specs(inserts_only);
n:=subtype(p); r:=page_ins_head;
while n>=subtype(link(r)) do r:=link(r);
n:=qo(n);
if subtype(r)<>qi(n) then
@<Create a page insertion node with |subtype(r)=qi(n)|, and
include the glue correction for box |n| in the
current page state@>;
if type(r)=split_up then insert_penalties:=insert_penalties+float_cost(p)
else begin last_ins_ptr(r):=p;
delta:=page_goal-page_total-page_depth+page_shrink;
{this much room is left if we shrink the maximum}
if count(n)=1000 then h:=height(p)
else h:=x_over_n(height(p),1000)*count(n); {this much room is needed}
if ((h<=0)or(h<=delta))and(height(p)+height(r)<=dimen(n)) then
begin page_goal:=page_goal-h; height(r):=height(r)+height(p);
end
else @<Find the best way to split the insertion, and change
|type(r)| to |split_up|@>;
end;
goto contribute;
end
@ We take note of the value of \.{\\skip} |n| and the height plus depth
of \.{\\box}~|n| only when the first \.{\\insert}~|n| node is
encountered for a new page. A user who changes the contents of \.{\\box}~|n|
after that first \.{\\insert}~|n| had better be either extremely careful
or extremely lucky, or both.
@<Create a page insertion node...@>=
begin q:=get_node(page_ins_node_size); link(q):=link(r); link(r):=q; r:=q;
subtype(r):=qi(n); type(r):=inserting; ensure_vbox(n);
if box(n)=null then height(r):=0
else height(r):=height(box(n))+depth(box(n));
best_ins_ptr(r):=null;@/
q:=skip(n);
if count(n)=1000 then h:=height(r)
else h:=x_over_n(height(r),1000)*count(n);
page_goal:=page_goal-h-width(q);@/
page_so_far[2+stretch_order(q)]:=@|page_so_far[2+stretch_order(q)]+stretch(q);@/
page_shrink:=page_shrink+shrink(q);
if (shrink_order(q)<>normal)and(shrink(q)<>0) then
begin print_err("Infinite glue shrinkage inserted from "); print_esc("skip");
@.Infinite glue shrinkage...@>
print_int(n);
help3("The correction glue for page breaking with insertions")@/
("must have finite shrinkability. But you may proceed,")@/
("since the offensive shrinkability has been made finite.");
error;
end;
end
@ Here is the code that will split a long footnote between pages, in an
emergency. The current situation deserves to be recapitulated: Node |p|
is an insertion into box |n|; the insertion will not fit, in its entirety,
either because it would make the total contents of box |n| greater than
\.{\\dimen} |n|, or because it would make the incremental amount of growth
|h| greater than the available space |delta|, or both. (This amount |h| has
been weighted by the insertion scaling factor, i.e., by \.{\\count} |n|
over 1000.) Now we will choose the best way to break the vlist of the
insertion, using the same criteria as in the \.{\\vsplit} operation.
@<Find the best way to split the insertion...@>=
begin if count(n)<=0 then w:=max_dimen
else begin w:=page_goal-page_total-page_depth;
if count(n)<>1000 then w:=x_over_n(w,count(n))*1000;
end;
if w>dimen(n)-height(r) then w:=dimen(n)-height(r);
q:=vert_break(ins_ptr(p),w,depth(p));
height(r):=height(r)+best_height_plus_depth;
@!stat if tracing_pages>0 then @<Display the insertion split cost@>;@+tats@;@/
if count(n)<>1000 then
best_height_plus_depth:=x_over_n(best_height_plus_depth,1000)*count(n);
page_goal:=page_goal-best_height_plus_depth;
type(r):=split_up; broken_ptr(r):=q; broken_ins(r):=p;
if q=null then insert_penalties:=insert_penalties+eject_penalty
else if type(q)=penalty_node then insert_penalties:=insert_penalties+penalty(q);
end
@ @<Display the insertion split cost@>=
begin begin_diagnostic; print_nl("% split"); print_int(n);
@.split@>
print(" to "); print_scaled(w);
print_char(","); print_scaled(best_height_plus_depth);@/
print(" p=");
if q=null then print_int(eject_penalty)
else if type(q)=penalty_node then print_int(penalty(q))
else print_char("0");
end_diagnostic(false);
end
@ When the page builder has looked at as much material as could appear before
the next page break, it makes its decision. The break that gave minimum
badness will be used to put a completed ``page'' into box 255, with insertions
appended to their other boxes.
We also set the values of |top_mark|, |first_mark|, and |bot_mark|. The
program uses the fact that |bot_mark<>null| implies |first_mark<>null|;
it also knows that |bot_mark=null| implies |top_mark=first_mark=null|.
The |fire_up| subroutine prepares to output the current page at the best
place; then it fires up the user's output routine, if there is one,
or it simply ships out the page. There is one parameter, |c|, which represents
the node that was being contributed to the page when the decision to
force an output was made.
@<Declare the procedure called |fire_up|@>=
procedure fire_up(@!c:pointer);
label exit;
var p,@!q,@!r,@!s:pointer; {nodes being examined and/or changed}
@!prev_p:pointer; {predecessor of |p|}
@!n:min_quarterword..255; {insertion box number}
@!wait:boolean; {should the present insertion be held over?}
@!save_vbadness:integer; {saved value of |vbadness|}
@!save_vfuzz: scaled; {saved value of |vfuzz|}
@!save_split_top_skip: pointer; {saved value of |split_top_skip|}
begin @<Set the value of |output_penalty|@>;
if sa_mark<>null then
if do_marks(fire_up_init,0,sa_mark) then sa_mark:=null;
if bot_mark<>null then
begin if top_mark<>null then delete_token_ref(top_mark);
top_mark:=bot_mark; add_token_ref(top_mark);
delete_token_ref(first_mark); first_mark:=null;
end;
@<Put the \(o)optimal current page into box 255, update |first_mark| and
|bot_mark|, append insertions to their boxes, and put the
remaining nodes back on the contribution list@>;
if sa_mark<>null then
if do_marks(fire_up_done,0,sa_mark) then sa_mark:=null;
if (top_mark<>null)and(first_mark=null) then
begin first_mark:=top_mark; add_token_ref(top_mark);
end;
if output_routine<>null then
if dead_cycles>=max_dead_cycles then
@<Explain that too many dead cycles have occurred in a row@>
else @<Fire up the user's output routine and |return|@>;
@<Perform the default output routine@>;
exit:end;
@ @<Set the value of |output_penalty|@>=
if type(best_page_break)=penalty_node then
begin geq_word_define(int_base+output_penalty_code,penalty(best_page_break));
penalty(best_page_break):=inf_penalty;
end
else geq_word_define(int_base+output_penalty_code,inf_penalty)
@ As the page is finally being prepared for output,
pointer |p| runs through the vlist, with |prev_p| trailing behind;
pointer |q| is the tail of a list of insertions that
are being held over for a subsequent page.
@<Put the \(o)optimal current page into box 255...@>=
if c=best_page_break then best_page_break:=null; {|c| not yet linked in}
@<Ensure that box 255 is empty before output@>;
insert_penalties:=0; {this will count the number of insertions held over}
save_split_top_skip:=split_top_skip;
if holding_inserts<=0 then
@<Prepare all the boxes involved in insertions to act as queues@>;
q:=hold_head; link(q):=null; prev_p:=page_head; p:=link(prev_p);
while p<>best_page_break do
begin if type(p)=ins_node then
begin if holding_inserts<=0 then
@<Either insert the material specified by node |p| into the
appropriate box, or hold it for the next page;
also delete node |p| from the current page@>;
end
else if type(p)=mark_node then
if mark_class(p)<>0 then @<Update the current marks for |fire_up|@>
else @<Update the values of
|first_mark| and |bot_mark|@>;
prev_p:=p; p:=link(prev_p);
end;
split_top_skip:=save_split_top_skip;
@<Break the current page at node |p|, put it in box~255,
and put the remaining nodes on the contribution list@>;
@<Delete \(t)the page-insertion nodes@>
@ @<Ensure that box 255 is empty before output@>=
if box(255)<>null then
begin print_err(""); print_esc("box"); print("255 is not void");
@:box255}{\.{\\box255 is not void}@>
help2("You shouldn't use \box255 except in \output routines.")@/
("Proceed, and I'll discard its present contents.");
box_error(255);
end
@ @<Update the values of |first_mark| and |bot_mark|@>=
begin if first_mark=null then
begin first_mark:=mark_ptr(p);
add_token_ref(first_mark);
end;
if bot_mark<>null then delete_token_ref(bot_mark);
bot_mark:=mark_ptr(p); add_token_ref(bot_mark);
end
@ When the following code is executed, the current page runs from node
|link(page_head)| to node |prev_p|, and the nodes from |p| to |page_tail|
are to be placed back at the front of the contribution list. Furthermore
the heldover insertions appear in a list from |link(hold_head)| to |q|; we
will put them into the current page list for safekeeping while the user's
output routine is active. We might have |q=hold_head|; and |p=null| if
and only if |prev_p=page_tail|. Error messages are suppressed within
|vpackage|, since the box might appear to be overfull or underfull simply
because the stretch and shrink from the \.{\\skip} registers for inserts
are not actually present in the box.
@<Break the current page at node |p|, put it...@>=
if p<>null then
begin if link(contrib_head)=null then
if nest_ptr=0 then tail:=page_tail
else contrib_tail:=page_tail;
link(page_tail):=link(contrib_head);
link(contrib_head):=p;
link(prev_p):=null;
end;
save_vbadness:=vbadness; vbadness:=inf_bad;
save_vfuzz:=vfuzz; vfuzz:=max_dimen; {inhibit error messages}
box(255):=vpackage(link(page_head),best_size,exactly,page_max_depth);
vbadness:=save_vbadness; vfuzz:=save_vfuzz;
if last_glue<>max_halfword then delete_glue_ref(last_glue);
@<Start a new current page@>; {this sets |last_glue:=max_halfword|}
if q<>hold_head then
begin link(page_head):=link(hold_head); page_tail:=q;
end
@ If many insertions are supposed to go into the same box, we want to know
the position of the last node in that box, so that we don't need to waste time
when linking further information into it. The |last_ins_ptr| fields of the
page insertion nodes are therefore used for this purpose during the
packaging phase.
@<Prepare all the boxes involved in insertions to act as queues@>=
begin r:=link(page_ins_head);
while r<>page_ins_head do
begin if best_ins_ptr(r)<>null then
begin n:=qo(subtype(r)); ensure_vbox(n);
if box(n)=null then box(n):=new_null_box;
p:=box(n)+list_offset;
while link(p)<>null do p:=link(p);
last_ins_ptr(r):=p;
end;
r:=link(r);
end;
end
@ @<Delete \(t)the page-insertion nodes@>=
r:=link(page_ins_head);
while r<>page_ins_head do
begin q:=link(r); free_node(r,page_ins_node_size); r:=q;
end;
link(page_ins_head):=page_ins_head
@ We will set |best_ins_ptr:=null| and package the box corresponding to
insertion node~|r|, just after making the final insertion into that box.
If this final insertion is `|split_up|', the remainder after splitting
and pruning (if any) will be carried over to the next page.
@<Either insert the material specified by node |p| into...@>=
begin r:=link(page_ins_head);
while subtype(r)<>subtype(p) do r:=link(r);
if best_ins_ptr(r)=null then wait:=true
else begin wait:=false; s:=last_ins_ptr(r); link(s):=ins_ptr(p);
if best_ins_ptr(r)=p then
@<Wrap up the box specified by node |r|, splitting node |p| if
called for; set |wait:=true| if node |p| holds a remainder after
splitting@>
else begin while link(s)<>null do s:=link(s);
last_ins_ptr(r):=s;
end;
end;
@<Either append the insertion node |p| after node |q|, and remove it
from the current page, or delete |node(p)|@>;
end
@ @<Wrap up the box specified by node |r|, splitting node |p| if...@>=
begin if type(r)=split_up then
if (broken_ins(r)=p)and(broken_ptr(r)<>null) then
begin while link(s)<>broken_ptr(r) do s:=link(s);
link(s):=null;
split_top_skip:=split_top_ptr(p);
ins_ptr(p):=prune_page_top(broken_ptr(r),false);
if ins_ptr(p)<>null then
begin temp_ptr:=vpack(ins_ptr(p),natural);
height(p):=height(temp_ptr)+depth(temp_ptr);
free_node(temp_ptr,box_node_size); wait:=true;
end;
end;
best_ins_ptr(r):=null;
n:=qo(subtype(r));
temp_ptr:=list_ptr(box(n));
free_node(box(n),box_node_size);
box(n):=vpack(temp_ptr,natural);
end
@ @<Either append the insertion node |p|...@>=
link(prev_p):=link(p); link(p):=null;
if wait then
begin link(q):=p; q:=p; incr(insert_penalties);
end
else begin delete_glue_ref(split_top_ptr(p));
free_node(p,ins_node_size);
end;
p:=prev_p
@ The list of heldover insertions, running from |link(page_head)| to
|page_tail|, must be moved to the contribution list when the user has
specified no output routine.
@<Perform the default output routine@>=
begin if link(page_head)<>null then
begin if link(contrib_head)=null then
if nest_ptr=0 then tail:=page_tail@+else contrib_tail:=page_tail
else link(page_tail):=link(contrib_head);
link(contrib_head):=link(page_head);
link(page_head):=null; page_tail:=page_head;
end;
flush_node_list(page_disc); page_disc:=null;
ship_out(box(255)); box(255):=null;
end
@ @<Explain that too many dead cycles have occurred in a row@>=
begin print_err("Output loop---"); print_int(dead_cycles);
@.Output loop...@>
print(" consecutive dead cycles");
help3("I've concluded that your \output is awry; it never does a")@/
("\shipout, so I'm shipping \box255 out myself. Next time")@/
("increase \maxdeadcycles if you want me to be more patient!"); error;
end
@ @<Fire up the user's output routine and |return|@>=
begin output_active:=true;
incr(dead_cycles);
push_nest; mode:=-vmode; prev_depth:=pdf_ignored_dimen; mode_line:=-line;
begin_token_list(output_routine,output_text);
new_save_level(output_group); normal_paragraph;
scan_left_brace;
return;
end
@ When the user's output routine finishes, it has constructed a vlist
in internal vertical mode, and \TeX\ will do the following:
@<Resume the page builder after an output routine has come to an end@>=
begin if (loc<>null) or
((token_type<>output_text)and(token_type<>backed_up)) then
@<Recover from an unbalanced output routine@>;
end_token_list; {conserve stack space in case more outputs are triggered}
end_graf; unsave; output_active:=false; insert_penalties:=0;@/
@<Ensure that box 255 is empty after output@>;
if tail<>head then {current list goes after heldover insertions}
begin link(page_tail):=link(head);
page_tail:=tail;
end;
if link(page_head)<>null then {and both go before heldover contributions}
begin if link(contrib_head)=null then contrib_tail:=page_tail;
link(page_tail):=link(contrib_head);
link(contrib_head):=link(page_head);
link(page_head):=null; page_tail:=page_head;
end;
flush_node_list(page_disc); page_disc:=null;
pop_nest; build_page;
end
@ @<Recover from an unbalanced output routine@>=
begin print_err("Unbalanced output routine");
@.Unbalanced output routine@>
help2("Your sneaky output routine has problematic {'s and/or }'s.")@/
("I can't handle that very well; good luck."); error;
repeat get_token;
until loc=null;
end {loops forever if reading from a file, since |null=min_halfword<=0|}
@ @<Ensure that box 255 is empty after output@>=
if box(255)<>null then
begin print_err("Output routine didn't use all of ");
print_esc("box"); print_int(255);
@.Output routine didn't use...@>
help3("Your \output commands should empty \box255,")@/
("e.g., by saying `\shipout\box255'.")@/
("Proceed; I'll discard its present contents.");
box_error(255);
end
@* \[46] The chief executive.
We come now to the |main_control| routine, which contains the master
switch that causes all the various pieces of \TeX\ to do their things,
in the right order.
In a sense, this is the grand climax of the program: It applies all the
tools that we have worked so hard to construct. In another sense, this is
the messiest part of the program: It necessarily refers to other pieces
of code all over the place, so that a person can't fully understand what is
going on without paging back and forth to be reminded of conventions that
are defined elsewhere. We are now at the hub of the web, the central nervous
system that touches most of the other parts and ties them together.
@^brain@>
The structure of |main_control| itself is quite simple. There's a label
called |big_switch|, at which point the next token of input is fetched
using |get_x_token|. Then the program branches at high speed into one of
about 100 possible directions, based on the value of the current
mode and the newly fetched command code; the sum |abs(mode)+cur_cmd|
indicates what to do next. For example, the case `|vmode+letter|' arises
when a letter occurs in vertical mode (or internal vertical mode); this
case leads to instructions that initialize a new paragraph and enter
horizontal mode.
The big |case| statement that contains this multiway switch has been labeled
|reswitch|, so that the program can |goto reswitch| when the next token
has already been fetched. Most of the cases are quite short; they call
an ``action procedure'' that does the work for that case, and then they
either |goto reswitch| or they ``fall through'' to the end of the |case|
statement, which returns control back to |big_switch|. Thus, |main_control|
is not an extremely large procedure, in spite of the multiplicity of things
it must do; it is small enough to be handled by \PASCAL\ compilers that put
severe restrictions on procedure size.
@!@^action procedure@>
One case is singled out for special treatment, because it accounts for most
of \TeX's activities in typical applications. The process of reading simple
text and converting it into |char_node| records, while looking for ligatures
and kerns, is part of \TeX's ``inner loop''; the whole program runs
efficiently when its inner loop is fast, so this part has been written
with particular care.
@ We shall concentrate first on the inner loop of |main_control|, deferring
consideration of the other cases until later.
@^inner loop@>
@d big_switch=60 {go here to branch on the next token of input}
@d main_loop=70 {go here to typeset a string of consecutive characters}
@d main_loop_wrapup=80 {go here to finish a character or ligature}
@d main_loop_move=90 {go here to advance the ligature cursor}
@d main_loop_move_lig=95 {same, when advancing past a generated ligature}
@d main_loop_lookahead=100 {go here to bring in another character, if any}
@d main_lig_loop=110 {go here to check for ligatures or kerning}
@d append_normal_space=120 {go here to append a normal space between words}
@p @t\4@>@<Declare action procedures for use by |main_control|@>@;
@t\4@>@<Declare the procedure called |handle_right_brace|@>@;
procedure main_control; {governs \TeX's activities}
label big_switch,reswitch,main_loop,main_loop_wrapup,
main_loop_move,main_loop_move+1,main_loop_move+2,main_loop_move_lig,
main_loop_lookahead,main_loop_lookahead+1,
main_lig_loop,main_lig_loop+1,main_lig_loop+2,
append_normal_space,exit;
var@!t:integer; {general-purpose temporary variable}
tmp_k1, tmp_k2: pointer; {for testing whether an auto kern should be inserted}
begin if every_job<>null then begin_token_list(every_job,every_job_text);
big_switch: get_x_token;@/
reswitch: @<Give diagnostic information, if requested@>;
case abs(mode)+cur_cmd of
hmode+letter,hmode+other_char,hmode+char_given: goto main_loop;
hmode+char_num: begin scan_char_num; cur_chr:=cur_val; goto main_loop;@+end;
hmode+no_boundary: begin get_x_token;
if (cur_cmd=letter)or(cur_cmd=other_char)or(cur_cmd=char_given)or
(cur_cmd=char_num) then cancel_boundary:=true;
goto reswitch;
end;
hmode+spacer:
if (space_factor = 1000) or (pdf_adjust_interword_glue > 0) then
goto append_normal_space
else app_space;
hmode+ex_space,mmode+ex_space: goto append_normal_space;
@t\4@>@<Cases of |main_control| that are not part of the inner loop@>@;
end; {of the big |case| statement}
goto big_switch;
main_loop:@<Append character |cur_chr| and the following characters (if~any)
to the current hlist in the current font; |goto reswitch| when
a non-character has been fetched@>;
append_normal_space:@<Append a normal inter-word space to the current list,
then |goto big_switch|@>;
exit:end;
@ When a new token has just been fetched at |big_switch|, we have an
ideal place to monitor \TeX's activity.
@^debugging@>
@<Give diagnostic information, if requested@>=
if interrupt<>0 then if OK_to_interrupt then
begin back_input; check_interrupt; goto big_switch;
end;
@!debug if panicking then check_mem(false);@+@;@+gubed
if tracing_commands>0 then show_cur_cmd_chr
@ The following part of the program was first written in a structured
manner, according to the philosophy that ``premature optimization is
the root of all evil.'' Then it was rearranged into pieces of
spaghetti so that the most common actions could proceed with little or
no redundancy.
The original unoptimized form of this algorithm resembles the
|reconstitute| procedure, which was described earlier in connection with
hyphenation. Again we have an implied ``cursor'' between characters
|cur_l| and |cur_r|. The main difference is that the |lig_stack| can now
contain a charnode as well as pseudo-ligatures; that stack is now
usually nonempty, because the next character of input (if any) has been
appended to it. In |main_control| we have
$$|cur_r|=\cases{|character(lig_stack)|,&if |lig_stack>null|;\cr
|font_bchar[cur_font]|,&otherwise;\cr}$$
except when |character(lig_stack)=font_false_bchar[cur_font]|.
Several additional global variables are needed.
@<Glob...@>=
@!main_f:internal_font_number; {the current font}
@!main_i:four_quarters; {character information bytes for |cur_l|}
@!main_j:four_quarters; {ligature/kern command}
@!main_k:font_index; {index into |font_info|}
@!main_p:pointer; {temporary register for list manipulation}
@!main_s:integer; {space factor value}
@!bchar:halfword; {boundary character of current font, or |non_char|}
@!false_bchar:halfword; {nonexistent character matching |bchar|, or |non_char|}
@!cancel_boundary:boolean; {should the left boundary be ignored?}
@!ins_disc:boolean; {should we insert a discretionary node?}
@ The boolean variables of the main loop are normally false, and always reset
to false before the loop is left. That saves us the extra work of initializing
each time.
@<Set init...@>=
ligature_present:=false; cancel_boundary:=false; lft_hit:=false; rt_hit:=false;
ins_disc:=false;
@ We leave the |space_factor| unchanged if |sf_code(cur_chr)=0|; otherwise we
set it equal to |sf_code(cur_chr)|, except that it should never change
from a value less than 1000 to a value exceeding 1000. The most common
case is |sf_code(cur_chr)=1000|, so we want that case to be fast.
The overall structure of the main loop is presented here. Some program labels
are inside the individual sections.
@^inner loop@>
@d adjust_space_factor==@t@>@;@/
main_s:=sf_code(cur_chr);
if main_s=1000 then space_factor:=1000
else if main_s<1000 then
begin if main_s>0 then space_factor:=main_s;
end
else if space_factor<1000 then space_factor:=1000
else space_factor:=main_s
@<Append character |cur_chr|...@>=
adjust_space_factor;@/
save_tail := null;
main_f:=cur_font;
bchar:=font_bchar[main_f]; false_bchar:=font_false_bchar[main_f];
if mode>0 then if language<>clang then fix_language;
fast_get_avail(lig_stack); font(lig_stack):=main_f; cur_l:=qi(cur_chr);
character(lig_stack):=cur_l;@/
cur_q:=tail;
tmp_k1 := get_auto_kern(main_f, non_char, cur_l);
@<If |tmp_k1| is not null then append that kern@>;
if cancel_boundary then
begin cancel_boundary:=false; main_k:=non_address;
end
else main_k:=bchar_label[main_f];
if main_k=non_address then goto main_loop_move+2; {no left boundary processing}
cur_r:=cur_l; cur_l:=non_char;
goto main_lig_loop+1; {begin with cursor after left boundary}
@#
main_loop_wrapup:@<Make a ligature node, if |ligature_present|;
insert a null discretionary, if appropriate@>;
main_loop_move:@<If the cursor is immediately followed by the right boundary,
|goto reswitch|; if it's followed by an invalid character, |goto big_switch|;
otherwise move the cursor one step to the right and |goto main_lig_loop|@>;
main_loop_lookahead:@<Look ahead for another character, or leave |lig_stack|
empty if there's none there@>;
main_lig_loop:@<If there's a ligature/kern command relevant to |cur_l| and
|cur_r|, adjust the text appropriately; exit to |main_loop_wrapup|@>;
main_loop_move_lig:@<Move the cursor past a pseudo-ligature, then
|goto main_loop_lookahead| or |main_lig_loop|@>
@ If |link(cur_q)| is nonnull when |wrapup| is invoked, |cur_q| points to
the list of characters that were consumed while building the ligature
character~|cur_l|.
A discretionary break is not inserted for an explicit hyphen when we are in
restricted horizontal mode. In particular, this avoids putting discretionary
nodes inside of other discretionaries.
@^inner loop@>
@d pack_lig(#)== {the parameter is either |rt_hit| or |false|}
begin main_p:=new_ligature(main_f,cur_l,link(cur_q));
if lft_hit then
begin subtype(main_p):=2; lft_hit:=false;
end;
if # then if lig_stack=null then
begin incr(subtype(main_p)); rt_hit:=false;
end;
if pdf_prepend_kern > 0 then
tmp_k2 := get_auto_kern(main_f, non_char, cur_l)
else
tmp_k2 := null;
if tmp_k2 = null then begin
link(cur_q):=main_p; tail:=main_p; ligature_present:=false;
end
else begin
link(cur_q) := tmp_k2;
link(tmp_k2) := main_p;
tail := main_p;
ligature_present := false;
end
end
@d wrapup(#)==if cur_l<non_char then
begin if link(cur_q)>null then
if character(tail)=qi(hyphen_char[main_f]) then ins_disc:=true;
if ligature_present then pack_lig(#);
if ins_disc then
begin ins_disc:=false;
if mode>0 then tail_append(new_disc);
end;
end
@<Make a ligature node, if |ligature_present|;...@>=
wrapup(rt_hit)
@ @<If the cursor is immediately followed by the right boundary...@>=
@^inner loop@>
if lig_stack=null then goto reswitch;
cur_q:=tail; cur_l:=character(lig_stack);
main_loop_move+1:if not is_char_node(lig_stack) then goto main_loop_move_lig;
main_loop_move+2:if(cur_chr<font_bc[main_f])or(cur_chr>font_ec[main_f]) then
begin char_warning(main_f,cur_chr); free_avail(lig_stack); goto big_switch;
end;
main_i:=char_info(main_f)(cur_l);
if not char_exists(main_i) then
begin char_warning(main_f,cur_chr); free_avail(lig_stack); goto big_switch;
end;
link(tail):=lig_stack; tail:=lig_stack {|main_loop_lookahead| is next}
@ Here we are at |main_loop_move_lig|.
When we begin this code we have |cur_q=tail| and |cur_l=character(lig_stack)|.
@<Move the cursor past a pseudo-ligature...@>=
main_p:=lig_ptr(lig_stack);
if main_p>null then tail_append(main_p); {append a single character}
temp_ptr:=lig_stack; lig_stack:=link(temp_ptr);
free_node(temp_ptr,small_node_size);
main_i:=char_info(main_f)(cur_l); ligature_present:=true;
if lig_stack=null then
if main_p>null then goto main_loop_lookahead
else cur_r:=bchar
else cur_r:=character(lig_stack);
goto main_lig_loop
@ The result of \.{\\char} can participate in a ligature or kern, so we must
look ahead for it.
@<Look ahead for another character...@>=
get_next; {set only |cur_cmd| and |cur_chr|, for speed}
if cur_cmd=letter then goto main_loop_lookahead+1;
if cur_cmd=other_char then goto main_loop_lookahead+1;
if cur_cmd=char_given then goto main_loop_lookahead+1;
x_token; {now expand and set |cur_cmd|, |cur_chr|, |cur_tok|}
if cur_cmd=letter then goto main_loop_lookahead+1;
if cur_cmd=other_char then goto main_loop_lookahead+1;
if cur_cmd=char_given then goto main_loop_lookahead+1;
if cur_cmd=char_num then
begin scan_char_num; cur_chr:=cur_val; goto main_loop_lookahead+1;
end;
if cur_cmd=no_boundary then bchar:=non_char;
cur_r:=bchar; lig_stack:=null; goto main_lig_loop;
main_loop_lookahead+1: adjust_space_factor;
fast_get_avail(lig_stack); font(lig_stack):=main_f;
cur_r:=qi(cur_chr); character(lig_stack):=cur_r;
if cur_r=false_bchar then cur_r:=non_char {this prevents spurious ligatures}
@ Even though comparatively few characters have a lig/kern program, several
of the instructions here count as part of \TeX's inner loop, since a
@^inner loop@>
potentially long sequential search must be performed. For example, tests with
Computer Modern Roman showed that about 40 per cent of all characters
actually encountered in practice had a lig/kern program, and that about four
lig/kern commands were investigated for every such character.
At the beginning of this code we have |main_i=char_info(main_f)(cur_l)|.
@<If there's a ligature/kern command...@>=
tmp_k1 := get_auto_kern(main_f, cur_l, cur_r);
@<If |tmp_k1| is not null then append that kern@>;
if char_tag(main_i)<>lig_tag then goto main_loop_wrapup;
if cur_r=non_char then goto main_loop_wrapup;
main_k:=lig_kern_start(main_f)(main_i); main_j:=font_info[main_k].qqqq;
if skip_byte(main_j)<=stop_flag then goto main_lig_loop+2;
main_k:=lig_kern_restart(main_f)(main_j);
main_lig_loop+1:main_j:=font_info[main_k].qqqq;
main_lig_loop+2:if next_char(main_j)=cur_r then
if skip_byte(main_j)<=stop_flag then
@<Do ligature or kern command, returning to |main_lig_loop|
or |main_loop_wrapup| or |main_loop_move|@>;
if skip_byte(main_j)=qi(0) then incr(main_k)
else begin if skip_byte(main_j)>=stop_flag then goto main_loop_wrapup;
main_k:=main_k+qo(skip_byte(main_j))+1;
end;
goto main_lig_loop+1
@ @<If |tmp_k1| is not null then append that kern@>=
if tmp_k1 <> null then begin
wrapup(rt_hit); {Note: |wrapup| might insert a null discretionary}
save_tail := tail;
{insert auto-kern before a null discretionary inserted by |wrapup| if appropriate}
if (not is_char_node(tail))
and (type(tail) = disc_node)
and (replace_count(tail) = 0)
and (pre_break(tail) = null)
and (post_break(tail) = null)
and (link(prev_tail) = tail) then
begin
insert_before_tail(tmp_k1);
end
else
tail_append(tmp_k1);
goto main_loop_move;
end
@ When a ligature or kern instruction matches a character, we know from
|read_font_info| that the character exists in the font, even though we
haven't verified its existence in the normal way.
This section could be made into a subroutine, if the code inside
|main_control| needs to be shortened.
\chardef\?='174 % vertical line to indicate character retention
@<Do ligature or kern command...@>=
begin if op_byte(main_j)>=kern_flag then
begin wrapup(rt_hit);
tail_append(new_kern(char_kern(main_f)(main_j))); goto main_loop_move;
end;
if cur_l=non_char then lft_hit:=true
else if lig_stack=null then rt_hit:=true;
check_interrupt; {allow a way out in case there's an infinite ligature loop}
case op_byte(main_j) of
qi(1),qi(5):begin cur_l:=rem_byte(main_j); {\.{=:\?}, \.{=:\?>}}
main_i:=char_info(main_f)(cur_l); ligature_present:=true;
end;
qi(2),qi(6):begin cur_r:=rem_byte(main_j); {\.{\?=:}, \.{\?=:>}}
if lig_stack=null then {right boundary character is being consumed}
begin lig_stack:=new_lig_item(cur_r); bchar:=non_char;
end
else if is_char_node(lig_stack) then {|link(lig_stack)=null|}
begin main_p:=lig_stack; lig_stack:=new_lig_item(cur_r);
lig_ptr(lig_stack):=main_p;
end
else character(lig_stack):=cur_r;
end;
qi(3):begin cur_r:=rem_byte(main_j); {\.{\?=:\?}}
main_p:=lig_stack; lig_stack:=new_lig_item(cur_r);
link(lig_stack):=main_p;
end;
qi(7),qi(11):begin wrapup(false); {\.{\?=:\?>}, \.{\?=:\?>>}}
cur_q:=tail; cur_l:=rem_byte(main_j);
main_i:=char_info(main_f)(cur_l); ligature_present:=true;
end;
othercases begin cur_l:=rem_byte(main_j); ligature_present:=true; {\.{=:}}
if lig_stack=null then goto main_loop_wrapup
else goto main_loop_move+1;
end
endcases;
if op_byte(main_j)>qi(4) then
if op_byte(main_j)<>qi(7) then goto main_loop_wrapup;
if cur_l<non_char then goto main_lig_loop;
main_k:=bchar_label[main_f]; goto main_lig_loop+1;
end
@ The occurrence of blank spaces is almost part of \TeX's inner loop,
@^inner loop@>
since we usually encounter about one space for every five non-blank characters.
Therefore |main_control| gives second-highest priority to ordinary spaces.
When a glue parameter like \.{\\spaceskip} is set to `\.{0pt}', we will
see to it later that the corresponding glue specification is precisely
|zero_glue|, not merely a pointer to some specification that happens
to be full of zeroes. Therefore it is simple to test whether a glue parameter
is zero or~not.
@<Append a normal inter-word space...@>=
if space_skip=zero_glue then
begin @<Find the glue specification, |main_p|, for
text spaces in the current font@>;
temp_ptr:=new_glue(main_p);
end
else temp_ptr:=new_param_glue(space_skip_code);
if pdf_adjust_interword_glue > 0 then
adjust_interword_glue(tail, temp_ptr);
link(tail):=temp_ptr; tail:=temp_ptr;
goto big_switch
@ Having |font_glue| allocated for each text font saves both time and memory.
If any of the three spacing parameters are subsequently changed by the
use of \.{\\fontdimen}, the |find_font_dimen| procedure deallocates the
|font_glue| specification allocated here.
@<Find the glue specification...@>=
begin main_p:=font_glue[cur_font];
if main_p=null then
begin main_p:=new_spec(zero_glue); main_k:=param_base[cur_font]+space_code;
width(main_p):=font_info[main_k].sc; {that's |space(cur_font)|}
stretch(main_p):=font_info[main_k+1].sc; {and |space_stretch(cur_font)|}
shrink(main_p):=font_info[main_k+2].sc; {and |space_shrink(cur_font)|}
font_glue[cur_font]:=main_p;
end;
end
@ @<Declare act...@>=
procedure app_space; {handle spaces when |space_factor<>1000|}
var@!q:pointer; {glue node}
begin if (space_factor>=2000)and(xspace_skip<>zero_glue) then
q:=new_param_glue(xspace_skip_code)
else begin if space_skip<>zero_glue then main_p:=space_skip
else @<Find the glue specification...@>;
main_p:=new_spec(main_p);
@<Modify the glue specification in |main_p| according to the space factor@>;
q:=new_glue(main_p); glue_ref_count(main_p):=null;
end;
link(tail):=q; tail:=q;
end;
@ @<Modify the glue specification in |main_p| according to the space factor@>=
if space_factor>=2000 then width(main_p):=width(main_p)+extra_space(cur_font);
stretch(main_p):=xn_over_d(stretch(main_p),space_factor,1000);
shrink(main_p):=xn_over_d(shrink(main_p),1000,space_factor)
@ Whew---that covers the main loop. We can now proceed at a leisurely
pace through the other combinations of possibilities.
@d any_mode(#)==vmode+#,hmode+#,mmode+# {for mode-independent commands}
@<Cases of |main_control| that are not part of the inner loop@>=
any_mode(relax),vmode+spacer,mmode+spacer,mmode+no_boundary:do_nothing;
any_mode(ignore_spaces): begin
if cur_chr = 0 then begin
@<Get the next non-blank non-call...@>;
goto reswitch;
end
else begin
t:=scanner_status;
scanner_status:=normal;
get_next;
scanner_status:=t;
if cur_cs < hash_base then
cur_cs := prim_lookup(cur_cs-single_base)
else
cur_cs := prim_lookup(text(cur_cs));
if cur_cs<>undefined_primitive then begin
cur_cmd := prim_eq_type(cur_cs);
cur_chr := prim_equiv(cur_cs);
cur_tok := cs_token_flag+prim_eqtb_base+cur_cs;
goto reswitch;
end;
end;
end;
vmode+stop: if its_all_over then return; {this is the only way out}
@t\4@>@<Forbidden cases detected in |main_control|@>@+@,any_mode(mac_param):
report_illegal_case;
@<Math-only cases in non-math modes, or vice versa@>: insert_dollar_sign;
@t\4@>@<Cases of |main_control| that build boxes and lists@>@;
@t\4@>@<Cases of |main_control| that don't depend on |mode|@>@;
@t\4@>@<Cases of |main_control| that are for extensions to \TeX@>@;
@ Here is a list of cases where the user has probably gotten into or out of math
mode by mistake. \TeX\ will insert a dollar sign and rescan the current token.
@d non_math(#)==vmode+#,hmode+#
@<Math-only cases in non-math modes...@>=
non_math(sup_mark), non_math(sub_mark), non_math(math_char_num),
non_math(math_given), non_math(math_comp), non_math(delim_num),
non_math(left_right), non_math(above), non_math(radical),
non_math(math_style), non_math(math_choice), non_math(vcenter),
non_math(non_script), non_math(mkern), non_math(limit_switch),
non_math(mskip), non_math(math_accent),
mmode+endv, mmode+par_end, mmode+stop, mmode+vskip, mmode+un_vbox,
mmode+valign, mmode+hrule
@ @<Declare action...@>=
procedure insert_dollar_sign;
begin back_input; cur_tok:=math_shift_token+"$";
print_err("Missing $ inserted");
@.Missing \$ inserted@>
help2("I've inserted a begin-math/end-math symbol since I think")@/
("you left one out. Proceed, with fingers crossed."); ins_error;
end;
@ When erroneous situations arise, \TeX\ usually issues an error message
specific to the particular error. For example, `\.{\\noalign}' should
not appear in any mode, since it is recognized by the |align_peek| routine
in all of its legitimate appearances; a special error message is given
when `\.{\\noalign}' occurs elsewhere. But sometimes the most appropriate
error message is simply that the user is not allowed to do what he or she
has attempted. For example, `\.{\\moveleft}' is allowed only in vertical mode,
and `\.{\\lower}' only in non-vertical modes. Such cases are enumerated
here and in the other sections referred to under `See also \dots.'
@<Forbidden cases...@>=
vmode+vmove,hmode+hmove,mmode+hmove,any_mode(last_item),
@ The `|you_cant|' procedure prints a line saying that the current command
is illegal in the current mode; it identifies these things symbolically.
@<Declare action...@>=
procedure you_cant;
begin print_err("You can't use `");
@.You can't use x in y mode@>
print_cmd_chr(cur_cmd,cur_chr);
print("' in "); print_mode(mode);
end;
@ @<Declare act...@>=
procedure report_illegal_case;
begin you_cant;
help4("Sorry, but I'm not programmed to handle this case;")@/
("I'll just pretend that you didn't ask for it.")@/
("If you're in the wrong mode, you might be able to")@/
("return to the right one by typing `I}' or `I$' or `I\par'.");@/
error;
end;
@ Some operations are allowed only in privileged modes, i.e., in cases
that |mode>0|. The |privileged| function is used to detect violations
of this rule; it issues an error message and returns |false| if the
current |mode| is negative.
@<Declare act...@>=
function privileged:boolean;
begin if mode>0 then privileged:=true
else begin report_illegal_case; privileged:=false;
end;
end;
@ Either \.{\\dump} or \.{\\end} will cause |main_control| to enter the
endgame, since both of them have `|stop|' as their command code.
@<Put each...@>=
primitive("end",stop,0);@/
@!@:end_}{\.{\\end} primitive@>
primitive("dump",stop,1);@/
@!@:dump_}{\.{\\dump} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
stop:if chr_code=1 then print_esc("dump")@+else print_esc("end");
@ We don't want to leave |main_control| immediately when a |stop| command
is sensed, because it may be necessary to invoke an \.{\\output} routine
several times before things really grind to a halt. (The output routine
might even say `\.{\\gdef\\end\{...\}}', to prolong the life of the job.)
Therefore |its_all_over| is |true| only when the current page
and contribution list are empty, and when the last output was not a
``dead cycle.''
@<Declare act...@>=
function its_all_over:boolean; {do this when \.{\\end} or \.{\\dump} occurs}
label exit;
begin if privileged then
begin if (page_head=page_tail)and(head=tail)and(dead_cycles=0) then
begin its_all_over:=true; return;
end;
back_input; {we will try to end again after ejecting residual material}
tail_append(new_null_box);
width(tail):=hsize;
tail_append(new_glue(fill_glue));
tail_append(new_penalty(-@'10000000000));@/
build_page; {append \.{\\hbox to \\hsize\{\}\\vfill\\penalty-'10000000000}}
end;
its_all_over:=false;
exit:end;
@* \[47] Building boxes and lists.
The most important parts of |main_control| are concerned with \TeX's
chief mission of box-making. We need to control the activities that put
entries on vlists and hlists, as well as the activities that convert
those lists into boxes. All of the necessary machinery has already been
developed; it remains for us to ``push the buttons'' at the right times.
@ As an introduction to these routines, let's consider one of the simplest
cases: What happens when `\.{\\hrule}' occurs in vertical mode, or
`\.{\\vrule}' in horizontal mode or math mode? The code in |main_control|
is short, since the |scan_rule_spec| routine already does most of what is
required; thus, there is no need for a special action procedure.
Note that baselineskip calculations are disabled after a rule in vertical
mode, by setting |prev_depth:=pdf_ignored_dimen|.
@<Cases of |main_control| that build...@>=
vmode+hrule,hmode+vrule,mmode+vrule: begin tail_append(scan_rule_spec);
if abs(mode)=vmode then prev_depth:=pdf_ignored_dimen
else if abs(mode)=hmode then space_factor:=1000;
end;
@ The processing of things like \.{\\hskip} and \.{\\vskip} is slightly
more complicated. But the code in |main_control| is very short, since
it simply calls on the action routine |append_glue|. Similarly, \.{\\kern}
activates |append_kern|.
@<Cases of |main_control| that build...@>=
vmode+vskip,hmode+hskip,mmode+hskip,mmode+mskip: append_glue;
any_mode(kern),mmode+mkern: append_kern;
@ The |hskip| and |vskip| command codes are used for control sequences
like \.{\\hss} and \.{\\vfil} as well as for \.{\\hskip} and \.{\\vskip}.
The difference is in the value of |cur_chr|.
@d fil_code=0 {identifies \.{\\hfil} and \.{\\vfil}}
@d fill_code=1 {identifies \.{\\hfill} and \.{\\vfill}}
@d ss_code=2 {identifies \.{\\hss} and \.{\\vss}}
@d fil_neg_code=3 {identifies \.{\\hfilneg} and \.{\\vfilneg}}
@d skip_code=4 {identifies \.{\\hskip} and \.{\\vskip}}
@d mskip_code=5 {identifies \.{\\mskip}}
@<Put each...@>=
primitive("hskip",hskip,skip_code);@/
@!@:hskip_}{\.{\\hskip} primitive@>
primitive("hfil",hskip,fil_code);
@!@:hfil_}{\.{\\hfil} primitive@>
primitive("hfill",hskip,fill_code);@/
@!@:hfill_}{\.{\\hfill} primitive@>
primitive("hss",hskip,ss_code);
@!@:hss_}{\.{\\hss} primitive@>
primitive("hfilneg",hskip,fil_neg_code);@/
@!@:hfil_neg_}{\.{\\hfilneg} primitive@>
primitive("vskip",vskip,skip_code);@/
@!@:vskip_}{\.{\\vskip} primitive@>
primitive("vfil",vskip,fil_code);
@!@:vfil_}{\.{\\vfil} primitive@>
primitive("vfill",vskip,fill_code);@/
@!@:vfill_}{\.{\\vfill} primitive@>
primitive("vss",vskip,ss_code);
@!@:vss_}{\.{\\vss} primitive@>
primitive("vfilneg",vskip,fil_neg_code);@/
@!@:vfil_neg_}{\.{\\vfilneg} primitive@>
primitive("mskip",mskip,mskip_code);@/
@!@:mskip_}{\.{\\mskip} primitive@>
primitive("kern",kern,explicit);
@!@:kern_}{\.{\\kern} primitive@>
primitive("mkern",mkern,mu_glue);@/
@!@:mkern_}{\.{\\mkern} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
hskip: case chr_code of
skip_code:print_esc("hskip");
fil_code:print_esc("hfil");
fill_code:print_esc("hfill");
ss_code:print_esc("hss");
othercases print_esc("hfilneg")
endcases;
vskip: case chr_code of
skip_code:print_esc("vskip");
fil_code:print_esc("vfil");
fill_code:print_esc("vfill");
ss_code:print_esc("vss");
othercases print_esc("vfilneg")
endcases;
mskip: print_esc("mskip");
kern: print_esc("kern");
mkern: print_esc("mkern");
@ All the work relating to glue creation has been relegated to the
following subroutine. It does not call |build_page|, because it is
used in at least one place where that would be a mistake.
@<Declare action...@>=
procedure append_glue;
var s:small_number; {modifier of skip command}
begin s:=cur_chr;
case s of
fil_code: cur_val:=fil_glue;
fill_code: cur_val:=fill_glue;
ss_code: cur_val:=ss_glue;
fil_neg_code: cur_val:=fil_neg_glue;
skip_code: scan_glue(glue_val);
mskip_code: scan_glue(mu_val);
end; {now |cur_val| points to the glue specification}
tail_append(new_glue(cur_val));
if s>=skip_code then
begin decr(glue_ref_count(cur_val));
if s>skip_code then subtype(tail):=mu_glue;
end;
end;
@ @<Declare act...@>=
procedure append_kern;
var s:quarterword; {|subtype| of the kern node}
begin s:=cur_chr; scan_dimen(s=mu_glue,false,false);
tail_append(new_kern(cur_val)); subtype(tail):=s;
end;
@ Many of the actions related to box-making are triggered by the appearance
of braces in the input. For example, when the user says `\.{\\hbox}
\.{to} \.{100pt\{$\langle\,\hbox{\rm hlist}\,\rangle$\}}' in vertical mode,
the information about the box size (100pt, |exactly|) is put onto |save_stack|
with a level boundary word just above it, and |cur_group:=adjusted_hbox_group|;
\TeX\ enters restricted horizontal mode to process the hlist. The right
brace eventually causes |save_stack| to be restored to its former state,
at which time the information about the box size (100pt, |exactly|) is
available once again; a box is packaged and we leave restricted horizontal
mode, appending the new box to the current list of the enclosing mode
(in this case to the current list of vertical mode), followed by any
vertical adjustments that were removed from the box by |hpack|.
The next few sections of the program are therefore concerned with the
treatment of left and right curly braces.
@ If a left brace occurs in the middle of a page or paragraph, it simply
introduces a new level of grouping, and the matching right brace will not have
such a drastic effect. Such grouping affects neither the mode nor the
current list.
@<Cases of |main_control| that build...@>=
non_math(left_brace): new_save_level(simple_group);
any_mode(begin_group): new_save_level(semi_simple_group);
any_mode(end_group): if cur_group=semi_simple_group then unsave
else off_save;
@ We have to deal with errors in which braces and such things are not
properly nested. Sometimes the user makes an error of commission by
inserting an extra symbol, but sometimes the user makes an error of omission.
\TeX\ can't always tell one from the other, so it makes a guess and tries
to avoid getting into a loop.
The |off_save| routine is called when the current group code is wrong. It tries
to insert something into the user's input that will help clean off
the top level.
@<Declare act...@>=
procedure off_save;
var p:pointer; {inserted token}
begin if cur_group=bottom_level then
@<Drop current token and complain that it was unmatched@>
else begin back_input; p:=get_avail; link(temp_head):=p;
print_err("Missing ");
@<Prepare to insert a token that matches |cur_group|,
and print what it is@>;
print(" inserted"); ins_list(link(temp_head));
help5("I've inserted something that you may have forgotten.")@/
("(See the <inserted text> above.)")@/
("With luck, this will get me unwedged. But if you")@/
("really didn't forget anything, try typing `2' now; then")@/
("my insertion and my current dilemma will both disappear.");
error;
end;
end;
@ At this point, |link(temp_head)=p|, a pointer to an empty one-word node.
@<Prepare to insert a token that matches |cur_group|...@>=
case cur_group of
semi_simple_group: begin info(p):=cs_token_flag+frozen_end_group;
print_esc("endgroup");
@.Missing \\endgroup inserted@>
end;
math_shift_group: begin info(p):=math_shift_token+"$"; print_char("$");
@.Missing \$ inserted@>
end;
math_left_group: begin info(p):=cs_token_flag+frozen_right; link(p):=get_avail;
p:=link(p); info(p):=other_token+"."; print_esc("right.");
@.Missing \\right\hbox{.} inserted@>
@^null delimiter@>
end;
othercases begin info(p):=right_brace_token+"}"; print_char("}");
@.Missing \} inserted@>
end
endcases
@ @<Drop current token and complain that it was unmatched@>=
begin print_err("Extra "); print_cmd_chr(cur_cmd,cur_chr);
@.Extra x@>
help1("Things are pretty mixed up, but I think the worst is over.");@/
error;
end
@ The routine for a |right_brace| character branches into many subcases,
since a variety of things may happen, depending on |cur_group|. Some
types of groups are not supposed to be ended by a right brace; error
messages are given in hopes of pinpointing the problem. Most branches
of this routine will be filled in later, when we are ready to understand
them; meanwhile, we must prepare ourselves to deal with such errors.
@<Cases of |main_control| that build...@>=
any_mode(right_brace): handle_right_brace;
@ @<Declare the procedure called |handle_right_brace|@>=
procedure handle_right_brace;
var p,@!q:pointer; {for short-term use}
@!d:scaled; {holds |split_max_depth| in |insert_group|}
@!f:integer; {holds |floating_penalty| in |insert_group|}
begin case cur_group of
simple_group: unsave;
bottom_level: begin print_err("Too many }'s");
@.Too many \}'s@>
help2("You've closed more groups than you opened.")@/
("Such booboos are generally harmless, so keep going."); error;
end;
semi_simple_group,math_shift_group,math_left_group: extra_right_brace;
@t\4@>@<Cases of |handle_right_brace| where a |right_brace| triggers
a delayed action@>@;
othercases confusion("rightbrace")
@:this can't happen rightbrace}{\quad rightbrace@>
endcases;
end;
@ @<Declare act...@>=
procedure extra_right_brace;
begin print_err("Extra }, or forgotten ");
@.Extra \}, or forgotten x@>
case cur_group of
semi_simple_group: print_esc("endgroup");
math_shift_group: print_char("$");
math_left_group: print_esc("right");
end;@/
help5("I've deleted a group-closing symbol because it seems to be")@/
("spurious, as in `$x}$'. But perhaps the } is legitimate and")@/
("you forgot something else, as in `\hbox{$x}'. In such cases")@/
("the way to recover is to insert both the forgotten and the")@/
("deleted material, e.g., by typing `I$}'."); error;
incr(align_state);
end;
@ Here is where we clear the parameters that are supposed to revert to their
default values after every paragraph and when internal vertical mode is entered.
@<Declare act...@>=
procedure normal_paragraph;
begin if looseness<>0 then eq_word_define(int_base+looseness_code,0);
if hang_indent<>0 then eq_word_define(dimen_base+hang_indent_code,0);
if hang_after<>1 then eq_word_define(int_base+hang_after_code,1);
if par_shape_ptr<>null then eq_define(par_shape_loc,shape_ref,null);
if inter_line_penalties_ptr<>null then
eq_define(inter_line_penalties_loc,shape_ref,null);
end;
@ Now let's turn to the question of how \.{\\hbox} is treated. We actually
need to consider also a slightly larger context, since constructions like
`\.{\\setbox3=}\penalty0\.{\\hbox...}' and
`\.{\\leaders}\penalty0\.{\\hbox...}' and
`\.{\\lower3.8pt\\hbox...}'
are supposed to invoke quite
different actions after the box has been packaged. Conversely,
constructions like `\.{\\setbox3=}' can be followed by a variety of
different kinds of boxes, and we would like to encode such things in an
efficient way.
In other words, there are two problems: to represent the context of a box,
and to represent its type.
The first problem is solved by putting a ``context code'' on the |save_stack|,
just below the two entries that give the dimensions produced by |scan_spec|.
The context code is either a (signed) shift amount, or it is a large
integer |>=box_flag|, where |box_flag=@t$2^{30}$@>|. Codes |box_flag| through
|global_box_flag-1| represent `\.{\\setbox0}' through `\.{\\setbox32767}';
codes |global_box_flag| through |ship_out_flag-1| represent
`\.{\\global\\setbox0}' through `\.{\\global\\setbox32767}';
code |ship_out_flag| represents `\.{\\shipout}'; and codes |leader_flag|
through |leader_flag+2| represent `\.{\\leaders}', `\.{\\cleaders}',
and `\.{\\xleaders}'.
The second problem is solved by giving the command code |make_box| to all
control sequences that produce a box, and by using the following |chr_code|
values to distinguish between them: |box_code|, |copy_code|, |last_box_code|,
|vsplit_code|, |vtop_code|, |vtop_code+vmode|, and |vtop_code+hmode|, where
the latter two are used to denote \.{\\vbox} and \.{\\hbox}, respectively.
@d box_flag==@'10000000000 {context code for `\.{\\setbox0}'}
@d global_box_flag==@'10000100000 {context code for `\.{\\global\\setbox0}'}
@d ship_out_flag==@'10000200000 {context code for `\.{\\shipout}'}
@d leader_flag==@'10000200001 {context code for `\.{\\leaders}'}
@d box_code=0 {|chr_code| for `\.{\\box}'}
@d copy_code=1 {|chr_code| for `\.{\\copy}'}
@d last_box_code=2 {|chr_code| for `\.{\\lastbox}'}
@d vsplit_code=3 {|chr_code| for `\.{\\vsplit}'}
@d vtop_code=4 {|chr_code| for `\.{\\vtop}'}
@<Put each...@>=
primitive("moveleft",hmove,1);
@!@:move_left_}{\.{\\moveleft} primitive@>
primitive("moveright",hmove,0);@/
@!@:move_right_}{\.{\\moveright} primitive@>
primitive("raise",vmove,1);
@!@:raise_}{\.{\\raise} primitive@>
primitive("lower",vmove,0);
@!@:lower_}{\.{\\lower} primitive@>
@#
primitive("box",make_box,box_code);
@!@:box_}{\.{\\box} primitive@>
primitive("copy",make_box,copy_code);
@!@:copy_}{\.{\\copy} primitive@>
primitive("lastbox",make_box,last_box_code);
@!@:last_box_}{\.{\\lastbox} primitive@>
primitive("vsplit",make_box,vsplit_code);
@!@:vsplit_}{\.{\\vsplit} primitive@>
primitive("vtop",make_box,vtop_code);@/
@!@:vtop_}{\.{\\vtop} primitive@>
primitive("vbox",make_box,vtop_code+vmode);
@!@:vbox_}{\.{\\vbox} primitive@>
primitive("hbox",make_box,vtop_code+hmode);@/
@!@:hbox_}{\.{\\hbox} primitive@>
primitive("shipout",leader_ship,a_leaders-1); {|ship_out_flag=leader_flag-1|}
@!@:ship_out_}{\.{\\shipout} primitive@>
primitive("leaders",leader_ship,a_leaders);
@!@:leaders_}{\.{\\leaders} primitive@>
primitive("cleaders",leader_ship,c_leaders);
@!@:c_leaders_}{\.{\\cleaders} primitive@>
primitive("xleaders",leader_ship,x_leaders);
@!@:x_leaders_}{\.{\\xleaders} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
hmove: if chr_code=1 then print_esc("moveleft")@+else print_esc("moveright");
vmove: if chr_code=1 then print_esc("raise")@+else print_esc("lower");
make_box: case chr_code of
box_code: print_esc("box");
copy_code: print_esc("copy");
last_box_code: print_esc("lastbox");
vsplit_code: print_esc("vsplit");
vtop_code: print_esc("vtop");
vtop_code+vmode: print_esc("vbox");
othercases print_esc("hbox")
endcases;
leader_ship: if chr_code=a_leaders then print_esc("leaders")
else if chr_code=c_leaders then print_esc("cleaders")
else if chr_code=x_leaders then print_esc("xleaders")
else print_esc("shipout");
@ Constructions that require a box are started by calling |scan_box| with
a specified context code. The |scan_box| routine verifies
that a |make_box| command comes next and then it calls |begin_box|.
@<Cases of |main_control| that build...@>=
vmode+hmove,hmode+vmove,mmode+vmove: begin t:=cur_chr;
scan_normal_dimen;
if t=0 then scan_box(cur_val)@+else scan_box(-cur_val);
end;
any_mode(leader_ship): scan_box(leader_flag-a_leaders+cur_chr);
any_mode(make_box): begin_box(0);
@ The global variable |cur_box| will point to a newly made box. If the box
is void, we will have |cur_box=null|. Otherwise we will have
|type(cur_box)=hlist_node| or |vlist_node| or |rule_node|; the |rule_node|
case can occur only with leaders.
@<Glob...@>=
@!cur_box:pointer; {box to be placed into its context}
@ The |box_end| procedure does the right thing with |cur_box|, if
|box_context| represents the context as explained above.
@<Declare act...@>=
procedure box_end(@!box_context:integer);
var p:pointer; {|ord_noad| for new box in math mode}
@!a:small_number; {global prefix}
begin if box_context<box_flag then @<Append box |cur_box| to the current list,
shifted by |box_context|@>
else if box_context<ship_out_flag then @<Store \(c)|cur_box| in a box register@>
else if cur_box<>null then
if box_context>ship_out_flag then @<Append a new leader node that
uses |cur_box|@>
else ship_out(cur_box);
end;
@ The global variable |adjust_tail| will be non-null if and only if the
current box might include adjustments that should be appended to the
current vertical list.
@<Append box |cur_box| to the current...@>=
begin if cur_box<>null then
begin shift_amount(cur_box):=box_context;
if abs(mode)=vmode then
begin
if pre_adjust_tail <> null then begin
if pre_adjust_head <> pre_adjust_tail then
append_list(pre_adjust_head)(pre_adjust_tail);
pre_adjust_tail := null;
end;
append_to_vlist(cur_box);
if adjust_tail <> null then begin
if adjust_head <> adjust_tail then
append_list(adjust_head)(adjust_tail);
adjust_tail := null;
end;
if mode>0 then build_page;
end
else begin if abs(mode)=hmode then space_factor:=1000
else begin p:=new_noad;
math_type(nucleus(p)):=sub_box;
info(nucleus(p)):=cur_box; cur_box:=p;
end;
link(tail):=cur_box; tail:=cur_box;
end;
end;
end
@ @<Store \(c)|cur_box| in a box register@>=
begin if box_context<global_box_flag then
begin cur_val:=box_context-box_flag; a:=0;
end
else begin cur_val:=box_context-global_box_flag; a:=4;
end;
if cur_val<256 then define(box_base+cur_val,box_ref,cur_box)
else sa_def_box;
end
@ @<Append a new leader node ...@>=
begin @<Get the next non-blank non-relax...@>;
if ((cur_cmd=hskip)and(abs(mode)<>vmode))or@|
((cur_cmd=vskip)and(abs(mode)=vmode)) then
begin append_glue; subtype(tail):=box_context-(leader_flag-a_leaders);
leader_ptr(tail):=cur_box;
end
else begin print_err("Leaders not followed by proper glue");
@.Leaders not followed by...@>
help3("You should say `\leaders <box or rule><hskip or vskip>'.")@/
("I found the <box or rule>, but there's no suitable")@/
("<hskip or vskip>, so I'm ignoring these leaders."); back_error;
flush_node_list(cur_box);
end;
end
@ Now that we can see what eventually happens to boxes, we can consider
the first steps in their creation. The |begin_box| routine is called when
|box_context| is a context specification, |cur_chr| specifies the type of
box desired, and |cur_cmd=make_box|.
@<Declare act...@>=
procedure begin_box(@!box_context:integer);
label exit, done;
var @!p,@!q:pointer; {run through the current list}
@!r:pointer; {running behind |p|}
@!fm:boolean; {a final \.{\\beginM} \.{\\endM} node pair?}
@!tx:pointer; {effective tail node}
@!m:quarterword; {the length of a replacement list}
@!k:halfword; {0 or |vmode| or |hmode|}
@!n:halfword; {a box number}
begin case cur_chr of
box_code: begin scan_register_num; fetch_box(cur_box);
change_box(null); {the box becomes void, at the same level}
end;
copy_code: begin scan_register_num; fetch_box(q); cur_box:=copy_node_list(q);
end;
last_box_code: @<If the current list ends with a box node, delete it from
the list and make |cur_box| point to it; otherwise set |cur_box:=null|@>;
vsplit_code: @<Split off part of a vertical box, make |cur_box| point to it@>;
othercases @<Initiate the construction of an hbox or vbox, then |return|@>
endcases;@/
box_end(box_context); {in simple cases, we use the box immediately}
exit:end;
@ Note that the condition |not is_char_node(tail)| implies that |head<>tail|,
since |head| is a one-word node.
@d fetch_effective_tail_eTeX(#)== {extract |tx|,
drop \.{\\beginM} \.{\\endM} pair}
q:=head; p:=null;
repeat r:=p; p:=q; fm:=false;
if not is_char_node(q) then
if type(q)=disc_node then
begin for m:=1 to replace_count(q) do p:=link(p);
if p=tx then #;
end
else if (type(q)=math_node)and(subtype(q)=begin_M_code) then fm:=true;
q:=link(p);
until q=tx; {found |r|$\to$|p|$\to$|q=tx|}
q:=link(tx); link(p):=q; link(tx):=null;
if q=null then if fm then confusion("tail1")
@:this can't happen tail1}{\quad tail1@>
else tail:=p
else if fm then {|r|$\to$|p=begin_M|$\to$|q=end_M|}
begin tail:=r; link(r):=null; flush_node_list(p);@+end
@#
@d check_effective_tail(#)==find_effective_tail_eTeX
@d fetch_effective_tail==fetch_effective_tail_eTeX
@<If the current list ends with a box node, delete it...@>=
begin cur_box:=null;
if abs(mode)=mmode then
begin you_cant; help1("Sorry; this \lastbox will be void."); error;
end
else if (mode=vmode)and(head=tail) then
begin you_cant;
help2("Sorry...I usually can't take things from the current page.")@/
("This \lastbox will therefore be void."); error;
end
else begin check_effective_tail(goto done);
if not is_char_node(tx) then
if (type(tx)=hlist_node)or(type(tx)=vlist_node) then
@<Remove the last box, unless it's part of a discretionary@>;
done:end;
end
@ @<Remove the last box...@>=
begin fetch_effective_tail(goto done);
cur_box:=tx; shift_amount(cur_box):=0;
end
@ Here we deal with things like `\.{\\vsplit 13 to 100pt}'.
@<Split off part of a vertical box, make |cur_box| point to it@>=
begin scan_register_num; n:=cur_val;
if not scan_keyword("to") then
@.to@>
begin print_err("Missing `to' inserted");
@.Missing `to' inserted@>
help2("I'm working on `\vsplit<box number> to <dimen>';")@/
("will look for the <dimen> next."); error;
end;
scan_normal_dimen;
cur_box:=vsplit(n,cur_val);
end
@ Here is where we enter restricted horizontal mode or internal vertical
mode, in order to make a box.
@<Initiate the construction of an hbox or vbox, then |return|@>=
begin k:=cur_chr-vtop_code; saved(0):=box_context;
if k=hmode then
if (box_context<box_flag)and(abs(mode)=vmode) then
scan_spec(adjusted_hbox_group,true)
else scan_spec(hbox_group,true)
else begin if k=vmode then scan_spec(vbox_group,true)
else begin scan_spec(vtop_group,true); k:=vmode;
end;
normal_paragraph;
end;
push_nest; mode:=-k;
if k=vmode then
begin prev_depth:=pdf_ignored_dimen;
if every_vbox<>null then begin_token_list(every_vbox,every_vbox_text);
end
else begin space_factor:=1000;
if every_hbox<>null then begin_token_list(every_hbox,every_hbox_text);
end;
return;
end
@ @<Declare act...@>=
procedure scan_box(@!box_context:integer);
{the next input should specify a box or perhaps a rule}
begin @<Get the next non-blank non-relax...@>;
if cur_cmd=make_box then begin_box(box_context)
else if (box_context>=leader_flag)and((cur_cmd=hrule)or(cur_cmd=vrule)) then
begin cur_box:=scan_rule_spec; box_end(box_context);
end
else begin@t@>@;@/
print_err("A <box> was supposed to be here");@/
@.A <box> was supposed to...@>
help3("I was expecting to see \hbox or \vbox or \copy or \box or")@/
("something like that. So you might find something missing in")@/
("your output. But keep trying; you can fix this later."); back_error;
end;
end;
@ When the right brace occurs at the end of an \.{\\hbox} or \.{\\vbox} or
\.{\\vtop} construction, the |package| routine comes into action. We might
also have to finish a paragraph that hasn't ended.
@<Cases of |handle...@>=
hbox_group: package(0);
adjusted_hbox_group: begin adjust_tail:=adjust_head;
pre_adjust_tail:=pre_adjust_head; package(0);
end;
vbox_group: begin end_graf; package(0);
end;
vtop_group: begin end_graf; package(vtop_code);
end;
@ @<Declare action...@>=
procedure package(@!c:small_number);
var h:scaled; {height of box}
@!p:pointer; {first node in a box}
@!d:scaled; {max depth}
begin d:=box_max_depth; unsave; save_ptr:=save_ptr-3;
if mode=-hmode then cur_box:=hpack(link(head),saved(2),saved(1))
else begin cur_box:=vpackage(link(head),saved(2),saved(1),d);
if c=vtop_code then @<Readjust the height and depth of |cur_box|,
for \.{\\vtop}@>;
end;
pop_nest; box_end(saved(0));
end;
@ The height of a `\.{\\vtop}' box is inherited from the first item on its list,
if that item is an |hlist_node|, |vlist_node|, or |rule_node|; otherwise
the \.{\\vtop} height is zero.
@<Readjust the height...@>=
begin h:=0; p:=list_ptr(cur_box);
if p<>null then if type(p)<=rule_node then h:=height(p);
depth(cur_box):=depth(cur_box)-h+height(cur_box); height(cur_box):=h;
end
@ Here is a really small patch to add a new primitive called
\.{\\quitvmode}. In vertical modes, it is identical to \.{\\indent},
but in horizontal and math modes it is really a no-op (as opposed to
\.{\\indent}, which executes the |indent_in_hmode| procedure).
A paragraph begins when horizontal-mode material occurs in vertical mode,
or when the paragraph is explicitly started by `\.{\\quitvmode}',
`\.{\\indent}' or `\.{\\noindent}'.
@<Put each...@>=
primitive("indent",start_par,1);
@!@:indent_}{\.{\\indent} primitive@>
primitive("noindent",start_par,0);
@!@:no_indent_}{\.{\\noindent} primitive@>
primitive("quitvmode",start_par,2);
@!@:quit_vmode_}{\.{\\quitvmode} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
start_par: if chr_code=0 then print_esc("noindent")@+ else if chr_code=1 then print_esc("indent")@+ else print_esc("quitvmode");
@ @<Cases of |main_control| that build...@>=
vmode+start_par: new_graf(cur_chr>0);
vmode+letter,vmode+other_char,vmode+char_num,vmode+char_given,
vmode+math_shift,vmode+un_hbox,vmode+vrule,
vmode+accent,vmode+discretionary,vmode+hskip,vmode+valign,
vmode+ex_space,vmode+no_boundary:@t@>@;@/
begin back_input; new_graf(true);
end;
@ @<Declare act...@>=
function norm_min(@!h:integer):small_number;
begin if h<=0 then norm_min:=1@+else if h>=63 then norm_min:=63@+
else norm_min:=h;
end;
@#
procedure new_graf(@!indented:boolean);
begin prev_graf:=0;
if (mode=vmode)or(head<>tail) then
tail_append(new_param_glue(par_skip_code));
push_nest; mode:=hmode; space_factor:=1000; set_cur_lang; clang:=cur_lang;
prev_graf:=(norm_min(left_hyphen_min)*@'100+norm_min(right_hyphen_min))
*@'200000+cur_lang;
if indented then
begin tail:=new_null_box; link(head):=tail; width(tail):=par_indent;@+
end;
if every_par<>null then begin_token_list(every_par,every_par_text);
if nest_ptr=1 then build_page; {put |par_skip| glue on current page}
end;
@ @<Cases of |main_control| that build...@>=
hmode+start_par,mmode+start_par: if cur_chr<>2 then indent_in_hmode;
@ @<Declare act...@>=
procedure indent_in_hmode;
var p,@!q:pointer;
begin if cur_chr>0 then {\.{\\indent}}
begin p:=new_null_box; width(p):=par_indent;
if abs(mode)=hmode then space_factor:=1000
else begin q:=new_noad; math_type(nucleus(q)):=sub_box;
info(nucleus(q)):=p; p:=q;
end;
tail_append(p);
end;
end;
@ A paragraph ends when a |par_end| command is sensed, or when we are in
horizontal mode when reaching the right brace of vertical-mode routines
like \.{\\vbox}, \.{\\insert}, or \.{\\output}.
@<Cases of |main_control| that build...@>=
vmode+par_end: begin normal_paragraph;
if mode>0 then build_page;
end;
hmode+par_end: begin if align_state<0 then off_save; {this tries to
recover from an alignment that didn't end properly}
end_graf; {this takes us to the enclosing mode, if |mode>0|}
if mode=vmode then build_page;
end;
hmode+stop,hmode+vskip,hmode+hrule,hmode+un_vbox,hmode+halign: head_for_vmode;
@ @<Declare act...@>=
procedure head_for_vmode;
begin if mode<0 then
if cur_cmd<>hrule then off_save
else begin print_err("You can't use `");
print_esc("hrule"); print("' here except with leaders");
@.You can't use \\hrule...@>
help2("To put a horizontal rule in an hbox or an alignment,")@/
("you should use \leaders or \hrulefill (see The TeXbook).");
error;
end
else begin back_input; cur_tok:=par_token; back_input; token_type:=inserted;
end;
end;
@ @<Declare act...@>=
procedure end_graf;
begin if mode=hmode then
begin if head=tail then pop_nest {null paragraphs are ignored}
else line_break(false);
if LR_save<>null then
begin flush_list(LR_save); LR_save:=null;
end;
normal_paragraph;
error_count:=0;
end;
end;
@ Insertion and adjustment and mark nodes are constructed by the following
pieces of the program.
@<Cases of |main_control| that build...@>=
any_mode(insert),hmode+vadjust,mmode+vadjust: begin_insert_or_adjust;
any_mode(mark): make_mark;
@ @<Forbidden...@>=
vmode+vadjust,
@ @<Declare act...@>=
procedure begin_insert_or_adjust;
begin if cur_cmd=vadjust then cur_val:=255
else begin scan_eight_bit_int;
if cur_val=255 then
begin print_err("You can't "); print_esc("insert"); print_int(255);
@.You can't \\insert255@>
help1("I'm changing to \insert0; box 255 is special.");
error; cur_val:=0;
end;
end;
saved(0) := cur_val;
if (cur_cmd = vadjust) and scan_keyword("pre") then
saved(1) := 1
else
saved(1) := 0;
save_ptr := save_ptr + 2;
new_save_level(insert_group); scan_left_brace; normal_paragraph;
push_nest; mode:=-vmode; prev_depth:=pdf_ignored_dimen;
end;
@ @<Cases of |handle...@>=
insert_group: begin end_graf; q:=split_top_skip; add_glue_ref(q);
d:=split_max_depth; f:=floating_penalty; unsave; save_ptr := save_ptr - 2;
{now |saved(0)| is the insertion number, or 255 for |vadjust|}
p:=vpack(link(head),natural); pop_nest;
if saved(0)<255 then
begin tail_append(get_node(ins_node_size));
type(tail):=ins_node; subtype(tail):=qi(saved(0));
height(tail):=height(p)+depth(p); ins_ptr(tail):=list_ptr(p);
split_top_ptr(tail):=q; depth(tail):=d; float_cost(tail):=f;
end
else begin tail_append(get_node(small_node_size));
type(tail):=adjust_node;@/
adjust_pre(tail) := saved(1); {the |subtype| is used for |adjust_pre|}
adjust_ptr(tail):=list_ptr(p); delete_glue_ref(q);
end;
free_node(p,box_node_size);
if nest_ptr=0 then build_page;
end;
output_group: @<Resume the page builder...@>;
@ @<Declare act...@>=
procedure make_mark;
var p:pointer; {new node}
@!c:halfword; {the mark class}
begin if cur_chr=0 then c:=0
else begin scan_register_num; c:=cur_val;
end;
p:=scan_toks(false,true); p:=get_node(small_node_size);
mark_class(p):=c;
type(p):=mark_node; subtype(p):=0; {the |subtype| is not used}
mark_ptr(p):=def_ref; link(tail):=p; tail:=p;
end;
@ Penalty nodes get into a list via the |break_penalty| command.
@^penalties@>
@<Cases of |main_control| that build...@>=
any_mode(break_penalty): append_penalty;
@ @<Declare action...@>=
procedure append_penalty;
begin scan_int; tail_append(new_penalty(cur_val));
if mode=vmode then build_page;
end;
@ The |remove_item| command removes a penalty, kern, or glue node if it
appears at the tail of the current list, using a brute-force linear scan.
Like \.{\\lastbox}, this command is not allowed in vertical mode (except
internal vertical mode), since the current list in vertical mode is sent
to the page builder. But if we happen to be able to implement it in
vertical mode, we do.
@<Cases of |main_control| that build...@>=
any_mode(remove_item): delete_last;
@ When |delete_last| is called, |cur_chr| is the |type| of node that
will be deleted, if present.
@<Declare action...@>=
procedure delete_last;
label exit;
var @!p,@!q:pointer; {run through the current list}
@!r:pointer; {running behind |p|}
@!fm:boolean; {a final \.{\\beginM} \.{\\endM} node pair?}
@!tx:pointer; {effective tail node}
@!m:quarterword; {the length of a replacement list}
begin if (mode=vmode)and(tail=head) then
@<Apologize for inability to do the operation now,
unless \.{\\unskip} follows non-glue@>
else begin check_effective_tail(return);
if not is_char_node(tx) then if type(tx)=cur_chr then
begin fetch_effective_tail(return);
flush_node_list(tx);
end;
end;
exit:end;
@ @<Apologize for inability to do the operation...@>=
begin if (cur_chr<>glue_node)or(last_glue<>max_halfword) then
begin you_cant;
help2("Sorry...I usually can't take things from the current page.")@/
("Try `I\vskip-\lastskip' instead.");
if cur_chr=kern_node then help_line[0]:=
("Try `I\kern-\lastkern' instead.")
else if cur_chr<>glue_node then help_line[0]:=@|
("Perhaps you can make the output routine do it.");
error;
end;
end
@ @<Put each...@>=
primitive("unpenalty",remove_item,penalty_node);@/
@!@:un_penalty_}{\.{\\unpenalty} primitive@>
primitive("unkern",remove_item,kern_node);@/
@!@:un_kern_}{\.{\\unkern} primitive@>
primitive("unskip",remove_item,glue_node);@/
@!@:un_skip_}{\.{\\unskip} primitive@>
primitive("unhbox",un_hbox,box_code);@/
@!@:un_hbox_}{\.{\\unhbox} primitive@>
primitive("unhcopy",un_hbox,copy_code);@/
@!@:un_hcopy_}{\.{\\unhcopy} primitive@>
primitive("unvbox",un_vbox,box_code);@/
@!@:un_vbox_}{\.{\\unvbox} primitive@>
primitive("unvcopy",un_vbox,copy_code);@/
@!@:un_vcopy_}{\.{\\unvcopy} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
remove_item: if chr_code=glue_node then print_esc("unskip")
else if chr_code=kern_node then print_esc("unkern")
else print_esc("unpenalty");
un_hbox: if chr_code=copy_code then print_esc("unhcopy")
else print_esc("unhbox");
un_vbox: if chr_code=copy_code then print_esc("unvcopy")
@<Cases of |un_vbox| for |print_cmd_chr|@>@/
else print_esc("unvbox");
@ The |un_hbox| and |un_vbox| commands unwrap one of the 256 current boxes.
@<Cases of |main_control| that build...@>=
vmode+un_vbox,hmode+un_hbox,mmode+un_hbox: unpackage;
@ @<Declare act...@>=
procedure unpackage;
label done, exit;
var p:pointer; {the box}
r: pointer; {to remove marginal kern nodes}
@!c:box_code..copy_code; {should we copy?}
begin if cur_chr>copy_code then @<Handle saved items and |goto done|@>;
c:=cur_chr; scan_register_num; fetch_box(p);
if p=null then return;
if (abs(mode)=mmode)or((abs(mode)=vmode)and(type(p)<>vlist_node))or@|
((abs(mode)=hmode)and(type(p)<>hlist_node)) then
begin print_err("Incompatible list can't be unboxed");
@.Incompatible list...@>
help3("Sorry, Pandora. (You sneaky devil.)")@/
("I refuse to unbox an \hbox in vertical mode or vice versa.")@/
("And I can't open any boxes in math mode.");@/
error; return;
end;
if c=copy_code then link(tail):=copy_node_list(list_ptr(p))
else begin link(tail):=list_ptr(p); change_box(null);
free_node(p,box_node_size);
end;
done:
while link(tail) <> null do begin
r := link(tail);
if not is_char_node(r) and (type(r) = margin_kern_node) then begin
link(tail) := link(r);
free_avail(margin_char(r));
free_node(r, margin_kern_node_size);
end;
tail:=link(tail);
end;
exit:end;
@ @<Forbidden...@>=vmode+ital_corr,
@ Italic corrections are converted to kern nodes when the |ital_corr| command
follows a character. In math mode the same effect is achieved by appending
a kern of zero here, since italic corrections are supplied later.
@<Cases of |main_control| that build...@>=
hmode+ital_corr: append_italic_correction;
mmode+ital_corr: tail_append(new_kern(0));
@ @<Declare act...@>=
procedure append_italic_correction;
label exit;
var p:pointer; {|char_node| at the tail of the current list}
@!f:internal_font_number; {the font in the |char_node|}
begin if tail<>head then
begin if is_char_node(tail) then p:=tail
else if type(tail)=ligature_node then p:=lig_char(tail)
else return;
f:=font(p);
tail_append(new_kern(char_italic(f)(char_info(f)(character(p)))));
subtype(tail):=explicit;
end;
exit:end;
@ Discretionary nodes are easy in the common case `\.{\\-}', but in the
general case we must process three braces full of items.
@<Put each...@>=
primitive("-",discretionary,1);
@!@:Single-character primitives -}{\quad\.{\\-}@>
primitive("discretionary",discretionary,0);
@!@:discretionary_}{\.{\\discretionary} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
discretionary: if chr_code=1 then
print_esc("-")@+else print_esc("discretionary");
@ @<Cases of |main_control| that build...@>=
hmode+discretionary,mmode+discretionary: append_discretionary;
@ The space factor does not change when we append a discretionary node,
but it starts out as 1000 in the subsidiary lists.
@<Declare act...@>=
procedure append_discretionary;
var c:integer; {hyphen character}
app_kern, pre_kern, p, c_node: pointer;
begin tail_append(new_disc);
if cur_chr=1 then
begin c:=hyphen_char[cur_font];
if c>=0 then if c<256 then begin
pre_kern := get_auto_kern(cur_font, non_char, c);
app_kern := get_auto_kern(cur_font, c, non_char);
c_node := new_character(cur_font,c);
if (app_kern = null) and (pre_kern = null) then {no auto-kern}
pre_break(tail) := c_node
else begin
if pre_kern = null then
pre_break(tail) := c_node
else begin
pre_break(tail) := pre_kern;
link(pre_kern) := c_node;
end;
if app_kern <> null then
link(c_node) := app_kern;
end;
end;
end
else begin incr(save_ptr); saved(-1):=0; new_save_level(disc_group);
scan_left_brace; push_nest; mode:=-hmode; space_factor:=1000;
end;
end;
@ The three discretionary lists are constructed somewhat as if they were
hboxes. A~subroutine called |build_discretionary| handles the transitions.
(This is sort of fun.)
@<Cases of |handle...@>=
disc_group: build_discretionary;
@ @<Declare act...@>=
procedure build_discretionary;
label done,exit;
var p,@!q:pointer; {for link manipulation}
@!n:integer; {length of discretionary list}
begin unsave;
@<Prune the current list, if necessary, until it contains only
|char_node|, |kern_node|, |hlist_node|, |vlist_node|, |rule_node|,
and |ligature_node| items; set |n| to the length of the list,
and set |q| to the list's tail@>;
p:=link(head); pop_nest;
case saved(-1) of
0:pre_break(tail):=p;
1:post_break(tail):=p;
2:@<Attach list |p| to the current list, and record its length;
then finish up and |return|@>;
end; {there are no other cases}
incr(saved(-1)); new_save_level(disc_group); scan_left_brace;
push_nest; mode:=-hmode; space_factor:=1000;
exit:end;
@ @<Attach list |p| to the current...@>=
begin if (n>0)and(abs(mode)=mmode) then
begin print_err("Illegal math "); print_esc("discretionary");
@.Illegal math \\disc...@>
help2("Sorry: The third part of a discretionary break must be")@/
("empty, in math formulas. I had to delete your third part.");
flush_node_list(p); n:=0; error;
end
else link(tail):=p;
if n<=max_quarterword then replace_count(tail):=n
else begin print_err("Discretionary list is too long");
@.Discretionary list is too long@>
help2("Wow---I never thought anybody would tweak me here.")@/
("You can't seriously need such a huge discretionary list?");
error;
end;
if n>0 then tail:=q;
decr(save_ptr); return;
end
@ During this loop, |p=link(q)| and there are |n| items preceding |p|.
@<Prune the current list, if necessary...@>=
q:=head; p:=link(q); n:=0;
while p<>null do
begin if not is_char_node(p) then if type(p)>rule_node then
if type(p)<>kern_node then if type(p)<>ligature_node then
begin print_err("Improper discretionary list");
@.Improper discretionary list@>
help1("Discretionary lists must contain only boxes and kerns.");@/
error;
begin_diagnostic;
print_nl("The following discretionary sublist has been deleted:");
@.The following...deleted@>
show_box(p);
end_diagnostic(true);
flush_node_list(p); link(q):=null; goto done;
end;
q:=p; p:=link(q); incr(n);
end;
done:
@ We need only one more thing to complete the horizontal mode routines, namely
the \.{\\accent} primitive.
@<Cases of |main_control| that build...@>=
hmode+accent: make_accent;
@ The positioning of accents is straightforward but tedious. Given an accent
of width |a|, designed for characters of height |x| and slant |s|;
and given a character of width |w|, height |h|, and slant |t|: We will shift
the accent down by |x-h|, and we will insert kern nodes that have the effect of
centering the accent over the character and shifting the accent to the
right by $\delta={1\over2}(w-a)+h\cdot t-x\cdot s$. If either character is
absent from the font, we will simply use the other, without shifting.
@<Declare act...@>=
procedure make_accent;
var s,@!t: real; {amount of slant}
@!p,@!q,@!r:pointer; {character, box, and kern nodes}
@!f:internal_font_number; {relevant font}
@!a,@!h,@!x,@!w,@!delta:scaled; {heights and widths, as explained above}
@!i:four_quarters; {character information}
begin scan_char_num; f:=cur_font; p:=new_character(f,cur_val);
if p<>null then
begin x:=x_height(f); s:=slant(f)/float_constant(65536);
@^real division@>
a:=char_width(f)(char_info(f)(character(p)));@/
do_assignments;@/
@<Create a character node |q| for the next character,
but set |q:=null| if problems arise@>;
if q<>null then @<Append the accent with appropriate kerns,
then set |p:=q|@>;
link(tail):=p; tail:=p; space_factor:=1000;
end;
end;
@ @<Create a character node |q| for the next...@>=
q:=null; f:=cur_font;
if (cur_cmd=letter)or(cur_cmd=other_char)or(cur_cmd=char_given) then
q:=new_character(f,cur_chr)
else if cur_cmd=char_num then
begin scan_char_num; q:=new_character(f,cur_val);
end
else back_input
@ The kern nodes appended here must be distinguished from other kerns, lest
they be wiped away by the hyphenation algorithm or by a previous line break.
The two kerns are computed with (machine-dependent) |real| arithmetic, but
their sum is machine-independent; the net effect is machine-independent,
because the user cannot remove these nodes nor access them via \.{\\lastkern}.
@<Append the accent with appropriate kerns...@>=
begin t:=slant(f)/float_constant(65536);
@^real division@>
i:=char_info(f)(character(q));
w:=char_width(f)(i); h:=char_height(f)(height_depth(i));
if h<>x then {the accent must be shifted up or down}
begin p:=hpack(p,natural); shift_amount(p):=x-h;
end;
delta:=round((w-a)/float_constant(2)+h*t-x*s);
@^real multiplication@>
@^real addition@>
r:=new_kern(delta); subtype(r):=acc_kern; link(tail):=r; link(r):=p;
tail:=new_kern(-a-delta); subtype(tail):=acc_kern; link(p):=tail; p:=q;
end
@ When `\.{\\cr}' or `\.{\\span}' or a tab mark comes through the scanner
into |main_control|, it might be that the user has foolishly inserted
one of them into something that has nothing to do with alignment. But it is
far more likely that a left brace or right brace has been omitted, since
|get_next| takes actions appropriate to alignment only when `\.{\\cr}'
or `\.{\\span}' or tab marks occur with |align_state=0|. The following
program attempts to make an appropriate recovery.
@<Cases of |main_control| that build...@>=
any_mode(car_ret), any_mode(tab_mark): align_error;
any_mode(no_align): no_align_error;
any_mode(omit): omit_error;
@ @<Declare act...@>=
procedure align_error;
begin if abs(align_state)>2 then
@<Express consternation over the fact that no alignment is in progress@>
else begin back_input;
if align_state<0 then
begin print_err("Missing { inserted");
@.Missing \{ inserted@>
incr(align_state); cur_tok:=left_brace_token+"{";
end
else begin print_err("Missing } inserted");
@.Missing \} inserted@>
decr(align_state); cur_tok:=right_brace_token+"}";
end;
help3("I've put in what seems to be necessary to fix")@/
("the current column of the current alignment.")@/
("Try to go on, since this might almost work."); ins_error;
end;
end;
@ @<Express consternation...@>=
begin print_err("Misplaced "); print_cmd_chr(cur_cmd,cur_chr);
@.Misplaced \&@>
@.Misplaced \\span@>
@.Misplaced \\cr@>
if cur_tok=tab_token+"&" then
begin help6("I can't figure out why you would want to use a tab mark")@/
("here. If you just want an ampersand, the remedy is")@/
("simple: Just type `I\&' now. But if some right brace")@/
("up above has ended a previous alignment prematurely,")@/
("you're probably due for more error messages, and you")@/
("might try typing `S' now just to see what is salvageable.");
end
else begin help5("I can't figure out why you would want to use a tab mark")@/
("or \cr or \span just now. If something like a right brace")@/
("up above has ended a previous alignment prematurely,")@/
("you're probably due for more error messages, and you")@/
("might try typing `S' now just to see what is salvageable.");
end;
error;
end
@ The help messages here contain a little white lie, since \.{\\noalign}
and \.{\\omit} are allowed also after `\.{\\noalign\{...\}}'.
@<Declare act...@>=
procedure no_align_error;
begin print_err("Misplaced "); print_esc("noalign");
@.Misplaced \\noalign@>
help2("I expect to see \noalign only after the \cr of")@/
("an alignment. Proceed, and I'll ignore this case."); error;
end;
procedure omit_error;
begin print_err("Misplaced "); print_esc("omit");
@.Misplaced \\omit@>
help2("I expect to see \omit only after tab marks or the \cr of")@/
("an alignment. Proceed, and I'll ignore this case."); error;
end;
@ We've now covered most of the abuses of \.{\\halign} and \.{\\valign}.
Let's take a look at what happens when they are used correctly.
@<Cases of |main_control| that build...@>=
vmode+halign:init_align;
hmode+valign:@<Cases of |main_control| for |hmode+valign|@>@; init_align;
mmode+halign: if privileged then
if cur_group=math_shift_group then init_align
else off_save;
vmode+endv,hmode+endv: do_endv;
@ An |align_group| code is supposed to remain on the |save_stack|
during an entire alignment, until |fin_align| removes it.
A devious user might force an |endv| command to occur just about anywhere;
we must defeat such hacks.
@<Declare act...@>=
procedure do_endv;
begin base_ptr:=input_ptr; input_stack[base_ptr]:=cur_input;
while (input_stack[base_ptr].index_field<>v_template) and
(input_stack[base_ptr].loc_field=null) and
(input_stack[base_ptr].state_field=token_list) do decr(base_ptr);
if (input_stack[base_ptr].index_field<>v_template) or
(input_stack[base_ptr].loc_field<>null) or
(input_stack[base_ptr].state_field<>token_list) then
fatal_error("(interwoven alignment preambles are not allowed)");
@.interwoven alignment preambles...@>
if cur_group=align_group then
begin end_graf;
if fin_col then fin_row;
end
else off_save;
end;
@ @<Cases of |handle_right_brace|...@>=
align_group: begin back_input; cur_tok:=cs_token_flag+frozen_cr;
print_err("Missing "); print_esc("cr"); print(" inserted");
@.Missing \\cr inserted@>
help1("I'm guessing that you meant to end an alignment here.");
ins_error;
end;
@ @<Cases of |handle_right_brace|...@>=
no_align_group: begin end_graf; unsave; align_peek;
end;
@ Finally, \.{\\endcsname} is not supposed to get through to |main_control|.
@<Cases of |main_control| that build...@>=
any_mode(end_cs_name): cs_error;
@ @<Declare act...@>=
procedure cs_error;
begin print_err("Extra "); print_esc("endcsname");
@.Extra \\endcsname@>
help1("I'm ignoring this, since I wasn't doing a \csname.");
error;
end;
@* \[48] Building math lists.
The routines that \TeX\ uses to create mlists are similar to those we have
just seen for the generation of hlists and vlists. But it is necessary to
make ``noads'' as well as nodes, so the reader should review the
discussion of math mode data structures before trying to make sense out of
the following program.
Here is a little routine that needs to be done whenever a subformula
is about to be processed. The parameter is a code like |math_group|.
@<Declare act...@>=
procedure push_math(@!c:group_code);
begin push_nest; mode:=-mmode; incompleat_noad:=null; new_save_level(c);
end;
@ We get into math mode from horizontal mode when a `\.\$' (i.e., a
|math_shift| character) is scanned. We must check to see whether this
`\.\$' is immediately followed by another, in case display math mode is
called for.
@<Cases of |main_control| that build...@>=
hmode+math_shift:init_math;
@ @<Declare act...@>=
@t\4@>@<Declare subprocedures for |init_math|@>@;
procedure init_math;
label reswitch,found,not_found,done;
var w:scaled; {new or partial |pre_display_size|}
@!j:pointer; {prototype box for display}
@!x:integer; {new |pre_display_direction|}
@!l:scaled; {new |display_width|}
@!s:scaled; {new |display_indent|}
@!p:pointer; {current node when calculating |pre_display_size|}
@!q:pointer; {glue specification when calculating |pre_display_size|}
@!f:internal_font_number; {font in current |char_node|}
@!n:integer; {scope of paragraph shape specification}
@!v:scaled; {|w| plus possible glue amount}
@!d:scaled; {increment to |v|}
begin get_token; {|get_x_token| would fail on \.{\\ifmmode}\thinspace!}
if (cur_cmd=math_shift)and(mode>0) then @<Go into display math mode@>
else begin back_input; @<Go into ordinary math mode@>;
end;
end;
@ @<Go into ordinary math mode@>=
begin push_math(math_shift_group); eq_word_define(int_base+cur_fam_code,-1);
if every_math<>null then begin_token_list(every_math,every_math_text);
end
@ We get into ordinary math mode from display math mode when `\.{\\eqno}' or
`\.{\\leqno}' appears. In such cases |cur_chr| will be 0 or~1, respectively;
the value of |cur_chr| is placed onto |save_stack| for safe keeping.
@<Cases of |main_control| that build...@>=
mmode+eq_no: if privileged then
if cur_group=math_shift_group then start_eq_no
else off_save;
@ @<Put each...@>=
primitive("eqno",eq_no,0);
@!@:eq_no_}{\.{\\eqno} primitive@>
primitive("leqno",eq_no,1);
@!@:leq_no_}{\.{\\leqno} primitive@>
@ When \TeX\ is in display math mode, |cur_group=math_shift_group|,
so it is not necessary for the |start_eq_no| procedure to test for
this condition.
@<Declare act...@>=
procedure start_eq_no;
begin saved(0):=cur_chr; incr(save_ptr);
@<Go into ordinary math mode@>;
end;
@ @<Cases of |print_cmd_chr|...@>=
eq_no:if chr_code=1 then print_esc("leqno")@+else print_esc("eqno");
@ @<Forbidden...@>=non_math(eq_no),
@ When we enter display math mode, we need to call |line_break| to
process the partial paragraph that has just been interrupted by the
display. Then we can set the proper values of |display_width| and
|display_indent| and |pre_display_size|.
@<Go into display math mode@>=
begin j:=null; w:=-max_dimen;
if head=tail then {`\.{\\noindent\$\$}' or `\.{\$\${ }\$\$}'}
@<Prepare for display after an empty paragraph@>
else begin line_break(true);@/
@<Calculate the natural width, |w|, by which the characters of the
final line extend to the right of the reference point,
plus two ems; or set |w:=max_dimen| if the non-blank information
on that line is affected by stretching or shrinking@>;
end;
{now we are in vertical mode, working on the list that will contain the display}
@<Calculate the length, |l|, and the shift amount, |s|, of the display lines@>;
push_math(math_shift_group); mode:=mmode;
eq_word_define(int_base+cur_fam_code,-1);@/
eq_word_define(dimen_base+pre_display_size_code,w);
LR_box:=j;
if eTeX_ex then eq_word_define(int_base+pre_display_direction_code,x);
eq_word_define(dimen_base+display_width_code,l);
eq_word_define(dimen_base+display_indent_code,s);
if every_display<>null then begin_token_list(every_display,every_display_text);
if nest_ptr=1 then build_page;
end
@ @<Calculate the natural width, |w|, by which...@>=
@<Prepare for display after a non-empty paragraph@>;
while p<>null do
begin @<Let |d| be the natural width of node |p|;
if the node is ``visible,'' |goto found|;
if the node is glue that stretches or shrinks, set |v:=max_dimen|@>;
if v<max_dimen then v:=v+d;
goto not_found;
found: if v<max_dimen then
begin v:=v+d; w:=v;
end
else begin w:=max_dimen; goto done;
end;
not_found: p:=link(p);
end;
done:
@<Finish the natural width computation@>
@ @<Let |d| be the natural width of node |p|...@>=
reswitch: if is_char_node(p) then
begin f:=font(p); d:=char_width(f)(char_info(f)(character(p)));
goto found;
end;
case type(p) of
hlist_node,vlist_node,rule_node: begin d:=width(p); goto found;
end;
ligature_node:@<Make node |p| look like a |char_node|...@>;
margin_kern_node: d:=width(p);
kern_node: d:=width(p);
@t\4@>@<Cases of `Let |d| be the natural width' that need special treatment@>@;
glue_node:@<Let |d| be the natural width of this glue; if stretching
or shrinking, set |v:=max_dimen|; |goto found| in the case of leaders@>;
whatsit_node: @<Let |d| be the width of the whatsit |p|@>;
othercases d:=0
endcases
@ We need to be careful that |w|, |v|, and |d| do not depend on any |glue_set|
values, since such values are subject to system-dependent rounding.
System-dependent numbers are not allowed to infiltrate parameters like
|pre_display_size|, since \TeX82 is supposed to make the same decisions on all
machines.
@<Let |d| be the natural width of this glue...@>=
begin q:=glue_ptr(p); d:=width(q);
if glue_sign(just_box)=stretching then
begin if (glue_order(just_box)=stretch_order(q))and@|
(stretch(q)<>0) then
v:=max_dimen;
end
else if glue_sign(just_box)=shrinking then
begin if (glue_order(just_box)=shrink_order(q))and@|
(shrink(q)<>0) then
v:=max_dimen;
end;
if subtype(p)>=a_leaders then goto found;
end
@ A displayed equation is considered to be three lines long, so we
calculate the length and offset of line number |prev_graf+2|.
@<Calculate the length, |l|, ...@>=
if par_shape_ptr=null then
if (hang_indent<>0)and@|
(((hang_after>=0)and(prev_graf+2>hang_after))or@|
(prev_graf+1<-hang_after)) then
begin l:=hsize-abs(hang_indent);
if hang_indent>0 then s:=hang_indent@+else s:=0;
end
else begin l:=hsize; s:=0;
end
else begin n:=info(par_shape_ptr);
if prev_graf+2>=n then p:=par_shape_ptr+2*n
else p:=par_shape_ptr+2*(prev_graf+2);
s:=mem[p-1].sc; l:=mem[p].sc;
end
@ Subformulas of math formulas cause a new level of math mode to be entered,
on the semantic nest as well as the save stack. These subformulas arise in
several ways: (1)~A left brace by itself indicates the beginning of a
subformula that will be put into a box, thereby freezing its glue and
preventing line breaks. (2)~A subscript or superscript is treated as a
subformula if it is not a single character; the same applies to
the nucleus of things like \.{\\underline}. (3)~The \.{\\left} primitive
initiates a subformula that will be terminated by a matching \.{\\right}.
The group codes placed on |save_stack| in these three cases are
|math_group|, |math_group|, and |math_left_group|, respectively.
Here is the code that handles case (1); the other cases are not quite as
trivial, so we shall consider them later.
@<Cases of |main_control| that build...@>=
mmode+left_brace: begin tail_append(new_noad);
back_input; scan_math(nucleus(tail));
end;
@ Recall that the |nucleus|, |subscr|, and |supscr| fields in a noad are
broken down into subfields called |math_type| and either |info| or
|(fam,character)|. The job of |scan_math| is to figure out what to place
in one of these principal fields; it looks at the subformula that
comes next in the input, and places an encoding of that subformula
into a given word of |mem|.
@d fam_in_range==((cur_fam>=0)and(cur_fam<16))
@<Declare act...@>=
procedure scan_math(@!p:pointer);
label restart,reswitch,exit;
var c:integer; {math character code}
begin restart:@<Get the next non-blank non-relax...@>;
reswitch:case cur_cmd of
letter,other_char,char_given: begin c:=ho(math_code(cur_chr));
if c=@'100000 then
begin @<Treat |cur_chr| as an active character@>;
goto restart;
end;
end;
char_num: begin scan_char_num; cur_chr:=cur_val; cur_cmd:=char_given;
goto reswitch;
end;
math_char_num: begin scan_fifteen_bit_int; c:=cur_val;
end;
math_given: c:=cur_chr;
delim_num: begin scan_twenty_seven_bit_int; c:=cur_val div @'10000;
end;
othercases @<Scan a subformula enclosed in braces and |return|@>
endcases;@/
math_type(p):=math_char; character(p):=qi(c mod 256);
if (c>=var_code)and fam_in_range then fam(p):=cur_fam
else fam(p):=(c div 256) mod 16;
exit:end;
@ An active character that is an |outer_call| is allowed here.
@<Treat |cur_chr|...@>=
begin cur_cs:=cur_chr+active_base;
cur_cmd:=eq_type(cur_cs); cur_chr:=equiv(cur_cs);
x_token; back_input;
end
@ The pointer |p| is placed on |save_stack| while a complex subformula
is being scanned.
@<Scan a subformula...@>=
begin back_input; scan_left_brace;@/
saved(0):=p; incr(save_ptr); push_math(math_group); return;
end
@ The simplest math formula is, of course, `\.{\${ }\$}', when no noads are
generated. The next simplest cases involve a single character, e.g.,
`\.{\$x\$}'. Even though such cases may not seem to be very interesting,
the reader can perhaps understand how happy the author was when `\.{\$x\$}'
was first properly typeset by \TeX. The code in this section was used.
@^Knuth, Donald Ervin@>
@<Cases of |main_control| that build...@>=
mmode+letter,mmode+other_char,mmode+char_given:
set_math_char(ho(math_code(cur_chr)));
mmode+char_num: begin scan_char_num; cur_chr:=cur_val;
set_math_char(ho(math_code(cur_chr)));
end;
mmode+math_char_num: begin scan_fifteen_bit_int; set_math_char(cur_val);
end;
mmode+math_given: set_math_char(cur_chr);
mmode+delim_num: begin scan_twenty_seven_bit_int;
set_math_char(cur_val div @'10000);
end;
@ The |set_math_char| procedure creates a new noad appropriate to a given
math code, and appends it to the current mlist. However, if the math code
is sufficiently large, the |cur_chr| is treated as an active character and
nothing is appended.
@<Declare act...@>=
procedure set_math_char(@!c:integer);
var p:pointer; {the new noad}
begin if c>=@'100000 then
@<Treat |cur_chr|...@>
else begin p:=new_noad; math_type(nucleus(p)):=math_char;
character(nucleus(p)):=qi(c mod 256);
fam(nucleus(p)):=(c div 256) mod 16;
if c>=var_code then
begin if fam_in_range then fam(nucleus(p)):=cur_fam;
type(p):=ord_noad;
end
else type(p):=ord_noad+(c div @'10000);
link(tail):=p; tail:=p;
end;
end;
@ Primitive math operators like \.{\\mathop} and \.{\\underline} are given
the command code |math_comp|, supplemented by the noad type that they
generate.
@<Put each...@>=
primitive("mathord",math_comp,ord_noad);
@!@:math_ord_}{\.{\\mathord} primitive@>
primitive("mathop",math_comp,op_noad);
@!@:math_op_}{\.{\\mathop} primitive@>
primitive("mathbin",math_comp,bin_noad);
@!@:math_bin_}{\.{\\mathbin} primitive@>
primitive("mathrel",math_comp,rel_noad);
@!@:math_rel_}{\.{\\mathrel} primitive@>
primitive("mathopen",math_comp,open_noad);
@!@:math_open_}{\.{\\mathopen} primitive@>
primitive("mathclose",math_comp,close_noad);
@!@:math_close_}{\.{\\mathclose} primitive@>
primitive("mathpunct",math_comp,punct_noad);
@!@:math_punct_}{\.{\\mathpunct} primitive@>
primitive("mathinner",math_comp,inner_noad);
@!@:math_inner_}{\.{\\mathinner} primitive@>
primitive("underline",math_comp,under_noad);
@!@:underline_}{\.{\\underline} primitive@>
primitive("overline",math_comp,over_noad);@/
@!@:overline_}{\.{\\overline} primitive@>
primitive("displaylimits",limit_switch,normal);
@!@:display_limits_}{\.{\\displaylimits} primitive@>
primitive("limits",limit_switch,limits);
@!@:limits_}{\.{\\limits} primitive@>
primitive("nolimits",limit_switch,no_limits);
@!@:no_limits_}{\.{\\nolimits} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
math_comp: case chr_code of
ord_noad: print_esc("mathord");
op_noad: print_esc("mathop");
bin_noad: print_esc("mathbin");
rel_noad: print_esc("mathrel");
open_noad: print_esc("mathopen");
close_noad: print_esc("mathclose");
punct_noad: print_esc("mathpunct");
inner_noad: print_esc("mathinner");
under_noad: print_esc("underline");
othercases print_esc("overline")
endcases;
limit_switch: if chr_code=limits then print_esc("limits")
else if chr_code=no_limits then print_esc("nolimits")
else print_esc("displaylimits");
@ @<Cases of |main_control| that build...@>=
mmode+math_comp: begin tail_append(new_noad);
type(tail):=cur_chr; scan_math(nucleus(tail));
end;
mmode+limit_switch: math_limit_switch;
@ @<Declare act...@>=
procedure math_limit_switch;
label exit;
begin if head<>tail then if type(tail)=op_noad then
begin subtype(tail):=cur_chr; return;
end;
print_err("Limit controls must follow a math operator");
@.Limit controls must follow...@>
help1("I'm ignoring this misplaced \limits or \nolimits command."); error;
exit:end;
@ Delimiter fields of noads are filled in by the |scan_delimiter| routine.
The first parameter of this procedure is the |mem| address where the
delimiter is to be placed; the second tells if this delimiter follows
\.{\\radical} or not.
@<Declare act...@>=
procedure scan_delimiter(@!p:pointer;@!r:boolean);
begin if r then scan_twenty_seven_bit_int
else begin @<Get the next non-blank non-relax...@>;
case cur_cmd of
letter,other_char: cur_val:=del_code(cur_chr);
delim_num: scan_twenty_seven_bit_int;
othercases cur_val:=-1
endcases;
end;
if cur_val<0 then @<Report that an invalid delimiter code is being changed
to null; set~|cur_val:=0|@>;
small_fam(p):=(cur_val div @'4000000) mod 16;
small_char(p):=qi((cur_val div @'10000) mod 256);
large_fam(p):=(cur_val div 256) mod 16;
large_char(p):=qi(cur_val mod 256);
end;
@ @<Report that an invalid delimiter...@>=
begin print_err("Missing delimiter (. inserted)");
@.Missing delimiter...@>
help6("I was expecting to see something like `(' or `\{' or")@/
("`\}' here. If you typed, e.g., `{' instead of `\{', you")@/
("should probably delete the `{' by typing `1' now, so that")@/
("braces don't get unbalanced. Otherwise just proceed.")@/
("Acceptable delimiters are characters whose \delcode is")@/
("nonnegative, or you can use `\delimiter <delimiter code>'.");
back_error; cur_val:=0;
end
@ @<Cases of |main_control| that build...@>=
mmode+radical:math_radical;
@ @<Declare act...@>=
procedure math_radical;
begin tail_append(get_node(radical_noad_size));
type(tail):=radical_noad; subtype(tail):=normal;
mem[nucleus(tail)].hh:=empty_field;
mem[subscr(tail)].hh:=empty_field;
mem[supscr(tail)].hh:=empty_field;
scan_delimiter(left_delimiter(tail),true); scan_math(nucleus(tail));
end;
@ @<Cases of |main_control| that build...@>=
mmode+accent,mmode+math_accent:math_ac;
@ @<Declare act...@>=
procedure math_ac;
begin if cur_cmd=accent then
@<Complain that the user should have said \.{\\mathaccent}@>;
tail_append(get_node(accent_noad_size));
type(tail):=accent_noad; subtype(tail):=normal;
mem[nucleus(tail)].hh:=empty_field;
mem[subscr(tail)].hh:=empty_field;
mem[supscr(tail)].hh:=empty_field;
math_type(accent_chr(tail)):=math_char;
scan_fifteen_bit_int;
character(accent_chr(tail)):=qi(cur_val mod 256);
if (cur_val>=var_code)and fam_in_range then fam(accent_chr(tail)):=cur_fam
else fam(accent_chr(tail)):=(cur_val div 256) mod 16;
scan_math(nucleus(tail));
end;
@ @<Complain that the user should have said \.{\\mathaccent}@>=
begin print_err("Please use "); print_esc("mathaccent");
print(" for accents in math mode");
@.Please use \\mathaccent...@>
help2("I'm changing \accent to \mathaccent here; wish me luck.")@/
("(Accents are not the same in formulas as they are in text.)");
error;
end
@ @<Cases of |main_control| that build...@>=
mmode+vcenter: begin scan_spec(vcenter_group,false); normal_paragraph;
push_nest; mode:=-vmode; prev_depth:=pdf_ignored_dimen;
if every_vbox<>null then begin_token_list(every_vbox,every_vbox_text);
end;
@ @<Cases of |handle...@>=
vcenter_group: begin end_graf; unsave; save_ptr:=save_ptr-2;
p:=vpack(link(head),saved(1),saved(0)); pop_nest;
tail_append(new_noad); type(tail):=vcenter_noad;
math_type(nucleus(tail)):=sub_box; info(nucleus(tail)):=p;
end;
@ The routine that inserts a |style_node| holds no surprises.
@<Put each...@>=
primitive("displaystyle",math_style,display_style);
@!@:display_style_}{\.{\\displaystyle} primitive@>
primitive("textstyle",math_style,text_style);
@!@:text_style_}{\.{\\textstyle} primitive@>
primitive("scriptstyle",math_style,script_style);
@!@:script_style_}{\.{\\scriptstyle} primitive@>
primitive("scriptscriptstyle",math_style,script_script_style);
@!@:script_script_style_}{\.{\\scriptscriptstyle} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
math_style: print_style(chr_code);
@ @<Cases of |main_control| that build...@>=
mmode+math_style: tail_append(new_style(cur_chr));
mmode+non_script: begin tail_append(new_glue(zero_glue));
subtype(tail):=cond_math_glue;
end;
mmode+math_choice: append_choices;
@ The routine that scans the four mlists of a \.{\\mathchoice} is very
much like the routine that builds discretionary nodes.
@<Declare act...@>=
procedure append_choices;
begin tail_append(new_choice); incr(save_ptr); saved(-1):=0;
push_math(math_choice_group); scan_left_brace;
end;
@ @<Cases of |handle_right_brace|...@>=
math_choice_group: build_choices;
@ @<Declare act...@>=
@t\4@>@<Declare the function called |fin_mlist|@>@t@>@;@/
procedure build_choices;
label exit;
var p:pointer; {the current mlist}
begin unsave; p:=fin_mlist(null);
case saved(-1) of
0:display_mlist(tail):=p;
1:text_mlist(tail):=p;
2:script_mlist(tail):=p;
3:begin script_script_mlist(tail):=p; decr(save_ptr); return;
end;
end; {there are no other cases}
incr(saved(-1)); push_math(math_choice_group); scan_left_brace;
exit:end;
@ Subscripts and superscripts are attached to the previous nucleus by the
@^superscripts@>@^subscripts@>
action procedure called |sub_sup|. We use the facts that |sub_mark=sup_mark+1|
and |subscr(p)=supscr(p)+1|.
@<Cases of |main_control| that build...@>=
mmode+sub_mark,mmode+sup_mark: sub_sup;
@ @<Declare act...@>=
procedure sub_sup;
var t:small_number; {type of previous sub/superscript}
@!p:pointer; {field to be filled by |scan_math|}
begin t:=empty; p:=null;
if tail<>head then if scripts_allowed(tail) then
begin p:=supscr(tail)+cur_cmd-sup_mark; {|supscr| or |subscr|}
t:=math_type(p);
end;
if (p=null)or(t<>empty) then @<Insert a dummy noad to be sub/superscripted@>;
scan_math(p);
end;
@ @<Insert a dummy...@>=
begin tail_append(new_noad);
p:=supscr(tail)+cur_cmd-sup_mark; {|supscr| or |subscr|}
if t<>empty then
begin if cur_cmd=sup_mark then
begin print_err("Double superscript");
@.Double superscript@>
help1("I treat `x^1^2' essentially like `x^1{}^2'.");
end
else begin print_err("Double subscript");
@.Double subscript@>
help1("I treat `x_1_2' essentially like `x_1{}_2'.");
end;
error;
end;
end
@ An operation like `\.{\\over}' causes the current mlist to go into a
state of suspended animation: |incompleat_noad| points to a |fraction_noad|
that contains the mlist-so-far as its numerator, while the denominator
is yet to come. Finally when the mlist is finished, the denominator will
go into the incompleat fraction noad, and that noad will become the
whole formula, unless it is surrounded by `\.{\\left}' and `\.{\\right}'
delimiters.
@d above_code=0 { `\.{\\above}' }
@d over_code=1 { `\.{\\over}' }
@d atop_code=2 { `\.{\\atop}' }
@d delimited_code=3 { `\.{\\abovewithdelims}', etc.}
@<Put each...@>=
primitive("above",above,above_code);@/
@!@:above_}{\.{\\above} primitive@>
primitive("over",above,over_code);@/
@!@:over_}{\.{\\over} primitive@>
primitive("atop",above,atop_code);@/
@!@:atop_}{\.{\\atop} primitive@>
primitive("abovewithdelims",above,delimited_code+above_code);@/
@!@:above_with_delims_}{\.{\\abovewithdelims} primitive@>
primitive("overwithdelims",above,delimited_code+over_code);@/
@!@:over_with_delims_}{\.{\\overwithdelims} primitive@>
primitive("atopwithdelims",above,delimited_code+atop_code);
@!@:atop_with_delims_}{\.{\\atopwithdelims} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
above: case chr_code of
over_code:print_esc("over");
atop_code:print_esc("atop");
delimited_code+above_code:print_esc("abovewithdelims");
delimited_code+over_code:print_esc("overwithdelims");
delimited_code+atop_code:print_esc("atopwithdelims");
othercases print_esc("above")
endcases;
@ @<Cases of |main_control| that build...@>=
mmode+above: math_fraction;
@ @<Declare act...@>=
procedure math_fraction;
var c:small_number; {the type of generalized fraction we are scanning}
begin c:=cur_chr;
if incompleat_noad<>null then
@<Ignore the fraction operation and complain about this ambiguous case@>
else begin incompleat_noad:=get_node(fraction_noad_size);
type(incompleat_noad):=fraction_noad;
subtype(incompleat_noad):=normal;
math_type(numerator(incompleat_noad)):=sub_mlist;
info(numerator(incompleat_noad)):=link(head);
mem[denominator(incompleat_noad)].hh:=empty_field;
mem[left_delimiter(incompleat_noad)].qqqq:=null_delimiter;
mem[right_delimiter(incompleat_noad)].qqqq:=null_delimiter;@/
link(head):=null; tail:=head;
@<Use code |c| to distinguish between generalized fractions@>;
end;
end;
@ @<Use code |c|...@>=
if c>=delimited_code then
begin scan_delimiter(left_delimiter(incompleat_noad),false);
scan_delimiter(right_delimiter(incompleat_noad),false);
end;
case c mod delimited_code of
above_code: begin scan_normal_dimen;
thickness(incompleat_noad):=cur_val;
end;
over_code: thickness(incompleat_noad):=default_code;
atop_code: thickness(incompleat_noad):=0;
end {there are no other cases}
@ @<Ignore the fraction...@>=
begin if c>=delimited_code then
begin scan_delimiter(garbage,false); scan_delimiter(garbage,false);
end;
if c mod delimited_code=above_code then scan_normal_dimen;
print_err("Ambiguous; you need another { and }");
@.Ambiguous...@>
help3("I'm ignoring this fraction specification, since I don't")@/
("know whether a construction like `x \over y \over z'")@/
("means `{x \over y} \over z' or `x \over {y \over z}'.");
error;
end
@ At the end of a math formula or subformula, the |fin_mlist| routine is
called upon to return a pointer to the newly completed mlist, and to
pop the nest back to the enclosing semantic level. The parameter to
|fin_mlist|, if not null, points to a |right_noad| that ends the
current mlist; this |right_noad| has not yet been appended.
@<Declare the function called |fin_mlist|@>=
function fin_mlist(@!p:pointer):pointer;
var q:pointer; {the mlist to return}
begin if incompleat_noad<>null then @<Compleat the incompleat noad@>
else begin link(tail):=p; q:=link(head);
end;
pop_nest; fin_mlist:=q;
end;
@ @<Compleat...@>=
begin math_type(denominator(incompleat_noad)):=sub_mlist;
info(denominator(incompleat_noad)):=link(head);
if p=null then q:=incompleat_noad
else begin q:=info(numerator(incompleat_noad));
if (type(q)<>left_noad)or(delim_ptr=null) then confusion("right");
@:this can't happen right}{\quad right@>
info(numerator(incompleat_noad)):=link(delim_ptr);
link(delim_ptr):=incompleat_noad; link(incompleat_noad):=p;
end;
end
@ Now at last we're ready to see what happens when a right brace occurs
in a math formula. Two special cases are simplified here: Braces are effectively
removed when they surround a single Ord without sub/superscripts, or when they
surround an accent that is the nucleus of an Ord atom.
@<Cases of |handle...@>=
math_group: begin unsave; decr(save_ptr);@/
math_type(saved(0)):=sub_mlist; p:=fin_mlist(null); info(saved(0)):=p;
if p<>null then if link(p)=null then
if type(p)=ord_noad then
begin if math_type(subscr(p))=empty then
if math_type(supscr(p))=empty then
begin mem[saved(0)].hh:=mem[nucleus(p)].hh;
free_node(p,noad_size);
end;
end
else if type(p)=accent_noad then if saved(0)=nucleus(tail) then
if type(tail)=ord_noad then @<Replace the tail of the list by |p|@>;
end;
@ @<Replace the tail...@>=
begin q:=head; while link(q)<>tail do q:=link(q);
link(q):=p; free_node(tail,noad_size); tail:=p;
end
@ We have dealt with all constructions of math mode except `\.{\\left}' and
`\.{\\right}', so the picture is completed by the following sections of
the program.
@<Put each...@>=
primitive("left",left_right,left_noad);
@!@:left_}{\.{\\left} primitive@>
primitive("right",left_right,right_noad);
@!@:right_}{\.{\\right} primitive@>
text(frozen_right):="right"; eqtb[frozen_right]:=eqtb[cur_val];
@ @<Cases of |print_cmd_chr|...@>=
left_right: if chr_code=left_noad then print_esc("left")
@/@<Cases of |left_right| for |print_cmd_chr|@>@/
else print_esc("right");
@ @<Cases of |main_control| that build...@>=
mmode+left_right: math_left_right;
@ @<Declare act...@>=
procedure math_left_right;
var t:small_number; {|left_noad| or |right_noad|}
@!p:pointer; {new noad}
@!q:pointer; {resulting mlist}
begin t:=cur_chr;
if (t<>left_noad)and(cur_group<>math_left_group) then
@<Try to recover from mismatched \.{\\right}@>
else begin p:=new_noad; type(p):=t;
scan_delimiter(delimiter(p),false);
if t=middle_noad then
begin type(p):=right_noad; subtype(p):=middle_noad;
end;
if t=left_noad then q:=p
else begin q:=fin_mlist(p); unsave; {end of |math_left_group|}
end;
if t<>right_noad then
begin push_math(math_left_group); link(head):=q; tail:=p;
delim_ptr:=p;
end
else begin
tail_append(new_noad); type(tail):=inner_noad;
math_type(nucleus(tail)):=sub_mlist;
info(nucleus(tail)):=q;
end;
end;
end;
@ @<Try to recover from mismatch...@>=
begin if cur_group=math_shift_group then
begin scan_delimiter(garbage,false);
print_err("Extra ");
if t=middle_noad then
begin print_esc("middle");
@.Extra \\middle.@>
help1("I'm ignoring a \middle that had no matching \left.");
end
else begin print_esc("right");
@.Extra \\right.@>
help1("I'm ignoring a \right that had no matching \left.");
end;
error;
end
else off_save;
end
@ Here is the only way out of math mode.
@<Cases of |main_control| that build...@>=
mmode+math_shift: if cur_group=math_shift_group then after_math
else off_save;
@ @<Declare act...@>=
@t\4@>@<Declare subprocedures for |after_math|@>@;
procedure after_math;
var l:boolean; {`\.{\\leqno}' instead of `\.{\\eqno}'}
@!danger:boolean; {not enough symbol fonts are present}
@!m:integer; {|mmode| or |-mmode|}
@!p:pointer; {the formula}
@!a:pointer; {box containing equation number}
@<Local variables for finishing a displayed formula@>@;
begin danger:=false;
@<Retrieve the prototype box@>;
@<Check that the necessary fonts for math symbols are present;
if not, flush the current math lists and set |danger:=true|@>;
m:=mode; l:=false; p:=fin_mlist(null); {this pops the nest}
if mode=-m then {end of equation number}
begin @<Check that another \.\$ follows@>;
cur_mlist:=p; cur_style:=text_style; mlist_penalties:=false;
mlist_to_hlist; a:=hpack(link(temp_head),natural);
set_box_lr(a)(dlist);
unsave; decr(save_ptr); {now |cur_group=math_shift_group|}
if saved(0)=1 then l:=true;
danger:=false;
@<Retrieve the prototype box@>;
@<Check that the necessary fonts for math symbols are present;
if not, flush the current math lists and set |danger:=true|@>;
m:=mode; p:=fin_mlist(null);
end
else a:=null;
if m<0 then @<Finish math in text@>
else begin if a=null then @<Check that another \.\$ follows@>;
@<Finish displayed math@>;
end;
end;
@ @<Check that the necessary fonts...@>=
if (font_params[fam_fnt(2+text_size)]<total_mathsy_params)or@|
(font_params[fam_fnt(2+script_size)]<total_mathsy_params)or@|
(font_params[fam_fnt(2+script_script_size)]<total_mathsy_params) then
begin print_err("Math formula deleted: Insufficient symbol fonts");@/
@.Math formula deleted...@>
help3("Sorry, but I can't typeset math unless \textfont 2")@/
("and \scriptfont 2 and \scriptscriptfont 2 have all")@/
("the \fontdimen values needed in math symbol fonts.");
error; flush_math; danger:=true;
end
else if (font_params[fam_fnt(3+text_size)]<total_mathex_params)or@|
(font_params[fam_fnt(3+script_size)]<total_mathex_params)or@|
(font_params[fam_fnt(3+script_script_size)]<total_mathex_params) then
begin print_err("Math formula deleted: Insufficient extension fonts");@/
help3("Sorry, but I can't typeset math unless \textfont 3")@/
("and \scriptfont 3 and \scriptscriptfont 3 have all")@/
("the \fontdimen values needed in math extension fonts.");
error; flush_math; danger:=true;
end
@ The |unsave| is done after everything else here; hence an appearance of
`\.{\\mathsurround}' inside of `\.{\$...\$}' affects the spacing at these
particular \.\$'s. This is consistent with the conventions of
`\.{\$\$...\$\$}', since `\.{\\abovedisplayskip}' inside a display affects the
space above that display.
@<Finish math in text@>=
begin tail_append(new_math(math_surround,before));
cur_mlist:=p; cur_style:=text_style; mlist_penalties:=(mode>0); mlist_to_hlist;
link(tail):=link(temp_head);
while link(tail)<>null do tail:=link(tail);
tail_append(new_math(math_surround,after));
space_factor:=1000; unsave;
end
@ \TeX\ gets to the following part of the program when the first `\.\$' ending
a display has been scanned.
@<Check that another \.\$ follows@>=
begin get_x_token;
if cur_cmd<>math_shift then
begin print_err("Display math should end with $$");
@.Display math...with \$\$@>
help2("The `$' that I just saw supposedly matches a previous `$$'.")@/
("So I shall assume that you typed `$$' both times.");
back_error;
end;
end
@ We have saved the worst for last: The fussiest part of math mode processing
occurs when a displayed formula is being centered and placed with an optional
equation number.
@<Local variables for finishing...@>=
@!b:pointer; {box containing the equation}
@!w:scaled; {width of the equation}
@!z:scaled; {width of the line}
@!e:scaled; {width of equation number}
@!q:scaled; {width of equation number plus space to separate from equation}
@!d:scaled; {displacement of equation in the line}
@!s:scaled; {move the line right this much}
@!g1,@!g2:small_number; {glue parameter codes for before and after}
@!r:pointer; {kern node used to position the display}
@!t:pointer; {tail of adjustment list}
@!pre_t:pointer; {tail of pre-adjustment list}
@ At this time |p| points to the mlist for the formula; |a| is either
|null| or it points to a box containing the equation number; and we are in
vertical mode (or internal vertical mode).
@<Finish displayed math@>=
cur_mlist:=p; cur_style:=display_style; mlist_penalties:=false;
mlist_to_hlist; p:=link(temp_head);@/
adjust_tail:=adjust_head; pre_adjust_tail:=pre_adjust_head;
b:=hpack(p,natural); p:=list_ptr(b);
t:=adjust_tail; adjust_tail:=null;@/
pre_t:=pre_adjust_tail; pre_adjust_tail:=null;@/
w:=width(b); z:=display_width; s:=display_indent;
if pre_display_direction<0 then s:=-s-z;
if (a=null)or danger then
begin e:=0; q:=0;
end
else begin e:=width(a); q:=e+math_quad(text_size);
end;
if w+q>z then
@<Squeeze the equation as much as possible; if there is an equation
number that should go on a separate line by itself,
set~|e:=0|@>;
@<Determine the displacement, |d|, of the left edge of the equation, with
respect to the line size |z|, assuming that |l=false|@>;
@<Append the glue or equation number preceding the display@>;
@<Append the display and perhaps also the equation number@>;
@<Append the glue or equation number following the display@>;
@<Flush the prototype box@>;
resume_after_display
@ @<Declare act...@>=
procedure resume_after_display;
begin if cur_group<>math_shift_group then confusion("display");
@:this can't happen display}{\quad display@>
unsave; prev_graf:=prev_graf+3;
push_nest; mode:=hmode; space_factor:=1000; set_cur_lang; clang:=cur_lang;
prev_graf:=(norm_min(left_hyphen_min)*@'100+norm_min(right_hyphen_min))
*@'200000+cur_lang;
@<Scan an optional space@>;
if nest_ptr=1 then build_page;
end;
@ The user can force the equation number to go on a separate line
by causing its width to be zero.
@<Squeeze the equation as much as possible...@>=
begin if (e<>0)and((w-total_shrink[normal]+q<=z)or@|
(total_shrink[fil]<>0)or(total_shrink[fill]<>0)or
(total_shrink[filll]<>0)) then
begin free_node(b,box_node_size);
b:=hpack(p,z-q,exactly);
end
else begin e:=0;
if w>z then
begin free_node(b,box_node_size);
b:=hpack(p,z,exactly);
end;
end;
w:=width(b);
end
@ We try first to center the display without regard to the existence of
the equation number. If that would make it too close (where ``too close''
means that the space between display and equation number is less than the
width of the equation number), we either center it in the remaining space
or move it as far from the equation number as possible. The latter alternative
is taken only if the display begins with glue, since we assume that the
user put glue there to control the spacing precisely.
@<Determine the displacement, |d|, of the left edge of the equation...@>=
set_box_lr(b)(dlist);
d:=half(z-w);
if (e>0)and(d<2*e) then {too close}
begin d:=half(z-w-e);
if p<>null then if not is_char_node(p) then if type(p)=glue_node then d:=0;
end
@ If the equation number is set on a line by itself, either before or
after the formula, we append an infinite penalty so that no page break will
separate the display from its number; and we use the same size and
displacement for all three potential lines of the display, even though
`\.{\\parshape}' may specify them differently.
@<Append the glue or equation number preceding the display@>=
tail_append(new_penalty(pre_display_penalty));@/
if (d+s<=pre_display_size)or l then {not enough clearance}
begin g1:=above_display_skip_code; g2:=below_display_skip_code;
end
else begin g1:=above_display_short_skip_code;
g2:=below_display_short_skip_code;
end;
if l and(e=0) then {it follows that |type(a)=hlist_node|}
begin app_display(j,a,0);
tail_append(new_penalty(inf_penalty));
end
else tail_append(new_param_glue(g1))
@ @<Append the display and perhaps also the equation number@>=
if e<>0 then
begin r:=new_kern(z-w-e-d);
if l then
begin link(a):=r; link(r):=b; b:=a; d:=0;
end
else begin link(b):=r; link(r):=a;
end;
b:=hpack(b,natural);
end;
app_display(j,b,d)
@ @<Append the glue or equation number following the display@>=
if (a<>null)and(e=0)and not l then
begin tail_append(new_penalty(inf_penalty));
app_display(j,a,z-width(a));
g2:=0;
end;
if t<>adjust_head then {migrating material comes after equation number}
begin link(tail):=link(adjust_head); tail:=t;
end;
if pre_t<>pre_adjust_head then
begin link(tail):=link(pre_adjust_head); tail:=pre_t;
end;
tail_append(new_penalty(post_display_penalty));
if g2>0 then tail_append(new_param_glue(g2))
@ When \.{\\halign} appears in a display, the alignment routines operate
essentially as they do in vertical mode. Then the following program is
activated, with |p| and |q| pointing to the beginning and end of the
resulting list, and with |aux_save| holding the |prev_depth| value.
@<Finish an alignment in a display@>=
begin do_assignments;
if cur_cmd<>math_shift then @<Pontificate about improper alignment in display@>
else @<Check that another \.\$ follows@>;
flush_node_list(LR_box);
pop_nest;
tail_append(new_penalty(pre_display_penalty));
tail_append(new_param_glue(above_display_skip_code));
link(tail):=p;
if p<>null then tail:=q;
tail_append(new_penalty(post_display_penalty));
tail_append(new_param_glue(below_display_skip_code));
prev_depth:=aux_save.sc; resume_after_display;
end
@ @<Pontificate...@>=
begin print_err("Missing $$ inserted");
@.Missing {\$\$} inserted@>
help2("Displays can use special alignments (like \eqalignno)")@/
("only if nothing but the alignment itself is between $$'s.");
back_error;
end
@* \[49] Mode-independent processing.
The long |main_control| procedure has now been fully specified, except for
certain activities that are independent of the current mode. These activities
do not change the current vlist or hlist or mlist; if they change anything,
it is the value of a parameter or the meaning of a control sequence.
Assignments to values in |eqtb| can be global or local. Furthermore, a
control sequence can be defined to be `\.{\\long}', `\.{\\protected}',
or `\.{\\outer}', and it might or might not be expanded. The prefixes
`\.{\\global}', `\.{\\long}', `\.{\\protected}',
and `\.{\\outer}' can occur in any order. Therefore we assign binary numeric
codes, making it possible to accumulate the union of all specified prefixes
by adding the corresponding codes. (\PASCAL's |set| operations could also
have been used.)
@<Put each...@>=
primitive("long",prefix,1);
@!@:long_}{\.{\\long} primitive@>
primitive("outer",prefix,2);
@!@:outer_}{\.{\\outer} primitive@>
primitive("global",prefix,4);
@!@:global_}{\.{\\global} primitive@>
primitive("def",def,0);
@!@:def_}{\.{\\def} primitive@>
primitive("gdef",def,1);
@!@:gdef_}{\.{\\gdef} primitive@>
primitive("edef",def,2);
@!@:edef_}{\.{\\edef} primitive@>
primitive("xdef",def,3);
@!@:xdef_}{\.{\\xdef} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
prefix: if chr_code=1 then print_esc("long")
else if chr_code=2 then print_esc("outer")
@/@<Cases of |prefix| for |print_cmd_chr|@>@/
else print_esc("global");
def: if chr_code=0 then print_esc("def")
else if chr_code=1 then print_esc("gdef")
else if chr_code=2 then print_esc("edef")
else print_esc("xdef");
@ Every prefix, and every command code that might or might not be prefixed,
calls the action procedure |prefixed_command|. This routine accumulates
a sequence of prefixes until coming to a non-prefix, then it carries out
the command.
@<Cases of |main_control| that don't...@>=
any_mode(toks_register),
any_mode(assign_toks),
any_mode(assign_int),
any_mode(assign_dimen),
any_mode(assign_glue),
any_mode(assign_mu_glue),
any_mode(assign_font_dimen),
any_mode(assign_font_int),
any_mode(set_aux),
any_mode(set_prev_graf),
any_mode(set_page_dimen),
any_mode(set_page_int),
any_mode(set_box_dimen),
any_mode(set_shape),
any_mode(def_code),
any_mode(def_family),
any_mode(set_font),
any_mode(def_font),
any_mode(letterspace_font),
any_mode(pdf_copy_font),
any_mode(register),
any_mode(advance),
any_mode(multiply),
any_mode(divide),
any_mode(prefix),
any_mode(let),
any_mode(shorthand_def),
any_mode(read_to_cs),
any_mode(def),
any_mode(set_box),
any_mode(hyph_data),
any_mode(set_interaction):prefixed_command;
@ If the user says, e.g., `\.{\\global\\global}', the redundancy is
silently accepted.
@<Declare act...@>=
@t\4@>@<Declare subprocedures for |prefixed_command|@>@t@>@;@/
procedure prefixed_command;
label done,exit;
var a:small_number; {accumulated prefix codes so far}
@!f:internal_font_number; {identifies a font}
@!j:halfword; {index into a \.{\\parshape} specification}
@!k:font_index; {index into |font_info|}
@!p,@!q:pointer; {for temporary short-term use}
@!n:integer; {ditto}
@!e:boolean; {should a definition be expanded? or was \.{\\let} not done?}
begin a:=0;
while cur_cmd=prefix do
begin if not odd(a div cur_chr) then a:=a+cur_chr;
@<Get the next non-blank non-relax...@>;
if cur_cmd<=max_non_prefixed_command then
@<Discard erroneous prefixes and |return|@>;
if tracing_commands>2 then if eTeX_ex then show_cur_cmd_chr;
end;
@<Discard the prefixes \.{\\long} and \.{\\outer} if they are irrelevant@>;
@<Adjust \(f)for the setting of \.{\\globaldefs}@>;
case cur_cmd of
@t\4@>@<Assignments@>@;
othercases confusion("prefix")
@:this can't happen prefix}{\quad prefix@>
endcases;
done: @<Insert a token saved by \.{\\afterassignment}, if any@>;
exit:end;
@ @<Discard erroneous...@>=
begin print_err("You can't use a prefix with `");
@.You can't use a prefix with x@>
print_cmd_chr(cur_cmd,cur_chr); print_char("'");
help1("I'll pretend you didn't say \long or \outer or \global.");
if eTeX_ex then help_line[0]:=@|
"I'll pretend you didn't say \long or \outer or \global or \protected.";
back_error; return;
end
@ @<Discard the prefixes...@>=
if a>=8 then
begin j:=protected_token; a:=a-8;
end
else j:=0;
if (cur_cmd<>def)and((a mod 4<>0)or(j<>0)) then
begin print_err("You can't use `"); print_esc("long"); print("' or `");
print_esc("outer");
help1("I'll pretend you didn't say \long or \outer here.");
if eTeX_ex then
begin help_line[0]:=@|
"I'll pretend you didn't say \long or \outer or \protected here.";
print("' or `"); print_esc("protected");
end;
print("' with `");
@.You can't use \\long...@>
print_cmd_chr(cur_cmd,cur_chr); print_char("'");
error;
end
@ The previous routine does not have to adjust |a| so that |a mod 4=0|,
since the following routines test for the \.{\\global} prefix as follows.
@d global==(a>=4)
@d define(#)==if global then geq_define(#)@+else eq_define(#)
@d word_define(#)==if global then geq_word_define(#)@+else eq_word_define(#)
@<Adjust \(f)for the setting of \.{\\globaldefs}@>=
if global_defs<>0 then
if global_defs<0 then
begin if global then a:=a-4;
end
else begin if not global then a:=a+4;
end
@ When a control sequence is to be defined, by \.{\\def} or \.{\\let} or
something similar, the |get_r_token| routine will substitute a special
control sequence for a token that is not redefinable.
@<Declare subprocedures for |prefixed_command|@>=
procedure get_r_token;
label restart;
begin restart: repeat get_token;
until cur_tok<>space_token;
if (cur_cs=0)or(cur_cs>frozen_control_sequence) then
begin print_err("Missing control sequence inserted");
@.Missing control...@>
help5("Please don't say `\def cs{...}', say `\def\cs{...}'.")@/
("I've inserted an inaccessible control sequence so that your")@/
("definition will be completed without mixing me up too badly.")@/
("You can recover graciously from this error, if you're")@/
("careful; see exercise 27.2 in The TeXbook.");
@:TeXbook}{\sl The \TeX book@>
if cur_cs=0 then back_input;
cur_tok:=cs_token_flag+frozen_protection; ins_error; goto restart;
end;
end;
@ @<Initialize table entries...@>=
text(frozen_protection):="inaccessible";
@.inaccessible@>
@ Here's an example of the way many of the following routines operate.
(Unfortunately, they aren't all as simple as this.)
@<Assignments@>=
set_font: define(cur_font_loc,data,cur_chr);
@ When a |def| command has been scanned,
|cur_chr| is odd if the definition is supposed to be global, and
|cur_chr>=2| if the definition is supposed to be expanded.
@<Assignments@>=
def: begin if odd(cur_chr)and not global and(global_defs>=0) then a:=a+4;
e:=(cur_chr>=2); get_r_token; p:=cur_cs;
q:=scan_toks(true,e);
if j<>0 then
begin q:=get_avail; info(q):=j; link(q):=link(def_ref);
link(def_ref):=q;
end;
define(p,call+(a mod 4),def_ref);
end;
@ Both \.{\\let} and \.{\\futurelet} share the command code |let|.
@<Put each...@>=
primitive("let",let,normal);@/
@!@:let_}{\.{\\let} primitive@>
primitive("futurelet",let,normal+1);@/
@!@:future_let_}{\.{\\futurelet} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
let: if chr_code<>normal then print_esc("futurelet")@+else print_esc("let");
@ @<Assignments@>=
let: begin n:=cur_chr;
get_r_token; p:=cur_cs;
if n=normal then
begin repeat get_token;
until cur_cmd<>spacer;
if cur_tok=other_token+"=" then
begin get_token;
if cur_cmd=spacer then get_token;
end;
end
else begin get_token; q:=cur_tok; get_token; back_input;
cur_tok:=q; back_input; {look ahead, then back up}
end; {note that |back_input| doesn't affect |cur_cmd|, |cur_chr|}
if cur_cmd>=call then add_token_ref(cur_chr)
else if (cur_cmd=register)or(cur_cmd=toks_register) then
if (cur_chr<mem_bot)or(cur_chr>lo_mem_stat_max) then
add_sa_ref(cur_chr);
define(p,cur_cmd,cur_chr);
end;
@ A \.{\\chardef} creates a control sequence whose |cmd| is |char_given|;
a \.{\\mathchardef} creates a control sequence whose |cmd| is |math_given|;
and the corresponding |chr| is the character code or math code. A \.{\\countdef}
or \.{\\dimendef} or \.{\\skipdef} or \.{\\muskipdef} creates a control
sequence whose |cmd| is |assign_int| or \dots\ or |assign_mu_glue|, and the
corresponding |chr| is the |eqtb| location of the internal register in question.
@d char_def_code=0 {|shorthand_def| for \.{\\chardef}}
@d math_char_def_code=1 {|shorthand_def| for \.{\\mathchardef}}
@d count_def_code=2 {|shorthand_def| for \.{\\countdef}}
@d dimen_def_code=3 {|shorthand_def| for \.{\\dimendef}}
@d skip_def_code=4 {|shorthand_def| for \.{\\skipdef}}
@d mu_skip_def_code=5 {|shorthand_def| for \.{\\muskipdef}}
@d toks_def_code=6 {|shorthand_def| for \.{\\toksdef}}
@<Put each...@>=
primitive("chardef",shorthand_def,char_def_code);@/
@!@:char_def_}{\.{\\chardef} primitive@>
primitive("mathchardef",shorthand_def,math_char_def_code);@/
@!@:math_char_def_}{\.{\\mathchardef} primitive@>
primitive("countdef",shorthand_def,count_def_code);@/
@!@:count_def_}{\.{\\countdef} primitive@>
primitive("dimendef",shorthand_def,dimen_def_code);@/
@!@:dimen_def_}{\.{\\dimendef} primitive@>
primitive("skipdef",shorthand_def,skip_def_code);@/
@!@:skip_def_}{\.{\\skipdef} primitive@>
primitive("muskipdef",shorthand_def,mu_skip_def_code);@/
@!@:mu_skip_def_}{\.{\\muskipdef} primitive@>
primitive("toksdef",shorthand_def,toks_def_code);@/
@!@:toks_def_}{\.{\\toksdef} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
shorthand_def: case chr_code of
char_def_code: print_esc("chardef");
math_char_def_code: print_esc("mathchardef");
count_def_code: print_esc("countdef");
dimen_def_code: print_esc("dimendef");
skip_def_code: print_esc("skipdef");
mu_skip_def_code: print_esc("muskipdef");
othercases print_esc("toksdef")
endcases;
char_given: begin print_esc("char"); print_hex(chr_code);
end;
math_given: begin print_esc("mathchar"); print_hex(chr_code);
end;
@ We temporarily define |p| to be |relax|, so that an occurrence of |p|
while scanning the definition will simply stop the scanning instead of
producing an ``undefined control sequence'' error or expanding the
previous meaning. This allows, for instance, `\.{\\chardef\\foo=123\\foo}'.
@<Assignments@>=
shorthand_def: begin n:=cur_chr; get_r_token; p:=cur_cs; define(p,relax,256);
scan_optional_equals;
case n of
char_def_code: begin scan_char_num; define(p,char_given,cur_val);
end;
math_char_def_code: begin scan_fifteen_bit_int; define(p,math_given,cur_val);
end;
othercases begin scan_register_num;
if cur_val>255 then
begin j:=n-count_def_code; {|int_val..box_val|}
if j>mu_val then j:=tok_val; {|int_val..mu_val| or |tok_val|}
find_sa_element(j,cur_val,true); add_sa_ref(cur_ptr);
if j=tok_val then j:=toks_register@+else j:=register;
define(p,j,cur_ptr);
end
else
case n of
count_def_code: define(p,assign_int,count_base+cur_val);
dimen_def_code: define(p,assign_dimen,scaled_base+cur_val);
skip_def_code: define(p,assign_glue,skip_base+cur_val);
mu_skip_def_code: define(p,assign_mu_glue,mu_skip_base+cur_val);
toks_def_code: define(p,assign_toks,toks_base+cur_val);
end; {there are no other cases}
end
endcases;
end;
@ @<Assignments@>=
read_to_cs: begin j:=cur_chr; scan_int; n:=cur_val;
if not scan_keyword("to") then
@.to@>
begin print_err("Missing `to' inserted");
@.Missing `to'...@>
help2("You should have said `\read<number> to \cs'.")@/
("I'm going to look for the \cs now."); error;
end;
get_r_token;
p:=cur_cs; read_toks(n,p,j); define(p,call,cur_val);
end;
@ The token-list parameters, \.{\\output} and \.{\\everypar}, etc., receive
their values in the following way. (For safety's sake, we place an
enclosing pair of braces around an \.{\\output} list.)
@<Assignments@>=
toks_register,assign_toks: begin q:=cur_cs;
e:=false; {just in case, will be set |true| for sparse array elements}
if cur_cmd=toks_register then
if cur_chr=mem_bot then
begin scan_register_num;
if cur_val>255 then
begin find_sa_element(tok_val,cur_val,true);
cur_chr:=cur_ptr; e:=true;
end
else cur_chr:=toks_base+cur_val;
end
else e:=true;
p:=cur_chr; {|p=every_par_loc| or |output_routine_loc| or \dots}
scan_optional_equals;
@<Get the next non-blank non-relax non-call token@>;
if cur_cmd<>left_brace then @<If the right-hand side is a token parameter
or token register, finish the assignment and |goto done|@>;
back_input; cur_cs:=q; q:=scan_toks(false,false);
if link(def_ref)=null then {empty list: revert to the default}
begin sa_define(p,null)(p,undefined_cs,null); free_avail(def_ref);
end
else begin if (p=output_routine_loc)and not e then {enclose in curlies}
begin link(q):=get_avail; q:=link(q);
info(q):=right_brace_token+"}";
q:=get_avail; info(q):=left_brace_token+"{";
link(q):=link(def_ref); link(def_ref):=q;
end;
sa_define(p,def_ref)(p,call,def_ref);
end;
end;
@ @<If the right-hand side is a token parameter...@>=
if (cur_cmd=toks_register)or(cur_cmd=assign_toks) then
begin if cur_cmd=toks_register then
if cur_chr=mem_bot then
begin scan_register_num;
if cur_val<256 then q:=equiv(toks_base+cur_val)
else begin find_sa_element(tok_val,cur_val,false);
if cur_ptr=null then q:=null
else q:=sa_ptr(cur_ptr);
end;
end
else q:=sa_ptr(cur_chr)
else q:=equiv(cur_chr);
if q=null then sa_define(p,null)(p,undefined_cs,null)
else begin add_token_ref(q); sa_define(p,q)(p,call,q);
end;
goto done;
end
@ Similar routines are used to assign values to the numeric parameters.
@<Assignments@>=
assign_int: begin p:=cur_chr; scan_optional_equals; scan_int;
word_define(p,cur_val);
end;
assign_dimen: begin p:=cur_chr; scan_optional_equals;
scan_normal_dimen; word_define(p,cur_val);
end;
assign_glue,assign_mu_glue: begin p:=cur_chr; n:=cur_cmd; scan_optional_equals;
if n=assign_mu_glue then scan_glue(mu_val)@+else scan_glue(glue_val);
trap_zero_glue;
define(p,glue_ref,cur_val);
end;
@ When a glue register or parameter becomes zero, it will always point to
|zero_glue| because of the following procedure. (Exception: The tabskip
glue isn't trapped while preambles are being scanned.)
@<Declare subprocedures for |prefixed_command|@>=
procedure trap_zero_glue;
begin if (width(cur_val)=0)and(stretch(cur_val)=0)and(shrink(cur_val)=0) then
begin add_glue_ref(zero_glue);
delete_glue_ref(cur_val); cur_val:=zero_glue;
end;
end;
@ The various character code tables are changed by the |def_code| commands,
and the font families are declared by |def_family|.
@<Put each...@>=
primitive("catcode",def_code,cat_code_base);
@!@:cat_code_}{\.{\\catcode} primitive@>
primitive("mathcode",def_code,math_code_base);
@!@:math_code_}{\.{\\mathcode} primitive@>
primitive("lccode",def_code,lc_code_base);
@!@:lc_code_}{\.{\\lccode} primitive@>
primitive("uccode",def_code,uc_code_base);
@!@:uc_code_}{\.{\\uccode} primitive@>
primitive("sfcode",def_code,sf_code_base);
@!@:sf_code_}{\.{\\sfcode} primitive@>
primitive("delcode",def_code,del_code_base);
@!@:del_code_}{\.{\\delcode} primitive@>
primitive("textfont",def_family,math_font_base);
@!@:text_font_}{\.{\\textfont} primitive@>
primitive("scriptfont",def_family,math_font_base+script_size);
@!@:script_font_}{\.{\\scriptfont} primitive@>
primitive("scriptscriptfont",def_family,math_font_base+script_script_size);
@!@:script_script_font_}{\.{\\scriptscriptfont} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
def_code: if chr_code=cat_code_base then print_esc("catcode")
else if chr_code=math_code_base then print_esc("mathcode")
else if chr_code=lc_code_base then print_esc("lccode")
else if chr_code=uc_code_base then print_esc("uccode")
else if chr_code=sf_code_base then print_esc("sfcode")
else print_esc("delcode");
def_family: print_size(chr_code-math_font_base);
@ The different types of code values have different legal ranges; the
following program is careful to check each case properly.
@<Assignments@>=
def_code: begin @<Let |n| be the largest legal code value, based on |cur_chr|@>;
p:=cur_chr; scan_char_num; p:=p+cur_val; scan_optional_equals;
scan_int;
if ((cur_val<0)and(p<del_code_base))or(cur_val>n) then
begin print_err("Invalid code ("); print_int(cur_val);
@.Invalid code@>
if p<del_code_base then print("), should be in the range 0..")
else print("), should be at most ");
print_int(n);
help1("I'm going to use 0 instead of that illegal code value.");@/
error; cur_val:=0;
end;
if p<math_code_base then define(p,data,cur_val)
else if p<del_code_base then define(p,data,hi(cur_val))
else word_define(p,cur_val);
end;
@ @<Let |n| be the largest...@>=
if cur_chr=cat_code_base then n:=max_char_code
else if cur_chr=math_code_base then n:=@'100000
else if cur_chr=sf_code_base then n:=@'77777
else if cur_chr=del_code_base then n:=@'77777777
else n:=255
@ @<Assignments@>=
def_family: begin p:=cur_chr; scan_four_bit_int; p:=p+cur_val;
scan_optional_equals; scan_font_ident; define(p,data,cur_val);
end;
@ Next we consider changes to \TeX's numeric registers.
@<Assignments@>=
register,advance,multiply,divide: do_register_command(a);
@ We use the fact that |register<advance<multiply<divide|.
@<Declare subprocedures for |prefixed_command|@>=
procedure do_register_command(@!a:small_number);
label found,exit;
var l,@!q,@!r,@!s:pointer; {for list manipulation}
@!p:int_val..mu_val; {type of register involved}
@!e:boolean; {does |l| refer to a sparse array element?}
@!w:integer; {integer or dimen value of |l|}
begin q:=cur_cmd;
e:=false; {just in case, will be set |true| for sparse array elements}
@<Compute the register location |l| and its type |p|; but |return| if invalid@>;
if q=register then scan_optional_equals
else if scan_keyword("by") then do_nothing; {optional `\.{by}'}
@.by@>
arith_error:=false;
if q<multiply then @<Compute result of |register| or
|advance|, put it in |cur_val|@>
else @<Compute result of |multiply| or |divide|, put it in |cur_val|@>;
if arith_error then
begin print_err("Arithmetic overflow");
@.Arithmetic overflow@>
help2("I can't carry out that multiplication or division,")@/
("since the result is out of range.");
if p>=glue_val then delete_glue_ref(cur_val);
error; return;
end;
if p<glue_val then sa_word_define(l,cur_val)
else begin trap_zero_glue; sa_define(l,cur_val)(l,glue_ref,cur_val);
end;
exit: end;
@ Here we use the fact that the consecutive codes |int_val..mu_val| and
|assign_int..assign_mu_glue| correspond to each other nicely.
@<Compute the register location |l| and its type |p|...@>=
begin if q<>register then
begin get_x_token;
if (cur_cmd>=assign_int)and(cur_cmd<=assign_mu_glue) then
begin l:=cur_chr; p:=cur_cmd-assign_int; goto found;
end;
if cur_cmd<>register then
begin print_err("You can't use `"); print_cmd_chr(cur_cmd,cur_chr);
@.You can't use x after ...@>
print("' after "); print_cmd_chr(q,0);
help1("I'm forgetting what you said and not changing anything.");
error; return;
end;
end;
if (cur_chr<mem_bot)or(cur_chr>lo_mem_stat_max) then
begin l:=cur_chr; p:=sa_type(l); e:=true;
end
else begin p:=cur_chr-mem_bot; scan_register_num;
if cur_val>255 then
begin find_sa_element(p,cur_val,true); l:=cur_ptr; e:=true;
end
else
case p of
int_val: l:=cur_val+count_base;
dimen_val: l:=cur_val+scaled_base;
glue_val: l:=cur_val+skip_base;
mu_val: l:=cur_val+mu_skip_base;
end; {there are no other cases}
end;
end;
found: if p<glue_val then@+if e then w:=sa_int(l)@+else w:=eqtb[l].int
else if e then s:=sa_ptr(l)@+else s:=equiv(l)
@ @<Compute result of |register| or |advance|...@>=
if p<glue_val then
begin if p=int_val then scan_int@+else scan_normal_dimen;
if q=advance then cur_val:=cur_val+w;
end
else begin scan_glue(p);
if q=advance then @<Compute the sum of two glue specs@>;
end
@ @<Compute the sum of two glue specs@>=
begin q:=new_spec(cur_val); r:=s;
delete_glue_ref(cur_val);
width(q):=width(q)+width(r);
if stretch(q)=0 then stretch_order(q):=normal;
if stretch_order(q)=stretch_order(r) then stretch(q):=stretch(q)+stretch(r)
else if (stretch_order(q)<stretch_order(r))and(stretch(r)<>0) then
begin stretch(q):=stretch(r); stretch_order(q):=stretch_order(r);
end;
if shrink(q)=0 then shrink_order(q):=normal;
if shrink_order(q)=shrink_order(r) then shrink(q):=shrink(q)+shrink(r)
else if (shrink_order(q)<shrink_order(r))and(shrink(r)<>0) then
begin shrink(q):=shrink(r); shrink_order(q):=shrink_order(r);
end;
cur_val:=q;
end
@ @<Compute result of |multiply| or |divide|...@>=
begin scan_int;
if p<glue_val then
if q=multiply then
if p=int_val then cur_val:=mult_integers(w,cur_val)
else cur_val:=nx_plus_y(w,cur_val,0)
else cur_val:=x_over_n(w,cur_val)
else begin r:=new_spec(s);
if q=multiply then
begin width(r):=nx_plus_y(width(s),cur_val,0);
stretch(r):=nx_plus_y(stretch(s),cur_val,0);
shrink(r):=nx_plus_y(shrink(s),cur_val,0);
end
else begin width(r):=x_over_n(width(s),cur_val);
stretch(r):=x_over_n(stretch(s),cur_val);
shrink(r):=x_over_n(shrink(s),cur_val);
end;
cur_val:=r;
end;
end
@ The processing of boxes is somewhat different, because we may need
to scan and create an entire box before we actually change the value of the old
one.
@<Assignments@>=
set_box: begin scan_register_num;
if global then n:=global_box_flag+cur_val@+else n:=box_flag+cur_val;
scan_optional_equals;
if set_box_allowed then scan_box(n)
else begin print_err("Improper "); print_esc("setbox");
@.Improper \\setbox@>
help2("Sorry, \setbox is not allowed after \halign in a display,")@/
("or between \accent and an accented character."); error;
end;
end;
@ The |space_factor| or |prev_depth| settings are changed when a |set_aux|
command is sensed. Similarly, |prev_graf| is changed in the presence of
|set_prev_graf|, and |dead_cycles| or |insert_penalties| in the presence of
|set_page_int|. These definitions are always global.
When some dimension of a box register is changed, the change isn't exactly
global; but \TeX\ does not look at the \.{\\global} switch.
@<Assignments@>=
set_aux:alter_aux;
set_prev_graf:alter_prev_graf;
set_page_dimen:alter_page_so_far;
set_page_int:alter_integer;
set_box_dimen:alter_box_dimen;
@ @<Declare subprocedures for |prefixed_command|@>=
procedure alter_aux;
var c:halfword; {|hmode| or |vmode|}
begin if cur_chr<>abs(mode) then report_illegal_case
else begin c:=cur_chr; scan_optional_equals;
if c=vmode then
begin scan_normal_dimen; prev_depth:=cur_val;
end
else begin scan_int;
if (cur_val<=0)or(cur_val>32767) then
begin print_err("Bad space factor");
@.Bad space factor@>
help1("I allow only values in the range 1..32767 here.");
int_error(cur_val);
end
else space_factor:=cur_val;
end;
end;
end;
@ @<Declare subprocedures for |prefixed_command|@>=
procedure alter_prev_graf;
var p:0..nest_size; {index into |nest|}
begin nest[nest_ptr]:=cur_list; p:=nest_ptr;
while abs(nest[p].mode_field)<>vmode do decr(p);
scan_optional_equals; scan_int;
if cur_val<0 then
begin print_err("Bad "); print_esc("prevgraf");
@.Bad \\prevgraf@>
help1("I allow only nonnegative values here.");
int_error(cur_val);
end
else begin nest[p].pg_field:=cur_val; cur_list:=nest[nest_ptr];
end;
end;
@ @<Declare subprocedures for |prefixed_command|@>=
procedure alter_page_so_far;
var c:0..7; {index into |page_so_far|}
begin c:=cur_chr; scan_optional_equals; scan_normal_dimen;
page_so_far[c]:=cur_val;
end;
@ @<Declare subprocedures for |prefixed_command|@>=
procedure alter_integer;
var c:small_number;
{0 for \.{\\deadcycles}, 1 for \.{\\insertpenalties}, etc.}
begin c:=cur_chr; scan_optional_equals; scan_int;
if c=0 then dead_cycles:=cur_val
@/@<Cases for |alter_integer|@>@/
else insert_penalties:=cur_val;
end;
@ @<Declare subprocedures for |prefixed_command|@>=
procedure alter_box_dimen;
var c:small_number; {|width_offset| or |height_offset| or |depth_offset|}
@!b:pointer; {box register}
begin c:=cur_chr; scan_register_num; fetch_box(b); scan_optional_equals;
scan_normal_dimen;
if b<>null then mem[b+c].sc:=cur_val;
end;
@ Paragraph shapes are set up in the obvious way.
@<Assignments@>=
set_shape: begin q:=cur_chr; scan_optional_equals; scan_int; n:=cur_val;
if n<=0 then p:=null
else if q>par_shape_loc then
begin n:=(cur_val div 2)+1; p:=get_node(2*n+1); info(p):=n;
n:=cur_val; mem[p+1].int:=n; {number of penalties}
for j:=p+2 to p+n+1 do
begin scan_int; mem[j].int:=cur_val; {penalty values}
end;
if not odd(n) then mem[p+n+2].int:=0; {unused}
end
else begin p:=get_node(2*n+1); info(p):=n;
for j:=1 to n do
begin scan_normal_dimen;
mem[p+2*j-1].sc:=cur_val; {indentation}
scan_normal_dimen;
mem[p+2*j].sc:=cur_val; {width}
end;
end;
define(q,shape_ref,p);
end;
@ Here's something that isn't quite so obvious. It guarantees that
|info(par_shape_ptr)| can hold any positive~|n| for which |get_node(2*n+1)|
doesn't overflow the memory capacity.
@<Check the ``constant''...@>=
if 2*max_halfword<mem_top-mem_min then bad:=41;
@ New hyphenation data is loaded by the |hyph_data| command.
@<Put each...@>=
primitive("hyphenation",hyph_data,0);
@!@:hyphenation_}{\.{\\hyphenation} primitive@>
primitive("patterns",hyph_data,1);
@!@:patterns_}{\.{\\patterns} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
hyph_data: if chr_code=1 then print_esc("patterns")
else print_esc("hyphenation");
@ @<Assignments@>=
hyph_data: if cur_chr=1 then
begin @!init new_patterns; goto done;@;@+tini@/
print_err("Patterns can be loaded only by INITEX");
@.Patterns can be...@>
help0; error;
repeat get_token; until cur_cmd=right_brace; {flush the patterns}
return;
end
else begin new_hyph_exceptions; goto done;
end;
@ All of \TeX's parameters are kept in |eqtb| except the font information,
the interaction mode, and the hyphenation tables; these are strictly global.
@<Assignments@>=
assign_font_dimen: begin find_font_dimen(true); k:=cur_val;
scan_optional_equals; scan_normal_dimen; font_info[k].sc:=cur_val;
end;
assign_font_int: begin n:=cur_chr; scan_font_ident; f:=cur_val;
if n = no_lig_code then set_no_ligatures(f)
else if n < lp_code_base then begin
scan_optional_equals; scan_int;
if n=0 then hyphen_char[f]:=cur_val@+else skew_char[f]:=cur_val;
end
else begin
scan_char_num; p := cur_val;
scan_optional_equals; scan_int;
case n of
lp_code_base: set_lp_code(f, p, cur_val);
rp_code_base: set_rp_code(f, p, cur_val);
ef_code_base: set_ef_code(f, p, cur_val);
tag_code: set_tag_code(f, p, cur_val);
kn_bs_code_base: set_kn_bs_code(f, p, cur_val);
st_bs_code_base: set_st_bs_code(f, p, cur_val);
sh_bs_code_base: set_sh_bs_code(f, p, cur_val);
kn_bc_code_base: set_kn_bc_code(f, p, cur_val);
kn_ac_code_base: set_kn_ac_code(f, p, cur_val);
end;
end;
end;
@ @<Put each...@>=
primitive("hyphenchar",assign_font_int,0);
@!@:hyphen_char_}{\.{\\hyphenchar} primitive@>
primitive("skewchar",assign_font_int,1);
@!@:skew_char_}{\.{\\skewchar} primitive@>
primitive("lpcode",assign_font_int,lp_code_base);
@!@:lp_code_}{\.{\\lpcode} primitive@>
primitive("rpcode",assign_font_int,rp_code_base);
@!@:rp_code_}{\.{\\rpcode} primitive@>
primitive("efcode",assign_font_int,ef_code_base);
@!@:ef_code_}{\.{\\efcode} primitive@>
primitive("tagcode",assign_font_int,tag_code);
@!@:tag_code_}{\.{\\tagcode} primitive@>
primitive("knbscode",assign_font_int,kn_bs_code_base);
@!@:kn_bs_code_}{\.{\\knbscode} primitive@>
primitive("stbscode",assign_font_int,st_bs_code_base);
@!@:st_bs_code_}{\.{\\stbscode} primitive@>
primitive("shbscode",assign_font_int,sh_bs_code_base);
@!@:sh_bs_code_}{\.{\\shbscode} primitive@>
primitive("knbccode",assign_font_int,kn_bc_code_base);
@!@:kn_bc_code_}{\.{\\knbccode} primitive@>
primitive("knaccode",assign_font_int,kn_ac_code_base);
@!@:kn_ac_code_}{\.{\\knaccode} primitive@>
primitive("pdfnoligatures",assign_font_int,no_lig_code);
@!@:no_lig_code_}{\.{\\pdfnoligatures} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
assign_font_int: case chr_code of
0: print_esc("hyphenchar");
1: print_esc("skewchar");
lp_code_base: print_esc("lpcode");
rp_code_base: print_esc("rpcode");
ef_code_base: print_esc("efcode");
tag_code: print_esc("tagcode");
kn_bs_code_base: print_esc("knbscode");
st_bs_code_base: print_esc("stbscode");
sh_bs_code_base: print_esc("shbscode");
kn_bc_code_base: print_esc("knbccode");
kn_ac_code_base: print_esc("knaccode");
no_lig_code: print_esc("pdfnoligatures");
endcases;
@ Here is where the information for a new font gets loaded.
@<Assignments@>=
def_font: new_font(a);
letterspace_font: new_letterspaced_font(a);
pdf_copy_font: make_font_copy(a);
@ @<Declare subprocedures for |prefixed_command|@>=
procedure new_font(@!a:small_number);
label common_ending;
var u:pointer; {user's font identifier}
@!s:scaled; {stated ``at'' size, or negative of scaled magnification}
@!f:internal_font_number; {runs through existing fonts}
@!t:str_number; {name for the frozen font identifier}
@!old_setting:0..max_selector; {holds |selector| setting}
@!flushable_string:str_number; {string not yet referenced}
begin if job_name=0 then open_log_file;
{avoid confusing \.{texput} with the font name}
@.texput@>
get_r_token; u:=cur_cs;
if u>=hash_base then t:=text(u)
else if u>=single_base then
if u=null_cs then t:="FONT"@+else t:=u-single_base
else begin old_setting:=selector; selector:=new_string;
print("FONT"); print(u-active_base); selector:=old_setting;
@.FONTx@>
str_room(1); t:=make_string;
end;
define(u,set_font,null_font); scan_optional_equals; scan_file_name;
@<Scan the font size specification@>;
@<If this font has already been loaded, set |f| to the internal
font number and |goto common_ending|@>;
f:=read_font_info(u,cur_name,cur_area,s);
common_ending: define(u,set_font,f); eqtb[font_id_base+f]:=eqtb[u]; font_id_text(f):=t;
end;
@ @<Scan the font size specification@>=
name_in_progress:=true; {this keeps |cur_name| from being changed}
if scan_keyword("at") then @<Put the \(p)(positive) `at' size into |s|@>
@.at@>
else if scan_keyword("scaled") then
@.scaled@>
begin scan_int; s:=-cur_val;
if (cur_val<=0)or(cur_val>32768) then
begin print_err("Illegal magnification has been changed to 1000");@/
@.Illegal magnification...@>
help1("The magnification ratio must be between 1 and 32768.");
int_error(cur_val); s:=-1000;
end;
end
else s:=-1000;
name_in_progress:=false
@ @<Put the \(p)(positive) `at' size into |s|@>=
begin scan_normal_dimen; s:=cur_val;
if (s<=0)or(s>=@'1000000000) then
begin print_err("Improper `at' size (");
print_scaled(s); print("pt), replaced by 10pt");
@.Improper `at' size...@>
help2("I can only handle fonts at positive sizes that are")@/
("less than 2048pt, so I've changed what you said to 10pt.");
error; s:=10*unity;
end;
end
@ When the user gives a new identifier to a font that was previously loaded,
the new name becomes the font identifier of record. Font names `\.{xyz}' and
`\.{XYZ}' are considered to be different.
@<If this font has already been loaded...@>=
flushable_string:=str_ptr-1;
for f:=font_base+1 to font_ptr do
if str_eq_str(font_name[f],cur_name)and str_eq_str(font_area[f],cur_area) then
begin if cur_name=flushable_string then
begin flush_string; cur_name:=font_name[f];
end;
if s>0 then
begin if s=font_size[f] then goto common_ending;
end
else if font_size[f]=xn_over_d(font_dsize[f],-s,1000) then
goto common_ending;
end
@ @<Cases of |print_cmd_chr|...@>=
set_font:begin print("select font "); slow_print(font_name[chr_code]);
if font_size[chr_code]<>font_dsize[chr_code] then
begin print(" at "); print_scaled(font_size[chr_code]);
print("pt");
end;
end;
@ @<Put each...@>=
primitive("batchmode",set_interaction,batch_mode);
@!@:batch_mode_}{\.{\\batchmode} primitive@>
primitive("nonstopmode",set_interaction,nonstop_mode);
@!@:nonstop_mode_}{\.{\\nonstopmode} primitive@>
primitive("scrollmode",set_interaction,scroll_mode);
@!@:scroll_mode_}{\.{\\scrollmode} primitive@>
primitive("errorstopmode",set_interaction,error_stop_mode);
@!@:error_stop_mode_}{\.{\\errorstopmode} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
set_interaction: case chr_code of
batch_mode: print_esc("batchmode");
nonstop_mode: print_esc("nonstopmode");
scroll_mode: print_esc("scrollmode");
othercases print_esc("errorstopmode")
endcases;
@ @<Assignments@>=
set_interaction: new_interaction;
@ @<Declare subprocedures for |prefixed_command|@>=
procedure new_interaction;
begin print_ln;
interaction:=cur_chr;
@<Initialize the print |selector| based on |interaction|@>;
if log_opened then selector:=selector+2;
end;
@ The \.{\\afterassignment} command puts a token into the global
variable |after_token|. This global variable is examined just after
every assignment has been performed.
@<Glob...@>=
@!after_token:halfword; {zero, or a saved token}
@ @<Set init...@>=
after_token:=0;
@ @<Cases of |main_control| that don't...@>=
any_mode(after_assignment):begin get_token; after_token:=cur_tok;
end;
@ @<Insert a token saved by \.{\\afterassignment}, if any@>=
if after_token<>0 then
begin cur_tok:=after_token; back_input; after_token:=0;
end
@ Here is a procedure that might be called `Get the next non-blank non-relax
non-call non-assignment token'.
@<Declare act...@>=
procedure do_assignments;
label exit;
begin loop begin @<Get the next non-blank non-relax...@>;
if cur_cmd<=max_non_prefixed_command then return;
set_box_allowed:=false; prefixed_command; set_box_allowed:=true;
end;
exit:end;
@ @<Cases of |main_control| that don't...@>=
any_mode(after_group):begin get_token; save_for_after(cur_tok);
end;
@ Files for \.{\\read} are opened and closed by the |in_stream| command.
@<Put each...@>=
primitive("openin",in_stream,1);
@!@:open_in_}{\.{\\openin} primitive@>
primitive("closein",in_stream,0);
@!@:close_in_}{\.{\\closein} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
in_stream: if chr_code=0 then print_esc("closein")
else print_esc("openin");
@ @<Cases of |main_control| that don't...@>=
any_mode(in_stream): open_or_close_in;
@ @<Declare act...@>=
procedure open_or_close_in;
var c:0..1; {1 for \.{\\openin}, 0 for \.{\\closein}}
@!n:0..15; {stream number}
begin c:=cur_chr; scan_four_bit_int; n:=cur_val;
if read_open[n]<>closed then
begin a_close(read_file[n]); read_open[n]:=closed;
end;
if c<>0 then
begin scan_optional_equals; scan_file_name;
if cur_ext="" then cur_ext:=".tex";
pack_cur_name;
if a_open_in(read_file[n]) then read_open[n]:=just_open;
end;
end;
@ The user can issue messages to the terminal, regardless of the
current mode.
@<Cases of |main_control| that don't...@>=
any_mode(message):issue_message;
@ @<Put each...@>=
primitive("message",message,0);
@!@:message_}{\.{\\message} primitive@>
primitive("errmessage",message,1);
@!@:err_message_}{\.{\\errmessage} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
message: if chr_code=0 then print_esc("message")
else print_esc("errmessage");
@ @<Declare act...@>=
procedure issue_message;
var old_setting:0..max_selector; {holds |selector| setting}
@!c:0..1; {identifies \.{\\message} and \.{\\errmessage}}
@!s:str_number; {the message}
begin c:=cur_chr; link(garbage):=scan_toks(false,true);
old_setting:=selector; selector:=new_string;
token_show(def_ref); selector:=old_setting;
flush_list(def_ref);
str_room(1); s:=make_string;
if c=0 then @<Print string |s| on the terminal@>
else @<Print string |s| as an error message@>;
flush_string;
end;
@ @<Print string |s| on the terminal@>=
begin if term_offset+length(s)>max_print_line-2 then print_ln
else if (term_offset>0)or(file_offset>0) then print_char(" ");
slow_print(s); update_terminal;
end
@ If \.{\\errmessage} occurs often in |scroll_mode|, without user-defined
\.{\\errhelp}, we don't want to give a long help message each time. So we
give a verbose explanation only once.
@<Glob...@>=
@!long_help_seen:boolean; {has the long \.{\\errmessage} help been used?}
@ @<Set init...@>=long_help_seen:=false;
@ @<Print string |s| as an error message@>=
begin print_err(""); slow_print(s);
if err_help<>null then use_err_help:=true
else if long_help_seen then help1("(That was another \errmessage.)")
else begin if interaction<error_stop_mode then long_help_seen:=true;
help4("This error message was generated by an \errmessage")@/
("command, so I can't give any explicit help.")@/
("Pretend that you're Hercule Poirot: Examine all clues,")@/
@^Poirot, Hercule@>
("and deduce the truth by order and method.");
end;
error; use_err_help:=false;
end
@ The |error| routine calls on |give_err_help| if help is requested from
the |err_help| parameter.
@p procedure give_err_help;
begin token_show(err_help);
end;
@ The \.{\\uppercase} and \.{\\lowercase} commands are implemented by
building a token list and then changing the cases of the letters in it.
@<Cases of |main_control| that don't...@>=
any_mode(case_shift):shift_case;
@ @<Put each...@>=
primitive("lowercase",case_shift,lc_code_base);
@!@:lowercase_}{\.{\\lowercase} primitive@>
primitive("uppercase",case_shift,uc_code_base);
@!@:uppercase_}{\.{\\uppercase} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
case_shift:if chr_code=lc_code_base then print_esc("lowercase")
else print_esc("uppercase");
@ @<Declare act...@>=
procedure shift_case;
var b:pointer; {|lc_code_base| or |uc_code_base|}
@!p:pointer; {runs through the token list}
@!t:halfword; {token}
@!c:eight_bits; {character code}
begin b:=cur_chr; p:=scan_toks(false,false); p:=link(def_ref);
while p<>null do
begin @<Change the case of the token in |p|, if a change is appropriate@>;
p:=link(p);
end;
back_list(link(def_ref)); free_avail(def_ref); {omit reference count}
end;
@ When the case of a |chr_code| changes, we don't change the |cmd|.
We also change active characters, using the fact that
|cs_token_flag+active_base| is a multiple of~256.
@^data structure assumptions@>
@<Change the case of the token in |p|, if a change is appropriate@>=
t:=info(p);
if t<cs_token_flag+single_base then
begin c:=t mod 256;
if equiv(b+c)<>0 then info(p):=t-c+equiv(b+c);
end
@ We come finally to the last pieces missing from |main_control|, namely the
`\.{\\show}' commands that are useful when debugging.
@<Cases of |main_control| that don't...@>=
any_mode(xray): show_whatever;
@ @d show_code=0 { \.{\\show} }
@d show_box_code=1 { \.{\\showbox} }
@d show_the_code=2 { \.{\\showthe} }
@d show_lists_code=3 { \.{\\showlists} }
@<Put each...@>=
primitive("show",xray,show_code);
@!@:show_}{\.{\\show} primitive@>
primitive("showbox",xray,show_box_code);
@!@:show_box_}{\.{\\showbox} primitive@>
primitive("showthe",xray,show_the_code);
@!@:show_the_}{\.{\\showthe} primitive@>
primitive("showlists",xray,show_lists_code);
@!@:show_lists_code_}{\.{\\showlists} primitive@>
@ @<Cases of |print_cmd_chr|...@>=
xray: case chr_code of
show_box_code:print_esc("showbox");
show_the_code:print_esc("showthe");
show_lists_code:print_esc("showlists");
@<Cases of |xray| for |print_cmd_chr|@>@;@/
othercases print_esc("show")
endcases;
@ @<Declare act...@>=
procedure show_whatever;
label common_ending;
var p:pointer; {tail of a token list to show}
@!t:small_number; {type of conditional being shown}
@!m:normal..or_code; {upper bound on |fi_or_else| codes}
@!l:integer; {line where that conditional began}
@!n:integer; {level of \.{\\if...\\fi} nesting}
begin case cur_chr of
show_lists_code: begin begin_diagnostic; show_activities;
end;
show_box_code: @<Show the current contents of a box@>;
show_code: @<Show the current meaning of a token, then |goto common_ending|@>;
@<Cases for |show_whatever|@>@;@/
othercases @<Show the current value of some parameter or register,
then |goto common_ending|@>
endcases;@/
@<Complete a potentially long \.{\\show} command@>;
common_ending: if interaction<error_stop_mode then
begin help0; decr(error_count);
end
else if tracing_online>0 then
begin@t@>@;@/
help3("This isn't an error message; I'm just \showing something.")@/
("Type `I\show...' to show more (e.g., \show\cs,")@/
("\showthe\count10, \showbox255, \showlists).");
end
else begin@t@>@;@/
help5("This isn't an error message; I'm just \showing something.")@/
("Type `I\show...' to show more (e.g., \show\cs,")@/
("\showthe\count10, \showbox255, \showlists).")@/
("And type `I\tracingonline=1\show...' to show boxes and")@/
("lists on your terminal as well as in the transcript file.");
end;
error;
end;
@ @<Show the current meaning of a token...@>=
begin get_token;
if interaction=error_stop_mode then wake_up_terminal;
print_nl("> ");
if cur_cs<>0 then
begin sprint_cs(cur_cs); print_char("=");
end;
print_meaning; goto common_ending;
end
@ @<Cases of |print_cmd_chr|...@>=
undefined_cs: print("undefined");
call,long_call,outer_call,long_outer_call: begin n:=cmd-call;
if info(link(chr_code))=protected_token then n:=n+4;
if odd(n div 4) then print_esc("protected");
if odd(n) then print_esc("long");
if odd(n div 2) then print_esc("outer");
if n>0 then print_char(" ");
print("macro");
end;
end_template: print_esc("outer endtemplate");
@ @<Show the current contents of a box@>=
begin scan_register_num; fetch_box(p); begin_diagnostic;
print_nl("> \box"); print_int(cur_val); print_char("=");
if p=null then print("void")@+else show_box(p);
end
@ @<Show the current value of some parameter...@>=
begin p:=the_toks;
if interaction=error_stop_mode then wake_up_terminal;
print_nl("> "); token_show(temp_head);
flush_list(link(temp_head)); goto common_ending;
end
@ @<Complete a potentially long \.{\\show} command@>=
end_diagnostic(true); print_err("OK");
@.OK@>
if selector=term_and_log then if tracing_online<=0 then
begin selector:=term_only; print(" (see the transcript file)");
selector:=term_and_log;
end
@* \[50] Dumping and undumping the tables.
After \.{INITEX} has seen a collection of fonts and macros, it
can write all the necessary information on an auxiliary file so
that production versions of \TeX\ are able to initialize their
memory at high speed. The present section of the program takes
care of such output and input. We shall consider simultaneously
the processes of storing and restoring,
so that the inverse relation between them is clear.
@.INITEX@>
The global variable |format_ident| is a string that is printed right
after the |banner| line when \TeX\ is ready to start. For \.{INITEX} this
string says simply `\.{ (INITEX)}'; for other versions of \TeX\ it says,
for example, `\.{ (preloaded format=plain 1982.11.19)}', showing the year,
month, and day that the format file was created. We have |format_ident=0|
before \TeX's tables are loaded.
@<Glob...@>=
@!format_ident:str_number;
@ @<Set init...@>=
format_ident:=0;
@ @<Initialize table entries...@>=
format_ident:=" (INITEX)";
@ @<Declare act...@>=
@!init procedure store_fmt_file;
label found1,found2,done1,done2;
var j,@!k,@!l:integer; {all-purpose indices}
@!p,@!q: pointer; {all-purpose pointers}
@!x: integer; {something to dump}
@!w: four_quarters; {four ASCII codes}
begin @<If dumping is not allowed, abort@>;
@<Create the |format_ident|, open the format file,
and inform the user that dumping has begun@>;
@<Dump constants for consistency check@>;
@<Dump the string pool@>;
@<Dump the dynamic memory@>;
@<Dump the table of equivalents@>;
@<Dump the font information@>;
@<Dump the hyphenation tables@>;
@<Dump pdftex data@>;
@<Dump a couple more things and the closing check word@>;
@<Close the format file@>;
end;
tini
@ Corresponding to the procedure that dumps a format file, we have a function
that reads one in. The function returns |false| if the dumped format is
incompatible with the present \TeX\ table sizes, etc.
@d bad_fmt=6666 {go here if the format file is unacceptable}
@d too_small(#)==begin wake_up_terminal;
wterm_ln('---! Must increase the ',#);
@.Must increase the x@>
goto bad_fmt;
end
@p @t\4@>@<Declare the function called |open_fmt_file|@>@;
function load_fmt_file:boolean;
label bad_fmt,exit;
var j,@!k:integer; {all-purpose indices}
@!p,@!q: pointer; {all-purpose pointers}
@!x: integer; {something undumped}
@!w: four_quarters; {four ASCII codes}
begin @<Undump constants for consistency check@>;
@<Undump the string pool@>;
@<Undump the dynamic memory@>;
@<Undump the table of equivalents@>;
@<Undump the font information@>;
@<Undump the hyphenation tables@>;
@<Undump pdftex data@>;
@<Undump a couple more things and the closing check word@>;
prev_depth := pdf_ignored_dimen;
load_fmt_file:=true; return; {it worked!}
bad_fmt: wake_up_terminal;
wterm_ln('(Fatal format file error; I''m stymied)');
@.Fatal format file error@>
load_fmt_file:=false;
exit:end;
@ The user is not allowed to dump a format file unless |save_ptr=0|.
This condition implies that |cur_level=level_one|, hence
the |xeq_level| array is constant and it need not be dumped.
@<If dumping is not allowed, abort@>=
if save_ptr<>0 then
begin print_err("You can't dump inside a group");
@.You can't dump...@>
help1("`{...\dump}' is a no-no."); succumb;
end
@ Format files consist of |memory_word| items, and we use the following
macros to dump words of different types:
@d dump_wd(#)==begin fmt_file^:=#; put(fmt_file);@+end
@d dump_int(#)==begin fmt_file^.int:=#; put(fmt_file);@+end
@d dump_hh(#)==begin fmt_file^.hh:=#; put(fmt_file);@+end
@d dump_qqqq(#)==begin fmt_file^.qqqq:=#; put(fmt_file);@+end
@<Glob...@>=
@!fmt_file:word_file; {for input or output of format information}
@ The inverse macros are slightly more complicated, since we need to check
the range of the values we are reading in. We say `|undump(a)(b)(x)|' to
read an integer value |x| that is supposed to be in the range |a<=x<=b|.
System error messages should be suppressed when undumping.
@^system dependencies@>
@d undump_wd(#)==begin get(fmt_file); #:=fmt_file^;@+end
@d undump_int(#)==begin get(fmt_file); #:=fmt_file^.int;@+end
@d undump_hh(#)==begin get(fmt_file); #:=fmt_file^.hh;@+end
@d undump_qqqq(#)==begin get(fmt_file); #:=fmt_file^.qqqq;@+end
@d undump_end_end(#)==#:=x;@+end
@d undump_end(#)==(x>#) then goto bad_fmt@+else undump_end_end
@d undump(#)==begin undump_int(x); if (x<#) or undump_end
@d undump_size_end_end(#)==too_small(#)@+else undump_end_end
@d undump_size_end(#)==if x># then undump_size_end_end
@d undump_size(#)==begin undump_int(x);
if x<# then goto bad_fmt; undump_size_end
@ The next few sections of the program should make it clear how we use the
dump/undump macros.
@<Dump constants for consistency check@>=
dump_int(@$);@/
@<Dump the \eTeX\ state@>@/
dump_int(mem_bot);@/
dump_int(mem_top);@/
dump_int(eqtb_size);@/
dump_int(hash_prime);@/
dump_int(hyph_size)
@ Sections of a \.{WEB} program that are ``commented out'' still contribute
strings to the string pool; therefore \.{INITEX} and \TeX\ will have
the same strings. (And it is, of course, a good thing that they do.)
@.WEB@>
@^string pool@>
@<Undump constants for consistency check@>=
x:=fmt_file^.int;
if x<>@$ then goto bad_fmt; {check that strings are the same}
@/@<Undump the \eTeX\ state@>@/
undump_int(x);
if x<>mem_bot then goto bad_fmt;
undump_int(x);
if x<>mem_top then goto bad_fmt;
undump_int(x);
if x<>eqtb_size then goto bad_fmt;
undump_int(x);
if x<>hash_prime then goto bad_fmt;
undump_int(x);
if x<>hyph_size then goto bad_fmt
@ @d dump_four_ASCII==
w.b0:=qi(so(str_pool[k])); w.b1:=qi(so(str_pool[k+1]));
w.b2:=qi(so(str_pool[k+2])); w.b3:=qi(so(str_pool[k+3]));
dump_qqqq(w)
@<Dump the string pool@>=
dump_int(pool_ptr);
dump_int(str_ptr);
for k:=0 to str_ptr do dump_int(str_start[k]);
k:=0;
while k+4<pool_ptr do
begin dump_four_ASCII; k:=k+4;
end;
k:=pool_ptr-4; dump_four_ASCII;
print_ln; print_int(str_ptr); print(" strings of total length ");
print_int(pool_ptr)
@ @d undump_four_ASCII==
undump_qqqq(w);
str_pool[k]:=si(qo(w.b0)); str_pool[k+1]:=si(qo(w.b1));
str_pool[k+2]:=si(qo(w.b2)); str_pool[k+3]:=si(qo(w.b3))
@<Undump the string pool@>=
undump_size(0)(pool_size)('string pool size')(pool_ptr);
undump_size(0)(max_strings)('max strings')(str_ptr);
for k:=0 to str_ptr do undump(0)(pool_ptr)(str_start[k]);
k:=0;
while k+4<pool_ptr do
begin undump_four_ASCII; k:=k+4;
end;
k:=pool_ptr-4; undump_four_ASCII;
init_str_ptr:=str_ptr; init_pool_ptr:=pool_ptr
@ By sorting the list of available spaces in the variable-size portion of
|mem|, we are usually able to get by without having to dump very much
of the dynamic memory.
We recompute |var_used| and |dyn_used|, so that \.{INITEX} dumps valid
information even when it has not been gathering statistics.
@<Dump the dynamic memory@>=
sort_avail; var_used:=0;
dump_int(lo_mem_max); dump_int(rover);
if eTeX_ex then for k:=int_val to tok_val do dump_int(sa_root[k]);
p:=mem_bot; q:=rover; x:=0;
repeat for k:=p to q+1 do dump_wd(mem[k]);
x:=x+q+2-p; var_used:=var_used+q-p;
p:=q+node_size(q); q:=rlink(q);
until q=rover;
var_used:=var_used+lo_mem_max-p; dyn_used:=mem_end+1-hi_mem_min;@/
for k:=p to lo_mem_max do dump_wd(mem[k]);
x:=x+lo_mem_max+1-p;
dump_int(hi_mem_min); dump_int(avail);
for k:=hi_mem_min to mem_end do dump_wd(mem[k]);
x:=x+mem_end+1-hi_mem_min;
p:=avail;
while p<>null do
begin decr(dyn_used); p:=link(p);
end;
dump_int(var_used); dump_int(dyn_used);
print_ln; print_int(x);
print(" memory locations dumped; current usage is ");
print_int(var_used); print_char("&"); print_int(dyn_used)
@ @<Undump the dynamic memory@>=
undump(lo_mem_stat_max+1000)(hi_mem_stat_min-1)(lo_mem_max);
undump(lo_mem_stat_max+1)(lo_mem_max)(rover);
if eTeX_ex then for k:=int_val to tok_val do
undump(null)(lo_mem_max)(sa_root[k]);
p:=mem_bot; q:=rover;
repeat for k:=p to q+1 do undump_wd(mem[k]);
p:=q+node_size(q);
if (p>lo_mem_max)or((q>=rlink(q))and(rlink(q)<>rover)) then goto bad_fmt;
q:=rlink(q);
until q=rover;
for k:=p to lo_mem_max do undump_wd(mem[k]);
if mem_min<mem_bot-2 then {make more low memory available}
begin p:=llink(rover); q:=mem_min+1;
link(mem_min):=null; info(mem_min):=null; {we don't use the bottom word}
rlink(p):=q; llink(rover):=q;@/
rlink(q):=rover; llink(q):=p; link(q):=empty_flag;
node_size(q):=mem_bot-q;
end;
undump(lo_mem_max+1)(hi_mem_stat_min)(hi_mem_min);
undump(null)(mem_top)(avail); mem_end:=mem_top;
for k:=hi_mem_min to mem_end do undump_wd(mem[k]);
undump_int(var_used); undump_int(dyn_used)
@ @<Dump the table of equivalents@>=
@<Dump regions 1 to 4 of |eqtb|@>;
@<Dump regions 5 and 6 of |eqtb|@>;
dump_int(par_loc); dump_int(write_loc);@/
@<Dump the hash table@>
@ @<Undump the table of equivalents@>=
@<Undump regions 1 to 6 of |eqtb|@>;
undump(hash_base)(frozen_control_sequence)(par_loc);
par_token:=cs_token_flag+par_loc;@/
undump(hash_base)(frozen_control_sequence)(write_loc);@/
@<Undump the hash table@>
@ The table of equivalents usually contains repeated information, so we dump it
in compressed form: The sequence of $n+2$ values $(n,x_1,\ldots,x_n,m)$ in the
format file represents $n+m$ consecutive entries of |eqtb|, with |m| extra
copies of $x_n$, namely $(x_1,\ldots,x_n,x_n,\ldots,x_n)$.
@<Dump regions 1 to 4 of |eqtb|@>=
k:=active_base;
repeat j:=k;
while j<int_base-1 do
begin if (equiv(j)=equiv(j+1))and(eq_type(j)=eq_type(j+1))and@|
(eq_level(j)=eq_level(j+1)) then goto found1;
incr(j);
end;
l:=int_base; goto done1; {|j=int_base-1|}
found1: incr(j); l:=j;
while j<int_base-1 do
begin if (equiv(j)<>equiv(j+1))or(eq_type(j)<>eq_type(j+1))or@|
(eq_level(j)<>eq_level(j+1)) then goto done1;
incr(j);
end;
done1:dump_int(l-k);
while k<l do
begin dump_wd(eqtb[k]); incr(k);
end;
k:=j+1; dump_int(k-l);
until k=int_base
@ @<Dump regions 5 and 6 of |eqtb|@>=
repeat j:=k;
while j<eqtb_size do
begin if eqtb[j].int=eqtb[j+1].int then goto found2;
incr(j);
end;
l:=eqtb_size+1; goto done2; {|j=eqtb_size|}
found2: incr(j); l:=j;
while j<eqtb_size do
begin if eqtb[j].int<>eqtb[j+1].int then goto done2;
incr(j);
end;
done2:dump_int(l-k);
while k<l do
begin dump_wd(eqtb[k]); incr(k);
end;
k:=j+1; dump_int(k-l);
until k>eqtb_size
@ @<Undump regions 1 to 6 of |eqtb|@>=
k:=active_base;
repeat undump_int(x);
if (x<1)or(k+x>eqtb_size+1) then goto bad_fmt;
for j:=k to k+x-1 do undump_wd(eqtb[j]);
k:=k+x;
undump_int(x);
if (x<0)or(k+x>eqtb_size+1) then goto bad_fmt;
for j:=k to k+x-1 do eqtb[j]:=eqtb[k-1];
k:=k+x;
until k>eqtb_size
@ A different scheme is used to compress the hash table, since its lower
region is usually sparse. When |text(p)<>0| for |p<=hash_used|, we output
two words, |p| and |hash[p]|. The hash table is, of course, densely packed
for |p>=hash_used|, so the remaining entries are output in a~block.
@<Dump the hash table@>=
for p:=0 to prim_size do dump_hh(prim[p]);
dump_int(hash_used); cs_count:=frozen_control_sequence-1-hash_used;
for p:=hash_base to hash_used do if text(p)<>0 then
begin dump_int(p); dump_hh(hash[p]); incr(cs_count);
end;
for p:=hash_used+1 to undefined_control_sequence-1 do dump_hh(hash[p]);
dump_int(cs_count);@/
print_ln; print_int(cs_count); print(" multiletter control sequences")
@ @<Undump the hash table@>=
for p:=0 to prim_size do undump_hh(prim[p]);
undump(hash_base)(frozen_control_sequence)(hash_used); p:=hash_base-1;
repeat undump(p+1)(hash_used)(p); undump_hh(hash[p]);
until p=hash_used;
for p:=hash_used+1 to undefined_control_sequence-1 do undump_hh(hash[p]);
undump_int(cs_count)
@ @<Dump the font information@>=
dump_int(fmem_ptr);
for k:=0 to fmem_ptr-1 do dump_wd(font_info[k]);
dump_int(font_ptr);
for k:=null_font to font_ptr do
@<Dump the array info for internal font number |k|@>;
print_ln; print_int(fmem_ptr-7); print(" words of font info for ");
print_int(font_ptr-font_base); print(" preloaded font");
if font_ptr<>font_base+1 then print_char("s")
@ @<Undump the font information@>=
undump_size(7)(font_mem_size)('font mem size')(fmem_ptr);
for k:=0 to fmem_ptr-1 do undump_wd(font_info[k]);
undump_size(font_base)(font_max)('font max')(font_ptr);
for k:=null_font to font_ptr do
@<Undump the array info for internal font number |k|@>
@ @<Dump the array info for internal font number |k|@>=
begin dump_qqqq(font_check[k]);
dump_int(font_size[k]);
dump_int(font_dsize[k]);
dump_int(font_params[k]);@/
dump_int(hyphen_char[k]);
dump_int(skew_char[k]);@/
dump_int(font_name[k]);
dump_int(font_area[k]);@/
dump_int(font_bc[k]);
dump_int(font_ec[k]);@/
dump_int(char_base[k]);
dump_int(width_base[k]);
dump_int(height_base[k]);@/
dump_int(depth_base[k]);
dump_int(italic_base[k]);
dump_int(lig_kern_base[k]);@/
dump_int(kern_base[k]);
dump_int(exten_base[k]);
dump_int(param_base[k]);@/
dump_int(font_glue[k]);@/
dump_int(bchar_label[k]);
dump_int(font_bchar[k]);
dump_int(font_false_bchar[k]);@/
print_nl("\font"); print_esc(font_id_text(k)); print_char("=");
print_file_name(font_name[k],font_area[k],"");
if font_size[k]<>font_dsize[k] then
begin print(" at "); print_scaled(font_size[k]); print("pt");
end;
end
@ @<Undump the array info for internal font number |k|@>=
begin undump_qqqq(font_check[k]);@/
undump_int(font_size[k]);
undump_int(font_dsize[k]);
undump(min_halfword)(max_halfword)(font_params[k]);@/
undump_int(hyphen_char[k]);
undump_int(skew_char[k]);@/
undump(0)(str_ptr)(font_name[k]);
undump(0)(str_ptr)(font_area[k]);@/
undump(0)(255)(font_bc[k]);
undump(0)(255)(font_ec[k]);@/
undump_int(char_base[k]);
undump_int(width_base[k]);
undump_int(height_base[k]);@/
undump_int(depth_base[k]);
undump_int(italic_base[k]);
undump_int(lig_kern_base[k]);@/
undump_int(kern_base[k]);
undump_int(exten_base[k]);
undump_int(param_base[k]);@/
undump(min_halfword)(lo_mem_max)(font_glue[k]);@/
undump(0)(fmem_ptr-1)(bchar_label[k]);
undump(min_quarterword)(non_char)(font_bchar[k]);
undump(min_quarterword)(non_char)(font_false_bchar[k]);
end
@ @<Dump the hyphenation tables@>=
dump_int(hyph_count);
for k:=0 to hyph_size do if hyph_word[k]<>0 then
begin dump_int(k); dump_int(hyph_word[k]); dump_int(hyph_list[k]);
end;
print_ln; print_int(hyph_count); print(" hyphenation exception");
if hyph_count<>1 then print_char("s");
if trie_not_ready then init_trie;
dump_int(trie_max);
dump_int(hyph_start);
for k:=0 to trie_max do dump_hh(trie[k]);
dump_int(trie_op_ptr);
for k:=1 to trie_op_ptr do
begin dump_int(hyf_distance[k]);
dump_int(hyf_num[k]);
dump_int(hyf_next[k]);
end;
print_nl("Hyphenation trie of length "); print_int(trie_max);
@.Hyphenation trie...@>
print(" has "); print_int(trie_op_ptr); print(" op");
if trie_op_ptr<>1 then print_char("s");
print(" out of "); print_int(trie_op_size);
for k:=255 downto 0 do if trie_used[k]>min_quarterword then
begin print_nl(" "); print_int(qo(trie_used[k]));
print(" for language "); print_int(k);
dump_int(k); dump_int(qo(trie_used[k]));
end
@ Only ``nonempty'' parts of |op_start| need to be restored.
@<Undump the hyphenation tables@>=
undump(0)(hyph_size)(hyph_count);
for k:=1 to hyph_count do
begin undump(0)(hyph_size)(j);
undump(0)(str_ptr)(hyph_word[j]);
undump(min_halfword)(max_halfword)(hyph_list[j]);
end;
undump_size(0)(trie_size)('trie size')(j); @+init trie_max:=j;@+tini
undump(0)(j)(hyph_start);
for k:=0 to j do undump_hh(trie[k]);
undump_size(0)(trie_op_size)('trie op size')(j); @+init trie_op_ptr:=j;@+tini
for k:=1 to j do
begin undump(0)(63)(hyf_distance[k]); {a |small_number|}
undump(0)(63)(hyf_num[k]);
undump(min_quarterword)(max_quarterword)(hyf_next[k]);
end;
init for k:=0 to 255 do trie_used[k]:=min_quarterword;@+tini@;@/
k:=256;
while j>0 do
begin undump(0)(k-1)(k); undump(1)(j)(x);@+init trie_used[k]:=qi(x);@+tini@;@/
j:=j-x; op_start[k]:=qo(j);
end;
@!init trie_not_ready:=false @+tini
@ Store some of the pdftex data structures in the format. The idea here is
to ensure that any data structures referenced from pdftex-specific whatsit
nodes are retained. For the sake of simplicity and speed, all the filled parts
of |pdf_mem| and |obj_tab| are retained, in the present implementation. We also
retain three of the linked lists that start from |head_tab|, so that it is
possible to, say, load an image in the \.{INITEX} run and then reference it in a
\.{VIRTEX} run that uses the dumped format.
@<Dump pdftex data@>=
begin
dumpimagemeta; {the image information array }
dump_int(pdf_mem_size);
dump_int(pdf_mem_ptr);
for k:=1 to pdf_mem_ptr-1 do begin
dump_int(pdf_mem[k]);
end;
print_ln; print_int(pdf_mem_ptr-1); print(" words of pdfTeX memory");
dump_int(obj_tab_size);
dump_int(obj_ptr);
dump_int(sys_obj_ptr);
for k:=1 to sys_obj_ptr do begin
dump_int(obj_tab[k].int0);
dump_int(obj_tab[k].int1);
dump_int(obj_tab[k].int3);
dump_int(obj_tab[k].int4);
end;
print_ln; print_int(sys_obj_ptr); print(" indirect objects");
dump_int(pdf_obj_count);
dump_int(pdf_xform_count);
dump_int(pdf_ximage_count);
dump_int(head_tab[obj_type_obj]);
dump_int(head_tab[obj_type_xform]);
dump_int(head_tab[obj_type_ximage]);
dump_int(pdf_last_obj);
dump_int(pdf_last_xform);
dump_int(pdf_last_ximage);
dumptounicode;
end
@ And restoring the pdftex data structures from the format. The
two function arguments to |undumpimagemeta| have been restored
already in an earlier module.
@<Undump pdftex data@>=
begin
undumpimagemeta(pdf_major_version,pdf_minor_version,pdf_inclusion_errorlevel); {the image information array }
undump_int(pdf_mem_size);
pdf_mem := xrealloc_array(pdf_mem, integer, pdf_mem_size);
undump_int(pdf_mem_ptr);
for k:=1 to pdf_mem_ptr-1 do begin
undump_int(pdf_mem[k]);
end;
undump_int(obj_tab_size);
undump_int(obj_ptr);
undump_int(sys_obj_ptr);
for k:=1 to sys_obj_ptr do begin
undump_int(obj_tab[k].int0);
undump_int(obj_tab[k].int1);
obj_tab[k].int2 := -1;
undump_int(obj_tab[k].int3);
undump_int(obj_tab[k].int4);
end;
undump_int(pdf_obj_count);
undump_int(pdf_xform_count);
undump_int(pdf_ximage_count);
undump_int(head_tab[obj_type_obj]);
undump_int(head_tab[obj_type_xform]);
undump_int(head_tab[obj_type_ximage]);
undump_int(pdf_last_obj);
undump_int(pdf_last_xform);
undump_int(pdf_last_ximage);
undumptounicode;
end
@ We have already printed a lot of statistics, so we set |tracing_stats:=0|
to prevent them from appearing again.
@<Dump a couple more things and the closing check word@>=
dump_int(interaction); dump_int(format_ident); dump_int(69069);
tracing_stats:=0
@ @<Undump a couple more things and the closing check word@>=
undump(batch_mode)(error_stop_mode)(interaction);
undump(0)(str_ptr)(format_ident);
undump_int(x);
if (x<>69069)or eof(fmt_file) then goto bad_fmt
@ @<Create the |format_ident|...@>=
selector:=new_string;
print(" (preloaded format="); print(job_name); print_char(" ");
print_int(year); print_char(".");
print_int(month); print_char("."); print_int(day); print_char(")");
if interaction=batch_mode then selector:=log_only
else selector:=term_and_log;
str_room(1);
format_ident:=make_string;
pack_job_name(format_extension);
while not w_open_out(fmt_file) do
prompt_file_name("format file name",format_extension);
print_nl("Beginning to dump on file ");
@.Beginning to dump...@>
slow_print(w_make_name_string(fmt_file)); flush_string;
print_nl(""); slow_print(format_ident)
@ @<Close the format file@>=
w_close(fmt_file)
@* \[51] The main program.
This is it: the part of \TeX\ that executes all those procedures we have
written.
Well---almost. Let's leave space for a few more routines that we may
have forgotten.
@p @<Last-minute procedures@>
@ We have noted that there are two versions of \TeX82. One, called \.{INITEX},
@.INITEX@>
has to be run first; it initializes everything from scratch, without
reading a format file, and it has the capability of dumping a format file.
The other one is called `\.{VIRTEX}'; it is a ``virgin'' program that needs
@.VIRTEX@>
to input a format file in order to get started. \.{VIRTEX} typically has
more memory capacity than \.{INITEX}, because it does not need the space
consumed by the auxiliary hyphenation tables and the numerous calls on
|primitive|, etc.
The \.{VIRTEX} program cannot read a format file instantaneously, of course;
the best implementations therefore allow for production versions of \TeX\ that
not only avoid the loading routine for \PASCAL\ object code, they also have
a format file pre-loaded. This is impossible to do if we stick to standard
\PASCAL; but there is a simple way to fool many systems into avoiding the
initialization, as follows:\quad(1)~We declare a global integer variable
called |ready_already|. The probability is negligible that this
variable holds any particular value like 314159 when \.{VIRTEX} is first
loaded.\quad(2)~After we have read in a format file and initialized
everything, we set |ready_already:=314159|.\quad(3)~Soon \.{VIRTEX}
will print `\.*', waiting for more input; and at this point we
interrupt the program and save its core image in some form that the
operating system can reload speedily.\quad(4)~When that core image is
activated, the program starts again at the beginning; but now
|ready_already=314159| and all the other global variables have
their initial values too. The former chastity has vanished!
In other words, if we allow ourselves to test the condition
|ready_already=314159|, before |ready_already| has been
assigned a value, we can avoid the lengthy initialization. Dirty tricks
rarely pay off so handsomely.
@^dirty \PASCAL@>
@^system dependencies@>
On systems that allow such preloading, the standard program called \.{TeX}
should be the one that has \.{plain} format preloaded, since that agrees
with {\sl The \TeX book}. Other versions, e.g., \.{AmSTeX}, should also
@:TeXbook}{\sl The \TeX book@>
@.AmSTeX@>
@.plain@>
be provided for commonly used formats.
@<Glob...@>=
@!ready_already:integer; {a sacrifice of purity for economy}
@ Now this is really it: \TeX\ starts and ends here.
The initial test involving |ready_already| should be deleted if the
\PASCAL\ runtime system is smart enough to detect such a ``mistake.''
@^system dependencies@>
@p begin @!{|start_here|}
history:=fatal_error_stop; {in case we quit during initialization}
t_open_out; {open the terminal for output}
if ready_already=314159 then goto start_of_TEX;
@<Check the ``constant'' values...@>@;
if bad>0 then
begin wterm_ln('Ouch---my internal constants have been clobbered!',
'---case ',bad:1);
@.Ouch...clobbered@>
goto final_end;
end;
initialize; {set global variables to their starting values}
@!init if not get_strings_started then goto final_end;
init_prim; {call |primitive| for each primitive}
init_str_ptr:=str_ptr; init_pool_ptr:=pool_ptr; fix_date_and_time;
tini@/
ready_already:=314159;
start_of_TEX: @<Initialize the output routines@>;
@<Get the first line of input and prepare to start@>;
history:=spotless; {ready to go!}
main_control; {come to life}
final_cleanup; {prepare for death}
end_of_TEX: close_files_and_terminate;
final_end: ready_already:=0;
end.
@ Here we do whatever is needed to complete \TeX's job gracefully on the
local operating system. The code here might come into play after a fatal
error; it must therefore consist entirely of ``safe'' operations that
cannot produce error messages. For example, it would be a mistake to call
|str_room| or |make_string| at this time, because a call on |overflow|
might lead to an infinite loop.
@^system dependencies@>
(Actually there's one way to get error messages, via |prepare_mag|;
but that can't cause infinite recursion.)
@^recursion@>
If |final_cleanup| is bypassed, this program doesn't bother to close
the input files that may still be open.
@<Last-minute...@>=
procedure close_files_and_terminate;
label done, done1;
var a, b, c, i, j, k, l: integer; {all-purpose index}
is_root: boolean; {|pdf_last_pages| is root of Pages tree?}
is_names: boolean; {flag for name tree output: is it Names or Kids?}
root, outlines, threads, names_tree, dests: integer;
xref_offset_width, names_head, names_tail: integer;
begin @<Finish the extensions@>; new_line_char:=-1;
@!stat if tracing_stats>0 then @<Output statistics about this job@>;@;@+tats@/
wake_up_terminal;
if not fixed_pdfoutput_set then
fix_pdfoutput;
if fixed_pdfoutput > 0 then begin
if history = fatal_error_stop then begin
remove_pdffile;
print_err(" ==> Fatal error occurred, no output PDF file produced!")
end
else begin
@<Finish the PDF file@>;
if log_opened then
begin wlog_cr;
wlog_ln('PDF statistics:');
wlog_ln(' ',obj_ptr:1,' PDF objects out of ',obj_tab_size:1,
' (max. ',sup_obj_tab_size:1,')');
if pdf_os_cntr > 0 then begin
wlog(' ',((pdf_os_cntr - 1) * pdf_os_max_objs + pdf_os_objidx + 1):1,
' compressed objects within ',pdf_os_cntr:1,' object stream');
if pdf_os_cntr > 1 then
wlog('s');
wlog_cr;
end;
wlog_ln(' ',pdf_dest_names_ptr:1,' named destinations out of ',dest_names_size:1,
' (max. ',sup_dest_names_size:1,')');
wlog_ln(' ',pdf_mem_ptr:1,' words of extra memory for PDF output out of ',pdf_mem_size:1,
' (max. ',sup_pdf_mem_size:1,')');
end;
end;
end
else begin
@<Finish the \.{DVI} file@>;
end;
if log_opened then
begin wlog_cr; a_close(log_file); selector:=selector-2;
if selector=term_only then
begin print_nl("Transcript written on ");
@.Transcript written...@>
slow_print(log_name); print_char(".");
end;
end;
end;
@ The present section goes directly to the log file instead of using
|print| commands, because there's no need for these strings to take
up |str_pool| memory when a non-{\bf stat} version of \TeX\ is being used.
@<Output statistics...@>=
if log_opened then
begin wlog_ln(' ');
wlog_ln('Here is how much of TeX''s memory',' you used:');
@.Here is how much...@>
wlog(' ',str_ptr-init_str_ptr:1,' string');
if str_ptr<>init_str_ptr+1 then wlog('s');
wlog_ln(' out of ', max_strings-init_str_ptr:1);@/
wlog_ln(' ',pool_ptr-init_pool_ptr:1,' string characters out of ',
pool_size-init_pool_ptr:1);@/
wlog_ln(' ',lo_mem_max-mem_min+mem_end-hi_mem_min+2:1,@|
' words of memory out of ',mem_end+1-mem_min:1);@/
wlog_ln(' ',cs_count:1,' multiletter control sequences out of ',
hash_size:1);@/
wlog(' ',fmem_ptr:1,' words of font info for ',
font_ptr-font_base:1,' font');
if font_ptr<>font_base+1 then wlog('s');
wlog_ln(', out of ',font_mem_size:1,' for ',font_max-font_base:1);@/
wlog(' ',hyph_count:1,' hyphenation exception');
if hyph_count<>1 then wlog('s');
wlog_ln(' out of ',hyph_size:1);@/
wlog_ln(' ',max_in_stack:1,'i,',max_nest_stack:1,'n,',@|
max_param_stack:1,'p,',@|
max_buf_stack+1:1,'b,',@|
max_save_stack+6:1,'s stack positions out of ',@|
stack_size:1,'i,',
nest_size:1,'n,',
param_size:1,'p,',
buf_size:1,'b,',
save_size:1,'s');
end
@ We get to the |final_cleanup| routine when \.{\\end} or \.{\\dump} has
been scanned and |its_all_over|\kern-2pt.
@<Last-minute...@>=
procedure final_cleanup;
label exit;
var c:small_number; {0 for \.{\\end}, 1 for \.{\\dump}}
begin c:=cur_chr; if c<>1 then new_line_char:=-1;
if job_name=0 then open_log_file;
while input_ptr>0 do
if state=token_list then end_token_list@+else end_file_reading;
while open_parens>0 do
begin print(" )"); decr(open_parens);
end;
if cur_level>level_one then
begin print_nl("("); print_esc("end occurred ");
print("inside a group at level ");
@:end_}{\.{(\\end occurred...)}@>
print_int(cur_level-level_one); print_char(")");
if eTeX_ex then show_save_groups;
end;
while cond_ptr<>null do
begin print_nl("("); print_esc("end occurred ");
print("when "); print_cmd_chr(if_test,cur_if);
if if_line<>0 then
begin print(" on line "); print_int(if_line);
end;
print(" was incomplete)");
if_line:=if_line_field(cond_ptr);
cur_if:=subtype(cond_ptr); temp_ptr:=cond_ptr;
cond_ptr:=link(cond_ptr); free_node(temp_ptr,if_node_size);
end;
if history<>spotless then
if ((history=warning_issued)or(interaction<error_stop_mode)) then
if selector=term_and_log then
begin selector:=term_only;
print_nl("(see the transcript file for additional information)");
@.see the transcript file...@>
selector:=term_and_log;
end;
if c=1 then
begin @!init for c:=top_mark_code to split_bot_mark_code do
if cur_mark[c]<>null then delete_token_ref(cur_mark[c]);
if sa_mark<>null then
if do_marks(destroy_marks,0,sa_mark) then sa_mark:=null;
for c:=last_box_code to vsplit_code do flush_node_list(disc_ptr[c]);
if last_glue<>max_halfword then delete_glue_ref(last_glue);
store_fmt_file; return;@+tini@/
print_nl("(\dump is performed only by INITEX)"); return;
@:dump_}{\.{\\dump...only by INITEX}@>
end;
exit:end;
@ @<Last-minute...@>=
@!init procedure init_prim; {initialize all the primitives}
begin no_new_control_sequence:=false;
first:=0;
@<Put each...@>;
no_new_control_sequence:=true;
end;
tini
@ When we begin the following code, \TeX's tables may still contain garbage;
the strings might not even be present. Thus we must proceed cautiously to get
bootstrapped in.
But when we finish this part of the program, \TeX\ is ready to call on the
|main_control| routine to do its work.
@<Get the first line...@>=
begin @<Initialize the input routines@>;
@<Enable \eTeX, if requested@>@;@/
if (format_ident=0)or(buffer[loc]="&") then
begin if format_ident<>0 then initialize; {erase preloaded format}
if not open_fmt_file then goto final_end;
if not load_fmt_file then
begin w_close(fmt_file); goto final_end;
end;
w_close(fmt_file);
while (loc<limit)and(buffer[loc]=" ") do incr(loc);
end;
if (pdf_output_option <> 0) then pdf_output := pdf_output_value;
if (pdf_draftmode_option <> 0) then pdf_draftmode := pdf_draftmode_value;
pdf_init_map_file('pdftex.map');
if eTeX_ex then wterm_ln('entering extended mode');
if end_line_char_inactive then decr(limit)
else buffer[limit]:=end_line_char;
fix_date_and_time;@/
random_seed :=(microseconds*1000)+(epochseconds mod 1000000);@/
init_randoms(random_seed);@/
@<Compute the magic offset@>;
@<Initialize the print |selector|...@>;
if (loc<limit)and(cat_code(buffer[loc])<>escape) then start_input;
{\.{\\input} assumed}
end
@* \[52] Debugging.
Once \TeX\ is working, you should be able to diagnose most errors with
the \.{\\show} commands and other diagnostic features. But for the initial
stages of debugging, and for the revelation of really deep mysteries, you
can compile \TeX\ with a few more aids, including the \PASCAL\ runtime
checks and its debugger. An additional routine called |debug_help|
will also come into play when you type `\.D' after an error message;
|debug_help| also occurs just before a fatal error causes \TeX\ to succumb.
@^debugging@>
@^system dependencies@>
The interface to |debug_help| is primitive, but it is good enough when used
with a \PASCAL\ debugger that allows you to set breakpoints and to read
variables and change their values. After getting the prompt `\.{debug \#}', you
type either a negative number (this exits |debug_help|), or zero (this
goes to a location where you can set a breakpoint, thereby entering into
dialog with the \PASCAL\ debugger), or a positive number |m| followed by
an argument |n|. The meaning of |m| and |n| will be clear from the
program below. (If |m=13|, there is an additional argument, |l|.)
@.debug \#@>
@d breakpoint=888 {place where a breakpoint is desirable}
@<Last-minute...@>=
@!debug procedure debug_help; {routine to display various things}
label breakpoint,exit;
var k,@!l,@!m,@!n:integer;
begin clear_terminal;
loop begin wake_up_terminal;
print_nl("debug # (-1 to exit):"); update_terminal;
@.debug \#@>
read(term_in,m);
if m<0 then return
else if m=0 then
begin goto breakpoint;@/ {go to every declared label at least once}
breakpoint: m:=0; @{'BREAKPOINT'@}@/
end
else begin read(term_in,n);
case m of
@t\4@>@<Numbered cases for |debug_help|@>@;
othercases print("?")
endcases;
end;
end;
exit:end;
gubed
@ @<Numbered cases...@>=
1: print_word(mem[n]); {display |mem[n]| in all forms}
2: print_int(info(n));
3: print_int(link(n));
4: print_word(eqtb[n]);
5: print_word(font_info[n]);
6: print_word(save_stack[n]);
7: show_box(n);
{show a box, abbreviated by |show_box_depth| and |show_box_breadth|}
8: begin breadth_max:=10000; depth_threshold:=pool_size-pool_ptr-10;
show_node_list(n); {show a box in its entirety}
end;
9: show_token_list(n,null,1000);
10: slow_print(n);
11: check_mem(n>0); {check wellformedness; print new busy locations if |n>0|}
12: search_mem(n); {look for pointers to |n|}
13: begin read(term_in,l); print_cmd_chr(n,l);
end;
14: for k:=0 to n do print(buffer[k]);
15: begin font_in_short_display:=null_font; short_display(n);
end;
16: panicking:=not panicking;
@* \[53] Extensions.
The program above includes a bunch of ``hooks'' that allow further
capabilities to be added without upsetting \TeX's basic structure.
Most of these hooks are concerned with ``whatsit'' nodes, which are
intended to be used for special purposes; whenever a new extension to
\TeX\ involves a new kind of whatsit node, a corresponding change needs
to be made to the routines below that deal with such nodes,
but it will usually be unnecessary to make many changes to the
other parts of this program.
In order to demonstrate how extensions can be made, we shall treat
`\.{\\write}', `\.{\\openout}', `\.{\\closeout}', `\.{\\immediate}',
`\.{\\special}', and `\.{\\setlanguage}' as if they were extensions.
These commands are actually primitives of \TeX, and they should
appear in all implementations of the system; but let's try to imagine
that they aren't. Then the program below illustrates how a person
could add them.
Sometimes, of course, an extension will require changes to \TeX\ itself;
no system of hooks could be complete enough for all conceivable extensions.
The features associated with `\.{\\write}' are almost all confined to the
following paragraphs, but there are small parts of the |print_ln| and
|print_char| procedures that were introduced specifically to \.{\\write}
characters. Furthermore one of the token lists recognized by the scanner
is a |write_text|; and there are a few other miscellaneous places where we
have already provided for some aspect of \.{\\write}. The goal of a \TeX\
extender should be to minimize alterations to the standard parts of the
program, and to avoid them completely if possible. He or she should also
be quite sure that there's no easy way to accomplish the desired goals
with the standard features that \TeX\ already has. ``Think thrice before
extending,'' because that may save a lot of work, and it will also keep
incompatible extensions of \TeX\ from proliferating.
@^system dependencies@>
@^extensions to \TeX@>
@ First let's consider the format of whatsit nodes that are used to represent
the data associated with \.{\\write} and its relatives. Recall that a whatsit
has |type=whatsit_node|, and the |subtype| is supposed to distinguish
different kinds of whatsits. Each node occupies two or more words; the
exact number is immaterial, as long as it is readily determined from the
|subtype| or other data.
We shall introduce five |subtype| values here, corresponding to the
control sequences \.{\\openout}, \.{\\write}, \.{\\closeout}, \.{\\special}, and
\.{\\setlanguage}. The second word of I/O whatsits has a |write_stream| field
that identifies the write-stream number (0 to 15, or 16 for out-of-range and
positive, or 17 for out-of-range and negative).
In the case of \.{\\write} and \.{\\special}, there is also a field that
points to the reference count of a token list that should be sent. In the
case of \.{\\openout}, we need three words and three auxiliary subfields
to hold the string numbers for name, area, and extension.
@d write_node_size=2 {number of words in a write/whatsit node}
@d open_node_size=3 {number of words in an open/whatsit node}
@d open_node=0 {|subtype| in whatsits that represent files to \.{\\openout}}
@d write_node=1 {|subtype| in whatsits that represent things to \.{\\write}}
@d close_node=2 {|subtype| in whatsits that represent streams to \.{\\closeout}}
@d special_node=3 {|subtype| in whatsits that represent \.{\\special} things}
@d latespecial_node==4 {|subtype| in whatsits that represent \.{\\special} things expanded during output}
@d language_node=5 {|subtype| in whatsits that change the current language}
@d what_lang(#)==link(#+1) {language number, in the range |0..255|}
@d what_lhm(#)==type(#+1) {minimum left fragment, in the range |1..63|}
@d what_rhm(#)==subtype(#+1) {minimum right fragment, in the range |1..63|}
@d write_tokens(#) == link(#+1) {reference count of token list to write}
@d write_stream(#) == info(#+1) {stream number (0 to 17)}
@d open_name(#) == link(#+1) {string number of file name to open}
@d open_area(#) == info(#+2) {string number of file area for |open_name|}
@d open_ext(#) == link(#+2) {string number of file extension for |open_name|}
@ The sixteen possible \.{\\write} streams are represented by the |write_file|
array. The |j|th file is open if and only if |write_open[j]=true|. The last
two streams are special; |write_open[16]| represents a stream number
greater than 15, while |write_open[17]| represents a negative stream number,
and both of these variables are always |false|.
@<Glob...@>=
@!write_file:array[0..15] of alpha_file;
@!write_open:array[0..17] of boolean;
@ @<Set init...@>=
for k:=0 to 17 do write_open[k]:=false;
@ Extensions might introduce new command codes; but it's best to use
|extension| with a modifier, whenever possible, so that |main_control|
stays the same.
@d immediate_code=5 {command modifier for \.{\\immediate}}
@d set_language_code=6 {command modifier for \.{\\setlanguage}}
@d pdftex_first_extension_code = 7
@d pdf_literal_node == pdftex_first_extension_code + 0
@d pdf_lateliteral_node == pdftex_first_extension_code + 1
@d pdf_obj_code == pdftex_first_extension_code + 2
@d pdf_refobj_node == pdftex_first_extension_code + 3
@d pdf_xform_code == pdftex_first_extension_code + 4
@d pdf_refxform_node == pdftex_first_extension_code + 5
@d pdf_ximage_code == pdftex_first_extension_code + 6
@d pdf_refximage_node == pdftex_first_extension_code + 7
@d pdf_annot_node == pdftex_first_extension_code + 8
@d pdf_start_link_node == pdftex_first_extension_code + 9
@d pdf_end_link_node == pdftex_first_extension_code + 10
@d pdf_outline_code == pdftex_first_extension_code + 11
@d pdf_dest_node == pdftex_first_extension_code + 12
@d pdf_thread_node == pdftex_first_extension_code + 13
@d pdf_start_thread_node == pdftex_first_extension_code + 14
@d pdf_end_thread_node == pdftex_first_extension_code + 15
@d pdf_save_pos_node == pdftex_first_extension_code + 16
@d pdf_info_code == pdftex_first_extension_code + 17
@d pdf_catalog_code == pdftex_first_extension_code + 18
@d pdf_names_code == pdftex_first_extension_code + 19
@d pdf_font_attr_code == pdftex_first_extension_code + 20
@d pdf_include_chars_code == pdftex_first_extension_code + 21
@d pdf_map_file_code == pdftex_first_extension_code + 22
@d pdf_map_line_code == pdftex_first_extension_code + 23
@d pdf_trailer_code == pdftex_first_extension_code + 24
@d pdf_trailer_id_code == pdftex_first_extension_code + 25
@d reset_timer_code == pdftex_first_extension_code + 26
@d pdf_font_expand_code == pdftex_first_extension_code + 27
@d set_random_seed_code == pdftex_first_extension_code + 28
@d pdf_snap_ref_point_node == pdftex_first_extension_code + 29
@d pdf_snapy_node == pdftex_first_extension_code + 30
@d pdf_snapy_comp_node == pdftex_first_extension_code + 31
@d pdf_glyph_to_unicode_code == pdftex_first_extension_code + 32
@d pdf_colorstack_node == pdftex_first_extension_code + 33
@d pdf_setmatrix_node == pdftex_first_extension_code + 34
@d pdf_save_node == pdftex_first_extension_code + 35
@d pdf_restore_node == pdftex_first_extension_code + 36
@d pdf_nobuiltin_tounicode_code== pdftex_first_extension_code + 37
@d pdf_interword_space_on_node == pdftex_first_extension_code + 38
@d pdf_interword_space_off_node== pdftex_first_extension_code + 39
@d pdf_fake_space_node == pdftex_first_extension_code + 40
@d pdf_running_link_off_node == pdftex_first_extension_code + 41
@d pdf_running_link_on_node == pdftex_first_extension_code + 42
@d pdf_space_font_code == pdftex_first_extension_code + 43
@d pdftex_last_extension_code == pdftex_first_extension_code + 43
@<Put each...@>=
primitive("openout",extension,open_node);@/
@!@:open_out_}{\.{\\openout} primitive@>
primitive("write",extension,write_node); write_loc:=cur_val;@/
@!@:write_}{\.{\\write} primitive@>
primitive("closeout",extension,close_node);@/
@!@:close_out_}{\.{\\closeout} primitive@>
primitive("special",extension,special_node);@/
@!@:special_}{\.{\\special} primitive@>
primitive("immediate",extension,immediate_code);@/
@!@:immediate_}{\.{\\immediate} primitive@>
primitive("setlanguage",extension,set_language_code);@/
@!@:set_language_}{\.{\\setlanguage} primitive@>
primitive("pdfliteral",extension,pdf_literal_node);@/
@!@:pdf_literal_}{\.{\\pdfliteral} primitive@>
primitive("pdfcolorstack",extension,pdf_colorstack_node);@/
@!@:pdf_colorstack_}{\.{\\pdfcolorstack} primitive@>
primitive("pdfsetmatrix",extension,pdf_setmatrix_node);@/
@!@:pdf_setmatrix_}{\.{\\pdfsetmatrix} primitive@>
primitive("pdfsave",extension,pdf_save_node);@/
@!@:pdf_save_}{\.{\\pdfsave} primitive@>
primitive("pdfrestore",extension,pdf_restore_node);@/
@!@:pdf_restore_}{\.{\\pdfrestore} primitive@>
primitive("pdfobj",extension,pdf_obj_code);@/
@!@:pdf_obj_}{\.{\\pdfobj} primitive@>
primitive("pdfrefobj",extension,pdf_refobj_node);@/
@!@:pdf_refobj_}{\.{\\pdfrefobj} primitive@>
primitive("pdfxform",extension,pdf_xform_code);@/
@!@:pdf_xform_}{\.{\\pdfxform} primitive@>
primitive("pdfrefxform",extension,pdf_refxform_node);@/
@!@:pdf_refxform_}{\.{\\pdfrefxform} primitive@>
primitive("pdfximage",extension,pdf_ximage_code);@/
@!@:pdf_ximage_}{\.{\\pdfximage} primitive@>
primitive("pdfrefximage",extension,pdf_refximage_node);@/
@!@:pdf_refximage_}{\.{\\pdfrefximage} primitive@>
primitive("pdfannot",extension,pdf_annot_node);@/
@!@:pdf_annot_}{\.{\\pdfannot} primitive@>
primitive("pdfstartlink",extension,pdf_start_link_node);@/
@!@:pdf_start_link_}{\.{\\pdfstartlink} primitive@>
primitive("pdfendlink",extension,pdf_end_link_node);@/
@!@:pdf_end_link_}{\.{\\pdfendlink} primitive@>
primitive("pdfoutline",extension,pdf_outline_code);@/
@!@:pdf_outline_}{\.{\\pdfoutline} primitive@>
primitive("pdfdest",extension,pdf_dest_node);@/
@!@:pdf_dest_}{\.{\\pdfdest} primitive@>
primitive("pdfthread",extension,pdf_thread_node);@/
@!@:pdf_thread_}{\.{\\pdfthread} primitive@>
primitive("pdfstartthread",extension,pdf_start_thread_node);@/
@!@:pdf_start_thread_}{\.{\\pdfstartthread} primitive@>
primitive("pdfendthread",extension,pdf_end_thread_node);@/
@!@:pdf_end_thread_}{\.{\\pdfendthread} primitive@>
primitive("pdfsavepos",extension,pdf_save_pos_node);@/
@!@:pdf_save_pos_}{\.{\\pdfsavepos} primitive@>
primitive("pdfsnaprefpoint",extension,pdf_snap_ref_point_node);@/
@!@:pdf_snap_ref_point_}{\.{\\pdfsnaprefpoint} primitive@>
primitive("pdfsnapy",extension,pdf_snapy_node);@/
@!@:pdf_snapy_}{\.{\\pdfsnapy} primitive@>
primitive("pdfsnapycomp",extension,pdf_snapy_comp_node);@/
@!@:pdf_snapy_comp_}{\.{\\pdfsnapycomp} primitive@>
primitive("pdfinfo",extension,pdf_info_code);@/
@!@:pdf_info_}{\.{\\pdfinfo} primitive@>
primitive("pdfcatalog",extension,pdf_catalog_code);@/
@!@:pdf_catalog_}{\.{\\pdfcatalog} primitive@>
primitive("pdfnames",extension,pdf_names_code);@/
@!@:pdf_names_}{\.{\\pdfnames} primitive@>
primitive("pdfincludechars",extension,pdf_include_chars_code);@/
@!@:pdf_include_chars_}{\.{\\pdfincludechars} primitive@>
primitive("pdffontattr",extension,pdf_font_attr_code);@/
@!@:pdf_font_attr_}{\.{\\pdffontattr} primitive@>
primitive("pdfmapfile",extension,pdf_map_file_code);@/
@!@:pdf_map_file_}{\.{\\pdfmapfile} primitive@>
primitive("pdfmapline",extension,pdf_map_line_code);@/
@!@:pdf_map_line_}{\.{\\pdfmapline} primitive@>
primitive("pdftrailer",extension,pdf_trailer_code);@/
@!@:pdf_trailer_}{\.{\\pdftrailer} primitive@>
primitive("pdftrailerid",extension,pdf_trailer_id_code);@/
@!@:pdf_trailer_id_}{\.{\\pdftrailerid} primitive@>
primitive("pdfresettimer",extension,reset_timer_code);@/
@!@:reset_timer_}{\.{\\pdfresettimer} primitive@>
primitive("pdfsetrandomseed",extension,set_random_seed_code);@/
@!@:set_random_seed_code}{\.{\\pdfsetrandomseed} primitive@>
primitive("pdffontexpand",extension,pdf_font_expand_code);@/
@!@:pdf_font_expand_}{\.{\\pdffontexpand} primitive@>
primitive("pdfglyphtounicode",extension,pdf_glyph_to_unicode_code);@/
@!@:pdf_glyph_to_unicode_}{\.{\\pdfglyphtounicode} primitive@>
primitive("pdfnobuiltintounicode",extension,pdf_nobuiltin_tounicode_code);@/
@!@:pdf_nobuiltin_tounicode_}{\.{\\pdfnobuiltintounicode} primitive@>
primitive("pdfinterwordspaceon",extension,pdf_interword_space_on_node);@/
@!@:pdf_interword_space_on_}{\.{\\pdfinterwordspaceon} primitive@>
primitive("pdfinterwordspaceoff",extension,pdf_interword_space_off_node);@/
@!@:pdf_interword_space_off_}{\.{\\pdfinterwordspaceoff} primitive@>
primitive("pdffakespace",extension,pdf_fake_space_node);@/
@!@:pdf_fake_space_}{\.{\\pdffakespace} primitive@>
primitive("pdfrunninglinkoff",extension,pdf_running_link_off_node);@/
@!@:pdf_running_link_off_}{\.{\\pdfrunninglinkoff} primitive@>
primitive("pdfrunninglinkon",extension,pdf_running_link_on_node);@/
@!@:pdf_running_link_on_}{\.{\\pdfrunninglinkon} primitive@>
primitive("pdfspacefont",extension,pdf_space_font_code);@/
@!@:pdf_space_font_}{\.{\\pdfspacefont} primitive@>
@ The variable |write_loc| just introduced is used to provide an
appropriate error message in case of ``runaway'' write texts.
@<Glob...@>=
@!write_loc:pointer; {|eqtb| address of \.{\\write}}
@ @<Cases of |print_cmd_chr|...@>=
extension: case chr_code of
open_node:print_esc("openout");
write_node:print_esc("write");
close_node:print_esc("closeout");
special_node:print_esc("special");
immediate_code:print_esc("immediate");
set_language_code:print_esc("setlanguage");
pdf_annot_node: print_esc("pdfannot");
pdf_catalog_code: print_esc("pdfcatalog");
pdf_dest_node: print_esc("pdfdest");
pdf_end_link_node: print_esc("pdfendlink");
pdf_end_thread_node: print_esc("pdfendthread");
pdf_font_attr_code: print_esc("pdffontattr");
pdf_font_expand_code: print_esc("pdffontexpand");
pdf_include_chars_code: print_esc("pdfincludechars");
pdf_info_code: print_esc("pdfinfo");
pdf_literal_node: print_esc("pdfliteral");
pdf_colorstack_node: print_esc("pdfcolorstack");
pdf_setmatrix_node: print_esc("pdfsetmatrix");
pdf_save_node: print_esc("pdfsave");
pdf_restore_node: print_esc("pdfrestore");
pdf_map_file_code: print_esc("pdfmapfile");
pdf_map_line_code: print_esc("pdfmapline");
pdf_names_code: print_esc("pdfnames");
pdf_obj_code: print_esc("pdfobj");
pdf_outline_code: print_esc("pdfoutline");
pdf_refobj_node: print_esc("pdfrefobj");
pdf_refxform_node: print_esc("pdfrefxform");
pdf_refximage_node: print_esc("pdfrefximage");
pdf_save_pos_node: print_esc("pdfsavepos");
pdf_snap_ref_point_node: print_esc("pdfsnaprefpoint");
pdf_snapy_comp_node: print_esc("pdfsnapycomp");
pdf_snapy_node: print_esc("pdfsnapy");
pdf_start_link_node: print_esc("pdfstartlink");
pdf_start_thread_node: print_esc("pdfstartthread");
pdf_thread_node: print_esc("pdfthread");
pdf_trailer_code: print_esc("pdftrailer");
pdf_trailer_id_code: print_esc("pdftrailerid");
pdf_xform_code: print_esc("pdfxform");
pdf_ximage_code: print_esc("pdfximage");
reset_timer_code: print_esc("pdfresettimer");
set_random_seed_code: print_esc("pdfsetrandomseed");
pdf_nobuiltin_tounicode_code: print_esc("pdfnobuiltintounicode");
pdf_glyph_to_unicode_code: print_esc("pdfglyphtounicode");
pdf_interword_space_on_node: print_esc("pdfinterwordspaceon");
pdf_interword_space_off_node: print_esc("pdfinterwordspaceoff");
pdf_fake_space_node: print_esc("pdffakespace");
pdf_running_link_off_node: print_esc("pdfrunninglinkoff");
pdf_running_link_on_node: print_esc("pdfrunninglinkon");
pdf_space_font_code: print_esc("pdfspacefont");
othercases print("[unknown extension!]")
endcases;
@ When an |extension| command occurs in |main_control|, in any mode,
the |do_extension| routine is called.
@<Cases of |main_control| that are for extensions...@>=
any_mode(extension):do_extension;
@ @<Declare act...@>=
@t\4@>@<Declare procedures needed in |do_extension|@>@;
procedure do_extension;
var i,@!j,@!k:integer; {all-purpose integers}
@!p,@!q,@!r:pointer; {all-purpose pointers}
begin case cur_chr of
open_node:@<Implement \.{\\openout}@>;
write_node:@<Implement \.{\\write}@>;
close_node:@<Implement \.{\\closeout}@>;
special_node:@<Implement \.{\\special}@>;
immediate_code:@<Implement \.{\\immediate}@>;
set_language_code:@<Implement \.{\\setlanguage}@>;
pdf_annot_node: @<Implement \.{\\pdfannot}@>;
pdf_catalog_code: @<Implement \.{\\pdfcatalog}@>;
pdf_dest_node: @<Implement \.{\\pdfdest}@>;
pdf_end_link_node: @<Implement \.{\\pdfendlink}@>;
pdf_end_thread_node: @<Implement \.{\\pdfendthread}@>;
pdf_font_attr_code: @<Implement \.{\\pdffontattr}@>;
pdf_font_expand_code: @<Implement \.{\\pdffontexpand}@>;
pdf_include_chars_code: @<Implement \.{\\pdfincludechars}@>;
pdf_info_code: @<Implement \.{\\pdfinfo}@>;
pdf_literal_node: @<Implement \.{\\pdfliteral}@>;
pdf_colorstack_node: @<Implement \.{\\pdfcolorstack}@>;
pdf_setmatrix_node: @<Implement \.{\\pdfsetmatrix}@>;
pdf_save_node: @<Implement \.{\\pdfsave}@>;
pdf_restore_node: @<Implement \.{\\pdfrestore}@>;
pdf_map_file_code: @<Implement \.{\\pdfmapfile}@>;
pdf_map_line_code: @<Implement \.{\\pdfmapline}@>;
pdf_names_code: @<Implement \.{\\pdfnames}@>;
pdf_obj_code: @<Implement \.{\\pdfobj}@>;
pdf_outline_code: @<Implement \.{\\pdfoutline}@>;
pdf_refobj_node: @<Implement \.{\\pdfrefobj}@>;
pdf_refxform_node: @<Implement \.{\\pdfrefxform}@>;
pdf_refximage_node: @<Implement \.{\\pdfrefximage}@>;
pdf_save_pos_node: @<Implement \.{\\pdfsavepos}@>;
pdf_snap_ref_point_node: @<Implement \.{\\pdfsnaprefpoint}@>;
pdf_snapy_comp_node: @<Implement \.{\\pdfsnapycomp}@>;
pdf_snapy_node: @<Implement \.{\\pdfsnapy}@>;
pdf_start_link_node: @<Implement \.{\\pdfstartlink}@>;
pdf_start_thread_node: @<Implement \.{\\pdfstartthread}@>;
pdf_thread_node: @<Implement \.{\\pdfthread}@>;
pdf_trailer_code: @<Implement \.{\\pdftrailer}@>;
pdf_trailer_id_code: @<Implement \.{\\pdftrailerid}@>;
pdf_xform_code: @<Implement \.{\\pdfxform}@>;
pdf_ximage_code: @<Implement \.{\\pdfximage}@>;
reset_timer_code: @<Implement \.{\\pdfresettimer}@>;
set_random_seed_code: @<Implement \.{\\pdfsetrandomseed}@>;
pdf_glyph_to_unicode_code: @<Implement \.{\\pdfglyphtounicode}@>;
pdf_nobuiltin_tounicode_code: @<Implement \.{\\pdfnobuiltintounicode}@>;
pdf_interword_space_on_node: @<Implement \.{\\pdfinterwordspaceon}@>;
pdf_interword_space_off_node: @<Implement \.{\\pdfinterwordspaceoff}@>;
pdf_fake_space_node: @<Implement \.{\\pdffakespace}@>;
pdf_running_link_off_node: @<Implement \.{\\pdfrunninglinkoff}@>;
pdf_running_link_on_node: @<Implement \.{\\pdfrunninglinkon}@>;
pdf_space_font_code: @<Implement \.{\\pdfspacefont}@>;
othercases confusion("ext1")
@:this can't happen ext1}{\quad ext1@>
endcases;
end;
@ Here is a subroutine that creates a whatsit node having a given |subtype|
and a given number of words. It initializes only the first word of the whatsit,
and appends it to the current list.
@<Declare procedures needed in |do_extension|@>=
procedure new_whatsit(@!s:small_number;@!w:small_number);
var p:pointer; {the new node}
begin p:=get_node(w); type(p):=whatsit_node; subtype(p):=s;
link(tail):=p; tail:=p;
end;
@ The next subroutine uses |cur_chr| to decide what sort of whatsit is
involved, and also inserts a |write_stream| number.
@<Declare procedures needed in |do_ext...@>=
procedure new_write_whatsit(@!w:small_number);
begin new_whatsit(cur_chr,w);
if w<>write_node_size then scan_four_bit_int
else begin scan_int;
if cur_val<0 then cur_val:=17
else if cur_val>15 then cur_val:=16;
end;
write_stream(tail):=cur_val;
end;
@ @<Implement \.{\\openout}@>=
begin new_write_whatsit(open_node_size);
scan_optional_equals; scan_file_name;@/
open_name(tail):=cur_name; open_area(tail):=cur_area; open_ext(tail):=cur_ext;
end
@ When `\.{\\write 12\{...\}}' appears, we scan the token list `\.{\{...\}}'
without expanding its macros; the macros will be expanded later when this
token list is rescanned.
@<Implement \.{\\write}@>=
begin k:=cur_cs; new_write_whatsit(write_node_size);@/
cur_cs:=k; p:=scan_toks(false,false); write_tokens(tail):=def_ref;
end
@ @<Implement \.{\\closeout}@>=
begin new_write_whatsit(write_node_size); write_tokens(tail):=null;
end
@ When `\.{\\special\{...\}}' appears, we expand the macros in the token
list as in \.{\\xdef} and \.{\\mark}. When marked with \.{shipout}, we keep
tokens unexpanded for now.
Unfortunately, the |write_stream(tail):=null| done here is not a valid
assignment in Web2C, because |null| (a.k.a.\ |min_halfword|) is a large
negative number ($-268435455 = -@"FFFFFFF$, set in \.{tex.ch}); too
large to fit in the {\bf short} structure element that's being assigned.
The warning from gcc~8.5.0 was:
\.{pdftex0.c: In function 'doextension':}
\.{pdftex0.c:37849:40: warning: overflow in conversion from 'long int' to 'short int'}
\.{changes value from '-268435455' to '1' [-Woverflow]}\hfil\break
\.{ mem [curlist .tailfield + 1 ].hh.b0 = -268435455L ;}
The correct thing to do is not immediately evident. However, for Web2C,
it does not matter, because these lines are changed for enc\TeX, in
\.{enctex2.ch}, and now zero is assigned, instead of |null|.
@<Implement \.{\\special}@>=
begin if scan_keyword("shipout") then
begin new_whatsit(latespecial_node,write_node_size); write_stream(tail):=null;
p:=scan_toks(false,false); write_tokens(tail):=def_ref;
end else
begin new_whatsit(special_node,write_node_size); write_stream(tail):=null;
p:=scan_toks(false,true); write_tokens(tail):=def_ref;
end; end
@ @<Implement \.{\\pdffontexpand}@>=
read_expand_font
@ The following macros are needed for further manipulation with whatsit nodes
for \pdfTeX{} extensions (copying, destroying, etc.).
@d add_action_ref(#) == incr(pdf_action_refcount(#)) {increase count of
references to this action}
@d delete_action_ref(#) == {decrease count of references to this
action; free it if there is no reference to this action}
begin
if pdf_action_refcount(#) = null then begin
if pdf_action_type(#) = pdf_action_user then
delete_token_ref(pdf_action_user_tokens(#))
else begin
if pdf_action_file(#) <> null then
delete_token_ref(pdf_action_file(#));
if pdf_action_type(#) = pdf_action_page then
delete_token_ref(pdf_action_page_tokens(#))
else if (pdf_action_named_id(#) and 1) = 1 then
delete_token_ref(pdf_action_id(#));
if (pdf_action_named_id(#) and 2) = 2 then
delete_token_ref(pdf_action_struct_id(#));
end;
free_node(#, pdf_action_size);
end
else
decr(pdf_action_refcount(#));
end
@ We have to check whether \.{\\pdfoutput} is set for using \pdfTeX{}
extensions.
@<Declare procedures needed in |do_ext...@>=
procedure check_pdfoutput(s: str_number; is_error : boolean);
begin
if pdf_output <= 0 then
begin
if is_error then
pdf_error(s, "not allowed in DVI mode (\pdfoutput <= 0)")
else
pdf_warning(s, "not allowed in DVI mode (\pdfoutput <= 0); ignoring it", true, true);
end
end;
procedure scan_pdf_ext_toks;
begin
call_func(scan_toks(false, true)); {like \.{\\special}}
end;
procedure scan_pdf_ext_late_toks;
begin
call_func(scan_toks(false, false)); {like \.{\\special}, but doesn't expand}
end;
procedure compare_strings; {to implement \.{\\pdfstrcmp}}
label done;
var s1, s2: str_number;
i1, i2, j1, j2: pool_pointer;
save_cur_cs: pointer;
begin
save_cur_cs:=cur_cs; call_func(scan_toks(false, true));
s1 := tokens_to_string(def_ref);
delete_token_ref(def_ref);
cur_cs:=save_cur_cs; call_func(scan_toks(false, true));
s2 := tokens_to_string(def_ref);
delete_token_ref(def_ref);
i1 := str_start[s1];
j1 := str_start[s1 + 1];
i2 := str_start[s2];
j2 := str_start[s2 + 1];
while (i1 < j1) and (i2 < j2) do begin
if str_pool[i1] < str_pool[i2] then begin
cur_val := -1;
goto done;
end;
if str_pool[i1] > str_pool[i2] then begin
cur_val := 1;
goto done;
end;
incr(i1);
incr(i2);
end;
if (i1 = j1) and (i2 = j2) then
cur_val := 0
else if i1 < j1 then
cur_val := 1
else
cur_val := -1;
done:
flush_str(s2);
flush_str(s1);
cur_val_level := int_val;
end;
@ @<Implement \.{\\pdfliteral}@>=
begin
check_pdfoutput("\pdfliteral", true);
if scan_keyword("shipout") then k:=pdf_lateliteral_node
else k:=pdf_literal_node;
new_whatsit(k, write_node_size);
if scan_keyword("direct") then
pdf_literal_mode(tail) := direct_always
else if scan_keyword("page") then
pdf_literal_mode(tail) := direct_page
else
pdf_literal_mode(tail) := set_origin;
if k=pdf_literal_node then
scan_pdf_ext_toks else scan_pdf_ext_late_toks;
pdf_literal_data(tail) := def_ref;
end
@ @<Implement \.{\\pdfcolorstack}@>=
begin
check_pdfoutput("\pdfcolorstack", true);
{Scan and check the stack number and store in |cur_val|}
scan_int;
if cur_val >= colorstackused then begin
print_err("Unknown color stack number ");
print_int(cur_val);
@.Unknown color stack@>
help3("Allocate and initialize a color stack with \\pdfcolorstackinit.")@/
("I'll use default color stack 0 here.")@/
("Proceed, with fingers crossed.");
error;
cur_val := 0;
end;
if cur_val < 0 then begin
print_err("Invalid negative color stack number");
@.Invalid negative color stack number@>
help2("I'll use default color stack 0 here.")@/
("Proceed, with fingers crossed.");
error;
cur_val := 0;
end;
{Scan the command and store in i, j holds the node size}
if scan_keyword("set") then begin
i := colorstack_set;
j := pdf_colorstack_setter_node_size;
end
else if scan_keyword("push") then begin
i := colorstack_push;
j := pdf_colorstack_setter_node_size;
end
else if scan_keyword("pop") then begin
i := colorstack_pop;
j := pdf_colorstack_getter_node_size;
end
else if scan_keyword("current") then begin
i := colorstack_current;
j := pdf_colorstack_getter_node_size;
end
else begin
i := -1; {error}
end;
if i >= 0 then begin
new_whatsit(pdf_colorstack_node, j);
pdf_colorstack_stack(tail) := cur_val;
pdf_colorstack_cmd(tail) := i;
if i <= colorstack_data then begin
scan_pdf_ext_toks;
pdf_colorstack_data(tail) := def_ref;
end;
end
else begin
print_err("Color stack action is missing");
@.Color stack action is missing@>
help3("The expected actions for \pdfcolorstack:")@/
(" set, push, pop, current")@/
("I'll ignore the color stack command.");
error;
end
end
@ @<Implement \.{\\pdfsetmatrix}@>=
begin
check_pdfoutput("\pdfsetmatrix", true);
new_whatsit(pdf_setmatrix_node, pdf_setmatrix_node_size);
scan_pdf_ext_toks;
pdf_setmatrix_data(tail) := def_ref;
end
@ @<Implement \.{\\pdfsave}@>=
begin
check_pdfoutput("\pdfsave", true);
new_whatsit(pdf_save_node, pdf_save_node_size);
end
@ @<Implement \.{\\pdfrestore}@>=
begin
check_pdfoutput("\pdfrestore", true);
new_whatsit(pdf_restore_node, pdf_restore_node_size);
end
@ The \.{\\pdfobj} primitive is used to create a ``raw'' object in the PDF
output file. The object contents will be hold in memory and will be written
out only when the object is referenced by \.{\\pdfrefobj}. When \.{\\pdfobj}
is used with \.{\\immediate}, the object contents will be written out
immediately. Objects referenced in the current page are appended into
|pdf_obj_list|.
@<Glob...@>=
@!pdf_last_obj: integer;
@ @<Implement \.{\\pdfobj}@>=
begin
check_pdfoutput("\pdfobj", true);
if scan_keyword("reserveobjnum") then begin
@<Scan an optional space@>;
incr(pdf_obj_count);
pdf_create_obj(obj_type_obj, pdf_obj_count);
pdf_last_obj := obj_ptr;
end
else begin
k := -1;
if scan_keyword("useobjnum") then begin
scan_int;
k := cur_val;
if (k <= 0) or (k > obj_ptr) or (obj_data_ptr(k) <> 0) then begin
pdf_warning("\pdfobj", "invalid object number being ignored", true, true);
pdf_retval := -1; {signal the problem}
k := -1; {will be generated again}
end;
end;
if k < 0 then begin
incr(pdf_obj_count);
pdf_create_obj(obj_type_obj, pdf_obj_count);
k := obj_ptr;
end;
obj_data_ptr(k) := pdf_get_mem(pdfmem_obj_size);
if scan_keyword("stream") then begin
obj_obj_is_stream(k) := 1;
if scan_keyword("attr") then begin
scan_pdf_ext_toks;
obj_obj_stream_attr(k) := def_ref;
end
else
obj_obj_stream_attr(k) := null;
end
else
obj_obj_is_stream(k) := 0;
if scan_keyword("file") then
obj_obj_is_file(k) := 1
else
obj_obj_is_file(k) := 0;
scan_pdf_ext_toks;
obj_obj_data(k) := def_ref;
pdf_last_obj := k;
end;
end
@ We need to check whether the referenced object exists.
@<Declare procedures that need to be declared forward for \pdfTeX@>=
function prev_rightmost(s, e: pointer): pointer;
{finds the node preceding the rightmost node |e|; |s| is some node
before |e|}
var p: pointer;
begin
prev_rightmost := null;
p := s;
if p = null then
return;
while link(p) <> e do begin
p := link(p);
if p = null then
return;
end;
prev_rightmost := p;
end;
procedure pdf_check_obj(t, n: integer);
var k: integer;
begin
k := head_tab[t];
while (k <> 0) and (k <> n) do
k := obj_link(k);
if k = 0 then
pdf_error("ext1", "cannot find referenced object");
end;
@ @<Implement \.{\\pdfrefobj}@>=
begin
check_pdfoutput("\pdfrefobj", true);
scan_int;
pdf_check_obj(obj_type_obj, cur_val);
new_whatsit(pdf_refobj_node, pdf_refobj_node_size);
pdf_obj_objnum(tail) := cur_val;
end
@ \.{\\pdfxform} and \.{\\pdfrefxform} are similar to \.{\\pdfobj} and
\.{\\pdfrefobj}.
@<Glob...@>=
@!pdf_last_xform: integer;
@ @<Implement \.{\\pdfxform}@>=
begin
check_pdfoutput("\pdfxform", true);
incr(pdf_xform_count);
pdf_create_obj(obj_type_xform, pdf_xform_count);
k := obj_ptr;
obj_data_ptr(k) := pdf_get_mem(pdfmem_xform_size);
if scan_keyword("attr") then begin
scan_pdf_ext_toks;
obj_xform_attr(k) := def_ref;
end
else
obj_xform_attr(k) := null;
if scan_keyword("resources") then begin
scan_pdf_ext_toks;
obj_xform_resources(k) := def_ref;
end
else
obj_xform_resources(k) := null;
scan_register_num;
fetch_box(p);
if p = null then
pdf_error("ext1", "\pdfxform cannot be used with a void box");
obj_xform_width(k) := width(p);
obj_xform_height(k) := height(p);
obj_xform_depth(k) := depth(p);
obj_xform_box(k) := p; {save pointer to the box}
change_box(null);
pdf_last_xform := k;
end
@ @<Implement \.{\\pdfrefxform}@>=
begin
check_pdfoutput("\pdfrefxform", true);
scan_int;
pdf_check_obj(obj_type_xform, cur_val);
new_whatsit(pdf_refxform_node, pdf_refxform_node_size);
pdf_xform_objnum(tail) := cur_val;
pdf_width(tail) := obj_xform_width(cur_val);
pdf_height(tail) := obj_xform_height(cur_val);
pdf_depth(tail) := obj_xform_depth(cur_val);
end
@ \.{\\pdfximage} and \.{\\pdfrefximage} are similar to \.{\\pdfxform} and
\.{\\pdfrefxform}. As we have to scan |<rule spec>| quite often, it is better
have a |rule_node| that holds the most recently scanned |<rule spec>|.
@<Glob...@>=
@!pdf_last_ximage: integer;
@!pdf_last_ximage_pages: integer;
@!pdf_last_ximage_colordepth: integer;
@!alt_rule: pointer;
@!warn_pdfpagebox: boolean;
@ @<Set init...@>=
alt_rule := null;
warn_pdfpagebox := true;
@ @<Declare procedures needed in |do_ext...@>=
procedure scale_image(n: integer);
var x, y, xr, yr: integer; {size and resolution of image}
w, h: scaled; {indeed size corresponds to image resolution}
default_res: integer;
image: integer;
begin
image := obj_ximage_data(n);
if (image_rotate(image) = 90) or (image_rotate(image) = 270) then begin
y := image_width(image);
x := image_height(image);
yr := image_x_res(image);
xr := image_y_res(image);
end else begin
x := image_width(image);
y := image_height(image);
xr := image_x_res(image);
yr := image_y_res(image);
end;
if (xr > 65535) or (yr > 65535) then begin
xr := 0;
yr := 0;
pdf_warning("ext1", "too large image resolution ignored", true, true);
end;
if (x <= 0) or (y <= 0) or (xr < 0) or (yr < 0) then
pdf_error("ext1", "invalid image dimensions");
if is_pdf_image(image) then begin
w := x;
h := y;
end
else begin
default_res := fix_int(pdf_image_resolution, 0, 65535);
if (default_res > 0) and ((xr = 0) or (yr = 0)) then begin
xr := default_res;
yr := default_res;
end;
if is_running(obj_ximage_width(n)) and
is_running(obj_ximage_height(n)) then
begin
if (xr > 0) and (yr > 0) then begin
w := ext_xn_over_d(one_hundred_inch, x, 100*xr);
h := ext_xn_over_d(one_hundred_inch, y, 100*yr);
end
else begin
w := ext_xn_over_d(one_hundred_inch, x, 7200);
h := ext_xn_over_d(one_hundred_inch, y, 7200);
end;
end;
end;
if is_running(obj_ximage_width(n)) and is_running(obj_ximage_height(n)) and
is_running(obj_ximage_depth(n)) then begin
obj_ximage_width(n) := w;
obj_ximage_height(n) := h;
obj_ximage_depth(n) := 0;
end
else if is_running(obj_ximage_width(n)) then begin
{image depth or height is explicitly specified}
if is_running(obj_ximage_height(n)) then begin
{image depth is explicitly specified}
obj_ximage_width(n) := ext_xn_over_d(h, x, y);
obj_ximage_height(n) := h - obj_ximage_depth(n);
end
else if is_running(obj_ximage_depth(n)) then begin
{image height is explicitly specified}
obj_ximage_width(n) := ext_xn_over_d(obj_ximage_height(n), x, y);
obj_ximage_depth(n) := 0;
end
else begin
{both image depth and height are explicitly specified}
obj_ximage_width(n) := ext_xn_over_d(obj_ximage_height(n) +
obj_ximage_depth(n), x, y);
end;
end
else begin
{image width is explicitly specified}
if is_running(obj_ximage_height(n)) and
is_running(obj_ximage_depth(n)) then begin
{both image depth and height are not specified}
obj_ximage_height(n) := ext_xn_over_d(obj_ximage_width(n), y, x);
obj_ximage_depth(n) := 0;
end
{image depth is explicitly specified}
else if is_running(obj_ximage_height(n)) then begin
obj_ximage_height(n) :=
ext_xn_over_d(obj_ximage_width(n), y, x) - obj_ximage_depth(n);
end
{image height is explicitly specified}
else if is_running(obj_ximage_depth(n)) then begin
obj_ximage_depth(n) := 0;
end
{both image depth and height are explicitly specified}
else
do_nothing;
end;
end;
function scan_pdf_box_spec: integer; {scans PDF pagebox specification}
begin
scan_pdf_box_spec := 0;
if scan_keyword("mediabox") then
scan_pdf_box_spec := pdf_box_spec_media
else if scan_keyword("cropbox") then
scan_pdf_box_spec := pdf_box_spec_crop
else if scan_keyword("bleedbox") then
scan_pdf_box_spec := pdf_box_spec_bleed
else if scan_keyword("trimbox") then
scan_pdf_box_spec := pdf_box_spec_trim
else if scan_keyword("artbox") then
scan_pdf_box_spec := pdf_box_spec_art
end;
procedure scan_alt_rule; {scans rule spec to |alt_rule|}
label reswitch;
begin
if alt_rule = null then
alt_rule := new_rule;
width(alt_rule) := null_flag;
height(alt_rule) := null_flag;
depth(alt_rule) := null_flag;
reswitch:
if scan_keyword("width") then begin
scan_normal_dimen;
width(alt_rule) := cur_val;
goto reswitch;
end;
if scan_keyword("height") then begin
scan_normal_dimen;
height(alt_rule) := cur_val;
goto reswitch;
end;
if scan_keyword("depth") then begin
scan_normal_dimen;
depth(alt_rule) := cur_val;
goto reswitch;
end;
end;
procedure scan_image;
label reswitch;
var k: integer;
named: str_number;
s: str_number;
page, pagebox, colorspace: integer;
begin
incr(pdf_ximage_count);
pdf_create_obj(obj_type_ximage, pdf_ximage_count);
k := obj_ptr;
obj_data_ptr(k) := pdf_get_mem(pdfmem_ximage_size);
scan_alt_rule; {scans |<rule spec>| to |alt_rule|}
obj_ximage_width(k) := width(alt_rule);
obj_ximage_height(k) := height(alt_rule);
obj_ximage_depth(k) := depth(alt_rule);
if scan_keyword("attr") then begin
scan_pdf_ext_toks;
obj_ximage_attr(k) := def_ref;
end
else
obj_ximage_attr(k) := null;
named := 0;
if scan_keyword("named") then begin
scan_pdf_ext_toks;
named := tokens_to_string(def_ref);
delete_token_ref(def_ref);
end
else if scan_keyword("page") then begin
scan_int;
page := cur_val;
end
else
page := 1;
if scan_keyword("colorspace") then begin
scan_int;
colorspace := cur_val;
end
else
colorspace := 0;
pagebox := scan_pdf_box_spec;
if pagebox = 0 then
pagebox := pdf_pagebox;
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
if pdf_option_always_use_pdfpagebox <> 0 then begin
pdf_warning("PDF inclusion", "Primitive \pdfoptionalwaysusepdfpagebox is obsolete; use \pdfpagebox instead.", true, true);
pdf_force_pagebox := pdf_option_always_use_pdfpagebox;
pdf_option_always_use_pdfpagebox := 0; {warn once}
warn_pdfpagebox := false;
end;
if pdf_option_pdf_inclusion_errorlevel <> 0 then begin
pdf_warning("PDF inclusion", "Primitive \pdfoptionpdfinclusionerrorlevel is obsolete; use \pdfinclusionerrorlevel instead.", true, true);
pdf_inclusion_errorlevel := pdf_option_pdf_inclusion_errorlevel;
pdf_option_pdf_inclusion_errorlevel := 0; {warn once}
end;
if pdf_force_pagebox > 0 then begin
if warn_pdfpagebox then begin
pdf_warning("PDF inclusion", "Primitive \pdfforcepagebox is obsolete; use \pdfpagebox instead.", true, true);
warn_pdfpagebox := false;
end;
pagebox := pdf_force_pagebox;
end;
if pagebox = 0 then {no pagebox specification given}
pagebox := pdf_box_spec_crop;
obj_ximage_data(k) := read_image(s, page, named, colorspace, pagebox,
pdf_major_version, pdf_minor_version,
pdf_inclusion_errorlevel);
if named <> 0 then flush_str(named);
flush_str(s);
scale_image(k);
pdf_last_ximage := k;
pdf_last_ximage_pages := image_pages(obj_ximage_data(k));
pdf_last_ximage_colordepth := image_colordepth(obj_ximage_data(k));
end;
@ @<Implement \.{\\pdfximage}@>=
begin
check_pdfoutput("\pdfximage", true);
check_pdfversion;
scan_image;
end
@ @<Implement \.{\\pdfrefximage}@>=
begin
check_pdfoutput("\pdfrefximage", true);
scan_int;
pdf_check_obj(obj_type_ximage, cur_val);
new_whatsit(pdf_refximage_node, pdf_refximage_node_size);
pdf_ximage_objnum(tail) := cur_val;
pdf_width(tail) := obj_ximage_width(cur_val);
pdf_height(tail) := obj_ximage_height(cur_val);
pdf_depth(tail) := obj_ximage_depth(cur_val);
end
@ The following function finds object with identifier |i| and type |t|.
|i < 0| indicates that |-i| should be treated as a string number. If no
such object exists then it will be created. This function is used mainly to
find destination for link annotations and outlines; however it is also used
in |pdf_ship_out| (to check whether a Page object already exists) so we need
to declare it together with subroutines needed in |pdf_hlist_out| and
|pdf_vlist_out|.
@<Declare procedures that need to be declared forward for \pdfTeX@>=
function find_obj(t, i: integer; byname: boolean): integer;
begin
find_obj := avl_find_obj(t, i, byname);
end;
procedure flush_str(s: str_number); {flush a string if possible}
begin
if flushable(s) then
flush_string;
end;
function get_obj(t, i: integer; byname: boolean): integer;
var r: integer;
s: str_number;
begin
if byname > 0 then begin
s := tokens_to_string(i);
r := find_obj(t, s, true);
end
else begin
s := 0;
r := find_obj(t, i, false);
end;
if r = 0 then begin
if byname > 0 then begin
pdf_create_obj(t, -s);
s := 0;
end
else
pdf_create_obj(t, i);
r := obj_ptr;
if (t = obj_type_dest) or (t = obj_type_struct_dest) then
obj_dest_ptr(r) := null;
end;
if s <> 0 then
flush_str(s);
get_obj := r;
end;
function get_microinterval:integer;
var s,@!m:integer; {seconds and microseconds}
begin
seconds_and_micros(s,m);
if (s-epochseconds)>32767 then
get_microinterval := max_integer
else if (microseconds>m) then
get_microinterval := ((s-1-epochseconds)*65536)+ (((m+1000000-microseconds)/100)*65536)/10000
else
get_microinterval := ((s-epochseconds)*65536) + (((m-microseconds)/100)*65536)/10000;
end;
@ @<Declare procedures needed in |do_ext...@>=
function scan_action: pointer; {read an action specification}
var p: integer;
begin
p := get_node(pdf_action_size);
scan_action := p;
pdf_action_file(p) := null;
pdf_action_refcount(p) := null;
if scan_keyword("user") then
pdf_action_type(p) := pdf_action_user
else if scan_keyword("goto") then
pdf_action_type(p) := pdf_action_goto
else if scan_keyword("thread") then
pdf_action_type(p) := pdf_action_thread
else
pdf_error("ext1", "action type missing");
if pdf_action_type(p) = pdf_action_user then begin
scan_pdf_ext_toks;
pdf_action_user_tokens(p) := def_ref;
return;
end;
pdf_action_named_id(p) := 0;
if scan_keyword("file") then begin
scan_pdf_ext_toks;
pdf_action_file(p) := def_ref;
end;
if scan_keyword("struct") then begin
if pdf_action_type(p) <> pdf_action_goto then
pdf_error("ext1", "only GoTo action can be used with `struct'");
if pdf_action_file(p) <> null then begin
scan_pdf_ext_toks;
pdf_action_named_id(p) := pdf_action_named_id(p) + 2;
pdf_action_struct_id(p) := def_ref;
end
else if scan_keyword("name") then begin
scan_pdf_ext_toks;
pdf_action_named_id(p) := pdf_action_named_id(p) + 2;
pdf_action_struct_id(p) := def_ref;
end
else if scan_keyword("num") then begin
scan_int;
if cur_val <= 0 then
pdf_error("ext1", "num identifier must be positive");
pdf_action_struct_id(p) := cur_val;
end
else
pdf_error("ext1", "identifier type missing");
end
else
pdf_action_struct_id(p) := null;
if scan_keyword("page") then begin
if pdf_action_type(p) <> pdf_action_goto then
pdf_error("ext1", "only GoTo action can be used with `page'");
pdf_action_type(p) := pdf_action_page;
scan_int;
if cur_val <= 0 then
pdf_error("ext1", "page number must be positive");
pdf_action_id(p) := cur_val;
scan_pdf_ext_toks;
pdf_action_page_tokens(p) := def_ref;
end
else if scan_keyword("name") then begin
scan_pdf_ext_toks;
pdf_action_named_id(p) := pdf_action_named_id(p) + 1;
pdf_action_id(p) := def_ref;
end
else if scan_keyword("num") then begin
if (pdf_action_type(p) = pdf_action_goto) and
(pdf_action_file(p) <> null) then
pdf_error("ext1",
"`goto' option cannot be used with both `file' and `num'");
scan_int;
if cur_val <= 0 then
pdf_error("ext1", "num identifier must be positive");
pdf_action_id(p) := cur_val;
end
else
pdf_error("ext1", "identifier type missing");
if scan_keyword("newwindow") then begin
pdf_action_new_window(p) := 1;
@<Scan an optional space@>; end
else if scan_keyword("nonewwindow") then begin
pdf_action_new_window(p) := 2;
@<Scan an optional space@>; end
else
pdf_action_new_window(p) := 0;
if (pdf_action_new_window(p) > 0) and
(((pdf_action_type(p) <> pdf_action_goto) and
(pdf_action_type(p) <> pdf_action_page)) or
(pdf_action_file(p) = null)) then
pdf_error("ext1",
"`newwindow'/`nonewwindow' must be used with `goto' and `file' option");
end;
procedure new_annot_whatsit(w, s: small_number); {create a new whatsit node for
annotation}
begin
new_whatsit(w, s);
scan_alt_rule; {scans |<rule spec>| to |alt_rule|}
pdf_width(tail) := width(alt_rule);
pdf_height(tail) := height(alt_rule);
pdf_depth(tail) := depth(alt_rule);
if (w = pdf_start_link_node) then begin
if scan_keyword("attr") then begin
scan_pdf_ext_toks;
pdf_link_attr(tail) := def_ref;
end
else
pdf_link_attr(tail) := null;
end;
if (w = pdf_thread_node) or (w = pdf_start_thread_node) then begin
if scan_keyword("attr") then begin
scan_pdf_ext_toks;
pdf_thread_attr(tail) := def_ref;
end
else
pdf_thread_attr(tail) := null;
end;
end;
@ @<Glob...@>=
@!pdf_last_annot: integer;
@ @<Implement \.{\\pdfannot}@>=
begin
check_pdfoutput("\pdfannot", true);
if scan_keyword("reserveobjnum") then begin
pdf_last_annot := pdf_new_objnum;
@<Scan an optional space@>; end
else begin
if scan_keyword("useobjnum") then begin
scan_int;
k := cur_val;
if (k <= 0) or (k > obj_ptr) or (obj_annot_ptr(k) <> 0) then
pdf_error("ext1", "invalid object number");
end
else
k := pdf_new_objnum;
new_annot_whatsit(pdf_annot_node, pdf_annot_node_size);
pdf_annot_objnum(tail) := k;
scan_pdf_ext_toks;
pdf_annot_data(tail) := def_ref;
pdf_last_annot := k;
end
end
@ \.{\\pdflastlink} needs an extra global variable.
@<Glob...@>=
@!pdf_last_link: integer;
@ @<Implement \.{\\pdfstartlink}@>=
begin
check_pdfoutput("\pdfstartlink", true);
if abs(mode) = vmode then
pdf_error("ext1", "\pdfstartlink cannot be used in vertical mode");
k := pdf_new_objnum;
new_annot_whatsit(pdf_start_link_node, pdf_annot_node_size);
pdf_link_action(tail) := scan_action;
pdf_link_objnum(tail) := k;
pdf_last_link := k;
{N.B.: although it is possible to set |obj_annot_ptr(k) := tail| here, it
is not safe if nodes are later copied/destroyed/moved; a better place
to do this is inside |do_link|, when the whatsit node is written out}
end
@ @<Implement \.{\\pdfendlink}@>=
begin
check_pdfoutput("\pdfendlink", true);
if abs(mode) = vmode then
pdf_error("ext1", "\pdfendlink cannot be used in vertical mode");
new_whatsit(pdf_end_link_node, small_node_size);
end
@ @<Declare procedures needed in |do_ext...@>=
function outline_list_count(p: pointer): integer; {return number of outline
entries in the same level with |p|}
var k: integer;
begin
k := 1;
while obj_outline_prev(p) <> 0 do begin
incr(k);
p := obj_outline_prev(p);
end;
outline_list_count := k;
end;
@ @<Implement \.{\\pdfoutline}@>=
begin
check_pdfoutput("\pdfoutline", true);
if scan_keyword("attr") then begin
scan_pdf_ext_toks;
r := def_ref;
end
else
r := 0;
p := scan_action;
if scan_keyword("count") then begin
scan_int;
i := cur_val;
end
else
i := 0;
scan_pdf_ext_toks;
q := def_ref;
pdf_new_obj(obj_type_others, 0, 1);
j := obj_ptr;
write_action(p);
pdf_end_obj;
delete_action_ref(p);
pdf_create_obj(obj_type_outline, 0);
k := obj_ptr;
obj_outline_ptr(k) := pdf_get_mem(pdfmem_outline_size);
obj_outline_action_objnum(k) := j;
obj_outline_count(k) := i;
pdf_new_obj(obj_type_others, 0, 1);
pdf_print_str_ln(tokens_to_string(q));
flush_str(last_tokens_string);
delete_token_ref(q);
pdf_end_obj;
obj_outline_title(k) := obj_ptr;
obj_outline_prev(k) := 0;
obj_outline_next(k) := 0;
obj_outline_first(k) := 0;
obj_outline_last(k) := 0;
obj_outline_parent(k) := pdf_parent_outline;
obj_outline_attr(k) := r;
if pdf_first_outline = 0 then
pdf_first_outline := k;
if pdf_last_outline = 0 then begin
if pdf_parent_outline <> 0 then
obj_outline_first(pdf_parent_outline) := k;
end
else begin
obj_outline_next(pdf_last_outline) := k;
obj_outline_prev(k) := pdf_last_outline;
end;
pdf_last_outline := k;
if obj_outline_count(k) <> 0 then begin
pdf_parent_outline := k;
pdf_last_outline := 0;
end
else if (pdf_parent_outline <> 0) and
(outline_list_count(k) = abs(obj_outline_count(pdf_parent_outline))) then
begin
j := pdf_last_outline;
repeat
obj_outline_last(pdf_parent_outline) := j;
j := pdf_parent_outline;
pdf_parent_outline := obj_outline_parent(pdf_parent_outline);
until (pdf_parent_outline = 0) or
(outline_list_count(j) < abs(obj_outline_count(pdf_parent_outline)));
if pdf_parent_outline = 0 then
pdf_last_outline := pdf_first_outline
else
pdf_last_outline := obj_outline_first(pdf_parent_outline);
while obj_outline_next(pdf_last_outline) <> 0 do
pdf_last_outline := obj_outline_next(pdf_last_outline);
end;
end
@ When a destination is created we need to check whether another destination
with the same identifier already exists and give a warning if needed.
@<Declare procedures needed in |pdf_hlist_out|, |pdf_vlist_out|@>=
procedure warn_dest_dup(id: integer; byname: small_number; s1, s2: str_number);
begin
if pdf_suppress_warning_dup_dest > 0 then
return;
pdf_warning(s1, "destination with the same identifier (", true, false);
if byname > 0 then begin
print("name");
print_mark(id);
end
else begin
print("num");
print_int(id);
end;
print(") ");
print(s2);
print_ln;
show_context;
end;
@ Notice that |scan_keyword| doesn't care if two words have same prefix; so
we should be careful when scan keywords with same prefix. The main rule: if
there are two or more keywords with the same prefix, then always test in
order from the longest one to the shortest one.
@<Implement \.{\\pdfdest}@>=
begin
check_pdfoutput("\pdfdest", true);
q := tail;
new_whatsit(pdf_dest_node, pdf_dest_node_size);
if scan_keyword("struct") then begin
scan_int;
if cur_val <= 0 then
pdf_error("ext1", "struct identifier must be positive");
pdf_dest_objnum(tail) := cur_val;
j := obj_type_struct_dest;
end else begin
pdf_dest_objnum(tail) := null;
j := obj_type_dest;
end;
if scan_keyword("num") then begin
scan_int;
if cur_val <= 0 then
pdf_error("ext1", "num identifier must be positive");
if cur_val > max_halfword then
pdf_error("ext1", "number too big");
pdf_dest_id(tail) := cur_val;
pdf_dest_named_id(tail) := 0;
end
else if scan_keyword("name") then begin
scan_pdf_ext_toks;
pdf_dest_id(tail) := def_ref;
pdf_dest_named_id(tail) := 1;
end
else
pdf_error("ext1", "identifier type missing");
if scan_keyword("xyz") then begin
pdf_dest_type(tail) := pdf_dest_xyz;
if scan_keyword("zoom") then begin
scan_int;
if cur_val > max_halfword then
pdf_error("ext1", "number too big");
pdf_dest_xyz_zoom(tail) := cur_val;
end
else
pdf_dest_xyz_zoom(tail) := null;
end
else if scan_keyword("fitbh") then
pdf_dest_type(tail) := pdf_dest_fitbh
else if scan_keyword("fitbv") then
pdf_dest_type(tail) := pdf_dest_fitbv
else if scan_keyword("fitb") then
pdf_dest_type(tail) := pdf_dest_fitb
else if scan_keyword("fith") then
pdf_dest_type(tail) := pdf_dest_fith
else if scan_keyword("fitv") then
pdf_dest_type(tail) := pdf_dest_fitv
else if scan_keyword("fitr") then
pdf_dest_type(tail) := pdf_dest_fitr
else if scan_keyword("fit") then
pdf_dest_type(tail) := pdf_dest_fit
else
pdf_error("ext1", "destination type missing");
@<Scan an optional space@>;
if pdf_dest_type(tail) = pdf_dest_fitr then begin
scan_alt_rule; {scans |<rule spec>| to |alt_rule|}
pdf_width(tail) := width(alt_rule);
pdf_height(tail) := height(alt_rule);
pdf_depth(tail) := depth(alt_rule);
end;
if pdf_dest_named_id(tail) <> 0 then begin
i := tokens_to_string(pdf_dest_id(tail));
k := find_obj(j, i, true);
flush_str(i);
end
else
k := find_obj(j, pdf_dest_id(tail), false);
if (k <> 0) and (obj_dest_ptr(k) <> null) then begin
warn_dest_dup(pdf_dest_id(tail), pdf_dest_named_id(tail),
"ext4", "has been already used, duplicate ignored");
flush_node_list(tail);
tail := q;
link(q) := null;
end;
end
@ @<Declare procedures needed in |do_ext...@>=
procedure scan_thread_id;
begin
if scan_keyword("num") then begin
scan_int;
if cur_val <= 0 then
pdf_error("ext1", "num identifier must be positive");
if cur_val > max_halfword then
pdf_error("ext1", "number too big");
pdf_thread_id(tail) := cur_val;
pdf_thread_named_id(tail) := 0;
end
else if scan_keyword("name") then begin
scan_pdf_ext_toks;
pdf_thread_id(tail) := def_ref;
pdf_thread_named_id(tail) := 1;
end
else
pdf_error("ext1", "identifier type missing");
end;
@ @<Implement \.{\\pdfthread}@>=
begin
check_pdfoutput("\pdfthread", true);
new_annot_whatsit(pdf_thread_node, pdf_thread_node_size);
scan_thread_id;
end
@ @<Implement \.{\\pdfstartthread}@>=
begin
check_pdfoutput("\pdfstartthread", true);
new_annot_whatsit(pdf_start_thread_node, pdf_thread_node_size);
scan_thread_id;
end
@ @<Implement \.{\\pdfendthread}@>=
begin
check_pdfoutput("\pdfendthread", true);
new_whatsit(pdf_end_thread_node, small_node_size);
end
@ @<Glob...@>=
@!pdf_last_x_pos: integer;
@!pdf_last_y_pos: integer;
@!pdf_snapx_refpos: integer;
@!pdf_snapy_refpos: integer;
@!count_do_snapy: integer;
@ @<Set init...@>=
count_do_snapy := 0;
@ @<Implement \.{\\pdfsnaprefpoint}@>=
begin
check_pdfoutput("\pdfsnaprefpoint", true);
new_whatsit(pdf_snap_ref_point_node, small_node_size);
end
@ @<Declare procedures needed in |do_ext...@>=
function new_snap_node(s: small_number): pointer;
var p: pointer;
begin
scan_glue(glue_val);
if width(cur_val) < 0 then
pdf_error("ext1", "negative snap glue");
p := get_node(snap_node_size);
type(p) := whatsit_node;
subtype(p) := s;
link(p) := null;
snap_glue_ptr(p) := cur_val;
final_skip(p) := 0;
new_snap_node := p;
end;
@ @<Implement \.{\\pdfsnapy}@>=
begin
check_pdfoutput("\pdfsnapy", true);
tail_append(new_snap_node(pdf_snapy_node));
end
@ @<Implement \.{\\pdfsnapycomp}@>=
begin
check_pdfoutput("\pdfsnapycomp", true);
new_whatsit(pdf_snapy_comp_node, small_node_size);
scan_int;
snapy_comp_ratio(tail) := fix_int(cur_val, 0, 1000);
end
@ @<Implement \.{\\pdfsavepos}@>=
begin
new_whatsit(pdf_save_pos_node, small_node_size);
end
@ To implement primitives as \.{\\pdfinfo}, \.{\\pdfcatalog} or
\.{\\pdfnames} we need to concatenate tokens lists.
@<Declare procedures needed in |do_ext...@>=
function concat_tokens(q, r: pointer): pointer; {concat |q| and |r| and
returns the result tokens list}
var p: pointer;
begin
if q = null then begin
concat_tokens := r;
return;
end;
p := q;
while link(p) <> null do
p := link(p);
link(p) := link(r);
free_avail(r);
concat_tokens := q;
end;
@ @<Implement \.{\\pdfinfo}@>=
begin
check_pdfoutput("\pdfinfo", false);
scan_pdf_ext_toks;
if pdf_output > 0 then
pdf_info_toks := concat_tokens(pdf_info_toks, def_ref);
end
@ @<Implement \.{\\pdfcatalog}@>=
begin
check_pdfoutput("\pdfcatalog", false);
scan_pdf_ext_toks;
if pdf_output > 0 then
pdf_catalog_toks := concat_tokens(pdf_catalog_toks, def_ref);
if scan_keyword("openaction") then begin
if pdf_catalog_openaction <> 0 then
pdf_error("ext1", "duplicate of openaction")
else begin
p := scan_action;
pdf_new_obj(obj_type_others, 0, 1);
if pdf_output > 0 then
pdf_catalog_openaction := obj_ptr;
write_action(p);
pdf_end_obj;
delete_action_ref(p);
end;
end
end
@ @<Implement \.{\\pdfnames}@>=
begin
check_pdfoutput("\pdfnames", true);
scan_pdf_ext_toks;
pdf_names_toks := concat_tokens(pdf_names_toks, def_ref);
end
@ @<Implement \.{\\pdftrailer}@>=
begin
check_pdfoutput("\pdftrailer", false);
scan_pdf_ext_toks;
if pdf_output > 0 then
pdf_trailer_toks := concat_tokens(pdf_trailer_toks, def_ref);
end
@ @<Implement \.{\\pdftrailerid}@>=
begin
check_pdfoutput("\pdftrailerid", false);
scan_pdf_ext_toks;
if pdf_output > 0 then
pdf_trailer_id_toks := concat_tokens(pdf_trailer_id_toks, def_ref);
end
@ @<Glob...@>=
@!pdf_retval: integer; {global multi-purpose return value}
@ @<Set initial values of key variables@>=
seconds_and_micros(epochseconds,microseconds);
init_start_time;
@ Negative random seed values are silently converted to positive ones.
@<Implement \.{\\pdfsetrandomseed}@>=
begin
scan_int;
if cur_val<0 then negate(cur_val);
random_seed := cur_val;
init_randoms(random_seed);
end
@ @<Implement \.{\\pdfresettimer}@>=
begin
seconds_and_micros(epochseconds,microseconds);
end
@ The following subroutines are about PDF-specific font issues.
@<Declare procedures needed in |do_ext...@>=
procedure pdf_include_chars;
var s: str_number;
k: pool_pointer; {running indices}
f: internal_font_number;
begin
scan_font_ident;
f := cur_val;
if f = null_font then
pdf_error("font", "invalid font identifier");
pdf_check_vf_cur_val;
if not font_used[f] then
pdf_init_font(f);
scan_pdf_ext_toks;
s := tokens_to_string(def_ref);
delete_token_ref(def_ref);
k := str_start[s];
while k < str_start[s + 1] do begin
pdf_mark_char(f, str_pool[k]);
incr(k);
end;
flush_str(s);
end;
procedure glyph_to_unicode;
var s1, s2: str_number;
begin
scan_pdf_ext_toks;
s1 := tokens_to_string(def_ref);
delete_token_ref(def_ref);
scan_pdf_ext_toks;
s2 := tokens_to_string(def_ref);
delete_token_ref(def_ref);
def_tounicode(s1, s2);
flush_str(s2);
flush_str(s1);
end;
@ @<Implement \.{\\pdfincludechars}@>=
begin
check_pdfoutput("\pdfincludechars", true);
pdf_include_chars;
end
@ @<Implement \.{\\pdffontattr}@>=
begin
check_pdfoutput("\pdffontattr", true);
scan_font_ident;
k := cur_val;
if k = null_font then
pdf_error("font", "invalid font identifier");
scan_pdf_ext_toks;
pdf_font_attr[k] := tokens_to_string(def_ref);
end
@ @<Implement \.{\\pdfmapfile}@>=
begin
check_pdfoutput("\pdfmapfile", true);
scan_pdf_ext_toks;
pdfmapfile(def_ref);
delete_token_ref(def_ref);
end
@ @<Implement \.{\\pdfmapline}@>=
begin
check_pdfoutput("\pdfmapline", true);
scan_pdf_ext_toks;
pdfmapline(def_ref);
delete_token_ref(def_ref);
end
@ @<Implement \.{\\pdfglyphtounicode}@>=
begin
glyph_to_unicode;
end
@ @<Implement \.{\\pdfnobuiltintounicode}@>=
begin
check_pdfoutput("\pdfnobuiltintounicode", true);
scan_font_ident;
k := cur_val;
if k = null_font then
pdf_error("font", "invalid font identifier");
pdf_font_nobuiltin_tounicode[k] := true;
end
@ @<Implement \.{\\pdfinterwordspaceon}@>=
begin
check_pdfoutput("\pdfinterwordspaceon", true);
new_whatsit(pdf_interword_space_on_node, small_node_size);
end
@ @<Implement \.{\\pdfinterwordspaceoff}@>=
begin
check_pdfoutput("\pdfinterwordspaceoff", true);
new_whatsit(pdf_interword_space_off_node, small_node_size);
end
@ @<Implement \.{\\pdffakespace}@>=
begin
check_pdfoutput("\pdffakespace", true);
new_whatsit(pdf_fake_space_node, small_node_size);
end
@ @<Implement \.{\\pdfrunninglinkoff}@>=
begin
check_pdfoutput("\pdfrunninglinkoff", true);
new_whatsit(pdf_running_link_off_node, small_node_size);
end
@ @<Implement \.{\\pdfrunninglinkon}@>=
begin
check_pdfoutput("\pdfrunninglinkon", true);
new_whatsit(pdf_running_link_on_node, small_node_size);
end
@ @<Implement \.{\\pdfspacefont}@>=
begin
check_pdfoutput("\pdfspacefont", true);
scan_pdf_ext_toks;
pdf_space_font_name := tokens_to_string(def_ref);
delete_token_ref(def_ref);
end
@ The following function are needed for outputting article thread.
@<Declare procedures needed in |do_ext...@>=
procedure thread_title(thread: integer);
begin
pdf_print("/Title (");
if obj_info(thread) < 0 then
pdf_print(-obj_info(thread))
else
pdf_print_int(obj_info(thread));
pdf_print_ln(")");
end;
procedure pdf_fix_thread(thread: integer);
var a: pointer;
begin
pdf_warning("thread", "destination ", true, false);
if obj_info(thread) < 0 then begin
print("name{");
print(-obj_info(thread));
print("}");
end
else begin
print("num");
print_int(obj_info(thread));
end;
print(" has been referenced but does not exist, replaced by a fixed one");
print_ln; print_ln;
pdf_new_dict(obj_type_others, 0, 0);
a := obj_ptr;
pdf_indirect_ln("T", thread);
pdf_indirect_ln("V", a);
pdf_indirect_ln("N", a);
pdf_indirect_ln("P", head_tab[obj_type_page]);
pdf_print("/R [0 0 ");
pdf_print_bp(pdf_page_width); pdf_out(" ");
pdf_print_bp(pdf_page_height);
pdf_print_ln("]");
pdf_end_dict;
pdf_begin_dict(thread, 1);
pdf_print_ln("/I << ");
thread_title(thread);
pdf_print_ln(">>");
pdf_indirect_ln("F", a);
pdf_end_dict;
end;
procedure out_thread(thread: integer);
var a, b: pointer;
last_attr: integer;
begin
if obj_thread_first(thread) = 0 then begin
pdf_fix_thread(thread);
return;
end;
pdf_begin_dict(thread, 1);
a := obj_thread_first(thread);
b := a;
last_attr := 0;
repeat
if obj_bead_attr(a) <> 0 then
last_attr := obj_bead_attr(a);
a := obj_bead_next(a);
until a = b;
if last_attr <> 0 then
pdf_print_ln(last_attr)
else begin
pdf_print_ln("/I << ");
thread_title(thread);
pdf_print_ln(">>");
end;
pdf_indirect_ln("F", a);
pdf_end_dict;
repeat
pdf_begin_dict(a, 1);
if a = b then
pdf_indirect_ln("T", thread);
pdf_indirect_ln("V", obj_bead_prev(a));
pdf_indirect_ln("N", obj_bead_next(a));
pdf_indirect_ln("P", obj_bead_page(a));
pdf_indirect_ln("R", obj_bead_rect(a));
pdf_end_dict;
a := obj_bead_next(a);
until a = b;
end;
@ @<Display <rule spec> for whatsit node created by \pdfTeX@>=
print("(");
print_rule_dimen(pdf_height(p));
print_char("+");
print_rule_dimen(pdf_depth(p));
print(")x");
print_rule_dimen(pdf_width(p))
@ Each new type of node that appears in our data structure must be capable
of being displayed, copied, destroyed, and so on. The routines that we
need for write-oriented whatsits are somewhat like those for mark nodes;
other extensions might, of course, involve more subtlety here.
@<Basic printing...@>=
procedure print_write_whatsit(@!s:str_number;@!p:pointer);
begin print_esc(s);
if write_stream(p)<16 then print_int(write_stream(p))
else if write_stream(p)=16 then print_char("*")
@.*\relax@>
else print_char("-");
end;
@ @<Display the whatsit...@>=
case subtype(p) of
open_node:begin print_write_whatsit("openout",p);
print_char("="); print_file_name(open_name(p),open_area(p),open_ext(p));
end;
write_node:begin print_write_whatsit("write",p);
print_mark(write_tokens(p));
end;
close_node:print_write_whatsit("closeout",p);
special_node:begin print_esc("special");
print_mark(write_tokens(p));
end;
latespecial_node:begin print_esc("special"); print(" shipout");
print_mark(write_tokens(p));
end;
language_node:begin print_esc("setlanguage");
print_int(what_lang(p)); print(" (hyphenmin ");
print_int(what_lhm(p)); print_char(",");
print_int(what_rhm(p)); print_char(")");
end;
pdf_literal_node,pdf_lateliteral_node: begin
print_esc("pdfliteral");
if subtype(p)=pdf_lateliteral_node then print(" shipout");
case pdf_literal_mode(p) of
set_origin:
do_nothing;
direct_page:
print(" page");
direct_always:
print(" direct");
othercases confusion("literal2")
endcases;
print_mark(pdf_literal_data(p));
end;
pdf_colorstack_node: begin
print_esc("pdfcolorstack ");
print_int(pdf_colorstack_stack(p));
case pdf_colorstack_cmd(p) of
colorstack_set:
print(" set ");
colorstack_push:
print(" push ");
colorstack_pop:
print(" pop");
colorstack_current:
print(" current");
othercases confusion("pdfcolorstack")
endcases;
if pdf_colorstack_cmd(p) <= colorstack_data then
print_mark(pdf_colorstack_data(p));
end;
pdf_setmatrix_node: begin
print_esc("pdfsetmatrix");
print_mark(pdf_setmatrix_data(p));
end;
pdf_save_node: begin
print_esc("pdfsave");
end;
pdf_restore_node: begin
print_esc("pdfrestore");
end;
pdf_refobj_node: begin
print_esc("pdfrefobj");
if obj_obj_is_stream(pdf_obj_objnum(p)) > 0 then begin
if obj_obj_stream_attr(pdf_obj_objnum(p)) <> null then begin
print(" attr");
print_mark(obj_obj_stream_attr(pdf_obj_objnum(p)));
end;
print(" stream");
end;
if obj_obj_is_file(pdf_obj_objnum(p)) > 0 then
print(" file");
print_mark(obj_obj_data(pdf_obj_objnum(p)));
end;
pdf_refxform_node: begin
print_esc("pdfrefxform");
print("(");
print_scaled(obj_xform_height(pdf_xform_objnum(p)));
print_char("+");
print_scaled(obj_xform_depth(pdf_xform_objnum(p)));
print(")x");
print_scaled(obj_xform_width(pdf_xform_objnum(p)));
end;
pdf_refximage_node: begin
print_esc("pdfrefximage");
print("(");
print_scaled(obj_ximage_height(pdf_ximage_objnum(p)));
print_char("+");
print_scaled(obj_ximage_depth(pdf_ximage_objnum(p)));
print(")x");
print_scaled(obj_ximage_width(pdf_ximage_objnum(p)));
end;
pdf_annot_node: begin
print_esc("pdfannot");
@<Display <rule spec> for whatsit node created by \pdfTeX@>;
print_mark(pdf_annot_data(p));
end;
pdf_start_link_node: begin
print_esc("pdfstartlink");
@<Display <rule spec> for whatsit node created by \pdfTeX@>;
if pdf_link_attr(p) <> null then begin
print(" attr");
print_mark(pdf_link_attr(p));
end;
print(" action");
if pdf_action_type(pdf_link_action(p)) = pdf_action_user then begin
print(" user");
print_mark(pdf_action_user_tokens(pdf_link_action(p)));
end
else begin
if pdf_action_file(pdf_link_action(p)) <> null then begin
print(" file");
print_mark(pdf_action_file(pdf_link_action(p)));
end;
case pdf_action_type(pdf_link_action(p)) of
pdf_action_goto: begin
if (pdf_action_named_id(pdf_link_action(p)) mod 2) = 1 then begin
print(" goto name");
print_mark(pdf_action_id(pdf_link_action(p)));
end
else begin
print(" goto num");
print_int(pdf_action_id(pdf_link_action(p)))
end;
end;
pdf_action_page: begin
print(" page");
print_int(pdf_action_id(pdf_link_action(p)));
print_mark(pdf_action_page_tokens(pdf_link_action(p)));
end;
pdf_action_thread: begin
if (pdf_action_named_id(pdf_link_action(p)) mod 2) = 1 then begin
print(" thread name");
print_mark(pdf_action_id(pdf_link_action(p)));
end
else begin
print(" thread num");
print_int(pdf_action_id(pdf_link_action(p)));
end;
end;
othercases pdf_error("displaying", "unknown action type");
endcases;
end
end;
pdf_end_link_node: print_esc("pdfendlink");
pdf_dest_node: begin
print_esc("pdfdest");
if pdf_dest_objnum(p) <> null then begin
print(" struct");
print_int(pdf_dest_objnum(p));
end;
if pdf_dest_named_id(p) > 0 then begin
print(" name");
print_mark(pdf_dest_id(p));
end
else begin
print(" num");
print_int(pdf_dest_id(p));
end;
print(" ");
case pdf_dest_type(p) of
pdf_dest_xyz: begin
print("xyz");
if pdf_dest_xyz_zoom(p) <> null then begin
print(" zoom");
print_int(pdf_dest_xyz_zoom(p));
end;
end;
pdf_dest_fitbh: print("fitbh");
pdf_dest_fitbv: print("fitbv");
pdf_dest_fitb: print("fitb");
pdf_dest_fith: print("fith");
pdf_dest_fitv: print("fitv");
pdf_dest_fitr: begin
print("fitr");
@<Display <rule spec> for whatsit node created by \pdfTeX@>;
end;
pdf_dest_fit: print("fit");
othercases print("unknown!");
endcases;
end;
pdf_thread_node,
pdf_start_thread_node: begin
if subtype(p) = pdf_thread_node then
print_esc("pdfthread")
else
print_esc("pdfstartthread");
print("("); print_rule_dimen(pdf_height(p)); print_char("+");
print_rule_dimen(pdf_depth(p)); print(")x");
print_rule_dimen(pdf_width(p));
if pdf_thread_attr(p) <> null then begin
print(" attr");
print_mark(pdf_thread_attr(p));
end;
if pdf_thread_named_id(p) > 0 then begin
print(" name");
print_mark(pdf_thread_id(p));
end
else begin
print(" num");
print_int(pdf_thread_id(p));
end;
end;
pdf_end_thread_node: print_esc("pdfendthread");
pdf_save_pos_node: print_esc("pdfsavepos");
pdf_snap_ref_point_node: print_esc("pdfsnaprefpoint");
pdf_snapy_node: begin
print_esc("pdfsnapy");
print_char(" ");
print_spec(snap_glue_ptr(p), 0);
print_char(" ");
print_spec(final_skip(p), 0);
end;
pdf_snapy_comp_node: begin
print_esc("pdfsnapycomp");
print_char(" ");
print_int(snapy_comp_ratio(p));
end;
pdf_interword_space_on_node: print_esc("pdfinterwordspaceon");
pdf_interword_space_off_node: print_esc("pdfinterwordspaceoff");
pdf_fake_space_node: print_esc("pdffakespace");
pdf_running_link_off_node: print_esc("pdfrunninglinkoff");
pdf_running_link_on_node: print_esc("pdfrunninglinkon");
othercases print("whatsit?")
endcases
@ @<Make a partial copy of the whatsit...@>=
case subtype(p) of
open_node: begin r:=get_node(open_node_size); words:=open_node_size;
end;
write_node,special_node,latespecial_node: begin r:=get_node(write_node_size);
add_token_ref(write_tokens(p)); words:=write_node_size;
end;
close_node,language_node: begin r:=get_node(small_node_size);
words:=small_node_size;
end;
pdf_literal_node,pdf_lateliteral_node: begin
r := get_node(write_node_size);
add_token_ref(pdf_literal_data(p));
words := write_node_size;
end;
pdf_colorstack_node: begin
if pdf_colorstack_cmd(p) <= colorstack_data then begin
r := get_node(pdf_colorstack_setter_node_size);
add_token_ref(pdf_colorstack_data(p));
words := pdf_colorstack_setter_node_size;
end
else begin
r := get_node(pdf_colorstack_getter_node_size);
words := pdf_colorstack_getter_node_size;
end;
end;
pdf_setmatrix_node: begin
r := get_node(pdf_setmatrix_node_size);
add_token_ref(pdf_setmatrix_data(p));
words := pdf_setmatrix_node_size;
end;
pdf_save_node: begin
r := get_node(pdf_save_node_size);
words := pdf_save_node_size;
end;
pdf_restore_node: begin
r := get_node(pdf_restore_node_size);
words := pdf_restore_node_size;
end;
pdf_refobj_node: begin
r := get_node(pdf_refobj_node_size);
words := pdf_refobj_node_size;
end;
pdf_refxform_node: begin
r := get_node(pdf_refxform_node_size);
words := pdf_refxform_node_size;
end;
pdf_refximage_node: begin
r := get_node(pdf_refximage_node_size);
words := pdf_refximage_node_size;
end;
pdf_annot_node: begin
r := get_node(pdf_annot_node_size);
add_token_ref(pdf_annot_data(p));
words := pdf_annot_node_size;
end;
pdf_start_link_node: begin
r := get_node(pdf_annot_node_size);
pdf_height(r) := pdf_height(p);
pdf_depth(r) := pdf_depth(p);
pdf_width(r) := pdf_width(p);
pdf_link_attr(r) := pdf_link_attr(p);
if pdf_link_attr(r) <> null then
add_token_ref(pdf_link_attr(r));
pdf_link_action(r) := pdf_link_action(p);
add_action_ref(pdf_link_action(r));
pdf_link_objnum(r) := pdf_link_objnum(p);
end;
pdf_end_link_node:
r := get_node(small_node_size);
pdf_dest_node: begin
r := get_node(pdf_dest_node_size);
if pdf_dest_named_id(p) > 0 then
add_token_ref(pdf_dest_id(p));
words := pdf_dest_node_size;
end;
pdf_thread_node,
pdf_start_thread_node: begin
r := get_node(pdf_thread_node_size);
if pdf_thread_named_id(p) > 0 then
add_token_ref(pdf_thread_id(p));
if pdf_thread_attr(p) <> null then
add_token_ref(pdf_thread_attr(p));
words := pdf_thread_node_size;
end;
pdf_end_thread_node:
r := get_node(small_node_size);
pdf_save_pos_node:
r := get_node(small_node_size);
pdf_snap_ref_point_node:
r := get_node(small_node_size);
pdf_snapy_node: begin
add_glue_ref(snap_glue_ptr(p));
r := get_node(snap_node_size);
words := snap_node_size;
end;
pdf_snapy_comp_node:
r := get_node(small_node_size);
pdf_interword_space_on_node:
r := get_node(small_node_size);
pdf_interword_space_off_node:
r := get_node(small_node_size);
pdf_fake_space_node:
r := get_node(small_node_size);
pdf_running_link_off_node:
r := get_node(small_node_size);
pdf_running_link_on_node:
r := get_node(small_node_size);
othercases confusion("ext2")
@:this can't happen ext2}{\quad ext2@>
endcases
@ @<Wipe out the whatsit...@>=
begin case subtype(p) of
open_node: free_node(p,open_node_size);
write_node,special_node,latespecial_node: begin delete_token_ref(write_tokens(p));
free_node(p,write_node_size); goto done;
end;
close_node,language_node: free_node(p,small_node_size);
pdf_literal_node,pdf_lateliteral_node: begin
delete_token_ref(pdf_literal_data(p));
free_node(p, write_node_size);
end;
pdf_colorstack_node: begin
if pdf_colorstack_cmd(p) <= colorstack_data then begin
delete_token_ref(pdf_colorstack_data(p));
free_node(p, pdf_colorstack_setter_node_size);
end
else
free_node(p, pdf_colorstack_getter_node_size);
end;
pdf_setmatrix_node: begin
delete_token_ref(pdf_setmatrix_data(p));
free_node(p, pdf_setmatrix_node_size);
end;
pdf_save_node: begin
free_node(p, pdf_save_node_size);
end;
pdf_restore_node: begin
free_node(p, pdf_restore_node_size);
end;
pdf_refobj_node:
free_node(p, pdf_refobj_node_size);
pdf_refxform_node:
free_node(p, pdf_refxform_node_size);
pdf_refximage_node:
free_node(p, pdf_refximage_node_size);
pdf_annot_node: begin
delete_token_ref(pdf_annot_data(p));
free_node(p, pdf_annot_node_size);
end;
pdf_start_link_node: begin
if pdf_link_attr(p) <> null then
delete_token_ref(pdf_link_attr(p));
delete_action_ref(pdf_link_action(p));
free_node(p, pdf_annot_node_size);
end;
pdf_end_link_node:
free_node(p, small_node_size);
pdf_dest_node: begin
if pdf_dest_named_id(p) > 0 then
delete_token_ref(pdf_dest_id(p));
free_node(p, pdf_dest_node_size);
end;
pdf_thread_node,
pdf_start_thread_node: begin
if pdf_thread_named_id(p) > 0 then
delete_token_ref(pdf_thread_id(p));
if pdf_thread_attr(p) <> null then
delete_token_ref(pdf_thread_attr(p));
free_node(p, pdf_thread_node_size);
end;
pdf_end_thread_node:
free_node(p, small_node_size);
pdf_save_pos_node:
free_node(p, small_node_size);
pdf_snap_ref_point_node:
free_node(p, small_node_size);
pdf_snapy_node: begin
delete_glue_ref(snap_glue_ptr(p));
free_node(p, snap_node_size);
end;
pdf_snapy_comp_node:
free_node(p, small_node_size);
pdf_interword_space_on_node:
free_node(p, small_node_size);
pdf_interword_space_off_node:
free_node(p, small_node_size);
pdf_fake_space_node:
free_node(p, small_node_size);
pdf_running_link_off_node:
free_node(p, small_node_size);
pdf_running_link_on_node:
free_node(p, small_node_size);
othercases confusion("ext3")
@:this can't happen ext3}{\quad ext3@>
endcases;@/
goto done;
end
@ @<Incorporate a whatsit node into a vbox@>=
if (subtype(p) = pdf_refxform_node) or (subtype(p) = pdf_refximage_node) then
begin x:=x+d+pdf_height(p); d:=pdf_depth(p);
s:=0;
if pdf_width(p)+s>w then w:=pdf_width(p)+s;
end
@ @<Incorporate a whatsit node into an hbox@>=
if (subtype(p) = pdf_refxform_node) or (subtype(p) = pdf_refximage_node) then
begin x:=x+pdf_width(p);
s:=0;
if pdf_height(p)-s>h then h:=pdf_height(p)-s;
if pdf_depth(p)+s>d then d:=pdf_depth(p)+s;
end
@ @<Let |d| be the width of the whatsit |p|@>=
if (subtype(p) = pdf_refxform_node) or (subtype(p) = pdf_refximage_node) then
d := pdf_width(p)
else
d := 0
@ @d adv_past(#)==@+if subtype(#)=language_node then
begin cur_lang:=what_lang(#); l_hyf:=what_lhm(#); r_hyf:=what_rhm(#);@+end
@<Advance \(p)past a whatsit node in the \(l)|line_break| loop@>=@+
begin
adv_past(cur_p);
if (subtype(cur_p) = pdf_refxform_node) or (subtype(cur_p) = pdf_refximage_node) then
act_width:=act_width+pdf_width(cur_p);
end
@ @<Advance \(p)past a whatsit node in the \(p)pre-hyphenation loop@>=@+
if subtype(s)=language_node then
begin cur_lang:=what_lang(s); l_hyf:=what_lhm(s); r_hyf:=what_rhm(s);
set_hyph_index;
end
@ @<Prepare to move whatsit |p| to the current page, then |goto contribute|@>=
begin
if (subtype(p) = pdf_refxform_node) or (subtype(p) = pdf_refximage_node) then
begin page_total:=page_total+page_depth+pdf_height(p);
page_depth:=pdf_depth(p);
end;
goto contribute;
end
@ @<Process whatsit |p| in |vert_break| loop, |goto not_found|@>=
begin
if (subtype(p) = pdf_refxform_node) or (subtype(p) = pdf_refximage_node) then
begin cur_height:=cur_height+prev_dp+pdf_height(p); prev_dp:=pdf_depth(p);
end;
goto not_found;
end
@ @<Output the whatsit node |p| in a vlist@>=
out_what(p)
@ @<Output the whatsit node |p| in an hlist@>=
out_what(p)
@ After all this preliminary shuffling, we come finally to the routines
that actually send out the requested data. Let's do \.{\\special} first
(it's easier).
@<Declare procedures needed in |hlist_out|, |vlist_out|@>=
procedure special_out(@!p:pointer);
var old_setting:0..max_selector; {holds print |selector|}
@!k:pool_pointer; {index into |str_pool|}
@!h:halfword;
@!q,@!r:pointer; {temporary variables for list manipulation}
@!old_mode:integer; {saved |mode|}
begin synch_h; synch_v;@/
old_setting:=selector; selector:=new_string;
selector:=old_setting;
if subtype(p)=latespecial_node then
begin @<Expand macros in the token list
and make |link(def_ref)| point to the result@>;
h:=def_ref;
end
else h:=write_tokens(p);
selector:=new_string;
show_token_list(link(h),null,pool_size-pool_ptr);
selector:=old_setting;
str_room(1);
if cur_length<256 then
begin dvi_out(xxx1); dvi_out(cur_length);
end
else begin dvi_out(xxx4); dvi_four(cur_length);
end;
for k:=str_start[str_ptr] to pool_ptr-1 do dvi_out(so(str_pool[k]));
pool_ptr:=str_start[str_ptr]; {erase the string}
if subtype(p)=latespecial_node then
flush_list(def_ref);
end;
@ To write a token list, we must run it through \TeX's scanner, expanding
macros and \.{\\the} and \.{\\number}, etc. This might cause runaways,
if a delimited macro parameter isn't matched, and runaways would be
extremely confusing since we are calling on \TeX's scanner in the middle
of a \.{\\shipout} command. Therefore we will put a dummy control sequence as
a ``stopper,'' right after the token list. This control sequence is
artificially defined to be \.{\\outer}.
@:end_write_}{\.{\\endwrite}@>
@<Initialize table...@>=
text(end_write):="endwrite"; eq_level(end_write):=level_one;
eq_type(end_write):=outer_call; equiv(end_write):=null;
@ @<Declare procedures needed in |hlist_out|, |vlist_out|@>=
procedure write_out(@!p:pointer);
var old_setting:0..max_selector; {holds print |selector|}
@!old_mode:integer; {saved |mode|}
@!j:small_number; {write stream number}
@!q,@!r:pointer; {temporary variables for list manipulation}
begin @<Expand macros in the token list
and make |link(def_ref)| point to the result@>;
old_setting:=selector; j:=write_stream(p);
if write_open[j] then selector:=j
else begin {write to the terminal if file isn't open}
if (j=17)and(selector=term_and_log) then selector:=log_only;
print_nl("");
end;
token_show(def_ref); print_ln;
flush_list(def_ref); selector:=old_setting;
end;
@ The final line of this routine is slightly subtle; at least, the author
didn't think about it until getting burnt! There is a used-up token list
@^Knuth, Donald Ervin@>
on the stack, namely the one that contained |end_write_token|. (We
insert this artificial `\.{\\endwrite}' to prevent runaways, as explained
above.) If it were not removed, and if there were numerous writes on a
single page, the stack would overflow.
@d end_write_token==cs_token_flag+end_write
@<Expand macros in the token list and...@>=
q:=get_avail; info(q):=right_brace_token+"}";@/
r:=get_avail; link(q):=r; info(r):=end_write_token; ins_list(q);@/
begin_token_list(write_tokens(p),write_text);@/
q:=get_avail; info(q):=left_brace_token+"{"; ins_list(q);
{now we're ready to scan
`\.\{$\langle\,$token list$\,\rangle$\.{\} \\endwrite}'}
old_mode:=mode; mode:=0;
{disable \.{\\prevdepth}, \.{\\spacefactor}, \.{\\lastskip}, \.{\\prevgraf}}
cur_cs:=write_loc; q:=scan_toks(false,true); {expand macros, etc.}
get_token;@+if cur_tok<>end_write_token then
@<Recover from an unbalanced write command@>;
mode:=old_mode;
end_token_list {conserve stack space}
@ @<Recover from an unbalanced write command@>=
begin print_err("Unbalanced write command");
@.Unbalanced write...@>
help2("On this page there's a \write with fewer real {'s than }'s.")@/
("I can't handle that very well; good luck."); error;
repeat get_token;
until cur_tok=end_write_token;
end
@ The |out_what| procedure takes care of outputting whatsit nodes for
|vlist_out| and |hlist_out|\kern-.3pt.
@<Declare procedures needed in |hlist_out|, |vlist_out|@>=
procedure out_what(@!p:pointer);
var j:small_number; {write stream number}
begin case subtype(p) of
open_node,write_node,close_node:@<Do some work that has been queued up
for \.{\\write}@>;
special_node,latespecial_node:special_out(p);
language_node:do_nothing;
pdf_save_pos_node:
@<Save current position in DVI mode@>;
others: begin
if (pdftex_first_extension_code <= subtype(p)) and (subtype(p) <= pdftex_last_extension_code) then
pdf_error("ext4", "pdf node ended up in DVI mode")
else
confusion("ext4")
@:this can't happen ext4}{\quad ext4@>
end;
endcases;
end;
@ @<Save current position in DVI mode@>=
begin
{4736286 = 1in, the funny DVI origin offset}
pdf_last_x_pos := cur_h + 4736286;
pdf_last_y_pos := cur_page_height - cur_v - 4736286;
end
@ We don't implement \.{\\write} inside of leaders. (The reason is that
the number of times a leader box appears might be different in different
implementations, due to machine-dependent rounding in the glue calculations.)
@^leaders@>
@<Do some work that has been queued up...@>=
if not doing_leaders then
begin j:=write_stream(p);
if subtype(p)=write_node then write_out(p)
else begin if write_open[j] then a_close(write_file[j]);
if subtype(p)=close_node then write_open[j]:=false
else if j<16 then
begin cur_name:=open_name(p); cur_area:=open_area(p);
cur_ext:=open_ext(p);
if cur_ext="" then cur_ext:=".tex";
pack_cur_name;
while not a_open_out(write_file[j]) do
prompt_file_name("output file name",".tex");
write_open[j]:=true;
end;
end;
end
@ The presence of `\.{\\immediate}' causes the |do_extension| procedure
to descend to one level of recursion. Nothing happens unless \.{\\immediate}
is followed by `\.{\\openout}', `\.{\\write}', or `\.{\\closeout}'.
@^recursion@>
@<Implement \.{\\immediate}@>=
begin get_x_token;
if cur_cmd=extension then begin
if cur_chr<=close_node then
begin p:=tail; do_extension; {append a whatsit node}
out_what(tail); {do the action immediately}
flush_node_list(tail); tail:=p; link(p):=null;
end
else case cur_chr of
pdf_obj_code: begin
do_extension; {scan object and set |pdf_last_obj|}
if obj_data_ptr(pdf_last_obj) = 0 then {this object has not been initialized yet}
pdf_error("ext1", "`\pdfobj reserveobjnum' cannot be used with \immediate");
pdf_write_obj(pdf_last_obj);
end;
pdf_xform_code: begin
do_extension; {scan form and set |pdf_last_xform|}
pdf_cur_form := pdf_last_xform;
pdf_ship_out(obj_xform_box(pdf_last_xform), false);
end;
pdf_ximage_code: begin
do_extension; {scan image and set |pdf_last_ximage|}
pdf_write_image(pdf_last_ximage);
end;
othercases back_input
endcases;
end
else
back_input;
end
@ The \.{\\language} extension is somewhat different.
We need a subroutine that comes into play when a character of
a non-|clang| language is being appended to the current paragraph.
@<Declare action...@>=
procedure fix_language;
var @!l:ASCII_code; {the new current language}
begin if language<=0 then l:=0
else if language>255 then l:=0
else l:=language;
if l<>clang then
begin new_whatsit(language_node,small_node_size);
what_lang(tail):=l; clang:=l;@/
what_lhm(tail):=norm_min(left_hyphen_min);
what_rhm(tail):=norm_min(right_hyphen_min);
end;
end;
@ @<Implement \.{\\setlanguage}@>=
if abs(mode)<>hmode then report_illegal_case
else begin new_whatsit(language_node,small_node_size);
scan_int;
if cur_val<=0 then clang:=0
else if cur_val>255 then clang:=0
else clang:=cur_val;
what_lang(tail):=clang;
what_lhm(tail):=norm_min(left_hyphen_min);
what_rhm(tail):=norm_min(right_hyphen_min);
end
@ @<Finish the extensions@>=
for k:=0 to 15 do if write_open[k] then a_close(write_file[k])
@ Shipping out PDF marks.
@<Types...@>=
dest_name_entry = record
objname: str_number; {destination name}
objnum: integer; {destination object number}
end;
@ @<Glob...@>=
@!cur_page_width: scaled; {width of page being shipped}
@!cur_page_height: scaled; {height of page being shipped}
@!cur_h_offset: scaled; {horizontal offset of page being shipped}
@!cur_v_offset: scaled; {vertical offset of page being shipped}
@!pdf_obj_list: pointer; {list of objects in the current page}
@!pdf_xform_list: pointer; {list of forms in the current page}
@!pdf_ximage_list: pointer; {list of images in the current page}
@!last_thread: pointer; {pointer to the last thread}
@!pdf_thread_ht, pdf_thread_dp, pdf_thread_wd: scaled; {dimensions of the last
thread}
@!pdf_last_thread_id: halfword; {identifier of the last thread}
@!pdf_last_thread_named_id: boolean; {is identifier of the last thread named}
@!pdf_thread_level: integer; {depth of nesting of box containing the last thread}
@!pdf_annot_list: pointer; {list of annotations in the current page}
@!pdf_link_list: pointer; {list of link annotations in the current page}
@!pdf_dest_list: pointer; {list of destinations in the current page}
@!pdf_bead_list: pointer; {list of thread beads in the current page}
@!pdf_obj_count: integer; {counter of objects}
@!pdf_xform_count: integer; {counter of forms}
@!pdf_ximage_count: integer; {counter of images}
@!pdf_cur_form: integer; {the form being output}
@!pdf_first_outline, pdf_last_outline, pdf_parent_outline: integer;
@!pdf_xform_width,
@!pdf_xform_height,
@!pdf_xform_depth: scaled; {dimension of the current form}
@!pdf_info_toks: pointer; {additional keys of Info dictionary}
@!pdf_catalog_toks: pointer; {additional keys of Catalog dictionary}
@!pdf_catalog_openaction: integer;
@!pdf_names_toks: pointer; {additional keys of Names dictionary}
@!pdf_dest_names_ptr: integer; {first unused position in |dest_names|}
@!dest_names_size: integer; {maximum number of names in name tree of PDF output file}
@!dest_names: ^dest_name_entry;
@!pk_dpi: integer; {PK pixel density value from \.{texmf.cnf}}
@!image_orig_x, image_orig_y: integer; {origin of cropped PDF images}
@!pdf_trailer_toks: pointer; {additional keys of Trailer dictionary}
@!pdf_trailer_id_toks: pointer; {custom Trailer ID}
@!gen_faked_interword_space: boolean; {flag to turn on/off faked interword spaces}
@!gen_running_link: boolean; {flag to turn on/off running link}
@!pdf_space_font_name: str_number; {name of font used for inter-word space in PDF output}
@ @<Set init...@>=
pdf_first_outline:= 0;
pdf_last_outline:= 0;
pdf_parent_outline:= 0;
pdf_obj_count := 0;
pdf_xform_count := 0;
pdf_ximage_count := 0;
pdf_dest_names_ptr := 0;
pdf_info_toks := null;
pdf_catalog_toks := null;
pdf_names_toks := null;
pdf_catalog_openaction := 0;
pdf_trailer_toks := null;
pdf_trailer_id_toks := null;
gen_faked_interword_space := false;
gen_running_link := true;
pdf_space_font_name := "pdftexspace";
@ The following procedures are needed for outputting whatsit nodes for
\pdfTeX{}.
@<Declare procedures needed in |pdf_hlist_out|, |pdf_vlist_out|@>=
procedure write_action(p: pointer); {write an action specification}
var s: str_number;
d: integer;
begin
if pdf_action_type(p) = pdf_action_user then begin
pdf_print_toks_ln(pdf_action_user_tokens(p));
return;
end;
pdf_print("<< ");
if pdf_action_file(p) <> null then begin
pdf_print("/F ");
s := tokens_to_string(pdf_action_file(p));
if (str_pool[str_start[s]] = 40) and
(str_pool[str_start[s] + length(s) - 1] = 41) then
pdf_print(s)
else begin
pdf_print_str(s);
end;
flush_str(s);
pdf_print(" ");
if pdf_action_new_window(p) > 0 then begin
pdf_print("/NewWindow ");
if pdf_action_new_window(p) = 1 then
pdf_print("true ")
else
pdf_print("false ");
end;
end;
case pdf_action_type(p) of
pdf_action_page: begin
if pdf_action_file(p) = null then begin
pdf_print("/S /GoTo /D [");
pdf_print_int(get_obj(obj_type_page, pdf_action_id(p), false));
pdf_print(" 0 R");
end
else begin
pdf_print("/S /GoToR /D [");
pdf_print_int(pdf_action_id(p) - 1);
end;
pdf_out(" ");
pdf_print(tokens_to_string(pdf_action_page_tokens(p)));
flush_str(last_tokens_string);
pdf_out("]");
end;
pdf_action_goto: begin
if pdf_action_file(p) = null then begin
pdf_print("/S /GoTo ");
d := get_obj(obj_type_dest, pdf_action_id(p),
pdf_action_named_id(p) mod 2);
end
else
pdf_print("/S /GoToR ");
if (pdf_action_named_id(p) mod 2) = 1 then begin
pdf_str_entry("D", tokens_to_string(pdf_action_id(p)));
flush_str(last_tokens_string);
end
else if pdf_action_file(p) = null then
pdf_indirect("D", d)
else
pdf_error("ext4", "`goto' option cannot be used with both `file' and `num'");
end;
pdf_action_thread: begin
pdf_print("/S /Thread ");
if pdf_action_file(p) = null then
d := get_obj(obj_type_thread, pdf_action_id(p),
pdf_action_named_id(p) mod 2);
if (pdf_action_named_id(p) mod 2) = 1 then begin
pdf_str_entry("D", tokens_to_string(pdf_action_id(p)));
flush_str(last_tokens_string);
end
else if pdf_action_file(p) = null then
pdf_indirect("D", d)
else
pdf_int_entry("D", pdf_action_id(p));
end;
endcases;
if pdf_action_struct_id(p) <> null then begin
pdf_out(" ");
if pdf_action_file(p) = null then
pdf_indirect("SD", get_obj(obj_type_struct_dest,
pdf_action_struct_id(p),
(pdf_action_named_id(p) div 2) mod 2))
else begin
pdf_print("/SD ");
pdf_print(tokens_to_string(pdf_action_struct_id(p)));
flush_str(last_tokens_string);
end;
end;
pdf_print_ln(" >>");
end;
procedure set_rect_dimens(p, parent_box: pointer; x, y, w, h, d, margin: scaled);
begin
pdf_left(p) := cur_h;
if is_running(w) then
pdf_right(p) := x + width(parent_box)
else
pdf_right(p) := cur_h + w;
if is_running(h) then
pdf_top(p) := y - height(parent_box)
else
pdf_top(p) := cur_v - h;
if is_running(d) then
pdf_bottom(p) := y + depth(parent_box)
else
pdf_bottom(p) := cur_v + d;
if is_shipping_page and matrixused then begin
matrixtransformrect(pdf_left(p), cur_page_height - pdf_bottom(p),
pdf_right(p), cur_page_height - pdf_top(p));
pdf_left(p) := getllx;
pdf_bottom(p) := cur_page_height - getlly;
pdf_right(p) := geturx;
pdf_top(p) := cur_page_height - getury;
end;
pdf_left(p) := pdf_left(p) - margin;
pdf_top(p) := pdf_top(p) - margin;
pdf_right(p) := pdf_right(p) + margin;
pdf_bottom(p) := pdf_bottom(p) + margin;
end;
procedure do_annot(p, parent_box: pointer; x, y: scaled);
begin
if not is_shipping_page then
pdf_error("ext4", "annotations cannot be inside an XForm");
if doing_leaders then
return;
if is_obj_scheduled(pdf_annot_objnum(p)) then
pdf_annot_objnum(p) := pdf_new_objnum;
set_rect_dimens(p, parent_box, x, y,
pdf_width(p), pdf_height(p), pdf_depth(p), 0);
obj_annot_ptr(pdf_annot_objnum(p)) := p;
pdf_append_list(pdf_annot_objnum(p))(pdf_annot_list);
set_obj_scheduled(pdf_annot_objnum(p));
end;
@ To implement nested link annotations, we need a stack to hold copy of
|pdf_start_link_node|'s that are being written out, together with their box
nesting level.
@d pdf_link_stack_top == pdf_link_stack[pdf_link_stack_ptr]
@<Constants...@>=
@!pdf_max_link_level = 10; {maximum depth of link nesting}
@ @<Types...@>=
@!pdf_link_stack_record = record
nesting_level: integer;
link_node: pointer; {holds a copy of the corresponding |pdf_start_link_node|}
ref_link_node: pointer; {points to original |pdf_start_link_node|, or a
copy of |link_node| created by |append_link| in
case of multi-line link}
end;
@ @<Glob...@>=
@!pdf_link_stack: array[1..pdf_max_link_level] of pdf_link_stack_record;
@!pdf_link_stack_ptr: small_number;
@ @<Set init...@>=
pdf_link_stack_ptr := 0;
@ @<Declare procedures needed in |pdf_hlist_out|, |pdf_vlist_out|@>=
procedure push_link_level(p: pointer);
begin
if pdf_link_stack_ptr >= pdf_max_link_level then
overflow("pdf link stack size", pdf_max_link_level);
pdfassert((type(p) = whatsit_node) and (subtype(p) = pdf_start_link_node));
incr(pdf_link_stack_ptr);
pdf_link_stack_top.nesting_level := cur_s;
pdf_link_stack_top.link_node := copy_node_list(p);
pdf_link_stack_top.ref_link_node := p;
end;
procedure pop_link_level;
begin
pdfassert(pdf_link_stack_ptr > 0);
flush_node_list(pdf_link_stack_top.link_node);
decr(pdf_link_stack_ptr);
end;
procedure do_link(p, parent_box: pointer; x, y: scaled);
begin
if not is_shipping_page then
pdf_error("ext4", "link annotations cannot be inside an XForm");
pdfassert(type(parent_box) = hlist_node);
if is_obj_scheduled(pdf_link_objnum(p)) then
pdf_link_objnum(p) := pdf_new_objnum;
push_link_level(p);
set_rect_dimens(p, parent_box, x, y,
pdf_width(p), pdf_height(p), pdf_depth(p),
pdf_link_margin);
obj_annot_ptr(pdf_link_objnum(p)) := p; {the reference for the pdf annot object
must be set here}
pdf_append_list(pdf_link_objnum(p))(pdf_link_list);
set_obj_scheduled(pdf_link_objnum(p));
end;
procedure end_link;
var p: pointer;
begin
if pdf_link_stack_ptr < 1 then
pdf_error("ext4", "pdf_link_stack empty, \pdfendlink used without \pdfstartlink?");
if pdf_link_stack_top.nesting_level <> cur_s then
pdf_warning(0, "\pdfendlink ended up in different nesting level than \pdfstartlink", true, true);
{N.B.: test for running link must be done on |link_node| and not |ref_link_node|,
as |ref_link_node| can be set by |do_link| or |append_link| already}
if is_running(pdf_width(pdf_link_stack_top.link_node)) then begin
p := pdf_link_stack_top.ref_link_node;
if is_shipping_page and matrixused then begin
matrixrecalculate(cur_h + pdf_link_margin);
pdf_left(p) := getllx - pdf_link_margin;
pdf_top(p) := cur_page_height - getury - pdf_link_margin;
pdf_right(p) := geturx + pdf_link_margin;
pdf_bottom(p) := cur_page_height - getlly + pdf_link_margin;
end
else
pdf_right(p) := cur_h + pdf_link_margin;
end;
pop_link_level;
end;
@ For ``running'' annotations we must append a new node when the end of
annotation is in other box than its start. The new created node is identical to
corresponding whatsit node representing the start of annotation, but its
|info| field is |max_halfword|. We set |info| field just before destroying the
node, in order to use |flush_node_list| to do the job.
@<Declare procedures needed in |pdf_hlist_out|, |pdf_vlist_out|@>=
procedure append_link(parent_box: pointer; x, y: scaled; i: small_number); {append a new
pdf annot to |pdf_link_list|}
var p: pointer;
begin
pdfassert(type(parent_box) = hlist_node);
p := copy_node_list(pdf_link_stack[i].link_node);
pdf_link_stack[i].ref_link_node := p;
info(p) := max_halfword; {mark that this node is not a whatsit node}
link(p) := null; {this node is not linked in any list}
set_rect_dimens(p, parent_box, x, y,
pdf_width(p), pdf_height(p), pdf_depth(p),
pdf_link_margin);
pdf_create_obj(obj_type_others, 0);
obj_annot_ptr(obj_ptr) := p;
pdf_append_list(obj_ptr)(pdf_link_list);
end;
@ Threads are handled in similar way as link annotations.
@<Declare procedures needed in |pdf_hlist_out|, |pdf_vlist_out|@>=
procedure append_bead(p: pointer);
var a, b, c, t: integer;
begin
if not is_shipping_page then
pdf_error("ext4", "threads cannot be inside an XForm");
t := get_obj(obj_type_thread, pdf_thread_id(p), pdf_thread_named_id(p));
b := pdf_new_objnum;
obj_bead_ptr(b) := pdf_get_mem(pdfmem_bead_size);
obj_bead_page(b) := pdf_last_page;
obj_bead_data(b) := p;
if pdf_thread_attr(p) <> null then
obj_bead_attr(b) := tokens_to_string(pdf_thread_attr(p))
else
obj_bead_attr(b) := 0;
if obj_thread_first(t) = 0 then begin
obj_thread_first(t) := b;
obj_bead_next(b) := b;
obj_bead_prev(b) := b;
end
else begin
a := obj_thread_first(t);
c := obj_bead_prev(a);
obj_bead_prev(b) := c;
obj_bead_next(b) := a;
obj_bead_prev(a) := b;
obj_bead_next(c) := b;
end;
pdf_append_list(b)(pdf_bead_list);
end;
procedure do_thread(p, parent_box: pointer; x, y: scaled);
begin
if doing_leaders then
return;
if subtype(p) = pdf_start_thread_node then begin
pdf_thread_wd := pdf_width(p);
pdf_thread_ht := pdf_height(p);
pdf_thread_dp := pdf_depth(p);
pdf_last_thread_id := pdf_thread_id(p);
pdf_last_thread_named_id := (pdf_thread_named_id(p) > 0);
if pdf_last_thread_named_id then
add_token_ref(pdf_thread_id(p));
pdf_thread_level := cur_s;
end;
set_rect_dimens(p, parent_box, x, y,
pdf_width(p), pdf_height(p), pdf_depth(p),
pdf_thread_margin);
append_bead(p);
last_thread := p;
end;
procedure append_thread(parent_box: pointer; x, y: scaled);
var p: pointer;
begin
p := get_node(pdf_thread_node_size);
info(p) := max_halfword; {this is not a whatsit node}
link(p) := null; {this node will be destroyed separately}
pdf_width(p) := pdf_thread_wd;
pdf_height(p) := pdf_thread_ht;
pdf_depth(p) := pdf_thread_dp;
pdf_thread_attr(p) := null;
pdf_thread_id(p) := pdf_last_thread_id;
if pdf_last_thread_named_id then begin
add_token_ref(pdf_thread_id(p));
pdf_thread_named_id(p) := 1;
end
else
pdf_thread_named_id(p) := 0;
set_rect_dimens(p, parent_box, x, y,
pdf_width(p), pdf_height(p), pdf_depth(p),
pdf_thread_margin);
append_bead(p);
last_thread := p;
end;
procedure end_thread;
begin
if pdf_thread_level <> cur_s then
pdf_error("ext4", "\pdfendthread ended up in different nesting level than \pdfstartthread");
if is_running(pdf_thread_dp) and (last_thread <> null) then
pdf_bottom(last_thread) := cur_v + pdf_thread_margin;
if pdf_last_thread_named_id then
delete_token_ref(pdf_last_thread_id);
last_thread := null;
end;
function open_subentries(p: pointer): integer;
var k, c: integer;
l, r: integer;
begin
k := 0;
if obj_outline_first(p) <> 0 then begin
l := obj_outline_first(p);
repeat
incr(k);
c := open_subentries(l);
if obj_outline_count(l) > 0 then
k := k + c;
obj_outline_parent(l) := p;
r := obj_outline_next(l);
if r = 0 then
obj_outline_last(p) := l;
l := r;
until l = 0;
end;
if obj_outline_count(p) > 0 then
obj_outline_count(p) := k
else
obj_outline_count(p) := -k;
open_subentries := k;
end;
procedure do_dest(p, parent_box: pointer; x, y: scaled);
var k: integer;
begin
if not is_shipping_page then
pdf_error("ext4", "destinations cannot be inside an XForm");
if doing_leaders then
return;
if pdf_dest_objnum(p) = null then
k := get_obj(obj_type_dest, pdf_dest_id(p), pdf_dest_named_id(p))
else
k := get_obj(obj_type_struct_dest, pdf_dest_id(p), pdf_dest_named_id(p));
if obj_dest_ptr(k) <> null then begin
warn_dest_dup(pdf_dest_id(p), pdf_dest_named_id(p),
"ext4", "has been already used, duplicate ignored");
return;
end;
obj_dest_ptr(k) := p;
pdf_append_list(k)(pdf_dest_list);
case pdf_dest_type(p) of
pdf_dest_xyz:
if matrixused then
set_rect_dimens(p, parent_box, x, y,
pdf_width(p), pdf_height(p), pdf_depth(p),
pdf_dest_margin)
else begin
pdf_left(p) := cur_h;
pdf_top(p) := cur_v;
end;
pdf_dest_fith,
pdf_dest_fitbh:
if matrixused then
set_rect_dimens(p, parent_box, x, y,
pdf_width(p), pdf_height(p), pdf_depth(p),
pdf_dest_margin)
else
pdf_top(p) := cur_v;
pdf_dest_fitv,
pdf_dest_fitbv:
if matrixused then
set_rect_dimens(p, parent_box, x, y,
pdf_width(p), pdf_height(p), pdf_depth(p),
pdf_dest_margin)
else
pdf_left(p) := cur_h;
pdf_dest_fit,
pdf_dest_fitb:
do_nothing;
pdf_dest_fitr:
set_rect_dimens(p, parent_box, x, y,
pdf_width(p), pdf_height(p), pdf_depth(p),
pdf_dest_margin);
endcases;
end;
procedure out_form(p: pointer);
begin
pdf_end_text;
pdf_print_ln("q");
if pdf_lookup_list(pdf_xform_list, pdf_xform_objnum(p)) = null then
pdf_append_list(pdf_xform_objnum(p))(pdf_xform_list);
cur_v := cur_v + obj_xform_depth(pdf_xform_objnum(p));
pdf_print("1 0 0 1 ");
pdf_print_bp(pdf_x(cur_h)); pdf_out(" ");
pdf_print_bp(pdf_y(cur_v));
pdf_print_ln(" cm");
pdf_print("/Fm");
pdf_print_int(obj_info(pdf_xform_objnum(p)));
pdf_print_resname_prefix;
pdf_print_ln(" Do");
pdf_print_ln("Q");
end;
procedure out_image(p: pointer);
var image, groupref: integer;
img_w, img_h: integer;
begin
image := obj_ximage_data(pdf_ximage_objnum(p));
if (image_rotate(image) = 90) or (image_rotate(image) = 270) then begin
img_h := image_width(image);
img_w := image_height(image);
end else begin
img_w := image_width(image);
img_h := image_height(image);
end;
pdf_end_text;
pdf_print_ln("q");
if pdf_lookup_list(pdf_ximage_list, pdf_ximage_objnum(p)) = null then
pdf_append_list(pdf_ximage_objnum(p))(pdf_ximage_list);
if not is_pdf_image(image) then begin
if is_png_image(image) then begin
groupref := get_image_group_ref(image);
if (groupref > 0) and (pdf_page_group_val = 0) then
pdf_page_group_val := groupref;
end;
pdf_print_real(ext_xn_over_d(pdf_width(p),
ten_pow[6], one_hundred_bp), 4);
pdf_print(" 0 0 ");
pdf_print_real(ext_xn_over_d(pdf_height(p) + pdf_depth(p),
ten_pow[6], one_hundred_bp), 4);
pdf_out(" ");
pdf_print_bp(pdf_x(cur_h)); pdf_out(" ");
pdf_print_bp(pdf_y(cur_v));
end
else begin
{for pdf images we generate the page group object number here}
groupref := get_image_group_ref(image); {0: no group, -1: to be generated; >0: already written}
if (groupref <> 0) and (pdf_page_group_val = 0) then begin
if groupref = -1 then begin
pdf_page_group_val := pdf_new_objnum;
set_image_group_ref(image, pdf_page_group_val);
end
else { groupref > 0 }
pdf_page_group_val := groupref;
end;
pdf_print_real(ext_xn_over_d(pdf_width(p),
ten_pow[6], img_w), 6);
pdf_print(" 0 0 ");
pdf_print_real(ext_xn_over_d(pdf_height(p) + pdf_depth(p),
ten_pow[6], img_h), 6);
pdf_out(" ");
pdf_print_bp(pdf_x(cur_h) -
ext_xn_over_d(pdf_width(p), epdf_orig_x(image),
img_w));
pdf_out(" ");
pdf_print_bp(pdf_y(cur_v) -
ext_xn_over_d(pdf_height(p) + pdf_depth(p), epdf_orig_y(image),
img_h));
end;
pdf_print_ln(" cm");
pdf_print("/Im");
pdf_print_int(obj_info(pdf_ximage_objnum(p)));
pdf_print_resname_prefix;
pdf_print_ln(" Do");
pdf_print_ln("Q");
end;
function gap_amount(p: pointer; cur_pos: scaled): scaled; {find the gap between
the position of the current snap node |p| and the nearest point on the grid}
var snap_unit, stretch_amount, shrink_amount: scaled;
last_pos, next_pos, g, g2: scaled;
begin
snap_unit := width(snap_glue_ptr(p));
if stretch_order(snap_glue_ptr(p)) > normal then
stretch_amount := max_dimen
else
stretch_amount := stretch(snap_glue_ptr(p));
if shrink_order(snap_glue_ptr(p)) > normal then
shrink_amount := max_dimen
else
shrink_amount := shrink(snap_glue_ptr(p));
if subtype(p) = pdf_snapy_node then
last_pos := pdf_snapy_refpos +
snap_unit * ((cur_pos - pdf_snapy_refpos) div snap_unit)
else
pdf_error("snapping", "invalid parameter value for gap_amount");
next_pos := last_pos + snap_unit;
@{
print_nl("snap ref pos = "); print_scaled(pdf_snapy_refpos);
print_nl("snap glue = "); print_spec(snap_glue_ptr(p), 0);
print_nl("gap amount = "); print_scaled(snap_unit);
print_nl("stretch amount = "); print_scaled(stretch_amount);
print_nl("shrink amount = "); print_scaled(shrink_amount);
print_nl("last point = "); print_scaled(last_pos);
print_nl("cur point = "); print_scaled(cur_pos);
print_nl("next point = "); print_scaled(next_pos);
@}
g := max_dimen;
g2 := max_dimen;
gap_amount := 0;
if cur_pos - last_pos < shrink_amount then
g := cur_pos - last_pos;
if (next_pos - cur_pos < stretch_amount) then
g2 := next_pos - cur_pos;
if (g = max_dimen) and (g2 = max_dimen) then
return; {unable to snap}
if g2 <= g then
gap_amount := g2 {skip forward}
else
gap_amount := -g; {skip backward}
end;
function get_vpos(p, q, b: pointer): pointer; {find the vertical position of
node |q| in the output PDF page; this functions is called when the current node
is |p| and current position is |cur_v| (global variable); |b| is the parent
box;}
var tmp_v: scaled;
g_order: glue_ord; {applicable order of infinity for glue}
g_sign: normal..shrinking; {selects type of glue}
glue_temp: real; {glue value before rounding}
cur_glue: real; {glue seen so far}
cur_g: scaled; {rounded equivalent of |cur_glue| times the glue ratio}
this_box: pointer; {pointer to containing box}
begin
tmp_v := cur_v;
this_box := b;
cur_g := 0;
cur_glue := float_constant(0);
g_order := glue_order(this_box);
g_sign := glue_sign(this_box);
while (p <> q) and (p <> null) do begin
if is_char_node(p) then
confusion("get_vpos")
else begin
case type(p) of
hlist_node,
vlist_node,
rule_node:
tmp_v := tmp_v + height(p) + depth(p);
whatsit_node:
if (subtype(p) = pdf_refxform_node) or
(subtype(p) = pdf_refximage_node) then
tmp_v := tmp_v + pdf_height(p) + pdf_depth(p);
glue_node: begin
@<Move down without outputting leaders@>;
tmp_v := tmp_v + rule_ht;
end;
kern_node:
tmp_v := tmp_v + width(p);
othercases do_nothing;
endcases;
end;
p := link(p);
end;
get_vpos := tmp_v;
end;
procedure do_snapy_comp(p, b: pointer); {do snapping compensation in vertical
direction; search for the next snap node and do the compensation if found}
var q: pointer;
tmp_v, g, g2: scaled;
begin
if not (not is_char_node(p) and
(type(p) = whatsit_node) and
(subtype(p) = pdf_snapy_comp_node))
then
pdf_error("snapping", "invalid parameter value for do_snapy_comp");
q := p;
while (q <> null) do begin
if not is_char_node(q) and
(type(q) = whatsit_node) and
(subtype(q) = pdf_snapy_node)
then begin
tmp_v := get_vpos(p, q, b); {get the position of |q|}
g := gap_amount(q, tmp_v); {get the gap to the grid}
g2 := round_xn_over_d(g, snapy_comp_ratio(p), 1000); {adjustment for |p|}
@{
print_nl("do_snapy_comp: tmp_v = "); print_scaled(tmp_v);
print_nl("do_snapy_comp: cur_v = "); print_scaled(cur_v);
print_nl("do_snapy_comp: g = "); print_scaled(g);
print_nl("do_snapy_comp: g2 = "); print_scaled(g2);
@}
cur_v := cur_v + g2;
final_skip(q) := g - g2; {adjustment for |q|}
if final_skip(q) = 0 then
final_skip(q) := 1; {use |1sp| as the magic value to record
that |final_skip| has been set here}
return;
end;
q := link(q);
end;
end;
procedure do_snapy(p: pointer);
begin
incr(count_do_snapy);
@{
print_nl("do_snapy: count = "); print_int(count_do_snapy);
print_nl("do_snapy: cur_v = "); print_scaled(cur_v);
print_nl("do_snapy: final skip = "); print_scaled(final_skip(p));
@}
if final_skip(p) <> 0 then
cur_v := cur_v + final_skip(p)
else
cur_v := cur_v + gap_amount(p, cur_v);
@{
print_nl("do_snapy: cur_v after snap = "); print_scaled(cur_v);
@}
end;
@ @<Move down without outputting leaders@>=
begin g:=glue_ptr(p); rule_ht:=width(g)-cur_g;
if g_sign<>normal then
begin if g_sign=stretching then
begin if stretch_order(g)=g_order then
begin cur_glue:=cur_glue+stretch(g);
vet_glue(float(glue_set(this_box))*cur_glue);
@^real multiplication@>
cur_g:=round(glue_temp);
end;
end
else if shrink_order(g)=g_order then
begin cur_glue:=cur_glue-shrink(g);
vet_glue(float(glue_set(this_box))*cur_glue);
cur_g:=round(glue_temp);
end;
end;
rule_ht:=rule_ht+cur_g;
end
@ @<Output the whatsit node |p| in |pdf_vlist_out|@>=
case subtype(p) of
pdf_literal_node,pdf_lateliteral_node:
pdf_out_literal(p);
pdf_colorstack_node:
pdf_out_colorstack(p);
pdf_setmatrix_node:
pdf_out_setmatrix(p);
pdf_save_node:
pdf_out_save(p);
pdf_restore_node:
pdf_out_restore(p);
pdf_refobj_node:
pdf_append_list(pdf_obj_objnum(p))(pdf_obj_list);
pdf_refxform_node:
@<Output a Form node in a vlist@>;
pdf_refximage_node:
@<Output a Image node in a vlist@>;
pdf_annot_node:
do_annot(p, this_box, left_edge, top_edge + height(this_box));
pdf_start_link_node:
pdf_error("ext4", "\pdfstartlink ended up in vlist");
pdf_end_link_node:
pdf_error("ext4", "\pdfendlink ended up in vlist");
pdf_dest_node:
do_dest(p, this_box, left_edge, top_edge + height(this_box));
pdf_thread_node,
pdf_start_thread_node:
do_thread(p, this_box, left_edge, top_edge + height(this_box));
pdf_end_thread_node:
end_thread;
pdf_save_pos_node:
@<Save current position to |pdf_last_x_pos|, |pdf_last_y_pos|@>;
special_node,latespecial_node:
pdf_special(p);
pdf_snap_ref_point_node:
@<Save current position to |pdf_snapx_refpos|, |pdf_snapy_refpos|@>;
pdf_snapy_comp_node:
do_snapy_comp(p, this_box);
pdf_snapy_node:
do_snapy(p);
pdf_interword_space_on_node:
gen_faked_interword_space := true;
pdf_interword_space_off_node:
gen_faked_interword_space := false;
pdf_fake_space_node:
pdf_insert_fake_space;
pdf_running_link_off_node:
gen_running_link := false;
pdf_running_link_on_node:
gen_running_link := true;
othercases out_what(p);
endcases
@ @<Glob...@>=
@!is_shipping_page: boolean; {set to |shipping_page| when |pdf_ship_out| starts}
@ @<Save current position to |pdf_last_x_pos|, |pdf_last_y_pos|@>=
begin
pdf_last_x_pos := cur_h;
if is_shipping_page then
pdf_last_y_pos := cur_page_height - cur_v
else
pdf_last_y_pos := pdf_xform_height + pdf_xform_depth - cur_v;
end
@ @<Save current position to |pdf_snapx_refpos|, |pdf_snapy_refpos|@>=
begin
pdf_snapx_refpos := cur_h;
pdf_snapy_refpos := cur_v;
end
@ @<Output a Image node in a vlist@>=
begin cur_v:=cur_v+pdf_height(p)+pdf_depth(p); save_v:=cur_v;
cur_h:=left_edge;
out_image(p);
cur_v:=save_v; cur_h:=left_edge;
end
@ @<Output a Form node in a vlist@>=
begin cur_v:=cur_v+pdf_height(p); save_v:=cur_v;
cur_h:=left_edge;
out_form(p);
cur_v:=save_v+pdf_depth(p); cur_h:=left_edge;
end
@ @<Output the whatsit node |p| in |pdf_hlist_out|@>=
case subtype(p) of
pdf_literal_node,pdf_lateliteral_node:
pdf_out_literal(p);
pdf_colorstack_node:
pdf_out_colorstack(p);
pdf_setmatrix_node:
pdf_out_setmatrix(p);
pdf_save_node:
pdf_out_save(p);
pdf_restore_node:
pdf_out_restore(p);
pdf_refobj_node:
pdf_append_list(pdf_obj_objnum(p))(pdf_obj_list);
pdf_refxform_node:
@<Output a Form node in a hlist@>;
pdf_refximage_node:
@<Output a Image node in a hlist@>;
pdf_annot_node:
do_annot(p, this_box, left_edge, base_line);
pdf_start_link_node:
do_link(p, this_box, left_edge, base_line);
pdf_end_link_node:
end_link;
pdf_dest_node:
do_dest(p, this_box, left_edge, base_line);
pdf_thread_node:
do_thread(p, this_box, left_edge, base_line);
pdf_start_thread_node:
pdf_error("ext4", "\pdfstartthread ended up in hlist");
pdf_end_thread_node:
pdf_error("ext4", "\pdfendthread ended up in hlist");
pdf_save_pos_node:
@<Save current position to |pdf_last_x_pos|, |pdf_last_y_pos|@>;
special_node,latespecial_node:
pdf_special(p);
pdf_snap_ref_point_node:
@<Save current position to |pdf_snapx_refpos|, |pdf_snapy_refpos|@>;
pdf_snapy_comp_node,
pdf_snapy_node: do_nothing; {snapy nodes do nothing in hlist}
pdf_interword_space_on_node:
gen_faked_interword_space := true;
pdf_interword_space_off_node:
gen_faked_interword_space := false;
pdf_fake_space_node:
pdf_insert_fake_space;
pdf_running_link_off_node:
gen_running_link := false;
pdf_running_link_on_node:
gen_running_link := true;
othercases out_what(p);
endcases
@ @<Output a Image node in a hlist@>=
begin
cur_v:=base_line+pdf_depth(p);
edge:=cur_h;
out_image(p);
cur_h:=edge+pdf_width(p); cur_v:=base_line;
end
@ @<Output a Form node in a hlist@>=
begin
cur_v:=base_line;
edge:=cur_h;
out_form(p);
cur_h:=edge+pdf_width(p); cur_v:=base_line;
end
@* \[53a] The extended features of \eTeX.
The program has two modes of operation: (1)~In \TeX\ compatibility mode
it fully deserves the name \TeX\ and there are neither extended features
nor additional primitive commands. There are, however, a few
modifications that would be legitimate in any implementation of \TeX\
such as, e.g., preventing inadequate results of the glue to \.{DVI}
unit conversion during |ship_out|. (2)~In extended mode there are
additional primitive commands and the extended features of \eTeX\ are
available.
The distinction between these two modes of operation initially takes
place when a `virgin' \.{eINITEX} starts without reading a format file.
Later on the values of all \eTeX\ state variables are inherited when
\.{eVIRTEX} (or \.{eINITEX}) reads a format file.
The code below is designed to work for cases where `$|init|\ldots|tini|$'
is a run-time switch.
@<Enable \eTeX, if requested@>=
@!init if (buffer[loc]="*")and(format_ident=" (INITEX)") then
begin no_new_control_sequence:=false;
@<Generate all \eTeX\ primitives@>@;
incr(loc); eTeX_mode:=1; {enter extended mode}
@<Initialize variables for \eTeX\ extended mode@>@;
end;
tini@;@/
if not no_new_control_sequence then {just entered extended mode ?}
no_new_control_sequence:=true@+else
@ The \eTeX\ features available in extended mode are grouped into two
categories: (1)~Some of them are permanently enabled and have no
semantic effect as long as none of the additional primitives are
executed. (2)~The remaining \eTeX\ features are optional and can be
individually enabled and disabled. For each optional feature there is
an \eTeX\ state variable named \.{\\...state}; the feature is enabled,
resp.\ disabled by assigning a positive, resp.\ non-positive value to
that integer.
@d eTeX_state_base=int_base+eTeX_state_code
@d eTeX_state(#)==eqtb[eTeX_state_base+#].int {an \eTeX\ state variable}
@#
@d eTeX_version_code=eTeX_int {code for \.{\\eTeXversion}}
@<Generate all \eTeX...@>=
primitive("lastnodetype",last_item,last_node_type_code);
@!@:last_node_type_}{\.{\\lastnodetype} primitive@>
primitive("eTeXversion",last_item,eTeX_version_code);
@!@:eTeX_version_}{\.{\\eTeXversion} primitive@>
primitive("eTeXrevision",convert,eTeX_revision_code);@/
@!@:eTeX_revision_}{\.{\\eTeXrevision} primitive@>
@ @<Cases of |last_item| for |print_cmd_chr|@>=
last_node_type_code: print_esc("lastnodetype");
eTeX_version_code: print_esc("eTeXversion");
@ @<Cases for fetching an integer value@>=
eTeX_version_code: cur_val:=eTeX_version;
@ @d eTeX_ex==(eTeX_mode=1) {is this extended mode?}
@<Glob...@>=
@!eTeX_mode: 0..1; {identifies compatibility and extended mode}
@ @<Initialize table entries...@>=
eTeX_mode:=0; {initially we are in compatibility mode}
@<Initialize variables for \eTeX\ compatibility mode@>@;
@ @<Dump the \eTeX\ state@>=
dump_int(eTeX_mode);
for j:=0 to eTeX_states-1 do eTeX_state(j):=0; {disable all enhancements}
@ @<Undump the \eTeX\ state@>=
undump(0)(1)(eTeX_mode);
if eTeX_ex then
begin @<Initialize variables for \eTeX\ extended mode@>@;
end
else begin @<Initialize variables for \eTeX\ compatibility mode@>@;
end;
@ The |eTeX_enabled| function simply returns its first argument as
result. This argument is |true| if an optional \eTeX\ feature is
currently enabled; otherwise, if the argument is |false|, the function
gives an error message.
@<Declare \eTeX\ procedures for use...@>=
function eTeX_enabled(@!b:boolean;@!j:quarterword;@!k:halfword):boolean;
begin if not b then
begin print_err("Improper "); print_cmd_chr(j,k);
help1("Sorry, this optional e-TeX feature has been disabled."); error;
end;
eTeX_enabled:=b;
end;
@ First we implement the additional \eTeX\ parameters in the table of
equivalents.
@<Generate all \eTeX...@>=
primitive("everyeof",assign_toks,every_eof_loc);
@!@:every_eof_}{\.{\\everyeof} primitive@>
primitive("tracingassigns",assign_int,int_base+tracing_assigns_code);@/
@!@:tracing_assigns_}{\.{\\tracingassigns} primitive@>
primitive("tracinggroups",assign_int,int_base+tracing_groups_code);@/
@!@:tracing_groups_}{\.{\\tracinggroups} primitive@>
primitive("tracingifs",assign_int,int_base+tracing_ifs_code);@/
@!@:tracing_ifs_}{\.{\\tracingifs} primitive@>
primitive("tracingscantokens",assign_int,int_base+tracing_scan_tokens_code);@/
@!@:tracing_scan_tokens_}{\.{\\tracingscantokens} primitive@>
primitive("tracingnesting",assign_int,int_base+tracing_nesting_code);@/
@!@:tracing_nesting_}{\.{\\tracingnesting} primitive@>
primitive("predisplaydirection",
assign_int,int_base+pre_display_direction_code);@/
@!@:pre_display_direction_}{\.{\\predisplaydirection} primitive@>
primitive("lastlinefit",assign_int,int_base+last_line_fit_code);@/
@!@:last_line_fit_}{\.{\\lastlinefit} primitive@>
primitive("savingvdiscards",assign_int,int_base+saving_vdiscards_code);@/
@!@:saving_vdiscards_}{\.{\\savingvdiscards} primitive@>
primitive("savinghyphcodes",assign_int,int_base+saving_hyph_codes_code);@/
@!@:saving_hyph_codes_}{\.{\\savinghyphcodes} primitive@>
@ @d every_eof==equiv(every_eof_loc)
@<Cases of |assign_toks| for |print_cmd_chr|@>=
every_eof_loc: print_esc("everyeof");
@ @<Cases for |print_param|@>=
tracing_assigns_code:print_esc("tracingassigns");
tracing_groups_code:print_esc("tracinggroups");
tracing_ifs_code:print_esc("tracingifs");
tracing_scan_tokens_code:print_esc("tracingscantokens");
tracing_nesting_code:print_esc("tracingnesting");
pre_display_direction_code:print_esc("predisplaydirection");
last_line_fit_code:print_esc("lastlinefit");
saving_vdiscards_code:print_esc("savingvdiscards");
saving_hyph_codes_code:print_esc("savinghyphcodes");
@ In order to handle \.{\\everyeof} we need an array |eof_seen| of
boolean variables.
@<Glob...@>=
@!eof_seen : array[1..max_in_open] of boolean; {has eof been seen?}
@ The |print_group| procedure prints the current level of grouping and
the name corresponding to |cur_group|.
@<Declare \eTeX\ procedures for tr...@>=
procedure print_group(@!e:boolean);
label exit;
begin case cur_group of
bottom_level: begin print("bottom level"); return;
end;
simple_group,semi_simple_group:
begin if cur_group=semi_simple_group then print("semi ");
print("simple");
end;
hbox_group,adjusted_hbox_group:
begin if cur_group=adjusted_hbox_group then print("adjusted ");
print("hbox");
end;
vbox_group: print("vbox");
vtop_group: print("vtop");
align_group,no_align_group:
begin if cur_group=no_align_group then print("no ");
print("align");
end;
output_group: print("output");
disc_group: print("disc");
insert_group: print("insert");
vcenter_group: print("vcenter");
math_group,math_choice_group,math_shift_group,math_left_group:
begin print("math");
if cur_group=math_choice_group then print(" choice")
else if cur_group=math_shift_group then print(" shift")
else if cur_group=math_left_group then print(" left");
end;
end; {there are no other cases}
print(" group (level "); print_int(qo(cur_level)); print_char(")");
if saved(-1)<>0 then
begin if e then print(" entered at line ") else print(" at line ");
print_int(saved(-1));
end;
exit:end;
@ The |group_trace| procedure is called when a new level of grouping
begins (|e=false|) or ends (|e=true|) with |saved(-1)| containing the
line number.
@<Declare \eTeX\ procedures for tr...@>=
@!stat procedure group_trace(@!e:boolean);
begin begin_diagnostic; print_char("{");
if e then print("leaving ") else print("entering ");
print_group(e); print_char("}"); end_diagnostic(false);
end;
tats
@ The \.{\\currentgrouplevel} and \.{\\currentgrouptype} commands return
the current level of grouping and the type of the current group
respectively.
@d current_group_level_code=eTeX_int+1 {code for \.{\\currentgrouplevel}}
@d current_group_type_code=eTeX_int+2 {code for \.{\\currentgrouptype}}
@<Generate all \eTeX...@>=
primitive("currentgrouplevel",last_item,current_group_level_code);
@!@:current_group_level_}{\.{\\currentgrouplevel} primitive@>
primitive("currentgrouptype",last_item,current_group_type_code);
@!@:current_group_type_}{\.{\\currentgrouptype} primitive@>
@ @<Cases of |last_item| for |print_cmd_chr|@>=
current_group_level_code: print_esc("currentgrouplevel");
current_group_type_code: print_esc("currentgrouptype");
@ @<Cases for fetching an integer value@>=
current_group_level_code: cur_val:=cur_level-level_one;
current_group_type_code: cur_val:=cur_group;
@ The \.{\\currentiflevel}, \.{\\currentiftype}, and
\.{\\currentifbranch} commands return the current level of conditionals
and the type and branch of the current conditional.
@d current_if_level_code=eTeX_int+3 {code for \.{\\currentiflevel}}
@d current_if_type_code=eTeX_int+4 {code for \.{\\currentiftype}}
@d current_if_branch_code=eTeX_int+5 {code for \.{\\currentifbranch}}
@<Generate all \eTeX...@>=
primitive("currentiflevel",last_item,current_if_level_code);
@!@:current_if_level_}{\.{\\currentiflevel} primitive@>
primitive("currentiftype",last_item,current_if_type_code);
@!@:current_if_type_}{\.{\\currentiftype} primitive@>
primitive("currentifbranch",last_item,current_if_branch_code);
@!@:current_if_branch_}{\.{\\currentifbranch} primitive@>
@ @<Cases of |last_item| for |print_cmd_chr|@>=
current_if_level_code: print_esc("currentiflevel");
current_if_type_code: print_esc("currentiftype");
current_if_branch_code: print_esc("currentifbranch");
@ @<Cases for fetching an integer value@>=
current_if_level_code: begin q:=cond_ptr; cur_val:=0;
while q<>null do
begin incr(cur_val); q:=link(q);
end;
end;
current_if_type_code: if cond_ptr=null then cur_val:=0
else if cur_if<unless_code then cur_val:=cur_if+1
else cur_val:=-(cur_if-unless_code+1);
current_if_branch_code:
if (if_limit=or_code)or(if_limit=else_code) then cur_val:=1
else if if_limit=fi_code then cur_val:=-1
else cur_val:=0;
@ The \.{\\fontcharwd}, \.{\\fontcharht}, \.{\\fontchardp}, and
\.{\\fontcharic} commands return information about a character in a
font.
@d font_char_wd_code=eTeX_dim {code for \.{\\fontcharwd}}
@d font_char_ht_code=eTeX_dim+1 {code for \.{\\fontcharht}}
@d font_char_dp_code=eTeX_dim+2 {code for \.{\\fontchardp}}
@d font_char_ic_code=eTeX_dim+3 {code for \.{\\fontcharic}}
@<Generate all \eTeX...@>=
primitive("fontcharwd",last_item,font_char_wd_code);
@!@:font_char_wd_}{\.{\\fontcharwd} primitive@>
primitive("fontcharht",last_item,font_char_ht_code);
@!@:font_char_ht_}{\.{\\fontcharht} primitive@>
primitive("fontchardp",last_item,font_char_dp_code);
@!@:font_char_dp_}{\.{\\fontchardp} primitive@>
primitive("fontcharic",last_item,font_char_ic_code);
@!@:font_char_ic_}{\.{\\fontcharic} primitive@>
@ @<Cases of |last_item| for |print_cmd_chr|@>=
font_char_wd_code: print_esc("fontcharwd");
font_char_ht_code: print_esc("fontcharht");
font_char_dp_code: print_esc("fontchardp");
font_char_ic_code: print_esc("fontcharic");
@ @<Cases for fetching a dimension value@>=
font_char_wd_code,
font_char_ht_code,
font_char_dp_code,
font_char_ic_code: begin scan_font_ident; q:=cur_val; scan_char_num;
if (font_bc[q]<=cur_val)and(font_ec[q]>=cur_val) then
begin i:=char_info(q)(qi(cur_val));
case m of
font_char_wd_code: cur_val:=char_width(q)(i);
font_char_ht_code: cur_val:=char_height(q)(height_depth(i));
font_char_dp_code: cur_val:=char_depth(q)(height_depth(i));
font_char_ic_code: cur_val:=char_italic(q)(i);
end; {there are no other cases}
end
else cur_val:=0;
end;
@ The \.{\\parshapedimen}, \.{\\parshapeindent}, and \.{\\parshapelength}
commands return the indent and length parameters of the current
\.{\\parshape} specification.
@d par_shape_length_code=eTeX_dim+4 {code for \.{\\parshapelength}}
@d par_shape_indent_code=eTeX_dim+5 {code for \.{\\parshapeindent}}
@d par_shape_dimen_code=eTeX_dim+6 {code for \.{\\parshapedimen}}
@<Generate all \eTeX...@>=
primitive("parshapelength",last_item,par_shape_length_code);
@!@:par_shape_length_}{\.{\\parshapelength} primitive@>
primitive("parshapeindent",last_item,par_shape_indent_code);
@!@:par_shape_indent_}{\.{\\parshapeindent} primitive@>
primitive("parshapedimen",last_item,par_shape_dimen_code);
@!@:par_shape_dimen_}{\.{\\parshapedimen} primitive@>
@ @<Cases of |last_item| for |print_cmd_chr|@>=
par_shape_length_code: print_esc("parshapelength");
par_shape_indent_code: print_esc("parshapeindent");
par_shape_dimen_code: print_esc("parshapedimen");
@ @<Cases for fetching a dimension value@>=
par_shape_length_code,
par_shape_indent_code,
par_shape_dimen_code: begin q:=cur_chr-par_shape_length_code; scan_int;
if (par_shape_ptr=null)or(cur_val<=0) then cur_val:=0
else begin if q=2 then
begin q:=cur_val mod 2; cur_val:=(cur_val+q)div 2;
end;
if cur_val>info(par_shape_ptr) then cur_val:=info(par_shape_ptr);
cur_val:=mem[par_shape_ptr+2*cur_val-q].sc;
end;
cur_val_level:=dimen_val;
end;
@ The \.{\\showgroups} command displays all currently active grouping
levels.
@d show_groups=4 { \.{\\showgroups} }
@<Generate all \eTeX...@>=
primitive("showgroups",xray,show_groups);
@!@:show_groups_}{\.{\\showgroups} primitive@>
@ @<Cases of |xray| for |print_cmd_chr|@>=
show_groups:print_esc("showgroups");
@ @<Cases for |show_whatever|@>=
show_groups: begin begin_diagnostic; show_save_groups;
end;
@ @<Types...@>=
@!save_pointer=0..save_size; {index into |save_stack|}
@ The modifications of \TeX\ required for the display produced by the
|show_save_groups| procedure were first discussed by Donald~E. Knuth in
{\sl TUGboat\/} {\bf 11}, 165--170 and 499--511, 1990.
@^Knuth, Donald Ervin@>
In order to understand a group type we also have to know its mode.
Since unrestricted horizontal modes are not associated with grouping,
they are skipped when traversing the semantic nest.
@<Declare \eTeX\ procedures for use...@>=
procedure show_save_groups;
label found1,found2,found,done;
var p:0..nest_size; {index into |nest|}
@!m:-mmode..mmode; {mode}
@!v:save_pointer; {saved value of |save_ptr|}
@!l:quarterword; {saved value of |cur_level|}
@!c:group_code; {saved value of |cur_group|}
@!a:-1..1; {to keep track of alignments}
@!i:integer;
@!j:quarterword;
@!s:str_number;
begin p:=nest_ptr; nest[p]:=cur_list; {put the top level into the array}
v:=save_ptr; l:=cur_level; c:=cur_group;
save_ptr:=cur_boundary; decr(cur_level);@/
a:=1;
print_nl(""); print_ln;
loop@+begin print_nl("### "); print_group(true);
if cur_group=bottom_level then goto done;
repeat m:=nest[p].mode_field;
if p>0 then decr(p) else m:=vmode;
until m<>hmode;
print(" (");
case cur_group of
simple_group: begin incr(p); goto found2;
end;
hbox_group,adjusted_hbox_group: s:="hbox";
vbox_group: s:="vbox";
vtop_group: s:="vtop";
align_group: if a=0 then
begin if m=-vmode then s:="halign" else s:="valign";
a:=1; goto found1;
end
else begin if a=1 then print("align entry") else print_esc("cr");
if p>=a then p:=p-a;
a:=0; goto found;
end;
no_align_group:
begin incr(p); a:=-1; print_esc("noalign"); goto found2;
end;
output_group:
begin print_esc("output"); goto found;
end;
math_group: goto found2;
disc_group,math_choice_group:
begin if cur_group=disc_group then print_esc("discretionary")
else print_esc("mathchoice");
for i:=1 to 3 do if i<=saved(-2) then print("{}");
goto found2;
end;
insert_group:
begin if saved(-2)=255 then print_esc("vadjust")
else begin print_esc("insert"); print_int(saved(-2));
end;
goto found2;
end;
vcenter_group: begin s:="vcenter"; goto found1;
end;
semi_simple_group: begin incr(p); print_esc("begingroup"); goto found;
end;
math_shift_group:
begin if m=mmode then print_char("$")
else if nest[p].mode_field=mmode then
begin print_cmd_chr(eq_no,saved(-2)); goto found;
end;
print_char("$"); goto found;
end;
math_left_group:
begin if type(nest[p+1].eTeX_aux_field)=left_noad then print_esc("left")
else print_esc("middle");
goto found;
end;
end; {there are no other cases}
@<Show the box context@>;
found1: print_esc(s); @<Show the box packaging info@>;
found2: print_char("{");
found: print_char(")"); decr(cur_level);
cur_group:=save_level(save_ptr); save_ptr:=save_index(save_ptr)
end;
done: save_ptr:=v; cur_level:=l; cur_group:=c;
end;
@ @<Show the box packaging info@>=
if saved(-2)<>0 then
begin print_char(" ");
if saved(-3)=exactly then print("to") else print("spread");
print_scaled(saved(-2)); print("pt");
end
@ @<Show the box context@>=
i:=saved(-4);
if i<>0 then
if i<box_flag then
begin if abs(nest[p].mode_field)=vmode then j:=hmove else j:=vmove;
if i>0 then print_cmd_chr(j,0) else print_cmd_chr(j,1);
print_scaled(abs(i)); print("pt");
end
else if i<ship_out_flag then
begin if i>=global_box_flag then
begin print_esc("global"); i:=i-(global_box_flag-box_flag);
end;
print_esc("setbox"); print_int(i-box_flag); print_char("=");
end
else print_cmd_chr(leader_ship,i-(leader_flag-a_leaders))
@ The |scan_general_text| procedure is much like |scan_toks(false,false)|,
but will be invoked via |expand|, i.e., recursively.
@^recursion@>
@<Declare \eTeX\ procedures for sc...@>=
procedure@?scan_general_text; forward;@t\2@>
@ The token list (balanced text) created by |scan_general_text| begins
at |link(temp_head)| and ends at |cur_val|. (If |cur_val=temp_head|,
the list is empty.)
@<Declare \eTeX\ procedures for tok...@>=
procedure scan_general_text;
label found;
var s:normal..absorbing; {to save |scanner_status|}
@!w:pointer; {to save |warning_index|}
@!d:pointer; {to save |def_ref|}
@!p:pointer; {tail of the token list being built}
@!q:pointer; {new node being added to the token list via |store_new_token|}
@!unbalance:halfword; {number of unmatched left braces}
begin s:=scanner_status; w:=warning_index; d:=def_ref;
scanner_status:=absorbing; warning_index:=cur_cs;
def_ref:=get_avail; token_ref_count(def_ref):=null; p:=def_ref;
scan_left_brace; {remove the compulsory left brace}
unbalance:=1;
loop@+ begin get_token;
if cur_tok<right_brace_limit then
if cur_cmd<right_brace then incr(unbalance)
else begin decr(unbalance);
if unbalance=0 then goto found;
end;
store_new_token(cur_tok);
end;
found: q:=link(def_ref); free_avail(def_ref); {discard reference count}
if q=null then cur_val:=temp_head @+ else cur_val:=p;
link(temp_head):=q;
scanner_status:=s; warning_index:=w; def_ref:=d;
end;
@ The \.{\\showtokens} command displays a token list.
@d show_tokens=5 { \.{\\showtokens} , must be odd! }
@<Generate all \eTeX...@>=
primitive("showtokens",xray,show_tokens);
@!@:show_tokens_}{\.{\\showtokens} primitive@>
@ @<Cases of |xray| for |print_cmd_chr|@>=
show_tokens:print_esc("showtokens");
@ The \.{\\unexpanded} primitive prevents expansion of tokens much as
the result from \.{\\the} applied to a token variable. The
\.{\\detokenize} primitive converts a token list into a list of
character tokens much as if the token list were written to a file. We
use the fact that the command modifiers for \.{\\unexpanded} and
\.{\\detokenize} are odd whereas those for \.{\\the} and \.{\\showthe}
are even.
@<Generate all \eTeX...@>=
primitive("unexpanded",the,1);@/
@!@:unexpanded_}{\.{\\unexpanded} primitive@>
primitive("detokenize",the,show_tokens);@/
@!@:detokenize_}{\.{\\detokenize} primitive@>
@ @<Cases of |the| for |print_cmd_chr|@>=
else if chr_code=1 then print_esc("unexpanded")
else print_esc("detokenize")
@ @<Handle \.{\\unexpanded} or \.{\\detokenize} and |return|@>=
if odd(cur_chr) then
begin c:=cur_chr; scan_general_text;
if c=1 then the_toks:=cur_val
else begin old_setting:=selector; selector:=new_string; b:=pool_ptr;
p:=get_avail; link(p):=link(temp_head);
token_show(p); flush_list(p);
selector:=old_setting; the_toks:=str_toks(b);
end;
return;
end
@ The \.{\\showifs} command displays all currently active conditionals.
@d show_ifs=6 { \.{\\showifs} }
@<Generate all \eTeX...@>=
primitive("showifs",xray,show_ifs);
@!@:show_ifs_}{\.{\\showifs} primitive@>
@ @<Cases of |xray| for |print_cmd_chr|@>=
show_ifs:print_esc("showifs");
@
@d print_if_line(#)==if #<>0 then
begin print(" entered on line "); print_int(#);
end
@<Cases for |show_whatever|@>=
show_ifs: begin begin_diagnostic; print_nl(""); print_ln;
if cond_ptr=null then
begin print_nl("### "); print("no active conditionals");
end
else begin p:=cond_ptr; n:=0;
repeat incr(n); p:=link(p);@+until p=null;
p:=cond_ptr; t:=cur_if; l:=if_line; m:=if_limit;
repeat print_nl("### level "); print_int(n); print(": ");
print_cmd_chr(if_test,t);
if m=fi_code then print_esc("else");
print_if_line(l);
decr(n); t:=subtype(p); l:=if_line_field(p); m:=type(p); p:=link(p);
until p=null;
end;
end;
@ The \.{\\interactionmode} primitive allows to query and set the
interaction mode.
@<Generate all \eTeX...@>=
primitive("interactionmode",set_page_int,2);
@!@:interaction_mode_}{\.{\\interactionmode} primitive@>
@ @<Cases of |set_page_int| for |print_cmd_chr|@>=
else if chr_code=2 then print_esc("interactionmode")
@ @<Cases for `Fetch the |dead_cycles| or the |insert_penalties|'@>=
else if m=2 then cur_val:=interaction
@ @<Declare \eTeX\ procedures for use...@>=
procedure@?new_interaction; forward;@t\2@>
@ @<Cases for |alter_integer|@>=
else if c=2 then
begin if (cur_val<batch_mode)or(cur_val>error_stop_mode) then
begin print_err("Bad interaction mode");
@.Bad interaction mode@>
help2("Modes are 0=batch, 1=nonstop, 2=scroll, and")@/
("3=errorstop. Proceed, and I'll ignore this case.");
int_error(cur_val);
end
else begin cur_chr:=cur_val; new_interaction;
end;
end
@ The |middle| feature of \eTeX\ allows one ore several \.{\\middle}
delimiters to appear between \.{\\left} and \.{\\right}.
@<Generate all \eTeX...@>=
primitive("middle",left_right,middle_noad);
@!@:middle_}{\.{\\middle} primitive@>
@ @<Cases of |left_right| for |print_cmd_chr|@>=
else if chr_code=middle_noad then print_esc("middle")
@ In constructions such as
$$\vbox{\halign{\.{#}\hfil\cr
{}\\hbox to \\hsize\{\cr
\hskip 25pt \\hskip 0pt plus 0.0001fil\cr
\hskip 25pt ...\cr
\hskip 25pt \\hfil\\penalty-200\\hfilneg\cr
\hskip 25pt ...\}\cr}}$$
the stretch components of \.{\\hfil} and \.{\\hfilneg} compensate; they may,
however, get modified in order to prevent arithmetic overflow during
|hlist_out| when each of them is multiplied by a large |glue_set| value.
Since this ``glue rounding'' depends on state variables |cur_g| and
|cur_glue| and \TeXXeT\ is supposed to emulate the behavior of \TeXeT\
(plus a suitable postprocessor) as close as possible the glue rounding
cannot be postponed until (segments of) an hlist has been reversed.
The code below is invoked after the effective width, |rule_wd|, of a glue
node has been computed. The glue node is either converted into a kern node
or, for leaders, the glue specification is replaced by an equivalent rigid
one; the subtype of the glue node remains unchanged.
@<Handle a glue node for mixed...@>=
if (((g_sign=stretching) and (stretch_order(g)=g_order)) or
((g_sign=shrinking) and (shrink_order(g)=g_order))) then
begin fast_delete_glue_ref(g);
if subtype(p)<a_leaders then
begin type(p):=kern_node; width(p):=rule_wd;
end
else begin g:=get_node(glue_spec_size);@/
stretch_order(g):=filll+1; shrink_order(g):=filll+1; {will never match}
width(g):=rule_wd; stretch(g):=0; shrink(g):=0; glue_ptr(p):=g;
end;
end
@ The optional |TeXXeT| feature of \eTeX\ contains the code for mixed
left-to-right and right-to-left typesetting. This code is inspired by
but different from \TeXeT\ as presented by Donald~E. Knuth and Pierre
MacKay in {\sl TUGboat\/} {\bf 8}, 14--25, 1987.
@^Knuth, Donald Ervin@>
@^MacKay, Pierre@>
In order to avoid confusion with \TeXeT\ the present implementation of
mixed direction typesetting is called \TeXXeT. It differs from \TeXeT\
in several important aspects: (1)~Right-to-left text is reversed
explicitly by the |ship_out| routine and is written to a normal \.{DVI}
file without any |begin_reflect| or |end_reflect| commands; (2)~a
|math_node| is (ab)used instead of a |whatsit_node| to record the
\.{\\beginL}, \.{\\endL}, \.{\\beginR}, and \.{\\endR} text direction
primitives in order to keep the influence on the line breaking algorithm
for pure left-to-right text as small as possible; (3)~right-to-left text
interrupted by a displayed equation is automatically resumed after that
equation; and (4)~the |valign| command code with a non-zero command
modifier is (ab)used for the text direction primitives.
Nevertheless there is a subtle difference between \TeX\ and \TeXXeT\
that may influence the line breaking algorithm for pure left-to-right
text. When a paragraph containing math mode material is broken into
lines \TeX\ may generate lines where math mode material is not enclosed
by properly nested \.{\\mathon} and \.{\\mathoff} nodes. Unboxing such
lines as part of a new paragraph may have the effect that hyphenation is
attempted for `words' originating from math mode or that hyphenation is
inhibited for words originating from horizontal mode.
In \TeXXeT\ additional \.{\\beginM}, resp.\ \.{\\endM} math nodes are
supplied at the start, resp.\ end of lines such that math mode material
inside a horizontal list always starts with either \.{\\mathon} or
\.{\\beginM} and ends with \.{\\mathoff} or \.{\\endM}. These
additional nodes are transparent to operations such as \.{\\unskip},
\.{\\lastpenalty}, or \.{\\lastbox} but they do have the effect that
hyphenation is never attempted for `words' originating from math mode
and is never inhibited for words originating from horizontal mode.
@d TeXXeT_state==eTeX_state(TeXXeT_code)
@d TeXXeT_en==(TeXXeT_state>0) {is \TeXXeT\ enabled?}
@<Cases for |print_param|@>=
eTeX_state_code+TeXXeT_code:print_esc("TeXXeTstate");
@ @<Generate all \eTeX...@>=
primitive("TeXXeTstate",assign_int,eTeX_state_base+TeXXeT_code);
@!@:TeXXeT_state_}{\.{\\TeXXeT_state} primitive@>
primitive("beginL",valign,begin_L_code);
@!@:beginL_}{\.{\\beginL} primitive@>
primitive("endL",valign,end_L_code);
@!@:endL_}{\.{\\endL} primitive@>
primitive("beginR",valign,begin_R_code);
@!@:beginR_}{\.{\\beginR} primitive@>
primitive("endR",valign,end_R_code);
@!@:endR_}{\.{\\endR} primitive@>
@ @<Cases of |valign| for |print_cmd_chr|@>=
else case chr_code of
begin_L_code: print_esc("beginL");
end_L_code: print_esc("endL");
begin_R_code: print_esc("beginR");
othercases print_esc("endR")
endcases
@ @<Cases of |main_control| for |hmode+valign|@>=
if cur_chr>0 then
begin if eTeX_enabled(TeXXeT_en,cur_cmd,cur_chr) then
@.Improper \\beginL@>
@.Improper \\endL@>
@.Improper \\beginR@>
@.Improper \\endR@>
tail_append(new_math(0,cur_chr));
end
else
@ An hbox with subtype dlist will never be reversed, even when embedded
in right-to-left text.
@<Display if this box is never to be reversed@>=
if (type(p)=hlist_node)and(box_lr(p)=dlist) then print(", display")
@ A number of routines are based on a stack of one-word nodes whose
|info| fields contain |end_M_code|, |end_L_code|, or |end_R_code|. The
top of the stack is pointed to by |LR_ptr|.
When the stack manipulation macros of this section are used below,
variable |LR_ptr| might be the global variable declared here for |hpack|
and |ship_out|, or might be local to |post_line_break|.
@d put_LR(#)==begin temp_ptr:=get_avail; info(temp_ptr):=#;
link(temp_ptr):=LR_ptr; LR_ptr:=temp_ptr;
end
@#
@d push_LR(#)==put_LR(end_LR_type(#))
@#
@d pop_LR==begin temp_ptr:=LR_ptr; LR_ptr:=link(temp_ptr);
free_avail(temp_ptr);
end
@<Glob...@>=
@!LR_ptr:pointer; {stack of LR codes for |hpack|, |ship_out|, and |init_math|}
@!LR_problems:integer; {counts missing begins and ends}
@!cur_dir:small_number; {current text direction}
@ @<Set init...@>=
LR_ptr:=null; LR_problems:=0; cur_dir:=left_to_right;
@ @<Insert LR nodes at the beg...@>=
begin q:=link(temp_head);
if LR_ptr<>null then
begin temp_ptr:=LR_ptr; r:=q;
repeat s:=new_math(0,begin_LR_type(info(temp_ptr))); link(s):=r; r:=s;
temp_ptr:=link(temp_ptr);
until temp_ptr=null;
link(temp_head):=r;
end;
while q<>cur_break(cur_p) do
begin if not is_char_node(q) then
if type(q)=math_node then @<Adjust \(t)the LR stack for the |p...@>;
q:=link(q);
end;
end
@ @<Adjust \(t)the LR stack for the |p...@>=
if end_LR(q) then
begin if LR_ptr<>null then if info(LR_ptr)=end_LR_type(q) then pop_LR;
end
else push_LR(q)
@ We use the fact that |q| now points to the node with \.{\\rightskip} glue.
@<Insert LR nodes at the end...@>=
if LR_ptr<>null then
begin s:=temp_head; r:=link(s);
while r<>q do
begin s:=r; r:=link(s);
end;
r:=LR_ptr;
while r<>null do
begin temp_ptr:=new_math(0,info(r));
link(s):=temp_ptr; s:=temp_ptr; r:=link(r);
end;
link(s):=q;
end
@ @<Initialize the LR stack@>=
put_LR(before) {this will never match}
@ @<Adjust \(t)the LR stack for the |hp...@>=
if end_LR(p) then
if info(LR_ptr)=end_LR_type(p) then pop_LR
else begin incr(LR_problems); type(p):=kern_node; subtype(p):=explicit;
end
else push_LR(p)
@ @<Check for LR anomalies at the end of |hp...@>=
begin if info(LR_ptr)<>before then
begin while link(q)<>null do q:=link(q);
repeat temp_ptr:=q; q:=new_math(0,info(LR_ptr)); link(temp_ptr):=q;
LR_problems:=LR_problems+10000; pop_LR;
until info(LR_ptr)=before;
end;
if LR_problems>0 then
begin @<Report LR problems@>; goto common_ending;
end;
pop_LR;
if LR_ptr<>null then confusion("LR1");
@:this can't happen LR1}{\quad LR1@>
end
@ @<Report LR problems@>=
begin print_ln; print_nl("\endL or \endR problem (");@/
print_int(LR_problems div 10000); print(" missing, ");@/
print_int(LR_problems mod 10000); print(" extra");@/
LR_problems:=0;
end
@ @<Initialize |hlist_out| for mixed...@>=
if eTeX_ex then
begin @<Initialize the LR stack@>;
if box_lr(this_box)=dlist then
if cur_dir=right_to_left then
begin cur_dir:=left_to_right; cur_h:=cur_h-width(this_box);
end
else set_box_lr(this_box)(0);
if (cur_dir=right_to_left)and(box_lr(this_box)<>reversed) then
@<Reverse the complete hlist and set the subtype to |reversed|@>;
end
@ @<Finish |hlist_out| for mixed...@>=
if eTeX_ex then
begin @<Check for LR anomalies at the end of |hlist_out|@>;
if box_lr(this_box)=dlist then cur_dir:=right_to_left;
end
@ @<Handle a math node in |hlist_out|@>=
begin if eTeX_ex then
@<Adjust \(t)the LR stack for the |hlist_out| routine; if necessary
reverse an hlist segment and |goto reswitch|@>;
cur_h:=cur_h+width(p);
end
@ Breaking a paragraph into lines while \TeXXeT\ is disabled may result
in lines with unpaired math nodes. Such hlists are silently accepted
in the absence of text direction directives.
@d LR_dir(#)==(subtype(#) div R_code) {text direction of a `math node'}
@<Adjust \(t)the LR stack for the |hl...@>=
begin if end_LR(p) then
if info(LR_ptr)=end_LR_type(p) then pop_LR
else begin if subtype(p)>L_code then incr(LR_problems);
end
else begin push_LR(p);
if LR_dir(p)<>cur_dir then
@<Reverse an hlist segment and |goto reswitch|@>;
end;
type(p):=kern_node;
end
@ @<Check for LR anomalies at the end of |hl...@>=
begin while info(LR_ptr)<>before do
begin if info(LR_ptr)>L_code then LR_problems:=LR_problems+10000;
pop_LR;
end;
pop_LR;
end
@ @d edge_node=style_node {a |style_node| does not occur in hlists}
@d edge_node_size=style_node_size {number of words in an edge node}
@d edge_dist(#)==depth(#) {new |left_edge| position relative to |cur_h|
(after |width| has been taken into account)}
@<Declare procedures needed in |hlist_out|, |vlist_out|@>=
function new_edge(@!s:small_number;@!w:scaled):pointer;
{create an edge node}
var p:pointer; {the new node}
begin p:=get_node(edge_node_size); type(p):=edge_node; subtype(p):=s;
width(p):=w; edge_dist(p):=0; {the |edge_dist| field will be set later}
new_edge:=p;
end;
@ @<Cases of |hlist_out| that arise...@>=
edge_node: begin cur_h:=cur_h+width(p);
left_edge:=cur_h+edge_dist(p); cur_dir:=subtype(p);
end;
@ We detach the hlist, start a new one consisting of just one kern node,
append the reversed list, and set the width of the kern node.
@<Reverse the complete hlist...@>=
begin save_h:=cur_h; temp_ptr:=p; p:=new_kern(0); link(prev_p):=p;
cur_h:=0; link(p):=reverse(this_box,null,cur_g,cur_glue); width(p):=-cur_h;
cur_h:=save_h; set_box_lr(this_box)(reversed);
end
@ We detach the remainder of the hlist, replace the math node by
an edge node, and append the reversed hlist segment to it; the tail of
the reversed segment is another edge node and the remainder of the
original list is attached to it.
@<Reverse an hlist segment...@>=
begin save_h:=cur_h; temp_ptr:=link(p); rule_wd:=width(p);
free_node(p,small_node_size);
cur_dir:=reflected; p:=new_edge(cur_dir,rule_wd); link(prev_p):=p;
cur_h:=cur_h-left_edge+rule_wd;
link(p):=reverse(this_box,new_edge(reflected,0),cur_g,cur_glue);
edge_dist(p):=cur_h; cur_dir:=reflected; cur_h:=save_h;
goto reswitch;
end
@ The |reverse| function defined here is responsible to reverse the
nodes of an hlist (segment). The first parameter |this_box| is the enclosing
hlist node, the second parameter |t| is to become the tail of the reversed
list, and the global variable |temp_ptr| is the head of the list to be
reversed. Finally |cur_g| and |cur_glue| are the current glue rounding state
variables, to be updated by this function. We remove nodes from the original
list and add them to the head of the new one.
@<Declare procedures needed in |hlist_out|, |vlist_out|@>=
function reverse(@!this_box,@!t:pointer; var cur_g:scaled;
var cur_glue:real):pointer;
label reswitch,next_p,done;
var l:pointer; {the new list}
@!p:pointer; {the current node}
@!q:pointer; {the next node}
@!g_order: glue_ord; {applicable order of infinity for glue}
@!g_sign: normal..shrinking; {selects type of glue}
@!glue_temp:real; {glue value before rounding}
@!m,@!n:halfword; {count of unmatched math nodes}
begin g_order:=glue_order(this_box); g_sign:=glue_sign(this_box);
l:=t; p:=temp_ptr; m:=min_halfword; n:=min_halfword;
loop@+ begin while p<>null do
@<Move node |p| to the new list and go to the next node;
or |goto done| if the end of the reflected segment has been reached@>;
if (t=null)and(m=min_halfword)and(n=min_halfword) then goto done;
p:=new_math(0,info(LR_ptr)); LR_problems:=LR_problems+10000;
{manufacture one missing math node}
end;
done:reverse:=l;
end;
@ @<Move node |p| to the new list...@>=
reswitch: if is_char_node(p) then
repeat f:=font(p); c:=character(p);
cur_h:=cur_h+char_width(f)(char_info(f)(c));
q:=link(p); link(p):=l; l:=p; p:=q;
until not is_char_node(p)
else @<Move the non-|char_node| |p| to the new list@>
@ @<Move the non-|char_node| |p| to the new list@>=
begin q:=link(p);
case type(p) of
hlist_node,vlist_node,rule_node,kern_node: rule_wd:=width(p);
@t\4@>@<Cases of |reverse| that need special treatment@>@;
edge_node: confusion("LR2");
@:this can't happen LR2}{\quad LR2@>
othercases goto next_p
endcases;@/
cur_h:=cur_h+rule_wd;
next_p: link(p):=l;
if type(p)=kern_node then if (rule_wd=0)or(l=null) then
begin free_node(p,small_node_size); p:=l;
end;
l:=p; p:=q;
end
@ Here we compute the effective width of a glue node as in |hlist_out|.
@<Cases of |reverse|...@>=
glue_node: begin round_glue;
@<Handle a glue node for mixed...@>;
end;
@ A ligature node is replaced by a char node.
@<Cases of |reverse|...@>=
ligature_node: begin flush_node_list(lig_ptr(p));
temp_ptr:=p; p:=get_avail; mem[p]:=mem[lig_char(temp_ptr)]; link(p):=q;
free_node(temp_ptr,small_node_size); goto reswitch;
end;
@ Math nodes in an inner reflected segment are modified, those at the
outer level are changed into kern nodes.
@<Cases of |reverse|...@>=
math_node: begin rule_wd:=width(p);
if end_LR(p) then
if info(LR_ptr)<>end_LR_type(p) then
begin type(p):=kern_node; incr(LR_problems);
end
else begin pop_LR;
if n>min_halfword then
begin decr(n); decr(subtype(p)); {change |after| into |before|}
end
else begin type(p):=kern_node;
if m>min_halfword then decr(m)
else @<Finish the reversed hlist segment and |goto done|@>;
end;
end
else begin push_LR(p);
if (n>min_halfword)or(LR_dir(p)<>cur_dir) then
begin incr(n); incr(subtype(p)); {change |before| into |after|}
end
else begin type(p):=kern_node; incr(m);
end;
end;
end;
@ Finally we have found the end of the hlist segment to be reversed; the
final math node is released and the remaining list attached to the
edge node terminating the reversed segment.
@<Finish the reversed...@>=
begin free_node(p,small_node_size);
link(t):=q; width(t):=rule_wd; edge_dist(t):=-cur_h-rule_wd; goto done;
end
@ @<Check for LR anomalies at the end of |s...@>=
begin if LR_problems>0 then
begin @<Report LR problems@>; print_char(")"); print_ln;
end;
if (LR_ptr<>null)or(cur_dir<>left_to_right) then confusion("LR3");
@:this can't happen LR3}{\quad LR3@>
end
@ Some special actions are required for displayed equation in paragraphs
with mixed direction texts. First of all we have to set the text
direction preceding the display.
@<Set the value of |x| to the text direction before the display@>=
if LR_save=null then x:=0
else if info(LR_save)>=R_code then x:=-1@+else x:=1
@ @<Prepare for display after an empty...@>=
begin pop_nest; @<Set the value of |x|...@>;
end
@ When calculating the natural width, |w|, of the final line preceding
the display, we may have to copy all or part of its hlist. We copy,
however, only those parts of the original list that are relevant for the
computation of |pre_display_size|.
@^data structure assumptions@>
@<Declare subprocedures for |init_math|@>=
procedure just_copy(@!p,@!h,@!t:pointer);
label found,not_found;
var @!r:pointer; {current node being fabricated for new list}
@!words:0..5; {number of words remaining to be copied}
begin while p<>null do
begin words:=1; {this setting occurs in more branches than any other}
if is_char_node(p) then r:=get_avail
else case type(p) of
hlist_node,vlist_node: begin r:=get_node(box_node_size);
mem[r+6]:=mem[p+6]; mem[r+5]:=mem[p+5]; {copy the last two words}
words:=5; list_ptr(r):=null; {this affects |mem[r+5]|}
end;
rule_node: begin r:=get_node(rule_node_size); words:=rule_node_size;
end;
ligature_node: begin r:=get_avail; {only |font| and |character| are needed}
mem[r]:=mem[lig_char(p)]; goto found;
end;
kern_node,math_node: begin r:=get_node(small_node_size);
words:=small_node_size;
end;
glue_node: begin r:=get_node(small_node_size); add_glue_ref(glue_ptr(p));
glue_ptr(r):=glue_ptr(p); leader_ptr(r):=null;
end;
whatsit_node:@<Make a partial copy of the whatsit...@>;
othercases goto not_found
endcases;
while words>0 do
begin decr(words); mem[r+words]:=mem[p+words];
end;
found: link(h):=r; h:=r;
not_found: p:=link(p);
end;
link(h):=t;
end;
@ When the final line ends with R-text, the value |w| refers to the line
reflected with respect to the left edge of the enclosing vertical list.
@<Prepare for display after a non-empty...@>=
if eTeX_ex then @<Let |j| be the prototype box for the display@>;
v:=shift_amount(just_box);
@<Set the value of |x|...@>;
if x>=0 then
begin p:=list_ptr(just_box); link(temp_head):=null;
end
else begin v:=-v-width(just_box);
p:=new_math(0,begin_L_code); link(temp_head):=p;
just_copy(list_ptr(just_box),p,new_math(0,end_L_code));
cur_dir:=right_to_left;
end;
v:=v+2*quad(cur_font);
if TeXXeT_en then @<Initialize the LR stack@>
@ @<Finish the natural width computation@>=
if TeXXeT_en then
begin while LR_ptr<>null do pop_LR;
if LR_problems<>0 then
begin w:=max_dimen; LR_problems:=0;
end;
end;
cur_dir:=left_to_right; flush_node_list(link(temp_head))
@ In the presence of text direction directives we assume that any LR
problems have been fixed by the |hpack| routine. If the final line
contains, however, text direction directives while \TeXXeT\ is disabled,
then we set |w:=max_dimen|.
@<Cases of `Let |d| be the natural...@>=
math_node: begin d:=width(p);
if TeXXeT_en then @<Adjust \(t)the LR stack for the |init_math| routine@>
else if subtype(p)>=L_code then
begin w:=max_dimen; goto done;
end;
end;
edge_node: begin d:=width(p); cur_dir:=subtype(p);
end;
@ @<Adjust \(t)the LR stack for the |i...@>=
if end_LR(p) then
begin if info(LR_ptr)=end_LR_type(p) then pop_LR
else if subtype(p)>L_code then
begin w:=max_dimen; goto done;
end
end
else begin push_LR(p);
if LR_dir(p)<>cur_dir then
begin just_reverse(p); p:=temp_head;
end;
end
@ @<Declare subprocedures for |init_math|@>=
procedure just_reverse(@!p:pointer);
label found,done;
var l:pointer; {the new list}
@!t:pointer; {tail of reversed segment}
@!q:pointer; {the next node}
@!m,@!n:halfword; {count of unmatched math nodes}
begin m:=min_halfword; n:=min_halfword;
if link(temp_head)=null then
begin just_copy(link(p),temp_head,null); q:=link(temp_head);
end
else begin q:=link(p); link(p):=null; flush_node_list(link(temp_head));
end;
t:=new_edge(cur_dir,0); l:=t; cur_dir:=reflected;
while q<>null do
if is_char_node(q) then
repeat p:=q; q:=link(p); link(p):=l; l:=p;
until not is_char_node(q)
else begin p:=q; q:=link(p);
if type(p)=math_node then
@<Adjust \(t)the LR stack for the |just_reverse| routine@>;
link(p):=l; l:=p;
end;
goto done;
found:width(t):=width(p); link(t):=q; free_node(p,small_node_size);
done:link(temp_head):=l;
end;
@ @<Adjust \(t)the LR stack for the |j...@>=
if end_LR(p) then
if info(LR_ptr)<>end_LR_type(p) then
begin type(p):=kern_node; incr(LR_problems);
end
else begin pop_LR;
if n>min_halfword then
begin decr(n); decr(subtype(p)); {change |after| into |before|}
end
else begin if m>min_halfword then decr(m)@+else goto found;
type(p):=kern_node;
end;
end
else begin push_LR(p);
if (n>min_halfword)or(LR_dir(p)<>cur_dir) then
begin incr(n); incr(subtype(p)); {change |before| into |after|}
end
else begin type(p):=kern_node; incr(m);
end;
end
@ The prototype box is an hlist node with the width, glue set, and shift
amount of |just_box|, i.e., the last line preceding the display. Its
hlist reflects the current \.{\\leftskip} and \.{\\rightskip}.
@<Let |j| be the prototype box for the display@>=
begin if right_skip=zero_glue then j:=new_kern(0)
else j:=new_param_glue(right_skip_code);
if left_skip=zero_glue then p:=new_kern(0)
else p:=new_param_glue(left_skip_code);
link(p):=j; j:=new_null_box; width(j):=width(just_box);
shift_amount(j):=shift_amount(just_box); list_ptr(j):=p;
glue_order(j):=glue_order(just_box); glue_sign(j):=glue_sign(just_box);
glue_set(j):=glue_set(just_box);
end
@ At the end of a displayed equation we retrieve the prototype box.
@<Local variables for finishing...@>=
@!j:pointer; {prototype box}
@ @<Retrieve the prototype box@>=
if mode=mmode then j:=LR_box
@ @<Flush the prototype box@>=
flush_node_list(j)
@ The |app_display| procedure used to append the displayed equation
and\slash or equation number to the current vertical list has three
parameters: the prototype box, the hbox to be appended, and the
displacement of the hbox in the display line.
@<Declare subprocedures for |after_math|@>=
procedure app_display(@!j,@!b:pointer;@!d:scaled);
var z:scaled; {width of the line}
@!s:scaled; {move the line right this much}
@!e:scaled; {distance from right edge of box to end of line}
@!x:integer; {|pre_display_direction|}
@!p,@!q,@!r,@!t,@!u:pointer; {for list manipulation}
begin s:=display_indent; x:=pre_display_direction;
if x=0 then shift_amount(b):=s+d
else begin z:=display_width; p:=b;
@<Set up the hlist for the display line@>;
@<Package the display line@>;
end;
append_to_vlist(b);
end;
@ Here we construct the hlist for the display, starting with node |p|
and ending with node |q|. We also set |d| and |e| to the amount of
kerning to be added before and after the hlist (adjusted for the
prototype box).
@<Set up the hlist for the display line@>=
if x>0 then e:=z-d-width(p)
else begin e:=d; d:=z-e-width(p);
end;
if j<>null then
begin b:=copy_node_list(j); height(b):=height(p); depth(b):=depth(p);
s:=s-shift_amount(b); d:=d+s; e:=e+width(b)-z-s;
end;
if box_lr(p)=dlist then q:=p {display or equation number}
else begin {display and equation number}
r:=list_ptr(p); free_node(p,box_node_size);
if r=null then confusion("LR4");
if x>0 then
begin p:=r;
repeat q:=r; r:=link(r); {find tail of list}
until r=null;
end
else begin p:=null; q:=r;
repeat t:=link(r); link(r):=p; p:=r; r:=t; {reverse list}
until r=null;
end;
end
@ In the presence of a prototype box we use its shift amount and width
to adjust the values of kerning and add these values to the glue nodes
inserted to cancel the \.{\\leftskip} and \.{\\rightskip}. If there is
no prototype box (because the display is preceded by an empty
paragraph), or if the skip parameters are zero, we just add kerns.
The |cancel_glue| macro creates and links a glue node that is, together
with another glue node, equivalent to a given amount of kerning. We can
use |j| as temporary pointer, since all we need is |j<>null|.
@d cancel_glue(#)==j:=new_skip_param(#); cancel_glue_cont
@d cancel_glue_cont(#)==link(#):=j; cancel_glue_cont_cont
@d cancel_glue_cont_cont(#)==link(j):=#; cancel_glue_end
@d cancel_glue_end(#)==j:=glue_ptr(#); cancel_glue_end_end
@d cancel_glue_end_end(#)==
stretch_order(temp_ptr):=stretch_order(j);
shrink_order(temp_ptr):=shrink_order(j); width(temp_ptr):=#-width(j);
stretch(temp_ptr):=-stretch(j); shrink(temp_ptr):=-shrink(j)
@<Package the display line@>=
if j=null then
begin r:=new_kern(0); t:=new_kern(0); {the widths will be set later}
end
else begin r:=list_ptr(b); t:=link(r);
end;
u:=new_math(0,end_M_code);
if type(t)=glue_node then {|t| is \.{\\rightskip} glue}
begin cancel_glue(right_skip_code)(q)(u)(t)(e); link(u):=t;
end
else begin width(t):=e; link(t):=u; link(q):=t;
end;
u:=new_math(0,begin_M_code);
if type(r)=glue_node then {|r| is \.{\\leftskip} glue}
begin cancel_glue(left_skip_code)(u)(p)(r)(d); link(r):=u;
end
else begin width(r):=d; link(r):=p; link(u):=r;
if j=null then
begin b:=hpack(u,natural); shift_amount(b):=s;
end
else list_ptr(b):=u;
end
@ The |scan_tokens| feature of \eTeX\ defines the \.{\\scantokens}
primitive.
@<Generate all \eTeX...@>=
primitive("scantokens",input,2);
@!@:scan_tokens_}{\.{\\scantokens} primitive@>
@ @<Cases of |input| for |print_cmd_chr|@>=
else if chr_code=2 then print_esc("scantokens")
@ @<Cases for |input|@>=
else if cur_chr=2 then pseudo_start
@ The global variable |pseudo_files| is used to maintain a stack of
pseudo files. The |info| field of each pseudo file points to a linked
list of variable size nodes representing lines not yet processed: the
|info| field of the first word contains the size of this node, all the
following words contain ASCII codes.
@<Glob...@>=
@!pseudo_files:pointer; {stack of pseudo files}
@ @<Set init...@>=
pseudo_files:=null;
@ The |pseudo_start| procedure initiates reading from a pseudo file.
@<Declare \eTeX\ procedures for ex...@>=
procedure@?pseudo_start; forward;@t\2@>
@ @<Declare \eTeX\ procedures for tok...@>=
procedure pseudo_start;
var old_setting:0..max_selector; {holds |selector| setting}
@!s:str_number; {string to be converted into a pseudo file}
@!l,@!m:pool_pointer; {indices into |str_pool|}
@!p,@!q,@!r:pointer; {for list construction}
@!w: four_quarters; {four ASCII codes}
@!nl,@!sz:integer;
begin scan_general_text;
old_setting:=selector; selector:=new_string;
token_show(temp_head); selector:=old_setting;
flush_list(link(temp_head));
str_room(1); s:=make_string;
@<Convert string |s| into a new pseudo file@>;
flush_string;
@<Initiate input from new pseudo file@>;
end;
@ @<Convert string |s| into a new pseudo file@>=
str_pool[pool_ptr]:=si(" "); l:=str_start[s];
nl:=si(new_line_char);
p:=get_avail; q:=p;
while l<pool_ptr do
begin m:=l;
while (l<pool_ptr)and(str_pool[l]<>nl) do incr(l);
sz:=(l-m+7)div 4;
if sz=1 then sz:=2;
r:=get_node(sz); link(q):=r; q:=r; info(q):=hi(sz);
while sz>2 do
begin decr(sz); incr(r);
w.b0:=qi(so(str_pool[m])); w.b1:=qi(so(str_pool[m+1]));
w.b2:=qi(so(str_pool[m+2])); w.b3:=qi(so(str_pool[m+3]));
mem[r].qqqq:=w; m:=m+4;
end;
w.b0:=qi(" "); w.b1:=qi(" "); w.b2:=qi(" "); w.b3:=qi(" ");
if l>m then
begin w.b0:=qi(so(str_pool[m]));
if l>m+1 then
begin w.b1:=qi(so(str_pool[m+1]));
if l>m+2 then
begin w.b2:=qi(so(str_pool[m+2]));
if l>m+3 then w.b3:=qi(so(str_pool[m+3]));
end;
end;
end;
mem[r+1].qqqq:=w;
if str_pool[l]=nl then incr(l);
end;
info(p):=link(p); link(p):=pseudo_files; pseudo_files:=p
@ @<Initiate input from new pseudo file@>=
begin_file_reading; {set up |cur_file| and new level of input}
line:=0; limit:=start; loc:=limit+1; {force line read}
if tracing_scan_tokens>0 then
begin if term_offset>max_print_line-3 then print_ln
else if (term_offset>0)or(file_offset>0) then print_char(" ");
name:=19; print("( "); incr(open_parens); update_terminal;
end
else name:=18
@ Here we read a line from the current pseudo file into |buffer|.
@<Declare \eTeX\ procedures for tr...@>=
function pseudo_input: boolean; {inputs the next line or returns |false|}
var p:pointer; {current line from pseudo file}
@!sz:integer; {size of node |p|}
@!w:four_quarters; {four ASCII codes}
@!r:pointer; {loop index}
begin last:=first; {cf.\ Matthew 19\thinspace:\thinspace30}
p:=info(pseudo_files);
if p=null then pseudo_input:=false
else begin info(pseudo_files):=link(p); sz:=ho(info(p));
if 4*sz-3>=buf_size-last then
@<Report overflow of the input buffer, and abort@>;
last:=first;
for r:=p+1 to p+sz-1 do
begin w:=mem[r].qqqq;
buffer[last]:=w.b0; buffer[last+1]:=w.b1;
buffer[last+2]:=w.b2; buffer[last+3]:=w.b3;
last:=last+4;
end;
if last>=max_buf_stack then max_buf_stack:=last+1;
while (last>first)and(buffer[last-1]=" ") do decr(last);
free_node(p,sz);
pseudo_input:=true;
end;
end;
@ When we are done with a pseudo file we `close' it.
@<Declare \eTeX\ procedures for tr...@>=
procedure pseudo_close; {close the top level pseudo file}
var p,@!q: pointer;
begin p:=link(pseudo_files); q:=info(pseudo_files);
free_avail(pseudo_files); pseudo_files:=p;
while q<>null do
begin p:=q; q:=link(p); free_node(p,ho(info(p)));
end;
end;
@ @<Dump the \eTeX\ state@>=
while pseudo_files<>null do pseudo_close; {flush pseudo files}
@ @<Generate all \eTeX...@>=
primitive("readline",read_to_cs,1);@/
@!@:read_line_}{\.{\\readline} primitive@>
@ @<Cases of |read| for |print_cmd_chr|@>=
else print_esc("readline")
@ @<Handle \.{\\readline} and |goto done|@>=
if j=1 then
begin while loc<=limit do {current line not yet finished}
begin cur_chr:=buffer[loc]; incr(loc);
if cur_chr=" " then cur_tok:=space_token
@+else cur_tok:=cur_chr+other_token;
store_new_token(cur_tok);
end;
goto done;
end
@ Here we define the additional conditionals of \eTeX\ as well as the
\.{\\unless} prefix.
@d if_def_code=17 { `\.{\\ifdefined}' }
@d if_cs_code=18 { `\.{\\ifcsname}' }
@d if_font_char_code=19 { `\.{\\iffontchar}' }
@d if_in_csname_code=20 { `\.{\\ifincsname}' }
@d if_pdfabs_num_code=22 { `\.{\\ifpdfabsnum}' } { 21 = |if_pdfprimitive|}
@d if_pdfabs_dim_code=23 { `\.{\\ifpdfabsdim}' }
@<Generate all \eTeX...@>=
primitive("unless",expand_after,1);@/
@!@:unless_}{\.{\\unless} primitive@>
primitive("ifdefined",if_test,if_def_code);
@!@:if_defined_}{\.{\\ifdefined} primitive@>
primitive("ifcsname",if_test,if_cs_code);
@!@:if_cs_name_}{\.{\\ifcsname} primitive@>
primitive("iffontchar",if_test,if_font_char_code);
@!@:if_font_char_}{\.{\\iffontchar} primitive@>
primitive("ifincsname",if_test,if_in_csname_code);
@!@:if_in_csname_}{\.{\\ifincsname} primitive@>
primitive("ifpdfabsnum",if_test,if_pdfabs_num_code);
@!@:if_pdfabs_num_}{\.{\\ifpdfabsnum} primitive@>
primitive("ifpdfabsdim",if_test,if_pdfabs_dim_code);
@!@:if_pdfabs_dim_}{\.{\\ifpdfabsdim} primitive@>
@ @<Cases of |expandafter| for |print_cmd_chr|@>=
else print_esc("unless")
@ @<Cases of |if_test| for |print_cmd_chr|@>=
if_def_code:print_esc("ifdefined");
if_cs_code:print_esc("ifcsname");
if_font_char_code:print_esc("iffontchar");
if_in_csname_code:print_esc("ifincsname");
if_pdfabs_num_code:print_esc("ifpdfabsnum");
if_pdfabs_dim_code:print_esc("ifpdfabsdim");
@ The result of a boolean condition is reversed when the conditional is
preceded by \.{\\unless}.
@<Negate a boolean conditional and |goto reswitch|@>=
begin get_token;
if (cur_cmd=if_test)and(cur_chr<>if_case_code) then
begin cur_chr:=cur_chr+unless_code; goto reswitch;
end;
print_err("You can't use `"); print_esc("unless"); print("' before `");
@.You can't use \\unless...@>
print_cmd_chr(cur_cmd,cur_chr); print_char("'");
help1("Continue, and I'll forget that it ever happened.");
back_error;
end
@ The conditional \.{\\ifdefined} tests if a control sequence is
defined.
We need to reset |scanner_status|, since \.{\\outer} control sequences
are allowed, but we might be scanning a macro definition or preamble.
@<Cases for |conditional|@>=
if_def_code:begin save_scanner_status:=scanner_status;
scanner_status:=normal;
get_next; b:=(cur_cmd<>undefined_cs);
scanner_status:=save_scanner_status;
end;
@ The conditional \.{\\ifcsname} is equivalent to \.{\{\\expandafter}
\.{\}\\expandafter} \.{\\ifdefined} \.{\\csname}, except that no new
control sequence will be entered into the hash table (once all tokens
preceding the mandatory \.{\\endcsname} have been expanded).
@<Cases for |conditional|@>=
if_cs_code:begin n:=get_avail; p:=n; {head of the list of characters}
e := is_in_csname; is_in_csname := true;
repeat get_x_token;
if cur_cs=0 then store_new_token(cur_tok);
until cur_cs<>0;
if cur_cmd<>end_cs_name then @<Complain about missing \.{\\endcsname}@>;
@<Look up the characters of list |n| in the hash table, and set |cur_cs|@>;
flush_list(n);
b:=(eq_type(cur_cs)<>undefined_cs);
is_in_csname := e;
end;
@ @<Look up the characters of list |n| in the hash table...@>=
m:=first; p:=link(n);
while p<>null do
begin if m>=max_buf_stack then
begin max_buf_stack:=m+1;
if max_buf_stack=buf_size then
overflow("buffer size",buf_size);
@:TeX capacity exceeded buffer size}{\quad buffer size@>
end;
buffer[m]:=info(p) mod @'400; incr(m); p:=link(p);
end;
if m>first+1 then
cur_cs:=id_lookup(first,m-first) {|no_new_control_sequence| is |true|}
else if m=first then cur_cs:=null_cs {the list is empty}
else cur_cs:=single_base+buffer[first] {the list has length one}
@ The conditional \.{\\iffontchar} tests the existence of a character in
a font.
@<Cases for |conditional|@>=
if_in_csname_code: b := is_in_csname;
if_pdfabs_dim_code, if_pdfabs_num_code: begin
if this_if=if_pdfabs_num_code then scan_int@+else scan_normal_dimen;
n:=cur_val;
if n < 0 then negate(n);
@<Get the next non-blank non-call...@>;
if (cur_tok>=other_token+"<")and(cur_tok<=other_token+">") then
r:=cur_tok-other_token
else begin print_err("Missing = inserted for ");
@.Missing = inserted@>
print_cmd_chr(if_test,this_if);
help1("I was expecting to see `<', `=', or `>'. Didn't.");
back_error; r:="=";
end;
if this_if=if_pdfabs_num_code then scan_int@+else scan_normal_dimen;
if cur_val < 0 then negate(cur_val);
case r of
"<": b:=(n<cur_val);
"=": b:=(n=cur_val);
">": b:=(n>cur_val);
end;
end;
if_font_char_code:begin scan_font_ident; n:=cur_val; scan_char_num;
if (font_bc[n]<=cur_val)and(font_ec[n]>=cur_val) then
b:=char_exists(char_info(n)(qi(cur_val)))
else b:=false;
end;
@ The |protected| feature of \eTeX\ defines the \.{\\protected} prefix
command for macro definitions. Such macros are protected against
expansions when lists of expanded tokens are built, e.g., for \.{\\edef}
or during \.{\\write}.
@<Generate all \eTeX...@>=
primitive("protected",prefix,8);
@!@:protected_}{\.{\\protected} primitive@>
@ @<Cases of |prefix| for |print_cmd_chr|@>=
else if chr_code=8 then print_esc("protected")
@ The |get_x_or_protected| procedure is like |get_x_token| except that
protected macros are not expanded.
@<Declare \eTeX\ procedures for sc...@>=
procedure get_x_or_protected; {sets |cur_cmd|, |cur_chr|, |cur_tok|,
and expands non-protected macros}
label exit;
begin loop@+begin get_token;
if cur_cmd<=max_command then return;
if (cur_cmd>=call)and(cur_cmd<end_template) then
if info(link(cur_chr))=protected_token then return;
expand;
end;
exit:end;
@ A group entered (or a conditional started) in one file may end in a
different file. Such slight anomalies, although perfectly legitimate,
may cause errors that are difficult to locate. In order to be able to
give a warning message when such anomalies occur, \eTeX\ uses the
|grp_stack| and |if_stack| arrays to record the initial |cur_boundary|
and |cond_ptr| values for each input file.
@<Glob...@>=
@!grp_stack : array[0..max_in_open] of save_pointer; {initial |cur_boundary|}
@!if_stack : array[0..max_in_open] of pointer; {initial |cond_ptr|}
@ When a group ends that was apparently entered in a different input
file, the |group_warning| procedure is invoked in order to update the
|grp_stack|. If moreover \.{\\tracingnesting} is positive we want to
give a warning message. The situation is, however, somewhat complicated
by two facts: (1)~There may be |grp_stack| elements without a
corresponding \.{\\input} file or \.{\\scantokens} pseudo file (e.g.,
error insertions from the terminal); and (2)~the relevant information is
recorded in the |name_field| of the |input_stack| only loosely
synchronized with the |in_open| variable indexing |grp_stack|.
@<Declare \eTeX\ procedures for tr...@>=
procedure group_warning;
var i:0..max_in_open; {index into |grp_stack|}
@!w:boolean; {do we need a warning?}
begin base_ptr:=input_ptr; input_stack[base_ptr]:=cur_input;
{store current state}
i:=in_open; w:=false;
while (grp_stack[i]=cur_boundary)and(i>0) do
begin @<Set variable |w| to indicate if this case should be reported@>;
grp_stack[i]:=save_index(save_ptr); decr(i);
end;
if w then
begin print_nl("Warning: end of "); print_group(true);
@.Warning: end of...@>
print(" of a different file"); print_ln;
if tracing_nesting>1 then show_context;
if history=spotless then history:=warning_issued;
end;
end;
@ This code scans the input stack in order to determine the type of the
current input file.
@<Set variable |w| to...@>=
if tracing_nesting>0 then
begin while (input_stack[base_ptr].state_field=token_list)or@|
(input_stack[base_ptr].index_field>i) do decr(base_ptr);
if input_stack[base_ptr].name_field>17 then w:=true;
end
@ When a conditional ends that was apparently started in a different
input file, the |if_warning| procedure is invoked in order to update the
|if_stack|. If moreover \.{\\tracingnesting} is positive we want to
give a warning message (with the same complications as above).
@<Declare \eTeX\ procedures for tr...@>=
procedure if_warning;
var i:0..max_in_open; {index into |if_stack|}
@!w:boolean; {do we need a warning?}
begin base_ptr:=input_ptr; input_stack[base_ptr]:=cur_input;
{store current state}
i:=in_open; w:=false;
while if_stack[i]=cond_ptr do
begin @<Set variable |w| to...@>;
if_stack[i]:=link(cond_ptr); decr(i);
end;
if w then
begin print_nl("Warning: end of "); print_cmd_chr(if_test,cur_if);
@.Warning: end of...@>
print_if_line(if_line); print(" of a different file"); print_ln;
if tracing_nesting>1 then show_context;
if history=spotless then history:=warning_issued;
end;
end;
@ Conversely, the |file_warning| procedure is invoked when a file ends
and some groups entered or conditionals started while reading from that
file are still incomplete.
@<Declare \eTeX\ procedures for tr...@>=
procedure file_warning;
var p:pointer; {saved value of |save_ptr| or |cond_ptr|}
@!l:quarterword; {saved value of |cur_level| or |if_limit|}
@!c:quarterword; {saved value of |cur_group| or |cur_if|}
@!i:integer; {saved value of |if_line|}
begin p:=save_ptr; l:=cur_level; c:=cur_group; save_ptr:=cur_boundary;
while grp_stack[in_open]<>save_ptr do
begin decr(cur_level);
print_nl("Warning: end of file when ");
@.Warning: end of file when...@>
print_group(true); print(" is incomplete");@/
cur_group:=save_level(save_ptr); save_ptr:=save_index(save_ptr)
end;
save_ptr:=p; cur_level:=l; cur_group:=c; {restore old values}
p:=cond_ptr; l:=if_limit; c:=cur_if; i:=if_line;
while if_stack[in_open]<>cond_ptr do
begin print_nl("Warning: end of file when ");
@.Warning: end of file when...@>
print_cmd_chr(if_test,cur_if);
if if_limit=fi_code then print_esc("else");
print_if_line(if_line); print(" is incomplete");@/
if_line:=if_line_field(cond_ptr); cur_if:=subtype(cond_ptr);
if_limit:=type(cond_ptr); cond_ptr:=link(cond_ptr);
end;
cond_ptr:=p; if_limit:=l; cur_if:=c; if_line:=i; {restore old values}
print_ln;
if tracing_nesting>1 then show_context;
if history=spotless then history:=warning_issued;
end;
@ Here are the additional \eTeX\ primitives for expressions.
@<Generate all \eTeX...@>=
primitive("numexpr",last_item,eTeX_expr-int_val+int_val);
@!@:num_expr_}{\.{\\numexpr} primitive@>
primitive("dimexpr",last_item,eTeX_expr-int_val+dimen_val);
@!@:dim_expr_}{\.{\\dimexpr} primitive@>
primitive("glueexpr",last_item,eTeX_expr-int_val+glue_val);
@!@:glue_expr_}{\.{\\glueexpr} primitive@>
primitive("muexpr",last_item,eTeX_expr-int_val+mu_val);
@!@:mu_expr_}{\.{\\muexpr} primitive@>
@ @<Cases of |last_item| for |print_cmd_chr|@>=
eTeX_expr-int_val+int_val: print_esc("numexpr");
eTeX_expr-int_val+dimen_val: print_esc("dimexpr");
eTeX_expr-int_val+glue_val: print_esc("glueexpr");
eTeX_expr-int_val+mu_val: print_esc("muexpr");
@ This code for reducing |cur_val_level| and\slash or negating the
result is similar to the one for all the other cases of
|scan_something_internal|, with the difference that |scan_expr| has
already increased the reference count of a glue specification.
@<Process an expression and |return|@>=
begin if m<eTeX_mu then
begin case m of
@/@<Cases for fetching a glue value@>@/
end; {there are no other cases}
cur_val_level:=glue_val;
end
else if m<eTeX_expr then
begin case m of
@/@<Cases for fetching a mu value@>@/
end; {there are no other cases}
cur_val_level:=mu_val;
end
else begin cur_val_level:=m-eTeX_expr+int_val; scan_expr;
end;
while cur_val_level>level do
begin if cur_val_level=glue_val then
begin m:=cur_val; cur_val:=width(m); delete_glue_ref(m);
end
else if cur_val_level=mu_val then mu_error;
decr(cur_val_level);
end;
if negative then
if cur_val_level>=glue_val then
begin m:=cur_val; cur_val:=new_spec(m); delete_glue_ref(m);
@<Negate all three glue components of |cur_val|@>;
end
else negate(cur_val);
return;
end
@ @<Declare \eTeX\ procedures for sc...@>=
procedure@?scan_expr; forward;@t\2@>
@ The |scan_expr| procedure scans and evaluates an expression.
@<Declare procedures needed for expressions@>=
@t\4@>@<Declare subprocedures for |scan_expr|@>
procedure scan_expr; {scans and evaluates an expression}
label restart, continue, found;
var a,@!b:boolean; {saved values of |arith_error|}
@!l:small_number; {type of expression}
@!r:small_number; {state of expression so far}
@!s:small_number; {state of term so far}
@!o:small_number; {next operation or type of next factor}
@!e:integer; {expression so far}
@!t:integer; {term so far}
@!f:integer; {current factor}
@!n:integer; {numerator of combined multiplication and division}
@!p:pointer; {top of expression stack}
@!q:pointer; {for stack manipulations}
begin l:=cur_val_level; a:=arith_error; b:=false; p:=null;
incr(expand_depth_count);
if expand_depth_count>=expand_depth then overflow("expansion depth",expand_depth);
@<Scan and evaluate an expression |e| of type |l|@>;
decr(expand_depth_count);
if b then
begin print_err("Arithmetic overflow");
@.Arithmetic overflow@>
help2("I can't evaluate this expression,")@/
("since the result is out of range.");
error;
if l>=glue_val then
begin delete_glue_ref(e); e:=zero_glue; add_glue_ref(e);
end
else e:=0;
end;
arith_error:=a; cur_val:=e; cur_val_level:=l;
end;
@ Evaluating an expression is a recursive process: When the left
parenthesis of a subexpression is scanned we descend to the next level
of recursion; the previous level is resumed with the matching right
parenthesis.
@d expr_none=0 {\.( seen, or \.( $\langle\it expr\rangle$ \.) seen}
@d expr_add=1 {\.( $\langle\it expr\rangle$ \.+ seen}
@d expr_sub=2 {\.( $\langle\it expr\rangle$ \.- seen}
@d expr_mult=3 {$\langle\it term\rangle$ \.* seen}
@d expr_div=4 {$\langle\it term\rangle$ \./ seen}
@d expr_scale=5 {$\langle\it term\rangle$ \.*
$\langle\it factor\rangle$ \./ seen}
@<Scan and eval...@>=
restart: r:=expr_none; e:=0; s:=expr_none; t:=0; n:=0;
continue: if s=expr_none then o:=l@+else o:=int_val;
@<Scan a factor |f| of type |o| or start a subexpression@>;
found: @<Scan the next operator and set |o|@>;
arith_error:=b;
@<Make sure that |f| is in the proper range@>;
case s of @<Cases for evaluation of the current term@>@;
end; {there are no other cases}
if o>expr_sub then s:=o@+else @<Evaluate the current expression@>;
b:=arith_error;
if o<>expr_none then goto continue;
if p<>null then @<Pop the expression stack and |goto found|@>
@ @<Scan the next op...@>=
@<Get the next non-blank non-call token@>;
if cur_tok=other_token+"+" then o:=expr_add
else if cur_tok=other_token+"-" then o:=expr_sub
else if cur_tok=other_token+"*" then o:=expr_mult
else if cur_tok=other_token+"/" then o:=expr_div
else begin o:=expr_none;
if p=null then
begin if cur_cmd<>relax then back_input;
end
else if cur_tok<>other_token+")" then
begin print_err("Missing ) inserted for expression");
@.Missing ) inserted@>
help1("I was expecting to see `+', `-', `*', `/', or `)'. Didn't.");
back_error;
end;
end
@ @<Scan a factor...@>=
@<Get the next non-blank non-call token@>;
if cur_tok=other_token+"(" then
@<Push the expression stack and |goto restart|@>;
back_input;
if o=int_val then scan_int
else if o=dimen_val then scan_normal_dimen
else if o=glue_val then scan_normal_glue
else scan_mu_glue;
f:=cur_val
@ @<Declare \eTeX\ procedures for sc...@>=
procedure@?scan_normal_glue; forward;@t\2@>@/
procedure@?scan_mu_glue; forward;@t\2@>
@ Here we declare two trivial procedures in order to avoid mutually
recursive procedures with parameters.
@<Declare procedures needed for expressions@>=
procedure scan_normal_glue;
begin scan_glue(glue_val);
end;
@#
procedure scan_mu_glue;
begin scan_glue(mu_val);
end;
@ Parenthesized subexpressions can be inside expressions, and this
nesting has a stack. Seven local variables represent the top of the
expression stack: |p| points to pushed-down entries, if any; |l|
specifies the type of expression currently being evaluated; |e| is the
expression so far and |r| is the state of its evaluation; |t| is the
term so far and |s| is the state of its evaluation; finally |n| is the
numerator for a combined multiplication and division, if any.
@d expr_node_size=4 {number of words in stack entry for subexpressions}
@d expr_e_field(#)==mem[#+1].int {saved expression so far}
@d expr_t_field(#)==mem[#+2].int {saved term so far}
@d expr_n_field(#)==mem[#+3].int {saved numerator}
@<Push the expression...@>=
begin q:=get_node(expr_node_size); link(q):=p; type(q):=l;
subtype(q):=4*s+r;
expr_e_field(q):=e; expr_t_field(q):=t; expr_n_field(q):=n;
p:=q; l:=o; goto restart;
end
@ @<Pop the expression...@>=
begin f:=e; q:=p;
e:=expr_e_field(q); t:=expr_t_field(q); n:=expr_n_field(q);
s:=subtype(q) div 4; r:=subtype(q) mod 4;
l:=type(q); p:=link(q); free_node(q,expr_node_size);
goto found;
end
@ We want to make sure that each term and (intermediate) result is in
the proper range. Integer values must not exceed |infinity|
($2^{31}-1$) in absolute value, dimensions must not exceed |max_dimen|
($2^{30}-1$). We avoid the absolute value of an integer, because this
might fail for the value $-2^{31}$ using 32-bit arithmetic.
@d num_error(#)== {clear a number or dimension and set |arith_error|}
begin arith_error:=true; #:=0;
end
@d glue_error(#)== {clear a glue spec and set |arith_error|}
begin arith_error:=true; delete_glue_ref(#); #:=new_spec(zero_glue);
end
@<Make sure that |f|...@>=
if (l=int_val)or(s>expr_sub) then
begin if (f>infinity)or(f<-infinity) then num_error(f);
end
else if l=dimen_val then
begin if abs(f)>max_dimen then num_error(f);
end
else begin if (abs(width(f))>max_dimen)or@|
(abs(stretch(f))>max_dimen)or@|
(abs(shrink(f))>max_dimen) then glue_error(f);
end
@ Applying the factor |f| to the partial term |t| (with the operator
|s|) is delayed until the next operator |o| has been scanned. Here we
handle the first factor of a partial term. A glue spec has to be copied
unless the next operator is a right parenthesis; this allows us later on
to simply modify the glue components.
@d normalize_glue(#)==
if stretch(#)=0 then stretch_order(#):=normal;
if shrink(#)=0 then shrink_order(#):=normal
@<Cases for evaluation of the current term@>=
expr_none: if (l>=glue_val)and(o<>expr_none) then
begin t:=new_spec(f); delete_glue_ref(f); normalize_glue(t);
end
else t:=f;
@ When a term |t| has been completed it is copied to, added to, or
subtracted from the expression |e|.
@d expr_add_sub(#)==add_or_sub(#,r=expr_sub)
@d expr_a(#)==expr_add_sub(#,max_dimen)
@<Evaluate the current expression@>=
begin s:=expr_none;
if r=expr_none then e:=t
else if l=int_val then e:=expr_add_sub(e,t,infinity)
else if l=dimen_val then e:=expr_a(e,t)
else @<Compute the sum or difference of two glue specs@>;
r:=o;
end
@ The function |add_or_sub(x,y,max_answer,negative)| computes the sum
(for |negative=false|) or difference (for |negative=true|) of |x| and
|y|, provided the absolute value of the result does not exceed
|max_answer|.
@<Declare subprocedures for |scan_expr|@>=
function add_or_sub(@!x,@!y,@!max_answer:integer;@!negative:boolean):integer;
var a:integer; {the answer}
begin if negative then negate(y);
if x>=0 then
if y<=max_answer-x then a:=x+y@+else num_error(a)
else if y>=-max_answer-x then a:=x+y@+else num_error(a);
add_or_sub:=a;
end;
@ We know that |stretch_order(e)>normal| implies |stretch(e)<>0| and
|shrink_order(e)>normal| implies |shrink(e)<>0|.
@<Compute the sum or diff...@>=
begin width(e):=expr_a(width(e),width(t));
if stretch_order(e)=stretch_order(t) then
stretch(e):=expr_a(stretch(e),stretch(t))
else if (stretch_order(e)<stretch_order(t))and(stretch(t)<>0) then
begin stretch(e):=stretch(t); stretch_order(e):=stretch_order(t);
end;
if shrink_order(e)=shrink_order(t) then
shrink(e):=expr_a(shrink(e),shrink(t))
else if (shrink_order(e)<shrink_order(t))and(shrink(t)<>0) then
begin shrink(e):=shrink(t); shrink_order(e):=shrink_order(t);
end;
delete_glue_ref(t); normalize_glue(e);
end
@ If a multiplication is followed by a division, the two operations are
combined into a `scaling' operation. Otherwise the term |t| is
multiplied by the factor |f|.
@d expr_m(#)==#:=nx_plus_y(#,f,0)
@<Cases for evaluation of the current term@>=
expr_mult: if o=expr_div then
begin n:=f; o:=expr_scale;
end
else if l=int_val then t:=mult_integers(t,f)
else if l=dimen_val then expr_m(t)
else begin expr_m(width(t)); expr_m(stretch(t)); expr_m(shrink(t));
end;
@ Here we divide the term |t| by the factor |f|.
@d expr_d(#)==#:=quotient(#,f)
@<Cases for evaluation of the current term@>=
expr_div: if l<glue_val then expr_d(t)
else begin expr_d(width(t)); expr_d(stretch(t)); expr_d(shrink(t));
end;
@ The function |quotient(n,d)| computes the rounded quotient
$q=\lfloor n/d+{1\over2}\rfloor$, when $n$ and $d$ are positive.
@<Declare subprocedures for |scan_expr|@>=
function quotient(@!n,@!d:integer):integer;
var negative:boolean; {should the answer be negated?}
@!a:integer; {the answer}
begin if d=0 then num_error(a)
else begin if d>0 then negative:=false
else begin negate(d); negative:=true;
end;
if n<0 then
begin negate(n); negative:=not negative;
end;
a:=n div d; n:=n-a*d; d:=n-d; {avoid certain compiler optimizations!}
if d+n>=0 then incr(a);
if negative then negate(a);
end;
quotient:=a;
end;
@ Here the term |t| is multiplied by the quotient $n/f$.
@d expr_s(#)==#:=fract(#,n,f,max_dimen)
@<Cases for evaluation of the current term@>=
expr_scale: if l=int_val then t:=fract(t,n,f,infinity)
else if l=dimen_val then expr_s(t)
else begin expr_s(width(t)); expr_s(stretch(t)); expr_s(shrink(t));
end;
@ Finally, the function |fract(x,n,d,max_answer)| computes the integer
$q=\lfloor xn/d+{1\over2}\rfloor$, when $x$, $n$, and $d$ are positive
and the result does not exceed |max_answer|. We can't use floating
point arithmetic since the routine must produce identical results in all
cases; and it would be too dangerous to multiply by~|n| and then divide
by~|d|, in separate operations, since overflow might well occur. Hence
this subroutine simulates double precision arithmetic, somewhat
analogous to \MF's |make_fraction| and |take_fraction| routines.
@d too_big=88 {go here when the result is too big}
@<Declare subprocedures for |scan_expr|@>=
function fract(@!x,@!n,@!d,@!max_answer:integer):integer;
label found, found1, too_big, done;
var negative:boolean; {should the answer be negated?}
@!a:integer; {the answer}
@!f:integer; {a proper fraction}
@!h:integer; {smallest integer such that |2*h>=d|}
@!r:integer; {intermediate remainder}
@!t:integer; {temp variable}
begin if d=0 then goto too_big;
a:=0;
if d>0 then negative:=false
else begin negate(d); negative:=true;
end;
if x<0 then
begin negate(x); negative:=not negative;
end
else if x=0 then goto done;
if n<0 then
begin negate(n); negative:=not negative;
end;
t:=n div d;
if t>max_answer div x then goto too_big;
a:=t*x; n:=n-t*d;
if n=0 then goto found;
t:=x div d;
if t>(max_answer-a) div n then goto too_big;
a:=a+t*n; x:=x-t*d;
if x=0 then goto found;
if x<n then
begin t:=x; x:=n; n:=t;
end; {now |0<n<=x<d|}
@<Compute \(f)$f=\lfloor xn/d+{1\over2}\rfloor$@>@;
if f>(max_answer-a) then goto too_big;
a:=a+f;
found: if negative then negate(a);
goto done;
too_big: num_error(a);
done: fract:=a;
end;
@ The loop here preserves the following invariant relations
between |f|, |x|, |n|, and~|r|:
(i)~$f+\lfloor(xn+(r+d))/d\rfloor=\lfloor x_0n_0/d+{1\over2}\rfloor$;
(ii)~|-d<=r<0<n<=x<d|, where $x_0$, $n_0$ are the original values of~$x$
and $n$.
Notice that the computation specifies |(x-d)+x| instead of |(x+x)-d|,
because the latter could overflow.
@<Compute \(f)$f=\lfloor xn/d+{1\over2}\rfloor$@>=
f:=0; r:=(d div 2)-d; h:=-r;
loop@+begin if odd(n) then
begin r:=r+x;
if r>=0 then
begin r:=r-d; incr(f);
end;
end;
n:=n div 2;
if n=0 then goto found1;
if x<h then x:=x+x
else begin t:=x-d; x:=t+x; f:=f+n;
if x<n then
begin if x=0 then goto found1;
t:=x; x:=n; n:=t;
end;
end;
end;
found1:
@ The \.{\\gluestretch}, \.{\\glueshrink}, \.{\\gluestretchorder}, and
\.{\\glueshrinkorder} commands return the stretch and shrink components
and their orders of ``infinity'' of a glue specification.
@d glue_stretch_order_code=eTeX_int+6 {code for \.{\\gluestretchorder}}
@d glue_shrink_order_code=eTeX_int+7 {code for \.{\\glueshrinkorder}}
@d glue_stretch_code=eTeX_dim+7 {code for \.{\\gluestretch}}
@d glue_shrink_code=eTeX_dim+8 {code for \.{\\glueshrink}}
@<Generate all \eTeX...@>=
primitive("gluestretchorder",last_item,glue_stretch_order_code);
@!@:glue_stretch_order_}{\.{\\gluestretchorder} primitive@>
primitive("glueshrinkorder",last_item,glue_shrink_order_code);
@!@:glue_shrink_order_}{\.{\\glueshrinkorder} primitive@>
primitive("gluestretch",last_item,glue_stretch_code);
@!@:glue_stretch_}{\.{\\gluestretch} primitive@>
primitive("glueshrink",last_item,glue_shrink_code);
@!@:glue_shrink_}{\.{\\glueshrink} primitive@>
@ @<Cases of |last_item| for |print_cmd_chr|@>=
glue_stretch_order_code: print_esc("gluestretchorder");
glue_shrink_order_code: print_esc("glueshrinkorder");
glue_stretch_code: print_esc("gluestretch");
glue_shrink_code: print_esc("glueshrink");
@ @<Cases for fetching an integer value@>=
glue_stretch_order_code, glue_shrink_order_code:
begin scan_normal_glue; q:=cur_val;
if m=glue_stretch_order_code then cur_val:=stretch_order(q)
else cur_val:=shrink_order(q);
delete_glue_ref(q);
end;
@ @<Cases for fetching a dimension value@>=
glue_stretch_code, glue_shrink_code:
begin scan_normal_glue; q:=cur_val;
if m=glue_stretch_code then cur_val:=stretch(q)
else cur_val:=shrink(q);
delete_glue_ref(q);
end;
@ The \.{\\mutoglue} and \.{\\gluetomu} commands convert ``math'' glue
into normal glue and vice versa; they allow to manipulate math glue with
\.{\\gluestretch} etc.
@d mu_to_glue_code=eTeX_glue {code for \.{\\mutoglue}}
@d glue_to_mu_code=eTeX_mu {code for \.{\\gluetomu}}
@<Generate all \eTeX...@>=
primitive("mutoglue",last_item,mu_to_glue_code);
@!@:mu_to_glue_}{\.{\\mutoglue} primitive@>
primitive("gluetomu",last_item,glue_to_mu_code);
@!@:glue_to_mu_}{\.{\\gluetomu} primitive@>
@ @<Cases of |last_item| for |print_cmd_chr|@>=
mu_to_glue_code: print_esc("mutoglue");
glue_to_mu_code: print_esc("gluetomu");
@ @<Cases for fetching a glue value@>=
mu_to_glue_code: scan_mu_glue;
@ @<Cases for fetching a mu value@>=
glue_to_mu_code: scan_normal_glue;
@ \eTeX\ (in extended mode) supports 32768 (i.e., $2^{15}$) count,
dimen, skip, muskip, box, and token registers. As in \TeX\ the first
256 registers of each kind are realized as arrays in the table of
equivalents; the additional registers are realized as tree structures
built from variable-size nodes with individual registers existing only
when needed. Default values are used for nonexistent registers: zero
for count and dimen values, |zero_glue| for glue (skip and muskip)
values, void for boxes, and |null| for token lists (and current marks
discussed below).
Similarly there are 32768 mark classes; the command \.{\\marks}|n|
creates a mark node for a given mark class |0<=n<=32767| (where
\.{\\marks0} is synonymous to \.{\\mark}). The page builder (actually
the |fire_up| routine) and the |vsplit| routine maintain the current
values of |top_mark|, |first_mark|, |bot_mark|, |split_first_mark|, and
|split_bot_mark| for each mark class. They are accessed as
\.{\\topmarks}|n| etc., and \.{\\topmarks0} is again synonymous to
\.{\\topmark}. As in \TeX\ the five current marks for mark class zero
are realized as |cur_mark| array. The additional current marks are
again realized as tree structure with individual mark classes existing
only when needed.
@<Generate all \eTeX...@>=
primitive("marks",mark,marks_code);
@!@:marks_}{\.{\\marks} primitive@>
primitive("topmarks",top_bot_mark,top_mark_code+marks_code);
@!@:top_marks_}{\.{\\topmarks} primitive@>
primitive("firstmarks",top_bot_mark,first_mark_code+marks_code);
@!@:first_marks_}{\.{\\firstmarks} primitive@>
primitive("botmarks",top_bot_mark,bot_mark_code+marks_code);
@!@:bot_marks_}{\.{\\botmarks} primitive@>
primitive("splitfirstmarks",top_bot_mark,split_first_mark_code+marks_code);
@!@:split_first_marks_}{\.{\\splitfirstmarks} primitive@>
primitive("splitbotmarks",top_bot_mark,split_bot_mark_code+marks_code);
@!@:split_bot_marks_}{\.{\\splitbotmarks} primitive@>
@ The |scan_register_num| procedure scans a register number that must
not exceed 255 in compatibility mode resp.\ 32767 in extended mode.
@<Declare \eTeX\ procedures for ex...@>=
procedure@?scan_register_num; forward;@t\2@>
@ @<Declare procedures that scan restricted classes of integers@>=
procedure scan_register_num;
begin scan_int;
if (cur_val<0)or(cur_val>max_reg_num) then
begin print_err("Bad register code");
@.Bad register code@>
help2(max_reg_help_line)("I changed this one to zero.");
int_error(cur_val); cur_val:=0;
end;
end;
@ @<Initialize variables for \eTeX\ comp...@>=
max_reg_num:=255;
max_reg_help_line:="A register number must be between 0 and 255.";
@ @<Initialize variables for \eTeX\ ext...@>=
max_reg_num:=32767;
max_reg_help_line:="A register number must be between 0 and 32767.";
@ @<Glob...@>=
@!max_reg_num: halfword; {largest allowed register number}
@!max_reg_help_line: str_number; {first line of help message}
@ There are seven almost identical doubly linked trees, one for the
sparse array of the up to 32512 additional registers of each kind and
one for the sparse array of the up to 32767 additional mark classes.
The root of each such tree, if it exists, is an index node containing 16
pointers to subtrees for 4096 consecutive array elements. Similar index
nodes are the starting points for all nonempty subtrees for 4096, 256,
and 16 consecutive array elements. These four levels of index nodes are
followed by a fifth level with nodes for the individual array elements.
Each index node is nine words long. The pointers to the 16 possible
subtrees or are kept in the |info| and |link| fields of the last eight
words. (It would be both elegant and efficient to declare them as
array, unfortunately \PASCAL\ doesn't allow this.)
The fields in the first word of each index node and in the nodes for the
array elements are closely related. The |link| field points to the next
lower index node and the |sa_index| field contains four bits (one
hexadecimal digit) of the register number or mark class. For the lowest
index node the |link| field is |null| and the |sa_index| field indicates
the type of quantity (|int_val|, |dimen_val|, |glue_val|, |mu_val|,
|box_val|, |tok_val|, or |mark_val|). The |sa_used| field in the index
nodes counts how many of the 16 pointers are non-null.
The |sa_index| field in the nodes for array elements contains the four
bits plus 16 times the type. Therefore such a node represents a count
or dimen register if and only if |sa_index<dimen_val_limit|; it
represents a skip or muskip register if and only if
|dimen_val_limit<=sa_index<mu_val_limit|; it represents a box register
if and only if |mu_val_limit<=sa_index<box_val_limit|; it represents a
token list register if and only if
|box_val_limit<=sa_index<tok_val_limit|; finally it represents a mark
class if and only if |tok_val_limit<=sa_index|.
The |new_index| procedure creates an index node (returned in |cur_ptr|)
having given contents of the |sa_index| and |link| fields.
@d box_val==4 {the additional box registers}
@d mark_val=6 {the additional mark classes}
@#
@d dimen_val_limit=@"20 {$2^4\cdot(|dimen_val|+1)$}
@d mu_val_limit=@"40 {$2^4\cdot(|mu_val|+1)$}
@d box_val_limit=@"50 {$2^4\cdot(|box_val|+1)$}
@d tok_val_limit=@"60 {$2^4\cdot(|tok_val|+1)$}
@#
@d index_node_size=9 {size of an index node}
@d sa_index==type {a four-bit address or a type or both}
@d sa_used==subtype {count of non-null pointers}
@<Declare \eTeX\ procedures for ex...@>=
procedure new_index(@!i:quarterword; @!q:pointer);
var k:small_number; {loop index}
begin cur_ptr:=get_node(index_node_size); sa_index(cur_ptr):=i;
sa_used(cur_ptr):=0; link(cur_ptr):=q;
for k:=1 to index_node_size-1 do {clear all 16 pointers}
mem[cur_ptr+k]:=sa_null;
end;
@ The roots of the seven trees for the additional registers and mark
classes are kept in the |sa_root| array. The first six locations must
be dumped and undumped; the last one is also known as |sa_mark|.
@d sa_mark==sa_root[mark_val] {root for mark classes}
@<Glob...@>=
@!sa_root:array[int_val..mark_val] of pointer; {roots of sparse arrays}
@!cur_ptr:pointer; {value returned by |new_index| and |find_sa_element|}
@!sa_null:memory_word; {two |null| pointers}
@ @<Set init...@>=
sa_mark:=null; sa_null.hh.lh:=null; sa_null.hh.rh:=null;
@ @<Initialize table...@>=
for i:=int_val to tok_val do sa_root[i]:=null;
@ Given a type |t| and a sixteen-bit number |n|, the |find_sa_element|
procedure returns (in |cur_ptr|) a pointer to the node for the
corresponding array element, or |null| when no such element exists. The
third parameter |w| is set |true| if the element must exist, e.g.,
because it is about to be modified. The procedure has two main
branches: one follows the existing tree structure, the other (only used
when |w| is |true|) creates the missing nodes.
We use macros to extract the four-bit pieces from a sixteen-bit register
number or mark class and to fetch or store one of the 16 pointers from
an index node.
@d if_cur_ptr_is_null_then_return_or_goto(#)== {some tree element is missing}
begin if cur_ptr=null then
if w then goto #@+else return;
end
@#
@d hex_dig1(#)==# div 4096 {the fourth lowest hexadecimal digit}
@d hex_dig2(#)==(# div 256) mod 16 {the third lowest hexadecimal digit}
@d hex_dig3(#)==(# div 16) mod 16 {the second lowest hexadecimal digit}
@d hex_dig4(#)==# mod 16 {the lowest hexadecimal digit}
@#
@d get_sa_ptr==if odd(i) then cur_ptr:=link(q+(i div 2)+1)
else cur_ptr:=info(q+(i div 2)+1)
{set |cur_ptr| to the pointer indexed by |i| from index node |q|}
@d put_sa_ptr(#)==if odd(i) then link(q+(i div 2)+1):=#
else info(q+(i div 2)+1):=#
{store the pointer indexed by |i| in index node |q|}
@d add_sa_ptr==begin put_sa_ptr(cur_ptr); incr(sa_used(q));
end {add |cur_ptr| as the pointer indexed by |i| in index node |q|}
@d delete_sa_ptr==begin put_sa_ptr(null); decr(sa_used(q));
end {delete the pointer indexed by |i| in index node |q|}
@<Declare \eTeX\ procedures for ex...@>=
procedure find_sa_element(@!t:small_number;@!n:halfword;@!w:boolean);
{sets |cur_val| to sparse array element location or |null|}
label not_found,not_found1,not_found2,not_found3,not_found4,exit;
var q:pointer; {for list manipulations}
@!i:small_number; {a four bit index}
begin cur_ptr:=sa_root[t];
if_cur_ptr_is_null_then_return_or_goto(not_found);@/
q:=cur_ptr; i:=hex_dig1(n); get_sa_ptr;
if_cur_ptr_is_null_then_return_or_goto(not_found1);@/
q:=cur_ptr; i:=hex_dig2(n); get_sa_ptr;
if_cur_ptr_is_null_then_return_or_goto(not_found2);@/
q:=cur_ptr; i:=hex_dig3(n); get_sa_ptr;
if_cur_ptr_is_null_then_return_or_goto(not_found3);@/
q:=cur_ptr; i:=hex_dig4(n); get_sa_ptr;
if (cur_ptr=null)and w then goto not_found4;
return;
not_found: new_index(t,null); {create first level index node}
sa_root[t]:=cur_ptr; q:=cur_ptr; i:=hex_dig1(n);
not_found1: new_index(i,q); {create second level index node}
add_sa_ptr; q:=cur_ptr; i:=hex_dig2(n);
not_found2: new_index(i,q); {create third level index node}
add_sa_ptr; q:=cur_ptr; i:=hex_dig3(n);
not_found3: new_index(i,q); {create fourth level index node}
add_sa_ptr; q:=cur_ptr; i:=hex_dig4(n);
not_found4: @<Create a new array element of type |t| with index |i|@>;
link(cur_ptr):=q; add_sa_ptr;
exit:end;
@ The array elements for registers are subject to grouping and have an
|sa_lev| field (quite analogous to |eq_level|) instead of |sa_used|.
Since saved values as well as shorthand definitions (created by e.g.,
\.{\\countdef}) refer to the location of the respective array element,
we need a reference count that is kept in the |sa_ref| field. An array
element can be deleted (together with all references to it) when its
|sa_ref| value is |null| and its value is the default value.
@^reference counts@>
Skip, muskip, box, and token registers use two word nodes, their values
are stored in the |sa_ptr| field.
Count and dimen registers use three word nodes, their
values are stored in the |sa_int| resp.\ |sa_dim| field in the third
word; the |sa_ptr| field is used under the name |sa_num| to store
the register number. Mark classes use four word nodes. The last three
words contain the five types of current marks
@d sa_lev==sa_used {grouping level for the current value}
@d pointer_node_size=2 {size of an element with a pointer value}
@d sa_type(#)==(sa_index(#) div 16) {type part of combined type/index}
@d sa_ref(#)==info(#+1) {reference count of a sparse array element}
@d sa_ptr(#)==link(#+1) {a pointer value}
@#
@d word_node_size=3 {size of an element with a word value}
@d sa_num==sa_ptr {the register number}
@d sa_int(#)==mem[#+2].int {an integer}
@d sa_dim(#)==mem[#+2].sc {a dimension (a somewhat esoteric distinction)}
@#
@d mark_class_node_size=4 {size of an element for a mark class}
@#
@d fetch_box(#)== {fetch |box(cur_val)|}
if cur_val<256 then #:=box(cur_val)
else begin find_sa_element(box_val,cur_val,false);
if cur_ptr=null then #:=null@+else #:=sa_ptr(cur_ptr);
end
@<Create a new array element...@>=
if t=mark_val then {a mark class}
begin cur_ptr:=get_node(mark_class_node_size);
mem[cur_ptr+1]:=sa_null; mem[cur_ptr+2]:=sa_null; mem[cur_ptr+3]:=sa_null;
end
else begin if t<=dimen_val then {a count or dimen register}
begin cur_ptr:=get_node(word_node_size); sa_int(cur_ptr):=0;
sa_num(cur_ptr):=n;
end
else begin cur_ptr:=get_node(pointer_node_size);
if t<=mu_val then {a skip or muskip register}
begin sa_ptr(cur_ptr):=zero_glue; add_glue_ref(zero_glue);
end
else sa_ptr(cur_ptr):=null; {a box or token list register}
end;
sa_ref(cur_ptr):=null; {all registers have a reference count}
end;
sa_index(cur_ptr):=16*t+i; sa_lev(cur_ptr):=level_one
@ The |delete_sa_ref| procedure is called when a pointer to an array
element representing a register is being removed; this means that the
reference count should be decreased by one. If the reduced reference
count is |null| and the register has been (globally) assigned its
default value the array element should disappear, possibly together with
some index nodes. This procedure will never be used for mark class
nodes.
@^reference counts@>
@d add_sa_ref(#)==incr(sa_ref(#)) {increase reference count}
@#
@d change_box(#)== {change |box(cur_val)|, the |eq_level| stays the same}
if cur_val<256 then box(cur_val):=#@+else set_sa_box(#)
@#
@d set_sa_box(#)==begin find_sa_element(box_val,cur_val,false);
if cur_ptr<>null then
begin sa_ptr(cur_ptr):=#; add_sa_ref(cur_ptr); delete_sa_ref(cur_ptr);
end;
end
@<Declare \eTeX\ procedures for tr...@>=
procedure delete_sa_ref(@!q:pointer); {reduce reference count}
label exit;
var p:pointer; {for list manipulations}
@!i:small_number; {a four bit index}
@!s:small_number; {size of a node}
begin decr(sa_ref(q));
if sa_ref(q)<>null then return;
if sa_index(q)<dimen_val_limit then
if sa_int(q)=0 then s:=word_node_size
else return
else begin if sa_index(q)<mu_val_limit then
if sa_ptr(q)=zero_glue then delete_glue_ref(zero_glue)
else return
else if sa_ptr(q)<>null then return;
s:=pointer_node_size;
end;
repeat i:=hex_dig4(sa_index(q)); p:=q; q:=link(p); free_node(p,s);
if q=null then {the whole tree has been freed}
begin sa_root[i]:=null; return;
end;
delete_sa_ptr; s:=index_node_size; {node |q| is an index node}
until sa_used(q)>0;
exit:end;
@ The |print_sa_num| procedure prints the register number corresponding
to an array element.
@<Basic print...@>=
procedure print_sa_num(@!q:pointer); {print register number}
var @!n:halfword; {the register number}
begin if sa_index(q)<dimen_val_limit then n:=sa_num(q) {the easy case}
else begin n:=hex_dig4(sa_index(q)); q:=link(q); n:=n+16*sa_index(q);
q:=link(q); n:=n+256*(sa_index(q)+16*sa_index(link(q)));
end;
print_int(n);
end;
@ Here is a procedure that displays the contents of an array element
symbolically. It is used under similar circumstances as is
|restore_trace| (together with |show_eqtb|) for the quantities kept in
the |eqtb| array.
@<Declare \eTeX\ procedures for tr...@>=
@!stat procedure show_sa(@!p:pointer;@!s:str_number);
var t:small_number; {the type of element}
begin begin_diagnostic; print_char("{"); print(s); print_char(" ");
if p=null then print_char("?") {this can't happen}
else begin t:=sa_type(p);
if t<box_val then print_cmd_chr(register,p)
else if t=box_val then
begin print_esc("box"); print_sa_num(p);
end
else if t=tok_val then print_cmd_chr(toks_register,p)
else print_char("?"); {this can't happen either}
print_char("=");
if t=int_val then print_int(sa_int(p))
else if t=dimen_val then
begin print_scaled(sa_dim(p)); print("pt");
end
else begin p:=sa_ptr(p);
if t=glue_val then print_spec(p,"pt")
else if t=mu_val then print_spec(p,"mu")
else if t=box_val then
if p=null then print("void")
else begin depth_threshold:=0; breadth_max:=1; show_node_list(p);
end
else if t=tok_val then
begin if p<>null then show_token_list(link(p),null,32);
end
else print_char("?"); {this can't happen either}
end;
end;
print_char("}"); end_diagnostic(false);
end;
tats
@ Here we compute the pointer to the current mark of type |t| and mark
class |cur_val|.
@<Compute the mark pointer...@>=
begin find_sa_element(mark_val,cur_val,false);
if cur_ptr<>null then
if odd(t) then cur_ptr:=link(cur_ptr+(t div 2)+1)
else cur_ptr:=info(cur_ptr+(t div 2)+1);
end
@ The current marks for all mark classes are maintained by the |vsplit|
and |fire_up| routines and are finally destroyed (for \.{INITEX} only)
@.INITEX@>
by the |final_cleanup| routine. Apart from updating the current marks
when mark nodes are encountered, these routines perform certain actions
on all existing mark classes. The recursive |do_marks| procedure walks
through the whole tree or a subtree of existing mark class nodes and
preforms certain actions indicted by its first parameter |a|, the action
code. The second parameter |l| indicates the level of recursion (at
most four); the third parameter points to a nonempty tree or subtree.
The result is |true| if the complete tree or subtree has been deleted.
@d vsplit_init==0 {action code for |vsplit| initialization}
@d fire_up_init==1 {action code for |fire_up| initialization}
@d fire_up_done==2 {action code for |fire_up| completion}
@d destroy_marks==3 {action code for |final_cleanup|}
@#
@d sa_top_mark(#)==info(#+1) {\.{\\topmarks}|n|}
@d sa_first_mark(#)==link(#+1) {\.{\\firstmarks}|n|}
@d sa_bot_mark(#)==info(#+2) {\.{\\botmarks}|n|}
@d sa_split_first_mark(#)==link(#+2) {\.{\\splitfirstmarks}|n|}
@d sa_split_bot_mark(#)==info(#+3) {\.{\\splitbotmarks}|n|}
@<Declare the function called |do_marks|@>=
function do_marks(@!a,@!l:small_number;@!q:pointer):boolean;
var i:small_number; {a four bit index}
begin if l<4 then {|q| is an index node}
begin for i:=0 to 15 do
begin get_sa_ptr;
if cur_ptr<>null then if do_marks(a,l+1,cur_ptr) then delete_sa_ptr;
end;
if sa_used(q)=0 then
begin free_node(q,index_node_size); q:=null;
end;
end
else {|q| is the node for a mark class}
begin case a of
@<Cases for |do_marks|@>@;
end; {there are no other cases}
if sa_bot_mark(q)=null then if sa_split_bot_mark(q)=null then
begin free_node(q,mark_class_node_size); q:=null;
end;
end;
do_marks:=(q=null);
end;
@ At the start of the |vsplit| routine the existing |split_fist_mark|
and |split_bot_mark| are discarded.
@<Cases for |do_marks|@>=
vsplit_init: if sa_split_first_mark(q)<>null then
begin delete_token_ref(sa_split_first_mark(q)); sa_split_first_mark(q):=null;
delete_token_ref(sa_split_bot_mark(q)); sa_split_bot_mark(q):=null;
end;
@ We use again the fact that |split_first_mark=null| if and only if
|split_bot_mark=null|.
@<Update the current marks for |vsplit|@>=
begin find_sa_element(mark_val,mark_class(p),true);
if sa_split_first_mark(cur_ptr)=null then
begin sa_split_first_mark(cur_ptr):=mark_ptr(p);
add_token_ref(mark_ptr(p));
end
else delete_token_ref(sa_split_bot_mark(cur_ptr));
sa_split_bot_mark(cur_ptr):=mark_ptr(p);
add_token_ref(mark_ptr(p));
end
@ At the start of the |fire_up| routine the old |top_mark| and
|first_mark| are discarded, whereas the old |bot_mark| becomes the new
|top_mark|. An empty new |top_mark| token list is, however, discarded
as well in order that mark class nodes can eventually be released. We
use again the fact that |bot_mark<>null| implies |first_mark<>null|; it
also knows that |bot_mark=null| implies |top_mark=first_mark=null|.
@<Cases for |do_marks|@>=
fire_up_init: if sa_bot_mark(q)<>null then
begin if sa_top_mark(q)<>null then delete_token_ref(sa_top_mark(q));
delete_token_ref(sa_first_mark(q)); sa_first_mark(q):=null;
if link(sa_bot_mark(q))=null then {an empty token list}
begin delete_token_ref(sa_bot_mark(q)); sa_bot_mark(q):=null;
end
else add_token_ref(sa_bot_mark(q));
sa_top_mark(q):=sa_bot_mark(q);
end;
@ @<Cases for |do_marks|@>=
fire_up_done: if (sa_top_mark(q)<>null)and(sa_first_mark(q)=null) then
begin sa_first_mark(q):=sa_top_mark(q); add_token_ref(sa_top_mark(q));
end;
@ @<Update the current marks for |fire_up|@>=
begin find_sa_element(mark_val,mark_class(p),true);
if sa_first_mark(cur_ptr)=null then
begin sa_first_mark(cur_ptr):=mark_ptr(p);
add_token_ref(mark_ptr(p));
end;
if sa_bot_mark(cur_ptr)<>null then delete_token_ref(sa_bot_mark(cur_ptr));
sa_bot_mark(cur_ptr):=mark_ptr(p); add_token_ref(mark_ptr(p));
end
@ Here we use the fact that the five current mark pointers in a mark
class node occupy the same locations as the the first five pointers of
an index node. For systems using a run-time switch to distinguish
between \.{VIRTEX} and \.{INITEX}, the codewords `$|init|\ldots|tini|$'
surrounding the following piece of code should be removed.
@.INITEX@>
@^system dependencies@>
@<Cases for |do_marks|@>=
@!init destroy_marks: for i:=top_mark_code to split_bot_mark_code do
begin get_sa_ptr;
if cur_ptr<>null then
begin delete_token_ref(cur_ptr); put_sa_ptr(null);
end;
end;
tini
@ The command code |register| is used for `\.{\\count}', `\.{\\dimen}',
etc., as well as for references to sparse array elements defined by
`\.{\\countdef}', etc.
@<Cases of |register| for |print_cmd_chr|@>=
begin if (chr_code<mem_bot)or(chr_code>lo_mem_stat_max) then
cmd:=sa_type(chr_code)
else begin cmd:=chr_code-mem_bot; chr_code:=null;
end;
if cmd=int_val then print_esc("count")
else if cmd=dimen_val then print_esc("dimen")
else if cmd=glue_val then print_esc("skip")
else print_esc("muskip");
if chr_code<>null then print_sa_num(chr_code);
end
@ Similarly the command code |toks_register| is used for `\.{\\toks}' as
well as for references to sparse array elements defined by
`\.{\\toksdef}'.
@<Cases of |toks_register| for |print_cmd_chr|@>=
begin print_esc("toks");
if chr_code<>mem_bot then print_sa_num(chr_code);
end
@ When a shorthand definition for an element of one of the sparse arrays
is destroyed, we must reduce the reference count.
@<Cases for |eq_destroy|@>=
toks_register,register:
if (equiv_field(w)<mem_bot)or(equiv_field(w)>lo_mem_stat_max) then
delete_sa_ref(equiv_field(w));
@ The task to maintain (change, save, and restore) register values is
essentially the same when the register is realized as sparse array
element or entry in |eqtb|. The global variable |sa_chain| is the head
of a linked list of entries saved at the topmost level |sa_level|; the
lists for lower levels are kept in special save stack entries.
@<Glob...@>=
@!sa_chain: pointer; {chain of saved sparse array entries}
@!sa_level: quarterword; {group level for |sa_chain|}
@ @<Set init...@>=
sa_chain:=null; sa_level:=level_zero;
@ The individual saved items are kept in pointer or word nodes similar
to those used for the array elements: a word node with value zero is,
however, saved as pointer node with the otherwise impossible |sa_index|
value |tok_val_limit|.
@d sa_loc==sa_ref {location of saved item}
@<Declare \eTeX\ procedures for tr...@>=
procedure sa_save(@!p:pointer); {saves value of |p|}
var q:pointer; {the new save node}
@!i:quarterword; {index field of node}
begin if cur_level<>sa_level then
begin check_full_save_stack; save_type(save_ptr):=restore_sa;
save_level(save_ptr):=sa_level; save_index(save_ptr):=sa_chain;
incr(save_ptr); sa_chain:=null; sa_level:=cur_level;
end;
i:=sa_index(p);
if i<dimen_val_limit then
begin if sa_int(p)=0 then
begin q:=get_node(pointer_node_size); i:=tok_val_limit;
end
else begin q:=get_node(word_node_size); sa_int(q):=sa_int(p);
end;
sa_ptr(q):=null;
end
else begin q:=get_node(pointer_node_size); sa_ptr(q):=sa_ptr(p);
end;
sa_loc(q):=p; sa_index(q):=i; sa_lev(q):=sa_lev(p);
link(q):=sa_chain; sa_chain:=q; add_sa_ref(p);
end;
@ @<Declare \eTeX\ procedures for tr...@>=
procedure sa_destroy(@!p:pointer); {destroy value of |p|}
begin if sa_index(p)<mu_val_limit then delete_glue_ref(sa_ptr(p))
else if sa_ptr(p)<>null then
if sa_index(p)<box_val_limit then flush_node_list(sa_ptr(p))
else delete_token_ref(sa_ptr(p));
end;
@ The procedure |sa_def| assigns a new value to sparse array elements,
and saves the former value if appropriate. This procedure is used only
for skip, muskip, box, and token list registers. The counterpart of
|sa_def| for count and dimen registers is called |sa_w_def|.
@d sa_define(#)==if e then
if global then gsa_def(#)@+else sa_def(#)
else define
@#
@d sa_def_box== {assign |cur_box| to |box(cur_val)|}
begin find_sa_element(box_val,cur_val,true);
if global then gsa_def(cur_ptr,cur_box)@+else sa_def(cur_ptr,cur_box);
end
@#
@d sa_word_define(#)==if e then
if global then gsa_w_def(#)@+else sa_w_def(#)
else word_define(#)
@<Declare \eTeX\ procedures for tr...@>=
procedure sa_def(@!p:pointer;@!e:halfword);
{new data for sparse array elements}
begin add_sa_ref(p);
if sa_ptr(p)=e then
begin @!stat if tracing_assigns>0 then show_sa(p,"reassigning");@+tats@;@/
sa_destroy(p);
end
else begin @!stat if tracing_assigns>0 then show_sa(p,"changing");@+tats@;@/
if sa_lev(p)=cur_level then sa_destroy(p)@+else sa_save(p);
sa_lev(p):=cur_level; sa_ptr(p):=e;
@!stat if tracing_assigns>0 then show_sa(p,"into");@+tats@;@/
end;
delete_sa_ref(p);
end;
@#
procedure sa_w_def(@!p:pointer;@!w:integer);
begin add_sa_ref(p);
if sa_int(p)=w then
begin @!stat if tracing_assigns>0 then show_sa(p,"reassigning");@+tats@;@/
end
else begin @!stat if tracing_assigns>0 then show_sa(p,"changing");@+tats@;@/
if sa_lev(p)<>cur_level then sa_save(p);
sa_lev(p):=cur_level; sa_int(p):=w;
@!stat if tracing_assigns>0 then show_sa(p,"into");@+tats@;@/
end;
delete_sa_ref(p);
end;
@ The |sa_def| and |sa_w_def| routines take care of local definitions.
@^global definitions@>
Global definitions are done in almost the same way, but there is no need
to save old values, and the new value is associated with |level_one|.
@<Declare \eTeX\ procedures for tr...@>=
procedure gsa_def(@!p:pointer;@!e:halfword); {global |sa_def|}
begin add_sa_ref(p);
@!stat if tracing_assigns>0 then show_sa(p,"globally changing");@+tats@;@/
sa_destroy(p); sa_lev(p):=level_one; sa_ptr(p):=e;
@!stat if tracing_assigns>0 then show_sa(p,"into");@+tats@;@/
delete_sa_ref(p);
end;
@#
procedure gsa_w_def(@!p:pointer;@!w:integer); {global |sa_w_def|}
begin add_sa_ref(p);
@!stat if tracing_assigns>0 then show_sa(p,"globally changing");@+tats@;@/
sa_lev(p):=level_one; sa_int(p):=w;
@!stat if tracing_assigns>0 then show_sa(p,"into");@+tats@;@/
delete_sa_ref(p);
end;
@ The |sa_restore| procedure restores the sparse array entries pointed
at by |sa_chain|.
@<Declare \eTeX\ procedures for tr...@>=
procedure sa_restore;
var p:pointer; {sparse array element}
begin repeat p:=sa_loc(sa_chain);
if sa_lev(p)=level_one then
begin if sa_index(p)>=dimen_val_limit then sa_destroy(sa_chain);
@!stat if tracing_restores>0 then show_sa(p,"retaining");@+tats@;@/
end
else begin if sa_index(p)<dimen_val_limit then
if sa_index(sa_chain)<dimen_val_limit then sa_int(p):=sa_int(sa_chain)
else sa_int(p):=0
else begin sa_destroy(p); sa_ptr(p):=sa_ptr(sa_chain);
end;
sa_lev(p):=sa_lev(sa_chain);
@!stat if tracing_restores>0 then show_sa(p,"restoring");@+tats@;@/
end;
delete_sa_ref(p);
p:=sa_chain; sa_chain:=link(p);
if sa_index(p)<dimen_val_limit then free_node(p,word_node_size)
else free_node(p,pointer_node_size);
until sa_chain=null;
end;
@ When the value of |last_line_fit| is positive, the last line of a
(partial) paragraph is treated in a special way and we need additional
fields in the active nodes.
@d active_node_size_extended=5 {number of words in extended active nodes}
@d active_short(#)==mem[#+3].sc {|shortfall| of this line}
@d active_glue(#)==mem[#+4].sc {corresponding glue stretch or shrink}
@<Glob...@>=
@!last_line_fill:pointer; {the |par_fill_skip| glue node of the new paragraph}
@!do_last_line_fit:boolean; {special algorithm for last line of paragraph?}
@!active_node_size:small_number; {number of words in active nodes}
@!fill_width:array[0..2] of scaled; {infinite stretch components of
|par_fill_skip|}
@!best_pl_short:array[very_loose_fit..tight_fit] of scaled; {|shortfall|
corresponding to |minimal_demerits|}
@!best_pl_glue:array[very_loose_fit..tight_fit] of scaled; {corresponding
glue stretch or shrink}
@ The new algorithm for the last line requires that the stretchability of
|par_fill_skip| is infinite and the stretchability of |left_skip| plus
|right_skip| is finite.
@<Check for special...@>=
do_last_line_fit:=false; active_node_size:=active_node_size_normal;
{just in case}
if last_line_fit>0 then
begin q:=glue_ptr(last_line_fill);
if (stretch(q)>0)and(stretch_order(q)>normal) then
if (background[3]=0)and(background[4]=0)and(background[5]=0) then
begin do_last_line_fit:=true;
active_node_size:=active_node_size_extended;
fill_width[0]:=0; fill_width[1]:=0; fill_width[2]:=0;
fill_width[stretch_order(q)-1]:=stretch(q);
end;
end
@ @<Other local variables for |try_break|@>=
@!g:scaled; {glue stretch or shrink of test line, adjustment for last line}
@ Here we initialize the additional fields of the first active node
representing the beginning of the paragraph.
@<Initialize additional fields of the first active node@>=
begin active_short(q):=0; active_glue(q):=0;
end
@ Here we compute the adjustment |g| and badness |b| for a line from |r|
to the end of the paragraph. When any of the criteria for adjustment is
violated we fall through to the normal algorithm.
The last line must be too short, and have infinite stretch entirely due
to |par_fill_skip|.
@<Perform computations for last line and |goto found|@>=
begin if (active_short(r)=0)or(active_glue(r)<=0) then goto not_found;
{previous line was neither stretched nor shrunk, or was infinitely bad}
if (cur_active_width[3]<>fill_width[0])or@|
(cur_active_width[4]<>fill_width[1])or@|
(cur_active_width[5]<>fill_width[2]) then goto not_found;
{infinite stretch of this line not entirely due to |par_fill_skip|}
if active_short(r)>0 then g:=cur_active_width[2]
else g:=cur_active_width[6];
if g<=0 then goto not_found; {no finite stretch resp.\ no shrink}
arith_error:=false; g:=fract(g,active_short(r),active_glue(r),max_dimen);
if last_line_fit<1000 then g:=fract(g,last_line_fit,1000,max_dimen);
if arith_error then
if active_short(r)>0 then g:=max_dimen@+else g:=-max_dimen;
if g>0 then
@<Set the value of |b| to the badness of the last line for stretching,
compute the corresponding |fit_class|, and |goto found|@>
else if g<0 then
@<Set the value of |b| to the badness of the last line for shrinking,
compute the corresponding |fit_class|, and |goto found|@>;
not_found:end
@ These badness computations are rather similar to those of the standard
algorithm, with the adjustment amount |g| replacing the |shortfall|.
@<Set the value of |b| to the badness of the last line for str...@>=
begin if g>shortfall then g:=shortfall;
if g>7230584 then if cur_active_width[2]<1663497 then
begin b:=inf_bad; fit_class:=very_loose_fit; goto found;
end;
b:=badness(g,cur_active_width[2]);
if b>12 then
if b>99 then fit_class:=very_loose_fit
else fit_class:=loose_fit
else fit_class:=decent_fit;
goto found;
end
@ @<Set the value of |b| to the badness of the last line for shr...@>=
begin if -g>cur_active_width[6] then g:=-cur_active_width[6];
b:=badness(-g,cur_active_width[6]);
if b>12 then fit_class:=tight_fit@+else fit_class:=decent_fit;
goto found;
end
@ Vanishing values of |shortfall| and |g| indicate that the last line is
not adjusted.
@<Adjust \(t)the additional data for last line@>=
begin if cur_p=null then shortfall:=0;
if shortfall>0 then g:=cur_active_width[2]
else if shortfall<0 then g:=cur_active_width[6]
else g:=0;
end
@ For each feasible break we record the shortfall and glue stretch or
shrink (or adjustment).
@<Store \(a)additional data for this feasible break@>=
begin best_pl_short[fit_class]:=shortfall; best_pl_glue[fit_class]:=g;
end
@ Here we save these data in the active node representing a potential
line break.
@<Store \(a)additional data in the new active node@>=
begin active_short(q):=best_pl_short[fit_class];
active_glue(q):=best_pl_glue[fit_class];
end
@ @<Print additional data in the new active node@>=
begin print(" s="); print_scaled(active_short(q));
if cur_p=null then print(" a=")@+else print(" g=");
print_scaled(active_glue(q));
end
@ Here we either reset |do_last_line_fit| or adjust the |par_fill_skip|
glue.
@<Adjust \(t)the final line of the paragraph@>=
if active_short(best_bet)=0 then do_last_line_fit:=false
else begin q:=new_spec(glue_ptr(last_line_fill));
delete_glue_ref(glue_ptr(last_line_fill));
width(q):=width(q)+active_short(best_bet)-active_glue(best_bet);
stretch(q):=0; glue_ptr(last_line_fill):=q;
end
@ When reading \.{\\patterns} while \.{\\savinghyphcodes} is positive
the current |lc_code| values are stored together with the hyphenation
patterns for the current language. They will later be used instead of
the |lc_code| values for hyphenation purposes.
The |lc_code| values are stored in the linked trie analogous to patterns
$p_1$ of length~1, with |hyph_root=trie_r[0]| replacing |trie_root| and
|lc_code(p_1)| replacing the |trie_op| code. This allows to compress
and pack them together with the patterns with minimal changes to the
existing code.
@d hyph_root==trie_r[0] {root of the linked trie for |hyph_codes|}
@<Initialize table entries...@>=
hyph_root:=0; hyph_start:=0;
@ @<Store hyphenation codes for current language@>=
begin c:=cur_lang; first_child:=false; p:=0;
repeat q:=p; p:=trie_r[q];
until (p=0)or(c<=so(trie_c[p]));
if (p=0)or(c<so(trie_c[p])) then
@<Insert a new trie node between |q| and |p|, and
make |p| point to it@>;
q:=p; {now node |q| represents |cur_lang|}
@<Store all current |lc_code| values@>;
end
@ We store all nonzero |lc_code| values, overwriting any previously
stored values (and possibly wasting a few trie nodes that were used
previously and are not needed now). We always store at least one
|lc_code| value such that |hyph_index| (defined below) will not be zero.
@<Store all current |lc_code| values@>=
p:=trie_l[q]; first_child:=true;
for c:=0 to 255 do
if (lc_code(c)>0)or((c=255)and first_child) then
begin if p=0 then
@<Insert a new trie node between |q| and |p|, and
make |p| point to it@>
else trie_c[p]:=si(c);
trie_o[p]:=qi(lc_code(c));
q:=p; p:=trie_r[q]; first_child:=false;
end;
if first_child then trie_l[q]:=0@+else trie_r[q]:=0
@ We must avoid to ``take'' location~1, in order to distinguish between
|lc_code| values and patterns.
@<Pack all stored |hyph_codes|@>=
begin if trie_root=0 then for p:=0 to 255 do trie_min[p]:=p+2;
first_fit(hyph_root); trie_pack(hyph_root);
hyph_start:=trie_ref[hyph_root];
end
@ The global variable |hyph_index| will point to the hyphenation codes
for the current language.
@d set_hyph_index== {set |hyph_index| for current language}
if trie_char(hyph_start+cur_lang)<>qi(cur_lang)
then hyph_index:=0 {no hyphenation codes for |cur_lang|}
else hyph_index:=trie_link(hyph_start+cur_lang)
@#
@d set_lc_code(#)== {set |hc[0]| to hyphenation or lc code for |#|}
if hyph_index=0 then hc[0]:=lc_code(#)
else if trie_char(hyph_index+#)<>qi(#) then hc[0]:=0
else hc[0]:=qo(trie_op(hyph_index+#))
@<Glob...@>=
@!hyph_start:trie_pointer; {root of the packed trie for |hyph_codes|}
@!hyph_index:trie_pointer; {pointer to hyphenation codes for |cur_lang|}
@ When |saving_vdiscards| is positive then the glue, kern, and penalty
nodes removed by the page builder or by \.{\\vsplit} from the top of a
vertical list are saved in special lists instead of being discarded.
@d tail_page_disc==disc_ptr[copy_code] {last item removed by page builder}
@d page_disc==disc_ptr[last_box_code] {first item removed by page builder}
@d split_disc==disc_ptr[vsplit_code] {first item removed by \.{\\vsplit}}
@<Glob...@>=
@!disc_ptr:array[copy_code..vsplit_code] of pointer; {list pointers}
@ @<Set init...@>=
page_disc:=null; split_disc:=null;
@ The \.{\\pagediscards} and \.{\\splitdiscards} commands share the
command code |un_vbox| with \.{\\unvbox} and \.{\\unvcopy}, they are
distinguished by their |chr_code| values |last_box_code| and
|vsplit_code|. These |chr_code| values are larger than |box_code| and
|copy_code|.
@<Generate all \eTeX...@>=
primitive("pagediscards",un_vbox,last_box_code);@/
@!@:page_discards_}{\.{\\pagediscards} primitive@>
primitive("splitdiscards",un_vbox,vsplit_code);@/
@!@:split_discards_}{\.{\\splitdiscards} primitive@>
@ @<Cases of |un_vbox| for |print_cmd_chr|@>=
else if chr_code=last_box_code then print_esc("pagediscards")
else if chr_code=vsplit_code then print_esc("splitdiscards")
@ @<Handle saved items and |goto done|@>=
begin link(tail):=disc_ptr[cur_chr]; disc_ptr[cur_chr]:=null;
goto done;
end
@ The \.{\\interlinepenalties}, \.{\\clubpenalties}, \.{\\widowpenalties},
and \.{\\displaywidowpenalties} commands allow to define arrays of
penalty values to be used instead of the corresponding single values.
@d inter_line_penalties_ptr==equiv(inter_line_penalties_loc)
@d club_penalties_ptr==equiv(club_penalties_loc)
@d widow_penalties_ptr==equiv(widow_penalties_loc)
@d display_widow_penalties_ptr==equiv(display_widow_penalties_loc)
@<Generate all \eTeX...@>=
primitive("interlinepenalties",set_shape,inter_line_penalties_loc);@/
@!@:inter_line_penalties_}{\.{\\interlinepenalties} primitive@>
primitive("clubpenalties",set_shape,club_penalties_loc);@/
@!@:club_penalties_}{\.{\\clubpenalties} primitive@>
primitive("widowpenalties",set_shape,widow_penalties_loc);@/
@!@:widow_penalties_}{\.{\\widowpenalties} primitive@>
primitive("displaywidowpenalties",set_shape,display_widow_penalties_loc);@/
@!@:display_widow_penalties_}{\.{\\displaywidowpenalties} primitive@>
@ @<Cases of |set_shape| for |print_cmd_chr|@>=
inter_line_penalties_loc: print_esc("interlinepenalties");
club_penalties_loc: print_esc("clubpenalties");
widow_penalties_loc: print_esc("widowpenalties");
display_widow_penalties_loc: print_esc("displaywidowpenalties");
@ @<Fetch a penalties array element@>=
begin scan_int;
if (equiv(m)=null)or(cur_val<0) then cur_val:=0
else begin if cur_val>penalty(equiv(m)) then cur_val:=penalty(equiv(m));
cur_val:=penalty(equiv(m)+cur_val);
end;
end
@* \[54] System-dependent changes.
This section should be replaced, if necessary, by any special
modifications of the program
that are necessary to make \TeX\ work at a particular installation.
It is usually best to design your change file so that all changes to
previous sections preserve the section numbering; then everybody's version
will be consistent with the published program. More extensive changes,
which introduce new sections, can be inserted here; then only the index
itself will get a new section number.
@^system dependencies@>
@* \[55] Index.
Here is where you can find all uses of each identifier in the program,
with underlined entries pointing to where the identifier was defined.
If the identifier is only one letter long, however, you get to see only
the underlined entries. {\sl All references are to section numbers instead of
page numbers.}
This index also lists error messages and other aspects of the program
that you might want to look up some day. For example, the entry
for ``system dependencies'' lists all sections that should receive
special attention from people who are installing \TeX\ in a new
operating environment. A list of various things that can't happen appears
under ``this can't happen''. Approximately 40 sections are listed under
``inner loop''; these account for about 60\pct! of \TeX's running time,
exclusive of input and output.
|