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
|
// The AppKit half of the macOS backend: NSEvent in, pardes_* out, one
// CoreGraphics pass per frame back.
//
// This file keeps no model of the screen. The core owns the grid and hands it
// over whole through src/macos/pardes.h, so everything here is translation, and
// the only state worth holding is the font metrics — expensive to measure and
// replaced only by Font/TaglineSize/zoom — plus the gesture state remembered
// between events: which button a click started with, and how hard it is being
// pressed.
//
// Every NSEvent override decodes and then calls one of the post-decode entry
// points below (press/release/drag/click/scroll/rotate/typeKey). That split is
// not decoration: NSTouch, pressure stages and rotation have no public
// constructors, so a test can never synthesize them, and the only way the
// trackpad behaviour is reachable by anything but a finger is for the decision
// to live one call below the event. test/macos_e2e.swift drives exactly those
// entry points.
//
// Every C constant below is wrapped in an explicit conversion (UInt16(...),
// UInt32(...)) rather than used bare. A macro's imported Swift type is decided
// by the importer, not by us, and this file should not have an opinion about it.
import AppKit
import CoreText
/// Posted after every call this view makes into the core, and answered by
/// AppDelegate.pump(). The core only queues what it was told and does nothing
/// until it is pumped, so an input without one of these is an input that
/// visibly did nothing. Declared here, where the posts are.
let pardesDidInputNotification = Notification.Name("pardesDidInput")
/// A cell, already clamped to the frame the core last rendered.
struct GridPoint {
var col: UInt16
var row: UInt16
}
protocol PardesViewDelegate: AnyObject {
func pardesViewDidResize(_ view: PardesView)
func pardesViewRequestsPaste(_ view: PardesView)
}
/// What a click means, from the fingers resting on the trackpad and the button
/// stream AppKit chose to deliver it on. Pure on purpose: NSTouch cannot be
/// constructed, so this is the part of the gesture a test can reach.
///
/// acme's three buttons are the whole vocabulary — 1 selects, 2 executes,
/// 3 looks — and a trackpad has one surface. More than one finger is Exec,
/// because running something is what a hand does over and over and it gets
/// the gesture that costs nothing; Look is the deep press, one deliberate
/// push past the click for the verb that goes somewhere.
///
/// Two and three fingers are the same verb here, and that is the hardware
/// talking rather than a shrug. macOS's secondary click is "click or tap with
/// TWO OR MORE fingers": with it on — the default — a three-finger click is
/// delivered as rightMouseDown exactly like a two-finger one, and a view that
/// trusts the stream calls both of them Look. Measured on real hardware, which
/// is the only way this was ever going to be found:
/// `rightMouseDown: resting=3`. So the count is what keeps a multi-finger
/// click off Look, and the stream cannot be trusted to do it.
///
/// The stream is only the fallback, for when there are no fingers to count:
/// a real mouse's right button is Look and its middle button is Exec, and both
/// arrive with an empty touch set.
enum Trackpad {
static func button(stream: pardes_mouse_button_e, fingers: Int) -> pardes_mouse_button_e {
switch fingers {
case 2...: return PARDES_MOUSE_MIDDLE
// One finger, or none to count: the stream is the answer. A trackpad
// single click comes in on the left stream and stays left; a real
// mouse's right and middle buttons keep their acme meanings.
default: return stream
}
}
/// A force click is a deliberate second gesture on top of an ordinary one,
/// so it gets the verb that goes somewhere rather than the one that runs
/// something: press harder and you Look.
static let forceClickButton: pardes_mouse_button_e = PARDES_MOUSE_RIGHT
}
// Matches bg_default/fg_default in src/gui/gui.zig and DEFAULT_FG/DEFAULT_BG in
// src/web/app.mjs. Three shells render the same core; if these drift, comparing
// a screenshot across backends stops meaning anything.
let pardesDefaultFG: UInt32 = 0xCC_CC_CC
let pardesDefaultBG: UInt32 = 0x12_12_12
/// Pinned sRGB for rasterized attachments, so a PDF page's bytes mean the same
/// thing here as they do in the SDL shell. DeviceRGB is the fallback rather
/// than a crash: a machine with no sRGB profile is not a reason to stop
/// drawing pages.
private let sRGB: CGColorSpace = CGColorSpace(name: CGColorSpace.sRGB) ?? CGColorSpaceCreateDeviceRGB()
// UNVERIFIED: kCTFontAttributeName bridged through NSAttributedString.Key. It is
// the same string as .font, but spelling the CoreText key means the value stays
// a CTFont instead of being bridged to NSFont on the way in.
private let fontAttribute = NSAttributedString.Key(kCTFontAttributeName as String)
// The named sixteen, then xterm's 6x6x6 cube, then the 24-step grey ramp. These
// sixteen are app.mjs's, not gui.zig's: gui.zig borrows ghostty's palette
// because it already links it, and the two disagree on the base colors.
private let ansi16: [UInt32] = [
0x00_00_00, 0xCC_00_00, 0x4E_9A_06, 0xC4_A0_00,
0x34_65_A4, 0x75_50_7B, 0x06_98_9A, 0xD3_D7_CF,
0x55_57_53, 0xEF_29_29, 0x8A_E2_34, 0xFC_E9_4F,
0x72_9F_CF, 0xAD_7F_A8, 0x34_E2_E2, 0xEE_EE_EC,
]
private func paletteColor(_ index: UInt8) -> UInt32 {
if index < 16 { return ansi16[Int(index)] }
if index >= 232 {
let grey = UInt32(8 + (Int(index) - 232) * 10)
return grey << 16 | grey << 8 | grey
}
let n = Int(index) - 16
func level(_ part: Int) -> UInt32 { part == 0 ? 0 : UInt32(55 + part * 40) }
return level(n / 36) << 16 | level(n / 6 % 6) << 8 | level(n % 6)
}
private func decodeColor(_ encoded: UInt32, _ fallback: UInt32) -> UInt32 {
if encoded == UInt32(PARDES_COLOR_DEFAULT) { return fallback }
if encoded & UInt32(PARDES_COLOR_TAG_MASK) == UInt32(PARDES_COLOR_INDEXED) {
return paletteColor(UInt8(encoded & 0xFF))
}
return encoded & UInt32(PARDES_COLOR_RGB_MASK)
}
/// The four faces, indexed by the two attribute bits that pick one. Also the
/// glyph cache's first key, which is why it is an ordinal and not four fields.
private enum Face: Int, CaseIterable {
case regular = 0, bold = 1, italic = 2, boldItalic = 3
init(bold: Bool, italic: Bool) {
self = Face(rawValue: (bold ? 1 : 0) | (italic ? 2 : 0))!
}
}
/// A background run that must not be painted at all, so the window's own
/// backdrop shows through. Outside the 24-bit RGB range, so it can never
/// collide with a real colour, and distinct from the `.max` the run loop
/// flushes on.
let bgClear: UInt32 = 0x0100_0000
/// `block` means the filled cursor sits on this cell. `ground` is what a
/// DEFAULT background resolves to, and `clearGround` asks for those cells to
/// come back as `bgClear` instead of a colour.
private func resolve(
_ cell: pardes_cell_s,
block: Bool,
ground: UInt32,
clearGround: Bool
) -> (fg: UInt32, bg: UInt32, alpha: CGFloat, visible: Bool) {
// The core never painted this cell, which is most of the screen most of the
// time, so this branch is the one that has to stay cheap.
if cell.flags & UInt8(PARDES_CELL_DEFAULT) != 0 {
return block
? (ground, pardesDefaultFG, 1, false)
: (pardesDefaultFG, clearGround ? bgClear : ground, 1, false)
}
let bgDefault = cell.bg == UInt32(PARDES_COLOR_DEFAULT)
var fg = decodeColor(cell.fg, pardesDefaultFG)
var bg = decodeColor(cell.bg, ground)
// The block cursor is a second reverse, so a cell that is already reversed
// cancels back to normal underneath it. Same rule as emitInstance in
// src/gui/gui.zig; the two must not drift.
var reverse = block
if cell.attrs & UInt16(PARDES_ATTR_REVERSE) != 0 { reverse = !reverse }
if reverse { swap(&fg, &bg) }
// ponytail: PARDES_ATTR_BLINK is decoded into nothing. Honouring it costs a
// timer plus a repaint budget for a bit nothing in pardes emits today; drive
// setNeedsDisplay from an NSTimer here when something does.
let visible = cell.attrs & UInt16(PARDES_ATTR_INVISIBLE) == 0 && cell.len > 0
// The other shells scale the channels by 6/10. Over a dark background alpha
// lands in the same place and costs one blend instead of three multiplies.
let alpha: CGFloat = cell.attrs & UInt16(PARDES_ATTR_DIM) != 0 ? 0.6 : 1
// Only an UNREVERSED default background is the ground. A reverse puts the
// text colour there, and text is a real colour that paints.
if clearGround && bgDefault && !reverse { bg = bgClear }
return (fg, bg, alpha, visible)
}
private func advance(_ font: CTFont, _ character: UniChar) -> CGFloat {
var input = character
var glyph = CGGlyph(0)
guard CTFontGetGlyphsForCharacters(font, &input, &glyph, 1) else { return 0 }
var size = CGSize.zero
CTFontGetAdvancesForGlyphs(font, .horizontal, &glyph, &size, 1)
return size.width
}
/// The size the window opens at and Cmd+0 returns to. Named here rather than
/// passed in because zoomReset has to know it too, and two spellings of one
/// number is how "actual size" stops being the size it actually opened at.
let defaultFontSize: CGFloat = 14
/// The faces CoreText should reach for when the grid face has no glyph.
///
/// The SDL shell loads a chain of fallback faces itself and rasterizes from
/// whichever one has the codepoint. This shell draws its non-ASCII through
/// CTLine, which already walks a cascade — but the SYSTEM cascade, and the
/// system cascade has never heard of a Nerd Font. Measured on a machine with
/// Mononoki Nerd Font installed: U+E0B0, U+E5FF, U+E700 and U+F015 all resolved
/// to `LastResort`, which is the tofu box. Braille, emoji and CJK resolved
/// fine, which is exactly why this went unnoticed — everything Unicode has an
/// opinion about already worked, and only the Private Use Area did not.
///
/// Two sources, in this order:
///
/// 1. `fonts.fallback_names` over the C ABI, so the PREFERENCE ORDER is the
/// one the SDL shell uses and lives in one file.
/// 2. Installed Nerd Font families, found by name and then CONFIRMED BY
/// COVERAGE. Both halves are load-bearing. Coverage alone is not enough: a
/// scan of all 250 families here put `Hannotate TC` and `HanziPen TC` at
/// 4 of 6 probes, because CJK faces map the PUA for their own purposes and
/// would answer a powerline request with an unrelated ideograph. A name
/// alone is not enough either, because "Nerd Font" in a family name is a
/// convention, not a guarantee. So the name decides what a codepoint MEANS
/// and coverage decides whether the face can actually draw it.
///
/// Computed once. The result is a list of descriptors, which carry no size, so
/// a zoom or a `Font` command reuses it; only installing a font invalidates it,
/// and that is a relaunch.
private enum FontFallbacks {
/// Representative codepoints, one per Nerd Font block that matters:
/// powerline separators, Seti file icons, devicons, Font Awesome. A face
/// answering all four is patched; a face answering one is a coincidence.
private static let nerdProbes: [UInt32] = [0xE0B0, 0xE5FF, 0xE700, 0xF015]
static let descriptors: [CTFontDescriptor] = build()
private static func build() -> [CTFontDescriptor] {
var out: [CTFontDescriptor] = []
var seen = Set<String>()
func take(_ family: String, _ descriptor: CTFontDescriptor) {
guard seen.insert(family).inserted else { return }
out.append(descriptor)
}
// 1. The shared preference order.
for index in 0..<pardes_fallback_font_count() {
var length: UInt32 = 0
guard let bytes = pardes_fallback_font_name(index, &length), length > 0 else { continue }
let name = String(decoding: UnsafeRawBufferPointer(start: bytes, count: Int(length)), as: UTF8.self)
guard let found = resolve(name) else { continue }
take(found.family, found.descriptor)
}
// 2. Nerd Fonts that are installed AND cover the blocks. `Mono` cuts
// first: this is a fixed grid, and the propo/variable cuts of the
// same family are drawn to different advances.
let families = (CTFontManagerCopyAvailableFontFamilyNames() as? [String]) ?? []
let nerd = families.filter { $0.range(of: "nerd font", options: .caseInsensitive) != nil }
for family in nerd.sorted(by: { rank($0) < rank($1) }) {
let descriptor = CTFontDescriptorCreateWithAttributes(
[kCTFontFamilyNameAttribute: family] as CFDictionary)
guard coverage(descriptor, nerdProbes) == nerdProbes.count else { continue }
take(family, descriptor)
}
return out
}
/// "Mono" before "Propo" before the proportional cut.
private static func rank(_ family: String) -> Int {
if family.range(of: "nerd font mono", options: .caseInsensitive) != nil { return 0 }
if family.range(of: "nerd font propo", options: .caseInsensitive) != nil { return 2 }
return 1
}
/// A descriptor that really is the font asked for. CoreText SUBSTITUTES
/// rather than failing — asking it for an uninstalled `SymbolsNerdFont-
/// Regular` hands back Helvetica, and a cascade seeded with Helvetica is a
/// cascade that answers every missing glyph with the wrong one.
private static func resolve(_ name: String) -> (family: String, descriptor: CTFontDescriptor)? {
for attribute in [kCTFontNameAttribute, kCTFontFamilyNameAttribute] {
let query = CTFontDescriptorCreateWithAttributes([attribute: name] as CFDictionary)
guard let match = CTFontDescriptorCreateMatchingFontDescriptor(query, nil) else { continue }
let postScript = CTFontDescriptorCopyAttribute(match, kCTFontNameAttribute) as? String ?? ""
let family = CTFontDescriptorCopyAttribute(match, kCTFontFamilyNameAttribute) as? String ?? ""
guard postScript.compare(name, options: .caseInsensitive) == .orderedSame
|| family.compare(name, options: .caseInsensitive) == .orderedSame
else { continue }
return (family.isEmpty ? postScript : family, match)
}
return nil
}
/// How many of `codepoints` this face can actually draw. Size is irrelevant
/// to coverage, so the probe face is built at a nominal one.
private static func coverage(_ descriptor: CTFontDescriptor, _ codepoints: [UInt32]) -> Int {
let font = CTFontCreateWithFontDescriptor(descriptor, 12, nil)
var hits = 0
for codepoint in codepoints {
guard let scalar = UnicodeScalar(codepoint) else { continue }
var units = Array(String(scalar).utf16)
var glyphs = [CGGlyph](repeating: 0, count: units.count)
if CTFontGetGlyphsForCharacters(font, &units, &glyphs, units.count) { hits += 1 }
}
return hits
}
/// `face` with the chain attached. Every face pardes draws with goes through
/// here exactly once, at the base: `CTFontCreateCopyWithSymbolicTraits` and
/// `CTFontCreateCopyWithAttributes` both carry the cascade into the copy, so
/// the bold/italic cuts and the smaller tagline cuts inherit it.
static func attach(to face: CTFont, size: CGFloat) -> CTFont {
guard !descriptors.isEmpty else { return face }
let descriptor = CTFontDescriptorCreateCopyWithAttributes(
CTFontCopyFontDescriptor(face),
[kCTFontCascadeListAttribute: descriptors] as CFDictionary)
return CTFontCreateWithFontDescriptor(descriptor, size, nil)
}
}
/// Everything that changes when the face or its size does, in one value so
/// that changing either is one assignment and cannot leave half the numbers
/// describing the old font.
///
/// Built at init and again for a `Font` command or a zoom. The view clears its
/// body/tagline glyph caches beside replacing this value: a CGGlyph is an index
/// into a particular face, so carrying one across a font change is invalid.
private struct Metrics {
let fonts: [CTFont]
/// False only when a non-nil requested file could not produce a fixed-pitch
/// CoreText face. The caller rejects that request and keeps old Metrics.
let acceptedPath: Bool
let ascent: CGFloat
let cellWidth: CGFloat
let cellHeight: CGFloat
let ruleThickness: CGFloat
let underlineOffset: CGFloat
/// ASCII is very nearly the whole screen, so its glyphs are resolved once
/// per face here and never looked up again.
let asciiGlyphs: [[CGGlyph]]
/// Round `v` onto the backing grid: `scale` is the display's
/// backingScaleFactor, so at 2x this lands on half-points, which are whole
/// device pixels.
private static func snap(_ v: CGFloat, _ scale: CGFloat, _ rule: FloatingPointRoundingRule) -> CGFloat {
(v * scale).rounded(rule) / scale
}
init(size: CGFloat, path: String?, scale: CGFloat) {
let requested = path.flatMap { Metrics.fromFile($0, size) }
// Attached ONCE, at the base: the trait and size copies below inherit
// the cascade, so every cut and the tagline's smaller cuts reach the
// same fallbacks. Metrics is measured from `face` too, and a cascade
// changes no metric — CoreText measures the primary face and only
// consults the chain for a codepoint it lacks.
let face = FontFallbacks.attach(to: requested ?? Metrics.defaultFace(size: size), size: size)
let scale = max(1, scale)
// UNVERIFIED: CTFontSymbolicTraits member spelling (.traitBold/.traitItalic).
// A face with no italic cut returns nil here, hence the fallback to `face`.
func variant(_ traits: CTFontSymbolicTraits) -> CTFont {
CTFontCreateCopyWithSymbolicTraits(face, size, nil, traits, traits) ?? face
}
let faces = [face, variant(.traitBold), variant(.traitItalic), variant([.traitBold, .traitItalic])]
// The grid has to land on WHOLE DEVICE PIXELS, and that is the whole
// constraint — a fractional column boundary makes the background pass
// (which runs with antialiasing off, or touching fills seam) wobble by
// a pixel from column to column, and on a screen made of tag bars and
// selections that stripe is visible.
//
// Whole POINTS is how that used to be spelled, and on a Retina display
// it asks for twice what it needs: half a point IS a whole pixel at 2x.
// The difference is not academic — Monaco advances 8.4014pt at 14, so
// ceiling to 9 spaced every column 7.1% wider than the face was drawn
// for, which is loose, washed-out text that reads as bad rendering.
// Snapped to the backing grid it is 8.5, i.e. +1.2%.
//
// Width rounds to NEAREST — a monospace glyph is drawn to fit its own
// advance, so the half-pixel either way is slack — while height rounds
// UP, because losing a pixel off a descender is clipping.
let snap = Metrics.snap
fonts = faces
acceptedPath = path == nil || requested != nil
// The ascent lands on a pixel for a second reason: it is the baseline's
// offset inside the cell, so the rules hung off it are whole-pixel
// fills rather than one-pixel bars smeared across two rows.
let bodyAscent = max(1 / scale, snap(CTFontGetAscent(face), scale, .toNearestOrAwayFromZero))
let bodyWidth = max(1 / scale, snap(advance(face, 0x4D), scale, .toNearestOrAwayFromZero))
let bodyHeight = max(1 / scale, snap(CTFontGetAscent(face) + CTFontGetDescent(face) + CTFontGetLeading(face), scale, .up))
ascent = bodyAscent
cellWidth = bodyWidth
cellHeight = bodyHeight
ruleThickness = max(1 / scale, snap(CTFontGetUnderlineThickness(face), scale, .toNearestOrAwayFromZero))
underlineOffset = snap(CTFontGetUnderlinePosition(face), scale, .toNearestOrAwayFromZero)
asciiGlyphs = faces.map { font in
var chars = Array(UniChar(0)..<UniChar(128))
var glyphs = [CGGlyph](repeating: 0, count: 128)
_ = CTFontGetGlyphsForCharacters(font, &chars, &glyphs, 128)
return glyphs
}
}
/// The regular system face used only when no file was requested. A failed
/// request is reported through `acceptedPath`; it never silently replaces
/// the face already on screen with this fallback.
private static func defaultFace(size: CGFloat) -> CTFont {
let system = NSFont.monospacedSystemFont(ofSize: size, weight: .regular)
// Through the descriptor, not through CTFontCreateWithName(fontName):
// the system monospace face has a dot-prefixed internal name that a
// by-name lookup can miss entirely, and NSFontDescriptor is toll-free
// bridged, so this cannot resolve to a different font than AppKit just
// handed us.
let face = CTFontCreateWithFontDescriptor(system.fontDescriptor as CTFontDescriptor, size, nil)
// The whole layout is a fixed grid, so a proportional face is not a
// cosmetic problem, it is a broken screen. "M" and "i" disagreeing on
// advance is the cheapest possible proof that we got one.
return Metrics.isFixedPitch(face) ? face : CTFontCreateWithName("Menlo" as CFString, size, nil)
}
/// A face out of a font FILE, which is what the core hands over — it found
/// the path by walking the font directories itself, so nothing here asks
/// CoreText to resolve a name that a different shell might resolve
/// differently.
///
/// Nil rather than a substitute for anything wrong with the file, because
/// the caller's fallback is the face already on screen: a font that cannot
/// be measured would otherwise leave a terminal with no way back out.
private static func fromFile(_ path: String, _ size: CGFloat) -> CTFont? {
let url = URL(fileURLWithPath: path) as CFURL
guard let descriptors = CTFontManagerCreateFontDescriptorsFromURL(url) as? [CTFontDescriptor],
!descriptors.isEmpty else { return nil }
// A .ttc holds a family's four cuts in one file. Take the one with
// neither trait set — the regular — because the bold and italic ones
// are derived from it below; falling back to the first face keeps a
// collection whose cuts are all styled from being unusable.
let plain = descriptors.first { descriptor in
let traits = CTFontDescriptorCopyAttribute(descriptor, kCTFontTraitsAttribute) as? [CFString: Any]
let symbolic = (traits?[kCTFontSymbolicTrait] as? UInt32) ?? 0
return symbolic & UInt32(CTFontSymbolicTraits.traitBold.rawValue | CTFontSymbolicTraits.traitItalic.rawValue) == 0
}
let chosen = CTFontCreateWithFontDescriptor(plain ?? descriptors[0], size, nil)
// A variable face's descriptor carries no variation, and CoreText
// picks whichever named instance it likes for it — Maple Mono's
// variable file comes up Thin. Pin every axis to its own default:
// the face the file itself calls regular.
var face = chosen
if let axes = CTFontCopyVariationAxes(face) as? [[CFString: Any]] {
var defaults: [CFNumber: Any] = [:]
for axis in axes {
guard let tag = axis[kCTFontVariationAxisIdentifierKey],
let value = axis[kCTFontVariationAxisDefaultValueKey] else { continue }
defaults[tag as! CFNumber] = value
}
if !defaults.isEmpty {
let descriptor = CTFontDescriptorCreateCopyWithAttributes(
CTFontCopyFontDescriptor(face),
[kCTFontVariationAttribute: defaults] as CFDictionary)
face = CTFontCreateWithFontDescriptor(descriptor, size, nil)
}
}
// The core already filtered for fixed pitch by reading the file's own
// advances. This is the same question asked of the face CoreText
// actually built, which is the one that will be drawn with.
return Metrics.isFixedPitch(face) ? face : nil
}
private static func isFixedPitch(_ face: CTFont) -> Bool {
let em = advance(face, 0x4D)
return em > 0 && abs(em - advance(face, 0x69)) <= 0.01
}
}
/// The independently replaceable half of font state. A TaglineSize command
/// rebuilds only this value and its non-ASCII cache; body metrics and therefore
/// the core grid never move. `height` is also the painted tag-band height, not
/// merely a smaller glyph centred inside a body-height colour bar.
private struct TaglineMetrics {
let percent: UInt8
let fonts: [CTFont]
/// The tagline face's OWN ascent. Deliberately not folded together with the
/// band's top offset the way it used to be: that offset is per-row now, and
/// a baseline carrying one row's offset would pin every band back to centre.
let ascent: CGFloat
/// The tagline face's OWN advance, clamped to the body cell it sits in.
/// A tag row steps by THIS, not by the body cell width: the band behind it
/// is still pane-wide on the body grid, but the text on top of it tracks at
/// the smaller face's own pitch. Centring a smaller glyph inside a
/// body-width cell instead — which is what this shell used to do — leaves
/// the tag text visibly looser than the same session in an SDL window.
let width: CGFloat
let height: CGFloat
let asciiGlyphs: [[CGGlyph]]
/// Kept so the band rules below can work in the physical pixels the core
/// states them in, and hand back points.
private let scale: CGFloat
private let bodyCellHeight: CGFloat
init(body: Metrics, percent: UInt8, scale rawScale: CGFloat) {
let scale = max(1, rawScale)
func snap(_ value: CGFloat, _ rule: FloatingPointRoundingRule) -> CGFloat {
(value * scale).rounded(rule) / scale
}
self.percent = percent
self.scale = scale
bodyCellHeight = body.cellHeight
let size = CTFontGetSize(body.fonts[0]) * CGFloat(percent) / 100
let faces = body.fonts.map { CTFontCreateCopyWithAttributes($0, size, nil, nil) }
fonts = faces
let face = faces[Face.regular.rawValue]
let measuredHeight = max(1 / scale, snap(
CTFontGetAscent(face) + CTFontGetDescent(face) + CTFontGetLeading(face), .up))
// Runtime configuration caps the percentage at the body face. Keep the
// clamp here too: a malformed/custom host value must not paint a tag
// over the body row below it.
height = min(body.cellHeight, measuredHeight)
ascent = max(1 / scale, snap(CTFontGetAscent(face), .toNearestOrAwayFromZero))
width = min(body.cellWidth, max(1 / scale, snap(advance(face, 0x4D), .toNearestOrAwayFromZero)))
asciiGlyphs = faces.map { font in
var chars = Array(UniChar(0)..<UniChar(128))
var glyphs = [CGGlyph](repeating: 0, count: 128)
_ = CTFontGetGlyphsForCharacters(font, &chars, &glyphs, 128)
return glyphs
}
}
private var cellPixels: UInt32 { UInt32(max(1, (bodyCellHeight * scale).rounded())) }
private var bandPixels: UInt32 { UInt32(max(1, (height * scale).rounded())) }
/// Where this band sits inside row `row`, measured down from the row's top.
/// The rule belongs to the core (`pardes_tagline_band_offset`) so that this
/// shell and the SDL one cannot disagree about it: every band is centred,
/// except a Tagbottom band on the last row, which faces the window edge.
func top(row: Int, canvasHeight: CGFloat) -> CGFloat {
CGFloat(pardes_tagline_band_offset(
UInt16(clamping: row), Float(canvasHeight * scale), cellPixels, bandPixels)) / scale
}
/// Canonical tag cells are physical grip slots; TagLayer positions text.
func glyphX(col: Int, row: Int, bodyCellWidth: CGFloat) -> CGFloat {
// Canonical tag cells are physical grips; TagLayer owns compact text.
CGFloat(col) * bodyCellWidth
}
/// Thickness of the rule joining the topbar band to the first pane-tag band,
/// zero when the two are meant to join directly.
var borderThickness: CGFloat {
CGFloat(pardes_topbar_pane_border_px(cellPixels, bandPixels)) / scale
}
/// Top of that rule. Placed the way the SDL shell places it, in WHOLE
/// pixels: half the rule above the topbar/pane boundary, floored, so a
/// one-pixel rule lands on the boundary instead of smeared across two rows.
var borderTop: CGFloat {
let px = pardes_topbar_pane_border_px(cellPixels, bandPixels)
return (CGFloat(cellPixels * UInt32(PARDES_TOPBAR_H)) - CGFloat(px / 2)) / scale
}
/// One physical pixel, in points. The rules separating discontinuous
/// context rows inside a body layer are a single pixel in the SDL shell,
/// so they are stated there and converted here rather than handing `scale`
/// out and letting the caller reinvent the conversion.
var contextBorderThickness: CGFloat { 1 / scale }
}
private func modifiers(_ flags: NSEvent.ModifierFlags) -> UInt32 {
var mods: UInt32 = 0
if flags.contains(.control) { mods |= UInt32(PARDES_MOD_CTRL) }
if flags.contains(.option) { mods |= UInt32(PARDES_MOD_ALT) }
if flags.contains(.shift) { mods |= UInt32(PARDES_MOD_SHIFT) }
return mods
}
final class PardesView: NSView {
weak var delegate: PardesViewDelegate?
// The face and the numbers off it, replaced whole by `wear`.
private var metrics: Metrics
private var taglines: TaglineMetrics
/// What `metrics` was built from, so a zoom keeps the face and a font
/// change keeps the size.
private var fontSize: CGFloat
private var fontPath: String?
var cellWidth: CGFloat { metrics.cellWidth }
var cellHeight: CGFloat { metrics.cellHeight }
// Glyphs the ASCII table above did not answer for. A stored 0 is .notdef,
// meaning "this face does not have it", which is a cache hit too — the
// CTLine fallback below is far more expensive than the lookup it would
// repeat. Keyed by role, face and codepoint, and thrown away with both
// body and tagline variants whenever the body face changes.
private var bodyGlyphCache: [UInt32: CGGlyph] = [:]
private var taglineGlyphCache: [UInt32: CGGlyph] = [:]
private struct GripGlyph {
let line: CTLine
let ink: CGRect
}
private var gripGlyphCache: [String: GripGlyph] = [:]
// Scratch for one batched run of glyphs. Held rather than made per row so a
// full redraw does not allocate 24 times.
private var runGlyphs: [CGGlyph] = []
private var runPositions: [CGPoint] = []
/// Ligature shaping, keyed by face and text. A sequence ligates when
/// shaping it produces fewer glyphs than it has characters — the only
/// answer CoreText gives without interrogating the font's own features.
/// Cleared with the glyph caches, because it belongs to one face.
private var ligatureShaped: [String: Bool] = [:]
/// Columns the current row has already consumed as part of a ligature
/// drawn further left. One row's worth at a time.
private var ligatureCovered: Set<Int> = []
/// Constructed lazily because the ordinary path is still a direct
/// CoreText/CoreGraphics frame. No scene bit and no panel track means no
/// bitmap, no Core Image context and no Metal work.
private lazy var scenePostprocessor: ScenePostprocessor? = ScenePostprocessor()
/// Kernel compilation is permanent for one executable. Runtime allocation
/// and device failures get three consecutive attempts before this session
/// stops advertising effects its GPU path cannot present.
private var postprocessorUnavailable = false
private var postprocessRetries = 0
/// The scene mapping of the pixels AppKit most recently accepted. Pointer
/// events use this snapshot, not a clock that may already be one tick ahead.
private var lastPresentedScene: pardes_scene_s?
/// Whether the last frame reached the optional Metal owner successfully.
/// Ordinary direct draws and a runtime-kernel failure leave this false.
private(set) var lastFrameUsedPostprocessor = false
/// Monotonic count of frames AppKit actually let this view present. The
/// host animation clock uses it as a permit: no new sample is consumed
/// while an occluded/coalesced frame is still waiting to be drawn.
private(set) var presentationSerial: UInt64 = 0
private var reportedCols: UInt16 = 0
private var reportedRows: UInt16 = 0
/// The backingScaleFactor `metrics` was snapped to, so a move between a
/// Retina and a 1x display re-measures the cell instead of leaving the grid
/// aligned to the other screen's pixels.
private var metricsScale: CGFloat = 2
/// The active theme's own background, or nil when it declares none — the
/// `*_transparent` themes and the curated `dark`. Nil is not a colour to
/// substitute but a decision: the ground stops being painted at all, the
/// view stops being opaque, and AppDelegate's NSVisualEffectView shows
/// through it. Read off pardes_theme_bg() once per pump, which is also
/// what makes a `Theme` command take hold without a relaunch.
private(set) var themeBG: UInt32? = pardesDefaultBG
/// Adopt what the core is wearing. Returns whether anything moved, so the
/// host only reconfigures the window when it has to.
@discardableResult
func adoptThemeBG(_ encoded: UInt32) -> Bool {
let wanted: UInt32? =
encoded == UInt32(PARDES_COLOR_DEFAULT) ? nil : encoded & UInt32(PARDES_COLOR_RGB_MASK)
guard wanted != themeBG else { return false }
themeBG = wanted
needsDisplay = true
return true
}
/// What `WindowOpacity` asked for, as the alpha every BACKGROUND is painted
/// at: the ground, cell and band backgrounds, and the chrome rules over
/// them. Glyph ink is never scaled by it, and neither is the block cursor —
/// it is foreground chrome that merely happens to be carried in a cell's
/// background, and it has to stay visible at `WindowOpacity 0`.
///
/// The rule is stated once for the SDL shell in shaders/ui.frag.glsl; this
/// is the same rule in CoreGraphics, where painting the ground at this
/// alpha and the glyph over it at its own coverage composites to what that
/// shader writes premultiplied in one pass.
///
/// Orthogonal to `themeBG`: a theme with no background of its own drops the
/// ground whatever this says, and an opaque theme still honours it.
private(set) var backgroundAlpha: CGFloat = 1
/// Adopt the core's percentage. Returns whether anything moved, on the same
/// contract as adoptThemeBG: the host redresses the window only when it has.
@discardableResult
func adoptWindowOpacity(_ percent: UInt8) -> Bool {
let wanted = CGFloat(min(percent, 100)) / 100
guard wanted != backgroundAlpha else { return false }
backgroundAlpha = wanted
needsDisplay = true
return true
}
// The button a left-stream click actually started with. mouseDown decides
// it from the fingers on the trackpad, and mouseDragged/mouseUp must use
// the same one: a press of right followed by a release of left leaves the
// core holding a drag nothing will ever end.
private var latchedButton: pardes_mouse_button_e?
private var latchedCell: GridPoint?
/// Last physical point delivered by AppKit and its mapping through the
/// accepted scene. The CRT's barrel moves a source cell under a stationary
/// hand, so successful scene presentations reconcile this point again.
private var pointerPoint: CGPoint?
private var pointerCell: GridPoint?
private var pointerMapped = false
private var pointerModifiers: UInt32 = 0
// Force-click stage, reset per press. AppKit repeats stage-2 events for as
// long as the finger stays down, and only the transition is the gesture.
private var pressureStage: Int = 0
// Fingers currently resting on the trackpad, kept from the touch stream.
//
// mouseDown was originally trusted to carry its own touch set, and on this
// hardware it does not always: AppKit routes NSTouch through the four
// touchesXxx callbacks, and the touch set hanging off a *mouse* event can
// come back empty depending on how the click was produced. Empty reads as
// one finger, which is a two-finger Exec silently degrading into a select
// — the exact failure this was supposed to avoid. So the count is
// maintained here and the mouse event's own set is preferred only when it
// has something in it.
private var restingFingers: Int = 0
init(fontSize size: CGFloat) {
// No window yet, so no backing scale to ask for: 2x is the guess every
// Mac shipped this decade would give, and viewDidChangeBackingProperties
// below re-measures the moment there is a real answer — including the
// 1x case, which a bare guess would otherwise leave wrong forever.
let built = Metrics(size: size, path: nil, scale: 2)
metrics = built
taglines = TaglineMetrics(
body: built, percent: pardes_gui_tagline_font_percent(), scale: 2)
fontSize = size
fontPath = nil
// 80x24 only so the window has a size to open at; the AppDelegate reads
// gridSize back and boots the core with whatever it actually got.
super.init(frame: NSRect(x: 0, y: 0, width: built.cellWidth * 80, height: built.cellHeight * 24))
runGlyphs.reserveCapacity(256)
runPositions.reserveCapacity(256)
// Files dropped ON the grid. Finder and the Dock already reach the app
// through application(_:open:), but that path cannot say WHERE — and
// where is the whole difference between "a file opened somewhere" and
// acme's "a file opened next to the pane I pointed at".
registerForDraggedTypes([.fileURL])
// Indirect touches are the trackpad's. Without this the touch set is
// always empty and every click looks like one finger, which is exactly
// the bug that would make two-finger Exec silently never fire.
allowedTouchTypes = [.indirect]
// Without a pressure configuration the deep-press stages are the
// system's business and stage 2 may never be delivered here.
// .primaryDeepClick is the one that means "a harder press is a second
// gesture", which is what it is being used for.
pressureConfiguration = NSPressureConfiguration(pressureBehavior: .primaryDeepClick)
}
required init?(coder: NSCoder) { fatalError("PardesView is built in code, not a nib") }
// MARK: - the face
/// The PostScript name of the face on screen. The only way anything
/// outside this file can find out which font is being drawn with — the
/// core has no font, so a cell-buffer snapshot cannot see one.
var faceName: String { CTFontCopyPostScriptName(metrics.fonts[0]) as String }
var effectivePointSize: CGFloat { CTFontGetSize(metrics.fonts[0]) }
/// Put on a face, or the same face at a different size, and tell the host
/// the grid moved under it.
///
/// A cell that changed size means a different number of columns fit the
/// same window, so this is a resize as far as the core is concerned — and
/// the delegate's resize path is already the one that reports both the
/// grid and the physical cell the PDF placement reads. A requested file
/// which cannot produce a fixed-pitch face is rejected before assignment,
/// leaving the screen exactly as it was rather than substituting a face.
private func wear(size: CGFloat, path: String?, resolvesRequest: Bool = false) {
let scale = window?.backingScaleFactor ?? metricsScale
let next = Metrics(size: size, path: path, scale: scale)
guard next.acceptedPath else {
// The requested file never became the fixed-pitch face the grid
// requires. Keep every old metric and resolve the pending request
// as rejected rather than claiming the system fallback is it.
if resolvesRequest { pardes_font_reject() }
return
}
// A CGGlyph is an index into a particular face. Kept across a change
// it would draw a different character, not a missing one.
bodyGlyphCache.removeAll(keepingCapacity: true)
taglineGlyphCache.removeAll(keepingCapacity: true)
gripGlyphCache.removeAll(keepingCapacity: true)
ligatureShaped.removeAll(keepingCapacity: true)
metrics = next
taglines = TaglineMetrics(body: next, percent: taglines.percent, scale: scale)
metricsScale = scale
fontSize = size
fontPath = path
delegate?.pardesViewDidResize(self)
needsDisplay = true
reportEffectiveFont(resolvesRequest: resolvesRequest)
}
/// Apply the core's live TaglineSize setting without touching body metrics,
/// the window grid, or PDF cell geometry. Called every pump; equality makes
/// the ordinary path one byte comparison.
@discardableResult
func adoptTaglinePercent(_ percent: UInt8) -> Bool {
guard percent != taglines.percent else { return false }
taglines = TaglineMetrics(body: metrics, percent: percent, scale: metricsScale)
taglineGlyphCache.removeAll(keepingCapacity: true)
gripGlyphCache.removeAll(keepingCapacity: true)
pardes_row_metrics(UInt16(max(1,(cellWidth*metricsScale).rounded())),UInt16(max(1,(cellHeight*metricsScale).rounded())),
UInt16(max(1,(taglines.width*metricsScale).rounded())),UInt16(max(1,(taglines.height*metricsScale).rounded())))
needsDisplay = true
return true
}
var taglinePercent: UInt8 { taglines.percent }
var taglineBandHeight: CGFloat { taglines.height }
var taglineCellWidth: CGFloat { taglines.width }
/// Seed runtime Config after init and update it after every successful
/// adopt/zoom. Points are the native owner's unit; the cell's backing-pixel
/// dimensions continue to travel through pardes_resize separately.
func reportEffectiveFont(resolvesRequest: Bool = false) {
let hundredths = UInt16(min(
max((effectivePointSize * 100).rounded(), 1),
CGFloat(UInt16.max)))
let name = faceName
name.withCString { pointer in
if resolvesRequest {
_ = pardes_font_ack(pointer, name.utf8.count, hundredths)
} else {
_ = pardes_font_observe(pointer, name.utf8.count, hundredths)
}
}
}
/// The file `Font <name>` resolved to, straight from the core.
func adoptFont(path: String, sizeHundredths: UInt16) {
let size = sizeHundredths == 0 ? fontSize : CGFloat(sizeHundredths) / 100
wear(size: size, path: path, resolvesRequest: true)
}
/// Cmd+ and Cmd-. Whole points, because the cell is rounded to whole
/// points anyway: a tenth-of-a-point step would spend several keystrokes
/// landing on the same grid and look like the key had stopped working.
/// The range is what stays legible at the bottom and still fits a useful
/// number of columns at the top.
func zoom(by step: CGFloat) {
let next = min(max(fontSize + step, 6), 72)
guard next != fontSize else { return }
wear(size: next, path: fontPath)
}
func zoomReset() {
guard fontSize != defaultFontSize else { return }
wear(size: defaultFontSize, path: fontPath)
}
// Row 0 at the top, so the drawing arithmetic reads like the grid it is.
override var isFlipped: Bool { true }
// Opaque only while the theme brings its own background AND that background
// is painted solid. A transparent theme has none, and an opaque view over a
// visual-effect backdrop is a grey rectangle where the blur should be;
// a WindowOpacity below 100 has the same problem against the desktop.
override var isOpaque: Bool { themeBG != nil && backgroundAlpha >= 1 }
override var acceptsFirstResponder: Bool { true }
// A click that focuses the window should also land in the grid: this is a
// text surface, and having to click twice after switching apps is the kind
// of thing that makes an app feel foreign.
override func acceptsFirstMouse(for event: NSEvent?) -> Bool { true }
var gridSize: (cols: UInt16, rows: UInt16) {
let cols = min(max((bounds.width / cellWidth).rounded(.down), 1), CGFloat(UInt16.max))
let rows = min(max((bounds.height / cellHeight).rounded(.down), 1), CGFloat(UInt16.max))
return (UInt16(cols), UInt16(rows))
}
// MARK: - drawing
override func draw(_ dirtyRect: NSRect) {
guard let destination = NSGraphicsContext.current?.cgContext else { return }
lastFrameUsedPostprocessor = false
// ponytail: dirtyRect is ignored. pardes_frame() re-renders the whole grid
// whatever we do, so clipping would save fills and nothing else. Narrow
// the row loops to the dirty band if that ever shows up in a profile.
let count = pardes_frame()
let nextPointer = pointerShape()
if nextPointer != pointer {
pointer = nextPointer
window?.invalidateCursorRects(for: self)
if let window, bounds.contains(convert(window.mouseLocationOutsideOfEventStream, from: nil)) {
cursorFor(pointer).set()
}
}
let scene = pardes_scene()
let trackCount = Int(pardes_frame_panel_tracks())
let tracks: UnsafeBufferPointer<pardes_panel_track_s>
if trackCount > 0, let list = pardes_frame_panel_track_list() {
tracks = UnsafeBufferPointer(start: list, count: trackCount)
} else {
tracks = UnsafeBufferPointer(start: nil, count: 0)
}
let wantsPostprocess = scene.flags != 0 || !tracks.isEmpty
if wantsPostprocess {
if postprocessorUnavailable {
pardes_postprocessor_unavailable()
} else if let postprocessor = scenePostprocessor {
if let sceneContext = postprocessor.renderContext(
size: bounds.size, scale: window?.backingScaleFactor ?? metricsScale
) {
drawFrame(sceneContext, count: count, hideCursor: !tracks.isEmpty)
let needsPrevious = tracks.contains {
$0.effect == UInt8(PARDES_PANEL_DISSOLVE)
|| $0.effect == UInt8(PARDES_PANEL_VERTICAL)
}
var oldReady = !needsPrevious
let previousCells = pardes_frame_previous_cells()
let changedCells = pardes_frame_changed_cells()
if needsPrevious, let previousCells, changedCells != nil,
let oldContext = postprocessor.previousRenderContext(
size: bounds.size,
scale: window?.backingScaleFactor ?? metricsScale
) {
drawFrame(
oldContext, count: count, cells: previousCells,
frozenImages: presentedImages, hideCursor: true)
oldReady = true
}
let outcome: ScenePostprocessor.CompositeOutcome = oldReady
? postprocessor.composite(
scene: scene, tracks: tracks,
changedCells: changedCells,
changedAttachmentRects: changedAttachmentRects(),
gridSize: (
cols: Int(pardes_frame_cols()),
rows: Int(pardes_frame_rows())),
cellSize: CGSize(width: cellWidth, height: cellHeight),
ground: themeBG, size: bounds.size, into: destination)
: .unavailable
switch outcome {
case .presented:
postprocessRetries = 0
lastPresentedScene = scene
lastFrameUsedPostprocessor = true
acknowledgePresentation(animatedPanels: !tracks.isEmpty)
return
case .retry:
postprocessRetries += 1
case .unavailable:
postprocessorUnavailable = true
}
} else {
postprocessRetries += 1
}
// This draw now falls back to canonical content. Scene effects
// may retry, but a panel must not resume from a later sample
// after its final geometry has already been shown.
if !tracks.isEmpty { pardes_panel_animation_failed() }
if postprocessRetries >= 3 { postprocessorUnavailable = true }
if postprocessorUnavailable { pardes_postprocessor_unavailable() }
} else {
// The source, Metal device, or fixed kernel set was absent at
// lazy construction. None can recover within this process.
postprocessorUnavailable = true
pardes_postprocessor_unavailable()
}
} else {
postprocessRetries = 0
}
lastPresentedScene = nil
drawFrame(destination, count: count, hideCursor: false)
acknowledgePresentation(animatedPanels: false)
}
/// A presentation can materialize a Look target under a stationary mouse
/// after AppDelegate already decided whether to run its 60 Hz clock. Wake
/// the ordinary pump only for that null->active edge; repeated frame acks
/// remain inert and cannot create a redraw loop.
private func acknowledgePresentation(animatedPanels: Bool) {
// Only a canonical presentation advances the attachment baseline.
// During a transition deleted panes keep their cropped CGImages alive
// here even after both the core placement and image cache entry vanish.
if !animatedPanels {
presentedImages = frameImages
presentedBodyLayers = snapshotBodyLayers()
presentedTagLayers = snapshotTagLayers()
}
presentationSerial &+= 1
let animationWoke = pardes_frame_presented(animatedPanels)
let pointerMoved = refreshPresentedPointer()
guard animationWoke || pointerMoved else { return }
DispatchQueue.main.async {
NotificationCenter.default.post(name: pardesDidInputNotification, object: self)
}
}
/// Re-feed only a changed mapping. Sending motion on every 60 Hz scene
/// frame would keep resetting the core's hover debounce forever.
private func refreshPresentedPointer() -> Bool {
guard let point = pointerPoint else { return false }
guard let at = cellAt(point) else {
guard pointerMapped else { return false }
pointerMapped = false
pardes_pointer_leave()
return true
}
let changed: Bool
if let previous = pointerCell {
changed = !pointerMapped || previous.col != at.col || previous.row != at.row
} else {
changed = true
}
pointerMapped = true
pointerCell = at
guard changed else { return false }
if let button = latchedButton {
latchedCell = at
sendMouse(button, PARDES_MOUSE_DRAG, at.col, at.row, pointerModifiers)
} else {
sendMouse(PARDES_MOUSE_NONE, PARDES_MOUSE_MOTION,
at.col, at.row, pointerModifiers)
}
return true
}
/// The canonical CoreText frame, independent of where it lands. Scene
/// effects change only the destination: direct view context when off, the
/// postprocessor's same-sized retained bitmap when on.
private func drawFrame(
_ ctx: CGContext,
count: UInt32,
cells suppliedCells: UnsafePointer<pardes_cell_s>? = nil,
frozenImages: [FrozenImage]? = nil,
hideCursor: Bool
) {
let cols = Int(pardes_frame_cols())
let rows = Int(pardes_frame_rows())
// The ground, from the core rather than from a constant agreed by hand.
// A transparent theme has none: CLEAR rather than fill, because AppKit
// does not blank a non-opaque view and last frame's pixels would
// otherwise pile up on themselves.
let ground = themeBG ?? pardesDefaultBG
let clearGround = themeBG == nil
// AppKit does not blank a non-opaque view, so anything that leaves the
// ground short of solid has to clear first or last frame's pixels pile
// up on themselves — a translucent ground would darken toward opaque
// over a few frames otherwise.
if clearGround || backgroundAlpha < 1 { ctx.clear(bounds) }
if !clearGround { fillBackground(ctx, bounds, ground, backgroundAlpha) }
if frozenImages == nil { frameImages.removeAll(keepingCapacity: true) }
guard cols > 0, rows > 0, Int(count) == cols * rows,
let cells = suppliedCells ?? pardes_frame_cells()
else { return }
// -1 when hidden, which never matches a real cell, so hidden and "bar, so
// not a block" collapse into the same comparison.
// A cursor has no pane/phase record. Match SDL and TTY by hiding it for
// the short panel transition instead of guessing whether it should
// move, stay fixed, or cover an overlapping opening pane.
let bar = !hideCursor && pardes_cursor_bar()
let blockX = hideCursor || bar ? -1 : Int(pardes_cursor_x())
let blockY = hideCursor || bar ? -1 : Int(pardes_cursor_y())
// Background first, batched into runs of equal color. A full redraw is
// 80x24 cells at the low end and per-cell fills are exactly what makes
// that feel slow. Antialiasing is off because touching rects share an
// edge, and blending that edge twice draws a visible seam.
ctx.setShouldAntialias(false)
// Band geometry is stated against the whole canvas: the last row's rule
// depends on where the window edge is, not just on the row index.
let canvasHeight = bounds.height
for row in 0..<rows {
let base = row * cols
let y = CGFloat(row) * cellHeight
// One offset per ROW, not per run: it is the same answer for every
// cell in the row, and it is a call across the ABI.
let bandTop = taglines.top(row: row, canvasHeight: canvasHeight)
var start = 0
var block = blockY == row && blockX == 0
var color = resolve(cells[base], block: block,
ground: ground, clearGround: clearGround).bg
var tagline = cells[base].flags & UInt8(PARDES_CELL_TAGLINE) != 0
for col in 1...cols {
// A real color is 24 bits, so .max is a sentinel that cannot
// compare equal and therefore always flushes the last run.
let nextBlock = col < cols && blockY == row && blockX == col
let next: UInt32 = col == cols
? .max
: resolve(cells[base + col], block: nextBlock,
ground: ground, clearGround: clearGround).bg
let nextTagline = col < cols
&& cells[base + col].flags & UInt8(PARDES_CELL_TAGLINE) != 0
// The cursor is in the run key as well as the colour: it is the
// one background that stays solid under WindowOpacity, so it
// cannot share a fill with the cells beside it even when the
// reverse happened to land on their colour.
if next == color && nextTagline == tagline && nextBlock == block { continue }
// bgClear runs are the ground showing through, and the ground is
// already clear — painting them would be painting the hole shut.
if color != bgClear {
let bandY = tagline ? y + bandTop : y
let bandHeight = tagline ? taglines.height : cellHeight
fillBackground(ctx, CGRect(x: CGFloat(start) * cellWidth, y: bandY,
width: CGFloat(col - start) * cellWidth, height: bandHeight),
color, block ? 1 : backgroundAlpha)
}
start = col
color = next
tagline = nextTagline
block = nextBlock
}
}
// The core grid contains only complete cells, so any window height that
// is not a whole multiple of the cell leaves a strip below the last row.
// A Tagbottom band there is bottom-aligned against the window edge, and
// without this that strip shows the page colour under it.
let gridBottom = CGFloat(rows) * cellHeight
if gridBottom < canvasHeight, rows > 0 {
let base = (rows - 1) * cols
for col in 0..<cols {
let cell = cells[base + col]
guard cell.flags & UInt8(PARDES_CELL_DEFAULT) == 0,
cell.flags & UInt8(PARDES_CELL_TAGLINE) != 0 else { continue }
let bg = resolve(cell, block: false, ground: ground,
clearGround: clearGround).bg
if bg != bgClear {
fillBackground(ctx, CGRect(x: 0, y: gridBottom, width: bounds.width,
height: canvasHeight - gridBottom), bg, backgroundAlpha)
}
break
}
}
// CTFontDrawGlyphs lays glyph outlines out with +y up, and isFlipped hands
// us a y-down CTM, so drawing text directly in view space renders every
// line mirrored. Un-flip once for the whole glyph pass and convert each
// baseline into it rather than fighting the text matrix per cell.
ctx.setShouldAntialias(true)
// Every glyph sits at an exact multiple of cellWidth and the ascent is
// whole points (see Metrics), so every baseline is already on a pixel:
// letting CoreText place a glyph on a subpixel would blur a grid that
// is aligned by construction. Quantizing keeps the rasterizer's own
// cache hitting.
ctx.setShouldSubpixelPositionFonts(false)
ctx.setShouldSubpixelQuantizeFonts(true)
// Grayscale antialiasing, never LCD subpixel. Smoothing needs to know
// the colour behind the glyph, which over a transparent theme's
// backdrop it cannot — the result is coloured fringing that reads as
// blur. macOS has defaulted this off since 10.14, but the user can turn
// it back on globally and it is not their call to make for this grid.
ctx.setShouldSmoothFonts(false)
ctx.saveGState()
ctx.textMatrix = .identity
ctx.translateBy(x: 0, y: bounds.height)
ctx.scaleBy(x: 1, y: -1)
let height = bounds.height
var paneGripCells = Set<Int>()
if frozenImages == nil {
for index in 0..<pardes_tag_layer_limit() {
if pardes_tag_layer_value(index, 0) == 0 || pardes_tag_layer_value(index, 1) != 2 { continue }
let x = Int(pardes_tag_layer_value(index, 4)) - Int(pardes_tag_text_inset())
let y = Int(pardes_tag_layer_value(index, 5))
if x >= 0 && x < cols && y >= 0 && y < rows { paneGripCells.insert(y * cols + x) }
}
} else {
for layer in presentedTagLayers where layer.values[1] == 2 {
let x = layer.values[4] - Int(pardes_tag_text_inset()), y = layer.values[5]
if x >= 0 && x < cols && y >= 0 && y < rows { paneGripCells.insert(y * cols + x) }
}
}
for row in 0..<rows {
drawRow(ctx, cells, base: row * cols, cols: cols, row: row,
baseline: height - (CGFloat(row) * cellHeight + metrics.ascent),
taglineTop: taglines.top(row: row, canvasHeight: canvasHeight),
blockCol: blockY == row ? blockX : -1, paneGripCells: paneGripCells)
}
ctx.restoreGState()
// Pixel attachments over the grid: rasterized PDF pages, and image
// panes' own pixels. After the glyphs, the way the SDL shell draws them
// after its cells — a PDF pane's cells are blank, so the order only
// matters for the tag row an attachment must never reach, and the clip
// below is what keeps it off.
if let frozenImages {
drawFrozenImages(ctx, frozenImages)
} else {
drawImages(ctx)
}
if bar {
let x = Int(pardes_cursor_x()), y = Int(pardes_cursor_y())
if x >= 0, y >= 0, x < cols, y < rows {
// gui.zig paints U+258F here. A rect is the same picture without
// asking the font for a glyph it may not carry.
let cell = cells[y * cols + x]
let fg = resolve(cell, block: false,
ground: themeBG ?? pardesDefaultBG, clearGround: false).fg
let tagline = cell.flags & UInt8(PARDES_CELL_TAGLINE) != 0
let caretY = CGFloat(y) * cellHeight
+ (tagline ? taglines.top(row: y, canvasHeight: bounds.height) : 0)
let caretHeight = tagline ? taglines.height : cellHeight
// On the compact grid when the cell is, or the caret sits a
// growing distance to the left of the character it marks as the
// row runs on. The SDL shell puts its cursor bar through the
// same layout for the same reason.
let caretX = tagline
? taglines.glyphX(col: x, row: y, bodyCellWidth: cellWidth)
: CGFloat(x) * cellWidth
let caretWidth = max(1, ((tagline ? taglines.width : cellWidth) / 8).rounded(.up))
ctx.setShouldAntialias(false)
fill(ctx, CGRect(x: caretX, y: caretY,
width: caretWidth, height: caretHeight), fg, 1)
}
}
if frozenImages == nil {
drawBodyLayers(ctx, hideCursor:hideCursor)
drawTagLayers(ctx, hideCursor:hideCursor, canonical:cells, cols:cols, rows:rows)
} else {
for layer in presentedTagLayers {
layer.cells.withUnsafeBufferPointer { tagCells in
if let base = tagCells.baseAddress {
drawTagLayer(ctx, values: layer.values, cells: base, hideCursor: true,
canonical: cells, cols: cols)
}
}
drawTagGrip(ctx, values: layer.values, canonical: cells, cols: cols, rows: rows)
}
for layer in presentedBodyLayers {
layer.cells.withUnsafeBufferPointer { cells in
if let base = cells.baseAddress { drawBodyLayer(ctx, values:layer.values, cells:base, hideCursor:true) }
}
}
drawTagRules(ctx, layers: presentedTagLayers.map { $0.values })
}
drawHoverGlass(ctx, cells: cells, cols: cols, rows: rows)
}
private var presentedTagLayers: [FrozenBodyLayer] = []
private func snapshotTagLayers() -> [FrozenBodyLayer] {
var result: [FrozenBodyLayer] = []
for index in 0..<pardes_tag_layer_limit() {
let values = (0...12).map { Int(pardes_tag_layer_value(index, UInt32($0))) }
if values[0] == 0 { continue }
if let cells = pardes_tag_layer_cells(index) {
result.append(FrozenBodyLayer(values: values, cells: Array(UnsafeBufferPointer(start: cells, count: values[0]))))
}
}
return result
}
private func drawTagLayers(_ ctx: CGContext, hideCursor: Bool, canonical: UnsafePointer<pardes_cell_s>, cols: Int, rows: Int) {
var layers: [[Int]] = []
for index in 0..<pardes_tag_layer_limit() {
let values = (0...12).map { Int(pardes_tag_layer_value(index, UInt32($0))) }
if values[0] == 0 { continue }
layers.append(values)
// The layer's full-row fill must land before the grip: the row
// background now spans the anchor columns, and the grip glyph
// and the anchor fills have to come back on top of it.
if let cells = pardes_tag_layer_cells(index) {
drawTagLayer(ctx, values: values, cells: cells, hideCursor: hideCursor,
canonical: canonical, cols: cols)
}
drawTagGrip(ctx, values: values, canonical: canonical, cols: cols, rows: rows)
}
drawTagRules(ctx, layers: layers)
}
/// SDL's chrome overlay is drawn after its compact layers. Keep these
/// one-point rules above the full-row tag backgrounds as well.
private func drawTagRules(_ ctx: CGContext, layers: [[Int]]) {
let pixel = CGFloat(1)
for values in layers where values[1] != 0 {
let kind = values[1]
let bottom = kind == 2 && values[11] != 0
let left = CGFloat(max(0, values[4] - Int(pardes_tag_text_inset()))) * cellWidth
let right = CGFloat(values[4] + values[6]) * cellWidth
let y = CGFloat(values[5] + (bottom ? 0 : 1)) * cellHeight - (bottom ? 0 : pixel)
fillBackground(ctx, CGRect(x: left, y: y, width: right-left, height: pixel),
UInt32(values[12]), backgroundAlpha)
}
if layers.contains(where: { $0[5] == Int(PARDES_TOPBAR_H) }), taglines.borderThickness > 0 {
fillBackground(ctx, CGRect(x: 0, y: taglines.borderTop, width: bounds.width,
height: taglines.borderThickness),
pardes_topbar_pane_border_rgb(), backgroundAlpha)
}
}
private func gripGlyph(_ text: String, face: Face) -> GripGlyph? {
let key = "\(face.rawValue):\(text)"
if let cached = gripGlyphCache[key] { return cached }
let attributed = NSAttributedString(string: text, attributes: [fontAttribute: taglines.fonts[face.rawValue],
NSAttributedString.Key(kCTForegroundColorFromContextAttributeName as String): true])
let line = CTLineCreateWithAttributedString(attributed as CFAttributedString)
let ink = CTLineGetBoundsWithOptions(line, [.useGlyphPathBounds])
guard !ink.isNull, !ink.isInfinite, !ink.isEmpty else { return nil }
let measured = GripGlyph(line: line, ink: ink)
gripGlyphCache[key] = measured
return measured
}
private func drawTagGrip(_ ctx: CGContext, values: [Int], canonical: UnsafePointer<pardes_cell_s>, cols: Int, rows: Int) {
let x = values[4] - Int(pardes_tag_text_inset()), y = values[5]
if values[1] != 2 || x < 0 || x >= cols || y < 0 || y >= rows { return }
var cell = canonical[y * cols + x]
let text = withUnsafeBytes(of: &cell.text) { String(decoding: $0.prefix(Int(cell.len)), as: UTF8.self) }
if text.isEmpty { return }
let style = resolve(cell, block:false, ground:themeBG ?? pardesDefaultBG, clearGround:false)
// The box drawTagLayer filled is this mark's ground, so the mark
// centres on that same square rather than on the grip columns: one
// rect measures both and the two cannot drift apart.
guard let square = anchorSquare(values: values) else { return }
let centerX = square.midX, centerY = square.midY
if text != " " {
let face = Face(bold: cell.attrs & UInt16(PARDES_ATTR_BOLD) != 0,
italic: cell.attrs & UInt16(PARDES_ATTR_ITALIC) != 0)
guard style.visible, let measured = gripGlyph(text, face: face) else { return }
let originX = ((centerX - measured.ink.midX) * metricsScale).rounded() / metricsScale
let baseline = ((bounds.height - centerY - measured.ink.midY) * metricsScale).rounded() / metricsScale
ctx.saveGState()
ctx.clip(to: square)
ctx.translateBy(x: 0, y: bounds.height)
ctx.scaleBy(x: 1, y: -1)
ctx.textMatrix = .identity
ctx.textPosition = CGPoint(x: originX, y: baseline)
setFill(ctx, style.fg, style.alpha)
CTLineDraw(measured.line, ctx)
ctx.restoreGState()
return
}
if taglines.height < 6 || taglines.width < 3 { return }
let halfWidth = max(1, min(3, cellWidth - 2))
fill(ctx, CGRect(x:floor(centerX-halfWidth), y:floor(centerY-2), width:2*halfWidth, height:1), style.fg, 1)
fill(ctx, CGRect(x:floor(centerX-halfWidth), y:floor(centerY+1), width:2*halfWidth, height:1), style.fg, 1)
}
private func drawTagLayer(_ ctx: CGContext, values: [Int], cells: UnsafePointer<pardes_cell_s>,
hideCursor: Bool, canonical: UnsafePointer<pardes_cell_s>, cols: Int) {
let left = CGFloat(values[4]) * cellWidth
let y = CGFloat(values[5]) * cellHeight + taglines.top(row: values[5], canvasHeight: bounds.height)
// SDL gives the tag a full body-row background; only its glyphs
// and per-cell highlights use the compact band. The band spans the
// row's whole extent, not just its text: the grip and the mode box
// live in the inset columns to the left of `values[4]`, and their
// own fills cover only the compact band — a row background that
// stops at the text leaves holes of ground under those anchors.
// The rule in drawTagRules spans exactly this left-to-right range.
let rowLeft = CGFloat(max(0, values[4] - Int(pardes_tag_text_inset()))) * cellWidth
let rowRight = CGFloat(values[4] + values[6]) * cellWidth
let viewport = CGRect(x: rowLeft, y: CGFloat(values[5]) * cellHeight,
width: rowRight - rowLeft, height: cellHeight)
ctx.saveGState()
ctx.clip(to: viewport)
fillBackground(ctx, viewport, UInt32(values[10]), backgroundAlpha)
// The anchor (grip, mode box) lives in the inset columns that fill
// just covered, so its own box goes back on top: one solid fill in
// the box colour the anchor cell wears, with drawTagGrip's mark
// drawn over it afterwards.
if let square = anchorSquare(values: values) {
let anchorX = max(0, values[4] - Int(pardes_tag_text_inset()))
let cell = canonical[values[5] * cols + anchorX]
let style = resolve(cell, block: false,
ground: UInt32(values[10]), clearGround: false)
if style.visible { fillBackground(ctx, square.integral, style.bg, backgroundAlpha) }
}
for pass in 0...1 {
for col in 0..<values[0] {
var cell = cells[col]
let isCursor = !hideCursor && col == values[8]
let block = isCursor && values[9] == 0
let style = resolve(cell, block: block, ground: UInt32(values[10]), clearGround: false)
let x = left + CGFloat(col) * taglines.width
if pass == 0 {
fillBackground(ctx, CGRect(x: x, y: y, width: taglines.width, height: taglines.height),
style.bg, block ? 1 : backgroundAlpha)
continue
}
let text = withUnsafeBytes(of: &cell.text) { String(decoding: $0.prefix(Int(cell.len)), as: UTF8.self) }
if style.visible && !text.isEmpty && text != " " {
let face = Face(bold: cell.attrs & UInt16(PARDES_ATTR_BOLD) != 0, italic: cell.attrs & UInt16(PARDES_ATTR_ITALIC) != 0)
ctx.saveGState()
ctx.translateBy(x: 0, y: bounds.height)
ctx.scaleBy(x: 1, y: -1)
let baseline = bounds.height - y - taglines.ascent
drawRules(ctx, cell, style, x: x, width: taglines.width, baseline: baseline)
setFill(ctx, style.fg, style.alpha)
ctx.textPosition = CGPoint(x: x, y: baseline)
let line = NSAttributedString(string: text, attributes: [fontAttribute: taglines.fonts[face.rawValue],
NSAttributedString.Key(kCTForegroundColorFromContextAttributeName as String): true])
CTLineDraw(CTLineCreateWithAttributedString(line as CFAttributedString), ctx)
ctx.restoreGState()
}
if isCursor && values[9] != 0 {
fill(ctx, CGRect(x: x, y: y, width: max(1, taglines.width / 8), height: taglines.height), style.fg, 1)
}
}
}
ctx.restoreGState()
}
/// The anchor square: one box drawn from the tag band's height — square,
/// at the row's left edge, inset by the same amount on both axes —
/// shared by the fill in drawTagLayer and the glyph in drawTagGrip so
/// the two can never disagree.
private func anchorSquare(values: [Int]) -> CGRect? {
let anchorX = max(0, values[4] - Int(pardes_tag_text_inset()))
guard anchorX < values[4] else { return nil }
let pad = (cellHeight - taglines.height) / 2
return CGRect(x: CGFloat(anchorX) * cellWidth + pad,
y: CGFloat(values[5]) * cellHeight + taglines.top(row: values[5], canvasHeight: bounds.height),
width: taglines.height, height: taglines.height)
}
/// The look-hover affordance as liquid glass: the core marks the word's
/// cells (PARDES_CELL_HOVER), and this composes a real material over the
/// run — the drawn frame snapshot refracted through CoreImage (a small
/// blur, then a lens scale about the pill's centre, which is what makes
/// the edges swim), the theme's selection colour as a faint tint, a
/// specular sheen from the top edge, and a light rim — with the word's
/// own glyphs drawn back on top, crisp, the way text sits on a real
/// material rather than behind one.
private func drawHoverGlass(_ ctx: CGContext, cells: UnsafePointer<pardes_cell_s>, cols: Int, rows: Int) {
var drew = false
for row in 0..<rows {
var start = -1
var tint: UInt32 = 0
for col in 0...cols {
let hover = col < cols
&& cells[row * cols + col].flags & UInt8(PARDES_CELL_HOVER) != 0
if hover, start < 0 {
start = col
tint = cells[row * cols + col].bg
}
if !hover, start >= 0 {
let rect = CGRect(x: CGFloat(start) * cellWidth, y: CGFloat(row) * cellHeight,
width: CGFloat(col - start) * cellWidth, height: cellHeight)
drawLiquidGlass(ctx, rect, tint: tint)
redrawHoverRun(ctx, cells, cols: cols, row: row, start: start, end: col)
drew = true
start = -1
}
}
}
// No affordance this frame: the held snapshot describes a frame
// that no longer exists, and the next hover must take a fresh one.
if !drew { glassShot = nil }
}
/// A CoreImage context for the glass refraction, created once.
private lazy var glassContext = CIContext()
/// The snapshot behind the current pill. Refraction reads the already
/// drawn frame, and re-reading it every pump would blur a moving pill
/// out of its own budget, so the shot is taken when the rect changes.
private var glassShot: (rect: CGRect, image: CGImage)?
private func drawLiquidGlass(_ ctx: CGContext, _ rect: CGRect, tint: UInt32) {
let radius = min(rect.height / 4, 6)
let pill = CGPath(roundedRect: rect.insetBy(dx: 1, dy: 1.5),
cornerWidth: radius, cornerHeight: radius, transform: nil)
// The refraction: the frame as drawn, blurred a little and scaled
// about the pill's centre, so the rim bends what surrounds it. The
// shot extends past the pill for exactly this — the lens needs
// pixels from outside the glass to pull in.
let lens = rect.insetBy(dx: -10, dy: -10)
if refract(ctx, pill: pill, rect: rect, lens: lens, tint: tint) {
// Specular: light caught at the top edge, fading as it falls.
ctx.saveGState()
ctx.addPath(pill)
ctx.clip()
let shine = [CGColor(srgbRed: 1, green: 1, blue: 1, alpha: 0.22),
CGColor(srgbRed: 1, green: 1, blue: 1, alpha: 0.0)] as CFArray
if let gradient = CGGradient(colorsSpace: CGColorSpace(name: CGColorSpace.sRGB),
colors: shine, locations: [0, 0.55]) {
ctx.drawLinearGradient(gradient,
start: CGPoint(x: rect.minX, y: rect.minY),
end: CGPoint(x: rect.minX, y: rect.maxY), options: [])
}
ctx.restoreGState()
} else {
// No refraction without a snapshot: the tint alone, faint.
ctx.saveGState()
ctx.addPath(pill)
ctx.clip()
ctx.setFillColor(CGColor(srgbRed: CGFloat((tint >> 16) & 0xFF) / 255,
green: CGFloat((tint >> 8) & 0xFF) / 255,
blue: CGFloat(tint & 0xFF) / 255,
alpha: 0.18))
ctx.fill(rect)
ctx.restoreGState()
}
// The lens edge: a light rim and a darker bottom hairline, the way a
// real material catches its own edge.
ctx.addPath(pill)
ctx.setStrokeColor(CGColor(srgbRed: 1, green: 1, blue: 1, alpha: 0.35))
ctx.setLineWidth(1)
ctx.strokePath()
ctx.addPath(pill)
ctx.setStrokeColor(CGColor(srgbRed: 0, green: 0, blue: 0, alpha: 0.25))
ctx.setLineWidth(0.5)
ctx.clip()
ctx.stroke(CGRect(x: rect.minX, y: rect.maxY - 2, width: rect.width, height: 1.5))
}
/// True when the refraction composited. The snapshot is taken when the
/// pill moves and reused while it sits still.
private func refract(_ ctx: CGContext, pill: CGPath, rect: CGRect, lens: CGRect, tint: UInt32) -> Bool {
guard let shot = snapshotFor(ctx, lens: lens) else { return false }
var image = CIImage(cgImage: shot)
// The blur is grown slightly past the crop and the whole thing is
// pulled toward the centre by a few percent: the rim bends what
// surrounds it, which is the refraction the eye reads as glass.
let blur = image.applyingGaussianBlur(sigma: 2 * metricsScale)
let grown = blur.extent.insetBy(dx: -8 * metricsScale, dy: -8 * metricsScale)
let centre = CGPoint(x: grown.midX, y: grown.midY)
let scale = 1.06
let lensTransform = CGAffineTransform(translationX: centre.x * (1 - scale),
y: centre.y * (1 - scale)).scaledBy(x: scale, y: scale)
image = blur.transformed(by: lensTransform)
guard let filtered = glassContext.createCGImage(image, from: grown) else { return false }
ctx.saveGState()
ctx.addPath(pill)
ctx.clip()
ctx.draw(filtered, in: rect)
// The glass's own body colour: the theme's selection, faint — the
// refraction and the sheen carry the material, not opacity.
ctx.setFillColor(CGColor(srgbRed: CGFloat((tint >> 16) & 0xFF) / 255,
green: CGFloat((tint >> 8) & 0xFF) / 255,
blue: CGFloat(tint & 0xFF) / 255,
alpha: 0.15))
ctx.fill(rect)
ctx.restoreGState()
return true
}
private func snapshotFor(_ ctx: CGContext, lens: CGRect) -> CGImage? {
if let held = glassShot, held.rect == lens { return held.image }
guard let whole = ctx.makeImage() else { return nil }
// makeImage hands back backing pixels; the lens is in view points.
let region = CGRect(x: lens.minX * metricsScale, y: lens.minY * metricsScale,
width: lens.width * metricsScale, height: lens.height * metricsScale)
guard let cropped = whole.cropping(to: region) else { return nil }
glassShot = (lens, cropped)
return cropped
}
/// The hovered word's glyphs, back on top of the material, crisp: text
/// sits on liquid glass, not behind it.
private func redrawHoverRun(_ ctx: CGContext, _ cells: UnsafePointer<pardes_cell_s>,
cols: Int, row: Int, start: Int, end: Int) {
ctx.saveGState()
ctx.textMatrix = .identity
ctx.translateBy(x: 0, y: bounds.height)
ctx.scaleBy(x: 1, y: -1)
let baseline = bounds.height - (CGFloat(row) * cellHeight + metrics.ascent)
for col in start..<end {
let cell = cells[row * cols + col]
guard cell.flags & UInt8(PARDES_CELL_DEFAULT) == 0 else { continue }
let text = withUnsafeBytes(of: cell.text) { raw in
String(decoding: raw.prefix(Int(cell.len)), as: UTF8.self)
}
guard !text.isEmpty, text != " " else { continue }
let style = resolve(cell, block: false,
ground: themeBG ?? pardesDefaultBG, clearGround: false)
guard style.visible else { continue }
setFill(ctx, style.fg, style.alpha)
ctx.textPosition = CGPoint(x: CGFloat(col) * cellWidth, y: baseline)
let attributed = NSAttributedString(string: text, attributes: [
fontAttribute: metrics.fonts[Face(bold: cell.attrs & UInt16(PARDES_ATTR_BOLD) != 0,
italic: cell.attrs & UInt16(PARDES_ATTR_ITALIC) != 0).rawValue],
NSAttributedString.Key(kCTForegroundColorFromContextAttributeName as String): true])
CTLineDraw(CTLineCreateWithAttributedString(attributed as CFAttributedString), ctx)
}
ctx.textMatrix = .identity
ctx.restoreGState()
}
private struct FrozenBodyLayer {
let values: [Int]
let cells: [pardes_cell_s]
}
private var presentedBodyLayers: [FrozenBodyLayer] = []
private func snapshotBodyLayers() -> [FrozenBodyLayer] {
var result: [FrozenBodyLayer] = []
for index in 0..<pardes_body_layer_limit() {
let count = 11 + Int(pardes_body_layer_value(index, 2))
let values = (0..<count).map { Int(pardes_body_layer_value(index, UInt32($0))) }
if values[0] == 0 { continue }
if let cells = pardes_body_layer_cells(index) {
result.append(FrozenBodyLayer(values:values, cells:Array(UnsafeBufferPointer(start:cells,count:values[0]*values[1]))))
}
}
return result
}
private func drawBodyLayers(_ ctx: CGContext, hideCursor:Bool) {
for index in 0..<pardes_body_layer_limit() {
let count = 11 + Int(pardes_body_layer_value(index, 2))
let values = (0..<count).map { Int(pardes_body_layer_value(index, UInt32($0))) }
if values[0] == 0 { continue }
if let cells = pardes_body_layer_cells(index) { drawBodyLayer(ctx, values:values, cells:cells, hideCursor:hideCursor) }
}
}
private func drawBodyLayer(_ ctx: CGContext, values: [Int], cells: UnsafePointer<pardes_cell_s>, hideCursor: Bool) {
func value(_ field: Int) -> Int { values[field] }
let rows = value(0), cols = value(1), contexts = value(2)
let left = CGFloat(value(3)) * cellWidth, top = CGFloat(value(4)) * cellHeight
let viewport = CGRect(x: left, y: top, width: CGFloat(value(5))*cellWidth,
height: CGFloat(value(6))*cellHeight)
ctx.saveGState()
ctx.clip(to: viewport)
fillBackground(ctx, viewport, themeBG ?? bgClear, backgroundAlpha)
for row in 0..<rows {
let compact = row < contexts
let advance = compact ? taglines.width : cellWidth
let height = compact ? taglines.height : cellHeight
let y = top + CGFloat(min(row, contexts))*taglines.height + CGFloat(max(0, row-contexts))*cellHeight
if y >= viewport.maxY { break }
let rowStyle = resolve(cells[row*cols], block: false, ground: themeBG ?? pardesDefaultBG, clearGround: themeBG == nil)
fillBackground(ctx, CGRect(x: left, y: y, width: viewport.width, height: height), rowStyle.bg, backgroundAlpha)
for pass in 0...1 {
for col in 0..<cols {
var cell = cells[row*cols+col]
let isCursor = !hideCursor && col == value(8) && row == value(9)
let block = isCursor && value(10) == 0
let style = resolve(cell, block: block,
ground: themeBG ?? pardesDefaultBG, clearGround: themeBG == nil)
let x = left + CGFloat(col)*advance
if pass == 0 {
fillBackground(ctx, CGRect(x: x, y: y, width: advance, height: height),
style.bg, block ? 1 : backgroundAlpha)
continue
}
let text = withUnsafeBytes(of: &cell.text) { bytes in
String(decoding: bytes.prefix(Int(cell.len)), as: UTF8.self)
}
if style.visible && !text.isEmpty && text != " " {
let face = Face(bold: cell.attrs & UInt16(PARDES_ATTR_BOLD) != 0,
italic: cell.attrs & UInt16(PARDES_ATTR_ITALIC) != 0)
let font = compact ? taglines.fonts[face.rawValue] : metrics.fonts[face.rawValue]
ctx.saveGState()
ctx.translateBy(x: 0, y: bounds.height)
ctx.scaleBy(x: 1, y: -1)
let baseline = bounds.height - y - (compact ? taglines.ascent : metrics.ascent)
drawRules(ctx, cell, style, x: x, width: advance, baseline: baseline)
setFill(ctx, style.fg, style.alpha)
ctx.textPosition = CGPoint(x: x, y: baseline)
let line = NSAttributedString(string: text, attributes: [fontAttribute: font,
NSAttributedString.Key(kCTForegroundColorFromContextAttributeName as String): true])
CTLineDraw(CTLineCreateWithAttributedString(line as CFAttributedString), ctx)
ctx.restoreGState()
}
if isCursor && value(10) != 0 {
fill(ctx, CGRect(x: x, y: y, width: max(1, advance/8), height: height), style.fg, 1)
}
}
}
}
let border = pardes_topbar_pane_border_rgb()
if border != UInt32(PARDES_COLOR_DEFAULT) {
for row in 0..<contexts {
if value(11 + row) == 0 { continue }
// The SDL shell paints this rule over the row's LAST pixel, not
// the next row's first one; keep the two shells on the same pixel.
let thickness = taglines.contextBorderThickness
fillBackground(ctx, CGRect(x: left, y: top + CGFloat(row + 1)*taglines.height - thickness,
width: viewport.width, height: thickness), border, backgroundAlpha)
}
}
ctx.restoreGState()
}
/// What identifies a decoded raster: the pane's lifetime, the page, and the
/// generation MuPDF last rendered. Panning, zooming to fit and scrolling
/// deliberately move none of them, so the CGImage survives all three.
private struct ImageKey: Hashable {
let serial: UInt32
let page: UInt32
let revision: UInt32
}
/// A fully-owned attachment placement from the last canonical frame.
/// The cropped CGImage retains its provider bytes, unlike pardes_image_s's
/// pointer, so a vertical closing tombstone can outlive pane deletion.
private struct FrozenImage {
let key: ImageKey
let image: CGImage
let source: CGRect
let body: CGRect
let destination: CGRect
let paperBG: UInt32
}
/// Rasterized attachments, decoded once each. The bytes the core lends are
/// only valid until the next `pardes_frame`, so the CGImage owns a COPY —
/// which is exactly why the cache has to be keyed well enough that the copy
/// happens when the pixels change and never on an ordinary scroll.
private var imageCache: [ImageKey: CGImage] = [:]
private var frameImages: [FrozenImage] = []
private var presentedImages: [FrozenImage] = []
private func drawImages(_ ctx: CGContext) {
let count = Int(pardes_frame_images())
guard count > 0, let list = pardes_frame_image_list() else {
// Nothing on screen owns pixels any more: the pages a closed pane
// rendered would otherwise sit in here for the rest of the session.
if !imageCache.isEmpty { imageCache.removeAll(keepingCapacity: true) }
return
}
// The core computed every rectangle in PHYSICAL pixels, because that is
// what pardes_resize handed it. The view draws in points.
let scale = max(1, metricsScale)
var live = Set<ImageKey>()
live.reserveCapacity(count)
ctx.setShouldAntialias(true)
for i in 0..<count {
let place = list[i]
let key = ImageKey(serial: place.serial, page: place.page, revision: place.revision)
live.insert(key)
guard let full = image(for: place, key: key) else { continue }
let source = CGRect(
x: Int(place.src_x), y: Int(place.src_y),
width: Int(place.src_w), height: Int(place.src_h))
guard let crop = full.cropping(to: source)
else { continue }
// The body is the rectangle nothing may paint past. The core has
// already clipped the geometry to the viewport, but a tagline is
// not the viewport — a page one pixel too tall would sit on it.
let body = CGRect(
x: CGFloat(place.cell_x) * cellWidth, y: CGFloat(place.cell_y) * cellHeight,
width: CGFloat(place.cell_w) * cellWidth, height: CGFloat(place.cell_h) * cellHeight)
let dst = CGRect(
x: body.minX + CGFloat(place.dst_x) / scale,
y: body.minY + (CGFloat(place.dst_y) + CGFloat(place.offset_y)) / scale,
width: CGFloat(place.dst_w) / scale,
height: CGFloat(place.dst_h) / scale)
let frozen = FrozenImage(
key: key, image: crop, source: source,
body: body, destination: dst, paperBG: place.paper_bg)
frameImages.append(frozen)
drawFrozenImage(ctx, frozen)
}
// Evict what this frame did not place. Scrolling a document past a page
// is the common case, and holding every page a session ever showed is
// how a PDF viewer ends up owning a gigabyte of decoded bitmaps.
if imageCache.count > live.count {
imageCache = imageCache.filter { live.contains($0.key) }
}
}
private func drawFrozenImages(_ ctx: CGContext, _ images: [FrozenImage]) {
ctx.setShouldAntialias(true)
for image in images { drawFrozenImage(ctx, image) }
}
/// Native attachments do not occupy Cell graphemes, so the core's semantic
/// text/style mask cannot see a page appearing, disappearing, rerasterizing
/// or moving. Add only those changed placements to the shader mask; an
/// identical key and geometry remains immediate like any unchanged cell.
private func changedAttachmentRects() -> [CGRect] {
var oldByKey: [ImageKey: FrozenImage] = [:]
for image in presentedImages { oldByKey[image.key] = image }
var changed: [CGRect] = []
changed.reserveCapacity(frameImages.count + presentedImages.count)
for image in frameImages {
guard let old = oldByKey.removeValue(forKey: image.key) else {
changed.append(image.destination.intersection(image.body))
continue
}
if old.source != image.source
|| old.body != image.body || old.destination != image.destination {
changed.append(old.destination.intersection(old.body))
changed.append(image.destination.intersection(image.body))
}
}
for old in oldByKey.values {
changed.append(old.destination.intersection(old.body))
}
return changed.filter { !$0.isNull && !$0.isEmpty }
}
private func drawFrozenImage(_ ctx: CGContext, _ placed: FrozenImage) {
ctx.saveGState()
ctx.clip(to: placed.body)
// isFlipped gives us a y-down CTM and CGImage draws +y up, so flip
// about this destination rather than changing the grid arithmetic.
let isPDF = placed.paperBG != UInt32(PARDES_COLOR_DEFAULT)
if isPDF {
fillBackground(ctx, placed.destination, placed.paperBG, backgroundAlpha)
}
ctx.translateBy(x: placed.destination.minX, y: placed.destination.maxY)
ctx.scaleBy(x: 1, y: -1)
ctx.interpolationQuality = .high
let rect = CGRect(x: 0, y: 0,
width: placed.destination.width, height: placed.destination.height)
if isPDF {
// Paper was painted at WindowOpacity. Content keeps the PDF's own
// coverage, so glyphs, photos and paths stay legible at zero opacity.
ctx.setAlpha(1)
ctx.setBlendMode(.normal)
ctx.draw(placed.image, in: rect)
ctx.restoreGState()
return
}
// Match image.frag.glsl/backgroundLayerBlend: source coverage removes
// the destination independently of WindowOpacity, then the source is
// added at that opacity. Ordinary source-over would compound alpha;
// copy would discard the background under transparent image pixels.
ctx.setAlpha(1)
ctx.setBlendMode(.destinationOut)
ctx.draw(placed.image, in: rect)
ctx.setAlpha(backgroundAlpha)
ctx.setBlendMode(.plusLighter)
ctx.draw(placed.image, in: rect)
ctx.restoreGState()
}
/// The decoded raster for one attachment, made once per generation.
private func image(for place: pardes_image_s, key: ImageKey) -> CGImage? {
if let cached = imageCache[key] { return cached }
let bytes = Int(place.iw) * Int(place.ih) * 4
guard bytes > 0, let rgba = place.rgba else { return nil }
// Copied, not referenced: the core lends these bytes until the next
// pardes_frame and this image outlives many of them.
guard let data = CFDataCreate(nil, rgba, bytes),
let provider = CGDataProvider(data: data)
else { return nil }
// Straight alpha, R,G,B,A in memory — the same bytes the SDL shell
// uploads as R8G8B8A8_UNORM and blends with ONE_MINUS_SRC_ALPHA.
let made = CGImage(
width: Int(place.iw), height: Int(place.ih),
bitsPerComponent: 8, bitsPerPixel: 32, bytesPerRow: Int(place.iw) * 4,
space: sRGB,
bitmapInfo: CGBitmapInfo(rawValue: CGImageAlphaInfo.last.rawValue | CGBitmapInfo.byteOrder32Big.rawValue),
provider: provider, decode: nil, shouldInterpolate: true, intent: .defaultIntent)
if let made { imageCache[key] = made }
return made
}
/// One row of glyphs, batched. Consecutive cells that share a face and a
/// colour go to CoreText as a single call with a position array: a row of
/// plain text is then one draw instead of eighty, which is the difference
/// between a full redraw being free and being felt.
private func drawRow(
_ ctx: CGContext,
_ cells: UnsafePointer<pardes_cell_s>,
base: Int,
cols: Int,
/// This row's grid index. Needed per cell rather than per row for the
/// compact tagline anchor: a column split puts two panes' tags side by
/// side on ONE row, so the origin is a question about the cell.
row: Int,
baseline: CGFloat,
/// Where this row's tagline band starts, from the row's top. Passed in
/// rather than recomputed per cell: it is one answer per row, and the
/// glyph has to sit in the band the background pass painted.
taglineTop: CGFloat,
blockCol: Int,
paneGripCells: Set<Int>
) {
var runFace = Face.regular
var runTagline = false
var runColor: UInt32 = 0
var runAlpha: CGFloat = 1
runGlyphs.removeAll(keepingCapacity: true)
runPositions.removeAll(keepingCapacity: true)
ligatureCovered.removeAll(keepingCapacity: true)
func flush() {
guard !runGlyphs.isEmpty else { return }
setFill(ctx, runColor, runAlpha)
let font = runTagline
? taglines.fonts[runFace.rawValue]
: metrics.fonts[runFace.rawValue]
CTFontDrawGlyphs(font, runGlyphs, runPositions, runGlyphs.count, ctx)
runGlyphs.removeAll(keepingCapacity: true)
runPositions.removeAll(keepingCapacity: true)
}
for col in 0..<cols {
let cell = cells[base + col]
if ligatureCovered.contains(col) { continue }
if cell.flags & UInt8(PARDES_CELL_DEFAULT) != 0 { continue }
let tagline = cell.flags & UInt8(PARDES_CELL_TAGLINE) != 0
let cellBaseline = tagline
? baseline + metrics.ascent - (taglineTop + taglines.ascent)
: baseline
// clearGround: false — this pass only reads `fg`, and a glyph is
// never the hole in the ground.
let style = resolve(cell, block: blockCol == col,
ground: themeBG ?? pardesDefaultBG, clearGround: false)
// Tagline cells step on the smaller face's own pitch, anchored at
// their pane; everything else on the body grid. The rules go with
// the glyph, not with the body cell, or an underlined tag word ends
// up underlining its neighbour.
let x = tagline
? taglines.glyphX(col: col, row: row, bodyCellWidth: cellWidth)
: CGFloat(col) * cellWidth
let advanceWidth = tagline ? taglines.width : cellWidth
// Rules before the glyph, and independent of it: an underlined space
// is a real thing and so is an underlined invisible cell. They are
// fills, not glyphs, so they interrupt the run.
if cell.attrs >> UInt16(PARDES_ATTR_UL_SHIFT) != 0
|| cell.attrs & UInt16(PARDES_ATTR_STRIKETHROUGH) != 0 {
flush()
drawRules(ctx, cell, style, x: x, width: advanceWidth, baseline: cellBaseline)
}
guard style.visible else { continue }
// UNVERIFIED: withUnsafeBytes over an imported C fixed-size array, which
// Swift models as an 8-tuple. String(decoding:) substitutes U+FFFD rather
// than trapping, and the core has shipped invalid UTF-8 through here
// before — the renderer must not be the thing that dies over it. prefix
// clamps, so a bogus len cannot walk off the eight bytes either.
let text = withUnsafeBytes(of: cell.text) { raw in
String(decoding: raw.prefix(Int(cell.len)), as: UTF8.self)
}
guard !text.isEmpty, text != " " else { continue }
let face = Face(bold: cell.attrs & UInt16(PARDES_ATTR_BOLD) != 0,
italic: cell.attrs & UInt16(PARDES_ATTR_ITALIC) != 0)
if paneGripCells.contains(base + col) && gripGlyph(text, face: face) != nil {
// The layer pass centers this symbol by its actual ink bounds.
continue
}
let units = text.utf16
let known = units.count == 1 ? glyph(face, units.first!, tagline: tagline) : 0
if known != 0 {
// Ligatures: consecutive cells shaped together when the face
// collapses them into fewer glyphs. A monospace coding
// ligature advances by the same whole cells its characters
// did, so the grid cannot drift and only the ink changes.
if !tagline, let ligature = ligatureSpan(cells, base: base, cols: cols, col: col,
face: face, fg: style.fg, alpha: style.alpha,
blockCol: blockCol, paneGripCells: paneGripCells) {
flush()
setFill(ctx, style.fg, style.alpha)
let attributed = NSAttributedString(string: ligature.text,
attributes: [fontAttribute: metrics.fonts[face.rawValue],
NSAttributedString.Key(kCTForegroundColorFromContextAttributeName as String): true])
ctx.textPosition = CGPoint(x: x, y: cellBaseline)
CTLineDraw(CTLineCreateWithAttributedString(attributed as CFAttributedString), ctx)
ctx.textMatrix = .identity
for covered in 1..<ligature.covered { ligatureCovered.insert(col + covered) }
continue
}
if !runGlyphs.isEmpty
&& (face != runFace || tagline != runTagline
|| style.fg != runColor || style.alpha != runAlpha) {
flush()
}
runFace = face
runTagline = tagline
runColor = style.fg
runAlpha = style.alpha
runGlyphs.append(known)
runPositions.append(CGPoint(x: x, y: cellBaseline))
continue
}
// Emoji, combining marks and anything the face is missing: CTLine finds
// a fallback font. The position is set explicitly per cell — this is a
// fixed grid, and letting CoreText advance across a row would drift off
// it.
flush()
setFill(ctx, style.fg, style.alpha)
let font = tagline ? taglines.fonts[face.rawValue] : metrics.fonts[face.rawValue]
let attributed = NSAttributedString(string: text, attributes: [fontAttribute: font,
NSAttributedString.Key(kCTForegroundColorFromContextAttributeName as String): true])
ctx.textPosition = CGPoint(x: x, y: cellBaseline)
CTLineDraw(CTLineCreateWithAttributedString(attributed as CFAttributedString), ctx)
// CTLineDraw leaves the text position at the END of what it drew,
// and textPosition IS the translation of the text matrix, which
// CTFontDrawGlyphs then applies to every position it is handed. So
// one fallback glyph silently displaces the entire rest of the
// frame by that glyph's advance, down and to the right — and since
// the wrap marker and the em dash take this path, that is most
// files. Put it back before anything else draws.
ctx.textMatrix = .identity
}
flush()
}
/// 0 is .notdef, i.e. "this face does not have it" — a real answer, cached
/// like any other, because the CTLine fallback it sends the caller to costs
/// far more than the lookup it would otherwise repeat every frame.
private func glyph(_ face: Face, _ character: UniChar, tagline: Bool) -> CGGlyph {
if character < 128 {
let ascii = tagline ? taglines.asciiGlyphs : metrics.asciiGlyphs
return ascii[face.rawValue][Int(character)]
}
let key = UInt32(face.rawValue) << 16 | UInt32(character)
if tagline, let cached = taglineGlyphCache[key] { return cached }
if !tagline, let cached = bodyGlyphCache[key] { return cached }
var input = character
var found = CGGlyph(0)
let font = tagline ? taglines.fonts[face.rawValue] : metrics.fonts[face.rawValue]
_ = CTFontGetGlyphsForCharacters(font, &input, &found, 1)
if tagline {
taglineGlyphCache[key] = found
} else {
bodyGlyphCache[key] = found
}
return found
}
/// Ligature-prone character heads: a coding ligature always begins with
/// one of these, and refusing everything else keeps the per-frame cost of
/// ligature detection a set lookup rather than a shape.
private static let ligatureHeads: Set<Character> = [
"<", ">", "=", "!", "&", "|", "-", "/", ":", ".", "#", "*", "+", "~", "^", "%",
]
private func ligates(_ face: Face, _ text: String) -> Bool {
let key = "\(face.rawValue):\(text)"
if let cached = ligatureShaped[key] { return cached }
let attributed = NSAttributedString(string: text, attributes: [fontAttribute: metrics.fonts[face.rawValue],
NSAttributedString.Key(kCTForegroundColorFromContextAttributeName as String): true])
let shaped = CTLineCreateWithAttributedString(attributed as CFAttributedString)
var glyphs: [CGGlyph] = []
for run in (CTLineGetGlyphRuns(shaped) as? [CTRun]) ?? [] {
let count = CTRunGetGlyphCount(run)
var runGlyphs = [CGGlyph](repeating: 0, count: count)
CTRunGetGlyphs(run, CFRange(location: 0, length: count), &runGlyphs)
glyphs.append(contentsOf: runGlyphs)
}
// A ligature is any divergence from per-character mapping. A font may
// collapse the pair into one glyph (JetBrains Mono) or swap each
// character for a joining half kept at the same count (Maple Mono) —
// either way the sequence must be shaped, not mapped.
let singles = text.utf16.map { glyph(face, $0, tagline: false) }
let result = glyphs.count != singles.count
|| zip(glyphs, singles).contains { $0 != $1 }
ligatureShaped[key] = result
return result
}
/// When the cells at `col` ligate under `face`, the text to shape and how
/// many cells the ligature covers. Nil when they do not. Ligature cells
/// must carry the same face, colour and alpha and no rules of their own —
/// a ligature is one glyph of one style, not a style transition.
private func ligatureSpan(_ cells: UnsafePointer<pardes_cell_s>, base: Int, cols: Int, col: Int,
face: Face, fg: UInt32, alpha: CGFloat,
blockCol: Int, paneGripCells: Set<Int>) -> (text: String, covered: Int)? {
func eligible(_ index: Int) -> String? {
let cell = cells[base + index]
if cell.flags & UInt8(PARDES_CELL_DEFAULT) != 0 { return nil }
if cell.flags & UInt8(PARDES_CELL_TAGLINE) != 0 { return nil }
if cell.attrs >> UInt16(PARDES_ATTR_UL_SHIFT) != 0
|| cell.attrs & UInt16(PARDES_ATTR_STRIKETHROUGH) != 0 { return nil }
if paneGripCells.contains(base + index) { return nil }
let text = withUnsafeBytes(of: cell.text) { raw in
String(decoding: raw.prefix(Int(cell.len)), as: UTF8.self)
}
guard text.utf16.count == 1 else { return nil }
let other = resolve(cell, block: blockCol == index,
ground: themeBG ?? pardesDefaultBG, clearGround: false)
guard other.visible, other.fg == fg, other.alpha == alpha,
Face(bold: cell.attrs & UInt16(PARDES_ATTR_BOLD) != 0,
italic: cell.attrs & UInt16(PARDES_ATTR_ITALIC) != 0) == face else { return nil }
return text
}
guard let head = eligible(col), PardesView.ligatureHeads.contains(head.first!) else { return nil }
guard col + 1 < cols, let second = eligible(col + 1) else { return nil }
let pair = head + second
if col + 2 < cols, let third = eligible(col + 2) {
let triple = pair + third
if ligates(face, triple) { return (triple, 3) }
}
if ligates(face, pair) { return (pair, 2) }
return nil
}
private func drawRules(
_ ctx: CGContext,
_ cell: pardes_cell_s,
_ style: (fg: UInt32, bg: UInt32, alpha: CGFloat, visible: Bool),
x: CGFloat,
/// The cell's advance: the body cell, or the narrower tagline one. A
/// rule is as wide as the character it belongs to, and on a tag row
/// that stopped being the body cell when the text compacted.
width: CGFloat,
baseline: CGFloat
) {
let underline = Int(cell.attrs >> PARDES_ATTR_UL_SHIFT) & 7
if underline != Int(PARDES_UL_OFF) {
let y = baseline + metrics.underlineOffset
fill(ctx, CGRect(x: x, y: y, width: width, height: metrics.ruleThickness), style.fg, style.alpha)
// ponytail: curly, dotted and dashed all come out solid; only double
// earns its second rule. ctx.setLineDash for two of them and a sine
// path for the third is the upgrade, once anyone notices.
if underline == Int(PARDES_UL_DOUBLE) {
fill(ctx, CGRect(x: x, y: y - metrics.ruleThickness * 2, width: width, height: metrics.ruleThickness),
style.fg, style.alpha)
}
}
if cell.attrs & UInt16(PARDES_ATTR_STRIKETHROUGH) != 0 {
// Rounded like every other rule offset: a third of the ascent is a
// fraction, and a fractional one-pixel bar is a two-pixel smear.
fill(ctx, CGRect(x: x, y: baseline + (metrics.ascent * 0.3).rounded(), width: width, height: metrics.ruleThickness),
style.fg, style.alpha)
}
}
private func setFill(_ ctx: CGContext, _ rgb: UInt32, _ alpha: CGFloat) {
// Theme channels, like PDF raster bytes, are sRGB. Device RGB can
// brighten them when AppKit's backing bitmap uses another profile.
ctx.setFillColor(CGColor(srgbRed: CGFloat((rgb >> 16) & 0xFF) / 255,
green: CGFloat((rgb >> 8) & 0xFF) / 255,
blue: CGFloat(rgb & 0xFF) / 255,
alpha: alpha))
}
/// One surface pixel has one background opacity, even when a compact
/// layer covers a canonical cell. Source-over would turn 71% into 92%,
/// then 98%, as the ground, row and cell are painted over each other.
private func fillBackground(_ ctx: CGContext, _ rect: CGRect, _ rgb: UInt32, _ alpha: CGFloat) {
ctx.saveGState()
ctx.setShouldAntialias(false)
if rgb == bgClear {
ctx.clear(rect)
} else {
ctx.setBlendMode(.copy)
fill(ctx, rect, rgb, alpha)
}
ctx.restoreGState()
}
private func fill(_ ctx: CGContext, _ rect: CGRect, _ rgb: UInt32, _ alpha: CGFloat) {
setFill(ctx, rgb, alpha)
ctx.fill(rect)
}
// MARK: - the core, and the pump
/// Everything below ends here. Posting the notification in one place is
/// what guarantees no entry point can feed the core and forget to ask for
/// the tick that performs it.
private func fed() {
NotificationCenter.default.post(name: pardesDidInputNotification, object: self)
}
/// A point inside the NSView can still be outside the CRT's curved tube.
/// For input that is the same as leaving the grid: discard a pending hover
/// preview, but do not manufacture a clamped click or wheel gesture.
private func leftGrid() {
pardes_pointer_leave()
fed()
}
func typeKey(_ cp: UInt32, text: String, mods: UInt32) {
// The pointer is borrowed for the call and nowhere else, which is the only
// thing the header promises about it.
text.withCString { pardes_key(cp, $0, text.utf8.count, mods) }
fed()
}
// `mods` defaults to none because a synthesized gesture carries no
// keyboard state; the NSEvent overrides always pass the real mask. Ctrl is
// the one the core actually consults — a left press with it held is
// goto-definition — so dropping it here would silently delete a feature.
private var sampledBodyPointer: CGPoint?
private func sendMouse(_ button: pardes_mouse_button_e, _ kind: pardes_mouse_kind_e,
_ col: UInt16, _ row: UInt16, _ mods: UInt32) {
guard let point = sampledBodyPointer else {
pardes_mouse(button, kind, col, row, mods)
return
}
let scale = metricsScale
pardes_mouse_pixel(button, kind, col, row, mods, Float(point.x*scale), Float(point.y*scale),
Float(cellWidth*scale), Float(cellHeight*scale), Float(taglines.width*scale), Float(taglines.height*scale))
}
func press(_ button: pardes_mouse_button_e, at cell: GridPoint, mods: UInt32 = 0) {
sendMouse(button, PARDES_MOUSE_PRESS, cell.col, cell.row, mods)
fed()
}
func release(_ button: pardes_mouse_button_e, at cell: GridPoint, mods: UInt32 = 0) {
sendMouse(button, PARDES_MOUSE_RELEASE, cell.col, cell.row, mods)
fed()
}
func drag(_ button: pardes_mouse_button_e, to cell: GridPoint, mods: UInt32 = 0) {
sendMouse(button, PARDES_MOUSE_DRAG, cell.col, cell.row, mods)
fed()
}
func motion(to cell: GridPoint, mods: UInt32 = 0) {
sendMouse(PARDES_MOUSE_NONE, PARDES_MOUSE_MOTION, cell.col, cell.row, mods)
fed()
}
/// A press and its release with nothing in between, which is what every
/// synthesized click is: a trackpad gesture we recognised rather than a
/// button the user held.
func click(_ button: pardes_mouse_button_e, at cell: GridPoint, mods: UInt32 = 0) {
press(button, at: cell, mods: mods)
release(button, at: cell, mods: mods)
}
/// One discrete wheel notch, as opposed to the continuous travel below.
func wheel(_ button: pardes_mouse_button_e, at cell: GridPoint, mods: UInt32 = 0) {
sendMouse(button, PARDES_MOUSE_PRESS, cell.col, cell.row, mods)
fed()
}
func scroll(rows: CGFloat, cols: CGFloat = 0, at cell: GridPoint) {
guard rows != 0 || cols != 0 else { return }
pardes_scroll(Float(rows), Float(cols), cell.col, cell.row)
fed()
}
/// Fingers down and fingers up on a precise scroll. Entry points of their
/// own for the same reason rotateEnd is one: NSEvent phases have no public
/// constructor, and a fling nothing can synthesize is a fling nothing can
/// assert.
func scrollBegin() {
pardes_scroll_begin()
fed()
}
func scrollEnd() {
pardes_scroll_end()
fed()
}
func rotate(degrees: CGFloat) {
guard degrees != 0 else { return }
pardes_rotate(Float(degrees))
fed()
}
/// The fingers came off the trackpad. A post-decode entry point of its own
/// so the e2e harness can throw the dial: NSEvent phases have no public
/// constructor, and a fling nothing can synthesize is a fling nothing can
/// assert.
func rotateEnd() {
pardes_rotate_end()
fed()
}
// MARK: - keyboard
override func keyDown(with event: NSEvent) {
let flags = event.modifierFlags
// Same reason as the trackpad trace below: whether AppKit delivered a
// keystroke at all is not something this process can otherwise answer,
// and "Escape does nothing" has two entirely different causes
// depending on whether this line prints.
trace("key: code=\(event.keyCode) mods=\(flags.rawValue) chars=" +
(event.charactersIgnoringModifiers?.unicodeScalars
.map { String($0.value, radix: 16) }.joined(separator: ",") ?? "-"))
// The ABI has no super bit, so a Command chord cannot be expressed at all.
// Anything the main menu claims never reaches here; the rest is swallowed
// rather than delivered as the bare keystroke the core would insert.
if flags.contains(.command) {
if event.charactersIgnoringModifiers?.lowercased() == "v" {
delegate?.pardesViewRequestsPaste(self)
}
return
}
let control = flags.contains(.control)
let option = flags.contains(.option)
// With ctrl or option down, `characters` is already the composed result —
// Ctrl-A is U+0001, Option-A is "å". The core wants the base key and no
// text, which is what app.mjs does with the same two bits.
let composed = (control || option ? event.charactersIgnoringModifiers : event.characters) ?? ""
guard let scalar = composed.unicodeScalars.first else { return }
var codepoint = scalar.value
// 0xF700..0xF8FF is AppKit's private-use block for function keys. The nine
// the core names get translated; the rest (F1-F12, Insert, the keypad) are
// dropped, because passing one through paints a stray glyph.
// These constants come from an unnamed C enum, so which width Swift picks
// for them is not something this file should depend on: wrapping each in
// UInt32() compiles whether they import as Int, Int32 or UInt32.
if scalar.value >= 0xF700 && scalar.value <= 0xF8FF {
switch scalar.value {
case UInt32(NSUpArrowFunctionKey): codepoint = UInt32(PARDES_KEY_UP)
case UInt32(NSDownArrowFunctionKey): codepoint = UInt32(PARDES_KEY_DOWN)
case UInt32(NSLeftArrowFunctionKey): codepoint = UInt32(PARDES_KEY_LEFT)
case UInt32(NSRightArrowFunctionKey): codepoint = UInt32(PARDES_KEY_RIGHT)
case UInt32(NSHomeFunctionKey): codepoint = UInt32(PARDES_KEY_HOME)
case UInt32(NSEndFunctionKey): codepoint = UInt32(PARDES_KEY_END)
case UInt32(NSPageUpFunctionKey): codepoint = UInt32(PARDES_KEY_PAGE_UP)
case UInt32(NSPageDownFunctionKey): codepoint = UInt32(PARDES_KEY_PAGE_DOWN)
case UInt32(NSDeleteFunctionKey): codepoint = UInt32(PARDES_KEY_DELETE)
default: return
}
}
// Enter, Tab, Escape and Backspace already arrive as the ASCII controls the
// header names. Two keys do not: the keypad's Enter is U+0003 and Shift-Tab
// is U+0019, neither of which is in the function-key block above, so without
// this both reach the core as a control it has no binding for and do
// nothing. The browser shell resolves them from the DOM key name and this
// is what keeps the two hosts saying the same thing.
if codepoint == 0x03 { codepoint = UInt32(PARDES_KEY_ENTER) }
if codepoint == 0x19 { codepoint = UInt32(PARDES_KEY_TAB) }
// A control character is functional, and functional keys must not also
// carry text.
let functional = codepoint < 0x20 || codepoint == 0x7F || codepoint >= 0xF0000
let text = functional || control || option ? "" : composed
// Typing is the moment the pointer stops being interesting and starts
// sitting on top of the words. It comes back on the next mouse move.
NSCursor.setHiddenUntilMouseMoves(true)
typeKey(codepoint, text: text, mods: modifiers(flags))
}
// MARK: - trackpad
// NSTouch arrives through these four and nowhere else. They are the only
// reliable source of "how many fingers are down right now": the touch set
// on a mouse event is an accident of how the click was produced, and an
// empty one is indistinguishable from one finger.
override func touchesBegan(with event: NSEvent) { countTouches(event) }
override func touchesMoved(with event: NSEvent) { countTouches(event) }
override func touchesEnded(with event: NSEvent) { countTouches(event) }
override func touchesCancelled(with event: NSEvent) { countTouches(event) }
private func countTouches(_ event: NSEvent) {
restingFingers = event.touches(matching: .touching, in: nil).count
trace("touch: resting=\(restingFingers)")
}
// MARK: - mouse
// All three button streams land in the same three functions, because which
// stream a trackpad click arrives on is not something the app gets to know
// in advance: with macOS's secondary click on, two AND three fingers both
// come in as rightMouseDown. The button is therefore decided once, at the
// press, from the fingers plus the stream, and then LATCHED — the core is
// tracking a drag keyed by button, and answering a press of 3 with a
// release of 1 leaves it holding a sweep nothing will ever end.
//
// The count itself is maintained by the touchesXxx callbacks above; see
// beginClick for why it can only come from there.
private func beginClick(_ stream: pardes_mouse_button_e, _ event: NSEvent) {
guard let at = cell(for: event) else {
leftGrid()
return
}
pressureStage = 0
// The count comes from the touch stream and NEVER from the mouse event.
// Asking a mouse event for its touches is not merely unreliable, it
// raises: -[NSEvent touchesMatchingPhase:inView:] is defined for
// gesture and touch events, and on anything else AppKit throws, catches
// it inside its own event dispatch, and abandons the rest of this
// method. Nothing crashes and nothing is logged — every click just
// silently stops working, a plain drag included, while rotation and
// scrolling carry on as if the backend were fine. That is exactly how
// this presented, and it is why restingFingers exists.
let button = Trackpad.button(stream: stream, fingers: restingFingers)
trace("press: stream=\(stream.rawValue) fingers=\(restingFingers) -> button=\(button.rawValue)")
latchedButton = button
latchedCell = at
press(button, at: at, mods: modifiers(event.modifierFlags))
}
private func continueClick(_ event: NSEvent) {
guard let button = latchedButton else { return }
guard let at = cell(for: event) else {
// The drag is still latched, but the curved CRT edge displays no
// source cell here. Keep its last real endpoint for mouseUp and
// clear hover/seam state without clamping into the grid.
leftGrid()
return
}
latchedCell = at
drag(button, to: at, mods: modifiers(event.modifierFlags))
}
private func endClick(_ event: NSEvent) {
pressureStage = 0
// Already nil when the force click below converted this press: it
// released the button itself and there is nothing left to end.
guard let button = latchedButton else { return }
latchedButton = nil
if let at = cell(for: event) {
latchedCell = nil
release(button, at: at, mods: modifiers(event.modifierFlags))
return
}
// A release must balance its press even when the hand ends in a black
// CRT corner. The last mapped drag point is an observed source cell,
// not a clamp of the unmappable release point. Send both state changes
// before one pump notification so no frame can observe a held button
// whose pointer is already outside the displayed scene.
if let last = latchedCell {
sendMouse(button, PARDES_MOUSE_RELEASE, last.col, last.row,
modifiers(event.modifierFlags))
}
latchedCell = nil
pardes_pointer_leave()
fed()
}
override func mouseDown(with event: NSEvent) { beginClick(PARDES_MOUSE_LEFT, event) }
override func mouseDragged(with event: NSEvent) { continueClick(event) }
override func mouseUp(with event: NSEvent) { endClick(event) }
// Where a two-finger click lands with macOS's own secondary click on, and
// where a three-finger one lands too — hence the finger count in
// Trackpad.button rather than a hardcoded RIGHT here.
override func rightMouseDown(with event: NSEvent) { beginClick(PARDES_MOUSE_RIGHT, event) }
override func rightMouseDragged(with event: NSEvent) { continueClick(event) }
override func rightMouseUp(with event: NSEvent) { endClick(event) }
// Thumb navigation has its own stream so it cannot replace a held
// selection button or inherit a resting trackpad's finger count.
override func otherMouseDown(with event: NSEvent) {
if event.buttonNumber == 2 { beginClick(PARDES_MOUSE_MIDDLE, event); return }
guard event.buttonNumber == 3 || event.buttonNumber == 4,
let at = cell(for: event) else { return }
press(event.buttonNumber == 3 ? PARDES_MOUSE_BACK : PARDES_MOUSE_FORWARD,
at: at, mods: pointerModifiers)
}
override func otherMouseDragged(with event: NSEvent) {
if event.buttonNumber == 2 { continueClick(event) }
}
override func otherMouseUp(with event: NSEvent) {
if event.buttonNumber == 2 { endClick(event); return }
guard event.buttonNumber == 3 || event.buttonNumber == 4,
let at = cell(for: event) else { return }
release(event.buttonNumber == 3 ? PARDES_MOUSE_BACK : PARDES_MOUSE_FORWARD,
at: at, mods: pointerModifiers)
}
/// A deep press, which is a second gesture layered on the click already in
/// flight. AppKit keeps sending stage-2 events while the finger stays down,
/// so only the transition counts.
///
/// Whatever button is in flight is released before the look one goes out:
/// a right press arriving while the core holds a left select-drag is
/// acme's 1-3 chord, which is Paste. Releasing first costs a cursor move
/// at the click point — which is what clicking there would have done
/// anyway; a multi-finger press released this way fires its own Exec,
/// which is what the fingers already asked for.
///
/// Not gated on the press being a LEFT one, which is what stopped this
/// working: on a Force Touch trackpad the deep press is just as likely to
/// have arrived on the right stream, and an in-flight Exec upgraded by
/// pressing harder is precisely the gesture. Already-Look is the only case
/// with nothing to do.
override func pressureChange(with event: NSEvent) {
trace("pressure: stage=\(event.stage) latched=\(String(describing: latchedButton?.rawValue))")
guard pressureStage < 2 else { return }
pressureStage = event.stage
guard event.stage == 2 else { return }
guard let at = latchedCell, let current = latchedButton,
current != Trackpad.forceClickButton else { return }
latchedButton = nil
latchedCell = nil
release(current, at: at, mods: modifiers(event.modifierFlags))
click(Trackpad.forceClickButton, at: at, mods: modifiers(event.modifierFlags))
}
override func mouseMoved(with event: NSEvent) {
guard let at = cell(for: event) else {
leftGrid()
return
}
motion(to: at, mods: modifiers(event.modifierFlags))
}
override func mouseExited(with event: NSEvent) {
pointerPoint = nil
pointerMapped = false
leftGrid()
}
override func scrollWheel(with event: NSEvent) {
guard let at = cell(for: event) else {
leftGrid()
return
}
if event.hasPreciseScrollingDeltas {
// Phases first: a finger back on the pad has to catch a coast before
// its own travel is spent, or the first millimetre of the new swipe
// would be added to the old fling instead of replacing it.
//
// Momentum events carry `phase == .none` and a momentumPhase
// instead, so neither branch here fires for them — they are just
// more travel, and libpardes lets them take the gesture over. That
// is deliberate: AppKit's fling is the one the rest of the system
// uses, and a second fling of our own underneath it would scroll
// everything at double speed. `pardes_scroll_end` exists for the
// devices AppKit does NOT fling for.
if event.phase == .began { scrollBegin() }
// The core scrolls a cell at a time, so libpardes accumulates the
// sub-cell travel and spends it as wheel presses — which is why the
// cell has to travel with the delta.
scroll(rows: -event.scrollingDeltaY / cellHeight,
cols: -event.scrollingDeltaX / cellWidth,
at: at)
switch event.phase {
case .ended: scrollEnd()
// A gesture the system took away should not be thrown. scrollBegin
// is the catching half of the pair — coast stopped, bank and
// velocity cleared — which is exactly what a cancellation means.
case .cancelled: scrollBegin()
default: break
}
} else {
// AppKit's sign is the opposite of the DOM's: positive deltaY means the
// content moved down, which is a scroll back through history.
if event.scrollingDeltaY != 0 {
wheel(event.scrollingDeltaY > 0 ? PARDES_MOUSE_WHEEL_UP : PARDES_MOUSE_WHEEL_DOWN,
at: at, mods: modifiers(event.modifierFlags))
}
if event.scrollingDeltaX != 0 {
wheel(event.scrollingDeltaX > 0 ? PARDES_MOUSE_WHEEL_LEFT : PARDES_MOUSE_WHEEL_RIGHT,
at: at, mods: modifiers(event.modifierFlags))
}
}
}
/// Two fingers twisted on the trackpad are the search-step keys: clockwise
/// walks forward through the matches, counterclockwise back. It is a dial,
/// and n/N is what a dial over a list of hits means. libpardes owns the
/// quantizing and the momentum, exactly as it owns the scroll accumulator.
///
/// AppKit gives rotation no momentum phase of its own — `momentumPhase` is
/// scroll's alone — so the fling is measured from the release speed on the
/// Zig side rather than handed to us. All this has to get right is telling
/// it where the gesture starts and stops.
override func rotate(with event: NSEvent) {
trace("rotate: degrees=\(event.rotation) phase=\(event.phase.rawValue)")
// A gesture starting drops whatever the last one left banked, so the
// first degree of a new twist cannot inherit a nearly-complete notch —
// and stops a fling still coasting, because a finger back down is how
// a hand catches a dial.
if event.phase == .began { pardes_rotate(0) }
rotate(degrees: CGFloat(event.rotation))
// .cancelled too: a gesture the system took away should not fling.
if event.phase == .ended || event.phase == .cancelled { rotateEnd() }
}
/// What the trackpad actually delivered, under PARDES_LOG — the same
/// variable the Zig side gates its logger on (src/macos.zig).
///
/// This is not scaffolding left behind. Which events a trackpad produces is
/// decided by the hardware and by four different System Settings switches
/// (secondary click, three-finger drag, force click, "look up"), none of
/// which this process can read, and every one of which turns a gesture into
/// a different NSEvent or into none at all. When someone reports that
/// two-finger Exec does nothing, this is the only thing that can answer
/// whether AppKit saw two fingers, one, or no click at all.
private func trace(_ message: @autoclosure () -> String) {
guard PardesView.tracing else { return }
FileHandle.standardError.write(Data(("pardes: " + message() + "\n").utf8))
}
private static let tracing = ProcessInfo.processInfo.environment["PARDES_LOG"] != nil
private func cell(for event: NSEvent) -> GridPoint? {
let point = convert(event.locationInWindow, from: nil)
pointerPoint = point
pointerModifiers = modifiers(event.modifierFlags)
let at = cellAt(point)
pointerMapped = at != nil
if let at { pointerCell = at }
return at
}
func cellAt(_ point: CGPoint) -> GridPoint? {
// Clamp against the frame the core last rendered, not against our own
// metrics: a window that has been resized but not yet ticked would
// otherwise report a column the core has no cell for. Before the first
// frame there is no grid to point at and the event is meaningless.
let cols = Int(pardes_frame_cols())
let rows = Int(pardes_frame_rows())
guard cols > 0, rows > 0 else { return nil }
let sampled: CGPoint
if let scene = lastPresentedScene {
guard let mapped = ScenePostprocessor.sourcePoint(point, size: bounds.size, scene: scene)
else { return nil }
sampled = mapped
} else {
sampled = point
}
sampledBodyPointer = sampled
let row = min(max(Int(sampled.y / cellHeight), 0), rows - 1)
let col = min(max(Int(sampled.x / cellWidth), 0), cols - 1)
return GridPoint(col: UInt16(col), row: UInt16(row))
}
// MARK: - files dropped on the grid
/// A drop is a CLICK followed by `Look`, and that is the whole definition.
///
/// The core has no notion of a drop and is not being given one: the pointer
/// lands where it landed, which focuses that pane exactly as a left click
/// there would, and then the ordinary `Look` builtin runs in it — so the
/// document opens beside the pane you pointed at rather than beside
/// whichever one happened to be focused. Drop on a tag and you clicked a
/// tag; there is no case to special-case, and nothing here the hand could
/// not have done itself.
override func draggingEntered(_ sender: NSDraggingInfo) -> NSDragOperation {
// AppKit reuses this answer for draggingUpdated when that is not
// implemented, so the cursor stays right for the whole drag.
droppedFiles(sender).isEmpty ? [] : .copy
}
override func performDragOperation(_ sender: NSDraggingInfo) -> Bool {
let paths = droppedFiles(sender)
guard !paths.isEmpty else { return false }
drop(paths, at: cellAt(convert(sender.draggingLocation, from: nil)))
return true
}
/// The drop, decoded: paths and a cell, nothing AppKit left in it.
///
/// Split out for the reason every gesture here is — `NSDraggingInfo` is a
/// protocol with a dozen members and no public conformer, so a test that
/// had to build one would be testing its own stub. The decision lives one
/// call below the event, and `drop` in test/macos_e2e.swift drives exactly
/// this.
///
/// A nil cell is a drop before the first frame, which has no grid to point
/// at: the files still open, they just open where focus already was.
func drop(_ paths: [String], at target: GridPoint?) {
if let target {
press(PARDES_MOUSE_LEFT, at: target)
release(PARDES_MOUSE_LEFT, at: target)
}
// Whole tail, unquoted: executeBuiltinLine takes everything after the
// first word as the argument, so a path with spaces in it needs no
// escaping and would in fact break under any.
for path in paths {
let line = "Look \(path)"
line.withCString { pardes_command($0, line.utf8.count) }
}
fed()
}
/// File paths on the drag pasteboard, in order. Empty for anything else,
/// which is also how draggingEntered decides whether to accept at all.
private func droppedFiles(_ sender: NSDraggingInfo) -> [String] {
let options: [NSPasteboard.ReadingOptionKey: Any] = [.urlReadingFileURLsOnly: true]
guard let urls = sender.draggingPasteboard.readObjects(
forClasses: [NSURL.self], options: options) as? [URL]
else { return [] }
return urls.map(\.path)
}
// MARK: - geometry
override func updateTrackingAreas() {
super.updateTrackingAreas()
for area in trackingAreas { removeTrackingArea(area) }
// .inVisibleRect keeps the area correct across resizes on its own, which
// is why the rect argument can be anything.
addTrackingArea(NSTrackingArea(rect: .zero,
options: [.mouseMoved, .mouseEnteredAndExited, .inVisibleRect, .activeInKeyWindow],
owner: self,
userInfo: nil))
}
private enum Pointer: Equatable { case text, link, target }
private var pointer: Pointer = .text
/// The core's pointer_shape, in this shell's cursor vocabulary: a link
/// is a PDF hyperlink (the hand), a target is a word the core's own
/// Look-hover plumbing validated as a real Look or Exec operand, and
/// anything else is text — the I-beam.
private func pointerShape() -> Pointer {
switch pardes_pointer_shape() {
case 1: return .link
case 2: return .target
default: return .text
}
}
private func cursorFor(_ shape: Pointer) -> NSCursor {
switch shape {
case .link: return .pointingHand
case .target: return .arrow
case .text: return .iBeam
}
}
override func resetCursorRects() {
// Every cell in this view is text, including the tags. An arrow over
// plain text is the wrong affordance — but a word the core has
// validated as a Look or Exec target earns it: middle- and
// right-clicking there acts, and the cursor says so before it does.
addCursorRect(bounds, cursor: cursorFor(pointer))
}
override func setFrameSize(_ newSize: NSSize) {
super.setFrameSize(newSize)
// AppKit resizes a view many times over one drag and almost all of those
// land inside the same cell. Only a changed grid is news, and the core
// reflows every pty on a resize, so the no-ops are not free.
let grid = gridSize
guard grid.cols != reportedCols || grid.rows != reportedRows else { return }
reportedCols = grid.cols
reportedRows = grid.rows
delegate?.pardesViewDidResize(self)
}
// Dragging the window between a Retina display and a 1x one changes the
// backing scale without moving a single bound, so setFrameSize above never
// fires. This is the only notification of it. (Ghostty hooks the same one,
// and additionally re-fires from the window's didChangeScreen
// notification, which AppKit does not always pair with it.)
//
// TWO things depend on the scale: the physical cell metrics the core uses
// to place PDF pages, and the cell itself, which is snapped to whole
// DEVICE pixels (see Metrics) and is therefore aligned to the display it
// was measured on. Re-measuring reports the resize on its own, so the
// delegate call is the else-branch and not an extra one.
override func viewDidChangeBackingProperties() {
super.viewDidChangeBackingProperties()
if let scale = window?.backingScaleFactor, scale != metricsScale {
wear(size: fontSize, path: fontPath)
} else {
delegate?.pardesViewDidResize(self)
}
}
}
// ponytail: no NSTextInputClient, so dead keys and IME composition never reach
// the core — keyDown reads `characters` and that is the whole story. Adopting
// the protocol and routing through interpretKeyEvents is the upgrade when
// someone needs to type Japanese, and it needs the core to be able to render an
// underlined preedit run first.
|