summaryrefslogtreecommitdiffstats
path: root/scm.texi
blob: f0cd4859468f1bc1881eee383f759cd29ecf3209 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename scm.info
@settitle SCM
@include version.txi
@setchapternewpage on
@c Choices for setchapternewpage are {on,off,odd}.
@paragraphindent 0
@defcodeindex ft
@syncodeindex ft tp
@c %**end of header

@dircategory The Algorithmic Language Scheme
@direntry
* SCM: (scm).           A Scheme interpreter.
@end direntry

@iftex
@finalout
@c DL: lose the egregious vertical whitespace, esp. around examples
@c but paras in @defun-like things don't have parindent
@parskip 4pt plus 1pt
@end iftex

@titlepage
@title SCM
@subtitle Scheme Implementation
@subtitle Version @value{SCMVERSION}
@author by Aubrey Jaffer

@page
@vskip 0pt plus 1filll
Copyright @copyright{} 1990-1999 Free Software Foundation

Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the entire
resulting derived work is distributed under the terms of a permission
notice identical to this one.

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation approved
by the author.
@end titlepage

@node Top, Overview, (dir), (dir)


@ifinfo
This manual documents the SCM Scheme implementation.  SCM version
@value{SCMVERSION} was released @value{SCMDATE}.  The most recent
information about SCM can be found on SCM's @dfn{WWW} home page:

@center @url{http://swissnet.ai.mit.edu/~jaffer/SCM.html}


Copyright (C) 1990-1999 Free Software Foundation

Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

@ignore
Permission is granted to process this file through TeX and print the
results, provided the printed document carries copying permission
notice identical to this one except for the removal of this paragraph
(this paragraph not being relevant to the printed manual).

@end ignore
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the entire
resulting derived work is distributed under the terms of a permission
notice identical to this one.

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation approved
by the author.
@end ifinfo

@menu
* Overview::                    
* Installing SCM::              
* Operational Features::        
* The Language::                Reference.
* Packages::                    Optional Capabilities.
* The Implementation::          How it works.
* Index::                       
@end menu

@node Overview, Installing SCM, Top, Top
@chapter Overview

@noindent
Scm is a portable Scheme implementation written in C.  Scm provides a
machine independent platform for [JACAL], a symbolic algebra system.

@iftex
@noindent
The most recent information about SCM can be found on SCM's @dfn{WWW}
home page:

@ifset html
<A HREF="http://swissnet.ai.mit.edu/~jaffer/SCM.html">
@end ifset
@center @url{http://swissnet.ai.mit.edu/~jaffer/SCM.html}
@ifset html
</A>
@end ifset
@end iftex

@menu
* SCM Features::                
* SCM Authors::                 
* Copying::                     
* Bibliography::                
@end menu

@node SCM Features, SCM Authors, Overview, Overview
@section Features

@itemize @bullet
@item
Conforms to Revised^5 Report on the Algorithmic Language Scheme [R5RS]
and the [IEEE] P1178 specification.
@item
Support for [SICP], [R2RS], [R3RS], and [R5RS] scheme code.
@item
Runs under Amiga, Atari-ST, MacOS, MS-DOS, OS/2, NOS/VE, Unicos, VMS,
Unix and similar systems.  Supports ASCII and EBCDIC character sets.
@item
Is fully documented in @TeX{}info form, allowing documentation to be
generated in info, @TeX{}, html, nroff, and troff formats.
@item
Supports inexact real and complex numbers, 30 bit immediate integers and
large precision integers.
@item
Many Common Lisp functions: @code{logand}, @code{logor}, @code{logxor},
@code{lognot}, @code{ash}, @code{logcount}, @code{integer-length},
@code{bit-extract}, @code{defmacro}, @code{macroexpand},
@code{macroexpand1}, @code{gentemp}, @code{defvar}, @code{force-output},
@code{software-type}, @code{get-decoded-time},
@code{get-internal-run-time}, @code{get-internal-real-time},
@code{delete-file}, @code{rename-file}, @code{copy-tree}, @code{acons},
and @code{eval}.
@item
@code{Char-code-limit}, @code{most-positive-fixnum},
@code{most-negative-fixnum}, @code{and internal-time-units-per-second}
constants.  @code{*Features*} and @code{*load-pathname*} variables.
@item
Arrays and bit-vectors.  String ports and software emulation ports.
I/O extensions providing ANSI C and POSIX.1 facilities.
@item
Interfaces to standard libraries including REGEX string regular
expression matching and the CURSES screen management package.
@item
Available add-on packages including an interactive debugger, database,
X-window graphics, BGI graphics, Motif, and Open-Windows packages.
@item
A compiler (HOBBIT, available separately) and dynamic linking of
compiled modules.
@item
User definable responses to interrupts and errors,
Process-syncronization primitives.  Setable levels of monitoring and
timing information printed interactively (the @code{verbose} function).
@code{Restart}, @code{quit}, and @code{exec}.
@end itemize

@node SCM Authors, Copying, SCM Features, Overview
@section Authors

@table @b
@item Aubrey Jaffer (jaffer @@ alum.mit.edu)
Most of SCM.
@item Radey Shouman
Arrays, @code{gsubr}s, compiled closures, records, Ecache, syntax-rules
macros, and @dfn{safeport}s.
@item Jerry D. Hedden
Real and Complex functions.  Fast mixed type arithmetics.
@item Hugh Secker-Walker
Syntax checking and memoization of special forms by evaluator.  Storage
allocation strategy and parameters.
@item George Carrette
@dfn{Siod}, written by George Carrette, was the starting point for SCM.
The major innovations taken from Siod are the evaluator's use of the
C-stack and being able to garbage collect off the C-stack
(@pxref{Garbage Collection}).
@end table

@noindent
There are many other contributors to SCM.  They are acknowledged in the
file @file{ChangeLog}, a log of changes that have been made to scm.

@node Copying, Bibliography, SCM Authors, Overview
@section Copyright

@noindent
Authors have assigned their SCM copyrights to:
@sp 1

@center Free Software Foundation, Inc.
@center 59 Temple Place, Suite 330, Boston, MA 02111, USA

@noindent
Permission to use, copy, modify, distribute, and sell this software and
its documentation for any purpose is hereby granted without fee,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation.

@center NO WARRANTY

@noindent
BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH
YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR OR CORRECTION.

@noindent
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL
DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM
(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF
THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR
OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.


@heading SIOD copyright
@sp 1

@center COPYRIGHT (c) 1989 BY
@center PARADIGM ASSOCIATES INCORPORATED, CAMBRIDGE, MASSACHUSETTS.
@center ALL RIGHTS RESERVED

@noindent
Permission to use, copy, modify, distribute and sell this software
and its documentation for any purpose and without fee is hereby
granted, provided that the above copyright notice appear in all copies
and that both that copyright notice and this permission notice appear
in supporting documentation, and that the name of Paradigm Associates
Inc not be used in advertising or publicity pertaining to distribution
of the software without specific, written prior permission.

@noindent
PARADIGM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
PARADIGM BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

@noindent
gjc@@paradigm.com
@flushright
Phone: 617-492-6079
@end flushright
@flushleft
Paradigm Associates Inc
29 Putnam Ave, Suite 6
Cambridge, MA 02138
@end flushleft

@node Bibliography,  , Copying, Overview
@section Bibliography

@table @asis

@item [IEEE]
@cindex IEEE
@cite{IEEE Standard 1178-1990.  IEEE Standard for the Scheme
Programming Language.}  IEEE, New York, 1991.

@item [R4RS]
@cindex R4RS
William Clinger and Jonathan Rees, Editors.
@ifset html
<A HREF="r4rs_toc.html">
@end ifset
Revised(4) Report on the Algorithmic Language Scheme.
@ifset html
</A>
@end ifset
@cite{ACM Lisp Pointers} Volume IV, Number 3 (July-September 1991),
pp. 1-55.
@ifinfo

@ref{Top, , , r4rs, Revised(4) Report on the Algorithmic Language
Scheme}.
@end ifinfo

@item [R5RS]
@cindex R5RS
Richard Kelsey and William Clinger and Jonathan (Rees, editors)
@ifset html
<A HREF="r5rs_toc.html">
@end ifset
Revised(5) Report on the Algorithmic Language Scheme.
@ifset html
</A>
@end ifset
@cite{Higher-Order and Symbolic Computation} Volume 11, Number 1 (1998),
pp. 7-105, and
@cite{ACM SIGPLAN Notices} 33(9), September 1998.
@ifinfo

@ref{Top, , , r5rs, Revised(5) Report on the Algorithmic Language
Scheme}.
@end ifinfo

@item [Exrename]
@cindex Exrename
William Clinger
@ifset html
<A HREF="http://www.cs.indiana.edu/scheme-repository/doc.proposals.html">
@end ifset
Hygienic Macros Through Explicit Renaming
@ifset html
</A>
@end ifset
@cite{Lisp Pointers} Volume IV, Number 4 (December 1991),
pp 17-23.

@item [SICP]
@cindex SICP
Harold Abelson and Gerald Jay Sussman with Julie Sussman.
@cite{Structure and Interpretation of Computer Programs.}
MIT Press, Cambridge, 1985.

@item [Simply]
@cindex Simply
Brian Harvey and Matthew Wright.
@ifset html
<A HREF="http://HTTP.CS.Berkeley.EDU/~bh/simply-toc.html">
@end ifset
@cite{Simply Scheme: Introducing Computer Science}
@ifset html
</A>
@end ifset
MIT Press, 1994 ISBN 0-262-08226-8

@item [SchemePrimer]
@cindex SchemePrimer
$B8$;tBg(B(Dai Inukai)
@ifset html
<A HREF="http://www.shuwasystem.co.jp/SchemePrimer/">
@end ifset
@cite{$BF~Lg(BScheme}
@ifset html
</A>
@end ifset
1999$BG/(B12$B7n=iHG(B ISBN4-87966-954-7

@c  @item [GUILE]
@c  @cindex GUILE
@c  Free Software Foundation
@c  @ifset html
@c  <A HREF="http://www.gnu.org/software/guile/guile.html">
@c  @end ifset
@c  Guile: Project GNU's extension language
@c  @ifset html
@c  </A>
@c  @end ifset

@item [SLIB]
@cindex SLIB
Todd R. Eigenschink, Dave Love, and Aubrey Jaffer.
@ifset html
<A HREF="slib_toc.html">
@end ifset
SLIB, The Portable Scheme Library.
@ifset html
</A>
@end ifset
Version 2c8, June 2000.
@ifinfo

@ref{Top, , , slib, SLIB}.
@end ifinfo

@item [JACAL]
@cindex JACAL
Aubrey Jaffer.
@ifset html
<A HREF="jacal_toc.html">
@end ifset
JACAL Symbolic Mathematics System.
@ifset html
</A>
@end ifset
Version 1b0, Sep 1999.
@ifinfo

@ref{Top, , , jacal, JACAL}.
@end ifinfo
@end table

@table @file
@item scm.texi
@itemx scm.info
Documentation of @code{scm} extensions (beyond Scheme standards).
Documentation on the internal representation and how to extend or
include @code{scm} in other programs.
@item Xlibscm.texi
@itemx Xlibscm.info
Documentation of the Xlib - SCM Language X Interface.
@end table

@node Installing SCM, Operational Features, Overview, Top
@chapter Installing SCM

@menu
* Making SCM::                  Bootstrapping.
* SLIB::                        REQUIREd reading.
* Building SCM::                
* Installing Dynamic Linking::  
* Configure Module Catalog::    
* Saving Images::               Make Fast-Booting Executables
* Automatic C Preprocessor Definitions::  
* Problems Compiling::          
* Problems Linking::            
* Problems Running::            
* Testing::                     
* Reporting Problems::          
@end menu

@node Making SCM, SLIB, Installing SCM, Installing SCM
@section Making SCM

The SCM distribution has @dfn{Makefile} which contains rules for making
@dfn{scmlit}, a ``bare-bones'' version of SCM sufficient for running
@file{build}.  @file{build} is used to compile (or create scripts to
compile) full featured versions.

Makefiles are not portable to the majority of platforms.  If
@file{Makefile} works for you, good; If not, I don't want to hear about
it.  If you need to compile SCM without build, there are several ways to
proceed:

@itemize @bullet
@item
Use the @uref{http://swissnet.ai.mit.edu/~jaffer/buildscm.html, build}
web page to create custom batch scripts for compiling SCM.

@item
Use SCM on a different platform to run @file{build} to create a script
to build SCM;

@item
Use another implementation of Scheme to run @file{build} to create a
script to build SCM;

@item
Create your own script or @file{Makefile}.
@end itemize


@node SLIB, Building SCM, Making SCM, Installing SCM
@section SLIB

@noindent
[SLIB] is a portable Scheme library meant to provide compatibility and
utility functions for all standard Scheme implementations.  Although
SLIB is not @emph{neccessary} to run SCM, I strongly suggest you obtain
and install it.  Bug reports about running SCM without SLIB have very
low priority.  SLIB is available from the same sites as SCM:

@ifclear html
@itemize @bullet
@item
swissnet.ai.mit.edu:/pub/scm/slib2d4.tar.gz
@item
ftp.gnu.org:/pub/gnu/jacal/slib2d4.tar.gz
@item
ftp.cs.indiana.edu:/pub/scheme-repository/imp/slib2d4.tar.gz
@end itemize
@end ifclear

@ifset html
@itemize @bullet
@item
<A HREF="http://swissnet.ai.mit.edu/ftpdir/scm/slib2d4.zip">
http://swissnet.ai.mit.edu/ftpdir/scm/slib2d4.zip
</A>
@item
<A HREF="ftp://ftp.gnu.org/pub/gnu/jacal/slib2d4.tar.gz">
ftp.gnu.org:/pub/gnu/jacal/slib2d4.tar.gz
</A>
@item
<A HREF="ftp://ftp.cs.indiana.edu/pub/scheme-repository/code/lib/slib2d4.tar.gz">
ftp.cs.indiana.edu:/pub/scheme-repository/code/lib/slib2d4.tar.gz
</A>
@end itemize
@end ifset

@noindent
Unpack SLIB (@samp{tar xzf slib2d4.tar.gz} or @samp{unzip -ao
slib2d4.zip}) in an appropriate directory for your system; both
@code{tar} and @code{unzip} will create the directory @file{slib}.

@noindent
Then create a file @file{require.scm} in the SCM
@dfn{implementation-vicinity} (this is the same directory as where the
file @file{Init@value{SCMVERSION}.scm} is installed).
@file{require.scm} should have the contents:

@example
(define (library-vicinity) "/usr/local/lib/slib/")
(load (in-vicinity (library-vicinity) "require"))
@end example

@noindent
where the pathname string @file{/usr/local/lib/slib/} is to be replaced
by the pathname into which you installed SLIB.  Absolute pathnames are
recommended here; if you use a relative pathname, SLIB can get confused
when the working directory is changed (@pxref{I/O-Extensions, chmod}).
The way to specify a relative pathname is to append it to the
implementation-vicinity, which is absolute:

@example
(define library-vicinity
  (let ((lv (string-append (implementation-vicinity) "../slib/")))
    (lambda () lv)))
(load (in-vicinity (library-vicinity) "require"))
@end example

@noindent
Alternatively, you can set the (shell) environment variable
@code{SCHEME_LIBRARY_PATH} to the pathname of the SLIB directory
(@pxref{SCM Variables, SCHEME_LIBRARY_PATH, Environment Variables}).  If
set, the environment variable overrides @file{require.scm}.  Again,
absolute pathnames are recommended.


@node Building SCM, Installing Dynamic Linking, SLIB, Installing SCM
@section Building SCM

The file @dfn{build} loads the file @dfn{build.scm}, which constructs a
relational database of how to compile and link SCM executables.
@file{build.scm} has information for the platforms which SCM has been
ported to (of which I have been notified).  Some of this information is
old, incorrect, or incomplete.  Send corrections and additions to jaffer
@@ ai.mit.edu.

@menu
* Invoking Build::              
* Build Options::               
* Compiling and Linking Custom Files::  
@end menu

@node Invoking Build, Build Options, Building SCM, Building SCM
@subsection Invoking Build

@noindent
The @emph{all} method will also work for MS-DOS and unix.  Use
the @emph{all} method if you encounter problems with @file{build}.

@table @asis
@item MS-DOS
From the SCM source directory, type @samp{build} followed by up to 9
command line arguments.

@item unix
From the SCM source directory, type @samp{./build} followed by command
line arguments.

@item @emph{all}
From the SCM source directory, start @samp{scm} or @samp{scmlit} and
type @code{(load "build")}.  Alternatively, start @samp{scm} or
@samp{scmlit} with the command line argument @samp{-ilbuild}.

@end table

@noindent
Invoking build without the @samp{-F} option will build or create a shell
script with the @code{arrays}, @code{inexact}, and @code{bignums}
options as defaults.

@example
bash$ ./build
@print{}
#! /bin/sh
# unix (linux) script created by SLIB/batch 
# ================ Write file with C defines
rm -f scmflags.h
echo '#define IMPLINIT "Init@value{SCMVERSION}.scm"'>>scmflags.h
echo '#define BIGNUMS'>>scmflags.h
echo '#define FLOATS'>>scmflags.h
echo '#define ARRAYS'>>scmflags.h
# ================ Compile C source files
gcc -O2 -c continue.c scm.c scmmain.c findexec.c script.c time.c repl.c scl.c eval.c sys.c subr.c debug.c unif.c rope.c
# ================ Link C object files
gcc -rdynamic -o scm continue.o scm.o scmmain.o findexec.o script.o time.o repl.o scl.o eval.o sys.o subr.o debug.o unif.o rope.o -lm -lc
@end example

@noindent
To cross compile for another platform, invoke build with the @samp{-p}
or @samp{--platform=} option.  This will create a script for the
platform named in the @samp{-p} or @samp{--platform=} option.

@example
bash$ ./build -o scmlit -p darwin -F lit
@print{}
#! /bin/sh
# unix (darwin) script created by SLIB/batch 
# ================ Write file with C defines
rm -f scmflags.h
echo '#define IMPLINIT "Init@value{SCMVERSION}.scm"'>>scmflags.h
# ================ Compile C source files
cc -O3 -c continue.c scm.c scmmain.c findexec.c script.c time.c repl.c scl.c eval.c sys.c subr.c debug.c unif.c rope.c
# ================ Link C object files
mv -f scmlit scmlit~
cc -o scmlit continue.o scm.o scmmain.o findexec.o script.o time.o repl.o scl.o eval.o sys.o subr.o debug.o unif.o rope.o
@end example


@node Build Options, Compiling and Linking Custom Files, Invoking Build, Building SCM
@subsection Build Options

@noindent
The options to @dfn{build} specify what, where, and how to build a SCM
program or dynamically linked module.  These options are unrelated to
the SCM command line options.

@deffn {Build Option} -p @var{platform-name}
@deffnx {Build Option} ---platform=@var{platform-name}
specifies that the compilation should be for a computer/operating-system
combination called @var{platform-name}.  @emph{Note:} The case of
@var{platform-name} is distinguised.  The current @var{platform-name}s
are all lower-case.

The platforms defined by table @dfn{platform} in @file{build.scm} are:
@end deffn
@example
@include platform.txi
@end example

@deffn {Build Option} -o @var{filename}
@deffnx {Build Option} ---outname=@var{filename}
specifies that the compilation should produce an executable or object
name of @var{filename}.  The default is @samp{scm}.  Executable suffixes
will be added if neccessary, e.g. @samp{scm} @result{} @samp{scm.exe}.
@end deffn

@deffn {Build Option} -l @var{libname} @dots{}
@deffnx {Build Option} ---libraries=@var{libname}
specifies that the @var{libname} should be linked with the executable
produced.  If compile flags or include directories (@samp{-I}) are
needed, they are automatically supplied for compilations.  The @samp{c}
library is always included.  SCM @dfn{features} specify any libraries
they need; so you shouldn't need this option often.
@end deffn

@deffn {Build Option} -D @var{definition} @dots{}
@deffnx {Build Option} ---defines=@var{definition}
specifies that the @var{definition} should be made in any C source
compilations.  If compile flags or include directories (@samp{-I}) are
needed, they are automatically supplied for compilations.  SCM
@dfn{features} specify any flags they need; so you shouldn't need this
option often.
@end deffn

@deffn {Build Option} ---compiler-options=@var{flag}
specifies that that @var{flag} will be put on compiler command-lines.
@end deffn

@deffn {Build Option} ---linker-options=@var{flag}
specifies that that @var{flag} will be put on linker command-lines.
@end deffn

@deffn {Build Option} -s @var{pathname}
@deffnx {Build Option} ---scheme-initial=@var{pathname}
specifies that @var{pathname} should be the default location of the SCM
initialization file @file{Init@value{SCMVERSION}.scm}.  SCM tries
several likely locations before resorting to @var{pathname}
(@pxref{File-System Habitat}).  If not specified, the current directory
(where build is building) is used.
@end deffn

@deffn {Build Option} -c @var{pathname} @dots{}
@deffnx {Build Option} ---c-source-files=@var{pathname}
specifies that the C source files @var{pathname} @dots{} are to be
compiled.
@end deffn

@deffn {Build Option} -j @var{pathname} @dots{}
@deffnx {Build Option} ---object-files=@var{pathname}
specifies that the object files @var{pathname} @dots{} are to be linked.
@end deffn

@deffn {Build Option} -i @var{call} @dots{}
@deffnx {Build Option} ---initialization=@var{call}
specifies that the C functions @var{call} @dots{} are to be
invoked during initialization.
@end deffn

@deffn {Build Option} -t @var{build-what}
@deffnx {Build Option} ---type=@var{build-what}
specifies in general terms what sort of thing to build.  The choices
are:
@table @samp
@item exe
executable program.
@item lib
library module.
@item dlls
archived dynamically linked library object files.
@item dll
dynamically linked library object file.
@end table

The default is to build an executable.
@end deffn

@deffn {Build Option} -h @var{batch-syntax}
@deffnx {Build Option} --batch-dialect=@var{batch-syntax}
specifies how to build.  The default is to create a batch file for the
host system.  The SLIB file @file{batch.scm} knows how to create batch
files for:
@itemize @bullet
@item
unix
@item
dos
@item
vms
@item
amigaos (was amigados)
@item
system

This option executes the compilation and linking commands through the
use of the @code{system} procedure.
@item
*unknown*

This option outputs Scheme code.
@end itemize
@end deffn

@deffn {Build Option} -w @var{batch-filename}
@deffnx {Build Option} --script-name=@var{batch-filename}
specifies where to write the build script.  The default is to display it
on @code{(current-output-port)}.
@end deffn

@deffn {Build Option} -F @var{feature} @dots{}
@deffnx {Build Option} ---features=@var{feature}
specifies to build the given features into the executable.  The defined
features are:

@table @dfn
@c  @itemx none
@c  @cindex none
@c  Lightweight -- no features

@include features.txi

@end table
@end deffn

@node Compiling and Linking Custom Files,  , Build Options, Building SCM
@subsection Compiling and Linking Custom Files

@noindent
A correspondent asks:

@quotation
How can we link in our own c files to the SCM interpreter so that we can
add our own functionality?  (e.g. we have a bunch of tcp functions we
want access to).  Would this involve changing build.scm or the Makefile
or both?
@end quotation

@noindent
(@pxref{Changing Scm} has instructions describing the C code format).
@cindex foo.c
@cindex Extending Scm
Suppose a C file @dfn{foo.c} has functions you wish to add to SCM.  To
compile and link your file at compile time, use the @samp{-c} and
@samp{-i} options to build:

@example
bash$ build -c foo.c -i init_foo
@print{}
#! /bin/sh
rm -f scmflags.h
echo '#define IMPLINIT "/home/jaffer/scm/Init@value{SCMVERSION}.scm"'>>scmflags.h
echo '#define COMPILED_INITS init_foo();'>>scmflags.h
echo '#define BIGNUMS'>>scmflags.h
echo '#define FLOATS'>>scmflags.h
echo '#define ARRAYS'>>scmflags.h
gcc -O2 -c continue.c scm.c findexec.c script.c time.c repl.c scl.c \
        eval.c sys.c subr.c unif.c rope.c foo.c
gcc -rdynamic -o scm continue.o scm.o findexec.o script.o time.o \
        repl.o scl.o eval.o sys.o subr.o unif.o rope.o foo.o -lm -lc
@end example

@noindent
To make a dynamically loadable object file use the @code{-t dll} option:

@example
bash$ build -t dll -c foo.c
@print{}
#! /bin/sh
rm -f scmflags.h
echo '#define IMPLINIT "/home/jaffer/scm/Init@value{SCMVERSION}.scm"'>>scmflags.h
echo '#define BIGNUMS'>>scmflags.h
echo '#define FLOATS'>>scmflags.h
echo '#define ARRAYS'>>scmflags.h
echo '#define DLL'>>scmflags.h
gcc -O2 -fpic -c foo.c
gcc -shared -o foo.so foo.o -lm -lc
@end example

@noindent
Once @file{foo.c} compiles correctly (and your SCM build supports
dynamic-loading), you can load the compiled file with the Scheme command
@code{(load "./foo.so")}.  See @ref{Configure Module Catalog} for how to
add a compiled dll file to SLIB's catalog.

@node Installing Dynamic Linking, Configure Module Catalog, Building SCM, Installing SCM
@section Installing Dynamic Linking

@noindent
Dynamic linking has not been ported to all platforms.  Operating systems
in the BSD family (a.out binary format) can usually be ported to
@dfn{DLD}.  The @dfn{dl} library (@code{#define SUN_DL} for SCM) was a
proposed POSIX standard and may be available on other machines with
@dfn{COFF} binary format.  For notes about porting to MS-Windows and
finishing the port to VMS @ref{Finishing Dynamic Linking}.

@noindent
@dfn{DLD} is a library package of C functions that performs @dfn{dynamic
link editing} on Linux, VAX (Ultrix), Sun 3 (SunOS 3.4 and 4.0),
SPARCstation (SunOS 4.0), Sequent Symmetry (Dynix), and Atari ST.  It is
available from:

@ifclear html
@itemize @bullet
@item
ftp.gnu.org:pub/gnu/dld-3.3.tar.gz
@end itemize
@end ifclear

@ifset html
<A HREF="ftp://ftp.gnu.org/pub/gnu/dld-3.3.tar.gz">
ftp.gnu.org:pub/gnu/dld-3.3.tar.gz
</A>
@end ifset

@noindent
These notes about using libdl on SunOS are from @file{gcc.info}:

@quotation
On a Sun, linking using GNU CC fails to find a shared library and
reports that the library doesn't exist at all.

This happens if you are using the GNU linker, because it does only
static linking and looks only for unshared libraries.  If you have
a shared library with no unshared counterpart, the GNU linker
won't find anything.

We hope to make a linker which supports Sun shared libraries, but
please don't ask when it will be finished--we don't know.

Sun forgot to include a static version of @file{libdl.a} with some
versions of SunOS (mainly 4.1).  This results in undefined symbols when
linking static binaries (that is, if you use @samp{-static}).  If you
see undefined symbols @samp{_dlclose}, @samp{_dlsym} or @samp{_dlopen}
when linking, compile and link against the file
@file{mit/util/misc/dlsym.c} from the MIT version of X windows.
@end quotation


@node Configure Module Catalog, Saving Images, Installing Dynamic Linking, Installing SCM
@section Configure Module Catalog

@noindent
The SLIB module @dfn{catalog} can be extended to define other
@code{require}-able packages by adding calls to the Scheme source file
@file{mkimpcat.scm}.  Within @file{mkimpcat.scm}, the following
procedures are defined.

@defun add-link feature object-file lib1 @dots{}
@var{feature} should be a symbol.  @var{object-file} should be a string
naming a file containing compiled @dfn{object-code}.  Each @var{lib}n
argument should be either a string naming a library file or @code{#f}.

If @var{object-file} exists, the @code{add-link} procedure registers
symbol @var{feature} so that the first time @code{require} is called
with the symbol @var{feature} as its argument, @var{object-file} and the
@var{lib1} @dots{} are dynamically linked into the executing SCM
session.

If @var{object-file} exists, @code{add-link} returns @code{#t},
otherwise it returns @code{#f}.

For example, to install a compiled dll @file{foo}, add these lines to
@file{mkimpcat.scm}:

@example
        (add-link 'foo
                  (in-vicinity (implementation-vicinity) "foo"
                               link:able-suffix))
@end example


@end defun

@defun add-alias alias feature
@var{alias} and @var{feature} are symbols.  The procedure
@code{add-alias} registers @var{alias} as an alias for @var{feature}.
An unspecified value is returned.

@code{add-alias} causes @code{(require '@var{alias})} to behave like
@code{(require '@var{feature})}.
@end defun

@defun add-source feature filename
@var{feature} is a symbol.  @var{filename} is a string naming a file
containing Scheme source code.  The procedure @code{add-source}
registers @var{feature} so that the first time @code{require} is called
with the symbol @var{feature} as its argument, the file @var{filename}
will be @code{load}ed.  An unspecified value is returned.
@end defun

@noindent
Remember to delete the file @file{slibcat} after modifying the file
@file{mkimpcat.scm} in order to force SLIB to rebuild its cache.

@node Saving Images, Automatic C Preprocessor Definitions, Configure Module Catalog, Installing SCM
@section Saving Images

@noindent
In SCM, the ability to save running program images is called @dfn{dump}
(@pxref{Dump}).  In order to make @code{dump} available to SCM, build
with feature @samp{dump}.  @code{dump}ed executables are compatible with
dynamic linking.

@noindent
Most of the code for @dfn{dump} is taken from
@file{emacs-19.34/src/unex*.c}.  No modifications to the emacs source
code were required to use @file{unexelf.c}.  Dump has not been ported to
all platforms.  If @file{unexec.c} or @file{unexelf.c} don't work for
you, try using the appropriate @file{unex*.c} file from emacs.



@node Automatic C Preprocessor Definitions, Problems Compiling, Saving Images, Installing SCM
@section Automatic C Preprocessor Definitions

These @samp{#defines} are automatically provided by preprocessors of
various C compilers.  SCM uses the presence or absence of these
definitions to configure @dfn{include file} locations and aliases for
library functions.  If the definition(s) corresponding to your system
type is missing as your system is configured, add @code{-D@var{flag}} to
the compilation command lines or add a @code{#define @var{flag}} line to
@file{scmfig.h} or the beginning of @file{scmfig.h}.

@example
#define         Platforms:
-------         ----------
ARM_ULIB        Huw Rogers free unix library for acorn archimedes
AZTEC_C         Aztec_C 5.2a
__CYGWIN__      Cygwin
_DCC            Dice C on AMIGA
__GNUC__        Gnu CC (and DJGPP)
__EMX__         Gnu C port (gcc/emx 0.8e) to OS/2 2.0
__HIGHC__       MetaWare High C
__IBMC__        C-Set++ on OS/2 2.1
_MSC_VER        MS VisualC++ 4.2
MWC             Mark Williams C on COHERENT
__MWERKS__      Metrowerks Compiler; Macintosh and WIN32 (?)
_POSIX_SOURCE   ??
_QC             Microsoft QuickC
__STDC__        ANSI C compliant
__TURBOC__      Turbo C and Borland C
__USE_POSIX     ??
__WATCOMC__     Watcom C on MS-DOS
__ZTC__         Zortech C

_AIX            AIX operating system
__APPLE__       Apple Darwin
AMIGA           SAS/C 5.10 or Dice C on AMIGA
__amigaos__     Gnu CC on AMIGA
atarist         ATARI-ST under Gnu CC
__FreeBSD__     FreeBSD
GNUDOS          DJGPP (obsolete in version 1.08)
__GO32__        DJGPP (future?)
hpux            HP-UX
linux           Linux
macintosh       Macintosh (THINK_C and __MWERKS__ define)
MCH_AMIGA       Aztec_c 5.2a on AMIGA
__MACH__        Apple Darwin
MSDOS           Microsoft C 5.10 and 6.00A
__MSDOS__       Turbo C, Borland C, and DJGPP
nosve           Control Data NOS/VE
SVR2            System V Revision 2.
__SVR4          SunOS
THINK_C         developement environment for the Macintosh
ultrix          VAX with ULTRIX operating system.
unix            most Unix and similar systems and DJGPP (!?)
__unix__        Gnu CC and DJGPP
_UNICOS         Cray operating system
vaxc            VAX C compiler
VAXC            VAX C compiler
vax11c          VAX C compiler
VAX11           VAX C compiler
_Windows        Borland C 3.1 compiling for Windows
_WIN32          MS VisualC++ 4.2 and Cygwin (Win32 API)
vms             (and VMS) VAX-11 C under VMS.

__alpha         DEC Alpha processor
__alpha__       DEC Alpha processor
hp9000s800      HP RISC processor
__i386__        DJGPP
i386            DJGPP
MULTIMAX        Encore computer
ppc             PowerPC
__ppc__         PowerPC
pyr             Pyramid 9810 processor
__sgi__         Silicon Graphics Inc.
sparc           SPARC processor
sequent         Sequent computer
tahoe           CCI Tahoe processor
vax             VAX processor
@end example

@node Problems Compiling, Problems Linking, Automatic C Preprocessor Definitions, Installing SCM
@section Problems Compiling

@multitable @columnfractions .10 .45 .45
@item FILE
@tab PROBLEM / MESSAGE
@tab HOW TO FIX
@item *.c
@tab include file not found.
@tab Correct the status of @t{STDC_HEADERS} in scmfig.h.
@item
@tab
@tab fix @t{#include} statement or add @t{#define} for system type to scmfig.h.
@item *.c
@tab Function should return a value.
@tab Ignore.
@item
@tab Parameter is never used.
@tab
@item
@tab Condition is always false.
@tab
@item
@tab Unreachable code in function.
@tab
@item scm.c
@tab assignment between incompatible types.
@tab Change @t{SIGRETTYPE} in scm.c.
@item time.c
@tab CLK_TCK redefined.
@tab incompatablility between <stdlib.h> and <sys/types.h>.
@item
@tab
@tab Remove @t{STDC_HEADERS} in scmfig.h.
@item
@tab
@tab Edit <sys/types.h> to remove incompatability.
@item subr.c
@tab Possibly incorrect assignment in function lgcd.
@tab Ignore.
@item sys.c
@tab statement not reached.
@tab Ignore.
@item
@tab constant in conditional expression.
@tab
@item sys.c
@tab undeclared, outside of functions.
@tab @t{#undef STDC_HEADERS} in scmfig.h.
@item scl.c
@tab syntax error.
@tab @t{#define SYSTNAME} to your system type in scl.c (softtype).
@end multitable

@node Problems Linking, Problems Running, Problems Compiling, Installing SCM
@section Problems Linking

@multitable @columnfractions .5 .5
@item PROBLEM
@tab HOW TO FIX
@item _sin etc. missing.
@tab Uncomment @t{LIBS} in makefile.
@end multitable

@node Problems Running, Testing, Problems Linking, Installing SCM
@section Problems Running

@multitable @columnfractions .5 .5
@item PROBLEM
@tab HOW TO FIX
@item Opening message and then machine crashes.
@tab Change memory model option to C compiler (or makefile).
@item
@tab Make sure @t{sizet} definition is correct in scmfig.h.
@item
@tab Reduce the size of @t{HEAP_SEG_SIZE} in setjump.h.
@item Input hangs.
@tab @t{#define NOSETBUF}
@item ERROR: heap: need larger initial.
@tab Increase initial heap allocation using -a<kb> or @t{INIT_HEAP_SIZE}.
@item ERROR: Could not allocate.
@tab Check @t{sizet} definition.
@item
@tab Use 32 bit compiler mode.
@item
@tab Don't try to run as subproccess.
@item remove <FLAG> in scmfig.h and recompile scm.
@tab Do so and recompile files.
@item add <FLAG> in scmfig.h and recompile scm.
@tab
@item ERROR: Init@value{SCMVERSION}.scm not found.
@tab Assign correct @t{IMPLINIT} in makefile or scmfig.h.
@item
@tab Define environment variable @t{SCM_INIT_PATH} to be the full pathname of Init@value{SCMVERSION}.scm.
@item WARNING: require.scm not found.
@tab Define environment variable @t{SCHEME_LIBRARY_PATH} to be the full pathname of the scheme library [SLIB].
@item
@tab Change @t{library-vicinity} in Init@value{SCMVERSION}.scm to point to library or remove.
@item
@tab Make sure the value of @t{(library-vicinity)} has a trailing file separator (like @t{/} or @t{\}).
@end multitable

@node Testing, Reporting Problems, Problems Running, Installing SCM
@section Testing

@noindent
Loading @file{r4rstest.scm} in the distribution will run an [R4RS]
conformance test on @code{scm}.

@example
> (load "r4rstest.scm")
@print{}
;loading "r4rstest.scm"
SECTION(2 1)
SECTION(3 4)
 #<primitive-procedure boolean?>
    #<primitive-procedure char?>
       #<primitive-procedure null?>
          #<primitive-procedure number?>
@dots{}
@end example

@noindent
Loading @file{pi.scm} in the distribution will enable you to compute
digits of pi.

@example
> (load "pi")
;loading "pi"
;done loading "pi.scm"
;Evaluation took 20 ms (0 in gc) 767 cells work, 233.B other
#<unspecified>
> (pi 100 5)
00003 14159 26535 89793 23846 26433 83279 50288 41971 69399
37510 58209 74944 59230 78164 06286 20899 86280 34825 34211
70679
;Evaluation took 550 ms (60 in gc) 36976 cells work, 1548.B other
#<unspecified>
@end example

@noindent
Loading @file{bench.scm} will compute and display performance statistics
of SCM running @file{pi.scm}.  @samp{make bench} or @samp{make benchlit}
appends the performance report to the file @file{BenchLog}, facilitating
tracking effects of changes to SCM on performance.

@multitable @columnfractions .5 .5
@item PROBLEM
@tab HOW TO FIX
@item Runs some and then machine crashes.
@tab See above under machine crashes.
@item Runs some and then ERROR: @dots{} (after a GC has happened).
@tab Remove optimization option to C compiler and recompile.
@item
@tab @t{#define SHORT_ALIGN} in @file{scmfig.h}.
@item Some symbol names print incorrectly.
@tab Change memory model option to C compiler (or makefile).
@item
@tab Check that @t{HEAP_SEG_SIZE} fits within @t{sizet}.
@item
@tab Increase size of @t{HEAP_SEG_SIZE} (or @t{INIT_HEAP_SIZE} if it is smaller than @t{HEAP_SEG_SIZE}).
@item ERROR: Rogue pointer in Heap.
@tab See above under machine crashes.
@item Newlines don't appear correctly in output files.
@tab Check file mode (define OPEN_@dots{} in @file{Init@value{SCMVERSION}.scm}).
@item Spaces or control characters appear in symbol names.
@tab Check character defines in @file{scmfig.h}.
@item Negative numbers turn positive.
@tab Check SRS in @file{scmfig.h}.
@item VMS: Couldn't unwind stack.
@tab @t{#define CHEAP_CONTIUATIONS} in @file{scmfig.h}.
@item VAX: botched longjmp.
@end multitable

@table @asis
@item Sparc(SUN-4) heap is growing out of control
You are experiencing a GC problem peculiar to the Sparc.  The problem is
that SCM doesn't know how to clear register windows.  Every location
which is not reused still gets marked at GC time.  This causes lots of
stuff which should be collected to not be.  This will be a problem with
any @emph{conservative} GC until we find what instruction will clear the
register windows.  This problem is exacerbated by using lots of
call-with-current-continuations.
@end table

@node Reporting Problems,  , Testing, Installing SCM
@section Reporting Problems

@noindent
Reported problems and solutions are grouped under Compiling, Linking,
Running, and Testing.  If you don't find your problem listed there, you
can send a bug report to @code{jaffer @@ alum.mit.edu}.  The bug report
should include:

@enumerate
@item
The version of SCM (printed when SCM is invoked with no arguments).
@item
The type of computer you are using.
@item
The name and version of your computer's operating system.
@item
The values of the environment variables @code{SCM_INIT_PATH} and
@code{SCHEME_LIBRARY_PATH}.
@item
The name and version of your C compiler.
@item
If you are using an executable from a distribution, the name, vendor,
and date of that distribution.  In this case, corresponding with the
vendor is recommended.
@end enumerate

@node Operational Features, The Language, Installing SCM, Top
@chapter Operational Features

@menu
* Invoking SCM::                
* SCM Options::                 
* Invocation Examples::         
* SCM Variables::               
* SCM Session::                 
* Editing Scheme Code::         
* Debugging Scheme Code::       
* Errors::                      
* Memoized Expressions::        
* Internal State::              
* Scripting::                   
@end menu

@node Invoking SCM, SCM Options, Operational Features, Operational Features
@section Invoking SCM

@example
@exdent @b{ scm } [-a @i{kbytes}] [-muvbiq] @w{[--version]} @w{[--help]}
@w{[[-]-no-init-file]} @w{[-p @i{int}]} @w{[-r @i{feature}]} @w{[-h @i{feature}]}
@w{[-d @i{filename}]} @w{[-f @i{filename}]} @w{[-l @i{filename}]}
@w{[-c @i{expression}]} @w{[-e @i{expression}]} @w{[-o @i{dumpname}]}
@w{[-- | - | -s]} @w{[@i{filename}]} @w{[@i{arguments} @dots{}]}
@end example

@noindent
Upon startup @code{scm} loads the file specified by by the environment
variable @var{SCM_INIT_PATH}.

@noindent
If @var{SCM_INIT_PATH} is not defined or if the file it names is not
present, @code{scm} tries to find the directory containing the
executable file.  If it is able to locate the executable, @code{scm}
looks for the initialization file (usually
@file{Init@value{SCMVERSION}.scm}) in platform-dependent directories
relative to this directory.  See @ref{File-System Habitat} for a
blow-by-blow description.

@noindent
As a last resort (if initialization file cannot be located), the C
compile parameter @var{IMPLINIT} (defined in the makefile or
@file{scmfig.h}) is tried.

@noindent
Unless the option @code{-no-init-file} or @code{--no-init-file} occurs
in the command line, @file{Init@value{SCMVERSION}.scm} checks to see if
there is file @file{ScmInit.scm} in the path specified by the
environment variable @var{HOME} (or in the current directory if
@var{HOME} is undefined).  If it finds such a file it is loaded.

@noindent
@file{Init@value{SCMVERSION}.scm} then looks for command input from one
of three sources: From an option on the command line, from a file named
on the command line, or from standard input.

@noindent
This explanation applies to SCMLIT or other builds of SCM.

@noindent
Scheme-code files can also invoke SCM and its variants.  @xref{Syntax
Extensions, #!}.

@node SCM Options, Invocation Examples, Invoking SCM, Operational Features
@section Options

@noindent
The options are processed in the order specified on the command line.

@deffn {Command Option} -a k
specifies that @code{scm} should allocate an initial heapsize of @var{k}
kilobytes.  This option, if present, must be the first on the command
line.  If not specified, the default is @code{INIT_HEAP_SIZE} in source
file @file{setjump.h} which the distribution sets at
@code{25000*sizeof(cell)}.
@end deffn

@deffn {Command Option} -no-init-file
@deffnx {Command Option} ---no-init-file
Inhibits the loading of @file{ScmInit.scm} as described above.
@end deffn

@deffn {Command Option} ---help
prints usage information and URI; then exit.
@end deffn

@deffn {Command Option} ---version
prints version information and exit.
@end deffn

@deffn {Command Option} -r feature
requires @var{feature}.  This will load a file from [SLIB] if that
@var{feature} is not already provided.  If @var{feature} is 2, 2rs,
r2rs, 3, 3rs, r3rs, 4, 4rs, r4rs, 5, 5rs, or r5rs; @code{scm} will
require the features neccessary to support [R2RS], [R3RS], [R4RS], or
[R5RS], respectively.
@end deffn

@deffn {Command Option} -h feature
provides @var{feature}.
@end deffn

@deffn {Command Option} -l filename
@deffnx {Command Option} -f filename
loads @var{filename}.  @code{Scm} will load the first (unoptioned) file
named on the command line if no @code{-c}, @code{-e}, @code{-f},
@code{-l},  or @code{-s} option preceeds
it.
@end deffn

@deffn {Command Option} -d filename
Loads SLIB @code{databases} feature and opens @var{filename} as a
database.
@end deffn

@deffn {Command Option} -e expression
@deffnx {Command Option} -c expression
specifies that the scheme expression @var{expression} is to be
evaluated.  These options are inspired by @code{perl} and @code{sh}
respectively.  On Amiga systems the entire option and argument need to be
enclosed in quotes.  For instance @samp{"-e(newline)"}.
@end deffn

@deffn {Command Option} -o dumpname
saves the current SCM session as the executable program @file{dumpname}.
This option works only in SCM builds supporting @code{dump}
(@pxref{Dump}).

If options appear on the command line after @samp{-o @var{dumpname}},
then the saved session will continue with processing those options when
it is invoked.  Otherwise the (new) command line is processed as usual
when the saved image is invoked.
@end deffn

@deffn {Command Option} -p level
sets the prolixity (verboseness) to @var{level}.  This is the same as
the @code{scm} command (verobse @var{level}).
@end deffn

@deffn {Command Option} -v
(verbose mode) specifies that @code{scm} will print prompts, evaluation
times, notice of loading files, and garbage collection statistics.  This
is the same as @code{-p3}.
@end deffn

@deffn {Command Option} -q
(quiet mode) specifies that @code{scm} will print no extra
information.  This is the same as @code{-p0}.
@end deffn

@deffn {Command Option} -m
specifies that subsequent loads, evaluations, and user interactions will
be with syntax-rules macro capability.  To use a specific syntax-rules
macro implementation from [SLIB] (instead of [SLIB]'s default) put
@code{-r} @var{macropackage} before @code{-m} on the command line.
@end deffn

@deffn {Command Option} -u
specifies that subsequent loads, evaluations, and user interactions will
be without syntax-rules macro capability.  Syntax-rules macro capability
can be restored by a subsequent @code{-m} on the command line or from
Scheme code.
@end deffn

@deffn {Command Option} -i
specifies that @code{scm} should run interactively.  That means that
@code{scm} will not terminate until the @code{(quit)} or @code{(exit)}
command is given, even if there are errors.  It also sets the prolixity
level to 2 if it is less than 2.  This will print prompts, evaluation
times, and notice of loading files.  The prolixity level can be set by
subsequent options.  If @code{scm} is started from a tty, it will assume
that it should be interactive unless given a subsequent @code{-b}
option.
@end deffn

@deffn {Command Option} -b
specifies that @code{scm} should run non-interactively.  That means that
@code{scm} will terminate after processing the command line or if there
are errors.
@end deffn

@deffn {Command Option} -s
specifies, by analogy with @code{sh}, that further options are to be
treated as program aguments.
@end deffn

@deffn {Command Option} -
@deffnx {Command Option} ---
specifies that there are no more options on the command line.
@end deffn

@node Invocation Examples, SCM Variables, SCM Options, Operational Features
@section Invocation Examples

@table @code
@item % scm foo.scm
Loads and executes the contents of @file{foo.scm} and then enters
interactive session.

@item % scm -f foo.scm arg1 arg2 arg3
Parameters @code{arg1}, @code{arg2}, and @code{arg3} are stored in the
global list @code{*argv*}; Loads and executes the contents of
@file{foo.scm} and exits.

@item % scm -s foo.scm arg1 arg2
Sets *argv* to @code{("foo.scm" "arg1" "arg2")} and enters interactive
session.

@item % scm -e `(write (list-ref *argv* *optind*))' bar
Prints @samp{"bar"}.

@item % scm -rpretty-print -r format -i
Loads @code{pretty-print} and @code{format} and enters interactive
session.

@item % scm -r5
Loads @code{dynamic-wind}, @code{values}, and syntax-rules macros and
enters interactive (with macros) session.

@item % scm -r5 -r4
Like above but @code{rev4-optional-procedures} are also loaded.
@end table

@node SCM Variables, SCM Session, Invocation Examples, Operational Features
@section Environment Variables

@defvr {Environment Variable} SCM_INIT_PATH
is the pathname where @code{scm} will look for its initialization
code.  The default is the file @file{Init@value{SCMVERSION}.scm} in the
source directory.
@end defvr

@defvr {Environment Variable} SCHEME_LIBRARY_PATH
is the [SLIB] Scheme library directory.
@end defvr

@defvr {Environment Variable} HOME
is the directory where @file{Init@value{SCMVERSION}.scm} will look for
the user initialization file @file{ScmInit.scm}.
@end defvr

@defvr {Environment Variable} EDITOR
is the name of the program which @code{ed} will call.  If @var{EDITOR}
is not defined, the default is @samp{ed}.
@end defvr

@section Scheme Variables

@defvar *argv*
contains the list of arguments to the program.  @code{*argv*} can change
during argument processing.  This list is suitable for use as an argument
to [SLIB] @code{getopt}.
@end defvar

@defvar *syntax-rules*
controls whether loading and interaction support syntax-rules
macros.  Define this in @file{ScmInit.scm} or files specified on the
command line.  This can be overridden by subsequent @code{-m} and
@code{-u} options.
@end defvar

@defvar *interactive*
controls interactivity as explained for the @code{-i} and @code{-b}
options.  Define this in @file{ScmInit.scm} or files specified on the
command line.  This can be overridden by subsequent @code{-i} and
@code{-b} options.
@end defvar

@node SCM Session, Editing Scheme Code, SCM Variables, Operational Features
@section SCM Session

@itemize @bullet
@item
Options, file loading and features can be specified from the command
line.  @xref{System interface, , , scm, SCM}.  @xref{Require, , , slib,
SLIB}.
@item
Typing the end-of-file character at the top level session (while SCM is
not waiting for parenthesis closure) causes SCM to exit.
@item
Typing the interrupt character aborts evaluation of the current form
and resumes the top level read-eval-print loop.
@end itemize

@defun quit
@defunx quit n
@defunx exit
@defunx exit n
Aliases for @code{exit} (@pxref{System, exit, , slib, SLIB}).  On many
systems, SCM can also tail-call another program.  @xref{I/O-Extensions,
execp}.
@end defun

@deffn {Callback procedure} boot-tail dumped?
@code{boot-tail} is called by @code{scm_top_level} just before entering
interactive top-level.  If @code{boot-tail} calls @code{quit}, then
interactive top-level is not entered.
@end deffn

@defun program-arguments
Returns a list of strings of the arguments scm was called with.
@end defun

@noindent
For documentation of the procedures @code{getenv} and @code{system}
@xref{System Interface, , , slib, SLIB}.

@defun vms-debug
If SCM is compiled under VMS this @code{vms-debug} will invoke the VMS
debugger.
@end defun


@node Editing Scheme Code, Debugging Scheme Code, SCM Session, Operational Features
@section Editing Scheme Code

@defun ed arg1 @dots{}
The value of the environment variable @code{EDITOR} (or just @code{ed}
if it isn't defined) is invoked as a command with arguments @var{arg1}
@dots{}.

@defunx ed filename
If SCM is compiled under VMS @code{ed} will invoke the editor with a
single the single argument @var{filename}.
@end defun


@table @asis
@item Gnu Emacs:
Editing of Scheme code is supported by emacs.  Buffers holding files
ending in .scm are automatically put into scheme-mode.  EMACS for MS-DOS
and MS-Windows systems is available (free) from:

@center @url{http://simtel.coast.net/SimTel/gnu/demacs.html}

If your Emacs can run a process in a buffer you can use the Emacs
command @samp{M-x run-scheme} with SCM.  Otherwise, use the emacs
command @samp{M-x suspend-emacs}; or see ``other systems'' below.

@item Epsilon (MS-DOS):
There is lisp (and scheme) mode available by use of the package
@samp{LISP.E}.  It offers several different indentation formats.  With
this package, buffers holding files ending in @samp{.L}, @samp{.LSP},
@samp{.S}, and @samp{.SCM} (my modification) are automatically put into
lisp-mode.

It is possible to run a process in a buffer under Epsilon.  With Epsilon
5.0 the command line options @samp{-e512 -m0} are neccessary to manage
RAM properly.  It has been reported that when compiling SCM with Turbo
C, you need to @samp{#define NOSETBUF} for proper operation in a process
buffer with Epsilon 5.0.

One can also call out to an editor from SCM if RAM is at a premium; See
``under other systems'' below.

@item other systems:
Define the environment variable @samp{EDITOR} to be the name of the
editing program you use.  The SCM procedure @code{(ed arg1 @dots{})}
will invoke your editor and return to SCM when you exit the editor.  The
following definition is convenient:

@example
(define (e) (ed "work.scm") (load "work.scm"))
@end example

Typing @samp{(e)} will invoke the editor with the file of interest.
After editing, the modified file will be loaded.
@end table


@node Debugging Scheme Code, Errors, Editing Scheme Code, Operational Features
@section Debugging Scheme Code

@noindent
The @code{cautious} and @code{stack-limit} options of @code{build}
(@pxref{Build Options}) support debugging in Scheme.

@table @dfn
@item CAUTIOUS
If SCM is built with the @samp{CAUTIOUS} flag, then when an error
occurs, a @dfn{stack trace} of certain pending calls are printed as part
of the default error response.  A (memoized) expression and newline are
printed for each partially evaluated combination whose procedure is not
builtin.  See @ref{Memoized Expressions} for how to read memoized
expressions.

Also as the result of the @samp{CAUTIOUS} flag, both @code{error} and
@code{user-interrupt} (invoked by @key{C-c}) to print stack traces and
conclude by calling @code{breakpoint} (@pxref{Breakpoints, , , slib,
SLIB}) instead of aborting to top level.  Under either condition,
program execution can be resumed by @code{(continue)}.

In this configuration one can interrupt a running Scheme program with
@key{C-c}, inspect or modify top-level values, trace or untrace
procedures, and continue execution with @code{(continue)}.

@item STACK_LIMIT
If SCM is built with the @samp{STACK_LIMIT} flag, the interpreter will
check stack size periodically.  If the size of stack exceeds a certain
amount (default is @code{HEAP_SEG_SIZE/2}), SCM generates a
@code{segment violation} interrupt.

The usefulness of @samp{STACK_LIMIT} depends on the user.  I don't use
it; but the user I added this feature for got primarily this type of
error.
@end table

@noindent
There are several SLIB macros which so useful that SCM automatically
loads the appropriate module from SLIB if they are invoked.

@defmac trace proc1 @dots{}
Traces the top-level named procedures given as arguments.
@defmacx trace
With no arguments, makes sure that all the currently traced identifiers
are traced (even if those identifiers have been redefined) and returns a
list of the traced identifiers.
@end defmac

@defmac untrace proc1 @dots{}
Turns tracing off for its arguments.
@defmacx untrace
With no arguments, untraces all currently traced identifiers and returns
a list of these formerly traced identifiers.
@end defmac

The routines I use most frequently for debugging are:

@deffn Procedure print arg1 @dots{}
@code{Print} writes all its arguments, separated by spaces.
@code{Print} outputs a @code{newline} at the end and returns the value
of the last argument.

One can just insert @samp{(print '<proc-name>} and @samp{)} around an
expression in order to see its value as a program operates.
@end deffn

@deffn Syntax print-args name1 @dots{}
Writes @var{name1} @dots{} (separated by spaces) and then writes the
values of the closest lexical bindings enclosing the call to
@code{Print-args}.

@example
(define (foo a b) (print-args foo) (+ a b))
(foo 3 6)
@print{} In foo: a = 3; b = 6; 
@result{} 9
@end example
@end deffn

@noindent
Sometimes more elaborate measures are needed to print values in a useful
manner.  When the values to be printed may have very large (or infinite)
external representations, @ref{Quick Print, , , slib, SLIB}, can be
used.

When @code{trace} is not sufficient to find program flow problems,
@ifset html
<A HREF="http://www.cs.tut.fi/staff/pk/scheme/psd/article/article.html">
@end ifset
SLIB-PSD, the Portable Scheme Debugger
@ifset html
</A>
@end ifset
offers source code debugging from
GNU Emacs.  PSD runs slowly, so start by instrumenting only a few
functions at a time.
@lisp
http://swissnet.ai.mit.edu/ftpdir/scm/slib-psd1-3.tar.gz
swissnet.ai.mit.edu:/pub/scm/slib-psd1-3.tar.gz
ftp.maths.tcd.ie:pub/bosullvn/jacal/slib-psd1-3.tar.gz
ftp.cs.indiana.edu:/pub/scheme-repository/utl/slib-psd1-3.tar.gz
@end lisp


@node Errors, Memoized Expressions, Debugging Scheme Code, Operational Features
@section Errors

@noindent
A computer-language implementation designer faces choices of how
reflexive to make the implementation in handling exceptions and errors;
that is, how much of the error and exception routines should be written
in the language itself.  The design of a portable implementation is
further constrained by the need to have (almost) all errors print
meaningful messages, even when the implementation itself is not
functioning correctly.  Therefore, SCM implements much of its error
response code in C.

@noindent
The following common error and conditions are handled by C code.  Those
with callback names after them can also be handled by Scheme code
(@pxref{Interrupts}).  If the callback identifier is not defined at top
level, the default error handler (C code) is invoked.  There are many
other error messages which are not treated specially.

@table @dfn
@item ARGn
Wrong type in argument
@item ARG1
Wrong type in argument 1
@item ARG2
Wrong type in argument 2
@item ARG3
Wrong type in argument 3
@item ARG4
Wrong type in argument 4
@item ARG5
Wrong type in argument 5
@item WNA
Wrong number of args
@item OVFLOW
numerical overflow
@item OUTOFRANGE
Argument out of range
@item NALLOC
@code{(out-of-storage)}
@item THRASH
GC is @code{(thrashing)}
@item EXIT
@code{(end-of-program)}
@item HUP_SIGNAL
@code{(hang-up)}
@item INT_SIGNAL
@code{(user-interrupt)}
@item FPE_SIGNAL
@code{(arithmetic-error)}
@item BUS_SIGNAL
bus error
@item SEGV_SIGNAL
segment violation
@item ALRM_SIGNAL
@code{(alarm-interrupt)}
@item VTALRM_SIGNAL
@code{(virtual-alarm-interrupt)}
@item PROF_SIGNAL
@code{(profile-alarm-interrupt)}
@end table

@defvar errobj
When SCM encounters a non-fatal error, it aborts evaluation of the
current form, prints a message explaining the error, and resumes the top
level read-eval-print loop.  The value of @var{errobj} is the offending
object if appropriate.  The builtin procedure @code{error} does
@emph{not} set @var{errobj}.
@end defvar

@noindent
@code{errno} and @code{perror} report ANSI C errors encountered during a
call to a system or library function.

@defun errno
@defunx errno n
With no argument returns the current value of the system variable
@code{errno}.  When given an argument, @code{errno} sets the system
variable @code{errno} to @var{n} and returns the previous value of
@code{errno}.  @code{(errno 0)} will clear outstanding errors.  This is
recommended after @code{try-load} returns @code{#f} since this occurs
when the file could not be opened.
@end defun

@defun perror string
Prints on standard error output the argument @var{string}, a colon,
followed by a space, the error message corresponding to the current
value of @code{errno} and a newline.  The value returned is unspecified.
@end defun

@noindent
@code{warn} and @code{error} provide a uniform way for Scheme code to
signal warnings and errors.

@defun warn arg1 arg2 arg3 @dots{}
Alias for @ref{System, slib:warn, , slib, SLIB}.  Outputs an error
message containing the arguments.  @code{warn} is defined in
@file{Init@value{SCMVERSION}.scm}.
@end defun

@defun error arg1 arg2 arg3 @dots{}
Alias for @ref{System, slib:error, , slib, SLIB}.  Outputs an error
message containing the arguments, aborts evaluation of the current form
and resumes the top level read-eval-print loop.  @code{Error} is defined
in @file{Init@value{SCMVERSION}.scm}.
@end defun

@noindent
If SCM is built with the @samp{CAUTIOUS} flag, then when an error
occurs, a @dfn{stack trace} of certain pending calls are printed as part
of the default error response.  A (memoized) expression and newline are
printed for each partially evaluated combination whose procedure is not
builtin.  See @ref{Memoized Expressions} for how to read memoized
expressions.

@noindent
Also as the result of the @samp{CAUTIOUS} flag, both @code{error} and
@code{user-interrupt} (invoked by @key{C-c}) are defined to print stack
traces and conclude by calling @code{breakpoint} (@pxref{Breakpoints, ,
, slib, SLIB}).  This allows the user to interract with SCM as with Lisp
systems.

@defun stack-trace
Prints information describing the stack of partially evaluated
expressions.  @code{stack-trace} returns @code{#t} if any lines were
printed and @code{#f} otherwise.  See @file{Init@value{SCMVERSION}.scm}
for an example of the use of @code{stack-trace}.
@end defun

@node Memoized Expressions, Internal State, Errors, Operational Features
@section Memoized Expressions

@noindent
SCM memoizes the address of each occurence of an identifier's value when
first encountering it in a source expression.  Subsequent executions of
that memoized expression is faster because the memoized reference
encodes where in the top-level or local environment its value is.

@noindent
When procedures are displayed, the memoized locations appear in a format
different from references which have not yet been executed.  I find this
a convenient aid to locating bugs and untested expressions.

@itemize @bullet
@item
The names of memoized lexically bound identifiers are replaced with
@r{#@@}@i{<m>}@r{-}@i{<n>}, where @i{<m>} is the number of binding
contours back and @i{<n>} is the index of the value in that
binding countour.
@item
The names of identifiers which are not lexiallly bound but defined at
top-level have @r{#@@} prepended.
@end itemize

@noindent
For instance, @code{open-input-file} is defined as follows in
@file{Init@value{SCMVERSION}.scm}:

@example
(define (open-input-file str)
  (or (open-file str OPEN_READ)
      (and (procedure? could-not-open) (could-not-open) #f)
      (error "OPEN-INPUT-FILE couldn't open file " str)))
@end example

@noindent
If @code{open-input-file} has not yet been used, the displayed procedure
is similar to the original definition (lines wrapped for readability):

@example
open-input-file @result{}
#<CLOSURE (str) (or (open-file str open_read)
 (and (procedure? could-not-open) (could-not-open) #f)
 (error "OPEN-INPUT-FILE couldn't open file " str))>
@end example

@noindent
If we open a file using @code{open-input-file}, the sections of code
used become memoized:

@example
(open-input-file "r4rstest.scm") @result{} #<input-port 3>
open-input-file @result{}
#<CLOSURE (str) (#@@or (#@@open-file #@@0+0 #@@open_read)
 (and (procedure? could-not-open) (could-not-open) #f)
 (error "OPEN-INPUT-FILE couldn't open file " str))>
@end example

@noindent
If we cause @code{open-input-file} to execute other sections of code,
they too become memoized:

@example
(open-input-file "foo.scm") @result{}

ERROR: No such file or directory
ERROR: OPEN-INPUT-FILE couldn't open file  "foo.scm"

open-input-file @result{}
#<CLOSURE (str) (#@@or (#@@open-file #@@0+0 #@@open_read)
 (#@@and (#@@procedure? #@@could-not-open) (could-not-open) #f)
 (#@@error "OPEN-INPUT-FILE couldn't open file " #@@0+0))>
@end example


@node Internal State, Scripting, Memoized Expressions, Operational Features
@section Internal State

@defvar *interactive*
The variable @var{*interactive*} determines whether the SCM session is
interactive, or should quit after the command line is processed.
@var{*interactive*} is controlled directly by the command-line options
@samp{-b}, @samp{-i}, and @samp{-s} (@pxref{Invoking SCM}).  If none of
these options are specified, the rules to determine interactivity are
more complicated; see @file{Init@value{SCMVERSION}.scm} for details.
@end defvar

@defun abort
Resumes the top level Read-Eval-Print loop.
@end defun

@defun restart
Restarts the SCM program with the same arguments as it was originally
invoked.  All @samp{-l} loaded files are loaded again; If those files
have changed, those changes will be reflected in the new session.

@emph{Note:} When running a saved executable (@pxref{Dump}),
@code{restart} is redefined to be @code{exec-self}.
@end defun

@defun exec-self
Exits and immediately re-invokes the same executable with the same
arguments.  If the executable file has been changed or replaced since
the beginning of the current session, the @emph{new} executable will be
invoked.  This differentiates @code{exec-self} from @code{restart}.
@end defun

@defun verbose n
Controls how much monitoring information is printed.
If @var{n} is:

@table @asis
@item 0
no prompt or information is printed.
@item >= 1
a prompt is printed.
@item >= 2
messages bracketing file loading are printed.
@item >= 3
the CPU time is printed after each top level form evaluated;
notifications of heap growth printed.
@item >= 4
a garbage collection summary is printed after each top level form
evaluated;
@item >= 5
a message for each GC (@pxref{Garbage Collection}) is printed;
warnings issued for top-level symbols redefined.
@end table
@end defun

@defun gc
Scans all of SCM objects and reclaims for further use those that are
no longer accessible.
@end defun

@defun room
@defunx room #t
Prints out statistics about SCM's current use of storage.  @code{(room #t)}
also gives the hexadecimal heap segment and stack bounds.
@end defun

@defvr Constant *scm-version*
Contains the version string (e.g. @file{@value{SCMVERSION}}) of SCM.
@end defvr

@subsection Executable path

@noindent
In order to dump a saved executable or to dynamically-link using DLD,
SCM must know where its executable file is.  Sometimes SCM
(@pxref{Executable Pathname}) guesses incorrectly the location of the
currently running executable.  In that case, the correct path can be set
by calling @code{execpath} with the pathname.

@defun execpath
Returns the path (string) which SCM uses to find the executable file
whose invocation the currently running session is, or #f if the path is
not set.

@defunx execpath #f
@defunx execpath newpath
Sets the path to @code{#f} or @var{newpath}, respectively.  The old path
is returned.
@end defun

@noindent
For other configuration constants and procedures @xref{Configuration, ,
, slib, SLIB}.


@node Scripting,  , Internal State, Operational Features
@section Scripting

@menu
* Unix Scheme Scripts::         From Olin Shivers' Scheme Shell
* MS-DOS Compatible Scripts::   Run in MS-DOS and Unix
* Unix Shell Scripts::          Use /bin/sh to run Scheme
@end menu

@node Unix Scheme Scripts, MS-DOS Compatible Scripts, Scripting, Scripting
@subsection Unix Scheme Scripts

@noindent
In reading this section, keep in mind that the first line of a script
file has (different) meanings to SCM and the operating system
(@code{execve}).

@deftp file #! interpreter \ @dots{}

@tindex Scheme Script
@tindex Scheme-Script
@tindex meta-argument
On unix systems, a @dfn{Shell-Script} is a file (with execute
permissions) whose first two characters are @samp{#!}.  The
@var{interpreter} argument must be the pathname of the program to
process the rest of the file.  The directories named by environment
variable @code{PATH} are @emph{not} searched to find @var{interpreter}.

When executing a shell-script, the operating system invokes
@var{interpreter} with a single argument encapsulating the rest of the
first line's contents (if if not just whitespace), the pathname of the
Scheme Script file, and then any arguments which the shell-script was
invoked with.

Put one space character between @samp{#!} and the first character of
@var{interpreter} (@samp{/}).  The @var{interpreter} name is followed by
@samp{ \}; SCM substitutes the second line of @var{file} for @samp{\}
(and the rest of the line), then appends any arguments given on the
command line invoking this Scheme-Script.

When SCM executes the script, the Scheme variable @var{*script*} will be
set to the script pathname.  The last argument before @samp{!#} on the
second line should be @samp{-}; SCM will load the script file, preserve
the unprocessed arguments, and set @var{*argv*} to a list of the script
pathname and the unprocessed arguments.

Note that the interpreter, not the operating system, provides the
@samp{\} substitution; this will only take place if @var{interpreter} is
a SCM or SCSH interpreter.
@end deftp

@c  @deffn {Read syntax} #! ignored
@c  When the first two characters of the file being loaded are @code{#!},
@c  the first line of that file will be ignored.

@deffn {Read syntax} #! ignored !#
When the first two characters of the file being loaded are @code{#!} and
a @samp{\} is present before a newline in the file, all characters up
to @samp{!#} will be ignored by SCM @code{read}.
@end deffn

@noindent
This combination of interpretatons allows SCM source files to be used as
POSIX shell-scripts if the first line is:

@example
#! /usr/local/bin/scm \
@end example

@noindent
The following Scheme-Script prints factorial of its argument:

@example
#! /usr/local/bin/scm \ %0 %1 %2 %3 %4 %5 %6 %7 %8 %9
- !#
                                        ; -*-scheme-*-
(define (go-script)
  (cond ((not *script*))
        ((and (= 1 (- (length *argv*) *optind*))
              (string->number (list-ref *argv* *optind*)))
         => (lambda (n) (print (fact n))))
        (else
         (print *argv*)
         (display "\
Usage: fact n
  Returns the factorial of N.

http://swissnet.ai.mit.edu/~jaffer/SLIB.html
"
                  (current-error-port))
         (exit #f))))

(define (fact n) (if (< n 2) 1 (* n (fact (+ -1 n)))))
(go-script)
@end example

@example
./fact 32
@result{}
263130836933693530167218012160000000
@end example

@noindent
If the wrong number of arguments is given, @code{fact} prints its
@var{argv} with usage information.

@example
./fact 3 2
@print{}
("./fact" "3" "2") 
Usage: fact n
  Returns the factorial of N.

http://swissnet.ai.mit.edu/~jaffer/SLIB.html
@end example


@node MS-DOS Compatible Scripts, Unix Shell Scripts, Unix Scheme Scripts, Scripting
@subsection MS-DOS Compatible Scripts

@noindent
It turns out that we can create scheme-scripts which run both under unix
and MS-DOS.  To implement this, I have written the MS-DOS programs:
@code{#!.bat} and @code{!#.exe}.
@cindex !#
@cindex !#.exe
@cindex #!
@cindex #!.bat

@noindent
With these two programs installed in a @code{PATH} directory, we have
the following syntax for @var{<program>.BAT} files.

@deftp file #! interpreter \ %0 %1 %2 %3 %4 %5 %6 %7 %8 %9

@tindex Scheme Script
@tindex Scheme-Script
The first two characters of the Scheme-Script are @samp{#!}.  The
@var{interpreter} can be either a unix style program path (using
@samp{/} between filename components) or a DOS program name or path.
The rest of the first line of the Scheme-Script should be literally
@w{@samp{\ %0 %1 %2 %3 %4 %5 %6 %7 %8 %9}}, as shown.

If @var{interpreter} has @samp{/} in it, @var{interpreter} is converted
to a DOS style filename (@samp{/} @result{} @samp{\}).

In looking for an executable named @var{interpreter}, @code{#!} first
checks this (converted) filename; if @var{interpreter} doesn't exist, it
then tries to find a program named like the string starting after the
last @samp{\} (or @samp{/}) in @var{interpreter}.  When searching for
executables, @code{#!} tries all directories named by environment
variable @code{PATH}.

Once the @var{interpreter} executable path is found, arguments are
processed in the manner of scheme-shell, with the all the text after the
@samp{\} taken as part of the meta-argument.  More precisely, @code{#!}
calls @var{interpreter} with any options on the second line of the
Scheme-Script up to @samp{!#}, the name of the Scheme-Script file, and
then any of at most 8 arguments given on the command line invoking this
Scheme-Script.
@end deftp

@noindent
The previous example Scheme-Script works in both MS-DOS and unix
systems.



@node Unix Shell Scripts,  , MS-DOS Compatible Scripts, Scripting
@subsection Unix Shell Scripts

@noindent
Scheme-scripts suffer from two drawbacks:
@itemize @bullet
@item
Some Unixes limit the length of the @samp{#!} interpreter line to the
size of an object file header, which can be as small as 32 bytes.
@item
A full, explicit pathname must be specified, perhaps requiring more than
32 bytes and making scripts vulnerable to breakage when programs are
moved.
@end itemize

@noindent
The following approach solves these problems at the expense of slower
startup.  Make @samp{#! /bin/sh} the first line and prepend every
subsequent line to be executed by the shell with @code{:;}.  The last
line to be executed by the shell should contain an @dfn{exec} command;
@code{exec} tail-calls its argument.

@noindent
@code{/bin/sh} is thus invoked with the name of the script file, which
it executes as a *sh script.  Usually the second line starts
@samp{:;exec scm -f$0}, which executes scm, which in turn loads the
script file.  When SCM loads the script file, it ignores the first and
second lines, and evaluates the rest of the file as Scheme source code.

@noindent
The second line of the script file does not have the length restriction
mentioned above.  Also, @code{/bin/sh} searches the directories listed
in the `PATH' environment variable for @samp{scm}, eliminating the need
to use absolute locations in order to invoke a program.

@noindent
The following example additionally sets @var{*script*} to the script
argument, making it compatible with the scheme code of the previous
example.

@example
#! /bin/sh
:;exec scm -e"(set! *script* \"$0\")" -l$0 $*

(define (go-script)
  (cond ((not *script*))
        ((and (= 1 (- (length *argv*) *optind*))
              (string->number (list-ref *argv* *optind*)))
         => (lambda (n) (print (fact n))))
        (else
         (print *argv*)
         (display "\
Usage: fact n
  Returns the factorial of N.

http://swissnet.ai.mit.edu/~jaffer/SLIB.html
"
                  (current-error-port))
         (exit #f))))

(define (fact n) (if (< n 2) 1 (* n (fact (+ -1 n)))))

(go-script)
@end example

@example
./fact 6
@result{} 720 
@end example


@node The Language, Packages, Operational Features, Top
@chapter The Language

@menu
* Standards Compliance::        Links to sections in [R5RS] and [SLIB]
* Miscellaneous Procedures::    
* Time::                        Both real time and processor time
* Interrupts::                  and exceptions
* Process Synchronization::     Because interrupts are preemptive
* Files and Ports::             
* Line Numbers::                
* Soft Ports::                  Emulate I/O devices
* Syntax Extensions::           
* Low Level Syntactic Hooks::   
* Syntactic Hooks for Hygienic Macros::  
@end menu

@node Standards Compliance, Miscellaneous Procedures, The Language, The Language
@section Standards Compliance

@noindent
Scm conforms to the
@ifset html
[IEEE],
@end ifset
@cite{IEEE Standard 1178-1990.  IEEE Standard for the Scheme Programming
Language.}
@ifclear html
(@pxref{Bibliography}),
@end ifclear
and
@ifset html
[R5RS], <A HREF="r5rs_toc.html">
@end ifset
@cite{Revised(5) Report on the Algorithmic Language Scheme}.
@ifset html
</A>
@end ifset
@ifinfo
@ref{Top, , , r5rs, Revised(5) Report on the Algorithmic Language
Scheme}.
@end ifinfo
All the required features of these specifications are supported.
Many of the optional features are supported as well.

@subheading Optionals of [R5RS] Supported by SCM

@table @asis
@item @code{-} and @code{/} of more than 2 arguments
@itemx @code{exp}
@itemx @code{log}
@itemx @code{sin}
@itemx @code{cos}
@itemx @code{tan}
@itemx @code{asin}
@itemx @code{acos}
@itemx @code{atan}
@itemx @code{sqrt}
@itemx @code{expt}
@itemx @code{make-rectangular}
@itemx @code{make-polar}
@itemx @code{real-part}
@itemx @code{imag-part}
@itemx @code{magnitude}
@itemx @code{angle}
@itemx @code{exact->inexact}
@itemx @code{inexact->exact}
@xref{Numerical operations, , , r5rs, Revised(5) Scheme}.
@itemx @code{with-input-from-file}
@itemx @code{with-output-to-file}
@xref{Ports, , , r5rs, Revised(5) Scheme}.
@itemx @code{load}
@itemx @code{transcript-on}
@itemx @code{transcript-off}
@xref{System interface, , , r5rs, Revised(5) Scheme}.
@end table

@subheading Optionals of [R5RS] not Supported by SCM

@table @asis
@item @code{numerator}
@itemx @code{denominator}
@itemx @code{rationalize}
@xref{Numerical operations, , , r5rs, Revised(5) Scheme}.
@end table

@subheading [SLIB] Features of SCM and SCMLIT

@table @code
@item delay
@itemx full-continuation
@itemx ieee-p1178
@itemx object-hash
@itemx rev4-report
@itemx source
See SLIB file @file{Template.scm}.
@item current-time
@xref{Time, , , slib, SLIB}.
@item defmacro
@xref{Defmacro, , , slib, SLIB}.
@item getenv
@itemx system
@xref{System Interface, , , slib, SLIB}.
@item hash
@xref{Hashing, , , slib, SLIB}.
@item logical
@xref{Bit-Twiddling, , , slib, SLIB}.
@item multiarg-apply
@xref{Multi-argument Apply, , , slib, SLIB}.
@item multiarg/and-
@xref{Multi-argument / and -, , , slib, SLIB}.
@item rev4-optional-procedures
@xref{Rev4 Optional Procedures, , , slib, SLIB}.
@item string-port
@xref{String Ports, , , slib, SLIB}.
@item tmpnam
@xref{Input/Output, , , slib, SLIB}.
@item transcript
@xref{Transcripts, , , slib, SLIB}.
@item vicinity
@xref{Vicinity, , , slib, SLIB}.
@item with-file
@xref{With-File, , , slib, SLIB}.
@end table

@subheading [SLIB] Features of SCM

@table @code
@item array
@xref{Arrays, , , slib, SLIB}.
@item array-for-each
@xref{Array Mapping, , , slib, SLIB}.
@item bignum
@itemx complex
@itemx inexact
@itemx rational
@itemx real
@xref{Require, , , slib, SLIB}.
@end table

@node Miscellaneous Procedures, Time, Standards Compliance, The Language
@section Miscellaneous Procedures

@defun try-load filename
If the string @var{filename} names an existing file, the try-load
procedure reads Scheme source code expressions and definitions from the
file and evaluates them sequentially and returns @code{#t}.  If not,
try-load returns @code{#f}.  The try-load procedure does not affect the
values returned by @code{current-input-port} and
@code{current-output-port}.
@end defun

@defvar *load-pathname*
Is set to the pathname given as argument to @code{load},
@code{try-load}, and @code{dyn:link}
(@pxref{Compiling And Linking, , , hobbit, Hobbit}).
@code{*load-pathname*} is used to compute the value of
@ref{Vicinity, program-vicinity, , slib, SLIB}.
@end defvar

@defun line-number
Returns the current line number of the file currently being loaded.
@end defun

@defun port-filename port
Returns the filename @var{port} was opened with.  If @var{port} is
not open to a file the result is unspecified.
@end defun

@defun port-line port
@defunx port-column port
If @var{port} is a tracked port, return the current line (column) number,
otherwise return @code{#f}.  Line and column numbers begin with 1.
The column number applies to the next character to be read; if that
character is a newline, then the column number will be one more than
the length of the line.
@end defun

@defun eval obj
Alias for @ref{System, eval, , slib, SLIB}.
@end defun

@defun eval-string str
Returns the result of reading an expression from @var{str} and
evaluating it.  @code{eval-string} does not change
@code{*load-pathname*} or  @code{line-number}.
@end defun

@defun load-string str
Reads and evaluates all the expressions from @var{str}.  As with
@code{load}, the value returned is unspecified.  @code{load-string} does
not change @code{*load-pathname*} or @code{line-number}.
@end defun

@defun vector-set-length! object length
Change the length of string, vector, bit-vector, or uniform-array
@var{object} to @var{length}.  If this shortens @var{object} then the
remaining contents are lost.  If it enlarges @var{object} then the
contents of the extended part are undefined but the original part is
unchanged.  It is an error to change the length of literal datums.  The
new object is returned.
@end defun

@defun copy-tree obj
@defunx @@copy-tree obj
@xref{Tree Operations, copy-tree, , slib, SLIB}.  This extends the SLIB
version by also copying vectors.  Use @code{@@copy-tree} if you
depend on this feature; @code{copy-tree} could get redefined.
@end defun

@defun acons obj1 obj2 obj3
Returns (cons (cons obj1 obj2) obj3).  The expression (set! a-list
(acons key datum a-list)) adds a new association to a-list.
@end defun

@defun terms
This command displays the GNU General Public License.
@end defun

@defun list-file filename
Displays the text contents of @var{filename}.
@end defun

@deffn Procedure print arg1 @dots{}
@code{Print} writes all its arguments, separated by spaces.
@code{Print} outputs a @code{newline} at the end and returns the value
of the last argument.
@end deffn

@node Time, Interrupts, Miscellaneous Procedures, The Language
@section Time

@defvr Constant internal-time-units-per-second

Is the integer number of internal time units in a second.
@end defvr

@defun get-internal-run-time
Returns the integer run time in internal time units from an unspecified
starting time.  The difference of two calls to
@code{get-internal-run-time} divided by
@code{internal-time-units-per-second} will give elapsed run time in
seconds.
@end defun

@defun get-internal-real-time
Returns the integer time in internal time units from an unspecified
starting time.  The difference of two calls to
@code{get-internal-real-time} divided by
@code{interal-time-units-per-second} will give elapsed real time in
seconds.
@end defun

@defun current-time
Returns the time since 00:00:00 GMT, January 1, 1970, measured in
seconds.  @xref{Time, current-time, , slib, SLIB}.  @code{current-time} is
used in @ref{Time, , , slib, SLIB}.
@end defun

@node Interrupts, Process Synchronization, Time, The Language
@section Interrupts

@defun ticks n
Returns the number of ticks remaining till the next tick interrupt.
Ticks are an arbitrary unit of evaluation.  Ticks can vary greatly in
the amount of time they represent.

If @var{n} is 0, any ticks request is canceled.  Otherwise a
@code{ticks-interrupt} will be signaled @var{n} from the current time.
@code{ticks} is supported if SCM is compiled with the @code{ticks} flag
defined.
@end defun

@deffn {Callback procedure} ticks-interrupt @dots{}
Establishes a response for tick interrupts.  Another tick interrupt will
not occur unless @code{ticks} is called again.  Program execution will
resume if the handler returns.  This procedure should (abort) or some
other action which does not return if it does not want processing to
continue.
@end deffn

@defun alarm secs
Returns the number of seconds remaining till the next alarm interrupt.
If @var{secs} is 0, any alarm request is canceled.  Otherwise an
@code{alarm-interrupt} will be signaled @var{secs} from the current
time.  ALARM is not supported on all systems.
@end defun

@defun milli-alarm millisecs interval
@defunx virtual-alarm millisecs interval
@defunx profile-alarm millisecs interval
@code{milli-alarm} is similar to @code{alarm}, except that the first
argument @var{millisecs}, and the return value are measured in
milliseconds rather than seconds.  If the optional argument
@var{interval} is supplied then alarm interrupts will be scheduled every
@var{interval} milliseconds until turned off by a call to
@code{milli-alarm} or @code{alarm}.

@code{virtual-alarm} and @code{profile-alarm} are similar.
@code{virtual-alarm} decrements process execution time rather than real
time, and causes @code{SIGVTALRM} to be signaled.
@code{profile-alarm} decrements both process execution time  and
system execution time on behalf of the process, and causes
@code{SIGPROF} to be signaled.

@code{milli-alarm}, @code{virtual-alarm}, and @code{profile-alarm} are
supported only on systems providing the @code{setitimer} system call.
@end defun

@deffn {Callback procedure} user-interrupt @dots{}
@deffnx {Callback procedure} alarm-interrupt @dots{}
@deffnx {Callback procedure} virtual-alarm-interrupt @dots{}
@deffnx {Callback procedure} profile-alarm-interrupt @dots{}
Establishes a response for @code{SIGINT} (control-C interrupt) and
@code{SIGALRM}, @code{SIGVTALRM}, and @code{SIGPROF} interrupts.
Program execution will resume if the handler returns.  This procedure
should @code{(abort)} or some other action which does not return if it
does not want processing to continue after it returns.

Interrupt handlers are disabled during execution @code{system} and
@code{ed} procedures.

To unestablish a response for an interrupt set the handler symbol to
@code{#f}.  For instance, @code{(set! user-interrupt #f)}.
@end deffn

@deffn {Callback procedure} out-of-storage @dots{}
@deffnx {Callback procedure} could-not-open @dots{}
@deffnx {Callback procedure} end-of-program @dots{}
@deffnx {Callback procedure} hang-up @dots{}
@deffnx {Callback procedure} arithmetic-error @dots{}
Establishes a response for storage allocation error, file opening
error, end of program, SIGHUP (hang up interrupt) and arithmetic
errors respectively.  This procedure should (abort) or some other
action which does not return if it does not want the default error
message to also be displayed.  If no procedure is defined for @var{hang-up}
then @var{end-of-program} (if defined) will be called.

To unestablish a response for an error set the handler symbol to
@code{#f}.  For instance, @code{(set! could-not-open #f)}.
@end deffn

@deffn {Callback procedure} gc-hook @dots{}
Allows a Scheme procedure to be run shortly after each garbage collection.
This procedure will not be run recursively.  If it runs long enough
to cause a garbage collection before returning a warning will be
printed.
@end deffn

@defun add-finalizer object finalizer
@var{object} may be any garbage collected object, that is, any object
other than an immediate integer, character, or special token such
as @code{#f} or @code{#t}, @xref{Immediates}.  @var{finalizer} is
a thunk, or procedure taking no arguments.

@var{finalizer} will be invoked asynchronously exactly once some time
after @var{object} becomes eligible for garbage collection.  A reference
to @var{object} in the environment of @var{finalizer} will not prevent
finalization, but will delay the reclamation of @var{object} at least
until the next garbage collection.  A reference to @var{object} in some
other object's finalizer will necessarily prevent finalization until both
objects are eligible for garbage collection.

Finalizers are not run in any predictable order.  All finalizers will be
run by the time the program ends.

This facility was based on the paper by Simon Peyton Jones, et al,
``Stretching the storage manager: weak pointers and stable names in
Haskell'', Proc. 11th International Workshop on the Implementation of
Functional Languages, The Netherlands, September 7-10 1999,
Springer-Verlag LNCS.

@end defun

@node Process Synchronization, Files and Ports, Interrupts, The Language
@section Process Synchronization

@noindent
An @dfn{exchanger} is a procedure of one argument regulating mutually
@cindex exchanger
exclusive access to a resource.  When a exchanger is called, its current
content is returned, while being replaced by its argument in an atomic
operation.

@defun make-exchanger obj

Returns a new exchanger with the argument @var{obj} as its initial
content.

@example
(define queue (make-exchanger (list a)))
@end example

A queue implemented as an exchanger holding a list can be protected from
reentrant execution thus:

@example
(define (pop queue)
  (let ((lst #f))
    (dynamic-wind
        (lambda () (set! lst (queue #f)))
        (lambda () (and lst (not (null? lst))
                        (let ((ret (car lst)))
                          (set! lst (cdr lst))
                          ret)))
        (lambda () (and lst (queue lst))))))

(pop queue)         @result{} a

(pop queue)         @result{} #f
@end example
@end defun

@defun make-arbiter name

Returns an object of type arbiter and name @var{name}.  Its state is
initially unlocked.
@end defun

@defun try-arbiter arbiter

Returns @code{#t} and locks @var{arbiter} if @var{arbiter} was unlocked.
Otherwise, returns @code{#f}.
@end defun

@defun release-arbiter arbiter

Returns @code{#t} and unlocks @var{arbiter} if @var{arbiter} was locked.
Otherwise, returns @code{#f}.
@end defun

@node Files and Ports, Line Numbers, Process Synchronization, The Language
@section Files and Ports

@noindent
These procedures generalize and extend the standard capabilities in
@ref{Ports, , ,r5rs, Revised(5) Scheme}.

@defun open-file string modes
@defunx try-open-file string modes
Returns a port capable of receiving or delivering characters as
specified by the @var{modes} string.  If a file cannot be opened
@code{#f} is returned.

Internal functions opening files @dfn{callback} to the SCM function
@code{open-file}.  You can extend @code{open-file} by redefining it.
@code{try-open-file} is the primitive procedure; Do not redefine
@code{try-open-file}!
@end defun

@defvr Constant open_read
@defvrx Constant open_write
@defvrx Constant open_both
Contain modes strings specifying that a file is to be opened for
reading, writing, and both reading and writing respectively.

Both input and output functions can be used with io-ports.  An end of
file must be read or a file-set-position done on the port between a read
operation and a write operation or vice-versa.
@end defvr

@defun _ionbf modestr
Returns a version of @var{modestr} which when @code{open-file} is called
with it as the second argument will return an unbuffered port.  An
input-port must be unbuffered in order for @code{char-ready?} and
@code{wait-for-input} to work correctly on it.  The initial value of
@code{(current-input-port)} is unbuffered if the platform supports it.
@end defun

@defun _tracked modestr
Returns a version of @var{modestr} which when @code{open-file} is called
with it as the second argument will return a tracked port.  A tracked
port maintains current line and column numbers, which may be queried
with @code{port-line} and @code{port-column}.
@end defun

@defun _exclusive modestr
Returns a version of @var{modestr} which when @code{open-file} is called
with it as the second argument will return a port only if the named file
does not already exist.  This functionality is provided by calling
@code{try-create-file} @xref{I/O-Extensions}, which is not available
for all platforms.
@end defun

@defun port-closed? port
Returns #t if @var{port} is closed.
@end defun

@defun port-type obj
If @var{obj} is not a port returns false, otherwise returns
a symbol describing the port type, for example string or pipe.
@end defun

@defun close-port port
Closes @var{port}.  The same as close-input-port and close-output-port.
@end defun

@defun current-error-port
Returns the current port to which diagnostic output is directed.
@end defun

@defun with-error-to-file string thunk
@var{thunk} must be a procedure of no arguments, and string must be a
string naming a file.  The file is opened for output, an output port
connected to it is made the default value returned by
current-error-port, and the @var{thunk} is called with no arguments.  When
the thunk returns, the port is closed and the previous default is
restored.  With-error-to-file returns the value yielded by @var{thunk}.
@end defun

@defun with-input-from-port port thunk
@defunx with-output-to-port port thunk
@defunx with-error-to-port port thunk
These routines differ from with-input-from-file, with-output-to-file,
and with-error-to-file in that the first argument is a port, rather
than a string naming a file.
@end defun

@defun call-with-outputs thunk proc
Calls the @var{thunk} procedure while the current-output-port and
current-error-port are directed to string-ports.  If @var{thunk}
returns, the @var{proc} procedure is called with the output-string, the
error-string, and the value returned by @var{thunk}.  If @var{thunk}
does not return a value (perhaps because of error), @var{proc} is called
with just the output-string and the error-string as arguments.
@end defun

@deffn {procedure} char-ready?
@deffnx {procedure} char-ready? port

Returns @code{#t} if a character is ready on the input @var{port} and
returns @code{#f} otherwise.  If @code{char-ready?} returns @code{#t}
then
@findex char-ready
the next @code{read-char} operation on the given @var{port} is
guaranteed
@findex read-char
not to hang.  If the @var{port} is at end of file then
@code{char-ready?} returns @code{#t}.
@findex char-ready?
@var{Port} may be omitted, in which case it defaults to
the value returned by @code{current-input-port}.
@findex current-input-port

@emph{Rationale:} @code{Char-ready?} exists to make it possible for a
program to
@findex char-ready?
accept characters from interactive ports without getting stuck waiting
for input.  Any input editors associated with such ports must ensure
that characters whose existence has been asserted by @code{char-ready?}
@findex char-ready?
cannot be rubbed out.  If @code{char-ready?} were to return @code{#f} at
end of file, a port at end of file would be indistinguishable from an
interactive port that has no ready characters.
@c end rationale
@end deffn

@deffn {procedure} wait-for-input x
@deffnx {procedure} wait-for-input x port1 @dots{}
Returns a list those ports @var{port1} @dots{} which are @code{char-ready?}.
@findex char-ready?
If none of @var{port1} @dots{} become @code{char-ready?} within the time
interval of @var{x} seconds, then #f is returned.  The
@var{port1} @dots{} arguments may be omitted, in which case they default
to the list of the value returned by @code{current-input-port}.
@findex current-input-port
@end deffn

@defun isatty? port
Returns @code{#t} if @var{port} is input or output to a serial non-file device.
@end defun

@defun freshline port
Outputs a newline to optional argument @var{port} unless the current
output column number of @var{port} is known to be zero, ie output will
start at the beginning of a new line.  @var{port} defaults to
@code{current-output-port}.  If @var{port} is not a tracked port
@code{freshline} is equivalent to @code{newline}.
@end defun

@defun open-ports
Returns a list of all currently open ports, excluding string ports,
see @xref{String Ports, , , slib, SLIB}.  This may be useful after
a fork @xref{Posix Extensions}, or for debugging.  Bear in mind that
ports that would be closed by gc will be kept open by a reference to
this list.
@end defun


@node Line Numbers, Soft Ports, Files and Ports, The Language
@section Line Numbers

Scheme code define by load may optionally contain line number
information.  Currently this information is used only for reporting
expansion time errors, but in the future run-time error messages may
also include line number information.

@defun try-load pathname reader
This is the primitive for loading, @var{pathname} is the name of 
a file containing Scheme code, and optional argument @var{reader} is
a function of one argument, a port.  @var{reader} should read and
return Scheme code as list structure.  The default value is @code{read},
which is used if @var{reader} is not supplied or is false.
@end defun

Line number objects are disjoint from integers or other Scheme types.
When evaluated or loaded as Scheme code, an s-expression containing a
line-number in the car is equivalent to the cdr of the s-expression.  A
pair consisting of a line-number in the car and a vector in the cdr is
equivalent to the vector.  The meaning of s-expressions with
line-numbers in other positions is undefined.

@defun read-numbered port
Behaves like @code{read}, except that every s-expression read will be
replaced with a cons of a line-number object and the sexp actually read.
This replacement is done only if @var{port} is a tracked port
See @xref{Files and Ports}.
@end defun

@defun integer->line-number int
Returns a line-number object with value @var{int}.  @var{int} should
be an exact non-negative integer.
@end defun

@defun line-number->integer linum
Returns the value of line-number object @var{linum} as an integer.
@end defun

@defun line-number? obj
Returns true if and only if @var{obj} is a line-number object.
@end defun

@defvar *load-reader*
@defvarx *slib-load-reader*
The value of @code{*load-reader*} should be a value acceptable as
the second argument to @code{try-load} (note that #f is acceptable).
This value will be used to read code during calls to @code{scm:load}.
The value of @code{*slib-load-reader*} will similarly be used during
calls to @code{slib:load} and @code{require}.

In order to disable all line-numbering, it is sufficient to set!
@code{*load-reader*} and @code{*slib-load-reader*} to #f.
@end defvar


@node Soft Ports, Syntax Extensions, Line Numbers, The Language
@section Soft Ports

@noindent
A @dfn{soft-port} is a port based on a vector of procedures capable of
accepting or delivering characters.  It allows emulation of I/O ports.

@defun make-soft-port vector modes
Returns a port capable of receiving or delivering characters as
specified by the @var{modes} string (@pxref{Files and Ports,
open-file}).  @var{vector} must be a vector of length 6.  Its components
are as follows:

@enumerate 0
@item
procedure accepting one character for output
@item
procedure accepting a string for output
@item
thunk for flushing output
@item
thunk for getting one character
@item
thunk for closing port (not by garbage collection)
@end enumerate

For an output-only port only elements 0, 1, 2, and 4 need be
procedures.  For an input-only port only elements 3 and 4 need be
procedures.  Thunks 2 and 4 can instead be @code{#f} if there is no useful
operation for them to perform.

If thunk 3 returns @code{#f} or an @code{eof-object} (@pxref{Input,
eof-object?, ,r5rs, Revised(5) Scheme}) it indicates that the port has
reached end-of-file.  For example:

If it is necessary to explicitly close the port when it is garbage
collected, (@pxref{Interrupts, add-finalizer}).

@example
(define stdout (current-output-port))
(define p (make-soft-port
           (vector
            (lambda (c) (write c stdout))
            (lambda (s) (display s stdout))
            (lambda () (display "." stdout))
            (lambda () (char-upcase (read-char)))
            (lambda () (display "@@" stdout)))
           "rw"))

(write p p) @result{} #<input-output-soft#\space45d10#\>
@end example
@end defun

@node Syntax Extensions, Low Level Syntactic Hooks, Soft Ports, The Language
@section Syntax Extensions

@deffn {procedure} procedure-documentation proc
Returns the documentation string of @var{proc} if it exists, or
@code{#f} if not.

If the body of a @code{lambda} (or the definition of a procedure) has
more than one expression, and the first expression (preceeding any
internal definitions) is a string, then that string is the
@dfn{documentation string} of that procedure.
@cindex documentation string

@example
(procedure-documentation (lambda (x) "Identity" x)) @result{} "Identity"
(define (square x)
    "Return the square of X."
    (* x x))
@result{} #<unspecified>
(procedure-documentation square) @result{} "Return the square of X."
@end example
@end deffn

@defun comment string1 @dots{}
Appends @var{string1} @dots{} to the strings given as arguments to
previous calls @code{comment}.
@defunx comment
Returns the (appended) strings given as arguments to previous calls
@code{comment} and empties the current string collection.
@end defun

@deffn {Read syntax} #;text-till-end-of-line
Behaves as @code{(comment "@var{text-till-end-of-line}")}.
@end deffn

@deffn {Read syntax} #. expression
Is read as the object resulting from the evaluation of @var{expression}.
This substitution occurs even inside quoted structure.

In order to allow compiled code to work with @code{#.} it is good
practice to define those symbols used inside of @var{expression} with
@code{#.(define @dots{})}.  For example:

@example
#.(define foo 9)                        @result{} #<unspecified>
'(#.foo #.(+ foo foo))                  @result{} (9 18)
@end example
@end deffn

@deffn {Read syntax} #+ feature form
If feature is @code{provided?} (by @code{*features*}) then @var{form} is
read as a scheme expression.  If not, then @var{form} is treated as
whitespace.

Feature is a boolean expression composed of symbols and @code{and},
@code{or}, and @code{not} of boolean expressions.

For more information on @code{provided?} and @code{*features*},
@xref{Require, , , slib, SLIB}.
@end deffn

@deffn {Read syntax} #- feature form
is equivalent to @code{#+(not feature) expression}.
@end deffn

@deffn {Read syntax} #' form
is equivalent to @var{form} (for compatibility with common-lisp).
@end deffn

@deffn {Read syntax} #| any thing |#
Is a balanced comment.  Everything up to the matching @code{|#} is
ignored by the @code{read}.  Nested @code{#|@dots{}|#} can occur inside
@var{any thing}.
@end deffn

@noindent
A similar read syntax @dfn{#!} (exclamation rather than vertical bar) is
supported for Posix shell-scripts (@pxref{Scripting}).

@deffn {Read syntax} #\token
If @var{token} is a sequence of two or more digits, then this syntax is
equivalent to @code{#.(integer->char (string->number token 8))}.

If @var{token} is @code{C-}, @code{c-}, or @code{^} followed by a
character, then this syntax is read as a control character.  If
@var{token} is @code{M-} or @code{m-} followed by a character, then a
meta character is read.  @code{c-} and @code{m-} prefixes may be
combined.
@end deffn

@defspec defined? symbol
Equivalent to @code{#t} if @var{symbol} is a syntactic keyword (such as
@code{if}) or a symbol with a value in the top level environment
(@pxref{Variables and regions, , ,r5rs, Revised(5) Scheme}).  Otherwise
equivalent to @code{#f}.
@end defspec

@defspec defvar identifier initial-value
If @var{identifier} is unbound in the top level environment, then
@var{identifier} is @code{define}d to the result of evaluating the form
@var{initial-value} as if the @code{defvar} form were instead the form
@code{(define identifier initial-value)} .  If @var{identifier} already
has a value, then @var{initial-value} is @emph{not} evaluated and
@var{identifier}'s value is not changed.  @code{defconst} is valid only
when used at top-level.
@end defspec

@defspec defconst identifier value
If @var{identifier} is unbound in the top level environment, then
@var{identifier} is @code{define}d to the result of evaluating the form
@var{value} as if the @code{defconst} form were instead the form
@code{(define identifier value)} .  If @var{identifier} already has a
value, then @var{value} is @emph{not} evaluated, @var{identifier}'s
value is not changed, and an error is signaled.  @code{defconst} is
valid only when used at top-level.
@end defspec

@defspec set! (variable1 variable2 @dots{}) @r{<expression>}

The identifiers @var{variable1}, @var{variable2}, @dots{} must be bound
either in some region enclosing the @samp{set!} expression or at top
level.

@r{<Expression>} is evaluated, and the elements of the resulting list
are stored in the locations to which each corresponding @var{variable}
is bound.  The result of the @samp{set!} expression is unspecified.

@example
(define x 2)
(define y 3)
(+ x y)                              @result{} 5
(set! (x y) (list 4 5))              @result{} @emph{unspecified}
(+ x y)                              @result{} 9
@end example
@end defspec

@defspec qase key clause1 clause2 @dots{}
@code{qase} is an extension of standard Scheme @code{case}: Each
@var{clause} of a @code{qase} statement must have as first element a
list containing elements which are:

@itemize @bullet
@item
literal datums, or
@item
a comma followed by the name of a symbolic constant, or
@item
a comma followed by an at-sign (@@) followed by the name of a symbolic
constant whose value is a list.
@end itemize

A @code{qase} statement is equivalent to a @code{case} statement in
which these symbolic constants preceded by commas have been replaced by
the values of the constants, and all symbolic constants preceded by
comma-at-signs have been replaced by the elements of the list values of
the constants.  This use of comma, (or, equivalently, @code{unquote}) is
similar to that of @code{quasiquote} except that the unquoted
expressions must be @dfn{symbolic constants}.

Symbolic constants are defined using @code{defconst}, their values are
substituted in the head of each @code{qase} clause during macro
expansion.  @code{defconst} constants should be defined before use.
@code{qase} can be substituted for any correct use of @code{case}.

@format
@t{(defconst unit '1)
(defconst semivowels '(w y))
(qase (* 2 3)
  ((2 3 5 7) 'prime)
  ((,unit 4 6 8 9) 'composite))        ==>  composite
(qase (car '(c d))
  ((a) 'a)
  ((b) 'b))                            ==>  @emph{unspecified}
(qase (car '(c d))
  ((a e i o u) 'vowel)
  ((,@@semivowels) 'semivowel)
  (else 'consonant))                   ==>  consonant
}
@end format

@end defspec

@noindent
@findex defmacro
@findex macroexpand
@findex macroexpand-1
@findex gentemp
SCM also supports the following constructs from Common Lisp:
@code{defmacro}, @code{macroexpand}, @code{macroexpand-1}, and
@code{gentemp}.  @xref{Defmacro, , , slib, SLIB}.

SCM @code{defmacro} is extended over that described for SLIB:

@lisp
(defmacro (macro-name . arguments) body)
@end lisp

is equivalent to

@lisp
(defmacro macro-name arguments body)
@end lisp

As in Common Lisp, an element of the formal argument list for
@code{defmacro} may be a possibly nested list, in which case the
corresponding actual argument must be a list with as many members as the
formal argument.  Rest arguments are indicated by improper lists, as in
Scheme.  It is an error if the actual argument list does not have the
tree structure required by the formal argument list.

For example:

@lisp
(defmacro (let1 ((name value)) . body)
    `((lambda (,name) ,@@body) ,value))

(let1 ((x (foo))) (print x) x) @equiv{} ((lambda (x) (print x) x) (foo))

(let1 not legal syntax) @error{} not "does not match" ((name value))
@end lisp

@findex syntax-rules
SCM supports [R5RS] @code{syntax-rules} macros
@xref{Macros, , ,r5rs, Revised(5) Scheme}.

The pattern language is extended by the syntax @code{(... <obj>)}, which
is identical to @code{<obj>} except that ellipses in @code{<obj>} are
treated as ordinary identifiers in a template, or as literals in a
pattern.  In particular, @code{(... ...)} quotes the ellipsis token
@code{...} in a pattern or template.

For example:
@lisp
(define-syntax check-tree
  (syntax-rules ()
    ((_ (?pattern (... ...)) ?obj)
     (let loop ((obj ?obj))
       (or (null? obj)
           (and (pair? obj)
                (check-tree ?pattern (car obj))
                (loop (cdr obj))))))
    ((_ (?first . ?rest) ?obj)
     (let ((obj ?obj))
       (and (pair? obj)
            (check-tree ?first (car obj))
            (check-tree ?rest (cdr obj)))))
    ((_ ?atom ?obj) #t)))

(check-tree ((a b) ...) '((1 2) (3 4) (5 6))) @result{} #t

(check-tree ((a b) ...) '((1 2) (3 4) not-a-2list) @result{} #f
@end lisp

Note that although the ellipsis is matched as a literal token in the
defined macro it is not included in the literals list for
@code{syntax-rules}.

The pattern language is also extended to support identifier macros.  A
reference to an identifier macro keyword that is not the first
identifier in a form may expand into Scheme code, rather than raising a
``keyword as variable'' error.  The pattern for expansion of such a bare
macro keyword is a single identifier, as in other syntax rules the
identifier is ignored.

For example:
@lisp
(define-syntax eight
    (syntax-rules ()
      (_ 8)))

(+ 3 eight) @result{} 11
(eight) @result{} ERROR
(set! eight 9) @result{} ERROR
@end lisp

@node Low Level Syntactic Hooks, Syntactic Hooks for Hygienic Macros, Syntax Extensions, The Language
@section Low Level Syntactic Hooks

@deffn {Callback procedure} read:sharp c port
If a @key{#} followed by a character (for a non-standard syntax) is
encountered by @code{read}, @code{read} will call the value of the
symbol @code{read:sharp} with arguments the character and the port being
read from.  The value returned by this function will be the value of
@code{read} for this expression unless the function returns
@code{#<unspecified>} in which case the expression will be treated as
whitespace.  @code{#<unspecified>} is the value returned by the
expression @code{(if #f #f)}.
@end deffn

@deffn {Callback procedure} read:sharp-char token
If the sequence @key{#\} followed by a non-standard character name is
encountered by @code{read}, @code{read} will call the value of the
symbol @code{read:sharp-char} with the token (a string of length at
least two) as argument.  If the value returned is a character, then that
will be the value of @code{read} for this expression, otherwise an error
will be signaled.
@end deffn

@emph{Note:} When adding new @key{#} syntaxes, have your code save the
previous value of @code{read:sharp} or @code{read:sharp-char} when
defining it.  Call this saved value if an invocation's syntax is not
recognized.  This will allow @code{#+}, @code{#-}, @code{#!}, and
@ref{Uniform Array}s to still be supported (as they use @code{read:sharp}).

@defun procedure->syntax proc
Returns a @dfn{macro} which, when a symbol defined to this value appears
as the first symbol in an expression, returns the result of applying
@var{proc} to the expression and the environment.
@end defun

@defun procedure->macro proc
@defunx procedure->memoizing-macro proc
@defunx procedure->identifier-macro
Returns a @dfn{macro} which, when a symbol defined to this value appears
as the first symbol in an expression, evaluates the result of applying
@var{proc} to the expression and the environment.  The value returned
from @var{proc} which has been passed to
@code{PROCEDURE->MEMOIZING-MACRO} replaces the form passed to
@var{proc}.  For example:

@example
(defsyntax trace
  (procedure->macro
   (lambda (x env) `(set! ,(cadr x) (tracef ,(cadr x) ',(cadr x))))))

(trace @i{foo}) @equiv{} (set! @i{foo} (tracef @i{foo} '@i{foo})).
@end example

@code{PROCEDURE->IDENTIFIER-MACRO} is similar to
@code{PROCEDURE->MEMOIZING-MACRO} except that @var{proc} is also
called in case the symbol bound to the macro appears in an expression
but @emph{not} as the first symbol, that is, when it looks like a
variable reference.  In that case, the form passed to @var{proc} is
a single identifier.

@end defun

@defspec defsyntax name expr
Defines @var{name} as a macro keyword bound to the result of evaluating
@var{expr}, which should be a macro.  Using @code{define} for this
purpose may not result in @var{name} being interpreted as a macro
keyword.
@end defspec

An @dfn{environment} is a list of frames representing lexical bindings.
Only the names and scope of the bindings are included in environments
passed to macro expanders -- run-time values are not included.

There are several types of environment frames:

@table @code
@item ((lambda (variable1 @dots{}) @dots{}) value1 @dots{})
@itemx (let ((variable1 value1) (variable2 value2) @dots{}) @dots{})
@itemx (letrec ((variable1 value1)  @dots{}) @dots{})
result in a single enviroment frame:
@example

(variable1 variable2 @dots{})

@end example

@item (let ((variable1 value1)) @dots{})
@itemx (let* ((variable1 value1) @dots{}) @dots{})
result in an environment frame for each variable:
@example

variable1 variable2 @dots{}

@end example

@item (let-syntax ((key1 macro1) (key2 macro2)) @dots{})
@itemx (letrec-syntax ((key1 value1) (key2 value2)) @dots{})
Lexically bound macros result in environment frames consisting of
a marker and an alist of keywords and macro objects:
@example

(<env-syntax-marker> (key1 . value1) (key2 . value2))

@end example
Currently <env-syntax-marker> is the integer 6.

@item line numbers
Line numbers (@pxref{Line Numbers}) may be included in the environment
as frame entries to indicate the line number on which a function is
defined.  They are ignored for variable lookup.
@example

#<line 8> 

@end example

@item miscellaneous
Debugging information is stored in environments in a plist format: Any
exact integer stored as an environment frame may be followed by any
value.  The two frame entries are ignored when doing variable lookup.
Load file names, procedure names, and closure documentation strings
are stored in this format.
@example

<env-filename-marker> "foo.scm" <env-procedure-name-marker> foo @dots{}

@end example

Currently <env-filename-marker> is the integer 1 and
<env-procedure-name-marker> the integer 2.


@end table

@defspec @@apply procedure argument-list
Returns the result of applying @var{procedure} to @var{argument-list}.
@code{@@apply} differs from @code{apply} when the identifiers bound by
the closure being applied are @code{set!}; setting affects
@var{argument-list}.

@example
(define lst (list 'a 'b 'c))
(@@apply (lambda (v1 v2 v3) (set! v1 (cons v2 v3))) lst)
lst           @result{} ((b . c) b c)
@end example

Thus a mutable environment can be treated as both a list and local
bindings.
@end defspec

@node Syntactic Hooks for Hygienic Macros,  , Low Level Syntactic Hooks, The Language
@section Syntactic Hooks for Hygienic Macros

SCM provides a synthetic identifier type for efficient implementation of
hygienic macros (for example, @code{syntax-rules} @pxref{Macros, , ,
r5rs, Revised(5) Scheme}) A synthetic identifier may be inserted in
Scheme code by a macro expander in any context where a symbol would
normally be used.  Collectively, symbols and synthetic identifiers are
@emph{identifiers}.

@defun identifier? obj
Returns @code{#t} if @var{obj} is a symbol or a synthetic
identifier, and @code{#f} otherwise.
@end defun

If it is necessary to distinguish between symbols and synthetic identifiers,
use the predicate @code{symbol?}.

A synthetic identifier includes two data: a parent, which is an
identifier, and an environment, which is either @code{#f} or a lexical
environment which has been passed to a @dfn{macro expander}
(a procedure passed as an argument to @code{procedure->macro},
@code{procedure->memoizing-macro}, or @code{procedure->syntax}).

@defun renamed-identifier parent env
Returns a synthetic identifier.  @var{parent} must be an identifier, and
@var{env} must either be @code{#f} or a lexical environment passed to a
macro expander.  @code{renamed-identifier} returns a distinct object for
each call, even if passed identical arguments.
@end defun

There is no direct way to access all of the data internal to a synthetic
identifier, those data are used during variable lookup.  If a synthetic
identifier is inserted as quoted data then during macro expansion it
will be repeatedly replaced by its parent, until a symbol is obtained.

@defun identifier->symbol id
Returns the symbol obtained by recursively extracting the parent of
@var{id}, which must be an identifier.
@end defun

@subsection Use of synthetic identifiers
@code{renamed-identifier} may be used as a replacement for @code{gentemp}:
@lisp
(define gentemp
  (let ((name (string->symbol "An unlikely variable")))
    (lambda ()
      (renamed-identifier name #f))))
@end lisp        

If an identifier returned by this version of @code{gentemp} is inserted
in a binding position as the name of a variable then it is guaranteed
that no other identifier (except one produced by passing the first to
@code{renamed-identifier}) may denote that variable.  If an identifier
returned by @code{gentemp} is inserted free, then it will denote the
top-level value bound to its parent, the symbol named ``An unlikely
variable''.  This behavior, of course, is meant to be put to good use:

@lisp
(define top-level-foo
  (procedure->memoizing-macro
   (lambda (exp env)
     (renamed-identifier 'foo #f))))
@end lisp

Defines a macro which may always be used to refer to the top-level binding
of @code{foo}.

@lisp
(define foo 'top-level)
(let ((foo 'local))
  (top-level-foo))  @result{} top-level
@end lisp

In other words, we can avoid capturing @code{foo}.

If a lexical environment is passed as the second argument to
@code{renamed-identifier} then if the identifier is inserted free
its parent will be looked up in that environment, rather than in 
the top-level environment.  The use of such an identifier @emph{must}
be restricted to the lexical scope of its environment.

There is another restriction imposed for implementation convenience:
Macros passing their lexical environments to @code{renamed-identifier}
may be lexically bound only by the special forms @code{let-syntax} or
@code{letrec-syntax}.  No error is signaled if this restriction is not
met, but synthetic identifier lookup will not work properly.

In order to maintain referential transparency it is necessary to
determine whether two identifiers have the same denotation.  With
synthetic identifiers it is not necessary that two identifiers be
@code{eq?} in order to denote the same binding.

@defun identifier-equal? id1 id2 env
Returns @code{#t} if identifiers @var{id1} and @var{id2} denote the same
binding in lexical environment @var{env}, and @code{#f} otherwise.
@var{env} must either be a lexical environment passed to a macro transformer
during macro expansion or the empty list.

For example,
@lisp
(define top-level-foo?
  (procedure->memoizing-macro
   (let ((foo-name (renamed-identifier 'foo #f)))
     (lambda (exp env)
       (identifier-equal? (cadr exp) foo-name env)))))

(top-level-foo? foo)  @result{} #t

(let ((foo 'local))
  (top-level-foo? foo))  @result{} #f
@end lisp
@end defun

@defun @@macroexpand1 expr env
If the @code{car} of @var{expr} denotes a macro in @var{env}, then
if that macro is a primitive, @var{expr} will be returned, if the
macro was defined in Scheme, then a macro expansion will be returned.
If the @code{car} of @var{expr} does not denote a macro, the @code{#f}
is returned.
@end defun

@defun extended-environment names values env
Returns a new environment object, equivalent to @var{env}, which must
either be an environment object or null, extended by one frame.
@var{names} must be an identifier, or an improper list of identifiers,
usable as a formals list in a @code{lambda} expression.  @var{values}
must be a list of objects long enough to provide a binding for each of
the identifiers in @var{names}.  If @var{names} is an identifier or an
improper list then @var{vals} may be, respectively, any object or an
improper list of objects.
@end defun

@defspec syntax-quote obj
Synthetic identifiers are converted to their parent symbols by @code{quote}
and @code{quasiquote} so that literal data in macro definitions will be
properly transcribed.  @code{syntax-quote} behaves like @code{quote}, but
preserves synthetic identifier intact.
@end defspec

@defspec the-macro mac
@code{the-macro} is the simplest of all possible macro transformers:
@var{mac} may be a syntactic keyword (macro name) or an expression
evaluating to a macro, otherwise an error is signaled.  @var{mac} is
evaluated and returned once only, after which the same memoizied value is
returned.

@code{the-macro} may be used to protect local copies of macros against
redefinition, for example:
@lisp
(@@let-syntax ((let (the-macro let)))
   ;; code that will continue to work even if LET is redefined.
        @dots{})
@end lisp
@end defspec

@defspec renaming-transformer proc
A low-level ``explicit renaming'' macro facility very similar to that
proposed by W. Clinger [Exrename] is supported.  Syntax may be defined
in @code{define-syntax}, @code{let-syntax}, and @code{letrec-syntax}
using @code{renaming-transformer} instead of @code{syntax-rules}.
@var{proc} should evaluate to a procedure accepting three arguments:
@var{expr}, @var{rename}, and @var{compare}.  @var{expr} is a
representation of Scheme code to be expanded, as list structure.
@var{rename} is a procedure accepting an identifier and returning an
identifier renamed in the definition environment of the new syntax.
@var{compare} accepts two identifiers and returns true if and only if
both denote the same binding in the usage environment of the new syntax.
@end defspec

@node Packages, The Implementation, The Language, Top
@chapter Packages

@menu
* Dynamic Linking::             
* Dump::                        Create Fast-Booting Executables
* Numeric::                     Numeric Language Extensions
* Arrays::                      As in APL
* Records::                     Define new aggregate data types
* I/O-Extensions::              i/o-extensions
* Posix Extensions::            posix
* Unix Extensions::             non-posix unix
* Regular Expression Pattern Matching::  regex
* Line Editing::                edit-line
* Curses::                      Screen Control
* Sockets::                     Cruise the Net
@end menu

@cindex Xlib
@cindex Xlibscm
@cindex xlib
@cindex xlibscm
@cindex x
@cindex X
@cindex graphics
@cindex hobbit
@menu
* Xlib: (Xlibscm).              X Window Graphics.
* Hobbit: (hobbit).             Scheme-to-C Compiler.
@end menu

@iftex
@section hobbit

@ifset html
<A HREF="hobbit_toc.html">
@code{(require 'compile)}

@dfn{hobbit}
</A>
is a SCM->C compiler.
@end ifset
@end iftex

@node Dynamic Linking, Dump, Packages, Packages
@section Dynamic Linking

@noindent
If SCM has been compiled with @file{dynl.c} then the additional
properties of load and ([SLIB]) require specified here are supported.
The @code{require} form is preferred.

@defun require feature
If the symbol @var{feature} has not already been given as an argument to
@code{require}, then the object and library files associated with
@var{feature} will be dynamically-linked, and an unspecified value
returned.  If @var{feature} is not found in @code{*catalog*}, then an
error is signaled.
@end defun

@defun usr:lib lib
Returns the pathname of the C library named @var{lib}.  For example:
@code{(usr:lib "m")} returns @code{"/usr/lib/libm.a"}, the path of the C
math library.
@end defun

@defun x:lib lib
Returns the pathname of the X library named @var{lib}.  For example:
@code{(x:lib "X11")} returns @code{"/usr/X11/lib/libX11.sa"}, the path
of the X11 library.
@end defun

@defun load filename lib1 @dots{}
In addition to the [R5RS] requirement of loading Scheme expressions if
@var{filename} is a Scheme source file, @code{load} will also
dynamically load/link object files (produced by @code{compile-file}, for
instance).  The object-suffix need not be given to load.  For example,

@example
(load (in-vicinity (implementation-vicinity) "sc2"))
or (load (in-vicinity (implementation-vicinity) "sc2.o"))
or (require 'rev2-procedures)
@ftindex rev2-procedures
or (require 'rev3-procedures)
@ftindex rev3-procedures
@end example

will load/link @file{sc2.o} if it exists.

The @var{lib1} @dots{} pathnames specify additional libraries which may
be needed for object files not produced by the Hobbit compiler.  For
instance, crs is linked on Linux by

@example
(load (in-vicinity (implementation-vicinity) "crs.o")
      (usr:lib "ncurses") (usr:lib "c"))
or (require 'curses)
@ftindex curses
@end example

Turtlegr graphics library is linked by:

@example
(load (in-vicinity (implementation-vicinity) "turtlegr")
      (usr:lib "X11") (usr:lib "c") (usr:lib "m"))
or (require 'turtle-graphics)
@ftindex turtle-graphics
@end example

And the string regular expression (@pxref{Regular Expression Pattern
Matching}) package is linked by:

@example
(load (in-vicinity (implementation-vicinity) "rgx") (usr:lib "c"))
@end example
or
@example
(require 'regex)
@ftindex regex
@end example
@end defun

@noindent
The following functions comprise the low-level Scheme interface to
dynamic linking.  See the file @file{Link.scm} in the SCM distribution
for an example of their use.

@defun dyn:link filename
@var{filename} should be a string naming an @dfn{object} or
@dfn{archive} file, the result of C-compiling.  The @code{dyn:link}
procedure links and loads @var{filename} into the current SCM session.
If successfull, @code{dyn:link} returns a @dfn{link-token} suitable for
passing as the second argument to @code{dyn:call}.  If not successful,
@code{#f} is returned.
@end defun

@defun dyn:call name link-token
@var{link-token} should be the value returned by a call to
@code{dyn:link}.  @var{name} should be the name of C function of no
arguments defined in the file named @var{filename} which was succesfully
@code{dyn:link}ed in the current SCM session.  The @code{dyn:call}
procedure calls the C function corresponding to @var{name}.  If
successful, @code{dyn:call} returns @code{#t}; If not successful,
@code{#f} is returned.

@code{dyn:call} is used to call the @dfn{init_@dots{}} function after
loading SCM object files.  The init_@dots{} function then makes the
identifiers defined in the file accessible as Scheme procedures.
@end defun

@defun dyn:main-call name link-token arg1 @dots{}
@var{link-token} should be the value returned by a call to
@code{dyn:link}.  @var{name} should be the name of C function of 2
arguments, @code{(int argc, char **argv)}, defined in the file named
@var{filename} which was succesfully @code{dyn:link}ed in the current
SCM session.  The @code{dyn:main-call} procedure calls the C function
corresponding to @var{name} with @code{argv} style arguments, such as
are given to C @code{main} functions.  If successful,
@code{dyn:main-call} returns the integer returned from the call to
@var{name}.

@code{dyn:main-call} can be used to call a @code{main} procedure from
SCM.  For example, I link in and @code{dyn:main-call} a large C program,
the low level routines of which callback (@pxref{Callbacks}) into SCM
(which emulates PCI hardware).
@end defun

@defun dyn:unlink link-token
@var{link-token} should be the value returned by a call to
@code{dyn:link}.  The @code{dyn:unlink} procedure removes the previously
loaded file from the current SCM session.  If successful,
@code{dyn:unlink} returns @code{#t}; If not successful, @code{#f} is
returned.
@end defun


@node Dump, Numeric, Dynamic Linking, Packages
@section Dump

@ftindex dump
@ftindex unexec
@dfn{Dump}, (also known as @dfn{unexec}), saves the continuation of an
entire SCM session to an executable file, which can then be invoked as a
program.  Dumped executables start very quickly, since no Scheme code
has to be loaded.

@noindent
There are constraints on which sessions are savable using @code{dump}

@itemize @bullet
@item
Saved continuations are invalid in subsequent invocations; they cause
segmentation faults and other unpleasant side effects.
@item
Although DLD (@pxref{Dynamic Linking}) can be used to load compiled
modules both before and after dumping, @samp{SUN_DL} ELF systems can
load compiled modules only after dumping.  This can be worked around by
compiling in those features you wish to @code{dump}.
@item
Ports (other than @code{current-input-port}, @code{current-output-port},
@code{current-error-port}), X windows, etc. are invalid in subsequent
invocations.

This restriction could be removed; @xref{Improvements To Make}.
@item
@code{Dump} should only be called from a loading file when the call to
dump is the last expression in that file.
@item
@code{Dump} can be called from the command line.
@end itemize

@defun dump newpath
@defunx dump newpath #f
@defunx dump newpath #t
@defunx dump newpath thunk
@itemize @bullet
@item
Calls @code{gc}.
@item
@findex boot-tail
Creates an executable program named @var{newpath} which continues the
state of the current SCM session when invoked.  The optional argument
@var{thunk}, if provided, should be a procedure of no arguments;
@var{boot-tail} will be set to this procedure, causing it to be called
in the restored executable.

If the optional argument is missing or a boolean, SCM's standard command
line processing will be called in the restored executable.

If the second argument to @code{dump} is @code{#t}, argument processing
will continue from the command line passed to the dumping session.  If
the second argument is missing or @code{#f} then the command line
arguments of the restoring invocation will be processed.
@item
Resumes the top level Read-Eval-Print loop.  This is done instead of
continuing normally to avoid creating a saved continuation in the dumped
executable.
@end itemize

@code{dump} may set the values of @code{boot-tail}, @code{*argv*},
@code{restart}, and @var{*interactive*}.  @code{dump} returns an
unspecified value.
@end defun

When a dumped executable is invoked, the variable @var{*interactive*}
(@pxref{Internal State}) has the value it possessed when @code{dump}
created it.  Calling @code{dump} with a single argument sets
@var{*interactive*} to @code{#f}, which is the state it has at the
beginning of command line processing.

The procedure @code{program-arguments} returns the command line
arguments for the curent invocation.  More specifically,
@code{program-arguments} for the restored session are @emph{not} saved
from the dumping session.  Command line processing is done on
the value of the identifier @code{*argv*}.

The following example shows how to create @samp{rscm}, which is like
regular scm, but which loads faster and has the @samp{random} package
alreadly provided.

@example
bash$ scm -rrandom
> (dump "rscm")
#<unspecified>
> (quit)
bash$ ./rscm -lpi.scm -e"(pi (random 200) 5)"
00003 14159 26535 89793 23846 26433 83279 50288 41971 69399
37510 58209 74944 59230 78164 06286 20899 86280 34825 34211
70679 82148 08651 32823 06647 09384 46095 50582 23172 53594
08128 48111 74502 84102 70193 85211 05559 64462 29489 
bash$ 
@end example

This task can also be accomplished using the @samp{-o} command line
option (@pxref{SCM Options}).

@example
bash$ scm -rrandom -o rscm
> (quit)
bash$ ./rscm -lpi.scm -e"(pi (random 200) 5)"
00003 14159 26535 89793 23846 26433 83279 50288 41971 69399
37510 58209 74944 59230 78164 06286 20899 86280 34825 34211
70679 82148 08651 32823 06647 09384 46095 50582 23172 53594
08128 48111 74502 84102 70193 85211 05559 64462 29489 
bash$ 
@end example

@node Numeric, Arrays, Dump, Packages
@section Numeric

@defvr Constant most-positive-fixnum
The immediate integer closest to positive infinity.
@xref{Configuration, , , slib, SLIB}.
@end defvr

@defvr Constant most-negative-fixnum
The immediate integer closest to negative infinity.
@end defvr

@defvr Constant $pi
@defvrx Constant pi
The ratio of the circumference to the diameter of a circle.
@end defvr

@noindent
These procedures augment the standard capabilities in @ref{Numerical
operations, , ,r5rs, Revised(5) Scheme}.

@defun pi* z
@code{(* pi @var{z})}
@end defun

@defun pi/ z
@code{(/ pi @var{z})}
@end defun

@defun sinh z
@defunx cosh z
@defunx tanh z
Return the hyperbolic sine, cosine, and tangent of @var{z}
@end defun

@defun asinh z
@defunx acosh z
@defunx atanh z
Return the inverse hyperbolic sine, cosine, and tangent of @var{z}
@end defun

@defun $sqrt x
@defunx $abs x
@defunx $exp x
@defunx $log x
@defunx $sin x
@defunx $cos x
@defunx $tan x
@defunx $asin x
@defunx $acos x
@defunx $atan x

@defunx $sinh x
@defunx $cosh x
@defunx $tanh x
@defunx $asinh x
@defunx $acosh x
@defunx $atanh x
Real-only versions of these popular functions.  The argument @var{x}
must be a real number.  It is an error if the value which should be
returned by a call to these procedures is @emph{not} real.
@end defun

@defun $log10 x
Real-only base 10 logarithm.
@end defun

@defun $atan2 y x
Computes @code{(angle (make-rectangular x y))} for real numbers @var{y}
and @var{x}.
@end defun

@defun $expt x1 x2
Returns real number @var{x1} raised to the real power @var{x2}.  It is
an error if the value which should be returned by a call to @code{$expt}
is not real.
@end defun

@node Arrays, Records, Numeric, Packages
@section Arrays

@menu
* Conventional Arrays::         
* Array Mapping::               array-for-each
* Uniform Array::               
* Bit Vectors::                 
@end menu

@node Conventional Arrays, Array Mapping, Arrays, Arrays
@subsection Conventional Arrays

@dfn{Arrays} read and write as a @code{#} followed by the @dfn{rank}
@cindex array
(number of dimensions) followed by the character #\a or #\A and what
appear as lists (of lists) of elements.  The lists must be nested to the
depth of the rank.  For each depth, all lists must be the same length.
@example
(make-array 'ho 3 3) @result{}
#2A((ho ho ho) (ho ho ho) (ho ho ho))
@end example

The rank may be elided, in which case it is read as one.
@example
'#A(a b c) @equiv{} '#(a b c)
@end example

Unshared conventional (not uniform) 0-based arrays of rank 1 (dimension)
are equivalent to (and can't be distinguished from) vectors.
@example
(make-array 'ho 3) @result{} #(ho ho ho)
@end example

When constructing an array, @var{bound} is either an inclusive range of
indices expressed as a two element list, or an upper bound expressed
as a single integer.  So
@example
(make-array 'foo 3 3) @equiv{} (make-array 'foo '(0 2) '(0 2))
@end example

@defun array? obj
Returns @code{#t} if the @var{obj} is an array, and @code{#f} if not.
@end defun

@defun make-array initial-value bound1 bound2 @dots{}
Creates and returns an array that has as many dimensions as there are
@var{bound}s and fills it with @var{initial-value}.
@end defun

@defun array-ref array index1 index2 @dots{}
Returns the @var{index1}, @var{index2}, @dots{}'th element of
@var{array}.
@end defun

@defun array-in-bounds? array index1 index2 @dots{}
Returns @code{#t} if its arguments would be acceptable to @var{array-ref}.
@end defun

@defun array-set! array new-value index1 index2 @dots{}
Sets the @var{index1}, @var{index2}, @dots{}'th element of @var{array}
to @var{new-value}.  The value returned by @code{array-set!} is
unspecified.
@end defun

@defun make-shared-array array mapper bound1 bound2 @dots{}
@code{make-shared-array} can be used to create shared subarrays of other
arrays.  The @var{mapper} is a function that translates coordinates in
the new array into coordinates in the old array.  A @var{mapper} must be
linear, and its range must stay within the bounds of the old array, but
it can be otherwise arbitrary.  A simple example:
@example
(define fred (make-array #f 8 8))
(define freds-diagonal
  (make-shared-array fred (lambda (i) (list i i)) 8))
(array-set! freds-diagonal 'foo 3)
(array-ref fred 3 3) @result{} foo
(define freds-center
  (make-shared-array fred (lambda (i j) (list (+ 3 i) (+ 3 j))) 2 2))
(array-ref freds-center 0 0) @result{} foo
@end example
@end defun

@defun transpose-array array dim0 dim1 @dots{}
Returns an array sharing contents with @var{array}, but with dimensions
arranged in a different order.  There must be one @var{dim} argument for
each dimension of @var{array}.  @var{dim0}, @var{dim1}, @dots{} should
be integers between 0 and the rank of the array to be returned.  Each
integer in that range must appear at least once in the argument list.

The values of @var{dim0}, @var{dim1}, @dots{} correspond to dimensions
in the array to be returned, their positions in the argument list to
dimensions of @var{array}.  Several @var{dim}s may have the same value,
in which case the returned array will have smaller rank than
@var{array}.

examples:
@example
(transpose-array '#2A((a b) (c d)) 1 0) @result{} #2A((a c) (b d))
(transpose-array '#2A((a b) (c d)) 0 0) @result{} #1A(a d)
(transpose-array '#3A(((a b c) (d e f)) ((1 2 3) (4 5 6))) 1 1 0) @result{}
                #2A((a 4) (b 5) (c 6))
@end example
@end defun

@defun enclose-array array dim0 dim1 @dots{}
@var{dim0}, @var{dim1} @dots{} should be nonnegative integers less than
the rank of @var{array}.  @var{enclose-array} returns an array
resembling an array of shared arrays.  The dimensions of each shared
array are the same as the @var{dim}th dimensions of the original array,
the dimensions of the outer array are the same as those of the original
array that did not match a @var{dim}.

An enclosed array is not a general Scheme array.  Its elements may not
be set using @code{array-set!}.  Two references to the same element of
an enclosed array will be @code{equal?} but will not in general be
@code{eq?}.  The value returned by @var{array-prototype} when given an
enclosed array is unspecified.

examples:
@example
(enclose-array '#3A(((a b c) (d e f)) ((1 2 3) (4 5 6))) 1) @result{}
   #<enclosed-array (#1A(a d) #1A(b e) #1A(c f)) (#1A(1 4) #1A(2 5) #1A(3 6))>

(enclose-array '#3A(((a b c) (d e f)) ((1 2 3) (4 5 6))) 1 0) @result{}
   #<enclosed-array #2A((a 1) (d 4)) #2A((b 2) (e 5)) #2A((c 3) (f 6))>
@end example
@end defun

@defun array-shape array
Returns a list of inclusive bounds of integers.
@example
(array-shape (make-array 'foo '(-1 3) 5)) @result{} ((-1 3) (0 4))
@end example
@end defun

@defun array-dimensions array
@code{Array-dimensions} is similar to @code{array-shape} but replaces
elements with a @code{0} minimum with one greater than the maximum.  So:
@example
(array-dimensions (make-array 'foo '(-1 3) 5)) @result{} ((-1 3) 5)
@end example
@end defun

@defun array-rank obj
Returns the number of dimensions of @var{obj}.  If @var{obj} is not an
array, @code{0} is returned.
@end defun

@defun array->list array
Returns a list consisting of all the elements, in order, of @var{array}.
In the case of a rank-0 array, returns the single element.
@end defun

@defun array-copy! source destination
Copies every element from vector or array @var{source} to the
corresponding element of @var{destination}.  @var{destination} must have
the same rank as @var{source}, and be at least as large in each
dimension.  The order of copying is unspecified.
@end defun

@defun serial-array-copy! source destination
Same as @code{array-copy!} but guaranteed to copy in row-major order.
@end defun

@defun array-fill! array fill
Stores @var{fill} in every element of @var{array}.  The value returned
is unspecified.
@end defun

@defun array-equal? array0 array1 @dots{}
Returns @code{#t} iff all arguments are arrays with the same shape, the
same type, and have corresponding elements which are either
@code{equal?}  or @code{array-equal?}.  This function differs from
@code{equal?} in that a one dimensional shared array may be
@var{array-equal?} but not @var{equal?} to a vector or uniform vector.
@end defun

@defun array-contents array
@defunx array-contents array strict
If @var{array} may be @dfn{unrolled} into a one dimensional shared array
without changing their order (last subscript changing fastest), then
@code{array-contents} returns that shared array, otherwise it returns
@code{#f}.  All arrays made by @var{make-array} and
@var{create-array} may be unrolled, some arrays made by
@var{make-shared-array} may not be.

If the optional argument @var{strict} is provided, a shared array will
be returned only if its elements are stored internally contiguous in
memory.
@end defun

@node Array Mapping, Uniform Array, Conventional Arrays, Arrays
@subsection Array Mapping

@code{(require 'array-for-each)}
@ftindex array-for-each

@defun array-map! array0 proc array1 @dots{}

If @var{array1}, @dots{} are arrays, they must have the same number of
dimensions as @var{array0} and have a range for each index which
includes the range for the corresponding index in @var{array0}.
If they are scalars, that is, not arrays, vectors, or strings, then
they will be converted internally to arrays of the appropriate shape.
@var{proc} is applied to each tuple of elements of @var{array1} @dots{}
and the result is stored as the corresponding element in @var{array0}.
The value returned is unspecified.  The order of application is
unspecified.

@end defun

@defun serial-array-map! array0 proc array1 @dots{}
Same as @var{array-map!}, but guaranteed to apply @var{proc} in
row-major order.
@end defun

@defun array-for-each proc array0 @dots{}
@var{proc} is applied to each tuple of elements of @var{array0} @dots{}
in row-major order.  The value returned is unspecified.
@end defun

@defun array-index-map! array proc
applies @var{proc} to the indices of each element of @var{array} in
turn, storing the result in the corresponding element.  The value
returned and the order of application are unspecified.

One can implement @var{array-indexes} as
@example
(define (array-indexes array)
    (let ((ra (apply make-array #f (array-shape array))))
      (array-index-map! ra (lambda x x))
      ra))
@end example
Another example:
@example
(define (apl:index-generator n)
    (let ((v (make-vector n 1)))
      (array-index-map! v (lambda (i) i))
      v))
@end example
@end defun

@defun scalar->array scalar array prototype
Returns a uniform array of the same shape as @var{array}, having only
one shared element, which is @code{eqv?} to @var{scalar}.
If the optional argument @var{prototype} is supplied it will be used
as the prototype for the returned array.  Otherwise the returned array
will be of the same type as @code{array} if that is possible, and
a conventional array if it is not.  This function is used internally
by @code{array-map!} and friends to handle scalar arguments.
@end defun


@node Uniform Array, Bit Vectors, Array Mapping, Arrays
@subsection Uniform Array

@noindent
@dfn{Uniform Arrays} and vectors are arrays whose elements are all of
the same type.  Uniform vectors occupy less storage than conventional
vectors.  Uniform Array procedures also work on vectors,
uniform-vectors, bit-vectors, and strings.

SLIB now supports uniform arrys.  The primary array creation procedure
is @code{create-array}, detailed in @xref{Arrays, , , slib, SLIB}.

@noindent
Unshared uniform character 0-based arrays of rank 1 (dimension)
are equivalent to (and can't be distinguished from) strings.
@example
(create-array "" 3) @result{} "$q2"
@end example

@noindent
Unshared uniform boolean 0-based arrays of rank 1 (dimension) are
equivalent to (and can't be distinguished from) @ref{Bit Vectors,
bit-vectors}.
@example
(create-array '#at() 3) @result{} #*000
@equiv{}
#At(#f #f #f) @result{} #*000
@equiv{}
#1At(#f #f #f) @result{} #*000
@end example

@noindent
@var{prototype} arguments in the following procedures are interpreted
according to the table:

@example
prototype       type                              display prefix

()              conventional vector                     #a
+64i            complex (double precision)              #ac64
64.0            double (double precision)               #ar64
32.0            float (single precision)                #ar32
32              unsigned integer (32-bit)               #au32
-32             signed integer (32-bit)                 #as32
-16             signed integer (16-bit)                 #as16
#\a             char (string)                           #a\
#t              boolean (bit-vector)                    #at
@end example

@noindent
Other uniform vectors are written in a form similar to that of general
arrays, except that one or more modifying characters are put between the
#\A character and the contents list.  For example, @code{'#As32(3 5 9)}
returns a uniform vector of signed integers.

@defun array? obj prototype
Returns @code{#t} if the @var{obj} is an array of type corresponding to
@var{prototype}, and @code{#f} if not.
@end defun

@defun array-prototype array
Returns an object that would produce an array of the same type as
@var{array}, if used as the @var{prototype} for
@code{list->uniform-array}.
@end defun

@defun list->uniform-array rank prot lst
Returns a uniform array of the type indicated by prototype @var{prot}
with elements the same as those of @var{lst}.  Elements must be of the
appropriate type, no coercions are done.

In, for example, the case of a rank-2 array, @var{lst} must be a list of
lists, all of the same length.  The length of @var{lst} will be the
first dimension of the result array, and the length of each element the
second dimension.

If @var{rank} is zero, @var{lst}, which need not be a list, is the
single element of the returned array.
@end defun

@defun uniform-vector-fill! uve fill
Stores @var{fill} in every element of @var{uve}.  The value returned is
unspecified.
@end defun

@defun dimensions->uniform-array dims prototype fill
@defunx dimensions->uniform-array dims prototype
Creates and returns a uniform array or vector of type corresponding to
@var{prototype} with dimensions @var{dims} or length @var{length}.  If
the @var{fill} argument is supplied, the returned array is filled with
this value.
@end defun

@defun uniform-array-read! ura
@defunx uniform-array-read! ura port
Attempts to read all elements of @var{ura}, in lexicographic order, as
binary objects from @var{port}.  If an end of file is encountered during
uniform-array-read! the objects up to that point only are put into @var{ura}
(starting at the beginning) and the remainder of the array is
unchanged.

@code{uniform-array-read!} returns the number of objects read.
@var{port} may be omitted, in which case it defaults to the value
returned by @code{(current-input-port)}.
@end defun

@defun uniform-array-write ura
@defunx uniform-array-write ura port
Writes all elements of @var{ura} as binary objects to @var{port}.  The
number of of objects actually written is returned.  @var{port} may be
omitted, in which case it defaults to the value returned by
@code{(current-output-port)}.
@end defun

@defun logaref array index1 index2 @dots{}
If an @var{index} is provided for each dimension of @var{array} returns
the @var{index1}, @var{index2}, @dots{}'th element of @var{array}.  If
one more @var{index} is provided, then the last index specifies bit
position of the twos-complement representation of the array element
indexed by the other @var{index}s returning @code{#t} if the bit is 1,
and @code{#f} if 0.  It is an error if this element is not an exact
integer.

@example
(logaref '#(#b1101 #b0010) 0)       @result{} #b1101
(logaref '#(#b1101 #b0010) 0 1)     @result{} #f
(logaref '#2((#b1101 #b0010)) 0 0)  @result{} #b1101
@end example
@end defun

@defun logaset! array val index1 index2 @dots{}
If an @var{index} is provided for each dimension of @var{array} sets the
@var{index1}, @var{index2}, @dots{}'th element of @var{array} to
@var{val}.  If one more @var{index} is provided, then the last index
specifies bit position of the twos-complement representation of an exact
integer array element, setting the bit to 1 if @var{val} is @code{#t}
and to 0 if @var{val} is @code{#f}.  In this case it is an error
if the array element is not an exact integer or if @var{val} is not
boolean.
@end defun

@node Bit Vectors,  , Uniform Array, Arrays
@subsection Bit Vectors

@noindent
Bit vectors can be written and read as a sequence of @code{0}s and
@code{1}s prefixed by @code{#*}.

@example
#At(#f #f #f #t #f #t #f) @result{} #*0001010
@end example

@noindent
Some of these operations will eventually be generalized to other
uniform-arrays.

@defun bit-count bool bv
Returns the number occurrences of @var{bool} in @var{bv}.
@end defun

@defun bit-position bool bv k
Returns the minimum index of an occurrence of @var{bool} in @var{bv}
which is at least @var{k}.  If no @var{bool} occurs within the specified
range @code{#f} is returned.
@end defun

@defun bit-invert! bv
Modifies @var{bv} by replacing each element with its negation.
@end defun

@defun bit-set*! bv uve bool
If uve is a bit-vector @var{bv} and uve must be of the same length.  If
@var{bool} is @code{#t}, uve is OR'ed into @var{bv}; If @var{bool} is @code{#f}, the
inversion of uve is AND'ed into @var{bv}.

If uve is a unsigned integer vector all the elements of uve must be
between 0 and the @code{LENGTH} of @var{bv}.  The bits of @var{bv}
corresponding to the indexes in uve are set to @var{bool}.

The return value is unspecified.
@end defun

@defun bit-count* bv uve bool
Returns
@example
(bit-count (bit-set*! (if bool bv (bit-invert! bv)) uve #t) #t).
@end example
@var{bv} is not modified.
@end defun

@node Records, I/O-Extensions, Arrays, Packages
@section Records

SCM provides user-definable datatypes with the same interface as SLIB,
see @xref{Records, , , slib, SLIB}, with the following extension.

@defun record-printer-set! rtd printer
Causes records of type @var{rtd} to be printed in a user-specified format.
@var{rtd} must be a record type descriptor returned by @code{make-record-type},
@var{printer} a procedure accepting three arguments:  the record to be printed,
the port to print to, and a boolean which is true if the record is being
written on behalf of @code{write} and false if for @code{display}.
If @var{printer} returns #f, the default record printer will be called.

A @var{printer} value of #f means use the default printer.

Only the default printer will be used when printing error messages.
@end defun

@node I/O-Extensions, Posix Extensions, Records, Packages
@section I/O-Extensions

@noindent
If @code{'i/o-extensions} is provided (by linking in @file{ioext.o}),
@ref{Line I/O, , , slib, SLIB}, and the following functions are defined:

@defun stat <port-or-string>
Returns a vector of integers describing the argument.  The argument
can be either a string or an open input port.  If the argument is an
open port then the returned vector describes the file to which the
port is opened; If the argument is a string then the returned vector
describes the file named by that string.  If there exists no file with
the name string, or if the file cannot be accessed @code{#f} is returned.
The elements of the returned vector are as follows:


@table @r
@item 0  st_dev
ID of device containing a directory entry for this file
@item 1  st_ino
Inode number
@item 2  st_mode
File type, attributes, and access control summary
@item 3  st_nlink
Number of links
@item 4  st_uid
User ID of file owner
@item 5  st_gid
Group ID of file group
@item 6  st_rdev
Device ID; this entry defined only for char or blk spec files
@item 7  st_size
File size (bytes)
@item 8  st_atime
Time of last access
@item 9  st_mtime
Last modification time
@item 10 st_ctime
Last file status change time
@end table
@end defun

@defun getpid
Returns the process ID of the current process.
@end defun

@defun file-position port
Returns the current position of the character in @var{port} which will
next be read or written.  If @var{port} is not open to a file the result
is unspecified.
@end defun

@defun file-set-position port integer
Sets the current position in @var{port} which will next be read or
written.  If @var{port} is not open to a file the action of
@code{file-set-position} is unspecified.  The result of
@code{file-set-position} is unspecified.
@end defun

@defun try-create-file name modes perms
If the file with name @var{name} already exists, return @code{#f},
otherwise try to create and open the file like @code{try-open-file},
@xref{Files and Ports}.  If the optional integer argument @var{perms} is
provided, it is used as the permissions of the new file (modified by
the current umask).
@end defun

@defun reopen-file filename modes port
Closes port @var{port} and reopens it with @var{filename} and
@var{modes}.  @code{reopen-file} returns @code{#t} if successful,
@code{#f} if not.
@end defun

@defun duplicate-port port modes
Creates and returns a @dfn{duplicate} port from @var{port}.  Duplicate
@emph{unbuffered} ports share one file position.  @var{modes} are as for
@ref{Files and Ports, open-file}.
@end defun

@defun redirect-port! from-port to-port
Closes @var{to-port} and makes @var{to-port} be a duplicate of
@var{from-port}.  @code{redirect-port!} returns @var{to-port} if
successful, @code{#f} if not.  If unsuccessful, @var{to-port} is not
closed.
@end defun

@defun opendir dirname
Returns a @dfn{directory} object corresponding to the file system
directory named @var{dirname}.  If unsuccessful, returns @code{#f}.
@end defun

@defun readdir dir
Returns the string name of the next entry from the directory @var{dir}.
If there are no more entries in the directory, @code{readdir} returns a
@code{#f}.
@end defun

@defun rewinddir dir
Reinitializes @var{dir} so that the next call to @code{readdir} with
@var{dir} will return the first entry in the directory again.
@end defun

@defun closedir dir
Closes @var{dir} and returns @code{#t}.  If @var{dir} is already
closed,, @code{closedir} returns a @code{#f}.
@end defun

@defun directory-for-each proc directory
The @var{list}s must be lists, and @var{proc} must be a procedure taking
one argument.  @samp{Directory-For-Each} applies @var{proc} to the
(string) name of each file in @var{directory}.  The dynamic order in
which @var{proc} is applied to the elements of the @var{list}s is
unspecified.  The value returned by @samp{directory-for-each} is
unspecified.

@defunx directory-for-each proc directory pred
Applies @var{proc} only to those filenames for which the procedure
@var{pred} returns a non-false value.

@defunx directory-for-each proc directory match
Applies @var{proc} only to those filenames for which
@code{(filename:match?? @var{match})} would return a non-false value
(@pxref{Filenames, , , slib, SLIB}).

@example
(require 'directory-for-each)
(directory-for-each print "." "[A-Z]*.scm")
@print{}
"Init.scm" 
"Iedline.scm" 
"Link.scm" 
"Macro.scm" 
"Transcen.scm" 
"Init@value{SCMVERSION}.scm" 
@end example
@end defun

@defun mkdir path mode
The @code{mkdir} function creates a new, empty directory whose name is
@var{path}.  The integer argument @var{mode} specifies the file
permissions for the new directory.  @xref{The Mode Bits for Access
Permission, , , libc, Gnu C Library}, for more information about this.

@code{mkdir} returns if successful, @code{#f} if not.
@end defun

@defun rmdir path
The @code{rmdir} function deletes the directory @var{path}.  The
directory must be empty before it can be removed.  @code{rmdir} returns
if successful, @code{#f} if not.
@end defun

@defun chdir filename
Changes the current directory to @var{filename}.  If @var{filename} does not
exist or is not a directory, @code{#f} is returned.  Otherwise, @code{#t} is
returned.
@end defun

@defun getcwd
The function @code{getcwd} returns a string containing the absolute file
name representing the current working directory.  If this string cannot
be obtained, @code{#f} is returned.
@end defun

@defun rename-file oldfilename newfilename
Renames the file specified by @var{oldfilename} to @var{newfilename}.
If the renaming is successful, @code{#t} is returned.  Otherwise,
@code{#f} is returned.
@end defun

@defun chmod file mode
The function @code{chmod} sets the access permission bits for the file
named by @var{file} to @var{mode}.  The @var{file} argument may be a
string containing the filename or a port open to the file.

@code{chmod} returns if successful, @code{#f} if not.
@end defun

@defun utime pathname acctime modtime
Sets the file times associated with the file named @var{pathname} to
have access time @var{acctime} and modification time @var{modtime}.
@code{utime} returns if successful, @code{#f} if not.
@end defun

@defun umask mode
The function @code{umask} sets the file creation mask of the current
process to @var{mask}, and returns the previous value of the file
creation mask.
@end defun

@defun fileno port
Returns the integer file descriptor associated with the port @var{port}.
If an error is detected, @code{#f} is returned.
@end defun

@defun access pathname how
Returns @code{#t} if the file named by @var{pathname} can be accessed in
the way specified by the @var{how} argument.  The @var{how} argument can
be the @code{logior} of the flags:

@enumerate 0
@item
File-exists?
@item
File-is-executable?
@item
File-is-writable?
@end enumerate
@enumerate 4
@item
File-is-readable?
@end enumerate

Or the @var{how} argument can be a string of 0 to 3 of the following
characters in any order.  The test performed is the @code{and} of the
associated tests and @code{file-exists?}.

@table @key
@item x
File-is-executable?
@item w
File-is-writable?
@item r
File-is-readable?
@end table
@end defun

@defun execl command arg0 @dots{}
@defunx execlp command arg0 @dots{}
Transfers control to program @var{command} called with arguments
@var{arg0} @dots{}.  For @code{execl}, @var{command} must be an exact
pathname of an executable file.  @code{execlp} searches for
@var{command} in the list of directories specified by the environment
variable @var{PATH}.  The convention is that @var{arg0} is the same name
as @var{command}.

If successful, this procedure does not return.  Otherwise an error
message is printed and the integer @code{errno} is returned.

@defunx execv command arglist
@defunx execvp command arglist
Like @code{execl} and @code{execlp} except that the set of arguments to
@var{command} is @var{arglist}.
@end defun

@defun putenv string
adds or removes definitions from the @dfn{environment}.  If the
@var{string} is of the form @samp{NAME=VALUE}, the definition is added
to the environment.  Otherwise, the @var{string} is interpreted as the
name of an environment variable, and any definition for this variable in
the environment is removed.

Names of environment variables are case-sensitive and must not contain
the character @code{=}.  System-defined environment variables are
invariably uppercase.

@code{Putenv} is used to set up the environment before calls to
@code{execl}, @code{execlp}, @code{execv}, @code{execvp}, @code{system},
or @code{open-pipe} (@pxref{Posix Extensions, open-pipe}).

To access environment variables, use @code{getenv} (@pxref{System
Interface, getenv, , slib, SLIB}).
@end defun

@node Posix Extensions, Unix Extensions, I/O-Extensions, Packages
@section Posix Extensions

@noindent
If @code{'posix} is provided (by linking in @file{posix.o}), the
following functions are defined:

@defun open-pipe string modes
If the string @var{modes} contains an @key{r}, returns an input port
capable of delivering characters from the standard output of the system
command @var{string}.  Otherwise, returns an output port capable of
receiving characters which become the standard input of the system
command @var{string}.  If a pipe cannot be created @code{#f} is
returned.
@end defun

@defun open-input-pipe string
Returns an input port capable of delivering characters from the
standard output of the system command @var{string}.  If a pipe cannot be
created @code{#f} is returned.
@end defun

@defun open-output-pipe string
Returns an output port capable of receiving characters which become
the standard input of the system command @var{string}.  If a pipe cannot
be created @code{#f} is returned.
@end defun

@defun broken-pipe port
If this function is defined at top level, it will be called when an
output pipe is closed from the other side (this is the condition under
which a SIGPIPE is sent).  The already closed @var{port} will be passed
so that any necessary cleanup may be done.  An error is not signaled
when output to a pipe fails in this way, but any further output to
the closed pipe will cause an error to be signaled.
@end defun

@defun close-port pipe
Closes the @var{pipe}, rendering it incapable of delivering or accepting
characters.  This routine has no effect if the pipe has already been
closed.  The value returned is unspecified.
@end defun

@defun pipe
Returns @code{(cons @var{rd} @var{wd})} where @var{rd} and @var{wd} are
the read and write (port) ends of a @dfn{pipe} respectively.
@end defun

@defun fork
Creates a copy of the process calling @code{fork}.  Both processes
return from @code{fork}, but the calling (@dfn{parent}) process's
@code{fork} returns the @dfn{child} process's ID whereas the child
process's @code{fork} returns 0.
@end defun

@noindent
For a discussion of @dfn{ID}s @xref{Process Persona, , , GNU C Library,
libc}.

@defun getppid
Returns the process ID of the parent of the current process.
For a process's own ID @xref{I/O-Extensions, getpid}.
@end defun

@defun getlogin
Returns the (login) name of the user logged in on the controlling
terminal of the process, or #f if this information cannot be determined.
@end defun

@defun getuid
Returns the real user ID of this process.
@end defun

@defun getgid
Returns the real group ID of this process.
@end defun

@defun getegid
Returns the effective group ID of this process.
@end defun

@defun geteuid
Returns the effective user ID of this process.
@end defun

@defun setuid id
Sets the real user ID of this process to @var{id}.
Returns @code{#t} if successful, @code{#f} if not.
@end defun

@defun setgid id
Sets the real group ID of this process to @var{id}.
Returns @code{#t} if successful, @code{#f} if not.
@end defun

@defun setegid id
Sets the effective group ID of this process to @var{id}.
Returns @code{#t} if successful, @code{#f} if not.
@end defun

@defun seteuid id
Sets the effective user ID of this process to @var{id}.
Returns @code{#t} if successful, @code{#f} if not.
@end defun

@defun kill pid sig
The @code{kill} function sends the signal @var{signum} to the process or
process group specified by @var{pid}.  Besides the signals listed in
@ref{Standard Signals, , ,libc , GNU C Library}, @var{signum} can also
have a value of zero to check the validity of the @var{pid}.

The @var{pid} specifies the process or process group to receive the
signal:

@table @asis
@item > 0
The process whose identifier is @var{pid}.

@item 0
All processes in the same process group as the sender.  The
sender itself does not receive the signal.

@item -1
If the process is privileged, send the signal to all
processes except for some special system processes.
Otherwise, send the signal to all processes with the same
effective user ID.

@item < -1
The process group whose identifier is @code{(abs @var{pid})}.
@end table

A process can send a signal to itself with @code{(kill (getpid)
@var{signum})}.  If @code{kill} is used by a process to send a signal to
itself, and the signal is not blocked, then @code{kill} delivers at
least one signal (which might be some other pending unblocked signal
instead of the signal @var{signum}) to that process before it returns.

The return value from @code{kill} is zero if the signal can be sent
successfully.  Otherwise, no signal is sent, and a value of @code{-1} is
returned.  If @var{pid} specifies sending a signal to several processes,
@code{kill} succeeds if it can send the signal to at least one of them.
There's no way you can tell which of the processes got the signal or
whether all of them did.
@end defun

@defun waitpid pid options

The @code{waitpid} function suspends execution of the current process
until a child as specified by the @var{pid} argument has exited, or
until a signal is delivered whose action is to terminate the current
process or to call a signal handling function.  If a child as requested
by @var{pid} has already exited by the time of the call (a so-called
@dfn{zombie} process), the function returns immediately.  Any system
resources used by the child are freed.

The value of @var{pid} can be:

@table @asis
@item < -1
which means to wait for any child process whose process group ID is
equal to the absolute value of @var{pid}.

@item -1
which means to wait for any child process; this is the same behaviour
which wait exhibits.

@item 0
which means to wait for any child process whose process group ID is
equal to that of the calling process.

@item > 0
which means to wait for the child whose process ID is equal to the value
of @var{pid}.
@end table

The value of @var{options} is one of the following:

@enumerate 0
@item
Nothing special.

@item
(@code{WNOHANG}) which means to return immediately if no child is there
to be waited for.

@item
(@code{WUNTRACED}) which means to also return for children which are
stopped, and whose status has not been reported.

@item
Which means both of the above.
@end enumerate

The return value normally is the exit status of the child process,
including the exit value along with flags indicating whether a coredump
was generated or the child terminated as a result of a signal.  If the
@code{WNOHANG} option was specified and no child process is waiting to
be noticed, the value is zero.  A value of @code{#f} is returned in case
of error and @code{errno} is set.  For information about the
@code{errno} codes @xref{Process Completion, , , GNU C Library, libc}.
@end defun

@defun uname
You can use the @code{uname} procedure to find out some information
about the type of computer your program is running on.

Returns a vector of strings.  These strings are:

@enumerate 0
@item
The name of the operating system in use.
@item
The network name of this particular computer.
@item
The current release level of the operating system implementation.
@item
The current version level within the release of the operating system.
@item
Description of the type of hardware that is in use.

Some examples are @samp{"i386-ANYTHING"}, @samp{"m68k-hp"},
@samp{"sparc-sun"}, @samp{"m68k-sun"}, @samp{"m68k-sony"} and @samp{"mips-dec"}.
@end enumerate
@end defun

@defun getpw name
@defunx getpw uid
@defunx getpw
Returns a vector of information for the entry for @code{NAME},
@code{UID}, or the next entry if no argument is given.  The
information is:

@enumerate 0
@item
The user's login name.
@item
The encrypted password string.
@item
The user ID number.
@item
The user's default group ID number.
@item
A string typically containing the user's real name, and
possibly other information such as a phone number.
@item
The user's home directory, initial working directory, or @code{#f}, in
which case the interpretation is system-dependent.
@item
The user's default shell, the initial program run when the user logs in,
or @code{#f}, indicating that the system default should be used.
@end enumerate
@end defun

@defun setpwent #t
Rewinds the pw entry table back to the begining.

@defunx setpwent #f
@defunx setpwent
Closes the pw table.
@end defun


@defun getgr name
@defunx getgr uid
@defunx getgr
Returns a vector of information for the entry for @code{NAME},
@code{UID}, or the next entry if no argument is given.  The
information is:

@enumerate 0
@item
The name of the group.
@item
The encrypted password string.
@item
The group ID number.
@item
A list of (string) names of users in the group.
@end enumerate
@end defun

@defun setgrent #t
Rewinds the group entry table back to the begining.

@defunx setgrent #f
@defunx setgrent
Closes the group table.
@end defun

@defun getgroups
Returns a vector of all the supplementary group IDs of the process.
@end defun


@defun link oldname newname
The @code{link} function makes a new link to the existing file named by
@var{oldname}, under the new name @var{newname}.

@code{link} returns a value of @code{#t} if it is successful and
@code{#f} on failure.
@end defun

@defun chown filename owner group
The @code{chown} function changes the owner of the file @var{filename}
to @var{owner}, and its group owner to @var{group}.

@code{chown} returns a value of @code{#t} if it is successful and
@code{#f} on failure.
@end defun

@defun ttyname port
If port @var{port} is associated with a terminal device, returns a
string containing the file name of termainal device; otherwise
@code{#f}.
@end defun

@node Unix Extensions, Regular Expression Pattern Matching, Posix Extensions, Packages
@section Unix Extensions

@noindent
If @code{'unix} is provided (by linking in @file{unix.o}), the following
functions are defined:

@noindent
These @dfn{privileged} and symbolic link functions are not in Posix:

@defun symlink oldname newname
The @code{symlink} function makes a symbolic link to @var{oldname} named
@var{newname}.

@code{symlink} returns a value of @code{#t} if it is successful and
@code{#f} on failure.
@end defun

@defun readlink filename
Returns the value of the symbolic link @var{filename} or @code{#f} for
failure.
@end defun

@defun lstat filename
The @code{lstat} function is like @code{stat}, except that it does not
follow symbolic links.  If @var{filename} is the name of a symbolic
link, @code{lstat} returns information about the link itself; otherwise,
@code{lstat} works like @code{stat}.  @xref{I/O-Extensions}.
@end defun

@defun nice increment
Increment the priority of the current process by @var{increment}.
@code{chown} returns a value of @code{#t} if it is successful and
@code{#f} on failure.
@end defun

@defun acct filename
When called with the name of an exisitng file as argument, accounting is
turned on, records for each terminating process are appended to
@var{filename} as it terminates.  An argument of @code{#f} causes
accounting to be turned off.

@code{acct} returns a value of @code{#t} if it is successful and
@code{#f} on failure.
@end defun

@defun mknod filename mode dev
The @code{mknod} function makes a special file with name @var{filename}
and modes @var{mode} for device number @var{dev}.

@code{mknod} returns a value of @code{#t} if it is successful and
@code{#f} on failure.
@end defun

@defun sync
@code{sync} first commits inodes to buffers, and then buffers to disk.
sync() only schedules the writes, so it may return before the actual
writing is done.  The value returned is unspecified.
@end defun


@node Regular Expression Pattern Matching, Line Editing, Unix Extensions, Packages
@section Regular Expression Pattern Matching

These functions are defined in @file{rgx.c} using a POSIX or GNU
@dfn{regex} library.  If your computer does not support regex, a package
is available via ftp from
@file{ftp.gnu.org:/pub/gnu/regex-0.12.tar.gz}.  For a description of
regular expressions, @xref{syntax, , , regex, "regex" regular expression
matching library}.

@defun regcomp @var{pattern} [@var{flags}]
Compile a @dfn{regular expression}.  Return a compiled regular
expression, or an integer error code suitable as an argument to
@code{regerror}.

@var{flags} in @code{regcomp} is a string of option letters used to
control the compilation of the regular expression.  The letters may
consist of:

@table @samp
@item n
newlines won't be matched by @code{.} or hat lists; ( @code{[^...]} )
@item i
ignore case.
@exdent only when compiled with @var{_GNU_SOURCE}:
@item 0
allows dot to match a null character.
@item f
enable GNU fastmaps.
@end table
@end defun

@defun regerror @var{errno}
Returns a string describing the integer @var{errno} returned when
@code{regcomp} fails.
@end defun

@defun regexec @var{re} @var{string}
Returns @code{#f} or a vector of integers.  These integers are in
doublets.  The first of each doublet is the index of @var{string} of
the start of the matching expression or sub-expression (delimited by
parentheses in the pattern).  The last of each doublet is index of
@var{string} of the end of that expression.  @code{#f} is returned if
the string does not match.
@end defun

@defun regmatch? @var{re} @var{string}
Returns @code{#t} if the @var{pattern} such that @var{regexp} = (regcomp
@var{pattern}) matches @var{string} as a POSIX extended regular
expressions.  Returns @code{#f} otherwise.
@end defun

@defun regsearch  @var{re} @var{string} [@var{start} [@var{len}]]
@defunx regsearchv @var{re} @var{string} [@var{start} [@var{len}]]
@defunx regmatch   @var{re} @var{string} [@var{start} [@var{len}]]
@defunx regmatchv  @var{re} @var{string} [@var{start} [@var{len}]]
@code{Regsearch} searches for the pattern within the string.

@code{Regmatch} anchors the pattern and begins matching it against
string.

@code{Regsearch} returns the character position where @var{re} starts,
or @code{#f} if not found.

@code{Regmatch} returns the number of characters matched, @code{#f} if
not matched.

@code{Regsearchv} and @code{regmatchv} return the match vector is
returned if @var{re} is found, @code{#f} otherwise.

@table @var
@item re
may be either:
@enumerate
@item
a compiled regular expression returned by @code{regcomp};
@item
a string representing a regular expression;
@item
a list of a string and a set of option letters.
@end enumerate
@item string
The string to be operated upon.
@item start
The character position at which to begin the search or match.  If absent,
the default is zero.

@exdent @emph{Compiled _GNU_SOURCE and using GNU libregex only:}

When searching, if @var{start} is negative, the absolute value of
@var{start} will be used as the start location and reverse searching
will be performed.

@item len
The search is allowed to examine only the first @var{len} characters of
@var{string}.  If absent, the entire string may be examined.
@end table
@end defun

@defun string-split  @var{re} @var{string}
@defunx string-splitv @var{re} @var{string}
@code{String-split} splits a string into substrings that are separated
by @var{re}, returning a vector of substrings.

@code{String-splitv} returns a vector of string positions that indicate
where the substrings are located.
@end defun

@defun string-edit  @var{re} @var{edit-spec} @var{string} [@var{count}]
Returns the edited string.

@table @var
@item edit-spec
Is a string used to replace occurances of @var{re}.  Backquoted integers
in the range of 1-9 may be used to insert subexpressions in @var{re}, as
in @code{sed}.
@item count
The number of substitutions for @code{string-edit} to perform.  If
@code{#t}, all occurances of @var{re} will be replaced.  The default is
to perform one substitution.
@end table
@end defun

@node Line Editing, Curses, Regular Expression Pattern Matching, Packages
@section Line Editing

@noindent
These procedures provide input line editing and recall.

@noindent
These functions are defined in @file{edline.c} and @file{Iedline.scm}
using the @dfn{editline} or GNU @dfn{readline} (@pxref{Top, , Overview
,readline ,GNU Readline Library}) libraries available from:

@itemize @bullet
@item
@ifset html
<A HREF="ftp://ftp.sys.toronto.edu/pub/rc/editline.shar">
@end ifset
@code{ftp.sys.toronto.edu:/pub/rc/editline.shar}
@ifset html
</A>
@end ifset
@item
@ifset html
<A HREF="ftp://ftp.gnu.org/pub/gnu/readline-2.0.tar.gz">
@end ifset
@code{ftp.gnu.org:/pub/gnu/readline-2.0.tar.gz}
@ifset html
</A>
@end ifset
@end itemize

@noindent
When @file{Iedline.scm} is loaded, if the current input port is the
default input port and the environment variable @var{EMACS} is not
defined, line-editing mode will be entered.

@defun default-input-port
Returns the initial @code{current-input-port} SCM was invoked with
(stdin).
@end defun

@defun default-output-port
Returns the initial @code{current-output-port} SCM was invoked with
(stdout).
@end defun

@defun make-edited-line-port
Returns an input/output port that allows command line editing and
retrieval of history.
@end defun

@defun line-editing
Returns the current edited line port or @code{#f}.

@defunx line-editing bool
If @var{bool} is false, exits line-editing mode and returns the previous
value of @code{(line-editing)}.  If @var{bool} is true, sets the current
input and output ports to an edited line port and returns the previous
value of @code{(line-editing)}.
@end defun

@node Curses, Sockets, Line Editing, Packages
@section Curses

@noindent
These functions are defined in @file{crs.c} using the @dfn{curses}
library.  Unless otherwise noted these routines return @code{#t} for
successful completion and @code{#f} for failure.

@defun initscr
Returns a port for a full screen window.  This routine must be called to
initialize curses.
@end defun

@defun endwin
A program should call @code{endwin} before exiting or escaping from
curses mode temporarily, to do a system call, for example.  This routine
will restore termio modes, move the cursor to the lower left corner of
the screen and reset the terminal into the proper non-visual mode.  To
resume after a temporary escape, call @ref{Window Manipulation,
refresh}.
@end defun

@menu
* Output Options Setting::      
* Terminal Mode Setting::       
* Window Manipulation::         
* Output::                      
* Input::                       
* Curses Miscellany::           
@end menu

@node Output Options Setting, Terminal Mode Setting, Curses, Curses
@subsection Output Options Setting

@noindent
These routines set options within curses that deal with output.  All
options are initially @code{#f}, unless otherwise stated.  It is not
necessary to turn these options off before calling @code{endwin}.

@defun clearok win bf
If enabled (@var{bf} is @code{#t}), the next call to @code{force-output}
or @code{refresh} with @var{win} will clear the screen completely and
redraw the entire screen from scratch.  This is useful when the contents
of the screen are uncertain, or in some cases for a more pleasing visual
effect.
@end defun

@defun idlok win bf
If enabled (@var{bf} is @code{#t}), curses will consider using the
hardware ``insert/delete-line'' feature of terminals so equipped.  If
disabled (@var{bf} is @code{#f}), curses will very seldom use this
feature.  The ``insert/delete-character'' feature is always considered.
This option should be enabled only if your application needs
``insert/delete-line'', for example, for a screen editor.  It is
disabled by default because

``insert/delete-line'' tends to be visually annoying when used in
applications where it is not really needed.  If ``insert/delete-line''
cannot be used, curses will redraw the changed portions of all lines.
@end defun

@defun leaveok win bf
Normally, the hardware cursor is left at the location of the window
cursor being refreshed.  This option allows the cursor to be left
wherever the update happens to leave it.  It is useful for
applications where the cursor is not used, since it reduces the need
for cursor motions.  If possible, the cursor is made invisible when
this option is enabled.
@end defun

@defun scrollok win bf
This option controls what happens when the cursor of window @var{win} is
moved off the edge of the window or scrolling region, either from a
newline on the bottom line, or typing the last character of the last
line.  If disabled (@var{bf} is @code{#f}), the cursor is left on the
bottom line at the location where the offending character was entered.
If enabled (@var{bf} is @code{#t}), @code{force-output} is called on the
window @var{win}, and then the physical terminal and window @var{win}
are scrolled up one line.

@emph{Note:} in order to get the physical scrolling effect on the
terminal, it is also necessary to call @code{idlok}.
@end defun

@defun nodelay win bf
This option causes wgetch to be a non-blocking call.  If no input is
ready, wgetch will return an eof-object.  If disabled, wgetch will hang
until a key is pressed.
@end defun

@node Terminal Mode Setting, Window Manipulation, Output Options Setting, Curses
@subsection Terminal Mode Setting

@noindent
These routines set options within curses that deal with input.  The
options involve using ioctl(2) and therefore interact with curses
routines.  It is not necessary to turn these options off before
calling @code{endwin}.  The routines in this section all return an
unspecified value.

@defun cbreak
@defunx nocbreak
These two routines put the terminal into and out of @code{CBREAK} mode,
respectively.  In @code{CBREAK} mode, characters typed by the user are
immediately available to the program and erase/kill character
processing is not performed.  When in @code{NOCBREAK} mode, the tty driver
will buffer characters typed until a @key{LFD} or @key{RET} is typed.
Interrupt and flowcontrol characters are unaffected by this mode.
Initially the terminal may or may not be in @code{CBREAK} mode, as it is
inherited, therefore, a program should call @code{cbreak} or @code{nocbreak}
explicitly.  Most interactive programs using curses will set @code{CBREAK}
mode.

@emph{Note:} @code{cbreak} overrides @code{raw}.  For a discussion of
how these routines interact with @code{echo} and @code{noecho}
@xref{Input, read-char}.
@end defun

@defun raw
@defunx noraw
The terminal is placed into or out of @code{RAW} mode.  @code{RAW} mode
is similar to @code{CBREAK} mode, in that characters typed are
immediately passed through to the user program.  The differences are
that in @code{RAW} mode, the interrupt, quit, suspend, and flow control
characters are passed through uninterpreted, instead of generating a
signal.  @code{RAW} mode also causes 8-bit input and output.  The
behavior of the @code{BREAK} key depends on other bits in the terminal
driver that are not set by curses.
@end defun

@defun echo
@defunx noecho
These routines control whether characters typed by the user are echoed
by @code{read-char} as they are typed.  Echoing by the tty driver is
always disabled, but initially @code{read-char} is in @code{ECHO} mode,
so characters typed are echoed.  Authors of most interactive programs
prefer to do their own echoing in a controlled area of the screen, or
not to echo at all, so they disable echoing by calling @code{noecho}.
For a discussion of how these routines interact with @code{echo} and
@code{noecho} @xref{Input, read-char}.
@end defun

@defun nl
@defunx nonl
These routines control whether @key{LFD} is translated into @key{RET}
and @code{LFD} on output, and whether @key{RET} is translated into
@key{LFD} on input.  Initially, the translations do occur.  By disabling
these translations using @code{nonl}, curses is able to make better use
of the linefeed capability, resulting in faster cursor motion.
@end defun

@defun resetty
@defunx savetty
These routines save and restore the state of the terminal modes.
@code{savetty} saves the current state of the terminal in a buffer and
@code{resetty} restores the state to what it was at the last call to
@code{savetty}.
@end defun

@node Window Manipulation, Output, Terminal Mode Setting, Curses
@subsection Window Manipulation

@defun newwin nlines ncols begy begx
Create and return a new window with the given number of lines (or rows),
@var{nlines}, and columns, @var{ncols}.  The upper left corner of the
window is at line @var{begy}, column @var{begx}.  If either @var{nlines}
or @var{ncols} is 0, they will be set to the value of
@code{LINES}-@var{begy} and @code{COLS}-@var{begx}.  A new full-screen
window is created by calling @code{newwin(0,0,0,0)}.
@end defun

@defun subwin orig nlines ncols begy begx
Create and return a pointer to a new window with the given number of
lines (or rows), @var{nlines}, and columns, @var{ncols}.  The window is
at position (@var{begy}, @var{begx}) on the screen.  This position is
relative to the screen, and not to the window @var{orig}.  The window is
made in the middle of the window @var{orig}, so that changes made to one
window will affect both windows.  When using this routine, often it will
be necessary to call @code{touchwin} or @code{touchline} on @var{orig}
before calling @code{force-output}.
@end defun

@defun close-port win
Deletes the window @var{win}, freeing up all memory associated with it.
In the case of sub-windows, they should be deleted before the main
window @var{win}.
@end defun

@defun refresh
@defunx force-output win
These routines are called to write output to the terminal, as most other
routines merely manipulate data structures.  @code{force-output} copies
the window @var{win} to the physical terminal screen, taking into
account what is already there in order to minimize the amount of
information that's sent to the terminal (called optimization).  Unless
@code{leaveok} has been enabled, the physical cursor of the terminal is
left at the location of window @var{win}'s cursor.  With @code{refresh},
the number of characters output to the terminal is returned.
@end defun

@defun mvwin win y x
Move the window @var{win} so that the upper left corner will be at position
(@var{y}, @var{x}).  If the move would cause the window @var{win} to be off the
screen, it is an error and the window @var{win} is not moved.
@end defun

@defun overlay srcwin dstwin
@defunx overwrite srcwin dstwin

These routines overlay @var{srcwin} on top of @var{dstwin}; that is, all
text in @var{srcwin} is copied into @var{dstwin}.  @var{srcwin} and
@var{dstwin} need not be the same size; only text where the two windows
overlap is copied.  The difference is that @code{overlay} is
non-destructive (blanks are not copied), while @code{overwrite} is
destructive.
@end defun

@defun touchwin win
@defunx touchline win start count
Throw away all optimization information about which parts of the window
@var{win} have been touched, by pretending that the entire window
@var{win} has been drawn on.  This is sometimes necessary when using
overlapping windows, since a change to one window will affect the other
window, but the records of which lines have been changed in the other
window will not reflect the change.  @code{touchline} only pretends that
@var{count} lines have been changed, beginning with line @var{start}.
@end defun

@defun wmove win y x
The cursor associated with the window @var{win} is moved to line (row) @var{y},
column @var{x}.  This does not move the physical cursor of the terminal
until @code{refresh} (or @code{force-output}) is called.  The position
specified is relative to the upper left corner of the window @var{win},
which is (0, 0).
@end defun

@node Output, Input, Window Manipulation, Curses
@subsection Output

@noindent
These routines are used to @dfn{draw} text on windows

@defun display ch win
@defunx display str win
@defunx wadd win ch
@defunx wadd win str
The character @var{ch} or characters in @var{str} are put into the
window @var{win} at the current cursor position of the window and the
position of @var{win}'s cursor is advanced.  At the right margin, an
automatic newline is performed.  At the bottom of the scrolling region,
if scrollok is enabled, the scrolling region will be scrolled up one
line.

If @var{ch} is a @key{TAB}, @key{LFD}, or backspace, the cursor will be
moved appropriately within the window @var{win}.  A @key{LFD} also does a
@code{wclrtoeol} before moving.  @key{TAB} characters are considered to
be at every eighth column.  If @var{ch} is another control character, it
will be drawn in the @kbd{C-x} notation.  (Calling @code{winch} after
adding a control character will not return the control character, but
instead will return the representation of the control character.)

Video attributes can be combined with a character by or-ing them into
the parameter.  This will result in these attributes also being set.
The intent here is that text, including attributes, can be copied from
one place to another using inch and display.  See @code{standout},
below.

@emph{Note:} For @code{wadd} @var{ch} can be an integer and will insert
the character of the corresponding value.
@end defun

@defun werase win
This routine copies blanks to every position in the window @var{win}.
@end defun

@defun wclear win
This routine is like @code{werase}, but it also calls @ref{Output
Options Setting, clearok}, arranging that the screen will be cleared
completely on the next call to @code{refresh} or @code{force-output} for
window @var{win}, and repainted from scratch.
@end defun

@defun wclrtobot win
All lines below the cursor in window @var{win} are erased.  Also, the
current line to the right of the cursor, inclusive, is erased.
@end defun

@defun wclrtoeol win
The current line to the right of the cursor, inclusive, is erased.
@end defun

@defun wdelch win
The character under the cursor in the window @var{win} is deleted.  All
characters to the right on the same line are moved to the left one
position and the last character on the line is filled with a blank.  The
cursor position does not change.  This does not imply use of the
hardware ``delete-character'' feature.
@end defun

@defun wdeleteln win
The line under the cursor in the window @var{win} is deleted.  All lines
below the current line are moved up one line.  The bottom line @var{win}
is cleared.  The cursor position does not change.  This does not imply
use of the hardware ``deleteline'' feature.
@end defun

@defun winsch win ch
The character @var{ch} is inserted before the character under the
cursor.  All characters to the right are moved one @key{SPC} to the
right, possibly losing the rightmost character of the line.  The cursor
position does not change .  This does not imply use of the hardware
``insertcharacter'' feature.
@end defun

@defun winsertln win
A blank line is inserted above the current line and the bottom line is
lost.  This does not imply use of the hardware ``insert-line'' feature.
@end defun

@defun scroll win
The window @var{win} is scrolled up one line.  This involves moving the
lines in @var{win}'s data structure.  As an optimization, if @var{win}
is stdscr and the scrolling region is the entire window, the physical
screen will be scrolled at the same time.
@end defun

@node Input, Curses Miscellany, Output, Curses
@subsection Input

@defun read-char win
A character is read from the terminal associated with the window
@var{win}.  Depending on the setting of @code{cbreak}, this will be
after one character (@code{CBREAK} mode), or after the first newline
(@code{NOCBREAK} mode).  Unless @code{noecho} has been set, the
character will also be echoed into @var{win}.

When using @code{read-char}, do not set both @code{NOCBREAK} mode
(@code{nocbreak}) and @code{ECHO} mode (@code{echo}) at the same time.
Depending on the state of the terminal driver when each character is
typed, the program may produce undesirable results.
@end defun

@defun winch win
The character, of type chtype, at the current position in window
@var{win} is returned.  If any attributes are set for that position,
their values will be OR'ed into the value returned.
@end defun

@defun getyx win
A list of the y and x coordinates of the cursor position of the window
@var{win} is returned
@end defun

@node Curses Miscellany,  , Input, Curses
@subsection Curses Miscellany

@defun wstandout win
@defunx wstandend win

These functions set the current attributes of the window @var{win}.  The
current attributes of @var{win} are applied to all characters that are
written into it.  Attributes are a property of the character, and move
with the character through any scrolling and insert/delete
line/character operations.  To the extent possible on the particular
terminal, they will be displayed as the graphic rendition of characters
put on the screen.

@code{wstandout} sets the current attributes of the window @var{win} to
be visibly different from other text.  @code{wstandend} turns off the
attributes.
@end defun

@defun box win vertch horch
A box is drawn around the edge of the window @var{win}.  @var{vertch}
and @var{horch} are the characters the box is to be drawn with.  If
@var{vertch} and @var{horch} are 0, then appropriate default characters,
@code{ACS_VLINE} and @code{ACS_HLINE}, will be used.

@emph{Note:} @var{vertch} and @var{horch} can be an integers and will
insert the character (with attributes) of the corresponding values.
@end defun

@defun unctrl c
This macro expands to a character string which is a printable
representation of the character @var{c}.  Control characters are
displayed in the @kbd{C-x} notation.  Printing characters are displayed
as is.
@end defun

@node Sockets,  , Curses, Packages
@section Sockets

@noindent
These procedures (defined in @file{socket.c}) provide a Scheme interface
to most of the C @dfn{socket} library.  For more information on sockets,
@xref{Sockets, , , libc, The GNU C Library Reference Manual}.

@menu
* Host Data::                   
* Internet Addresses and Socket Names::  
* Socket::                      
@end menu

@node Host Data, Internet Addresses and Socket Names, Sockets, Sockets
@subsection Host Data, Network, Protocol, and Service Inquiries

@defvr Constant af_inet
@defvrx Constant af_unix
Integer family codes for Internet and Unix sockets, respectively.
@end defvr

@defun gethost host-spec
@defunx gethost
Returns a vector of information for the entry for @code{HOST-SPEC} or the
next entry if @code{HOST-SPEC} isn't given.  The information is:

@enumerate 0
@item
host name string
@item
list of host aliases strings
@item
integer address type (@code{AF_INET})
@item
integer size of address entries (in bytes)
@item
list of integer addresses
@end enumerate
@end defun

@defun sethostent stay-open
@defunx sethostent
Rewinds the host entry table back to the begining if given an argument.
If the argument @var{stay-open} is @code{#f} queries will be be done
using @code{UDP} datagrams.  Otherwise, a connected @code{TCP} socket
will be used.  When called without an argument, the host table is
closed.
@end defun

@defun getnet name-or-number
@defunx getnet
Returns a vector of information for the entry for @var{name-or-number} or
the next entry if an argument isn't given.  The information is:

@enumerate 0
@item
official network name string
@item
list of network aliases strings
@item
integer network address type (@code{AF_INET})
@item
integer network number
@end enumerate
@end defun

@defun setnetent stay-open
@defunx setnetent
Rewinds the network entry table back to the begining if given an
argument.  If the argument @var{stay-open} is @code{#f} the table will be closed
between calls to getnet.  Otherwise, the table stays open.  When
called without an argument, the network table is closed.
@end defun

@defun getproto name-or-number
@defunx getproto
Returns a vector of information for the entry for @var{name-or-number} or
the next entry if an argument isn't given.  The information is:

@enumerate
@item
official protocol name string
@item
list of protocol aliases strings
@item
integer protocol number
@end enumerate
@end defun

@defun setprotoent stay-open
@defunx setprotoent
Rewinds the protocol entry table back to the begining if given an
argument.  If the argument @var{stay-open} is @code{#f} the table will be closed
between calls to getproto.  Otherwise, the table stays open.  When
called without an argument, the protocol table is closed.
@end defun

@defun getserv name-or-port-number protocol
@defunx getserv
Returns a vector of information for the entry for @var{name-or-port-number}
and @var{protocol} or the next entry if arguments aren't given.  The
information is:

@enumerate 0
@item
official service name string
@item
list of service aliases strings
@item
integer port number
@item
protocol
@end enumerate
@end defun

@defun setservent stay-open
@defunx setservent
Rewinds the service entry table back to the begining if given an
argument.  If the argument @var{stay-open} is @code{#f} the table will be closed
between calls to getserv.  Otherwise, the table stays open.  When
called without an argument, the service table is closed.
@end defun

@node Internet Addresses and Socket Names, Socket, Host Data, Sockets
@subsection Internet Addresses and Socket Names

@defun inet:string->address string
Returns the host address number (integer) for host @var{string} or
@code{#f} if not found.
@end defun

@defun inet:address->string address
Converts an internet (integer) address to a string in numbers and dots
notation.
@end defun

@defun inet:network address
Returns the network number (integer) specified from @var{address} or
@code{#f} if not found.
@end defun

@defun inet:local-network-address address
Returns the integer for the address of @var{address} within its local
network or @code{#f} if not found.
@end defun

@defun inet:make-address network local-address
Returns the Internet address of @var{local-address} in @var{network}.
@end defun

@noindent
The type @dfn{socket-name} is used for inquiries about open sockets in
the following procedures:

@defun getsockname socket
Returns the socket-name of @var{socket}.  Returns @code{#f} if
unsuccessful or @var{socket} is closed.
@end defun

@defun getpeername socket
Returns the socket-name of the socket connected to @var{socket}.
Returns @code{#f} if unsuccessful or @var{socket} is closed.
@end defun

@defun socket-name:family socket-name
Returns the integer code for the family of @var{socket-name}.
@end defun

@defun socket-name:port-number socket-name
Returns the integer port number of @var{socket-name}.
@end defun

@defun socket-name:address socket-name
Returns the integer Internet address for @var{socket-name}.
@end defun


@node Socket,  , Internet Addresses and Socket Names, Sockets
@subsection Socket

@noindent
When a port is returned from one of these calls it is unbuffered.
This allows both reading and writing to the same port to work.  If you
want buffered ports you can (assuming sock-port is a socket i/o port):
@example
(require 'i/o-extensions)
@ftindex i/o-extensions
(define i-port (duplicate-port sock-port "r"))
(define o-port (duplicate-port sock-port "w"))
@end example

@defun make-stream-socket family
@defunx make-stream-socket family protocol

Returns a @code{SOCK_STREAM} socket of type @var{family} using
@var{protocol}.  If @var{family} has the value @code{AF_INET},
@code{SO_REUSEADDR} will be set.  The integer argument @var{protocol}
corresponds to the integer protocol numbers returned (as vector
elements) from @code{(getproto)}.  If the @var{protocol} argument is not
supplied, the default (0) for the specified @var{family} is used.  SCM
sockets look like ports opened for neither reading nor writing.
@end defun

@defun make-stream-socketpair family
@defunx make-stream-socketpair family protocol

Returns a pair (cons) of connected @code{SOCK_STREAM} (socket) ports of
type @var{family} using @var{protocol}.  Many systems support only
socketpairs of the @code{af-unix} @var{family}.  The integer argument
@var{protocol} corresponds to the integer protocol numbers returned (as
vector elements) from (getproto).  If the @var{protocol} argument is
not supplied, the default (0) for the specified @var{family} is used.
@end defun

@defun socket:shutdown socket how
Makes @var{socket} no longer respond to some or all operations depending on
the integer argument @var{how}:

@enumerate 0
@item
Further input is disallowed.
@item
Further output is disallowed.
@item
Further input or output is disallowed.
@end enumerate

@code{Socket:shutdown} returns @var{socket} if successful, @code{#f} if
not.
@end defun

@defun socket:connect inet-socket host-number port-number
@defunx socket:connect unix-socket pathname
Returns @var{socket} (changed to a read/write port) connected to the
Internet socket on host @var{host-number}, port @var{port-number} or
the Unix socket specified by @var{pathname}.  Returns @code{#f} if not
successful.
@end defun

@defun socket:bind inet-socket port-number
@defunx socket:bind unix-socket pathname
Returns @var{inet-socket} bound to the integer @var{port-number} or the
@var{unix-socket} bound to new socket in the file system at location
@var{pathname}.  Returns @code{#f} if not successful.  Binding a
@var{unix-socket} creates a socket in the file system that must be
deleted by the caller when it is no longer needed (using
@code{delete-file}).
@end defun

@defun socket:listen socket backlog
The bound (@pxref{Socket, bind}) @var{socket} is readied to
accept connections.  The positive integer @var{backlog} specifies how
many pending connections will be allowed before further connection
requests are refused.  Returns @var{socket} (changed to a read-only
port) if successful, @code{#f} if not.
@end defun

@defun char-ready? listen-socket
The input port returned by a successful call to @code{socket:listen} can
be polled for connections by @code{char-ready?} (@pxref{Files and Ports,
char-ready?}).  This avoids blocking on connections by
@code{socket:accept}.
@end defun

@defun socket:accept socket
Accepts a connection on a bound, listening @var{socket}.  Returns an
input/output port for the connection.
@end defun

@noindent
The following example is not too complicated, yet shows the use of
sockets for multiple connections without input blocking.

@example
;;;; Scheme chat server

;;; This program implements a simple `chat' server which accepts
;;; connections from multiple clients, and sends to all clients any
;;; characters received from any client.

;;; To connect to chat `telnet localhost 8001'

(require 'socket)
@ftindex socket
(require 'i/o-extensions)
@ftindex i/o-extensions

(let ((listener-socket (socket:bind (make-stream-socket af_inet) 8001))
      (connections '()))
  (socket:listen listener-socket 5)
  (do () (#f)
    (let ((actives (or (apply wait-for-input 5 listener-socket connections)
                       '())))
      (cond ((null? actives))
            ((memq listener-socket actives)
             (set! actives (cdr (memq listener-socket actives)))
             (let ((con (socket:accept listener-socket)))
               (display "accepting connection from ")
               (display (getpeername con))
               (newline)
               (set! connections (cons con connections))
               (display "connected" con)
               (newline con))))
      (set! connections
            (let next ((con-list connections))
              (cond ((null? con-list) '())
                    (else
                     (let ((con (car con-list)))
                       (cond ((memq con actives)
                              (let ((c (read-char con)))
                                (cond ((eof-object? c)
                                       (display "closing connection from ")
                                       (display (getpeername con))
                                       (newline)
                                       (close-port con)
                                       (next (cdr con-list)))
                                      (else
                                       (for-each (lambda (con)
                                                   (file-set-position con 0)
                                                   (write-char c con)
                                                   (file-set-position con 0))
                                                 connections)
                                       (cons con (next (cdr con-list)))))))
                             (else (cons con (next (cdr con-list)))))))))))))
@end example

@noindent
You can use @samp{telnet localhost 8001} to connect to the chat server,
or you can use a client written in scheme:

@example
;;;; Scheme chat client

;;; this program connects to socket 8001.  It then sends all
;;; characters from current-input-port to the socket and sends all
;;; characters from the socket to current-output-port.

(require 'socket)
@ftindex socket
(require 'i/o-extensions)
@ftindex i/o-extensions

(define con (make-stream-socket af_inet))
(set! con (socket:connect con (inet:string->address "localhost") 8001))

(define (go)
  (define actives (wait-for-input (* 30 60) con (current-input-port)))
  (let ((cs (and actives (memq con actives) (read-char con)))
        (ct (and actives (memq (current-input-port) actives) (read-char))))
    (cond ((or (eof-object? cs) (eof-object? ct)) (close-port con))
          (else (cond (cs (display cs)))
                (cond (ct (file-set-position con 0)
                          (display ct con)
                          (file-set-position con 0)))
                (go)))))
(cond (con (display "Connecting to ")
           (display (getpeername con))
           (newline)
           (go))
      (else (display "Server not listening on port 8001")
            (newline)))
@end example

@iftex
@section Xlibscm

@ifset html
<A HREF="Xlibscm_toc.html">
@code{(require 'Xlib)}

@dfn{Xlibscm}
</A>
is a SCM interface to the
<A HREF="http://www.x.org/"> X Window System.</A>
@end ifset

@ifclear html
@xref{Top, ,SCM Language X Interface , Xlibscm, Xlibscm}, for the SCM
interface to the @dfn{X Window System}.
@end ifclear
@end iftex


@node The Implementation, Index, Packages, Top
@chapter The Implementation

@menu
* Data Types::                  
* Operations::                  
* Program Self-Knowledge::      What SCM needs to know about itself.
* Improvements To Make::        
@end menu

@node Data Types, Operations, The Implementation, The Implementation
@section Data Types

@noindent
In the descriptions below it is assumed that @code{long int}s are 32
bits in length.  Acutally, SCM is written to work with any @code{long
int} size larger than 31 bits.  With some modification, SCM could work
with word sizes as small as 24 bits.

@noindent
All SCM objects are represented by type @dfn{SCM}.  Type @code{SCM} come
in 2 basic flavors, Immediates and Cells:

@menu
* Immediates::                  
* Cells::                       Non-Immediate types
* Header Cells::                Malloc objects
* Subr Cells::                  Built-in and Compiled Procedures
* Ptob Cells::                  I/O ports
* Smob Cells::                  Miscellaneous datatypes
* Data Type Representations::   How they all fit together
@end menu

@node Immediates, Cells, Data Types, Data Types
@subsection Immediates

@noindent
An @dfn{immediate} is a data type contained in type @code{SCM}
(@code{long int}).  The type codes distinguishing immediate types from
each other vary in length, but reside in the low order bits.

@defmac IMP x
@defmacx NIMP x
Return non-zero if the @code{SCM} object @var{x} is an immediate or
non-immediate type, respectively.
@end defmac

@deftp Immediate inum
immediate 30 bit signed integer.  An INUM is flagged by a @code{1} in
the second to low order bit position.  The high order 30 bits are used
for the integer's value.

@defmac INUMP x
@defmacx NINUMP x
Return non-zero if the @code{SCM} @var{x} is an immediate integer or not
an immediate integer, respectively.
@end defmac

@defmac INUM x
Returns the C @code{long integer} corresponding to @code{SCM} @var{x}.
@end defmac

@defmac MAKINUM x
Returns the @code{SCM} inum corresponding to C @code{long integer} x.
@end defmac

@defvr {Immediate Constant} INUM0
is equivalent to @code{MAKINUM(0)}.
@end defvr

Computations on INUMs are performed by converting the arguments to C
integers (by a shift), operating on the integers, and converting the
result to an inum.  The result is checked for overflow by converting
back to integer and checking the reverse operation.

The shifts used for conversion need to be signed shifts.  If the C
implementation does not support signed right shift this fact is detected
in a #if statement in @file{scmfig.h} and a signed right shift,
@code{SRS}, is constructed in terms of unsigned right shift.
@end deftp

@deftp Immediate ichr
characters.

@defmac ICHRP x
Return non-zero if the @code{SCM} object @var{x} is a character.
@end defmac

@defmac ICHR x
Returns corresponding @code{unsigned char}.
@end defmac

@defmac MAKICHR x
Given @code{char} @var{x}, returns @code{SCM} character.
@end defmac

@end deftp

@deftp Immediate iflags
These are frequently used immediate constants.
@deftypevr {Immediate Constant} SCM BOOL_T
@code{#t}
@end deftypevr
@deftypevr {Immediate Constant} SCM BOOL_F
@code{#f}
@end deftypevr
@deftypevr {Immediate Constant} SCM EOL
@code{()}.  If @code{SICP} is @code{#define}d, @code{EOL} is
@code{#define}d to be identical with @code{BOOL_F}.  In this case, both
print as @code{#f}.
@end deftypevr
@deftypevr {Immediate Constant} SCM EOF_VAL
end of file token, @code{#<eof>}.
@end deftypevr
@deftypevr {Immediate Constant} SCM UNDEFINED
@code{#<undefined>} used for variables which have not been defined and
absent optional arguments.
@end deftypevr
@deftypevr {Immediate Constant} SCM UNSPECIFIED
@code{#<unspecified>} is returned for those procedures whose return
values are not specified.
@end deftypevr

@end deftp

@defmac IFLAGP n
Returns non-zero if @var{n} is an ispcsym, isym or iflag.
@end defmac

@defmac ISYMP n
Returns non-zero if @var{n} is an ispcsym or isym.
@end defmac

@defmac ISYMNUM n
Given ispcsym, isym, or iflag @var{n}, returns its index in the C array
@code{isymnames[]}.
@end defmac

@defmac ISYMCHARS n
Given ispcsym, isym, or iflag @var{n}, returns its @code{char *}
representation (from @code{isymnames[]}).
@end defmac

@defmac MAKSPCSYM n
Returns @code{SCM} ispcsym @var{n}.
@end defmac

@defmac MAKISYM n
Returns @code{SCM} iisym @var{n}.
@end defmac

@defmac MAKIFLAG n
Returns @code{SCM} iflag @var{n}.
@end defmac

@defvar isymnames
An array of strings containing the external representations of all the
ispcsym, isym, and iflag immediates.  Defined in @file{repl.c}.
@end defvar

@defvr Constant NUM_ISPCSYM
@defvrx Constant NUM_ISYMS
The number of ispcsyms and ispcsyms+isyms, respectively.  Defined in
@file{scm.h}.
@end defvr

@deftp Immediate isym
@code{and}, @code{begin}, @code{case}, @code{cond}, @code{define},
@code{do}, @code{if}, @code{lambda}, @code{let}, @code{let*},
@code{letrec}, @code{or}, @code{quote}, @code{set!}, @code{#f},
@code{#t}, @code{#<undefined>}, @code{#<eof>}, @code{()}, and
@code{#<unspecified>}.

@deftpx {CAR Immediate} ispcsym
special symbols: syntax-checked versions of first 14 isyms
@end deftp

@deftp {CAR Immediate} iloc
indexes to a variable's location in environment
@end deftp

@deftp {CAR Immediate} gloc
pointer to a symbol's value cell
@end deftp

@deftp Immediate CELLPTR
pointer to a cell (not really an immediate type, but here for
completeness).  Since cells are always 8 byte aligned, a pointer to a
cell has the low order 3 bits @code{0}.

There is one exception to this rule, @emph{CAR Immediate}s, described
next.
@end deftp

@noindent
A @dfn{CAR Immediate} is an Immediate point which can only occur in the
@code{CAR}s of evaluated code (as a result of @code{ceval}'s memoization
process).

@node Cells, Header Cells, Immediates, Data Types
@subsection Cells

@noindent
@dfn{Cell}s represent all SCM objects other than immediates.  A cell has
a @code{CAR} and a @code{CDR}.  Low-order bits in @code{CAR} identify
the type of object.  The rest of @code{CAR} and @code{CDR} hold object
data.  The number after @code{tc} specifies how many bits are in the
type code.  For instance, @code{tc7} indicates that the type code is 7
bits.

@defmac NEWCELL x
Allocates a new cell and stores a pointer to it in @code{SCM} local
variable @var{x}.

Care needs to be taken that stores into the new cell pointed to by
@var{x} do not create an inconsistent object.  @xref{Signals}.
@end defmac

@noindent
All of the C macros decribed in this section assume that their argument
is of type @code{SCM} and points to a cell (@code{CELLPTR}).

@defmac CAR x
@defmacx CDR x
Returns the @code{car} and @code{cdr} of cell @var{x}, respectively.
@end defmac

@defmac TYP3 x
@defmacx TYP7 x
@defmacx TYP16 x
Returns the 3, 7, and 16 bit type code of a cell.
@end defmac

@deftp Cell tc3_cons
scheme cons-cell returned by (cons arg1 arg2).

@defmac CONSP x
@defmacx NCONSP x
Returns non-zero if @var{x} is a @code{tc3_cons} or isn't, respectively.
@end defmac
@end deftp

@deftp Cell tc3_closure
applicable object returned by (lambda (args) @dots{}).
@code{tc3_closure}s have a pointer to the body of the procedure in the
@code{CAR} and a pointer to the environment in the @code{CDR}.  Bits 1
and 2 (zero-based) in the @code{CDR} indicate a lower bound on the
number of required arguments to the closure, which is used to avoid
allocating rest argument lists in the environment cache.  This encoding
precludes an immediate value for the @code{CDR}:  In the case of
an empty environment all bits above 2 in the @code{CDR} are zero.


@defmac CLOSUREP x
Returns non-zero if @var{x} is a @code{tc3_closure}.
@end defmac

@defmac CODE x
@defmacx ENV x
Returns the code body or environment of closure @var{x}, respectively.
@end defmac

@defmac ARGC x
Returns the a lower bound on the number of required arguments to closure
@var{x}, it cannot exceed 3.
@end defmac

@end deftp

@node Header Cells, Subr Cells, Cells, Data Types
@subsection Header Cells

@noindent
@dfn{Header}s are Cells whose @code{CDR}s point elsewhere in memory,
such as to memory allocated by @code{malloc}.

@deftp Header spare
spare @code{tc7} type code
@end deftp

@deftp Header tc7_vector
scheme vector.

@defmac VECTORP x
@defmacx NVECTORP x
Returns non-zero if @var{x} is a @code{tc7_vector} or if not, respectively.
@end defmac

@defmac VELTS x
@defmacx LENGTH x
Returns the C array of @code{SCM}s holding the elements of vector
@var{x} or its length, respectively.
@end defmac
@end deftp

@deftp Header tc7_ssymbol
static scheme symbol (part of initial system)

@deftpx Header tc7_msymbol
@code{malloc}ed scheme symbol (can be GCed)

@defmac SYMBOLP x
Returns non-zero if @var{x} is a @code{tc7_ssymbol} or
@code{tc7_msymbol}.
@end defmac

@defmac CHARS x
@defmacx UCHARS x
@defmacx LENGTH x
Returns the C array of @code{char}s or as @code{unsigned char}s holding
the elements of symbol @var{x} or its length, respectively.
@end defmac
@end deftp

@deftp Header tc7_string
scheme string

@defmac STRINGP x
@defmacx NSTRINGP x
Returns non-zero if @var{x} is a @code{tc7_string} or isn't,
respectively.
@end defmac

@defmac CHARS x
@defmacx UCHARS x
@defmacx LENGTH x
Returns the C array of @code{char}s or as @code{unsigned char}s holding
the elements of string @var{x} or its length, respectively.
@end defmac
@end deftp

@deftp Header tc7_bvect
uniform vector of booleans (bit-vector)
@end deftp

@deftp Header tc7_ivect
uniform vector of integers
@end deftp

@deftp Header tc7_uvect
uniform vector of non-negative integers
@end deftp

@deftp Header tc7_svect
uniform vector of short integers
@end deftp

@deftp Header tc7_fvect
uniform vector of short inexact real numbers
@end deftp

@deftp Header tc7_dvect
uniform vector of double precision inexact real numbers
@end deftp

@deftp Header tc7_cvect
uniform vector of double precision inexact complex numbers
@end deftp

@deftp Header tc7_contin
applicable object produced by call-with-current-continuation
@end deftp

@deftp Header tc7_specfun
subr that is treated specially within the evaluator

@code{apply} and @code{call-with-current-continuation} are denoted by
these objects.  Their behavior as functions is built into the evaluator;
they are not directly associated with C functions.  This is necessary
in order to make them properly tail recursive.

tc16_cclo is a subtype of tc7_specfun, a cclo is similar to a vector
(and is GCed like one), but can be applied as a function:

@enumerate
@item
the cclo itself is consed onto the head of the argument list
@item
the first element of the cclo is applied to that list.  Cclo invocation
is currently not tail recursive when given 2 or more arguments.
@end enumerate

@defun makcclo proc len
makes a closure from the @emph{subr} @var{proc} with @var{len}-1 extra
locations for @code{SCM} data.  Elements of a @var{cclo} are referenced
using @code{VELTS(cclo)[n]} just as for vectors.
@end defun

@defmac CCLO_LENGTH cclo
Expands to the length of @var{cclo}.
@end defmac
@end deftp

@node Subr Cells, Ptob Cells, Header Cells, Data Types
@subsection Subr Cells

@noindent
A @dfn{Subr} is a header whose @code{CDR} points to a C code procedure.
Scheme primitive procedures are subrs.  Except for the arithmetic
@code{tc7_cxr}s, the C code procedures will be passed arguments (and
return results) of type @code{SCM}.

@deftp Subr tc7_asubr
associative C function of 2 arguments.  Examples are @code{+}, @code{-},
@code{*}, @code{/}, @code{max}, and @code{min}.
@end deftp

@deftp Subr tc7_subr_0
C function of no arguments.
@end deftp

@deftp Subr tc7_subr_1
C function of one argument.
@end deftp

@deftp Subr tc7_cxr
These subrs are handled specially.  If inexact numbers are enabled, the
@code{CDR} should be a function which takes and returns type
@code{double}.  Conversions are handled in the interpreter.

@code{floor}, @code{ceiling}, @code{truncate}, @code{round},
@code{$sqrt}, @code{$abs}, @code{$exp}, @code{$log}, @code{$sin},
@code{$cos}, @code{$tan}, @code{$asin}, @code{$acos}, @code{$atan},
@code{$sinh}, @code{$cosh}, @code{$tanh}, @code{$asinh}, @code{$acosh},
@code{$atanh}, and @code{exact->inexact} are defined this way.

If the @code{CDR} is @code{0} (@code{NULL}), the name string of the
procedure is used to control traversal of its list structure argument.

@code{car}, @code{cdr}, @code{caar}, @code{cadr}, @code{cdar},
@code{cddr}, @code{caaar}, @code{caadr}, @code{cadar}, @code{caddr},
@code{cdaar}, @code{cdadr}, @code{cddar}, @code{cdddr}, @code{caaaar},
@code{caaadr}, @code{caadar}, @code{caaddr}, @code{cadaar},
@code{cadadr}, @code{caddar}, @code{cadddr}, @code{cdaaar},
@code{cdaadr}, @code{cdadar}, @code{cdaddr}, @code{cddaar},
@code{cddadr}, @code{cdddar}, and @code{cddddr} are defined this way.
@end deftp

@deftp Subr tc7_subr_3
C function of 3 arguments.
@end deftp

@deftp Subr tc7_subr_2
C function of 2 arguments.
@end deftp

@deftp Subr tc7_rpsubr
transitive relational predicate C function of 2 arguments.  The C
function should return either @code{BOOL_T} or @code{BOOL_F}.
@end deftp

@deftp Subr tc7_subr_1o
C function of one optional argument.  If the optional argument is not
present, @code{UNDEFINED} is passed in its place.
@end deftp

@deftp Subr tc7_subr_2o
C function of 1 required and 1 optional argument.  If the optional
argument is not present, @code{UNDEFINED} is passed in its place.
@end deftp

@deftp Subr tc7_lsubr_2
C function of 2 arguments and a list of (rest of) @code{SCM} arguments.
@end deftp

@deftp Subr tc7_lsubr
C function of list of @code{SCM} arguments.
@end deftp

@node Ptob Cells, Smob Cells, Subr Cells, Data Types
@subsection Ptob Cells

@noindent
A @dfn{ptob} is a port object, capable of delivering or accepting
@tindex ptob
characters.  @xref{Ports, , , r5rs, Revised(5) Report on the Algorithmic
Language Scheme}.  Unlike the types described so far, new varieties of
ptobs can be defined dynamically (@pxref{Defining Ptobs}).  These are
the initial ptobs:

@deftp ptob tc16_inport
input port.
@end deftp

@deftp ptob tc16_outport
output port.
@end deftp

@deftp ptob tc16_ioport
input-output port.
@end deftp

@deftp ptob tc16_inpipe
input pipe created by @code{popen()}.
@end deftp

@deftp ptob tc16_outpipe
output pipe created by @code{popen()}.
@end deftp

@deftp ptob tc16_strport
String port created by @code{cwos()} or @code{cwis()}.
@end deftp

@deftp ptob tc16_sfport
Software (virtual) port created by @code{mksfpt()} (@pxref{Soft Ports}).
@end deftp

@defmac PORTP x
@defmacx OPPORTP x
@defmacx OPINPORTP x
@defmacx OPOUTPORTP x
@defmacx INPORTP x
@defmacx OUTPORTP x
Returns non-zero if @var{x} is a port, open port, open input-port, open
output-port, input-port, or output-port, respectively.
@end defmac

@defmac OPENP x
@defmacx CLOSEDP x
Returns non-zero if port @var{x} is open or closed, respectively.
@end defmac

@defmac STREAM x
Returns the @code{FILE *} stream for port @var{x}.
@end defmac

@noindent
Ports which are particularly well behaved are called @dfn{fport}s.
Advanced operations like @code{file-position} and @code{reopen-file}
only work for fports.

@defmac FPORTP x
@defmacx OPFPORTP x
@defmacx OPINFPORTP x
@defmacx OPOUTFPORTP x
Returns non-zero if @var{x} is a port, open port, open input-port, or
open output-port, respectively.
@end defmac

@node Smob Cells, Data Type Representations, Ptob Cells, Data Types
@subsection Smob Cells

@noindent
A @dfn{smob} is a miscellaneous datatype.  The type code and GCMARK bit
@tindex smob
occupy the lower order 16 bits of the @code{CAR} half of the cell.  The
rest of the @code{CAR} can be used for sub-type or other information.
The @code{CDR} contains data of size long and is often a pointer to
allocated memory.

@noindent
Like ptobs, new varieties of smobs can be defined dynamically
(@pxref{Defining Smobs}).  These are the initial smobs:

@deftp smob tc_free_cell
unused cell on the freelist.
@end deftp

@deftp smob tc16_flo
single-precision float.

Inexact number data types are subtypes of type @code{tc16_flo}.  If the
sub-type is:

@enumerate 0
@item
a single precision float is contained in the @code{CDR}.
@item
@code{CDR} is a pointer to a @code{malloc}ed double.
@end enumerate
@enumerate 3
@item
@code{CDR} is a pointer to a @code{malloc}ed pair of doubles.
@end enumerate

@deftp smob tc_dblr
double-precision float.
@end deftp

@deftp smob tc_dblc
double-precision complex.
@end deftp
@end deftp

@deftp smob tc16_bigpos
@deftpx smob tc16_bigneg
positive and negative bignums, respectively.

Scm has large precision integers called bignums.  They are stored in
sign-magnitude form with the sign occuring in the type code of the SMOBs
bigpos and bigneg.  The magnitude is stored as a @code{malloc}ed array
of type @code{BIGDIG} which must be an unsigned integral type with size
smaller than @code{long}.  @code{BIGRAD} is the radix associated with
@code{BIGDIG}.

@code{NUMDIGS_MAX} (defined in @file{scmfig.h}) limits the number of
digits of a bignum to 1000.  These digits are base @code{BIGRAD}, which
is typically 65536, giving 4816 decimal digits.

Why only 4800 digits?  The simple multiplication algorithm SCM uses is
O(n^2); this means the number of processor instructions required to
perform a multiplication is @emph{some multiple} of the product of the
number of digits of the two multiplicands.

@example
digits * digits  ==> operations
 5                    x
 50                   100 * x
 500                  10000 * x
 5000                 1000000 * x
@end example

To calculate numbers larger than this, FFT multiplication [O(n*log(n))]
and other specialized algorithms are required.  You should obtain a
package which specializes in number-theoretical calculations:

@center @url{ftp://megrez.math.u-bordeaux.fr/pub/pari/}



@end deftp

@deftp smob tc16_promise
made by DELAY.  @xref{Control features, , , r5rs, Revised(5) Scheme}.
@end deftp

@deftp smob tc16_arbiter
synchronization object.  @xref{Process Synchronization}.
@end deftp

@deftp smob tc16_macro
macro expanding function.  @xref{Low Level Syntactic Hooks}.
@end deftp

@deftp smob tc16_array
multi-dimensional array.  @xref{Arrays}.

This type implements both conventional arrays (those with arbitrary data
as elements @pxref{Conventional Arrays}) and uniform arrays (those with
elements of a uniform type @pxref{Uniform Array}).

Conventional Arrays have a pointer to a vector for their @code{CDR}.
Uniform Arrays have a pointer to a Uniform Vector type (string, bvect,
ivect, uvect, fvect, dvect, or cvect) in their @code{CDR}.
@end deftp


@node Data Type Representations,  , Smob Cells, Data Types
@subsection Data Type Representations

@format
@r{IMMEDIATE:      B,D,E,F=data bit, C=flag code, P=pointer address bit}
@t{        ................................
inum    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBB10
ichr    BBBBBBBBBBBBBBBBBBBBBBBB11110100
iflag                   CCCCCCC101110100
isym                    CCCCCCC001110100}
@r{        IMCAR:  only in car of evaluated code, cdr has cell's GC bit}
@t{ispcsym                 000CCCC00CCCC100
iloc    0DDDDDDDDDDDEFFFFFFFFFFF11111100
pointer PPPPPPPPPPPPPPPPPPPPPPPPPPPPP000
gloc    PPPPPPPPPPPPPPPPPPPPPPPPPPPPP001}

@r{   HEAP CELL:   G=gc_mark; 1 during mark, 0 other times.
        1s and 0s here indicate type.     G missing means sys (not GC'd)
        SIMPLE:}
@t{cons    ..........SCM car..............0  ...........SCM cdr.............G
closure ..........SCM code...........011  ...........SCM env...........CCG
        HEADERs:
ssymbol .........long length....G0000101  ..........char *chars...........
msymbol .........long length....G0000111  ..........char *chars...........
string  .........long length....G0001101  ..........char *chars...........
vector  .........long length....G0001111  ...........SCM **elts...........
bvect   .........long length....G0010101  ..........long *words...........
 spare                          G0010111
ivect   .........long length....G0011101  ..........long *words...........
uvect   .........long length....G0011111  ......unsigned long *words......
 spare                          G0100101
svect   .........long length....G0100111  ........ short *words...........
fvect   .........long length....G0101101  .........float *words...........
dvect   .........long length....G0101111  ........double *words...........
cvect   .........long length....G0110101  ........double *words...........

contin  .........long length....G0111101  .............*regs..............
specfun ................xxxxxxxxG1111111  ...........SCM name.............
cclo    ..short length..xxxxxx10G1111111  ...........SCM **elts...........}
@r{                        PTOBs:}
@t{   port            0bwroxxxxxxxxG0110111  ..........FILE *stream..........
 socket ttttttt    00001xxxxxxxxG0110111  ..........FILE *stream..........
 inport uuuuuuuuuuU00011xxxxxxxxG0110111  ..........FILE *stream..........
outport 0000000000000101xxxxxxxxG0110111  ..........FILE *stream..........
 ioport uuuuuuuuuuU00111xxxxxxxxG0110111  ..........FILE *stream..........
fport              00   00000000G0110111  ..........FILE *stream..........
pipe               00   00000001G0110111  ..........FILE *stream..........
strport            00   00000010G0110111  ..........FILE *stream..........
sfport             00   00000011G0110111  ..........FILE *stream..........}
@r{        SUBRs:}
@t{ spare                          010001x1
 spare                          010011x1
subr_0  ..........int hpoff.....01010101  ...........SCM (*f)()...........
subr_1  ..........int hpoff.....01010111  ...........SCM (*f)()...........
cxr     ..........int hpoff.....01011101  .........double (*f)()..........
subr_3  ..........int hpoff.....01011111  ...........SCM (*f)()...........
subr_2  ..........int hpoff.....01100101  ...........SCM (*f)()...........
asubr   ..........int hpoff.....01100111  ...........SCM (*f)()...........
subr_1o ..........int hpoff.....01101101  ...........SCM (*f)()...........
subr_2o ..........int hpoff.....01101111  ...........SCM (*f)()...........
lsubr_2 ..........int hpoff.....01110101  ...........SCM (*f)()...........
lsubr   ..........int hpoff.....01110111  ...........SCM (*f)()...........
rpsubr  ..........int hpoff.....01111101  ...........SCM (*f)()...........}
@r{                        SMOBs:}
@t{free_cell
        000000000000000000000000G1111111  ...........*free_cell........000
flo     000000000000000000000001G1111111  ...........float num............
dblr    000000000000000100000001G1111111  ..........double *real..........
dblc    000000000000001100000001G1111111  .........complex *cmpx..........
bignum  ...int length...0000001 G1111111  .........short *digits..........
bigpos  ...int length...00000010G1111111  .........short *digits..........
bigneg  ...int length...00000011G1111111  .........short *digits..........
                        xxxxxxxx = code assigned by newsmob();
promise 000000000000000fxxxxxxxxG1111111  ...........SCM val..............
arbiter 000000000000000lxxxxxxxxG1111111  ...........SCM name.............
macro   000000000000000mxxxxxxxxG1111111  ...........SCM name.............
array   ...short rank..cxxxxxxxxG1111111  ............*array..............}
@end format

@node Operations, Program Self-Knowledge, Data Types, The Implementation
@section Operations

@menu
* Garbage Collection::          Automatically reclaims unused storage
* Memory Management for Environments::  
* Signals::                     
* C Macros::                    
* Changing Scm::                
* Defining Subrs::              
* Defining Smobs::              
* Defining Ptobs::              
* Allocating memory::           
* Embedding SCM::               In other programs
* Callbacks::                   
* Type Conversions::            For use with C code.
* Continuations::               For C and SCM
* Evaluation::                  Why SCM is fast
@end menu

@node Garbage Collection, Memory Management for Environments, Operations, Operations
@subsection Garbage Collection

The garbage collector is in the latter half of @file{sys.c}.  The
primary goal of @dfn{garbage collection} (or @dfn{GC}) is to recycle
those cells no longer in use.  Immediates always appear as parts of
other objects, so they are not subject to explicit garbage collection.

All cells reside in the @dfn{heap} (composed of @dfn{heap segments}).
Note that this is different from what Computer Science usually defines
as a heap.

@menu
* Marking Cells::               
* Sweeping the Heap::           
@end menu

@node Marking Cells, Sweeping the Heap, Garbage Collection, Garbage Collection
@subsubsection Marking Cells

The first step in garbage collection is to @dfn{mark} all heap objects
in use.  Each heap cell has a bit reserved for this purpose.  For pairs
(cons cells) the lowest order bit (0) of the CDR is used.  For other
types, bit 8 of the CAR is used.  The GC bits are never set except
during garbage collection.  Special C macros are defined in @file{scm.h}
to allow easy manipulation when GC bits are possibly set.  @code{CAR},
@code{TYP3}, and @code{TYP7} can be used on GC marked cells as they are.

@defmac GCCDR x
Returns the CDR of a cons cell, even if that cell has been GC marked.
@end defmac
@defmac GCTYP16 x
Returns the 16 bit type code of a cell.
@end defmac

We need to (recursively) mark only a few objects in order to assure that
all accessible objects are marked.  Those objects are
@code{sys_protects[]} (for example, @code{dynwinds}), the current
C-stack and the hash table for symbols, @dfn{symhash}.

@deftypefun void gc_mark (SCM @var{obj})
The function @code{gc_mark()} is used for marking SCM cells.  If
@var{obj} is marked, @code{gc_mark()} returns.  If @var{obj} is
unmarked, gc_mark sets the mark bit in @var{obj}, then calls
@code{gc_mark()} on any SCM components of @var{obj}.  The last call to
@code{gc_mark()} is tail-called (looped).
@end deftypefun

@deftypefun void mark_locations (STACKITEM @var{x}[], sizet @var{len}))
The function @code{mark_locations} is used for marking segments of
C-stack or saved segments of C-stack (marked continuations).  The
argument @var{len} is the size of the stack in units of size
@code{(STACKITEM)}.

Each longword in the stack is tried to see if it is a valid cell pointer
into the heap.  If it is, the object itself and any objects it points to
are marked using @code{gc_mark}.  If the stack is word rather than
longword aligned @code{(#define WORD_ALIGN)}, both alignments are tried.
This arrangement will occasionally mark an object which is no longer
used.  This has not been a problem in practice and the advantage of
using the c-stack far outweighs it.
@end deftypefun

@node Sweeping the Heap,  , Marking Cells, Garbage Collection
@subsubsection Sweeping the Heap

After all found objects have been marked, the heap is swept.

The storage for strings, vectors, continuations, doubles, complexes, and
bignums is managed by malloc.  There is only one pointer to each malloc
object from its type-header cell in the heap.  This allows malloc
objects to be freed when the associated heap object is garbage
collected.

@deftypefun static void gc_sweep ()
The function @code{gc_sweep} scans through all heap segments.  The mark
bit is cleared from marked cells.  Unmarked cells are spliced into
@var{freelist}, where they can again be returned by invocations of
@code{NEWCELL}.

If a type-header cell pointing to malloc space is unmarked, the malloc
object is freed.  If the type header of smob is collected, the smob's
@code{free} procedure is called to free its storage.
@end deftypefun

@node Memory Management for Environments, Signals, Garbage Collection, Operations
@subsection Memory Management for Environments

@cindex memory management
@cindex environments
@cindex ecache
@itemize @bullet
@item
@dfn{Ecache} was designed and implemented by Radey Shouman.

@item
This documentation of ecache was written by Tom Lord.
@end itemize

The memory management component of SCM contains special features which
optimize the allocation and garbage collection of environments.

The optimizations are based on certain facts and assumptions:

The SCM evaluator creates many environments with short lifetimes and
these account of a @emph{large portion} of the total number of objects
allocated.

The general purpose allocator allocates objects from a freelist, and
collects using a mark/sweep algorithm.  Research into garbage
collection suggests that such an allocator is sub-optimal for object
populations containing a large portion of short-lived members and that
allocation strategies involving a copying collector are more
appropriate.

It is a property of SCM, reflected throughout the source code, that a
simple copying collector can not be used as the general purpose memory
manager: much code assumes that the run-time stack can be treated as a
garbage collection root set using @dfn{conservative garbage collection}
techniques, which are incompatible with objects that change location.

Nevertheless, it is possible to use a mostly-separate
copying-collector, just for environments.  Roughly speaking, cons
pairs making up environments are initially allocated from a small heap
that is collected by a precise copying collector.  These objects must
be handled specially for the collector to work.  The (presumably)
small number of these objects that survive one collection of the
copying heap are copied to the general purpose heap, where they will
later be collected by the mark/sweep collector.  The remaining pairs
are more rapidly collected than they would otherwise be and all of
this collection is accomplished without having to mark or sweep any
other segment of the heap.

Allocating cons pairs for environments from this special heap is a
heuristic that approximates the (unachievable) goal:

@quotation
allocate all short-lived objects from the copying-heap, at no extra cost
in allocation time.
@end quotation


@subsubheading Implementation Details

A separate heap (@code{ecache_v}) is maintained for the copying
collector.  Pairs are allocated from this heap in a stack-like fashion.
Objects in this heap may be protected from garbage collection by:

@enumerate
@item
Pushing a reference to the object on a stack specially maintained for
that purpose.  This stack (@code{scm_estk}) is used in place of the C
run-time stack by the SCM evaluator to hold local variables which refer
to the copying heap.

@item
Saving a reference to every object in the mark/sweep heap which directly
references the copying heap in a root set that is specially maintained
for that purpose (@code{scm_egc_roots}).  If no object in the mark/sweep
heap directly references an object from the copying heap, that object
can be preserved by storing a direct reference to it in the
copying-collector root set.
@item
Keeping no other references to these objects, except references between
the objects themselves, during copying collection.
@end enumerate

When the copying heap or root-set becomes full, the copying collector is
invoked.  All protected objects are copied to the mark-sweep heap.  All
references to those objects are updated.  The copying collector root-set
and heap are emptied.

References to pairs allocated specificly for environments are
inaccessible to the Scheme procedures evaluated by SCM.  These pairs
are manipulated by only a small number of code fragments in the
interpreter.  To support copying collection, those code fragments
(mostly in @file{eval.c}) have been modified to protect environments from
garbage collection using the three rules listed above.

During a mark-sweep collection, the copying collector heap is marked
and swept almost like any ordinary segment of the general purpose
heap.  The only difference is that pairs from the copying heap that
become free during a sweep phase are not added to the freelist.

@cindex NO_ENV_CACHE
The environment cache is disabled by adding @code{#define NO_ENV_CACHE}
to @file{eval.c}; all environment cells are then allocated from the
regular heap.

@subsubheading Relation to Other Work

This work seems to build upon a considerable amount of previous work
into garbage collection techniques about which a considerable amount
of literature is available.




@node Signals, C Macros, Memory Management for Environments, Operations
@subsection Signals
@cindex signals

@defun init_signals
(in @file{scm.c}) initializes handlers for @code{SIGINT} and
@code{SIGALRM} if they are supported by the C implementation.  All of
the signal handlers immediately reestablish themselves by a call to
@code{signal()}.
@end defun

@defun int_signal sig
@defunx alrm_signal sig
The low level handlers for @code{SIGINT} and @code{SIGALRM}.
@end defun

If an interrupt handler is defined when the interrupt is received, the
code is interpreted.  If the code returns, execution resumes from where
the interrupt happened.  @code{Call-with-current-continuation} allows
the stack to be saved and restored.

SCM does not use any signal masking system calls.  These are not a
portable feature.  However, code can run uninterrupted by use of the C
macros @code{DEFER_INTS} and @code{ALLOW_INTS}.

@defmac DEFER_INTS
sets the global variable @code{ints_disabled} to 1.  If an interrupt
occurs during a time when @code{ints_disabled} is 1, then
@code{deferred_proc} is set to non-zero, one of the global variables
@code{SIGINT_deferred} or @code{SIGALRM_deferred} is set to 1, and the
handler returns.

@defmacx ALLOW_INTS
Checks the deferred variables and if set the appropriate handler is
called.

Calls to @code{DEFER_INTS} can not be nested.  An @code{ALLOW_INTS} must
happen before another @code{DEFER_INTS} can be done.  In order to check
that this constraint is satisfied @code{#define CAREFUL_INTS} in
@file{scmfig.h}.
@end defmac

@node C Macros, Changing Scm, Signals, Operations
@subsection C Macros


@defmac ASSERT cond arg pos subr
signals an error if the expression (@var{cond}) is 0.  @var{arg} is the
offending object, @var{subr} is the string naming the subr, and
@var{pos} indicates the position or type of error.  @var{pos} can be one
of

@itemize @bullet
@item @code{ARGn} @i{(> 5 or unknown ARG number)}
@item @code{ARG1}
@item @code{ARG2}
@item @code{ARG3}
@item @code{ARG4}
@item @code{ARG5}
@item @code{WNA} @i{(wrong number of args)}
@item @code{OVFLOW}
@item @code{OUTOFRANGE}
@item @code{NALLOC}
@item @code{EXIT}
@item @code{HUP_SIGNAL}
@item @code{INT_SIGNAL}
@item @code{FPE_SIGNAL}
@item @code{BUS_SIGNAL}
@item @code{SEGV_SIGNAL}
@item @code{ALRM_SIGNAL}
@item a C string @code{(char *)}
@end itemize

Error checking is not done by @code{ASSERT} if the flag @code{RECKLESS}
is defined.  An error condition can still be signaled in this case with
a call to @code{wta(arg, pos, subr)}.
@end defmac

@defmac ASRTGO cond label
@code{goto} @var{label} if the expression (@var{cond}) is 0.  Like
@code{ASSERT}, @code{ASRTGO} does is not active if the flag
@code{RECKLESS} is defined.
@end defmac


@node Changing Scm, Defining Subrs, C Macros, Operations
@subsection Changing Scm

@noindent
When writing C-code for SCM, a precaution is recommended.  If your
routine allocates a non-cons cell which will @emph{not} be incorporated
into a @code{SCM} object which is returned, you need to make sure that a
@code{SCM} variable in your routine points to that cell as long as part
of it might be referenced by your code.

@noindent
In order to make sure this @code{SCM} variable does not get optimized
out you can put this assignment after its last possible use:

@example
SCM_dummy1 = @i{foo};
@end example

@noindent
or put this assignment somewhere in your routine:

@example
SCM_dummy1 = (SCM) &@i{foo};
@end example

@noindent
@code{SCM_dummy} variables are not currently defined.  Passing the
address of the local @code{SCM} variable to @emph{any} procedure also
protects it.  The procedure @code{scm_protect_temp} is provided for
this purpose.

@noindent
Also, if you maintain a static pointer to some (non-immediate)
@code{SCM} object, you must either make your pointer be the value cell
of a symbol (see @code{errobj} for an example) or make your pointer be
one of the @code{sys_protects} (see @code{dynwinds} for an example).
The former method is prefered since it does not require any changes to
the SCM distribution.

@noindent
To add a C routine to scm:

@enumerate
@item
choose the appropriate subr type from the type list.
@item
write the code and put into @file{scm.c}.
@item
add a @code{make_subr} or @code{make_gsubr} call to @code{init_scm}.  Or
put an entry into the appropriate @code{iproc} structure.
@end enumerate

To add a package of new procedures to scm (see @file{crs.c} for
example):

@enumerate
@item
create a new C file (@file{@i{foo}.c}).
@item
at the front of @file{@i{foo}.c} put declarations for strings for your
procedure names.

@example
static char s_twiddle_bits[]="twiddle-bits!";
static char s_bitsp[]="bits?";
@end example

@item
choose the appropriate subr types from the type list in @file{code.doc}.
@item
write the code for the procedures and put into @file{@i{foo}.c}
@item
create one @code{iproc} structure for each subr type used in @file{@i{foo}.c}

@example
static iproc subr3s[]= @{
        @{s_twiddle-bits,twiddle-bits@},
        @{s_bitsp,bitsp@},
        @{0,0@} @};
@end example

@item
create an @code{init_@i{<name of file>}} routine at the end of the file
which calls @code{init_iprocs} with the correct type for each of the
@code{iproc}s created in step 5.

@example
void init_@i{foo}()
@{
  init_iprocs(subr1s, tc7_subr_1);
  init_iprocs(subr3s, tc7_subr_3);
@}
@end example

If your package needs to have a @dfn{finalization} routine called to
free up storage, close files, etc, then also have a line in
@code{init_@i{foo}} like:

@example
add_final(final_@i{foo});
@end example

@code{final_@i{foo}} should be a (void) procedure of no arguments.  The
finals will be called in opposite order from their definition.

The line:

@example
add_feature("@i{foo}");
@end example

will append a symbol @code{'@i{foo}} to the (list) value of
@code{*features*}.
@item
put any scheme code which needs to be run as part of your package into
@file{I@i{foo}.scm}.
@item
put an @code{if} into @file{Init@value{SCMVERSION}.scm} which loads
@file{I@i{foo}.scm} if your package is included:

@example
(if (defined? twiddle-bits!)
    (load (in-vicinity (implementation-vicinity)
                       "I@i{foo}"
                       (scheme-file-suffix))))
@end example

or use @code{(provided? '@i{foo})} instead of @code{(defined?
twiddle-bits!)} if you have added the feature.
@item
put documentation of the new procedures into @file{@i{foo}.doc}
@item
add lines to your @file{Makefile} to compile and link SCM with your
object file.  Add a @code{init_@i{foo}\(\)\;} to the @code{INITS=@dots{}}
line at the beginning of the makefile.
@end enumerate

@noindent
These steps should allow your package to be linked into SCM with a
minimum of difficulty.  Your package should also work with dynamic
linking if your SCM has this capability.

Special forms (new syntax) can be added to scm.

@enumerate
@item
define a new @code{MAKISYM} in @file{scm.h} and increment
@code{NUM_ISYMS}.
@item
add a string with the new name in the corresponding place in
@code{isymnames} in @file{repl.c}.
@item
add @code{case:} clause to @code{ceval()} near @code{i_quasiquote} (in
@file{eval.c}).
@end enumerate

@noindent
New syntax can now be added without recompiling SCM by the use of the
@code{procedure->syntax}, @code{procedure->macro},
@code{procedure->memoizing-macro}, and @code{defmacro}.  For details,
@xref{Syntax Extensions}.

@node Defining Subrs, Defining Smobs, Changing Scm, Operations
@subsection Defining Subrs

@noindent
If @dfn{CCLO} is @code{#define}d when compiling, the compiled closure
feature will be enabled.  It is automatically enabled if dynamic linking
is enabled.

@noindent
The SCM interpreter directly recognizes subrs taking small numbers of
arguments.  In order to create subrs taking larger numbers of arguments
use:

@defun make_gsubr name req opt rest fcn
returns a cclo (compiled closure) object of name @code{char *}
@var{name} which takes @code{int} @var{req} required arguments,
@code{int} @var{opt} optional arguments, and a list of rest arguments if
@code{int} @var{rest} is 1 (0 for not).

@code{SCM (*fcn)()} is a pointer to a C function to do the work.

The C function will always be called with @var{req} + @var{opt} +
@var{rest} arguments, optional arguments not supplied will be passed
@code{UNDEFINED}.  An error will be signaled if the subr is called with
too many or too few arguments.  Currently a total of 10 arguments may be
specified, but increasing this limit should not be difficult.

@example
/* A silly example, taking 2 required args,
   1 optional, and a list of rest args */

#include <scm.h>

SCM gsubr_21l(req1,req2,opt,rst)
     SCM req1,req2,opt,rst;
@{
  lputs("gsubr-2-1-l:\n req1: ", cur_outp);
  display(req1,cur_outp);
  lputs("\n req2: ", cur_outp);
  display(req2,cur_outp);
  lputs("\n opt: ", cur_outp);
  display(opt,cur_outp);
  lputs("\n rest: ", cur_outp);
  display(rst,cur_outp);
  newline(cur_outp);
  return UNSPECIFIED;
@}

void init_gsubr211()
@{
  make_gsubr("gsubr-2-1-l", 2, 1, 1, gsubr_21l);
@}
@end example
@end defun

@node Defining Smobs, Defining Ptobs, Defining Subrs, Operations
@subsection Defining Smobs

@noindent
Here is an example of how to add a new type named @code{@i{foo}} to SCM.
The following lines need to be added to your code:

@table @code
@item long tc16_@i{foo};
The type code which will be used to identify the new type.
@item static smobfuns @i{foo}smob = @{mark@i{foo},free@i{foo},print@i{foo},equalp@i{foo}@};
smobfuns is a structure composed of 4 functions:

@example
typedef struct @{
  SCM   (*mark)P((SCM));
  sizet (*free)P((CELLPTR));
  int   (*print)P((SCM exp, SCM port, int writing));
  SCM   (*equalp)P((SCM, SCM));
@} smobfuns;
@end example

@table @code
@item smob.mark
is a function of one argument of type @code{SCM} (the cell to mark) and
returns type @code{SCM} which will then be marked.  If no further
objects need to be marked then return an immediate object such as
@code{BOOL_F}.  The smob cell itself will already have been marked.
@emph{Note:} This is different from SCM versions prior to 5c5.  Only
additional data specific to a smob type need be marked by @code{smob.mark}.

 2 functions are provided:

@table @code
@item markcdr(ptr)
returns @code{CDR(ptr)}.
@item mark0(ptr)
is a no-op used for smobs containing no additional @code{SCM} data.  0
may also be used in this case.
@end table

@item smob.free
is a function of one argument of type @code{CELLPTR} (the cell to
collected) and returns type @code{sizet} which is the number of
@code{malloc}ed bytes which were freed.  @code{Smob.free} should free
any @code{malloc}ed storage associated with this object.  The function
free0(ptr) is provided which does not free any storage and returns 0.
@item smob.print
is 0 or a function of 3 arguments.  The first, of type @code{SCM}, is
the smob object.  The second, of type @code{SCM}, is the stream on which
to write the result.  The third, of type int, is 1 if the object should
be @code{write}n, 0 if it should be @code{display}ed, and 2 if it should
be @code{write}n for an error report.  This function should return non-zero
if it printed, and zero otherwise (in which case a hexadecimal number will
be printed).
@item smob.equalp
is 0 or a function of 2 @code{SCM} arguments.  Both of these arguments
will be of type @code{tc16@i{foo}}.  This function should return
@code{BOOL_T} if the smobs are equal, @code{BOOL_F} if they are not.  If
@code{smob.equalp} is 0, @code{equal?} will return @code{BOOL_F} if they
are not @code{eq?}.
@end table

@item tc16_@i{foo} = newsmob(&@i{foo}smob);
Allocates the new type with the functions from @code{@i{foo}smob}.  This
line goes in an @code{init_} routine.
@end table

@noindent
Promises and macros in @file{eval.c} and arbiters in @file{repl.c}
provide examples of SMOBs.  There are a maximum of 256 SMOBs.
Smobs that must allocate blocks of memory should use, for example,
@code{must_malloc} rather than @code{malloc} @xref{Allocating memory}.

@node Defining Ptobs, Allocating memory, Defining Smobs, Operations
@subsection Defining Ptobs

@noindent
@dfn{ptob}s are similar to smobs but define new types of port to which
SCM procedures can read or write.  The following functions are defined
in the @code{ptobfuns}:

@example
typedef struct @{
  SCM   (*mark)P((SCM ptr));
  int   (*free)P((FILE *p));
  int   (*print)P((SCM exp, SCM port, int writing));
  SCM   (*equalp)P((SCM, SCM));
  int   (*fputc)P((int c, FILE *p));
  int   (*fputs)P((char *s, FILE *p));
  sizet (*fwrite)P((char *s, sizet siz, sizet num, FILE *p));
  int   (*fflush)P((FILE *stream));
  int   (*fgetc)P((FILE *p));
  int   (*fclose)P((FILE *p));
@} ptobfuns;
@end example

@noindent
The @code{.free} component to the structure takes a @code{FILE *} or
other C construct as its argument, unlike @code{.free} in a smob, which
takes the whole smob cell.  Often, @code{.free} and @code{.fclose} can be
the same function.  See @code{fptob} and @code{pipob} in @file{sys.c}
for examples of how to define ptobs.
Ptobs that must allocate blocks of memory should use, for example,
@code{must_malloc} rather than @code{malloc} @xref{Allocating memory}.

@node Allocating memory, Embedding SCM, Defining Ptobs, Operations
@subsection Allocating memory
SCM maintains a count of bytes allocated using malloc, and calls the
garbage collector when that number exceeds a dynamically managed limit.
In order for this to work properly, @code{malloc} and @code{free} should
not be called directly to manage memory freeable by garbage collection.
The following functions are provided for that purpose:

@deftypefun SCM must_malloc_cell (long @var{len}, SCM @var{c}, char *@var{what})
@deftypefunx {char *} must_malloc (long @var{len}, char *@var{what})
@var{len} is the number of bytes that should be allocated, @var{what} is
a string to be used in error or gc messages.  @code{must_malloc} returns
a pointer to newly allocated memory.  @code{must_malloc_cell} returns a
newly allocated cell whose @code{car} is @var{c} and whose @code{cdr} is
a pointer to newly allocated memory.
@end deftypefun

@deftypefun void must_realloc_cell (SCM @var{z}, long @var{olen}, long @var{len}, char *@var{what})
@deftypefunx {char *} must_realloc (char *@var{where}, long @var{olen}, long @var{len}, char *@var{what})
@code{must_realloc_cell} takes as argument @var{z} a cell whose
@code{cdr} should be a pointer to a block of memory of length @var{olen}
allocated with @code{must_malloc_cell} and modifies the @code{cdr} to point
to a block of memory of length @var{len}.  @code{must_realloc} takes as
argument @var{where} the address of a block of memory of length @var{olen}
allocated by @code{must_malloc} and returns the address of a block of 
length @var{len}.

The contents of the reallocated block will be unchanged up to the
minimum of the old and new sizes.

@var{what} is a pointer to a string used for error and gc messages.
@end deftypefun

@code{must_malloc}, @code{must_malloc_cell}, @code{must_realloc}, and
@code{must_realloc_cell} must be called with interrupts deferred
@xref{Signals}.  @code{must_realloc} and @code{must_realloc_cell} must
not be called during initialization (non-zero errjmp_bad) -- the initial
allocations must be large enough.

@deftypefun void must_free (char *@var{ptr}, sizet @var{len})
@code{must_free} is used to free a block of memory allocated by the
above functions and pointed to by @var{ptr}.  @var{len} is the length of
the block in bytes, but this value is used only for debugging purposes.
If it is difficult or expensive to calculate then zero may be used
instead.
@end deftypefun



@node Embedding SCM, Callbacks, Allocating memory, Operations
@subsection Embedding SCM
@cindex Embedding SCM

@noindent
The file @file{scmmain.c} contains the definition of main().
When SCM is compiled as a library @file{scmmain.c} is not included in
the library; a copy of @file{scmmain.c} can be modified to use SCM as an
embedded library module.

@deftypefun int main (int @var{argc}, char **@var{argv})
This is the top level C routine.  The value of the @var{argc} argument
is the number of command line arguments.  The @var{argv} argument is a
vector of C strings; its elements are the individual command line
argument strings.  A null pointer always follows the last element:
@code{@var{argv}[@var{argc}]} is this null pointer.
@end deftypefun

@deftypevar char *execpath
This string is the pathname of the executable file being run.  This
variable can be examined and set from Scheme (@pxref{Internal State}).
@var{execpath} must be set to executable's path in order to use DUMP
(@pxref{Dump}) or DLD.
@end deftypevar

@noindent
Rename main() and arrange your code to call it with an @var{argv} which
sets up SCM as you want it.

@noindent
If you need more control than is possible through @var{argv}, here are
descriptions of the functions which main() calls.

@deftypefun void init_sbrk (void)
Call this before SCM calls malloc().  Value returned from sbrk() is used
to gauge how much storage SCM uses.
@end deftypefun

@deftypefun {char *} scm_find_execpath (int @var{argc}, char **@var{argv}, char *@var{script_arg})
@var{argc} and @var{argv} are as described in main().  @var{script_arg}
is the pathname of the SCSH-style script (@pxref{Scripting}) being
invoked; 0 otherwise.  @code{scm_find_execpath} returns the pathname of
the executable being run; if @code{scm_find_execpath} cannot determine
the pathname, then it returns 0.
@end deftypefun

@noindent
@code{scm_find_implpath} is defined in @file{scmmain.c}.  Preceeding
this are definitions of@var{GENERIC_NAME} and @var{INIT_GETENV}.  These,
along with @var{IMPLINIT} and @var{dirsep} control scm_find_implpath()'s
operation.

@noindent
If your application has an easier way to locate initialization code for
SCM, then you can replace @code{scm_find_implpath}.

@deftypefun {char *} scm_find_implpath (char *@var{execpath})
Returns the full pathname of the Scheme initialization file or 0 if it
cannot find it.

The string value of the preprocessor variable @var{INIT_GETENV} names an
environment variable (default @samp{"SCM_INIT_PATH"}).  If this
environment variable is defined, its value will be returned from
@code{scm_find_implpath}.  Otherwise find_impl_file() is called with the
arguments @var{execpath}, @var{GENERIC_NAME} (default "scm"),
@var{INIT_FILE_NAME} (default "Init@value{SCMVERSION}_scm"), and the
directory separator string @var{dirsep}.  If find_impl_file() returns 0
and @var{IMPLINIT} is defined, then a copy of the string @var{IMPLINIT}
is returned.
@end deftypefun

@deftypefun int init_buf0 (FILE *@var{inport})
Tries to determine whether @var{inport} (usually stdin) is an
interactive input port which should be used in an unbuffered mode.  If
so, @var{inport} is set to unbuffered and non-zero is returned.
Otherwise, 0 is returned.

@code{init_buf0} should be called before any input is read from
@var{inport}.  Its value can be used as the last argument to
scm_init_from_argv().
@end deftypefun

@deftypefun void scm_init_from_argv (int @var{argc}, char **@var{argv}, char *@var{script_arg}, int @var{iverbose}, int @var{buf0stdin})
Initializes SCM storage and creates a list of the argument strings
@var{program-arguments} from @var{argv}.  @var{argc} and @var{argv} must
already be processed to accomodate Scheme Scripts (if desired).  The
scheme variable @var{*script*} is set to the string @var{script_arg}, or
#f if @var{script_arg} is 0.
@var{iverbose} is the initial prolixity level.  If @var{buf0stdin} is
non-zero, stdin is treated as an unbuffered port.
@end deftypefun

@noindent
Call @code{init_signals} and @code{restore_signals} only if you want SCM
to handle interrupts and signals.

@deftypefun void init_signals (void)
Initializes handlers for @code{SIGINT} and @code{SIGALRM} if they are
supported by the C implementation.  All of the signal handlers
immediately reestablish themselves by a call to @code{signal()}.
@end deftypefun

@deftypefun void restore_signals (void)
Restores the handlers in effect when @code{init_signals} was called.
@end deftypefun

@deftypefun SCM scm_top_level (char *@var{initpath}, SCM (*toplvl_fun)())
This is SCM's top-level.  Errors longjmp here.  @var{toplvl_fun} is a
callback function of zero arguments that is called by
@code{scm_top_level} to do useful work -- if zero, then @code{repl},
which implements a read-eval-print loop, is called.

If @var{toplvl_fun} returns, then @code{scm_top_level} will return as
well.  If the return value of @var{toplvl_fun} is an immediate integer
then it will be used as the return value of @code{scm_top_level}.  In
the main function supplied with SCM, this return value is the exit
status of the process.

If the first character of string @var{initpath} is @samp{;}, @samp{(} or
whitespace, then scm_ldstr() is called with @var{initpath} to initialize
SCM; otherwise @var{initpath} names a file of Scheme code to be loaded
to initialize SCM.

When a Scheme error is signaled; control will pass into
@code{scm_top_level} by @code{longjmp}, error messages will be printed
to @code{current-error-port}, and then @var{toplvl_fun} will be called
again.  @var{toplvl_fun} must maintain enough state to prevent errors
from being resignalled.  If @code{toplvl_fun} can not recover from an
error situation it may simply return.
@end deftypefun

@deftypefun void final_scm (int @var{freeall})
Calls all finalization routines registered with add_final().  If
@var{freeall} is non-zero, then all memory which SCM allocated with
malloc() will be freed.
@end deftypefun

@noindent
You can call indivdual Scheme procedures from C code in the
@var{toplvl_fun} argument passed to scm_top_level(), or from module
subrs (registered by an @code{init_} function, @pxref{Changing Scm}).

@noindent
Use @code{apply} to call Scheme procedures from your C code.  For
example:

@example
/* If this apply fails, SCM will catch the error */
apply(CDR(intern("srv:startup",sizeof("srv:startup")-1)),
      mksproc(srvproc),
      listofnull);

func = CDR(intern(rpcname,strlen(rpcname)));
retval = apply(func, cons(mksproc(srvproc), args), EOL);
@end example

Functions for loading Scheme files and evaluating Scheme code given
as C strings are described in the next section, (@pxref{Callbacks}).

Here is a minimal embedding program @file{libtest.c}:

@example
/* gcc -o libtest libtest.c libscm.a -ldl -lm -lc */
#include "scm.h"
/* include patchlvl.h for SCM's INIT_FILE_NAME. */
#include "patchlvl.h"

void init_user_scm()
@{
  fputs("This is init_user_scm\n", stderr); fflush(stderr);
  sysintern("*the-string*", makfrom0str("hello world\n"));
@}

SCM user_main()
@{
  static int done = 0;
  if (done++) return MAKINUM(EXIT_FAILURE);
  scm_ldstr("(display *the-string*)");
  return MAKINUM(EXIT_SUCCESS);
@}

int main(argc, argv)
     int argc;
     char **argv;
@{
  SCM retval;
  char *implpath, *execpath;

  execpath = dld_find_executable(argv[0]);
  fprintf(stderr, "dld_find_executable(%s): %s\n", argv[0], execpath);
  implpath = find_impl_file(execpath, "scm", INIT_FILE_NAME, dirsep);
  fprintf(stderr, "implpath: %s\n", implpath);
  scm_init_from_argv(argc, argv, 0L, 0, 0);

  retval = scm_top_level(implpath, user_main);

  final_scm(!0);
  return (int)INUM(retval);
@}

@print{}
dld_find_executable(./libtest): /home/jaffer/scm/libtest
implpath: /home/jaffer/scm/Init@value{SCMVERSION}.scm
This is init_user_scm
hello world
@end example


@node Callbacks, Type Conversions, Embedding SCM, Operations
@subsection Callbacks
@cindex callbacks

@noindent
SCM now has routines to make calling back to Scheme procedures easier.
The source code for these routines are found in @file{rope.c}.

@deftypefun int scm_ldfile (char *@var{file})
Loads the Scheme source file @var{file}.  Returns 0 if successful, non-0
if not.  This function is used to load SCM's initialization file
@file{Init@value{SCMVERSION}.scm}.
@end deftypefun

@deftypefun int scm_ldprog (char *@var{file})
Loads the Scheme source file @code{(in-vicinity (program-vicinity)
@var{file})}.  Returns 0 if successful, non-0 if not.

This function is useful for compiled code init_ functions to load
non-compiled Scheme (source) files.  @code{program-vicinity} is the
directory from which the calling code was loaded (@pxref{Vicinity, , ,
slib, SLIB}).
@end deftypefun

@deftypefun SCM scm_evstr (char *@var{str})
Returns the result of reading an expression from @var{str} and
evaluating it.
@end deftypefun

@deftypefun void scm_ldstr (char *@var{str})
Reads and evaluates all the expressions from @var{str}.
@end deftypefun

@noindent
If you wish to catch errors during execution of Scheme code, then you
can use a wrapper like this for your Scheme procedures:

@example
(define (srv:protect proc)
  (lambda args
    (define result #f)                  ; put default value here
    (call-with-current-continuation
     (lambda (cont)
       (dynamic-wind (lambda () #t)
                     (lambda ()
                       (set! result (apply proc args))
                       (set! cont #f))
                     (lambda ()
                       (if cont (cont #f))))))
    result))
@end example

@noindent
Calls to procedures so wrapped will return even if an error occurs.

@node Type Conversions, Continuations, Callbacks, Operations
@subsection Type Conversions

These type conversion functions are very useful for connecting SCM and C
code.  Most are defined in @file{rope.c}.

@deftypefun SCM long2num (long @var{n})
@deftypefunx SCM ulong2num (unsigned long @var{n})
Return an object of type @code{SCM} corresponding to the @code{long} or
@code{unsigned long} argument @var{n}.  If @var{n} cannot be converted,
@code{BOOL_F} is returned.  Which numbers can be converted depends on
whether SCM was compiled with the @code{BIGDIG} or @code{FLOATS} flags.

To convert integer numbers of smaller types (@code{short} or
@code{char}), use the macro @code{MAKINUM(n)}.
@end deftypefun

@deftypefun long num2long (SCM @var{num}, char *@var{pos}, char *@var{s_caller})
@deftypefunx unsigned long num2ulong (SCM @var{num}, char *@var{pos}, char *@var{s_caller})
@deftypefunx unsigned short num2ushort (SCM @var{num}, char *@var{pos}, char *@var{s_caller})
@deftypefunx unsigned char num2uchar (SCM @var{num}, char *@var{pos}, char *@var{s_caller})
These functions are used to check and convert @code{SCM} arguments to
the named C type.  The first argument @var{num} is checked to see it it
is within the range of the destination type.  If so, the converted
number is returned.  If not, the @code{ASSERT} macro calls @code{wta}
with @var{num} and strings @var{pos} and @var{s_caller}.  For a listing
of useful predefined @var{pos} macros, @xref{C Macros}.

@emph{Note:} Inexact numbers are accepted only by @code{num2long} and
@code{num2ulong} (for when @code{SCM} is compiled without bignums).  To
convert inexact numbers to exact numbers, @xref{Numerical operations,
inexact->exact, , r5rs, Revised(5) Scheme}.
@end deftypefun

@deftypefun unsigned long scm_addr (SCM @var{args}, char *@var{s_name})
Returns a pointer (cast to an @code{unsigned long}) to the storage
corresponding to the location accessed by
@code{aref(CAR(args),CDR(args))}.  The string @var{s_name} is used in
any messages from error calls by @code{scm_addr}.

@code{scm_addr} is useful for performing C operations on strings or
other uniform arrays (@pxref{Uniform Array}).

@emph{Note:} While you use a pointer returned from @code{scm_addr} you
must keep a pointer to the associated @code{SCM} object in a stack
allocated variable or GC-protected location in order to assure that SCM
does not reuse that storage before you are done with it.
@end deftypefun

@deftypefun SCM makfrom0str (char *@var{src})
@deftypefunx SCM makfromstr (char *@var{src}, sizet @var{len})
Return a newly allocated string @code{SCM} object copy of the
null-terminated string @var{src} or the string @var{src} of length
@var{len}, respectively.
@end deftypefun

@deftypefun SCM makfromstrs (int @var{argc}, char **@var{argv})
Returns a newly allocated @code{SCM} list of strings corresponding to
the @var{argc} length array of null-terminated strings @var{argv}.  If
@var{argv} is less than @code{0}, @var{argv} is assumed to be
@code{NULL} terminated.  @code{makfromstrs} is used by
@code{scm_init_from_argv} to convert the arguments SCM was called with
to a @code{SCM} list which is the value of SCM procedure calls to
@code{program-arguments} (@pxref{SCM Session, program-arguments}).
@end deftypefun

@deftypefun {char **} makargvfrmstrs (SCM @var{args}, char *@var{s_name})
Returns a @code{NULL} terminated list of null-terminated strings copied
from the @code{SCM} list of strings @var{args}.  The string @var{s_name}
is used in messages from error calls by @code{makargvfrmstrs}.

@code{makargvfrmstrs} is useful for constructing argument lists suitable
for passing to @code{main} functions.
@end deftypefun

@deftypefun void must_free_argv (char **@var{argv})
Frees the storage allocated to create @var{argv} by a call to
@code{makargvfrmstrs}.
@end deftypefun

@node Continuations, Evaluation, Type Conversions, Operations
@subsection Continuations
@cindex continuations

@noindent
The source files @file{continue.h} and @file{continue.c} are designed to
function as an independent resource for programs wishing to use
continuations, but without all the rest of the SCM machinery.  The
concept of continuations is explained in @ref{Control features,
call-with-current-continuation, , r5rs, Revised(5) Scheme}.

@noindent
The C constructs @code{jmp_buf}, @code{setjmp}, and @code{longjmp}
implement escape continuations.  On VAX and Cray platforms, the setjmp
provided does not save all the registers.  The source files
@file{setjump.mar}, @file{setjump.s}, and @file{ugsetjump.s} provide
implementations which do meet this criteria.

@noindent
SCM uses the names @code{jump_buf}, @code{setjump}, and @code{longjump}
in lieu of @code{jmp_buf}, @code{setjmp}, and @code{longjmp} to prevent
name and declaration conflicts.

@deftp {Data type} CONTINUATION jmpbuf length stkbse other parent
is a @code{typedef}ed structure holding all the information needed to
represent a continuation.  The @var{other} slot can be used to hold any
data the user wishes to put there by defining the macro
@code{CONTINUATION_OTHER}.
@end deftp

@defmac SHORT_ALIGN
If @code{SHORT_ALIGN} is @code{#define}d (in @file{scmfig.h}), then the
it is assumed that pointers in the stack can be aligned on @code{short
int} boundaries.
@end defmac

@deftp {Data type} STACKITEM
is a pointer to objects of the size specified by @code{SHORT_ALIGN}
being @code{#define}d or not.
@end deftp

@defmac CHEAP_CONTINUATIONS
If @code{CHEAP_CONTINUATIONS} is @code{#define}d (in @file{scmfig.h})
each @code{CONTINUATION} has size @code{sizeof CONTINUATION}.
Otherwise, all but @dfn{root} @code{CONTINUATION}s have additional
storage (immediately following) to contain a copy of part of the stack.

@emph{Note:} On systems with nonlinear stack disciplines (multiple
stacks or non-contiguous stack frames) copying the stack will not work
properly.  These systems need to #define @code{CHEAP_CONTINUATIONS} in
@file{scmfig.h}.
@end defmac

@defmac STACK_GROWS_UP
Expresses which way the stack grows by its being @code{#define}d or not.
@end defmac

@deftypevar long thrown_value
Gets set to the @var{value} passed to @code{throw_to_continuation}.
@end deftypevar

@deftypefun long stack_size (STACKITEM *@var{start})
Returns the number of units of size @code{STACKITEM} which fit between
@var{start} and the current top of stack.  No check is done in this
routine to ensure that @var{start} is actually in the current stack
segment.
@end deftypefun

@deftypefun {CONTINUATION *} make_root_continuation (STACKITEM *@var{stack_base})
Allocates (@code{malloc}) storage for a @code{CONTINUATION} of the
current extent of stack.  This newly allocated @code{CONTINUATION} is
returned if successful, @code{0} if not.  After
@code{make_root_continuation} returns, the calling routine still needs
to @code{setjump(@var{new_continuation}->jmpbuf)} in order to complete
the capture of this continuation.
@end deftypefun

@deftypefun {CONTINUATION *} make_continuation (CONTINUATION *@var{parent_cont})
Allocates storage for the current @code{CONTINUATION}, copying (or
encapsulating) the stack state from @code{@var{parent_cont}->stkbse} to
the current top of stack.  The newly allocated @code{CONTINUATION} is
returned if successful, @code{0}q if not.  After
@code{make_continuation} returns, the calling routine still needs to
@code{setjump(@var{new_continuation}->jmpbuf)} in order to complete the
capture of this continuation.
@end deftypefun

@deftypefun void free_continuation (CONTINUATION *@var{cont})
Frees the storage pointed to by @var{cont}.  Remember to free storage
pointed to by @code{@var{cont}->other}.
@end deftypefun

@deftypefun void throw_to_continuation (CONTINUATION *@var{cont}, long @var{value}, CONTINUATION *@var{root_cont})
Sets @code{thrown_value} to @var{value} and returns from the
continuation @var{cont}.

If @code{CHEAP_CONTINUATIONS} is @code{#define}d, then
@code{throw_to_continuation} does @code{longjump(@var{cont}->jmpbuf, val)}.

If @code{CHEAP_CONTINUATIONS} is not @code{#define}d, the CONTINUATION
@var{cont} contains a copy of a portion of the C stack (whose bound must
be @code{CONT(@var{root_cont})->stkbse}).  Then:

@itemize @bullet
@item
the stack is grown larger than the saved stack, if neccessary.
@item
the saved stack is copied back into it's original position.
@item
@code{longjump(@var{cont}->jmpbuf, val)};
@end itemize
@end deftypefun

@node Evaluation,  , Continuations, Operations
@subsection Evaluation

SCM uses its type representations to speed evaluation.  All of the
@code{subr} types (@pxref{Subr Cells}) are @code{tc7} types.  Since the
@code{tc7} field is in the low order bit position of the @code{CAR} it
can be retrieved and dispatched on quickly by dereferencing the SCM
pointer pointing to it and masking the result.

All the SCM @dfn{Special Forms} get translated to immediate symbols
(@code{isym}) the first time they are encountered by the interpreter
(@code{ceval}).  The representation of these immediate symbols is
engineered to occupy the same bits as @code{tc7}.  All the @code{isym}s
occur only in the @code{CAR} of lists.

If the @code{CAR} of a expression to evaluate is not immediate, then it
may be a symbol.  If so, the first time it is encountered it will be
converted to an immediate type @code{ILOC} or @code{GLOC}
(@pxref{Immediates}).  The codes for @code{ILOC} and @code{GLOC} lower 7
bits distinguish them from all the other types we have discussed.

Once it has determined that the expression to evaluate is not immediate,
@code{ceval} need only retrieve and dispatch on the low order 7 bits of
the @code{CAR} of that cell, regardless of whether that cell is a
closure, header, or subr, or a cons containing @code{ILOC} or
@code{GLOC}.

In order to be able to convert a SCM symbol pointer to an immediate @code{ILOC}
or @code{GLOC}, the evaluator must be holding the pointer to the list in which
that symbol pointer occurs.  Turning this requirement to an advantage,
@code{ceval} does not recursively call itself to evaluate symbols in
lists; It instead calls the macro @dfn{EVALCAR}.  @code{EVALCAR} does
symbol lookup and memoization for symbols, retrieval of values for @code{ILOC}s
and @code{GLOC}s, returns other immediates, and otherwise recursively calls
itself with the @code{CAR} of the list.

@code{ceval} inlines evaluation (using @code{EVALCAR}) of almost all
procedure call arguments.  When @code{ceval} needs to evaluate a list of
more than length 3, the procedure @code{eval_args} is called.  So
@code{ceval} can be said to have one level lookahead.  The avoidance of
recursive invocations of @code{ceval} for the most common cases (special
forms and procedure calls) results in faster execution.  The speed of
the interpreter is currently limited on most machines by interpreter
size, probably having to do with its cache footprint.  In order to keep
the size down, certain @code{EVALCAR} calls which don't need to be fast
(because they rarely occur or because they are part of expensive
operations) are instead calls to the C function @code{evalcar}.

@defvar symhash
Top level symbol values are stored in the @code{symhash} table.
@code{symhash} is an array of lists of @code{ISYM}s and pairs of symbols
and values.
@end defvar

@deftp Immediate ILOC
Whenever a symbol's value is found in the local environment the pointer
to the symbol in the code is replaced with an immediate object
(@code{ILOC}) which specifies how many environment frames down and how
far in to go for the value.  When this immediate object is subsequently
encountered, the value can be retrieved quickly.
@end deftp

@code{ILOC}s work up to a maximum depth of 4096 frames or 4096
identifiers in a frame.  Radey Shouman added @dfn{FARLOC}
@tindex FARLOC
to handle cases exceeding these limits.  A @code{FARLOC} consists of a
pair whose CAR is the immediate type @code{IM_FARLOC_CAR} or
@code{IM_FARLOC_CDR}, and whose CDR is a pair of INUMs specifying the
frame and distance with a larger range than @code{ILOC}s span.

Adding @code{#define TEST_FARLOC} to @file{eval.c} causes @code{FARLOC}s
to be generated for all local identifiers; this is useful only for
testing memoization.

@deftp Immediate GLOC
Pointers to symbols not defined in local environments are changed to one
plus the value cell address in symhash.  This incremented pointer is
called a @code{GLOC}.  The low order bit is normally reserved for
GCmark; But, since references to variables in the code always occur in
the @code{CAR} position and the GCmark is in the @code{CDR}, there is no
conflict.
@end deftp

If the compile FLAG @code{CAUTIOUS} is #defined then the number of
arguments is always checked for application of closures.  If the compile
FLAG @code{RECKLESS} is #defined then they are not checked.  Otherwise,
number of argument checks for closures are made only when the function
position (whose value is the closure) of a combination is not an
@code{ILOC} or @code{GLOC}.  When the function position of a combination
is a symbol it will be checked only the first time it is evaluated
because it will then be replaced with an @code{ILOC} or @code{GLOC}.

@defmac EVAL expression env
@defmacx SIDEVAL expression env
@code{EVAL} Returns the result of evaluating @var{expression} in
@var{env}.  @code{SIDEVAL} evaluates @var{expression} in @var{env} when
the value of the expression is not used.

Both of these macros alter the list structure of @var{expression} as it
is memoized and hence should be used only when it is known that
@var{expression} will not be referenced again.  The C function
@code{eval} is safe from this problem.
@end defmac

@deftypefun SCM eval (SCM @var{expression})
Returns the result of evaluating @var{expression} in the top-level
environment.  @code{eval} copies @code{expression} so that memoization
does not modify @code{expression}.
@end deftypefun

@node Program Self-Knowledge, Improvements To Make, Operations, The Implementation
@section Program Self-Knowledge

@menu
* File-System Habitat::         
* Executable Pathname::         
* Script Support::              
@end menu

@node File-System Habitat, Executable Pathname, Program Self-Knowledge, Program Self-Knowledge
@subsection File-System Habitat

@noindent
Where should software reside?  Although individually a minor annoyance,
cumulatively this question represents many thousands of frustrated user
hours spent trying to find support files or guessing where packages need
to be installed.  Even simple programs require proper habitat; games
need to find their score files.

@noindent
Aren't there standards for this?  Some Operating Systems have devised
regimes of software habitats -- only to have them violated by large
software packages and imports from other OS varieties.

@noindent
In some programs, the expected locations of support files are fixed at
time of compilation.  This means that the program may not run on
configurations unanticipated by the authors.  Compiling locations into a
program also can make it immovable -- necessitating recompilation to
install it.

@quotation
Programs of the world unite!  You have nothing to lose but loss itself.
@end quotation

@noindent
The function @code{find_impl_file} in @file{scm.c} is an attempt to
create a utility (for inclusion in programs) which will hide the details
of platform-dependent file habitat conventions.  It takes as input the
pathname of the executable file which is running.  If there are systems
for which this information is either not available or unrelated to the
locations of support files, then a higher level interface will be
needed.

@deftypefun {char *} find_impl_file (char *@var{exec_path}, char *@var{generic_name}, char *@var{initname}, char *@var{sep})

Given the pathname of this executable (@var{exec_path}), test for the
existence of @var{initname} in the implementation-vicinity of this
program.  Return a newly allocated string of the path if successful, 0
if not.  The @var{sep} argument is a @emph{null-terminated string} of
the character used to separate directory components.
@end deftypefun

@itemize @bullet
@item
One convention is to install the support files for an executable program
in the same directory as the program.  This possibility is tried first,
which satisfies not only programs using this convention, but also
uninstalled builds when testing new releases, etc.

@item
Another convention is to install the executables in a directory named
@file{bin}, @file{BIN}, @file{exe}, or @file{EXE} and support files in a
directroy named @file{lib}, which is a peer the executable directory.
This arrangement allows multiple executables can be stored in a single
directory.  For example, the executable might be in
@samp{/usr/local/bin/} and initialization file in
@samp{/usr/local/lib/}.

If the executable directory name matches, the peer directroy @file{lib}
is tested for @var{initname}.

@item
Sometimes @file{lib} directories become too crowded.  So we look in any
subdirectories of @file{lib} or @file{src} having the name (sans type
suffix such as @samp{.EXE}) of the program we are running.  For example,
the executable might be @samp{/usr/local/bin/foo} and initialization
file in @samp{/usr/local/lib/foo/}.

@item
But the executable name may not be the usual program name; So also look
in any @var{generic_name} subdirectories of @file{lib} or @file{src}
peers.

@item
Finally, if the name of the executable file being run has a (system
dependent) suffix which is not needed to invoke the program, then look
in a subdirectory (of the one containing the executable file) named for
the executable (without the suffix); And look in a @var{generic_name}
subdirectory.  For example, the executable might be
@samp{C:\foo\bar.exe} and the initialization file in @samp{C:\foo\bar\}.
@end itemize


@node Executable Pathname, Script Support, File-System Habitat, Program Self-Knowledge
@subsection Executable Pathname

@noindent
For purposes of finding @file{Init@value{SCMVERSION}.scm}, dumping an
executable, and dynamic linking, a SCM session needs the pathname of its
executable image.

@noindent
When a program is executed by MS-DOS, the full pathname of that
executable is available in @code{argv[0]}.  This value can be passed
directly to @code{find_impl_file} (@pxref{File-System Habitat}).

@noindent
In order to find the habitat for a unix program, we first need to know
the full pathname for the associated executable file.

@deftypefun {char *} dld_find_executable (const char *@var{command})
@code{dld_find_executable} returns the absolute path name of the file
that would be executed if @var{command} were given as a command.  It
looks up the environment variable @var{PATH}, searches in each of the
directory listed for @var{command}, and returns the absolute path name
for the first occurrence.  Thus, it is advisable to invoke
@code{dld_init} as:

@example
main (int argc, char **argv)
@{
    @dots{}
    if (dld_init (dld_find_executable (argv[0]))) @{
        @dots{}
    @}
    @dots{}
@}
@end example

@quotation
@strong{Note:} If the current process is executed using the
@code{execve} call without passing the correct path name as argument 0,
@code{dld_find_executable (argv[0]) } will also fail to locate the
executable file.
@end quotation

@code{dld_find_executable} returns zero if @code{command} is not found
in any of the directories listed in @code{PATH}.
@end deftypefun

@node Script Support,  , Executable Pathname, Program Self-Knowledge
@subsection Script Support

@noindent
Source code for these C functions is in the file @file{script.c}.
@ref{Scripting} for a description of script argument processing.

@noindent
@code{script_find_executable} is only defined on unix systems.

@deftypefun {char *} script_find_executable (const char *@var{name})
@code{script_find_executable} returns the path name of the
executable which is invoked by the script file @var{name};
@var{name} if it is a binary executable (not a script); or 0 if
@var{name} does not exist or is not executable.
@end deftypefun

@deftypefun {char **} script_process_argv (int @var{argc}; char **@var{argv})
Given an @dfn{main} style argument vector @var{argv} and the number of
arguments, @var{argc}, @code{script_process_argv} returns a newly
allocated argument vector in which the second line of the script being
invoked is substituted for the corresponding meta-argument.
@tindex meta-argument

If the script does not have a meta-argument, or if the file named by the
argument following a meta-argument cannot be opened for reading, then 0
is returned.

@code{script_process_argv} correctly processes argument vectors of
nested script invocations.
@end deftypefun

@deftypefun int script_count_argv (char **@var{argv})
Returns the number of argument strings in @var{argv}.
@end deftypefun


@node Improvements To Make,  , Program Self-Knowledge, The Implementation
@section Improvements To Make

@itemize @bullet
@item
Allow users to set limits for @code{malloc()} storage.
@item
Prefix and make more uniform all C function, variable, and constant
names.  Provide a file full of #define's to provide backward
compatability.
@item
@code{lgcd()} @emph{needs} to generate at most one bignum, but currently
generates more.
@item
@code{divide()} could use shifts instead of multiply and divide when
scaling.
@item
Currently, @code{dump}ing an executable does not preserve ports.  When
loading a @code{dump}ed executable, disk files could be reopened to the
same file and position as they had when the executable was dumped.
@item
Copying all of the stack is wasteful of storage.  Any time a
call-with-current-continuation is called the stack could be re-rooted
with a frame which calls the contin just created.  This in combination
with checking stack depth could also be used to allow stacks deeper
than 64K on the IBM PC.
@item
In the quest for speed, there has been some discussion about a "Forth"
style Scheme interpreter.

@quotation
Provided there is still type code space available in SCM, if we devote
some of the IMCAR codes to "inlined" operations, we should get a
significant performance boost.  What is eliminated is the having to look
up a @code{GLOC} or @code{ILOC} and then dispatch on the subr type.  The
IMCAR operation would be dispatched to directly.  Another way to view
this is that we make available special form versions of @code{CAR},
@code{CDR}, etc.  Since the actual operation code is localized in the
interpreter, it is much easier than uncompilation and then recompilation
to handle @code{(trace car)}; For instance a switch gets set which tells
the interpreter to instead always look up the values of the associated
symbols.
@end quotation

@end itemize

@menu
* Finishing Dynamic Linking::   
@end menu

@node Finishing Dynamic Linking,  , Improvements To Make, Improvements To Make
@subsection Finishing Dynamic Linking

@noindent
Scott Schwartz <schwartz@@galapagos.cse.psu.edu> suggests: One way to
tidy up the dynamic loading stuff would be to grab the code from perl5.

@subsubheading VMS

@noindent
George Carrette (gjc@@mitech.com) outlines how to dynamically link on
VMS.  There is already some code in @file{dynl.c} to do this, but
someone with a VMS system needs to finish and debug it.

@enumerate
@item
Say you have this @file{main.c} program:

@format
@t{main()
@{init_lisp();
 lisp_repl();@}}
@end format

@item
and you have your lisp in files @file{repl.c}, @file{gc.c},
@code{eval.c} and there are some toplevel non-static variables in use
called @code{the_heap}, @code{the_environment}, and some read-only
toplevel structures, such as @code{the_subr_table}.

@format
@t{$ LINK/SHARE=LISPRTL.EXE/DEBUG REPL.OBJ,GC.OBJ,EVAL.OBJ,LISPRTL.OPT/OPT}
@end format

@item
where @file{LISPRTL.OPT} must contain at least this:

@format
@t{SYS$LIBRARY:VAXCRTL/SHARE
UNIVERSAL=init_lisp
UNIVERSAL=lisp_repl
PSECT_ATTR=the_subr_table,SHR,NOWRT,LCL
PSECT_ATTR=the_heap,NOSHR,LCL
PSECT_ATTR=the_environment,NOSHR,LCL}
@end format

@emph{Notice:} The @dfn{psect} (Program Section) attributes.
@table @code
@item LCL
means to keep the name local to the shared library.  You almost always
want to do that for a good clean library.
@item SHR,NOWRT
means shared-read-only.  Which is the default for code, and is also good
for efficiency of some data structures.
@item NOSHR,LCL
is what you want for everything else.
@end table

Note: If you do not have a handy list of all these toplevel variables,
do not dispair.  Just do your link with the /MAP=LISPRTL.MAP/FULL
and then search the map file,

@format
@t{$SEARCH/OUT=LISPRTL.LOSERS LISPRTL.MAP  ",  SHR,NOEXE,  RD,  WRT"}
@end format

And use an emacs keyboard macro to muck the result into the proper form.
Of course only the programmer can tell if things can be made read-only.
I have a DCL command procedure to do this if you want it.

@item
@noindent
Now MAIN.EXE would be linked thusly:

@format
@t{$ DEFINE LISPRTL USER$DISK:[JAFFER]LISPRTL.EXE

$LINK MAIN.OBJ,SYS$INPUT:/OPT
 SYS$LIBRARY:VAXCRTL/SHARE
 LISPRTL/SHARE}
@end format

Note the definition of the @code{LISPRTL} logical name.  Without such a
definition you will need to copy @file{LISPRTL.EXE} over to
@file{SYS$SHARE:} (aka @file{SYS$LIBRARY:}) in order to invoke the main
program once it is linked.

@item
Now say you have a file of optional subrs, @file{MYSUBRS.C}.  And there
is a routine @code{INIT_MYSUBRS} that must be called before using it.

@format
@t{$ CC MYSUBRS.C
$ LINK/SHARE=MYSUBRS.EXE MYSUBRS.OBJ,SYS$INPUT:/OPT
  SYS$LIBRARY:VAXCRTL/SHARE
  LISPRTL/SHARE
  UNIVERSAL=INIT_MYSUBRS}
@end format

Ok.  Another hint is that you can avoid having to add the @code{PSECT}
declaration of @code{NOSHR,LCL} by declaring variables @code{status} in
the C language source.  That works great for most things.

@item
Then the dynamic loader would have to do this:

@format
@t{@{void (*init_fcn)();
 long retval;
 retval = lib$find_image_symbol("MYSUBRS","INIT_MYSUBRS",&init_fcn,
                                "SYS$DISK:[].EXE");
 if (retval != SS$_NORMAL) error(@dots{});
 (*init_fcn)();@}}
@end format

But of course all string arguments must be @code{(struct dsc$descriptor
*)} and the last argument is optional if @code{MYSUBRS} is defined as a
logical name or if @file{MYSUBRS.EXE} has been copied over to
@file{SYS$SHARE}.  The other consideration is that you will want to turn
off @key{C-c} or other interrupt handling while you are inside most
@code{lib$} calls.

As far as the generation of all the @code{UNIVERSAL=@dots{}}
declarations.  Well, you could do well to have that automatically
generated from the public @file{LISPRTL.H} file, of course.

VMS has a good manual called the @cite{Guide to Writing Modular
Procedures} or something like that, which covers this whole area rather
well, and also talks about advanced techniques, such as a way to declare
a program section with a pointer to a procedure that will be
automatically invoked whenever any shared image is dynamically
activated.  Also, how to set up a handler for normal or abnormal program
exit so that you can clean up side effects (such as opening a database).
But for use with @code{LISPRTL} you probably don't need that hair.

One fancier option that is useful under VMS for @file{LISPLIB.EXE} is to
define all your exported procedures through an @dfn{call vector} instead
of having them just be pointers into random places in the image, which
is what you get by using @code{UNIVERSAL}.

If you set up the call vector thing correctly it will allow you to
modify and relink @file{LISPLIB.EXE} without having to relink programs
that have been linked against it.
@end enumerate

@subsubheading Windows NT
@noindent
George Carrette (gjc@@mitech.com) outlines how to dynamically link on
Windows NT:

@itemize @bullet
@item
The Software Developers Kit has a sample called SIMPLDLL.
Here is the gist of it, following along the lines of the VMS description
above (contents of a makefile for the SDK NMAKE)

@format
@t{LISPLIB.exp:
LISPLIB.lib: LISPLIB.def
    $(implib) -machine:$(CPU) -def:LISPLIB.def -out:LISPLIB.lib

LISPLIB.DLL : $(LISPLIB_OBJS) LISPLIB.EXP
    $(link) $(linkdebug)              \
    -dll                 \
    -out:LISPLIB.DLL     \
    LISPLIB.EXP $(LISPLIB_OBJS) $(conlibsdll)}
@end format

@item
The @file{LISPDEF.DEF} file has this:

@format
@t{LIBRARY lisplib
EXPORT
 init_lisp
 init_repl}
@end format

@item
And @file{MAIN.EXE} using:

@format
@t{CLINK = $(link) $(ldebug) $(conflags) -out:$*.exe $** $(conlibsdll)

MAIN.EXE : MAIN.OBJ LISPLIB.LIB
 $(CLINK)}
@end format

@item
And @file{MYSUBRS.DLL} is produced using:

@format
@t{mysubrs.exp:
mysubrs.lib: mysubrs.def
    $(implib) -machine:$(CPU) -def:MYSUBRS.def -out:MYSUBRS.lib

mysubrs.dll : mysubrs.obj mysubrs.exp mysubrs.lib
    $(link) $(linkdebug) \
    -dll                 \
    -out:mysubrs.dll     \
    MYSUBRS.OBJ MYSUBRS.EXP LISPLIB.LIB $(conlibsdll)}
@end format

@item
Where @file{MYSUBRS.DEF} has

@format
@t{LIBRARY mysubrs
EXPORT
 INIT_MYSUBRS}
@end format

@item
And the dynamic loader looks something like this, calling the two
procedures @code{LoadLibrary} and @code{GetProcAddress}.

@format
@t{LISP share_image_load(LISP fname)
@{long iflag;
 LISP retval,(*fcn)(void);
 HANDLE hLib;
 DWORD err;
 char *libname,fcnname[64];
 iflag = nointerrupt(1);
 libname = c_string(fname);
 _snprintf(fcnname,sizeof(fcnname),"INIT_%s",libname);
 if (!(hLib = LoadLibrary(libname)))
   @{err = GetLastError();
    retval = list2(fname,LSPNUM(err));
    serror1("library failed to load",retval);@}
 if (!(fcn = (LISP (*)(void)) GetProcAddress(hLib,fcnname)))
   @{err = GetLastError();
    retval = list2(fname,LSPNUM(err));
    serror1("could not find library init procedure",retval);@}
 retval = (*fcn)();
 nointerrupt(iflag);
 return(retval);@}}
@end format

@item
@emph{Note:} in VMS the linker and dynamic loader is case sensitive, but
all the language compilers, including C, will by default upper-case
external symbols for use by the linker, although the debugger gets its
own symbols and case sensitivity is language mode dependant.  In Windows
NT things are case sensitive generally except for file and device names,
which are case canonicalizing like in the Symbolics filesystem.

@item
@emph{Also:} All this WINDOWS NT stuff will work in MS-DOS MS-Windows
3.1 too, by a method of compiling and linking under Windows NT, and then
copying various files over to MS-DOS/WINDOWS.
@end itemize


@node Index,  , The Implementation, Top
@c @node Procedure and Macro Index, Variable Index, The Implementation, Top
@unnumbered Procedure and Macro Index

This is an alphabetical list of all the procedures and macros in SCM.

@printindex fn

@c @node Variable Index, Type Index, Procedure and Macro Index, Top
@unnumbered Variable Index

This is an alphabetical list of all the global variables in SCM.

@printindex vr

@c @node Type Index,  , Variable Index, Top
@unnumbered Type Index

This is an alphabetical list of data types and feature names in SCM.

@printindex tp

This is an alphabetical list of concepts introduced in this manual.

@unnumbered Concept Index
@printindex cp

@contents
@bye