[9759f6]: src / code / stream.lisp Maximize Restore History

Download this file

stream.lisp    2126 lines (1976 with data), 91.3 kB

   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
;;;; os-independent stream functions
;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.
(in-package "SB!IMPL")
;;;; standard streams
;;; The initialization of these streams is performed by
;;; STREAM-COLD-INIT-OR-RESET.
(defvar *terminal-io* () #!+sb-doc "terminal I/O stream")
(defvar *standard-input* () #!+sb-doc "default input stream")
(defvar *standard-output* () #!+sb-doc "default output stream")
(defvar *error-output* () #!+sb-doc "error output stream")
(defvar *query-io* () #!+sb-doc "query I/O stream")
(defvar *trace-output* () #!+sb-doc "trace output stream")
(defvar *debug-io* () #!+sb-doc "interactive debugging stream")
(defun ill-in (stream &rest ignore)
(declare (ignore ignore))
(error 'simple-type-error
:datum stream
:expected-type '(satisfies input-stream-p)
:format-control "~S is not a character input stream."
:format-arguments (list stream)))
(defun ill-out (stream &rest ignore)
(declare (ignore ignore))
(error 'simple-type-error
:datum stream
:expected-type '(satisfies output-stream-p)
:format-control "~S is not a character output stream."
:format-arguments (list stream)))
(defun ill-bin (stream &rest ignore)
(declare (ignore ignore))
(error 'simple-type-error
:datum stream
:expected-type '(satisfies input-stream-p)
:format-control "~S is not a binary input stream."
:format-arguments (list stream)))
(defun ill-bout (stream &rest ignore)
(declare (ignore ignore))
(error 'simple-type-error
:datum stream
:expected-type '(satisfies output-stream-p)
:format-control "~S is not a binary output stream."
:format-arguments (list stream)))
(defun closed-flame (stream &rest ignore)
(declare (ignore ignore))
(error 'closed-stream-error :stream stream))
(defun no-op-placeholder (&rest ignore)
(declare (ignore ignore)))
;;; stream manipulation functions
(defun ansi-stream-input-stream-p (stream)
(declare (type ansi-stream stream))
(if (synonym-stream-p stream)
(input-stream-p (symbol-value (synonym-stream-symbol stream)))
(and (not (eq (ansi-stream-in stream) #'closed-flame))
;;; KLUDGE: It's probably not good to have EQ tests on function
;;; values like this. What if someone's redefined the function?
;;; Is there a better way? (Perhaps just VALID-FOR-INPUT and
;;; VALID-FOR-OUTPUT flags? -- WHN 19990902
(or (not (eq (ansi-stream-in stream) #'ill-in))
(not (eq (ansi-stream-bin stream) #'ill-bin))))))
(defun input-stream-p (stream)
(declare (type stream stream))
(and (ansi-stream-p stream)
(ansi-stream-input-stream-p stream)))
(defun ansi-stream-output-stream-p (stream)
(declare (type ansi-stream stream))
(if (synonym-stream-p stream)
(output-stream-p (symbol-value (synonym-stream-symbol stream)))
(and (not (eq (ansi-stream-in stream) #'closed-flame))
(or (not (eq (ansi-stream-out stream) #'ill-out))
(not (eq (ansi-stream-bout stream) #'ill-bout))))))
(defun output-stream-p (stream)
(declare (type stream stream))
(and (ansi-stream-p stream)
(ansi-stream-output-stream-p stream)))
(declaim (inline ansi-stream-open-stream-p))
(defun ansi-stream-open-stream-p (stream)
(declare (type ansi-stream stream))
;; CLHS 22.1.4 lets us not worry about synonym streams here.
(not (eq (ansi-stream-in stream) #'closed-flame)))
(defun open-stream-p (stream)
(ansi-stream-open-stream-p stream))
(declaim (inline ansi-stream-element-type))
(defun ansi-stream-element-type (stream)
(declare (type ansi-stream stream))
(funcall (ansi-stream-misc stream) stream :element-type))
(defun stream-element-type (stream)
(ansi-stream-element-type stream))
(defun stream-external-format (stream)
(funcall (ansi-stream-misc stream) stream :external-format))
(defun interactive-stream-p (stream)
(declare (type stream stream))
(funcall (ansi-stream-misc stream) stream :interactive-p))
(declaim (inline ansi-stream-close))
(defun ansi-stream-close (stream abort)
(declare (type ansi-stream stream))
(when (open-stream-p stream)
(funcall (ansi-stream-misc stream) stream :close abort))
t)
(defun close (stream &key abort)
(ansi-stream-close stream abort))
(defun set-closed-flame (stream)
(setf (ansi-stream-in stream) #'closed-flame)
(setf (ansi-stream-bin stream) #'closed-flame)
(setf (ansi-stream-n-bin stream) #'closed-flame)
(setf (ansi-stream-out stream) #'closed-flame)
(setf (ansi-stream-bout stream) #'closed-flame)
(setf (ansi-stream-sout stream) #'closed-flame)
(setf (ansi-stream-misc stream) #'closed-flame))
;;;; for file position and file length
(defun external-format-char-size (external-format)
(ef-char-size (get-external-format external-format)))
;;; Call the MISC method with the :FILE-POSITION operation.
#!-sb-fluid (declaim (inline ansi-stream-file-position))
(defun ansi-stream-file-position (stream position)
(declare (type stream stream))
(declare (type (or index (alien sb!unix:off-t) (member nil :start :end))
position))
;; FIXME: It would be good to comment on the stuff that is done here...
;; FIXME: This doesn't look interrupt safe.
(cond
(position
(setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
(funcall (ansi-stream-misc stream) stream :file-position position))
(t
(let ((res (funcall (ansi-stream-misc stream) stream :file-position nil)))
(when res
#!-sb-unicode
(- res
(- +ansi-stream-in-buffer-length+
(ansi-stream-in-index stream)))
#!+sb-unicode
(let ((char-size (if (fd-stream-p stream)
(fd-stream-char-size stream)
(external-format-char-size (stream-external-format stream)))))
(- res
(etypecase char-size
(function
(loop with buffer = (ansi-stream-cin-buffer stream)
with start = (ansi-stream-in-index stream)
for i from start below +ansi-stream-in-buffer-length+
sum (funcall char-size (aref buffer i))))
(fixnum
(* char-size
(- +ansi-stream-in-buffer-length+
(ansi-stream-in-index stream))))))))))))
(defun file-position (stream &optional position)
(if (ansi-stream-p stream)
(ansi-stream-file-position stream position)
(stream-file-position stream position)))
;;; This is a literal translation of the ANSI glossary entry "stream
;;; associated with a file".
;;;
;;; KLUDGE: Note that since Unix famously thinks "everything is a
;;; file", and in particular stdin, stdout, and stderr are files, we
;;; end up with this test being satisfied for weird things like
;;; *STANDARD-OUTPUT* (to a tty). That seems unlikely to be what the
;;; ANSI spec really had in mind, especially since this is used as a
;;; qualification for operations like FILE-LENGTH (so that ANSI was
;;; probably thinking of something like what Unix calls block devices)
;;; but I can't see any better way to do it. -- WHN 2001-04-14
(defun stream-associated-with-file-p (x)
"Test for the ANSI concept \"stream associated with a file\"."
(or (typep x 'file-stream)
(and (synonym-stream-p x)
(stream-associated-with-file-p (symbol-value
(synonym-stream-symbol x))))))
(defun stream-must-be-associated-with-file (stream)
(declare (type stream stream))
(unless (stream-associated-with-file-p stream)
(error 'simple-type-error
;; KLUDGE: The ANSI spec for FILE-LENGTH specifically says
;; this should be TYPE-ERROR. But what then can we use for
;; EXPECTED-TYPE? This SATISFIES type (with a nonstandard
;; private predicate function..) is ugly and confusing, but
;; I can't see any other way. -- WHN 2001-04-14
:datum stream
:expected-type '(satisfies stream-associated-with-file-p)
:format-control
"~@<The stream ~2I~_~S ~I~_isn't associated with a file.~:>"
:format-arguments (list stream))))
;;; like FILE-POSITION, only using :FILE-LENGTH
(defun file-length (stream)
;; FIXME: The following declaration uses yet undefined types, which
;; cause cross-compiler hangup.
;;
;; (declare (type (or file-stream synonym-stream) stream))
;;
;; The description for FILE-LENGTH says that an error must be raised
;; for streams not associated with files (which broadcast streams
;; aren't according to the glossary). However, the behaviour of
;; FILE-LENGTH for broadcast streams is explicitly described in the
;; BROADCAST-STREAM entry.
(unless (typep stream 'broadcast-stream)
(stream-must-be-associated-with-file stream))
(funcall (ansi-stream-misc stream) stream :file-length))
(defun file-string-length (stream object)
(funcall (ansi-stream-misc stream) stream :file-string-length object))
;;;; input functions
(defun ansi-stream-read-line-from-frc-buffer (stream eof-error-p eof-value)
(prepare-for-fast-read-char stream
(declare (ignore %frc-method%))
(let ((chunks-total-length 0)
(chunks nil))
(declare (type index chunks-total-length)
(list chunks))
(labels ((refill-buffer ()
(prog1
(fast-read-char-refill stream nil nil)
(setf %frc-index% (ansi-stream-in-index %frc-stream%))))
(newline-position ()
(position #\Newline (the (simple-array character (*))
%frc-buffer%)
:test #'char=
:start %frc-index%))
(make-and-return-result-string (pos)
(let* ((len (+ (- (or pos %frc-index%)
%frc-index%)
chunks-total-length))
(res (make-string len))
(start 0))
(declare (type index start))
(when chunks
(dolist (chunk (nreverse chunks))
(declare (type (simple-array character) chunk))
(replace res chunk :start1 start)
(incf start (length chunk))))
(unless (null pos)
(replace res %frc-buffer%
:start1 start
:start2 %frc-index% :end2 pos)
(setf %frc-index% (1+ pos)))
(done-with-fast-read-char)
(return-from ansi-stream-read-line-from-frc-buffer (values res (null pos)))))
(add-chunk ()
(let* ((end (length %frc-buffer%))
(len (- end %frc-index%))
(chunk (make-string len)))
(replace chunk %frc-buffer% :start2 %frc-index% :end2 end)
(push chunk chunks)
(incf chunks-total-length len)
(when (refill-buffer)
(make-and-return-result-string nil)))))
(declare (inline make-and-return-result-string
refill-buffer))
(when (and (= %frc-index% +ansi-stream-in-buffer-length+)
(refill-buffer))
;; EOF had been reached before we read anything
;; at all. Return the EOF value or signal the error.
(done-with-fast-read-char)
(return-from ansi-stream-read-line-from-frc-buffer
(values (eof-or-lose stream eof-error-p eof-value) t)))
(loop
(let ((pos (newline-position)))
(if pos
(make-and-return-result-string pos)
(add-chunk))))))))
#!-sb-fluid (declaim (inline ansi-stream-read-line))
(defun ansi-stream-read-line (stream eof-error-p eof-value recursive-p)
(declare (ignore recursive-p))
(if (ansi-stream-cin-buffer stream)
;; Stream has a fast-read-char buffer. Copy large chunks directly
;; out of the buffer.
(ansi-stream-read-line-from-frc-buffer stream eof-error-p eof-value)
;; Slow path, character by character.
(prepare-for-fast-read-char stream
(let ((res (make-string 80))
(len 80)
(index 0))
(loop
(let ((ch (fast-read-char nil nil)))
(cond (ch
(when (char= ch #\newline)
(done-with-fast-read-char)
(return (values (%shrink-vector res index) nil)))
(when (= index len)
(setq len (* len 2))
(let ((new (make-string len)))
(replace new res)
(setq res new)))
(setf (schar res index) ch)
(incf index))
((zerop index)
(done-with-fast-read-char)
(return (values (eof-or-lose stream
eof-error-p
eof-value)
t)))
;; Since FAST-READ-CHAR already hit the eof char, we
;; shouldn't do another READ-CHAR.
(t
(done-with-fast-read-char)
(return (values (%shrink-vector res index) t))))))))))
(defun read-line (&optional (stream *standard-input*) (eof-error-p t) eof-value
recursive-p)
(let ((stream (in-synonym-of stream)))
(if (ansi-stream-p stream)
(ansi-stream-read-line stream eof-error-p eof-value recursive-p)
;; must be Gray streams FUNDAMENTAL-STREAM
(multiple-value-bind (string eof) (stream-read-line stream)
(if (and eof (zerop (length string)))
(values (eof-or-lose stream eof-error-p eof-value) t)
(values string eof))))))
;;; We proclaim them INLINE here, then proclaim them NOTINLINE later on,
;;; so, except in this file, they are not inline by default, but they can be.
#!-sb-fluid (declaim (inline read-char unread-char read-byte listen))
#!-sb-fluid (declaim (inline ansi-stream-read-char))
(defun ansi-stream-read-char (stream eof-error-p eof-value recursive-p)
(declare (ignore recursive-p))
(prepare-for-fast-read-char stream
(prog1
(fast-read-char eof-error-p eof-value)
(done-with-fast-read-char))))
(defun read-char (&optional (stream *standard-input*)
(eof-error-p t)
eof-value
recursive-p)
(let ((stream (in-synonym-of stream)))
(if (ansi-stream-p stream)
(ansi-stream-read-char stream eof-error-p eof-value recursive-p)
;; must be Gray streams FUNDAMENTAL-STREAM
(let ((char (stream-read-char stream)))
(if (eq char :eof)
(eof-or-lose stream eof-error-p eof-value)
char)))))
#!-sb-fluid (declaim (inline ansi-stream-unread-char))
(defun ansi-stream-unread-char (character stream)
(let ((index (1- (ansi-stream-in-index stream)))
(buffer (ansi-stream-cin-buffer stream)))
(declare (fixnum index))
(when (minusp index) (error "nothing to unread"))
(cond (buffer
(setf (aref buffer index) character)
(setf (ansi-stream-in-index stream) index))
(t
(funcall (ansi-stream-misc stream) stream
:unread character)))))
(defun unread-char (character &optional (stream *standard-input*))
(let ((stream (in-synonym-of stream)))
(if (ansi-stream-p stream)
(ansi-stream-unread-char character stream)
;; must be Gray streams FUNDAMENTAL-STREAM
(stream-unread-char stream character)))
nil)
#!-sb-fluid (declaim (inline ansi-stream-listen))
(defun ansi-stream-listen (stream)
(or (/= (the fixnum (ansi-stream-in-index stream))
+ansi-stream-in-buffer-length+)
;; Handle :EOF return from misc methods specially
(let ((result (funcall (ansi-stream-misc stream) stream :listen)))
(if (eq result :eof)
nil
result))))
(defun listen (&optional (stream *standard-input*))
(let ((stream (in-synonym-of stream)))
(if (ansi-stream-p stream)
(ansi-stream-listen stream)
;; Fall through to Gray streams FUNDAMENTAL-STREAM case.
(stream-listen stream))))
#!-sb-fluid (declaim (inline ansi-stream-read-char-no-hang))
(defun ansi-stream-read-char-no-hang (stream eof-error-p eof-value recursive-p)
(if (funcall (ansi-stream-misc stream) stream :listen)
;; On T or :EOF get READ-CHAR to do the work.
(ansi-stream-read-char stream eof-error-p eof-value recursive-p)
nil))
(defun read-char-no-hang (&optional (stream *standard-input*)
(eof-error-p t)
eof-value
recursive-p)
(let ((stream (in-synonym-of stream)))
(if (ansi-stream-p stream)
(ansi-stream-read-char-no-hang stream eof-error-p eof-value
recursive-p)
;; must be Gray streams FUNDAMENTAL-STREAM
(let ((char (stream-read-char-no-hang stream)))
(if (eq char :eof)
(eof-or-lose stream eof-error-p eof-value)
char)))))
#!-sb-fluid (declaim (inline ansi-stream-clear-input))
(defun ansi-stream-clear-input (stream)
(setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
(funcall (ansi-stream-misc stream) stream :clear-input))
(defun clear-input (&optional (stream *standard-input*))
(let ((stream (in-synonym-of stream)))
(if (ansi-stream-p stream)
(ansi-stream-clear-input stream)
;; must be Gray streams FUNDAMENTAL-STREAM
(stream-clear-input stream)))
nil)
#!-sb-fluid (declaim (inline ansi-stream-read-byte))
(defun ansi-stream-read-byte (stream eof-error-p eof-value recursive-p)
;; Why the "recursive-p" parameter? a-s-r-b is funcall'ed from
;; a-s-read-sequence and needs a lambda list that's congruent with
;; that of a-s-read-char
(declare (ignore recursive-p))
(with-fast-read-byte (t stream eof-error-p eof-value)
(fast-read-byte)))
(defun read-byte (stream &optional (eof-error-p t) eof-value)
(if (ansi-stream-p stream)
(ansi-stream-read-byte stream eof-error-p eof-value nil)
;; must be Gray streams FUNDAMENTAL-STREAM
(let ((char (stream-read-byte stream)))
(if (eq char :eof)
(eof-or-lose stream eof-error-p eof-value)
char))))
;;; Read NUMBYTES bytes into BUFFER beginning at START, and return the
;;; number of bytes read.
;;;
;;; Note: CMU CL's version of this had a special interpretation of
;;; EOF-ERROR-P which SBCL does not have. (In the EOF-ERROR-P=NIL
;;; case, CMU CL's version would return as soon as any data became
;;; available.) This could be useful behavior for things like pipes in
;;; some cases, but it wasn't being used in SBCL, so it was dropped.
;;; If we ever need it, it could be added later as a new variant N-BIN
;;; method (perhaps N-BIN-ASAP?) or something.
#!-sb-fluid (declaim (inline read-n-bytes))
(defun read-n-bytes (stream buffer start numbytes &optional (eof-error-p t))
(if (ansi-stream-p stream)
(ansi-stream-read-n-bytes stream buffer start numbytes eof-error-p)
;; We don't need to worry about element-type size here is that
;; callers are supposed to have checked everything is kosher.
(let* ((end (+ start numbytes))
(read-end (stream-read-sequence stream buffer start end)))
(eof-or-lose stream (and eof-error-p (< read-end end)) (- read-end start)))))
(defun ansi-stream-read-n-bytes (stream buffer start numbytes eof-error-p)
(declare (type ansi-stream stream)
(type index numbytes start)
(type (or (simple-array * (*)) system-area-pointer) buffer))
(let* ((stream (in-synonym-of stream ansi-stream))
(in-buffer (ansi-stream-in-buffer stream))
(index (ansi-stream-in-index stream))
(num-buffered (- +ansi-stream-in-buffer-length+ index)))
(declare (fixnum index num-buffered))
(cond
((not in-buffer)
(funcall (ansi-stream-n-bin stream)
stream
buffer
start
numbytes
eof-error-p))
((<= numbytes num-buffered)
#+nil
(let ((copy-function (typecase buffer
((simple-array * (*)) #'ub8-bash-copy)
(system-area-pointer #'copy-ub8-to-system-area))))
(funcall copy-function in-buffer index buffer start numbytes))
(%byte-blt in-buffer index
buffer start (+ start numbytes))
(setf (ansi-stream-in-index stream) (+ index numbytes))
numbytes)
(t
(let ((end (+ start num-buffered)))
#+nil
(let ((copy-function (typecase buffer
((simple-array * (*)) #'ub8-bash-copy)
(system-area-pointer #'copy-ub8-to-system-area))))
(funcall copy-function in-buffer index buffer start num-buffered))
(%byte-blt in-buffer index buffer start end)
(setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
(+ (funcall (ansi-stream-n-bin stream)
stream
buffer
end
(- numbytes num-buffered)
eof-error-p)
num-buffered))))))
;;; the amount of space we leave at the start of the in-buffer for
;;; unreading
;;;
;;; (It's 4 instead of 1 to allow word-aligned copies.)
(defconstant +ansi-stream-in-buffer-extra+
4) ; FIXME: should be symbolic constant
;;; This function is called by the FAST-READ-CHAR expansion to refill
;;; the IN-BUFFER for text streams. There is definitely an IN-BUFFER,
;;; and hence must be an N-BIN method. It's also called by other stream
;;; functions which directly peek into the frc buffer.
(defun fast-read-char-refill (stream eof-error-p eof-value)
(let* ((ibuf (ansi-stream-cin-buffer stream))
(count (funcall (ansi-stream-n-bin stream)
stream
ibuf
+ansi-stream-in-buffer-extra+
(- +ansi-stream-in-buffer-length+
+ansi-stream-in-buffer-extra+)
nil))
(start (- +ansi-stream-in-buffer-length+ count)))
(declare (type index start count))
(cond ((zerop count)
;; An empty count does not necessarily mean that we reached
;; the EOF, it's also possible that it's e.g. due to a
;; invalid octet sequence in a multibyte stream. To handle
;; the resyncing case correctly we need to call the reading
;; function and check whether an EOF was really reached. If
;; not, we can just fill the buffer by one character, and
;; hope that the next refill will not need to resync.
;;
;; KLUDGE: we can't use FD-STREAM functions (which are the
;; only ones which will give us decoding errors) here,
;; because this code is generic. We can't call the N-BIN
;; function, because near the end of a real file that can
;; legitimately bounce us to the IN function. So we have
;; to call ANSI-STREAM-IN.
(let* ((index (1- +ansi-stream-in-buffer-length+))
(value (funcall (ansi-stream-in stream) stream nil :eof)))
(cond
((eql value :eof)
;; definitely EOF now
(setf (ansi-stream-in-index stream)
+ansi-stream-in-buffer-length+)
(values t (eof-or-lose stream eof-error-p eof-value)))
;; we resynced or were given something instead
(t
(setf (aref ibuf index) value)
(values nil (setf (ansi-stream-in-index stream) index))))))
(t
(when (/= start +ansi-stream-in-buffer-extra+)
(#.(let* ((n-character-array-bits
(sb!vm:saetp-n-bits
(find 'character
sb!vm:*specialized-array-element-type-properties*
:key #'sb!vm:saetp-specifier)))
(bash-function (intern (format nil "UB~D-BASH-COPY" n-character-array-bits)
(find-package "SB!KERNEL"))))
bash-function)
ibuf +ansi-stream-in-buffer-extra+
ibuf start
count))
(values nil
(setf (ansi-stream-in-index stream) start))))))
;;; This is similar to FAST-READ-CHAR-REFILL, but we don't have to
;;; leave room for unreading.
(defun fast-read-byte-refill (stream eof-error-p eof-value)
(let* ((ibuf (ansi-stream-in-buffer stream))
(count (funcall (ansi-stream-n-bin stream) stream
ibuf 0 +ansi-stream-in-buffer-length+
nil))
(start (- +ansi-stream-in-buffer-length+ count)))
(declare (type index start count))
(cond ((zerop count)
(setf (ansi-stream-in-index stream) +ansi-stream-in-buffer-length+)
(funcall (ansi-stream-bin stream) stream eof-error-p eof-value))
(t
(unless (zerop start)
(ub8-bash-copy ibuf 0
ibuf start
count))
(setf (ansi-stream-in-index stream) (1+ start))
(aref ibuf start)))))
;;; output functions
(defun write-char (character &optional (stream *standard-output*))
(with-out-stream stream (ansi-stream-out character)
(stream-write-char character))
character)
(defun terpri (&optional (stream *standard-output*))
(with-out-stream stream (ansi-stream-out #\newline) (stream-terpri))
nil)
#!-sb-fluid (declaim (inline ansi-stream-fresh-line))
(defun ansi-stream-fresh-line (stream)
(when (/= (or (charpos stream) 1) 0)
(funcall (ansi-stream-out stream) stream #\newline)
t))
(defun fresh-line (&optional (stream *standard-output*))
(let ((stream (out-synonym-of stream)))
(if (ansi-stream-p stream)
(ansi-stream-fresh-line stream)
;; must be Gray streams FUNDAMENTAL-STREAM
(stream-fresh-line stream))))
#!-sb-fluid (declaim (inline ansi-stream-write-string))
(defun ansi-stream-write-string (string stream start end)
(with-array-data ((data string) (offset-start start)
(offset-end end)
:check-fill-pointer t)
(funcall (ansi-stream-sout stream)
stream data offset-start offset-end)))
(defun %write-string (string stream start end)
(let ((stream (out-synonym-of stream)))
(if (ansi-stream-p stream)
(ansi-stream-write-string string stream start end)
;; must be Gray streams FUNDAMENTAL-STREAM
(stream-write-string stream string start end)))
string)
(defun write-string (string &optional (stream *standard-output*)
&key (start 0) end)
(declare (type string string))
(declare (type stream-designator stream))
(%write-string string stream start end))
;;; A wrapper function for all those (MACROLET OUT-FUN) definitions,
;;; which cannot deal with keyword arguments. %WRITE-STRING cannot
;;; replace this, as this needs to deal with simple-strings as well.
(declaim (inline write-string-no-key))
(defun write-string-no-key (string stream start end)
(write-string string stream :start start :end end))
(defun write-line (string &optional (stream *standard-output*)
&key (start 0) end)
(declare (type string string))
(declare (type stream-designator stream))
(let ((stream (out-synonym-of stream)))
(cond ((ansi-stream-p stream)
(ansi-stream-write-string string stream start end)
(funcall (ansi-stream-out stream) stream #\newline))
(t
(stream-write-string stream string start end)
(stream-write-char stream #\newline))))
string)
(defun charpos (&optional (stream *standard-output*))
(with-out-stream stream (ansi-stream-misc :charpos) (stream-line-column)))
(defun line-length (&optional (stream *standard-output*))
(with-out-stream stream (ansi-stream-misc :line-length)
(stream-line-length)))
(defun finish-output (&optional (stream *standard-output*))
(with-out-stream stream (ansi-stream-misc :finish-output)
(stream-finish-output))
nil)
(defun force-output (&optional (stream *standard-output*))
(with-out-stream stream (ansi-stream-misc :force-output)
(stream-force-output))
nil)
(defun clear-output (&optional (stream *standard-output*))
(with-out-stream stream (ansi-stream-misc :clear-output)
(stream-clear-output))
nil)
(defun write-byte (integer stream)
(with-out-stream/no-synonym stream (ansi-stream-bout integer)
(stream-write-byte integer))
integer)
;;; (These were inline throughout this file, but that's not appropriate
;;; globally. And we must not inline them in the rest of this file if
;;; dispatch to gray or simple streams is to work, since both redefine
;;; these functions later.)
(declaim (notinline read-char unread-char read-byte listen))
;;; This is called from ANSI-STREAM routines that encapsulate CLOS
;;; streams to handle the misc routines and dispatch to the
;;; appropriate SIMPLE- or FUNDAMENTAL-STREAM functions.
(defun stream-misc-dispatch (stream operation &optional arg1 arg2)
(declare (type stream stream) (ignore arg2))
(ecase operation
(:listen
;; Return T if input available, :EOF for end-of-file, otherwise NIL.
(let ((char (read-char-no-hang stream nil :eof)))
(when (characterp char)
(unread-char char stream))
char))
(:unread
(unread-char arg1 stream))
(:close
(close stream))
(:clear-input
(clear-input stream))
(:force-output
(force-output stream))
(:finish-output
(finish-output stream))
(:element-type
(stream-element-type stream))
(:stream-external-format
(stream-external-format stream))
(:interactive-p
(interactive-stream-p stream))
(:line-length
(line-length stream))
(:charpos
(charpos stream))
(:file-length
(file-length stream))
(:file-string-length
(file-string-length stream arg1))
(:file-position
(file-position stream arg1))))
;;;; broadcast streams
(defstruct (broadcast-stream (:include ansi-stream
(out #'broadcast-out)
(bout #'broadcast-bout)
(sout #'broadcast-sout)
(misc #'broadcast-misc))
(:constructor %make-broadcast-stream
(&rest streams))
(:copier nil))
;; a list of all the streams we broadcast to
(streams () :type list :read-only t))
(defun make-broadcast-stream (&rest streams)
(dolist (stream streams)
(unless (output-stream-p stream)
(error 'type-error
:datum stream
:expected-type '(satisfies output-stream-p))))
(apply #'%make-broadcast-stream streams))
(macrolet ((out-fun (name fun &rest args)
`(defun ,name (stream ,@args)
(dolist (stream (broadcast-stream-streams stream))
(,fun ,(car args) stream ,@(cdr args))))))
(out-fun broadcast-out write-char char)
(out-fun broadcast-bout write-byte byte)
(out-fun broadcast-sout write-string-no-key string start end))
(defun broadcast-misc (stream operation &optional arg1 arg2)
(let ((streams (broadcast-stream-streams stream)))
(case operation
;; FIXME: This may not be the best place to note this, but I
;; think the :CHARPOS protocol needs revision. Firstly, I think
;; this is the last place where a NULL return value was possible
;; (before adjusting it to be 0), so a bunch of conditionals IF
;; CHARPOS can be removed; secondly, it is my belief that
;; FD-STREAMS, when running FILE-POSITION, do not update the
;; CHARPOS, and consequently there will be much wrongness.
;;
;; FIXME: see also TWO-WAY-STREAM treatment of :CHARPOS -- why
;; is it testing the :charpos of an input stream?
;;
;; -- CSR, 2004-02-04
(:charpos
(dolist (stream streams 0)
(let ((charpos (charpos stream)))
(if charpos (return charpos)))))
(:line-length
(let ((min nil))
(dolist (stream streams min)
(let ((res (line-length stream)))
(when res (setq min (if min (min res min) res)))))))
(:element-type
#+nil ; old, arguably more logical, version
(let (res)
(dolist (stream streams (if (> (length res) 1) `(and ,@res) t))
(pushnew (stream-element-type stream) res :test #'equal)))
;; ANSI-specified version (under System Class BROADCAST-STREAM)
(let ((res t))
(do ((streams streams (cdr streams)))
((null streams) res)
(when (null (cdr streams))
(setq res (stream-element-type (car streams)))))))
(:external-format
(let ((res :default))
(dolist (stream streams res)
(setq res (stream-external-format stream)))))
(:file-length
(let ((last (last streams)))
(if last
(file-length (car last))
0)))
(:file-position
(if arg1
(let ((res (or (eql arg1 :start) (eql arg1 0))))
(dolist (stream streams res)
(setq res (file-position stream arg1))))
(let ((res 0))
(dolist (stream streams res)
(setq res (file-position stream))))))
(:file-string-length
(let ((res 1))
(dolist (stream streams res)
(setq res (file-string-length stream arg1)))))
(:close
(set-closed-flame stream))
(t
(let ((res nil))
(dolist (stream streams res)
(setq res
(if (ansi-stream-p stream)
(funcall (ansi-stream-misc stream) stream operation
arg1 arg2)
(stream-misc-dispatch stream operation arg1 arg2)))))))))
;;;; synonym streams
(defstruct (synonym-stream (:include ansi-stream
(in #'synonym-in)
(bin #'synonym-bin)
(n-bin #'synonym-n-bin)
(out #'synonym-out)
(bout #'synonym-bout)
(sout #'synonym-sout)
(misc #'synonym-misc))
(:constructor make-synonym-stream (symbol))
(:copier nil))
;; This is the symbol, the value of which is the stream we are synonym to.
(symbol nil :type symbol :read-only t))
(def!method print-object ((x synonym-stream) stream)
(print-unreadable-object (x stream :type t :identity t)
(format stream ":SYMBOL ~S" (synonym-stream-symbol x))))
;;; The output simple output methods just call the corresponding
;;; function on the synonymed stream.
(macrolet ((out-fun (name fun &rest args)
`(defun ,name (stream ,@args)
(declare (optimize (safety 1)))
(let ((syn (symbol-value (synonym-stream-symbol stream))))
(,fun ,(car args) syn ,@(cdr args))))))
(out-fun synonym-out write-char ch)
(out-fun synonym-bout write-byte n)
(out-fun synonym-sout write-string-no-key string start end))
;;; For the input methods, we just call the corresponding function on the
;;; synonymed stream. These functions deal with getting input out of
;;; the In-Buffer if there is any.
(macrolet ((in-fun (name fun &rest args)
`(defun ,name (stream ,@args)
(declare (optimize (safety 1)))
(,fun (symbol-value (synonym-stream-symbol stream))
,@args))))
(in-fun synonym-in read-char eof-error-p eof-value)
(in-fun synonym-bin read-byte eof-error-p eof-value)
(in-fun synonym-n-bin read-n-bytes buffer start numbytes eof-error-p))
(defun synonym-misc (stream operation &optional arg1 arg2)
(declare (optimize (safety 1)))
(let ((syn (symbol-value (synonym-stream-symbol stream))))
(if (ansi-stream-p syn)
;; We have to special-case some operations which interact with
;; the in-buffer of the wrapped stream, since just calling
;; ANSI-STREAM-MISC on them
(case operation
(:listen (or (/= (the fixnum (ansi-stream-in-index syn))
+ansi-stream-in-buffer-length+)
(funcall (ansi-stream-misc syn) syn :listen)))
(:clear-input (clear-input syn))
(:unread (unread-char arg1 syn))
(t
(funcall (ansi-stream-misc syn) syn operation arg1 arg2)))
(stream-misc-dispatch syn operation arg1 arg2))))
;;;; two-way streams
(defstruct (two-way-stream
(:include ansi-stream
(in #'two-way-in)
(bin #'two-way-bin)
(n-bin #'two-way-n-bin)
(out #'two-way-out)
(bout #'two-way-bout)
(sout #'two-way-sout)
(misc #'two-way-misc))
(:constructor %make-two-way-stream (input-stream output-stream))
(:copier nil))
(input-stream (missing-arg) :type stream :read-only t)
(output-stream (missing-arg) :type stream :read-only t))
(defprinter (two-way-stream) input-stream output-stream)
(defun make-two-way-stream (input-stream output-stream)
#!+sb-doc
"Return a bidirectional stream which gets its input from INPUT-STREAM and
sends its output to OUTPUT-STREAM."
;; FIXME: This idiom of the-real-stream-of-a-possibly-synonym-stream
;; should be encapsulated in a function, and used here and most of
;; the other places that SYNONYM-STREAM-P appears.
(unless (output-stream-p output-stream)
(error 'type-error
:datum output-stream
:expected-type '(satisfies output-stream-p)))
(unless (input-stream-p input-stream)
(error 'type-error
:datum input-stream
:expected-type '(satisfies input-stream-p)))
(funcall #'%make-two-way-stream input-stream output-stream))
(macrolet ((out-fun (name fun &rest args)
`(defun ,name (stream ,@args)
(let ((syn (two-way-stream-output-stream stream)))
(,fun ,(car args) syn ,@(cdr args))))))
(out-fun two-way-out write-char ch)
(out-fun two-way-bout write-byte n)
(out-fun two-way-sout write-string-no-key string start end))
(macrolet ((in-fun (name fun &rest args)
`(defun ,name (stream ,@args)
(,fun (two-way-stream-input-stream stream) ,@args))))
(in-fun two-way-in read-char eof-error-p eof-value)
(in-fun two-way-bin read-byte eof-error-p eof-value)
(in-fun two-way-n-bin read-n-bytes buffer start numbytes eof-error-p))
(defun two-way-misc (stream operation &optional arg1 arg2)
(let* ((in (two-way-stream-input-stream stream))
(out (two-way-stream-output-stream stream))
(in-ansi-stream-p (ansi-stream-p in))
(out-ansi-stream-p (ansi-stream-p out)))
(case operation
(:listen
(if in-ansi-stream-p
(or (/= (the fixnum (ansi-stream-in-index in))
+ansi-stream-in-buffer-length+)
(funcall (ansi-stream-misc in) in :listen))
(listen in)))
((:finish-output :force-output :clear-output)
(if out-ansi-stream-p
(funcall (ansi-stream-misc out) out operation arg1 arg2)
(stream-misc-dispatch out operation arg1 arg2)))
(:clear-input (clear-input in))
(:unread (unread-char arg1 in))
(:element-type
(let ((in-type (stream-element-type in))
(out-type (stream-element-type out)))
(if (equal in-type out-type)
in-type `(and ,in-type ,out-type))))
(:close
(set-closed-flame stream))
(t
(or (if in-ansi-stream-p
(funcall (ansi-stream-misc in) in operation arg1 arg2)
(stream-misc-dispatch in operation arg1 arg2))
(if out-ansi-stream-p
(funcall (ansi-stream-misc out) out operation arg1 arg2)
(stream-misc-dispatch out operation arg1 arg2)))))))
;;;; concatenated streams
(defstruct (concatenated-stream
(:include ansi-stream
(in #'concatenated-in)
(bin #'concatenated-bin)
(n-bin #'concatenated-n-bin)
(misc #'concatenated-misc))
(:constructor %make-concatenated-stream (&rest streams))
(:copier nil))
;; The car of this is the substream we are reading from now.
(streams nil :type list))
(def!method print-object ((x concatenated-stream) stream)
(print-unreadable-object (x stream :type t :identity t)
(format stream
":STREAMS ~S"
(concatenated-stream-streams x))))
(defun make-concatenated-stream (&rest streams)
#!+sb-doc
"Return a stream which takes its input from each of the streams in turn,
going on to the next at EOF."
(dolist (stream streams)
(unless (input-stream-p stream)
(error 'type-error
:datum stream
:expected-type '(satisfies input-stream-p))))
(apply #'%make-concatenated-stream streams))
(macrolet ((in-fun (name fun)
`(defun ,name (stream eof-error-p eof-value)
(do ((streams (concatenated-stream-streams stream)
(cdr streams)))
((null streams)
(eof-or-lose stream eof-error-p eof-value))
(let* ((stream (car streams))
(result (,fun stream nil nil)))
(when result (return result)))
(pop (concatenated-stream-streams stream))))))
(in-fun concatenated-in read-char)
(in-fun concatenated-bin read-byte))
(defun concatenated-n-bin (stream buffer start numbytes eof-errorp)
(do ((streams (concatenated-stream-streams stream) (cdr streams))
(current-start start)
(remaining-bytes numbytes))
((null streams)
(if eof-errorp
(error 'end-of-file :stream stream)
(- numbytes remaining-bytes)))
(let* ((stream (car streams))
(bytes-read (read-n-bytes stream buffer current-start
remaining-bytes nil)))
(incf current-start bytes-read)
(decf remaining-bytes bytes-read)
(when (zerop remaining-bytes) (return numbytes)))
(setf (concatenated-stream-streams stream) (cdr streams))))
(defun concatenated-misc (stream operation &optional arg1 arg2)
(let* ((left (concatenated-stream-streams stream))
(current (car left)))
(case operation
(:listen
(unless left
(return-from concatenated-misc :eof))
(loop
(let ((stuff (if (ansi-stream-p current)
(funcall (ansi-stream-misc current) current
:listen)
(stream-misc-dispatch current :listen))))
(cond ((eq stuff :eof)
;; Advance STREAMS, and try again.
(pop (concatenated-stream-streams stream))
(setf current
(car (concatenated-stream-streams stream)))
(unless current
;; No further streams. EOF.
(return :eof)))
(stuff
;; Stuff's available.
(return t))
(t
;; Nothing is available yet.
(return nil))))))
(:clear-input (when left (clear-input current)))
(:unread (when left (unread-char arg1 current)))
(:close
(set-closed-flame stream))
(t
(when left
(if (ansi-stream-p current)
(funcall (ansi-stream-misc current) current operation arg1 arg2)
(stream-misc-dispatch current operation arg1 arg2)))))))
;;;; echo streams
(defstruct (echo-stream
(:include two-way-stream
(in #'echo-in)
(bin #'echo-bin)
(misc #'echo-misc)
(n-bin #'echo-n-bin))
(:constructor %make-echo-stream (input-stream output-stream))
(:copier nil))
(unread-stuff nil :type boolean))
(def!method print-object ((x echo-stream) stream)
(print-unreadable-object (x stream :type t :identity t)
(format stream
":INPUT-STREAM ~S :OUTPUT-STREAM ~S"
(two-way-stream-input-stream x)
(two-way-stream-output-stream x))))
(defun make-echo-stream (input-stream output-stream)
#!+sb-doc
"Return a bidirectional stream which gets its input from INPUT-STREAM and
sends its output to OUTPUT-STREAM. In addition, all input is echoed to
the output stream."
(unless (output-stream-p output-stream)
(error 'type-error
:datum output-stream
:expected-type '(satisfies output-stream-p)))
(unless (input-stream-p input-stream)
(error 'type-error
:datum input-stream
:expected-type '(satisfies input-stream-p)))
(funcall #'%make-echo-stream input-stream output-stream))
(macrolet ((in-fun (name in-fun out-fun &rest args)
`(defun ,name (stream ,@args)
(let* ((unread-stuff-p (echo-stream-unread-stuff stream))
(in (echo-stream-input-stream stream))
(out (echo-stream-output-stream stream))
(result (if eof-error-p
(,in-fun in ,@args)
(,in-fun in nil in))))
(setf (echo-stream-unread-stuff stream) nil)
(cond
((eql result in) eof-value)
;; If unread-stuff was true, the character read
;; from the input stream was previously echoed.
(t (unless unread-stuff-p (,out-fun result out)) result))))))
(in-fun echo-in read-char write-char eof-error-p eof-value)
(in-fun echo-bin read-byte write-byte eof-error-p eof-value))
(defun echo-n-bin (stream buffer start numbytes eof-error-p)
(let ((bytes-read 0))
;; Note: before ca 1.0.27.18, the logic for handling unread
;; characters never could have worked, so probably nobody has ever
;; tried doing bivalent block I/O through an echo stream; this may
;; not work either.
(when (echo-stream-unread-stuff stream)
(let* ((char (read-char stream))
(octets (string-to-octets
(string char)
:external-format
(stream-external-format
(echo-stream-input-stream stream))))
(octet-count (length octets))
(blt-count (min octet-count numbytes)))
(replace buffer octets :start1 start :end1 (+ start blt-count))
(incf start blt-count)
(decf numbytes blt-count)))
(incf bytes-read (read-n-bytes (echo-stream-input-stream stream) buffer
start numbytes nil))
(cond
((not eof-error-p)
(write-sequence buffer (echo-stream-output-stream stream)
:start start :end (+ start bytes-read))
bytes-read)
((> numbytes bytes-read)
(write-sequence buffer (echo-stream-output-stream stream)
:start start :end (+ start bytes-read))
(error 'end-of-file :stream stream))
(t
(write-sequence buffer (echo-stream-output-stream stream)
:start start :end (+ start bytes-read))
(aver (= numbytes (+ start bytes-read)))
numbytes))))
;;;; STRING-INPUT-STREAM stuff
(defstruct (string-input-stream
(:include ansi-stream
(in #'string-inch)
(bin #'ill-bin)
(n-bin #'ill-bin)
(misc #'string-in-misc))
(:constructor internal-make-string-input-stream
(string current end))
(:copier nil))
(string (missing-arg) :type simple-string)
(current (missing-arg) :type index)
(end (missing-arg) :type index))
(defun string-inch (stream eof-error-p eof-value)
(declare (type string-input-stream stream))
(let ((string (string-input-stream-string stream))
(index (string-input-stream-current stream)))
(cond ((>= index (the index (string-input-stream-end stream)))
(eof-or-lose stream eof-error-p eof-value))
(t
(setf (string-input-stream-current stream) (1+ index))
(char string index)))))
(defun string-binch (stream eof-error-p eof-value)
(declare (type string-input-stream stream))
(let ((string (string-input-stream-string stream))
(index (string-input-stream-current stream)))
(cond ((>= index (the index (string-input-stream-end stream)))
(eof-or-lose stream eof-error-p eof-value))
(t
(setf (string-input-stream-current stream) (1+ index))
(char-code (char string index))))))
(defun string-stream-read-n-bytes (stream buffer start requested eof-error-p)
(declare (type string-input-stream stream)
(type index start requested))
(let* ((string (string-input-stream-string stream))
(index (string-input-stream-current stream))
(available (- (string-input-stream-end stream) index))
(copy (min available requested)))
(declare (type simple-string string))
(when (plusp copy)
(setf (string-input-stream-current stream)
(truly-the index (+ index copy)))
;; FIXME: why are we VECTOR-SAP'ing things here? what's the point?
;; and are there SB-UNICODE issues here as well? --njf, 2005-03-24
(with-pinned-objects (string buffer)
(system-area-ub8-copy (vector-sap string)
index
(if (typep buffer 'system-area-pointer)
buffer
(vector-sap buffer))
start
copy)))
(if (and (> requested copy) eof-error-p)
(error 'end-of-file :stream stream)
copy)))
(defun string-in-misc (stream operation &optional arg1 arg2)
(declare (type string-input-stream stream)
(ignore arg2))
(case operation
(:file-position
(if arg1
(setf (string-input-stream-current stream)
(case arg1
(:start 0)
(:end (string-input-stream-end stream))
;; We allow moving position beyond EOF. Errors happen
;; on read, not move -- or the user may extend the
;; input string.
(t arg1)))
(string-input-stream-current stream)))
;; According to ANSI: "Should signal an error of type type-error
;; if stream is not a stream associated with a file."
;; This is checked by FILE-LENGTH, so no need to do it here either.
;; (:file-length (length (string-input-stream-string stream)))
(:unread (decf (string-input-stream-current stream)))
(:close (set-closed-flame stream))
(:listen (or (/= (the index (string-input-stream-current stream))
(the index (string-input-stream-end stream)))
:eof))
(:element-type (array-element-type (string-input-stream-string stream)))))
(defun make-string-input-stream (string &optional (start 0) end)
#!+sb-doc
"Return an input stream which will supply the characters of STRING between
START and END in order."
(declare (type string string)
(type index start)
(type (or index null) end))
(let* ((string (coerce string '(simple-array character (*)))))
;; FIXME: Why WITH-ARRAY-DATA, since the array is already simple?
(with-array-data ((string string) (start start) (end end))
(internal-make-string-input-stream
string ;; now simple
start
end))))
;;;; STRING-OUTPUT-STREAM stuff
;;;;
;;;; FIXME: This, like almost none of the stream code is particularly
;;;; interrupt or thread-safe. While it should not be possible to
;;;; corrupt the heap here, it certainly is possible to end up with
;;;; a string-output-stream whose internal state is messed up.
;;;;
;;;; FIXME: It would be nice to support space-efficient
;;;; string-output-streams with element-type base-char. This would
;;;; mean either a separate subclass, or typecases in functions.
(defparameter *string-output-stream-buffer-initial-size* 64)
#!-sb-fluid
(declaim (inline string-output-string-stream-buffer
string-output-string-stream-pointer
string-output-string-stream-index))
(defstruct (string-output-stream
(:include ansi-stream
(out #'string-ouch)
(sout #'string-sout)
(misc #'string-out-misc))
(:constructor make-string-output-stream
(&key (element-type 'character)
&aux (buffer
(make-string
*string-output-stream-buffer-initial-size*))))
(:copier nil))
;; The string we throw stuff in.
(buffer (missing-arg) :type (simple-array character (*)))
;; Chains of buffers to use
(prev nil :type list)
(next nil :type list)
;; Index of the next location to use in the current string.
(pointer 0 :type index)
;; Global location in the stream
(index 0 :type index)
;; Index cache: when we move backwards we save the greater of this
;; and index here, so the greater of index and this is always the
;; end of the stream.
(index-cache 0 :type index)
;; Requested element type
(element-type 'character :type type-specifier))
#!+sb-doc
(setf (fdocumentation 'make-string-output-stream 'function)
"Return an output stream which will accumulate all output given it for the
benefit of the function GET-OUTPUT-STREAM-STRING.")
;;; Pushes the current segment onto the prev-list, and either pops
;;; or allocates a new one.
(defun string-output-stream-new-buffer (stream size)
(declare (index size))
(/show0 "/string-output-stream-new-buffer")
(push (string-output-stream-buffer stream)
(string-output-stream-prev stream))
(setf (string-output-stream-buffer stream)
(or (pop (string-output-stream-next stream))
;; FIXME: This would be the correct place to detect that
;; more then FIXNUM characters are being written to the
;; stream, and do something about it.
(make-string size))))
;;; Moves to the end of the next segment or the current one if there are
;;; no more segments. Returns true as long as there are next segments.
(defun string-output-stream-next-buffer (stream)
(/show0 "/string-output-stream-next-buffer")
(let* ((old (string-output-stream-buffer stream))
(new (pop (string-output-stream-next stream)))
(old-size (length old))
(skipped (- old-size (string-output-stream-pointer stream))))
(cond (new
(let ((new-size (length new)))
(push old (string-output-stream-prev stream))
(setf (string-output-stream-buffer stream) new
(string-output-stream-pointer stream) new-size)
(incf (string-output-stream-index stream) (+ skipped new-size)))
t)
(t
(setf (string-output-stream-pointer stream) old-size)
(incf (string-output-stream-index stream) skipped)
nil))))
;;; Moves to the start of the previous segment or the current one if there
;;; are no more segments. Returns true as long as there are prev segments.
(defun string-output-stream-prev-buffer (stream)
(/show0 "/string-output-stream-prev-buffer")
(let ((old (string-output-stream-buffer stream))
(new (pop (string-output-stream-prev stream)))
(skipped (string-output-stream-pointer stream)))
(cond (new
(push old (string-output-stream-next stream))
(setf (string-output-stream-buffer stream) new
(string-output-stream-pointer stream) 0)
(decf (string-output-stream-index stream) (+ skipped (length new)))
t)
(t
(setf (string-output-stream-pointer stream) 0)
(decf (string-output-stream-index stream) skipped)
nil))))
(defun string-ouch (stream character)
(/show0 "/string-ouch")
(let ((pointer (string-output-stream-pointer stream))
(buffer (string-output-stream-buffer stream))
(index (string-output-stream-index stream)))
(cond ((= pointer (length buffer))
(setf buffer (string-output-stream-new-buffer stream index)
(aref buffer 0) character
(string-output-stream-pointer stream) 1))
(t
(setf (aref buffer pointer) character
(string-output-stream-pointer stream) (1+ pointer))))
(setf (string-output-stream-index stream) (1+ index))))
(defun string-sout (stream string start end)
(declare (type simple-string string)
(type index start end))
(let* ((full-length (- end start))
(length full-length)
(buffer (string-output-stream-buffer stream))
(pointer (string-output-stream-pointer stream))
(space (- (length buffer) pointer))
(here (min space length))
(stop (+ start here))
(overflow (- length space)))
(declare (index length space here stop full-length)
(fixnum overflow)
(type (simple-array character (*)) buffer))
(tagbody
:more
(when (plusp here)
(etypecase string
((simple-array character (*))
(replace buffer string :start1 pointer :start2 start :end2 stop))
(simple-base-string
(replace buffer string :start1 pointer :start2 start :end2 stop))
((simple-array nil (*))
(replace buffer string :start1 pointer :start2 start :end2 stop)))
(setf (string-output-stream-pointer stream) (+ here pointer)))
(when (plusp overflow)
(setf start stop
length (- end start)
buffer (string-output-stream-new-buffer
stream (max overflow (string-output-stream-index stream)))
pointer 0
space (length buffer)
here (min space length)
stop (+ start here)
;; there may be more overflow if we used a buffer
;; already allocated to the stream
overflow (- length space))
(go :more)))
(incf (string-output-stream-index stream) full-length)))
;;; Factored out of the -misc method due to size.
(defun set-string-output-stream-file-position (stream pos)
(let* ((index (string-output-stream-index stream))
(end (max index (string-output-stream-index-cache stream))))
(declare (index index end))
(setf (string-output-stream-index-cache stream) end)
(cond ((eq :start pos)
(loop while (string-output-stream-prev-buffer stream)))
((eq :end pos)
(loop while (string-output-stream-next-buffer stream))
(let ((over (- (string-output-stream-index stream) end)))
(decf (string-output-stream-pointer stream) over))
(setf (string-output-stream-index stream) end))
((< pos index)
(loop while (< pos index)
do (string-output-stream-prev-buffer stream)
(setf index (string-output-stream-index stream)))
(let ((step (- pos index)))
(incf (string-output-stream-pointer stream) step)
(setf (string-output-stream-index stream) pos)))
((> pos index)
;; We allow moving beyond the end of stream, implicitly
;; extending the output stream.
(let ((next (string-output-stream-next-buffer stream)))
;; Update after -next-buffer, INDEX is kept pointing at
;; the end of the current buffer.
(setf index (string-output-stream-index stream))
(loop while (and next (> pos index))
do (setf next (string-output-stream-next-buffer stream)
index (string-output-stream-index stream))))
;; Allocate new buffer if needed, or step back to
;; the desired index and set pointer and index
;; correctly.
(let ((diff (- pos index)))
(if (plusp diff)
(let* ((new (string-output-stream-new-buffer stream diff))
(size (length new)))
(aver (= pos (+ index size)))
(setf (string-output-stream-pointer stream) size
(string-output-stream-index stream) pos))
(let ((size (length (string-output-stream-buffer stream))))
(setf (string-output-stream-pointer stream) (+ size diff)
(string-output-stream-index stream) pos))))))))
(defun string-out-misc (stream operation &optional arg1 arg2)
(declare (ignore arg2))
(declare (optimize speed))
(case operation
(:charpos
;; Keeping this first is a silly micro-optimization: FRESH-LINE
;; makes this the most common one.
(/show0 "/string-out-misc charpos")
(prog ((pointer (string-output-stream-pointer stream))
(buffer (string-output-stream-buffer stream))
(prev (string-output-stream-prev stream))
(base 0))
(declare (type (or null (simple-array character (*))) buffer))
:next
(let ((pos (when buffer
(position #\newline buffer :from-end t :end pointer))))
(when (or pos (not buffer))
;; If newline is at index I, and pointer at index I+N, charpos
;; is N-1. If there is no newline, and pointer is at index N,
;; charpos is N.
(return (+ base (if pos (- pointer pos 1) pointer))))
(setf base (+ base pointer)
buffer (pop prev)
pointer (length buffer))
(/show0 "/string-out-misc charpos next")
(go :next))))
(:file-position
(/show0 "/string-out-misc file-position")
(when arg1
(set-string-output-stream-file-position stream arg1))
(string-output-stream-index stream))
(:close
(/show0 "/string-out-misc close")
(set-closed-flame stream))
(:element-type (string-output-stream-element-type stream))))
;;; Return a string of all the characters sent to a stream made by
;;; MAKE-STRING-OUTPUT-STREAM since the last call to this function.
(defun get-output-stream-string (stream)
(declare (type string-output-stream stream))
(let* ((length (max (string-output-stream-index stream)
(string-output-stream-index-cache stream)))
(element-type (string-output-stream-element-type stream))
(prev (nreverse (string-output-stream-prev stream)))
(this (string-output-stream-buffer stream))
(next (string-output-stream-next stream))
(result
(case element-type
;; overwhelmingly common case: can be inlined
;;
;; FIXME: If we were willing to use %SHRINK-VECTOR here,
;; and allocate new strings the size of 2 * index in
;; STRING-SOUT, we would not need to allocate one here in
;; the common case, but could just use the last one
;; allocated, and chop it down to size..
;;
((character) (make-string length))
;; slightly less common cases: inline it anyway
((base-char standard-char)
(make-string length :element-type 'base-char))
(t
(make-string length :element-type element-type)))))
(setf (string-output-stream-index stream) 0
(string-output-stream-index-cache stream) 0
(string-output-stream-pointer stream) 0
;; throw them away for simplicity's sake: this way the rest of the
;; implementation can assume that the greater of INDEX and INDEX-CACHE
;; is always within the last buffer.
(string-output-stream-prev stream) nil
(string-output-stream-next stream) nil)
(flet ((replace-all (fun)
(let ((start 0))
(declare (index start))
(dolist (buffer prev)
(funcall fun buffer start)
(incf start (length buffer)))
(funcall fun this start)
(incf start (length this))
(dolist (buffer next)
(funcall fun buffer start)
(incf start (length buffer)))
;; Hack: erase the pointers to strings, to make it less
;; likely that the conservative GC will accidentally
;; retain the buffers.
(fill prev nil)
(fill next nil))))
(macrolet ((frob (type)
`(replace-all (lambda (buffer from)
(declare (type ,type result)
(type (simple-array character (*))
buffer))
(replace result buffer :start1 from)))))
(etypecase result
((simple-array character (*))
(frob (simple-array character (*))))
(simple-base-string
(frob simple-base-string))
((simple-array nil (*))
(frob (simple-array nil (*)))))))
result))
;;;; fill-pointer streams
;;; Fill pointer STRING-OUTPUT-STREAMs are not explicitly mentioned in
;;; the CLM, but they are required for the implementation of
;;; WITH-OUTPUT-TO-STRING.
;;; FIXME: need to support (VECTOR NIL), ideally without destroying all hope
;;; of efficiency.
(declaim (inline vector-with-fill-pointer))
(defun vector-with-fill-pointer-p (x)
(and (vectorp x)
(array-has-fill-pointer-p x)))
(deftype string-with-fill-pointer ()
`(and (or (vector character) (vector base-char))
(satisfies vector-with-fill-pointer-p)))
(defstruct (fill-pointer-output-stream
(:include ansi-stream
(out #'fill-pointer-ouch)
(sout #'fill-pointer-sout)
(misc #'fill-pointer-misc))
(:constructor make-fill-pointer-output-stream (string))
(:copier nil))
;; a string with a fill pointer where we stuff the stuff we write
(string (missing-arg) :type string-with-fill-pointer :read-only t))
(defun fill-pointer-ouch (stream character)
(let* ((buffer (fill-pointer-output-stream-string stream))
(current (fill-pointer buffer))
(current+1 (1+ current)))
(declare (fixnum current))
(with-array-data ((workspace buffer) (start) (end))
(string-dispatch
((simple-array character (*))
(simple-array base-char (*)))
workspace
(let ((offset-current (+ start current)))
(declare (fixnum offset-current))
(if (= offset-current end)
(let* ((new-length (1+ (* current 2)))
(new-workspace
(ecase (array-element-type workspace)
(character (make-string new-length
:element-type 'character))
(base-char (make-string new-length
:element-type 'base-char)))))
(replace new-workspace workspace :start2 start :end2 offset-current)
(setf workspace new-workspace
offset-current current)
(set-array-header buffer workspace new-length
current+1 0 new-length nil nil))
(setf (fill-pointer buffer) current+1))
(setf (char workspace offset-current) character))))
current+1))
(defun fill-pointer-sout (stream string start end)
(declare (fixnum start end))
(string-dispatch
((simple-array character (*))
(simple-array base-char (*)))
string
(let* ((buffer (fill-pointer-output-stream-string stream))
(current (fill-pointer buffer))
(string-len (- end start))
(dst-end (+ string-len current)))
(declare (fixnum current dst-end string-len))
(with-array-data ((workspace buffer) (dst-start) (dst-length))
(let ((offset-dst-end (+ dst-start dst-end))
(offset-current (+ dst-start current)))
(declare (fixnum offset-dst-end offset-current))
(if (> offset-dst-end dst-length)
(let* ((new-length (+ (the fixnum (* current 2)) string-len))
(new-workspace
(ecase (array-element-type workspace)
(character (make-string new-length
:element-type 'character))
(base-char (make-string new-length
:element-type 'base-char)))))
(replace new-workspace workspace
:start2 dst-start :end2 offset-current)
(setf workspace new-workspace
offset-current current
offset-dst-end dst-end)
(set-array-header buffer workspace new-length
dst-end 0 new-length nil nil))
(setf (fill-pointer buffer) dst-end))
(replace workspace string
:start1 offset-current :start2 start :end2 end)))
dst-end)))
(defun fill-pointer-misc (stream operation &optional arg1 arg2)
(declare (ignore arg2))
(case operation
(:file-position
(let ((buffer (fill-pointer-output-stream-string stream)))
(if arg1
(setf (fill-pointer buffer)
(case arg1
(:start 0)
;; Fill-pointer is always at fill-pointer we will
;; make :END move to the end of the actual string.
(:end (array-total-size buffer))
;; We allow moving beyond the end of string if the
;; string is adjustable.
(t (when (>= arg1 (array-total-size buffer))
(if (adjustable-array-p buffer)
(adjust-array buffer arg1)
(error "Cannot move FILE-POSITION beyond the end ~
of WITH-OUTPUT-TO-STRING stream ~
constructed with non-adjustable string.")))
arg1)))
(fill-pointer buffer))))
(:charpos
(let* ((buffer (fill-pointer-output-stream-string stream))
(current (fill-pointer buffer)))
(with-array-data ((string buffer) (start) (end current))
(declare (simple-string string) (ignore start))
(let ((found (position #\newline string :test #'char=
:end end :from-end t)))
(if found
(- end (the fixnum found))
current)))))
(:element-type
(array-element-type
(fill-pointer-output-stream-string stream)))))
;;;; case frobbing streams, used by FORMAT ~(...~)
(defstruct (case-frob-stream
(:include ansi-stream
(misc #'case-frob-misc))
(:constructor %make-case-frob-stream (target out sout))
(:copier nil))
(target (missing-arg) :type stream))
(defun make-case-frob-stream (target kind)
#!+sb-doc
"Return a stream that sends all output to the stream TARGET, but modifies
the case of letters, depending on KIND, which should be one of:
:UPCASE - convert to upper case.
:DOWNCASE - convert to lower case.
:CAPITALIZE - convert the first letter of words to upper case and the
rest of the word to lower case.
:CAPITALIZE-FIRST - convert the first letter of the first word to upper
case and everything else to lower case."
(declare (type stream target)
(type (member :upcase :downcase :capitalize :capitalize-first)
kind)
(values stream))
(if (case-frob-stream-p target)
;; If we are going to be writing to a stream that already does
;; case frobbing, why bother frobbing the case just so it can
;; frob it again?
target
(multiple-value-bind (out sout)
(ecase kind
(:upcase
(values #'case-frob-upcase-out
#'case-frob-upcase-sout))
(:downcase
(values #'case-frob-downcase-out
#'case-frob-downcase-sout))
(:capitalize
(values #'case-frob-capitalize-out
#'case-frob-capitalize-sout))
(:capitalize-first
(values #'case-frob-capitalize-first-out
#'case-frob-capitalize-first-sout)))
(%make-case-frob-stream target out sout))))
(defun case-frob-misc (stream op &optional arg1 arg2)
(declare (type case-frob-stream stream))
(case op
(:close
(set-closed-flame stream))
(t
(let ((target (case-frob-stream-target stream)))
(if (ansi-stream-p target)
(funcall (ansi-stream-misc target) target op arg1 arg2)
(stream-misc-dispatch target op arg1 arg2))))))
(defun case-frob-upcase-out (stream char)
(declare (type case-frob-stream stream)
(type character char))
(let ((target (case-frob-stream-target stream))
(char (char-upcase char)))
(if (ansi-stream-p target)
(funcall (ansi-stream-out target) target char)
(stream-write-char target char))))
(defun case-frob-upcase-sout (stream str start end)
(declare (type case-frob-stream stream)
(type simple-string str)
(type index start)
(type (or index null) end))
(let* ((target (case-frob-stream-target stream))
(len (length str))
(end (or end len))
(string (if (and (zerop start) (= len end))
(string-upcase str)
(nstring-upcase (subseq str start end))))
(string-len (- end start)))
(if (ansi-stream-p target)
(funcall (ansi-stream-sout target) target string 0 string-len)
(stream-write-string target string 0 string-len))))
(defun case-frob-downcase-out (stream char)
(declare (type case-frob-stream stream)
(type character char))
(let ((target (case-frob-stream-target stream))
(char (char-downcase char)))
(if (ansi-stream-p target)
(funcall (ansi-stream-out target) target char)
(stream-write-char target char))))
(defun case-frob-downcase-sout (stream str start end)
(declare (type case-frob-stream stream)
(type simple-string str)
(type index start)
(type (or index null) end))
(let* ((target (case-frob-stream-target stream))
(len (length str))
(end (or end len))
(string (if (and (zerop start) (= len end))
(string-downcase str)
(nstring-downcase (subseq str start end))))
(string-len (- end start)))
(if (ansi-stream-p target)
(funcall (ansi-stream-sout target) target string 0 string-len)
(stream-write-string target string 0 string-len))))
(defun case-frob-capitalize-out (stream char)
(declare (type case-frob-stream stream)
(type character char))
(let ((target (case-frob-stream-target stream)))
(cond ((alphanumericp char)
(let ((char (char-upcase char)))
(if (ansi-stream-p target)
(funcall (ansi-stream-out target) target char)
(stream-write-char target char)))
(setf (case-frob-stream-out stream) #'case-frob-capitalize-aux-out)
(setf (case-frob-stream-sout stream)
#'case-frob-capitalize-aux-sout))
(t
(if (ansi-stream-p target)
(funcall (ansi-stream-out target) target char)
(stream-write-char target char))))))
(defun case-frob-capitalize-sout (stream str start end)
(declare (type case-frob-stream stream)
(type simple-string str)
(type index start)
(type (or index null) end))
(let* ((target (case-frob-stream-target stream))
(str (subseq str start end))
(len (length str))
(inside-word nil))
(dotimes (i len)
(let ((char (schar str i)))
(cond ((not (alphanumericp char))
(setf inside-word nil))
(inside-word
(setf (schar str i) (char-downcase char)))
(t
(setf inside-word t)
(setf (schar str i) (char-upcase char))))))
(when inside-word
(setf (case-frob-stream-out stream)
#'case-frob-capitalize-aux-out)
(setf (case-frob-stream-sout stream)
#'case-frob-capitalize-aux-sout))
(if (ansi-stream-p target)
(funcall (ansi-stream-sout target) target str 0 len)
(stream-write-string target str 0 len))))
(defun case-frob-capitalize-aux-out (stream char)
(declare (type case-frob-stream stream)
(type character char))
(let ((target (case-frob-stream-target stream)))
(cond ((alphanumericp char)
(let ((char (char-downcase char)))
(if (ansi-stream-p target)
(funcall (ansi-stream-out target) target char)
(stream-write-char target char))))
(t
(if (ansi-stream-p target)
(funcall (ansi-stream-out target) target char)
(stream-write-char target char))
(setf (case-frob-stream-out stream)
#'case-frob-capitalize-out)
(setf (case-frob-stream-sout stream)
#'case-frob-capitalize-sout)))))
(defun case-frob-capitalize-aux-sout (stream str start end)
(declare (type case-frob-stream stream)
(type simple-string str)
(type index start)
(type (or index null) end))
(let* ((target (case-frob-stream-target stream))
(str (subseq str start end))
(len (length str))
(inside-word t))
(dotimes (i len)
(let ((char (schar str i)))
(cond ((not (alphanumericp char))
(setf inside-word nil))
(inside-word
(setf (schar str i) (char-downcase char)))
(t
(setf inside-word t)
(setf (schar str i) (char-upcase char))))))
(unless inside-word
(setf (case-frob-stream-out stream)
#'case-frob-capitalize-out)
(setf (case-frob-stream-sout stream)
#'case-frob-capitalize-sout))
(if (ansi-stream-p target)
(funcall (ansi-stream-sout target) target str 0 len)
(stream-write-string target str 0 len))))
(defun case-frob-capitalize-first-out (stream char)
(declare (type case-frob-stream stream)
(type character char))
(let ((target (case-frob-stream-target stream)))
(cond ((alphanumericp char)
(let ((char (char-upcase char)))
(if (ansi-stream-p target)
(funcall (ansi-stream-out target) target char)
(stream-write-char target char)))
(setf (case-frob-stream-out stream)
#'case-frob-downcase-out)
(setf (case-frob-stream-sout stream)
#'case-frob-downcase-sout))
(t
(if (ansi-stream-p target)
(funcall (ansi-stream-out target) target char)
(stream-write-char target char))))))
(defun case-frob-capitalize-first-sout (stream str start end)
(declare (type case-frob-stream stream)
(type simple-string str)
(type index start)
(type (or index null) end))
(let* ((target (case-frob-stream-target stream))
(str (subseq str start end))
(len (length str)))
(dotimes (i len)
(let ((char (schar str i)))
(when (alphanumericp char)
(setf (schar str i) (char-upcase char))
(do ((i (1+ i) (1+ i)))
((= i len))
(setf (schar str i) (char-downcase (schar str i))))
(setf (case-frob-stream-out stream)
#'case-frob-downcase-out)
(setf (case-frob-stream-sout stream)
#'case-frob-downcase-sout)
(return))))
(if (ansi-stream-p target)
(funcall (ansi-stream-sout target) target str 0 len)
(stream-write-string target str 0 len))))
;;;; READ-SEQUENCE
(defun read-sequence (seq stream &key (start 0) end)
#!+sb-doc
"Destructively modify SEQ by reading elements from STREAM.
That part of SEQ bounded by START and END is destructively modified by
copying successive elements into it from STREAM. If the end of file
for STREAM is reached before copying all elements of the subsequence,
then the extra elements near the end of sequence are not updated, and
the index of the next element is returned."
(declare (type sequence seq)
(type stream stream)
(type index start)
(type sequence-end end)
(values index))
(if (ansi-stream-p stream)
(ansi-stream-read-sequence seq stream start end)
;; must be Gray streams FUNDAMENTAL-STREAM
(stream-read-sequence stream seq start end)))
(declaim (inline compatible-vector-and-stream-element-types-p))
(defun compatible-vector-and-stream-element-types-p (vector stream)
(declare (type vector vector)
(type ansi-stream stream))
(or (and (typep vector '(simple-array (unsigned-byte 8) (*)))
(subtypep (stream-element-type stream) '(unsigned-byte 8)))
(and (typep vector '(simple-array (signed-byte 8) (*)))
(subtypep (stream-element-type stream) '(signed-byte 8)))))
(defun ansi-stream-read-sequence (seq stream start %end)
(declare (type sequence seq)
(type ansi-stream stream)
(type index start)
(type sequence-end %end)
(values index))
(let ((end (or %end (length seq))))
(declare (type index end))
(etypecase seq
(list
(let ((read-function
(if (subtypep (stream-element-type stream) 'character)
#'ansi-stream-read-char
#'ansi-stream-read-byte)))
(do ((rem (nthcdr start seq) (rest rem))
(i start (1+ i)))
((or (endp rem) (>= i end)) i)
(declare (type list rem)
(type index i))
(let ((el (funcall read-function stream nil :eof nil)))
(when (eq el :eof)
(return i))
(setf (first rem) el)))))
(vector
(with-array-data ((data seq) (offset-start start) (offset-end end)
:check-fill-pointer t)
(cond ((compatible-vector-and-stream-element-types-p data stream)
(let* ((numbytes (- end start))
(bytes-read (read-n-bytes stream data offset-start
numbytes nil)))
(if (< bytes-read numbytes)
(+ start bytes-read)
end)))
((and (ansi-stream-cin-buffer stream)
(typep seq 'simple-string))
(ansi-stream-read-string-from-frc-buffer seq stream
start %end))
(t
(let ((read-function
(if (subtypep (stream-element-type stream) 'character)
;; If the stream-element-type is CHARACTER,
;; this might be a bivalent stream. If the
;; sequence is a specialized unsigned-byte
;; vector, try to read use binary IO. It'll
;; signal an error if stream is an pure
;; character stream.
(if (subtypep (array-element-type data)
'unsigned-byte)
#'ansi-stream-read-byte
#'ansi-stream-read-char)
#'ansi-stream-read-byte)))
(do ((i offset-start (1+ i)))
((>= i offset-end) end)
(declare (type index i))
(let ((el (funcall read-function stream nil :eof nil)))
(when (eq el :eof)
(return (+ start (- i offset-start))))
(setf (aref data i) el)))))))))))
(defun ansi-stream-read-string-from-frc-buffer (seq stream start %end)
(declare (type simple-string seq)
(type ansi-stream stream)
(type index start)
(type (or null index) %end))
(let ((needed (- (or %end (length seq))
start))
(read 0))
(prepare-for-fast-read-char stream
(declare (ignore %frc-method%))
(unless %frc-buffer%
(return-from ansi-stream-read-string-from-frc-buffer nil))
(labels ((refill-buffer ()
(prog1
(fast-read-char-refill stream nil nil)
(setf %frc-index% (ansi-stream-in-index %frc-stream%))))
(add-chunk ()
(let* ((end (length %frc-buffer%))
(len (min (- end %frc-index%)
(- needed read))))
(declare (type index end len read needed))
(string-dispatch (simple-base-string
(simple-array character (*)))
seq
(replace seq %frc-buffer%
:start1 (+ start read)
:end1 (+ start read len)
:start2 %frc-index%
:end2 (+ %frc-index% len)))
(incf read len)
(incf %frc-index% len)
(when (or (eql needed read)
(refill-buffer))
(done-with-fast-read-char)
(return-from ansi-stream-read-string-from-frc-buffer
(+ start read))))))
(declare (inline refill-buffer))
(when (and (= %frc-index% +ansi-stream-in-buffer-length+)
(refill-buffer))
;; EOF had been reached before we read anything
;; at all. Return the EOF value or signal the error.
(done-with-fast-read-char)
(return-from ansi-stream-read-string-from-frc-buffer start))
(loop (add-chunk))))))
;;;; WRITE-SEQUENCE
(defun write-sequence (seq stream &key (start 0) (end nil))
#!+sb-doc
"Write the elements of SEQ bounded by START and END to STREAM."
(declare (type sequence seq)
(type stream stream)
(type index start)
(type sequence-end end)
(values sequence))
(if (ansi-stream-p stream)
(ansi-stream-write-sequence seq stream start end)
;; must be Gray-streams FUNDAMENTAL-STREAM
(stream-write-sequence stream seq start end)))
(defun ansi-stream-write-sequence (seq stream start %end)
(declare (type sequence seq)
(type ansi-stream stream)
(type index start)
(type sequence-end %end)
(values sequence))
(let ((end (or %end (length seq))))
(declare (type index end))
(etypecase seq
(list
(let ((write-function
(if (subtypep (stream-element-type stream) 'character)
(ansi-stream-out stream)
(ansi-stream-bout stream))))
(do ((rem (nthcdr start seq) (rest rem))
(i start (1+ i)))
((or (endp rem) (>= i end)))
(declare (type list rem)
(type index i))
(funcall write-function stream (first rem)))))
(string
(%write-string seq stream start end))
(vector
(with-array-data ((data seq) (offset-start start) (offset-end end)
:check-fill-pointer t)
(labels
((output-seq-in-loop ()
(let ((write-function
(if (subtypep (stream-element-type stream) 'character)
(lambda (stream object)
;; This might be a bivalent stream, so we need
;; to dispatch on a per-element basis, rather
;; than just based on the sequence or stream
;; element types.
(if (characterp object)
(funcall (ansi-stream-out stream)
stream object)
(funcall (ansi-stream-bout stream)
stream object)))
(ansi-stream-bout stream))))
(do ((i offset-start (1+ i)))
((>= i offset-end))
(declare (type index i))
(funcall write-function stream (aref data i))))))
(if (and (fd-stream-p stream)
(compatible-vector-and-stream-element-types-p data stream))
(buffer-output stream data offset-start offset-end)
(output-seq-in-loop)))))))
seq)
;;;; etc.