satx-core 0.12.1

HP 48/49 calculator layer of satx: Kermit and XModem driver loops, calculator operations, HP objects; blocking or sans-I/O (wasm32)
Documentation
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
//! What a user does with a calculator in Kermit server mode: list, change
//! directory, get, put, run host commands, fetch PICT, backup and restore.
//!
//! Everything is built from `C` host commands, `G D` listings, GET and SEND
//! (wiki: protocols/server-commands). A host command returns the whole stack
//! as display text and leaves its results on the user's stack, so every
//! internal query drops what it pushed. A failed command replies `Error: X`
//! (no E packet) and leaves its arguments on the stack. Evaluating an
//! undefined name pushes the name and evaluating a variable runs it, so names
//! are checked against the listing before they are evaluated.

use crate::time::Duration;

use kermit_proto::{Command, OutgoingFile};

use crate::charset::{decode, encode, encode_command};
use crate::grob::Grob;
#[cfg(not(target_arch = "wasm32"))]
use crate::link::{self, Link};
use crate::object::{HEADER_LEN, KERMIT_PADDING_ALLOWANCE, ObjectType, inspect};
use crate::object::{object_size, strip_padding, unpack};
use crate::reply::{Iopar, Listing, StackReply, parse_list, parse_listing, parse_real};
use crate::reply::{parse_name, parse_stack, parse_string, parse_whole_string};
use crate::session::KermitCore;
#[cfg(not(target_arch = "wasm32"))]
use crate::session::Session;
use crate::transport::BAUD;
#[cfg(not(target_arch = "wasm32"))]
use crate::transport::Transport;
use crate::xmodem::{
    XmodemDirection, XmodemPlan, eval_keys, program_text, server_again, stacked_program,
};
use crate::{Error, Result};

/// [`Calculator::iopar`]'s command: the user's flags saved and STD set
/// ([`CalcOps::drop_and_restore_flags`]), IOPAR's items, each a
/// short real, and their count on level 1. The list itself can be wider
/// than the 49G's display, which cuts each level at 20 characters (ROM
/// 1.18: `{ 9600. 0. 0. 0. 3. `) or 22 (2.x: `{9600.,0.,0.,0.,3.,1.}` just
/// fits, but not in FIX 4). `LIST→` fails on anything but a list and leaves
/// it on the stack. Every model has it.
const IOPAR_ITEMS: &str = "RCLF STD IOPAR LIST\u{2192}";
/// Drops what [`IOPAR_ITEMS`] pushed: `DROPN` takes LIST→'s count from
/// level 1 and drops that many items, whatever satx made of the reply;
/// `STOF` puts the flags back.
const IOPAR_DROP: &str = "DROPN STOF";
/// [`Calculator::mem`]'s command: the user's flags saved and STD set
/// ([`CalcOps::drop_and_restore_flags`]), then MEM.
const MEM_STD: &str = "RCLF STD MEM";
/// What [`VERSION_CHUNKS`] cuts into: 10 characters, 12 displayed with the
/// quotes, far below every model's display width.
const CHUNK: usize = 10;
/// With `VERSION`'s two strings on the stack (version on level 2,
/// copyright on level 1): the user's flags saved beneath them and STD
/// set ([`CalcOps::drop_and_restore_flags`]), the two joined cut into
/// [`CHUNK`]-character strings (first chunk deepest), and the joined
/// length on level 1. For the 49G, which cuts the two-line version string
/// at its display width (`"Version HP49-C\nRevi` on ROM 1.18, of the 29
/// characters `Version HP49-C\nRevision #1.18`). Where the two meet comes
/// from the string that arrived whole (the copyright, 19 characters with
/// its quotes). 70 bytes, one packet (77 at most): the version's length
/// does not fit in too.
const VERSION_CHUNKS: &str =
    "RCLF ROT ROT STD + 1 OVER SIZE FOR k DUP k k 9 + SUB SWAP 10 STEP SIZE";
/// Temporary variable for [`Calculator::pict`].
const PICT_VAR: &str = "SATXTMP";
/// Temporary variable and port-0 object for [`Calculator::backup`].
const BACKUP_VAR: &str = "SATXBK";
/// Temporary variable and port-0 object for [`Calculator::restore`].
pub const RESTORE_VAR: &str = "SATXRS";
/// Reply timeout for the final `RESTORE`, which never gets a reply (the
/// session's timeout when that is shorter).
const RESTORE_TIMEOUT: Duration = Duration::from_secs(3);
/// A NAK of a host command this soon after it went out is the calculator
/// rejecting it, not the idle server's NAK
/// (`Config::first_packet_nak_window`): a `C` of up to ~90 bytes takes
/// ~94 ms at 9600 baud, and the idle server NAKs once, a server timeout
/// after its last packet, and then stays silent (measured on Saturnus and
/// saturnng; real hardware unverified; wiki: protocols/server-commands), so
/// one that crosses the `C` lands inside 250 ms only by coincidence (the
/// residual risk, security.md invariant 6).
const HOST_NAK_WINDOW: Duration = Duration::from_millis(250);
/// Wait after such a NAK before the one resend it allows, unless an answer
/// (`S`, short reply or `E`) comes first (`Config::first_packet_nak_grace`; the
/// session's timeout when that is shorter).
const HOST_NAK_GRACE: Duration = Duration::from_secs(3);
/// One byte (10 bits) at the link's [`BAUD`]: a NAK sooner than the `C`'s
/// length times this after it went out cannot answer it
/// (`Config::first_packet_nak_byte_time`; ~10 ms for a short command).
const HOST_BYTE_TIME: Duration = Duration::from_nanos(10_000_000_000 / BAUD as u64);

/// Calculator model, as far as the ROM version text tells.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Model {
    /// HP 48S/SX: no `VERSION` command, no XModem.
    Hp48Sx,
    /// HP 48G/GX: `HP48-x, Copyright HP 1993`; XModem with checksum only.
    Hp48Gx,
    /// HP 49G: XModem with checksum, HP's CRC (`D`) and 1k blocks.
    Hp49G,
    /// HP 38G: no Kermit server; it is the Kermit client of a PC "disk
    /// drive", asking for `HP38DIR.CUR` first, and has no XModem (wiki:
    /// protocols/aplet-transfer).
    Hp38G,
    /// HP 39G and HP 40G, which run the same ROM and look the same on the
    /// wire: as the 38G with `HP39DIR.CUR`, and XModem for binary aplets
    /// ("HP39/40 (Wire)": 128-byte blocks, checksum).
    Hp39G,
    /// Anything else.
    Unknown,
}

impl Model {
    /// The model from the `VERSION` text ([`Calculator::version`]): `None`
    /// is the 48S/SX, which lacks the command; the 48G/GX says
    /// `HP48-R, Copyright HP 1993`; the 49G says `HP49-C Revision #1.18`
    /// (ROM 1.x) or `HP48-C Revision #2.15` (2.x) and is told apart by its
    /// copyright year (1999 or later) or an `HP49`.
    pub fn from_version(version: Option<&str>) -> Model {
        let Some(v) = version else {
            return Model::Hp48Sx;
        };
        let year = v
            .rsplit(|c: char| !c.is_ascii_digit())
            .find(|w| w.len() == 4)
            .and_then(|w| w.parse::<u32>().ok());
        if v.contains("HP49") || year.is_some_and(|y| y >= 1999) {
            Model::Hp49G
        } else if v.contains("HP48") {
            Model::Hp48Gx
        } else {
            Model::Unknown
        }
    }

    /// The model that asks a "disk drive" for directory file `name`:
    /// `HP38DIR.` (the 38G) or `HP39DIR.` (the 39G or 40G) and anything
    /// after, in any case; `None` for other names.
    pub fn from_directory_file(name: &[u8]) -> Option<Model> {
        let head = name.get(..8)?.to_ascii_uppercase();
        match head.as_slice() {
            b"HP38DIR." => Some(Model::Hp38G),
            b"HP39DIR." => Some(Model::Hp39G),
            _ => None,
        }
    }

    /// Display name, e.g. `HP 48G/GX`.
    pub fn name(self) -> &'static str {
        match self {
            Model::Hp48Sx => "HP 48S/SX",
            Model::Hp48Gx => "HP 48G/GX",
            Model::Hp49G => "HP 49G",
            Model::Hp38G => "HP 38G",
            Model::Hp39G => "HP 39G/40G",
            Model::Unknown => "unknown",
        }
    }

    /// Whether the model has XModem: `XRECV`/`XSEND` on the 48G/GX and
    /// 49G, "HP39/40 (Wire)" for aplets on the 39G and 40G (unknown models
    /// are given the benefit of the doubt).
    pub fn has_xmodem(self) -> bool {
        !matches!(self, Model::Hp48Sx | Model::Hp38G)
    }

    /// Whether the calculator drives every transfer as the Kermit client
    /// of a "disk drive" (the 38G, 39G and 40G), instead of running a
    /// Kermit server the computer drives.
    pub fn drives_transfers(self) -> bool {
        matches!(self, Model::Hp38G | Model::Hp39G)
    }
}

/// Kermit transfer format, flag -35 on the calculator.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum TransferMode {
    /// Flag -35 set: GET returns `HPHP48-x` / `HPHP49-x` + object; PUT of a
    /// file that is not an HP binary object stores it as a String.
    Binary,
    /// Flag -35 clear (a fresh calculator): objects travel as `%%HP:` text.
    Ascii,
}

/// What a calculator connection remembers between operations, apart from
/// the Kermit session.
#[derive(Debug)]
pub(crate) struct CalcState {
    /// Last transfer mode set or read by us; `None` = unknown.
    pub(crate) mode: Option<TransferMode>,
    /// State of the generator behind the sync markers.
    rng: u64,
}

impl CalcState {
    /// A fresh state; `seed` makes the sync markers of this connection
    /// differ from those of an earlier one.
    pub(crate) fn new(seed: u64) -> Self {
        CalcState {
            mode: None,
            rng: seed,
        }
    }

    /// The next sync marker: `SATX-` and six hex digits of a splitmix64
    /// step (13 characters with the quotes, far below every model's display
    /// width), plain ASCII without RPL delimiters.
    fn marker(&mut self) -> String {
        self.rng = self.rng.wrapping_add(0x9E37_79B9_7F4A_7C15);
        let mut z = self.rng;
        z = (z ^ (z >> 30)).wrapping_mul(0xBF58_476D_1CE4_E5B9);
        z = (z ^ (z >> 27)).wrapping_mul(0x94D0_49BB_1331_11EB);
        z ^= z >> 31;
        format!("SATX-{:06x}", z & 0xFF_FFFF)
    }
}

/// The calculator operations as async code on a Kermit core (see
/// [`crate::machine`]): driven by [`Calculator`] over a transport, or by a
/// [`Machine`](crate::machine::Machine) from outside.
pub(crate) struct CalcOps<'a> {
    pub(crate) k: &'a mut KermitCore,
    pub(crate) st: &'a mut CalcState,
}

impl CalcOps<'_> {
    /// [`Calculator::sync`].
    pub(crate) async fn sync(&mut self) -> Result<()> {
        let marker = self.st.marker();
        self.sync_with(&marker).await
    }

    async fn sync_with(&mut self, marker: &str) -> Result<()> {
        let command = format!("\"{marker}\"");
        for attempt in 0..2 {
            // The first attempt is sent once and gets one timeout period
            // (20 s by default), not the whole retry budget; the second has
            // the normal budget: the marker is the one command that may
            // safely run twice, only markers are ever dropped.
            let result = if attempt == 0 {
                self.host(&command).await
            } else {
                self.host_retrying(&command).await
            };
            let reply = match result {
                // The calculator aborted a transfer left over from the dead
                // client (seen: "Transfer Failed" on the 48SX): an odd
                // reply like any other.
                Err(Error::Remote(_)) => continue,
                // The late reply and our command crossed and the exchange
                // stalled (seen on the emulated 49G under load: the marker
                // ran, its reply never came). Once more: the second reply
                // shows both markers and both are dropped.
                Err(Error::NoReply { .. } | Error::Kermit(kermit_proto::Error::Timeout))
                    if attempt == 0 =>
                {
                    continue;
                }
                reply => reply?,
            };
            let ours = reply
                .levels
                .iter()
                .take_while(|level| parse_string(level).as_deref() == Some(marker))
                .count();
            if reply.error.is_none() && ours > 0 {
                self.drop_levels(ours).await?;
                return Ok(());
            }
        }
        Err(Error::Reply(format!(
            "not in step with the calculator: neither reply showed the sync marker {marker}"
        )))
    }

    /// Before a best-effort cleanup after a failed step: forget the link's
    /// error so the cleanup tries the link again, as each call to the
    /// transport did before the seam (a dead link still fails it).
    fn retry_link(&self) {
        self.k.link.clear_error();
    }

    /// [`Calculator::run`].
    pub(crate) async fn run(&mut self, command: &str) -> Result<StackReply> {
        self.st.mode = None;
        self.host(command).await
    }

    /// Send `command` as a `C` packet exactly once and parse the stack
    /// reply. A `C` resent after a lost or late ACK runs again on the
    /// calculator, which cannot tell it from a new command, so the packet
    /// is never retransmitted (`first_packet_retries = Some(0)`), and a NAK
    /// (usually a stale one from the idle server) does not shorten the wait.
    /// One exception: a NAK within [`HOST_NAK_WINDOW`] of the `C` going out,
    /// but not sooner than the `C`'s wire time ([`HOST_BYTE_TIME`] per
    /// byte), is the calculator rejecting it, and the `C` is resent once
    /// after [`HOST_NAK_GRACE`] if no answer (`S`, short reply or `E`) came
    /// meanwhile (the command did not run). Input waiting before the `C`
    /// is discarded first (`Session::transact_with`), so a stale NAK is not
    /// read as one. No answer to the `C` within the timeout is
    /// [`Error::NoReply`]. Once
    /// the calculator's `S` is in, the reply packets keep the session's
    /// retries; a failure after that is the Kermit error (the command ran).
    async fn host(&mut self, command: &str) -> Result<StackReply> {
        let timeout = self.k.config().timeout;
        self.host_once(command, timeout).await
    }

    /// [`host`](Self::host) with a reply timeout of `timeout`.
    async fn host_once(&mut self, command: &str, timeout: Duration) -> Result<StackReply> {
        let normal = self.k.config().clone();
        let mut once = normal.clone();
        once.timeout = timeout;
        once.first_packet_retries = Some(0);
        once.nak_grace = timeout;
        once.first_packet_nak_window = Some(HOST_NAK_WINDOW);
        once.first_packet_nak_grace = Some(HOST_NAK_GRACE.min(timeout));
        once.first_packet_nak_byte_time = Some(HOST_BYTE_TIME);
        self.k.set_config(once);
        let result = self.host_retrying(command).await;
        self.k.set_config(normal);
        match result {
            Err(Error::Kermit(kermit_proto::Error::Timeout)) if !self.k.answered() => {
                Err(Error::NoReply {
                    command: command.to_string(),
                })
            }
            other => other,
        }
    }

    /// Send `command` as a `C` packet with the session's retries and parse
    /// the stack reply. Only for a command that may run twice (the sync
    /// marker).
    async fn host_retrying(&mut self, command: &str) -> Result<StackReply> {
        let bytes = encode_command(command)?;
        let transcript = self.k.transact(Command::Host(bytes)).await?;
        Ok(parse_stack(&decode(&transcript.text)))
    }

    /// Run `parts` joined by spaces as one command; if that is too long for
    /// a packet, run each part on its own in order. The first reply with an
    /// error becomes [`Error::Calculator`].
    async fn exec(&mut self, parts: &[String]) -> Result<StackReply> {
        match self.host(&parts.join(" ")).await {
            Err(Error::CommandTooLong { .. }) if parts.len() > 1 => {
                let mut last = StackReply::default();
                for part in parts {
                    last = checked(self.host(part).await?)?;
                }
                Ok(last)
            }
            reply => checked(reply?),
        }
    }

    /// Run `command`, read `levels` stack levels (level 1 first) and drop
    /// them again. Only for short values that every display mode shows
    /// exactly (a flag's 0 or 1, `1.E0` in `0 SCI`; the 48S/SX's path): the
    /// 49G cuts each level at its display width, 20 characters on ROM
    /// 1.18, without a marker, and a real with more digits needs STD
    /// ([`Self::drop_and_restore_flags`]).
    async fn query(&mut self, command: &str, levels: usize) -> Result<Vec<String>> {
        let reply = checked(self.host(command).await?)?;
        if reply.levels.len() < levels {
            return Err(Error::Reply(format!(
                "{command}: expected {levels} stack level(s), got {:?}",
                reply.levels
            )));
        }
        let values = reply.levels[..levels].to_vec();
        self.drop_levels(levels).await?;
        Ok(values)
    }

    /// Drop `n` levels pushed by an internal query: `DROP`, `DROP2`, or
    /// `n. DROPN` (a real: a 49G in exact mode reads `7` as an integer).
    async fn drop_levels(&mut self, n: usize) -> Result<()> {
        match drop_command(n) {
            Some(command) => checked(self.host(&command).await?).map(|_| ()),
            None => Ok(()),
        }
    }

    /// Drop `n` levels above the flags a query saved and put the flags
    /// back, in one command (`n. DROPN STOF`).
    ///
    /// A query whose reply holds reals that satx reads starts with `RCLF
    /// STD`: the user's flags saved on the stack (a list of binary
    /// integers) and the number display set to STD, so a real arrives with
    /// all its digits whatever the display mode (in `0 SCI` 9600 shows as
    /// `1.E4`). The fraction mark (flag -51) stays; [`parse_real`] reads
    /// both. `RCLF`, `STD` and `STOF` work alike on the 48S/SX, 48G/GX and
    /// 49G (emulated, 2026-11-08).
    async fn drop_and_restore_flags(&mut self, n: usize) -> Result<()> {
        let command = match drop_command(n) {
            Some(drop) => format!("{drop} STOF"),
            None => "STOF".to_string(),
        };
        checked(self.host(&command).await?).map(|_| ())
    }

    /// [`Calculator::list`].
    pub(crate) async fn list(&mut self) -> Result<Listing> {
        let transcript = self.k.transact(Command::Directory).await?;
        parse_listing(&decode(&transcript.text))
    }

    /// [`Calculator::path`].
    pub(crate) async fn path(&mut self) -> Result<Vec<String>> {
        if let Some(path) = self.list().await?.path {
            return Ok(path);
        }
        let [value]: [String; 1] = self
            .query("PATH", 1)
            .await?
            .try_into()
            .map_err(|_| Error::Reply("PATH: no value".into()))?;
        parse_list(&value).ok_or_else(|| Error::Reply(format!("PATH: not a list: {value:?}")))
    }

    /// [`Calculator::cd`].
    pub(crate) async fn cd(&mut self, path: &[&str]) -> Result<()> {
        let components = match path.split_first() {
            Some((&"HOME", rest)) => rest,
            _ => path,
        };
        for name in components {
            validate_name(name)?;
        }
        self.exec(&["HOME".to_string()]).await?;
        for name in components {
            let listing = self.list().await?;
            let is_dir = listing
                .entries
                .iter()
                .any(|e| e.name == *name && e.is_directory());
            if !is_dir {
                return Err(Error::Reply(format!("{name}: no such directory")));
            }
            self.exec(&[(*name).to_string()]).await?;
        }
        Ok(())
    }

    /// [`Calculator::updir`].
    pub(crate) async fn updir(&mut self) -> Result<()> {
        self.exec(&["UPDIR".to_string()]).await.map(|_| ())
    }

    /// [`Calculator::mkdir`].
    pub(crate) async fn mkdir(&mut self, name: &str) -> Result<()> {
        self.exec(&[format!("{} CRDIR", quote(name)?)])
            .await
            .map(|_| ())
    }

    /// [`Calculator::remove`].
    pub(crate) async fn remove(&mut self, name: &str) -> Result<()> {
        let quoted = quote(name)?;
        let is_dir = self
            .list()
            .await?
            .entries
            .iter()
            .find(|e| e.name == name)
            .map(|e| e.is_directory())
            .ok_or_else(|| Error::Reply(format!("{name}: no such variable")))?;
        let purge = if is_dir { "PGDIR" } else { "PURGE" };
        self.exec(&[format!("{quoted} {purge}")]).await.map(|_| ())
    }

    /// [`Calculator::rename`].
    pub(crate) async fn rename(&mut self, from: &str, to: &str) -> Result<()> {
        let quoted_from = quote(from)?;
        let quoted_to = quote(to)?;
        let listing = self.list().await?;
        let is_dir = listing
            .entries
            .iter()
            .find(|e| e.name == from)
            .map(|e| e.is_directory())
            .ok_or_else(|| Error::Reply(format!("{from}: no such variable")))?;
        if listing.entries.iter().any(|e| e.name == to) {
            return Err(Error::Reply(format!("{to}: already exists")));
        }
        let purge = if is_dir { "PGDIR" } else { "PURGE" };
        self.exec(&[
            format!("{quoted_from} RCL"),
            format!("{quoted_to} STO"),
            format!("{quoted_from} {purge}"),
        ])
        .await
        .map(|_| ())
    }

    /// [`Calculator::mem`]: read in STD ([`MEM_STD`]), as a backup checks
    /// it against its size (Files on the 48S/SX, whose listing lacks it).
    pub(crate) async fn mem(&mut self) -> Result<f64> {
        let reply = checked(self.host(MEM_STD).await?)?;
        let value = reply.level(1).unwrap_or_default().to_string();
        self.drop_and_restore_flags(1).await?;
        parse_real(&value).ok_or_else(|| Error::Reply(format!("MEM: not a number: {value:?}")))
    }

    /// [`Calculator::version`].
    pub(crate) async fn version(&mut self) -> Result<Option<String>> {
        let reply = checked(self.host("VERSION").await?)?;
        // 48SX: the undefined name evaluates to itself.
        let level1 = reply.level(1).unwrap_or_default().trim();
        if level1 == "VERSION" || parse_name(level1).as_deref() == Some("VERSION") {
            self.drop_levels(1).await?;
            return Ok(None);
        }
        let (Some(l2), Some(l1)) = (reply.level(2), reply.level(1)) else {
            return Err(Error::Reply(format!(
                "VERSION: expected two strings, got {:?}",
                reply.levels
            )));
        };
        let bad = |s: &str| Error::Reply(format!("VERSION: not a string: {s:?}"));
        parse_string(l2).ok_or_else(|| bad(l2))?;
        parse_string(l1).ok_or_else(|| bad(l1))?;
        let (version, copyright) = match (parse_whole_string(l2), parse_whole_string(l1)) {
            (Some(version), Some(copyright)) => {
                self.drop_levels(2).await?;
                (version, copyright)
            }
            (None, None) => {
                // Nothing tells where the two would meet in the chunks.
                self.drop_levels(2).await?;
                return Err(Error::Reply(format!(
                    "VERSION: both strings arrived cut: {:?}",
                    reply.levels
                )));
            }
            // The 49G cut one at its display width.
            (version, copyright) => {
                let below = reply.levels.len() - 2;
                self.whole_version(version, copyright, below).await?
            }
        };
        let version = version.split_whitespace().collect::<Vec<_>>().join(" ");
        Ok(Some(format!("{version}, {copyright}")))
    }

    /// `VERSION`'s two strings, still on the stack above `below` levels of
    /// the user's, whole: fetched in chunks by [`VERSION_CHUNKS`], then
    /// dropped with the chunks and the user's flags put back. `version` or
    /// `copyright` is the one that arrived whole and tells where the two
    /// meet in the joined text.
    async fn whole_version(
        &mut self,
        version: Option<String>,
        copyright: Option<String>,
        below: usize,
    ) -> Result<(String, String)> {
        let reply = match checked(self.host(VERSION_CHUNKS).await?) {
            Err(e @ Error::Calculator { .. }) => {
                self.drop_after_failed_chunks(&e, below).await?;
                return Err(e);
            }
            reply => reply?,
        };
        let bad =
            |reply: &StackReply| Error::Reply(format!("VERSION: bad chunks: {:?}", reply.levels));
        // The saved flags are the first list from level 1 down: above them
        // are only the chunks (strings) and the total (a real).
        let Some(flags) = (1..=reply.levels.len()).find(|&n| reply.level(n).is_some_and(is_flags))
        else {
            return Err(bad(&reply));
        };
        self.drop_and_restore_flags(flags - 1).await?;
        let total = reply.level(1).and_then(parse_count);
        let joined = (2..flags)
            .rev()
            .map(|n| reply.level(n).and_then(parse_whole_string))
            .collect::<Option<String>>()
            .unwrap_or_default();
        let split = match (&version, &copyright) {
            (_, Some(copyright)) if joined.ends_with(copyright.as_str()) => {
                Some(joined.len() - copyright.len())
            }
            (Some(version), None) if joined.starts_with(version.as_str()) => Some(version.len()),
            _ => None,
        };
        match (total, split) {
            (Some(total), Some(split))
                if joined.chars().count() == total && flags - 2 == total.div_ceil(CHUNK) =>
            {
                let (version, copyright) = joined.split_at(split);
                Ok((version.to_string(), copyright.to_string()))
            }
            _ => Err(bad(&reply)),
        }
    }

    /// After [`VERSION_CHUNKS`] failed (`err`'s stack is what it left):
    /// drop everything above the user's `below` levels and, if the flags
    /// were saved by then (the deepest of those levels), put them back.
    async fn drop_after_failed_chunks(&mut self, err: &Error, below: usize) -> Result<()> {
        let Error::Calculator { stack, .. } = err else {
            return Ok(());
        };
        let ours = stack.len().saturating_sub(below);
        match ours.checked_sub(1).and_then(|deepest| stack.get(deepest)) {
            Some(deepest) if is_flags(deepest) => self.drop_and_restore_flags(ours - 1).await,
            _ => self.drop_levels(ours).await,
        }
    }

    /// [`Calculator::iopar`]: read item by item, in STD ([`IOPAR_ITEMS`]).
    pub(crate) async fn iopar(&mut self) -> Result<Iopar> {
        let reply = match checked(self.host(IOPAR_ITEMS).await?) {
            Err(e @ Error::Calculator { .. }) => {
                // IOPAR is no list: LIST→ left it (or the undefined name)
                // on the stack, above the saved flags.
                if let Error::Calculator { stack, .. } = &e
                    && stack.get(1).is_some_and(|l| is_flags(l))
                {
                    self.drop_and_restore_flags(1).await?;
                }
                return Err(e);
            }
            reply => reply?,
        };
        checked(self.host(IOPAR_DROP).await?)?;
        let Some(n) = reply.level(1).and_then(parse_count) else {
            return Err(Error::Reply(format!(
                "IOPAR: no item count: {:?}",
                reply.levels
            )));
        };
        if reply.levels.len() < n + 2 {
            return Err(Error::Reply(format!(
                "IOPAR: expected {n} items, got {:?}",
                reply.levels
            )));
        }
        // Level n + 1 is the first item.
        let items: Vec<&str> = (2..=n + 1)
            .rev()
            .map(|level| reply.level(level).unwrap_or_default())
            .collect();
        Iopar::from_items(&items)
            .ok_or_else(|| Error::Reply(format!("IOPAR: bad list: {{ {} }}", items.join(" "))))
    }

    /// [`Calculator::set_iopar`].
    pub(crate) async fn set_iopar(&mut self, iopar: &Iopar) -> Result<()> {
        self.exec(&[
            "PATH HOME".to_string(),
            format!("{} 'IOPAR' STO", iopar.to_rpl()),
            "EVAL".to_string(),
        ])
        .await
        .map(|_| ())
    }

    /// [`Calculator::transfer_mode`].
    pub(crate) async fn transfer_mode(&mut self) -> Result<TransferMode> {
        let values = self.query("-35 FS?", 1).await?;
        let value = values.first().map(String::as_str).unwrap_or_default();
        let mode = match parse_real(value) {
            Some(1.0) => TransferMode::Binary,
            Some(0.0) => TransferMode::Ascii,
            _ => return Err(Error::Reply(format!("-35 FS?: not a flag: {value:?}"))),
        };
        self.st.mode = Some(mode);
        Ok(mode)
    }

    /// [`Calculator::set_transfer_mode`].
    pub(crate) async fn set_transfer_mode(&mut self, mode: TransferMode) -> Result<()> {
        if self.st.mode == Some(mode) {
            return Ok(());
        }
        let command = match mode {
            TransferMode::Binary => "-35 SF",
            TransferMode::Ascii => "-35 CF",
        };
        self.exec(&[command.to_string()]).await?;
        self.st.mode = Some(mode);
        Ok(())
    }

    /// [`Calculator::get`].
    pub(crate) async fn get(&mut self, name: &str, mode: TransferMode) -> Result<Vec<u8>> {
        validate_name(name)?;
        self.set_transfer_mode(mode).await?;
        let transcript = self.k.transact(Command::Get(encode(name)?)).await?;
        let [file]: [_; 1] = transcript.files.try_into().map_err(|files: Vec<_>| {
            Error::Reply(format!(
                "GET {name}: expected one file, got {}",
                files.len()
            ))
        })?;
        Ok(match mode {
            TransferMode::Binary => strip_padding(&file.data, KERMIT_PADDING_ALLOWANCE).to_vec(),
            TransferMode::Ascii => file.data,
        })
    }

    /// [`Calculator::put`].
    pub(crate) async fn put(
        &mut self,
        name: &str,
        data: &[u8],
        mode: TransferMode,
    ) -> Result<String> {
        validate_name(name)?;
        self.set_transfer_mode(mode).await?;
        let file = OutgoingFile {
            name: encode(name)?,
            data: data.to_vec(),
        };
        let transcript = self.k.transact(Command::Send(vec![file])).await?;
        transcript
            .stored_names
            .into_iter()
            .next()
            .ok_or_else(|| Error::Reply(format!("SEND {name}: no file stored")))
    }

    /// [`Calculator::pict`].
    pub(crate) async fn pict(&mut self) -> Result<Grob> {
        Grob::from_file(&self.pict_file().await?)
    }

    /// [`Calculator::pict`] as the binary transfer file the calculator
    /// sent, checked to hold a GROB.
    pub(crate) async fn pict_file(&mut self) -> Result<Vec<u8>> {
        self.refuse_existing(PICT_VAR).await?;
        self.exec(&[format!("PICT RCL '{PICT_VAR}' STO")]).await?;
        let data = self.get(PICT_VAR, TransferMode::Binary).await;
        self.retry_link();
        let purge = self.exec(&[format!("'{PICT_VAR}' PURGE")]).await;
        let data = data?;
        purge?;
        Grob::from_file(&data)?;
        Ok(data)
    }

    /// [`Calculator::backup`].
    pub(crate) async fn backup(&mut self) -> Result<Vec<u8>> {
        self.refuse_existing(BACKUP_VAR).await?;
        self.exec(&[format!(":0:{BACKUP_VAR} ARCHIVE")]).await?;
        let result = self.backup_steps().await;
        if result.is_err() {
            // Best effort: the error being reported matters more.
            self.retry_link();
            let _ = self.exec(&[format!(":0:{BACKUP_VAR} PURGE")]).await;
            self.retry_link();
            let _ = self.exec(&[format!("'{BACKUP_VAR}' PGDIR")]).await;
        }
        let data = result?;
        let info = inspect(&data)?;
        if info.object_type != Some(ObjectType::Directory) {
            return Err(Error::Object(format!(
                "backup is not a directory (prolog {:05X})",
                info.prolog
            )));
        }
        Ok(data)
    }

    async fn backup_steps(&mut self) -> Result<Vec<u8>> {
        // STO before PURGE, else "Object In Use".
        let copied = self
            .exec(&[
                format!(":0:{BACKUP_VAR} RCL"),
                format!("'{BACKUP_VAR}' STO"),
                format!(":0:{BACKUP_VAR} PURGE"),
            ])
            .await;
        // A `STO` that failed (no room for the copy) leaves the name and
        // the recalled archive on the stack, which keeps the port object in
        // use: the cleanup's `PURGE` would fail too. Only this command: a
        // later failure's level 2 is the user's. A 49G in algebraic mode
        // shows the name without its quotes.
        if let Err(Error::Calculator { stack, .. }) = &copied
            && stack.first().is_some_and(|l| {
                l.trim() == BACKUP_VAR || parse_name(l).as_deref() == Some(BACKUP_VAR)
            })
        {
            self.retry_link();
            let _ = self.drop_levels(2).await;
        }
        copied?;
        let data = self.get(BACKUP_VAR, TransferMode::Binary).await?;
        self.exec(&[format!("'{BACKUP_VAR}' PGDIR")]).await?;
        Ok(data)
    }

    /// [`Calculator::restore`].
    pub(crate) async fn restore(&mut self, data: &[u8]) -> Result<()> {
        self.restore_leaving(data, None).await
    }

    /// [`Calculator::restore`], with flag -35 set to `mode` just before
    /// `RESTORE`: the warm start ends server mode, so a host that changed
    /// the flag for its session cannot put it back afterwards. RESTORE
    /// keeps the calculator's flags (a backup made with -35 clear restored
    /// onto a calculator with it set leaves it set; Saturnus, 48SX and
    /// 48GX, 2026-10-11).
    pub(crate) async fn restore_leaving(
        &mut self,
        data: &[u8],
        mode: Option<TransferMode>,
    ) -> Result<()> {
        check_backup(data)?;
        self.refuse_existing(RESTORE_VAR).await?;
        let stored = self.put(RESTORE_VAR, data, TransferMode::Binary).await?;
        if stored != RESTORE_VAR {
            return Err(Error::Reply(format!(
                "backup stored as {stored}, expected {RESTORE_VAR}"
            )));
        }
        let copied = self
            .exec(&[
                format!("'{RESTORE_VAR}' RCL"),
                format!(":0:{RESTORE_VAR} STO"),
                format!("'{RESTORE_VAR}' PGDIR"),
            ])
            .await;
        if let Err(e) = copied {
            self.retry_link();
            let _ = self.exec(&[format!("'{RESTORE_VAR}' PGDIR")]).await;
            return Err(e);
        }
        if let Some(mode) = mode {
            self.set_transfer_mode(mode).await?;
        }
        self.restore_from_port().await
    }

    /// `RESTORE` from `:0:SATXRS`. The warm start ends server mode, so no
    /// reply ever comes; but no reply is also what a lost `C` gives. A
    /// probe follows: no answer means the warm start ended server mode
    /// (success). An answer leaves the result unknown ([`Error::Reply`],
    /// `:0:SATXRS` stays): the `RESTORE` may have been lost, or it ran and
    /// someone restarted `SERVER` within the probe's timeout.
    async fn restore_from_port(&mut self) -> Result<()> {
        self.st.mode = None;
        let timeout = self.k.config().timeout;
        let restore = format!(":0:{RESTORE_VAR} RESTORE");
        match self.host_once(&restore, RESTORE_TIMEOUT.min(timeout)).await {
            Err(Error::NoReply { .. }) => {}
            Err(e) => return Err(e),
            Ok(reply) => {
                checked(reply)?;
                return Err(Error::Reply("calculator did not restart".into()));
            }
        }
        let marker = self.st.marker();
        let probe = self.host_once(&format!("\"{marker}\""), timeout).await;
        let still_running = || {
            Error::Reply(format!(
                "the calculator answers again, so RESTORE's result is unknown: it may have \
                 run before the server was restarted; the backup stays in :0:{RESTORE_VAR}"
            ))
        };
        match probe {
            Err(Error::NoReply { .. }) => Ok(()),
            Err(Error::Remote(_)) => Err(still_running()),
            Err(e) => Err(e),
            Ok(reply) => {
                if reply.error.is_none()
                    && reply.level(1).and_then(parse_string).as_deref() == Some(marker.as_str())
                {
                    // Best effort: the probe's own marker; the error matters
                    // more.
                    let _ = self.drop_levels(1).await;
                }
                Err(still_running())
            }
        }
    }

    /// [`Calculator::purge_restore_leftover`].
    pub(crate) async fn purge_restore_leftover(&mut self) -> Result<()> {
        self.exec(&[format!(":0:{RESTORE_VAR} PURGE")])
            .await
            .map(|_| ())
    }

    /// [`Calculator::finish`].
    pub(crate) async fn finish(&mut self) -> Result<()> {
        self.k.transact(Command::Finish).await.map(|_| ())
    }

    /// [`Calculator::model`].
    pub(crate) async fn model(&mut self) -> Result<Model> {
        Ok(Model::from_version(self.version().await?.as_deref()))
    }

    /// [`Calculator::prepare_for_xmodem`].
    pub(crate) async fn prepare_for_xmodem(
        &mut self,
        direction: XmodemDirection,
        name: &str,
    ) -> Result<XmodemPlan> {
        validate_name(name)?;
        let model = self.model().await?;
        if !model.has_xmodem() {
            return Err(Error::Unsupported(format!(
                "the {} has no XModem; use Kermit",
                model.name()
            )));
        }
        let exists = self.list().await?.entries.iter().any(|e| e.name == name);
        if direction == XmodemDirection::FromCalculator && !exists {
            return Err(Error::Reply(format!("{name}: no such variable")));
        }
        if direction == XmodemDirection::ToCalculator && exists && model == Model::Hp48Gx {
            // XRECV stops with "XRECV Error: Name Conflict" before any start
            // character and leaves the name on the stack (emulated 48GX,
            // 2026-10-05).
            return Err(Error::Reply(format!("{name}: already exists")));
        }
        let mut switched_to_rpn = false;
        if model == Model::Hp49G {
            let flag = self.query("-95. FS?", 1).await?;
            let alg = flag.first().and_then(|v| parse_real(v)) == Some(1.0);
            if alg {
                self.exec(&["-95. CF".to_string()]).await?;
                switched_to_rpn = true;
            }
        }
        // The program the user runs with EVAL once the server has ended
        // (XRECV and XSEND do not run inside it): on the stack, not run.
        if let Err(e) = self.exec(&[stacked_program(direction, name)]).await {
            // Nothing happened for the user: algebraic mode back, as it was.
            if switched_to_rpn {
                let _ = self.exec(&["-95. SF".to_string()]).await;
            }
            return Err(e);
        }
        self.finish().await?;
        self.st.mode = None;

        let mut notes = Vec::new();
        if direction == XmodemDirection::ToCalculator && exists {
            notes.push(match model {
                Model::Hp49G => format!(
                    "{name} exists: the 49G does not overwrite it but stores the object as {name}.1."
                ),
                _ => format!(
                    "{name} exists: the 49G stores the object as {name}.1 and the 48G/GX \
                     refuses with \"Name Conflict\"; this model is unknown."
                ),
            });
        }
        if direction == XmodemDirection::ToCalculator && model == Model::Hp48Gx {
            notes.push(format!(
                "If the transfer fails, {name} may be left holding an empty string."
            ));
        }
        if switched_to_rpn {
            notes.push(
                "The calculator was in algebraic mode and is now in RPN mode \
                 (flag -95 cleared); type -95 SF to switch back."
                    .to_string(),
            );
        }
        notes.push(
            "If you do not go on, press \u{2190} (backspace) instead: it drops the program, \
             and the stack is as it was."
                .to_string(),
        );
        notes.push(format!(
            "The calculator has left server mode; {} after the transfer.",
            server_again(model)
        ));
        Ok(XmodemPlan {
            model,
            direction,
            name: name.to_string(),
            program: program_text(direction, name),
            keys: eval_keys(model).iter().map(|k| k.to_string()).collect(),
            switched_to_rpn,
            exists,
            notes,
        })
    }

    /// Fail if `name` exists in the current directory.
    async fn refuse_existing(&mut self, name: &str) -> Result<()> {
        if self.list().await?.entries.iter().any(|e| e.name == name) {
            return Err(Error::Reply(format!(
                "{name} exists in the current directory; remove it first"
            )));
        }
        Ok(())
    }
}

/// A calculator in Kermit server mode, over a blocking [`Transport`] with
/// the system clock. For a link driven from outside (a browser), see
/// [`machine::Machine`](crate::machine::Machine), which runs the same
/// operations.
#[derive(Debug)]
#[cfg(not(target_arch = "wasm32"))]
pub struct Calculator {
    session: Session,
    state: CalcState,
}

#[cfg(not(target_arch = "wasm32"))]
impl Calculator {
    /// Wrap an open session. The transfer mode is unknown until read or set.
    pub fn new(session: Session) -> Self {
        Calculator {
            session,
            state: CalcState::new(entropy()),
        }
    }

    /// Open `addr` (see [`crate::transport::open`]) with default options
    /// and [`sync`](Calculator::sync).
    pub fn open(addr: &str) -> Result<Self> {
        let mut calc = Calculator::new(Session::open(addr)?);
        calc.sync()?;
        Ok(calc)
    }

    /// The underlying session. Forgets the cached transfer mode, since the
    /// caller may change flag -35 through it.
    pub fn session(&mut self) -> &mut Session {
        self.state.mode = None;
        &mut self.session
    }

    /// The underlying session, consuming the calculator.
    pub fn into_session(self) -> Session {
        self.session
    }

    /// The open link, consuming the calculator, e.g. for an
    /// [`XmodemSession`](crate::XmodemSession) after
    /// [`Calculator::prepare_for_xmodem`].
    pub fn into_transport(self) -> Box<dyn Transport> {
        self.session.into_transport()
    }

    /// The transport, the link and the operations, borrowed apart.
    fn split(&mut self) -> (&mut dyn Transport, Link, CalcOps<'_>) {
        let link = self.session.core.link.clone();
        let ops = CalcOps {
            k: &mut self.session.core,
            st: &mut self.state,
        };
        (self.session.transport.as_mut(), link, ops)
    }

    #[cfg(test)]
    fn sync_with(&mut self, marker: &str) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.sync_with(marker), &mut |_| {})
    }

    #[cfg(test)]
    fn restore_from_port(&mut self) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.restore_from_port(), &mut |_| {})
    }

    /// Get in step with the server at the start of a session.
    ///
    /// When a client dies while a host command runs, the calculator still
    /// finishes the command and offers its reply (an S packet repeated
    /// every 5 s for about a minute). The next client's first command is
    /// eaten as a bad ACK and the late reply arrives in its place. Sequence
    /// numbers restart at zero for every command and host commands and
    /// `G D` both answer with text, so the late reply cannot be told apart
    /// on the wire, and repeating an arbitrary command would repeat its
    /// effect. Instead the session starts with a sacrificial command that
    /// pushes a marker string unique to this session ([`sync_marker`],
    /// short enough that no model truncates it). A reply whose level 1 is
    /// the marker is ours: the marker is dropped (every copy of it on top
    /// of the stack, in case an earlier attempt was not eaten after all).
    /// Any other reply was a late one and our command was eaten: the marker
    /// command is sent once more. Nothing but the marker is ever dropped
    /// and nothing else is ever resent. Link errors are returned; a second
    /// odd reply is [`Error::Reply`]: satx and the calculator are not in
    /// step, and nothing is run on a stack it cannot vouch for.
    pub fn sync(&mut self) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.sync(), &mut |_| {})
    }

    /// Run a host command (Unicode or ASCII trigraphs such as `\->`) and
    /// return the stack. An `Error:` reply is `Ok` with `error` set. Forgets
    /// the cached transfer mode, since the command may change flag -35.
    /// The command is sent once: no reply in time is [`Error::NoReply`],
    /// never a second run.
    pub fn run(&mut self, command: &str) -> Result<StackReply> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.run(command), &mut |_| {})
    }

    /// The current directory listing (`G D`).
    pub fn list(&mut self) -> Result<Listing> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.list(), &mut |_| {})
    }

    /// The current directory path, e.g. `["HOME", "D1"]`: from the listing
    /// header (48GX, 49G) or a `PATH` query (48SX, whose listing has none).
    pub fn path(&mut self) -> Result<Vec<String>> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.path(), &mut |_| {})
    }

    /// Change to the absolute directory `path`, e.g. `["HOME", "D1"]` (the
    /// leading `HOME` is optional). Each component is checked against the
    /// listing before it is evaluated.
    pub fn cd(&mut self, path: &[&str]) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.cd(path), &mut |_| {})
    }

    /// Go to the parent directory (`UPDIR`).
    pub fn updir(&mut self) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.updir(), &mut |_| {})
    }

    /// Create directory `name` in the current directory (`CRDIR`).
    pub fn mkdir(&mut self, name: &str) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.mkdir(name), &mut |_| {})
    }

    /// Delete variable `name` from the current directory; a directory is
    /// deleted with its contents (`PGDIR`).
    pub fn remove(&mut self, name: &str) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.remove(name), &mut |_| {})
    }

    /// Rename variable `from` to `to` in the current directory (`RCL`, `STO`,
    /// then `PURGE` or `PGDIR`). `to` must not exist yet.
    pub fn rename(&mut self, from: &str, to: &str) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.rename(from, to), &mut |_| {})
    }

    /// Free memory in bytes (`MEM`).
    pub fn mem(&mut self) -> Result<f64> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.mem(), &mut |_| {})
    }

    /// The ROM version text, e.g. `Version HP48-R, Copyright HP 1993`;
    /// `None` on the 48SX, which has no `VERSION` command.
    pub fn version(&mut self) -> Result<Option<String>> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.version(), &mut |_| {})
    }

    /// The serial settings (`IOPAR`).
    pub fn iopar(&mut self) -> Result<Iopar> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.iopar(), &mut |_| {})
    }

    /// Store `iopar` as `IOPAR` in HOME and return to the current directory.
    /// Takes effect when the calculator reopens the port (e.g. the next
    /// `SERVER`), not in the running session.
    pub fn set_iopar(&mut self, iopar: &Iopar) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.set_iopar(iopar), &mut |_| {})
    }

    /// Read the transfer mode (flag -35) and cache it.
    pub fn transfer_mode(&mut self) -> Result<TransferMode> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.transfer_mode(), &mut |_| {})
    }

    /// Set the transfer mode (flag -35) unless the cached mode already is
    /// `mode`.
    pub fn set_transfer_mode(&mut self, mode: TransferMode) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.set_transfer_mode(mode), &mut |_| {})
    }

    /// GET variable `name` from the current directory in `mode`. Binary
    /// data is cut after the object (the calculator pads the last packet).
    pub fn get(&mut self, name: &str, mode: TransferMode) -> Result<Vec<u8>> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.get(name, mode), &mut |_| {})
    }

    /// SEND `data` as variable `name` in `mode` and return the name the
    /// calculator stored it under (it can differ, e.g. a `.1` suffix when
    /// the name exists).
    pub fn put(&mut self, name: &str, data: &[u8], mode: TransferMode) -> Result<String> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.put(name, data, mode), &mut |_| {})
    }

    /// Fetch the graphics screen PICT (plots, drawings) via `PICT RCL`, a
    /// temporary variable `SATXTMP` and a binary GET; the variable is purged
    /// afterwards. A calculator that never drew anything has a 0x0 PICT;
    /// `ERASE` makes it 131x64. The display itself cannot be captured over
    /// the link: `LCD→` in server mode only sees the server's own banner.
    /// Leaves the calculator in binary transfer mode.
    pub fn pict(&mut self) -> Result<Grob> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.pict(), &mut |_| {})
    }

    /// Back up HOME: `ARCHIVE` into port 0, recall it into a temporary
    /// variable `SATXBK`, GET that in binary mode, then remove both. Returns
    /// the binary transfer file of the Directory object. `ARCHIVE :IO:name`
    /// fails in server mode ("Port Not Available"), hence the detour.
    /// Leaves the calculator in binary transfer mode.
    pub fn backup(&mut self) -> Result<Vec<u8>> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.backup(), &mut |_| {})
    }

    /// Replace HOME with the backup `data` (from [`Calculator::backup`]):
    /// binary PUT as `SATXRS`, copy to port 0, `RESTORE` from there. The
    /// calculator warm-starts and leaves server mode; restart `SERVER` on
    /// it, then call [`Calculator::purge_restore_leftover`] to delete
    /// `:0:SATXRS`. `data` must be a Directory whose object walk succeeds
    /// (a truncated file never reaches `RESTORE`).
    pub fn restore(&mut self, data: &[u8]) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.restore(data), &mut |_| {})
    }

    /// Delete the backup object `:0:SATXRS` that [`Calculator::restore`]
    /// leaves in port 0, once `SERVER` runs again.
    pub fn purge_restore_leftover(&mut self) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.purge_restore_leftover(), &mut |_| {})
    }

    /// End server mode (`G F`).
    pub fn finish(&mut self) -> Result<()> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.finish(), &mut |_| {})
    }

    /// The model, from the `VERSION` text (see [`Model::from_version`]).
    pub fn model(&mut self) -> Result<Model> {
        let (transport, link, mut c) = self.split();
        link::drive(transport, &link, c.model(), &mut |_| {})
    }

    /// Get the calculator ready for an XModem transfer of variable `name`
    /// in the current directory and say what the user must press.
    ///
    /// `XRECV` and `XSEND` cannot be started through the Kermit server (they
    /// fail with "Port Not Available" on the 49G and 48GX), so this checks
    /// the name (it must exist for `XSEND`), switches a 49G in algebraic
    /// mode to RPN (flag -95; EVAL of the program needs RPN), puts the
    /// program `« 'NAME' XRECV »` (or `XSEND`) on the stack
    /// ([`stacked_program`]) and ends
    /// server mode with Kermit FINISH. An existing `NAME` is refused for
    /// `XRECV` on the 48G/GX ("XRECV Error: Name Conflict"); the 49G stores
    /// the object as `NAME.1` instead, which the plan's notes say. The user then presses
    /// [`XmodemPlan::keys`] (EVAL) on the calculator while an
    /// [`XmodemSession`](crate::XmodemSession) on
    /// [`Calculator::into_transport`] waits. Afterwards the calculator is
    /// out of server mode with the stack as before: `SERVER` must be
    /// started again. A user who does not go on drops the program with the
    /// backspace key. Errors for the 48S/SX, which has no XModem.
    pub fn prepare_for_xmodem(
        &mut self,
        direction: XmodemDirection,
        name: &str,
    ) -> Result<XmodemPlan> {
        let (transport, link, mut c) = self.split();
        link::drive(
            transport,
            &link,
            c.prepare_for_xmodem(direction, name),
            &mut |_| {},
        )
    }
}

/// Seed for the sync markers of a [`Calculator`]: the per-process random
/// hasher keys mixed with the time.
fn entropy() -> u64 {
    use std::hash::{BuildHasher, Hasher};
    #[cfg(not(target_arch = "wasm32"))]
    use std::time::{SystemTime, UNIX_EPOCH};
    #[cfg(target_arch = "wasm32")]
    use web_time::{SystemTime, UNIX_EPOCH};
    // RandomState is seeded per process from the OS; mix in the time so two
    // states in one process differ too.
    let mut hasher = std::collections::hash_map::RandomState::new().build_hasher();
    if let Ok(since) = SystemTime::now().duration_since(UNIX_EPOCH) {
        hasher.write_u128(since.as_nanos());
    }
    hasher.finish()
}

/// A sync marker as [`Calculator::sync`] pushes: `SATX-` and six random
/// hex digits (13 characters with the quotes, far below every model's
/// display width), plain ASCII without RPL delimiters.
pub fn sync_marker() -> String {
    CalcState::new(entropy()).marker()
}

/// Check that `data` is a backup [`Calculator::restore`] can upload: a
/// binary Directory object whose size walk succeeds.
fn check_backup(data: &[u8]) -> Result<()> {
    let info = inspect(data).map_err(|e| Error::Object(format!("not a backup: {e}")))?;
    if info.object_type != Some(ObjectType::Directory) {
        return Err(Error::Object(format!(
            "not a backup: prolog {:05X} is not a directory",
            info.prolog
        )));
    }
    let nibbles = unpack(data.get(HEADER_LEN..).unwrap_or_default());
    object_size(&nibbles, 0).map_err(|e| Error::Object(format!("not a backup: {e}")))?;
    Ok(())
}

/// The command that drops `n` levels: `DROP`, `DROP2`, or `n. DROPN` (a
/// real: a 49G in exact mode reads `7` as an integer); `None` for none.
fn drop_command(n: usize) -> Option<String> {
    match n {
        0 => None,
        1 => Some("DROP".to_string()),
        2 => Some("DROP2".to_string()),
        n => Some(format!("{n}. DROPN")),
    }
}

/// A displayed level that is the flags `RCLF` saved: a list of binary
/// integers (`{ # 1688849860264944d # 0d }`, the 49G's cut
/// `{# 6000204010FF0h;# 0h`).
fn is_flags(level: &str) -> bool {
    level.trim_start().starts_with('{') && level.contains('#')
}

/// A displayed count or length (`7`, `7.`, `7.0000`), if it is a whole
/// number of a sane size.
fn parse_count(level: &str) -> Option<usize> {
    let x = parse_real(level)?;
    (x.fract() == 0.0 && (0.0..1.0e6).contains(&x)).then_some(x as usize)
}

/// Turn a reply with an error into [`Error::Calculator`].
fn checked(reply: StackReply) -> Result<StackReply> {
    match reply.error {
        Some(message) => Err(Error::Calculator {
            message,
            stack: reply.levels,
        }),
        None => Ok(reply),
    }
}

/// `'NAME'` after [`validate_name`].
fn quote(name: &str) -> Result<String> {
    validate_name(name)?;
    Ok(format!("'{name}'"))
}

/// Check that `name` is a plain global variable name
/// (`saturnus_objects::transfer::is_plain_name`: 1 to 127 characters, not
/// starting with a digit or `.`, no whitespace, control characters,
/// backslash, `@` or RPL delimiters and operators, encodable in the HP character
/// set). The names Windows reserves for devices (`CON`, `NUL`, `COM1`, ...,
/// also with an extension such as `NUL.X`, any case) are refused on every
/// platform: a name is the default file name of a download, and the
/// calculator has commands of most of these names anyway.
pub fn validate_name(name: &str) -> Result<()> {
    if !saturnus_objects::transfer::is_plain_name(name) || is_windows_device(name) {
        return Err(Error::Name(name.to_string()));
    }
    Ok(())
}

/// `CON`, `PRN`, `AUX`, `NUL`, `COM1`-`COM9` or `LPT1`-`LPT9`, in any case,
/// alone or before a `.`.
fn is_windows_device(name: &str) -> bool {
    let stem = name
        .split('.')
        .next()
        .unwrap_or_default()
        .to_ascii_uppercase();
    match stem.as_bytes() {
        b"CON" | b"PRN" | b"AUX" | b"NUL" => true,
        [b'C', b'O', b'M', d] | [b'L', b'P', b'T', d] => (b'1'..=b'9').contains(d),
        _ => false,
    }
}

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::expect_used)]
pub(crate) mod tests {
    use super::*;
    use crate::session::Options;
    use crate::transport::MemoryTransport;
    use kermit_proto::codec::{BlockCheck, Deframer, Framing, Packet, parse_frame};
    use kermit_proto::prefix::{self, Quoting};
    use std::sync::{Arc, Mutex};

    pub(crate) type Log = Arc<Mutex<Vec<String>>>;

    /// A Kermit server answering `C` and `G D` like the 48SX trace
    /// `48sx-host.trace`, with block check type 1: S, then X, D.., Z, B,
    /// each after the ACK of the previous one. `reply` maps the decoded
    /// command (`G D` for the listing) to the reply text.
    pub(crate) fn fake_server(
        log: Log,
        mut reply: impl FnMut(&str) -> String + Send + 'static,
    ) -> impl FnMut(&[u8]) -> Vec<Vec<u8>> + Send {
        let check = BlockCheck::Type1;
        let mut deframer = Deframer::new();
        let mut queue: Vec<Packet> = Vec::new();
        move |bytes| {
            let wire = |p: &Packet| p.encode(check, &Framing::default()).unwrap();
            deframer.push(bytes);
            let mut out = Vec::new();
            while let Some(frame) = deframer.next_frame() {
                let p = parse_frame(&frame, check).unwrap();
                let data = prefix::decode(&p.data, &Quoting::default()).unwrap();
                match p.kind {
                    b'G' if data == b"F" => {
                        // FINISH: a plain ACK.
                        log.lock().unwrap().push("G F".into());
                        out.push(wire(&Packet::new(p.seq, b'Y', Vec::new())));
                    }
                    b'C' | b'G' => {
                        let command = if p.kind == b'G' {
                            format!("G {}", decode(&data))
                        } else {
                            decode(&data)
                        };
                        log.lock().unwrap().push(command.clone());
                        let reply = reply(&command);
                        // `SILENT` never answers (the client times out);
                        // `E:message` plays an E packet instead of a reply.
                        if reply == "SILENT" {
                            queue.clear();
                            continue;
                        }
                        if let Some(message) = reply.strip_prefix("E:") {
                            queue.clear();
                            out.push(wire(&Packet::new(0, b'E', message.as_bytes().to_vec())));
                            continue;
                        }
                        let text = encode(&reply).unwrap();
                        queue = vec![Packet::new(1, b'X', Vec::new())];
                        let mut rest = text.as_slice();
                        while !rest.is_empty() {
                            let (enc, used) = prefix::encode(rest, &Quoting::default(), 90);
                            let seq = u8::try_from(queue.len() + 1).unwrap();
                            queue.push(Packet::new(seq, b'D', enc));
                            rest = &rest[used..];
                        }
                        let seq = u8::try_from(queue.len() + 1).unwrap();
                        queue.push(Packet::new(seq, b'Z', Vec::new()));
                        queue.push(Packet::new(seq + 1, b'B', Vec::new()));
                        out.push(wire(&Packet::new(0, b'S', b"~* @-#Y1 ".to_vec())));
                    }
                    b'Y' => {
                        if let Some(next) = queue.iter().find(|q| q.seq == p.seq + 1) {
                            out.push(wire(next));
                        }
                    }
                    // A reply packet NAKed: send it again.
                    b'N' => {
                        if let Some(again) = queue.iter().find(|q| q.seq == p.seq) {
                            out.push(wire(again));
                        }
                    }
                    // The client gave up (timeout).
                    b'E' => queue.clear(),
                    kind => panic!("unexpected packet {}", char::from(kind)),
                }
            }
            out
        }
    }

    fn calc(reply: impl FnMut(&str) -> String + Send + 'static) -> (Calculator, Log) {
        let log: Log = Arc::default();
        let transport = MemoryTransport::new(fake_server(Arc::clone(&log), reply));
        let mut kermit = Options::default().kermit;
        kermit.timeout = Duration::from_millis(200);
        // The fake server never repeats a B: no linger, no wait.
        kermit.linger = Duration::ZERO;
        let options = Options {
            kermit,
            drain: Duration::ZERO,
            turnaround: Duration::ZERO,
        };
        let session = Session::new(Box::new(transport), options).unwrap();
        (Calculator::new(session), log)
    }

    fn sent(log: &Log) -> Vec<String> {
        log.lock().unwrap().clone()
    }

    const EMPTY: &str = "Empty Stack\r\n";
    const GX_DIR: &str =
        "{ HOME D1 } 127847\r\nX 10.5 Real Number 1234\r\nSUB 5.5 Directory 4321\r\n";
    const SX_DIR: &str = "X 10.5 Real Number 1234\r\nSUB 5.5 Directory 4321\r\n";

    /// The 48SX's `RCLF` as the emulated one shows it.
    const SX_FLAGS: &str = "{ # 1008d # 0d }";
    /// The emulated 49G's (ROM 2.15) `RCLF`, cut at 22 characters.
    const G49_FLAGS: &str = "{# 2000204010FF0h,# 0h";

    #[test]
    fn mem_drops_its_value() {
        let (mut c, log) = calc(|cmd| match cmd {
            MEM_STD => format!("2: {SX_FLAGS}\r\n1:              12345\r\n"),
            _ => EMPTY.into(),
        });
        assert_eq!(c.mem().unwrap(), 12345.0);
        assert_eq!(sent(&log), [MEM_STD, "DROP STOF"]);
    }

    #[test]
    fn path_from_listing_header() {
        let (mut c, log) = calc(|cmd| match cmd {
            "G D" => GX_DIR.into(),
            _ => panic!("unexpected {cmd}"),
        });
        assert_eq!(c.path().unwrap(), ["HOME", "D1"]);
        assert_eq!(sent(&log), ["G D"]);
    }

    const MARKER: &str = "SATX-0a1b2c";
    const MARKER_CMD: &str = "\"SATX-0a1b2c\"";

    /// Sync with [`MARKER`] against a server whose replies to the marker
    /// command are `replies` in order (then an empty stack); the log of
    /// what was sent.
    fn sync_against(replies: Vec<&'static str>) -> Vec<String> {
        let (result, log) = try_sync_against(replies);
        result.unwrap();
        log
    }

    /// [`sync_against`] without the unwrap.
    fn try_sync_against(replies: Vec<&'static str>) -> (Result<()>, Vec<String>) {
        let mut replies = replies.into_iter();
        let (mut c, log) = calc(move |cmd| match cmd {
            MARKER_CMD => replies.next().unwrap_or(EMPTY).into(),
            "DROP" | "DROP2" => EMPTY.into(),
            _ => panic!("unexpected {cmd}"),
        });
        let result = c.sync_with(MARKER);
        (result, sent(&log))
    }

    fn assert_not_in_step(result: Result<()>) {
        assert!(
            matches!(&result, Err(Error::Reply(m)) if m.contains("not in step")),
            "{result:?}"
        );
    }

    #[test]
    fn sync_marker_is_short_and_plain() {
        let m = sync_marker();
        assert_eq!(m.len(), 11, "{m}");
        assert!(m.starts_with("SATX-"));
        assert!(m[5..].chars().all(|c| c.is_ascii_hexdigit()), "{m}");
        assert_ne!(sync_marker(), sync_marker());
    }

    #[test]
    fn sync_in_step_costs_two_transactions() {
        let one = "1:      \"SATX-0a1b2c\"\r\n";
        assert_eq!(sync_against(vec![one]), [MARKER_CMD, "DROP"]);
    }

    /// The first command after an aborted client is eaten by the server and
    /// answered with the late reply of the aborted command (here a stack
    /// display): sync sends the marker again and drops only the marker.
    #[test]
    fn sync_skips_a_stale_reply() {
        let stale = "2:                  1\r\n1:                  2\r\n";
        let ours = "3:                  1\r\n2:                  2\r\n1:      \"SATX-0a1b2c\"\r\n";
        assert_eq!(
            sync_against(vec![stale, ours]),
            [MARKER_CMD, MARKER_CMD, "DROP"]
        );
    }

    /// A late reply that is a 49G path cut at the display width (no closing
    /// brace, fixture `49g-vars.txt` style) is not taken for ours.
    #[test]
    fn sync_skips_a_truncated_path_reply() {
        let stale = "1: {HOME,SATXAAAA,SATXBB\r\n";
        let ours = "2: {HOME,SATXAAAA,SATXBB\r\n1:      \"SATX-0a1b2c\"\r\n";
        assert_eq!(
            sync_against(vec![stale, ours]),
            [MARKER_CMD, MARKER_CMD, "DROP"]
        );
    }

    /// The aborted command's own result was a path: it stays on the stack.
    #[test]
    fn sync_keeps_a_path_shaped_stale_result() {
        let stale = "1:          { HOME }\r\n";
        let ours = "2:          { HOME }\r\n1:      \"SATX-0a1b2c\"\r\n";
        // One DROP for the marker; the path at level 2 is the user's.
        assert_eq!(
            sync_against(vec![stale, ours]),
            [MARKER_CMD, MARKER_CMD, "DROP"]
        );
    }

    /// In a deep 49G directory the stack shows truncated values; the marker
    /// at level 1 is recognised all the same and only it is dropped.
    #[test]
    fn sync_in_a_deep_49g_directory() {
        let ours = "2: {D1,G,TG,B,C,A,P,L,S,R\r\n1: \"SATX-0a1b2c\"\r\n";
        assert_eq!(sync_against(vec![ours]), [MARKER_CMD, "DROP"]);
    }

    /// Our first marker command was not eaten after all: both copies are
    /// ours and both go.
    #[test]
    fn sync_drops_every_copy_of_its_marker() {
        let stale = "Error: Bad Argument Type\r\n";
        let ours =
            "3:                  7\r\n2:      \"SATX-0a1b2c\"\r\n1:      \"SATX-0a1b2c\"\r\n";
        assert_eq!(
            sync_against(vec![stale, ours]),
            [MARKER_CMD, MARKER_CMD, "DROP2"]
        );
    }

    /// An E packet (the calculator aborting a leftover transfer) is an odd
    /// reply, not an error: the marker goes again.
    #[test]
    fn sync_survives_an_error_packet() {
        let ours = "1:      \"SATX-0a1b2c\"\r\n";
        assert_eq!(
            sync_against(vec!["E:Transfer Failed", ours]),
            [MARKER_CMD, MARKER_CMD, "DROP"]
        );
        let (result, log) = try_sync_against(vec!["E:Transfer Failed", "E:Transfer Failed"]);
        assert_eq!(log, [MARKER_CMD, MARKER_CMD]);
        assert_not_in_step(result);
    }

    /// The first marker command ran but its reply never came (timeout): the
    /// second reply shows both markers and both go. A second timeout is a
    /// link failure.
    #[test]
    fn sync_retries_once_after_a_timeout() {
        let mut n = 0;
        let (mut c, log) = calc(move |cmd| {
            n += 1;
            match (cmd, n) {
                (MARKER_CMD, 1) => "SILENT".into(),
                (MARKER_CMD, _) => {
                    "3:                  7\r\n2:      \"SATX-0a1b2c\"\r\n1:      \"SATX-0a1b2c\"\r\n"
                        .into()
                }
                ("DROP2", _) => EMPTY.into(),
                _ => panic!("unexpected {cmd}"),
            }
        });
        c.sync_with(MARKER).unwrap();
        assert_eq!(sent(&log), [MARKER_CMD, MARKER_CMD, "DROP2"]);
        // The normal budget is back for everything after the sync.
        assert_eq!(
            c.session().config().retries,
            Options::default().kermit.retries
        );

        let (mut c, log) = calc(|_| "SILENT".into());
        let err = c.sync_with(MARKER).unwrap_err();
        assert!(
            matches!(err, Error::Kermit(kermit_proto::Error::Timeout)),
            "{err:?}"
        );
        // The first attempt is one try (no retransmission), the second the
        // normal budget (1 + 5); only the marker is ever sent.
        let log = sent(&log);
        assert_eq!(log.len(), 1 + 6, "{log:?}");
        assert!(log.iter().all(|c| c == MARKER_CMD), "{log:?}");
    }

    /// Audit PR #18, #2: two odd replies in a row are an error (they used
    /// to be accepted as success). Nothing is dropped and there is no third
    /// attempt: a marker below level 1 or another marker is not ours to
    /// drop.
    #[test]
    fn sync_never_drops_what_it_did_not_push() {
        let error = "Error: Bad Argument Type\r\n1:                  1\r\n";
        let (result, log) = try_sync_against(vec![error, EMPTY]);
        assert_eq!(log, [MARKER_CMD, MARKER_CMD]);
        assert_not_in_step(result);
        let below = "2:      \"SATX-0a1b2c\"\r\n1:                  1\r\n";
        let other = "1:      \"SATX-ffffff\"\r\n";
        let (result, log) = try_sync_against(vec![below, other]);
        assert_eq!(log, [MARKER_CMD, MARKER_CMD]);
        assert_not_in_step(result);
    }

    /// Audit PR #18, #1: a host command goes out once. Its reply is late
    /// (never comes here) and a NAK is read within the `C`'s wire time (a
    /// stale NAK of the idle server that was waiting in the input, read at
    /// once, or one sent while the `C` was on the wire, read halfway
    /// through it; PR #26 review, #1): no `C` is resent, neither after the
    /// NAK nor after the timeout, and the error says the command may have
    /// run. On a fake clock through the [`Machine`](crate::Machine): with
    /// the real clock a runner that stalled for the `C`'s wire time
    /// (~17 ms) between sending it and reading the NAK made it the
    /// calculator's rejection, and the `C` went out twice (macOS CI, PR
    /// 147). That the session's retries come back after a host command is
    /// [`host_command_late_nak_is_not_resent`]'s check.
    #[test]
    fn host_command_is_never_resent() {
        use crate::machine::{Machine, Op};
        use crate::time::Instant;
        for halves in [0, 1] {
            let log: Log = Arc::default();
            let mut server = fake_server(Arc::clone(&log), |_| "SILENT".into());
            let check = BlockCheck::Type1;
            let mut deframer = Deframer::new();
            let timeout = Duration::from_millis(300);
            let mut kermit = Options::default().kermit;
            kermit.timeout = timeout;
            let options = Options {
                kermit,
                drain: Duration::ZERO,
                turnaround: Duration::ZERO,
            };
            let t0 = Instant::now();
            let mut clock = t0;
            let mut m = Machine::new(clock, options, 1);
            m.set_events(false);
            m.start(clock, Op::Run("1 'X' STO+".into())).unwrap();
            let mut result = None;
            for _ in 0..1000 {
                while let Some(bytes) = m.poll_transmit() {
                    let mut out = server(&bytes);
                    // A NAK after each C, at once or halfway through its
                    // wire time: a stale one from the idle server, or the
                    // server asking for the C again.
                    deframer.push(&bytes);
                    while let Some(frame) = deframer.next_frame() {
                        if parse_frame(&frame, check).unwrap().kind == b'C' {
                            let nak = Packet::new(0, b'N', Vec::new());
                            out.push(nak.encode(check, &Framing::default()).unwrap());
                            let wire = HOST_BYTE_TIME * u32::try_from(bytes.len()).unwrap();
                            clock += wire * halves / 2;
                        }
                    }
                    for chunk in out {
                        m.handle_input(clock, &chunk);
                    }
                }
                result = m.poll_result();
                if result.is_some() {
                    break;
                }
                let deadline = m.next_timeout().expect("waits without a deadline");
                clock = clock.max(deadline);
                m.handle_timeout(clock);
            }
            let err = result.expect("no result").unwrap_err();
            assert!(
                matches!(&err, Error::NoReply { command } if command == "1 'X' STO+"),
                "{err:?}"
            );
            assert!(err.to_string().contains("may have run"), "{err}");
            assert_eq!(sent(&log), ["1 'X' STO+"], "NAK after {halves}/2 wire time");
            // The NAK did not cut the wait short (the old grace was 1 s, here
            // longer than the timeout; the deadline is the full timeout).
            assert!(clock - t0 >= timeout, "{:?}", clock - t0);
        }
    }

    /// Iteration 13: the idle server's NAK (it NAKs once, a server timeout
    /// after its last packet, and then stays silent) arrives after
    /// [`HOST_NAK_WINDOW`] (300 ms after the `C`), with the reply late
    /// (never here): it may have crossed a `C` the server took, so no `C` is
    /// resent, and the wait is the full timeout.
    #[test]
    fn host_command_late_nak_is_not_resent() {
        let log: Log = Arc::default();
        let mut server = fake_server(Arc::clone(&log), |_| "SILENT".into());
        let check = BlockCheck::Type1;
        let mut deframer = Deframer::new();
        let transport = MemoryTransport::new(move |bytes: &[u8]| {
            let mut out = server(bytes);
            // A NAK after each C, outside the immediate-NAK window: a
            // stale one from the idle server that crossed the C.
            deframer.push(bytes);
            while let Some(frame) = deframer.next_frame() {
                if parse_frame(&frame, check).unwrap().kind == b'C' {
                    std::thread::sleep(HOST_NAK_WINDOW + Duration::from_millis(50));
                    let nak = Packet::new(0, b'N', Vec::new());
                    out.push(nak.encode(check, &Framing::default()).unwrap());
                }
            }
            out
        });
        let mut kermit = Options::default().kermit;
        kermit.timeout = Duration::from_millis(600);
        let options = Options {
            kermit,
            drain: Duration::ZERO,
            turnaround: Duration::ZERO,
        };
        let mut c = Calculator::new(Session::new(Box::new(transport), options).unwrap());
        let start = std::time::Instant::now();
        let err = c.run("1 'X' STO+").unwrap_err();
        assert!(
            matches!(&err, Error::NoReply { command } if command == "1 'X' STO+"),
            "{err:?}"
        );
        assert!(err.to_string().contains("may have run"), "{err}");
        assert_eq!(sent(&log), ["1 'X' STO+"]);
        // The NAK did not cut the wait short (the old grace was 1 s, here
        // longer than the timeout; the deadline is the full timeout).
        assert!(start.elapsed() >= Duration::from_millis(600));
        // The session's own budget is back for the next transaction.
        assert_eq!(
            c.session().config().retries,
            Options::default().kermit.retries
        );
        assert_eq!(c.session().config().first_packet_retries, None);
    }

    /// Iteration 13 (Saturnus trace, 48SX): the calculator NAKs a `C` at
    /// once and never answers it (it rejected the packet; the command did
    /// not run). The `C` is resent once after the immediate-NAK grace, and
    /// the answer to the resend completes the command, which ran once. The
    /// wiring only; the timing is kermit-proto's `immediate_nak_*` tests.
    #[test]
    fn host_command_rejected_at_once_is_resent() {
        let log: Log = Arc::default();
        let mut server = fake_server(Arc::clone(&log), |_| "1:                 42\r\n".into());
        let wire: Log = Arc::default();
        let on_wire = Arc::clone(&wire);
        let check = BlockCheck::Type1;
        let mut deframer = Deframer::new();
        let transport = MemoryTransport::new(move |bytes: &[u8]| {
            deframer.push(bytes);
            let mut first_c = false;
            while let Some(frame) = deframer.next_frame() {
                if parse_frame(&frame, check).unwrap().kind == b'C' {
                    let mut seen = on_wire.lock().unwrap();
                    seen.push("C".into());
                    first_c = seen.len() == 1;
                }
            }
            if first_c {
                // Rejected: a NAK once the C is in (after its wire time at
                // 9600 baud, ~11 ms); the server never runs the C.
                std::thread::sleep(Duration::from_millis(30));
                let nak = Packet::new(0, b'N', Vec::new());
                return vec![nak.encode(check, &Framing::default()).unwrap()];
            }
            server(bytes)
        });
        // A short timeout: the immediate-NAK grace is capped by it.
        let mut kermit = Options::default().kermit;
        kermit.timeout = Duration::from_millis(300);
        kermit.linger = Duration::ZERO;
        let options = Options {
            kermit,
            drain: Duration::ZERO,
            turnaround: Duration::ZERO,
        };
        let mut c = Calculator::new(Session::new(Box::new(transport), options).unwrap());
        assert_eq!(c.run("6 7 *").unwrap().levels, ["42"]);
        assert_eq!(sent(&wire), ["C", "C"]);
        assert_eq!(sent(&log), ["6 7 *"]);
        // The session's own config is back for the next transaction.
        assert_eq!(c.session().config().first_packet_nak_window, None);
    }

    /// A calculator over `fake_server` whose D packets are lost `drop`
    /// times (`usize::MAX`: always).
    fn calc_dropping_data(
        drop: usize,
        reply: impl FnMut(&str) -> String + Send + 'static,
    ) -> (Calculator, Log) {
        let log: Log = Arc::default();
        let mut server = fake_server(Arc::clone(&log), reply);
        let mut left = drop;
        let mut deframer = Deframer::new();
        let transport = MemoryTransport::new(move |bytes: &[u8]| {
            let mut out = server(bytes);
            out.retain(|chunk| {
                deframer.push(chunk);
                let data = deframer
                    .next_frame()
                    .is_some_and(|f| parse_frame(&f, BlockCheck::Type1).unwrap().kind == b'D');
                if data && left > 0 {
                    left -= 1;
                    return false;
                }
                true
            });
            out
        });
        let mut kermit = Options::default().kermit;
        kermit.timeout = Duration::from_millis(100);
        kermit.linger = Duration::ZERO;
        let options = Options {
            kermit,
            drain: Duration::ZERO,
            turnaround: Duration::ZERO,
        };
        let session = Session::new(Box::new(transport), options).unwrap();
        (Calculator::new(session), log)
    }

    /// PR #20 review: the single-shot rule covers the `C` only. A reply
    /// packet lost after the calculator's `S` is re-requested, and a reply
    /// that never completes is a Kermit timeout (the command ran), not
    /// `NoReply`.
    #[test]
    fn host_reply_packets_keep_their_retries() {
        let reply = |_: &str| "1:                 42\r\n".to_string();
        let (mut c, log) = calc_dropping_data(1, reply);
        assert_eq!(c.run("6 7 *").unwrap().levels, ["42"]);
        assert_eq!(sent(&log), ["6 7 *"]);

        let (mut c, log) = calc_dropping_data(usize::MAX, reply);
        let err = c.run("6 7 *").unwrap_err();
        assert!(
            matches!(err, Error::Kermit(kermit_proto::Error::Timeout)),
            "{err:?}"
        );
        assert_eq!(sent(&log), ["6 7 *"]);
    }

    /// `fake_server` behind a link that swallows the first `R` packet (a
    /// GET) and fails the read after it once: a transient link error.
    struct GlitchOnGet {
        inner: MemoryTransport,
        fail_next_read: bool,
        glitched: bool,
    }

    impl Transport for GlitchOnGet {
        fn write_packet(&mut self, packet: &[u8]) -> std::io::Result<()> {
            if !self.glitched && packet.get(3) == Some(&b'R') {
                self.glitched = true;
                self.fail_next_read = true;
                return Ok(());
            }
            self.inner.write_packet(packet)
        }

        fn read(&mut self, buf: &mut [u8], timeout: Duration) -> std::io::Result<usize> {
            if std::mem::take(&mut self.fail_next_read) {
                return Err(std::io::Error::other("glitch"));
            }
            self.inner.read(buf, timeout)
        }
    }

    /// PR 108 review: a link error in PICT's GET does not stop the
    /// best-effort PURGE of the temporary variable from trying the link
    /// again, as before the seam.
    #[test]
    fn pict_cleanup_tries_the_link_after_a_link_error() {
        let log: Log = Arc::default();
        let server = fake_server(Arc::clone(&log), |cmd: &str| match cmd {
            "G D" => SX_DIR.into(),
            _ => EMPTY.into(),
        });
        let transport = GlitchOnGet {
            inner: MemoryTransport::new(server),
            fail_next_read: false,
            glitched: false,
        };
        let mut kermit = Options::default().kermit;
        kermit.timeout = Duration::from_millis(200);
        kermit.linger = Duration::ZERO;
        let options = Options {
            kermit,
            drain: Duration::ZERO,
            turnaround: Duration::ZERO,
        };
        let mut c = Calculator::new(Session::new(Box::new(transport), options).unwrap());
        let err = c.pict().unwrap_err();
        assert!(
            matches!(&err, Error::Io(e) if e.to_string() == "glitch"),
            "{err:?}"
        );
        assert_eq!(
            sent(&log),
            ["G D", "PICT RCL 'SATXTMP' STO", "-35 SF", "'SATXTMP' PURGE"]
        );
    }

    /// A `STO` that fails for lack of room leaves the name and the recalled
    /// archive on the stack; they go first, or the port object's `PURGE`
    /// fails with "Object In Use". Any other failure drops nothing.
    #[test]
    fn a_failed_backup_drops_what_keeps_the_port_object_in_use() {
        for (level, dropped) in [("'SATXBK'", true), ("SATXBK", true), ("'OTHER'", false)] {
            let (mut c, log) = calc(move |cmd| match cmd {
                "G D" => "{ HOME } 1000\r\n".to_string(),
                ":0:SATXBK RCL 'SATXBK' STO :0:SATXBK PURGE" => {
                    format!("Error: Insufficient Memory\r\n2: Directory\r\n1: {level}\r\n")
                }
                _ => "Empty Stack\r\n".to_string(),
            });
            let err = c.backup().unwrap_err();
            assert!(matches!(err, Error::Calculator { .. }), "{err:?}");
            let sent = log.lock().unwrap().clone();
            let purge = sent.iter().position(|s| s == ":0:SATXBK PURGE").unwrap();
            let drop2 = sent.iter().position(|s| s == "DROP2");
            if dropped {
                assert!(drop2.is_some_and(|d| d < purge), "{sent:?}");
            } else {
                assert_eq!(drop2, None, "{sent:?}");
            }
        }
    }

    /// Audit PR #18, #3: a backup whose directory walk fails (here cut in
    /// half) is refused before anything is sent; it used to pass on its
    /// Directory prolog alone and reach RESTORE.
    #[test]
    fn restore_refuses_a_truncated_backup() {
        let path = format!("{}/fixtures/48sx-D1.hp", env!("CARGO_MANIFEST_DIR"));
        let full = std::fs::read(path).unwrap();
        let cut = &full[..full.len() / 2];
        assert_eq!(
            inspect(cut).unwrap().object_type,
            Some(ObjectType::Directory)
        );
        let (mut c, log) = calc(|cmd| panic!("unexpected {cmd}"));
        let err = c.restore(cut).unwrap_err();
        assert!(
            matches!(&err, Error::Object(m) if m.starts_with("not a backup")),
            "{err:?}"
        );
        assert!(sent(&log).is_empty());
    }

    /// PR #20 review: a backup holding a directory with an attached
    /// library (field #123, not #7FF) is a backup like any other.
    #[test]
    fn check_backup_accepts_an_attached_library() {
        let nibbles = |lib: u32| -> Vec<u8> {
            let mut n = Vec::new();
            for (value, width) in [(0x02A96u32, 5), (lib, 3), (0, 5)] {
                n.extend((0..width).map(|i| ((value >> (4 * i)) & 0xF) as u8));
            }
            n
        };
        for lib in [0x7FF, 0x123] {
            let mut data = b"HPHP48-R".to_vec();
            data.extend(crate::object::pack(&nibbles(lib)));
            check_backup(&data).unwrap();
        }
    }

    /// Audit PR #18, #9: no reply to RESTORE is success only when the probe
    /// after it gets no reply either (the warm start ended server mode); an
    /// answered probe leaves the result unknown (PR #20 review: SERVER may
    /// have been restarted after a RESTORE that ran).
    #[test]
    fn restore_probe_after_the_silent_restore() {
        const RESTORE: &str = ":0:SATXRS RESTORE";
        // RESTORE ran: the calculator is gone, the probe times out.
        let (mut c, log) = calc(|_| "SILENT".into());
        c.restore_from_port().unwrap();
        let log = sent(&log);
        assert_eq!(log.len(), 2, "{log:?}");
        assert_eq!(log[0], RESTORE);
        assert!(log[1].starts_with("\"SATX-"), "{log:?}");

        // The server answers the probe: RESTORE lost, or SERVER restarted.
        let (mut c, log) = calc(|cmd| match cmd {
            RESTORE => "SILENT".into(),
            "DROP" => EMPTY.into(),
            probe => format!("1: {probe}\r\n"),
        });
        let err = c.restore_from_port().unwrap_err();
        assert!(
            matches!(&err, Error::Reply(m) if m.contains("RESTORE's result is unknown")),
            "{err:?}"
        );
        let log = sent(&log);
        assert_eq!(log.len(), 3, "{log:?}");
        assert_eq!(log[2], "DROP", "the probe's marker is dropped");
    }

    #[test]
    fn path_query_without_header() {
        let (mut c, log) = calc(|cmd| match cmd {
            "G D" => SX_DIR.into(),
            "PATH" => "1:          { HOME D1 }\r\n".into(),
            _ => EMPTY.into(),
        });
        assert_eq!(c.path().unwrap(), ["HOME", "D1"]);
        assert_eq!(sent(&log), ["G D", "PATH", "DROP"]);
    }

    #[test]
    fn version_48sx() {
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => "1:  'VERSION'\r\n".into(),
            _ => EMPTY.into(),
        });
        assert_eq!(c.version().unwrap(), None);
        assert_eq!(sent(&log), ["VERSION", "DROP"]);
    }

    #[test]
    fn version_48gx() {
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => "2:     \"Version HP48-R\"\r\n1:  \"Copyright HP 1993\"\r\n".into(),
            _ => EMPTY.into(),
        });
        assert_eq!(
            c.version().unwrap().as_deref(),
            Some("Version HP48-R, Copyright HP 1993")
        );
        assert_eq!(sent(&log), ["VERSION", "DROP2"]);
    }

    /// A two-line version string that arrived whole.
    #[test]
    fn version_49g_two_line_string() {
        let (mut c, _) = calc(|cmd| match cmd {
            "VERSION" => {
                "2: \"Version HP49-C\r\nRevision #1.19-6\"\r\n1:  \"Copyright HP 2009\"\r\n".into()
            }
            _ => EMPTY.into(),
        });
        assert_eq!(
            c.version().unwrap().as_deref(),
            Some("Version HP49-C Revision #1.19-6, Copyright HP 2009")
        );
    }

    /// The stack reply to [`VERSION_CHUNKS`] with `version` and
    /// `copyright` on the stack above `below` (deepest first): the saved
    /// flags, the chunks, the total.
    fn chunk_reply(version: &str, copyright: &str, below: &[&str]) -> String {
        let joined: Vec<char> = format!("{version}{copyright}").chars().collect();
        let mut levels: Vec<String> = below.iter().map(|l| (*l).to_string()).collect();
        levels.push(G49_FLAGS.to_string());
        for chunk in joined.chunks(CHUNK) {
            let chunk: String = chunk.iter().collect();
            levels.push(format!("\"{}\"", chunk.replace('\n', "\r\n")));
        }
        levels.push(format!("{}.", joined.len()));
        let depth = levels.len();
        levels
            .iter()
            .enumerate()
            .map(|(i, level)| format!("{}: {level}\r\n", depth - i))
            .collect()
    }

    /// ROM 1.18 on a real 49G (2026-11-08): `VERSION`'s level 2 cut at 20
    /// characters. The whole text comes in chunks; the user's 4711 stays.
    #[test]
    fn version_49g_1_18_cut_at_the_display_width() {
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => {
                "3: 4711.\r\n2: \"Version HP49-C\r\nRevi\r\n1: \"Copyright HP 2000\"\r\n".into()
            }
            VERSION_CHUNKS => chunk_reply(
                "Version HP49-C\nRevision #1.18",
                "Copyright HP 2000",
                &["4711."],
            ),
            _ => EMPTY.into(),
        });
        let version = c.version().unwrap();
        assert_eq!(
            version.as_deref(),
            Some("Version HP49-C Revision #1.18, Copyright HP 2000")
        );
        assert_eq!(Model::from_version(version.as_deref()), Model::Hp49G);
        // 46 characters: five chunks and the total above the flags.
        assert_eq!(sent(&log), ["VERSION", VERSION_CHUNKS, "6. DROPN STOF"]);
    }

    /// ROM 2.15 on the emulated 49G: level 2 cut at 22 characters; the
    /// chunks as it sent them.
    #[test]
    fn version_49g_2_15_cut_at_the_display_width() {
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => "2: \"Version HP48-C\r\nRevisi\r\n1: \"Copyright HP 2009\"\r\n".into(),
            VERSION_CHUNKS => format!(
                "7: {G49_FLAGS}\r\n6: \"Version HP\"\r\n5: \"48-C\r\nRevis\"\r\n\
                 4: \"ion #2.15C\"\r\n3: \"opyright H\"\r\n2: \"P 2009\"\r\n1: 46.\r\n"
            ),
            _ => EMPTY.into(),
        });
        assert_eq!(
            c.version().unwrap().as_deref(),
            Some("Version HP48-C Revision #2.15, Copyright HP 2009")
        );
        assert_eq!(sent(&log), ["VERSION", VERSION_CHUNKS, "6. DROPN STOF"]);
    }

    /// Chunks that do not add up are an error, and what the command pushed
    /// is dropped all the same, the flags put back.
    #[test]
    fn version_chunks_that_do_not_add_up() {
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => "2: \"Version HP49-C\r\nRevi\r\n1: \"Copyright HP 2000\"\r\n".into(),
            VERSION_CHUNKS => format!(
                "4: {G49_FLAGS}\r\n3: \"Version\"\r\n2: \"Copyright HP 2000\"\r\n1: 20.\r\n"
            ),
            _ => EMPTY.into(),
        });
        let err = c.version().unwrap_err();
        assert!(
            matches!(&err, Error::Reply(m) if m.contains("bad chunks")),
            "{err:?}"
        );
        assert_eq!(sent(&log), ["VERSION", VERSION_CHUNKS, "3. DROPN STOF"]);
    }

    /// The copyright cut and the version whole: the version tells where
    /// the two meet.
    #[test]
    fn version_with_the_copyright_cut() {
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => "2: \"HP49-C\"\r\n1: \"Copyright HP 2000 and l\r\n".into(),
            VERSION_CHUNKS => chunk_reply("HP49-C", "Copyright HP 2000 and later", &[]),
            _ => EMPTY.into(),
        });
        assert_eq!(
            c.version().unwrap().as_deref(),
            Some("HP49-C, Copyright HP 2000 and later")
        );
        assert_eq!(sent(&log), ["VERSION", VERSION_CHUNKS, "5. DROPN STOF"]);
    }

    /// Both strings cut: nothing tells where they meet; they are dropped.
    #[test]
    fn version_with_both_strings_cut() {
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => "2: \"Version HP49-C\r\nRevi\r\n1: \"Copyright HP 2000 an\r\n".into(),
            _ => EMPTY.into(),
        });
        let err = c.version().unwrap_err();
        assert!(
            matches!(&err, Error::Reply(m) if m.contains("both")),
            "{err:?}"
        );
        assert_eq!(sent(&log), ["VERSION", "DROP2"]);
    }

    /// A failed chunk command leaves what it pushed and the two strings (or
    /// what became of them); all of it above the user's 4711 is dropped,
    /// and the flags are put back if it got as far as saving them.
    #[test]
    fn version_chunks_that_fail() {
        let cut = "3: 4711.\r\n2: \"Version HP49-C\r\nRevi\r\n1: \"Copyright HP 2000\"\r\n";
        let after_rclf = format!(
            "Error: Insufficient Memory\r\n5: 4711.\r\n4: {G49_FLAGS}\r\n\
             3: \"Version HP\"\r\n2: \"49-C\r\nRevis\"\r\n1: \"Version HP49-C\r\nRevi\r\n"
        );
        let before_rclf = format!("Error: Insufficient Memory\r\n{cut}");
        for (failed, cleanup) in [(after_rclf, "3. DROPN STOF"), (before_rclf, "DROP2")] {
            let (mut c, log) = calc(move |cmd| match cmd {
                "VERSION" => cut.into(),
                VERSION_CHUNKS => failed.clone(),
                _ => EMPTY.into(),
            });
            let err = c.version().unwrap_err();
            assert!(
                matches!(&err, Error::Calculator { message, .. } if message == "Insufficient Memory"),
                "{err:?}"
            );
            assert_eq!(sent(&log), ["VERSION", VERSION_CHUNKS, cleanup]);
        }
    }

    /// ROM 1.18 on a real 49G cuts IOPAR's list (`{ 9600. 0. 0. 0. 3. `);
    /// satx never reads the list, only its items.
    #[test]
    fn iopar_item_by_item() {
        let items_49g = format!(
            "8: {G49_FLAGS}\r\n7: 9600.\r\n6: 0.\r\n5: 0.\r\n4: 0.\r\n3: 3.\r\n2: 1.\r\n1: 6.\r\n"
        );
        let items_48 = format!(
            "9: 4711\r\n8: {SX_FLAGS}\r\n7: 9600\r\n6: 0\r\n5: 0\r\n4: 0\r\n3: 3\r\n2: 1\r\n\
             1: 6\r\n"
        );
        // With the fraction mark `,` (flag -51), which STD keeps.
        let items_comma = format!(
            "8: {G49_FLAGS}\r\n7: 2400,\r\n6: -2,\r\n5: 1,\r\n4: 0,\r\n3: 1,\r\n2: 3,\r\n1: 6,\r\n"
        );
        let other = Iopar {
            baud: 2400,
            parity: -2,
            receive_pacing: true,
            transmit_pacing: false,
            checksum: 1,
            translate: 3,
        };
        for (items, expected) in [
            (items_49g, Iopar::default()),
            (items_48, Iopar::default()),
            (items_comma, other),
        ] {
            let (mut c, log) = calc(move |cmd| match cmd {
                "IOPAR" => "1: { 9600. 0. 0. 0. 3. \r\n".into(),
                IOPAR_ITEMS => items.clone(),
                _ => EMPTY.into(),
            });
            assert_eq!(c.iopar().unwrap(), expected);
            assert_eq!(sent(&log), [IOPAR_ITEMS, IOPAR_DROP]);
        }
    }

    /// IOPAR that is not a six-item list: LIST→ refuses anything but a list
    /// and leaves it, which is dropped, the flags put back; a list of
    /// another length is dropped with its items. An error with no saved
    /// flags where they belong leaves the stack alone.
    #[test]
    fn iopar_that_is_not_a_six_item_list() {
        let (mut c, log) = calc(|cmd| match cmd {
            IOPAR_ITEMS => format!("Error: Bad Argument Type\r\n2: {SX_FLAGS}\r\n1: 'IOPAR'\r\n"),
            _ => EMPTY.into(),
        });
        let err = c.iopar().unwrap_err();
        assert!(matches!(&err, Error::Calculator { .. }), "{err:?}");
        assert_eq!(sent(&log), [IOPAR_ITEMS, "DROP STOF"]);

        let (mut c, log) = calc(|cmd| match cmd {
            IOPAR_ITEMS => "Error: Insufficient Memory\r\n1: 4711\r\n".into(),
            _ => EMPTY.into(),
        });
        assert!(c.iopar().is_err());
        assert_eq!(sent(&log), [IOPAR_ITEMS]);

        let (mut c, log) = calc(|cmd| match cmd {
            IOPAR_ITEMS => format!("4: {SX_FLAGS}\r\n3: 9600\r\n2: 0\r\n1: 2\r\n"),
            _ => EMPTY.into(),
        });
        let err = c.iopar().unwrap_err();
        assert!(
            matches!(&err, Error::Reply(m) if m.contains("bad list")),
            "{err:?}"
        );
        assert_eq!(sent(&log), [IOPAR_ITEMS, IOPAR_DROP]);
    }

    /// A real as `0 SCI` shows it: one digit (9600 is `1.E4`).
    fn sci_0(x: f64) -> String {
        if x == 0.0 {
            return "0.E0".into();
        }
        let mut exp = x.abs().log10().floor() as i32;
        let mut digit = (x / 10f64.powi(exp)).round();
        if digit.abs() >= 10.0 {
            digit /= 10.0;
            exp += 1;
        }
        format!("{digit}.E{exp}")
    }

    /// A 49G in `0 SCI` (as on the emulated one, 2026-11-08): reals show
    /// with one digit (`1.E4`) until a command sets STD and again after
    /// STOF. IOPAR, MEM and VERSION read all the digits all the same, and
    /// the mode is back afterwards.
    #[test]
    fn queries_in_0_sci() {
        let std = Arc::new(Mutex::new(false));
        let mode = Arc::clone(&std);
        let (mut c, log) = calc(move |cmd| {
            let mut std = mode.lock().unwrap();
            if cmd.contains("STD") {
                *std = true;
            }
            let real = |x: f64| if *std { format!("{x}.") } else { sci_0(x) };
            let reply = match cmd {
                "VERSION" => G49_VERSION.into(),
                VERSION_CHUNKS => {
                    let joined = "Version HP48-C\nRevision #2.15Copyright HP 2009";
                    let mut levels = vec![G49_FLAGS.to_string()];
                    let chars: Vec<char> = joined.chars().collect();
                    for chunk in chars.chunks(CHUNK) {
                        let chunk: String = chunk.iter().collect();
                        levels.push(format!("\"{}\"", chunk.replace('\n', "\r\n")));
                    }
                    levels.push(real(chars.len() as f64));
                    let depth = levels.len();
                    levels
                        .iter()
                        .enumerate()
                        .map(|(i, l)| format!("{}: {l}\r\n", depth - i))
                        .collect()
                }
                IOPAR_ITEMS => {
                    let items = [9600.0, 0.0, 0.0, 0.0, 3.0, 1.0, 6.0];
                    let mut text = format!("8: {G49_FLAGS}\r\n");
                    for (i, x) in items.iter().enumerate() {
                        text.push_str(&format!("{}: {}\r\n", 7 - i, real(*x)));
                    }
                    text
                }
                MEM_STD => format!("2: {G49_FLAGS}\r\n1: {}\r\n", real(245_886.0)),
                "-35 FS?" => format!("1: {}\r\n", real(1.0)),
                _ => EMPTY.into(),
            };
            if cmd.ends_with("STOF") {
                *std = false;
            }
            reply
        });
        assert_eq!(c.iopar().unwrap(), Iopar::default());
        assert!(!*std.lock().unwrap(), "STD left on after IOPAR");
        assert_eq!(c.mem().unwrap(), 245_886.0);
        assert_eq!(
            c.version().unwrap().as_deref(),
            Some("Version HP48-C Revision #2.15, Copyright HP 2009")
        );
        assert!(!*std.lock().unwrap(), "STD left on after VERSION");
        // A flag is 0 or 1 in any mode: `1.E0`.
        assert_eq!(c.transfer_mode().unwrap(), TransferMode::Binary);
        assert_eq!(
            sent(&log),
            [
                IOPAR_ITEMS,
                IOPAR_DROP,
                MEM_STD,
                "DROP STOF",
                "VERSION",
                VERSION_CHUNKS,
                "6. DROPN STOF",
                "-35 FS?",
                "DROP",
            ]
        );
        assert_eq!(sci_0(9600.0), "1.E4");
        assert_eq!(sci_0(46.0), "5.E1");
    }

    #[test]
    fn model_from_version() {
        use Model::*;
        assert_eq!(Model::from_version(None), Hp48Sx);
        assert_eq!(
            Model::from_version(Some("Version HP48-R, Copyright HP 1993")),
            Hp48Gx
        );
        assert_eq!(
            Model::from_version(Some("Version HP48-C Revision #2.15, Copyright HP 2009")),
            Hp49G
        );
        assert_eq!(
            Model::from_version(Some("Version HP49-C, Copyright HP 2000")),
            Hp49G
        );
        assert_eq!(Model::from_version(Some("something else")), Unknown);
        assert_eq!(Hp48Gx.name(), "HP 48G/GX");
        assert!(!Hp48Sx.has_xmodem() && Hp48Gx.has_xmodem() && Hp49G.has_xmodem());
    }

    const G49_VERSION: &str = "2: \"Version HP48-C\r\nRevisi\r\n1:  \"Copyright HP 2009\"\r\n";
    const GX_VERSION: &str = "2:     \"Version HP48-R\"\r\n1:  \"Copyright HP 1993\"\r\n";

    #[test]
    fn prepare_xrecv_on_49g_in_alg_mode() {
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => G49_VERSION.into(),
            VERSION_CHUNKS => {
                chunk_reply("Version HP48-C\nRevision #2.15", "Copyright HP 2009", &[])
            }
            "G D" => "{ HOME } 2000.\r\nSATXX 10.5 String 1234.\r\n".into(),
            "-95. FS?" => "1:                     1.\r\n".into(),
            _ => EMPTY.into(),
        });
        let plan = c
            .prepare_for_xmodem(XmodemDirection::ToCalculator, "SATXX")
            .unwrap();
        assert_eq!(
            sent(&log),
            [
                "VERSION",
                VERSION_CHUNKS,
                "6. DROPN STOF",
                "G D",
                "-95. FS?",
                "DROP",
                "-95. CF",
                "\u{ab} 'SATXX' XRECV \u{bb}",
                "G F"
            ]
        );
        assert_eq!(plan.model, Model::Hp49G);
        assert_eq!(plan.program, "\u{ab} 'SATXX' XRECV \u{bb}");
        assert_eq!(plan.keys, ["right-shift", "SYMB"]);
        assert!(plan.exists && plan.switched_to_rpn);
        let text = plan.instructions();
        assert!(
            text.starts_with(
                "\u{ab} 'SATXX' XRECV \u{bb} is on the calculator's stack. On the calculator, \
                 press right-shift, then SYMB (EVAL) to run it."
            ),
            "{text}"
        );
        assert!(text.contains("SATXX.1"), "{text}");
        assert!(text.contains("-95 SF"), "{text}");
        assert!(text.contains("drops the program"), "{text}");
        assert!(
            text.ends_with("type SERVER and press ENTER after the transfer."),
            "{text}"
        );
    }

    /// Review of PR #261: the program could not be put on the stack, so
    /// the 49G goes back to algebraic mode and the error is the push's.
    #[test]
    fn prepare_xrecv_failed_push_restores_alg_mode() {
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => G49_VERSION.into(),
            VERSION_CHUNKS => {
                chunk_reply("Version HP48-C\nRevision #2.15", "Copyright HP 2009", &[])
            }
            "G D" => "{ HOME } 2000.\r\n".into(),
            "-95. FS?" => "1:                     1.\r\n".into(),
            "\u{ab} 'SATXX' XRECV \u{bb}" => "Error: Insufficient Memory\r\n".into(),
            _ => EMPTY.into(),
        });
        let err = c
            .prepare_for_xmodem(XmodemDirection::ToCalculator, "SATXX")
            .unwrap_err();
        assert!(matches!(err, Error::Calculator { .. }), "{err:?}");
        let sent = sent(&log);
        assert_eq!(
            &sent[sent.len() - 3..],
            ["-95. CF", "\u{ab} 'SATXX' XRECV \u{bb}", "-95. SF"]
        );
    }

    #[test]
    fn prepare_xsend_on_48gx() {
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => GX_VERSION.into(),
            "G D" => "{ HOME } 2000\r\nSATXX 10.5 String 1234\r\n".into(),
            _ => EMPTY.into(),
        });
        let plan = c
            .prepare_for_xmodem(XmodemDirection::FromCalculator, "SATXX")
            .unwrap();
        assert_eq!(
            sent(&log),
            [
                "VERSION",
                "DROP2",
                "G D",
                "\u{ab} 'SATXX' XSEND \u{bb}",
                "G F"
            ]
        );
        assert_eq!(plan.keys, ["EVAL"]);
        assert!(!plan.switched_to_rpn);
        assert_eq!(plan.notes.len(), 2);
        let text = plan.instructions();
        assert!(text.contains("press EVAL to run it."), "{text}");
        assert!(text.ends_with("press right-shift, then \u{2192} (or type SERVER and press ENTER) after the transfer."), "{text}");
    }

    #[test]
    fn prepare_refuses_existing_name_on_48gx() {
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => GX_VERSION.into(),
            "G D" => "{ HOME } 2000\r\nSATXX 10.5 String 1234\r\n".into(),
            _ => EMPTY.into(),
        });
        let err = c
            .prepare_for_xmodem(XmodemDirection::ToCalculator, "SATXX")
            .unwrap_err();
        assert!(matches!(&err, Error::Reply(m) if m == "SATXX: already exists"));
        assert_eq!(sent(&log), ["VERSION", "DROP2", "G D"]);
    }

    #[test]
    fn prepare_refuses_before_finishing() {
        // XSEND of a missing variable, and any XModem on a 48SX, fail
        // without ending server mode.
        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => GX_VERSION.into(),
            "G D" => "{ HOME } 2000\r\n".into(),
            _ => EMPTY.into(),
        });
        let err = c
            .prepare_for_xmodem(XmodemDirection::FromCalculator, "NOSUCH")
            .unwrap_err();
        assert!(matches!(&err, Error::Reply(m) if m == "NOSUCH: no such variable"));
        assert!(!sent(&log).contains(&"G F".to_string()));
        assert!(matches!(
            c.prepare_for_xmodem(XmodemDirection::ToCalculator, "A B"),
            Err(Error::Name(_))
        ));

        let (mut c, log) = calc(|cmd| match cmd {
            "VERSION" => "1:  'VERSION'\r\n".into(),
            _ => EMPTY.into(),
        });
        let err = c
            .prepare_for_xmodem(XmodemDirection::ToCalculator, "X")
            .unwrap_err();
        assert!(matches!(err, Error::Unsupported(_)), "{err:?}");
        assert_eq!(sent(&log), ["VERSION", "DROP"]);
    }

    #[test]
    fn cd_checks_each_component() {
        let (mut c, log) = calc(|cmd| match cmd {
            "G D" => "D1 5.5 Directory 4321\r\nX 10.5 Real Number 1234\r\n".into(),
            _ => EMPTY.into(),
        });
        c.cd(&["HOME", "D1"]).unwrap();
        assert_eq!(sent(&log), ["HOME", "G D", "D1"]);

        log.lock().unwrap().clear();
        let err = c.cd(&["NOSUCH"]).unwrap_err();
        assert!(matches!(&err, Error::Reply(m) if m.contains("no such directory")));
        assert_eq!(sent(&log), ["HOME", "G D"]);

        log.lock().unwrap().clear();
        let err = c.cd(&["HOME", "X"]).unwrap_err();
        assert!(matches!(&err, Error::Reply(m) if m.contains("no such directory")));
        assert_eq!(sent(&log), ["HOME", "G D"]);

        log.lock().unwrap().clear();
        assert!(matches!(c.cd(&["A B"]), Err(Error::Name(_))));
        assert!(sent(&log).is_empty());
    }

    #[test]
    fn rename_joined_split_and_directory() {
        let (mut c, log) = calc(|cmd| match cmd {
            "G D" => format!(
                "X 10.5 Real Number 1234\r\nSUB 5.5 Directory 4321\r\n{} 10.5 Real Number 1\r\n",
                "L".repeat(40)
            ),
            _ => EMPTY.into(),
        });
        c.rename("X", "Y").unwrap();
        assert_eq!(sent(&log), ["G D", "'X' RCL 'Y' STO 'X' PURGE"]);

        log.lock().unwrap().clear();
        let long = "L".repeat(40);
        let to = "M".repeat(40);
        c.rename(&long, &to).unwrap();
        assert_eq!(
            sent(&log),
            [
                "G D".to_string(),
                format!("'{long}' RCL"),
                format!("'{to}' STO"),
                format!("'{long}' PURGE"),
            ]
        );

        log.lock().unwrap().clear();
        c.rename("SUB", "SUB2").unwrap();
        assert_eq!(sent(&log), ["G D", "'SUB' RCL 'SUB2' STO 'SUB' PGDIR"]);

        log.lock().unwrap().clear();
        assert!(matches!(c.rename("NOSUCH", "Z"), Err(Error::Reply(_))));
        assert!(matches!(c.rename("X", "SUB"), Err(Error::Reply(_))));
        assert_eq!(sent(&log), ["G D", "G D"]);
    }

    #[test]
    fn remove_checks_listing() {
        let (mut c, log) = calc(|cmd| match cmd {
            "G D" => SX_DIR.into(),
            _ => EMPTY.into(),
        });
        let err = c.remove("NOSUCH").unwrap_err();
        assert!(matches!(&err, Error::Reply(m) if m.contains("no such variable")));
        assert_eq!(sent(&log), ["G D"]);
        c.remove("SUB").unwrap();
        c.remove("X").unwrap();
        assert_eq!(
            sent(&log),
            ["G D", "G D", "'SUB' PGDIR", "G D", "'X' PURGE"]
        );
    }

    #[test]
    fn calculator_error() {
        let (mut c, _) = calc(|_| "Error: Undefined Name\r\n1:          'NOSUCH'\r\n".into());
        let reply = c.run("'NOSUCH' RCL").unwrap();
        assert_eq!(reply.error.as_deref(), Some("Undefined Name"));
        let err = c.mkdir("NOSUCH").unwrap_err();
        assert!(
            matches!(&err, Error::Calculator { message, stack }
                if message == "Undefined Name" && stack == &["'NOSUCH'"]),
            "{err:?}"
        );
    }

    #[test]
    fn transfer_mode_is_cached() {
        let (mut c, log) = calc(|_| EMPTY.into());
        c.set_transfer_mode(TransferMode::Binary).unwrap();
        c.set_transfer_mode(TransferMode::Binary).unwrap();
        assert_eq!(sent(&log), ["-35 SF"]);
        c.set_transfer_mode(TransferMode::Ascii).unwrap();
        assert_eq!(sent(&log), ["-35 SF", "-35 CF"]);
        // An arbitrary command may change the flag.
        c.run("1").unwrap();
        c.set_transfer_mode(TransferMode::Ascii).unwrap();
        assert_eq!(sent(&log), ["-35 SF", "-35 CF", "1", "-35 CF"]);
    }

    #[test]
    fn transfer_mode_query() {
        let (mut c, log) = calc(|cmd| match cmd {
            "-35 FS?" => "1: 1.\r\n".into(),
            _ => EMPTY.into(),
        });
        assert_eq!(c.transfer_mode().unwrap(), TransferMode::Binary);
        c.set_transfer_mode(TransferMode::Binary).unwrap();
        assert_eq!(sent(&log), ["-35 FS?", "DROP"]);
    }

    #[test]
    fn set_iopar_stores_reals() {
        // Recorded on the emulated 49G: `{ 9600 0 0 0 3 3 }` stored as exact
        // integers, the server answered nothing and stopped with "Invalid
        // IOPAR". The list must hold reals, in one command.
        let (mut c, log) = calc(|_| EMPTY.into());
        let iopar = Iopar {
            translate: 3,
            ..Iopar::default()
        };
        c.set_iopar(&iopar).unwrap();
        assert_eq!(
            sent(&log),
            ["PATH HOME { 9600. 0. 0. 0. 3. 3. } 'IOPAR' STO EVAL"]
        );
        // The widest list still fits one `C` packet, so it is never split.
        log.lock().unwrap().clear();
        let wide = Iopar {
            baud: 115_200,
            parity: -4,
            receive_pacing: true,
            transmit_pacing: true,
            checksum: 3,
            translate: 255,
        };
        c.set_iopar(&wide).unwrap();
        assert_eq!(
            sent(&log),
            ["PATH HOME { 115200. -4. 1. 1. 3. 255. } 'IOPAR' STO EVAL"]
        );
    }

    #[test]
    fn command_too_long() {
        let (mut c, log) = calc(|_| EMPTY.into());
        let err = c.run(&"1".repeat(200)).unwrap_err();
        assert!(
            matches!(err, Error::CommandTooLong { len: 200, .. }),
            "{err:?}"
        );
        assert!(sent(&log).is_empty());
        c.run("1").unwrap();
    }

    #[test]
    fn names() {
        for ok in [
            "A",
            "SATXE2E",
            "IOPAR",
            "x\u{0304}",
            "Σ1",
            "a.b",
            "CONS",
            "COM0",
            "COM10",
            "LPT",
            "XNUL",
            &"N".repeat(127),
        ] {
            assert!(validate_name(ok).is_ok(), "{ok:?}");
        }
        for bad in [
            "",
            "1A",
            ".A",
            "A B",
            "A\tB",
            "A'",
            "A\"",
            "«A",
            "{A}",
            "A[1]",
            "F(X)",
            "#A",
            ":0:A",
            "A,B",
            "A;B",
            "A+B",
            "A-B",
            "A*B",
            "A/B",
            "A^B",
            "A=B",
            "A<B",
            "A>B",
            "A\u{1}",
            "A\u{263A}",
            // security.md "Windows file names": backslash and device names.
            "A\\B",
            "CON",
            "nul",
            "Aux",
            "PRN",
            "COM1",
            "lpt9",
            "NUL.X",
            "con.txt",
            &"N".repeat(128),
        ] {
            assert!(matches!(validate_name(bad), Err(Error::Name(_))), "{bad:?}");
        }
    }
}