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
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
|
;;; kotl-mode.el --- Major mode for editing koutlines and associated commands -*- lexical-binding:t -*-
;;
;; Author: Bob Weiner
;;
;; Orig-Date: 6/30/93
;;
;; Copyright (C) 1993-2017 Free Software Foundation, Inc.
;; See the "../HY-COPY" file for license information.
;;
;; This file is part of GNU Hyperbole.
;;; Commentary:
;;; Code:
;;; ************************************************************************
;;; Other required Lisp Libraries
;;; ************************************************************************
(eval-and-compile (mapc #'require '(delsel hsettings hmail kfile kvspec kcell)))
(declare-function outline-invisible-in-p "hyperbole")
;;; ************************************************************************
;;; Public variables
;;; ************************************************************************
(defvar kotl-mode-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map
(if (boundp 'indented-text-mode-map)
indented-text-mode-map
text-mode-map))
;; Ensure mouse wheel scrolling leaves point in a valid Koutline position
(if (and (boundp 'mwheel-scroll-up-function)
(eq (symbol-value 'mwheel-scroll-up-function) 'scroll-up))
(setq mwheel-scroll-up-function 'kotl-mode:scroll-up
mwheel-scroll-down-function 'kotl-mode:scroll-down))
;; Overload edit keys to deal with structure and labels.
(dolist (cmd
'(
back-to-indentation
backward-char
backward-delete-char
backward-delete-char-untabify
backward-kill-word
backward-or-forward-delete-char
backward-para
backward-paragraph
backward-sentence
backward-word
beginning-of-buffer
beginning-of-line
completion-kill-region
copy-region-as-kill
copy-to-register
delete-blank-lines
delete-backward-char
delete-char
delete-forward-char
delete-horizontal-space
delete-indentation
end-of-buffer
end-of-line
fill-paragraph
fill-paragraph-or-region
;; cursor keys
fkey-backward-char
fkey-forward-char
fkey-next-line
fkey-previous-line
backward-char-command
forward-char-command
;;
forward-char
forward-word
forward-para
forward-paragraph
forward-sentence
just-one-space
kill-word
kill-line
kill-region
kill-ring-save
kill-sentence
left-char
mark-paragraph
mark-whole-buffer
move-beginning-of-line
move-end-of-line
newline
newline-and-indent
next-line
open-line
previous-line
right-char
scroll-down
scroll-up
scroll-down-command
scroll-up-command
set-fill-prefix
transpose-chars
transpose-lines
transpose-paragraphs
transpose-sentences
transpose-words
yank
yank-pop
zap-to-char
))
(let ((local-cmd (intern-soft
(concat "kotl-mode:" (symbol-name cmd)))))
;; Only bind key locally if kotl-mode local-cmd has already
;; been defined and cmd is a valid command.
(if (and local-cmd (fboundp cmd))
(progn
;; Make local-cmd have the same property list as cmd,
;; e.g. so pending-delete property is the same.
(setplist local-cmd (symbol-plist cmd))
(if (fboundp 'command-remapping)
(define-key map (vector 'remap cmd) local-cmd)
(substitute-key-definition
cmd local-cmd map global-map))))))
;; kotl-mode keys
(define-key map "\C-c@" 'kotl-mode:mail-tree)
(define-key map "\C-c+" 'kotl-mode:append-cell)
(define-key map "\C-c," 'kotl-mode:beginning-of-cell)
(define-key map "\C-c." 'kotl-mode:end-of-cell)
(define-key map "\C-c<" 'kotl-mode:first-sibling)
(define-key map "\C-c>" 'kotl-mode:last-sibling)
(define-key map "\C-c^" 'kotl-mode:beginning-of-tree)
(define-key map "\C-c$" 'kotl-mode:end-of-tree)
(define-key map "\C-ca" 'kotl-mode:add-child)
(define-key map "\C-c\C-a" 'kotl-mode:show-all)
(define-key map "\C-cb" 'kvspec:toggle-blank-lines)
(define-key map "\C-c\C-b" 'kotl-mode:backward-cell)
(define-key map "\C-cc" 'kotl-mode:copy-after)
(define-key map "\C-c\C-c" 'kotl-mode:copy-before)
(define-key map "\C-c\M-c" 'kotl-mode:copy-to-buffer)
(define-key map "\C-cd" 'kotl-mode:down-level)
(define-key map "\C-c\C-d" 'kotl-mode:down-level)
(define-key map "\C-ce" 'kotl-mode:exchange-cells)
(define-key map "\C-c\C-f" 'kotl-mode:forward-cell)
(define-key map "\C-cg" 'kotl-mode:goto-cell)
(define-key map "\C-ch" 'kotl-mode:cell-help)
(define-key map "\C-c\C-h" 'kotl-mode:hide-tree)
;; Since the next key binds M-BS, it may already have a local binding,
;; in which case we don't want to bind it here.
(if (featurep 'xemacs)
(unless (lookup-key map '[(meta backspace)])
(define-key map '[(meta backspace)] 'kotl-mode:hide-subtree))
;; Do this under GNU Emacs only or will overwrite M-BS binding above.
(unless (lookup-key map "\M-\C-h")
(define-key map "\M-\C-h" 'kotl-mode:hide-subtree)))
;; Override this global binding for set-selective-display with a similar
;; function appropriate for kotl-mode.
(define-key map "\C-x$" 'kotl-mode:hide-sublevels)
(define-key map "\C-i" 'kotl-mode:tab-command) ;; TAB
(define-key map [backtab] 'kotl-mode:untab-command) ;; Shift-TAB
(define-key map "\M-\C-i" 'kotl-mode:untab-command) ;; M-TAB
(define-key map "\C-c\C-i" 'kotl-mode:set-or-remove-cell-attribute)
(define-key map "\C-j" 'kotl-mode:add-cell)
(define-key map "\M-j" 'kotl-mode:fill-paragraph)
(define-key map "\C-c\M-j" 'kotl-mode:fill-cell)
(define-key map "\M-\C-j" 'kotl-mode:fill-tree)
(define-key map "\C-c\C-k" 'kotl-mode:kill-tree)
(define-key map "\C-ck" 'kotl-mode:kill-contents)
;; Force an override of the global {C-x i} insert-file binding
(define-key map "\C-xi" 'kimport:insert-file)
;; Force an override of the global {C-x r i} insert-register binding
(define-key map "\C-xri" 'kimport:insert-register)
(define-key map "\C-ck" 'kotl-mode:kill-contents)
(define-key map "\C-cl" 'klink:create)
(define-key map "\C-c\C-l" 'kview:set-label-type)
(define-key map "\C-c\M-l" 'kview:set-label-separator)
(define-key map "\C-m" 'kotl-mode:newline)
(define-key map "\C-cm" 'kotl-mode:move-after)
(define-key map "\C-c\C-m" 'kotl-mode:move-before)
(define-key map "\C-c\C-n" 'kotl-mode:next-cell)
(define-key map "\C-c\C-o" 'kotl-mode:overview)
(define-key map "\C-c\C-p" 'kotl-mode:previous-cell)
(define-key map "\C-cp" 'kotl-mode:add-parent)
(if (memq (global-key-binding "\M-q") '(fill-paragraph
fill-paragraph-or-region))
(progn
(define-key map "\C-c\M-q" 'kotl-mode:fill-cell)
(define-key map "\M-\C-q" 'kotl-mode:fill-tree)))
(define-key map "\C-cs" 'kotl-mode:split-cell)
(define-key map "\C-c\C-s" 'kotl-mode:show-tree)
(define-key map "\C-c\C-\\" 'kotl-mode:show-tree)
(define-key map "\M-s" 'kotl-mode:center-line)
(define-key map "\M-S" 'kotl-mode:center-paragraph)
(define-key map "\C-ct" 'kotl-mode:transpose-cells)
(define-key map "\C-c\C-t" 'kotl-mode:top-cells)
(define-key map "\C-cu" 'kotl-mode:up-level)
(define-key map "\C-c\C-u" 'kotl-mode:up-level)
(define-key map "\C-c\C-v" 'kvspec:activate)
(define-key map "\C-x\C-w" 'kfile:write)
map)
"Keymap containing koutliner editing and viewing commands.")
(defcustom kotl-mode:shrink-region-flag nil
"*If non-nil, Koutliner commands automatically shrink the region to within the visible bounds of a single cell before editing it.
The region then falls within the first visible cell that was part of the
region or that followed it. Default value is nil."
:type 'boolean
:group 'hyperbole-koutliner)
(defcustom kotl-mode:refill-flag nil
"*Automatically refill cells during move, copy, promotion and demotion operations when non-nil.
Default value is nil. Cells with a `no-fill' attribute are never refilled
during such operations, regardless of the value of this flag."
:type 'boolean
:group 'hyperbole-koutliner)
(defcustom kotl-mode:tab-flag nil
"*Non-nil means {\\[kotl-mode:tab-command]} inserts a literal tab character and {\\[kotl-mode:untab-command]} deletes backward.
Nil means {\\[kotl-mode:tab-command]} demotes the current tree and
{\\[kotl-mode:untab-command]} promotes the tree. The default is nil."
:type 'boolean
:group 'hyperbole-koutliner)
(defcustom kotl-mode:indent-tabs-mode t
"*Non-nil means {\\[kotl-mode:tab-command]} may insert literal tab characters rather than space characters when `kotl-mode:tab-flag' is non-nil.
Default value is t. The value of this variable is local to each Koutline buffer."
:type 'boolean
:group 'hyperbole-koutliner)
;; Define these newer Emacs variables if Emacs has not already done so.
(defvar yank-window-start nil)
(defvar yank-undo-function nil
"If non-nil, the function used by `yank-pop' to delete the last stretch of yanked text.
Function is called with two parameters, START and END corresponding to
the value of the mark and point; it is guaranteed that START <= END.
Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
;;; ************************************************************************
;;; Public functions
;;; ************************************************************************
(defvar kotl-previous-mode)
;;;###autoload
(defun kotl-mode ()
"The major mode used to edit and view koutlines.
It provides the following keys:
\\{kotl-mode-map}"
(interactive)
;; FIXME: Use define-derived-mode (but before we can do that, we have to get
;; rid of this kotl-previous-mode).
(let ((prevmode (if (bound-and-true-p 'kotl-previous-mode)
kotl-previous-mode
major-mode)))
(kill-all-local-variables) ;FIXME: Derive from text-mode instead?
(setq-local kotl-previous-mode prevmode))
(use-local-map kotl-mode-map)
(set-syntax-table text-mode-syntax-table)
;; Turn off filladapt minor mode if on, so that it does not interfere with
;; the filling code in "kfill.el".
(and (bound-and-true-p 'filladapt-mode)
(fboundp 'filladapt-mode) (filladapt-mode 0))
;; Ensure that outline structure data is saved when save-buffer is called
;; from save-some-buffers, {C-x s}.
(add-hook (if (featurep 'xemacs)
'local-write-file-hooks
'write-file-functions)
#'kotl-mode:update-buffer nil t)
(mapc #'make-local-variable
'(indent-line-function indent-region-function
outline-isearch-open-invisible-function
line-move-ignore-invisible minor-mode-alist
selective-display-ellipses
paragraph-separate paragraph-start))
;; Remove indication that buffer is narrowed.
(setq mode-line-format (copy-sequence mode-line-format)
;; FIXME: mode-line-format is a sequence, not a set!
mode-line-format (set:remove "%n" mode-line-format))
;;
(if (fboundp 'add-to-invisibility-spec)
(add-to-invisibility-spec '(outline . t)))
(setq indent-line-function #'kotl-mode:indent-line
indent-region-function #'kotl-mode:indent-region
outline-isearch-open-invisible-function #'kotl-mode:isearch-open-invisible
line-move-ignore-invisible 'keep-column
local-abbrev-table text-mode-abbrev-table
;; These par* settings must be anchored to the bol since
;; kfill.el and `kotl-mode:fill-paragraph' use them in regexp
;; searches.
paragraph-separate "^[ \t]*$\\|^\^L"
paragraph-start "^[ \t]*$\\|^\^L"
selective-display-ellipses t
track-eol t)
;;
;; This major-mode setting must come after the local variable settings but
;; before the koutline is formatted.
(setq major-mode 'kotl-mode
mode-name "Kotl"
;; Used when indenting cells.
indent-tabs-mode nil)
;; Used when indenting lines within cells.
(make-local-variable 'kotl-mode:indent-tabs-mode)
(setq auto-fill-function #'kfill:do-auto-fill)
;; If buffer has not yet been formatted for editing, format it.
(let (version)
(cond
;; Koutline file that has been loaded and formatted for editing.
((kview:is-p kview)
;; The buffer might have been widened for inspection, so narrow to cells
;; only.
(kfile:narrow-to-kcells))
;; Koutline file that has been loaded but not yet formatted for editing.
((setq version (kfile:is-p))
(kfile:read
(current-buffer)
(and buffer-file-name (file-exists-p buffer-file-name))
version)
(kvspec:activate))
;; New koutline buffer or a foreign text buffer that must be converted to
;; koutline format.
(t
(kfile:create (current-buffer))
(kvspec:activate))))
;; We have been converting a buffer from a foreign format to a koutline.
;; Now that it is converted, ensure that `kotl-previous-mode' is set to
;; koutline now.
(setq kotl-previous-mode 'kotl-mode)
(add-hook 'change-major-mode-hook #'kotl-mode:show-all nil t)
;; Always run the mode-hook last.
(run-mode-hooks 'kotl-mode-hook))
;;;###autoload
(defun kotl-mode:example ()
"Display the Koutliner example file for demonstration use by a user."
(interactive)
(let* ((example "EXAMPLE.kotl")
(personal-example (expand-file-name example "~/"))
(original-example (expand-file-name example (concat hyperb:dir "kotl/"))))
(if (file-newer-than-file-p original-example personal-example)
(if (file-exists-p personal-example)
;; save it and use the original example file
(rename-file personal-example (expand-file-name (concat "SAVED-" example) "~/") t)))
(cond ((get-file-buffer personal-example)
(switch-to-buffer (get-file-buffer personal-example)))
((file-readable-p personal-example)
(find-file personal-example))
;; Create a new personal-example file
(t (switch-to-buffer (create-file-buffer personal-example))
(setq buffer-file-name personal-example
default-directory (expand-file-name "~/")
buffer-auto-save-file-name nil
buffer-read-only nil)
(insert-file-contents
(expand-file-name example (concat hyperb:dir "kotl/")))
(goto-char (point-min))
(kotl-mode)
(save-buffer)))))
;;; ------------------------------------------------------------------------
;;; Editing within a single kotl
;;; ------------------------------------------------------------------------
(defalias 'kotl-mode:backward-delete-char-untabify
'kotl-mode:delete-backward-char)
(defalias 'kotl-mode:backward-delete-char
'kotl-mode:delete-backward-char)
(defalias 'kotl-mode:delete-forward-char
'kotl-mode:delete-char)
(defalias 'kotl-mode:left-char 'kotl-mode:backward-char)
(defalias 'kotl-mode:right-char 'kotl-mode:forward-char)
(defun kotl-mode:backward-kill-word (arg)
"Kill up to prefix ARG words preceding point within a single cell."
(interactive "*p")
(or arg (setq arg 1))
(cond ((< arg 0)
(if (kotl-mode:eocp)
(error "(kotl-mode:backward-kill-word): End of cell")))
((> arg 0)
(if (kotl-mode:bocp)
(error "(kotl-mode:backward-kill-word): Beginning of cell"))))
(unless (= arg 0)
(save-restriction
(narrow-to-region (kcell-view:start) (kcell-view:end-contents))
(backward-kill-word arg))))
(defun kotl-mode:backward-or-forward-delete-char (arg)
"Delete ARG characters backwards or forwards.
Direction is determined from the value of `delete-key-deletes-forward' or
whether the Backspace key exists on the keyboard. If there is no Backspace
key, the delete key should always delete backward one character."
(interactive "*p")
(if (not (featurep 'xemacs))
(kotl-mode:delete-char (if normal-erase-is-backspace arg (- arg)) nil)
;; XEmacs
(kotl-mode:delete-char (if (delete-forward-p) arg (- arg)) nil)))
(defun kotl-mode:center-line ()
"Center the line point is on, within the width specified by `fill-column'.
This means adjusting the indentation so that it equals the distance between
the end of the text and `fill-column'."
(interactive "*")
(kotl-mode:maintain-region-highlight)
(let ((indent (kcell-view:indent))
(opoint (point-marker))
(bocp)
start)
(setq start (kotl-mode:to-start-of-line))
(if (setq bocp (kotl-mode:bocp))
(progn
;; Add a temporary fill-prefix since this is the 1st line of the cell
;; where label could interfere with centering.
(insert "\n\n") (insert-char ?\ indent)))
(center-line)
(if bocp
;; Delete temporary fill prefix.
(delete-region start (+ start indent 2)))
(goto-char opoint)
;; Move to editable point if need be.
(kotl-mode:to-valid-position)))
(defun kotl-mode:center-paragraph ()
"Center each nonblank line in the paragraph at or after point.
See `center-line' for more info."
(interactive "*")
(kotl-mode:maintain-region-highlight)
(let ((indent (kcell-view:indent))
(opoint (point-marker))
start)
(backward-paragraph)
(kotl-mode:to-valid-position)
(setq start (point))
;; Add a temporary fill-prefix for 1st line in cell which contains a
;; label, so is centered properly.
(insert "\n\n") (insert-char ?\ indent)
(kcell-view:operate 'center-paragraph)
;; Delete temporary fill prefix.
(delete-region start (+ start indent 2))
;; Return to original point.
(goto-char (min opoint (kcell-view:end-contents)))
;; Move to editable point if need be.
(kotl-mode:to-valid-position)))
(defun kotl-mode:copy-region-as-kill (start end)
"Copy region between START and END within a single kcell to kill ring."
(interactive "r")
(kotl-mode:kill-region start end t))
(defun kotl-mode:copy-to-register (register start end &optional delete-flag)
"Copy into REGISTER the region START to END.
With optional prefix arg DELETE-FLAG, delete region."
(interactive "cCopy to register: \nr\nP")
(let ((indent (kcell-view:indent)))
(set-register register
(hypb:replace-match-string
(concat "^" (make-string indent ?\ ))
(buffer-substring start end)
"" t)))
(if delete-flag (delete-region start end)))
(defun kotl-mode:delete-backward-char (arg &optional kill-flag)
"Delete up to the preceding prefix ARG characters.
Return number of characters deleted.
Optional KILL-FLAG non-nil means save in kill ring instead of deleting.
Does not delete across cell boundaries."
(interactive "*P")
(if (called-interactively-p 'interactive)
(if current-prefix-arg
(setq kill-flag t
arg (prefix-numeric-value current-prefix-arg))))
(or arg (setq arg 1))
(kotl-mode:delete-char (- arg) kill-flag))
(defun kotl-mode:delete-blank-lines ()
"On blank line within a cell, delete all surrounding blank lines, leaving just one.
On isolated blank line, delete that one.
On nonblank line, delete all blank lines that follow it.
If nothing but whitespace follows point until the end of a cell, delete all
whitespace at the end of the cell."
(interactive "*")
;; If nothing but whitespace from point until the end of cell, remove all
;; cell trailing whitespace.
(let ((end (kcell-view:end-contents))
start)
(if (save-excursion
(skip-chars-forward " \t\n\r" end)
(not (kotl-mode:eocp)))
(kcell-view:operate #'delete-blank-lines)
(setq start (kcell-view:start))
(goto-char end)
;; delete any preceding whitespace
(skip-chars-backward " \t\n\r" start)
(delete-region (max start (point)) end)))
(kotl-mode:to-valid-position))
(defun kotl-mode:delete-char (arg &optional kill-flag)
"Delete up to prefix ARG characters following point.
Return number of characters deleted.
Optional KILL-FLAG non-nil means save in kill ring instead of deleting.
Does not delete across cell boundaries."
(interactive "*P")
(if (called-interactively-p 'interactive)
(if current-prefix-arg
(setq kill-flag t
arg (prefix-numeric-value current-prefix-arg))))
(or arg (setq arg 1))
(let ((del-count 0)
(indent (kcell-view:indent))
count start end)
(cond ((> arg 0)
(if (kotl-mode:eocp)
(error "(kotl-mode:delete-char): End of cell")
(setq end (kcell-view:end)
arg (min arg (- end (point))))
(while (and (> arg 0) (not (kotl-mode:eocp)))
(if (kotl-mode:eolp)
(if (not (eq ?\ (char-syntax (following-char))))
(setq arg 0
del-count (1- del-count))
(delete-char 1 kill-flag)
;; There may be non-whitespace characters in the
;; indent area. Don't delete them.
(setq count indent)
(while (and (> count 0)
(eq ?\ (char-syntax (following-char))))
(delete-char 1)
(setq count (1- count))))
(delete-char 1 kill-flag))
(setq arg (1- arg)
del-count (1+ del-count)))
))
((< arg 0)
(if (kotl-mode:bocp)
(error "(kotl-mode:delete-char): Beginning of cell")
(setq start (kcell-view:start)
arg (max arg (- start (point))))
(while (and (< arg 0) (not (kotl-mode:bocp)))
(if (kotl-mode:bolp)
(if (not (eq ?\ (char-syntax (preceding-char))))
(setq arg 0
del-count (1- del-count))
;; There may be non-whitespace characters in the
;; indent area. Don't delete them.
(setq count indent)
(while (and (> count 0)
(eq ?\ (char-syntax (preceding-char))))
(delete-char -1)
(setq count (1- count)))
(if (zerop count)
(delete-char -1 kill-flag)))
(delete-char -1 kill-flag))
(setq arg (1+ arg)
del-count (1+ del-count))))))
del-count))
(defun kotl-mode:delete-horizontal-space ()
"Delete all spaces and tabs around point."
(interactive "*")
(save-restriction
(narrow-to-region
(save-excursion
(kotl-mode:to-start-of-line))
(save-excursion
(kotl-mode:to-end-of-line)))
(delete-horizontal-space)))
(defun kotl-mode:delete-indentation (&optional arg)
"Join this line to previous and fix up whitespace at join.
If there is a fill prefix, delete it from the beginning of this line.
With prefix ARG non-nil, join this line to the following line."
(interactive "*P")
(kcell-view:operate
(lambda ()
(let ((opoint (point)))
(beginning-of-line)
(if arg (kfill:forward-line 1))
(if (eq (preceding-char) ?\n)
(progn
(delete-region (point) (1- (point)))
;; If the second line started with the fill prefix,
;; delete the prefix.
(if (and fill-prefix
(<= (+ (point) (length fill-prefix)) (point-max))
(string-equal fill-prefix
(buffer-substring
(point) (+ (point) (length fill-prefix)))))
(delete-region (point) (+ (point) (length fill-prefix))))
(fixup-whitespace))
(goto-char opoint))))))
(defun kotl-mode:fill-cell (&optional justify ignore-collapsed-p)
"Fill current cell within current view if it lacks a non-nil `no-fill' attribute.
With optional JUSTIFY, justify cell as well.
IGNORE-COLLAPSED-P is used when caller has already expanded cell, indicating
it is not collapsed."
(interactive "*P")
(cond ((kcell-view:get-attr 'no-fill)
(if (called-interactively-p 'interactive)
(progn (beep)
(message "Current cell has a `do not fill' attribute.")
nil)))
((string-match "\\`[ \t\n\r]*\\'" (kcell-view:contents))
;; Cell content is all whitespace.
nil)
(t (let* ((indent (kcell-view:indent))
(opoint (set-marker (make-marker) (point)))
(start (set-marker (make-marker) (kcell-view:start)))
(collapsed-p)
(end (set-marker (make-marker) (kcell-view:end-contents)))
temp-prefix prev-point)
(goto-char start)
;; Expand cell if collapsed so that filling is done properly.
(if (and (not ignore-collapsed-p)
(kcell-view:collapsed-p start))
(progn (setq collapsed-p (kview:get-cells-status kview start end))
(outline-flag-region start end nil)))
(goto-char start)
;; Add a temporary fill-prefix for first labeled line, so is
;; filled properly.
(insert (setq temp-prefix
(concat "\n\n" (make-string indent ?\ ))))
(while (progn (if (fboundp 'fill-paragraph-and-align)
(fill-paragraph-and-align justify)
(fill-paragraph justify))
(setq prev-point (point))
(forward-paragraph)
(and (not (eq (point) prev-point))
(< (point) (kcell-view:end-contents))
(if (or (= (preceding-char) ?\n) (outline-invisible-p (1- (point))))
(not (or (= (following-char) ?\n) (outline-invisible-p)))
t))))
;; Delete temporary fill prefix.
(goto-char start)
(if (looking-at temp-prefix)
(replace-match "" t t))
;; Return to original point.
(setq end (kcell-view:end-contents))
(goto-char (min opoint end))
;;
;; If cell was collapsed before filling, restore its status.
(if (remq 0 collapsed-p) (kview:set-cells-status kview start end collapsed-p))
;;
;; Remove markers.
(set-marker start nil)
(set-marker end nil)
(set-marker opoint nil))
;; Move to editable point if need be.
(kotl-mode:to-valid-position))))
(defun kotl-mode:fill-paragraph (&optional justify)
"Fill the current paragraph within the cell.
With optional JUSTIFY, justify the paragraph as well.
Ignore any non-nil no-fill attribute attached to the cell."
(interactive "*P")
(let ((indent (kcell-view:indent))
(opoint (point-marker))
start end)
(re-search-backward (concat "\\`\\|" paragraph-separate))
(kotl-mode:to-valid-position)
(setq start (point-marker))
;; Add a temporary fill-prefix for the 1st line in the cell which
;; contains a label, so that it is filled properly.
(insert "\n\n") (insert-char ?\ indent)
(setq end (point-marker))
;; Return to original paragraph point. This is the correct formula,
;; considering the fill prefix that was just added.
(goto-char (min (max opoint (point)) (kcell-view:end-contents)))
(if (fboundp 'fill-paragraph-and-align)
(fill-paragraph-and-align justify)
(fill-paragraph justify))
;; Delete temporary fill prefix.
(delete-region start end)
;; Return to original point.
(goto-char (min opoint (kcell-view:end-contents)))
;; Move to editable point if need be.
(kotl-mode:to-valid-position)
;; Remove markers
(set-marker opoint nil)
(set-marker start nil)
(set-marker end nil)))
;; XEmacs binds this to {M-q}.
(defalias 'kotl-mode:fill-paragraph-or-region 'kotl-mode:fill-paragraph)
(defun kotl-mode:fill-tree (&optional top-p)
"Refill each cell within the tree whose root is at point.
Skip cells with a non-nil no-fill attribute.
With optional prefix argument TOP-P non-nil, refill all cells in the outline."
(interactive "P")
;; Temporarily expand, then refill cells lacking no-fill property.
(kview:map-expanded-tree (lambda (_view) (kotl-mode:fill-cell)) kview top-p))
(defun kotl-mode:just-one-space ()
"Delete all spaces and tabs around point and leave one space."
(interactive "*")
(save-excursion
(save-restriction
(save-excursion
(narrow-to-region (kotl-mode:to-start-of-line) (kotl-mode:to-end-of-line)))
(just-one-space))))
(defun kotl-mode:kill-line (&optional arg)
"Kill ARG lines from point."
(interactive "*P")
(if (and (null arg)
(kotl-mode:bolp)
(boundp 'kill-whole-line) kill-whole-line)
(let ((indent (kcell-view:indent)))
;; Kill whole line including newline, if any.
(kcell-view:operate
(lambda ()
(let ((no-newline))
(kill-region (point)
(progn (setq no-newline
(not (search-forward "\n" nil 'stay)))
(point)))
(or no-newline (delete-char indent))))))
;; Kill part of a line or multiple lines.
(let ((num-arg (prefix-numeric-value arg)))
(cond
((and (null arg) (not (kotl-mode:eolp)))
;; kill to eol but not newline
(kill-region (point) (setq arg (kotl-mode:to-end-of-line))))
((= num-arg 0)
;; kill to bol
(kill-region (point) (setq arg (kotl-mode:to-start-of-line))))
(t ;; (/= num-arg 0)
;; Find start and end of region to kill
(let ((start (point))
(end (min (kcell-view:end-contents)
(save-excursion (kfill:forward-line num-arg) (point)))))
(kotl-mode:kill-region start end))))))
(setq last-command 'kill-region))
(defun kotl-mode:kill-region (start end &optional copy-p)
"Kill region between START and END within a single kcell.
With optional COPY-P equal to 't, copy region to kill ring but does not
kill it. With COPY-P any other non-nil value, return region as a
string without affecting kill ring.
If the buffer is read-only and COPY-P is nil, the region will not be deleted
but it will be copied to the kill ring and then an error will be signaled."
(interactive "*r")
(let ((read-only (and (not copy-p) buffer-read-only)))
(if read-only (setq copy-p t))
(if (and (number-or-marker-p start)
(number-or-marker-p end)
(eq (kcell-view:cell start)
(kcell-view:cell end)))
(save-excursion
(goto-char start)
(let ((indent (kcell-view:indent))
killed subst-str)
;; Convert region to string
;; Convert all occurrences of newline + indent
;; to just newline, eliminating indent.
;; Then save to kill ring.
(setq subst-str (concat "\\([\n\r]\\)" (make-string indent ?\ ))
killed
(hypb:replace-match-string
subst-str (buffer-substring start end) "\\1"))
(unless copy-p
;; If last char of region is a newline, then delete indent in
;; following line.
(delete-region
start (+ end (if (memq (char-after (1- (max start end)))
'(?\n ?\r))
indent
0))))
(if (and copy-p (not (eq copy-p t)))
;; Return killed region as a string.
killed
(if (eq last-command 'kill-region)
(kill-append killed (< end start))
(kill-new killed))
(setq this-command 'kill-region)
(if read-only (barf-if-buffer-read-only))
)))
(error
"(kotl-mode:kill-region): Bad region or not within a single Koutline cell."))))
;; Bound to {C-w} when completion.el library is loaded.
(defalias 'kotl-mode:completion-kill-region 'kotl-mode:kill-region)
;; Bound to {M-w}
(defalias 'kotl-mode:kill-ring-save 'kotl-mode:copy-region-as-kill)
(defun kotl-mode:kill-sentence (&optional arg)
"Kill up to prefix ARG (or 1) sentences following point within a single cell."
(interactive "*p")
(or arg (setq arg 1))
(cond ((> arg 0)
(if (kotl-mode:eocp)
(error "(kotl-mode:kill-sentence): End of cell")))
((< arg 0)
(if (kotl-mode:bocp)
(error "(kotl-mode:kill-sentence): Beginning of cell"))))
(unless (= arg 0)
(kotl-mode:kill-region (point)
(save-excursion
(kotl-mode:forward-sentence arg)))))
(defun kotl-mode:kill-word (arg)
"Kill up to prefix ARG words following point within a single cell."
(interactive "*p")
(or arg (setq arg 1))
(cond ((> arg 0)
(if (kotl-mode:eocp)
(error "(kotl-mode:kill-word): End of cell")))
((< arg 0)
(if (kotl-mode:bocp)
(error "(kotl-mode:kill-word): Beginning of cell"))))
(unless (= arg 0)
(save-restriction
(narrow-to-region (kcell-view:start) (kcell-view:end-contents))
(kill-word arg))))
(defun kotl-mode:newline (&optional arg)
"Insert a newline. With optional ARG, insert ARG newlines.
In Auto Fill mode, if no numeric arg, break the preceding line if it is
too long."
(interactive "*p")
(kotl-mode:delete-horizontal-space)
(let ((indent (kcell-view:indent)))
(if (and arg (= arg 1))
(progn
(save-excursion
(insert ?\n)
(insert-char ?\ indent))
(do-auto-fill)
(kfill:forward-line 1)
(kotl-mode:to-start-of-line))
(while (> arg 0)
(insert ?\n)
(insert-char ?\ indent)
(setq arg (1- arg))))))
(defalias 'kotl-mode:electric-indent-just-newline 'kotl-mode:newline)
(defalias 'kotl-mode:electric-newline-and-maybe-indent 'kotl-mode:newline)
(defalias 'kotl-mode:newline-and-indent 'kotl-mode:newline)
(defalias 'kotl-mode:reindent-then-newline-and-indent 'kotl-mode:newline)
(defun kotl-mode:open-line (arg)
"Insert a newline and leave point before it.
With arg N, insert N newlines."
(interactive "*p")
(let* ((bolp (and (kotl-mode:bolp) (not (kotl-mode:bocp))))
(indent (kcell-view:indent)))
(while (> arg 0)
(save-excursion
(insert ?\n)
(if (and (not bolp) fill-prefix)
(insert fill-prefix)
(insert-char ?\ indent)))
(setq arg (1- arg)))
(if (and bolp fill-prefix)
(progn (delete-horizontal-space)
(insert fill-prefix)))))
(defun kotl-mode:quoted-insert (arg)
"Read next input character and insert it.
This is useful for inserting control characters.
With argument, insert ARG copies of the character.
If the first character you type after this command is an octal digit,
you should type a sequence of octal digits which specify a character code.
Any nondigit terminates the sequence. If the terminator is a RET,
it is discarded; any other terminator is used itself as input.
The variable `read-quoted-char-radix' specifies the radix for this feature;
set it to 10 or 16 to use decimal or hex instead of octal.
In overwrite mode, this function inserts the character anyway, and
does not handle octal digits specially. This means that if you use
overwrite as your normal editing mode, you can use this function to
insert characters when necessary.
In binary overwrite mode, this function does overwrite, and octal
digits are interpreted as a character code. This is intended to be
useful for editing binary files."
(interactive "*p")
(let* ((char
;; Avoid "obsolete" warnings for translation-table-for-input.
(with-no-warnings
(let (translation-table-for-input input-method-function)
(if (or (not overwrite-mode)
(eq overwrite-mode 'overwrite-mode-binary))
(read-quoted-char)
(read-char))))))
(unless (characterp char)
(user-error "%s is not a valid character"
(key-description (vector char))))
(if (> arg 0)
(if (eq overwrite-mode 'overwrite-mode-binary)
(kotl-mode:delete-char arg)))
(while (> arg 0)
(insert-and-inherit char)
(setq arg (1- arg)))))
(defun kotl-mode:set-fill-prefix (turn-off)
"Sets fill prefix to line up to point.
With prefix arg TURN-OFF or at begin of line, turns fill prefix off."
(interactive "P")
(if (or turn-off (kotl-mode:bolp))
(save-excursion
(forward-line 0)
(set-fill-prefix))
(set-fill-prefix)))
(defun kotl-mode:tab-command (arg)
"Tab over by ARG tab stops or demote the current tree a maximum of ARG levels.
Which command is run depends on the value of `kotl-mode:tab-flag'. Toggle
its value by sending this command an explicit ARG of 1. Use nil for ARG to
run the tab command once.
See also the documentation strings for `kotl-mode:indent-line' and
`kotl-mode:demote-tree'."
(interactive "*P")
(if (eq arg 1)
(call-interactively 'kotl-mode:toggle-tab-flag)
(setq arg (prefix-numeric-value arg))
(cond (kotl-mode:tab-flag (kotl-mode:indent-line arg))
(t (kotl-mode:demote-tree arg)))))
(defun kotl-mode:toggle-indent-tabs-mode ()
"Toggle the value of `kotl-mode:indent-tabs-mode' and explain its current usage."
(interactive)
(setq kotl-mode:indent-tabs-mode (not kotl-mode:indent-tabs-mode))
(if (called-interactively-p 'interactive)
(if kotl-mode:indent-tabs-mode
(message "Tab insertion now uses literal tabs.")
(message "Tab insertion now uses spaces to form tabs."))))
(defun kotl-mode:toggle-tab-flag ()
"Toggle the value of `kotl-mode:tab-flag' and explain its current usage."
(interactive)
(setq kotl-mode:tab-flag (not kotl-mode:tab-flag))
(if (called-interactively-p 'interactive)
(if kotl-mode:tab-flag
(message (substitute-command-keys
"{\\[kotl-mode:tab-command]} now inserts literal tabs; {\\[kotl-mode:untab-command]} removes tabs."))
(message (substitute-command-keys
"{\\[kotl-mode:tab-command]} now demotes trees; {\\[kotl-mode:untab-command]} promotes trees.")))))
(defun kotl-mode:transpose-chars (arg)
"Interchange characters around point, moving forward one character.
With prefix ARG, take character before point and drag it forward past ARG
other characters (backward if ARG negative). If no prefix ARG and at
the end of a line, the previous two characters are exchanged."
(interactive "*P")
(if (or (kotl-mode:bolp)
(and (null arg) (kotl-mode:eolp)
(save-excursion (kotl-mode:forward-char -1) (kotl-mode:bolp))))
(error "(kotl-mode:transpose-chars): Insufficient characters to transpose"))
(and (null arg) (kotl-mode:eolp) (kotl-mode:forward-char -1))
(transpose-subr 'kotl-mode:forward-char (prefix-numeric-value arg)))
(defun kotl-mode:transpose-lines (arg)
"Exchange current line and previous line, leaving point after both.
If no previous line, exchange current with next line.
With prefix ARG, take previous line and move it past ARG lines.
With prefix ARG = 0, interchange the line that contains point with the line
that contains mark."
(interactive "*p")
(cond
((and (kotl-mode:first-line-p) (kotl-mode:last-line-p))
(error "(kotl-mode:transpose-lines): Only one line in outline"))
;;
;; Transpose current and previous lines or current and next lines, if no
;; previous line. Leave point after both exchanged lines.
((= arg 1)
(let* ((point (point-marker))
(mark (set-marker (make-marker)
(if (kotl-mode:first-line-p)
(kotl-mode:next-line 1)
(kotl-mode:previous-line 1)))))
(kotl-mode:transpose-lines-internal point mark)
(goto-char (max point mark))
(kotl-mode:next-line 1)
(set-marker mark nil)))
;;
;; Transpose point and mark lines, leaving point on the line of text that
;; originally contained point.
((= arg 0)
(kotl-mode:transpose-lines-internal (point-marker) (hypb:mark-marker t))
(kotl-mode:exchange-point-and-mark))
;;
;; Move previous line past ARG next lines and leave point after previous
;; line text.
(t
(if (kotl-mode:first-line-p)
(error "(kotl-mode:transpose-lines): No previous line to transpose"))
(kotl-mode:previous-line 1)
(let* ((mark (set-marker (make-marker)
(save-excursion (kotl-mode:next-line arg))))
(line-to-move (kotl-mode:delete-line)))
(condition-case ()
;; Delete trailing newline if any, ignoring error.
(kotl-mode:delete-char 1)
(error nil))
(goto-char mark)
(set-marker mark nil)
(kotl-mode:to-end-of-line)
(insert "\n")
(insert-char ?\ (kcell-view:indent))
(insert line-to-move)
(kotl-mode:to-start-of-line)))))
(defun kotl-mode:transpose-paragraphs (arg)
"Interchange this (or next) paragraph with previous one."
(interactive "*p")
(transpose-subr 'kotl-mode:forward-paragraph (prefix-numeric-value arg)))
(defun kotl-mode:transpose-sentences (arg)
"Interchange this (next) and previous sentence."
(interactive "*p")
(transpose-subr 'kotl-mode:forward-sentence (prefix-numeric-value arg)))
(defun kotl-mode:transpose-words (arg)
"Interchange words around point, leaving point after both words.
With prefix ARG, take word before or around point and drag it forward past
ARG other words (backward if ARG negative). If ARG is zero, the words around
or after point and around or after mark are interchanged."
(interactive "*p")
(transpose-subr 'kotl-mode:forward-word (prefix-numeric-value arg)))
(defun kotl-mode:untab-command (arg)
"Delete backwards by ARG tab stops or promote the current tree a maximum of ARG levels.
Which command is run depends on the value of `kotl-mode:tab-flag'. Toggle
its value by sending this command an explicit ARG of 1. Use nil for ARG to
run the untab command once.
See also the documentation strings for `kotl-mode:delete-backward-char' and
`kotl-mode:promote-tree'."
(interactive "*P")
(if (eq arg 1)
(call-interactively 'kotl-mode:toggle-tab-flag)
(setq arg (prefix-numeric-value arg))
(cond (kotl-mode:tab-flag (kotl-mode:delete-backward-char arg))
(t (kotl-mode:promote-tree arg)))))
(defun kotl-mode:zap-to-char (arg char)
"Kill up to and including prefix ARG'th occurrence of CHAR.
Goes backward if ARG is negative; error if CHAR not found."
(interactive "*p\ncZap to char within current cell: ")
(kcell-view:operate
(lambda () (zap-to-char arg char))))
;;; ------------------------------------------------------------------------
;;; Editing across kotls
;;; ------------------------------------------------------------------------
(defvar hargs:defaults)
(defun kotl-mode:append-cell (contents-cell append-to-cell)
"Append CONTENTS-CELL to APPEND-TO-CELL.
APPEND-TO-CELL is refilled if neither cell has a no-fill property and
kotl-mode:refill-flag is enabled."
(interactive
(let* ((label (kcell-view:label))
(hargs:defaults (list label label)))
(hargs:iform-read
'(interactive
"*+KAppend contents of cell: \n+KAppend contents of cell <%s> to cell: "))))
(save-excursion
(kotl-mode:goto-cell contents-cell)
(let ((contents (kcell-view:contents))
(no-fill (kcell-view:get-attr 'no-fill)))
(kotl-mode:goto-cell append-to-cell)
(if no-fill nil (setq no-fill (kcell-view:get-attr 'no-fill)))
(goto-char (kcell-view:end-contents))
(let ((fill-prefix (make-string (kcell-view:indent) ?\ )))
(unless (kotl-mode:bolp)
;; Append contents of cell beginning on its own line.
(insert "\n" fill-prefix))
(kview:insert-contents (kcell-view:cell) contents
(or no-fill (null kotl-mode:refill-flag))
fill-prefix)))))
(defun kotl-mode:clipboard-yank ()
"Insert the clipboard contents, or the last stretch of killed text."
(interactive "*")
(let ((select-enable-clipboard t))
(kotl-mode:yank)))
(defun kotl-mode:copy-after (from-cell-ref to-cell-ref child-p)
"Copy tree rooted at FROM-CELL-REF to follow tree rooted at TO-CELL-REF.
If prefix arg CHILD-P is non-nil, make FROM-CELL-REF the first child of
TO-CELL-REF, otherwise make it the sibling following TO-CELL-REF.
Leave point at the start of the root cell of the new tree."
(interactive
(let* ((label (kcell-view:label))
(hargs:defaults (list label label)))
(append
(hargs:iform-read
(list
'interactive
(format "*+KCopy tree: \n+KCopy tree <%%s> to follow as %s of cell: "
(if current-prefix-arg "child" "sibling"))))
(list current-prefix-arg))))
;;
;; Copy tree in current view and leave point at the start of the copy.
(goto-char (kotl-mode:move-after from-cell-ref to-cell-ref child-p t))
;; Alter the copied tree so each cell appears to be newly created.
(kview:map-tree
(lambda (view)
(kcell-view:set-cell
(kcell:create nil (kview:id-increment view))))
kview))
(defun kotl-mode:copy-before (from-cell-ref to-cell-ref parent-p)
"Copy tree rooted at FROM-CELL-REF to precede tree rooted at TO-CELL-REF.
If prefix arg PARENT-P is non-nil, make FROM-CELL-REF the first child of
TO-CELL-REF's parent, otherwise make it the preceding sibling of TO-CELL-REF.
Leave point at the start of the root cell of the new tree."
(interactive
(let* ((label (kcell-view:label))
(hargs:defaults (list label label)))
(append
(hargs:iform-read
(list 'interactive
(format "*+KCopy tree: \n+KCopy tree <%%s> to be %s of cell: "
(if current-prefix-arg "first child of parent"
"preceding sibling"))))
(list current-prefix-arg))))
;;
;; Copy tree in current view and leave point at the start of the copy.
(goto-char (kotl-mode:move-before from-cell-ref to-cell-ref parent-p t))
;; Alter the copied tree so each cell appears to be newly created.
(kview:map-tree
(lambda (view)
(kcell-view:set-cell
(kcell:create nil (kview:id-increment view))))
kview))
(defun kotl-mode:copy-to-buffer (cell-ref buffer invisible-flag)
"Copy outline tree rooted at CELL-REF to a non-koutline BUFFER.
Invisible text is expanded and included in the copy only if INVISIBLE-FLAG is
non-nil. The tree is inserted before point in BUFFER. Use \"0\" to copy the
whole outline buffer."
(interactive
(let ((label-default (kcell-view:label)))
(hargs:iform-read
`(interactive
(list
(hargs:read "Copy tree without attributes: (0 for whole outline) "
nil ',label-default nil 'kcell)
(read-buffer "To buffer: "
(save-window-excursion
(if (one-window-p)
(select-frame (next-frame))
(other-window 1))
(buffer-name))
t)
(y-or-n-p "Copy invisible text? "))))))
(message "") ;; Erase last interactive prompt, if any.
(setq buffer (get-buffer-create buffer))
(if (equal cell-ref "0")
(hypb:insert-region buffer (point-min) (point-max) invisible-flag)
(let (start end)
(save-excursion
(kotl-mode:goto-cell cell-ref t)
(save-excursion (kfill:forward-line 0) (setq start (point)))
(setq end (kotl-mode:tree-end)))
(hypb:insert-region buffer start end invisible-flag))))
(defun kotl-mode:move-after (from-cell-ref to-cell-ref child-p
&optional copy-p fill-p)
"Move tree rooted at FROM-CELL-REF to follow tree rooted at TO-CELL-REF.
If prefix arg CHILD-P is non-nil, make FROM-CELL-REF the first child of
TO-CELL-REF, otherwise make it the sibling following TO-CELL-REF.
With optional COPY-P, copies tree rather than moving it.
Leave point at original location but return the tree's new start point."
(interactive
(let* ((label (kcell-view:label))
(hargs:defaults (list label label)))
(append
(hargs:iform-read
(list
'interactive
(format "*+KMove tree: \n+KMove tree <%%s> to follow as %s of cell: "
(if current-prefix-arg "child" "sibling"))))
(list current-prefix-arg))))
(if (and (not copy-p) (equal from-cell-ref to-cell-ref))
(error "(kotl-mode:move-after): Can't move tree after itself"))
(let* ((label-sep-len (kview:label-separator-length kview))
(move-to-point (set-marker
(make-marker)
(kotl-mode:goto-cell to-cell-ref t)))
(to-label (kcell-view:label))
(to-indent (kcell-view:indent nil label-sep-len))
(from-label (progn (kotl-mode:goto-cell from-cell-ref t)
(kcell-view:label)))
(from-indent (kcell-view:indent nil label-sep-len))
(start (kotl-mode:tree-start))
(end (kotl-mode:tree-end))
(sib-id (if (= 0 (kotl-mode:forward-cell 1))
(kcell-view:idstamp)))
new-tree-start)
;;
;; We can't move a tree to a point within itself, so if that is the case
;; and this is not a copy operation, signal an error.
(if (and (not copy-p) (>= move-to-point start) (<= move-to-point end))
(error "(kotl-mode:move-after): Can't move tree <%s> to within itself"
from-label))
;;
;; If tree to move has a sibling, point is now at the start of the
;; sibling cell. Mark its label with a property which will be deleted
;; whenever the cell label is renumbered. This tells us whether or not
;; to renumber the sibling separately from the tree to move.
(if sib-id
;; Move to middle of label and insert klabel-original temp property.
(progn (goto-char (- (point) label-sep-len 3))
(kproperty:set 'klabel-original t)))
;;
;; Position for insertion before deletion of tree-to-move from old
;; position, in case old position precedes new one.
;; Skip past either cell or tree at move-to-point.
(goto-char move-to-point)
(if child-p
;; Move to insert position for first child of to-cell-ref.
(progn (goto-char (kcell-view:end))
(setq to-label (klabel:child to-label)
to-indent (+ to-indent (kview:level-indent kview))))
;; Move to after to-cell-ref's tree for insertion as following sibling.
(goto-char (kotl-mode:tree-end))
(setq to-label (klabel:increment to-label)))
;;
;; Insert tree-to-move at new location
;;
(kview:move start end (point) from-indent to-indent copy-p
(or fill-p kotl-mode:refill-flag))
;;
;; Ensure that point is within editable region of cell with to-label.
(kotl-mode:to-valid-position)
(setq new-tree-start (point))
;;
;; Update current cell and new siblings' labels within view.
(klabel-type:update-labels to-label)
;;
(unless copy-p
;;
;; Move to sibling of tree-to-move within view and update labels within
;; view of tree-to-move's original siblings.
(if sib-id
(progn (kotl-mode:goto-cell sib-id t)
;; Sibling labels may have already been updated if tree was
;; moved somewhere preceding its siblings.
(let ((label-middle (- (point) label-sep-len 2)))
(if (kproperty:get label-middle 'klabel-original)
(klabel-type:update-labels from-label))))))
;;
(goto-char new-tree-start)
;;
;; Ensure that point is within editable region of a cell.
(kotl-mode:to-valid-position)
;;
(set-marker move-to-point nil)
new-tree-start))
(defun kotl-mode:move-before (from-cell-ref to-cell-ref parent-p
&optional copy-p fill-p)
"Move tree rooted at FROM-CELL-REF to precede tree rooted at TO-CELL-REF.
If prefix arg PARENT-P is non-nil, make FROM-CELL-REF the first child of
TO-CELL-REF's parent, otherwise make it the preceding sibling of TO-CELL-REF.
With optional COPY-P, copies tree rather than moving it.
Leave point at original location but return the tree's new start point."
(interactive
(let* ((label (kcell-view:label))
(hargs:defaults (list label label)))
(append
(hargs:iform-read
(list 'interactive
(format "*+KMove tree: \n+KMove tree <%%s> to be %s of cell: "
(if current-prefix-arg "first child of parent"
"preceding sibling"))))
(list current-prefix-arg))))
(if (and (not copy-p) (equal from-cell-ref to-cell-ref))
(error "(kotl-mode:move-before): Can't move tree before itself"))
(let* ((label-sep-len (kview:label-separator-length kview))
(move-to-point (set-marker
(make-marker)
(kotl-mode:goto-cell to-cell-ref t)))
(to-label (kcell-view:label))
(to-indent (kcell-view:indent nil label-sep-len))
(from-label (progn (kotl-mode:goto-cell from-cell-ref t)
(kcell-view:label)))
(from-indent (kcell-view:indent nil label-sep-len))
(start (kotl-mode:tree-start))
(end (kotl-mode:tree-end))
(sib-id (if (= 0 (kotl-mode:forward-cell 1))
(kcell-view:idstamp)))
new-tree-start)
;;
;; We can't move a tree to a point within itself, so if that is the case
;; and this is not a copy operation, signal an error.
(if (and (not copy-p) (>= move-to-point start) (<= move-to-point end))
(error "(kotl-mode:move-before): Can't move tree <%s> to within itself"
from-label))
;;
;; If tree to move has a sibling, point is now at the start of the
;; sibling cell. Mark its label with a property which will be deleted
;; whenever the cell label is renumbered. This tells us whether or not
;; to renumber the sibling separately from the tree to move.
(if sib-id
;; Move to middle of label and insert klabel-original temp property.
(progn (goto-char (- (point) label-sep-len 3))
(kproperty:set 'klabel-original t)))
;;
;; Position for insertion at succeeding-tree, before deletion of
;; tree-to-move from old position, in case old position precedes new one.
(goto-char move-to-point)
(if parent-p
;; Move to insert position for first child of to-cell-ref's parent.
(if (kcell-view:parent nil label-sep-len)
(progn (setq to-label (klabel:child (kcell-view:label)))
(goto-char (kcell-view:end)))
(error "(kotl-mode:move-before): to-cell-ref's parent not in current view"))
;; Move to before to-cell-ref for insertion as preceding sibling.
(goto-char (kotl-mode:tree-start)))
;;
;; Insert tree-to-move at new location
;;
(kview:move start end (point) from-indent to-indent copy-p
(or fill-p kotl-mode:refill-flag))
;;
;; Ensure that point is within editable region of root of tree just moved.
(kotl-mode:to-valid-position)
(setq new-tree-start (point))
;;
;; Update current cell and new siblings' labels within view.
(klabel-type:update-labels to-label)
;;
(unless copy-p
;;
;; Move to sibling of tree-to-move within view and update labels within
;; view of tree-to-move's original siblings.
(if sib-id
(progn
(kotl-mode:goto-cell sib-id t)
;; Sibling labels may have already been updated if tree was
;; moved somewhere preceding its siblings.
(let ((label-middle (- (point) label-sep-len 2)))
(if (kproperty:get label-middle 'klabel-original)
(klabel-type:update-labels from-label))))))
;;
(goto-char new-tree-start)
;;
;; Ensure that point is within editable region of a cell.
(kotl-mode:to-valid-position)
;;
(set-marker move-to-point nil)
new-tree-start))
(defun kotl-mode:yank (&optional arg)
"Reinsert (\"paste\") the last stretch of killed text.
More precisely, reinsert the most recent kill, which is the
stretch of killed text most recently killed OR yanked. Put point
at the end, and set mark at the beginning without activating it.
With just \\[universal-argument] as argument, put point at beginning, and mark at end.
With argument N, reinsert the Nth most recent kill.
When this command inserts text into the buffer, it honors the
`yank-handled-properties' and `yank-excluded-properties'
variables, and the `yank-handler' text property. See
`insert-for-yank-1' for details.
See also the command `yank-pop' (\\[yank-pop])."
(interactive "*P")
(setq yank-window-start (window-start))
;; If we don't get all the way thru, make last-command indicate that
;; for the following command.
(setq this-command t)
(push-mark (point))
(let* ((yank-text (current-kill (cond
((listp arg) 0)
((eq arg '-) -1)
(t (1- arg)))))
(indent (kcell-view:indent))
(indent-str (make-string indent ?\ )))
;; Convert all occurrences of newline to newline + cell indent.
;; Then insert into buffer.
(insert (hypb:replace-match-string
"[\n\r]" yank-text (concat "\\0" indent-str))))
(if (consp arg) (kotl-mode:exchange-point-and-mark))
;; If we do get all the way thru, make this-command indicate that.
(if (eq this-command t) (setq this-command 'kotl-mode:yank))
nil)
(defun kotl-mode:yank-pop (arg)
"Replace just-yanked stretch of killed text with a different stretch.
This command is allowed only immediately after a `yank' or a `yank-pop'.
At such a time, the region contains a stretch of reinserted
previously-killed text. `yank-pop' deletes that text and inserts in its
place a different stretch of killed text.
With no argument, the previous kill is inserted.
With argument N, insert the Nth previous kill.
If N is negative, this is a more recent kill.
The sequence of kills wraps around, so that after the oldest one
comes the newest one.
When this command inserts killed text into the buffer, it honors
`yank-excluded-properties' and `yank-handler' as described in the
doc string for `insert-for-yank-1', which see."
(interactive "*p")
(if (not (eq last-command 'kotl-mode:yank))
(error "Previous command was not a yank"))
(setq this-command 'kotl-mode:yank)
(or arg (setq arg 1))
(let ((inhibit-read-only t)
(before (< (point) (mark t))))
(if before
(funcall (or yank-undo-function 'delete-region) (point) (mark t))
(funcall (or yank-undo-function 'delete-region) (mark t) (point)))
(set-marker (hypb:mark-marker t) (point) (current-buffer))
(let* ((yank-text (current-kill arg))
(indent (kcell-view:indent))
(indent-str (make-string indent ?\ )))
;; Convert all occurrences of newline to newline + cell indent.
;; Then insert into buffer.
(insert (hypb:replace-match-string
"[\n\r]" yank-text (concat "\\0" indent-str))))
;; Set the window start back where it was in the yank command,
;; if possible.
(set-window-start (selected-window) yank-window-start t)
(if before (kotl-mode:exchange-point-and-mark)))
nil)
;;; ------------------------------------------------------------------------
;;; Movement
;;; ------------------------------------------------------------------------
(defalias 'kotl-mode:scroll-down-command 'kotl-mode:scroll-down)
(defalias 'kotl-mode:scroll-up-command 'kotl-mode:scroll-up)
;;; Cursor and keypad key functions aliases for XEmacs.
(if (featurep 'xemacs)
(progn
(defalias 'kotl-mode:backward-char-command 'kotl-mode:backward-char)
(defalias 'kotl-mode:forward-char-command 'kotl-mode:forward-char)
(defalias 'kotl-mode:fkey-backward-char 'kotl-mode:backward-char)
(defalias 'kotl-mode:fkey-forward-char 'kotl-mode:forward-char)
(defalias 'kotl-mode:fkey-next-line 'kotl-mode:next-line)
(defalias 'kotl-mode:fkey-previous-line 'kotl-mode:previous-line)
(defalias 'kotl-mode:deprecated-scroll-down 'kotl-mode:scroll-down)
(defalias 'kotl-mode:deprecated-scroll-up 'kotl-mode:scroll-up)
(defalias 'kotl-mode:deprecated-bob 'kotl-mode:beginning-of-buffer)
(defalias 'kotl-mode:deprecated-eob 'kotl-mode:end-of-buffer)))
(defun kotl-mode:back-to-indentation ()
"Move point to the first non-read-only non-whitespace character on this line."
(interactive)
(kotl-mode:maintain-region-highlight)
(back-to-indentation)
(kotl-mode:to-valid-position))
(defun kotl-mode:backward-cell (arg)
"Move to prefix ARGth prior visible cell (same level) within current view.
Return number of cells left to move."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(if (< arg 0)
(kotl-mode:forward-cell (- arg))
(let ((prior (= arg 0))
(label-sep-len (kview:label-separator-length kview)))
(while (and (> arg 0) (setq prior (kcell-view:backward t label-sep-len)))
(setq arg (1- arg)))
(if (or prior (not (called-interactively-p 'interactive)))
arg
(error "(kotl-mode:backward-cell): No prior cell at same level")))))
(defun kotl-mode:backward-char (&optional arg)
"Move point backward ARG (or 1) characters and return point."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(or arg (setq arg 1))
(if (>= arg 0)
(while (> arg 0)
(cond ((kotl-mode:bobp)
(error "(kotl-mode:backward-char): Beginning of buffer"))
((kotl-mode:bocp)
(if (kcell-view:previous t)
(kotl-mode:end-of-cell)))
((kotl-mode:bolp)
(if (re-search-backward "[\n\r]" nil t)
(kotl-mode:to-valid-position t)))
(t (backward-char)))
(setq arg (1- arg)))
(kotl-mode:forward-char (- arg)))
(point))
(defun kotl-mode:backward-paragraph (&optional arg)
"Move backward to start of paragraph.
With arg N, do it N times; negative arg -N means move forward N paragraphs.
Return point.
A paragraph start is the beginning of a line which is a
`first-line-of-paragraph' or which is ordinary text and follows a
paragraph-separating line.
See `forward-paragraph' for more information."
(interactive "p")
(when (featurep 'xemacs) (setq zmacs-region-stays t))
(kotl-mode:forward-paragraph (- (or arg 1))))
(defalias 'kotl-mode:backward-para 'kotl-mode:backward-paragraph)
(defun kotl-mode:backward-sentence (&optional arg)
"Move point backward ARG (or 1) sentences and return point."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(let* ((label-sep-len (kview:label-separator-length kview))
;; Setting fill prefix makes sentence commands properly recognize
;; indented paragraphs.
(fill-prefix (make-string (kcell-view:indent nil label-sep-len) ?\ )))
(if (kotl-mode:bobp)
(error "(kotl-mode:backward-sentence): First sentence")
(if (and (kotl-mode:bocp) (kcell-view:previous nil label-sep-len))
(goto-char (kcell-view:end-contents)))
(or arg (setq arg 1))
(save-restriction
(if (= arg 1)
(narrow-to-region
(- (kcell-view:start nil label-sep-len)
(kcell-view:indent nil label-sep-len))
(kcell-view:end-contents)))
(unwind-protect
(let ((opoint (point)))
(backward-sentence arg)
(if (= opoint (point))
(progn (kcell-view:previous nil label-sep-len)
(backward-sentence arg))))
(kotl-mode:to-valid-position t)))))
(point))
(defun kotl-mode:backward-word (&optional arg)
"Move point backward ARG (or 1) words and return point."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(or arg (setq arg 1))
(if (>= arg 0)
(while (> arg 0)
(cond ((kotl-mode:bobp) (setq arg 0))
((kotl-mode:bocp)
(if (kcell-view:previous t)
(kotl-mode:end-of-cell))))
(unwind-protect
(backward-word 1)
(kotl-mode:to-valid-position t))
(setq arg (1- arg)))
(kotl-mode:forward-word (- arg)))
(point))
(defun kotl-mode:beginning-of-buffer ()
"Move point to beginning of buffer and return point."
(interactive)
(kotl-mode:maintain-region-highlight)
(goto-char (point-min))
;; Move to cell start.
(goto-char (kcell-view:start)))
(defun kotl-mode:beginning-of-cell (&optional arg)
"Move point to beginning of current or ARGth - 1 prior cell and return point."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(or arg (setq arg 1))
(or (integer-or-marker-p arg)
(error "(kotl-mode:beginning-of-cell): Wrong type arg, integer-or-marker, `%s'" arg))
(if (= arg 1)
(goto-char (kcell-view:start))
(kotl-mode:backward-cell (1- arg)))
(point))
;;; Avoid XEmacs byte-compiler bug which inserts nil for calls to this
;;; function if named kotl-mode:beginning-of-line.
;;;
(defun kotl-mode:to-start-of-line (&optional arg)
"Move point to beginning of current or ARGth - 1 line and return point."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(or arg (setq arg 1))
(or (integer-or-marker-p arg)
(error "(kotl-mode:to-start-of-line): Wrong type arg, integer-or-marker, `%s'" arg))
(kfill:forward-line (1- arg))
(unless (eolp)
(forward-char (prog1 (kcell-view:indent)
(beginning-of-line))))
(point))
;;; This ensures that the key bound to `beginning-of-line' is replaced in kotl-mode.
(defalias 'kotl-mode:beginning-of-line 'kotl-mode:to-start-of-line)
(defalias 'kotl-mode:move-beginning-of-line 'kotl-mode:beginning-of-line)
(defun kotl-mode:beginning-of-tree ()
"Move point to the level 1 root of the current cell's tree.
Leave point at the start of the cell."
(interactive)
(kotl-mode:maintain-region-highlight)
(let ((label-sep-len (kview:label-separator-length kview)))
(if (/= (kcell-view:level nil label-sep-len) 1)
;; Enable user to return to this previous position if desired.
(push-mark nil 'no-msg))
(while (and (/= (kcell-view:level nil label-sep-len) 1)
(kcell-view:parent nil label-sep-len)))
(kotl-mode:beginning-of-cell)))
(defun kotl-mode:down-level (arg)
"Move down prefix ARG levels lower within current tree."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(if (< arg 0)
(kotl-mode:up-level (- arg))
;; Enable user to return to this previous position if desired.
(push-mark nil 'no-msg)
(let ((child))
(while (and (> arg 0) (kcell-view:child))
(or child (setq child t))
(setq arg (1- arg)))
;; Signal an error if couldn't move down at least 1 child level.
(or child
(progn
(goto-char (hypb:mark t))
(pop-mark)
(error "(kotl-mode:down-level): No child level to which to move")
)))))
(defun kotl-mode:end-of-buffer ()
"Move point to end of buffer and return point."
(interactive)
(kotl-mode:maintain-region-highlight)
(goto-char (point-max))
;; To move to cell end.
(kotl-mode:to-valid-position t)
(point))
(defun kotl-mode:end-of-cell (&optional arg)
"Move point to the end of the current cell and return point.
With optional ARG > 0, move to the ARGth - 1 next visible cell.
With optional ARG < 0, move to the ARGth previous visible cell."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(or arg (setq arg 1))
(or (integer-or-marker-p arg)
(error "(kotl-mode:end-of-cell): Wrong type arg, integer-or-marker, `%s'" arg))
(kotl-mode:next-cell (if (> arg 0) (1- arg) arg))
(goto-char (kcell-view:end-contents)))
;;; Avoid XEmacs byte-compiler bug which inserts nil for calls to this
;;; function if named kotl-mode:end-of-line.
;;;
(defun kotl-mode:to-end-of-line (&optional arg)
"Move point to end of current or ARGth - 1 line and return point."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(or arg (setq arg 1))
(or (integer-or-marker-p arg)
(error "(kotl-mode:to-end-of-line): Wrong type arg, integer-or-marker, `%s'" arg))
(kfill:forward-line (1- arg))
(end-of-visible-line)
;; May have to move backwards to before label if support labels
;; at end of cells.
(point))
;;; This ensures that the key bound to `end-of-line' is replaced in kotl-mode.
(defalias 'kotl-mode:end-of-line 'kotl-mode:to-end-of-line)
(defalias 'kotl-mode:move-end-of-line 'kotl-mode:to-end-of-line)
(defun kotl-mode:end-of-tree ()
"Move point to the last cell in tree rooted at the current cell.
Leave point at the start of the cell."
(interactive)
(kotl-mode:maintain-region-highlight)
;; Enable user to return to this previous position if desired.
(push-mark nil 'no-msg)
(let ((label-sep-len (kview:label-separator-length kview)))
(if (kcell-view:forward nil label-sep-len)
;; Move to cell preceding start of next tree.
(kcell-view:previous nil label-sep-len)
;; Otherwise, no next tree, so move until find last cell in tree.
(let ((cell-indent (kcell-view:indent nil label-sep-len))
(end-point (point)))
;; Terminate when no further cells or when reach a cell at an equal
;; or higher level in the outline than the first cell that we
;; processed.
(while (and (kcell-view:next nil label-sep-len)
(> (kcell-view:indent nil label-sep-len) cell-indent))
(setq end-point (point)))
(goto-char end-point)))
(kotl-mode:beginning-of-cell)))
(defun kotl-mode:first-sibling ()
"Move point to the first sibling of the present cell.
Leave point at the start of the cell or at its present position if it is
already within the first sibling cell."
(interactive)
(kotl-mode:maintain-region-highlight)
(let ((label-sep-len (kview:label-separator-length kview)))
(if (save-excursion (kcell-view:backward nil label-sep-len))
;; Enable user to return to this previous position if desired.
(push-mark nil 'no-msg))
(while (kcell-view:backward nil label-sep-len))))
(defun kotl-mode:forward-cell (arg)
"Move to prefix ARGth following cell (same level) within current view.
Return number of cells left to move."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(if (< arg 0)
(kotl-mode:backward-cell (- arg))
(let ((next (= arg 0))
(label-sep-len (kview:label-separator-length kview)))
(while (and (> arg 0) (setq next (kcell-view:forward t label-sep-len)))
(setq arg (1- arg)))
(if (or next (not (called-interactively-p 'interactive)))
arg
(error "(kotl-mode:forward-cell): No following cell at same level")))))
(defun kotl-mode:forward-char (&optional arg)
"Move point forward ARG (or 1) characters and return point."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(or arg (setq arg 1))
(if (>= arg 0)
(while (> arg 0)
(cond ((and (kotl-mode:eolp) (kotl-mode:last-line-p))
(error "(kotl-mode:forward-char): End of buffer"))
((kotl-mode:eocp)
(kcell-view:next t))
((kotl-mode:eolp)
(forward-char)
(kotl-mode:to-visible-position))
(t (forward-char)))
(setq arg (1- arg)))
(kotl-mode:backward-char (- arg)))
(point))
(defun kotl-mode:forward-paragraph (&optional arg)
"Move point forward until after the last character of the current paragraph.
With arg N, do it N times; negative arg -N means move backward N paragraphs.
Return point.
A line which `paragraph-start' matches either separates paragraphs
\(if `paragraph-separate' matches it also) or is the first line of a paragraph.
A paragraph end is one character before the beginning of a line which is not
part of the paragraph, or the end of the buffer."
(interactive "p")
(when (featurep 'xemacs) (setq zmacs-region-stays t))
(setq arg (or arg 1))
(if (< arg 0)
(progn
(if (kotl-mode:bocp) (setq arg (1- arg)))
(while (< arg 0)
(start-of-paragraph-text)
(setq arg (1+ arg))))
(while (> arg 0)
(end-of-paragraph-text)
(setq arg (1- arg))))
(kotl-mode:to-valid-position)
(point))
(defalias 'kotl-mode:forward-para 'kotl-mode:forward-paragraph)
(defun kotl-mode:forward-sentence (&optional arg)
"Move point forward ARG (or 1) sentences and return point."
(interactive "P")
(kotl-mode:maintain-region-highlight)
(let* ((label-sep-len (kview:label-separator-length kview))
;; Setting fill prefix makes sentence commands properly recognize
;; indented paragraphs.
(fill-prefix (make-string (kcell-view:indent nil label-sep-len) ?\ )))
(if (kotl-mode:eobp)
(error "(kotl-mode:forward-sentence): Last sentence")
(if (kotl-mode:eocp) (kcell-view:next nil label-sep-len))
(or arg (setq arg 1))
(save-restriction
(if (= arg 1)
(narrow-to-region
(- (kcell-view:start nil label-sep-len)
(kcell-view:indent nil label-sep-len))
(kcell-view:end-contents)))
(unwind-protect
(let ((opoint (point)))
(forward-sentence arg)
(if (= opoint (point))
(progn (kcell-view:next nil label-sep-len)
(forward-sentence arg))))
(kotl-mode:to-valid-position)))))
(point))
(defun kotl-mode:forward-word (&optional arg)
"Move point forward ARG (or 1) words and return point."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(or arg (setq arg 1))
(if (>= arg 0)
(while (> arg 0)
(cond ((kotl-mode:eobp) (setq arg 0))
((kotl-mode:eocp)
(kcell-view:next t)))
(unwind-protect
(forward-word 1)
(kotl-mode:to-valid-position))
;; If point is at beginning of a cell after moving forward a word,
;; then we moved over something other than a word (some
;; punctuation or an outline autonumber); therefore, leave counter as
;; is in order to move forward over next word.
(or (kotl-mode:bocp)
(setq arg (1- arg))))
(kotl-mode:backward-word (- arg)))
(point))
(defun kotl-mode:goto-cell (cell-ref &optional error-p)
"Move point to start of cell given by CELL-REF. (See `kcell:ref-to-id'.)
Return point if CELL-REF is found within current view, else nil.
With a prefix argument, CELL-REF is assigned the argument value for use
as an idstamp.
With optional second arg, ERROR-P, non-nil, signal an error if
CELL-REF is not found within current view. Will signal same
error if called interactively when CELL-REF is not found."
(interactive
(list (if current-prefix-arg
(format "0%d" (prefix-numeric-value current-prefix-arg))
(read-string "Goto cell label or id: "))))
(setq cell-ref
(or (kcell:ref-to-id cell-ref)
(error "(kotl-mode:goto-cell): Invalid cell reference, `%s'" cell-ref)))
(let* ((opoint (point))
(found)
cell-id kvspec)
(if (eq ?| (aref cell-ref 0))
;; This is a standalone view spec, not a cell reference.
(progn (kvspec:activate cell-ref) (setq found (point)))
;; !! Remove any relative specs and view specs from
;; cell-ref to form cell-id. Really should account for relative
;; specs here, but we don't yet support them.
(if (string-match "\\(\\.[a-zA-Z]+\\)?\\([|:].*\\)\\|\\.[a-zA-Z]+"
cell-ref)
(setq cell-id (substring cell-ref 0 (match-beginning 0))
kvspec (if (match-beginning 2)
(substring
cell-ref (match-beginning 2) (match-end 2))))
(setq cell-id cell-ref kvspec nil))
(goto-char (point-min))
(cond ((eq ?0 (aref cell-id 0))
;; is an idstamp
(if (kview:goto-cell-id cell-id)
(setq found (point))))
;; is a label
((re-search-forward
(format "\\([\n\r][\n\r]\\|\\`\\)[ ]*%s%s"
(regexp-quote cell-id)
(regexp-quote (kview:label-separator kview)))
nil t)
(setq found (point)))
;; no match
(t (goto-char opoint)
nil))
(if (and (not found) (or error-p (called-interactively-p 'interactive)))
(error "(kotl-mode:goto-cell): No `%s' cell in this view" cell-ref)
;; Activate any viewspec associated with cell-ref.
(if kvspec (kvspec:activate kvspec))))
found))
(defun kotl-mode:head-cell ()
"Move point to the start of the first visible cell at the same level as current cell.
If at head cell already, do nothing and return nil."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(let ((moved)
(label-sep-len (kview:label-separator-length kview)))
(while (kcell-view:backward t label-sep-len)
(setq moved t))
moved))
(defun kotl-mode:last-sibling ()
"Move point to the last sibling of the present cell.
Leave point at the start of the cell or at its present position if it is
already within the last sibling cell."
(interactive)
(kotl-mode:maintain-region-highlight)
(let ((label-sep-len (kview:label-separator-length kview)))
(if (save-excursion (kcell-view:forward nil label-sep-len))
;; Enable user to return to this previous position if desired.
(push-mark nil 'no-msg))
(while (kcell-view:forward nil label-sep-len))))
(defun kotl-mode:mark-paragraph ()
"Put point at beginning of this paragraph, mark at end.
The paragraph marked is the one that contains point or follows point."
(interactive)
(forward-paragraph 1)
(kotl-mode:to-valid-position t)
(push-mark nil t t)
(backward-paragraph 1)
(kotl-mode:to-valid-position))
(defun kotl-mode:mark-whole-buffer ()
"Put point at first editable character in buffer and mark at the last such character."
(interactive)
(push-mark (point))
(kotl-mode:end-of-buffer)
(push-mark (point) nil t)
(kotl-mode:beginning-of-buffer))
(defun kotl-mode:next-cell (arg)
"Move to prefix ARGth next cell (any level) within current view."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(if (< arg 0)
(kotl-mode:previous-cell (- arg))
(let ((next (= arg 0))
(label-sep-len (kview:label-separator-length kview)))
(while (and (> arg 0) (setq next (kcell-view:next t label-sep-len)))
(setq arg (1- arg)))
(if next
arg
(error "(kotl-mode:next-cell): Last cell")))))
(defun kotl-mode:next-line (arg)
"Move point to ARGth next line and return point."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(kotl-mode:set-temp-goal-column)
(let ((orig-arg arg))
(cond ((> arg 0)
(while (and (> arg 0) (= 0 (kfill:forward-line 1)))
(cond ((kotl-mode:eobp)
(kfill:forward-line -1)
(goto-char (kcell-view:end-contents))
(and (called-interactively-p 'interactive) (= orig-arg arg)
(message "(kotl-mode:next-line): End of buffer") (beep))
(setq arg 0))
;; Visible blank line between cells
((and (looking-at "^$") (not (eq (kproperty:get (point) 'invisible) t)))
nil) ;; Don't count this line.
(t (setq arg (1- arg)))))
(kotl-mode:line-move 0)
(kotl-mode:to-valid-position))
((< arg 0)
(kotl-mode:previous-line (- arg)))))
(setq this-command 'next-line)
(point))
(defun kotl-mode:next-tree ()
"Move past current tree to next tree, or to last cell in tree if no next tree.
Return non-nil iff there is a next tree within this koutline."
(let ((start-indent (kcell-view:indent))
(label-sep-len (kview:label-separator-length kview))
(same-tree t))
(while (and (kcell-view:next nil label-sep-len)
(setq same-tree (< start-indent
(kcell-view:indent nil label-sep-len)))))
(not same-tree)))
(defun kotl-mode:previous-line (arg)
"Move point to ARGth previous line and return point."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(kotl-mode:set-temp-goal-column)
(let ((orig-arg arg))
(cond ((> arg 0)
(while (and (> arg 0) (= 0 (kfill:forward-line -1)))
(cond ((kotl-mode:bobp)
(kotl-mode:beginning-of-cell)
(and (called-interactively-p 'interactive) (= orig-arg arg)
(message "(kotl-mode:previous-line): Beginning of buffer") (beep))
(setq arg 0))
;; Visible blank line between cells
((and (looking-at "^$") (not (eq (kproperty:get (point) 'invisible) t)))
nil) ;; Don't count this line.
(t (setq arg (1- arg)))))
(kotl-mode:line-move 0)
(kotl-mode:to-valid-position))
((< arg 0)
(kotl-mode:next-line (- arg)))))
(setq this-command 'previous-line)
(point))
(defun kotl-mode:previous-cell (arg)
"Move to prefix ARGth previous cell (any level) within current view."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(if (< arg 0)
(kotl-mode:next-cell (- arg))
(let ((previous (= arg 0))
(label-sep-len (kview:label-separator-length kview)))
(while (and (> arg 0) (setq previous
(kcell-view:previous t label-sep-len)))
(setq arg (1- arg)))
(if previous
arg
(error "(kotl-mode:previous-cell): First cell")))))
(defun kotl-mode:scroll-down (&optional arg)
"Scroll text of current window downward ARG lines; or a windowful if no ARG."
(interactive "P")
(if (eq major-mode 'kotl-mode)
(progn (kotl-mode:maintain-region-highlight)
(scroll-down arg)
(kotl-mode:to-valid-position t))
(scroll-down arg)))
(defun kotl-mode:scroll-up (&optional arg)
"Scroll text of current window upward ARG lines; or a windowful if no ARG."
(interactive "P")
(if (eq major-mode 'kotl-mode)
(progn (kotl-mode:maintain-region-highlight)
(scroll-up arg)
(kotl-mode:to-valid-position))
(scroll-up arg)))
(defun kotl-mode:tail-cell ()
"Move point to the start of the last visible cell at the same level as current cell and return t.
If at tail cell already, do nothing and return nil."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(let ((moved)
(label-sep-len (kview:label-separator-length kview)))
(while (kcell-view:forward t label-sep-len)
(setq moved t))
moved))
(defun kotl-mode:up-level (arg)
"Move up prefix ARG levels higher in current outline view."
(interactive "p")
(kotl-mode:maintain-region-highlight)
(if (< arg 0)
(kotl-mode:down-level (- arg))
;; Enable user to return to this previous position if desired.
(push-mark nil 'no-msg)
(let ((parent)
(label-sep-len (kview:label-separator-length kview))
result)
(while (and (> arg 0) (setq result (kcell-view:parent t label-sep-len)))
(or parent (setq parent result))
(setq arg (if (eq result 0) 0 (1- arg))))
;; Signal an error if couldn't move up at least 1 parent level.
(or (and parent (not (eq parent 0)))
(progn
(goto-char (hypb:mark t))
(pop-mark)
(error "(kotl-mode:up-level): No parent level to which to move")
)))))
;;; ------------------------------------------------------------------------
;;; Predicates
;;; ------------------------------------------------------------------------
(defun kotl-mode:bobp ()
"Return point if at the start of the first cell in kview, else nil."
(interactive)
(or (bobp)
(and (not (save-excursion (re-search-backward "[\n\r]" nil t)))
(kotl-mode:bolp))))
(defun kotl-mode:bocp ()
"Return point if at beginning of a kcell, else nil."
(and (kotl-mode:bolp)
(let ((begin-point (kcell-view:plist-point))
(bol))
(and begin-point
(save-excursion
;; If first line-begin is less than cell begin point,
;; then we know we are on the first line of the cell.
(if (setq bol (re-search-backward "^" nil t))
(<= bol begin-point)))))
(point)))
(defun kotl-mode:bolp ()
"Return point if at beginning of a kview line, else nil."
(if (= (current-column) (kcell-view:indent))
(point)))
(defun kotl-mode:buffer-empty-p ()
"Return non-nil iff there are no outline cells within current buffer."
(save-excursion
(goto-char (point-min))
(looking-at "[\n\r]*\\'")))
(defun kotl-mode:eobp ()
"Return point if after the end of the last cell in kview, else nil."
(interactive)
(if (looking-at "^[\n\r]*\\'") (point)))
(defun kotl-mode:eocp ()
"Return point if in a visible position at the end of a kview cell, else nil."
(and (or (eobp)
(looking-at "[\n\r]+\\'")
(and (kotl-mode:eolp)
(save-excursion
(skip-chars-forward "\n\r")
(kotl-mode:to-start-of-line)
(kotl-mode:bocp))))
(point)))
(defun kotl-mode:eolp ()
"Return t if point is at the end of a visible line or the end of the buffer."
(or (eobp)
(and (eolp)
(or (not (kview:char-invisible-p))
(not (kview:char-invisible-p (1- (point)))))
t)))
(defun kotl-mode:first-cell-p ()
"Return t iff point is on the first cell of the outline."
(save-excursion (not (kcell-view:previous))))
(defalias 'kotl-mode:first-line-p 'first-line-p)
(defun kotl-mode:last-cell-p ()
"Return t iff point is on the last cell of the outline."
(save-excursion (not (kcell-view:next))))
(defun kotl-mode:last-line-p ()
"Return t iff point is on the last line of the outline."
(save-excursion
(kotl-mode:to-end-of-line)
(looking-at "\n*\\'")))
;;; ------------------------------------------------------------------------
;;; Smart Key Support
;;; ------------------------------------------------------------------------
(defun kotl-mode:action-key ()
"Collapses, expands, links to, and scrolls through koutline cells.
Invoked via a key press when in kotl-mode. It assumes that its caller has
already checked that the key was pressed in an appropriate buffer and has
moved the cursor to the selected buffer.
If key is pressed:
(1) at the end of buffer, uncollapse and unhide all cells in view;
(2) within a cell, if its subtree is hidden then show it,
otherwise hide it;
(3) between cells or within the read-only indentation region to the left of
a cell, then move point to prior location and begin creation of a
klink to some other outline cell; hit the Action Key twice to select the
link referent cell;
(4) anywhere else, invoke `action-key-eol-function', typically to scroll up
a windowful."
(interactive)
(cond ((kotl-mode:eobp) (kotl-mode:show-all))
((kotl-mode:eolp) (funcall action-key-eol-function))
((not (kview:valid-position-p))
(if (markerp action-key-depress-prev-point)
(progn (select-window
(get-buffer-window
(marker-buffer action-key-depress-prev-point)))
(goto-char (marker-position action-key-depress-prev-point))
(call-interactively 'klink:create))
(kotl-mode:to-valid-position)
(error "(kotl-mode:action-key): Action Key released at invalid position")))
(t ;; On a cell line (not at the end of line).
(if (smart-outline-subtree-hidden-p)
(kotl-mode:show-tree)
(kotl-mode:hide-tree))))
(kotl-mode:to-valid-position))
(defun kotl-mode:assist-key ()
"Displays properties of koutline cells, collapses all cells, and scrolls back.
Invoked via an assist-key press when in kotl-mode. It assumes that its caller
has already checked that the assist-key was pressed in an appropriate buffer
and has moved the cursor to the selected buffer.
If assist-key is pressed:
(1) at the end of buffer, collapse all cells and hide all non-level-one
cells;
(2) on a header line but not at the beginning or end, display properties of
each cell in tree beginning at point;
(3) between cells or within the read-only indentation region to the left of
a cell, then move point to prior location and prompt to move one tree to
a new location in the outline; hit the Action Key twice to select the
tree to move and where to move it;
(4) anywhere else, invoke `assist-key-eol-function', typically to scroll down
a windowful."
(interactive)
(cond ((kotl-mode:eobp) (kotl-mode:overview))
((kotl-mode:eolp) (funcall assist-key-eol-function))
((not (kview:valid-position-p))
(if (markerp assist-key-depress-prev-point)
(progn (select-window
(get-buffer-window
(marker-buffer assist-key-depress-prev-point)))
(goto-char (marker-position
assist-key-depress-prev-point))
(call-interactively 'kotl-mode:move-after))
(kotl-mode:to-valid-position)
(error "(kotl-mode:assist-key): Help Key released at invalid position")))
((not (bolp))
;; On an outline header line but not at the start/end of line,
;; show attributes for tree at point.
(kotl-mode:cell-help (kcell-view:label) (or current-prefix-arg 2)))
((smart-scroll-down)))
(kotl-mode:to-valid-position))
;;; ------------------------------------------------------------------------
;;; Structure Editing
;;; ------------------------------------------------------------------------
(defun kotl-mode:add-child ()
"Add a new cell to current kview as first child of current cell."
(interactive "*")
(kotl-mode:add-cell '(4)))
(defun kotl-mode:add-parent ()
"Add a new cell to current kview as sibling of current cell's parent."
(interactive "*")
(kotl-mode:add-cell -1))
(defun kotl-mode:add-cell (&optional relative-level contents plist no-fill)
"Add a cell following current cell at optional RELATIVE-LEVEL with CONTENTS string, attributes in PLIST, a property list, and NO-FILL flag to prevent any filling of CONTENTS.
Optional prefix arg RELATIVE-LEVEL means add as sibling if nil or >= 0, as
child if equal to universal argument, {C-u}, and as sibling of current cell's
parent, otherwise. If added as sibling of current level, RELATIVE-LEVEL is
used as a repeat count for the number of cells to add.
Return last newly added cell."
(interactive "*P")
(or (stringp contents) (setq contents nil))
(let ((klabel (kcell-view:label))
(label-sep-len (kview:label-separator-length kview))
cell-level new-cell sibling-p child-p start parent
cells-to-add)
(setq cell-level (kcell-view:level nil label-sep-len)
child-p (equal relative-level '(4))
sibling-p (and (not child-p)
(cond ((not relative-level) 1)
((>= (prefix-numeric-value relative-level) 0)
(prefix-numeric-value relative-level))))
cells-to-add (or sibling-p 1))
(if child-p
(setq cell-level (1+ cell-level))
(unless sibling-p
;; Add as following sibling of current cell's parent.
;; Move to parent.
(setq cell-level (1- cell-level)
start (point)
parent (kcell-view:parent nil label-sep-len))
(if (not (eq parent t))
(progn
(goto-char start)
(error
"(kotl-mode:add-cell): No higher level at which to add cell.")
)))
;; Skip from point past any children to next cell.
(if (kotl-mode:next-tree)
;; If found a new tree, then move back to prior cell so can add
;; new cell after it.
(kcell-view:previous nil label-sep-len)))
(goto-char (kcell-view:end))
;;
;; Insert new cells into view.
(if (= cells-to-add 1)
(setq klabel
(cond (sibling-p
(klabel:increment klabel))
(child-p
(kview:id-increment kview)
(klabel:child klabel))
;; add as sibling of parent of current cell
(t (klabel:increment (klabel:parent klabel))))
new-cell (kview:add-cell klabel cell-level contents plist
(or no-fill sibling-p
(not kotl-mode:refill-flag))))
;;
;; sibling-p must be true if we are looping here so there is no need to
;; conditionalize how to increment the labels.
(while (>= (setq cells-to-add (1- cells-to-add)) 0)
(setq klabel (klabel:increment klabel)
;; Since new cells are at the same level as old one, don't fill
;; any of their intial contents.
new-cell (kview:add-cell klabel cell-level contents plist t))))
;;
;; Move back to last inserted cell and then move to its following
;; sibling if any.
(kotl-mode:to-valid-position t)
(save-excursion
(if (kcell-view:forward t label-sep-len)
(let ((label-type (kview:label-type kview)))
(if (memq label-type '(alpha legal partial-alpha))
;; Update the labels of these siblings and their subtrees.
(klabel-type:update-labels (klabel:increment klabel))))))
;;
;; Leave point within last newly added cell and return this cell.
(kotl-mode:beginning-of-cell)
new-cell))
(defun kotl-mode:demote-tree (arg)
"Move current tree a maximum of prefix ARG levels lower in current view.
Each cell is refilled iff its `no-fill' attribute is nil and
kotl-mode:refill-flag is non-nil. With prefix ARG = 0, cells are demoted up
to one level and kotl-mode:refill-flag is treated as true."
(interactive "*p")
(if (< arg 0)
(kotl-mode:promote-tree (- arg))
(let* ((label-sep-len (kview:label-separator-length kview))
(orig-id (kcell-view:idstamp))
(fill-p (= arg 0))
(orig-pos-in-cell
(- (point) (kcell-view:start (point) label-sep-len)))
start-level start-point prev prev-level)
;; Next line ensures point is in the root of the current tree if
;; the tree is at all hidden.
(kotl-mode:to-start-of-line)
(setq start-point (point)
start-level (kcell-view:level start-point label-sep-len))
(if fill-p (setq arg 1))
(unwind-protect
(progn
(backward-char 1)
(while (and (> arg 0)
(setq prev
(kcell-view:previous nil label-sep-len)))
(if prev
(progn (setq prev-level
(kcell-view:level (point) label-sep-len))
(cond ((> prev-level (+ start-level arg))
;; Don't want to demote this far
;; so keep looking at prior nodes.
nil)
((= arg (- prev-level start-level))
;; Demote to be sibling of this kcell.
(setq arg -1))
((< prev-level start-level)
;; prev is at higher level then
;; orig, so can't demote
(setq prev nil
arg 0))
(t
;; Demote below this kcell. This is
;; as far we can demote, though it may
;; not be the full amount of arg.
(setq arg 0))))))
(if prev
(kotl-mode:move-after
(kcell-view:label start-point)
(kcell-view:label) (= arg 0)
nil fill-p)))
;; Move to start of original cell
(kotl-mode:goto-cell orig-id)
;; Move to original pos within cell
(forward-char (min orig-pos-in-cell
(- (kcell-view:end-contents)
(kcell-view:start))))
(kotl-mode:to-valid-position))
(if (not prev)
(error "(kotl-mode:demote-tree): Cannot demote any further")))))
(defun kotl-mode:exchange-cells (cell-ref-1 cell-ref-2)
"Exchange CELL-REF-1 with CELL-REF-2 in current view. Don't move point."
(interactive
(let ((hargs:defaults
(save-excursion
(list (kcell-view:label)
(cond
((kcell-view:previous t)
(kcell-view:label))
((kcell-view:next t)
(kcell-view:label))
(t (error
"(kotl-mode:exchange-cells): No two visible cells available")))))))
(hargs:iform-read
'(interactive "*+KExchange cell: \n+KExchange cell <%s> with cell: "))))
(save-excursion
(let (kcell-1 contents-1
kcell-2 contents-2)
;;
;; Save cell-1 attributes
(kotl-mode:goto-cell cell-ref-1 t)
(setq kcell-1 (kcell-view:cell)
contents-1 (kcell-view:contents))
;;
;; Save cell-2 attributes
(kotl-mode:goto-cell cell-ref-2 t)
(setq kcell-2 (kcell-view:cell)
contents-2 (kcell-view:contents))
;;
;; Substitute cell-1 attributes into cell-2 location.
;;
;; Set kcell properties.
(kcell-view:set-cell kcell-1)
;; If idstamp labels are on, then must exchange labels in view.
(if (eq (kview:label-type kview) 'id)
(klabel:set (kcell-view:idstamp)))
;; Exchange cell contents.
(delete-region (kcell-view:start) (kcell-view:end-contents))
(insert
(hypb:replace-match-string
"\\([\n\r]\\)"
contents-1 (concat "\\1" (make-string (kcell-view:indent) ?\ ))))
(if kotl-mode:refill-flag (kotl-mode:fill-cell))
;;
;; Substitute cell-2 attributes into cell-1 location.
;;
;; Set kcell properties.
(kotl-mode:goto-cell cell-ref-1 t)
(kcell-view:set-cell kcell-2)
;; If idstamp labels are on, then must exchange labels in view.
(if (eq (kview:label-type kview) 'id)
(klabel:set (kcell-view:idstamp)))
;; Exchange cell contents.
(delete-region (kcell-view:start) (kcell-view:end-contents))
;; Add indentation to all but first line.
(insert
(hypb:replace-match-string
"\\([\n\r]\\)"
contents-2 (concat "\\1" (make-string (kcell-view:indent) ?\ ))))
(if kotl-mode:refill-flag (kotl-mode:fill-cell)))))
(defun kotl-mode:kill-contents (arg)
"Kill contents of cell from point to cell end.
With prefix ARG, kill entire cell contents."
(interactive "*P")
(kotl-mode:kill-region
(if arg (kcell-view:start) (point))
(kcell-view:end-contents)))
(defun kotl-mode:kill-tree (&optional arg)
"Kill ARG following trees starting with tree rooted at point.
If ARG is a non-positive number, nothing is done."
(interactive "*p")
(or (integerp arg) (setq arg 1))
(let ((killed) (label (kcell-view:label))
(label-sep-len (kview:label-separator-length kview))
start end sib)
(while (> arg 0)
(setq start (kotl-mode:tree-start)
end (kotl-mode:tree-end)
sib (kcell-view:sibling-p nil nil label-sep-len)
arg (1- arg)
killed t)
;; Don't want to delete any prior cells, so if on last cell, ensure
;; this is the last one killed.
(if (kotl-mode:last-cell-p)
(progn (setq arg 0)
(kview:delete-region start end))
(kview:delete-region start end)
(kotl-mode:to-valid-position)))
(if killed
(progn
(cond (sib (klabel-type:update-labels label))
((kotl-mode:buffer-empty-p)
;; Always leave at least 1 visible cell within a view.
(kview:add-cell "1" 1)))
(kotl-mode:to-valid-position)))))
(defun kotl-mode:mail-tree (cell-ref invisible-flag)
"Mail outline tree rooted at CELL-REF. Use \"0\" for whole outline buffer.
Invisible text is expanded and included in the mail only if INVISIBLE-FLAG is
non-nil."
(interactive
;; FIXME: Why use `hargs:iform-read' here?
;; Why compute `label-default' before calling `hargs:iform-read'?
(let ((label-default (kcell-view:label)))
(hargs:iform-read
`(interactive
(list
(hargs:read "Mail tree: (0 for whole outline) "
nil ',label-default nil 'kcell)
(y-or-n-p "Include invisible text? "))))))
(if (equal cell-ref "0")
(hmail:buffer nil invisible-flag)
(let (start end)
(save-excursion
(kotl-mode:goto-cell cell-ref t)
(forward-line 0)
(setq start (point))
(kotl-mode:to-valid-position)
(setq end (kotl-mode:tree-end)))
(hmail:region start end nil invisible-flag))))
(defun kotl-mode:promote-tree (arg)
"Move current tree a maximum of prefix ARG levels higher in current view.
Each cell is refilled iff its `no-fill' attribute is nil and
kotl-mode:refill-flag is non-nil. With prefix ARG = 0, cells are promoted up
to one level and kotl-mode:refill-flag is treated as true."
(interactive "*p")
(if (< arg 0)
(kotl-mode:demote-tree (- arg))
(let* ((parent) (result)
(label-sep-len (kview:label-separator-length kview))
(orig-id (kcell-view:idstamp))
(fill-p (= arg 0))
(orig-pos-in-cell
(- (point) (kcell-view:start nil label-sep-len)))
start-point)
;; Next line ensures point is in the root of the current tree if
;; the tree is at all hidden.
(kotl-mode:to-start-of-line)
(setq start-point (point))
(if fill-p (setq arg 1))
(unwind-protect
(progn
(backward-char 1)
(while (and (> arg 0)
(setq result (kcell-view:parent nil label-sep-len))
(not (eq result 0)))
(setq parent result
arg (1- arg)))
(if parent
(kotl-mode:move-after
(kcell-view:label start-point)
(kcell-view:label) nil
nil fill-p)))
;; Move to start of original cell
(kotl-mode:goto-cell orig-id)
;; Move to original pos within cell
(forward-char (min orig-pos-in-cell
(- (kcell-view:end-contents)
(kcell-view:start))))
(kotl-mode:to-valid-position))
(if (not parent)
(error "(kotl-mode:promote-tree): Cannot promote any further")))))
(defun kotl-mode:remove-cell-attribute (attribute &optional pos)
"Remove ATTRIBUTE from the current cell or the cell at optional POS."
(interactive
(let* ((plist (copy-sequence (kcell-view:plist)))
(existing-attributes plist)
attribute)
(barf-if-buffer-read-only)
;; Remove attribute values leaving only attribute symbols in existing-attributes.
(while plist
(setcdr plist (cdr (cdr plist)))
(setq plist (cdr plist)))
;; Remove read-only attributes
(setq existing-attributes (apply #'set:create existing-attributes)
existing-attributes (set:difference
existing-attributes
kcell:read-only-attributes))
(while (zerop (length (setq attribute
(completing-read
(format "Name of attribute to remove from cell <%s>: "
(kcell-view:label))
(mapcar 'list
(mapcar 'symbol-name
existing-attributes))))))
(beep))
(setq attribute (intern attribute))
(list attribute nil)))
(barf-if-buffer-read-only)
(kcell-view:remove-attr attribute pos)
;; Note that buffer needs to be saved to store modified property list.
(set-buffer-modified-p t)
(if (called-interactively-p 'interactive)
(message "Attribute `%s' removed from cell <%s>."
attribute (kcell-view:label pos))))
(defun kotl-mode:set-cell-attribute (attribute value &optional pos)
"Include ATTRIBUTE VALUE with the current cell or the cell at optional POS.
Replace any existing value that ATTRIBUTE has.
When called interactively, display the setting in the minibuffer as
confirmation."
(interactive
(let* ((plist (copy-sequence (kcell-view:plist)))
(existing-attributes plist)
attribute value)
(barf-if-buffer-read-only)
;; Remove attribute values leaving only attribute symbols in existing-attributes.
(while plist
(setcdr plist (cdr (cdr plist)))
(setq plist (cdr plist)))
;; Remove read-only attributes
(setq existing-attributes (apply #'set:create existing-attributes)
existing-attributes (set:difference
existing-attributes
kcell:read-only-attributes))
(while (zerop (length (setq attribute
(completing-read
(format "Name of attribute to set in cell <%s>: "
(kcell-view:label))
(mapcar 'list
(mapcar 'symbol-name
existing-attributes))))))
(beep))
(setq attribute (intern attribute)
value (kcell-view:get-attr attribute))
(if value
(setq value (read-minibuffer
(format "Change the value of `%s' to: " attribute)
(prin1-to-string value)))
(setq value (read-minibuffer
(format "Set property `%s' to (use double quotes around a string): " attribute))))
(list attribute value nil)))
(barf-if-buffer-read-only)
(kcell-view:set-attr attribute value pos)
;; Note that buffer needs to be saved to store new attribute value.
(set-buffer-modified-p t)
(if (called-interactively-p 'interactive)
(message "Attribute `%s' set to `%s' in cell <%s>."
attribute value (kcell-view:label pos))))
(defun kotl-mode:set-or-remove-cell-attribute (arg)
"With prefix ARG, interactively run kotl-mode:remove-cell-attribute; otherwise, run kotl-mode:set-cell-attribute."
(interactive "P")
(call-interactively
(if arg #'kotl-mode:remove-cell-attribute #'kotl-mode:set-cell-attribute)))
(defun kotl-mode:split-cell (&optional arg)
"Split the current cell into two cells and move to the new cell.
The cell contents after point become part of the newly created cell.
The default is to create the new cell as a sibling of the current cell.
With optional universal ARG, {C-u}, the new cell is added as the child of
the current cell."
(interactive "*P")
(let ((new-cell-contents (kotl-mode:kill-region
(point) (kcell-view:end-contents) 'string))
(start (kcell-view:start)))
;; delete any preceding whitespace
(skip-chars-backward " \t\n\r" start)
(delete-region (max start (point)) (kcell-view:end-contents))
(kotl-mode:add-cell arg new-cell-contents (kcell-view:plist))))
(defun kotl-mode:transpose-cells (arg)
"Exchange current and previous visible cells, leaving point after both.
If no previous cell, exchange current with next cell.
With prefix ARG, take current tree and move it past ARG visible cells.
With prefix ARG = 0, interchange the cell that contains point with the cell
that contains mark."
(interactive "*p")
(let ((label-sep-len (kview:label-separator-length kview)))
(cond
((save-excursion (not (or (kcell-view:next t label-sep-len)
(kcell-view:previous t label-sep-len))))
(error "(kotl-mode:transpose-cells): Only one visible cell in outline"))
;;
;; Transpose current and previous cells or current and next cells, if no
;; previous cell. Leave point after both exchanged cells or within last
;; visible cell.
((= arg 1)
(let ((label-1 (kcell-view:label))
(prev (kcell-view:previous t label-sep-len))
label-2)
(or prev (kcell-view:next t label-sep-len))
(setq label-2 (kcell-view:label))
(kotl-mode:exchange-cells label-1 label-2)
(kcell-view:next t label-sep-len)
(if prev (kcell-view:next t label-sep-len))))
;;
;; Transpose point and mark cells, moving point to the new location of the
;; cell which originally contained point.
((= arg 0)
(let ((label-1 (kcell-view:label))
label-2)
(kotl-mode:exchange-point-and-mark)
(setq label-2 (kcell-view:label))
(kotl-mode:exchange-cells label-1 label-2)))
;;
;; Move current tree past ARG next visible cells and leave point after
;; original cell text.
(t
(let ((mark (set-marker (make-marker)
(save-excursion (kotl-mode:next-line arg)))))
(kotl-mode:move-after
(kcell-view:label)
(progn (while (and (> arg 0) (kcell-view:next t label-sep-len))
(setq arg (1- arg)))
(kcell-view:label))
nil)
(goto-char mark)
(set-marker mark nil))))))
;;; ------------------------------------------------------------------------
;;; Structure Viewing
;;; ------------------------------------------------------------------------
(defun kotl-mode:collapse-tree (&optional all-flag)
"Collapse to one line each visible cell of the tree rooted at point.
With optional prefix ALL-FLAG non-nil, collapse all cells visible
within the current view."
(interactive "P")
(kotl-mode:is-p)
(let ((inhibit-read-only t))
(kview:map-tree (lambda (_kview)
;; Use free variable label-sep-len bound in
;; kview:map-tree for speed.
(defvar label-sep-len)
(kcell-view:collapse nil label-sep-len))
kview all-flag t)))
(defun kotl-mode:expand-tree (&optional all-flag)
"Expand each visible cell of the tree rooted at point.
With optional prefix ALL-FLAG non-nil, expand all cells visible within
the current view."
(interactive "P")
(kotl-mode:is-p)
(let ((inhibit-read-only t))
(kview:map-tree
(lambda (_kview)
;; Use free variable label-sep-len bound in kview:map-tree for speed.
(defvar label-sep-len)
(goto-char (kcell-view:start (point) label-sep-len))
(outline-flag-region (point) (kcell-view:end-contents) nil))
kview all-flag t)))
(defun kotl-mode:toggle-tree-expansion (&optional all-flag)
"Collapse or expand each cell of tree rooted at point or all visible cells if optional prefix arg ALL-FLAG is given.
If current cell is collapsed, cells will be expanded, otherwise they will be
collapsed."
(interactive "P")
(if (kcell-view:collapsed-p)
;; expand cells
(kotl-mode:expand-tree all-flag)
(kotl-mode:collapse-tree all-flag)))
;;;
;;;###autoload
(defun kotl-mode:overview (&optional arg)
"Show the first line of each cell.
With optional prefix ARG, toggle display of blank lines between cells."
(interactive "P")
(kotl-mode:show-all)
(if arg (kvspec:toggle-blank-lines))
(kotl-mode:collapse-tree t))
;;;###autoload
(defun kotl-mode:show-all (&optional arg)
"Show (expand) all cells in the current view.
With optional prefix ARG, toggle display of blank lines between cells."
(interactive "P")
(if (kotl-mode:is-p)
(progn (kview:set-attr kview 'levels-to-show 0)
(kview:set-attr kview 'lines-to-show 0)
(outline-flag-region (point-min) (point-max) nil)
(if arg (kvspec:toggle-blank-lines))
(kvspec:update t))))
;;;###autoload
(defun kotl-mode:top-cells (&optional arg)
"Collapse all level 1 cells in view and hide any deeper sublevels.
With optional prefix ARG, toggle display of blank lines between cells."
(interactive "P")
(kotl-mode:is-p)
(let ((modified-p (buffer-modified-p))
(buffer-read-only))
(kvspec:levels-to-show 1)
(kvspec:show-lines-per-cell 1)
(if arg (kvspec:toggle-blank-lines))
(kvspec:activate)
;; Restore buffer modification status
(set-buffer-modified-p modified-p)))
;;;
(defun kotl-mode:hide-sublevels (levels-to-keep)
"Hide all cells in outline at levels deeper than LEVELS-TO-KEEP (a number).
Shows any hidden cells within LEVELS-TO-KEEP. 1 is the first level. 0 means
display all levels of cells. Interactively, prompts for LEVELS-TO-KEEP."
(interactive "P")
(kvspec:levels-to-show levels-to-keep)
;; The prior call might have shown more lines per cell than the current
;; viewspec supports, so reset lines per cell.
(kvspec:lines-to-show)
(kvspec:update t))
(defun kotl-mode:hide-subtree (&optional cell-ref show-flag)
"Hide subtree, ignoring root, at optional CELL-REF (defaults to cell at point).
With optional SHOW-FLAG, expand the subtree instead."
(interactive)
(kotl-mode:is-p)
(save-excursion
;; Next line ensures point is in the root of the current tree if
;; the tree is at all hidden.
(kotl-mode:to-start-of-line)
(if cell-ref
(kotl-mode:goto-cell cell-ref t)
(kotl-mode:beginning-of-cell))
(let ((start (kcell-view:end-contents))
(end (kotl-mode:tree-end t))
(buffer-read-only))
(outline-flag-region start end (not show-flag)))))
(defun kotl-mode:show-subtree (&optional cell-ref)
"Show subtree, ignoring root, at optional CELL-REF (defaults to cell at point)."
(interactive)
(kotl-mode:hide-subtree cell-ref t))
;;;###autoload
(defun kotl-mode:hide-tree (&optional cell-ref show-flag)
"Collapse tree rooted at optional CELL-REF (defaults to cell at point).
With optional SHOW-FLAG, expand the tree instead."
(interactive)
(kotl-mode:is-p)
(save-excursion
;; Next line ensures point is in the root of the current tree if
;; the tree is at all hidden.
(kotl-mode:to-start-of-line)
(let ((start (if cell-ref
(kotl-mode:goto-cell cell-ref t)
(kotl-mode:beginning-of-cell)))
(end (kotl-mode:tree-end t))
(buffer-read-only))
(and (not show-flag) (search-forward "\n" nil t)
;; Leave first line visible.
(setq start (1- (point))))
(outline-flag-region start end (not show-flag)))))
;;;###autoload
(defun kotl-mode:show-tree (&optional cell-ref)
"Display fully expanded tree rooted at CELL-REF."
(interactive)
(kotl-mode:hide-tree cell-ref t))
(defun kotl-mode:cell-attributes (all-flag)
"Display a temporary buffer with the attributes of the current kcell.
With prefix arg ALL-FLAG non-nil, display the attributes of all visible
kcells in the current buffer.
See also the documentation for `kotl-mode:cell-help'."
(interactive "P")
;; Ensure these do not invoke with-output-to-temp-buffer a second time.
(let ((temp-buffer-show-hook)
(temp-buffer-show-function))
(with-help-window (hypb:help-buf-name "Koutliner")
(save-excursion
(if (not all-flag)
(kotl-mode:print-attributes)
(let ((label-sep-len (kview:label-separator-length kview)))
(kotl-mode:beginning-of-buffer)
(while (progn (kotl-mode:print-attributes kview)
(kcell-view:next t label-sep-len)))))))))
(defun kotl-mode:cell-help (&optional cell-ref cells-flag)
"Display a temporary buffer with CELL-REF's attributes.
CELL-REF defaults to current cell.
Optional prefix arg CELLS-FLAG selects the cells to print:
If = 1, print CELL-REF's cell only;
If > 1, print CELL-REF's visible tree (the tree rooted at CELL-REF);
If < 1, print all visible cells in current view (CELL-REF is not used).
See also the documentation for `kotl-mode:cell-attributes'."
(interactive
(let* ((label (kcell-view:label))
(hargs:defaults (list label label)))
(append
(let ((arg (prefix-numeric-value current-prefix-arg)))
(if (< arg 1)
0
(hargs:iform-read
(list 'interactive
(format "+KDisplay properties of koutline %s: "
(if (= arg 1) "cell" "tree"))))))
(list current-prefix-arg))))
(or (integerp cells-flag)
(setq cells-flag (prefix-numeric-value cells-flag)))
(or (stringp cell-ref) (setq cell-ref (kcell-view:label)))
;; Ensure these do not invoke with-output-to-temp-buffer a second time.
(let ((temp-buffer-show-hook)
(temp-buffer-show-function))
(with-help-window (hypb:help-buf-name "Koutliner")
(save-excursion
(if (equal cell-ref "0")
(progn
(hattr:report (kcell:plist (kview:top-cell kview)))
(terpri)
(cond ((= cells-flag 1) nil)
((> cells-flag 1)
(kview:map-tree #'kotl-mode:print-attributes kview t t))
;; (< cells-flag 1)
(t (kotl-mode:cell-attributes t))))
(cond ((= cells-flag 1)
(kotl-mode:goto-cell cell-ref)
(kotl-mode:print-attributes))
((> cells-flag 1)
(kotl-mode:goto-cell cell-ref)
(kview:map-tree #'kotl-mode:print-attributes kview nil t))
;; (< cells-flag 1)
(t (kotl-mode:cell-attributes t))))))))
(defun kotl-mode:get-cell-attribute (attribute &optional pos)
"Return ATTRIBUTE's value for the current cell or the cell at optional POS.
When called interactively, it displays the value in the minibuffer."
(interactive "SCurrent cell attribute to get: ")
(let ((value (kcell-view:get-attr attribute pos)))
(if (called-interactively-p 'interactive)
(message "Attribute \"%s\" = `%s' in cell <%s>."
attribute value (kcell-view:label pos)))
value))
;;; ************************************************************************
;;; Private functions
;;; ************************************************************************
(defun kotl-mode:add-indent-to-region (&optional indent start end)
"Add current cell's indent to current region.
Optionally, INDENT and region START and END may be given."
(or (integerp indent) (setq indent (kcell-view:indent)))
(save-excursion
(save-restriction
(narrow-to-region (or start (point)) (or end (hypb:mark t)))
(goto-char (point-min))
(let ((indent-str (concat "\n" (make-string indent ?\ ))))
(while (search-forward "\n" t t)
(replace-match indent-str t t))))))
(defun kotl-mode:delete-line (&optional pos)
"Delete and return contents of cell line at point or optional POS as a string.
Does not delete newline at end of line."
(save-excursion
(if pos (goto-char pos))
(if (kview:valid-position-p)
(let ((bol (kotl-mode:to-start-of-line))
(eol (kotl-mode:to-end-of-line)))
(prog1
(buffer-substring bol eol)
(delete-region bol eol)))
(error "(kotl-mode:delete-line): Invalid position, `%d'" (point)))))
(defun kotl-mode:exchange-point-and-mark ()
"Put the mark where point is now, and point where the mark is now.
This is like exchange-point-and-mark, but doesn't activate the mark."
(goto-char (prog1 (hypb:mark t)
(set-marker (hypb:mark-marker t) (point) (current-buffer)))))
(defun kotl-mode:indent-line (&optional arg)
"Indent line relative to the previous one.
With optional prefix ARG greater than 1, tab forward ARG times.
See the documentation string of `kotl-mode:indent-tabs-mode' for details
on when tabs are used for indenting."
(interactive "*p")
(setq arg (prefix-numeric-value arg))
(let ((indent-tabs-mode kotl-mode:indent-tabs-mode))
(if (> arg 1)
(while (> arg 0)
(tab-to-tab-stop)
(setq arg (1- arg)))
(indent-relative))))
(defun kotl-mode:indent-region (start end)
(kotl-mode:maybe-shrink-region-p)
(indent-region start end nil))
;;;###autoload
(defun kotl-mode:is-p ()
"Signal an error if current buffer is not a Hyperbole outline, else return t."
(if (kview:is-p kview)
t
(hypb:error
"(kotl-mode:is-p): Command requires a valid Hyperbole koutline.")))
(defun kotl-mode:shrink-region ()
"If a region is active and outside the visible bounds of a single cell, shrink it to within those bounds.
The region then falls within the first visible cell that was part of
the region or that followed it. This prevents editing actions from
removing Koutline structure."
(interactive)
;; Caller has already tested for: (and (not (kotl-mode:valid-region-p)) (region-active-p))
;; Reduce the region to within the visible portion of a single cell
(let ((end (max (point) (mark)))
(exchange-p (> (point) (mark))))
(if exchange-p (kotl-mode:exchange-point-and-mark))
(kotl-mode:to-visible-position)
(setq end (kview:first-invisible-point))
(set-mark (min end (kcell-view:end-contents (point))))
(if exchange-p (kotl-mode:exchange-point-and-mark))))
(defun kotl-mode:valid-region-p ()
"Return t if there is no active region or if the region is within the visible bounds of a single cell, else nil."
(if (region-active-p)
(and (kview:valid-position-p (point))
(kview:valid-position-p (mark))
(>= (region-beginning) (kcell-view:start))
(<= (region-end) (kcell-view:end-contents))
(not (outline-invisible-in-p (region-beginning) (region-end))))
t))
(defun kotl-mode:maybe-shrink-region-p ()
"If `kotl-mode:shrink-region-flag' is non-nil, shrink any active region that includes hidden text or crosses cell boundaries.
The region then falls within the first visible cell that was part of the region or that followed it
Return t unless any region problem is left uncorrected, notably in
cases where `kotl-mode:shrink-region-flag' is nil."
;; This function is called from pre-command-hook, so don't trigger
;; any error as that will delete it from pre-command-hook and it
;; will no longer be called.
;;
(if (not (eq major-mode 'kotl-mode))
t
;; Deactivate empty region
(if (eq (point) (mark))
(deactivate-mark))
(if (not (kotl-mode:valid-region-p))
(if kotl-mode:shrink-region-flag
(progn (kotl-mode:shrink-region) t)
(message "(Hyperbole): Limit the region to a single visible cell or set `kotl-mode:shrink-region-flag'.")
(beep)
nil)
t)))
(defun kotl-mode:tree-end (&optional omit-end-newlines)
"Return end point of current cell's tree within this view.
If optional OMIT-END-NEWLINES is non-nil, point returned precedes any
newlines at end of tree."
(let* ((label-sep-len (kview:label-separator-length kview))
(start-indent (kcell-view:indent nil label-sep-len))
(next))
(save-excursion
(while (and (setq next (kcell-view:next nil label-sep-len))
(< start-indent (kcell-view:indent nil label-sep-len))))
(cond (next
(goto-char (progn (kcell-view:previous nil label-sep-len)
(kcell-view:end))))
(t (goto-char (kcell-view:end))))
(if omit-end-newlines (skip-chars-backward "\n\r"))
(point))))
(defun kotl-mode:tree-start ()
"Return beginning of line position preceding current cell's start point."
(save-excursion (goto-char (kcell-view:start)) (beginning-of-line)
(point)))
(defun kotl-mode:line-move (arg)
"Move point ARG visible lines forward within an outline."
(if (not selective-display)
(kfill:forward-line arg)
;; Move by arg lines, but ignore invisible ones.
(while (> arg 0)
(vertical-motion 1)
(forward-char -1)
(kfill:forward-line 1)
(setq arg (1- arg)))
(while (< arg 0)
(vertical-motion -1)
(beginning-of-line)
(setq arg (1+ arg))))
(let ((col (or goal-column (if (consp temporary-goal-column) (car temporary-goal-column)
temporary-goal-column))))
(move-to-column (if (numberp col) (round col) 0) nil)))
(defun kotl-mode:print-attributes (&optional _kview)
"Print to the `standard-output' stream the attributes of the current visible kcell.
Takes dummy argument KVIEW (so it can be used with `kview:map-tree')
but always operates upon the current view."
;; Move to start of visible cell to avoid printing attributes for an
;; invisible kcell which point may be over.
;; Print first line of cell for reference.
(save-excursion
(princ
(buffer-substring (progn (beginning-of-line) (point))
(progn (kview:end-of-actual-line)
(point)))))
(terpri)
(hattr:report (kcell:plist (kcell-view:cell)))
(terpri))
(put 'outline 'reveal-toggle-invisible 'kotl-mode:reveal-toggle-invisible)
(defun kotl-mode:isearch-open-invisible (_overlay)
(kotl-mode:show-tree))
;; Adapted from outline-reveal-toggle-invisible; called by isearch.
(defun kotl-mode:reveal-toggle-invisible (o hidep)
(if (not (eq major-mode 'kotl-mode))
(outline-reveal-toggle-invisible o hidep)
(save-excursion
(goto-char (overlay-start o))
(if hidep
;; When hiding the area again, we could just clean it up and let
;; reveal do the rest, by simply doing:
;; (remove-overlays (overlay-start o) (overlay-end o)
;; 'invisible 'outline)
;;
;; That works fine as long as everything is in sync, but if the
;; structure of the document is changed while revealing parts of it,
;; the resulting behavior can be ugly. I.e. we need to make
;; sure that we hide exactly a subtree.
(let ((end (overlay-end o)))
(delete-overlay o)
(while (progn
(kotl-mode:hide-subtree)
(kotl-mode:to-visible-position)
(and (not (kotl-mode:eobp)) (< (point) end)))))
;; When revealing, we just need to reveal sublevels. If point is
;; inside one of the sublevels, reveal will call us again.
;; But we need to preserve the original overlay.
(let ((o1 (copy-overlay o)))
(overlay-put o 'invisible nil) ;Show (most of) the text.
(while (progn
(kotl-mode:show-tree)
;; Normally just the above is needed.
;; But in odd cases, the above might fail to show anything.
;; To avoid an infinite loop, we have to make sure that
;; *something* gets shown.
(and (equal (overlay-start o) (overlay-start o1))
(< (point) (overlay-end o))
(= 0 (kfill:forward-line 1)))))
;; If still nothing was shown, just kill the damn thing.
(when (equal (overlay-start o) (overlay-start o1))
;; I've seen it happen at the end of buffer.
(delete-overlay o1)))))))
(defun kotl-mode:set-temp-goal-column ()
(if (not (or (eq last-command 'next-line)
(eq last-command 'previous-line)))
(setq temporary-goal-column
(if (and track-eol (kotl-mode:eolp)
;; Don't count beg of empty line as end of line
;; unless we just did explicit end-of-line.
(or (not (bolp)) (eq last-command 'end-of-line)))
9999
(current-column)))))
(defun kotl-mode:to-visible-position (&optional backward-p)
"Move point to the nearest visible and editable position within the current koutline view.
With optional BACKWARD-P, move backward if possible to get to valid position."
;; Empty, visible cell
(unless (and (kotl-mode:bocp) (kotl-mode:eocp) (not (kcell-view:invisible-p (point))))
(if (if backward-p
(kview:char-invisible-p (1- (point)))
(kview:char-invisible-p))
(goto-char (if backward-p
(kview:previous-visible-point)
(kview:first-visible-point))))
(kotl-mode:to-valid-position backward-p)))
(defun kotl-mode:to-valid-position (&optional backward-p)
"Move point to the nearest editable position within the current koutline view.
With optional BACKWARD-P, move backward if possible to get to valid position."
(unless (kview:valid-position-p)
(let ((label-sep-len (kview:label-separator-length kview)))
(cond ((kotl-mode:bobp)
(goto-char (kcell-view:start nil label-sep-len)))
((kotl-mode:eobp)
(skip-chars-backward "\n\r"))
(t (let ((indent (kcell-view:indent nil label-sep-len)))
(if (bolp)
(if backward-p
(skip-chars-backward "\n\r")
(skip-chars-forward "\n\r")))
(setq indent (kcell-view:indent nil label-sep-len))
(if (< (current-column) indent)
(move-to-column indent))))))))
(defun kotl-mode:transpose-lines-internal (start end)
"Transpose lines at START and END markers within an outline.
Leave point at end of line now residing at START."
(if (and start end
(kview:valid-position-p start)
(kview:valid-position-p end))
(let* ((pline (kotl-mode:delete-line start))
mline)
(goto-char end)
(setq mline (kotl-mode:delete-line))
(insert pline)
(goto-char start)
(insert mline))
;; Set non-point and non-mark markers to point nowhere before signalling
;; an error.
(or (eq start (point-marker))
(eq start (hypb:mark-marker t))
(set-marker start nil))
(or (eq end (point-marker))
(eq end (hypb:mark-marker t))
(set-marker start nil))
(error "(kotl-mode:transpose-lines): Point or mark is at an invalid position")))
(defun kotl-mode:update-buffer ()
"Update current view buffer in preparation for saving."
(if (kview:is-p kview)
(let ((mod-p (buffer-modified-p))
(start (window-start)))
(save-excursion
(kfile:update)
(set-buffer-modified-p mod-p))
(set-window-start nil (max (point-min) start) t)
nil)))
(defun kotl-mode:maintain-region-highlight ()
(if (featurep 'xemacs)
(setq zmacs-region-stays t) ;; Maintain region highlight for XEmacs.
;; FIXME: If the user set transient-mark-mode to nil, we shouldn't override
;; his choice!
;; FIXME: The way to prevent auto-deactivation of the region after buffer
;; modifications is by let-binding `deactivate-mark' around the code
;; modifying the buffer.
(setq transient-mark-mode t))) ;; For GNU Emacs
;;; ------------------------------------------------------------------------
;; When delete-selection-mode (pending-delete-mode) is enabled, make
;; these commands delete the region.
(put 'kotl-mode:quoted-insert 'delete-selection t)
(put 'kotl-mode:yank 'delete-selection 'yank)
(put 'kotl-mode:clipboard-yank 'delete-selection 'yank)
(put 'kimport:insert-register 'delete-selection t)
(put 'kotl-mode:delete-backward-char 'delete-selection 'supersede)
(put 'kotl-mode:delete-forward-char 'delete-selection 'supersede)
(put 'kotl-mode:delete-char 'delete-selection 'supersede)
(put 'kotl-mode:reindent-then-newline-and-indent 'delete-selection t)
(put 'kotl-mode:newline-and-indent 'delete-selection t)
(put 'kotl-mode:newline 'delete-selection t)
(put 'kotl-mode:electric-newline-and-maybe-indent 'delete-selection t)
(put 'kotl-mode:open-line 'delete-selection t)
(defun delete-selection-pre-hook ()
"Function run before commands that delete selections are executed.
Commands which will delete the selection need a `delete-selection'
property on their symbol; commands which insert text but don't
have this property won't delete the selection.
See `delete-selection-helper'."
(when (and delete-selection-mode (use-region-p)
(not buffer-read-only))
(let ((deletion-type (and (symbolp this-command)
(get this-command 'delete-selection))))
(if (and deletion-type (kotl-mode:maybe-shrink-region-p))
(delete-selection-helper deletion-type)))))
(provide 'kotl-mode)
;;; kotl-mode.el ends here
|