1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
|
/* boxes.c - Generic editor development sandbox.
*
* Copyright 2012 David Seikel <won_fang@yahoo.com>
*
* Not in SUSv4. An entirely new invention, thus no web site either.
* See -
* http://pubs.opengroup.org/onlinepubs/9699919799/utilities/ex.html
* http://pubs.opengroup.org/onlinepubs/9699919799/utilities/more.html
* http://pubs.opengroup.org/onlinepubs/9699919799/utilities/sed.html
* http://pubs.opengroup.org/onlinepubs/9699919799/utilities/vi.html
* http://linux.die.net/man/1/less
USE_BOXES(NEWTOY(boxes, "w#h#m(mode):a(stickchars)1", TOYFLAG_USR|TOYFLAG_BIN))
config BOXES
bool "boxes"
default n
help
usage: boxes [-m|--mode mode] [-a|--stickchars] [-w width] [-h height]
Generic text editor and pager.
Mode selects which editor or text viewr it emulates, the choices are -
emacs is a microemacs type editor.
joe is a joe / wordstar type editor.
less is a less type pager.
mcedit (the default) is cooledit / mcedit type editor.
more is a more type pager.
nano is a nano / pico type editor.
vi is a vi type editor.
Stick chars means to use ASCII for the boxes instead of "graphics" characters.
*/
#include "toys.h"
GLOBALS(
char *mode;
long h, w;
// TODO - actually, these should be globals in the library, and leave this buffer alone.
int stillRunning, overWriteMode;
)
#define TT this.boxes
#define FLAG_a 2
#define FLAG_m 4
#define FLAG_h 8
#define FLAG_w 16
/* This is trying to be a generic text editing, text viewing, and terminal
* handling system. The current code is a work in progress, and the design
* may change. Certainly at this moment it's only partly written. It is
* "usable" though, for a very small value of "usable". In the following
* I'll use "editors" to refer to the toys using this, though not all will
* be editors.
*
* The things it is targeting are - vi and more (part of the standards, so
* part of the toybox TODO), less (also on the toybox TODO), joe and
* wordstar (coz Rob said they would be good to include), nano (again Rob
* thinks it would be good and I agree), microemacs (to avoid religous
* wars), and mcedit (coz that's what I actually use). The ex editor comes
* along for the ride coz vi is basically a screen editor wrapper around
* the ex line editor. Sed might be supported coz I'll need to do basic
* editing functions that are common to the editors, and sed needs the same
* editing functions.
*
* I will also use this for a midnight commander clone as discussed on the
* mailing list. This would have things in common with emacs dired, so we
* might get that as well. Parts of this code could also be used for a
* file chooser, as used by some of the editors we are targeting. Finally,
* the terminal handling stuff might be useful for other toys, so should be
* generic in it's own right. Oh, screen is listed in the toybox TODO as
* "maybe", so I'll poke at that to.
*
* The basic building blocks are box, content, context, edit line, and
* view. A box is an on screen rectanglur area. Content is a file, and
* the text that is in that file. A context represents a particular editor
* type, it has key mappings and other similar stuff. The edit line is a
* single line where editing happens, it's similar to readline. A view is
* a view into a content, there can be many, it represents that portion of
* the content that is on screen right now.
*
* I plan on splitting these things up a bit so they can be used
* separately. Then I can make actually toybox libraries out of them. For
* now it's all one big file for ease of development.
*
* The screen is split into boxes, by default there are only two, the main
* text area and the command line at the bottom. Each box contains a view,
* and each view points to a content (file) for it's text. A content can
* have many views. Each content has a context (editor). There is only
* ever one edit line, it's the line that is being edited at the moment.
* The edit line moves within and between boxes (including the command
* line) as needed.
*
* The justification for boxes is that most of the editors we are trying to
* emulate include some splitting up of the screen area for various
* reasons, and some of them include a split window system as well. So
* this boxes concept covers command line, main editing area, split windows,
* menus, on screen display of command keys, file selection, and anything
* else that might be needed.
*
* To keep things simple boxes are organised as a binary tree of boxes.
* There is a root box, it's a global. Each box can have two sub boxes.
* Only the leaf nodes of the box tree are visible on the screen. Each box
* with sub boxes is split either horizontally or vertically. Navigating
* through the boxes goes depth first.
*
* A content keeps track of a file and it's text. Each content also has a
* context, which is a collection of the things that define a particular
* editor. (I might move the context pointer from content to view, makes
* more sense I think.)
*
* A context is the heart of the generic part of the system. Any given
* toybox command that uses this system would basically define a context
* and pass that to the rest of the system. See the end of this file for a
* few examples. A context holds a list of command to C function mappings,
* key to command mappings, and a list of modes.
*
* Most of the editors targetted include a command line where the user
* types in editor commands, and each of those editors has different
* commands. They would mostly use the same editing C functions though, or
* short wrappers around them. The vi context at the end of this file is a
* good example, it has a bunch of short C wrappers around some editing
* functions, or uses standard C editing functions directly. So a context
* has an editor command to C function mapping.
*
* The editors respond to keystrokes, and those keystrokes invoke editor
* commands, often in a modal way. So there are keystroke to editor
* command mappings. To cater for editing modes, each context has a list
* of modes, and each mode can have key to command mappings, as well as
* menu to command mappings, and a list of displayed key/command pairs.
* Menu and key/command pair display is not written yet. Most editors have
* a system for remapping key to command mappings, that's not supported
* yet. Emacs has a heirarchy of key to command mappings, that's not
* supported yet. Some twiddling of the current design would be needed for
* those.
*
* The key mappings used can be multiple keystrokes in a sequence, the
* system caters for that. Some can be multi byte like function keys, and
* even different strings of bytes depending on the terminal type. To
* simplify this, there is a table that maps various terminals ideas of
* special keys to key names, and the mapping of keys to commands uses
* those key names.
*
* A view represents the on screen visible portion of a content within a
* box. To cater for split window style editors, a content can have many
* views. It deals with keeping track of what's shown on screen, mapping
* the on screen representation of the text to the stored text during input
* and output. Each box holds one view.
*
* The edit line is basically a movable readline. There are editing C
* functions for moving it up and down lines within a view, and for
* shifting the edit line to some other box. So an editor would map the
* cursor keys for "up a line" and "down a line" to these C functions for
* example. Actual readline style functionality is just the bottom command
* box being a single line view, with the history file loaded into it's
* content, and the Enter key mapped to the editor contexts "do this
* command" function. Using most of the system with not much special casing.
*
*
* I assume that there wont be a terribly large number of boxes.
* Things like minimum box sizes, current maximum screen sizes, and the fact
* that they all have to be on the screen mean that this assumption should
* be safe. It's likely that most of the time there will be only a few at
* most. The point is there is a built in limit, there's only so many non
* overlapping boxes with textual contents that you can squeeze onto one
* terminal screen at once.
*
* I assume that there will only be one command line, no matter how many boxes,
* and that the command line is for the current box.
*
* I use a wide screen monitor and small font.
* My usual terminal is 104 x 380 characters.
* There will be people with bigger monitors and smaller fonts.
* So use sixteen bits for storing screen positions and the like.
* Eight bits wont cut it.
*
*
* These are the escape sequences we send -
* \x1B[m reset attributes and colours
* \x1B[1m turn on bold
* \x1B[%d;%dH move cursor
* Plus some experimentation with turning on mouse reporting that's not
* currently used.
*
*
* TODO - disentangle boxes from views.
*
* TODO - should split this up into editing, UI, and boxes parts,
* so the developer can leave out bits they are not using.
*
* TODO - Show status line instead of command line when it's not being edited.
*
* TODO - should review it all for UTF8 readiness. Think I can pull that off
* by keeping everything on the output side as "screen position", and using
* the formatter to sort out the input to output mapping.
*
* TODO - see if there are any simple shortcuts to avoid recalculating
* everything all the time. And to avoid screen redraws.
*/
/* Robs "It's too big" lament.
> So when you give me code, assume I'm dumber than you. Because in this
> context, I am. I need bite sized pieces, each of which I can
> understand in its entirety before moving on to the next.
As I mentioned in my last email to the Aboriginal linux list, I wrote
the large blob so I could see how the ideas all work to do the generic
editor stuff and other things. It kinda needs to be that big to do
anything that is actually useful. So, onto musings about cutting it up
into bite sized bits...
You mentioned on the Aboriginal Linux list that you wanted a
"readline", and you listed some features. My reply was that you had
basically listed the features of my "basic editor". The main
difference between "readline" and a full screen editor, is that the
editor is fullscreen, while the "readline" is one line. They both have
to deal with a list of lines, going up and down through those lines,
editing the contents of those lines, one line at a time. For persistent
line history, they both have to save and load those lines to a file.
Other than that "readline" adds other behaviour, like moving the
current line to the end when you hit return and presenting that line to
the caller (here's the command). So just making "readline" wont cut
out much of the code. In fact, my "readline" is really just a thin
wrapper around the rest of the code.
Starting from the other end of the size spectrum, I guess "find out
terminal size" is a small enough bite sized chunk. To actually do
anything useful with that you would probably start to write stuff I've
already written though. Would be better off just using the stuff I've
already written. On the other hand, maybe that would be useful for
"ls" listings and the like, then we can start with just that bit?
I guess the smallest useful command I have in my huge blob of code
would be "more". I could even cut it down more. Show a page of text,
show the next page of text when you hit the space bar, quit when you
hit "q". Even then, I would estimate it would only cut out a third of
the code.
On the other hand, there's a bunch of crap in that blob that is for
future plans, and is not doing anything now.
In the end though, breaking it up into suitable bite sized bits might
be almost as hard as writing it in the first place. I'll see what I
can do, when I find some time. I did want to break it up into three
bits anyway, and there's a TODO to untangle a couple of bits that are
currently too tightly coupled.
*/
/* Robs contradiction
On Thu, 27 Dec 2012 06:06:53 -0600 Rob Landley <rob@landley.net> wrote:
> On 12/27/2012 12:56:07 AM, David Seikel wrote:
> > On Thu, 27 Dec 2012 00:37:46 -0600 Rob Landley <rob@landley.net>
> > wrote:
> > > Since ls isn't doiing any of that, probing would just be awkward
> > > so toysh should set COLUMNS to a sane value. The problem is,
> > > we're not using toysh yet because it's still just a stub...
> >
> > I got some or all of that terminal sizing stuff in my editor thingy
> > already if I remember correctly. I remember you wanted me to cut it
> > down into tiny bits to start with, so you don't have to digest the
> > huge lump I sent.
>
> Basically what I'd like is a self-contained line reader. More or less
> a getline variant that can handle cursoring left and right to insert
> stuff, handle backspace past a wordwrap (which on unix requires
> knowing the screen width and your current cursor position), and one
> that lets up/down escape sequences be hooked for less/more screen
> scrolling, vi line movement, shell command history, and so on.
Which is most of an editor already, so how to break it up into bite
sized morsels?
> There's sort of three levels here, the first is "parse raw input,
> assembling escape sequences into cursor-left and similar as
> necessary". (That's the one I had to redo in busybox vi because they
> didn't do it right.)
>
> The second is "edit a line of text, handling cursoring _within_ the
> line". That's the better/interactive getline().
>
> The third is handling escapes from that line triggering behavior in
> the larger command (cursor up and cursor down do different things in
> less, in vi, and in shell command history).
>
> The fiddly bit is that terminal_size() sort of has to integrate with
> all of these. Possibly I need to have width and height be members of
> struct toy_context. Or have the better_getline() take a pointer to a
> state structure it can update, containing that info...
*/
struct key
{
char *code;
char *name;
};
// This table includes some variations I have found on some terminals, and the MC "Esc digit" versions.
// http://rtfm.etla.org/xterm/ctlseq.html has a useful guide.
// TODO - Don't think I got all the linux console variations.
// TODO - Add more shift variations, plus Ctrl & Alt variations when needed.
// TODO - tmux messes with the shift function keys somehow.
// TODO - Add other miscelany that does not use an escape sequence.
// This is sorted by type, though there is some overlap.
// Human typing speeds wont need binary searching speeds on this small table.
// So simple wins out over speed, and sorting by terminal type wins the simple test.
struct key keys[] =
{
// Control characters.
// {"\x00", "^@"}, // NUL Commented out coz it's the C string terminator, and may confuse things.
{"\x01", "^A"}, // SOH Apparently sometimes sent as Home
{"\x02", "^B"}, // STX
{"\x03", "^C"}, // ETX SIGINT Emacs and vi.
{"\x04", "^D"}, // EOT EOF Emacs, joe, and nano.
{"\x05", "^E"}, // ENQ Apparently sometimes sent as End
{"\x06", "^F"}, // ACK
{"\x07", "^G"}, // BEL
{"\x08", "Del"}, // BS Delete key, usually.
{"\x09", "Tab"}, // HT Tab key.
{"\x0A", "Return"}, // LF Return key. Roxterm at least is translating both Ctrl-J and Ctrl-M into this.
{"\x0B", "^K"}, // VT
{"\x0C", "^L"}, // FF
{"\x0D", "^M"}, // CR Other Return key, usually.
{"\x0E", "^N"}, // SO
{"\x0F", "^O"}, // SI DISCARD
{"\x10", "^P"}, // DLE
{"\x11", "^Q"}, // DC1 SIGCONT Vi, and made up commands in MC, which seem to work anyway.
{"\x12", "^R"}, // DC2
{"\x13", "^S"}, // DC3 SIGSTOP can't be caught. Emacs and vi, so much for "can't be caught".
{"\x14", "^T"}, // DC4 SIGINFO STATUS
{"\x15", "^U"}, // NAK KILL character
{"\x16", "^V"}, // SYN LNEXT
{"\x17", "^W"}, // ETB WERASE
{"\x18", "^X"}, // CAN KILL character
{"\x19", "^Y"}, // EM DSUSP SIGTSTP
{"\x1A", "^Z"}, // SUB SIGTSTP
// {"\x1B", "^["}, // ESC Esc key. Commented out coz it's the ANSI start byte in the below multibyte keys. Handled in the code with a timeout.
{"\x1C", "^\\"}, // FS SIGQUIT Some say ^D is SIGQUIT, but my tests say it's this.
{"\x1D", "^]"}, // GS
{"\x1E", "^^"}, // RS
{"\x1F", "^_"}, // US
{"\x7F", "BS"}, // Backspace key, usually. Ctrl-? perhaps?
// {"\x9B", "CSI"}, // CSI The eight bit encoding of "Esc [". Commented out for the same reason Esc is.
// "Usual" xterm CSI sequences, with ";1" omitted for no modifiers.
// Even though we have a proper CSI parser, these should still be in this table.
// Coz we would need a table anyway in the CSI parser, so might as well keep them with the others.
// Also, less code, no need to have a separate scanner for that other table.
{"\x9B\x31~", "Home"}, // Duplicate, think I've seen this somewhere.
{"\x9B\x32~", "Ins"},
{"\x9B\x33~", "Del"},
{"\x9B\x34~", "End"}, // Duplicate, think I've seen this somewhere.
{"\x9B\x35~", "PgUp"},
{"\x9B\x36~", "PgDn"},
{"\x9B\x37~", "Home"},
{"\x9B\x38~", "End"},
{"\x9B\x31\x31~", "F1"},
{"\x9B\x31\x32~", "F2"},
{"\x9B\x31\x33~", "F3"},
{"\x9B\x31\x34~", "F4"},
{"\x9B\x31\x35~", "F5"},
{"\x9B\x31\x37~", "F6"},
{"\x9B\x31\x38~", "F7"},
{"\x9B\x31\x39~", "F8"},
{"\x9B\x32\x30~", "F9"},
{"\x9B\x32\x31~", "F10"},
{"\x9B\x32\x33~", "F11"},
{"\x9B\x32\x34~", "F12"},
// As above, ";2" means shift modifier.
{"\x9B\x31;2~", "Shift Home"},
{"\x9B\x32;2~", "Shift Ins"},
{"\x9B\x33;2~", "Shift Del"},
{"\x9B\x34;2~", "Shift End"},
{"\x9B\x35;2~", "Shift PgUp"},
{"\x9B\x36;2~", "Shift PgDn"},
{"\x9B\x37;2~", "Shift Home"},
{"\x9B\x38;2~", "Shift End"},
{"\x9B\x31\x31;2~", "Shift F1"},
{"\x9B\x31\x32;2~", "Shift F2"},
{"\x9B\x31\x33;2~", "Shift F3"},
{"\x9B\x31\x34;2~", "Shift F4"},
{"\x9B\x31\x35;2~", "Shift F5"},
{"\x9B\x31\x37;2~", "Shift F6"},
{"\x9B\x31\x38;2~", "Shift F7"},
{"\x9B\x31\x39;2~", "Shift F8"},
{"\x9B\x32\x30;2~", "Shift F9"},
{"\x9B\x32\x31;2~", "Shift F10"},
{"\x9B\x32\x33;2~", "Shift F11"},
{"\x9B\x32\x34;2~", "Shift F12"},
// "Normal" Some terminals are special, and it seems they only have four function keys.
{"\x9B\x41", "Up"},
{"\x9B\x42", "Down"},
{"\x9B\x43", "Right"},
{"\x9B\x44", "Left"},
{"\x9B\x46", "End"},
{"\x9BH", "Home"},
{"\x9BP", "F1"},
{"\x9BQ", "F2"},
{"\x9BR", "F3"},
{"\x9BS", "F4"},
{"\x9B\x31;2P", "Shift F1"},
{"\x9B\x31;2Q", "Shift F2"},
{"\x9B\x31;2R", "Shift F3"},
{"\x9B\x31;2S", "Shift F4"},
// "Application" Esc O is known as SS3
{"\x1BOA", "Up"},
{"\x1BOB", "Down"},
{"\x1BOC", "Right"},
{"\x1BOD", "Left"},
{"\x1BOF", "End"},
{"\x1BOH", "Home"},
{"\x1BOn", "Del"},
{"\x1BOp", "Ins"},
{"\x1BOq", "End"},
{"\x1BOw", "Home"},
{"\x1BOP", "F1"},
{"\x1BOO", "F2"},
{"\x1BOR", "F3"},
{"\x1BOS", "F4"},
{"\x1BOT", "F5"},
// These two conflict with the above four function key variations.
{"\x9BR", "F6"},
{"\x9BS", "F7"},
{"\x9BT", "F8"},
{"\x9BU", "F9"},
{"\x9BV", "F10"},
{"\x9BW", "F11"},
{"\x9BX", "F12"},
// Can't remember, but saw them somewhere.
{"\x1BO1;2P", "Shift F1"},
{"\x1BO1;2Q", "Shift F2"},
{"\x1BO1;2R", "Shift F3"},
{"\x1BO1;2S", "Shift F4"},
// MC "Esc digit" specials.
// NOTE - The MC Esc variations might not be such a good idea, other programs want the Esc key for other things.
// Notably seems that "Esc somekey" is used in place of "Alt somekey" AKA "Meta somekey" coz apparently some OSes swallow those.
// Conversely, some terminals send "Esc somekey" when you do "Alt somekey".
// MC Esc variants might be used on Macs for other things?
{"\x1B\x31", "F1"},
{"\x1B\x32", "F2"},
{"\x1B\x33", "F3"},
{"\x1B\x34", "F4"},
{"\x1B\x35", "F5"},
{"\x1B\x36", "F6"},
{"\x1B\x37", "F7"},
{"\x1B\x38", "F8"},
{"\x1B\x39", "F9"},
{"\x1B\x30", "F10"},
/* TODO - Rob says -
...you don't need a NULL terminator for
an array, you can do sizeof(table)/sizeof(*table). Divide the size of
the table (in bytes) by the size of a member of the table (in bytes) to
get the number of entries.
I should try that trick. Seems to work, let's do that everywhere.
*/
{NULL, NULL}
};
char *borderChars[][6] =
{
{"-", "|", "+", "+", "+", "+"}, // "stick" characters.
{"\xE2\x94\x80", "\xE2\x94\x82", "\xE2\x94\x8C", "\xE2\x94\x90", "\xE2\x94\x94", "\xE2\x94\x98"}, // UTF-8
{"\x71", "\x78", "\x6C", "\x6B", "\x6D", "\x6A"}, // VT100 alternate character set.
{"\xC4", "\xB3", "\xDA", "\xBF", "\xC0", "\xD9"} // DOS
};
char *borderCharsCurrent[][6] =
{
{"=", "#", "+", "+", "+", "+"}, // "stick" characters.
{"\xE2\x95\x90", "\xE2\x95\x91", "\xE2\x95\x94", "\xE2\x95\x97", "\xE2\x95\x9A", "\xE2\x95\x9D"}, // UTF-8
{"\x71", "\x78", "\x6C", "\x6B", "\x6D", "\x6A"}, // VT100 alternate character set has none of these. B-(
{"\xCD", "\xBA", "\xC9", "\xBB", "\xC8", "\xBC"} // DOS
};
typedef struct _box box;
typedef struct _view view;
typedef void (*boxFunction) (box *box);
typedef void (*eventHandler) (view *view);
typedef char *(*CSIhandler) (long extra, int *code, int count);
struct function
{
char *name; // Name for script purposes.
char *description; // Human name for the menus.
char type;
union
{
eventHandler handler;
char *scriptCallback;
};
};
struct keyCommand
{
char *key, *command;
};
struct item
{
char *text; // What's shown to humans.
struct key *key; // Shortcut key while the menu is displayed.
// If there happens to be a key bound to the same command, the menu system should find that and show it to.
char type;
union
{
char *command;
struct item *items; // An array of next level menu items.
};
};
struct borderWidget
{
char *text, *command;
};
// TODO - a generic "part of text", and what is used to define them.
// For instance - word, line, paragraph, section.
// Each context can have a collection of these.
struct mode
{
struct keyCommand *keys; // An array of key to command mappings.
struct item *items; // An array of top level menu items.
struct item *functionKeys; // An array of single level "menus". Used to show key commands.
uint8_t flags; // commandMode.
};
/*
Have a common menu up the top.
MC has a menu that changes per mode.
Nano has no menu.
Have a common display of certain keys down the bottom.
MC is one row of F1 to F10, but changes for edit / view / file browse. But those are contexts here.
Nano is 12 random Ctrl keys, possibly in two lines, that changes depending on the editor mode, like editing the prompt line for various reasons, help.
*/
struct context // Defines a context for content. Text viewer, editor, file browser for instance.
{
struct function *commands; // The master list, the ones pointed to by the menus etc should be in this list.
struct mode *modes; // A possible empty array of modes, indexed by the view.
// OR might be better to have these as a linked list, so that things like Emacs can have it's mode keymap hierarcy.
eventHandler handler; // TODO - Might be better to put this in the modes. I think vi will need that.
// Should set the damage list if it needs a redraw, and flags if border or status line needs updating.
// Keyboard / mouse events if the box did not handle them itself.
// DrawAll event for when drawing the box for the first time, on reveals for coming out of full screen, or user hit the redraw key.
// Scroll event if the content wants to handle that itself.
// Timer event for things like top that might want to have this called regularly.
boxFunction doneRedraw; // The box is done with it's redraw, so we can free the damage list or whatever now.
boxFunction delete;
// This can be used as the sub struct for various context types. Like viewer, editor, file browser, top, etc.
// Could even be an object hierarchy, like generic editor, which Basic vi inherits from.
// Or not, since the commands might be different / more of them.
};
// TODO - might be better off just having a general purpose "widget" which includes details of where it gets attached.
// Status lines can have them to.
struct border
{
struct borderWidget *topLeft, *topMiddle, *topRight;
struct borderWidget *bottomLeft, *bottomMiddle, *bottomRight;
struct borderWidget *left, *right;
};
struct line
{
struct line *next, *prev;
uint32_t length; // Careful, this is the length of the allocated memory for real lines, but the number of lines in the header node.
char *line; // Should be blank for the header.
};
struct damage
{
struct damage *next; // A list for faster draws?
uint16_t X, Y, W, H; // The rectangle to be redrawn.
uint16_t offset; // Offest from the left for showing lines.
struct line *lines; // Pointer to a list of text lines, or NULL.
// Note - likely a pointer into the middle of the line list in a content.
};
struct content // For various instances of context types.
// Editor / text viewer might have several files open, so one of these per file.
// MC might have several directories open, one of these per directory. No idea why you might want to do this. lol
{
struct context *context;
char *name, *file, *path;
struct line lines;
// file type
// double linked list of bookmarks, pointer to line, character position, length (or ending position?), type, blob for types to keep context.
uint16_t minW, minH, maxW, maxH;
uint8_t flags; // readOnly, modified.
// This can be used as the sub struct for various content types.
};
struct _view
{
struct content *content;
box *box;
struct border *border; // Can be NULL.
char *statusLine; // Text of the status line, or NULL if none.
int mode; // For those contexts that can be modal. Normally used to index the keys, menus, and key displays.
struct damage *damage; // Can be NULL. If not NULL after context->doneRedraw(), box will free it and it's children.
// TODO - Gotta be careful of overlapping views.
void *data; // The context controls this blob, it's specific to each box.
uint32_t offsetX, offsetY; // Offset within the content, coz box handles scrolling, usually.
uint16_t X, Y, W, H; // Position and size of the content area within the box. Calculated, but cached coz that might be needed for speed.
uint16_t cX, cY; // Cursor position within the content.
uint16_t iX, oW; // Cursor position inside the lines input text, in case the formatter makes it different, and output length.
char *output; // The current line formatted for output.
uint8_t flags; // redrawStatus, redrawBorder;
// Assumption is that each box has it's own editLine (likely the line being edited), or that there's a box that is just the editLine (emacs minibuffer, and command lines for other proggies).
struct line *line; // Pointer to the current line, might be the only line.
char *prompt; // Optional prompt for the editLine.
// Display mode / format hook.
// view specific bookmarks, including highlighted block and it's type.
// Linked list of selected lines for a filtered view, or processing only those lines.
// Linked list of pointers to struct keyCommand, for emacs keymaps hierarchy, and anything similar in other editors. Plus some way of dealing with emacs minor mode keymaps.
};
struct _box
{
box *sub1, *sub2, *parent;
view *view; // This boxes view into it's content. For sharing contents, like a split pane editor for instance, there might be more than one box with this content, but a different view.
// If it's just a parent box, it wont have this, so just make it a damn pointer, that's the simplest thing. lol
// TODO - Are parent boxes getting a view anyway?
uint16_t X, Y, W, H; // Position and size of the box itself, not the content. Calculated, but cached coz that might be needed for speed.
float split; // Ratio of sub1's part of the split, the sub2 box gets the rest.
uint8_t flags; // Various flags.
};
// Sometimes you just can't avoid circular definitions.
void drawBox(box *box);
#define BOX_HSPLIT 1 // Marks if it's a horizontally or vertically split.
#define BOX_BORDER 2 // Mark if it has a border, often full screen boxes wont.
static box *rootBox; // Parent of the rest of the boxes, or the only box. Always a full screen.
static box *currentBox;
static view *commandLine;
static int commandMode;
static volatile sig_atomic_t sigWinch;
#define MEM_SIZE 128 // Chunk size for line memory allocation.
// Inserts the line after the given line, or at the end of content if no line.
struct line *addLine(struct content *content, struct line *line, char *text, uint32_t length)
{
struct line *result = NULL;
uint32_t len;
if (!length)
length = strlen(text);
// Round length up.
len = (((length + 1) / MEM_SIZE) + 1) * MEM_SIZE;
result = xzalloc(sizeof(struct line));
result->line = xzalloc(len);
result->length = len;
strncpy(result->line, text, length);
if (content)
{
if (!line)
line = content->lines.prev;
result->next = line->next;
result->prev = line;
line->next->prev = result;
line->next = result;
content->lines.length++;
}
else
{
result->next = result;
result->prev = result;
}
return result;
}
void freeLine(struct content *content, struct line *line)
{
line->next->prev = line->prev;
line->prev->next = line->next;
if (content)
content->lines.length--;
free(line->line);
free(line);
}
void loadFile(struct content *content)
{
int fd = open(content->path, O_RDONLY);
if (-1 != fd)
{
char *temp = NULL;
long len;
do
{
// TODO - get_rawline() is slow, and wont help much with DOS and Mac line endings.
temp = get_rawline(fd, &len, '\n');
if (temp)
{
if (temp[len - 1] == '\n')
temp[--len] = '\0';
addLine(content, NULL, temp, len);
}
} while (temp);
close(fd);
}
}
// TODO - load and save should be able to deal with pipes, and with loading only parts of files, to load more parts later.
void saveFile(struct content *content)
{
// TODO - Should do "Save as" as well. Which is just a matter of changing content->path before calling this.
int fd;
fd = open(content->path, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH);
if (-1 != fd)
{
struct line *line = content->lines.next;
while (&(content->lines) != line) // We are at the end if we have wrapped to the beginning.
{
write(fd, line->line, strlen(line->line));
write(fd, "\n", 1);
line = line->next;
}
close(fd);
}
else
{
fprintf(stderr, "Can't open file %s\n", content->path);
exit(1);
}
}
struct content *addContent(char *name, struct context *context, char *filePath)
{
struct content *result = xzalloc(sizeof(struct content));
result->lines.next = &(result->lines);
result->lines.prev = &(result->lines);
result->name = strdup(name);
result->context = context;
if (filePath)
{
result->path = strdup(filePath);
loadFile(result);
}
return result;
}
// General purpose line moosher. Used for appends, inserts, overwrites, and deletes.
// TODO - should have the same semantics as mooshStrings, only it deals with whole lines in double linked lists.
// We need content so we can adjust it's number of lines if needed.
void mooshLines(struct content *content, struct line *result, struct line *moosh, uint16_t index, uint16_t length, int insert)
{
}
// General purpose string moosher. Used for appends, inserts, overwrites, and deletes.
void mooshStrings(struct line *result, char *moosh, uint16_t index, uint16_t length, int insert)
{
char *c, *pos;
int limit = strlen(result->line);
int mooshLen = 0, resultLen;
if (moosh)
mooshLen = strlen(moosh);
/*
* moosh == NULL a deletion
* length == 0 simple insertion
* length < mooshlen delete some, insert moosh
* length == mooshlen exact overwrite.
* length > mooshlen delete a lot, insert moosh
*/
mooshLen -= length;
resultLen = limit + mooshLen;
// If we need more space, allocate more.
if (resultLen > result->length)
{
result->length = resultLen + MEM_SIZE;
result->line = xrealloc(result->line, result->length);
}
if (limit <= index) // At end, just add to end.
{
// TODO - Possibly add spaces to pad out to where index is?
// Would be needed for "go beyond end of line" and "column blocks".
// Both of those are advanced editing.
index = limit;
insert = 1;
}
pos = &(result->line[index]);
if (insert) // Insert / delete before current character, so move it and the rest up / down mooshLen bytes.
{
if (0 < mooshLen) // Gotta move things up.
{
c = &(result->line[limit]);
while (c >= pos)
{
*(c + mooshLen) = *c;
c--;
}
}
else if (0 > mooshLen) // Gotta move things down.
{
c = pos;
while (*c)
{
*c = *(c - mooshLen); // A double negative.
c++;
}
}
}
if (moosh)
{
c = moosh;
do
{
*pos++ = *c++;
}
while (*c);
}
}
// TODO - Should draw the current border in green, the text as default (or highlight / bright).
// Then allow one other box to be red bordered (MC / dired destination box).
// All other boxes with dark gray border, and dim text.
void drawLine(int y, int start, int end, char *left, char *internal, char *contents, char *right, int current)
{
int size = strlen(internal);
int len = (end - start) * size, x = 0;
char line[len + 1];
if ('\0' != left[0]) // Assumes that if one side has a border, then so does the other.
len -= 2 * size;
if (contents)
{
// strncpy wont add a null at the end if the source is longer, but will pad with nulls if source is shorter.
// So it's best to put a safety null in first.
line[len] = '\0';
strncpy(line, contents, len);
// Make sure the following while loop pads out line with the internal character.
x = strlen(line);
}
while (x < len)
{
strcpy(&line[x], internal);
x += size;
}
line[x++] = '\0';
if ('\0' == left[0]) // Assumes that if one side has a border, then so does the other.
{
if (current)
printf("\x1B[1m\x1B[%d;%dH%s\x1B[m", y + 1, start + 1, line);
else
printf("\x1B[m\x1B[%d;%dH%s", y + 1, start + 1, line);
}
else
{
if (current)
printf("\x1B[1m\x1B[%d;%dH%s%s%s\x1B[m", y + 1, start + 1, left, line, right);
else
printf("\x1B[m\x1B[%d;%dH%s%s%s", y + 1, start + 1, left, line, right);
}
}
void formatCheckCursor(view *view, long *cX, long *cY, char *input)
{
int i = 0, o = 0, direction = (*cX) - view->cX;
// Adjust the cursor if needed, depending on the contents of the line, and the direction of travel.
while (input[i])
{
// When o is equal to the cX position, update the iX position to be where i is.
if ('\t' == input[i])
{
int j = 8 - (i % 8);
// Check if the cursor is in the middle of the tab.
if (((*cX) > o) && ((*cX) < (o + j)))
{
if (0 <= direction)
{
*cX = (o + j);
view->iX = i + 1;
}
else
{
*cX = o;
view->iX = i;
}
}
o += j;
}
else
{
if ((*cX) == o)
view->iX = i;
o++;
}
i++;
}
// One more check in case the cursor is at the end of the line.
if ((*cX) == o)
view->iX = i;
}
// TODO - Should convert control characters to reverse video, and deal with UTF8.
/* FIXME - We get passed a NULL input, apparently when the file length is close to the screen length. -
> On Thu, 6 Sep 2012 11:56:17 +0800 Roy Tam <roytam@gmail.com> wrote:
>
> > 2012/9/6 David Seikel <onefang@gmail.com>:
> > >> Program received signal SIGSEGV, Segmentation fault.
> > >> formatLine (view=0x8069168, input=0x0, output=0x806919c)
> > >> at toys/other/boxes.c:843
> > >> 843 int len = strlen(input), i = 0, o = 0;
> > >> (gdb) bt
> > >> #0 formatLine (view=0x8069168, input=0x0, output=0x806919c)
> > >> at toys/other/boxes.c:843
> > >> #1 0x0804f1dd in moveCursorAbsolute (view=0x8069168, cX=0,
> > >> cY=10, sX=0, sY=0) at toys/other/boxes.c:951
> > >> #2 0x0804f367 in moveCursorRelative (view=0x8069168, cX=0,
> > >> cY=10, sX=0, sY=0) at toys/other/boxes.c:1011
> > >> #3 0x0804f479 in upLine (view=0x8069168, event=0x0) at
> > >> toys/other/boxes.c:1442 #4 0x0804fb63 in handleKey
> > >> (view=0x8069168, i=2, keyName=<optimized out>, buffer=0xbffffad8
> > >> "\033[A") at toys/other/boxes.c:1593 #5 0x0805008d in editLine
> > >> (view=0x8069168, X=-1, Y=-1, W=-1, H=-1) at
> > >> toys/other/boxes.c:1785 #6 0x08050288 in boxes_main () at
> > >> toys/other/boxes.c:2482 #7 0x0804b262 in toy_exec
> > >> (argv=0xbffffd58) at main.c:104 #8 0x0804b29d in toybox_main ()
> > >> at main.c:118 #9 0x0804b262 in toy_exec (argv=0xbffffd54) at
> > >> main.c:104 #10 0x0804b29d in toybox_main () at main.c:118
> > >> #11 0x0804affa in main (argc=5, argv=0xbffffd54) at main.c:159
> > >
> > > No segfault here when I try that, nor with different files. As I
> > > said, it has bugs. I have seen other cases before when NULL lines
> > > are passed around near that code. Guess I've not got them all.
> > > Might help to mention what terminal proggy you are using, it's
> > > size in characters, toybox version, OS, etc. Something is
> > > different between you and me.
> >
> > Terminal Program: PuTTY
> > Windows size: 80 * 25 chars
> > Toybox version: hg head
> > OS: Linux 3.2 (Debian wheezy)
> > File: Toybox LICENSE file
>
> I'll install PuTTY, try toybox hg head, and play with them later, see
> if I can reproduce that segfault. I use the last released tarball of
> toybox, an old Ubuntu, and a bunch of other terminal proggies. I did
> not know that PuTTY had been ported to Unix.
>
> But as I mentioned, not interested in a bug hunt right now. That will
> be more appropriate when it's less of a "sandbox for testing the
> ideas" and more of a "good enough to bother using". Always good to
> have other terminals for testing though.
Seems to be sensitive to the number of lines. On my usual huge
roxterm, using either toybox 0.4 or hg head, doing this -
./toybox boxes -m less LICENSE -h 25
and just hitting down arrow until you get to the bottom of the page
segfaults as well. -h means "pretend the terminal is that many lines
high", there's a similar -w as well. 80x25 in any other terminal did
the same. For that particular file (17 lines long), any value of -h
between 19 and 34 will segfault after some moving around. -h 35 makes
it segfault straight away. Less than 19 or over 35 is fine. Longer
files don't have that problem, though I suspect it will happen on
shortish files where the number of lines is about the length of the
screen.
I guess that somewhere I'm doing maths wrong and getting an out of
bounds line number when the file length is close to the screen length.
I'll make note of that, and fix it when I next get time to beat on
boxes.
Thanks for reporting it Roy.
*/
int formatLine(view *view, char *input, char **output)
{
int len = strlen(input), i = 0, o = 0;
*output = xrealloc(*output, len + 1);
while (input[i])
{
if ('\t' == input[i])
{
int j = 8 - (i % 8);
*output = xrealloc(*output, len + j + 1);
for (; j; j--)
{
(*output)[o++] = ' ';
len++;
}
len--; // Not counting the actual tab character itself.
}
else
(*output)[o++] = input[i];
i++;
}
(*output)[o++] = '\0';
return len;
}
void drawContentLine(view *view, int y, int start, int end, char *left, char *internal, char *contents, char *right, int current)
{
char *temp = NULL;
int offset = view->offsetX, len;
if (contents == view->line->line)
{
view->oW = formatLine(view, contents, &(view->output));
temp = view->output;
len = view->oW;
}
else // Only time we are not drawing the current line, and only used for drawing the entire page.
len = formatLine(NULL, contents, &(temp));
if (offset > len)
offset = len;
drawLine(y, start, end, left, internal, &(temp[offset]), right, current);
}
void updateLine(view *view)
{
int y, len;
// Coz things might change out from under us, find the current view. Again.
if (commandMode) view = commandLine;
else view = currentBox->view;
// TODO - When doing scripts and such, might want to turn off the line update until finished.
// Draw the prompt and the current line.
y = view->Y + (view->cY - view->offsetY);
len = strlen(view->prompt);
drawLine(y, view->X, view->X + view->W, "", " ", view->prompt, "", 0);
drawContentLine(view, y, view->X + len, view->X + view->W, "", " ", view->line->line, "", 1);
// Move the cursor.
printf("\x1B[%d;%dH", y + 1, view->X + len + (view->cX - view->offsetX) + 1);
fflush(stdout);
}
void doCommand(view *view, char *command)
{
if (command)
{
struct function *functions = view->content->context->commands;
int i;
for (i = 0; functions[i].name; i++)
{
if (strcmp(functions[i].name, command) == 0)
{
if (functions[i].handler);
{
functions[i].handler(view);
updateLine(view);
}
break;
}
}
}
}
int moveCursorAbsolute(view *view, long cX, long cY, long sX, long sY)
{
struct line *newLine = view->line;
long oX = view->offsetX, oY = view->offsetY;
long lX = view->oW, lY = view->content->lines.length - 1;
long nY = view->cY;
uint16_t w = view->W - 1, h = view->H - 1;
int moved = 0, updatedY = 0, endOfLine = 0;
// Check if it's still within the contents.
if (0 > cY) // Trying to move before the beginning of the content.
cY = 0;
else if (lY < cY) // Trying to move beyond end of the content.
cY = lY;
if (0 > cX) // Trying to move before the beginning of the line.
{
// See if we can move to the end of the previous line.
if (view->line->prev != &(view->content->lines))
{
cY--;
endOfLine = 1;
}
else
cX = 0;
}
else if (lX < cX) // Trying to move beyond end of line.
{
// See if we can move to the begining of the next line.
if (view->line->next != &(view->content->lines))
{
cY++;
cX = 0;
}
else
cX = lX;
}
// Find the new line.
while (nY != cY)
{
updatedY = 1;
if (nY < cY)
{
newLine = newLine->next;
nY++;
if (view->content->lines.prev == newLine) // We are at the end if we have wrapped to the beginning.
break;
}
else
{
newLine = newLine->prev;
nY--;
if (view->content->lines.next == newLine) // We are at the end if we have wrapped to the beginning.
break;
}
}
cY = nY;
// Check if we have moved past the end of the new line.
if (updatedY)
{
// Format it.
view->oW = formatLine(view, newLine->line, &(view->output));
if (view->oW < cX)
endOfLine = 1;
if (endOfLine)
cX = view->oW;
}
// Let the formatter decide if it wants to adjust things.
// It's up to the formatter to deal with things if it changes cY.
// On the other hand, changing cX is it's job.
formatCheckCursor(view, &cX, &cY, newLine->line);
// Check the scrolling.
lY -= view->H - 1;
oX += sX;
oY += sY;
if (oY > cY) // Trying to move above the box.
oY += cY - oY;
else if ((oY + h) < cY) // Trying to move below the box
oY += cY - (oY + h);
if (oX > cX) // Trying to move to the left of the box.
oX += cX - oX;
else if ((oX + w) <= cX) // Trying to move to the right of the box.
oX += cX - (oX + w);
if (oY < 0)
oY = 0;
if (oY >= lY)
oY = lY;
if (oX < 0)
oX = 0;
// TODO - Should limit oX to less than the longest line, minus box width.
// Gonna be a pain figuring out what the longest line is.
// On the other hand, don't think that will be an actual issue unless "move past end of line" is enabled, and that's an advanced editor thing.
// Though still might want to do that for the longest line on the new page to be.
if ((view->cX != cX) || (view->cY != cY))
moved = 1;
// Actually update stuff, though some have been done already.
view->cX = cX;
view->cY = cY;
view->line = newLine;
// Handle scrolling.
if ((view->offsetX != oX) || (view->offsetY != oY))
{
view->offsetX = oX;
view->offsetY = oY;
if (view->box)
drawBox(view->box);
}
return moved;
}
int moveCursorRelative(view *view, long cX, long cY, long sX, long sY)
{
return moveCursorAbsolute(view, view->cX + cX, view->cY + cY, sX, sY);
}
void sizeViewToBox(box *box, int X, int Y, int W, int H)
{
uint16_t one = 1, two = 2;
if (!(box->flags & BOX_BORDER))
{
one = 0;
two = 0;
}
box->view->X = X;
box->view->Y = Y;
box->view->W = W;
box->view->H = H;
if (0 > X) box->view->X = box->X + one;
if (0 > Y) box->view->Y = box->Y + one;
if (0 > W) box->view->W = box->W - two;
if (0 > H) box->view->H = box->H - two;
}
view *addView(char *name, struct context *context, char *filePath, uint16_t X, uint16_t Y, uint16_t W, uint16_t H)
{
view *result = xzalloc(sizeof(struct _view));
result->X = X;
result->Y = Y;
result->W = W;
result->H = H;
result->content = addContent(name, context, filePath);
result->prompt = xzalloc(1);
// If there was content, format it's first line as usual, otherwise create an empty first line.
if (result->content->lines.next != &(result->content->lines))
{
result->line = result->content->lines.next;
result->oW = formatLine(result, result->line->line, &(result->output));
}
else
{
result->line = addLine(result->content, NULL, "\0", 0);
result->output = xzalloc(1);
}
return result;
}
box *addBox(char *name, struct context *context, char *filePath, uint16_t X, uint16_t Y, uint16_t W, uint16_t H)
{
box *result = xzalloc(sizeof(struct _box));
result->X = X;
result->Y = Y;
result->W = W;
result->H = H;
result->view = addView(name, context, filePath, X, Y, W, H);
result->view->box = result;
sizeViewToBox(result, X, Y, W, H);
return result;
}
void freeBox(box *box)
{
if (box)
{
freeBox(box->sub1);
freeBox(box->sub2);
if (box->view)
{
// In theory the line should not be part of the content if there is no content, so we should free it.
if (!box->view->content)
freeLine(NULL, box->view->line);
free(box->view->prompt);
free(box->view->output);
free(box->view);
}
free(box);
}
}
void drawBox(box *box)
{
// This could be heavily optimized, but let's keep things simple for now.
// Optimized for sending less characters I mean, on slow serial links for instance.
char **bchars = (toys.optflags & FLAG_a) ? borderChars[0] : borderChars[1];
char *left = "\0", *right = "\0";
struct line *lines = NULL;
int y = box->Y, current = (box == currentBox);
uint16_t h = box->Y + box->H;
if (current)
bchars = (toys.optflags & FLAG_a) ? borderCharsCurrent[0] : borderCharsCurrent[1];
// Slow and laborious way to figure out where in the linked list of lines we start from.
// Wont scale well, but is simple.
if (box->view && box->view->content)
{
int i = box->view->offsetY;
lines = &(box->view->content->lines);
while (i--)
{
lines = lines->next;
if (&(box->view->content->lines) == lines) // We are at the end if we have wrapped to the beginning.
break;
}
}
if (box->flags & BOX_BORDER)
{
h--;
left = right = bchars[1];
drawLine(y++, box->X, box->X + box->W, bchars[2], bchars[0], NULL, bchars[3], current);
}
while (y < h)
{
char *line = "";
if (lines)
{
lines = lines->next;
if (&(box->view->content->lines) == lines) // We are at the end if we have wrapped to the beginning.
lines = NULL;
else
line = lines->line;
// Figure out which line is our current line while we are here.
if (box->view->Y + (box->view->cY - box->view->offsetY) == y)
box->view->line = lines;
}
drawContentLine(box->view, y++, box->X, box->X + box->W, left, " ", line, right, current);
}
if (box->flags & BOX_BORDER)
drawLine(y++, box->X, box->X + box->W, bchars[4], bchars[0], NULL, bchars[5], current);
fflush(stdout);
}
void drawBoxes(box *box)
{
if (box->sub1) // If there's one sub box, there's always two.
{
drawBoxes(box->sub1);
drawBoxes(box->sub2);
}
else
drawBox(box);
}
void calcBoxes(box *box)
{
if (box->sub1) // If there's one sub box, there's always two.
{
box->sub1->X = box->X;
box->sub1->Y = box->Y;
box->sub1->W = box->W;
box->sub1->H = box->H;
box->sub2->X = box->X;
box->sub2->Y = box->Y;
box->sub2->W = box->W;
box->sub2->H = box->H;
if (box->flags & BOX_HSPLIT)
{
box->sub1->H *= box->split;
box->sub2->H -= box->sub1->H;
box->sub2->Y += box->sub1->H;
}
else
{
box->sub1->W *= box->split;
box->sub2->W -= box->sub1->W;
box->sub2->X += box->sub1->W;
}
sizeViewToBox(box->sub1, -1, -1, -1, -1);
calcBoxes(box->sub1);
sizeViewToBox(box->sub2, -1, -1, -1, -1);
calcBoxes(box->sub2);
}
// Move the cursor to where it is, to check it's not now outside the box.
moveCursorAbsolute(box->view, box->view->cX, box->view->cY, 0, 0);
// We could call drawBoxes() here, but this is recursive, and so is drawBoxes().
// The combination might be deadly. Drawing the content of a box might be an expensive operation.
// Later we might use a dirty box flag to deal with this, if it's not too much of a complication.
}
void deleteBox(view *view)
{
box *box = view->box;
if (box->parent)
{
struct _box *oldBox = box, *otherBox = box->parent->sub1;
if (otherBox == oldBox)
otherBox = box->parent->sub2;
if (currentBox->parent == box->parent)
currentBox = box->parent;
box = box->parent;
box->X = box->sub1->X;
box->Y = box->sub1->Y;
if (box->flags & BOX_HSPLIT)
box->H = box->sub1->H + box->sub2->H;
else
box->W = box->sub1->W + box->sub2->W;
box->flags &= ~BOX_HSPLIT;
// Move the other sub boxes contents up to this box.
box->sub1 = otherBox->sub1;
box->sub2 = otherBox->sub2;
if (box->sub1)
{
box->sub1->parent = box;
box->sub2->parent = box;
box->flags = otherBox->flags;
if (currentBox == box)
currentBox = box->sub1;
}
else
{
if (!box->parent)
box->flags &= ~BOX_BORDER;
box->split = 1.0;
}
otherBox->sub1 = NULL;
otherBox->sub2 = NULL;
// Safe to free the boxes now that we have all their contents.
freeBox(otherBox);
freeBox(oldBox);
}
// Otherwise it must be a single full screen box. Never delete that one, unless we are quitting.
// Start the recursive recalculation of all the sub boxes.
calcBoxes(box);
drawBoxes(box);
}
void cloneBox(struct _box *box, struct _box *sub)
{
sub->parent = box;
// Only a full screen box has no border.
sub->flags |= BOX_BORDER;
sub->view = xmalloc(sizeof(struct _view));
// TODO - After this is more stable, should check if the memcpy() is simpler than - xzalloc() then copy a few things manually.
// Might even be able to arrange the structure so we can memcpy just part of it, leaving the rest blank.
memcpy(sub->view, box->view, sizeof(struct _view));
sub->view->damage = NULL;
sub->view->data = NULL;
sub->view->output = NULL;
sub->view->box = sub;
if (box->view->prompt)
sub->view->prompt = strdup(box->view->prompt);
}
void splitBox(box *box, float split)
{
uint16_t size;
int otherBox = 0;
// First some sanity checks.
if (0.0 > split)
{
// TODO - put this in the status line, or just silently fail. Also, better message. lol
fprintf(stderr, "User is crazy.\n");
return;
}
else if (1.0 <= split) // User meant to unsplit, and it may already be split.
{
// Actually, this means that the OTHER sub box gets deleted.
if (box->parent)
{
if (box == box->parent->sub1)
deleteBox(box->parent->sub2->view);
else
deleteBox(box->parent->sub1->view);
}
return;
}
else if (0.0 < split) // This is the normal case, so do nothing.
{
}
else // User meant to delete this, zero split.
{
deleteBox(box->view);
return;
}
if (box->flags & BOX_HSPLIT)
size = box->H;
else
size = box->W;
if (6 > size) // Is there room for 2 borders for each sub box and one character of content each?
// TODO - also should check the contents minimum size.
// No need to check the no border case, that's only for full screen.
// People using terminals smaller than 6 characters get what they deserve.
{
// TODO - put this in the status line, or just silently fail.
fprintf(stderr, "Box is too small to split.\n");
return;
}
// Note that a split box is actually three boxes. The parent, which is not drawn, and the two subs, which are.
// Based on the assumption that there wont be lots of boxes, this keeps things simple.
// It's possible that the box has already been split, and this is called just to update the split.
box->split = split;
if (NULL == box->sub1) // If not split already, do so.
{
box->sub1 = xzalloc(sizeof(struct _box));
box->sub2 = xzalloc(sizeof(struct _box));
cloneBox(box, box->sub1);
cloneBox(box, box->sub2);
if (box->flags & BOX_HSPLIT)
{
// Split the boxes in the middle of the content.
box->sub2->view->offsetY += (box->H * box->split) - 2;
// Figure out which sub box the cursor will be in, then update the cursor in the other box.
if (box->sub1->view->cY < box->sub2->view->offsetY)
box->sub2->view->cY = box->sub2->view->offsetY;
else
{
box->sub1->view->cY = box->sub2->view->offsetY - 1;
otherBox = 1;
}
}
else
{
// Split the boxes in the middle of the content.
box->sub2->view->offsetX += (box->W * box->split) - 2;
// Figure out which sub box the cursor will be in, then update the cursor in the other box.
if (box->sub1->view->cX < box->sub2->view->offsetX)
box->sub2->view->cX = box->sub2->view->offsetX;
else
{
box->sub1->view->cX = box->sub2->view->offsetX - 1;
otherBox = 1;
}
}
}
if ((currentBox == box) && (box->sub1))
{
if (otherBox)
currentBox = box->sub2;
else
currentBox = box->sub1;
}
// Start the recursive recalculation of all the sub boxes.
calcBoxes(box);
drawBoxes(box);
}
// TODO - Might be better to just have a double linked list of boxes, and traverse that instead.
// Except that leaves a problem when deleting boxes, could end up with a blank space.
void switchBoxes(view *view)
{
box *box = view->box;
// The assumption here is that box == currentBox.
struct _box *oldBox = currentBox;
struct _box *thisBox = box;
int backingUp = 0;
// Depth first traversal.
while ((oldBox == currentBox) && (thisBox->parent))
{
if (thisBox == thisBox->parent->sub1)
{
if (backingUp && (thisBox->parent))
currentBox = thisBox->parent->sub2;
else if (thisBox->sub1)
currentBox = thisBox->sub1;
else
currentBox = thisBox->parent->sub2;
}
else if (thisBox == thisBox->parent->sub2)
{
thisBox = thisBox->parent;
backingUp = 1;
}
}
// If we have not found the next box to move to, move back to the beginning.
if (oldBox == currentBox)
currentBox = rootBox;
// If we ended up on a parent box, go to it's first sub.
while (currentBox->sub1)
currentBox = currentBox->sub1;
// Just redraw them all.
drawBoxes(rootBox);
}
// TODO - It might be better to do away with this bunch of single line functions
// and map script commands directly to lower functions.
// How to deal with the various argument needs?
// Might be where we can re use the toybox argument stuff.
void halveBoxHorizontally(view *view)
{
view->box->flags |= BOX_HSPLIT;
splitBox(view->box, 0.5);
}
void halveBoxVertically(view *view)
{
view->box->flags &= ~BOX_HSPLIT;
splitBox(view->box, 0.5);
}
void switchMode(view *view)
{
currentBox->view->mode++;
// Assumes that modes will always have a key mapping, which I think is a safe bet.
if (NULL == currentBox->view->content->context->modes[currentBox->view->mode].keys)
currentBox->view->mode = 0;
commandMode = currentBox->view->content->context->modes[currentBox->view->mode].flags & 1;
}
void leftChar(view *view)
{
moveCursorRelative(view, -1, 0, 0, 0);
}
void rightChar(view *view)
{
moveCursorRelative(view, 1, 0, 0, 0);
}
void upLine(view *view)
{
moveCursorRelative(view, 0, -1, 0, 0);
}
void downLine(view *view)
{
moveCursorRelative(view, 0, 1, 0, 0);
}
void upPage(view *view)
{
moveCursorRelative(view, 0, 0 - (view->H - 1), 0, 0 - (view->H - 1));
}
void downPage(view *view)
{
moveCursorRelative(view, 0, view->H - 1, 0, view->H - 1);
}
void endOfLine(view *view)
{
moveCursorAbsolute(view, strlen(view->prompt) + view->oW, view->cY, 0, 0);
}
void startOfLine(view *view)
{
// TODO - add the advanced editing "smart home".
moveCursorAbsolute(view, strlen(view->prompt), view->cY, 0, 0);
}
void splitLine(view *view)
{
// TODO - should move this into mooshLines().
addLine(view->content, view->line, &(view->line->line[view->iX]), 0);
view->line->line[view->iX] = '\0';
moveCursorAbsolute(view, 0, view->cY + 1, 0, 0);
if (view->box)
drawBox(view->box);
}
void deleteChar(view *view)
{
// TODO - should move this into mooshLines().
// If we are at the end of the line, then join this and the next line.
if (view->oW == view->cX)
{
// Only if there IS a next line.
if (&(view->content->lines) != view->line->next)
{
mooshStrings(view->line, view->line->next->line, view->iX, 1, !TT.overWriteMode);
view->line->next->line = NULL;
freeLine(view->content, view->line->next);
// TODO - should check if we are on the last page, then deal with scrolling.
if (view->box)
drawBox(view->box);
}
}
else
mooshStrings(view->line, NULL, view->iX, 1, !TT.overWriteMode);
}
void backSpaceChar(view *view)
{
if (moveCursorRelative(view, -1, 0, 0, 0))
deleteChar(view);
}
void saveContent(view *view)
{
saveFile(view->content);
}
void executeLine(view *view)
{
struct line *result = view->line;
// Don't bother doing much if there's nothing on this line.
if (result->line[0])
{
doCommand(currentBox->view, result->line);
// If we are not at the end of the history contents.
if (&(view->content->lines) != result->next)
{
struct line *line = view->content->lines.prev;
// Remove the line first.
result->next->prev = result->prev;
result->prev->next = result->next;
// Check if the last line is already blank, then remove it.
if ('\0' == line->line[0])
{
freeLine(view->content, line);
line = view->content->lines.prev;
}
// Then add it to the end.
result->next = line->next;
result->prev = line;
line->next->prev = result;
line->next = result;
view->cY = view->content->lines.length - 1;
}
moveCursorAbsolute(view, 0, view->content->lines.length, 0, 0);
// Make sure there is one blank line at the end.
if ('\0' != view->line->line[0])
{
endOfLine(view);
splitLine(view);
}
}
saveFile(view->content);
}
void quit(view *view)
{
TT.stillRunning = 0;
}
void nop(view *view)
{
// 'tis a nop, don't actually do anything.
}
static void lineChar(long extra, char *buffer)
{
struct _view *view = (struct _view *) extra; // Though we pretty much stomp on this straight away.
// Coz things might change out from under us, find the current view.
if (commandMode) view = commandLine;
else view = currentBox->view;
// TODO - Should check for tabs to, and insert them.
// Though better off having a function for that?
mooshStrings(view->line, buffer, view->iX, 0, !TT.overWriteMode);
view->oW = formatLine(view, view->line->line, &(view->output));
moveCursorRelative(view, strlen(buffer), 0, 0, 0);
updateLine(view);
}
static struct keyCommand * lineCommand(long extra, char *command)
{
struct _view *view = (struct _view *) extra; // Though we pretty much stomp on this straight away.
// Coz things might change out from under us, find the current view.
if (commandMode) view = commandLine;
else view = currentBox->view;
doCommand(view, command);
// This is using the currentBox instead of view, coz the command line keys are part of the box context now, not separate.
return currentBox->view->content->context->modes[currentBox->view->mode].keys;
}
char *termSize(long extra, int *params, int count)
{
struct _view *view = (struct _view *) extra; // Though we pretty much stomp on this straight away.
int r = params[0], c = params[1];
// The defaults are 1, which get ignored by the heuristic below.
// Check it's not an F3 key variation, coz some of them use the same CSI function code.
// This is a heuristic, we are checking against an unusable terminal size.
// TODO - Double check what the maximum F3 variations can be.
if ((2 == count) && (8 < r) && (8 < c))
{
// FIXME - The change is not being propogated to everything properly.
sizeViewToBox(rootBox, rootBox->X, rootBox->Y, c, r - 1);
calcBoxes(rootBox);
drawBoxes(rootBox);
// Move the cursor to where it is, to check it's not now outside the terminal window.
moveCursorAbsolute(rootBox->view, rootBox->view->cX, rootBox->view->cY, 0, 0);
// We have no idea which is the current view now.
if (commandMode) view = commandLine;
else view = currentBox->view;
updateLine(view);
}
return NULL;
}
struct CSI
{
char *code;
CSIhandler func;
};
struct CSI CSI_terminators[] =
{
{"R", termSize}, // Parameters are cursor line and column. Note this may be sent at other times, not just during terminal resize.
{NULL, NULL}
};
// Basically this is the main loop.
/* Unhandled complications -
Less and more have the "ZZ" command, but nothing else seems to have multi ordinary character commands.
Some editors have a shortcut command concept. The smallest unique first part of each command will match, as well as anything longer.
A further complication is if we are not implementing some commands that might change what is "shortest unique prefix".
*/
void editLine(long extra, void (*lineChar)(long extra, char *buffer), struct keyCommand * (*lineCommand)(long extra, char *command))
{
fd_set selectFds;
struct timespec timeout;
sigset_t signalMask;
// Get the initial command set.
struct keyCommand *ourKeys = lineCommand(extra, "");
char buffer[20], command[20], csFinal[8];
int csi = 0, csCount = 0, csIndex = 0, csParams[8], index = 0, pollcount = 1;
// TODO - multiline editLine is an advanced feature. Editing boxes just moves the editLine up and down.
// uint16_t h = 1;
// TODO - should check if it's at the top of the box, then grow it down instead of up if so.
buffer[0] = 0;
command[0] = 0;
sigemptyset(&signalMask);
sigaddset(&signalMask, SIGWINCH);
// TODO - OS buffered keys might be a problem, but we can't do the usual timestamp filter for now.
TT.stillRunning = 1;
while (TT.stillRunning)
{
int j, p;
char *found = NULL;
if (0 == index)
{
buffer[0] = 0;
csi = 0;
csCount = 0;
csIndex = 0;
}
// Apparently it's more portable to reset these each time.
FD_ZERO(&selectFds);
FD_SET(0, &selectFds);
timeout.tv_sec = 0; timeout.tv_nsec = 100000000; // One tenth of a second.
// TODO - A bit unstable at the moment, something makes it go into a horrid CPU eating edit line flicker mode sometimes. And / or vi mode can crash on exit (stack smash).
// This might be fixed now.
// We got a "terminal size changed" signal, ask the terminal how big it is now.
if (sigWinch)
{
// Send - save cursor position, down 999, right 999, request cursor position, restore cursor position.
printf("\x1B[s\x1B[999C\x1B[999B\x1B[6n\x1B[u");
fflush(stdout);
sigWinch = 0;
}
// TODO - Should only ask for a time out after we get an Escape.
// I wanted to use poll, but that would mean using ppoll, which is Linux only, and involves defining swear words to get it.
p = pselect(0 + 1, &selectFds, NULL, NULL, &timeout, &signalMask);
if (0 > p)
{
if (EINTR == errno)
continue;
perror_exit("poll");
}
if (0 == p) // A timeout, trigger a time event.
{
if ((1 == index) && ('\x1B' == buffer[0]))
{
// After a short delay to check, this is a real Escape key, not part of an escape sequence, so deal with it.
strcpy(command, "^[");
index = 0;
}
// TODO - Send a timer event to lineCommand(). This wont be a precise timed event, but don't think we need one.
}
if (FD_ISSET(0, &selectFds))
{
// I am assuming that we get the input atomically, each multibyte key fits neatly into one read.
// If that's not true (which is entirely likely), then we have to get complicated with circular buffers and stuff, or just one byte at a time.
j = read(0, &buffer[buffIndex], sizeof(buffer) - (buffIndex + 1));
if (j < 0) // An error happened.
{
// For now, just ignore errors.
fprintf(stderr, "input error on %d\n", p);
fflush(stderr);
}
else if (j == 0) // End of file.
{
TT.stillRunning = 0;
fprintf(stderr, "EOF\n");
for (j = 0; buffer[j + 1]; j++)
fprintf(stderr, "(%x), ", (int) buffer[j]);
fflush(stderr);
}
else
{
buffIndex += j;
if (sizeof(buffer) < (buffIndex + 1)) // Ran out of buffer.
{
fprintf(stderr, "Full buffer - %s -> %s\n", buffer, sequence);
for (j = 0; buffer[j + 1]; j++)
fprintf(stderr, "(%x) %c, ", (int) buffer[j], buffer[j]);
fflush(stderr);
buffIndex = 0;
}
else buffer[buffIndex] = 0;
}
}
// Check if it's a CSI before we check for the known key sequences.
if ('\x9B' == buffer[0])
csi = 1;
if (('\x1B' == buffer[0]) && ('[' == buffer[1]))
csi = 2;
if (('\xC2' == buffer[0]) && ('\x9B' == buffer[1]))
csi = 2;
if (2 == csi)
{
buffer[0] = '\x9B';
for (j = 1; buffer[j]; j++)
buffer[j] = buffer[j + 1];
index--;
csi = 1;
}
// Check for known key sequences.
// For a real timeout checked Esc, buffer is now empty, so this for loop wont find it anyway.
// While it's true we could avoid it by checking, the user already had to wait for a time out, and this loop wont take THAT long.
for (j = 0; keys[j].code; j++) // Search for multibyte keys and control keys.
{
if (strcmp(keys[j].code, buffer) == 0)
{
strcat(command, keys[j].name);
index = 0;
csi = 0;
break;
}
}
// Find out if it's a CSI sequence that's not in the known key sequences.
if (csi)
{
/* ECMA-048 section 5.2 defines this, and is unreadable.
General CSI format - CSI [private] n1 ; n2 [extra] final
private 0x3c to 0x3f "<=>?" if first byte is one of these, this is a private command, if it's one of the other n1 ones, it's not private.
n1 0x30 to 0x3f "01234567890:;<=>?" ASCII digits forming a "number"
0x3a [:] used for floats, not expecting any. Could also be used as some other sort of inter digit separator.
0x3b [;] separates the parameters
extra 0x20 to 0x2f [ !"#$%&'()*+,-./] Can be multiple, likely isn't.
final 0x40 to 0x7e "@A .. Z[\]^_`a .. z{|}~" it's private if 0x70 to 0x7e "p .. z{|}~"
Though the "private" ~ is used for key codes.
We also have SS3 "\x1BO" for other keys, but that's not a CSI.
C0 controls, DEL (0x7f), or high characters are undefined.
TODO So abort the current CSI and start from scratch.
*/
char *t;
csIndex = 1;
csFinal[0] = 0;
// Unspecified params default to a value that is command dependant.
// However, they will never be negative, so we can use -1 to flag a default value.
for (j = 0; j < (sizeof(csParams) / sizeof(*csParams)); j++)
csParams[j] = -1;
if ('M' == buffer[1])
{
// TODO - We have a mouse report, which is CSI M ..., where the rest is binary encoded, more or less. Not fitting into the CSI format.
}
else
{
// TODO - Using rindex here, coz index is a variable in this scope. Should rename index.
// Check for the private bit.
if (rindex("<=>?", buffer[1]))
{
csFinal[0] = buffer[1];
csFinal[1] = 0;
csIndex++;
}
// Decode parameters.
j = csIndex;
do
{
// So we know when we get to the end of parameter space.
t = rindex("01234567890:;<=>?", buffer[j + 1]);
// See if we passed a paremeter.
if ((';' == buffer[j]) || (!t))
{
// Only stomp on the ; if it's really the ;.
if (t)
buffer[j] = 0;
// Empty parameters are default parameters, so only deal with non defaults.
if (';' != buffer[csIndex] || (!t))
{
// TODO - Might be ":" in the number somewhere, but we are not expecting any in anything we do.
csParams[csCount] = atoi(&buffer[csIndex]);
}
csCount++;
csIndex = j + 1;
}
j++;
}
while (t);
// Get the final command sequence, and search for it.
strcat(csFinal, &buffer[csIndex]);
for (j = 0; CSI_terminators[j].code; j++)
{
if (strcmp(CSI_terminators[j].code, csFinal) == 0)
{
t = CSI_terminators[j].func(extra, csParams, csCount);
if (t)
strcpy(command, t);
break;
}
}
}
csi = 0;
// Wether or not it's a CSI we understand, it's been handled either here or in the key sequence scanning above.
index = 0;
}
// See if it's an ordinary key,
if ((1 == index) && isprint(buffer[0]))
{
// Here we want to run it through the command finder first, and only "insert" it if it's not a command.
for (j = 0; ourKeys[j].key; j++)
{
if (strcmp(ourKeys[j].key, buffer) == 0)
{
strcpy(command, buffer);
found = command;
break;
}
}
if (NULL == found)
{
// If there's an outstanding command, add this to the end of it.
if (command[0]) strcat(command, buffer);
else lineChar(extra, buffer);
}
index = 0;
}
if (command[0]) // Search for a bound key.
{
if (sizeof(command) < (strlen(command) + 1))
{
fprintf(stderr, "Full command buffer - %s \n", command);
fflush(stderr);
command[0] = 0;
}
if (NULL == found)
{
for (j = 0; ourKeys[j].key; j++)
{
if (strcmp(ourKeys[j].key, command) == 0)
{
found = ourKeys[j].command;
break;
}
}
}
if (found)
{
ourKeys = lineCommand(extra, found);
command[0] = 0;
}
}
}
}
// The default command to function mappings, with help text. Any editor that does not have it's own commands can use these for keystroke binding and such.
// Though most of the editors have their own variation. Maybe just use the joe one as default, it uses short names at least.
struct function simpleEditCommands[] =
{
{"backSpaceChar", "Back space last character.", 0, {backSpaceChar}},
{"deleteBox", "Delete a box.", 0, {deleteBox}},
{"deleteChar", "Delete current character.", 0, {deleteChar}},
{"downLine", "Move cursor down one line.", 0, {downLine}},
{"downPage", "Move cursor down one page.", 0, {downPage}},
{"endOfLine", "Go to end of line.", 0, {endOfLine}},
{"executeLine", "Execute a line as a script.", 0, {executeLine}},
{"leftChar", "Move cursor left one character.", 0, {leftChar}},
{"quit", "Quit the application.", 0, {quit}},
{"rightChar", "Move cursor right one character.", 0, {rightChar}},
{"save", "Save.", 0, {saveContent}},
{"splitH", "Split box in half horizontally.", 0, {halveBoxHorizontally}},
{"splitLine", "Split line at cursor.", 0, {splitLine}},
{"splitV", "Split box in half vertically.", 0, {halveBoxVertically}},
{"startOfLine", "Go to start of line.", 0, {startOfLine}},
{"switchBoxes", "Switch to another box.", 0, {switchBoxes}},
{"switchMode", "Switch between command and box.", 0, {switchMode}},
{"upLine", "Move cursor up one line.", 0, {upLine}},
{"upPage", "Move cursor up one page.", 0, {upPage}},
{NULL, NULL, 0, {NULL}}
};
// Construct a simple command line.
// The key to command mappings.
// TODO - Should not move off the ends of the line to the next / previous line.
struct keyCommand simpleCommandKeys[] =
{
{"BS", "backSpaceChar"},
{"Del", "deleteChar"},
{"Down", "downLine"},
{"End", "endOfLine"},
{"F10", "quit"},
{"Home", "startOfLine"},
{"Left", "leftChar"},
{"Return", "executeLine"},
{"Right", "rightChar"},
{"^[", "switchMode"},
{"Up", "upLine"},
{NULL, NULL}
};
// Construct a simple emacs editor.
// Mostly control keys, some meta keys.
// Ctrl-h and Ctrl-x have more keys in the commands. Some of those extra keys are commands by themselves. Up to "Ctrl-x 4 Ctrl-g" which apparently is identical to just Ctrl-g. shrugs
// Ctrl-h is backspace / del. Pffft.
// Meta key is either Alt-keystroke, Esc keystroke, or an actual Meta-keystroke (do they still exist?).
// TODO - Alt and Meta not supported yet, so using Esc.
// Windows commands.
// readline uses these same commands, and defaults to emacs keystrokes.
struct function simpleEmacsCommands[] =
{
{"delete-backward-char", "Back space last character.", 0, {backSpaceChar}},
{"delete-window", "Delete a box.", 0, {deleteBox}},
{"delete-char", "Delete current character.", 0, {deleteChar}},
{"next-line", "Move cursor down one line.", 0, {downLine}},
{"scroll-up", "Move cursor down one page.", 0, {downPage}},
{"end-of-line", "Go to end of line.", 0, {endOfLine}},
{"accept-line", "Execute a line as a script.", 0, {executeLine}}, // From readline, which uses emacs commands, coz mg at least does not seem to have this.
{"backward-char", "Move cursor left one character.", 0, {leftChar}},
{"save-buffers-kill-emacs", "Quit the application.", 0, {quit}}, // TODO - Does more than just quit.
{"forward-char", "Move cursor right one character.", 0, {rightChar}},
{"save-buffer", "Save.", 0, {saveContent}},
{"split-window-horizontally", "Split box in half horizontally.", 0, {halveBoxHorizontally}}, // TODO - Making this one up for now, mg does not have it.
{"newline", "Split line at cursor.", 0, {splitLine}},
{"split-window-vertically", "Split box in half vertically.", 0, {halveBoxVertically}},
{"beginning-of-line", "Go to start of line.", 0, {startOfLine}},
{"other-window", "Switch to another box.", 0, {switchBoxes}}, // There is also "previous-window" for going in the other direction, which we don't support yet.
{"execute-extended-command", "Switch between command and box.", 0, {switchMode}}, // Actually a one time invocation of the command line.
{"previous-line", "Move cursor up one line.", 0, {upLine}},
{"scroll-down", "Move cursor up one page.", 0, {upPage}},
{NULL, NULL, 0, {NULL}}
};
// The key to command mappings.
struct keyCommand simpleEmacsKeys[] =
{
{"Del", "delete-backward-char"},
{"^D", "delete-char"},
{"Down", "next-line"},
{"^N", "next-line"},
{"End", "end-of-line"},
{"^E", "end-of-line"},
{"^X^C", "save-buffers-kill-emacs"},
{"^X^S", "save-buffer"},
{"Home", "beginning-of-line"},
{"^A", "beginning-of-line"},
{"Left", "backward-char"},
{"^B", "backward-char"},
{"PgDn", "scroll-up"},
{"^V", "scroll-up"},
{"PgUp", "scroll-down"},
{"^[v", "scroll-down"}, // M-v
{"Return", "newline"},
{"Right", "forward-char"},
{"^F", "forward-char"},
{"^[x", "execute-extended-command"}, // M-x
{"^X2", "split-window-vertically"},
{"^X3", "split-window-horizontally"}, // TODO - Just making this up for now.
{"^XP", "other-window"},
{"^XP", "other-window"},
{"^X0", "delete-window"},
{"Up", "previous-line"},
{"^P", "previous-line"},
{NULL, NULL}
};
struct keyCommand simpleEmacsCommandKeys[] =
{
{"Del", "delete-backwards-char"},
{"^D", "delete-char"},
{"^D", "delete-char"},
{"Down", "next-line"},
{"^N", "next-line"},
{"End", "end-of-line"},
{"^E", "end-of-line"},
{"Home", "beginning-of-line"},
{"^A", "beginning-of-line"},
{"Left", "backward-char"},
{"^B", "backward-char"},
{"Up", "previous-line"},
{"^P", "previous-line"},
{"Return", "accept-line"},
{"^[x", "execute-extended-command"},
{NULL, NULL}
};
// An array of various modes.
struct mode simpleEmacsMode[] =
{
{simpleEmacsKeys, NULL, NULL, 0},
{simpleEmacsCommandKeys, NULL, NULL, 1},
{NULL, NULL, NULL}
};
// Put it all together into a simple editor context.
struct context simpleEmacs =
{
simpleEmacsCommands,
simpleEmacsMode,
NULL,
NULL,
NULL
};
// Construct a simple joe / wordstar editor, using joe is the reference, seems to be the popular Unix variant.
// Esc x starts up the command line.
// Has multi control key combos. Mostly Ctrl-K, Ctrl-[ (Esc), (Ctrl-B, Ctrl-Q in wordstar and delphi), but might be others.
// Can't find a single list of command mappings for joe, gotta search all over. sigh
// Even the command line keystroke I stumbled on (Esc x) is not documented.
// Note that you don't have to let go of the Ctrl key for the second keystroke, but you can.
// From http://joe-editor.sourceforge.net/list.html
// TODO - Some of these might be wrong. Just going by the inadequate joe docs for now.
struct function simpleJoeCommands[] =
{
{"backs", "Back space last character.", 0, {backSpaceChar}},
{"abort", "Delete a box.", 0, {deleteBox}},
{"delch", "Delete current character.", 0, {deleteChar}},
{"dnarw", "Move cursor down one line.", 0, {downLine}},
{"pgdn", "Move cursor down one page.", 0, {downPage}},
{"eol", "Go to end of line.", 0, {endOfLine}},
{"ltarw", "Move cursor left one character.", 0, {leftChar}},
{"killjoe", "Quit the application.", 0, {quit}},
{"rtarw", "Move cursor right one character.", 0, {rightChar}},
{"save", "Save.", 0, {saveContent}},
{"splitw", "Split box in half horizontally.", 0, {halveBoxHorizontally}},
{"open", "Split line at cursor.", 0, {splitLine}},
{"bol", "Go to start of line.", 0, {startOfLine}},
{"home", "Go to start of line.", 0, {startOfLine}},
{"nextw", "Switch to another box.", 0, {switchBoxes}}, // This is "next window", there's also "previous window" which we don't support yet.
{"execmd", "Switch between command and box.", 0, {switchMode}}, // Actually I think this just switches to the command mode, not back and forth. Or it might execute the actual command.
{"uparw", "Move cursor up one line.", 0, {upLine}},
{"pgup", "Move cursor up one page.", 0, {upPage}},
// Not an actual joe command.
{"executeLine", "Execute a line as a script.", 0, {executeLine}}, // Perhaps this should be execmd?
{NULL, NULL, 0, {NULL}}
};
struct keyCommand simpleJoeKeys[] =
{
{"BS", "backs"},
{"^D", "delch"},
{"Down", "dnarw"},
{"^N", "dnarw"},
{"^E", "eol"},
// {"F10", "killjoe"}, // "deleteBox" should do this if it's the last window.
{"^Kd", "save"},
{"^K^D" "save"},
{"^A", "bol"},
{"Left", "ltarw"},
{"^B", "ltarw"},
{"^V", "pgdn"}, // Actually half a page.
{"^U", "pgup"}, // Actually half a page.
{"Return", "open"},
{"Right", "rtarw"},
{"^F", "rtarw"},
{"^[x", "execmd"},
{"^[^X", "execmd"},
{"^Ko", "splitw"},
{"^K^O", "splitw"},
{"^Kn", "nextw"},
{"^K^N", "nextw"},
{"^Kx", "abort"}, // Should ask if it should save if it's been modified. A good generic thing to do anyway.
{"^K^X", "abort"},
{"Up", "uparw"},
{"^P", "uparw"},
{NULL, NULL}
};
struct keyCommand simpleJoeCommandKeys[] =
{
{"BS", "backs"},
{"^D", "delch"},
{"Down", "dnarw"},
{"^N", "dnarw"},
{"^E", "eol"},
{"^A", "bol"},
{"Left", "ltarw"},
{"^B", "ltarw"},
{"Right", "rtarw"},
{"^F", "rtarw"},
{"^[x", "execmd"},
{"^[^X", "execmd"},
{"Up", "uparw"},
{"^P", "uparw"},
{"Return", "executeLine"},
{NULL, NULL}
};
struct mode simpleJoeMode[] =
{
{simpleJoeKeys, NULL, NULL, 0},
{simpleJoeCommandKeys, NULL, NULL, 1},
{NULL, NULL, NULL, 0}
};
struct context simpleJoe =
{
simpleJoeCommands,
simpleJoeMode,
NULL,
NULL,
NULL
};
// Simple more and / or less.
// '/' and '?' for search command mode. I think they both have some ex commands with the usual : command mode starter.
// No cursor movement, just scrolling.
// TODO - Put content into read only mode.
// TODO - actually implement read only mode where up and down one line do actual scrolling instead of cursor movement.
// TODO - maybe I can support the ZZ command in one of two ways -
// Just have a Z command do the quit.
// Have the first Z go into a special mode, where anything other than a Z restores the original mode.
struct keyCommand simpleLessKeys[] =
{
{"Down", "downLine"},
{"j", "downLine"},
{"Return", "downLine"},
{"End", "endOfLine"},
{"q", "quit"},
{":q", "quit"}, // TODO - A vi ism, should do ex command stuff instead.
{"ZZ", "quit"}, // The infrastructure here does not support this style of command.
{"PgDn", "downPage"},
{"f", "downPage"},
{" ", "downPage"},
{"^F", "downPage"},
{"Left", "leftChar"},
{"Right", "rightChar"},
{"PgUp", "upPage"},
{"b", "upPage"},
{"^B", "upPage"},
{"Up", "upLine"},
{"k", "upLine"},
{NULL, NULL}
};
struct mode simpleLessMode[] =
{
{simpleLessKeys, NULL, NULL, 0},
{simpleCommandKeys, NULL, NULL, 1},
{NULL, NULL, NULL}
};
struct context simpleLess =
{
simpleEditCommands,
simpleLessMode,
NULL,
NULL,
NULL
};
struct keyCommand simpleMoreKeys[] =
{
{"j", "downLine"},
{"Return", "downLine"},
{"q", "quit"},
{":q", "quit"}, // See comments for "less".
{"ZZ", "quit"}, // See comments for "less".
{"f", "downPage"},
{" ", "downPage"},
{"^F", "downPage"},
{"b", "upPage"},
{"^B", "upPage"},
{"k", "upLine"},
{NULL, NULL}
};
struct mode simpleMoreMode[] =
{
{simpleMoreKeys, NULL, NULL, 0},
{simpleCommandKeys, NULL, NULL, 1},
{NULL, NULL, NULL}
};
struct context simpleMore =
{
simpleEditCommands,
simpleMoreMode,
NULL,
NULL,
NULL
};
// Construct a simple mcedit / cool edit editor.
struct keyCommand simpleMceditKeys[] =
{
{"BS", "backSpaceChar"},
{"Del", "deleteChar"},
{"Down", "downLine"},
{"End", "endOfLine"},
{"F10", "quit"},
{"^[0", "quit"},
{"F2", "save"},
{"^[2", "save"},
{"Home", "startOfLine"},
{"Left", "leftChar"},
{"PgDn", "downPage"},
{"PgUp", "upPage"},
{"Return", "splitLine"},
{"Right", "rightChar"},
{"Shift F2", "switchMode"}, // MC doesn't have a command mode.
{"^[:", "switchMode"}, // Sorta vi like, and coz tmux is screwing with the shift function keys somehow.
{"^[|", "splitV"}, // MC doesn't have a split window concept, so make these up to match tmux more or less.
{"^[-", "splitH"},
{"^[o", "switchBoxes"},
{"^[x", "deleteBox"},
{"Up", "upLine"},
{NULL, NULL}
};
struct mode simpleMceditMode[] =
{
{simpleMceditKeys, NULL, NULL, 0},
{simpleCommandKeys, NULL, NULL, 1},
{NULL, NULL, NULL}
};
struct context simpleMcedit =
{
simpleEditCommands,
simpleMceditMode,
NULL,
NULL,
NULL
};
// Simple nano editor.
// Has key to function bindings, but no command line mode. Has "enter parameter on this line" mode for some commands.
// Control and meta keys, only singles, unlike emacs and joe.
// Can have multiple buffers, but no windows. Think I can skip that for simple editor.
struct function simpleNanoCommands[] =
{
{"backSpaceChar", "Back space last character.", 0, {backSpaceChar}},
{"delete", "Delete current character.", 0, {deleteChar}},
{"down", "Move cursor down one line.", 0, {downLine}},
{"downPage", "Move cursor down one page.", 0, {downPage}},
{"end", "Go to end of line.", 0, {endOfLine}},
{"left", "Move cursor left one character.", 0, {leftChar}},
{"exit", "Quit the application.", 0, {quit}},
{"right", "Move cursor right one character.", 0, {rightChar}},
{"writeout", "Save.", 0, {saveContent}},
{"enter", "Split line at cursor.", 0, {splitLine}},
{"home", "Go to start of line.", 0, {startOfLine}},
{"up", "Move cursor up one line.", 0, {upLine}},
{"upPage", "Move cursor up one page.", 0, {upPage}},
{NULL, NULL, 0, {NULL}}
};
// Hmm, back space, page up, and page down don't seem to have bindable commands according to the web page, but they are bound to keys anyway.
struct keyCommand simpleNanoKeys[] =
{
// TODO - Delete key is ^H dammit. Find the alternate Esc sequence for Del.
// {"^H", "backSpaceChar"}, // ?
{"BS", "backSpaceChar"},
{"^D", "delete"},
{"Del", "delete"},
{"^N", "down"},
{"Down", "down"},
{"^E", "end"},
{"End", "end"},
{"^X", "exit"},
{"F2", "quit"},
{"^O", "writeout"},
{"F3", "writeout"},
{"^A", "home"},
{"Home", "home"},
{"^B", "left"},
{"Left", "left"},
{"^V", "downPage"}, // ?
{"PgDn", "downPage"},
{"^Y", "upPage"}, // ?
{"PgUp", "upPage"},
{"Return", "enter"}, // TODO - Not sure if this is correct.
{"^F", "right"},
{"Right", "right"},
{"^P", "up"},
{"Up", "up"},
{NULL, NULL}
};
struct mode simpleNanoMode[] =
{
{simpleNanoKeys, NULL, NULL, 0},
{NULL, NULL, NULL}
};
struct context simpleNano =
{
simpleNanoCommands,
simpleNanoMode,
NULL,
NULL,
NULL
};
// Construct a simple vi editor.
// Only vi is not so simple. lol
// The "command line" modes are /, ?, :, and !,
// / is regex search.
// ? is regex search backwards.
// : is ex command mode.
// ! is replace text with output from shell command mode.
// Arrow keys do the right thing in "normal" mode, but not in insert mode.
// "i" goes into insert mode, "Esc" (or Ctrl-[ or Ctrl-C) gets you out. So much for "you can do it all touch typing on the home row". Pffft
// Ah, the Esc key WAS a lot closer to the home row (where Tab usually is now) on the original keyboard vi was designed for, ADM3A.
// Which is also the keyboard with the arrow keys marked on h, j, k, and l keys.
// Did I mention that vi is just a horrid historic relic that should have died long ago?
// Emacs looks to have the same problem, originally designed for an ancient keyboard that is nothing like what people actually use these days.
// "h", "j", "k", "l" move cursor, which is just random keys for dvorak users.
// ":" goes into ex command mode.
// ":q" deletes current window in vim.
// ":qa!" goes into ex mode and does some sort of quit command.
// The 'q' is short for quit, the ! is an optional argument to quit. No idea yet what the a is for, all windows?
// Del or "x" to delete a character. Del in insert mode.
// "X" to backspace. BS or Ctrl-H to backspace in insert mode.
// NOTE - Backspace in normal mode just moves left.
// Tab or Ctrl-I to insert a tab in insert mode.
// Return in normal mode goes to the start of the next line, or splits the line in insert mode.
// ":help" opens a window with help text.
// Vim window commands.
// Vi needs extra variables and functions.
static int viTempExMode;
void viMode(view *view)
{
currentBox->view->mode = 0;
commandMode = 0;
viTempExMode = 0;
}
void viInsertMode(view *view)
{
currentBox->view->mode = 1;
commandMode = 0;
}
void viExMode(view *view)
{
currentBox->view->mode = 2;
commandMode = 1;
// TODO - Should change this based on the event, : or Q.
viTempExMode = 1;
commandLine->prompt = xrealloc(commandLine->prompt, 2);
strcpy(commandLine->prompt, ":");
}
void viBackSpaceChar(view *view)
{
if ((2 == currentBox->view->mode) && (0 == view->cX) && viTempExMode)
viMode(view);
else
backSpaceChar(view);
}
void viStartOfNextLine(view *view)
{
startOfLine(view);
downLine(view);
}
// TODO - ex uses "shortest unique string" to match commands, should implement that, and do it for the other contexts to.
struct function simpleViCommands[] =
{
// These are actual ex commands.
{"insert", "Switch to insert mode.", 0, {viInsertMode}},
{"quit", "Quit the application.", 0, {quit}},
{"visual", "Switch to visual mode.", 0, {viMode}},
{"write", "Save.", 0, {saveContent}},
// These are not ex commands.
{"backSpaceChar", "Back space last character.", 0, {viBackSpaceChar}},
{"deleteBox", "Delete a box.", 0, {deleteBox}},
{"deleteChar", "Delete current character.", 0, {deleteChar}},
{"downLine", "Move cursor down one line.", 0, {downLine}},
{"downPage", "Move cursor down one page.", 0, {downPage}},
{"endOfLine", "Go to end of line.", 0, {endOfLine}},
{"executeLine", "Execute a line as a script.", 0, {executeLine}},
{"exMode", "Switch to ex mode.", 0, {viExMode}},
{"leftChar", "Move cursor left one character.", 0, {leftChar}},
{"rightChar", "Move cursor right one character.", 0, {rightChar}},
{"splitH", "Split box in half horizontally.", 0, {halveBoxHorizontally}},
{"splitLine", "Split line at cursor.", 0, {splitLine}},
{"splitV", "Split box in half vertically.", 0, {halveBoxVertically}},
{"startOfLine", "Go to start of line.", 0, {startOfLine}},
{"startOfNLine", "Go to start of next line.", 0, {viStartOfNextLine}},
{"switchBoxes", "Switch to another box.", 0, {switchBoxes}},
{"upLine", "Move cursor up one line.", 0, {upLine}},
{"upPage", "Move cursor up one page.", 0, {upPage}},
{NULL, NULL, 0, {NULL}}
};
struct keyCommand simpleViNormalKeys[] =
{
{"BS", "leftChar"},
{"X", "backSpaceChar"},
{"Del", "deleteChar"},
{"x", "deleteChar"},
{"Down", "downLine"},
{"j", "downLine"},
{"End", "endOfLine"},
{"Home", "startOfLine"},
{"Left", "leftChar"},
{"h", "leftChar"},
{"PgDn", "downPage"},
{"^F", "downPage"},
{"PgUp", "upPage"},
{"^B", "upPage"},
{"Return", "startOfNextLine"},
{"Right", "rightChar"},
{"l", "rightChar"},
{"i", "insert"},
{":", "exMode"}, // This is the temporary ex mode that you can backspace out of. Or any command backs you out.
{"Q", "exMode"}, // This is the ex mode you need to do the "visual" command to get out of.
{"^Wv", "splitV"},
{"^W^V", "splitV"},
{"^Ws", "splitH"},
{"^WS", "splitH"},
{"^W^S", "splitH"},
{"^Ww", "switchBoxes"},
{"^W^W", "switchBoxes"},
{"^Wq", "deleteBox"},
{"^W^Q", "deleteBox"},
{"Up", "upLine"},
{"k", "upLine"},
{NULL, NULL}
};
struct keyCommand simpleViInsertKeys[] =
{
{"BS", "backSpaceChar"},
{"Del", "deleteChar"},
{"Return", "splitLine"},
{"^[", "visual"},
{"^C", "visual"},
{NULL, NULL}
};
struct keyCommand simpleExKeys[] =
{
{"BS", "backSpaceChar"},
{"Del", "deleteChar"},
{"Down", "downLine"},
{"End", "endOfLine"},
{"Home", "startOfLine"},
{"Left", "leftChar"},
{"Return", "executeLine"},
{"Right", "rightChar"},
{"^[", "visual"},
{"Up", "upLine"},
{NULL, NULL}
};
struct mode simpleViMode[] =
{
{simpleViNormalKeys, NULL, NULL, 0},
{simpleViInsertKeys, NULL, NULL, 0},
{simpleExKeys, NULL, NULL, 1},
{NULL, NULL, NULL}
};
struct context simpleVi =
{
simpleViCommands,
simpleViMode,
NULL,
NULL,
NULL
};
// TODO - simple sed editor? May be out of scope for "simple", so leave it until later?
// Probably entirely useless for "simple".
// TODO - have any unrecognised escape key sequence start up a new box (split one) to show the "show keys" content.
// That just adds each "Key is X" to the end of the content, and allows scrolling, as well as switching between other boxes.
static void handleSignals(int signo)
{
sigWinch = 1;
}
void boxes_main(void)
{
struct context *context = &simpleMcedit; // The default is mcedit, coz that's what I use.
struct termios termio, oldtermio;
char *prompt = "Enter a command : ";
unsigned W = 80, H = 24;
struct sigaction sigAction, oldSigActions;
// For testing purposes, figure out which context we use. When this gets real, the toybox multiplexer will sort this out for us instead.
if (toys.optflags & FLAG_m)
{
if (strcmp(TT.mode, "emacs") == 0)
context = &simpleEmacs;
else if (strcmp(TT.mode, "joe") == 0)
context = &simpleJoe;
else if (strcmp(TT.mode, "less") == 0)
context = &simpleLess;
else if (strcmp(TT.mode, "mcedit") == 0)
context = &simpleMcedit;
else if (strcmp(TT.mode, "more") == 0)
context = &simpleMore;
else if (strcmp(TT.mode, "nano") == 0)
context = &simpleNano;
else if (strcmp(TT.mode, "vi") == 0)
context = &simpleVi;
}
// TODO - Should do an isatty() here, though not sure about the usefullness of driving this from a script or redirected input, since it's supposed to be a UI for terminals.
// It would STILL need the terminal size for output though. Perhaps just bitch and abort if it's not a tty?
// On the other hand, sed don't need no stinkin' UI. And things like more or less should be usable on the end of a pipe.
// Grab the old terminal settings and save it.
tcgetattr(0, &oldtermio);
tcflush(0, TCIFLUSH);
termio = oldtermio;
// Mould the terminal to our will.
/*
IUCLC (not in POSIX) Map uppercase characters to lowercase on input.
IXON Enable XON/XOFF flow control on output.
IXOFF Enable XON/XOFF flow control on input.
IXANY (not in POSIX.1; XSI) Enable any character to restart output.
ECHO Echo input characters.
ECHOE If ICANON is also set, the ERASE character erases the preceding input character, and WERASE erases the preceding word.
ECHOK If ICANON is also set, the KILL character erases the current line.
ECHONL If ICANON is also set, echo the NL character even if ECHO is not set.
TOSTOP Send the SIGTTOU signal to the process group of a background process which tries to write to its controlling terminal.
ICANON Enable canonical mode. This enables the special characters EOF, EOL, EOL2, ERASE, KILL, LNEXT, REPRINT, STATUS, and WERASE, and buffers by lines.
VTIME Timeout in deciseconds for non-canonical read.
VMIN Minimum number of characters for non-canonical read.
raw mode turning off ICANON, IEXTEN, and ISIG kills most special key processing.
termio.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IXON);
termio.c_oflag &= ~OPOST;
termio.c_lflag &= ~(ECHO | ECHONL | ICANON | ISIG | IEXTEN);
termio.c_cflag &= ~(CSIZE | PARENB);
termio.c_cflag |= CS8;
IGNBRK ignore BREAK
BRKINT complicated, bet in this context, sends BREAK as '\x00'
PARMRK characters with parity or frame erors are sent as '\x00'
ISTRIP strip 8th byte
INLCR translate LF to CR in input
IGLCR ignore CR
OPOST enable implementation defined output processing
ISIG generate signals on INTR (SIGINT on ^C), QUIT (SIGQUIT on ^\\), SUSP (SIGTSTP on ^Z), DSUSP (SIGTSTP on ^Y)
IEXTEN enable implementation defined input processing, turns on some key -> signal -tuff
CSIZE mask for character sizes, so in this case, we mask them all out
PARENB enable parity
CS8 8 bit characters
VEOF "sends" EOF on ^D, ICANON turns that on.
VSTART restart output on ^Q, IXON turns that on.
VSTATUS display status info and sends SIGINFO (STATUS) on ^T. Not in POSIX, not supported in Linux. ICANON turns that on.
VSTOP stop output on ^S, IXON turns that on.
*/
termio.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IUCLC | IXON | IXOFF | IXANY);
termio.c_oflag &= ~OPOST;
termio.c_lflag &= ~(ECHO | ECHOE | ECHOK | ECHONL | TOSTOP | ICANON | ISIG | IEXTEN);
termio.c_cflag &= ~(CSIZE | PARENB);
termio.c_cflag |= CS8;
termio.c_cc[VTIME]=0; // deciseconds.
termio.c_cc[VMIN]=1;
tcsetattr(0, TCSANOW, &termio);
// Terminals send the SIGWINCH signal when they resize.
memset(&sigAction, 0, sizeof(sigAction));
sigAction.sa_handler = handleSignals;
sigAction.sa_flags = SA_RESTART;// Useless if we are using poll.
if (sigaction(SIGWINCH, &sigAction, &oldSigActions)) perror_exit("can't set signal handler SIGWINCH");
terminal_size(&W, &H);
if (toys.optflags & FLAG_w)
W = TT.w;
if (toys.optflags & FLAG_h)
H = TT.h;
// Create the main box. Right now the system needs one for wrapping around while switching. The H - 1 bit is to leave room for our example command line.
rootBox = addBox("root", context, toys.optargs[0], 0, 0, W, H - 1);
currentBox = rootBox;
// Create the command line view, sharing the same context as the root. It will differentiate based on the view mode of the current box.
// Also load the command line history as it's file.
// TODO - different contexts will have different history files, though what to do about ones with no history, and ones with different histories for different modes?
commandLine = addView("command", rootBox->view->content->context, ".boxes.history", 0, H, W, 1);
// Add a prompt to it.
commandLine->prompt = xrealloc(commandLine->prompt, strlen(prompt) + 1);
strcpy(commandLine->prompt, prompt);
// Move to the end of the history.
moveCursorAbsolute(commandLine, 0, commandLine->content->lines.length, 0, 0);
// All the mouse tracking methods suck one way or another. sigh
// http://rtfm.etla.org/xterm/ctlseq.html documents xterm stuff, near the bottom is the mouse stuff.
// http://leonerds-code.blogspot.co.uk/2012/04/wide-mouse-support-in-libvterm.html is helpful.
// Enable mouse (VT200 normal tracking mode, UTF8 encoding). The limit is 2015. Seems to only be in later xterms.
// printf("\x1B[?1005h");
// Enable mouse (VT340 locator reporting mode). In theory has no limit. Wont actually work though.
// On the other hand, only allows for four buttons, so only half a mouse wheel.
// Responds with "\1B[e;p;r;c;p&w" where e is event type, p is a bitmap of buttons pressed, r and c are the mouse coords in decimal, and p is the "page number".
// printf("\x1B[1;2'z\x1B[1;3'{");
// Enable mouse (VT200 normal tracking mode). Has a limit of 256 - 32 rows and columns. An xterm exclusive I think, but works in roxterm at least. No wheel reports.
// Responds with "\x1B[Mbxy" where x and y are the mouse coords, and b is bit encoded buttons and modifiers - 0=MB1 pressed, 1=MB2 pressed, 2=MB3 pressed, 3=release, 4=Shift, 8=Meta, 16=Control
printf("\x1B[?1000h");
fflush(stdout);
calcBoxes(currentBox);
drawBoxes(currentBox);
// Do the first cursor update.
updateLine(currentBox->view);
// Run the main loop.
editLine((long) currentBox->view, lineChar, lineCommand);
// TODO - Should remember to turn off mouse reporting when we leave.
sigaction(SIGWINCH, &oldSigActions, NULL);
// Restore the old terminal settings.
tcsetattr(0, TCSANOW, &oldtermio);
puts("\n");
fflush(stdout);
}
|