package matrix
Build not yet checked sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>
Fast, modern terminal toolkit for OCaml
Install
dune-project
Dependency
Authors
Maintainers
Sources
mosaic-0.3.0.tbz
sha256=a92cbbcbe016fb19fb0a749222da0e459a9567aef3f4c7340d9bd6b71c53ed6f
sha512=6a7ab054605538bb31a2b73a1a6d093981a2704c9f0af5852221c05735290d74aca7c7282298c4d0f91e86a800e2ccd94b4918af883cd963449c758eb6b272b3
doc/src/matrix/matrix.ml.html
Source file matrix.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 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 2688module Ansi = Ansi module Grid = Matrix_grid module Input = Matrix_input module Screen = Matrix_screen module Terminal = Matrix_terminal module Terminfo = Matrix_terminfo module Text = Matrix_text module Tty = Tty (* Types *) type kitty_keyboard = [ `Auto | `Off ] type mode = [ `Alt | `Primary ] type event = | Key of Input.Keystroke.t | Key_release of Input.Keystroke.release | Text of string | Mouse of Input.Mouse_report.t | Paste_start | Paste_data of string | Paste_end of [ `Complete | `Cut ] | Focus_in | Focus_out | Resize of int * int | Color_scheme of [ `Dark | `Light ] | Palette of Ansi.Palette.t option | Invalid of string | Reply of Input.Reply.t let pp_event ppf = function | Key k -> Format.fprintf ppf "Key %a" Input.Keystroke.pp k | Key_release r -> Format.fprintf ppf "Key_release %a" Input.Keystroke.pp_release r | Text s -> Format.fprintf ppf "Text %S" s | Mouse m -> Format.fprintf ppf "Mouse %a" Input.Mouse_report.pp m | Paste_start -> Format.pp_print_string ppf "Paste_start" | Paste_data s -> Format.fprintf ppf "Paste_data %S" s | Paste_end `Complete -> Format.pp_print_string ppf "Paste_end Complete" | Paste_end `Cut -> Format.pp_print_string ppf "Paste_end Cut" | Focus_in -> Format.pp_print_string ppf "Focus_in" | Focus_out -> Format.pp_print_string ppf "Focus_out" | Resize (cols, rows) -> Format.fprintf ppf "Resize %dx%d" cols rows | Color_scheme `Dark -> Format.pp_print_string ppf "Color_scheme Dark" | Color_scheme `Light -> Format.pp_print_string ppf "Color_scheme Light" | Palette None -> Format.pp_print_string ppf "Palette None" | Palette (Some p) -> Format.fprintf ppf "Palette %a" Ansi.Palette.pp p | Invalid s -> Format.fprintf ppf "Invalid %S" s | Reply r -> Format.fprintf ppf "Reply %a" Input.Reply.pp r module Signal = Tty.Signal (* The device a run drives: a terminal's input and output, a clock, and a way to wait for them. A run decodes, negotiates and schedules; a device moves bytes and waits. [unix] is the device of a run on descriptors. *) module Device = struct type signal = Winch | Cont | Tstp | Terminate of int type in_process = { idle : until:int option -> stepped:bool -> bool; frame : unit -> unit; presented : (unit -> Grid.t * [ `Row of int | `Cursor of int ] * [ `Kitty | `Sixel | `Blocks ]) -> unit; } type t = { now : unit -> int; wait : until:int option -> reading:bool -> bool; wake : unit -> unit; fds : reading:bool -> Unix.file_descr list; take_signals : unit -> signal list; read_input : bytes -> int -> int -> int; write_output : bytes -> int -> int -> unit; terminal_size : unit -> (int * int) option; window_pixels : unit -> (int * int) option; set_raw_mode : bool -> unit; flush_input : unit -> unit; input_is_tty : bool; output_is_tty : bool; controlling : bool; on_fatal : string -> unit; cleanup : unit -> unit; env : Terminal.Caps.env; in_process : in_process option; } let handled = [| (Sys.sigwinch, Winch); (Sys.sigcont, Cont); (Sys.sigtstp, Tstp); (Sys.sigint, Terminate Sys.sigint); (Sys.sigterm, Terminate Sys.sigterm); (Sys.sighup, Terminate Sys.sighup); (Sys.sigquit, Terminate Sys.sigquit); |] (* The signals the handlers recorded for holder [h], in the order of [handled], from its [i]th on. Every turn asks, so none received allocates nothing. *) let rec received_from h i = if i = Array.length handled then [] else let s, signal = handled.(i) in if Signal.received h s then signal :: received_from h (i + 1) else received_from h (i + 1) let signals_from_handlers h () = received_from h 0 (* The environment of the process, with the description the terminfo database has for its [TERM]. *) let process_env () = let terminfo = match Sys.getenv_opt "TERM" with | Some term -> Result.to_option (Tty.terminfo term) | None -> None in Terminal.Caps.env ?terminfo Sys.getenv_opt ~win32:Sys.win32 (* A run on descriptors, which the holder waits for and reads. Windows has no descriptor to wait for a console with: [fds] raises there. *) let unix ?(input = Unix.stdin) ?(output = Unix.stdout) ?env () = let input_is_tty = Tty.is_tty input in let output_is_tty = Tty.is_tty output in let controlling = Tty.is_controlling input || Tty.is_controlling output in let env = match env with Some env -> env | None -> process_env () in let holder = Signal.hold ~controlling ~output:(if output_is_tty then Some output else None) in let console = Tty.enable_vt output in let fds = if Sys.win32 then fun ~reading:_ -> invalid_arg "Matrix.fds: no descriptor stands for a Windows console" else let wake_r = Signal.wake_fd holder in let both = [ input; wake_r ] and wake_only = [ wake_r ] in fun ~reading -> if reading then both else wake_only in let saved = ref None in let set_raw_mode raw = match (raw, !saved) with | true, None when input_is_tty -> Signal.keep_settings holder ~input; saved := Some (Tty.raw input) | false, Some settings -> saved := None; Tty.restore input settings; Signal.forget_settings holder | _ -> () in let some_input = Some input in let wait ~until ~reading = Signal.wait holder ~input:(if reading then some_input else None) ~until in { now = Tty.now; wait; wake = (fun () -> Signal.wake holder); fds; take_signals = signals_from_handlers holder; read_input = Signal.read holder input; write_output = Signal.write holder output; terminal_size = (fun () -> Tty.window output); window_pixels = (fun () -> Tty.window_pixels output); set_raw_mode; flush_input = (fun () -> if input_is_tty then Tty.flush_input input); input_is_tty; output_is_tty; controlling; on_fatal = Signal.set_reset holder; cleanup = (fun () -> Fun.protect (fun () -> set_raw_mode false) ~finally:(fun () -> Tty.restore_console output console; Signal.release holder)); env; in_process = None; } end (* Stop requests. A request wakes the runs the request was given to, by their serial, so that a run waiting for its descriptors steps and sees it; a run given one already requested sees it at its first step. *) module Stop = struct type t = { requested : bool Atomic.t; lock : Mutex.t; mutable wakes : (int * (unit -> unit)) list; } let create () = { requested = Atomic.make false; lock = Mutex.create (); wakes = [] } let request t = if not (Atomic.exchange t.requested true) then Mutex.protect t.lock (fun () -> List.iter (fun (_, wake) -> wake ()) t.wakes) let attach t serial wake = Mutex.protect t.lock (fun () -> t.wakes <- (serial, wake) :: t.wakes) let detach t serial = Mutex.protect t.lock (fun () -> t.wakes <- List.filter (fun (s, _) -> s <> serial) t.wakes) end (* The tools [MATRIX_DEBUG] names: a panel over each frame, which the run times, and a dump of each frame drawn into a directory. [app] sums the time the application spent handling steps since the last frame: from a step's return ([returned], [-1] once the next call has begun) to the next call of the loop or to [draw], and from the end of [draw] to the next call. *) type tools = { overlay : Debug_overlay.t option; frames : string option; mutable app : int; mutable returned : int; } let tools_of_string s = let tool tools = function | "" -> tools | "overlay" -> { tools with overlay = Some (Debug_overlay.create ()) } | "frames" -> { tools with frames = Some "frames" } | item when String.starts_with ~prefix:"frames=" item -> let dir = String.sub item 7 (String.length item - 7) in { tools with frames = Some dir } | item -> invalid_arg (Printf.sprintf "Matrix.run: MATRIX_DEBUG names no tool %S" item) in match List.fold_left tool { overlay = None; frames = None; app = 0; returned = -1 } (String.split_on_char ',' s) with | { overlay = None; frames = None; _ } -> None | tools -> Some tools (* Configuration *) type config = { mode : mode; raw_mode : bool; mouse : Terminal.mouse_mode; bracketed_paste : bool; kitty_keyboard : kitty_keyboard; key_releases : bool; fps : float; explicit_width : bool; min_tui_height : int option; (** [None] when the application states none. *) caps : Terminal.capabilities option; color : Ansi.Styling.choice option; (** [None] for [`Auto]. *) device : Device.t option; (* [MATRIX_DEBUG], which [run] reads for a run on descriptors. *) debug : string option; } let config ?(mode = `Alt) ?(raw_mode = true) ?(mouse = `Sgr_any) ?(bracketed_paste = true) ?(kitty_keyboard = `Auto) ?(key_releases = false) ?(fps = 60.) ?(explicit_width = false) ?min_tui_height ?caps ?color () = if (not (Float.is_finite fps)) || fps <= 0. then invalid_arg "Matrix.config: fps must be positive and finite"; { mode; raw_mode; mouse; bracketed_paste; kitty_keyboard; key_releases; fps; explicit_width; min_tui_height; caps; color; device = None; debug = None; } let on_device d config = { config with device = Some d } let default_config = config (* Queries sent together, which the terminal answers in order. A batch of capability queries, of the runtime's other queries, of the palette or of the application's ends with DA1; a cursor batch is one position report, its own answer, which says on which row of the screen the live region's origin is, in [`Primary] mode, from the cursor left [below] rows below it on a terminal [rows] high. *) type question = | Capabilities of Terminal.Caps.batch | Cursor of { below : int; rows : int } | Own (** Queries whose replies the runtime takes as they come. *) | Palette (** The palette's colors, gathered until DA1's reply. *) | Application (* The colors the palette's batch in flight has been told so far. *) type heard = { mutable foreground : (int * int * int) option; mutable background : (int * int * int) option; mutable cursor : (int * int * int) option; entries : (int * int * int) option array; } type batch = { question : question; owed : Input.Decoder.owed; sent : int; mutable reports : int; (** Cursor reports received. *) mutable answered : bool; } (* Deadlines, in a binary heap ordered by time, then by the order they were set, which a timer's number is. *) type entry = { deadline : int; id : int; mutable index : int } type heap = { mutable entries : entry array; mutable length : int; by_id : (int, entry) Hashtbl.t; mutable next_id : int; } type timer = int type 'msg step = | Event of event | Timer of timer | Posted of 'msg | Frame | Stopped (* The size the terminal reported and the runtime has yet to apply. *) type size_report = Applied | Read | Reported of int * int (* Static rows queued for the transcript: their lines, or a copy of rows with pictures, whose lines are written when they go out. *) type static = | Lines of { text : string; rows : int } | Pictures of { grid : Grid.t; rows : int } type 'msg app = { serial : int; terminal : Terminal.t; decoder : Input.Decoder.t; input_buffer : bytes; mutable input_ended : bool; (* When input last arrived, from which silence is measured. *) mutable last_input : int; (* The round trip of the startup probe, 0 until measured. *) mutable rtt : int; mutable evidence : Terminal.Caps.evidence; (* Batches still owed, oldest first. *) mutable batches : batch list; (* Cursor reports owed by batches given up, which a late report answers first. *) mutable lost_reports : int; (* Batches that end with DA1 and wait for the one in flight, oldest first. *) mutable waiting : (question * (string * Input.Decoder.owed)) list; (* Made at the first ask of the palette. *) mutable heard : heard option; (* Events decoded and not yet returned. *) events : event Queue.t; config : config; (* The mouse tracking the run keeps, [config]'s until [set_mouse]. *) mutable mouse : Terminal.mouse_mode; backend : Device.t; variable : string -> string option; (* [Caps.variable] of the backend's environment, made once: a frame decides the styling and allocates nothing for it. *) stop : Stop.t option; owner : int; screen : Screen.t; (* One retained writer owns the complete terminal frame. *) submit_buf : Ansi.Writer.t; mutable width : int; mutable height : int; (* [`Primary] mode: the region the live region is drawn as, the rows it was asked for, which it keeps ([live_height]), and the static rows queued for the next frame, latest first, with whether they replace the transcript. *) mutable region : Screen.Region.t; mutable live_rows : int; mutable static : static list; mutable replace : bool; (* The fewest rows the live region has, and the rows the static rows queued take from it ([lent]). *) min_live : int; mutable lent : int; (* With no height stated, the live region takes the rows down to the terminal's last row ([fill]); the next frame drawn afresh then asks where its origin is, and the answer gives it those rows and [extra] more ([ask]). *) mutable fill : bool; mutable ask : int option; (* The screen row of the region's origin, from 0, which mouse rows count from: as the latest cursor report says, moved down by the lines each write prints above the region since. [None] while unknown. *) mutable origin : int option; (* Whether the run leaves its last frame when it ends ([keep_frame]), and that frame, once it ends. *) mutable keep : bool; mutable final : Grid.t option; (* The region's rows, and the rows from its origin down to where the cursor rests, as the last write left them, which the reset bytes describe. *) mutable shown : int; mutable below : int; mutable scroll_hint : Screen.scroll_hint option; (* Cursor state tracking — visual caches are valid only while the cursor is visible. [None] means the terminal state is unknown (startup, hidden, or after the terminal was given to another program), so the next visible frame must emit. *) mutable last_cursor_position : (int * int) option; mutable last_cursor_visible : bool option; mutable last_cursor_shape : Ansi.cursor_shape option; mutable last_cursor_color : (int * int * int) option option; (* Time *) mutable now : int; heap : heap; (* Functions posted from any thread, newest first, and those taken by the current turn. *) mailbox : 'msg list Atomic.t; accepting : bool Atomic.t; posted : 'msg Queue.t; (* Posts made and not yet returned as steps, in the mailbox or in [posted]. Off the loop's thread a post waits on [room], with [room_lock], while [most_pending] are pending. *) pending : int Atomic.t; room_lock : Mutex.t; room : Condition.t; (* Whether a turn has begun since the run last had nothing to do, and whether each kind of work still owes the current turn the step every turn gives it. *) mutable begun : bool; (* The time of the latest step, against which the turn's budget and the frame interval are measured. *) mutable latest : int; (* Whether [next]'s wait has just ended, and whether the input was readable then: the turn after it need not look again. *) mutable waited : bool; mutable waited_ready : bool; mutable owe_event : bool; mutable owe_timer : bool; mutable owe_post : bool; (* Frames *) interval : int; mutable dirty : bool; (* A run on a device ([in_process]) draws at once a frame asked for outside a frame: by input, a timer, a post or the runtime itself. A frame asked for from a Frame step until the next step is an animation's, and waits its interval. *) in_process : bool; mutable asked_outside : bool; mutable in_frame_step : bool; (* Discrete input ([discrete_event]) is drawn in the turn that read it: a frame asked for while the step being done is such an event comes at the end of that turn. A turn draws one frame at most, and reads the input once, so input that arrives while a frame is drawn is read by the next turn and shown by its frame. [discrete] is whether the step being done is one, [asked_discrete] whether a frame was asked for in one since the last frame. An early frame leaves the grid, [last_frame], where it was. *) mutable discrete : bool; mutable asked_discrete : bool; (* Whether the latest frame is early, drawn before the grid's next frame: for discrete input, or by a device. *) mutable early : bool; on_frame : unit -> unit; tools : tools option; (* Whether [next] returned a step since it last waited. *) mutable stepped : bool; mutable drawing : bool; (* The frame being drawn was drawn across a release. *) mutable void : bool; (* The grid's point of the latest frame on the grid: the next frame on the grid is due an interval after it. *) mutable last_frame : int; (* The time between the latest frame and the one before, 0 until the second. *) mutable frame_dt : int; (* When the latest frame was drawn, which [last_frame] is not for a frame a device draws early. *) mutable drawn : int; mutable force_full_next_frame : bool; mutable size_report : size_report; (* The usable size last returned as [Resize]. *) mutable usable : int * int; (* The cell's size in pixels as the terminal answered CSI 16 t, the window's as the system reports it, and the cell size these and the text area's size give ([cell_size]). *) mutable cell_answer : (int * int) option; mutable window_pixels : (int * int) option; mutable cell_size : (int * int) option; (* A [Resize] was returned for the frame that follows it. *) mutable frame_follows : bool; mutable frame_modes_armed : bool; mutable restore_modes_on_next_focus : bool; mutable released : bool; (* The modes are set once the screen is taken: the kitty keyboard protocol's flags belong to the screen they are pushed on. *) mutable modes_taken : bool; (* Signals the run took, to restore when it ends. *) mutable taken : int list; (* Signals received and not yet acted on, oldest first. *) mutable kept : Device.signal list; mutable tstp_ignored : bool; (* Undos of the steps that took the terminal, latest first. *) mutable undo : (exiting:bool -> unit) list; } (* The last frame's time before the first frame: long enough ago that the first is due at once. *) let no_frame = min_int / 2 (* The runs, latest first, under [runs_lock]: runs may start on several domains. A run on the controlling terminal holds it; one started inside [release] holds it while the outer one waits. *) type held = Held : 'msg app -> held let runs : held list ref = ref [] let runs_lock = Mutex.create () let serials = Atomic.make 0 let thread_id () = Thread.id (Thread.self ()) let check t = if thread_id () <> t.owner then invalid_arg "Matrix: called off the thread that runs the application" (* Heap *) let heap_create () = { entries = [||]; length = 0; by_id = Hashtbl.create 8; next_id = 0 } let before a b = a.deadline < b.deadline || (a.deadline = b.deadline && a.id < b.id) let heap_set h i e = h.entries.(i) <- e; e.index <- i let rec sift_up h i = if i > 0 then let parent = (i - 1) / 2 in let e = h.entries.(i) and p = h.entries.(parent) in if before e p then ( heap_set h parent e; heap_set h i p; sift_up h parent) let rec sift_down h i = let l = (2 * i) + 1 in if l < h.length then let r = l + 1 in let child = if r < h.length && before h.entries.(r) h.entries.(l) then r else l in let e = h.entries.(i) and c = h.entries.(child) in if before c e then ( heap_set h i c; heap_set h child e; sift_down h child) let heap_add h deadline = let id = h.next_id in h.next_id <- id + 1; let e = { deadline; id; index = h.length } in if h.length = Array.length h.entries then ( let grown = Array.make (max 8 (2 * h.length)) e in Array.blit h.entries 0 grown 0 h.length; h.entries <- grown); heap_set h h.length e; h.length <- h.length + 1; Hashtbl.replace h.by_id id e; sift_up h e.index; id let heap_remove h e = Hashtbl.remove h.by_id e.id; let last = h.entries.(h.length - 1) in h.length <- h.length - 1; if e.index < h.length then ( heap_set h e.index last; sift_down h last.index; sift_up h last.index) (* The earliest deadline, [max_int] when there is none. *) let heap_min h = if h.length = 0 then max_int else h.entries.(0).deadline (* Small helpers *) let clamp lo hi v = max lo (min hi v) let ms n = n * 1_000_000 (* Layout *) (* The live region's rows: those asked for, as many as fit under its origin, and at least one, which a terminal of one row cannot show. *) let live_height t = max 1 (min t.live_rows (t.height - 1)) let force_full_redraw t = t.force_full_next_frame <- true (* The terminal's size as its device has it. An output with no window, a pipe, a file or a socket, keeps the size its terminal last reported in band (mode 2048). *) let device_size t = Option.value (t.backend.terminal_size ()) ~default:(t.width, t.height) (* Accessors *) let size t = check t; match t.config.mode with | `Alt -> (t.width, t.height) | `Primary -> (t.width, live_height t) let full_size t = check t; (t.width, t.height) let mode t = check t; t.config.mode let pixel_resolution t = check t; Terminal.pixel_resolution t.terminal let cell_size t = check t; t.cell_size (* The cell's size: the terminal's answer, else its text area's size, else its window's, divided by its columns and rows and floored, which drops any padding under a pixel a cell. A frame follows a change while pictures show, which are fit at the cell size. *) let update_cell_size t = let w, h = match (t.cell_answer, Terminal.pixel_resolution t.terminal) with | Some (w, h), _ when w > 0 && h > 0 -> (w, h) | _, Some (pw, ph) when pw >= t.width && ph >= t.height -> (pw / t.width, ph / t.height) | _ -> ( match t.window_pixels with | Some (pw, ph) when pw >= t.width && ph >= t.height -> (pw / t.width, ph / t.height) | _ -> (0, 0)) in (* A size that did not change allocates nothing. *) match t.cell_size with | Some (cw, ch) when cw = w && ch = h -> () | None when w = 0 || h = 0 -> () | _ -> t.cell_size <- (if w = 0 || h = 0 then None else Some (w, h)); if Grid.has_pictures (Screen.current_grid t.screen) then ( t.dirty <- true; t.asked_outside <- true) let terminal t = check t; t.terminal let capabilities t = check t; Terminal.capabilities t.terminal let now t = check t; t.now let frame_dt t = check t; Float.of_int t.frame_dt *. 1e-9 let early t = check t; t.early (* A reply needs a terminal on the input side, in raw mode. *) let can_query t = t.backend.input_is_tty && t.config.raw_mode && not t.input_ended (* A frame the runtime needs, as after a resize, is asked for outside a frame; the application's requests are an animation's from a Frame step until the next step. *) let owe_frame t = t.dirty <- true; t.asked_outside <- true let ask_frame t = if not t.in_frame_step then t.asked_outside <- true; if t.discrete then t.asked_discrete <- true; t.dirty <- true let request_redraw t = check t; ask_frame t let at t time = check t; heap_add t.heap time let cancel t timer = check t; match Hashtbl.find_opt t.heap.by_id timer with | Some e -> heap_remove t.heap e | None -> () (* Back-pressure on posts. A post off the loop's thread reserves its place in [pending], and waits while [most_pending] are pending, so that a producer faster than the loop holds a bounded backlog. The loop wakes the posts waiting once it has taken [pending] down to [resume_pending], half the bound, so that a producer refills it in one go rather than one post per wake. A post reads [pending] and waits with [room_lock] held, and the loop broadcasts with it held, so a post that read the bound before the loop took it down is in [Condition.wait] when the broadcast comes. Every post that waits read the bound, and [pending] passes [resume_pending] on its way back down, unless the run ends first, which broadcasts too. A post on the loop's thread never waits, since the loop would wait for itself. Nor does a post to a run on a device: there the test harness decides when the program steps, and it holds the program still while the test runs and while [quiesce] waits for work that may be posting, so a post that waited for steps could wait forever. *) let most_pending = 65_536 let resume_pending = most_pending / 2 let wait_for_room t = Mutex.lock t.room_lock; while Atomic.get t.accepting && Atomic.get t.pending >= most_pending do Condition.wait t.room t.room_lock done; Mutex.unlock t.room_lock let wake_posts t = Mutex.lock t.room_lock; Condition.broadcast t.room; Mutex.unlock t.room_lock let rec push t msg = let posts = Atomic.get t.mailbox in if not (Atomic.compare_and_set t.mailbox posts (msg :: posts)) then push t msg else if posts = [] then t.backend.wake () let rec post t msg = if Atomic.get t.accepting then let n = Atomic.get t.pending in if n >= most_pending && (not t.in_process) && thread_id () <> t.owner then ( wait_for_room t; post t msg) else if Atomic.compare_and_set t.pending n (n + 1) then push t msg else post t msg (* The terminal cuts what it receives into cells by the width method the runtime sets, and the screen lays out its cells by the same, so a cell is as wide on the screen as in the terminal. A change of method voids the cells the terminal shows, laid out by the old one. *) let width_method t = if t.config.explicit_width then `Wcwidth else (Terminal.capabilities t.terminal).unicode_width (* The runtime sets the terminal's grapheme mode only where the terminal answered it reset, and resets it when it gives the terminal back: a terminal is left with the mode as it was found. *) let set_width_method t m = let caps = Terminal.capabilities t.terminal in Terminal.enable_grapheme_mode t.terminal (m <> `Wcwidth && caps.grapheme_mode = Some false); if Grid.width_method (Screen.current_grid t.screen) <> m then ( Screen.set_width_method t.screen m; force_full_redraw t) (* The styling is decided from the environment the run's capabilities were read from, also when [config.caps] stands in for what it says of the terminal, so a test's terminal never reads the process's NO_COLOR. *) let decide_styling t = let caps = Terminal.capabilities t.terminal in Ansi.Styling.decide ?color:t.config.color t.variable ~tty:t.backend.output_is_tty ~dumb:caps.dumb caps.colors let styling t = check t; decide_styling t let refresh_capabilities t = let caps = Terminal.capabilities t.terminal in let styling = decide_styling t in Screen.apply_capabilities t.screen ~explicit_width:caps.explicit_width ~explicit_cursor_positioning:caps.explicit_cursor_positioning ~hyperlinks:caps.hyperlinks ~colors:(caps.colors :> Ansi.Color.depth) ~styling ~graphics:caps.graphics ~cell_size:t.cell_size; set_width_method t (width_method t) (* A batch's queries are sent, and what they are owed is added to the decoder's counts until the batch is answered or given up. *) let send_batch t question (bytes, owed) = Terminal.send t.terminal bytes; Input.Decoder.expect t.decoder owed; let b = { question; owed; sent = t.now; reports = 0; answered = false } in t.batches <- t.batches @ [ b ]; b let ends_with_da1 = function | Capabilities Widths | Cursor _ -> false | Capabilities _ | Own | Palette | Application -> true (* A batch that ends with DA1 is sent once no other is in flight. Every DA1 reply is alike, so a reply is told to answer a batch by the order of the batches alone, and a batch whose DA1 never comes, such as a passthrough check that tmux drops, would otherwise take the next batch's. *) let ask_batch t question bytes_owed = if List.exists (fun b -> ends_with_da1 b.question) t.batches then ( if (* The runtime's own query, or the palette's, already waiting, would be answered the same. *) not ((question = Own || question = Palette) && List.mem (question, bytes_owed) t.waiting) then t.waiting <- t.waiting @ [ (question, bytes_owed) ]) else ignore (send_batch t question bytes_owed : batch) let da1 = Ansi.(to_string (query Device_attributes)) (* A query whose reply the runtime takes as it comes, such as the pixel size, is a batch closed by DA1 too, so that its reply is never taken for the application's. *) let ask_own t q = if can_query t then ask_batch t Own ( Ansi.(to_string (query q)) ^ da1, { Input.Decoder.cursor_reports = 0; string_replies = 0 } ) (* The text area's size and the cell's, which change with the window and the font. *) let cell_pixels_da1 = "\027[16t" ^ da1 let ask_pixels t = if can_query t then ask_batch t Own ( Ansi.(to_string (query Pixel_size)) ^ cell_pixels_da1, { Input.Decoder.cursor_reports = 0; string_replies = 0 } ) (* Input modes follow the configuration and the capabilities, and are set again whenever the capabilities change: setting a mode a terminal has is idempotent, so this is the difference between what the modes were and what they must be. Focus, color scheme and resize reports are set without asking: no reference says what a terminal does with a private mode it does not know, but xterm (charproc.c, dpmodes: "unknown private code"), kitty (screen.c, set_mode_from_const: "Unsupported screen mode"), foot (csi.c, decset_decrst: UNHANDLED) and tmux (input.c, input_csi_dispatch_sm_private: "unknown") log it and do nothing else. The kitty keyboard flags are pushed once the terminal has answered its query, then asked for again, so that the capabilities say which flags hold. *) let kitty_flags t = if t.config.key_releases then 0b11111 else 0b00101 let apply_modes t = let terminal = t.terminal in let caps = Terminal.capabilities terminal in Terminal.set_mouse_mode terminal t.mouse; Terminal.enable_bracketed_paste terminal t.config.bracketed_paste; Terminal.enable_focus_reporting terminal true; Terminal.enable_color_scheme_reports terminal true; Terminal.enable_resize_reports terminal true; Terminal.enable_meta_sends_escape terminal (caps.meta_sends_escape = Some false); let kitty = t.config.kitty_keyboard = `Auto && Option.is_some caps.kitty_keyboard in if kitty && not (Terminal.kitty_keyboard_enabled terminal) then ( Terminal.enable_kitty_keyboard ~flags:(kitty_flags t) terminal true; ask_own t Csi_u_support) else if not kitty then Terminal.enable_kitty_keyboard terminal false; Terminal.enable_modify_other_keys terminal (not kitty); set_width_method t (width_method t) let update_capabilities t = let caps = Terminal.Caps.derive t.evidence in if caps <> Terminal.capabilities t.terminal then ( Terminal.set_capabilities t.terminal caps; if not t.released then ( if t.modes_taken then apply_modes t; refresh_capabilities t; force_full_redraw t; owe_frame t)) (* Input The decoder holds no clock: the runtime says when the terminal has been silent. Silence is measured from the last bytes read, and only a wait that read nothing ends it; how long a wait must be scales with the round trip of the startup probe, the time a terminal takes to write what it began. An ESC that may begin a sequence waits max(50 ms, 2 RTT), the 50 ms that libtermkey and neovim wait; a sequence begun, which a terminal writes whole, waits max(500 ms, 4 RTT). A batch of queries is owed until it is answered, by its DA1 or, for a cursor batch, its report, and while it is owed the decoder reads its replies as replies: a reply is never typed for arriving late. The runtime waits for an answer only max(500 ms, 4 RTT), then goes on without it, and the batch stays owed. A terminal that never answers would then keep [ESC P], [ESC \]] and [ESC _] from being Alt keys, and a modified F3 from being F3, for the whole session, so a batch is given up after max(5 s, 4 RTT). No reference bounds it: it must exceed any real answer's delay, since a reply after it decodes as input, and it costs only those keys while it lasts. 5 s is ten times the wait for an answer, and 4 RTT keeps it above a slow link's round trip as the sequence wait does. The cursor reports a given-up batch was owed are counted: a report that comes later answers them first, so that it never answers a later batch, such as the one that anchors the live region. *) let silence t = match Input.Decoder.pending t.decoder with | Nothing -> None | Ambiguous -> Some (max (ms 50) (2 * t.rtt)) | Sequence -> Some (max (ms 500) (4 * t.rtt)) let answer_wait t = max (ms 500) (4 * t.rtt) let owed_bound t = max (ms 5000) (4 * t.rtt) let push t event = Queue.push event t.events (* A batch leaves the decoder's counts once, answered or given up. *) let close t b = if List.memq b t.batches then ( Input.Decoder.settle t.decoder b.owed; t.batches <- List.filter (fun b' -> b' != b) t.batches; match t.waiting with | (question, bytes_owed) :: rest when ends_with_da1 b.question -> t.waiting <- rest; ignore (send_batch t question bytes_owed : batch) | _ -> ()) (* What the terminal answered of the palette's batch, once its DA1 reply says it has answered all it will: a palette if it reported the pair. The colors heard are forgotten for the next batch, which the terminal answers after this one. *) let take_palette t = match t.heard with | None -> None | Some h -> let palette = match (h.foreground, h.background) with | Some foreground, Some background -> Some { Ansi.Palette.foreground; background; cursor = h.cursor; entries = Array.copy h.entries; } | _ -> None in h.foreground <- None; h.background <- None; h.cursor <- None; Array.fill h.entries 0 (Array.length h.entries) None; palette (* Every ask of the palette is answered: one given up, with nothing. *) let give_up t b = t.lost_reports <- t.lost_reports + b.owed.Input.Decoder.cursor_reports - b.reports; close t b; if b.question = Palette then ( ignore (take_palette t : Ansi.Palette.t option); push t (Palette None)) let ask t batch = ask_batch t (Capabilities batch) (Terminal.Caps.ask t.evidence batch) let cursor_query = Ansi.(to_string (query Cursor_position)) let ask_cursor t below = ignore (send_batch t (Cursor { below; rows = t.height }) (cursor_query, { Input.Decoder.cursor_reports = 1; string_replies = 0 }) : batch) (* A cursor report answers the oldest query still owed one, a given-up one first. *) let cursor_report t ~row ~col ~page = if t.lost_reports > 0 then t.lost_reports <- t.lost_reports - 1 else match List.find_opt (fun b -> b.reports < b.owed.Input.Decoder.cursor_reports) t.batches with | None -> () | Some b -> ( let index = b.reports in b.reports <- index + 1; match b.question with | Capabilities q -> t.evidence <- Terminal.Caps.cursor t.evidence q ~index ~row ~col; if b.reports = b.owed.cursor_reports && not (ends_with_da1 b.question) then ( b.answered <- true; close t b) | Cursor { below; rows } -> ( b.answered <- true; close t b; (* The reports come in the order of the writes they follow, so the latest says where the origin is. *) let origin = row - below in t.origin <- Some origin; (* The live region takes the rows down to the last row, from a report on a terminal of the height it has: one asked before a resize says nothing of the rows after it. *) match t.ask with | Some extra when rows = t.height -> t.ask <- None; t.live_rows <- max t.min_live (min (t.height - 1) (t.height - 1 - origin + extra)); owe_frame t | _ -> ()) | Application -> push t (Reply (Cursor { row; col; page })) | Own | Palette -> ()) (* The batch that ends with DA1 in flight, which the replies that are not cursor reports answer. *) let replying t = List.find_opt (fun b -> ends_with_da1 b.question) t.batches (* A DA1 reply answers the batch in flight that asked for one. The terminal answers in order, so every query sent before it has been answered or never will be. *) let attributes_report t attributes = match replying t with | None -> () | Some b -> ( let rec before = function | b' :: rest when b' != b -> b' :: before rest | _ -> [] in List.iter (close t) (before t.batches); t.lost_reports <- 0; b.answered <- true; close t b; match b.question with | Capabilities q -> if q = Probe then t.rtt <- max 0 (t.now - b.sent); t.evidence <- Terminal.Caps.answered t.evidence q ~attributes; Option.iter (ask t) (Terminal.Caps.next t.evidence q) | Palette -> push t (Palette (take_palette t)) | Application -> push t (Reply (Primary_attributes attributes)) | Own | Cursor _ -> ()) (* A reply is the runtime's to act on, and the application's too while its batch is the one being answered. The reports a terminal sends on its own that are application facts are events. *) let reply t (r : Input.Reply.t) = (match r with | Cursor { row; col; page } -> cursor_report t ~row ~col ~page | Primary_attributes attributes -> attributes_report t attributes | Color_scheme scheme -> push t (Color_scheme scheme) | Resize { rows; cols; height; width } -> Terminal.set_pixel_resolution t.terminal (Some (width, height)); update_cell_size t; if (cols, rows) <> (t.width, t.height) then ( t.size_report <- Reported (cols, rows); owe_frame t) | r -> ( (match r with | Text_area_pixels { height; width } -> Terminal.set_pixel_resolution t.terminal (Some (width, height)); update_cell_size t | Cell_pixels { height; width } -> t.cell_answer <- Some (width, height); update_cell_size t | r -> t.evidence <- Terminal.Caps.add t.evidence r); match (replying t, r) with | Some { question = Application; _ }, r -> push t (Reply r) | Some { question = Palette; _ }, Color { target; rgb; _ } -> ( match t.heard with | None -> () | Some h -> ( match target with | `Foreground -> h.foreground <- Some rgb | `Background -> h.background <- Some rgb | `Cursor -> h.cursor <- Some rgb | `Entry i when i >= 0 && i < 16 -> h.entries.(i) <- Some rgb | `Entry _ -> ())) | _ -> ())); update_capabilities t let decoded t : Input.Decoder.event -> unit = function | Reply r -> reply t r | Key k -> push t (Key k) | Key_release r -> push t (Key_release r) | Text s -> push t (Text s) | Mouse m -> push t (Mouse m) | Focus_in -> push t Focus_in | Focus_out -> push t Focus_out | Paste_start -> push t Paste_start | Paste_data s -> push t (Paste_data s) | Paste_end ending -> push t (Paste_end ending) | Invalid s -> push t (Invalid s) (* What was cut or over the budget is in error, and dropped. *) | Cut _ | Too_long _ -> () let rec expire_batches t = function | [] -> () | b :: rest -> if t.now >= b.sent + owed_bound t then give_up t b; expire_batches t rest let expire t = expire_batches t t.batches (* The time the input next needs attention, [max_int] when it needs none: a silence that resolves what the decoder holds, or a batch given up. *) let input_deadline t = let silence = match silence t with Some wait -> t.last_input + wait | None -> max_int in match t.batches with | [] -> silence | b :: _ -> min silence (b.sent + owed_bound t) (* Waits in the backend, which says whether the input is readable. A wait until a time already past ([past]) looks without waiting. *) let wait_only t ~until = t.backend.wait ~until ~reading:(not t.input_ended) let past = Some min_int (* Reads what the input has, once, if [ready]; a wait that read nothing is silence, which decides what the decoder holds once it has lasted. *) let read_input t ~ready = let n = if ready && not t.input_ended then t.backend.read_input t.input_buffer 0 (Bytes.length t.input_buffer) else -1 in (if n = 0 then ( t.input_ended <- true; Input.Decoder.finish t.decoder (decoded t)) else if n > 0 then ( t.last_input <- t.now; Input.Decoder.feed t.decoder t.input_buffer ~off:0 ~len:n (decoded t); (* An emulated terminal has written all it sent once nothing follows. *) if t.in_process && not (wait_only t ~until:past) then Input.Decoder.idle t.decoder (decoded t)) else match silence t with | Some wait when t.now >= t.last_input + wait -> Input.Decoder.idle t.decoder (decoded t) | _ -> ()); expire t (* The run's own waits, as it takes and gives back the terminal, are on its clock. *) let wait t ~until = let ready = wait_only t ~until in t.now <- t.backend.now (); ready (* Reads input until every batch in [batches] is answered, the wait for an answer since [from] is over, or the input ends. The wait grows if the round trip is measured meanwhile. Events decoded meanwhile are kept. *) let await t ~from batches = let pending () = List.exists (fun b -> not b.answered) batches in while pending () && (not t.input_ended) && t.now < from + answer_wait t do let until = min (from + answer_wait t) (input_deadline t) in let ready = wait t ~until:(Some until) in read_input t ~ready done let abort_paste t = check t; Input.Decoder.cut_paste t.decoder (decoded t) let query t ~owed bytes = check t; if can_query t then ask_batch t Application (bytes ^ da1, owed) (* The pair, the cursor and entries 0 to 15. What a program derives from a palette, a theme's roles and their legible entries, reads no entry past 15, so the batch asks for 19 colors of the 259. *) let palette_query = Ansi.( to_string (seq (query Foreground_color :: query Background_color :: query Cursor_color :: List.init 16 (fun i -> query (Palette_entry i))))) ^ da1 let palette_owed = { Input.Decoder.cursor_reports = 0; string_replies = 19 } let query_palette t = check t; if can_query t then ( if t.heard = None then t.heard <- Some { foreground = None; background = None; cursor = None; entries = Array.make 16 None; }; ask_batch t Palette (palette_query, palette_owed)) else push t (Palette None) let refresh_render_region t = match t.config.mode with | `Alt -> Screen.set_row_offset t.screen 0; Screen.resize t.screen ~width:t.width ~height:t.height | `Primary -> Screen.resize t.screen ~width:t.width ~height:(live_height t) (* Static output (primary mode only) *) let sgr_reset = Ansi.(to_string reset) let sync_output_on = Ansi.(to_string (enable Sync_output)) let sync_output_off = Ansi.(to_string (disable Sync_output)) let cursor_hide_seq = Ansi.(to_string (disable Cursor_visible)) let cursor_show_seq = Ansi.(to_string (enable Cursor_visible)) let clear_scrollback_seq = Ansi.(to_string (erase_display ~mode:`Scrollback)) let reset_scroll_region_seq = Ansi.(to_string reset_scrolling_region) (* What ends a frame write a signal cut anywhere, as [Screen.Region.teardown] begins. CAN ends a control string left open in any state of a DEC-compatible parser; ST ends it on a terminal that lets CAN through. A hyperlink left open is closed, which SGR 0 does not do: the OSC 8 specification makes a link an attribute of its own and allows closing one that is not open. *) let end_cut_seq = "\024\027\\" ^ Ansi.(to_string hyperlink_end) (* Helpers for buffered frame output. All frame content is accumulated into an ANSI writer and flushed as a single write in [draw]. *) let buf_cursor_position buf ~row ~col = Ansi.cursor_position ~row:(max 1 row) ~col:(max 1 col) buf (* Inside tmux, the kitty graphics commands among [s] are wrapped for its passthrough, as kitty's icat wraps them; the placeholders are text, which tmux draws. *) let wrap_graphics t s = if (Terminal.capabilities t.terminal).multiplexer <> Some `Tmux then s else let b = Buffer.create (String.length s + 64) in let rec go i = match String.index_from_opt s i '\027' with | Some j when j + 2 < String.length s && s.[j + 1] = '_' && s.[j + 2] = 'G' -> Buffer.add_substring b s i (j - i); let rec stop k = match String.index_from_opt s k '\027' with | Some k when k + 1 < String.length s && s.[k + 1] = '\\' -> k + 2 | Some k -> stop (k + 1) | None -> String.length s in let e = stop (j + 1) in Buffer.add_string b Ansi.( to_string (tmux_passthrough (literal (String.sub s j (e - j))))); go e | Some j -> Buffer.add_substring b s i (j + 1 - i); go (j + 1) | None -> Buffer.add_substring b s i (String.length s - i) in go 0; Buffer.contents b (* The rows the live region has once the static rows queued have taken theirs. *) let lend t = if t.lent > 0 then ( t.live_rows <- max t.min_live (t.live_rows - t.lent); t.lent <- 0) let effective_size t = check t; match t.config.mode with | `Alt -> (t.width, t.height) | `Primary -> ( t.width, max 1 (min (max t.min_live (t.live_rows - t.lent)) (t.height - 1)) ) let static_rows = function Lines { rows; _ } | Pictures { rows; _ } -> rows (* Static rows are lines that go above the live region with the next frame, wrapped by the terminal as any output. Rows with pictures are copied and written when they go out, by the screen, which writes their pictures in the form it writes them then; others are written now. *) let static_snapshot t ?rows grid = if Grid.width grid > t.width then invalid_arg "Matrix.static_write: grid is wider than the terminal"; let rows = Option.value rows ~default:(Grid.height grid) in if rows < 0 || rows > Grid.height grid then invalid_arg "Matrix.static_write: rows must be within the grid's height"; if rows = 0 then None else if Grid.has_pictures grid then Some (Pictures { grid = Grid.copy grid; rows }) else Some (Lines { text = Screen.static_rows t.screen grid ~rows; rows }) (* The live region keeps its rows whatever [preserve_live_region] says: the static rows go above it, and the rows above them scroll into the scrollback once it is at the bottom of the screen. *) let static_write ?(preserve_live_region = false) ?rows t grid = check t; if t.config.mode <> `Alt then match static_snapshot t ?rows grid with | None -> () | Some static -> t.static <- static :: t.static; if not preserve_live_region then t.lent <- t.lent + static_rows static; ask_frame t (* A replaced transcript leaves the live region the screen, where it takes the rows down to the last, before the rows that replace it take theirs. *) let static_replace ?(preserve_live_region = false) ?rows t grid = check t; if t.config.mode <> `Alt then ( let static = static_snapshot t ?rows grid in t.static <- Option.to_list static; t.replace <- true; if t.fill then t.live_rows <- t.height - 1; t.lent <- (match static with | Some s when not preserve_live_region -> static_rows s | _ -> 0); ask_frame t) (* Immediate, outside the frames: the screen is erased now, and the next frame draws the live region afresh from its first row. *) let static_clear t = check t; if t.config.mode = `Primary then ( Terminal.send t.terminal (Screen.Region.clear t.region); t.static <- []; t.replace <- false; t.lent <- 0; t.origin <- Some 0; if t.fill then t.live_rows <- t.height - 1; force_full_redraw t; let cols, rows = device_size t in t.width <- max 1 cols; t.height <- max 1 rows; refresh_render_region t; ask_frame t) let set_scroll_hint t hint = check t; t.scroll_hint <- Some hint (* Frames *) (* No eager buffer clear here: Screen defers the post-present clear of the next grid and hit grid to their first observation ([Screen.next_grid], [Screen.build], ...), so both direct-draw apps given the grid and renderer hosts building through [Screen.build] pay for exactly one clear per frame instead of clearing here and again downstream. *) let prepare ?primary_required_rows t = refresh_capabilities t; if t.config.mode = `Primary then ( lend t; (* A height stated is the application's: the live region no longer takes the rows down to the last. *) Option.iter (fun rows -> t.fill <- false; t.ask <- None; t.live_rows <- max t.live_rows rows) primary_required_rows); refresh_render_region t let current_grid t = check t; Screen.current_grid t.screen let hits t = check t; Screen.next_hit_grid t.screen let screen t = check t; t.screen (* Apply cursor position, style, and color into the frame buffer. Style and color are only emitted when they differ from the last frame. *) let cursor_shape (cursor : Screen.cursor) : Ansi.cursor_shape = Ansi.cursor_shape_of_style ~style:cursor.style ~blinking:cursor.blinking (* In [`Alt] mode a visible cursor with no position waits on the bottom row. *) let cursor_output_position t ~(cursor : Screen.cursor) = match cursor.position with | Some (x, y) -> Some (clamp 0 (t.height - 1) y + 1, max 1 (x + 1)) | None -> if cursor.visible then Some (t.height, 1) else None (* In [`Primary] mode the region places the cursor: shown on the cell asked for, clamped to the [shown] rows, or with none at the start of the last row; hidden, it rests on the region's origin. *) let region_cursor (cursor : Screen.cursor) ~shown : Screen.Region.cursor = if not cursor.visible then Hidden else let x, y = match cursor.position with | Some (x, y) -> (max 0 x, clamp 0 (shown - 1) y) | None -> (0, shown - 1) in At { x; y = max 0 y } (* Allocation-free "changed since last frame" checks: comparing through the stored options directly avoids wrapping the current value in [Some]. *) let[@inline] visible_dirty t visible = match t.last_cursor_visible with Some v -> v <> visible | None -> true let[@inline] shape_dirty t shape = match t.last_cursor_shape with Some s -> s <> shape | None -> true let[@inline] color_dirty t color = match t.last_cursor_color with Some c -> c <> color | None -> true let cursor_dirty t ~(cursor : Screen.cursor) ~position = position <> t.last_cursor_position || visible_dirty t cursor.visible || cursor.visible && (shape_dirty t (cursor_shape cursor) || color_dirty t cursor.color) (* The cursor's shape and color, which move nothing, and the state the next frame compares with. *) let apply_cursor_appearance t ~buf ~(cursor : Screen.cursor) ~position = if cursor.visible then begin let shape = cursor_shape cursor in if shape_dirty t shape then begin Terminal.write_cursor_style t.terminal ~shape buf; t.last_cursor_shape <- Some shape end; if color_dirty t cursor.color then begin Terminal.write_cursor_color t.terminal cursor.color buf; t.last_cursor_color <- Some cursor.color end end else begin t.last_cursor_shape <- None; t.last_cursor_color <- None end; t.last_cursor_position <- position; t.last_cursor_visible <- Some cursor.visible let apply_cursor_state t ~buf ~(cursor : Screen.cursor) ~position = (match position with | Some (row, col) -> buf_cursor_position buf ~row ~col; if cursor.visible then Ansi.Writer.write_string buf cursor_show_seq | None -> ()); apply_cursor_appearance t ~buf ~cursor ~position (* The pixels of the pictures the frame shows go before the synchronized update: they show nothing yet, and a large image would hold the update past the terminal's timeout. *) let write_pictures t buf = Screen.send_pictures t.screen buf; if Ansi.Writer.len buf > 0 && (Terminal.capabilities t.terminal).multiplexer = Some `Tmux then ( let sent = wrap_graphics t (Ansi.Writer.contents buf) in Ansi.Writer.reset_pos buf; Ansi.Writer.write_string buf sent) (* All frame output is accumulated into a single buffer and flushed as one write. Skips the write entirely when nothing changed. *) let submit_alt t = let cursor = Screen.cursor t.screen in let caps = Terminal.capabilities t.terminal in let use_sync = Terminal.tty t.terminal && caps.sync in let buf = t.submit_buf in Ansi.Writer.reset_pos buf; write_pictures t buf; let pictures = Ansi.Writer.len buf in (* Preamble: BSU + cursor hide. *) if use_sync then Ansi.Writer.write_string buf sync_output_on; Ansi.Writer.write_string buf cursor_hide_seq; let preamble_len = Ansi.Writer.len buf in (* No cursor homing here: the diff renderer emits an absolute cursor_position for every run it touches, so anything written between the preamble capture and the skip check would defeat the unchanged-frame write skip. *) let forced_full = let ff = t.force_full_next_frame in if ff then t.force_full_next_frame <- false; ff in let scroll_hint = t.scroll_hint in t.scroll_hint <- None; Screen.render_into ~full:forced_full ?scroll_hint t.screen buf; (* Skip the write when nothing beyond the preamble was produced and cursor state is unchanged. *) let position = cursor_output_position t ~cursor in if Ansi.Writer.len buf > preamble_len || pictures > 0 || cursor_dirty t ~cursor ~position then begin Ansi.cursor_position ~row:t.height ~col:1 buf; apply_cursor_state t ~buf ~cursor ~position; if use_sync then Ansi.Writer.write_string buf sync_output_off; t.frame_modes_armed <- true; t.backend.write_output (Ansi.Writer.buffer buf) 0 (Ansi.Writer.len buf) end (* The static rows queued, oldest first, taken for the next write. *) let take_static t = match t.static with | [] -> [] | static -> t.static <- []; List.rev static let static_text t = function | Lines { text; _ } -> text | Pictures { grid; rows } -> wrap_graphics t (Screen.static_rows t.screen grid ~rows) (* The sixels over the static rows with pictures, once they are on the terminal, from the region's origin, which the write has left the cursor on. A row [k] rows above the origin is on the screen if the origin is at least [k] rows down: the lines the write printed moved it at least as far, unless the region's [shown] rows took it back up from the screen's last row. *) let write_static_sixels t buf static ~shown = let lines = List.fold_left (fun n s -> n + static_rows s) 0 static in let reach = max 0 (min lines (t.height - 1 - shown)) in ignore (List.fold_left (fun after s -> (match s with | Pictures { grid; rows } -> Ansi.Writer.write_string buf (Screen.static_sixels t.screen grid ~rows ~below:(after + 1) ~reach); (* The copy is drawn and dropped: give back its graphemes now rather than when the GC finalises it. *) Grid.clear grid | Lines _ -> ()); after + static_rows s) 0 (List.rev static) : int) (* The bytes that reset what a run may set, which the SIGABRT handler writes itself. They first end the frame's write a signal cut, in [`Primary] mode the region's, which also leaves the cursor below its rows; no scrolling region is set there, and resetting one (DECSTBM) would move the cursor to the screen's first row. *) let abort_bytes t = String.concat "" [ (match t.config.mode with | `Alt -> end_cut_seq | `Primary -> Screen.Region.teardown t.region); sync_output_off; (match t.config.mode with | `Alt -> reset_scroll_region_seq | `Primary -> ""); "\027[?7h"; "\027[?1000l\027[?1002l\027[?1003l\027[?1006l"; "\027[?2004l\027[?1004l\027[?2031l\027[?2048l\027[?1036r"; "\027[<u\027[>4;0m"; sgr_reset; cursor_show_seq; (match t.config.mode with `Alt -> "\027[?1049l" | `Primary -> ""); ] (* The reset bytes describe the region's rows and where the cursor rests, and are set again once a write that changed them has returned. *) let publish_reset t ~shown ~below = if shown <> t.shown || below <> t.below then ( t.shown <- shown; t.below <- below; t.backend.on_fatal (abort_bytes t)) (* In [`Primary] mode the frame is the region's rows, drawn by the screen relative to the region's origin, and the static rows queued go above them in the same write. A write afresh draws the rows down to the last that shows anything, the region having erased the rest; another writes the cells that changed. A write that may have moved the origin is followed by a cursor report, which says where mouse rows count from. *) let submit_primary ?(report = true) t = let cursor = Screen.cursor t.screen in let buf = t.submit_buf in Ansi.Writer.reset_pos buf; write_pictures t buf; let pictures = Ansi.Writer.len buf in let replace = t.replace in if replace then begin t.replace <- false; (* The erase and the rows that replace the transcript are one update. *) Ansi.Writer.write_string buf sync_output_on; Ansi.Writer.write_string buf (Screen.Region.clear t.region); Ansi.Writer.write_string buf clear_scrollback_seq; (* kitty keeps the images of the rows an erase of the scrollback takes away (their placeholders are virtual placements, which no erase deletes), so the run deletes them with it. *) let w = Ansi.Writer.create 0 in Screen.delete_transcript t.screen w; if Ansi.Writer.len w > 0 then Ansi.Writer.write_string buf (wrap_graphics t (Ansi.Writer.contents w)) end; let static = take_static t in let above = match static with | [] -> "" | [ s ] -> static_text t s | static -> String.concat "" (List.map (static_text t) static) in let forced_full = let ff = t.force_full_next_frame in if ff then t.force_full_next_frame <- false; ff in t.scroll_hint <- None; let shown = min (live_height t) (t.height - 1) in let whole = Screen.Region.start t.region buf ~cols:t.width ~rows:t.height ~above ~whole:forced_full ~height:shown in if static <> [] then write_static_sixels t buf static ~shown; (* The lines printed above move the origin down, until the region's rows reach the screen's last row. A line wider than the terminal, which it wraps, moves it further, as the next report says. *) if whole then begin let origin = if replace then Some 0 else t.origin in let lines = List.fold_left (fun n s -> n + static_rows s) 0 static in t.origin <- Option.map (fun o -> max 0 (min (o + lines) (t.height - 1 - shown))) origin end; let before = Ansi.Writer.len buf in let height = if whole then min shown (Screen.active_height t.screen) else shown in Screen.render_into ~full:whole ~relative:true ~viewport:{ Screen.y = 1; height } t.screen buf; let rendered = Ansi.Writer.len buf > before in let placed = region_cursor cursor ~shown in let position, below = match placed with | At { x; y } when shown > 0 -> (Some (y + 1, x + 1), y + 1) | _ -> (None, 0) in let dirty = cursor_dirty t ~cursor ~position in apply_cursor_appearance t ~buf ~cursor ~position; Screen.Region.finish t.region ~cursor:placed buf; if whole || replace || rendered || pictures > 0 || dirty then begin t.frame_modes_armed <- true; t.backend.write_output (Ansi.Writer.buffer buf) 0 (Ansi.Writer.len buf); publish_reset t ~shown ~below; if report && whole && (t.mouse <> `Off || t.ask <> None) && can_query t then ask_cursor t below end let submit t = match t.config.mode with `Alt -> submit_alt t | `Primary -> submit_primary t (* A frame drawn across a release is not presented: what the screen holds is unknown, and the next frame is drawn whole. *) let present t = t.drawing <- false; if t.void then ( t.void <- false; t.dirty <- true) else submit t (* The tools draw after the application, the dump first so that it holds the application's frame alone. The application may have built the next grid anew ([Screen.build]), so the panel draws on the one it left. *) let draw_with_tools t tools f = let start = Tty.now () in if tools.returned >= 0 then tools.app <- tools.app + (start - tools.returned); f (Screen.next_grid t.screen); Option.iter (fun dir -> Frame_dump.snapshot ~dir ~hits:true t.screen) tools.frames; Option.iter (fun o -> Debug_overlay.draw o ~metrics:(Screen.last_metrics t.screen) ~gc:(Gc.quick_stat ()) (Screen.next_grid t.screen)) tools.overlay; present t; let stop = Tty.now () in Option.iter (fun o -> Debug_overlay.record o ~app:tools.app ~start ~ns:(stop - start)) tools.overlay; tools.app <- 0; tools.returned <- stop let draw t ?primary_required_rows f = check t; if not t.drawing then invalid_arg "Matrix.draw: no frame is being drawn"; prepare ?primary_required_rows t; match t.tools with | None -> f (Screen.next_grid t.screen); present t | Some tools -> draw_with_tools t tools f (* Cursor *) (* Cursor setters update Screen state only. The actual terminal output is deferred to [draw], which writes everything into the frame buffer as a single write. *) let set_cursor ?visible ?style t = check t; let cursor = Screen.cursor t.screen in let visible = Option.value visible ~default:cursor.visible in let style = Option.value style ~default:cursor.style in Screen.set_cursor t.screen { cursor with visible; style } let set_cursor_style t ~style ~blinking = check t; let cursor = Screen.cursor t.screen in Screen.set_cursor t.screen { cursor with style; blinking } let set_cursor_position t ~row ~col = check t; let max_row = if t.config.mode = `Primary then live_height t else max 1 t.height in let row = clamp 1 max_row row in let col = max 1 col in let cursor = Screen.cursor t.screen in Screen.set_cursor t.screen { cursor with position = Some (col - 1, row - 1) } let set_cursor_color t ~r ~g ~b = check t; let clamp_01 f = Float.max 0. (Float.min 1. f) in let to_byte f = int_of_float (Float.round (f *. 255.)) |> clamp 0 255 in let cursor = Screen.cursor t.screen in Screen.set_cursor t.screen { cursor with color = Some (to_byte (clamp_01 r), to_byte (clamp_01 g), to_byte (clamp_01 b)); } (* Resize *) (* The terminal's size, applied when a frame is next drawn: a storm of reports costs one layout. In [`Primary] mode the frame then draws the region afresh from its origin, wherever the terminal moved it. *) let apply_size t = let cols, rows = match t.size_report with | Applied -> (t.width, t.height) | Read -> device_size t | Reported (cols, rows) -> (cols, rows) in t.size_report <- Applied; if cols > 0 && rows > 0 && (cols, rows) <> (t.width, t.height) then ( t.width <- cols; t.height <- rows; t.window_pixels <- t.backend.window_pixels (); update_cell_size t; ask_pixels t; force_full_redraw t; (* A terminal moves its rows as it resizes, by rules of its own: the next frame asks where the origin went, for the rows below it. *) t.origin <- None; if t.fill then t.ask <- Some 0; refresh_render_region t) (* Event delivery *) (* In [`Primary] mode a mouse row counts from the live region's first row, the row below its origin; above it, or before any cursor report has said where the origin is, it is [-1]. *) let adjust_event_for_offset t event = match (t.config.mode, event) with | `Primary, Mouse mouse -> let y = match t.origin with | Some origin when mouse.y > origin -> mouse.y - origin - 1 | _ -> -1 in Mouse { mouse with y } | _ -> event (* The events a person makes one at a time, each of which they expect to see answered. Motion, the wheel and paste data come in streams, and a resize as a drag. *) let discrete_event = function | Key _ | Key_release _ | Text _ | Paste_end _ | Focus_in | Focus_out -> true | Mouse { kind = Press _ | Release _; _ } -> true | Mouse { kind = Motion _ | Scroll _; _ } | Paste_start | Paste_data _ | Resize _ | Color_scheme _ | Palette _ | Invalid _ | Reply _ -> false (* A Focus_in after a Focus_out sets the modes again, once: a multiplexer that was detached meanwhile may have lost them. *) let deliver t event = t.discrete <- discrete_event event; (match event with | Focus_in -> if t.restore_modes_on_next_focus then ( t.restore_modes_on_next_focus <- false; Terminal.restore_modes t.terminal) | Focus_out -> t.restore_modes_on_next_focus <- true | _ -> ()); Event (adjust_event_for_offset t event) (* Taking the terminal and giving it back Each step that takes something pushes the undo that gives it back; giving the terminal back runs the undos, latest first, each even if another raises. [exiting] tells the end of the run from a release, which hands the terminal to another program and takes it again. *) let push_undo t undo = t.undo <- undo :: t.undo let run_undos t ~exiting = let undos = t.undo in t.undo <- []; let first = ref None in List.iter (fun undo -> try undo ~exiting with exn -> if !first = None then first := Some (exn, Printexc.get_raw_backtrace ())) undos; Option.iter (fun (exn, bt) -> Printexc.raise_with_backtrace exn bt) !first (* Signals, which the runtime takes as Tty.Signal's policy says, for a run on a terminal. *) let stopping_signals = [ Sys.sigtstp; Sys.sigterm; Sys.sighup ] let interrupting_signals = [ Sys.sigint; Sys.sigquit ] let take_signal t s = if Signal.take s then t.taken <- s :: t.taken let take_signals t = t.tstp_ignored <- Signal.ignored Sys.sigtstp; if (not t.in_process) && (t.backend.input_is_tty || t.backend.output_is_tty || t.backend.controlling) then List.iter (take_signal t) (Signal.signals ~controlling:t.backend.controlling); push_undo t (fun ~exiting -> if exiting then ( List.iter Signal.give_back t.taken; t.taken <- [])) (* Raw mode. Leaving it waits for the output to be sent and keeps input not yet read for whoever reads next; at the end of the run that is the shell, which must not read the runtime's mouse reports. *) let take_raw_mode t = if t.backend.input_is_tty && t.config.raw_mode then ( t.backend.set_raw_mode true; push_undo t (fun ~exiting -> (if exiting then try t.backend.flush_input () with _ -> ()); t.backend.set_raw_mode false; if exiting then t.backend.flush_input ())) (* Frame writes bypass the terminal handle and may stop between mode changes, inside a control string or inside a hyperlink. Attempt every reset independently, before handing the terminal back. A frame sets a scrolling region only in [`Alt] mode, and resetting one (DECSTBM) moves the cursor to the screen's first row, where in [`Primary] mode the region's origin is not. *) let restore_frame_modes t = if t.frame_modes_armed then ( t.frame_modes_armed <- false; (try Terminal.send t.terminal end_cut_seq with _ -> ()); (try Terminal.send t.terminal sync_output_off with _ -> ()); (if t.config.mode = `Alt then try Terminal.send t.terminal reset_scroll_region_seq with _ -> ()); try Terminal.send t.terminal "\027[?7h" with _ -> ()) (* The screen a program run in the application's place finds. In [`Primary] mode that is the transcript, the static rows queued for it included, and the live region erased, with the cursor at the start of its origin, the row where it began: the program's output goes on from there. A run that ends leaves its last frame instead when it was asked to ([keep_frame]), the rows of the frame [give_back] kept that show anything, with the cursor below them, as they are on the screen, pictures included. The static rows queued, and a frame kept that the screen may no longer show, go out first, in a write of their own. In [`Alt] mode it is the primary screen as the shell left it. The cursor is shown. *) let give_screen t ~exiting = let kept = if exiting then t.final else None in (* The live frame's images are deleted, which the terminal would keep; the next frame is drawn whole. A frame kept keeps its images. *) if kept = None && Grid.has_pictures (Screen.current_grid t.screen) then ( Grid.clear (Screen.next_grid t.screen); Screen.invalidate_presented t.screen; let w = Ansi.Writer.create 0 in Screen.send_pictures t.screen w; if Ansi.Writer.len w > 0 then Terminal.send t.terminal (wrap_graphics t (Ansi.Writer.contents w))); match t.config.mode with | `Alt -> Terminal.leave_alternate_screen t.terminal | `Primary -> t.origin <- None; let redraw = t.static <> [] || t.replace || (kept <> None && t.force_full_next_frame) in if redraw then ( Option.iter (fun frame -> Grid.blit ~src:frame ~dst:(Screen.next_grid t.screen)) kept; force_full_redraw t; submit_primary ~report:false t); (match kept with | Some frame -> let shown = min (live_height t) (t.height - 1) in Terminal.send t.terminal (Screen.Region.keep t.region (min shown (Grid.active_height frame))) | None -> Terminal.send t.terminal (Screen.Region.close t.region ~cols:t.width ~rows:t.height None)); (* The region shows no row now, as the reset bytes taken again say. *) t.shown <- 0; t.below <- 0 (* What the screen held is unknown once another program had it: the next frame is drawn whole and sets the cursor again. *) let forget_screen t = force_full_redraw t; t.last_cursor_position <- None; t.last_cursor_visible <- None; t.last_cursor_shape <- None; t.last_cursor_color <- None; Grid.clear (Screen.next_grid t.screen); Screen.Hit_grid.clear (Screen.next_hit_grid t.screen) (* A step that writes may fail halfway: its undo is pushed first, and undoes whatever part of it was done. *) let take_screen t = push_undo t (fun ~exiting -> give_screen t ~exiting); match t.config.mode with | `Alt -> Terminal.enter_alternate_screen t.terminal; let cursor = Screen.cursor t.screen in Screen.set_cursor t.screen { cursor with visible = false } | `Primary -> Terminal.leave_alternate_screen t.terminal let reset_modes t ~exiting = restore_frame_modes t; if exiting then Terminal.close t.terminal else List.iter (fun reset -> try reset () with _ -> ()) [ (fun () -> Terminal.set_mouse_mode t.terminal `Off); (fun () -> Terminal.enable_bracketed_paste t.terminal false); (fun () -> Terminal.enable_focus_reporting t.terminal false); (fun () -> Terminal.enable_kitty_keyboard t.terminal false); (fun () -> Terminal.enable_modify_other_keys t.terminal false); (fun () -> Terminal.enable_color_scheme_reports t.terminal false); (fun () -> Terminal.enable_resize_reports t.terminal false); (fun () -> Terminal.enable_meta_sends_escape t.terminal false); (fun () -> Terminal.enable_grapheme_mode t.terminal false); (fun () -> Terminal.send t.terminal cursor_show_seq); ] let take_modes t = push_undo t (fun ~exiting -> reset_modes t ~exiting); t.modes_taken <- true; refresh_capabilities t; apply_modes t; refresh_render_region t; force_full_redraw t (* What restores the terminal if the process ends where no OCaml code runs: the backend writes these bytes itself, and they go once the terminal is given back. *) let take_fatal_reset t = t.backend.on_fatal (abort_bytes t); push_undo t (fun ~exiting:_ -> t.backend.on_fatal "") (* Waits, when a reply is owed, for the terminal to answer what was sent: the replies that come after the terminal is given away would reach the shell, or the program run in the application's place, as typing. Every event decoded and not yet returned, meanwhile or before, is dropped, but for replies, and a paste in progress is cut ([release] says why). Batches still owed are dropped: their answers went to whoever has the terminal. *) let settle t = (* Each batch is waited for until as long after it was sent as any answer is: the probe's, already waited for as the run began, is not waited for again. *) if t.batches <> [] && can_query t then await t ~from:(List.fold_left (fun from b -> max from b.sent) min_int t.batches) t.batches; let kept = Queue.create () in Queue.iter (function (Reply _ | Palette _) as e -> Queue.push e kept | _ -> ()) t.events; Queue.clear t.events; Queue.transfer kept t.events; List.iter (fun b -> Input.Decoder.settle t.decoder b.owed; if b.question = Palette then ( ignore (take_palette t : Ansi.Palette.t option); push t (Palette None))) t.batches; t.batches <- []; t.lost_reports <- 0; (* A paste the application began to receive ends. *) Input.Decoder.cut_paste t.decoder (decoded t); Input.Decoder.reset t.decoder (* The screen is given back where the terminal has it: its size is read, which the loop may not have seen change, after the frame a run that ends leaves is kept, since a new size clears it. *) let give_back t ~exiting = if exiting && t.keep && t.config.mode = `Primary then t.final <- Some (Grid.copy (Screen.current_grid t.screen)); (try t.size_report <- Read; apply_size t; settle t with _ -> ()); run_undos t ~exiting (* The batch that waited for the ones dropped is sent. *) let send_waiting t = match t.waiting with | (question, bytes_owed) :: rest when t.batches = [] -> t.waiting <- rest; ignore (send_batch t question bytes_owed : batch) | _ -> () (* Takes the terminal again after another program had it: its settings are the shell's now, input it left is discarded, the size is read, and in [`Primary] mode the next frame draws the region from a row of its own, below what the program wrote. *) let take_again t = take_fatal_reset t; take_raw_mode t; t.backend.flush_input (); let cols, rows = device_size t in t.width <- max 1 cols; t.height <- max 1 rows; t.size_report <- Applied; forget_screen t; take_screen t; take_modes t; (* The live region begins below what the program wrote, on the rows down to the last, as at the start. *) if t.fill then t.ask <- Some 1; send_waiting t; owe_frame t let release t f = check t; if t.released then invalid_arg "Matrix.release: the terminal is released"; if t.drawing then t.void <- true; t.now <- t.backend.now (); give_back t ~exiting:false; t.released <- true; (* POSIX system(): the child gets the terminal's suspend and termination signals; the interrupt and quit characters reach the parent too, which ignores them. *) let stopping = List.filter (fun s -> List.mem s t.taken) stopping_signals in List.iter Signal.give_back stopping; t.taken <- List.filter (fun s -> not (List.mem s stopping)) t.taken; let take_back () = List.iter (take_signal t) stopping; t.kept <- t.kept @ List.filter (function | Device.Terminate s -> not (List.mem s interrupting_signals) | _ -> true) (t.backend.take_signals ()); t.released <- false; t.now <- t.backend.now (); take_again t in match f () with | result -> take_back (); result | exception exn -> let bt = Printexc.get_raw_backtrace () in (try take_back () with _ -> ()); Printexc.raise_with_backtrace exn bt let keep_frame t keep = check t; t.keep <- keep let set_mouse t mode = check t; t.mouse <- mode; if t.modes_taken then Terminal.set_mouse_mode t.terminal mode let stop_job t = check t; if t.backend.controlling && (not t.tstp_ignored) && not Sys.win32 then release t Signal.stop_group (* The loop *) let has_due_timer t = t.heap.length > 0 && heap_min t.heap <= t.now let take_timer t = let e = t.heap.entries.(0) in heap_remove t.heap e; Timer e.id (* A frame is due once the grid's next point has passed by the latest step's time: work that took the turn's budget may have taken it past it. One asked for by discrete input is due at once. *) let frame_due t = t.dirty && (not t.released) && (t.latest >= t.last_frame + t.interval || (t.in_process && t.asked_outside) || t.asked_discrete) (* The time the run next needs a step if nothing it waits for comes first: now when work is left, otherwise the earliest deadline, if any. *) let wait_deadline t = if (not (Queue.is_empty t.events)) || (not (Queue.is_empty t.posted)) || has_due_timer t || Atomic.get t.mailbox != [] then Some t.now else let deadline = min (heap_min t.heap) (input_deadline t) in let deadline = if t.dirty then min deadline (t.last_frame + t.interval) else deadline in if deadline = max_int then None else Some deadline (* Whether a run is ending the process on a termination signal. *) let ending = Atomic.make false (* The signals received since the last call, kept ones first. *) let received t = let s = t.kept @ t.backend.take_signals () in t.kept <- []; s let rec end_run t s = if Atomic.compare_and_set ending false true then ( t.now <- t.backend.now (); (try give_back t ~exiting:true with _ -> ()); List.iter Signal.give_back t.taken; t.taken <- []; (* The other runs' terminals, as an abort restores them. *) Signal.restore_all (); Signal.raise_default s; (* The default action ends the process; nothing returns here. *) exit 2) else (* Another run ends the process. *) let m = Mutex.create () and never = Condition.create () in Mutex.lock m; while true do Condition.wait never m done (* A SIGCONT the run did not cause: whoever continued the process has put back the shell's settings. *) and continued t = if not t.released then ( if t.backend.input_is_tty && t.config.raw_mode then ( t.backend.set_raw_mode false; t.backend.set_raw_mode true); Terminal.restore_modes t.terminal; (* The shell may have written where the cursor rested. *) Screen.Region.moved t.region; t.origin <- None; if t.fill then t.ask <- Some 0; forget_screen t; t.size_report <- Read; owe_frame t) and on_signals t signals = List.iter (function | Device.Winch -> t.size_report <- Read; owe_frame t | Cont -> continued t | Tstp -> if not t.released then ( release t (fun () -> Signal.raise_default Sys.sigtstp); (* The SIGCONT that ended the stop is this one's. *) on_signals t (List.filter (function Device.Cont -> false | _ -> true) (received t))) | Terminate s -> end_run t s) signals let take_posts t = match Atomic.exchange t.mailbox [] with | [] -> () | posts -> List.iter (fun f -> Queue.push f t.posted) (List.rev posts) (* The next post taken, returned as a step. *) let take_post t = let msg = Queue.pop t.posted in if Atomic.fetch_and_add t.pending (-1) = resume_pending + 1 then wake_posts t; Posted msg (* A turn begins at [now]. The input is looked at without waiting, unless [next]'s wait has just said whether it is readable; then the signals, the input and the posts received are taken. *) let begin_turn t ~now = let ready = if t.waited then ( t.waited <- false; t.waited_ready) else wait_only t ~until:past in t.now <- now; (match received t with [] -> () | s -> on_signals t s); if Queue.is_empty t.events then read_input t ~ready else expire t; take_posts t; t.owe_event <- not (Queue.is_empty t.events); t.owe_timer <- has_due_timer t; t.owe_post <- not (Queue.is_empty t.posted) (* A frame on the grid drawn less than an interval after the grid's next point takes that point, so the grid keeps its phase however late each frame is drawn, as a cell's theoretical arrival time does in the generic cell rate algorithm (ITU-T I.371, Annex A). One drawn later, after a pause or a long turn, starts the grid again from its own time. *) let start_frame t = t.dirty <- false; t.asked_outside <- false; t.in_frame_step <- true; t.drawing <- true; t.void <- false; if t.drawn <> no_frame then t.frame_dt <- t.latest - t.drawn; t.drawn <- t.latest; (* A frame drawn before the interval has passed, for discrete input or by a device, keeps the grid. *) let point = t.last_frame + t.interval in let on_grid = t.latest >= point in if on_grid then t.last_frame <- (if t.latest < point + t.interval then point else t.latest); t.early <- not on_grid; t.asked_discrete <- false; t.on_frame (); Frame (* Work goes on until one frame interval has passed since the turn began. *) let within_budget t = t.latest - t.now < t.interval (* The turn has no step left: the run waits for what {!fds} and {!deadline} say. Raised rather than returned in an option, so that [next]'s idle turns allocate nothing. *) exception Idle (* Whether the run's stop was requested. *) let stop_requested t = match t.stop with Some s -> Atomic.get s.Stop.requested | None -> false let rec work t = if stop_requested t then Stopped else if t.owe_event && not (Queue.is_empty t.events) then ( t.owe_event <- false; deliver t (Queue.pop t.events)) else if t.owe_timer && has_due_timer t then ( t.owe_timer <- false; take_timer t) else if t.owe_post && not (Queue.is_empty t.posted) then ( t.owe_post <- false; take_post t) else if (not (Queue.is_empty t.events)) && within_budget t then deliver t (Queue.pop t.events) else if has_due_timer t && within_budget t then take_timer t else if (not (Queue.is_empty t.posted)) && within_budget t then take_post t else if t.input_ended && Queue.is_empty t.events then Stopped else if frame_due t then begin_frame t else raise_notrace Idle (* The latest size is applied before a frame; a change of the usable size is returned first, and the frame follows it. *) and begin_frame t = if t.size_report <> Applied then apply_size t; let usable = size t in if usable <> t.usable then ( t.usable <- usable; t.frame_follows <- true; Event (Resize (fst usable, snd usable))) else start_frame t (* A turn begins after every time the run had nothing to do, and when the work of the last one is done. The first has the input read while the terminal was taken, and what was posted and set since. *) let turn t = begin_turn t ~now:t.latest; match work t with | step -> step | exception Idle -> t.begun <- false; raise_notrace Idle (* The application's time between steps, for the overlay's [app]. *) let entered t = match t.tools with | Some tools when tools.returned >= 0 -> tools.app <- tools.app + (Tty.now () - tools.returned); tools.returned <- -1 | _ -> () let returned t = match t.tools with Some tools -> tools.returned <- Tty.now () | None -> () let step_exn t ~now = check t; entered t; if now < t.latest then invalid_arg "Matrix.step: now is earlier than an earlier step's"; t.latest <- now; t.drawing <- false; t.in_frame_step <- false; t.discrete <- false; if t.frame_follows then ( t.frame_follows <- false; start_frame t) else if not t.begun then ( t.begun <- true; turn t) else match work t with step -> step | exception Idle -> turn t let step t ~now = match step_exn t ~now with | step -> returned t; Some step | exception Idle -> None let deadline t = check t; wait_deadline t let fds t = check t; t.backend.fds ~reading:(not t.input_ended) let clock = Tty.now (* [step] waiting with [select(2)], through the backend: the wait says whether the input is readable, so the turn after it looks no further. *) let rec next t = match step_exn t ~now:(t.backend.now ()) with | step -> t.stepped <- true; returned t; step | exception Idle -> let until = wait_deadline t in t.waited_ready <- (match t.backend.in_process with | Some (d : Device.in_process) -> (* A device decides how a run that waits goes on. *) let stepped = t.stepped in t.stepped <- false; d.idle ~until ~stepped && not t.input_ended | None -> wait_only t ~until); t.waited <- true; next t (* Running *) let make backend ?stop config = let evidence = match config.caps with | Some caps -> Terminal.Caps.assume caps | None -> Terminal.Caps.evidence backend.Device.env in let terminal = Terminal.make ~tty:backend.output_is_tty ~output:(fun s -> backend.write_output (Bytes.unsafe_of_string s) 0 (String.length s)) (Terminal.Caps.derive evidence) in (* An output with no window has the size of a classic terminal until its terminal reports one. *) let cols, rows = Option.value (backend.terminal_size ()) ~default:(80, 24) in let width = max 1 cols and height = max 1 rows in let screen = Screen.create ~cursor_visible:false ~explicit_width:config.explicit_width () in let now = backend.now () in { serial = Atomic.fetch_and_add serials 1; terminal; decoder = Input.Decoder.create (); input_buffer = Bytes.create 4096; input_ended = false; last_input = now; rtt = 0; evidence; batches = []; lost_reports = 0; waiting = []; heard = None; events = Queue.create (); config; backend; variable = Terminal.Caps.variable backend.env; stop; owner = thread_id (); screen; submit_buf = Ansi.Writer.create 4096; width; height; region = Screen.Region.create (); live_rows = max 1 (Option.value config.min_tui_height ~default:1); min_live = max 1 (Option.value config.min_tui_height ~default:1); lent = 0; fill = config.mode = `Primary && config.min_tui_height = None; ask = (if config.mode = `Primary && config.min_tui_height = None then Some 1 else None); static = []; replace = false; origin = None; keep = true; final = None; shown = 0; below = 0; scroll_hint = None; last_cursor_position = None; last_cursor_visible = None; last_cursor_shape = None; last_cursor_color = None; now; heap = heap_create (); mailbox = Atomic.make []; accepting = Atomic.make true; posted = Queue.create (); pending = Atomic.make 0; room_lock = Mutex.create (); room = Condition.create (); begun = false; latest = now; waited = false; waited_ready = false; owe_event = false; owe_timer = false; owe_post = false; interval = Float.to_int (Float.round (1e9 /. config.fps)); dirty = true; in_process = Option.is_some backend.in_process; asked_outside = true; in_frame_step = false; discrete = false; asked_discrete = false; early = false; stepped = false; on_frame = (match backend.Device.in_process with | Some d -> d.Device.frame | None -> Fun.const ()); tools = Option.bind config.debug tools_of_string; drawing = false; void = false; last_frame = no_frame; frame_dt = 0; drawn = no_frame; force_full_next_frame = true; size_report = Applied; usable = (width, height); cell_answer = None; window_pixels = backend.window_pixels (); cell_size = None; frame_follows = false; frame_modes_armed = false; restore_modes_on_next_focus = false; released = false; modes_taken = false; mouse = config.mouse; taken = []; kept = []; tstp_ignored = false; undo = []; } (* A terminal answers queries only on a raw input: the probe waits for its answers, and input that comes meanwhile is kept for the run. Whether the terminal answered it is returned. *) let probe t = if not (can_query t) then false else let b = send_batch t (Capabilities Probe) (Terminal.Caps.ask t.evidence Probe) in await t ~from:b.sent [ b ]; let cols, rows = device_size t in t.width <- max 1 cols; t.height <- max 1 rows; b.answered (* The measure of text sizing writes on the screen, from the row the cursor is on to the end, so it is written once the screen is taken, on rows the run owns, and only to a terminal that answered the probe, never on the screen's first row, so that a late report, [CSI 1 ; col R], is never the modified F3 [CSI 1 ; m R]. In [`Alt] mode that is the alternate screen's second row. In [`Primary] mode it is the first row of a region of two, the rows a scaled space takes, drawn below the origin, which a terminal of fewer than three rows has no room for. *) let measure_widths t = let at = match t.config.mode with | `Alt -> Some (Ansi.(to_string (cursor_position ~row:2 ~col:1)), "") | `Primary when t.height >= 3 -> let rows = Grid.create ~width:1 ~height:2 () in let region = Screen.Region.draw t.region ~cols:t.width ~rows:t.height ~cursor:Hidden (Some rows) in (* Down to the region's first row, and back to its origin after. *) Some (region ^ "\027[B", "\027[A") | `Primary -> None in match at with | Some (before, after) when can_query t -> Terminal.send t.terminal before; let b = send_batch t (Capabilities Widths) (Terminal.Caps.ask t.evidence Widths) in Terminal.send t.terminal after; await t ~from:b.sent [ b ] | _ -> () (* An output that is not a terminal has no window to read a size from. The size its terminal has already reported in band, as the transport of a served session writes it ahead of the run, is taken before the first frame: the input there is read and decoded, and kept for the run. *) let take_reported_size t = if not t.backend.output_is_tty then ( read_input t ~ready:(wait_only t ~until:past); match t.size_report with | Reported (cols, rows) -> t.width <- max 1 cols; t.height <- max 1 rows; t.size_report <- Applied | Applied | Read -> ()) let setup t = take_signals t; take_fatal_reset t; take_raw_mode t; take_reported_size t; let answered = probe t in (* In [`Primary] mode the region is made for what the terminal does as the probe has told it, before its first write. *) (if t.config.mode = `Primary then let caps = Terminal.capabilities t.terminal in t.region <- Screen.Region.create ~eager_wrap:caps.eager_wrap ~lifts_resting_cursor:caps.lifts_resting_cursor ()); take_screen t; if answered then measure_widths t; take_modes t; update_cell_size t; ask_pixels t; t.usable <- size t (* Registers [t], unless its terminal is the controlling one and another run holds it. *) let hold t = Mutex.protect runs_lock (fun () -> if t.backend.controlling && List.exists (fun (Held app) -> app.backend.controlling && not app.released) !runs then false else ( runs := Held t :: !runs; true)) let unhold t = Mutex.protect runs_lock (fun () -> runs := List.filter (fun (Held app) -> app.serial <> t.serial) !runs) (* The process can end while a run holds its terminal: a program that calls [exit] in a run, or whose main domain returns while a run on another domain is still giving its terminal back. Its exit path restores every terminal not yet given back, as an abort does; one given back is left alone. *) let exit_restores = Atomic.make false let restore_on_exit () = if not (Atomic.exchange exit_restores true) then at_exit Signal.restore_all let run_on backend ?stop ?(config = config ()) f = restore_on_exit (); let t = try make backend ?stop config with exn -> let bt = Printexc.get_raw_backtrace () in (try backend.Device.cleanup () with _ -> ()); Printexc.raise_with_backtrace exn bt in if not (hold t) then ( (try backend.cleanup () with _ -> ()); invalid_arg "Matrix.run: another run holds the terminal"); Option.iter (fun s -> Stop.attach s t.serial t.backend.wake) stop; (* A device reads the frame the run presented, and the terminal row its first row is on. *) Option.iter (fun (d : Device.in_process) -> d.presented (fun () -> ( current_grid t, (match t.config.mode with | `Alt -> `Row 0 | `Primary -> (* The region's first row is the one below its origin, from where the cursor rests. *) `Cursor (1 - t.below)), (* The screen writes half blocks without a cell size. *) match Screen.cell_size t.screen with | None -> `Blocks | Some _ -> (Terminal.capabilities t.terminal).graphics ))) backend.in_process; let finish () = Atomic.set t.accepting false; wake_posts t; Option.iter (fun s -> Stop.detach s t.serial) stop; unhold t; t.backend.cleanup () in let teardown () = Fun.protect ~finally:finish (fun () -> t.now <- t.backend.now (); give_back t ~exiting:true) in match setup t; f t with | result -> teardown (); result | exception exn -> let bt = Printexc.get_raw_backtrace () in (try teardown () with _ -> ()); Printexc.raise_with_backtrace exn bt let run ?input ?output ?env ?stop ?config f = let backend = match (config, input, output, env) with | Some { device = Some d; _ }, None, None, None -> d | Some { device = Some _; _ }, _, _, _ -> invalid_arg "Matrix.run: a run on a device takes no descriptors" | _ -> Device.unix ?input ?output ?env () in let config = match config with | Some { device = Some _; _ } -> config | _ -> let c = Option.value config ~default:(default_config ()) in Some { c with debug = Sys.getenv_opt "MATRIX_DEBUG" } in run_on backend ?stop ?config f (* Diagnostics *) module Debug_overlay = Debug_overlay (* The frame being drawn is in the screen's next grid until [draw] presents it; after, that grid is the next frame's, cleared when next read. *) let dump_frame ?(hits = false) ?dir ?pattern t = check t; if not t.drawing then invalid_arg "Matrix.dump_frame: no frame is being drawn"; Frame_dump.snapshot ?dir ?pattern ~hits t.screen
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>