Source file matrix_grid.ml
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
module Text = Matrix_text
module Color_packed = Ansi.Color.Packed
module Buf = struct
type ints = (int, Bigarray.int_elt, Bigarray.c_layout) Bigarray.Array1.t
type shorts =
(int, Bigarray.int16_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t
let ints len : ints =
Bigarray.Array1.create Bigarray.int Bigarray.c_layout len
let shorts len : shorts =
Bigarray.Array1.create Bigarray.int16_unsigned Bigarray.c_layout len
let[@inline] get (a : ints) i = Bigarray.Array1.unsafe_get a i
let[@inline] set (a : ints) i v = Bigarray.Array1.unsafe_set a i v
let[@inline] get_short (a : shorts) i = Bigarray.Array1.unsafe_get a i
let[@inline] set_short (a : shorts) i v = Bigarray.Array1.unsafe_set a i v
let[@inline] get_cell a i = Packed_cell.unsafe_of_int (get a i)
let[@inline] set_cell a i (v : Packed_cell.t) = set a i (Packed_cell.to_int v)
let fill = Bigarray.Array1.fill
let blit = Bigarray.Array1.blit
let dim = Bigarray.Array1.dim
let fill_cell a (v : Packed_cell.t) = fill a (Packed_cell.to_int v)
let[@inline] blit_range src ~src_pos dst ~dst_pos ~len =
if src == dst && src_pos < dst_pos then
for i = len - 1 downto 0 do
set dst (dst_pos + i) (get src (src_pos + i))
done
else
for i = 0 to len - 1 do
set dst (dst_pos + i) (get src (src_pos + i))
done
let[@inline] blit_short_range src ~src_pos dst ~dst_pos ~len =
if src == dst && src_pos < dst_pos then
for i = len - 1 downto 0 do
set_short dst (dst_pos + i) (get_short src (src_pos + i))
done
else
for i = 0 to len - 1 do
set_short dst (dst_pos + i) (get_short src (src_pos + i))
done
let[@inline] fill_range a ~pos ~len v =
for i = pos to pos + len - 1 do
set a i v
done
let[@inline] fill_short_range a ~pos ~len v =
for i = pos to pos + len - 1 do
set_short a i v
done
end
module Rect = struct
type t = { x : int; y : int; width : int; height : int }
let intersection a b =
let x = max a.x b.x in
let y = max a.y b.y in
let w = min (a.x + a.width) (b.x + b.width) - x in
let h = min (a.y + a.height) (b.y + b.height) - y in
if w > 0 && h > 0 then Some { x; y; width = w; height = h } else None
let clip_to_bounds max_w max_h r =
let x = max 0 r.x in
let y = max 0 r.y in
let w = min (r.x + r.width) max_w - x in
let h = min (r.y + r.height) max_h - y in
if w > 0 && h > 0 then Some { x; y; width = w; height = h } else None
end
module Scissor_stack = struct
type t = Rect.t Dynarray.t
let create () = Dynarray.create ()
let current s = if Dynarray.is_empty s then None else Dynarray.find_last s
let push s r =
let r =
match current s with
| None -> r
| Some c -> (
match Rect.intersection c r with
| Some i -> i
| None -> Rect.{ x = 0; y = 0; width = 0; height = 0 })
in
Dynarray.add_last s r
let pop s = ignore (Dynarray.pop_last_opt s)
let clear s = Dynarray.clear s
let[@inline] contains rect_opt ~x ~y =
match rect_opt with
| None -> true
| Some Rect.{ x = rx; y = ry; width = rw; height = rh } ->
x >= rx && y >= ry && x < rx + rw && y < ry + rh
end
module Border = Border
module Lines = Lines
type region = Rect.t = { x : int; y : int; width : int; height : int }
type t = {
mutable width : int;
mutable height : int;
grapheme_store : Grapheme_store.t;
mutable width_method : Text.width_method;
mutable chars : Buf.ints;
mutable fg_color : Buf.ints;
mutable bg_color : Buf.ints;
mutable attrs : Buf.shorts;
mutable links : string array;
grapheme_tracker : Grapheme_tracker.t;
scissor_stack : Scissor_stack.t;
opacity_stack : float Dynarray.t;
mutable opacity_product : float;
}
let space_cell = Packed_cell.space
let null_cell = Packed_cell.empty
let no_link = ""
let default_fg = Ansi.Color.default_fg
let default_bg = Ansi.Color.transparent
let default_fg_packed = Color_packed.encode default_fg
let default_bg_packed = Color_packed.encode default_bg
let terminal_bg_packed = Color_packed.encode Ansi.Color.default_bg
let[@inline] get_link t idx =
if Array.length t.links = 0 then no_link else Array.unsafe_get t.links idx
let ensure_links t =
if Array.length t.links = 0 then
t.links <- Array.make (t.width * t.height) no_link
let[@inline] set_link t idx link =
if Array.length t.links <> 0 then Array.unsafe_set t.links idx link
else if link <> no_link then (
ensure_links t;
Array.unsafe_set t.links idx link)
let clear_links t pos len =
if Array.length t.links <> 0 then Array.fill t.links pos len no_link
let blit_links ~src ~dst src_pos dst_pos len =
if Array.length src.links = 0 then clear_links dst dst_pos len
else (
ensure_links dst;
Array.blit src.links src_pos dst.links dst_pos len)
let[@inline] is_clipped t x y =
not (Scissor_stack.contains (Scissor_stack.current t.scissor_stack) ~x ~y)
let[@inline] get_fg t idx = Color_packed.decode (Buf.get t.fg_color idx)
let[@inline] get_bg t idx = Color_packed.decode (Buf.get t.bg_color idx)
(** Clip a rectangle against both the scissor stack and grid bounds. *)
let clip_rect_to_grid t r =
let open Rect in
match Scissor_stack.current t.scissor_stack with
| None -> clip_to_bounds t.width t.height r
| Some s -> (
match intersection r s with
| None -> None
| Some i -> clip_to_bounds t.width t.height i)
(** Write a blank on [bg] into a cell, leaving the grapheme tracker alone. *)
let[@inline] write_blank t idx bg =
Buf.set_cell t.chars idx space_cell;
Buf.set_short t.attrs idx 0;
set_link t idx no_link;
Buf.set t.fg_color idx default_fg_packed;
Buf.set t.bg_color idx bg
(** Turn a cell into a blank on [bg], releasing its grapheme tracker entry. *)
let[@inline] blank_cell t idx bg =
let code = Buf.get_cell t.chars idx in
if code <> space_cell then Grapheme_tracker.remove t.grapheme_tracker code;
write_blank t idx bg
let[@inline] extent_left code =
if Packed_cell.is_inline code then 0 else Packed_cell.left_extent code
let[@inline] extent_right code =
if Packed_cell.is_inline code then max 0 (Packed_cell.cell_width code - 1)
else Packed_cell.right_extent code
(** Blank the other cells of the grapheme at [idx] on [bg], so that overwriting
[idx] leaves no part of it. *)
let cleanup_grapheme_at t idx bg =
let code = Buf.get_cell t.chars idx in
let start_idx = idx - extent_left code
and end_idx = idx + extent_right code in
if start_idx >= 0 && end_idx < Buf.dim t.chars then
for i = start_idx to end_idx do
if i <> idx then blank_cell t i bg
done
(** Blank every cell of the grapheme at [idx] on [bg]. *)
let blank_grapheme t idx bg =
cleanup_grapheme_at t idx bg;
blank_cell t idx bg
let cleanup_overwritten_cell t idx bg =
let old = Buf.get_cell t.chars idx in
if old <> space_cell then begin
if (not (Packed_cell.is_inline old)) || Packed_cell.cell_width old > 1 then
cleanup_grapheme_at t idx bg;
Grapheme_tracker.remove t.grapheme_tracker old
end
(** Write a cell code into a cell, blanking the rest of the grapheme it
overwrites on [bg] and maintaining grapheme tracker state. *)
let[@inline] write_cell t idx code bg =
let old = Buf.get_cell t.chars idx in
if old <> code then begin
if not (Packed_cell.is_inline code) then
Grapheme_tracker.add t.grapheme_tracker code;
if (not (Packed_cell.is_inline old)) || Packed_cell.cell_width old > 1 then
cleanup_grapheme_at t idx bg;
Grapheme_tracker.remove t.grapheme_tracker old;
Buf.set_cell t.chars idx code
end
let make_cell_copier ~src_store ~dst_store =
let cache = Hashtbl.create 64 in
fun code ->
match Packed_cell.store_key code with
| None -> code
| Some key ->
let copied =
match Hashtbl.find_opt cache key with
| Some g -> g
| None ->
let g = Packed_cell.copy ~src:src_store code ~dst:dst_store in
Hashtbl.add cache key g;
g
in
if Packed_cell.is_empty copied then copied
else
Packed_cell.pack_start
(Packed_cell.unpack_idx copied)
(Packed_cell.unpack_gen copied)
(Packed_cell.grapheme_width code)
let fill_defaults t =
Grapheme_tracker.clear t.grapheme_tracker;
Scissor_stack.clear t.scissor_stack;
Buf.fill_cell t.chars space_cell;
Buf.fill t.attrs 0;
clear_links t 0 (t.width * t.height);
Buf.fill t.fg_color default_fg_packed;
Buf.fill t.bg_color default_bg_packed
let create_with_store ~width ~height ~grapheme_store ~width_method =
if width <= 0 || height <= 0 then
invalid_arg "Matrix_grid.create: width and height must be > 0";
if width > Packed_cell.max_width then
invalid_arg "Matrix_grid.create: width exceeds the maximum";
let size = width * height in
let t =
{
width;
height;
grapheme_store;
width_method;
chars = Buf.ints size;
fg_color = Buf.ints size;
bg_color = Buf.ints size;
attrs = Buf.shorts size;
links = [||];
grapheme_tracker = Grapheme_tracker.create grapheme_store;
scissor_stack = Scissor_stack.create ();
opacity_stack = Dynarray.create ();
opacity_product = 1.0;
}
in
fill_defaults t;
t
let create ~width ~height ?width_method () =
create_with_store ~width ~height ~grapheme_store:(Grapheme_store.create ())
~width_method:(Option.value width_method ~default:`Unicode)
let create_like g ~width ~height =
create_with_store ~width ~height ~grapheme_store:g.grapheme_store
~width_method:g.width_method
let max_width = Packed_cell.max_width
let width t = t.width
let height t = t.height
let width_method t = t.width_method
let set_width_method t m = t.width_method <- m
let[@inline] idx t ~x ~y = (y * t.width) + x
let[@inline] get_codepoint t idx =
let code = Buf.get_cell t.chars idx in
if Packed_cell.is_inline code then Packed_cell.codepoint code else -1
let protected_bit = 1 lsl Ansi.Attr.bits
let attrs_mask = protected_bit - 1
let () = assert (protected_bit <= 0x8000)
let[@inline] get_attrs t idx = Buf.get_short t.attrs idx land attrs_mask
let[@inline] is_protected t idx =
Buf.get_short t.attrs idx land protected_bit <> 0
let get_style t idx =
let attrs = Ansi.Attr.unpack (get_attrs t idx) in
let url = get_link t idx in
let link = if url = no_link then None else Some url in
Ansi.Style.make ~fg:(get_fg t idx) ~bg:(get_bg t idx) ?link ()
|> Ansi.Style.with_attrs attrs
let[@inline] has_text c =
not (c = Packed_cell.empty || Packed_cell.is_continuation c)
let get_text t idx =
let c = Buf.get_cell t.chars idx in
if has_text c then Packed_cell.to_string t.grapheme_store c else ""
let cell_text_length t idx =
let c = Buf.get_cell t.chars idx in
if has_text c then Packed_cell.length t.grapheme_store c else 0
let blit_cell_text t idx buf ~pos =
if pos < 0 || pos > Bytes.length buf then
invalid_arg "Matrix_grid.blit_cell_text: position out of bounds";
let c = Buf.get_cell t.chars idx in
if has_text c then Packed_cell.blit t.grapheme_store c buf ~pos else 0
let is_empty t idx = Buf.get_cell t.chars idx = Packed_cell.empty
let is_continuation t idx =
Packed_cell.is_continuation (Buf.get_cell t.chars idx)
let cell_width t idx = Packed_cell.cell_width (Buf.get_cell t.chars idx)
let extent t idx =
if idx < 0 || idx >= t.width * t.height then
invalid_arg "Matrix_grid.extent: index outside the grid";
let code = Buf.get_cell t.chars idx in
let left = extent_left code in
(idx - left, left + extent_right code + 1)
let[@inline] cells_equal t1 idx1 t2 idx2 =
let same_graphemes = t1.grapheme_store == t2.grapheme_store in
let c1 = Buf.get_cell t1.chars idx1 and c2 = Buf.get_cell t2.chars idx2 in
(if same_graphemes then c1 = c2
else Packed_cell.equal t1.grapheme_store c1 t2.grapheme_store c2)
&& get_attrs t1 idx1 = get_attrs t2 idx2
&& String.equal (get_link t1 idx1) (get_link t2 idx2)
&& Buf.get t1.fg_color idx1 = Buf.get t2.fg_color idx2
&& Buf.get t1.bg_color idx1 = Buf.get t2.bg_color idx2
let rebuild_grapheme_tracker t =
let tracker = t.grapheme_tracker in
let old = Grapheme_tracker.start_recount tracker in
let len = t.width * t.height in
for i = 0 to len - 1 do
let code = Buf.get_cell t.chars i in
if Packed_cell.is_complex code then Grapheme_tracker.add tracker code
done;
Grapheme_tracker.finish_recount tracker old
let sanitize_extents t =
for y = 0 to t.height - 1 do
let row_start = y * t.width in
let covered_until = ref (-1) in
for x = 0 to t.width - 1 do
let idx = row_start + x in
let code = Buf.get_cell t.chars idx in
if Packed_cell.is_continuation code then
begin if x > !covered_until then write_blank t idx default_bg_packed
end
else
let w = Packed_cell.cell_width code in
if w > 1 then
if x + w > t.width then write_blank t idx default_bg_packed
else begin
let valid = ref true in
for dx = 1 to w - 1 do
if
not
(Packed_cell.is_continuation
(Buf.get_cell t.chars (idx + dx)))
then valid := false
done;
if !valid then covered_until := max !covered_until (x + w - 1)
else begin
write_blank t idx default_bg_packed;
for dx = 1 to w - 1 do
write_blank t (idx + dx) default_bg_packed
done
end
end
done
done
let clear ?color t =
Grapheme_tracker.clear t.grapheme_tracker;
Buf.fill_cell t.chars space_cell;
Buf.fill t.attrs 0;
clear_links t 0 (t.width * t.height);
Buf.fill t.fg_color default_fg_packed;
let bg_color =
Option.value color ~default:default_bg |> Color_packed.encode
in
Buf.fill t.bg_color bg_color
let resize t ~width ~height =
if width <= 0 || height <= 0 then
invalid_arg "Matrix_grid.resize: width and height must be > 0";
if width > Packed_cell.max_width then
invalid_arg "Matrix_grid.resize: width exceeds the maximum";
if width = t.width && height = t.height then ()
else
let old_w = t.width and old_h = t.height in
let old_chars = t.chars and old_attrs = t.attrs and old_links = t.links in
let old_fg_color = t.fg_color and old_bg_color = t.bg_color in
let new_size = width * height in
let new_chars = Buf.ints new_size in
let new_attrs = Buf.shorts new_size in
let new_links =
if Array.length old_links = 0 then [||] else Array.make new_size no_link
in
let new_fg_color = Buf.ints new_size in
let new_bg_color = Buf.ints new_size in
Buf.fill_cell new_chars space_cell;
Buf.fill new_attrs 0;
Buf.fill new_fg_color default_fg_packed;
Buf.fill new_bg_color default_bg_packed;
let copy_w = min old_w width in
let copy_h = min old_h height in
for y = 0 to copy_h - 1 do
let src_off = y * old_w and dst_off = y * width in
Buf.blit_range old_chars ~src_pos:src_off new_chars ~dst_pos:dst_off
~len:copy_w;
Buf.blit_short_range old_attrs ~src_pos:src_off new_attrs ~dst_pos:dst_off
~len:copy_w;
if Array.length old_links <> 0 then
Array.blit old_links src_off new_links dst_off copy_w;
Buf.blit_range old_fg_color ~src_pos:src_off new_fg_color ~dst_pos:dst_off
~len:copy_w;
Buf.blit_range old_bg_color ~src_pos:src_off new_bg_color ~dst_pos:dst_off
~len:copy_w
done;
t.width <- width;
t.height <- height;
t.chars <- new_chars;
t.attrs <- new_attrs;
t.links <- new_links;
t.fg_color <- new_fg_color;
t.bg_color <- new_bg_color;
sanitize_extents t;
rebuild_grapheme_tracker t
let resize_clear ?color t ~width ~height =
if width <= 0 || height <= 0 then
invalid_arg "Matrix_grid.resize_clear: width and height must be > 0";
if width > Packed_cell.max_width then
invalid_arg "Matrix_grid.resize_clear: width exceeds the maximum";
if width <> t.width || height <> t.height then (
resize t ~width ~height;
clear ?color t)
let push_clip t rect = Scissor_stack.push t.scissor_stack rect
let pop_clip t = Scissor_stack.pop t.scissor_stack
let clear_clip t = Scissor_stack.clear t.scissor_stack
let clip_region t =
match Scissor_stack.current t.scissor_stack with
| None -> { x = 0; y = 0; width = t.width; height = t.height }
| Some r ->
let x = max 0 r.x and y = max 0 r.y in
{
x;
y;
width = max 0 (min t.width (r.x + r.width) - x);
height = max 0 (min t.height (r.y + r.height) - y);
}
let intersects_clip t (r : region) =
if r.width <= 0 || r.height <= 0 then false
else
let x0 = max 0 r.x in
let y0 = max 0 r.y in
let x1 = min t.width (r.x + r.width) in
let y1 = min t.height (r.y + r.height) in
if x0 >= x1 || y0 >= y1 then false
else
match Scissor_stack.current t.scissor_stack with
| None -> true
| Some clip ->
x0 < clip.x + clip.width
&& x1 > clip.x
&& y0 < clip.y + clip.height
&& y1 > clip.y
let clip t rect f =
push_clip t rect;
Fun.protect ~finally:(fun () -> pop_clip t) f
let push_opacity t opacity =
let clamped = Float.max 0.0 (Float.min 1.0 opacity) in
Dynarray.add_last t.opacity_stack clamped;
t.opacity_product <- t.opacity_product *. clamped
let pop_opacity t =
match Dynarray.pop_last_opt t.opacity_stack with
| None -> ()
| Some _ ->
let depth = Dynarray.length t.opacity_stack in
if depth = 0 then t.opacity_product <- 1.0
else
let p = ref 1.0 in
for i = 0 to depth - 1 do
p := !p *. Dynarray.get t.opacity_stack i
done;
t.opacity_product <- !p
let current_opacity t = t.opacity_product
let[@inline] apply_opacity t color =
if t.opacity_product >= 1. then color
else
Color_packed.with_alpha color
(int_of_float
(Float.round
(float_of_int (Color_packed.alpha color) *. t.opacity_product)))
let copy_rendition t ~lead idx =
Buf.set_short t.attrs idx (Buf.get_short t.attrs lead);
set_link t idx (get_link t lead);
Buf.set t.fg_color idx (Buf.get t.fg_color lead);
Buf.set t.bg_color idx (Buf.get t.bg_color lead)
type write = Copy | Draw | Overlay
let set_cell_internal t ~idx ~code ~fg_color ~bg_color ~attrs ~link ~write =
let fg_alpha = Color_packed.alpha fg_color in
let bg_alpha = Color_packed.alpha bg_color in
let blending = write <> Copy in
if blending && fg_alpha = 0 && bg_alpha = 0 then ()
else if blending && (fg_alpha < 255 || bg_alpha < 255) then begin
let dest_code = Buf.get_cell t.chars idx in
let blank = write = Overlay && (code = space_cell || code = null_cell) in
if Packed_cell.is_continuation code then begin
let lead = idx - Packed_cell.left_extent code in
write_cell t idx code (Buf.get t.bg_color lead);
copy_rendition t ~lead idx
end
else if blank && Packed_cell.is_continuation dest_code then
copy_rendition t ~lead:(idx - Packed_cell.left_extent dest_code) idx
else begin
let blended_bg =
Color_packed.blend ~src:bg_color ~dst:(Buf.get t.bg_color idx)
in
if blank && dest_code <> null_cell && dest_code <> space_cell then begin
Buf.set t.fg_color idx
(Color_packed.blend ~src:bg_color ~dst:(Buf.get t.fg_color idx));
set_link t idx link;
Buf.set t.bg_color idx blended_bg;
for i = idx + 1 to idx + extent_right dest_code do
copy_rendition t ~lead:idx i
done
end
else begin
write_cell t idx code blended_bg;
Buf.set_short t.attrs idx attrs;
Buf.set t.fg_color idx
(Color_packed.blend ~src:fg_color ~dst:blended_bg);
set_link t idx link;
Buf.set t.bg_color idx blended_bg
end
end
end
else begin
write_cell t idx code bg_color;
Buf.set_short t.attrs idx attrs;
set_link t idx link;
Buf.set t.fg_color idx fg_color;
Buf.set t.bg_color idx bg_color
end
let set_uchar t ~x ~y ~uchar ~fg ~bg ~attrs ?link ?(blend = false) () =
if x >= 0 && y >= 0 && x < t.width && y < t.height && not (is_clipped t x y)
then begin
let code = Packed_cell.of_uchar uchar in
let width = max 1 (Packed_cell.cell_width code) in
let fits = x + width <= t.width in
let fg_color = Color_packed.encode fg
and bg_color = Color_packed.encode bg in
let fg_color = if blend then apply_opacity t fg_color else fg_color in
let bg_color = if blend then apply_opacity t bg_color else bg_color in
let link = Option.value link ~default:no_link in
let attrs = Ansi.Attr.pack attrs in
for dx = 0 to min width (t.width - x) - 1 do
let cell =
if not fits then space_cell
else if dx = 0 then code
else Packed_cell.make_continuation ~left:dx ~right:(width - dx - 1)
in
set_cell_internal t
~idx:((y * t.width) + x + dx)
~code:cell ~fg_color ~bg_color ~attrs ~link
~write:(if blend then Draw else Copy)
done
end
let rec has_control s i limit =
i < limit
&&
let b = Char.code (String.unsafe_get s i) in
b < 0x20 || b = 0x7F
|| b = 0xC2
&& i + 1 < limit
&& Char.code (String.unsafe_get s (i + 1)) < 0xA0
&& Char.code (String.unsafe_get s (i + 1)) >= 0x80
|| has_control s (i + 1) limit
let set_grapheme t ~x ~y ~width ~fg ~bg ~attrs ?(link = no_link)
?(protected = false) s ~pos ~len =
if pos < 0 || len <= 0 || pos > String.length s - len then
invalid_arg "Matrix_grid.set_grapheme: invalid substring";
if width < 1 || x < 0 || x + width > t.width || y < 0 || y >= t.height then
invalid_arg "Matrix_grid.set_grapheme: cells outside the grid";
if has_control s pos (pos + len) then
invalid_arg "Matrix_grid.set_grapheme: control character";
let code = Packed_cell.intern_sub t.grapheme_store s ~pos ~len ~width in
let fg_color = Color_packed.encode fg and bg_color = Color_packed.encode bg in
let attrs =
if protected then Ansi.Attr.pack attrs lor protected_bit
else Ansi.Attr.pack attrs
in
let idx = (y * t.width) + x in
set_cell_internal t ~idx ~code ~fg_color ~bg_color ~attrs ~link ~write:Copy;
for i = 1 to width - 1 do
let code = Packed_cell.make_continuation ~left:i ~right:(width - 1 - i) in
set_cell_internal t ~idx:(idx + i) ~code ~fg_color ~bg_color ~attrs ~link
~write:Copy
done
let erase_unprotected t (r : region) =
match Rect.clip_to_bounds t.width t.height r with
| None -> ()
| Some r ->
for y = r.y to r.y + r.height - 1 do
let row = y * t.width in
let first = row + r.x and last = row + r.x + r.width - 1 in
let stop = last + extent_right (Buf.get_cell t.chars last) in
let i = ref (first - extent_left (Buf.get_cell t.chars first)) in
while !i <= stop do
let w = max 1 (Packed_cell.cell_width (Buf.get_cell t.chars !i)) in
if not (is_protected t !i) then
for j = !i to !i + w - 1 do
let code = Buf.get_cell t.chars j in
if code <> space_cell then begin
Grapheme_tracker.remove t.grapheme_tracker code;
Buf.set_cell t.chars j space_cell
end;
set_link t j no_link
done;
i := !i + w
done
done
let fill_opaque_rect t ~x0 ~y0 ~width ~height ~bg_color =
if x0 = 0 && y0 = 0 && width = t.width && height = t.height then begin
Grapheme_tracker.clear t.grapheme_tracker;
Buf.fill_cell t.chars space_cell;
Buf.fill t.attrs 0;
clear_links t 0 (t.width * t.height);
Buf.fill t.fg_color default_fg_packed;
Buf.fill t.bg_color bg_color
end
else
let y1 = y0 + height - 1 in
for row = y0 to y1 do
let start_idx = (row * t.width) + x0 in
let end_idx = start_idx + width - 1 in
for i = start_idx to end_idx do
cleanup_overwritten_cell t i bg_color
done;
Buf.fill_range t.chars ~pos:start_idx ~len:width
(Packed_cell.to_int space_cell);
Buf.fill_short_range t.attrs ~pos:start_idx ~len:width 0;
clear_links t start_idx width;
Buf.fill_range t.fg_color ~pos:start_idx ~len:width default_fg_packed;
Buf.fill_range t.bg_color ~pos:start_idx ~len:width bg_color
done
let clear_rect ?color t ~x ~y ~width ~height =
let x0 = ref (max 0 x) and y0 = ref (max 0 y) in
let x1 = ref (min t.width (x + width))
and y1 = ref (min t.height (y + height)) in
let scissors = Dynarray.length t.scissor_stack in
if scissors > 0 then begin
let s = Dynarray.get t.scissor_stack (scissors - 1) in
x0 := max !x0 s.Rect.x;
y0 := max !y0 s.y;
x1 := min !x1 (s.x + s.width);
y1 := min !y1 (s.y + s.height)
end;
if !x1 > !x0 && !y1 > !y0 then
let bg_color =
Option.value color ~default:default_bg |> Color_packed.encode
in
fill_opaque_rect t ~x0:!x0 ~y0:!y0 ~width:(!x1 - !x0) ~height:(!y1 - !y0)
~bg_color
let fill_rect t ~x ~y ~width ~height ~color =
match clip_rect_to_grid t Rect.{ x; y; width; height } with
| None -> ()
| Some r ->
let bg_color = apply_opacity t (Color_packed.encode color) in
let alpha = Color_packed.alpha bg_color in
if alpha = 0 then ()
else if alpha = 255 then
fill_opaque_rect t ~x0:r.x ~y0:r.y ~width:r.width ~height:r.height
~bg_color
else
for row = r.y to r.y + r.height - 1 do
let base = (row * t.width) + r.x in
for dx = 0 to r.width - 1 do
set_cell_internal t ~idx:(base + dx) ~code:space_cell
~fg_color:default_fg_packed ~bg_color ~attrs:0 ~link:no_link
~write:Overlay
done
done
let merge_rect t ~x ~y ~width ~height (style : Ansi.Style.t) =
match clip_rect_to_grid t Rect.{ x; y; width; height } with
| _ when t.opacity_product <= 0. -> ()
| None -> ()
| Some r ->
let packed c =
Option.map (fun c -> apply_opacity t (Color_packed.encode c)) c
in
let fg = packed style.fg and bg = packed style.bg in
let attrs = Ansi.Attr.pack style.attrs in
for row = r.y to r.y + r.height - 1 do
let base = row * t.width in
for i = base + r.x to base + r.x + r.width - 1 do
(match fg with
| Some c when Buf.get t.fg_color i = default_fg_packed ->
Buf.set t.fg_color i c
| _ -> ());
(match bg with
| Some c when Color_packed.alpha (Buf.get t.bg_color i) = 0 ->
Buf.set t.bg_color i c
| _ -> ());
if attrs <> 0 then
Buf.set_short t.attrs i (Buf.get_short t.attrs i lor attrs)
done
done
let blit ~src ~dst =
if src == dst then ()
else (
resize dst ~width:src.width ~height:src.height;
dst.width_method <- src.width_method;
Buf.blit src.fg_color dst.fg_color;
Buf.blit src.bg_color dst.bg_color;
Buf.blit src.attrs dst.attrs;
blit_links ~src ~dst 0 0 (src.width * src.height);
if src.grapheme_store == dst.grapheme_store then (
Buf.blit src.chars dst.chars;
Grapheme_tracker.clear dst.grapheme_tracker;
let len = src.width * src.height in
for i = 0 to len - 1 do
let c = Buf.get_cell dst.chars i in
if Packed_cell.is_complex c then
Grapheme_tracker.add dst.grapheme_tracker c
done)
else
let copy_cell =
make_cell_copier ~src_store:src.grapheme_store
~dst_store:dst.grapheme_store
in
Grapheme_tracker.clear dst.grapheme_tracker;
let len = src.width * src.height in
for i = 0 to len - 1 do
let src_c = Buf.get_cell src.chars i in
let dst_c =
if Packed_cell.is_inline src_c then src_c else copy_cell src_c
in
Buf.set_cell dst.chars i dst_c;
if Packed_cell.is_complex dst_c then
Grapheme_tracker.add dst.grapheme_tracker dst_c
done)
let copy t =
let dst =
create ~width:t.width ~height:t.height ~width_method:t.width_method ()
in
blit ~src:t ~dst;
dst
(** Update grapheme tracker for a bulk row copy within the same grid. *)
let bulk_update_graphemes t ~src_idx ~dst_idx ~len =
if Grapheme_tracker.unique_count t.grapheme_tracker > 0 then begin
for i = 0 to len - 1 do
let code = Buf.get_cell t.chars (src_idx + i) in
if not (Packed_cell.is_inline code) then
Grapheme_tracker.add t.grapheme_tracker code
done;
for i = 0 to len - 1 do
let code = Buf.get_cell t.chars (dst_idx + i) in
if not (Packed_cell.is_inline code) then
Grapheme_tracker.remove t.grapheme_tracker code
done
end
let move_within t ~src_x ~src_y ~width ~height ~dst_x ~dst_y ~repair =
if src_x = 0 && dst_x = 0 && width = t.width then begin
let si = src_y * t.width in
let di = dst_y * t.width in
let len = width * height in
bulk_update_graphemes t ~src_idx:si ~dst_idx:di ~len;
Buf.blit
(Bigarray.Array1.sub t.chars si len)
(Bigarray.Array1.sub t.chars di len);
Buf.blit
(Bigarray.Array1.sub t.attrs si len)
(Bigarray.Array1.sub t.attrs di len);
blit_links ~src:t ~dst:t si di len;
Buf.blit
(Bigarray.Array1.sub t.fg_color si len)
(Bigarray.Array1.sub t.fg_color di len);
Buf.blit
(Bigarray.Array1.sub t.bg_color si len)
(Bigarray.Array1.sub t.bg_color di len)
end
else begin
let y_start, y_limit, y_step =
if src_y < dst_y then (height - 1, -1, -1) else (0, height, 1)
in
let row = ref y_start in
while !row <> y_limit do
let si = ((src_y + !row) * t.width) + src_x in
let di = ((dst_y + !row) * t.width) + dst_x in
let last = di + width - 1 in
let old_start = di - extent_left (Buf.get_cell t.chars di) in
let old_end = last + extent_right (Buf.get_cell t.chars last) in
bulk_update_graphemes t ~src_idx:si ~dst_idx:di ~len:width;
Buf.blit_range t.chars ~src_pos:si t.chars ~dst_pos:di ~len:width;
Buf.blit_short_range t.attrs ~src_pos:si t.attrs ~dst_pos:di ~len:width;
blit_links ~src:t ~dst:t si di width;
Buf.blit_range t.fg_color ~src_pos:si t.fg_color ~dst_pos:di ~len:width;
Buf.blit_range t.bg_color ~src_pos:si t.bg_color ~dst_pos:di ~len:width;
for i = old_start to di - 1 do
blank_cell t i repair
done;
for i = last + 1 to old_end do
blank_cell t i repair
done;
let first = Buf.get_cell t.chars di in
let final = Buf.get_cell t.chars last in
if Packed_cell.is_continuation first then
for i = di to min last (di + Packed_cell.right_extent first) do
blank_cell t i repair
done;
if extent_right final > 0 then
for i = max di (last - extent_left final) to last do
blank_cell t i repair
done;
row := !row + y_step
done
end
let transfer_region ~blend ~src ~dst ~src_x ~src_y ~width ~height ~dst_x ~dst_y
=
let width = max 0 width and height = max 0 height in
let src_x, dst_x, width =
if src_x < 0 then (0, dst_x - src_x, width + src_x)
else (src_x, dst_x, width)
in
let src_y, dst_y, height =
if src_y < 0 then (0, dst_y - src_y, height + src_y)
else (src_y, dst_y, height)
in
let src_x, dst_x, width =
if dst_x < 0 then (src_x - dst_x, 0, width + dst_x)
else (src_x, dst_x, width)
in
let src_y, dst_y, height =
if dst_y < 0 then (src_y - dst_y, 0, height + dst_y)
else (src_y, dst_y, height)
in
let width = min width (min (src.width - src_x) (dst.width - dst_x)) in
let height = min height (min (src.height - src_y) (dst.height - dst_y)) in
if width <= 0 || height <= 0 then ()
else
let target = Rect.{ x = dst_x; y = dst_y; width; height } in
let clipped =
match Scissor_stack.current dst.scissor_stack with
| None -> Some target
| Some scissor -> Rect.intersection target scissor
in
match clipped with
| None -> ()
| Some clipped ->
let dst_x = clipped.x and dst_y = clipped.y in
let width = clipped.width and height = clipped.height in
let src_x = src_x + (dst_x - target.x) in
let src_y = src_y + (dst_y - target.y) in
let same_grid = src == dst in
let y_start, y_limit, y_step =
if same_grid && src_y < dst_y then (height - 1, -1, -1)
else (0, height, 1)
in
if (not blend) && same_grid then
move_within src ~src_x ~src_y ~width ~height ~dst_x ~dst_y
~repair:default_bg_packed
else begin
let copy_cell =
if same_grid || src.grapheme_store == dst.grapheme_store then Fun.id
else
make_cell_copier ~src_store:src.grapheme_store
~dst_store:dst.grapheme_store
in
let x_start, x_limit, x_step =
if same_grid && src_x < dst_x then (width - 1, -1, -1)
else (0, width, 1)
in
let i = ref y_start in
while !i <> y_limit do
let sy = src_y + !i and dy = dst_y + !i in
let k = ref x_start in
while !k <> x_limit do
let sx = src_x + !k and dx = dst_x + !k in
let sidx = (sy * src.width) + sx in
let code = Buf.get_cell src.chars sidx in
let fg_color = Buf.get src.fg_color sidx in
let bg_color = Buf.get src.bg_color sidx in
let fg_color =
if blend then apply_opacity dst fg_color else fg_color
in
let bg_color =
if blend then apply_opacity dst bg_color else bg_color
in
if
(not blend)
|| Color_packed.alpha fg_color <> 0
|| Color_packed.alpha bg_color <> 0
then begin
let attrs = Buf.get_short src.attrs sidx in
let link = get_link src sidx in
let is_orphan =
Packed_cell.is_continuation code
&& (sx - Packed_cell.left_extent code < src_x
|| sx + Packed_cell.right_extent code >= src_x + width)
in
let is_right_truncated_start =
(not (Packed_cell.is_continuation code))
&&
let cw = Packed_cell.cell_width code in
cw > 1 && (sx + cw > src_x + width || dx + cw > dst_x + width)
in
let mapped_code =
if is_orphan || is_right_truncated_start then space_cell
else if
src.grapheme_store == dst.grapheme_store
|| Packed_cell.is_inline code
then code
else copy_cell code
in
let is_reset = mapped_code = space_cell && code <> space_cell in
let attrs = if is_reset then 0 else attrs in
let link = if is_reset then no_link else link in
let fg_color =
if is_reset then
if blend then apply_opacity dst default_fg_packed
else default_fg_packed
else fg_color
in
set_cell_internal dst
~idx:((dy * dst.width) + dx)
~code:mapped_code ~fg_color ~bg_color ~attrs ~link
~write:(if blend then Overlay else Copy)
end;
k := !k + x_step
done;
i := !i + y_step
done
end
let blit_region = transfer_region ~blend:false
let draw_region ~src ~dst ~src_x ~src_y ~width ~height ~dst_x ~dst_y =
if width > 0 && height > 0 && dst.opacity_product > 0. then begin
let src = if src == dst then copy src else src in
transfer_region ~blend:true ~src ~dst ~src_x ~src_y ~width ~height ~dst_x
~dst_y
end
let blank_cut_edges t (r : region) bg =
for y = r.y to r.y + r.height - 1 do
let first = (y * t.width) + r.x in
let last = first + r.width - 1 in
if extent_left (Buf.get_cell t.chars first) > 0 then
blank_grapheme t first bg;
if extent_right (Buf.get_cell t.chars last) > 0 then
blank_grapheme t last bg
done
let shift t (r : region) ~dx ~dy ~color =
match Rect.clip_to_bounds t.width t.height r with
| None -> ()
| Some _ when dx = 0 && dy = 0 -> ()
| Some r ->
let bg = Color_packed.encode color in
let blank (b : region) =
if b.width > 0 && b.height > 0 then
fill_opaque_rect t ~x0:b.x ~y0:b.y ~width:b.width ~height:b.height
~bg_color:bg
in
blank_cut_edges t r bg;
if abs dx >= r.width || abs dy >= r.height then blank r
else begin
let width = r.width - abs dx and height = r.height - abs dy in
let src_x = if dx < 0 then r.x - dx else r.x in
let src_y = if dy < 0 then r.y - dy else r.y in
let dst_x = src_x + dx and dst_y = src_y + dy in
move_within t ~src_x ~src_y ~width ~height ~dst_x ~dst_y ~repair:bg;
let rows_x = r.x and rows_w = r.width in
if dy > 0 then
blank { x = rows_x; y = r.y; width = rows_w; height = dy }
else if dy < 0 then
blank
{
x = rows_x;
y = r.y + r.height + dy;
width = rows_w;
height = -dy;
};
if dx > 0 then blank { x = r.x; y = dst_y; width = dx; height }
else if dx < 0 then
blank { x = r.x + r.width + dx; y = dst_y; width = -dx; height }
end
let draw_text ?style ?(tab_width = 2) ?width_method t ~x ~y ~text =
if tab_width < 1 then invalid_arg "Matrix_grid.draw_text: tab width below 1";
let width_method = Option.value width_method ~default:t.width_method in
if text = "" || y < 0 || y >= t.height then ()
else
let s = Option.value style ~default:Ansi.Style.default in
let fg_color =
Option.value s.fg ~default:default_fg
|> Color_packed.encode |> apply_opacity t
in
let bg_color =
Option.value s.bg ~default:default_bg
|> Color_packed.encode |> apply_opacity t
in
if Color_packed.alpha fg_color = 0 && Color_packed.alpha bg_color = 0 then
()
else
let attrs = Ansi.Attr.pack s.attrs in
let link = Option.value s.link ~default:no_link in
let cur_x = ref x in
let tabw = tab_width in
let text =
if String.contains text '\t' then (
let len = String.length text in
let b = Buffer.create (len + (tabw * 4)) in
for i = 0 to len - 1 do
let c = String.unsafe_get text i in
if Char.equal c '\t' then
for _ = 1 to tabw do
Buffer.add_char b ' '
done
else Buffer.add_char b c
done;
Buffer.contents b)
else text
in
let scissor = Scissor_stack.current t.scissor_stack in
let row_visible =
match scissor with
| None -> true
| Some r -> y >= r.y && y < r.y + r.height
in
if not row_visible then ()
else
let cell_visible =
match scissor with
| None -> fun _ -> true
| Some r ->
let x_min = r.x and x_max = r.x + r.width in
fun x -> x >= x_min && x < x_max
in
let writer ~offset ~len ~w =
let bounds_ok = !cur_x + w <= t.width && !cur_x >= 0 in
let start_visible = cell_visible !cur_x in
if bounds_ok && start_visible then begin
let code =
Packed_cell.intern_sub t.grapheme_store text ~pos:offset ~len
~width:w
in
let w = Packed_cell.cell_width code in
begin
let idx = (y * t.width) + !cur_x in
set_cell_internal t ~idx ~code ~fg_color ~bg_color ~attrs ~link
~write:Draw;
for i = 1 to w - 1 do
let c_x = !cur_x + i in
let c_idx = (y * t.width) + c_x in
let cont =
Packed_cell.make_continuation ~left:i ~right:(w - 1 - i)
in
set_cell_internal t ~idx:c_idx ~code:cont ~fg_color ~bg_color
~attrs ~link ~write:Draw
done
end;
cur_x := !cur_x + w
end
else begin
if (not bounds_ok) && !cur_x >= 0 && !cur_x < t.width then
for x_fill = !cur_x to t.width - 1 do
if cell_visible x_fill then
let idx = (y * t.width) + x_fill in
let bg_color =
match s.bg with
| None -> Buf.get t.bg_color idx
| Some _ -> bg_color
in
set_cell_internal t ~idx ~code:space_cell ~fg_color ~bg_color
~attrs ~link ~write:Copy
done;
cur_x := !cur_x + w
end
in
try
Text.iter_units ~width_method ~tab_width:tabw
(fun ~offset ~len ~width:w ->
let start_x = !cur_x in
let end_x = start_x + w in
if end_x <= 0 then cur_x := end_x
else if start_x >= t.width then raise Exit
else writer ~offset ~len ~w)
text
with Exit -> ()
let draw_spans ?(tab_width = 2) ?width_method ?width t ~x ~y spans =
if tab_width < 1 then invalid_arg "Matrix_grid.draw_spans: tab width below 1";
let width_method = Option.value width_method ~default:t.width_method in
let room = Option.value width ~default:(t.width - x) in
let spans =
List.map
(fun (s : Ansi.span) ->
if String.contains s.text '\n' then
{ s with text = String.map (function '\n' -> ' ' | c -> c) s.text }
else s)
(Ansi.sanitize_spans spans)
in
let measure text = Text.measure ~width_method ~tab_width text in
let draw x (s : Ansi.span) text =
draw_text ~style:s.style ~tab_width ~width_method t ~x ~y ~text
in
let total =
List.fold_left (fun a (s : Ansi.span) -> a + measure s.text) 0 spans
in
if total <= room then
List.fold_left
(fun x (s : Ansi.span) ->
draw x s s.text;
x + measure s.text)
x spans
else
let ellipsis = "\u{2026}" in
let fit = room - measure ellipsis in
let rec go used = function
| [] -> x + used
| (s : Ansi.span) :: rest ->
let w = measure s.text in
if used + w <= fit then (
draw (x + used) s s.text;
go (used + w) rest)
else
let start = used in
let used = ref used and stop = ref 0 in
(try
Text.iter_units ~width_method ~tab_width
(fun ~offset ~len ~width:w ->
if !used + w > fit then raise Exit;
used := !used + w;
stop := offset + len)
s.text
with Exit -> ());
draw (x + start) s (String.sub s.text 0 !stop);
draw (x + !used) s ellipsis;
x + !used + measure ellipsis
in
if fit < 0 then x else go 0 spans
let draw_box t ~x ~y ~width ~height ?(border = Border.single)
?(sides = Border.all) ?(style = Ansi.Style.default) ?fill ?title
?title_alignment ?title_style () =
let wide u = Packed_cell.cell_width (Packed_cell.of_uchar u) > 1 in
let b = border in
if
List.exists wide
[
b.top_left;
b.top_right;
b.bottom_left;
b.bottom_right;
b.horizontal;
b.vertical;
b.top_t;
b.bottom_t;
b.left_t;
b.right_t;
b.cross;
]
then invalid_arg "Matrix_grid.draw_box: a border character wider than a cell";
if width <= 0 || height <= 0 then ()
else
let target = Rect.{ x; y; width; height } in
let scissor_ok =
match Scissor_stack.current t.scissor_stack with
| None -> true
| Some scissor -> Option.is_some (Rect.intersection target scissor)
in
if not scissor_ok then ()
else begin
let border_chars = border in
let should_fill = Option.is_some fill in
let bg_color =
match fill with
| Some c -> c
| None -> (
match style.bg with Some c -> c | None -> Ansi.Color.transparent)
in
let bg_color_packed = apply_opacity t (Color_packed.encode bg_color) in
let open Border in
let has side = List.mem side sides in
let sx = max 0 x and sy = max 0 y in
let ex = min (t.width - 1) (x + width - 1) in
let ey = min (t.height - 1) (y + height - 1) in
if should_fill then begin
let has_l = has `Left and has_r = has `Right in
let has_t = has `Top and has_b = has `Bottom in
let ix = if has_l then x + 1 else x in
let iy = if has_t then y + 1 else y in
let iw = width - (if has_l then 1 else 0) - if has_r then 1 else 0 in
let ih = height - (if has_t then 1 else 0) - if has_b then 1 else 0 in
if iw > 0 && ih > 0 then
fill_rect t ~x:ix ~y:iy ~width:iw ~height:ih ~color:bg_color
end;
let b_fg_color =
Option.value style.Ansi.Style.fg ~default:default_fg
|> Color_packed.encode |> apply_opacity t
in
let b_attrs = Ansi.Attr.pack style.attrs in
let cell_top_left = Packed_cell.of_uchar border_chars.top_left in
let cell_top_right = Packed_cell.of_uchar border_chars.top_right in
let cell_bottom_left = Packed_cell.of_uchar border_chars.bottom_left in
let cell_bottom_right = Packed_cell.of_uchar border_chars.bottom_right in
let cell_horizontal = Packed_cell.of_uchar border_chars.horizontal in
let cell_vertical = Packed_cell.of_uchar border_chars.vertical in
let draw_b bx by cell =
if
bx >= 0 && by >= 0 && bx < t.width && by < t.height
&& not (is_clipped t bx by)
then
set_cell_internal t
~idx:((by * t.width) + bx)
~code:cell ~fg_color:b_fg_color ~bg_color:bg_color_packed
~attrs:b_attrs ~link:no_link ~write:Draw
in
if has `Top || has `Bottom then begin
let row y_pos top =
if y_pos >= 0 && y_pos < t.height then
for c = sx to ex do
if c >= x && c < x + width then
let ch =
if c = x then
if has `Left then
if top then cell_top_left else cell_bottom_left
else cell_horizontal
else if c = x + width - 1 then
if has `Right then
if top then cell_top_right else cell_bottom_right
else cell_horizontal
else cell_horizontal
in
draw_b c y_pos ch
done
in
if has `Top then row y true;
if has `Bottom then row (y + height - 1) false
end;
let left_only = has `Left && (not (has `Top)) && not (has `Bottom) in
let right_only = has `Right && (not (has `Top)) && not (has `Bottom) in
let bottom_with_verts =
has `Bottom && (not (has `Top)) && (has `Left || has `Right)
in
let top_with_verts =
has `Top && (not (has `Bottom)) && (has `Left || has `Right)
in
let extend_top = left_only || right_only || bottom_with_verts in
let extend_bottom = left_only || right_only || top_with_verts in
let vy_start = max sy (if extend_top then y else y + 1) in
let vy_end =
min ey (if extend_bottom then y + height - 1 else y + height - 2)
in
if vy_start <= vy_end then begin
if has `Left && x >= 0 && x < t.width then
for r = vy_start to vy_end do
draw_b x r cell_vertical
done;
if has `Right then
let rx = x + width - 1 in
if rx >= 0 && rx < t.width then
for r = vy_start to vy_end do
draw_b rx r cell_vertical
done
end;
match title with
| Some txt when has `Top && width >= 4 ->
let w = Text.measure ~width_method:t.width_method ~tab_width:2 txt in
if w <= width - 4 then
let pad =
match title_alignment with
| Some `Right -> width - 2 - w
| Some `Center -> (width - w) / 2
| _ -> 2
in
let title_s =
match title_style with
| Some s -> Ansi.Style.bg bg_color s
| None -> Ansi.Style.make ?fg:style.fg ~bg:bg_color ()
in
draw_text t ~x:(x + pad) ~y ~text:txt ~style:title_s
| _ -> ()
end
let draw_scalar t ~x ~y ~(style : Ansi.Style.t) u =
if x >= 0 && y >= 0 && x < t.width && y < t.height && not (is_clipped t x y)
then
let color c default =
Option.value c ~default |> Color_packed.encode |> apply_opacity t
in
set_cell_internal t
~idx:((y * t.width) + x)
~code:(Packed_cell.of_uchar u)
~fg_color:(color style.fg default_fg)
~bg_color:(color style.bg default_bg)
~attrs:(Ansi.Attr.pack style.attrs)
~link:(Option.value style.link ~default:no_link)
~write:Draw
let draw_glyph t ~x ~y ~style s =
let len = String.length s in
if len > 0 then
let d = String.get_utf_8_uchar s 0 in
let u = Uchar.utf_decode_uchar d in
if
Uchar.utf_decode_is_valid d
&& Uchar.utf_decode_length d = len
&& Text.uchar_width ~tab_width:1 u = 1
&& Text.grapheme_cluster_break u = `XX
then draw_scalar t ~x ~y ~style u
else draw_text ~style t ~x ~y ~text:s
let draw_lines ?(glyphs = Lines.Unicode) t lines =
let lx = Lines.x lines and ly = Lines.y lines and lw = Lines.width lines in
for y = max 0 ly to min (ly + Lines.height lines) t.height - 1 do
for x = max 0 lx to min (lx + lw) t.width - 1 do
let c = Lines.code lines (((y - ly) * lw) + x - lx) in
if c <> 0 then
let style = Lines.style lines c in
match glyphs with
| Lines.Unicode ->
draw_scalar t ~x ~y ~style (Lines.scalar ~rounded:false c)
| Rounded -> draw_scalar t ~x ~y ~style (Lines.scalar ~rounded:true c)
| Set set -> draw_glyph t ~x ~y ~style (Lines.glyph set c)
done
done
type line_symbols = {
h : string;
v : string;
diag_up : string;
diag_down : string;
}
let default_line_symbols = { h = "─"; v = "│"; diag_up = "╱"; diag_down = "╲" }
let ascii_line_symbols = { h = "-"; v = "|"; diag_up = "/"; diag_down = "\\" }
let braille_lut = Grid_data.braille_lut
let braille_base = 0x2800
let braille_max = 0x28FF
(** Decode an existing braille cell to its bit pattern, 0 for non-braille. *)
let decode_braille_bits t ~x ~y =
if x < 0 || y < 0 || x >= t.width || y >= t.height then 0
else
let idx = (y * t.width) + x in
let code = Buf.get_cell t.chars idx in
let cp =
if Packed_cell.is_inline code then Packed_cell.codepoint code
else if Packed_cell.is_start code then
let s = Packed_cell.to_string t.grapheme_store code in
if String.length s = 3 then
let b0 = Char.code (String.unsafe_get s 0) in
let b1 = Char.code (String.unsafe_get s 1) in
let b2 = Char.code (String.unsafe_get s 2) in
if b0 land 0xF0 = 0xE0 && b1 land 0xC0 = 0x80 && b2 land 0xC0 = 0x80
then
((b0 land 0x0F) lsl 12) lor ((b1 land 0x3F) lsl 6) lor (b2 land 0x3F)
else 0
else 0
else 0
in
if cp >= braille_base && cp <= braille_max then cp - braille_base else 0
let[@inline] braille_bit_pos bit_x bit_y =
match (bit_x, bit_y) with
| 0, 0 -> 0
| 0, 1 -> 1
| 0, 2 -> 2
| 0, 3 -> 6
| 1, 0 -> 3
| 1, 1 -> 4
| 1, 2 -> 5
| 1, 3 -> 7
| _ -> 0
let draw_line t ~x1 ~y1 ~x2 ~y2 ?(style = Ansi.Style.default)
?(symbols = default_line_symbols) ?(kind = `Line) () =
let dx = abs (x2 - x1) and dy = abs (y2 - y1) in
let sx = if x1 < x2 then 1 else -1 in
let sy = if y1 < y2 then 1 else -1 in
match kind with
| `Line ->
let diag_cell =
if (x2 - x1) * (y2 - y1) > 0 then symbols.diag_down else symbols.diag_up
in
let x = ref x1 and y = ref y1 and err = ref (dx - dy) in
while not (!x = x2 && !y = y2) do
let e2 = 2 * !err in
let move_x = e2 > -dy and move_y = e2 < dx in
let cell =
if move_x && move_y then diag_cell
else if move_x then symbols.h
else symbols.v
in
draw_text t ~x:!x ~y:!y ~text:cell ~style;
if move_x then (
x := !x + sx;
err := !err - dy);
if move_y then (
y := !y + sy;
err := !err + dx)
done;
let final_cell =
if dx = 0 && dy = 0 then symbols.h
else if dx = 0 then symbols.v
else if dy = 0 then symbols.h
else diag_cell
in
draw_text t ~x:!x ~y:!y ~text:final_cell ~style
| `Braille ->
let buffer = Hashtbl.create 32 in
let set_dot px py =
let cell_x = if px >= 0 then px / 2 else ((px + 1) / 2) - 1 in
let cell_y = if py >= 0 then py / 4 else ((py + 1) / 4) - 1 in
if cell_x >= 0 && cell_x < t.width && cell_y >= 0 && cell_y < t.height
then
let bit_x = ((px mod 2) + 2) mod 2 in
let bit_y = ((py mod 4) + 4) mod 4 in
let key = (cell_x, cell_y) in
let current = Option.value (Hashtbl.find_opt buffer key) ~default:0 in
Hashtbl.replace buffer key
(current lor (1 lsl braille_bit_pos bit_x bit_y))
in
let x = ref x1 and y = ref y1 and err = ref (dx - dy) in
while not (!x = x2 && !y = y2) do
set_dot !x !y;
let e2 = 2 * !err in
if e2 > -dy then (
x := !x + sx;
err := !err - dy);
if e2 < dx then (
y := !y + sy;
err := !err + dx)
done;
set_dot x2 y2;
Hashtbl.iter
(fun (cx, cy) bits ->
let existing = decode_braille_bits t ~x:cx ~y:cy in
draw_text t ~x:cx ~y:cy ~text:braille_lut.(existing lor bits) ~style)
buffer
type picture = Grapheme_store.picture
let picture_ids = Atomic.make 1
let picture ~width ~height rgba =
if width <= 0 || height <= 0 then
invalid_arg "Matrix_grid.picture: width and height must be > 0";
if String.length rgba <> 4 * width * height then
invalid_arg "Matrix_grid.picture: rgba is not 4 * width * height bytes";
{
Grapheme_store.id = Atomic.fetch_and_add picture_ids 1;
width;
height;
rgba;
}
let picture_size (p : picture) = (p.width, p.height)
let draw_picture t ~x ~y ~width ~height p =
match clip_rect_to_grid t Rect.{ x; y; width; height } with
| None -> ()
| Some r ->
for row = r.y to r.y + r.height - 1 do
for col = r.x to r.x + r.width - 1 do
let idx = (row * t.width) + col in
let code =
Packed_cell.intern_tile t.grapheme_store p ~cols:width ~rows:height
~col:(col - x) ~row:(row - y)
in
write_cell t idx code (Buf.get t.bg_color idx);
Buf.set_short t.attrs idx 0;
set_link t idx no_link;
Buf.set t.fg_color idx default_fg_packed
done
done
let space_code = Packed_cell.to_int space_cell
let null_code = Packed_cell.to_int null_cell
let[@inline] blank_cell t idx =
let code = Buf.get t.chars idx in
(code = space_code || code = null_code)
&& Buf.get_short t.attrs idx land attrs_mask = 0
&& (let bg = Buf.get t.bg_color idx in
bg = default_bg_packed || bg = terminal_bg_packed
|| Color_packed.alpha bg = 0
||
match Color_packed.intent bg with
| Default -> true
| Indexed _ | Rgb -> false)
&& (Array.length t.links = 0
|| String.length (Array.unsafe_get t.links idx) = 0)
let active_height t =
let rec find_row y =
if y < 0 then 0
else
let row_start = y * t.width in
let x = ref 0 in
while !x < t.width && blank_cell t (row_start + !x) do
incr x
done;
if !x < t.width then y + 1 else find_row (y - 1)
in
find_row (t.height - 1)
let grapheme_stats t =
( Grapheme_store.live_count t.grapheme_store,
Grapheme_store.slot_count t.grapheme_store )
let to_text ?(trim = true) t =
let width = t.width and height = t.height in
if width <= 0 || height <= 0 then ""
else begin
let line = Buffer.create width in
let buf = Buffer.create ((width + 1) * height) in
for y = 0 to height - 1 do
Buffer.clear line;
for x = 0 to width - 1 do
let idx = (y * width) + x in
if not (is_continuation t idx) then begin
let text = get_text t idx in
if String.length text = 0 then Buffer.add_char line ' '
else Buffer.add_string line text
end
done;
let row = Buffer.contents line in
let row =
if trim then begin
let last = ref (String.length row - 1) in
while !last >= 0 && row.[!last] = ' ' do
decr last
done;
if !last = String.length row - 1 then row
else String.sub row 0 (!last + 1)
end
else row
in
Buffer.add_string buf row;
if y < height - 1 then Buffer.add_char buf '\n'
done;
Buffer.contents buf
end
let shows_nothing t idx =
let code = Buf.get_cell t.chars idx in
(Packed_cell.is_empty code || code = space_cell)
&&
let bg = Buf.get t.bg_color idx in
(bg = default_bg_packed || bg = terminal_bg_packed)
&& Buf.get_short t.attrs idx = 0
&& String.length (get_link t idx) = 0
let to_ansi ?(styling = `Truecolor) ?(trim = false) ?(complete_rows = false)
?rows t =
let height = Option.value rows ~default:t.height in
if height < 0 || height > t.height then
invalid_arg "Matrix_grid.to_ansi: rows must be within grid height";
let width = t.width in
if width <= 0 || height <= 0 then ""
else
let store = t.grapheme_store in
let scratch = ref (Bytes.create 256) in
Ansi.to_string (fun w ->
let style = Ansi.Sgr_state.create () in
let styled =
match styling with
| `Plain -> false
| #Ansi.Color.depth as depth ->
Ansi.Sgr_state.set_color_depth style depth;
true
in
for y = 0 to height - 1 do
if y > 0 && not complete_rows then Ansi.emit (Ansi.char '\n') w;
if complete_rows then Ansi.emit (Ansi.erase_line ~mode:`All) w;
let last =
let last = ref width in
if trim then
while !last > 0 && shows_nothing t ((y * width) + !last - 1) do
decr last
done;
!last
in
let x = ref 0 in
while !x < last do
let idx = (y * width) + !x in
let code = Buf.get_cell t.chars idx in
let cw = Packed_cell.cell_width code in
let step = if cw <= 0 then 1 else cw in
if styled then
Ansi.Sgr_state.update style w ~fg:(get_fg t idx)
~bg:(get_bg t idx) ~attrs:(get_attrs t idx)
~link:(get_link t idx);
begin if
cw <= 0
|| Packed_cell.is_continuation code
|| Packed_cell.is_empty code
then Ansi.emit (Ansi.char ' ') w
else
let len = Packed_cell.length store code in
if len <= 0 then Ansi.emit (Ansi.char ' ') w
else begin
if len > Bytes.length !scratch then
scratch := Bytes.create (max (Bytes.length !scratch * 2) len);
let written = Packed_cell.blit store code !scratch ~pos:0 in
Ansi.emit (Ansi.bytes !scratch ~off:0 ~len:written) w
end
end;
x := !x + step
done;
if styled then (
Ansi.Sgr_state.close_link style w;
Ansi.emit Ansi.reset w;
Ansi.Sgr_state.reset style);
if complete_rows then Ansi.emit (Ansi.literal "\r\n") w
done)
type tile = Grapheme_store.tile = {
picture : picture;
cols : int;
rows : int;
col : int;
row : int;
}
let has_pictures t = Grapheme_store.live_tiles t.grapheme_store > 0
let picture_id (p : picture) = p.id
let picture_rgba (p : picture) = p.rgba
module Unsafe = struct
let[@inline] is_picture t idx =
let c = Buf.get_cell t.chars idx in
Packed_cell.names_slot c
&& (Packed_cell.tile t.grapheme_store c).picture.id <> 0
let tile t idx = Packed_cell.tile t.grapheme_store (Buf.get_cell t.chars idx)
let get_codepoint = get_codepoint
let get_attrs = get_attrs
let get_link = get_link
let get_fg = get_fg
let get_bg = get_bg
let cell_text_length = cell_text_length
let blit_cell_text = blit_cell_text
let cell_width = cell_width
let is_empty = is_empty
let cells_equal = cells_equal
end
let[@inline never] outside name =
invalid_arg ("Matrix_grid." ^ name ^ ": index outside the grid")
let[@inline] check name t idx =
if idx < 0 || idx >= t.width * t.height then outside name
let[@inline] get_codepoint t idx =
check "get_codepoint" t idx;
get_codepoint t idx
let picture_at t idx =
check "picture_at" t idx;
if Unsafe.is_picture t idx then Some (Unsafe.tile t idx) else None
let[@inline] get_attrs t idx =
check "get_attrs" t idx;
get_attrs t idx
let[@inline] get_link t idx =
check "get_link" t idx;
get_link t idx
let[@inline] get_fg t idx =
check "get_fg" t idx;
get_fg t idx
let[@inline] get_bg t idx =
check "get_bg" t idx;
get_bg t idx
let[@inline] get_text t idx =
check "get_text" t idx;
get_text t idx
let[@inline] cell_text_length t idx =
check "cell_text_length" t idx;
cell_text_length t idx
let[@inline] blit_cell_text t idx buf ~pos =
check "blit_cell_text" t idx;
blit_cell_text t idx buf ~pos
let[@inline] get_style t idx =
check "get_style" t idx;
get_style t idx
let[@inline] is_empty t idx =
check "is_empty" t idx;
is_empty t idx
let[@inline] is_continuation t idx =
check "is_continuation" t idx;
is_continuation t idx
let[@inline] cell_width t idx =
check "cell_width" t idx;
cell_width t idx
let[@inline] cells_equal t1 idx1 t2 idx2 =
check "cells_equal" t1 idx1;
check "cells_equal" t2 idx2;
cells_equal t1 idx1 t2 idx2
let[@inline] is_protected t idx =
check "is_protected" t idx;
is_protected t idx