Commit 83d5fb4cc39daa424fff95a1381aafde5e2f6b51
2006-10-30T16:58:53
add documentation git-svn-id: svn://coreboot.org/openbios/fcode-utils@109 f158a5a8-5612-0410-a976-696ce0be7e32
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
diff --git a/README b/README
index 47d50bd..34b854e 100644
--- a/README
+++ b/README
@@ -8,8 +8,9 @@ It consists of:
- localvalues
NOTE: all parts of the OpenBIOS FCODE suite are GPL v2, except the localvalues
-implementation which is released under the Common Public License (CPL) version
-1.0 (see: http://www.opensource.org/licenses/cpl1.0.php)
+implementation and parts of the documentation which are released under the
+Common Public License (CPL) version 1.0
+(see: http://www.opensource.org/licenses/cpl1.0.php)
For information please contact info@coresystems.de
diff --git a/documentation/detok.html b/documentation/detok.html
new file mode 100644
index 0000000..8fe3e84
--- /dev/null
+++ b/documentation/detok.html
@@ -0,0 +1,343 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<!-- ESWDESDOCFILE %Z%%M% %I% %W% %G% %U% -->
+ <title>ESW PART-FW: OpenBIOS DeTokenizer detok (A User's Guide)</title>
+ <link rel="stylesheet" type="text/css"
+ href="workbook.css">
+</head>
+<body>
+<h1 style="text-align: center;" class="title"><a class="mozTocH1"
+ name="mozTocId94624"></a>OpenBIOS DeTokenizer detok</h1>
+<h1 style="text-align: center;"><a class="mozTocH1"
+ name="mozTocId186871"></a>(A
+User's Guide)</h1>
+<div class="document-control">
+<ul>
+ <li>Updated Wed, 18 Oct 2006 at 12:37 PDT by David L. Paktor</li>
+</ul>
+</div>
+<p class="copyright">Copyright © 2005 International Business
+Machines<sup>®</sup>,
+All Rights Reserved.<br>
+Licensed under the <a
+ href="http://www.opensource.org/licenses/cpl1.0.php">Common Public
+License (CPL) version 1.0</a><br>
+</p>
+<!-- =========================================================================== --><!-- =========================================================================== -->
+<h1><a class="mozTocH2" name="mozTocId48196"></a>Table of Contents</h1>
+<ol id="mozToc">
+<!--mozToc h1 1 h2 2 h3 3 h4 4 h5 5 h6 6--> <li><a
+ href="#mozTocId734288">Overview</a></li>
+ <li><a href="#mozTocId101390">Output Formats</a>
+ <ol>
+ <li><a href="#mozTocId555273">Sample source file:</a></li>
+ <li><a href="#mozTocId805568">DeTokenizer output with no
+options selected:</a></li>
+ <li><a href="#mozTocId621166">DeTokenizer output with the
+"verbose" option selected:</a></li>
+ <li><a href="#mozTocId409633">DeTokenizer output with the
+"offsets" option selected:</a></li>
+ <li><a href="#mozTocId460016">DeTokenizer output with both
+the "verbose" and "offsets" options selected:</a></li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId930428">Command-Line Format</a>
+ <ol>
+ <li><a href="#mozTocId582301">Command-Line Options</a>
+ <ol>
+ <li><a href="#mozTocId403694">Switches</a></li>
+ <li><a href="#mozTocId532000">The "Additional FCodes"
+file</a></li>
+ <ol>
+ <li><a href="#mozTocId814200">Special Functions<br>
+ </a></li>
+ </ol>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId657867">End Of Document</a></li>
+</ol>
+<h2><a class="mozTocH2" name="mozTocId734288"></a>Overview</h2>
+The DeTokenizer is an adjunct tool to the Tokenizer, and performs the
+reverse function, in a fashion. That is, it converts binary FCode
+into a form that can be read for purposes of verification. This
+implementation is not, however, a complete DeTokenizer in the sense of
+one whose output can be turned back through the Tokenizer to generate
+the same binary. Such programs might exist, but this is not one
+of them.<br>
+<h2><a class="mozTocH2" name="mozTocId101390"></a>Output Formats</h2>
+The output of this DeTokenizer basically consists of one token
+(sometimes two) per line, with optional additional information,
+depending on which Command-Line Options have been specified.<br>
+<br>
+<h3 style="margin-left: 40px;"><a class="mozTocH3" name="mozTocId555273"></a>Sample
+source file:<br>
+</h3>
+<div style="margin-left: 40px;">The easiest way to describe the
+different optional output formats would
+be by creating an example of a source file that has been Tokenized and
+displaying the output of the DeTokenizer, applied to its resultant
+FCode binary, with the various options.<br>
+<br>
+Our example source file looks like this:<br>
+<br>
+</div>
+<pre style="font-family: courier new; margin-left: 40px;">\ Demo program for DeTokenizer output format display.<br><br><span
+ style="font-weight: bold;">tokenizer[</span> <br> <span
+ style="font-weight: bold;">h#</span> 17d5 \ Vendor ID: 0x17d5<br> <span
+ style="font-weight: bold;">h#</span> 5417 \ Device ID: 0x5417<br> <span
+ style="font-weight: bold;">h#</span> 020000 \ Class Code: 0x020000 (Ethernet)<br> <span
+ style="font-weight: bold;">h#</span> f2ed \ Rev-Level<br> <span
+ style="font-weight: bold;">]tokenizer</span><br> <span
+ style="font-weight: bold;">SET-REV-LEVEL</span><br> <span
+ style="font-weight: bold;">pci-header</span><br><br><span
+ style="font-weight: bold;">fcode-version2</span><br><br><span
+ style="font-weight: bold;">headers</span><br><span
+ style="font-weight: bold;">hex</span><br><br><span
+ style="font-weight: bold;">:</span> hello/goodbye ( hello? -- )<br> <span
+ style="font-weight: bold;">if</span><br> <span
+ style="font-weight: bold;">."</span> Hello, you big beautiful world!"<br> <span
+ style="font-weight: bold;">else</span><br> <span
+ style="font-weight: bold;">."</span> Goodbye, cruel world. Gggga-a-a-ackkkkk!"<br> <span
+ style="font-weight: bold;">then</span><br><span
+ style="font-weight: bold;">;</span><br><br><span
+ style="font-weight: bold;">:</span> I-say-hello <span
+ style="font-weight: bold;">true</span> hello/goodbye <span
+ style="font-weight: bold;">;</span><br><span style="font-weight: bold;">:</span> You-say-goodbye <span
+ style="font-weight: bold;">false</span> hello/goodbye <span
+ style="font-weight: bold;">;</span><br><br><br><span
+ style="font-weight: bold;">fcode-end</span></pre>
+<h3 style="margin-left: 40px;"><a class="mozTocH3" name="mozTocId805568">
+</a>DeTokenizer output with no options selected:</h3>
+<div style="margin-left: 40px;"><br>
+With no options selected, the DeTokenizer output looks like this:<br>
+<br>
+</div>
+<pre
+ style="font-family: courier new; margin-left: 40px; color: rgb(204, 0, 0);">\ PCI Header identified<br>\ Offset to Data Structure = 0x001c (28)<br>\ PCI Data Structure identified<br>\ Data Structure Length = 0x0018 (24)<br>\ Vendor ID: 0x17d5<br>\ Device ID: 0x5417<br>\ Class Code: 0x020000 (Ethernet controller)<br>\ Image Revision: 0xf2ed<br>\ Code Type: 0x01 (Open Firmware)<br>\ Image Length: 0x0001 blocks (512 bytes)<br>\ Last PCI Image.<br>start1 ( 16-bit offsets)<br> format: 0x08<br> checksum: 0x33d5 (Ok)<br> len: 0x009e ( 158 bytes)<br>named-token hello/goodbye 0x800<br>b(:) <br> b?branch 0x0028 ( =dec 40)<br> b(") ( len=0x1f [31 bytes] )<br> " Hello, you big beautiful world!"<br> type <br> bbranch 0x0030 ( =dec 48)<br> b(>resolve) <br> b(") ( len=0x29 [41 bytes] )<br> " Goodbye, cruel world. Gggga-a-a-ackkkkk!"<br> type <br> b(>resolve) <br>b(;) <br>named-token I-say-hello 0x801<br>b(:) <br> -1 <br> hello/goodbye <br>b(;) <br>named-token You-say-goodbye 0x802<br>b(:) <br> 0 <br> hello/goodbye <br>b(;) <br>end0 <br>\ Detokenization finished normally after 158 bytes.<br>\ PCI Image padded with 302 bytes of zero</pre>
+<h3 style="margin-left: 40px;"><a class="mozTocH3" name="mozTocId621166"></a><a
+ name="with_verbose"></a>DeTokenizer output
+with the "verbose" option selected:</h3>
+<div style="margin-left: 40px;">The "verbose" option adds a display of
+the hex value of each token
+processed, (as well as a signature block), thus:<br>
+<br>
+</div>
+<pre
+ style="font-family: courier new; margin-left: 40px; color: rgb(204, 0, 0);">\ Welcome to the OpenBIOS detokenizer v0.6.1<br>\ detok Copyright(c) 2001-2005 by Stefan Reinauer.<br>\ Written by Stefan Reinauer, <stepan@openbios.org><br>\ This program is free software; you may redistribute it under the terms of<br>\ the GNU General Public License. This program has absolutely no warranty.<br>\ <br>\ (C) Copyright 2005 IBM Corporation. All Rights Reserved.<br>\ PCI Header identified<br>\ Offset to Data Structure = 0x001c (28)<br>\ PCI Data Structure identified<br>\ Data Structure Length = 0x0018 (24)<br>\ Vendor ID: 0x17d5<br>\ Device ID: 0x5417<br>\ Class Code: 0x020000 (Ethernet controller)<br>\ Image Revision: 0xf2ed<br>\ Code Type: 0x01 (Open Firmware)<br>\ Image Length: 0x0001 blocks (512 bytes)<br>\ Last PCI Image.<br>start1 ( 0x0f1 ) ( 16-bit offsets)<br> format: 0x08<br> checksum: 0x33d5 (Ok)<br> len: 0x009e ( 158 bytes)<br>named-token ( 0x0b6 ) hello/goodbye 0x800<br>b(:) ( 0x0b7 ) <br> b?branch ( 0x014 ) 0x0028 ( =dec 40)<br> b(") ( 0x012 ) ( len=0x1f [31 bytes] )<br> " Hello, you big beautiful world!"<br> type ( 0x090 ) <br> bbranch ( 0x013 ) 0x0030 ( =dec 48)<br> b(>resolve) ( 0x0b2 ) <br> b(") ( 0x012 ) ( len=0x29 [41 bytes] )<br> " Goodbye, cruel world. Gggga-a-a-ackkkkk!"<br> type ( 0x090 ) <br> b(>resolve) ( 0x0b2 ) <br>b(;) ( 0x0c2 ) <br>named-token ( 0x0b6 ) I-say-hello 0x801<br>b(:) ( 0x0b7 ) <br> -1 ( 0x0a4 ) <br> hello/goodbye ( 0x800 ) <br>b(;) ( 0x0c2 ) <br>named-token ( 0x0b6 ) You-say-goodbye 0x802<br>b(:) ( 0x0b7 ) <br> 0 ( 0x0a5 ) <br> hello/goodbye ( 0x800 ) <br>b(;) ( 0x0c2 ) <br>end0 ( 0x000 ) <br>\ Detokenization finished normally after 158 bytes.<br>\ PCI Image padded with 302 bytes of zero</pre>
+<h3 style="margin-left: 40px;"><a class="mozTocH3" name="mozTocId409633"></a><a
+ name="with_offsets"></a>DeTokenizer output
+with the "offsets" option selected:</h3>
+<div style="margin-left: 40px;">The "offsets" option shows the position
+of the tokens relative to the
+start of the first FCode block after a PCI header (if one is present)
+and the destination-offset of each
+branch. If more than one FCode header follows a single PCI header, the
+offset-counter will continue; if a new PCI header is encountered, the
+offset-counter will be reset and will begin counting again from zero
+after the end of the latest PCI header.
+<p>Without the "verbose" option, i.e., with just the
+"offsets" option by itself, the DeTokenizer output looks like this:</p>
+</div>
+<pre
+ style="font-family: courier new; margin-left: 40px; color: rgb(204, 0, 0);">\ PCI Header identified<br>\ Offset to Data Structure = 0x001c (28)<br>\ PCI Data Structure identified<br>\ Data Structure Length = 0x0018 (24)<br>\ Vendor ID: 0x17d5<br>\ Device ID: 0x5417<br>\ Class Code: 0x020000 (Ethernet controller)<br>\ Image Revision: 0xf2ed<br>\ Code Type: 0x01 (Open Firmware)<br>\ Image Length: 0x0001 blocks (512 bytes)<br>\ Last PCI Image.<br> 0: start1 ( 16-bit offsets)<br> 1: format: 0x08<br> 2: checksum: 0x33d5 (Ok)<br> 4: len: 0x009e ( 158 bytes)<br> 8: named-token hello/goodbye 0x800<br> 25: b(:) <br> 26: b?branch 0x0028 ( =dec 40 dest = 67 )<br> 29: b(") ( len=0x1f [31 bytes] )<br> " Hello, you big beautiful world!"<br> 62: type <br> 63: bbranch 0x0030 ( =dec 48 dest = 112 )<br> 66: b(>resolve) <br> 67: b(") ( len=0x29 [41 bytes] )<br> " Goodbye, cruel world. Gggga-a-a-ackkkkk!"<br> 110: type <br> 111: b(>resolve) <br> 112: b(;) <br> 113: named-token I-say-hello 0x801<br> 128: b(:) <br> 129: -1 <br> 130: hello/goodbye <br> 132: b(;) <br> 133: named-token You-say-goodbye 0x802<br> 152: b(:) <br> 153: 0 <br> 154: hello/goodbye <br> 156: b(;) <br> 157: end0 <br>\ Detokenization finished normally after 158 bytes.<br>\ PCI Image padded with 302 bytes of zero</pre>
+<h3 style="margin-left: 40px;"><a class="mozTocH3" name="mozTocId460016"></a><a
+ name="with_verbose_and_offsets"></a>DeTokenizer output
+with both the "verbose" and "offsets" options selected:</h3>
+<div style="margin-left: 40px;">Combining the "verbose" and "offsets"
+options results in something that
+looks like this:<br>
+<br>
+</div>
+<pre
+ style="font-family: courier new; margin-left: 40px; color: rgb(204, 0, 0);">\ Welcome to the OpenBIOS detokenizer v0.6.1<br>\ detok Copyright(c) 2001-2005 by Stefan Reinauer.<br>\ Written by Stefan Reinauer, <stepan@openbios.org><br>\ This program is free software; you may redistribute it under the terms of<br>\ the GNU General Public License. This program has absolutely no warranty.<br>\ <br>\ (C) Copyright 2005 IBM Corporation. All Rights Reserved.<br>\ PCI Header identified<br>\ Offset to Data Structure = 0x001c (28)<br>\ PCI Data Structure identified<br>\ Data Structure Length = 0x0018 (24)<br>\ Vendor ID: 0x17d5<br>\ Device ID: 0x5417<br>\ Class Code: 0x020000 (Ethernet controller)<br>\ Image Revision: 0xf2ed<br>\ Code Type: 0x01 (Open Firmware)<br>\ Image Length: 0x0001 blocks (512 bytes)<br>\ Last PCI Image.<br> 0: start1 ( 0x0f1 ) ( 16-bit offsets)<br> 1: format: 0x08<br> 2: checksum: 0x33d5 (Ok)<br> 4: len: 0x009e ( 158 bytes)<br> 8: named-token ( 0x0b6 ) hello/goodbye 0x800<br> 25: b(:) ( 0x0b7 ) <br> 26: b?branch ( 0x014 ) 0x0028 ( =dec 40 dest = 67 )<br> 29: b(") ( 0x012 ) ( len=0x1f [31 bytes] )<br> " Hello, you big beautiful world!"<br> 62: type ( 0x090 ) <br> 63: bbranch ( 0x013 ) 0x0030 ( =dec 48 dest = 112 )<br> 66: b(>resolve) ( 0x0b2 ) <br> 67: b(") ( 0x012 ) ( len=0x29 [41 bytes] )<br> " Goodbye, cruel world. Gggga-a-a-ackkkkk!"<br> 110: type ( 0x090 ) <br> 111: b(>resolve) ( 0x0b2 ) <br> 112: b(;) ( 0x0c2 ) <br> 113: named-token ( 0x0b6 ) I-say-hello 0x801<br> 128: b(:) ( 0x0b7 ) <br> 129: -1 ( 0x0a4 ) <br> 130: hello/goodbye ( 0x800 ) <br> 132: b(;) ( 0x0c2 ) <br> 133: named-token ( 0x0b6 ) You-say-goodbye 0x802<br> 152: b(:) ( 0x0b7 ) <br> 153: 0 ( 0x0a5 ) <br> 154: hello/goodbye ( 0x800 ) <br> 156: b(;) ( 0x0c2 ) <br> 157: end0 ( 0x000 ) <br>\ Detokenization finished normally after 158 bytes.<br>\ PCI Image padded with 302 bytes of zero</pre>
+<div style="margin-left: 80px;">There's another option called "line
+numbers" but it only numbers the
+lines of output. It's easy enough to describe, and so needs no
+illustration.<br>
+</div>
+<br>
+<!-- =========================================================================== -->
+<!-- =========================================================================== -->
+<h2><a class="mozTocH2" name="mozTocId930428"></a>Command-Line Format</h2>
+<div style="margin-left: 40px;">The command-line format is simply:<br>
+<br>
+</div>
+<div
+ style="font-family: courier new,courier,monospace; margin-left: 80px;">detok
+[options] fc-file [fc-file ...]<br>
+</div>
+<br>
+<div style="margin-left: 40px;">The output of this DeTokenizer is
+directed to STDOUT, so there is no
+"Output file" option per se. Simply redirect the output to the
+file in which you wish to keep the results, using the standard Shell
+conventions.<br>
+</div>
+<h3 style="margin-left: 40px;"><a class="mozTocH3" name="mozTocId582301"></a>Command-Line
+Options</h3>
+<div style="margin-left: 40px;">Command-Line option Switches are
+case-sensitive;
+only one option has an applicable argument, and that one is a file
+name. Its case sensitivity is, of course, dependent on the Host
+Operating System.<br>
+</div>
+<h4 style="margin-left: 40px;"><a class="mozTocH4" name="mozTocId403694"></a>Switches</h4>
+<ul style="margin-left: 40px;">
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-h</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-?</span></li>
+</ul>
+<div style="margin-left: 80px;">Print a brief help message and then
+exit.
+</div>
+<ul style="margin-left: 40px;">
+ <li><span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">-v</span></li>
+</ul>
+<div style="margin-left: 80px;">Verbose -- display
+<a href="#with_verbose">additional information</a>: the hex value
+of each token processed, as
+well as a signature block.<br>
+</div>
+<ul
+ style="font-weight: bold; font-family: courier new; margin-left: 40px;">
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-o</span></li>
+</ul>
+<div style="margin-left: 80px;">Offsets -- display the
+<a href="#with_offsets">positions of the tokens</a> relative to the
+start of the first FCode block after a PCI header (if one is present),
+and
+the destination-offset of each branch.<br>
+<p>Note that the <a href="#with_verbose_and_offsets">combination</a>
+of
+the Verbose and Offsets options yields the maximum amount of useful
+information. </p>
+</div>
+<ul style="margin-left: 40px;">
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-n</span></li>
+</ul>
+<div style="margin-left: 80px;">Line Numbers -- display the
+sequential number of each line of output.<br>
+<p>Note that the <span
+ style="font-family: courier new; font-weight: bold;">-n</span> and <span
+ style="font-family: courier new; font-weight: bold;">-o</span> options
+are mutually exclusive; if both are specified, <span
+ style="font-family: courier new; font-weight: bold;">-o</span> will be
+favoured.</p>
+</div>
+<ul style="margin-left: 40px;">
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-a</span></li>
+</ul>
+<div style="margin-left: 80px;">Process All input. Do not stop
+when <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">end0</span>
+has been encountered. This option is usually not needed, but may
+be useful in cases where a file has been corrupted or when
+something very strange has been Tokenized...<br>
+</div>
+<ul style="margin-left: 40px;">
+ <li><span style="font-family: courier new; font-weight: bold;">-f
+<FCode-List-File></span></li>
+</ul>
+<div style="margin-left: 80px;">Pre-load Additional FCodes before
+processing. These might be, for instance, a set of
+vendor-specific FCodes that were generated for a specific vendor's
+products by a Tokenizer customized for that specific vendor. A
+detailed discussion of <a href="#Additional_FCodes_file">the
+"Additional FCodes" file</a> will be presented in a separate dedicated
+section. </div>
+<!-- =========================================================================== --><!-- =========================================================================== -->
+<h4 style="margin-left: 40px;"><a class="mozTocH4" name="mozTocId532000"></a><a
+ name="Additional_FCodes_file"></a>The
+"Additional FCodes" file</h4>
+<div style="margin-left: 80px;">Some vendors' FCode drivers contain
+non-standard FCode tokens. In order to accommodate those
+situations, provision is made to specify the names of the FCodes in
+question. The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-f</span>
+command-line option permits the user to specify an "Additional FCodes
+List" file, which will be read before detokenization begins and which
+will contain the list of "Additional FCodes" to be recognized.<br>
+<p>The format of the file is as follows:<br>
+</p>
+<ol>
+ <li>One entry, consisting of an FCode and its name, on a line.
+The FCode Number is given first, in the form of a hex number, preceded
+by an optional <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">0x</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">0X</span>
+(Thus: <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">0x602</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">0X602</span>
+or simply <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">602</span>
+are all equivalent.) At least one blank space separates the FCode
+Number from the Name, which must be on the same line. Any number
+of blanks are permitted, and any text that follows the Name is
+permitted and will be ignored.</li>
+ <li>Blank lines are permitted and will be ignored.</li>
+ <li>Comment lines are permitted and will be ignored.
+A comment-line starts with either a pound-sign ( <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#</span>
+) or a backslash ( <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">\</span>
+).</li>
+ <li>FCode Numbers are limited to the range <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">0x10..0x7ff</span>
+Numbers smaller than <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">0x10</span>
+are the leading-byte of a two-byte FCode, and numbers from <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">0x800</span>
+and up are assigned by the tokenizer. Lines with numbers outside
+the permitted range will be ignored, and a message will be printed.</li>
+ <li>FCode numbers that are already assigned will not be permitted to
+be overwritten. Lines with numbers that are already assigned
+will be ignored, and a message will be printed. </li>
+</ol>
+<p>If the file cannot be read, that will be regarded as an immediate
+failure and cause the program to exit. <br>
+</p>
+<h5><big><a name="mozTocId814200"></a><a name="Special_Functions"></a>Special
+Functions</big></h5>
+In addition to non-standard FCode tokens with simple behavior, some
+vendors' FCode drivers also contain non-standard FCode tokens with
+complex behavior. An example that was recently encountered is "<span
+ style="font-weight: bold;">double(lit)</span>" which precedes a
+double-length (i.e., 64-bit) literal. This DeTokenizer is
+structured to allow the creation of a list of pre-defined Special
+Function names, each of which has a special behavior associated with
+it. When one of those names occurs in the "Additional FCodes
+List" file, it will be recognized; the FCode Number given with it is
+assigned to it. When that FCode number is encountered, the
+assigned special behavior will be exercised.<br>
+<p>Adding to the list of Special Function names, and associating a
+new behavior with the added function, requires modifying the
+DeTokenizer code, but the infrastructure that is already in place
+should make this a manageable task for even a modestly skilled
+programmer.<br>
+</p>
+<p>At the present writing, only one such Special Function name is
+supported, and that one is, of course, <span
+ style="font-weight: bold;">double(lit)</span></p>
+<p>Its associated special behavior is to collect the next eight bytes
+from the FCode input stream and display them as a double-length literal.<br>
+</p>
+<p>If you modify the DeTokenizer to recognize additional Special
+Function names, please update this document to list them and describe
+their special behaviors. Thank you. </p>
+<br>
+</div>
+<!-- ...................................................................................... --><!-- =========================================================================== -->
+<h2><a class="mozTocH2" name="mozTocId657867"></a>End Of Document</h2>
+<!-- =========================================================================== -->
+</body>
+</html>
diff --git a/documentation/localvalues.html b/documentation/localvalues.html
new file mode 100644
index 0000000..987e7b2
--- /dev/null
+++ b/documentation/localvalues.html
@@ -0,0 +1,859 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<!-- ESWDESDOCFILE %Z%%M% %I% %W% %G% %U% -->
+ <title>ESW PART-FW: Support for "Local Values" in the OpenBIOS
+Tokenizer</title>
+ <link rel="stylesheet" type="text/css"
+ href="workbook.css">
+</head>
+<body>
+<h1 class="title"><a class="mozTocH1" name="mozTocId810036"></a>Support
+for "Local Values" in the OpenBIOS Tokenizer</h1>
+<div class="document-control">
+<ul>
+ <li>Updated Wed, 26 Jul 2006 at 10:04 PDT by David L. Paktor<br>
+ </li>
+</ul>
+</div>
+<p class="copyright"> Copyright © 2005 International Business
+Machines<sup>®</sup>, All Rights Reserved.<br>
+Licensed under the <a
+ href="http://www.opensource.org/licenses/cpl1.0.php">Common Public
+License (CPL) version 1.0</a><br>
+</p>
+<!-- =========================================================================== --><!-- =========================================================================== -->
+<h2><a class="mozTocH2" name="mozTocId207724"></a>Table Of Contents</h2>
+<ol id="mozToc">
+<!--mozToc h1 1 h2 2 h3 3 h4 4 h5 5 h6 6--><li><a href="#mozTocId810036">Support
+for "Local Values" in the OpenBIOS Tokenizer</a>
+ <ol>
+ <li><a href="#mozTocId944022">Overview</a></li>
+ <li><a href="#mozTocId303607">Scope of this Document</a></li>
+ <li><a href="#mozTocId272611">Design Objectives</a></li>
+ <li><a href="#mozTocId383861">Functional
+Requirements</a></li>
+ <li><a href="#mozTocId969736">Interface
+Specification</a>
+ <ol>
+ <li><a href="#mozTocId699042">Syntax:</a>
+ <ol>
+ <li><a href="#mozTocId94063">Declaration:
+(Curly-braces: { and
+ } )</a></li>
+ <li><a href="#mozTocId444210">Separation
+Character between Initialized and
+Uninitialized Local Values</a></li>
+ <li><a href="#mozTocId715222">Value Extraction:
+Invocation</a></li>
+ <li><a href="#mozTocId677769">Value Assignment: The
+ ->
+Operator.</a></li>
+ <li><a href="#mozTocId189696">Scope of Local Values:</a></li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId107943">Semantics:</a>
+ <ol>
+ <li><a href="#mozTocId459457">Order of
+Initialization:</a></li>
+ <li><a href="#mozTocId908599">Note two significant
+departures from the "Local Variables"
+discussed in the ANSI FORTH Standard document: </a></li>
+ <li><a href="#mozTocId213536">Value Extraction</a></li>
+ <li><a href="#mozTocId563286">Value Assignment</a></li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId505598">Implementation</a>
+ <ol>
+ <li><a href="#mozTocId134995">Compilation -- the
+Parser:</a>
+ <ol>
+ <li><a href="#mozTocId467215">Run-Time Support
+Function names:</a>
+ <ol>
+ <li><a href="#mozTocId497158">Example:</a></li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId361894">Run-Time Support --
+the Local Values Support "Library":</a>
+ <ol>
+ <li><a href="#mozTocId191315">Operational Run-Time
+Support
+Functions:</a></li>
+ <li><a href="#mozTocId750894">Important note regarding
+floading of the Local Values Support Functions file</a></li>
+ <li><a href="#mozTocId684194">Adjusting the size of
+Local Values Storage:</a></li>
+ <li><a href="#mozTocId208497">Additional Support
+Function(s):</a>
+ <ol>
+ <li><a href="#mozTocId781114">CATCH / THROW</a></li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+</ol>
+<h2><a class="mozTocH2" name="mozTocId944022"></a>Overview</h2>
+<!-- =========================================================================== -->
+The goal of this project is to implement support for "Local Values"
+in the OpenBIOS Tokenizer.
+<p>"Local Values" are an IBM-specific extension of FORTH syntax,
+currently used both by the FCode Tokenizer and Platform Firmware.
+They might be considered a variant that meets the spirit, if not the
+letter, of the suggestions for a "Locals word set" discussed
+-- but not specified -- in the ANSI FORTH Standard, Section 13 and
+Appendix A.13</p>
+<p>
+(Please note that the ANSI document does not really specify this
+feature,
+because the Committee could not reach an agreement. Appendix A.13
+records the somewhat lively discussions that accompanied this topic.)</p>
+<p>We will refer to this feature with the nomenclature "<span
+ style="font-weight: bold;">Local Values</span>" in preference to
+"Local
+Variables" or "Locals" in order to (a) more accurately
+characterize the behavior of these objects, and (b) further emphasize
+the differences between the IBM-specific extension and those discussed
+in the ANSI document.
+</p>
+<h2><a class="mozTocH2" name="mozTocId303607"></a>Scope of this Document</h2>
+<!-- ...................................................................................... -->
+The sections labeled <a style="font-weight: bold;" href="#Syntax">Syntax</a>
+and <a style="font-weight: bold;" href="#Semantics">Semantics</a>
+describe the user's view of this feature.<br>
+<p>The section
+labeled <a style="font-weight: bold;" href="#Implementation">Implementation</a>
+is a description of the
+underlying parsing and support mechanisms that meet the <a
+ style="font-weight: bold;" href="#Design_Objectives">Design Objectives</a>.
+</p>
+<!-- ...................................................................................... --><!-- =========================================================================== -->
+<h2><a class="mozTocH2" name="mozTocId272611"></a><a
+ name="Design_Objectives"></a>Design Objectives</h2>
+<!-- =========================================================================== -->The
+"Local Values" extension is intended to relieve programmers maintaining
+FCode device drivers from the complexity involved in keeping track of
+the
+positions of the various items on the stack. The programmer can,
+instead,
+refer to these items by symbolic names, in a manner similar to "<big><b>C</b></big>"
+syntax.
+<!-- =========================================================================== -->
+<h2><a class="mozTocH2" name="mozTocId383861"></a>Functional
+Requirements</h2>
+<!-- =========================================================================== -->
+Tokenizing source-code that makes use of the "Local Values" syntax
+shall still result in Industry Standard FCode that can be interpreted
+by the
+FCode interpreter of any Open Firmware-compliant Host Platform, without
+imposing any IBM-specific requirements.<br>
+<p>Also, the implementation shall support a means whereby to remain
+compatible with IBM's existing code-base.</p>
+<!-- =========================================================================== -->
+<h2><a class="mozTocH2" name="mozTocId969736"></a>Interface
+Specification</h2>
+<!-- =========================================================================== -->
+<h3><a class="mozTocH3" name="mozTocId699042"></a><a name="Syntax"></a>Syntax:</h3>
+<h4><a class="mozTocH4" name="mozTocId94063"></a>Declaration:
+(Curly-braces: <b><big>{</big></b> and
+ <big><b>}</b></big> )</h4>
+<p>
+Local Values may only be declared in connection with a colon-definition
+(A "word" in FORTH parlance.) </p>
+<p> Declaration of Local Values is triggered by an open-curly-brace
+(i.e.,: <b>{</b> ) , and ends with a close-curly-brace (
+ <b>}</b>
+).</p>
+<p>A further distinction is made between Initialized Local Values and
+Uninitialized Local Values: Initialized Local Values are declared
+first, and
+are separated by a <a href="#Separation_Character_between_Initialized">special
+character</a> from Uninitialized Local Values.<br>
+</p>
+<p>Declaration of Local Values may only occur once within the body of
+the colon-definition.<br>
+</p>
+<p>Declaration of Local Values after code has been compiled into the
+body of the word is not recommended, but is permitted. A Local
+Values
+Declaration that occurs inside a Flow-Control Structure will be
+reported as an <a href="TokenizerNewFeatures.htm#An_ERROR">Error</a>.<br>
+</p>
+<p>A Local Values Declaration may include comments and may continue
+across
+multiple lines. See the <a href="#mozTocId497158">example</a> in
+the <a href="#Implementation">Implementation</a> section.</p>
+<h4><a class="mozTocH4" name="mozTocId444210"></a><a
+ name="Separation_Character_between_Initialized"></a>Separation
+Character between Initialized and
+Uninitialized Local Values</h4>
+<p>Two symbols are accepted as the separator between
+Initialized and Uninitialized Local Values, the <b>Semicolon</b>
+( <span style="font-family: courier new,courier,monospace;"
+ font-weight="" bold="">;</span> ) and the <span
+ style="font-weight: bold;">Vertical-Bar</span> ( <span
+ style="font-weight: bold;">|</span> ).
+</p>
+<p>Since, in FORTH, Semicolon is heavily fraught with a very important
+meaning,
+it is preferable to use a different symbol -- one that isn't used
+for anything else -- as the separator between Initialized and
+Uninitialized Local Values. Better still would be a symbol that's given
+at least passing mention in the discussion about the (failed) attempt
+to establish an ANSI standard for Locals (see the ANSI Forth Spec.,
+section 13.6.2.1795).</p>
+<p>
+The <span style="font-weight: bold;">Vertical-Bar</span>
+symbol
+( <span style="font-weight: bold;">|</span> )
+fills that bill nicely.</p>
+<p><a name="Legacy_Separator"></a>Local Values Declarations
+will accept Semicolon as an alternative ("Legacy") separator between
+Initialized
+and Uninitialized Local Values, and issue a Warning message to the
+effect
+that the
+use of Semicolons in that context is deprecated in favor of the
+Vertical-Bar.</p>
+<p>The User may suppress this
+message by means of a <a
+ href="TokenizerNewFeatures.htm#Command-Line_options_">Command-line
+switch</a>, known as the
+<a href="TokenizerNewFeatures.htm#Special_Feature_Flags">Special-Feature
+Flag</a> named <a href="TokenizerNewFeatures.htm#SF_Flag_LV_Leg_Mssg"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">NoLV-Legacy-Message</span></a>
+, which is described in the <a href="TokenizerNewFeatures.htm">Tokenizer
+User's Guide</a>.</p>
+<p><a name="Disallow_Legacy"></a>Conversely, the User who wishes to
+disallow the use of Semicolon as
+an alternative separator may do so by means of the
+Special-Feature Flag named <a
+ href="TokenizerNewFeatures.htm#SF_Flag_LV_Leg_Sep"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">NoLV-Legacy-Separator</span></a>
+. When the Legacy Local Values
+Separator is thus disallowed, occurrences will be treated as an
+Error.</p>
+<h4><a class="mozTocH4" name="mozTocId715222"></a>Value Extraction:
+Invocation</h4>
+A name declared as a Local Value may be invoked within the body of a
+word in connection with which it was declared, simply by name, in a
+manner similar to a name defined by the Standard FORTH defining-word, <i><b>VALUE</b></i>
+, to mean that its associated value is to be extracted and placed onto
+the Stack.
+<h4><a class="mozTocH4" name="mozTocId677769"></a>Value Assignment: The
+ <b><big>-></big></b>
+Operator.</h4>
+The symbol <b>-></b> (dash angle-bracket, pronounced
+"dash-arrow"), may precede the name of a Local Value, and it may not
+precede anything else.
+<p>No comments are permitted between the <b>-></b>
+and the Local-Value name to which it applies.</p>
+<p>The <b>-></b> and
+the Local-Value name to which it applies must be on the same line. </p>
+<p>The <b>-></b> operator relates to the Local-Value
+name to which it is applied in a manner similar to the way the <i><b>TO</b></i>
+operator relates, when it is applied, to a name defined by <i><b>VALUE</b></i>
+; it causes the numeric value on
+top of the Parameter Stack to be popped and stored into -- associated
+with -- the named Local Value.</p>
+<h4><a class="mozTocH4" name="mozTocId189696"></a>Scope of Local Values:</h4>
+Upon completion of the definition of the word in connection with which
+a set of Local Values was declared, i.e., at the semicolon, the names
+of the Local Values cease to be recognized. If the same names are
+declared in connection with a subsequent definition, they are only
+applicable to that subsequent definition, as if they were newly
+created. No warning is issued, nor do rules concerning "overloading"
+apply.<!-- ...................................................................................... -->
+<h3><a class="mozTocH3" name="mozTocId107943"></a><a name="Semantics"></a>Semantics:</h3>
+<h4><a class="mozTocH4" name="mozTocId459457"></a>Order of
+Initialization:</h4>
+Uninitialized Local Values do not have a value until one is assigned
+within the definition, by the use of the <b>-></b>
+("dash-arrow") operator.
+<p>Initialized Local Values are initialized from the stack at the start
+of execution of the defined word, in the same order as the convention
+for a stack-diagram, i.e., the first-named Local Value is
+initialized from the stack-item whose depth corresponds to the total
+number of initialized Local Values, the last-named Local Value is
+initialized from the top-of-stack item, and so on in between. </p>
+<p>
+The following will serve to illustrate:
+</p>
+<code><font color="#000000">
+<p>: <word-name> ( P_x ... P_y P_0 P_1 ... P_n-2 P_n-1 --
+??? )<br>
+
+
+ { IL_0 IL_1
+... IL_n-2 IL_n-1 | UL_0 UL_1 } </p>
+<p> \
+ At the start of the word,
+IL_0 through IL_n-1 are initialized<br>
+ \
+with P_0 thorough P_n-1, respectively, and the stack contains<br>
+
+
+
+
+
+ ( P_x ... P_y )
+</p>
+</font></code>
+<h4><a class="mozTocH4" name="mozTocId908599"></a>Note two significant
+departures from the "Locals"
+discussed in the ANSI FORTH Standard document:
+</h4>
+<p>(1) The ANSI FORTH Committee discussions make no provision for
+Uninitialized Locals, <br>
+</p>
+<p>and
+</p>
+<p> (2) The order of initialization is reversed. In the ANSI document,
+Locals are initialized
+in the order they are declared, so that the first-declared will take
+the topmost value on the stack, and the last-declared will take the
+deepest value.
+</p>
+<p> The general consensus within IBM is that this scheme is confusing
+at best, and does not serve the intent of the <a
+ href="#Design_Objectives">Design Objectives</a>.
+</p>
+<h4><a class="mozTocH4" name="mozTocId213536"></a>Value Extraction</h4>
+When the name of a Local Value is invoked, its associated value is
+extracted
+and pushed onto the Parameter Stack.
+<h4><a class="mozTocH4" name="mozTocId563286"></a>Value Assignment</h4>
+If the <b>-></b> ("dash-arrow") symbol precedes the
+name of a Local Value, then the numeric value on
+top of the Parameter Stack is popped and stored into -- associated with
+-- the named Local-Value.<br>
+<p>Following the -> ("dash-arrow") symbol
+with anything other than the name of a Local Value is an Error.</p>
+<!-- =========================================================================== -->
+<h2><a class="mozTocH2" name="mozTocId505598"></a><a
+ name="Implementation"></a>Implementation</h2>
+<!-- =========================================================================== -->
+<!-- ...................................................................................... -->
+<h3><a class="mozTocH3" name="mozTocId134995"></a>Compilation -- the
+Parser:</h3>
+<!-- ...................................................................................... -->
+A separate area (a "vocabulary", in Forth parlance) must be reserved
+where temporary compile-time
+definitions of the new Local Value names can be created, and whence the
+new Local Value names can be removed after the definition of the word
+in connection with which they were declared is completed. Variables
+must also be set aside to keep count of the Initialized and
+Uninitialized Local Value names declared inside the curly-braces.
+<p> Each new Local Value name has an integer assigned to it. The Parser
+assigns successive integers, starting with 0, to the Local Value names,
+in the order that they are declared, and enters the name of each new
+Local Value, together with its assigned integer, into the separate
+reserved temporary area.
+</p>
+<p> After all the Local Value names have been declared, i.e., after the
+close-curly-brace has been read, the Parser compiles-in the number of
+Initialized Local Values, followed by the number of Uninitialized Local
+Values, where they will act as arguments to the <a href="#push-locals">appropriate
+function</a>,
+which the Parser compiles-in immediately after. The function will be
+the special one that allocates space for, and initializes, the Local
+Values at the time they are about to be used.
+</p>
+<p> While the definition under construction is being compiled, the area
+where the temporary compile-time definitions of the new Local Value
+names have been created must be available to the scanning process, so
+that the new names will be recognized when invoked. Also, it should be
+scanned first, ahead of any other word-lists, so that the Local Value
+names will supercede any similarly-named words, in case of a
+naming-overlap.
+</p>
+<p> When a Local Value's name is invoked, the Parser compiles-in its
+assigned integer as an argument to the <a href="#_local">appropriate
+function</a>, which is
+compiled-in immediately after. The function will be a common one that
+will push onto the stack the address at which the numbered Local Value
+can be accessed. The Parser will then compile-in either the "fetch"
+function ( <b>@</b> ) or the "store" function ( <b>!</b>
+ ), depending on whether the Local Value name was invoked by
+itself or in conjunction with the <b>-></b> operator.
+This way the User/Programmer's view of Local Values' <i><b>VALUE</b></i>-style
+behavior is preserved. </p>
+<p>The FORTH functions <b>exit</b> and <b>;</b> (semicolon) have to
+be overloaded. (Section 13.3.3 of the ANSI document also mentions
+ <b>;CODE</b> and <b>DOES></b> but
+these are not recognized by the Tokenizer, so we will not discuss them
+here.) The overloaded definitions must take special action at
+compile-time
+(note that <b>;</b> -- semicolon -- does that normally,
+anyway, but <b>exit</b> does not) to: compile-in the total number of
+Local Values as an argument to the <a href="#pop-locals">appropriate
+function</a>, which is
+compiled-in immediately afterwards, before completing their normal
+behavior. The function in this case will be the special one that
+releases the space that had been allocated for the Local Values, and
+restores the state of Local Values storage to the way the calling
+routine left it. Semicolon must also clear the area where the temporary
+compile-time definitions of the new local-names were created,
+rendering them inaccessible. </p>
+<h4><a class="mozTocH4" name="mozTocId467215"></a>Run-Time Support
+Function names:</h4>
+The names of the three functions that the Parser compiles-in must be
+well-known and documented, so that they can be implemented and exported
+correctly in the
+Run-Time Support "Library" file.
+<p>The three functions' names are: </p>
+<p> <b>{push-locals} ( #ilocals
+#ulocals -- )</b></p>
+<p> <b>{pop-locals}
+( total#locals
+-- ) </b></p>
+<p> <b>_{local}
+( local-var# --
+addr )<br>
+</b></p>
+<h4><a class="mozTocH4" name="mozTocId497158"></a>Example:</h4>
+The following is an example of a word definition that declares and
+makes
+use of Local Values; it also shows inclusion of comments and
+continuation
+of the Declaration
+across multiple lines:<br>
+<br>
+<tt>
+
+<font color="#663333" face="Courier New, Courier, monospace"></font></tt>
+<table style="text-align: left; width: 821px; height: 356px;" border="0" cellpadding="0" cellspacing="0">
+
+
+ <tbody>
+
+
+ <tr>
+
+
+ <td style="text-align: left; vertical-align: top; width: 33%; white-space: nowrap;"><font style="font-family: monospace;" color="#663333" size="-1"><span style="color: rgb(102, 0, 204);">:</span></font><font style="font-family: monospace;" color="#663333" size="-1">
+ <span style="color: rgb(0, 102, 0);">faber</span> <span style="color: rgb(136, 136, 136);">( m4 m3 n2 n1 n0 -- m4 m3 )<br>
+
+
+ <span style="color: rgb(204, 51, 204);"> {</span><br>
+
+
+ </span></font><font style="font-family: monospace;" color="#663333" size="-1"><span style="color: rgb(204, 51, 204);"></span></font><font style="font-family: monospace;" color="#663333" size="-1"> <span style="color: rgb(119, 119, 119);">\ These are initialized values:</span><br>
+
+
+ <span style="color: rgb(51, 102, 255);">_otter</span><br>
+
+
+ </font><font style="font-family: monospace;" color="#663333" size="-1"> <span style="color: rgb(51, 102, 255);">_weasel</span><br>
+
+
+ </font><font style="font-family: monospace;" color="#663333" size="-1"> <span style="color: rgb(51, 102, 255);">_skunk</span><br>
+
+
+ <br>
+
+
+ <span style="color: rgb(204, 51, 204);">|</span><br>
+
+
+ <br>
+
+
+ <span style="color: rgb(119, 119, 119);">\ </span></font><font style="font-family: monospace;" color="#663333" size="-1"><span style="color: rgb(119, 119, 119);">These are uninitialized:</span><br>
+
+
+ </font><font style="font-family: monospace;" size="-1"><span style="color: rgb(51, 153, 153);">_muskrat</span><br>
+
+
+ </font><font style="font-family: monospace;" color="#663333" size="-1"> </font><font style="font-family: monospace;" color="#663333" size="-1"><span style="color: rgb(51, 153, 153);">_mole</span><br>
+
+
+ <span style="color: rgb(204, 51, 204);"> }</span></font><font style="font-family: monospace;" color="#663333" size="-1"><br>
+
+
+ <span style="color: rgb(0, 0, 0);"> </span></font><font style="font-family: monospace;" size="-1"><span style="color: rgb(0, 0, 0);">_skunk 40 * -> _muskrat<br>
+
+
+ _muskrat alloc-mem -> _mole<br>
+
+
+ base @<br>
+
+
+ hex _weasel (.)
+_mole place<br>
+
+
+ decimal _otter (.) _mole $cat<br>
+
+
+ base !<br>
+
+
+ _mole count type<br>
+
+
+ </span></font><font style="font-family: monospace;" color="#663333" size="-1"><span style="color: rgb(0, 0, 0);">_mole _muskrat free-mem</span><br>
+
+
+ </font><font style="font-family: monospace;" color="#663333" size="-1"><span style="color: rgb(102, 0, 204);">;</span></font><tt><font color="#663333" face="Courier New, Courier, monospace"></font></tt></td>
+
+
+ <td style="text-align: left; vertical-align: top; white-space: nowrap; background-color: rgb(255, 255, 255);"><font style="font-family: monospace;" size="-1"><span style="color: rgb(119, 119, 119);">\ Does nothing useful. Just an example.<br>
+
+
+\ BEGIN the declaration of Local Values.<br>
+
+
+ <br>
+
+
+\ _otter is initialized with
+the value of n2<br>
+
+
+\ _weasel is initialized with
+the value of n1<br>
+
+
+\ _skunk is
+initialized
+with the value of n0<br>
+
+
+\ and will be used to
+determine an amount of memory
+to allocate.<br>
+
+
+\ Vertical bar ends the group of Initialized Local Values.<br>
+
+
+\ NOTE: m4 and m3 stay on the stack.<br>
+
+
+ <br>
+
+
+\ _muskrat will take the
+final size of the allocation.</span><br style="color: rgb(119, 119, 119);">
+
+
+ </font><font style="color: rgb(119, 119, 119); font-family: monospace;" color="#663333" size="-1">\ _mole will hold the address of the allocated memory<br>
+
+
+\ END the declaration of Local Values.</font><font style="font-family: monospace;" color="#663333"><br>
+
+
+ </font><tt><font color="#663333" face="Courier New, Courier, monospace"></font></tt></td>
+
+
+ </tr>
+
+
+
+
+ </tbody>
+</table>
+
+<!-- <font color="#663333" face="Courier New, Courier, monospace">:
+faber ( m4 m3 n2 n1 n0 -- m4 m3 )
+\ Does nothing useful. Just an example.<br>
+ {
+_otter \
+_otter
+is initialized with
+the value of n2<br>
+
+ _weasel
+ \ _weasel is initialized with
+the value of n1<br>
+ _skunk
+ \ _skunk is
+initialized
+with the value of n0<br>
+
+ \
+
+
+ and will be used to
+determine<br>
+
+ \
+
+
+ an amount of memory
+to allocate<br>
+
+
+ ( Vertical
+Bar ends the group of Initialized
+Local Values )
+ | ( m3 and m4 stay on the
+stack )<br>
+
+\ These are uninitialized:<br>
+
+
+_muskrat \ _muskrat will take the
+final size of the allocation<br>
+
+_mole
+\ _mole will hold the address of the allocated memory<br>
+
+ }<br>
+ _skunk 40 * -> _muskrat<br>
+ _muskrat alloc-mem -> _mole<br>
+
+base @<br>
+ hex _weasel (.)
+_mole place<br>
+ decimal _otter (.) _mole $cat<br>
+ base !<br>
+ _mole count type<br>
+ _mole _muskrat free-mem<br>
+; </font>
+-->
+</tt>
+<p> The compilation of <font color="#663333"
+ face="Courier New, Courier, monospace">
+<b>faber</b></font>
+starts with <b>3 2
+{push-locals}</b> . The first invocation of <font
+ color="#663333" face="Courier New, Courier, monospace"><b>_skunk</b></font>
+(by itself) compiles as <b>2 _{local} @</b> and the
+sequence <b>
+<font color="#663333" face="Courier New, Courier, monospace">->
+_muskrat</font></b>
+ compiles as <b>3 _{local) !</b> <br>
+Finally, <font color="#663333"
+ face="Courier New, Courier, monospace"><b>faber</b></font>
+ends with <b>5 {pop-locals}</b> before the <b>unnest</b>
+. After
+that, the local-names are no longer accessible. </p>
+<h3><a class="mozTocH3" name="mozTocId361894"></a>Run-Time Support --
+the Local Values Support "Library":</h3>
+<!-- ...................................................................................... -->
+An FCode program that makes use of the Local Values extension will
+need to incorporate an implementation of the three compiled-in
+functions named above, together with a collection of functions that
+support them. These support functions must be defined in a way such
+that they can be tokenized into Industry Standard FCode, conformant to
+the Open Firmware specification, without imposing any non-Standard
+requirements on the FCode interpreter of the Host Platform.
+<p>The obvious way to deliver this package of support functions would
+be to incorporate, into
+the FCode source being Tokenized, a Prologue or "Library" file that
+contains the definitions of the three above-named compiled-in
+functions, along with all their required support.<br>
+</p>
+<p>A file defining the Local Values Support Functions has been written
+and
+will be delivered as part of the implementation of this
+Project. The user/programmer will be responsible for <span
+ style="font-family: courier new;">fload</span>ing
+it into the FCode source program to be Tokenized.<br>
+</p>
+<p>The user/programmer has the option of specifying the
+placement of the Local Values Support Functions file within the body of
+the
+FCode source program, and even of making alterations to it, if needed.<br>
+</p>
+<p><b><a name="Error_handling"></a>Error handling:</b>
+If the Local Values Support Functions file is not <span
+ style="font-family: courier new;">fload</span>ed, then the
+Parser, when it completes the processing of a Local Values declaration,
+i.e, when it encounters the close-curly-brace, or, similarly, when it
+encounters an invocation of a Local Value's name, will proceed as
+normal to compile-in the call to the appropriate function. That
+function's name will not be recognized, and the Tokenizer will exhibit
+the normal error-behavior for an invocation of an unrecognized name.<br>
+</p>
+<h4><a class="mozTocH4" name="mozTocId191315"></a>Operational Run-Time
+Support
+Functions:</h4>
+To make Local Values operate, we will, of course, need to reserve an
+area of Backing Storage. The size of that area will be <a
+ href="#Adjusting_size_of_L_V_Storage">adjustable by
+the programmer</a>, and we have chosen a suitable default.<br>
+<p>We define a
+ <b>locals-base</b> pointer that will point to the base
+-- within the reserved Local Values Storage Area -- of the set of Local
+Values currently in use; it will be initialized to point just past the
+end of the locals-storage area.
+</p>
+<p><a name="_local"></a> The address to which the <i><n></i>
+ <b>_{local}</b>
+ routine will point is calculated as the given number of cells
+above the <b>locals-base</b> pointer. </p>
+<p><a name="push-locals"></a> The <i>( #I-Ls #U-Ls -- )</i>
+<b>{push-locals}</b>
+ routine works in two stages: for the Unitialized Local Values,
+it
+simply decrements the <b>locals-base</b> pointer by the
+number of cells given in the top argument. The Initialized Local Values
+are
+then handled one at a time: the <b>locals-base</b>
+pointer is decremented by a single cell, and the data-item on top of
+the parameter stack is popped and stored into the cell at which the
+ <b>locals-base</b> pointer now points. The result is
+that the topmost stack-item is placed in the last-declared Initialized
+Local, and so on down the line until the lowest stack-item is placed in
+the first-declared Initialized Local Value. Neat, sweet, and petite. </p>
+<p><a name="pop-locals"></a> The <i>( #-Ls -- )</i> <b>{pop-locals}</b>
+
+routine simply increments the <b>locals-base</b>
+pointer by the given number of cells, which is the total number of
+Local Values used by the function in which it
+occurs. </p>
+<p> Because functions that use Local Values can call each other, (i.e.,
+the use of Local Values can be nested), the depth of the nesting might
+be
+unpredictable. Therefore, the <b>{push-locals}</b>
+routine must perform error-checking: Before decrementing the <b>locals-base</b>
+pointer, it must test whether doing so would put the pointer
+below the start of the area reserved for Local Values Storage. Such an
+error is inevitably fatal, and can only be handled by an <b>ABORT</b>
+ occurring in conjunction with a warning message advising the
+programmer to increase the size of the Local Values Storage (and, by
+implication, re-Tokenize).
+</p>
+<p> It will be the developer's responsibility to catch all such errors
+during early testing. To prevent generating hidden errors of this sort,
+the programmer is advised to use Local Values judiciously, and
+particularly to avoid using them in functions that may be called
+re-entrantly or recursively to an uncontrolled depth. Fortunately, such
+routines are rare and easily identified.
+</p>
+<p>Additional help can be provided in the form of a second <span
+ style="font-family: courier new;">fload</span>able
+Local Values Support Function source file -- to be used during
+development only -- that would overload the
+ <b>{push-locals}</b>
+and
+ <b>{pop-locals}</b> routines with the additional action
+of keeping track of -- and, of course, displaying at will
+--
+the maximum depth used in the course of a test run. Such overloading of
+functions is very simple and straightforward in FORTH.<br>
+</p>
+<h4><a class="mozTocH4" name="mozTocId750894"></a><a
+ name="Instance_Data_in_L_V_Support"></a>Important note
+regarding <span style="font-family: courier new,courier,monospace;">fload</span>ing
+of the Local Values Support Functions file</h4>
+In order to simplify management of the allocation and de-allocation of
+the area of Backing Storage, and to assure independence among instances
+of a device-package, both the reserved Local Values Storage Area and
+the <b>locals-base</b> pointer are created as part
+of the device-node's <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+data.<br>
+<br>
+The <a href="TokenizerNewFeatures.htm#INSTANCE_at_run_time">consequence</a>
+of this is that, in device-drivers that are configured
+with <a href="TokenizerNewFeatures.htm#Multiple_device_nodes">multiple
+device-nodes</a>, the Local Values Support Functions file
+must be re-<span style="font-family: courier new;">fload</span>ed for
+each device-node that uses Local Values. That is to say, every
+invocation of the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">new-device</span>
+command creates a new device node; if that new device-node will be
+making use of Local Values, then the Local Values Support
+Functions file must be <span style="font-family: courier new;">fload</span>ed
+again.<br>
+<p>The Tokenizer is sophisticated enough to keep a <a
+ href="TokenizerNewFeatures.htm#device-node_vocabularies">separate
+vocabulary
+for each device-node</a>, and will flag an <a href="#Error_handling">Error</a>
+if Local Values are used in a device-node for which the Local Values
+Support Functions file has not been <span
+ style="font-family: courier new;">fload</span>ed. </p>
+<p>However, should the user so choose, a <a
+ href="TokenizerNewFeatures.htm#Example_4">means</a> is available
+whereby a single <span style="font-family: courier new;">fload</span>ing
+of the Local Values
+Support Functions can become <a
+ href="TokenizerNewFeatures.htm#Global_Definitions">accessible to all
+Device Nodes</a> in a driver, trading off economy of System-memory
+for convenience of programming. </p>
+<h4><a class="mozTocH4" name="mozTocId684194"></a><a
+ name="Adjusting_size_of_L_V_Storage"></a>Adjusting the size of
+Local Values Storage:</h4>
+The user is responsible for declaring the maximum depth of the run-time
+Local Values stack, in storage units (Cells).<br>
+<br>
+This may be accomplished either by:<br>
+<ul>
+ <li>defining a constant named <b>_local-storage-size_</b>
+before <span style="font-family: courier new;">fload</span>ing the
+Local Values Support Functions file</li>
+ <li>defining <b>_local-storage-size_</b> as a
+Command-Line User-Symbol when the Tokenizer is run.</li>
+</ul>
+<div style="margin-left: 40px;">The form of the Command-Line
+User-Symbol definition resembles:<br>
+<div style="text-align: center;"> <span
+ style="font-family: courier new,courier,monospace;">-d
+'_local-storage-size_=d# <span style="font-style: italic;">42</span>'</span><br>
+<span style="font-family: courier new,courier,monospace;"></span></div>
+ (Be sure to enclose it within quotes
+so that the Shell treats it as a single string, and, of course, replace
+the <span
+ style="font-family: courier new,courier,monospace; font-style: italic;">42</span>
+with the actual number you need...)<br>
+</div>
+<br>
+If <b>_local-storage-size_</b> is defined
+both ways, the Command-Line User-Symbol will prevail.<br>
+<br>
+If the <b>_local-storage-size_</b> definition
+is omitted, the Local Values Support Functions file will supply a
+default.<br>
+<h4><a class="mozTocH4" name="mozTocId208497"></a>Additional Support
+Function(s):</h4>
+<h5><a class="mozTocH5" name="mozTocId781114"></a>CATCH / THROW</h5>
+Another way that a function might exit prematurely is via a call to <b><i>throw</i></b>
+ .
+<p>An FCode program that utilizes Local Values, that calls <b><i>throw</i></b>
+,
+and that has a corresponding <b><i>catch</i></b> to guard it, will
+need to
+keep its Local Values properly synchronized.
+</p>
+<p>A <b><i>throw</i></b> done by an FCode program that does not have a
+corresponding <b><i>catch</i></b> to guard it will be caught outside
+the scope of that FCode program, and the question of synchronizing
+Local Values will be rendered irrelevant.
+</p>
+<p>An <a href="TokenizerNewFeatures.htm#The_OVERLOAD_Directive">overloaded</a>
+<b><i>catch</i></b> in the Local Values Support
+Functions file does the job.<br>
+</p>
+<p>Constructing it was quite simple: It needs to (a) save
+the <b>locals-base</b> pointer onto the return stack,
+(b) do a system (generic) CATCH, and (c) restore the <b>locals-base</b>
+ pointer. Counterintuitive though this might be, it does not even
+need to examine the result of the system (generic) CATCH ; it can
+restore the <b>locals-base</b> pointer in either case.
+If the result was zero (i.e., no <b><i>throw</i></b> occurred), the
+Local Values Pointer will be the same as it was when saved and
+restoring it
+will be harmless...
+</p>
+<!-- ...................................................................................... -->
+<!-- =========================================================================== -->
+<h2><a class="mozTocH2" name="mozTocId951082"></a>End Of Document</h2>
+<!-- =========================================================================== -->
+<br>
+<br>
+<br>
+</body>
+</html>
diff --git a/documentation/toke.html b/documentation/toke.html
new file mode 100644
index 0000000..1060455
--- /dev/null
+++ b/documentation/toke.html
@@ -0,0 +1,3968 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<!-- ESWDESDOCFILE %Z%%M% %I% %W% %G% %U% -->
+ <title>ESW PART-FW: New Features in the OpenBIOS Tokenizer toke (A
+User's Guide)</title>
+ <link rel="stylesheet" type="text/css"
+ href="workbook.css">
+</head>
+<body>
+<h1 style="text-align: center;" class="title"><a class="mozTocH1"
+ name="mozTocId449746"></a>New Features in OpenBIOS Tokenizer toke
+</h1>
+<h1 style="text-align: center;"><a class="mozTocH1"
+ name="mozTocId459488"></a>(A
+User's Guide)
+</h1>
+<div class="document-control">
+<ul>
+ <li>Updated Wed, 18 Oct 2006 at 12:39 PDT by David L. Paktor </li>
+</ul>
+</div>
+<p class="copyright">Copyright © 2005 International Business
+Machines<sup>®</sup>,
+All Rights Reserved.<br>
+Licensed under the <a
+ href="http://www.opensource.org/licenses/cpl1.0.php">Common Public
+License (CPL) version 1.0</a><br>
+</p>
+<!-- =========================================================================== --><!-- =========================================================================== -->
+<h2><a class="mozTocH2" name="mozTocId700910"></a><a name="TOC"></a>Table
+Of Contents</h2>
+<ol id="mozToc">
+<!--mozToc h1 1 h2 2 h3 3 h4 4 h5 5 h6 6--><a href="#mozTocId459488">New
+Features in OpenBIOS Tokenizer toke (A User's Guide)</a><br>
+ <li><a href="#mozTocId601312">Overview</a></li>
+ <li><a href="#mozTocId119716">Scope of this Document</a>
+ <ol>
+ <li><a href="#mozTocId206214">What this document
+does not cover: </a></li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId343012">Error Detection
+and other messages:</a></li>
+ <li><a href="#mozTocId271949">Case Sensitivity</a><br>
+ </li>
+ <li><a href="#mozTocId280593">Categories of Features</a>
+ <ol>
+ <li><a href="#mozTocId460640">Directives</a></li>
+ <li><a href="#mozTocId930032">Command-Line options</a></li>
+ <li><a href="#mozTocId379181">Non-standard input,
+syntaxes and behavior</a></li>
+ <li><a href="#mozTocId303703">“Tokenizer-Escape” Mode</a></li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId959733">Features, by Category:</a>
+ <ol>
+ <li><a href="#mozTocId499618">Command-Line options</a>
+ <ol>
+ <li><a href="#mozTocId510152">Switches</a></li>
+ <li><a href="#mozTocId514350">Include-List Directories</a></li>
+ <li><a href="#mozTocId515750">Trace the Creation and
+Invocation of FCode or
+"Tokenizer Escape"-mode Definitions</a><br>
+ </li>
+ <li><a href="#mozTocId580387">Command-Line Symbol Definitions</a></li>
+ <li><a href="#mozTocId632060">Special-Feature Flags</a></li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId445349">“Tokenizer-Escape” Mode</a></li>
+ <ol>
+ <li><a href="#mozTocId445715">The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">emit-byte</span>
+command</a></li>
+ <li><a href="#mozTocId446081">Other commands</a></li>
+ <ol>
+ <li><a href="#mozTocId446447">Standard Commands</a></li>
+ <ol>
+ <li><a href="#mozTocId446813">The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">next-fcode</span>
+command</a></li>
+ </ol>
+ <li><a href="#mozTocId447179">Non-Standard operations</a></li>
+ <ol>
+ <li><a href="#mozTocId447545">constant</a></li>
+ <li><a href="#mozTocId447911">emit-fcode</a></li>
+ </ol>
+ <li><a href="#mozTocId448277">Additional FORTH-compatible
+operations</a><br>
+ </li>
+ </ol>
+ </ol>
+ <li><a href="#mozTocId649525">Directives</a>
+ <ol>
+ <li><a href="#mozTocId557512">Conditional Tokenization</a>
+ <ol>
+ <li><a href="#mozTocId686605">The Conditional-block
+Terminator</a></li>
+ <li><a href="#mozTocId763728">The
+"False" segment-switcher</a></li>
+ <li><a href="#mozTocId375310">Condition-Testers</a></li>
+ <ol>
+ <li><a href="#mozTocId104560">True/False flag
+on the top of the stack</a></li>
+ <li><a href="#mozTocId956359">Existence or
+non-existence of an
+FCode or "Tokenizer Escape"-mode definition</a></li>
+ <li><a href="#mozTocId880808">Definition or
+non-definition of a
+Command-Line Symbol</a></li>
+ </ol>
+ <li><a href="#mozTocId891224">Tracing the state of
+Conditional Tokenization</a><br>
+ </li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId202222">Suspending the Duplicate-Name
+Test
+for one Definition ("Overloading")</a></li>
+ <li><a href="#mozTocId202620">Suspending the Multi-Line
+Warning for one occasion</a><br>
+ </li>
+ <li><a href="#mozTocId203416">Controlling the Scope of
+Definitions</a><br>
+ </li>
+ <li><a href="#mozTocId314185">Evaluating
+Command-line Symbols </a></li>
+ <li><a href="#mozTocId655967">Outputting
+Arbitrary Byte-Sequences to
+the FCode Binary</a></li>
+ <li><a href="#mozTocId114013">Encoding
+blocks of binary data taken from a file</a></li>
+ <li><a href="#mozTocId69109">Generating Special Text-Strings
+and Literals</a><br>
+ </li>
+ <ol>
+ <li><a href="#mozTocId70133">Current date or time</a></li>
+ <li><a href="#mozTocId71157">Name of the function
+currently being defined</a></li>
+ <li><a href="#mozTocId72181">Input-File Name and Line Number</a></li>
+ </ol>
+ <li><a href="#mozTocId844437">Pre-pending
+PCI Headers to FCode
+images </a></li>
+ <li><a href="#mozTocId931658">Modifying the PCI
+Header</a>
+ <ol>
+ <li><a href="#mozTocId504353">"Revision
+Level of the Vendor's ROM"</a></li>
+ <ol>
+ <li><a href="#mozTocId503878">Byte-Order</a></li>
+ </ol>
+ <li><a href="#mozTocId53081">"Last
+Image Indicator" bit</a></li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId410469">Changing the name of the
+Binary Output File</a></li>
+ <li><a href="#mozTocId982642">Issuing messages at
+Tokenization
+time.</a></li>
+ <li><a href="#mozTocId550942">Changing Special-Feature
+Flags
+from Source</a>
+ <ol>
+ <li><a href="#mozTocId551846">Displaying
+Special-Feature Flags from Source</a></li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId573280">Manipulating the
+FCode-Token-Number Assignment Counter</a></li>
+ <ol>
+ <li><a href="#mozTocId566072">Saving
+and Restoring</a></li>
+ <li><a href="#mozTocId568474">Resetting</a><br>
+ </li>
+ </ol>
+ <li><a href="#mozTocId575686">Resetting
+Symbols Defined in Either Mode</a></li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId957252">Non-standard input,
+syntaxes, and behavior </a>
+ <ol>
+ <li><a href="#mozTocId850914">Ambiguous
+Conditions</a>
+ <ol>
+ <li><a href="#mozTocId162252">Tokens
+expected on the same
+line</a></li>
+ <li><a href="#mozTocId246601">The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">h#</span>
+ <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">d#</span> and
+ <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">o#</span>
+directives </a></li>
+ <li><a href="#mozTocId978546">The
+commands <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">leave</span>
+ <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">?leave</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">unloop</span>
+outside of a loop-control framework</a></li>
+ <li><a href="#mozTocId73206">The
+commands <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[']</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">'</span>
+followed by a name that is not a valid target</a></li>
+ <li><a href="#mozTocId74410">The Forth word <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">to</span>
+followed by a name that is not a valid target </a><br>
+ </li>
+ <li><a href="#mozTocId75614">The word <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span><br>
+ </a></li>
+ <ol>
+ <li><a href="#mozTocId76818">Followed by an
+inapplicable defining-word</a></li>
+ <li><a href="#mozTocId78022">Left unresolved</a></li>
+ <li><a href="#mozTocId79226">Not Allowed in...</a></li>
+ </ol>
+ <li><a href="#mozTocId884280">The command <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fload</span>
+inside a colon-definition<br>
+ </a></li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId901662">Non-Standard
+Synonyms for Standard
+Functions</a></li>
+ <li><a href="#mozTocId732819">Non-Standard
+Functions or behaviors</a>
+ <ol>
+ <li><a href="#mozTocId522750">Alias</a></li>
+ <li><a href="#mozTocId824541">String-Escape
+characters and other
+String-Gathering Features </a></li>
+ <ol>
+ <li><a href="#mozTocId945290">Quoted
+String-Escape Characters</a></li>
+ <li><a href="#mozTocId758170">Embedded New-Lines</a></li>
+ <li><a href="#mozTocId42456">Hex-Sequence
+Processing </a></li>
+ <li><a href="#mozTocId150131">C-Style
+String-Escape Characters</a></li>
+ </ol>
+ <li><a href="#mozTocId40998">The ABORT"
+(Abort-Quote) command</a></li>
+ <li><a href="#mozTocId526780">Conveniently
+Convert Short
+Character-Sequence to Number</a></li>
+ <ol>
+ <li><a href="#mozTocId53626">Left-Justified</a><br>
+ </li>
+ </ol>
+ <li><a href="#mozTocId54171">F[']
+("Eff-Bracket-Tick-Bracket")</a></li>
+ <ol>
+ <li><a href="#mozTocId54716">F['] in "Normal
+Tokenization" Mode</a></li>
+ <li><a href="#mozTocId55261">F['] in "Tokenizer-Escape"
+Mode</a><br>
+ </li>
+ </ol>
+ <li><a href="#mozTocId887752">Shell-Environment Variables
+in File-Names</a><br>
+ </li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId505746">Featured
+behaviors, supported by this
+Tokenizer, that are not mentioned in the Standard</a>
+ <ol>
+ <li><a href="#mozTocId530910">User-Defined Macros</a><br>
+ </li>
+ <li><a href="#mozTocId539069">Multiple
+device-nodes</a></li>
+ <ol>
+ <li><a href="#mozTocId540605">Global Definitions</a><br>
+ </li>
+ </ol>
+ <li><a href="#mozTocId354426">Multiple
+FCode-block Images</a></li>
+ <li><a href="#mozTocId232809">Multiple
+PCI-Image</a></li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ <li><a href="#mozTocId194505">Examples:</a>
+ <ol>
+ <li><a href="#mozTocId544211">Example #1:</a></li>
+ <li><a href="#mozTocId80432">Example #2: </a></li>
+ <li><a href="#mozTocId455242">Example #3:</a></li>
+ <li><a href="#mozTocId861304">Example #4:</a></li>
+ <li><a href="#mozTocId866180">Example #5:</a><br>
+ </li>
+ </ol>
+ </li>
+</ol>
+<h2><a class="mozTocH2" name="mozTocId601312"></a>Overview</h2>
+<!-- ...................................................................................... -->
+<p>The goal of this project is to produce an FCode Tokenizer that can
+both
+be used in-house and be presented to third-party vendors, VARs and the
+like, as a professional-quality tool for their use, without adversely
+affecting IBM's
+Intellectual-Property rights.</p>
+<p>We are using, as a starting basis, the Open-Source tokenizer
+that is available from the <a href="http://openbios.org/">OpenBIOS
+project</a> . </p>
+<p>We expect to be able to deliver this tool to our vendors by
+returning our modifications to the OpenBIOS project, from whence it can
+be obtained openly by anyone. </p>
+<h2><a class="mozTocH2" name="mozTocId119716"></a>Scope of this Document</h2>
+<!-- ...................................................................................... -->
+In order to achieve the first part of the goal -- making it suitable
+for in-house use -- a number of features were added that are not
+covered in the IEEE-1275 Standard for Boot Firmware (also referred to
+herein simply as "the Standard").
+<p>This document describes those <a href="#Categories_of_Features">features</a>
+and how they are used.
+</p>
+<p>There will be a brief overview of <a
+ href="#Error_Detection_and_other_messages:">Error Detection</a> and
+other
+messages.</p>
+<p>There will be some <a href="#Examples:">examples</a> at the end.<br>
+</p>
+<h3><a class="mozTocH3" name="mozTocId206214"></a>What this document
+does not cover:<br>
+</h3>
+<ul>
+ <li>Standard behavior, particularly conversion between ANSI /
+IEEE-1275 Standard Forth and IEEE-1275 Standard FCode, and standard
+Tokenizer Macros. These are
+expected and will be regarded as "presumed" by this document.</li>
+ <li>Changes to older versions of the OpenBIOS Tokenizer.</li>
+ <li>A complete list of Tokenization Source Errors detected and
+reported.</li>
+ <li>A complete list of conditions that generate WARNING or ADVISORY
+messages.</li>
+ <li>A complete list of FATAL conditions.<br>
+ </li>
+ <li>Support for <a href="TokenizerLocalValues.htm">IBM-Style Local
+Values</a>. That is the subject of a
+separate writeup.</li>
+</ul>
+<!-- =========================================================================== -->
+<!-- =========================================================================== -->
+<h2><a class="mozTocH2" name="mozTocId343012"></a><a
+ name="Error_Detection_and_other_messages:"></a>Error Detection
+and other messages:</h2>
+The Tokenizer is capable of producing the following kinds of messages:<br>
+<ul>
+ <li>FATAL</li>
+ <li>ERROR</li>
+ <li>WARNING</li>
+ <li>ADVISORY</li>
+ <li>MESSAGE generated by the User.</li>
+ <li>TRACE-NOTE<br>
+ </li>
+</ul>
+<p>A <span style="font-style: italic; font-weight: bold;">FATAL</span>
+condition is sufficient cause to immediately stop activity. It is
+usually (but not always) a symptom of a system failure, rather than a
+result of User
+input.</p>
+<p><a name="An_ERROR"></a>An <span
+ style="font-style: italic; font-weight: bold;">ERROR</span>
+occurs as a result of User input. It is a condition sufficient to
+make the run a failure, but not to stop activity. Unless the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold; font-style: italic;">-i</span>
+<a href="#Ignore_Errors_option">("Ignore Errors")</a> <a
+ href="#Command-Line_options_">Command-Line
+option</a> has been specified, the production of a Binary
+Output file
+will be suppressed and theTokenizer will exit with a non-zero status,
+if an Error Message has been issued. <br>
+</p>
+<p><a name="A_WARNING"></a>A <span
+ style="font-weight: bold; font-style: italic;">WARNING</span>
+is issued for a condition that, while not necessarily an error, might
+be something to avoid. E.g., a deprecated feature, or a
+feature that might be incompatible with other Standard tokenizers.</p>
+<p><a name="Advisories"></a>An <span
+ style="font-weight: bold; font-style: italic;">ADVISORY</span>
+message is issued for a condition that is a response to User input, and
+where processing continues unchanged, but it is nonetheless (in
+this author's opinion) worthwhile to give the User a "heads-up" to make
+sure that what you got is what you wanted. <span
+ style="font-weight: bold; font-style: italic;">ADVISORY</span>
+messages are only displayed when the <a
+ style="font-style: italic; font-weight: bold;" href="#verbose_option">verbose</a>
+<a href="#Command-Line_options_">Command-Line option</a> is selected. </p>
+<p>
+A User-generated <span style="font-weight: bold; font-style: italic;">MESSAGE</span>
+-- unsurprisingly -- is a message generated by the User via any of the
+<a href="#User_Messages">directives</a> supported for that purpose.<br>
+</p>
+<p><a name="Trace_Notes"></a>A <span
+ style="font-weight: bold; font-style: italic;">TRACE-NOTE</span> is
+issued if the <a href="#Trace_Symbols">Trace-Symbols</a>
+feature is activated, whenever a symbol on the Trace-List is either
+created or invoked.<br>
+</p>
+<p><a name="Message_Format"></a>Each message of the above types is
+accompanied by the name of the
+source file and the line number in which the condition that triggered
+it was detected, as well as the current position to which data is being
+generated into the Binary Output. If a PCI Header is in effect,
+the position relative to the end of that PCI Header will also be shown;
+this is to maintain consistency with the <a
+ href="DeTokenizer.htm#with_offsets">"offsets</a>" displayed be the <a
+ href="DeTokenizer.htm">DeTokenizer</a><br>
+</p>
+<p><a name="Errors_Ignored"></a>
+The Tokenizer typically runs through to completion of the source file,
+displaying an ERROR message for each error it encounters (I.e., it does
+not "bail" after the first error). If the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold; font-style: italic;">-i</span>
+<a href="#Ignore_Errors_option">("Ignore
+Errors")</a> <a href="#Command-Line_options_">Command-Line
+option</a> has been specified, the Tokenizer will attempt to
+produce binary output for each error, as far as is feasible, and will
+produce
+a Binary Output file. While this practice is not recommended, the
+author acknowledges that it
+might be useful in some limited circumstances.</p>
+At the end of its run, the Tokenizer will print a tally of the number
+of each type of message that was generated.<br>
+<h2><a name="mozTocId271949"></a><a name="Case_Sensitivity"></a>Case
+Sensitivity</h2>
+Although Command-Line option
+<a href="#Command_Line_Switches">switches</a>
+are case-sensitive, this Tokenizer is insensitive to the distinctions
+between upper- or
+lower- -case characters in all other matters: in Command-Line <a
+ href="#Symbol_Definitions">symbol-definitions</a> and <a
+ href="#Special_Feature_Flags">Special-Feature Flag</a> settings and in
+the Input Source.<br>
+<p>Character-case is preserved in string sequences and in the
+assignment
+of names of headered definitions, but is ignored for purposes of
+name-matching. Case sensitivity of filenames, of course, is
+dependent on the Host Operating System.<br>
+</p>
+<p>This Tokenizer supports a pair of Special-Feature Flags that will
+enable the User to <a href="#Token_Name_Cases">over-ride the
+preservation of character-case</a> in the
+assignment
+of names of headered definitions. </p>
+<h2><a class="mozTocH2" name="mozTocId280593"></a><a
+ name="Categories_of_Features"></a>Categories of <a
+ href="#Features_by_Category">Features</a></h2>
+<!-- ...................................................................................... -->
+The features described in this document fall into four categories:<br>
+<ol>
+ <li><a href="#Directives">Directives</a></li>
+ <li><a href="#Command-Line_options">Command-Line options</a></li>
+ <li><a href="#Non-standard_input_syntaxes">Non-standard</a>
+input, syntaxes, and behavior</li>
+ <li>Options available within “<a href="#Tokenizer-Escape_Mode">tokenizer-escape</a>”
+mode (I.e., within
+the scope of a <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">tokenizer[
+... ]tokenizer</span> block).</li>
+</ol>
+<h3><a class="mozTocH3" name="mozTocId460640"></a><a name="Directives"></a>Directives</h3>
+<a href="#Directives_">Directives</a> are commands that occur within
+the body of the Tokenization
+Source File, but are not part of the FCode program itself. They
+are recognized by the Tokenizer and cause it to perform special actions
+that might serve such diverse functions as:<br>
+<ul>
+ <li>Printing a message to the Standard Output during the Tokenization
+process</li>
+ <li>Controlling whether selected passages of the Source are
+processed or ignored (also called Conditional Compilation or
+Conditional Tokenization)</li>
+ <li>Outputting arbitrary sequences of bytes to the FCode binary file</li>
+</ul>
+<h3><a class="mozTocH3" name="mozTocId930032"></a><a
+ name="Command-Line_options"></a>Command-Line options</h3>
+<a href="#Command-Line_options_">Command-Line options</a> are, as the
+name suggests, switches that can be
+set on the command-line when the Tokenizer is invoked. They
+affect behaviors such as:<br>
+<ul>
+ <li>The verbosity of output during the Tokenization
+process</li>
+ <li>Definition of symbols that feed into some of the Conditional
+Tokenization Directives<br>
+ </li>
+ <li>Allowing output to be produced even when errors have been
+detected.</li>
+ <li>Selectively
+enabling variants of Non-standard input, syntaxes, and behavior<br>
+ </li>
+</ul>
+<h3><a class="mozTocH3" name="mozTocId379181"></a><a
+ name="Non-standard_input_syntaxes"></a><a
+ href="#Non-standard_input_syntaxes_">Non-standard input</a>,
+syntaxes and behavior</h3>
+Certain sequences of source code that are not covered by the IEEE-1275
+Standard are, nonetheless, recognized by this Tokenizer and cause it to
+produce valid FCode. Examples of these include:<br>
+<ul>
+ <li>"C"-style escape characters in strings</li>
+ <li>Sun-style versus Apple-style implementation of the command <span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">ABORT"</span>
+ <br>
+ </li>
+ <li>IBM-style Local-Values</li>
+</ul>
+In order to
+accommodate the conflicting goals of standard-compliance and
+convenience, non-Standard variants will be selectively enabled by
+a set of Command-Line options known as "<a href="#Special_Feature_Flags">Special-Feature
+Flags</a>"
+<h3><a class="mozTocH3" name="mozTocId303703"></a><a
+ name="Tokenizer-Escape_Mode"></a>“Tokenizer-Escape” Mode</h3>
+Section C.3.1 of
+the IEEE-1275 Standard describes “<a href="#Tokenizer-Escape_Mode_">tokenizer-escape</a>”
+mode and its basic
+command, <a href="#emit_byte"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">emit-byte</span></a>
+The OpenBIOS Tokenizer toke, while it does not have a full FORTH
+capability, does support a few additional Forth-style commands that can
+be used to:<br>
+<ul>
+ <li>Define and retrieve named constants</li>
+ <li>Create aliases</li>
+ <li>Set the value of the next FCode-token<br>
+ </li>
+</ul>
+<!-- =========================================================================== -->
+<!-- =========================================================================== -->
+<h2><a class="mozTocH2" name="mozTocId959733"></a><a
+ name="Features_by_Category"></a>Features, by Category:</h2>
+The following sections will supply a complete list of the new features,
+organized by category.<br>
+<!-- ...................................................................................... -->
+<h3><a class="mozTocH3" name="mozTocId499618"></a><a
+ name="Command-Line_options_"></a>Command-Line options:</h3>
+Command-Line option Switches are <a href="#Case_Sensitivity">case-sensitive</a>;
+their arguments, where applicable, are not.<br>
+<br>
+<h4><a class="mozTocH4" name="mozTocId510152"></a><a
+ name="Command_Line_Switches"></a>Switches</h4>
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-h</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-?</span></li>
+</ul>
+<div style="margin-left: 40px;">Print a brief help message and then
+exit.
+</div>
+<ul>
+ <li><a name="verbose_option"></a><span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">-v</span></li>
+</ul>
+<p style="margin-left: 40px;">Verbose -- print additional
+messages (including <a href="#Advisories">Advisories</a>) during
+tokenization.<br>
+</p>
+<ul>
+ <li
+ style="font-weight: bold; font-family: courier new,courier,monospace;"><a
+ name="Ignore_Errors_option"></a>-i</li>
+</ul>
+<p style="margin-left: 40px;">Ignore Errors. Generate a Binary
+Output <a href="#Errors_Ignored">even if
+errors were reported</a>.
+</p>
+<ul>
+ <li><a name="Binary_Output_Name_option"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-o
+<OutputFileName></span></li>
+</ul>
+<p style="margin-left: 40px;">Direct the Binary Output (FCode result of
+Tokenization) to the named
+file instead of to the <a href="#Binary_Output_File_Name_Default">default-named
+file</a>. This option is not valid when multiple input files are
+named.
+</p>
+<ul>
+ <li><a name="FLoad_List_option"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-l</span></li>
+</ul>
+<p style="margin-left: 40px;">FLoad List -- Collect the names of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fload</span>ed
+files into an
+FLoad-List File. The names collected are in the same form as they
+were presented in the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fload</span>
+statements.
+</p>
+<p style="margin-left: 40px;">The name of the FLoad-List File is
+derived
+from
+the name of
+the Binary Output File, by replacing its extension with <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">.fl</span>
+, or, if the Binary Output File name had no extension, merely appending
+the
+extension <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">.fl<br>
+</span></p>
+<p style="margin-left: 40px;">The Binary Output File name used for this
+purpose is either the one specified <a
+ href="#Binary_Output_Name_option">on the Command
+Line</a>, or the one created by <a
+ href="#Binary_Output_File_Name_Default">default</a>. <br>
+</p>
+<ul>
+ <li><a name="Depncy_List_option"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-P</span>
+(Note: Switch is upper-case)<br>
+ </li>
+</ul>
+<p style="margin-left: 40px;">Dependency List -- Collect the
+fully-resolved pathnames
+of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fload</span>ed
+and <a href="#ENCODE_FILE">ENCODE</a>d files into a Dependency-List
+File. The names collected are in the form that is presented to
+the Host Operating System: <a
+ href="#Shell_Env_Vbles_in_File_Names">Shell Environment Variables</a>
+and
+related expressions will be fully expanded, and the directory within
+the <a href="#Include_List">Include-List</a> in which the file was
+found will
+be attached.<br>
+</p>
+<p style="margin-left: 40px;">The name of the Dependency-List File will
+be the same as that of the FLoad-List File, except that its extension
+will be <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">.P</span>
+instead of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">.fl</span>
+</p>
+<ul>
+ <li>If an FLoad List or a Dependency List is being collected,
+the
+names of any files that cannot be read, for any reason, will be
+collected into
+a Missing-Files-List file.</li>
+</ul>
+<p style="margin-left: 40px;">The name of the Missing-Files-List file
+will be the same as that of the FLoad-List File except that its
+extension will be <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">.fl.missing</span>
+instead of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">.fl</span></p>
+<p style="margin-left: 40px;">The Missing-Files-List file will not be
+created if all of the files are read successfully.<br>
+</p>
+<p style="margin-left: 40px;">If the name
+of the Binary Output File is <a
+ href="#Binary_Output_File_Name_Directive">changed
+by a directive</a>
+embedded within the Tokenization Source File, that will not alter the
+names of the FLoad-List, Dependency List or Missing-Files-List files.</p>
+<h4><a class="mozTocH4" name="mozTocId514350"></a><a name="Include_List"></a>Include-List
+Directories</h4>
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-I
+directory</span> (Note: Switch is
+upper-case)</li>
+</ul>
+<p style="margin-left: 40px;">This Tokenizer supports the notion of an
+Include-List. The User creates the Include-List by specifying a
+number of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-I
+directory</span> pairs on the Command-Line. All file-reads,
+whether for an <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fload</span>
+command or an <a href="#ENCODE_FILE"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">encode-file</span></a>
+directive, will involve a search for the named file through the
+directories of the Include-List, in the order they were supplied on the
+Command-Line.
+</p>
+<p style="margin-left: 40px;">If no Include-List is created, file-reads
+are relative to the Current Working
+Directory. If an Include-List <span style="font-style: italic;">is</span>
+created, file-reads are
+restricted to the directories within it. For the Current Working
+Directory to be included in the file-search, it must be specified
+explicitly. <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-I<big>.</big></span>
+will accomplish that quite
+effectively.<br>
+</p>
+<h4><a name="mozTocId515750"></a><a name="Trace_Symbols"></a>Trace the
+Creation and Invocation of FCode or
+"Tokenizer Escape"-mode Definitions</h4>
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-T
+<</span><span style="font-family: courier new,courier,monospace;">symbol</span><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">></span>
+ (Note: Switch is upper-case)</li>
+</ul>
+<p style="margin-left: 40px;">This Tokenizer supports the notion of a
+"Trace-List". The User creates the Trace-List by specifying a
+number of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-T
+<symbol></span> pairs on the Command-Line.<br>
+</p>
+<p style="margin-left: 40px;">When a name is defined, whether as an
+FCode, an alias, a Macro or anything else, either in normal
+tokenization mode or "Tokenizer Escape"-mode, if it matches a symbol
+that has been added to the Trace List, a <a href="#Trace_Notes">Trace
+Note</a> Message will be issued indicating that a definition of that
+name has been created. Subsequent <a href="#Trace_Notes">Trace
+Note</a> Messages
+will be issued when the definition of that name is invoked.</p>
+<p style="margin-left: 40px;">This "<span
+ style="font-weight: bold; color: rgb(0, 80, 178);">Trace-Symbols</span>"
+feature can be helpful during maintenance of Legacy
+code, for instance, when multiple symbols carry the same name.<br>
+</p>
+<h4><a class="mozTocH4" name="mozTocId580387"></a><a
+ name="Symbol_Definitions"></a>Command-Line Symbol
+Definitions</h4>
+<ul>
+ <li style="font-family: courier new,courier,monospace;"><a
+ name="Define_Command-Line_symbol"></a><span style="font-weight: bold;">-d
+Symbol</span>[<span style="font-weight: bold;">=Value</span>]</li>
+</ul>
+<p style="margin-left: 40px;">Define a Command-Line Symbol.
+Optionally, assign a value to it. If you wish the "value" to
+contain spaces or quotes, you can accomplish that using the shell
+escape conventions. This sequence may be repeated. Once a
+Symbol is defined on the command-line, it stays in effect for the
+duration of the entire batch of tokenizations (i.e., if there are
+multiple input files named on the command line). Command-Line
+Symbols can be <a href="#Definition_or_non-definition_of_a">tested</a>
+for purposes of Conditional Tokenization, or their assigned values can
+be
+<a href="#Evaluating_Command-line_Symbols">Evaluated</a>.<br>
+</p>
+<h4><a class="mozTocH4" name="mozTocId632060"></a><a
+ name="Special_Feature_Flags"></a>Special-Feature Flags<br>
+</h4>
+<ul>
+ <li style="font-family: courier new,courier,monospace;"><span
+ style="font-weight: bold;">-f</span> [<span style="font-weight: bold;">no</span>]<<span
+ style="font-weight: bold;">FlagName</span>> </li>
+</ul>
+<p style="margin-left: 40px;">The Tokenizer
+recognizes a specific set of Special-Feature Flag-names; each is
+associated with a
+specific non-Standard variant
+behavior. Pass the Flag-name as an argument to the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-f</span>
+switch to enable the behavior; to disable it, precede the Flag-name
+with the
+optional string <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">No</span>
+<br>
+</p>
+<p style="margin-left: 40px;">The settings of the Special-Feature Flags
+can also be <a href="#Changing_C-L_Flags_from_Source">changed</a> or <a
+ href="#Displaying_C-L_Flags_from_Source">displayed</a> from
+within the Source Input File<br>
+</p>
+<p style="margin-left: 40px;">The Special-Feature Flags are all
+initially set to be enabled, except where noted.<br>
+</p>
+<p style="margin-left: 40px;">The Flag-names and their associated
+Special-Features are as follows:</p>
+<ul>
+ <ul>
+ <li><a name="SF_Flag_Loc_Val"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Local-Values</span></li>
+ </ul>
+</ul>
+<p style="margin-left: 120px;">Support IBM-style <a
+ href="TokenizerLocalValues.htm">Local Values</a> ("LV"s).
+Initially disabled.
+</p>
+<ul>
+ <ul>
+ <li><a name="SF_Flag_LV_Leg_Sep"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">LV-Legacy-Separator</span></li>
+ </ul>
+</ul>
+<p style="margin-left: 120px;">Allow Semicolon for Local Values
+<a
+ href="TokenizerLocalValues.htm#Separation_Character_between_Initialized">Separator</a>
+("<a href="TokenizerLocalValues.htm#Disallow_Legacy">Legacy</a>").
+</p>
+<ul>
+ <ul>
+ <li><a name="SF_Flag_LV_Leg_Mssg"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">LV-Legacy-Message</span></li>
+ </ul>
+</ul>
+<p style="margin-left: 120px;">Display a <a
+ href="TokenizerLocalValues.htm#Legacy_Separator">Warning
+Message</a> when
+Semicolon
+is used as the Local Values Separator.
+</p>
+<ul>
+ <ul>
+ <li><a name="SF_Flag_AB_Q"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT-Quote</span></li>
+ </ul>
+</ul>
+<p style="margin-left: 120px;">Allow <a href="#SFeat_AB_Q">ABORT"</a>
+macro.
+</p>
+<ul>
+ <ul>
+ <li><a name="SF_Flag_Sun_AB_Q"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Sun-ABORT-Quote</span></li>
+ </ul>
+</ul>
+<p style="margin-left: 120px;">ABORT" with <a href="#SFeat_Sun_AB_Q">implicit
+IF ... THEN</a>
+</p>
+<ul style="font-family: courier new,courier,monospace;">
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"><a
+ name="SF_Flag_AB_Q_Throw"></a>Abort-Quote-Throw</span></li>
+ </ul>
+</ul>
+<p style="margin-left: 120px;">Use <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-2
+THROW</span> , rather than <a href="#Abort_Quote_Abort"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT</span></a>,
+in an <a href="#SFeat_AB_Q">Abort"</a> phrase</p>
+<ul style="font-family: courier new,courier,monospace;">
+ <ul>
+ <li><a name="SF_Flag_Str_Rem_Esc"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">String-remark-escape</span></li>
+ </ul>
+</ul>
+<p style="margin-left: 120px;">Allow <a href="#SFeat_Str_Rem_Esc">"\
+(Quote-Backslash)</a> to interrupt
+string parsing.
+</p>
+<ul>
+ <ul>
+ <li><a name="SF_Flag_Hex_Rem_Esc"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Hex-remark-escape</span></li>
+ </ul>
+</ul>
+<p style="margin-left: 120px;">Allow <a href="#SFeat_Hex_Rem_Esc">\
+(Backslash)</a> to interrupt
+<a href="#Hex_Seq_Procg">hex-sequence parsing</a> within a string.
+</p>
+<ul>
+ <ul>
+ <li><a name="SF_Flag_C_Str_Esc"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">C-Style-string-escape</span></li>
+ </ul>
+</ul>
+<p style="margin-left: 120px;">Allow the <a
+ href="#C-Style_String-Escape_Characters"><big><b>C</b></big>-style
+String-Escape</a>
+pairs <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">\n</span>
+<span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">\t</span>
+and <a href="#SFeat_BS_xx"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">\xx\</span></a>
+to be treated as special characters
+in string parsing.
+</p>
+<ul>
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Always-Headers</span></li>
+ </ul>
+</ul>
+<p style="margin-left: 120px;">Over-ride occurrences of the
+Standard directive <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">headerless</span>
+in the Source with -- effectively -- <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">headers</span>
+to make all definitions have a header. Occurrences of the
+directive <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">external</span>
+will continue to behave in the Standard manner. Initially
+disabled.
+</p>
+<ul>
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Always-External</span></li>
+ </ul>
+</ul>
+<p style="margin-left: 120px;">All definitions will be made as
+though under the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">external</span>
+directive; occurrences of either Standard directive <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">headerless</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">headers</span>
+in the Source will be over-ridden. This Special-Feature Flag will
+also over-ride the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Always-Headers</span>
+Special-Feature Flag in the event that both have been specified.
+Initially disabled.
+</p>
+<ul>
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"><a
+ name="Warn_if_Duplicate_Flag"></a>Warn-if-Duplicate</span></li>
+ </ul>
+</ul>
+<div style="margin-left: 120px;">Display a <a href="#A_WARNING">WARNING</a>
+message whenever
+a
+definition is made
+whose name duplicates that of an existing definition. Disabling
+this flag will suspend the duplicate-names test globally, until it
+is re-enabled. A Directive is supported that will <a
+ href="#The_OVERLOAD_Directive">suspend the
+test for the duration of only a single definition</a>, without
+affecting global behavior.
+</div>
+<ul>
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"><a
+ name="Obso_FCode_Warning"></a>Obsolete-FCode-Warning</span></li>
+ </ul>
+</ul>
+<div style="margin-left: 120px;">Display a <a href="#A_WARNING">WARNING</a>
+message whenever an FCode function is invoked that the Standard
+identifies as "obsolete".
+</div>
+<ul>
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"><a
+ name="Trace_Condls"></a>Trace-Conditionals</span></li>
+ </ul>
+</ul>
+<div style="margin-left: 120px;">Issue <a href="#Advisories">Advisory
+Messages</a> about the <a href="#Tracing_Conditional_State">state of</a>
+<a href="#Conditional_Tokenization">Conditional Tokenization</a>.
+(Remember that <a href="#Advisories">Advisory
+Messages</a> are displayed only if the "verbose" option <a
+ href="#verbose_option"><span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">-v</span></a>
+is set.)
+Initially disabled.
+</div>
+<ul>
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"><a
+ name="Token_Name_Case_Upper"></a><a name="Token_Name_Cases"></a>Upper-Case-Token-Names
+ </span> </li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"><a
+ name="Token_Name_Case_Lower"></a>Lower-Case-Token-Names </span> </li>
+ </ul>
+</ul>
+<div style="margin-left: 120px;">When outputting the names of headered
+functions ("Token-Names") to the Binary Output File, over-ride the
+character-case in which the names appeared in the Source, and convert
+them to Upper- or Lower- -Case, respectively. (These flags do not
+affect text string sequences, whose character-case is always
+preserved.)
+Initially disabled.<br>
+</div>
+<ul>
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"><a
+ name="Big_End_PCI_Rev_Level"></a>Big-End-PCI-Rev-Level</span></li>
+ </ul>
+</ul>
+<div style="margin-left: 120px;">Save the "<a href="#PCI_Rev_Level">Revision
+Level of the
+Vendor's ROM</a>" field of the PCI Header in <a
+ href="#PCI_Rev_Level_Byte_Order">Big-Endian byte-order</a>, rather
+than "Little-Endian" as per the general PCI Standard
+convention. (This flag does not affect any other field of the PCI
+Header).
+Initially disabled.<br>
+</div>
+<ul>
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"><a
+ name="Ret_Stk_Interp"></a>Ret-Stk-Interp<br>
+ </span></li>
+ </ul>
+</ul>
+<div style="margin-left: 120px;">Allow Return-Stack Operations during
+Interpretation. While the Standard specifies that usage of the
+operators <span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">>r</span>
+<span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">r@</span>
+and <span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">r></span>
+while interpreting is allowed, actual practice in the industry is
+inconsistent. Developers who wish to take a more cautious
+approach to this question can disable this flag so that any attempt to
+use the operators <span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">>r</span>
+<span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">r@</span>
+and <span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">r></span>
+in the "interpreting" state will generate an <a href="#An_ERROR">ERROR</a>
+Message.<br>
+</div>
+<p style="margin-left: 40px;">
+Also, the pseudo-Flag-name <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">help</span>
+will cause a list of the Flag-names and their associated
+Special-Features to be printed.</p>
+<p style="margin-left: 40px;">
+The use of some of these flags is illustrated in <a href="#Example_2">Example
+#2</a>
+</p>
+<h3><a class="mozTocH3" name="mozTocId445349"></a><a
+ name="Tokenizer-Escape_Mode_"></a>“Tokenizer-Escape” Mode</h3>
+<p>The directive <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">tokenizer[</span>
+behaves as specified in Section C.3.1 of the IEEE-1275 Standard: it
+saves the current tokenizer numeric conversion radix, sets the radix to
+sixteen (hexadecimal) and enters “tokenizer-escape” mode.
+Likewise, the directive <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">]tokenizer</span>
+restores the radix and resumes the Tokenizer’s normal behavior.</p>
+<p>
+For convenience and compatibility with IBM's source-base, the
+directives <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">f[ </span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">f]</span>
+are synonyms for <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">tokenizer[</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">]tokenizer</span>
+respectively. In addition, the variant <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">]f</span>
+is a synonym for <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">f]</span>
+.
+</p>
+<p>The numeric conversion radix can be changed during
+“Tokenizer-Escape” mode by the use of the standard directives <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">hex
+decimal </span> and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">
+octal</span> . These will always change the numeric
+conversion radix in “tokenizer-escape” mode; even if
+“tokenizer-escape” mode was entered in the middle of a
+colon-definition, they will not issue an FCode sequence. And, as
+per the Standard, the numeric conversion radix will be restored when
+the Tokenizer returns to "Normal" mode.<br>
+</p>
+<a name="Tkz_Esc_Scope"></a>Function-names that were defined during
+normal tokenization mode will
+not be recognized in “Tokenizer-escape” mode and vice-versa. The
+one exception is that <a href="#F_B-T-B_TkzEsc"><span
+ style="font-family: courier new; font-weight: bold;">F[']</span></a> ,
+even when invoked in “Tokenizer-escape” mode, will apply to
+function-names that were defined during normal tokenization mode.<br>
+<h4 style="margin-left: 40px;"><a name="mozTocId445715"></a>The <span
+ style="font-family: courier new,courier,monospace;"><a name="emit_byte"></a>emit-byte</span>
+command
+</h4>
+<p style="margin-left: 40px;"><a name="Run-time_data_stack"></a>This
+Tokenizer supports the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">emit-byte</span>
+command as specified in the Section cited above. In order to be
+able to do that, the “tokenizer-escape” mode needs to be able to
+support a tokenization-time data stack, and, indeed, it does.<br>
+</p>
+<h4 style="margin-left: 40px;"><a name="mozTocId446081"></a>Other
+commands</h4>
+<p style="margin-left: 40px;">In
+“tokenizer-escape” mode, a string representing a number (optionally
+preceded by one of the directives <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">h#
+d#</span> or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">
+o#</span> ) causes that number to be pushed to the stack, where
+it is available for use by any of several other commands as follows:<br>
+</p>
+<h5 style="font-weight: bold; margin-left: 80px;"><big><a
+ name="mozTocId446447"></a>Standard Commands</big></h5>
+<ul style="margin-left: 120px;">
+ <li><a name="mozTocId446813"></a>The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"><a
+ name="next_fcode"></a>next-fcode</span> command </li>
+</ul>
+<div style="margin-left: 160px;">Set the value of the
+FCode-token-number
+assignment counter to the
+number
+that was on the stack. Subsequent fcode-functions defined in the
+source will be assigned FCode token numbers starting with this
+number.
+If the number supplied on the stack is outside the legal range
+specified by the IEEE-1275 Standard, the attempt will be disallowed and
+reported as an <a href="#An_ERROR">Error</a>.<br>
+<p>Note that this Tokenizer supports additional directives for <a
+ href="#Manipulate_FCode_Number">manipulating the FCode-token-number
+assignment counter</a>.<br>
+</p>
+</div>
+<h5 style="margin-left: 80px;"><big><a name="mozTocId447179"></a>Non-Standard
+operations
+</big></h5>
+<ul style="margin-left: 120px;">
+ <li><span style="font-family: courier new,courier,monospace;"><span
+ style="font-weight: bold;"><a name="Tkz_Esc_Const"></a><a
+ name="mozTocId447545"></a>constant</span>
+<Name></span><br>
+ </li>
+</ul>
+<p style="margin-left: 160px;">Define <span
+ style="font-family: courier new,courier,monospace;"><Name></span>
+as a named constant with the value that was on the stack. <span
+ style="font-family: courier new,courier,monospace;"><Name></span>
+will be known within “tokenizer-escape” mode but will not be recognized
+during normal tokenization. When <span
+ style="font-family: courier new,courier,monospace;"><Name></span>
+is invoked, its value will be pushed onto the stack. Two named
+constants are pre-defined: <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">true</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">
+false</span><br>
+</p>
+<ul
+ style="font-family: courier new,courier,monospace; margin-left: 120px;">
+ <li><a name="emit_fcode"></a><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"><a
+ name="mozTocId447911"></a>emit-fcode</span></li>
+</ul>
+<p style="margin-left: 160px;">Emit the value that was on the stack as
+an FCode token, either one or two bytes long, depending on the
+value. Report an <a href="#An_ERROR">Error</a> if the number
+supplied on the stack is
+outside the legal range
+specified by the IEEE-1275 Standard. Since this is sort of a
+"cheat", issue an <a href="#Advisories">Advisory</a> if the
+operation is successful.<br>
+</p>
+<h4 style="margin-left: 40px;"><a name="mozTocId448277"></a>Additional
+FORTH-compatible operations</h4>
+<p style="margin-left: 40px;">
+In addition to the above, “Tokenizer-escape” mode recognizes a limited
+number of FORTH-compatible named constants and operations, as follows:<br>
+</p>
+<ul style="margin-left: 40px;">
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">TRUE</span>
+Push -1 onto the stack </li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FALSE</span>
+Push 0 onto the stack</li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">0=</span>
+Invert the Boolean-flag on top of the stack: replace 0 with <span
+ style="font-family: courier new,courier,monospace;">TRUE</span>
+or
+any non-zero number with <span
+ style="font-family: courier new,courier,monospace;">FALSE</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">SWAP</span>
+Exchange top two stack items</li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">2SWAP</span>
+Exchange top two pairs of stack items</li>
+ <li><span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">noop</span>
+Take no action. </li>
+</ul>
+<p style="margin-left: 40px;">These are different from the
+corresponding words in "Normal" mode,
+which would
+compile an FCode token. In “Tokenizer-escape” mode, they initiate an
+immediate
+action within the Tokenization process.
+</p>
+<h3><a class="mozTocH3" name="mozTocId649525"></a><a name="Directives_"></a>Directives</h3>
+<p>This Tokenizer supports a number of directives that are not
+specified
+by the Standard, but which serve functions as follows:<br>
+</p>
+<ul>
+ <li><a href="#Conditional_Tokenization">Conditional Tokenization</a></li>
+ <li><a href="#The_OVERLOAD_Directive">Suspending</a> the
+Duplicate-Name
+Test for one Definition ("Overloading")</li>
+ <li>Suspending the <a href="#Allow_Multi_Line">Multi-Line Warning</a>
+for one occasion<br>
+ </li>
+ <li><a href="#mozTocId203416">Controlling the
+Scope of
+Definitions</a></li>
+ <li><a href="#Evaluating_Command-line_Symbols">Evaluation</a> of
+symbols defined on the command-line</li>
+ <li>Outputting <a href="#FLITERAL">arbitrary sequences</a> of bytes
+to the FCode binary file</li>
+ <li><a href="#ENCODE_FILE">Encoding</a> blocks of binary data taken
+from a file</li>
+ <li>Generating <a href="#Gen_Specl_Txt_Strs">Special Text-Strings</a>
+and Literals: <br>
+ </li>
+ <ul>
+ <li>The <a href="#fcode_date">current
+date or time</a>.</li>
+ <li>The <a href="#function_name">name
+of the function</a> currently
+being defined</li>
+ <li>The <a href="#Inp_Fil_Nm_Strg">Input-File Name</a> and Line
+Number <br>
+ </li>
+ </ul>
+ <li>Pre-pending <a href="#Pre_pending_PCI_Headers_to_FCode_images_">PCI
+headers</a> to FCode
+images</li>
+ <li><a href="#Modifying_PCI_Header">Modifying</a> the PCI Header<br>
+ </li>
+ <li>Changing the name of the <a href="#Binary_Output_File_Name">Binary
+Output File</a></li>
+ <li>Issuing a <a href="#User_Messages">message</a> at tokenization
+time</li>
+ <li><a href="#Changing_C-L_Flags_from_Source">Over-riding</a> the
+setting of a <a href="#Special_Feature_Flags">Special-Feature Flag</a></li>
+ <li><a href="#Displaying_C-L_Flags_from_Source">Displaying</a> the
+settings of all the <a href="#Special_Feature_Flags">Special-Feature
+Flags</a> </li>
+ <li><a href="#Manipulate_FCode_Number">Saving, Restoring and
+Resetting the
+FCode-Token-Number Assignment Counter</a> </li>
+ <li><a href="#Resetting_Symbols_Defined_in_Either_Mode">Resetting the
+symbols</a> defined either in Normal Tokenization Mode or in "Tokenizer
+Escape" mode.<br>
+ </li>
+</ul>
+<h4><a class="mozTocH4" name="mozTocId557512"></a><a
+ name="Conditional_Tokenization"></a>Conditional Tokenization</h4>
+The
+OpenBIOS Tokenizer toke supports a fully-nestable Conditional
+Tokenization capability comparable to the one in the "<big><b>C</b></big>"
+pre-processor. A
+Conditional Tokenization block consists of either one or two segments
+-- a "True" segment and an optional "False" segment -- delimited by <a
+ name="Conditional_Operators"></a>Conditional Operators of three types:<br>
+<ul>
+ <li>the <a href="#Condition_Testers">Condition-Tester</a></li>
+ <li>the optional <a href="#The_False_segment-switcher">"False"
+segment switcher</a></li>
+ <li>the <a href="#The_Conditional-block_Terminator">Conditional-block
+terminator</a></li>
+</ul>
+<p>The "True" segment immediately follows the Condition-Tester,
+and
+is ended either by the "False" segment switcher or by the
+Conditional-block terminator. If the "False" segment
+switcher is present, it introduces the "False" segment, which
+is ended by the
+Conditional-block terminator. The three delimiters (in reverse
+order) are:
+</p>
+<h5 style="margin-left: 40px;"><a class="mozTocH5" name="mozTocId686605"></a><a
+ name="The_Conditional-block_Terminator"></a><big>The Conditional-block
+Terminator</big></h5>
+<div style="margin-left: 40px;">Exit the current level of Conditional
+Tokenization.
+<p>If the
+Conditional-block in question was nested within another
+one, resume conditional processing at the
+level of the enclosing segment. When the outermost
+Conditional-block is exited, resume normal processing.<br>
+</p>
+<p>While it is a requirement that the
+Conditional-block terminator be contained within the same Input File as
+the Condition-Tester and its optional "False" segment switcher, the
+body of a Conditional Segment may contain separate <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fload</span>
+directives, which will be processed or ignored in accordance with the
+prevailing Condition. An <a href="#Example_4_Condl_FLoad">illustration</a>
+can be seen in <a href="#Example_4">Example #4</a>. </p>
+There are several synonyms for the Conditional-block terminator:<br>
+</div>
+<ul style="margin-left: 40px;">
+ <big> </big><li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[then]</span></li>
+ <big> </big><li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#then</span></li>
+ <big> </big><li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#then]</span></li>
+ <big> </big><li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[endif]</span></li>
+ <big> </big><li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#endif</span></li>
+ <big> </big><li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#endif]</span></li>
+</ul>
+<h5 style="margin-left: 40px;"><a class="mozTocH5" name="mozTocId763728"></a><a
+ name="The_False_segment-switcher"></a><big>The
+"False" segment-switcher</big></h5>
+<p style="margin-left: 40px;">Reverses the sense of the condition and
+introduces the "False"
+segment.</p>
+<p style="margin-left: 40px;">If the Condition-Test resulted in "TRUE",
+then the first segment -- the
+"True" segment -- was processed and the "False" segment will be
+ignored. Conversely, if the Condition-Test resulted in "FALSE",
+then the first segment -- the "True" segment -- was ignored and the
+"False" segment will be processed.</p>
+<p style="margin-left: 40px;">There are three synonyms for this
+function:<br>
+</p>
+<ul style="margin-left: 40px;">
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[else]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#else</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#else]</span></li>
+</ul>
+<h5 style="margin-left: 40px;"><a class="mozTocH5" name="mozTocId375310"></a><a
+ name="Condition_Testers"></a><big>Condition-Testers</big></h5>
+<div style="margin-left: 40px;">Tokenization can be controlled
+according to the following conditions:
+</div>
+<ul style="margin-left: 40px;">
+ <li>A <a href="#TrueFalse_flag_on_the_top_of_the_stack">True/False
+flag</a> on the top of the stack</li>
+ <li><a href="#Existence_or_non-existence_of_an_FCode">Existence</a>
+or non-existence of an FCode or "Tokenizer Escape"-mode
+definition</li>
+ <li><a href="#Definition_or_non-definition_of_a">Definition</a> or
+non-definition of a Command-Line symbol.</li>
+</ul>
+<h5 style="margin-left: 80px;"><a class="mozTocH5" name="mozTocId104560"></a><a
+ name="TrueFalse_flag_on_the_top_of_the_stack"></a><big>True/False flag
+on the top of the
+stack</big></h5>
+<div style="margin-left: 80px;">
+<p>A number that was placed on the stack
+in “Tokenizer-Escape” mode will be consumed and tested. If the
+number was
+non-zero, the Condition-Test will result in "TRUE", and the first
+segment -- the "True" segment -- will be processed and the "False"
+segment, if present, will be ignored. Conversely, if the number
+was zero, the Condition-Test will result in "FALSE", and the first
+segment -- the "True" segment -- will be ignored and the "False"
+segment, if present, will be processed.</p>
+<p>There is only one word for this
+function:<br>
+</p>
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[if]</span></li>
+</ul>
+The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[if]</span>
+Operator can be invoked from either "Tokenizer Escape" mode or normal
+tokenization mode, but the number to be tested must have been put on
+top of the Stack during "Tokenizer Escape" mode.
+</div>
+<h5 style="margin-left: 80px;"><a class="mozTocH5" name="mozTocId956359"></a><a
+ name="Existence_or_non-existence_of_an_FCode"></a><big>Existence or
+non-existence of an
+FCode or "Tokenizer Escape"-mode definition</big></h5>
+<p style="margin-left: 80px;">A name-string must follow the directive
+<a href="#Expected_on_same_line">on the same line</a>. A
+search for that name is conducted through the word-list of the mode --
+i.e.,
+"Tokenizer Escape" mode versus "Normal" mode -- and the <a
+ href="#Scope_Directives">Scope</a> -- i.e., "<a
+ href="#Global_Definitions">Global</a>" versus "<a
+ href="#device-node_vocabularies">Current Device-Node</a>" -- in which
+the
+Tokenizer is currently operating.</p>
+<p style="margin-left: 80px;">If the directive is for the existence of
+the definition, and the name
+is found, or if the directive is for the non-existence of the
+definition, and the name is not found, the Condition-Test will result
+in "TRUE". Otherwise, the Condition-Test results in "FALSE".</p>
+<div style="margin-left: 80px;">The synonyms for the test for <span
+ style="font-style: italic; font-weight: bold;">existence</span> of a
+definition are:<br>
+</div>
+<ul style="margin-left: 80px;">
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[ifexist]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#ifexist</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#ifexist]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[ifexists]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#ifexists</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#ifexists]</span></li>
+</ul>
+<p style="margin-left: 120px;">(Note the variants with
+and without a final '<span style="font-weight: bold;">s</span>')<br>
+</p>
+<div style="margin-left: 80px;">The synonyms for the test for <span
+ style="font-weight: bold; font-style: italic;">non-existence</span> of
+a definition are:<br>
+</div>
+<ul style="margin-left: 80px;">
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[ifnexist]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#ifnexist</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#ifnexist]</span></li>
+</ul>
+<div style="margin-left: 120px;">(Note that variants with a final '<span
+ style="font-weight: bold;">s</span>'
+didn't make sense here.)<br>
+</div>
+<h5 style="margin-left: 80px;"><a class="mozTocH5" name="mozTocId880808"></a><a
+ name="Definition_or_non-definition_of_a"></a><big>Definition or
+non-definition of a
+Command-Line Symbol</big></h5>
+<div style="margin-left: 80px;">As noted <a
+ href="#Define_Command-Line_symbol">above</a>, the Tokenizer
+recognizes the syntax<br>
+</div>
+<div style="margin-left: 120px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-d
+Symbol</span>[<span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">=Value</span>]
+<br>
+</div>
+<div style="margin-left: 80px;">as the means by which to define a
+Command-Line Symbol and optionally assign a value to it.<br>
+</div>
+<div style="margin-left: 80px;">
+<p>A pair of Condition-Tester directives
+are supported that will test, respectively, for definition or
+non-definition of a named Symbol. Their operation is similar to
+that of the Tests for existence of non-existence of a Definition, in
+that a name-string must follow the directive
+<a href="#Expected_on_same_line">on the same line</a>, but they are
+different in the matter of where the
+search for the name string is conducted: these directives search
+the list of Command-Line Symbols. The relation between the type
+of directive and the result of the search is also similar to that of
+the Tests for existence of non-existence of a Definition.</p>
+</div>
+<div style="margin-left: 80px;">The synonyms for the test for <span
+ style="font-weight: bold; font-style: italic;">definition</span> of a
+Command-Line Symbol are:<br>
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[ifdef]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#ifdef</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#ifdef]</span></li>
+</ul>
+</div>
+<div style="margin-left: 80px;">The synonyms for the test
+for <span style="font-weight: bold; font-style: italic;">non-definition</span>
+of a Command-Line Symbol are:<br>
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[ifndef]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#ifndef</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#ifndef]</span><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"></span>
+ </li>
+</ul>
+</div>
+<div style="margin-left: 80px;">The test is simply to verify the
+existence of a Symbol; it is not sensitive to
+whether or not the optional value was assigned. <br>
+</div>
+<h5 style="margin-left: 40px;"><a name="mozTocId891224"></a><a
+ name="Tracing_Conditional_State"></a><big>Tracing the state of
+Conditional
+Tokenization</big></h5>
+<div style="margin-left: 40px;">The nesting and un-nesting of
+<a href="#Conditional_Tokenization">Conditional Tokenization</a> can
+become complicated; an <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fload</span>ed
+file may contain a segment-switcher or Conditional-block terminator
+that interacts with the prevailing Condition-Tester that originated in
+another Source file, which might lead to unexpected results. To
+help trace the status of Conditional Tokenization, the User can invoke
+the <a href="#Trace_Condls"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Trace-Conditionals</span></a>
+Special-Feature Flag together with the"verbose" option ( <a
+ href="#verbose_option"><span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">-v</span></a>
+). This will cause an <a href="#Advisories">Advisory
+Message</a> to be displayed whenever a <a href="#Conditional_Operators">Conditional
+Operator</a> is
+encountered, even if it is in a segment that is already being ignored.
+The message will indicate the location of the associated <a
+ href="#Condition_Testers">Condition-Tester</a> (or the state of the
+condition, if the Conditional Operator <span
+ style="font-style: italic;">is</span> a Condition-Tester) and whether
+the segment is being Processed or being Ignored. </div>
+<br>
+<h4><a class="mozTocH4" name="mozTocId202222"></a><a
+ name="The_OVERLOAD_Directive"></a><big>Suspending
+the Duplicate-Name Test for one Definition ("Overloading")</big></h4>
+<p>When a definition is created whose name duplicates that of an
+existing definition, default behavior is to issue a <a
+ href="#A_WARNING">WARNING</a>
+notification.
+</p>
+<p>Intentionally creating such a
+duplicately-named definition is called "overloading" the name.
+This may be required, for instance, to supplant future invocations of
+the named function with a version that incorporates the earlier
+instance of the function of
+the same name and supplies additional behavior.
+</p>
+<p>When this is intentional, no warning should be issued. This
+Tokenizer
+supports a directive called <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">overload</span>
+which the User may invoke to bypass the duplicate-name test for the
+duration of only one definition that follows
+it (as contrasted with <a href="#Warn_if_Duplicate_Flag">suspending
+the test globally</a>). An illustration of its use may be seen in
+<a href="#Example_4">Example 4</a>.<br>
+</p>
+<h4><a class="mozTocH4" name="mozTocId202620"></a><a
+ name="Allow_Multi_Line"></a><big>Suspending the Multi-Line Warning
+for one occasion</big></h4>
+<p>The Standard allows Comments and Strings that extend across multiple
+lines, terminated by their specific delimiter. In addition, this
+Tokenizer allows User-generated Messages and Local-Values Declarations
+that, likewise, extend across multiple lines. Because of the
+potential for a cascade of errors that can be caused by a missing
+delimiter, this Tokenizer issues a <a href="#A_WARNING">WARNING</a>
+notification whenever such an entity is encountered. <a
+ href="#Example_5_func_nam">Example #5</a> shows an occasion where this
+might be helpful.<br>
+</p>
+<p>When this is intentional, no warning should be issued. This
+Tokenizer
+supports a directive called <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">multi-line</span>
+which the User may invoke to suppress the notification for the next
+multi-line item that follows
+it. </p>
+<h4><a class="mozTocH4" name="mozTocId203416"></a><a
+ name="Scope_Directives"></a><big>Controlling
+the Scope of Definitions</big></h4>
+<p>The User may wish to create a collection of utility functions
+that will be available to all the device-nodes in a <a
+ href="#Multiple_device_nodes">multiple-node
+driver</a>. Directly accessing such functions across device-nodes
+can
+be risky if any component uses <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+data. However, if the use of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+data is precluded, such access can be performed safely.</p>
+<p>This Tokenizer
+supports a pair of directives for setting the Scope of
+Definitions. The one called <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">global-definitions</span>
+will cause all subsequent definitions -- Aliases and Macros as well as
+FCode -- to be entered into the same vocabulary -- referred to as the
+"core" -- from which all the Standard functions are drawn. The
+other, called <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">device-definitions</span>
+, will cause the Scope of Definitions to revert to the <a
+ href="#current_device-node"><span
+ style="font-family: courier new,courier,monospace; font-style: italic;">current
+device-node</span></a>. The use of these directives is
+illustrated in
+<a href="#Example_4">Example #4</a>.<br>
+</p>
+<p>While Global Scope is in effect, the use of the word <a
+ href="#Instance_Not_Allowed"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span></a>
+will not be allowed, nor will definitions made in any device-node be
+recognized. Conversely, an attempt to enter Global Scope while <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+is in effect will be reported as an <a href="#An_ERROR">Error</a>
+condition.</p>
+<h4><a class="mozTocH4" name="mozTocId314185"></a><a
+ name="Evaluating_Command-line_Symbols"></a><big>Evaluating
+Command-line Symbols</big></h4>
+A Directive is supported that can be used to extract the <a
+ href="#Define_Command-Line_symbol">optional
+value</a> that was assigned to a Command-Line Symbol.
+<p>The Symbol name must appear <a href="#Expected_on_same_line">on the
+same line</a> as the directive.</p>
+<p>If the Symbol name is not found or no value has been assigned to it,
+a <a href="#A_WARNING">WARNING</a> will
+be issued.</p>
+Otherwise, the associated value will be interpreted as though it were
+source-code.
+<p>The synonyms for the directive to evaluate a Command-Line Symbol's
+assigned value are:<br>
+</p>
+<ul>
+ <li><span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">[defined]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#defined</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#defined]</span></li>
+</ul>
+<h4><a class="mozTocH4" name="mozTocId655967"></a><big><a
+ name="FLITERAL"></a>Outputting
+Arbitrary Byte-Sequences to
+the FCode Binary</big></h4>
+In addition to the Standard <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">emit-byte</span>
+command, this Tokenizer supports a directive called <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FLITERAL</span>
+, which will emit the number popped from the top of the Data Stack as a
+literal to the FCode Binary, as though the number were invoked during
+normal operation.
+<p>The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FLITERAL</span>
+directive can be invoked from either "Tokenizer Escape" mode or normal
+tokenization mode, but the number to be emitted must have been put on
+top of the Stack during "Tokenizer Escape" mode.</p>
+<h4><a class="mozTocH4" name="mozTocId114013"></a><big><a
+ name="ENCODE_FILE"></a>Encoding blocks of binary data taken from a
+file
+</big></h4>
+The directive <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ENCODE-FILE</span>
+takes a file-name as an argument <a href="#Expected_on_same_line">on
+the same line</a>. It translates
+the contents of the file into a series of strings interspersed
+with <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">encode-bytes</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">encode+</span>
+commands, resulting in a block of byte-encoded binary data.<br>
+<h4><a name="mozTocId69109"></a><big><a name="Gen_Specl_Txt_Strs"></a>Generating
+Special Text-Strings and Literals</big></h4>
+This Tokenizer supports a set of directives that will present a string
+or a literal
+for processing as though it were part of the Tokenization Source
+File. Except as otherwise noted, these directives may be invoked
+in either "Normal" or
+"Tokenizer-Escape" mode: in "Normal" mode, the string produced
+will be
+compiled-in as an in-line text
+string; in "Tokenizer-Escape" mode, it will be displayed as a
+User-generated <a href="#User_Messages"><span
+ style="font-weight: bold; font-style: italic;">MESSAGE</span></a>.<br>
+<br>
+<h5 style="margin-left: 40px;"><a class="mozTocH4" name="mozTocId70133"></a><big><a
+ name="fcode_date"></a>Current date or time</big></h5>
+<div style="margin-left: 40px;">The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[fcode-date]</span>
+directive produces a string that consists of the current date,
+formatted as <span
+ style="font-family: courier new,courier,monospace;">mm/dd/ccyy</span>
+.
+</div>
+<p style="margin-left: 40px;">The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[fcode-time]</span>
+directive produces a string that consists of the current time,
+formatted as <span
+ style="font-family: courier new,courier,monospace;">hh:mm:ss ZZZ</span>
+(where <span style="font-family: courier new,courier,monospace;">ZZZ</span>
+represents the local Time-Zone).<br>
+</p>
+<p style="margin-left: 40px;">An <a href="#timestamp_prop">illustration</a>
+is included in <a href="#Example_4">Example 4</a>.<br>
+</p>
+<h5 style="margin-left: 40px;"><a class="mozTocH4" name="mozTocId71157"></a><big><a
+ name="function_name"></a>Name of the Function currently
+being defined</big></h5>
+<div style="margin-left: 40px;">
+<p>The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[function-name]</span>
+directive, when invoked in "Normal" mode, produces an in-line string
+that consists of the name of the function (colon-definition) most
+recently -- or currently
+being --
+defined. It will persist until a new colon-definition is
+started.
+This can be useful for embedding interpetation-time or run-time
+debugging-statements into or after
+functions' definitions. In "Tokenizer-Escape" mode, it will
+display the
+function name in more detail as a
+User-generated <a href="#User_Messages"><span
+ style="font-weight: bold; font-style: italic;">MESSAGE</span></a>.
+<a href="#Example_5">Example 5</a> illustrates its
+use in "Normal" mode, and has a small <a href="#Example_5_func_nam">illustration</a>
+of its use in "Tokenizer-Escape" mode.
+</p>
+</div>
+<h5 style="margin-left: 40px;"><a name="mozTocId72181"></a><big><a
+ name="Inp_Fil_Nm_Strg"></a>Input-File Name and Line Number</big></h5>
+<div style="margin-left: 40px;">The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[input-file-name]</span>directive
+produces an in-line string that
+consists of the name of the current Input File.<br>
+<p>The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[line-number]</span>directive
+produces an in-line numeric literal giving the Line-Number within the
+current Input File.<br>
+</p>
+<p>These directives
+can only be invoked in "Normal" mode; they are not supported -- or
+needed -- in
+"Tokenizer-Escape" mode, because any User-generated <a
+ href="#User_Messages"><span
+ style="font-weight: bold; font-style: italic;">MESSAGE</span></a> will
+print that information. An <a href="#Example_5_func_nam">illustration</a>
+is included in <a href="#Example_5">Example 5</a>.<br>
+</p>
+</div>
+<h4><a class="mozTocH4" name="mozTocId844437"></a><big><a
+ name="Pre_pending_PCI_Headers_to_FCode_images_"></a>Pre-pending
+PCI Headers to FCode
+images</big>
+</h4>
+The directive <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">pci-header</span>
+, which can be invoked from either "Tokenizer Escape" mode or normal
+tokenization mode, will cause a PCI Header to be generated to the
+Binary Output file, in front of the FCode Binary image. It takes
+three parameters from the Data Stack: Vendor ID as the third item
+on the Stack, Device ID as the second, and Class Code as the top item
+on the Data Stack. These must be put on the Stack during
+"Tokenizer Escape" mode.
+<p>An attempt to issue the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">pci-header</span>
+directive after FCode output has begun will be reported as an <a
+ href="#An_ERROR">Error</a> condition.</p>
+<p>
+The PCI Header cannot be completed until after the FCode Binary image
+has been completely tokenized. The directive to complete the PCI
+Header should be issued at the end of the process. Synonyms for
+this directive are:
+</p>
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">pci-header-end</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">pci-end</span></li>
+</ul>
+<h4 style="font-weight: bold;"><a class="mozTocH4" name="mozTocId931658"></a><a
+ name="Modifying_PCI_Header"></a><big>Modifying the PCI
+Header</big></h4>
+Directives are supported that will alter specific fields of the PCI
+Header. They can be issued at any time before the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">pci-end</span>
+directive to specify the contents of certain fields of the PCI Data
+Structure as follows:<br>
+<ul>
+ <li>"Revision Level of the Vendor's ROM" (2 bytes at
+offset 0x12)</li>
+ <li>"Last Image Indicator" bit (High-order bit of 1 byte at offset
+0x15)</li>
+</ul>
+The syntax for these functions is:<br>
+<h5 style="margin-left: 40px;"><a class="mozTocH5" name="mozTocId504353"></a><big><a
+ name="PCI_Rev_Level"></a>"Revision
+Level of the Vendor's ROM"</big></h5>
+<div style="margin-left: 40px;">To set the "Revision Level of the
+Vendor's ROM" field of the PCI Header to the number popped from the top
+of the Data Stack, use any of these synonyms:<br>
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">set-rev-level</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">pci-revision</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">pci-code-revision</span></li>
+</ul>
+These directives can be invoked from either "Tokenizer Escape" mode or
+normal tokenization mode, but the number to be used must have been put
+on top of the Stack during "Tokenizer Escape" mode.
+<p>The default setting for this field is 1.<br>
+</p>
+<h6 style="font-weight: bold; margin-left: 40px;"><a
+ name="mozTocId503878"></a><big><a name="PCI_Rev_Level_Byte_Order"></a>Byte-Order</big></h6>
+<p style="margin-left: 40px;">Ordinarily, the "Revision Level of the
+Vendor's ROM" field of the PCI Header follows the general PCI Standard
+convention of "Little-Endian" byte-order. However, some
+organizations' legacy code saves this field in Big-Endian order.
+To
+accommodate the need for compatibility, this
+Tokenizer supports a <a href="#Special_Feature_Flags">Special-Feature
+Flag</a> called <a href="#Big_End_PCI_Rev_Level"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Big-End-PCI-Rev-Level</span></a>.
+Its default is <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">no</span>,
+i.e., to follow the PCI Standard. </p>
+<br>
+</div>
+<h5 style="margin-left: 40px;"><a class="mozTocH5" name="mozTocId53081"></a><big><a
+ name="Last_Image_Indicator_bit"></a>"Last
+Image Indicator" bit</big></h5>
+<div style="margin-left: 40px;">The "Last Image Indicator" bit can be
+specified in either of three ways:<br>
+<ul>
+ <li>Force it to be set to TRUE. Synonyms for this are:</li>
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">last-image</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">last-img</span></li>
+ </ul>
+</ul>
+<ul>
+ <li>Force it to be reset to FALSE. Synonyms for this are:</li>
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">not-last-image</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">not-last-img</span></li>
+ </ul>
+</ul>
+<ul>
+ <li>Set or reset it according to the number popped from the top
+of the Data Stack. Synonyms for this are:</li>
+ <ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">set-last-image</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">set-last-img</span></li>
+ </ul>
+</ul>
+</div>
+<div style="margin-left: 80px;">If the number was zero, the "Last Image
+Indicator" bit will be reset to FALSE; if it was non-zero, the bit will
+be set to TRUE.</div>
+<p style="margin-left: 80px;">These directives can be invoked from
+either "Tokenizer Escape"
+mode or
+normal tokenization mode, but the number to be examined must have been
+put
+on top of the Stack during "Tokenizer Escape" mode.
+</p>
+<p style="margin-left: 40px;">The default setting for this field is
+TRUE.</p>
+<h4><a class="mozTocH4" name="mozTocId410469"></a><big><a
+ name="Binary_Output_File_Name"></a>Changing the name of the
+Binary Output File</big></h4>
+<p><a name="Binary_Output_File_Name_Default"></a>By default, the name
+of the Binary Output File is derived from the
+name
+of the Source Input File, by replacing its extension with <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">.fc</span>
+, or, if the Input File name had no extension, merely appending
+the
+extension <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">.fc</span></p>
+<p>
+The name of the Binary Output File may be specified on the Command
+Line, as noted <a href="#Binary_Output_Name_option">above</a>.</p>
+<p><a name="Binary_Output_File_Name_Directive"></a>
+The name of the Binary Output File may also be specified by a directive
+embedded within the Tokenization Source File. Synonyms for the
+directive are <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">save-image</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">save-img</span>
+; the name follows after the directive <a href="#Expected_on_same_line">on
+the same line</a>.<br>
+</p>
+<p>The directive can be invoked from either "Tokenizer Escape" mode or
+normal tokenization mode. It does not cause an imediate action (i.e.,
+saving the Binary Image), but merely alters the name of the file to
+which the image will be saved when tokenization is completed.<br>
+</p>
+<p>Note that this directive does not change the name of the <a
+ href="#FLoad_List_option">FLoad-List File</a>, if one has been
+specified.
+</p>
+<h4><a class="mozTocH4" name="mozTocId982642"></a><big><a
+ name="User_Messages"></a>Issuing messages at Tokenization
+time.</big></h4>
+Directives are supported that will gather text and output it as a
+User-generated <span style="font-weight: bold; font-style: italic;">MESSAGE</span>
+during
+Tokenization.
+<p>These directives can be invoked from either "Tokenizer
+Escape" mode or normal tokenization mode:</p>
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#MESSAGE"</span>
+will parse text in <a href="#String_Gathering_Features">string-collection
+mode</a>, i.e., with
+sensitivity to the special escaped-characters, until a concluding
+Quote-followed-by-whitespace,</li>
+</ul>
+<div style="margin-left: 40px;">and the synonyms:
+</div>
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[MESSAGE]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#MESSAGE</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#MESSAGE]</span></li>
+</ul>
+<div style="margin-left: 40px;">will gather the text remaining on the
+line.
+</div>
+<p>In addition, the commands <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">."</span>
+(Dot-Quote) and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">.(</span>
+(Dot-Paren), which have Standard meanings in normal tokenization
+mode, will, when invoked in
+"Tokenizer Escape" mode,
+collect text in their Standard manner and output it as a User-generated
+<span style="font-weight: bold; font-style: italic;">MESSAGE</span>:</p>
+<ul>
+ <li>Dot-Quote will parse text in <a href="#String_Gathering_Features">string-collection
+mode</a>,</li>
+ <li>Dot-Paren will collect text until a
+balancing Close-Paren -- <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">)</span>
+-- character.</li>
+</ul>
+<p>Also, as noted earlier, the <a href="#fcode_date"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[fcode-date]</span></a>
+and <a href="#fcode_date"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[fcode-time]</span></a>
+directives, when invoked in
+"Tokenizer Escape" mode, will display the current date and time,
+respectively, as a User-generated
+<span style="font-weight: bold; font-style: italic;">MESSAGE</span>: </p>
+<h4><a class="mozTocH4" name="mozTocId550942"></a><big><a
+ name="Changing_C-L_Flags_from_Source"></a>Changing Special-Feature
+Flags
+from Source</big></h4>
+A directive is supported that can be used from within the Tokenization
+Source File to over-ride the setting of any one of the <a
+ href="#Special_Feature_Flags">Special-Feature
+Flags</a> that might have been made from the Command Line. The
+name of the Flag -- with, of course, an optional leading <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">No</span>
+-- must follow after the directive <a href="#Expected_on_same_line">on
+the same line</a>. It can be
+invoked from either "Tokenizer Escape" mode or normal tokenization
+mode. Its synonyms are:
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[FLAG]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#FLAG</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#FLAG]</span></li>
+</ul>
+<p>The User is hereby admonished to exercise caution when using this
+directive. Not all combinations are meaningful, and automated
+error-checking is not feasible. An <a href="#Advisories">Advisory
+Message</a> will
+be issued to remind the User of the change.<br>
+</p>
+<h5 style="margin-left: 40px;"><a class="mozTocH5" name="mozTocId551846"></a><big><a
+ name="Displaying_C-L_Flags_from_Source"></a>Displaying
+Special-Feature Flags from Source</big></h5>
+<div style="margin-left: 40px;">A directive is supported that can be
+used from within the Tokenization
+Source File to display a <a href="#User_Messages"><span
+ style="font-weight: bold; font-style: italic;">MESSAGE</span></a> with
+a list of the settings of all of the Special-Feature Flags. Its
+synonyms are:
+</div>
+<div style="margin-left: 40px;">
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[FLAGS]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">#FLAGS</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[#FLAGS]</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">SHOW-FLAGS</span></li>
+</ul>
+</div>
+<h4><a class="mozTocH4" name="mozTocId573280"></a><big><a
+ name="Manipulate_FCode_Number"></a>Manipulating the
+FCode-Token-Number Assignment Counter</big></h4>
+In addition to the Standard <a href="#next_fcode"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">next-fcode</span></a>
+command, this Tokenizer supports additional directives that can be used
+to
+alter the normal sequence of FCode-token-number assignment.<br>
+<p>In order to protect against unintended collisions in FCode-token
+numbers, which can cause severe
+errors at run-time, this Tokenizer will report an <a href="#An_ERROR">Error</a>
+the first time
+an FCode-number assignment overlaps FCodes that were assigned in a
+different range.<br>
+</p>
+<p>Because the programmer may choose to "recycle" FCode-token-numbers
+intentionally, a directive is supported that clears the records of
+FCode-number assignments and resets the FCode-token-number assignment
+counter to its inital value. </p>
+<h5 style="margin-left: 40px;"><big><a name="mozTocId566072"></a>Saving
+and Restoring</big></h5>
+<div style="margin-left: 40px;">
+The directive <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FCode-Push</span>
+can be used to save the value of the FCode-token-number assignment
+counter on the <a href="#Run-time_data_stack">tokenization-time
+data
+stack</a> . Later, the saved value can be restored by invoking
+the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FCode-Pop</span>
+directive. Note that <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FCode-Pop</span>
+is functionally equivalent to <a href="#next_fcode"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">next-fcode</span></a>
+except that <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FCode-Push</span>
+ and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FCode-Pop</span>
+can be invoked from either "Tokenizer Escape" mode or "Normal" mode.</div>
+<h5 style="margin-left: 40px;"><big><a name="mozTocId568474"></a>Resetting</big></h5>
+<div style="margin-left: 40px;">
+The directive <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FCode-Reset</span>
+will re-initalize the value of the FCode-token-number assignment
+counter and clear the records of previous FCode-number
+assignments. Note that it is not equivalent to:<br>
+<p style="margin-left: 40px;"><span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">F[</span>
+ <span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">h#
+800 next-fcode</span>
+ <span
+ style="font-weight: bold; font-family: courier new,courier,monospace;">F]</span></p>
+which merely re-initalizes the value of the FCode-token-number
+assignment counter, but does not prevent the first assignment of this
+FCode-number from being regarded as overlapping an earlier
+assignment and therefore being reported as an <a href="#An_ERROR">Error</a>.<br>
+<p>The FCode-token-number assignment
+counter and the records of previous FCode-number assignments will also
+be automatically re-initalized when a <a href="#Multiple_PCI_Image">new
+PCI-Image</a> block is started.<br>
+</p>
+</div>
+<h4><a class="mozTocH4" name="mozTocId575686"></a><big>Resetting
+Symbols Defined in Either Mode</big></h4>
+Symbol names defined in "Normal" mode persist until a <a
+ href="#Multiple_device_nodes">device-node is finished</a>, or until
+the end of an FCode-block or of a PCI Image.<br>
+<p>Symbol names defined in "Tokenizer Escape" mode persist throughout
+the entire run of the Tokenizer. </p>
+The directive <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Reset-Symbols</span>
+enables the User to delete symbol-definitions at any other time, should
+that be required. <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Reset-Symbols</span>
+is sensitive to the the mode in which the Tokenizer is operating:
+invoked during "Tokenizer Escape" mode, it will cause only the
+definitions made under "Tokenizer Escape" mode to be deleted; during
+"Normal" mode, only those made under "Normal" mode. <a
+ href="#Example_1">Example
+#1</a> contains an invocation in "Tokenizer Escape" mode.<br>
+<br>
+<h3><a class="mozTocH3" name="mozTocId957252"></a><a
+ name="Non-standard_input_syntaxes_"></a>Non-standard input,
+syntaxes, and behavior<br>
+</h3>
+<p>In this section, we will discuss:<br>
+</p>
+<ul>
+ <li>This Tokenizer's handling of conditions the Standard calls
+"ambiguous"</li>
+ <li>Non-Standard synonyms for Standard functions</li>
+ <li>Non-Standard functions or behaviors that are supported by this
+Tokenizer.</li>
+ <li>Featured behaviors, supported by this Tokenizer, that are not
+mentioned in the Standard. </li>
+</ul>
+<h4 style="margin-left: 40px;"><a class="mozTocH4" name="mozTocId850914"></a>Ambiguous
+Conditions</h4>
+<div style="margin-left: 80px;">The Standard only identifies a few
+questionable combinations as "ambiguous conditions" or "behavior ...
+unspecified" and leaves their
+handling open to interpretation of the implementor. Here's how
+this Tokenizer handles them:<br>
+</div>
+<div style="margin-left: 40px;">
+<h5 style="margin-left: 40px;"><a class="mozTocH5" name="mozTocId162252"></a><big><a
+ name="Expected_on_same_line"></a>Tokens
+expected on the same
+line</big></h5>
+<p style="margin-left: 40px;">Certain commands and directives expect a
+token to appear on the same line, and will report an <a
+ href="#An_ERROR">Error</a> condition if no
+token appears on the same line:</p>
+<ul>
+ <ul>
+ <li>The <a href="#The_h_d_and_o_directives_"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">h#</span>
+ <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">d#</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">o#</span></a>
+directives, and the <a href="#Char_Seq_To_Num">a#</a> and <a
+ href="#Char_to_Num_Left_Justified">al#</a>
+directives.<br>
+ </li>
+ <li>The <a
+ href="#Existence_or_non-existence_of_an_FCode"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[ifexist]</span>
+ <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[ifnexist]</span></a>
+ <a href="#Definition_or_non-definition_of_a"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[ifdef]</span>
+ <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[ifndef]</span></a>
+and <a href="#Evaluating_Command-line_Symbols"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[defined]</span></a>
+directives and all their synonyms</li>
+ <li>The commands <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[']</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">'</span>
+ <br>
+ </li>
+ <li>The <a href="#F_Eff-Bracket-Tick-Bracket"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">F[']</span></a>
+directive</li>
+ <li>The <a href="#Alias"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ALIAS</span></a>
+directive (expects two tokens on the same line)</li>
+ <li>The <a href="#Macros"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[macro]</span></a>
+directive (expects at least two tokens on the same line) </li>
+ <li>The directives <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">control
+ascii </span><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">char</span><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">
+ </span>and<span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">
+[char]</span></li>
+ <li>The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FLOAD</span>
+command</li>
+ <li>The <a href="#Binary_Output_File_Name"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">SAVE-IMAGE</span></a>
+directive</li>
+ <li>The <a href="#Changing_C-L_Flags_from_Source"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[FLAG]</span></a>
+directive and its synonyms <br>
+ </li>
+ <li>The <a href="#ENCODE_FILE"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ENCODE-FILE</span></a>
+directive </li>
+ </ul>
+</ul>
+</div>
+<h5 style="margin-left: 40px;"><a class="mozTocH5" name="mozTocId246601"></a><a
+ name="The_h_d_and_o_directives_"></a><big>The
+<span style="font-family: courier new,courier,monospace;">h#</span>
+<span style="font-family: courier new,courier,monospace;">d#</span> and
+<span style="font-family: courier new,courier,monospace;">o#</span>
+directives</big></h5>
+<div style="margin-left: 40px;">The directives <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">h#
+d# </span>and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">o#</span>
+convert the token immediately following to a
+number, in hex, decimal or
+octal, respectively.
+<p>If the token is present, but cannot be converted to a number using
+the
+appropriate radix, i.e., if the conversion fails, the
+Tokenizer will issue a <a href="#A_WARNING">WARNING</a>,
+ignore the directive and attempt to
+process the token
+as ordinary input. If the name is not
+known, the "ordinary processing" will catch the error.</p>
+</div>
+<h5 style="margin-left: 40px;"><a class="mozTocH5" name="mozTocId978546"></a><big>The
+commands <span
+ style="font-family: courier new,courier,monospace;">leave</span>
+<span style="font-family: courier new,courier,monospace;">?leave</span>
+or <span style="font-family: courier new,courier,monospace;">unloop</span>
+outside of a loop-control framework</big></h5>
+<div style="margin-left: 40px;">The Standard only speaks briefly about
+the execution consequences of this condition, and says nothing about
+whether a Tokenizer should permit such a sequence. This Tokenizer will
+report it as an <a href="#An_ERROR">Error</a>
+condition.
+</div>
+<h5 style="margin-left: 40px;"><a class="mozTocH5" name="mozTocId73206"></a><big>The
+commands <span
+ style="font-family: courier new,courier,monospace;">[']</span>
+or <span style="font-family: courier new,courier,monospace;">'</span>
+followed by a name that is not a valid target</big></h5>
+<div style="margin-left: 40px;">Valid targets for the commands <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[']</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">'</span>
+are function-names that were defined during normal tokenization
+mode.
+This Tokenizer reports an <a href="#An_ERROR">Error</a>
+if the name following the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[']</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">'</span>
+is not a valid target (e.g., is the name of a macro). It will
+then
+attempt to
+process the name in the ordinary manner.</div>
+<h5 style="margin-left: 40px;"><big><a class="mozTocH5"
+ name="mozTocId74410"></a>The Forth word <span
+ style="font-family: courier new,courier,monospace;">to</span>
+followed by a name that is not a valid target</big></h5>
+<div style="margin-left: 40px;">The Standard specifies the Forth word <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">to</span>
+as the means for setting the value of a word defined with either the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">value</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">defer</span>
+defining-words, but says nothing about how a Tokenizer should respond
+to attempts to apply it to other targets. This
+Tokenizer reports an <a href="#An_ERROR">Error</a>
+if the name following the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">to</span>
+is not a valid target (e.g., is the name of a macro or a
+colon-definition).
+<p>An exception is made for a word defined as a <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">variable</span>
+: Although such words are not a valid target for <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">to</span>,
+many platforms' firmware will execute the sequence correctly; this
+Tokenizer will issue a <a href="A_WARNING">WARNING</a>.</p>
+</div>
+<h5 style="margin-left: 40px;"><big><a class="mozTocH5"
+ name="mozTocId75614"></a><a name="Instance"></a>The
+word <span style="font-family: courier new,courier,monospace;">instance</span></big>
+</h5>
+<h6 style="font-weight: bold; margin-left: 80px;"><big><a
+ name="mozTocId76818"></a>Followed by an inapplicable
+defining-word</big></h6>
+<div style="margin-left: 80px;">The Standard implies (but does not
+state) that,
+once <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+has been executed, it remains in effect until an applicable
+defining-word ( <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">value</span>
+, <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">variable</span>
+, <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">defer</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">buffer:</span>
+)
+is encountered. For example, in the sequence:
+<p style="font-family: courier new,courier,monospace;"><span
+ style="font-weight: bold;">instance</span> <span
+ style="font-weight: bold;">:</span> <span>nonsense</span> <span
+ style="font-weight: bold;">dup</span> <span style="font-weight: bold;">swap</span>
+<span style="font-weight: bold;">drop</span> <span
+ style="font-weight: bold;">;</span><br>
+<span style="font-weight: bold;">variable</span> boombah</p>
+<p>the colon-definition of <span
+ style="font-family: courier new,courier,monospace;">nonsense</span> is
+unaffected by the occurrence of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+, which will, instead, be applied to the defining-word <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">variable</span>
+(which defines <span
+ style="font-family: courier new,courier,monospace;">boombah</span> )
+on a later line.
+</p>
+<p>Since <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+would typically be followed immediately by the defining-word
+to which it is intended to apply, a sequence like the above can
+reasonably be presumed to be a likely error. This Tokenizer will
+issue
+a <a href="A_WARNING">WARNING</a> when an
+inapplicable
+defining-word is encountered while <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+is in effect, and another WARNING when the dangling <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+is finally applied to a valid definer.
+</p>
+</div>
+<h6 style="margin-left: 80px;"><big><a name="mozTocId78022"></a>Left
+unresolved</big></h6>
+<div style="margin-left: 80px;">Multiple occurrences of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+are not cumulative; if a second <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+is encountered before the first is applied, only one occurrence of an
+applicable defining-word will be modified. This Tokenizer will
+issue a <a href="#A_WARNING">WARNING</a> when
+a second occurrence of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+is encountered before the first has been applied. </div>
+<div style="margin-left: 80px;">
+<p>The Standard says nothing about what
+should occur
+if <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+has not been applied by the time a device-node is "<span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">finish</span>"ed
+or a new device-node
+is started. In most Platforms' implementations of the FCode
+Interpreter, the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+state will remain in effect. This Tokenizer will issue a WARNING
+the first time a device-node
+is changed while an <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+remains unresolved.<br>
+</p>
+</div>
+<h6 style="margin-left: 80px;"><a name="mozTocId79226"></a><big><a
+ name="Instance_Not_Allowed"></a>Not
+Allowed in...</big></h6>
+<div style="margin-left: 80px;">
+Although the Standard says nothing about the subject, an inclusion
+of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+inside
+a Colon-definition would serve no purpose and is <a
+ href="#INSTANCE_at_run_time">potentially harmful</a>; <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+should not be allowed in a Colon-definition. This Tokenizer will
+detect an attempt to compile <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+into
+a Colon-definition and report it as an <a href="#An_ERROR">Error</a>
+condition.
+<p>Also, <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+can not be allowed when <a href="#Global_Definitions">Global Scope</a>
+is in effect, as <a href="#INSTANCE_at_run_time">explained elsewhere</a>.<br>
+</p>
+</div>
+<h5 style="margin-left: 40px;"><a class="mozTocH5" name="mozTocId884280"></a><big>The
+command <span style="font-family: courier new,courier,monospace;">fload</span>
+inside a colon-definition</big></h5>
+<div style="margin-left: 40px;">If the command <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fload</span>
+is encountered while a colon-definition
+is in progress, this Tokenizer will process it immediately, and read
+the contents of
+the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fload</span>ed
+file as a continuation of Source input. </div>
+<h4 style="margin-left: 40px;"><a class="mozTocH4" name="mozTocId901662"></a>Non-Standard
+Synonyms for Standard
+Functions</h4>
+<div style="margin-left: 40px;">This Tokenizer accepts the following
+non-Standard words as synonyms for the Standard words, as listed:<br>
+<ul>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ENDIF</span>
+as a synonym for <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">THEN</span></li>
+ <li><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">NAME</span>
+as a synonym for <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">DEVICE-NAME</span></li>
+</ul>
+</div>
+<h4 style="margin-left: 40px;"><a class="mozTocH4" name="mozTocId732819"></a>Non-Standard
+Functions or behaviors</h4>
+<div style="margin-left: 40px;">This section will discuss features
+supported by this Tokenizer that extend capabilities regarded by the
+Standard as unsupportable, or that are left only vaguely specified as
+"implementation-dependent".
+It will also present a few minor items that are introduced as
+conveniences for the User.<br>
+</div>
+<h5 style="margin-left: 80px;"><a class="mozTocH5" name="mozTocId522750"></a><a
+ name="Alias"></a><big>Alias</big></h5>
+<p style="margin-left: 80px;">In normal tokenization mode the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">alias</span>
+directive behaves as specified in the Standard, i.e., it creates a new
+command with the exact behavior of an existing command. Any occurrence
+of the new command will cause the assigned FCode of the old command to
+be generated, with all the implications that follow from that.</p>
+<p style="margin-left: 80px;">The Standard, further, states that:
+"In FCode source, <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">alias</span>
+cannot be called from within a colon definition." However, this
+Tokenizer can handle that, and issues a <a href="#A_WARNING">WARNING</a>
+message when it
+does so.</p>
+<p style="margin-left: 80px;">The Standard does not specify the
+behavior of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">alias</span>
+in "Tokenizer Escape" mode. This
+Tokenizer will allow <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">alias</span>
+commands issued in "Tokenizer Escape" mode to take effect in that mode,
+and, furthermore, aliases to words that are recognized in either mode
+may be created in either mode and will be recognized in either mode.<br>
+</p>
+<p style="margin-left: 80px;">Generally speaking, an alias definition
+will take on the <a href="#Scope_Directives">Scope</a> that is current
+at the time it is made: If Device Scope is in effect, the new
+name -- even if it is an alias to a word that has <a
+ href="#Global_Definitions">Global scope</a> -- will only be accessible
+from the <span
+ style="font-family: courier new,courier,monospace; font-style: italic;">current
+device-node</span>. An <a href="#Advisories">ADVISORY</a>
+message will be issued for this condition.
+</p>
+<h5 style="margin-left: 80px;"><a class="mozTocH5" name="mozTocId824541"></a><a
+ name="String_Gathering_Features"></a>
+<big>String-Escape characters and other String-Gathering Features</big></h5>
+<div style="margin-left: 80px;">The Standard specifies, in effect, that
+a string is terminated by a double-quote (the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"</span>
+character) when it is immediately followed by whitespace; that if the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"</span>
+is followed by an open-parenthesis, hex-sequence parsing begins until a
+close-parenthesis is found; and that if the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"</span>
+is followed by any other character, "the result is
+implementation-dependent".<br>
+<h6 style="margin-left: 40px;"><big><a class="mozTocH5"
+ name="mozTocId945290"></a>Quoted
+String-Escape Characters</big></h6>
+<p style="margin-left: 40px;">Common practice -- widely enough used as
+to merit consideration as an undocumented de-facto standard -- has been
+to recognize a set of letters and to translate them into special
+characters when they immediately follow the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"</span>
+.<br>
+</p>
+<p style="margin-left: 40px;">This
+Tokenizer translates String-Escape Quoted-pairs as follows:
+</p>
+<p style="margin-left: 60px;">
+<table style="text-align: left; width: 100%;" border="0" cellpadding="1"
+ cellspacing="4">
+ <tbody>
+ <tr>
+ <td style="vertical-align: top; text-align: left; width: 105px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"n</span>
+ </td>
+ <td style="vertical-align: top;">New-Line </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; text-align: left; width: 105px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"l</span></td>
+ <td style="vertical-align: top;">New-Line</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; text-align: left; width: 105px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"r</span></td>
+ <td style="vertical-align: top;">Carriage-Return</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; text-align: left; width: 105px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"t</span></td>
+ <td style="vertical-align: top;">Horizontal Tab</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; text-align: left; width: 105px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"f</span></td>
+ <td style="vertical-align: top;">Form-Feed</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; text-align: left; width: 105px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"b</span></td>
+ <td style="vertical-align: top;">Backspace</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; text-align: left; width: 105px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"!</span></td>
+ <td style="vertical-align: top;">Bell</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; text-align: left; width: 105px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"<span
+ style="font-style: italic;">^</span></span><span
+ style="font-family: arial; font-style: italic;">L</span></td>
+ <td style="vertical-align: top;">Quote-Caret followed by a letter
+is
+translated as "Control"-<span
+ style="font-family: arial; font-style: italic;">the-letter</span>.</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; text-align: left; width: 105px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"</span><span
+ style="font-family: arial; font-style: italic;">Other</span></td>
+ <td style="vertical-align: top;">Any unrecognized character
+following the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"</span>
+
+is taken verbatim.<br>
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">""</span></td>
+ <td style="vertical-align: top;">The way to embed a double-quote
+into a string is to
+escape it with itself. (This is a special instance of the
+preceding rule)<br>
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; text-align: left; width: 105px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"(</span></td>
+ <td style="vertical-align: top;">As was mentioned above,
+Quote-Open-Parenthesis begins parsing a hex-sequence as per Section A.2
+of the
+Standard under the description of the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"</span>
+operator. Details will be discussed <a href="#Hex_Seq_Procg">below</a>.<br>
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; text-align: left; width: 105px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"\<a
+ name="SFeat_Str_Rem_Esc"></a></span></td>
+ <td style="vertical-align: top;">Quote-Backslash permits
+insertion of remarks into the middle of a string definition; it will
+interrupt
+string parsing, causing the remainder of
+the line, together with any whitespace that might begin the new line,
+to be ignored.
+ <p>Because this feature is not in usual
+practice, the User can disable it by invoking the <a
+ href="#SF_Flag_Str_Rem_Esc"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">noString-remark-escape</span></a> <a
+ href="#Special_Feature_Flags"> Special-Feature
+Flag</a>.</p>
+ <p>If this feature is disabled, the Backslash following the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"</span>
+
+will be taken verbatim; the Backslash, the text following it on the
+remainder of the line, the new-line and the whitespace on the next line
+-- all of which would otherwise have been ignored -- will be included
+in the
+string parsing and incorporated into the result. </p>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</p>
+</div>
+<div style="margin-left: 120px;">
+<h6><big><a class="mozTocH5" name="mozTocId758170"></a>Embedded
+New-Lines</big></h6>
+<p>The Standard makes no mention about what to do when a string reaches
+a new-line before its termination. This
+Tokenizer continues parsing and includes the new-line, together with
+any whitespace that might begin the new line, in the result.<br>
+</p>
+<h6><big><a class="mozTocH5" name="mozTocId42456"></a><a
+ name="Hex_Seq_Procg"></a>Hex-Sequence
+Processing</big></h6>
+The Standard mentions parsing hexadecimal characters in pairs in the
+substring between <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"(</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">)</span>
+but makes no mention of what to do when a single hexadecimal character
+appears between nonhexadecimal characters. The usual practice is
+to treat it as representing the low-order digit of a single byte, and
+this Tokenizer follows that convention.<br>
+<p><a name="SFeat_Hex_Rem_Esc"></a>This Tokenizer also supports
+an option -- not in usual practice,
+hence listed separately here -- that permits insertion of remarks in
+the middle of a hex-sequence in a string. The occurrence of a
+single <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">\</span>
+(backslash) character will interrupt hex-sequence parsing, causing the
+remainder of the line,
+together with any whitespace that might begin the next line, to be
+ignored. The User can disable this feature by invoking the <a
+ href="#SF_Flag_Hex_Rem_Esc"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">noHex-remark-escape</span></a> <a
+ href="#Special_Feature_Flags"> Special-Feature
+Flag</a>.<br>
+</p>
+<p>If the Hex-Remark-Escape feature is disabled, the Backslash will be
+treated as an ordinary nonhexadecimal character, and Hex-Sequence
+parsing will proceed. Any hexadecimal characters on the
+remainder of the line -- which would otherwise have been ignored
+-- will be recognized and incorporated into the result. </p>
+<h6><big><a class="mozTocH5" name="mozTocId150131"></a><a
+ name="C-Style_String-Escape_Characters"></a><big>C</big>-Style
+String-Escape Characters</big></h6>
+In addition to the Quoted String-Escape sequences, this
+Tokenizer recognizes a small subset of the Backslash-based
+String-Escape
+pairs that are used in <big><b>C</b></big> and translates them
+similarly.
+<p>Specifically, <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">\n</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">\t</span>
+are translated into New-Line and Horizontal Tab respectively.</p>
+<p><a name="SFeat_BS_xx"></a>If the Backslash is followed by other
+characters, the
+Tokenizer will attempt to read them as a digit-string, using the
+current base, and create a numeric byte. The numeric sequence ends with
+the first non-numeric character (which is treated as a delimiter and
+consumed, unless it's a double-quote, in which case it's allowed to
+terminate the string or apply whatever action is triggered by the
+character following it). If the value represented by the numeric
+sequence exceeds
+the size of a byte, its low-order byte will be used and a <a
+ href="#A_WARNING">WARNING</a> will
+be issued.
+</p>
+<p>If the first character after the backslash was non-numeric, the
+character will be used literally (and a WARNING will be issued).
+As in <big><b>C</b></big>, the backslash can be used to escape itself.
+</p>
+</div>
+<p style="margin-left: 120px;">The User can disable this feature by
+invoking the <a href="#SF_Flag_C_Str_Esc"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">noC-Style-string-escape</span></a>
+<a href="#Special_Feature_Flags">Special-Feature
+Flag</a>.
+</p>
+<h5 style="margin-left: 80px;"><a class="mozTocH5" name="mozTocId40998"></a><big><a
+ name="SFeat_AB_Q"></a>The <big><span
+ style="font-family: courier new,courier,monospace;">ABORT"</span></big>
+(Abort-Quote) command<br>
+</big></h5>
+<div style="margin-left: 80px;">The Standard is not very clear about
+the use of this FORTH command, and does not assign it an FCode.
+Nonetheless, it has historically been treated as a macro, and this
+Tokenizer will support that treatment.<br>
+<p><a name="SFeat_Sun_AB_Q"></a>To complicate matters, there are two
+distinct styles in which this
+macro is used in FCode drivers, "Apple" style and "Sun" style:<br>
+</p>
+<p>In Sun Style, the sequence, in the Source, would look like this:<br>
+</p>
+<p style="margin-left: 40px;"><span
+ style="font-family: courier new,courier,monospace;"><span
+ style="font-style: italic;"><Condition></span> <span
+ style="font-weight: bold;">ABORT"</span> <span
+ style="font-style: italic;">Message text</span><span
+ style="font-weight: bold;">"</span></span></p>
+<p>Semantically, it would mean that if the <span
+ style="font-family: courier new,courier,monospace; font-style: italic;"><Condition></span>
+is true, the <span
+ style="font-family: courier new,courier,monospace; font-style: italic;">Message
+text</span> would be printed and a <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-2
+THROW</span> would be performed; conversely, if the <span
+ style="font-family: courier new,courier,monospace; font-style: italic;"><Condition></span>
+is false, the <span
+ style="font-family: courier new,courier,monospace; font-style: italic;">Message
+text</span> would be bypassed and execution would continue with
+the next token after.
+</p>
+<p>The sequence could be translated into FCode as a macro like this:</p>
+<div style="margin-left: 40px;"><span
+ style="font-family: courier new,courier,monospace;"><span
+ style="font-style: italic;"><Condition></span> <span
+ style="font-weight: bold;">IF</span> <span style="font-weight: bold;">"</span>
+<span style="font-style: italic;">Message text</span><span
+ style="font-weight: bold;">" TYPE</span> <span
+ style="font-weight: bold;">-2 THROW</span>
+<span style="font-weight: bold;">THEN</span></span><br>
+</div>
+<p>In Apple Style, the Source supplies the surrounding <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">IF</span>
+... <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">THEN</span>
+. The action of the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT"</span>
+command is to leave
+the <span
+ style="font-family: courier new,courier,monospace; font-style: italic;">Message
+text</span> on the stack and perform the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-2
+THROW</span> unconditionally, with the expectation that the system <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">CATCH</span>
+will print the string
+it finds on the stack. <br>
+</p>
+<p>The Source sequence would look like this:<br>
+</p>
+<p style="margin-left: 40px;"><span
+ style="font-family: courier new,courier,monospace;"><span
+ style="font-style: italic;"><Condition></span> <span
+ style="font-weight: bold;">IF</span> <span style="font-weight: bold;">ABORT"</span>
+<span style="font-style: italic;">Message text</span><span
+ style="font-weight: bold;">" </span><span style="font-weight: bold;">THEN</span></span><br>
+</p>
+<p>The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT"</span>
+...
+<span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">"</span>
+portion of the
+sequence would be translated into FCode as a macro like this:</p>
+<div style="margin-left: 40px;"><span
+ style="font-family: courier new,courier,monospace;"><span
+ style="font-weight: bold;">"</span> <span style="font-style: italic;">Message
+text</span><span style="font-weight: bold;">"</span> <span
+ style="font-weight: bold;">-2 THROW
+</span></span><br>
+</div>
+<p>Because the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT"</span>
+command is not specified in the Standard, the User can disable it by
+invoking the <a href="#SF_Flag_AB_Q"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">noABORT-Quote</span></a>
+<a href="#Special_Feature_Flags">Special-Feature
+Flag</a>.
+</p>
+<p>The User who chooses to enable this feature, can, further, select to
+disable "Sun" style in favor of "Apple" style by invoking the <a
+ href="#SF_Flag_Sun_AB_Q"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">noSun-ABORT-Quote</span></a>
+<a href="#Special_Feature_Flags">Special-Feature
+Flag</a>.<br>
+</p>
+<p><a name="Abort_Quote_Abort"></a>And to complicate matters even
+further, some Legacy applications prefer to use the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT</span>
+command (note there's no quote) in place of the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-2
+THROW</span> sequence. Although the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT</span>
+command is not recommended, it <span style="font-style: italic;">is</span>
+a legitimate FCode function, and this Tokenizer supports a <a
+ href="#Special_Feature_Flags">Special-Feature
+Flag</a>, called <a href="#SF_Flag_AB_Q_Throw">Abort-Quote-Throw</a>,
+which controls whether an <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT"</span>
+(Abort-Quote) phrase will be tokenized with the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">-2
+THROW</span> sequence or with the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT</span>
+function. The User who chooses to have <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT"</span>
+(Abort-Quote) phrases tokenized with the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT</span>
+function can do so by invoking <a href="#SF_Flag_AB_Q_Throw">noAbort-Quote-Throw</a>
+</p>
+</div>
+<h5 style="margin-left: 80px;"><a name="mozTocId526780"></a><big><a
+ name="Char_Seq_To_Num"></a>Conveniently Convert Short
+Character-Sequence to Number</big><br>
+</h5>
+<p style="margin-left: 80px;">Occasionally, a User needs to create a
+numeric constant whose value corresponds to a short sequence of
+characters. For instance, <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">PCIR</span>
+will get coded as <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">h#
+50434952</span>. This tokenizer supports a convenient directive
+called <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">a#</span>
+, syntactically similar to <a href="#The_h_d_and_o_directives_"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">h#
+d# </span>and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">o#</span></a>
+, which makes the conversion directly. The above example can be
+written: <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">a#
+PCIR</span> , sparing the programmer -- and the maintainer -- from
+needing to translate ASCII on the fly.<br>
+</p>
+<p style="margin-left: 80px;">The <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">a#</span>
+operator expects
+its target argument <a href="#Expected_on_same_line">on the same line</a>.<br>
+</p>
+<p style="margin-left: 80px;">If the target-sequence contains more than
+four characters, the last four will become the number; if the
+target-sequence contains fewer than four characters, they will
+fill the low-order part of the number. (I.e., the operation
+of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">a#</span>
+is right-justified.) Thus:<br>
+</p>
+<div style="margin-left: 160px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">a#
+CPU</span>
+ is equivalent to
+
+ <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">h#
+00435055</span>
+</div>
+<div style="margin-left: 120px;"> and
+</div>
+<div style="margin-left: 160px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">a#
+LotsOfStuff</span> is equivalent to <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">a#
+tuff</span> or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">h#
+74756666</span></div>
+<p style="margin-left: 80px;">Also, the conversion is case-sensitive:
+ <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">a#
+cpu</span> is equivalent to <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">h#
+00637075</span></p>
+<h6 style="margin-left: 120px;"><a class="mozTocH5" name="mozTocId53626"></a><big><a
+ name="Char_to_Num_Left_Justified"></a>Left-Justified</big></h6>
+<div style="margin-left: 120px;">To accommodate situations that call
+for
+the characters to occupy the high-order part of the number, this
+Tokenizer supports an
+"Ascii-Left" conversion directive called <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">al#</span>
+, which is equivalent to <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">a#</span>
+in all respects except when the
+target-sequence contains fewer than four characters: <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">al#
+CPU</span> is equivalent to <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">h#
+43505500</span></div>
+<h5 style="margin-left: 80px;"><a class="mozTocH5" name="mozTocId54171"></a><a
+ name="F_Eff-Bracket-Tick-Bracket"></a><big>F[']
+("Eff-Bracket-Tick-Bracket")</big></h5>
+<p style="margin-left: 80px;">Syntactically similar to the Standard <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[']</span>
+("Bracket-Tick-Bracket"). Valid targets for <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">F[']</span>
+are the same as for <a href="#mozTocId73206"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[']</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">'</span></a>
+. Attempts to apply <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">F[']</span>
+to an invalid target will be handled similarly.<br>
+</p>
+<p style="margin-left: 80px;">This directive acquires the given word's
+FCode-Token number,
+which is then used according to whether the directive is invoked during
+"Normal Tokenization" or "Tokenizer-Escape" mode:</p>
+<h6 style="margin-left: 120px;"><big><big><a name="mozTocId54716"></a><a
+ name="F_B-T-B_Normal"></a>F['] in "Normal Tokenization" Mode:</big></big></h6>
+<p style="margin-left: 120px;">The given word's FCode-Token number is
+tokenized as a literal, which can be used, for instance, as the
+argument to a <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">get-token</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">set-token</span>
+command.<br>
+</p>
+<div style="margin-left: 120px;">For example, the sequence:<big> </big><br>
+</div>
+<div style="margin-left: 200px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">F[']
+rl@ get-token</span><span
+ style="font-family: helvetica,arial,sans-serif;"></span>
+</div>
+<div style="margin-left: 160px;">is equivalent to:<big> </big><br>
+</div>
+<div style="margin-left: 200px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;"> h#
+234 get-token</span><br>
+</div>
+<h6 style="margin-left: 120px;"><big><big><a name="mozTocId55261"></a><a
+ name="F_B-T-B_TkzEsc"></a>F['] in "Tokenizer-Escape" Mode:</big></big></h6>
+<p style="margin-left: 120px;">This function is the one <a
+ href="#Tkz_Esc_Scope">exception to the general rule</a> about the <a
+ href="#Scope_Directives">scope</a> of words recognized in
+"Tokenizer-Escape" mode; it will recognize function-names that
+were defined during normal tokenization mode and that were <a
+ href="#current_device-node">current at the time</a> "Tokenizer-Escape"
+mode was entered.<br>
+</p>
+<p style="margin-left: 120px;">The given word's FCode-Token number is
+pushed
+onto the data-stack, from whence it can be used, for instance, as the
+numeric argument to a <a href="#Tkz_Esc_Const"><span
+ style="font-family: courier new; font-weight: bold;">constant</span></a>
+definition.<br>
+</p>
+<h5 style="margin-left: 80px;"><a name="mozTocId887752"></a><big><a
+ name="Shell_Env_Vbles_in_File_Names"></a>Shell-Environment
+Variables in
+File-Names</big></h5>
+<p style="margin-left: 80px;">The filename that follows the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fload</span>
+command or the <a href="#ENCODE_FILE"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">encode-file</span></a>
+directive may be an
+absolute path, a path relative to the Current Working
+Directory, or a path relative to one of the
+directories in the <a href="#Include_List">Include-List</a>. It
+may also contain Shell Environment Variables and
+related expressions recognized by the Host Operating System environment
+in which the
+Tokenizer is running. These will all be expanded before loading
+the
+file. An illustration may be
+seen in <a href="#Example_4">Example #4</a>. </p>
+<p style="margin-left: 80px;">An <a href="#Advisories">ADVISORY</a>
+message showing the expanded value will be printed if the <a
+ style="font-style: italic; font-weight: bold;" href="#verbose_option">verbose</a>
+<a href="#Command-Line_options_">option</a> has
+been selected or in the event of a failure to read the file.<br>
+</p>
+<h4 style="margin-left: 40px;"><a class="mozTocH4" name="mozTocId505746"></a>Featured
+behaviors, supported by this
+Tokenizer, that are not mentioned in the Standard</h4>
+<h5 style="margin-left: 80px;"><a name="mozTocId530910"></a><big><a
+ name="Macros"></a>User-Defined Macros</big></h5>
+<div style="margin-left: 80px;">The Standard mentions built-in
+tokenizer macros (such as <span
+ style="font-family: courier new,courier,monospace;">3drop</span> for
+example) but makes no provision for the User to define any additional
+macros.
+<p>This Tokenizer supports a directive that allows the User to define
+additional macros. Its syntax is:</p>
+<p style="margin-left: 40px;">
+<span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[macro]</span>
+<span style="font-family: courier new,courier,monospace;"><<span
+ style="font-style: italic;">macroname</span>> <span
+ style="font-style: italic;">cmnd1 cmnd2 cmnd3 ... cmndN</span></span></p>
+<p>The entire body of the macro definition must be contained on a
+single line. The linefeed at the end of the line will be included
+as part of the macro definition.<br>
+</p>
+<p>In this Tokenizer, macros are implemented as simple
+string
+substitutions, interpreted at the time they are invoked. If a
+component of the macro should change its meaning -- i.e., be redefined
+-- then, on subsequent invocations of the macro, the new meaning will
+take effect. (Note that this is different from an <a
+ href="#Alias">alias</a>). It is also (eminently) possible to
+define a macro
+that uses a name that has not been defined at the time the macro is
+defined, to define that name later, and to invoke the macro after
+the name has been defined. This is legitimate and will work.<br>
+</p>
+<p>For the same reason, macros may be nested; i.e., one macro may be
+defined in such a way as to invoke another. However, if a macro
+-- or a series of nested macros -- were to invoke a macro that is
+already running, that will be detected and reported as an <a
+ href="#An_ERROR">Error</a> condition.
+For a simple example, a User who needed to identify all occurrences of
+the word <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">2drop</span>
+might attempt to write:</p>
+<div
+ style="margin-left: 40px; font-family: courier new,courier,monospace;"> <span
+ style="font-weight: bold;">overload</span> <span
+ style="font-weight: bold;">[macro]</span> 2drop <span
+ style="font-weight: bold;">message"</span> 2DROP called here<span
+ style="font-weight: bold;">"</span> <span style="font-weight: bold;">2drop</span>
+</div>
+ in the expectation that the second <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">2drop</span>
+would be interpreted as the generic one, which outputs the
+corresponding token.
+<p>However, because the macro definition is not "compiled" in the same
+way
+as a colon-definition, but is, instead, interpreted at run-time, the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">2drop</span>
+that would be executed would, in fact, be the macro itself, leading to
+an infinite loop of messages (if the condition were not
+detected...). In order to protect against this condition, the
+User should, instead, do something like this:</p>
+<div
+ style="margin-left: 40px; font-family: courier new,courier,monospace;">\
+Keep a "generic" 2DROP handy.<br>
+<span style="font-weight: bold;">alias</span>
+generic-2drop 2drop<br>
+<span style="font-weight: bold;">overload</span> <span
+ style="font-weight: bold;">[macro]</span> 2drop <span
+ style="font-weight: bold;">message"</span> 2DROP called here<span
+ style="font-weight: bold;">" </span>generic-2drop
+</div>
+<p>
+This has the added advantage that, when the passage in which the
+notification is needed comes to an end, the User can restore <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">2drop</span>
+to its Standard behavior with:<br>
+</p>
+<div
+ style="margin-left: 40px; font-family: courier new,courier,monospace;"><span
+ style="font-weight: bold;">overload</span> <span
+ style="font-weight: bold;">alias</span> 2drop generic-2drop</div>
+<p>A User-Defined Macro takes on the <a href="#Scope_Directives">Scope</a>
+that is current at the time it is created. An illustration may be
+seen in <a href="#Example_4">Example #4</a>. </p>
+</div>
+<h5 style="margin-left: 80px;"><a class="mozTocH5" name="mozTocId539069"></a><big><a
+ name="Multiple_device_nodes"></a>Multiple
+device-nodes</big></h5>
+<div style="margin-left: 80px;">The typical use of a tokenizer is to
+write a driver for a single-node device. For such an application,
+the commands <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">new-device</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">finish-device</span>
+are not required. However, many newer devices consist of
+complexes of subordinate and peer devices within a single assembly;
+some additional caution is required when developing drivers for such
+configurations.<br>
+<p><a name="INSTANCE_at_run_time"></a>In particular, an attempt within
+one device-node to access directly
+a method defined in another device-node must be flagged as an
+error. Consider
+what would happen at run-time if it were allowed: the called
+method
+would be expecting the instance-pointer to be pointing to the instance
+data of the device-node in which that method was defined, but it would,
+instead,
+be pointing to the instance data of the device-node that made the
+call.
+This is an invitation to havoc that would be -- to put it politely --
+somewhat difficult to trace.<br>
+</p>
+<p>The correct way to invoke a method across device-node boundaries is
+via <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">$call-parent</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">$call-method</span>
+or the like.<br>
+</p>
+<p><a name="device-node_vocabularies"></a>In order to detect such
+errors early on, this Tokenizer keeps track
+of separate but linked "vocabularies"
+associated with device-nodes. When the command <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">new-device</span>
+is encountered in interpretation mode, a new device-node vocabulary is
+opened and new
+definitions are entered into it. Definition-names created in the
+preceding device-node -- presumably the parent of the newly started
+device -- are suspended from accessiblity. <br>
+</p>
+<p>Correspondingly, when the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">finish-device</span>
+command is encountered in interpretation mode, the "vocabulary" of the
+device
+being ended is emptied ("forgotten" in classic Forth parlance) and the
+"vocabulary" of the parent-device is resumed.<br>
+</p>
+<p><a name="current_device-node"></a>The device-node vocabulary to
+which definitions are being entered at
+any given time, and from which definitions are accessible, may be
+referred to as the <span
+ style="font-family: courier new,courier,monospace; font-style: italic;">current
+device-node</span> for purposes of discussion.<br>
+</p>
+<p>Note that the Tokenizer does not switch vocabularies when the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">new-device</span>
+or <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">finish-device</span>
+commands are encountered in compilation mode (i.e., when they are being
+compiled-in to a method); they are treated as ordinary tokens, since
+the shift to a new device-node will not occur until run-time.
+</p>
+<p>The commands <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">new-device</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">finish-device</span>
+must remain in balance. If a <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">finish-device</span>
+is encountered without a prior corresponding <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">new-device</span>,
+or if the end of FCode (or a <a
+ href="#Resetting_Symbols_Defined_in_Either_Mode"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Reset-Symbols</span></a>
+directive issued in "normal" mode) is reached and not all occurrences
+of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">new-device</span>
+are balanced by a call to <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">finish-device</span>,
+it will be reported as an <a href="#An_ERROR">Error</a> condition. </p>
+<p>Definitions made in "Tokenizer-Escape" mode, however, are
+independent of device-node vocabularies and remain accessible until
+they
+are explicitly reset by a <a
+ href="#Resetting_Symbols_Defined_in_Either_Mode"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Reset-Symbols</span></a>
+directive issued in "Tokenizer-Escape" mode.<br>
+</p>
+</div>
+<h6 style="margin-left: 120px;"><a name="mozTocId540605"></a><big><big><a
+ name="Global_Definitions"></a>Global
+Definitions</big></big></h6>
+<div style="margin-left: 120px;">Occasionally, the User might need to
+create definitions of methods that are
+intended to be directly accessible to all the device-nodes in a
+driver, even though they reside in one device
+node. Such
+definitions are, effectively, added to the "core" vocabulary, and are
+Global in scope. <a href="#Scope_Directives">Directives</a> to
+control the creation of Global Definitions are supported by this
+Tokenizer.</div>
+<h5 style="margin-left: 80px;"><a class="mozTocH5" name="mozTocId354426"></a><big><a
+ name="Multiple_FCode-block_Images"></a>Multiple
+FCode-block Images</big></h5>
+<div style="margin-left: 80px;">In addition to supporting complexes of
+subordinate and peer devices within a single assembly, this Tokenizer
+supports configurations in which subordinate devices' drivers are kept
+in separate but related FCode blocks. This is accomplished simply
+by invoking multiple bodies of code bracketed by <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fcode-version<span
+ style="font-style: italic;"><</span></span><span
+ style="font-family: courier new,courier,monospace; font-style: italic;">n</span><span
+ style="font-family: courier new,courier,monospace; font-weight: bold; font-style: italic;">></span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fcode-end</span>
+(or one of its synonyms).<br>
+<p>When the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fcode-end</span>
+(or equivalent) that ends one body of code is processed, and before
+the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fcode-version<span
+ style="font-style: italic;"><</span></span><span
+ style="font-family: courier new,courier,monospace; font-style: italic;">n</span><span
+ style="font-family: courier new,courier,monospace; font-weight: bold; font-style: italic;">></span>
+that begins the next, the definitions that had been created are
+forgotten, but assignment of FCode-token numbers will continue in
+sequence. Likewise, definitions made in "Tokenizer-Escape" mode
+will persist.<br>
+</p>
+<p>The User who desires to reset one or the other of these, or both,
+can do so by issuing the directives:<br>
+</p>
+<div style="margin-left: 40px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FCode-Reset<br>
+</span>
+<div style="margin-left: 40px;">or<br>
+</div>
+</div>
+<div style="margin-left: 40px;"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Reset-Symbols</span><br>
+</div>
+</div>
+<div style="margin-left: 40px;">
+<div style="margin-left: 40px;"><br>
+respectively, in "Tokenizer-Escape" mode. This is illustrated in <a
+ href="#Example_3">Example #3</a>.<br>
+</div>
+</div>
+<h5 style="margin-left: 80px;"><a class="mozTocH5" name="mozTocId232809"></a><big><a
+ name="Multiple_PCI_Image"></a>Multiple
+PCI-Image</big></h5>
+<div style="margin-left: 80px;">The PCI Standard allows for a chain of
+PCI Images to be bundled together in a single binary (as indicated by
+the <a href="#Last_Image_Indicator_bit">"Last Image" bit</a>).
+This Tokenizer supports such configurations by correctly processing
+Source that contains multiple occurrences of blocks of code bracketed
+by <span
+ style="font-family: courier new,courier,monospace; color: rgb(68, 34, 0); font-weight: bold;">pci-header</span>
+... <span
+ style="font-family: courier new,courier,monospace; color: rgb(68, 34, 0); font-weight: bold;">pci-header-end</span>
+directives. An illustration can be seen in <a href="#Example_1">Example
+#1</a>, below.<br>
+</div>
+<h2><a class="mozTocH2" name="mozTocId194505"></a><a name="Examples:"></a>Examples:</h2>
+<h3><a class="mozTocH3" name="mozTocId544211"></a><a name="Example_1"></a>Example
+#1:</h3>
+In the first example, the "Inner Body" file has some sections that
+compile
+different code, depending on the value of a named-constant
+switch. The "Outer Shell " file controls the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">fload</span>ing
+of the
+"Inner Body": It reminds the User to specify the setting of the
+switch, then produces an image with two PCI-Images, based on opposite
+settings of the switch. Note that the use of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold; color: rgb(68, 34, 0);">Reset-Symbols</span>
+in "Tokenizer-Escape" mode before the redefinition of <span
+ style="font-family: courier new,courier,monospace; color: rgb(68, 34, 0);">function-switch</span>,
+to avoid a "Duplicate definition" condition, may be omitted if the User
+is willing to tolerate the warning.
+<h5><a class="mozTocH5" name="mozTocId563670"></a>File:
+InnerBody.fth</h5>
+<span
+ style="font-family: courier new,courier,monospace; color: rgb(68, 34, 0);"><span
+ style="font-weight: bold;">fcode-version2</span><br>
+<span style="font-style: italic;">... Common code <obligatory
+sneeze> ...</span><br>
+<span style="font-weight: bold;">F[</span>
+function-switch <span style="font-weight: bold;">F]</span>
+<span style="font-weight: bold;">[if]</span><br>
+ <span style="font-style: italic;">True-conditional
+code</span><br>
+
+<span style="font-weight: bold;">[message]</span> The true
+path was wisely chosen<br>
+<span style="font-weight: bold;">[else]</span><br>
+
+<span style="font-style: italic;">False-conditional code</span><br>
+
+<span style="font-weight: bold;">[message]</span> You have
+foolishly chosen the false path.<br>
+<span style="font-weight: bold;">[then]</span><br>
+<span style="font-style: italic;">...
+More common code <now cough>.</span><br>
+<span style="font-weight: bold;">end0</span></span><br>
+<h5><a class="mozTocH5" name="mozTocId570875"></a>File:
+OuterShell.fth</h5>
+<span
+ style="font-family: courier new,courier,monospace; color: rgb(68, 34, 0);"><span
+ style="font-weight: bold;">[ifndef]</span> first-path<br>
+
+<span style="font-weight: bold;">F[</span><br>
+ <span style="font-weight: bold;">."</span> Add a
+command-line switch:
+-d ""first-path=<true|false>"" "n"\<br>
+ <span style="font-weight: bold;"> </span> "tthen run
+this again.<span style="font-weight: bold;">"</span><br>
+
+<span style="font-weight: bold;">F]</span><br>
+<span style="font-weight: bold;">[else]</span><br>
+ <span style="font-weight: bold;">F[</span><br>
+ <span style="font-weight: bold;">[defined]</span>
+first-path <span style="font-weight: bold;">constant</span>
+function-switch<br>
+<div style="margin-left: 40px;"><span style="font-style: italic;">vendor-id</span>
+<span style="font-style: italic;">device1-id</span> <span
+ style="font-style: italic;">class-code1</span> <span
+ style="font-weight: bold;">pci-header</span><br>
+
+<span style="font-weight: bold;">F]</span><br>
+<span style="font-weight: bold;">not-last-image</span><br>
+<span style="font-weight: bold;">fload</span> InnerBody.fth<br>
+<span style="font-weight: bold;">pci-header-end</span><br>
+<br>
+</div>
+ <span style="font-weight: bold;">F[</span> <span
+ style="font-weight: bold;">reset-symbols</span><br>
+ <span style="font-weight: bold;">[defined]</span>
+first-path <span style="font-weight: bold;">0=</span> <span
+ style="font-weight: bold;">constant</span> function-switch<br>
+<div style="margin-left: 40px;"><span style="font-style: italic;">vendor-id</span>
+<span style="font-style: italic;">device2-id</span> <span
+ style="font-style: italic;">class-code2</span> <span
+ style="font-weight: bold;">pci-header</span><br>
+
+<span style="font-weight: bold;">F]</span><br>
+<span style="font-weight: bold;">last-image</span><br>
+<span style="font-weight: bold;">fload</span> InnerBody.fth<br>
+<span style="font-weight: bold;">pci-header-end</span><br>
+</div>
+<span style="font-weight: bold;">[then]</span></span><br>
+<h5><a class="mozTocH5" name="mozTocId953372"></a>Command-Line
+invocation:</h5>
+<span
+ style="font-family: courier new,courier,monospace; color: rgb(68, 34, 0); font-weight: bold;">toke
+-v -d "first-path=true"
+OuterShell.fth</span><br>
+<br>
+<h3><a class="mozTocH3" name="mozTocId80432"></a><a name="Example_2"></a>Example
+#2:<br>
+</h3>
+<p>The second example illustrates the use of
+<a href="#Special_Feature_Flags">Special-Feature
+Flags</a> to select or de-select
+specific non-standard
+features.<br>
+</p>
+<p>The User is developing code that will run across all platforms, and
+therefore must
+must be neutral with regard to "Sun"- or "Apple"- -style usage of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT"</span>
+; this can be best achieved by disallowing the use of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">ABORT"</span>
+altogether.
+</p>
+<p>There is no concern, however, about compatibility of the Source with
+other Tokenizers, so the User need not forgo the conveniences of Local
+Values and String-remark-escapes.
+</p>
+<p>Furthermore, the Source contains many passages taken from IBM Legacy
+sources, and the User does not wish to see a WARNING message when the
+Legacy Locals Separator is used.
+</p>
+<p>The command-line for these conditions would include the following:</p>
+<span
+ style="font-family: courier new,courier,monospace; color: rgb(68, 34, 0); font-weight: bold;">toke
+-f NOabort-quote -f local-values -f NOlv-legacy-warning</span>
+<p>Alternatively, these flags may be set from <a
+ href="#Changing_C-L_Flags_from_Source">within the Source code</a>
+thus:
+</p>
+<div
+ style="margin-left: 40px; color: rgb(68, 34, 0); font-family: courier new,courier,monospace; font-weight: bold;">[flag]
+NOabort-quote<br>
+[flag] local-values<br>
+[flag] NOlv-legacy-warning
+</div>
+<p>Note that the invocation of <span
+ style="font-family: courier new,courier,monospace; color: rgb(68, 34, 0);">-f
+local-values</span> is necessary, as its default state is to be
+disabled.
+Also, because <span
+ style="font-family: courier new,courier,monospace; color: rgb(68, 34, 0);">-f
+NOabort-quote</span> is invoked, the setting of the <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">Sun-ABORT-Quote</span>
+flag is irrelevant.<br>
+</p>
+<h3><a class="mozTocH3" name="mozTocId455242"></a><a name="Example_3"></a>Example
+#3:</h3>
+<p>The third example illustrates two situations where two or three
+<a href="#Multiple_FCode-block_Images">FCode blocks</a>
+are incorporated into a single PCI Image.<br>
+</p>
+<p>In the first situation, the "Outer" block will <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">byte-load</span>
+the code of
+the "Inner" block before the "Outer" block has been completely
+interpreted. It is therefore important to avoid collisions in
+FCode-token numeric assignments.<br>
+</p>
+<div
+ style="color: rgb(68, 34, 0); font-family: courier new,courier,monospace; margin-left: 40px;">
+<span style="font-weight: bold;">F[</span><br>
+<div style="margin-left: 40px;">h# 5afe <span
+ style="font-weight: bold;">set-rev-level</span>
+<br>
+h# beef
+\ Vendor<br>
+h# c0de
+\ Device ID<br>
+h# 90210 \
+Class Code (A "classy" ZIP Code... ;-)<br>
+</div>
+<span style="font-weight: bold;">F]</span> <span
+ style="font-weight: bold;">pci-header</span><br>
+<br>
+<span style="font-weight: bold;">fcode-version2</span><br>
+<br>
+<span style="font-weight: bold;">fload</span>
+outer-block.fth<span><br>
+</span><br>
+<span style="font-weight: bold;">fcode-end<br>
+<br>
+</span><span style="font-family: helvetica,arial,sans-serif;">\
+At this point, the last definition's assigned FCode number
+is approximately 0Xac0</span><br>
+<br>
+<span style="font-weight: bold;">fcode-version2</span><br>
+<br>
+<span style="font-family: helvetica,arial,sans-serif;">\ The next
+definitions' assigned FCode numbers continue from
+0Xac1</span><br>
+<br>
+<span style="font-weight: bold;">fload</span>
+inner-block.fth<span style="font-weight: bold;"><br>
+</span><br>
+<span style="font-weight: bold;">fcode-end</span><br>
+<br>
+<span style="font-weight: bold;">pci-header-end</span><br>
+<br>
+</div>
+<p>In the second situation, the "Outer" block will have been completely
+interpreted before it begins to <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">byte-load</span>
+the code of the two "Inner" blocks. It can safely discard the
+token-table of the interpreter, and allow its assigned FCode-token
+numbers to be re-cycled. Furthermore, the large number of
+definitions presents a real risk that the full range of usable
+FCode-token numbers will be exhausted. For these reasons, the
+User finds it necessary to reset the FCode-token numeric assignments to
+their initial state before tokenizing the two "Inner" blocks. <br>
+</p>
+<div
+ style="margin-left: 40px; color: rgb(68, 34, 0); font-family: courier new,courier,monospace;">
+<span style="font-weight: bold;">F[</span><br>
+<div style="margin-left: 40px;">
+h# face
+ <span style="font-weight: bold;">set-rev-level</span><br>
+h# cafe
+ \
+Vendor<br>
+h# d00d
+ \
+Device ID<br>
+h# 95014
+ \ Another Class(y
+ZIP) Code</div>
+<span style="font-weight: bold;">F]</span> <span
+ style="font-weight: bold;">pci-header</span><br>
+<br>
+<span style="font-weight: bold;">fcode-version2</span><br>
+<br>
+<span style="font-weight: bold;">fload</span> outer-block.fth<br>
+<br>
+<span style="font-weight: bold;">fcode-end</span><br>
+<br>
+<span style="font-family: helvetica,arial,sans-serif;">\ At this
+point, the last definition's assigned FCode number
+is approximately 0Xae0</span><br>
+<br>
+<span style="font-weight: bold;">fcode-version2<br>
+<br>
+</span><span style="font-family: helvetica,arial,sans-serif;">\
+Reset the assigned FCode numbers for the first "inner" block<br>
+ </span><br>
+<span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FCode-Reset</span><span
+ style="font-weight: bold;"><br>
+</span> <br>
+<span style="font-weight: bold;">fload</span> inner-block_01.fth<br>
+<br>
+<span style="font-weight: bold;">fcode-end</span><br>
+<br>
+\ Load the second "inner" block.<br>
+<br>
+<span style="font-weight: bold;">fcode-version2</span><br>
+<br>
+<span style="font-family: helvetica,arial,sans-serif;">\ Reset
+the assigned FCode numbers for the second "inner" block</span><br>
+<br>
+<span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">FCode-Reset</span><br>
+<br>
+<span style="font-weight: bold;">fload</span> inner-block_02.fth<br>
+<br>
+<span style="font-weight: bold;">fcode-end</span><br>
+<br>
+<span style="font-weight: bold;">pci-header-end</span>
+</div>
+<br>
+<h3><a class="mozTocH3" name="mozTocId861304"></a><a name="Example_4"></a>Example
+#4</h3>
+<p>This example serves to illustrate the use of the directives that
+control the
+<a href="#Scope_Directives">Scope of Definitions</a>, and also to show
+a means whereby the IBM-Style
+Local Values
+Support File can be incorporated at a <a href="#Global_Definitions">Global</a>
+level. Normally, <a href="#Multiple_device_nodes">that would be
+problematical</a> because
+the <a href="TokenizerLocalValues.htm#Instance_Data_in_L_V_Support">Local
+Values
+Support functions</a> are written to use <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+data, in order to conserve use of System memory. By temporarily
+over-riding the definition of <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">instance</span>
+in the <a href="#over_ride_instance">manner shown</a>, the User has
+traded-off economy of System-memory
+for convenience of programming.
+</p>
+<p>This example also offers an illustration of the use of <a
+ href="#Shell_Env_Vbles_in_File_Names">Shell-Environment Variables in
+File-Names</a>: Let us suppose that the directory in which the
+main file for the controller of the assembly whose driver being
+compiled here resides in a directory-tree, several layers under the
+root. Immediately below the root is a sub-directory called <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">shared</span>
+that contains shared functions and the Local Values support, and
+elsewhere under the tree are sharable bodies of driver code for
+device-modules that can be incorporated into various assemblies.
+Let us also suppose that the Makefile that governs this Tokenization
+process sets Environment Variables; the root of the tree is called <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">DevRoot</span>,
+and the directory in which the sharable bodies reside are called <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">SCZ</span>
+and <span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">SLZ</span>
+respectively. And let us further suppose that the <a
+ href="#Example_4_Condl_FLoad">inclusion of these two subsidiary devices</a>
+is
+optional, controlled by command-line symbol definitions. </p>
+<div
+ style="margin-left: 40px; color: rgb(68, 34, 0); font-family: courier new,courier,monospace;">
+\ Define a few macros and functions that will become available<br>
+\ to all subordinate device-nodes in this bundle.<br>
+<br>
+\ Some of our functions are written using Local Values.<br>
+\ We can make the Local Values Support accessible Globally<br>
+\ without incurring any Warning messages, and
+without<br>
+\ altering the LocalValuesSupport file, if we
+temporarily<br>
+\ disable the definition of INSTANCE<br>
+<br>
+<span style="font-weight: bold;">fcode-version2</span><br>
+<br>
+<span style="font-weight: bold;">headers</span><br>
+<br>
+<span style="font-weight: bold;">global-definitions</span><br>
+<br>
+<a name="over_ride_instance"></a>\ Bypass warning about
+Instance<br>
+\ without altering
+LocalValuesSupport file<br>
+<br>
+\ Leave ourselves a way to recover<br>
+<span style="font-weight: bold;">alias</span> generic-instance
+instance<br>
+<br>
+\ Here's where we disable it. During development, give
+confirmation<br>
+\ that the macro has been activated by
+printing a message. Also,<br>
+\ insert a token in the place where
+the Instance would have<br>
+\ gone so that our detokenizations line
+up
+when we inspect. We<br>
+\ do this by defining a comand-line
+symbol called proto-code<br>
+\ For the final production run, we can make the macro completely<br>
+\ silent by leaving proto-code
+undefined.<br>
+<span style="font-weight: bold;">[ifdef]</span> proto-code<br>
+ <span style="font-weight: bold;">overload [macro]</span>
+instance <span style="font-weight: bold;">message"</span>
+Bypassing Instance<span style="font-weight: bold;">"</span> <span
+ style="font-weight: bold;">noop</span><br>
+<span style="font-weight: bold;">[else]</span><br>
+ \ Make it completely silent<br>
+ <span style="font-weight: bold;">overload [macro]</span>
+instance <span style="font-weight: bold;">f[ noop ]f</span><br>
+<span style="font-weight: bold;">[endif]</span><br>
+<br>
+<span style="font-weight: bold;">fload</span> ${DevRoot}/shared/<span
+ style="font-weight: bold;">LocalValuesSupport.fth</span><br>
+<br>
+\ Restore normal meaning of Instance , also in Global scope.<br>
+<span style="font-weight: bold;">overload alias</span> instance
+generic-instance<br>
+<br>
+\ Here's a global definition that uses Local Values<br>
+: $CAT ( _max _str1 _len1 _str2 _len2 -- _max _str1 _len1' )<br>
+ <span style="font-weight: bold;">{</span> _max _str1
+_len1 _str2 _len2 <span style="font-weight: bold;">}</span><br>
+ _len1 _max <
+if
+\ there is room<br>
+ _str2 _str1 _len1 + _len2 _max _len1 -
+min move<br>
+ then<br>
+ _max _str1 _len1 _len2 + _max min \ always leave
+total length<br>
+;<br>
+<br>
+\ Here is a global macro<br>
+<span style="font-weight: bold;">[macro]</span> 4DUP 2over 2over<br>
+<br>
+\ And another<br>
+<span style="font-weight: bold;">[macro]</span> 4DROP 2drop
+2drop<br>
+<br>
+\ And yet another<br>
+<span style="font-weight: bold;">[macro]</span> (.h) base @
+swap hex (.) rot base !<br>
+<br>
+\ Other shared functions are in a file in the Shared Code
+directory:<br>
+<span style="font-weight: bold;">fload</span>
+${DevRoot}/shared/sharedfuncts.fth<br>
+<br>
+\ Definitions in all subsequent device-nodes will be able to
+access<br>
+\ the $CAT function and the macros
+4DUP and
+4DROP, as well as<br>
+\ to make use of IBM-Style Local Values
+without re-<span style="font-style: italic; font-weight: bold;">fload</span>ing<br>
+\ the Support File<br>
+<br>
+\ Now let's get back into the primary device-node.<br>
+<span style="font-weight: bold;">device-definitions</span><br>
+<br>
+\ Use instance data to create a large temporary buffer<br>
+d# 40 dup instance buffer: temp-buf
+( max )<br>
+<br>
+\ Convolutions to create a name on the fly...<br>
+s" controller_" tuck
+
+( max len adr len )<br>
+temp-buf
+swap
+ ( max len adr buf len )<br>
+move
+ ( max len )<br>
+temp-buf
+swap
+ ( max buf len )<br>
+my-self
+(.h)
+( max buf len adr2 len2 )<br>
+$cat
+( max buf len )<br>
+device-name drop<br>
+<br>
+\ Make a macro of that. Define it in parts.<br>
+\ Requires the core of the name on the stack.<br>
+\ Macro will create its own temp-buf in the current
+device.<br>
+<br>
+<span style="font-weight: bold;">global-definitions<br>
+<br>
+</span>\ First part of the operation: ( adr len --
+max adr len )<br>
+\ Note that "instance" is allowed here because it is not<br>
+\ invoked -- or even parsed --
+until the macro is invoked.<br>
+<span style="font-weight: bold;">[macro]</span>
+create-buffr d# 40 dup instance buffer: temp-buf -rot<br>
+<br>
+\ Second part of the operation: ( max adr len -- max buf
+len )<br>
+<span style="font-weight: bold;">[macro]</span>
+name-to-buffr tuck temp-buf swap move temp-buf swap<br>
+<br>
+\ Last part of the operation: ( max buf len -- )<br>
+\ We're using my-self as part of the device-name<br>
+\ for no particularly good reason other than<br>
+\ that it makes for an interesting example...
+;-}<br>
+<span style="font-weight: bold;">[macro]</span>
+buffr-to-dev-name my-self (.h) $cat device-name drop<br>
+<br>
+\ Combine the parts:<br>
+<span style="font-weight: bold;">[macro]</span> make-my-dev
+create-buffr name-to-buffr buffr-to-dev-name<br>
+<br>
+\ Back to the primary device-node.<br>
+<span style="font-weight: bold;">device-definitions</span><br>
+<br>
+\ Load its methods from the Current Directory<br>
+<span style="font-weight: bold;">fload</span> controller_methods.fth<br>
+<br>
+<a name="timestamp_prop"></a>\ Create timestamp property based on
+actual tokenization date and time<br>
+\ Combine into a single string (with a space between).<br>
+\ No trailing null-byte until end.<br>
+[fcode-date] encode-bytes " " encode-bytes encode+<br>
+[fcode-time] encode-string encode+ " release-time" property<br>
+<br>
+\ Log timestamp to the Audit Trail<br>
+tokenizer[ [fcode-date] [fcode-time] ]tokenizer<br>
+<br>
+<a name="Example_4_Condl_FLoad"></a>\ First optional subsidiary
+device. Inclusion controlled by command-line symbol.<br>
+<span style="font-weight: bold;">[ifdef]</span> scuzzy<br>
+<div style="margin-left: 40px;"><span style="font-weight: bold;">new-device</span><br>
+<br>
+" scuzzy_" make-my-dev<br>
+<br>
+\ Load its methods<br>
+<span style="font-weight: bold;">fload</span> ${SCZ}/scuzzy_methods.fth<br>
+<br>
+<span style="font-weight: bold;">finish-device</span><br>
+</div>
+<span style="font-weight: bold;">[endif]</span><br>
+<br>
+\ Second optional subsidiary device, controlled by command-line
+symbol.<br>
+<span style="font-weight: bold;">[ifdef]</span> sleazy<br>
+<div style="margin-left: 40px;"><span style="font-weight: bold;">new-device</span><br>
+<br>
+" sleazy_" make-my-dev<br>
+<br>
+\ Load its methods<br>
+<span style="font-weight: bold;">fload</span> ${SLZ}sleazy_methods.fth<br>
+<br>
+<span style="font-weight: bold;">finish-device</span><br>
+</div>
+<span style="font-weight: bold;">[endif]</span><br>
+<br>
+\ That's enough for now...<br>
+<span style="font-weight: bold;">fcode-end</span><br>
+</div>
+<h3><a class="mozTocH3" name="mozTocId866180"></a><a name="Example_5"></a>Example
+#5</h3>
+<p>This example serves to illustrate the use of the <a
+ href="#function_name"><span
+ style="font-family: courier new,courier,monospace; font-weight: bold;">[function-name]</span></a>
+directive to create a series of "you are here" debugging messages.<br>
+</p>
+<p>We will create a pair of macros whose names we can cut'n'paste at
+the beginning and end of every function we want to give a "you are
+here" message, switchable by a local debug-flag. The macros will
+be globally defined, but will make reference to locally-defined names
+for the debug-flag and the device-node name string. </p>
+<div
+ style="margin-left: 40px; color: rgb(68, 34, 0); font-family: courier new,courier,monospace;">
+<br>
+<span style="font-weight: bold;">fcode-version2</span><br>
+<br>
+<span style="font-weight: bold;">global-definitions</span><br>
+\ Each dev-node will create its own debug-flag and alias it
+to debug-me?<br>
+\ Each dev-node creates a macro called my-dev-name giving its
+device-name<br>
+<span style="font-weight: bold;"></span><br>
+<span style="font-weight: bold;">[macro]</span> .fname&dev <span
+ style="font-weight: bold;">[function-name]</span> <span
+ style="font-weight: bold;">type</span> <span
+ style="font-weight: bold;">."</span> in <span
+ style="font-weight: bold;">"</span> my-dev-name <span
+ style="font-weight: bold;">type</span> <br>
+ <br>
+<span style="font-weight: bold;">[macro]</span> name-my-dev
+my-dev-name <span style="font-weight: bold;">device-name<br>
+</span><br>
+<span style="font-weight: bold;">[macro]</span> .dbg-enter
+debug-me? <span style="font-weight: bold;">@</span> <span
+ style="font-weight: bold;">if</span> <span style="font-weight: bold;">."</span>
+Entering<span style="font-weight: bold;"> "</span> .fname&dev
+<span style="font-weight: bold;">cr</span> <span
+ style="font-weight: bold;">then</span><br>
+<span style="font-weight: bold;">[macro]</span> .dbg-leave
+debug-me? <span style="font-weight: bold;">@</span> <span
+ style="font-weight: bold;">if</span> <span style="font-weight: bold;">."</span>
+Leaving <span style="font-weight: bold;">"</span>
+.fname&dev <span style="font-weight: bold;">cr</span> <span
+ style="font-weight: bold;">then</span><br>
+<span style="font-weight: bold;">device-definitions</span><br>
+<br>
+<span style="font-weight: bold;">headers</span><br>
+\ Top-most device, named billy<br>
+<span style="font-weight: bold;">[macro]</span> my-dev-name "
+billy"<br>
+name-my-dev<br>
+<br>
+\ debug-billy? is a flag the user can turn "on" to get
+debug-messages<br>
+\ from the methods of the device we call "billy"<br>
+<span style="font-weight: bold;">variable</span> debug-billy?
+debug-billy? <span style="font-weight: bold;">off</span><br>
+\ Set it up for the macro<br>
+<span style="font-weight: bold;">alias</span> debug-me? debug-billy?<br>
+<br>
+: bill<br>
+
+.dbg-enter
+\ This will display Entering bill in billy<br>
+ <span style="font-weight: bold;">[char]</span> G <span
+ style="font-weight: bold;">dup</span><br>
+ <span style="font-weight: bold;">control</span> G <span
+ style="font-weight: bold;">3drop</span><br>
+
+.dbg-leave
+\ This will display Leaving bill in billy<br>
+<br>
+;<br>
+<br>
+: factl recursive ( n -- n! )<br>
+<span style="font-weight: bold;">type</span> <span
+ style="font-weight: bold;">."</span> Entering First vers. of <span
+ style="font-weight: bold;">"</span> .fname&dev <span
+ style="font-weight: bold;">cr</span><br>
+ <span style="font-weight: bold;">?dup</span> <span
+ style="font-weight: bold;">0=</span> <span style="font-weight: bold;">if</span>
+<span style="font-weight: bold;">1</span><br>
+ <span style="font-weight: bold;">else</span> <span
+ style="font-weight: bold;">dup</span> <span style="font-weight: bold;">1-</span>
+factl <span style="font-weight: bold;">*</span><br>
+ <span style="font-weight: bold;">then</span><br>
+ <span style="font-weight: bold;">."</span> Leaving
+First vers. of <span style="font-weight: bold;">"</span>
+.fname&dev <span style="font-weight: bold;">type</span> <span
+ style="font-weight: bold;">cr</span><br>
+;<br>
+<br>
+: factl ( n -- n! )<br>
+<span style="font-weight: bold;">type</span> <span
+ style="font-weight: bold;">."</span> Entering Second vers. of <span
+ style="font-weight: bold;">"</span> <span style="font-weight: bold;">[function-name]</span>
+<span style="font-weight: bold;">cr</span><br>
+ <span style="font-weight: bold;">?dup</span> <span
+ style="font-weight: bold;">0=</span> <span style="font-weight: bold;">if</span>
+<span style="font-weight: bold;">1</span> factl<br>
+ <span style="font-weight: bold;">else</span> <span
+ style="font-weight: bold;">dup</span> <span style="font-weight: bold;">1-</span>
+<span style="font-weight: bold;">recurse</span> <span
+ style="font-weight: bold;">*</span><br>
+ <span style="font-weight: bold;">then</span><br>
+<span style="font-weight: bold;">type</span> <span
+ style="font-weight: bold;">."</span> Leaving Second vers. of <span
+ style="font-weight: bold;">"</span> <span style="font-weight: bold;">[function-name]</span>
+<span style="font-weight: bold;">cr</span><br>
+;<br>
+<br>
+<span style="font-weight: bold;">variable</span> naught<br>
+<span style="font-weight: bold;">defer</span> do-nothing<br>
+20 <span style="font-weight: bold;">value</span> twenty<br>
+30 <span style="font-weight: bold;">value</span> thirty<br>
+40 <span style="font-weight: bold;">buffer:</span> forty<br>
+50 <span style="font-weight: bold;">constant</span> fifty<br>
+<span style="font-weight: bold;">create</span> three 0 <span
+ style="font-weight: bold;">,</span> 00 <span
+ style="font-weight: bold;">,</span> <span style="font-weight: bold;">h#</span>
+000 <span style="font-weight: bold;">,</span><br>
+<span style="font-weight: bold;">struct</span><br>
+4 <span style="font-weight: bold;">field</span> >four<br>
+<span style="font-weight: bold;">constant</span> /four<br>
+<br>
+: peril<br>
+
+.dbg-enter
+\ This will display Entering peril in billy<br>
+ <span style="font-weight: bold;">[']</span> <span
+ style="font-weight: bold;">noop</span> <span
+ style="font-weight: bold;">to</span> do-nothing<br>
+ 100 <span style="font-weight: bold;">to</span>
+thirty<br>
+ 5 <span style="font-weight: bold;">to</span>
+naught
+<span style="font-style: italic;">\ Generates a WARNING</span><br>
+ thirty <span style="font-weight: bold;">dup</span> <span
+ style="font-weight: bold;">-</span> <span style="font-weight: bold;">abort"</span>
+Never Happen<span style="font-weight: bold;">"</span><br>
+
+.dbg-leave
+\ You get the idea...<br>
+;<br>
+<br>
+: thirty ( new-val -- )<br>
+ .dbg-enter<br>
+ <span style="font-weight: bold;">dup</span> <span
+ style="font-weight: bold;">to</span> thirty<br>
+ <span style="font-weight: bold;">alias</span> .dec <span
+ style="font-weight: bold;">.d</span>
+\ Generates a WARNING and an ADVISORY<br>
+ ." Dirty" .dec<br>
+ .dbg-leave<br>
+;<br>
+<br>
+\ First subsidiary device, "child" of billy<br>
+<span style="font-weight: bold;">new-device</span><br>
+ <span style="font-weight: bold;">instance</span> <span
+ style="font-weight: bold;">variable</span> cheryl<br>
+ <span style="font-weight: bold;">[macro]</span>
+my-dev-name <span style="font-weight: bold;">"</span> cheryl<span
+ style="font-weight: bold;">"</span><br>
+ name-my-dev<br>
+<br>
+ \ Third-level device, "grandchild" of billy<br>
+ <span style="font-weight: bold;">new-device</span><br>
+ <span
+ style="font-weight: bold;">[macro]</span> my-dev-name <span
+ style="font-weight: bold;">"</span> meryl<span
+ style="font-weight: bold;">"</span><br>
+ name-my-dev<br>
+ <span
+ style="font-weight: bold;">variable</span> debug-meryl?
+debug-meryl? <span style="font-weight: bold;">off</span><br>
+ <span
+ style="font-weight: bold;">alias</span> debug-me? debug-meryl?<br>
+<br>
+ : merle<br>
+
+.dbg-enter
+\ This will display Entering merle in meryl<br>
+
+cheryl
+\ ERROR. Is in a different dev-node.<br>
+ .dbg-leave<br>
+ ;<br>
+ <span style="font-weight: bold;">variable</span>
+beryl<br>
+ <span style="font-weight: bold;">finish-device</span><br>
+<br>
+ \ Now we're back to "cheryl"<br>
+ <br>
+ <span style="font-weight: bold;">variable</span>
+debug-cheryl? debug-cheryl? <span style="font-weight: bold;">off</span><br>
+ alias debug-me? debug-cheryl?<br>
+<br>
+ : queryl<br>
+
+.dbg-enter
+\ This will display Entering queryl in cheryl<br>
+ <span style="font-weight: bold; font-style: italic;">over
+rot dup nip drop swap</span> \ Not the most useful
+code... ;-}<br>
+ .dbg-leave<br>
+ ;<br>
+<span style="font-weight: bold;">finish-device</span><br>
+\ And we're back to billy.<br>
+: droop ( -- )<br>
+
+.dbg-enter
+\ This will display Entering droop in billy<br>
+ twenty<br>
+ 0 <span style="font-weight: bold;">?do</span> i .h <span
+ style="font-weight: bold;">loop</span><br>
+
+.dbg-leave
+\ You get the idea....<br>
+;<br>
+<br>
+<a name="Example_5_func_nam"></a><br>
+\ The following will generate some unexpected errors:<br>
+: quack ( maybe not -- oops! I-forgot-the-close-paren<br>
+
+.dbg-enter
+\ This should display Entering quack in billy<br>
+
+\ But it doesn't display anything and I don't know why.<br>
+ h# 30 .d<br>
+
+.dbg-leave
+\ and I'm still baffled...<br>
+; \ Oh, well, soldier on...<br>
+: cluck ( don't count -- before hatched ) \ Now, <span
+ style="font-style: italic;">there's</span> a close-paren....
+</div>
+<br>
+<div
+ style="color: black; font-family: helvetica,arial,sans-serif; font-weight: bold;"><span
+ style="font-style: italic;">Note:</span> At this point,
+the Tokenizer has issued a <a href="#Allow_Multi_Line">Multi-Line
+Warning</a> about a Comment that
+began six lines earlier, which gives the User a good indication as to
+just what
+went wrong... </div>
+<br>
+<div
+ style="margin-left: 40px; color: rgb(68, 34, 0); font-family: courier new,courier,monospace;">
+.dbg-enter
+\ This does display, but not what I expected.<br>
+ ." Coming from" <a href="#Inp_Fil_Nm_Strg">[input-file-name]</a>
+type ." line
+" <a href="#Inp_Fil_Nm_Strg">[line-number]</a> .d cr<br>
+tokenizer[ <a href="#function_name">[function-name]</a>
+]tokenizer \ Let's not wait for run-time<br>
+
+.dbg-leave
+\ Now I get it...<br>
+;<br>
+<span style="font-weight: bold;">fcode-end</span><br>
+<br>
+</div>
+<br>
+<h2><a class="mozTocH2" name="mozTocId856440"></a>End Of Document</h2>
+<!-- =========================================================================== -->
+</body>
+</html>
diff --git a/documentation/workbook.css b/documentation/workbook.css
new file mode 100644
index 0000000..c6d0932
--- /dev/null
+++ b/documentation/workbook.css
@@ -0,0 +1,426 @@
+/************ This page modified on March 14, 2001 by Sharon Rempert ***************/
+.title
+{
+ text-align: right;
+}
+/*table*/
+table
+{
+ padding: 3px;
+ border: 1px;
+ margin-left: 20px;
+}
+.small
+{
+ font-size: 10pt;
+}
+
+/* body */
+body
+{
+ margin: 1em 2em 2em 1em;
+ font-family: sans-serif;
+ color: black;
+ background: white;
+}
+
+.draft
+{
+ margin: 1em 2em 2em 2em;
+ color: black;
+ background: white url(/:/projects/esw/process/doc/draft.gif) no-repeat fixed top left;
+}
+
+p, a,ul,dt,li,dd,ol,b,i,blockquote,font
+{
+ font-family: sans-serif;
+}
+
+address
+{
+ font-size: 10pt;
+ text-align: center;
+ font-family: sans-serif;
+}
+
+.logo
+{
+ text-align: center;
+}
+
+/*text*/
+
+
+p.adoption
+{
+ color: #0050B2;
+ background: white;
+ font-size: large;
+}
+
+p.copyright {font-size: small;}
+
+p.warning
+{
+ color: #901010;
+ background: white;
+ margin: 1em 4em 1em 4em;
+ border: solid red;
+}
+
+.note1
+{
+ width: 80%;
+ border: solid #800080;
+}
+.note
+{
+ color: green;
+ background: white;
+}
+
+pre
+{
+ white-space: pre;
+ font-family: monospace;
+ margin-left: 2em;
+ color: maroon;
+ background: white;
+}
+
+pre.example
+{
+ white-space: pre;
+ color: #203838;
+ background: #B0E0E0;
+ margin: 1em 4em 1em 4em;
+ padding: 0.5em 0.5em 0.5em 0.5em;
+ font-family: monospace;
+ border: none;
+}
+
+pre.code
+{
+ white-space: pre;
+ color: maroon;
+ background: #eed6b4;
+ margin: 1em 4em 1em 0em;
+ padding: 1em 1em 1em 1em;
+ font-family: monospace;
+ border: none;
+}
+
+h1, h2, h3, h4, h5, h6
+{
+ font-family: sans-serif;
+ text-align: left;
+ font-weight: bold;
+ color: #0050B2;
+ background: white;
+}
+
+.special
+{
+ color: #FF0000;
+}
+.spec_head
+{
+ color: #FF0000;
+ text-decoration: underline;
+ font-weight: bold;
+}
+.spec_pre
+{
+ font-style: oblique;
+}
+
+
+h1.title
+{
+ text-align: left;
+}
+
+ul.toc
+{
+ list-style: none;
+}
+
+dl { margin-top: 1em; }
+
+th, td
+{
+ font-family: sans-serif;
+ vertical-align:top;
+}
+.command
+{
+ font-weight: 700;
+ color: #0050B2;
+ background-color: white;
+}
+
+.description
+{
+ margin: 40px 0px 0px 0px;
+ font-family: sans-serif;
+}
+
+/*media*/
+
+@media screen
+{
+ a:hover
+ {
+ background: #FFFFAA;
+ color: blue;
+ }
+}
+
+@media aural
+{
+ h1, h2, h3
+ {
+ stress: 20;
+ richness: 90;
+ }
+
+ .hide {speak: none;}
+
+ p.copyright
+ {
+ volume: x-soft;
+ speech-rate: x-fast;
+ }
+
+ dt {pause-before: 20%;}
+ pre {speak-punctuation: code;}
+}
+
+/* inline markup */
+
+em {font-style: italic;}
+
+strong {font-weight: bold;}
+
+.emp
+{
+ font-weight: bold;
+ text-decoration: underline;
+}
+
+
+.strongerEmp
+{
+ font-weight: 900;
+ font-style: italic;
+}
+
+cite {font-style: italic;}
+
+dfn
+{
+ font-weight: 700;
+ font-style: italic;
+}
+
+var
+{
+ font-style: italic;
+ font-family: monospace;
+ color: #0000CD;
+ background: white;
+}
+
+acronym
+{
+ font-variant: small-caps;
+ font-style: normal;
+}
+
+abbr {font-style: normal;}
+
+code
+{
+ font-style: normal;
+ font-family: monospace;
+ color: #a72ea0;
+ background: white;
+}
+
+samp
+{
+ font-style: normal;
+ font-family: monospace;
+ color: #a723a0;
+ background: white;
+}
+
+kbd
+{
+ font-style: italic;
+ font-family: monospace;
+ color: #0000CD;
+ background: white;
+}
+
+/*hide*/
+
+.hide {display: none}
+
+/*span*/
+
+span.doc-string
+{
+ /* purple */
+ color: purple;
+ background-color: white;
+}
+
+span.reference
+{
+ /* red3 */
+ color: rgb(205,0,0);
+ background-color: white;
+}
+
+span.type
+{
+ /* MediumPurple3 */
+ color: rgb(137,104,205);
+ background-color: white;
+}
+
+span.function-name
+{
+ /* forestgreen */
+ color: rgb(34,139,34);
+ font-weight: bold;
+ background-color: white;
+}
+
+span.string
+{
+ /* blue4 */
+ color: rgb(0,0,139);
+ background-color: white;
+}
+
+span.comment
+{
+ /* red */
+ color: red;
+ font-style:italic;
+ background-color: white;
+}
+
+span.variable-name
+{
+ /* blue3 */
+ color: rgb(0,0,205);
+ background-color: white;
+}
+
+span.preprocessor
+{
+ /* blue3 */
+ color: rgb(0,0,205);
+ background-color: white;
+}
+
+span.keyword
+{
+ /* goldenrod3 */
+ color: rgb(205,155,29);
+ background-color: white;
+}
+
+.lists
+{
+ font-size: 14pt;
+ font-family: sans-serif;
+ text-align: left;
+ font-weight: bold;
+ color: #0050B2;
+ background: white;
+}
+
+
+.text
+{
+ font-family: sans-serif;
+}
+
+/*div*/
+
+.subtoc
+{
+ /*padding: 1em;*/
+ border: solid thin;
+ /*margin: 1em 0;*/
+ color: white;
+ background: #d0d0d0;
+}
+
+
+div.head {margin-bottom: 1em;}
+
+div.head h1
+{
+ margin-top: 2em;
+ clear: both;
+}
+
+div.head table
+{
+ margin-left: 2em;
+ margin-top: 2em;
+}
+
+div.head img
+{
+ color: black;
+ background: white;
+ border: none;
+}
+
+.document-control_2
+{
+ border: solid #404040;
+ color: black;
+ background: #e0e0e0;
+}
+
+.document-control
+{
+ margin-top: 1em;
+ margin-left: 10%;
+ margin-bottom: 1em;
+ border: solid #404040;
+ color: black;
+ background: #e0e0e0;
+}
+
+/* why doesn't dt work here? */
+div.document-control dl dt
+{
+ font-weight: bold;
+}
+
+
+/*links*/
+
+a.normref
+{
+ color: red;
+ background: white;
+}
+
+a.informref
+{
+ color: green;
+ background: white;
+}
+.no_bullet
+{
+ list-style-type: none;
+}