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
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
| | ;;; cus-edit.el --- tools for customizing Emacs and Lisp packages
;;
;; Copyright (C) 1996-1997, 1999-2013 Free Software Foundation, Inc.
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Maintainer: FSF
;; Keywords: help, faces
;; Package: emacs
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; This file implements the code to create and edit customize buffers.
;;
;; See `custom.el'.
;; No commands should have names starting with `custom-' because
;; that interferes with completion. Use `customize-' for commands
;; that the user will run with M-x, and `Custom-' for interactive commands.
;; The identity of a customize option is represented by a Lisp symbol.
;; The following values are associated with an option.
;; 0. The current value.
;; This is the value of the option as seen by "the rest of Emacs".
;; Usually extracted by 'default-value', but can be extracted with
;; different means if the option symbol has the 'custom-get'
;; property. Similarly, set-default (or the 'custom-set' property)
;; can set it.
;; 1. The widget value.
;; This is the value shown in the widget in a customize buffer.
;; 2. The customized value.
;; This is the last value given to the option through customize.
;; It is stored in the 'customized-value' property of the option, in a
;; cons-cell whose car evaluates to the customized value.
;; 3. The saved value.
;; This is last value saved from customize.
;; It is stored in the 'saved-value' property of the option, in a
;; cons-cell whose car evaluates to the saved value.
;; 4. The standard value.
;; This is the value given in the 'defcustom' declaration.
;; It is stored in the 'standard-value' property of the option, in a
;; cons-cell whose car evaluates to the standard value.
;; 5. The "think" value.
;; This is what customize thinks the current value should be.
;; This is the customized value, if any such value exists, otherwise
;; the saved value, if that exists, and as a last resort the standard
;; value.
;; The reason for storing values unevaluated: This is so you can have
;; values that depend on the environment. For example, you can have a
;; variable that has one value when Emacs is running under a window
;; system, and another value on a tty. Since the evaluation is only done
;; when the variable is first initialized, this is only relevant for the
;; saved (and standard) values, but affect others values for
;; compatibility.
;; You can see (and modify and save) this unevaluated value by selecting
;; "Show Saved Lisp Expression" from the Lisp interface. This will
;; give you the unevaluated saved value, if any, otherwise the
;; unevaluated standard value.
;; The possible states for a customize widget are:
;; 0. unknown
;; The state has not been determined yet.
;; 1. modified
;; The widget value is different from the current value.
;; 2. changed
;; The current value is different from the "think" value.
;; 3. set
;; The "think" value is the customized value.
;; 4. saved
;; The "think" value is the saved value.
;; 5. standard
;; The "think" value is the standard value.
;; 6. rogue
;; There is no standard value. This means that the variable was
;; not defined with defcustom, nor handled in cus-start.el. Most
;; standard interactive Custom commands do not let you create a
;; Custom buffer containing such variables. However, such Custom
;; buffers can be created, for instance, by calling
;; `customize-apropos' with a prefix arg or by calling
;; `customize-option' non-interactively.
;; 7. hidden
;; There is no widget value.
;; 8. mismatch
;; The widget value is not valid member of the :type specified for the
;; option.
;;; Code:
(require 'cus-face)
(require 'wid-edit)
(defvar custom-versions-load-alist) ; from cus-load
(defvar recentf-exclude) ; from recentf.el
(condition-case nil
(require 'cus-load)
(error nil))
(condition-case nil
(require 'cus-start)
(error nil))
(put 'custom-define-hook 'custom-type 'hook)
(put 'custom-define-hook 'standard-value '(nil))
(custom-add-to-group 'customize 'custom-define-hook 'custom-variable)
;;; Customization Groups.
(defgroup emacs nil
"Customization of the One True Editor."
:link '(custom-manual "(emacs)Top"))
;; Most of these groups are stolen from `finder.el',
(defgroup editing nil
"Basic text editing facilities."
:group 'emacs)
(defgroup convenience nil
"Convenience features for faster editing."
:group 'emacs)
(defgroup files nil
"Support for editing files."
:group 'emacs)
(defgroup wp nil
"Support for editing text files."
:tag "Text"
:group 'emacs)
(defgroup data nil
"Support for editing binary data files."
:group 'emacs)
(defgroup abbrev nil
"Abbreviation handling, typing shortcuts, macros."
:tag "Abbreviations"
:group 'convenience)
(defgroup matching nil
"Various sorts of searching and matching."
:group 'editing)
(defgroup emulations nil
"Emulations of other editors."
:link '(custom-manual "(emacs)Emulation")
:group 'editing)
(defgroup mouse nil
"Mouse support."
:group 'editing)
(defgroup outlines nil
"Support for hierarchical outlining."
:group 'wp)
(defgroup external nil
"Interfacing to external utilities."
:group 'emacs)
(defgroup comm nil
"Communications, networking, and remote access to files."
:tag "Communication"
:group 'emacs)
(defgroup processes nil
"Process, subshell, compilation, and job control support."
:group 'external)
(defgroup programming nil
"Support for programming in other languages."
:group 'emacs)
(defgroup languages nil
"Modes for editing programming languages."
:group 'programming)
(defgroup lisp nil
"Lisp support, including Emacs Lisp."
:link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
:group 'languages
:group 'development)
(defgroup c nil
"Support for the C language and related languages."
:link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
:link '(custom-manual "(ccmode)")
:group 'languages)
(defgroup tools nil
"Programming tools."
:group 'programming)
(defgroup applications nil
"Applications written in Emacs."
:group 'emacs)
(defgroup calendar nil
"Calendar and time management support."
:group 'applications)
(defgroup mail nil
"Modes for electronic-mail handling."
:group 'applications)
(defgroup news nil
"Reading and posting to newsgroups."
:link '(custom-manual "(gnus)")
:group 'applications)
(defgroup games nil
"Games, jokes and amusements."
:group 'applications)
(defgroup development nil
"Support for further development of Emacs."
:group 'emacs)
(defgroup docs nil
"Support for Emacs documentation."
:group 'development)
(defgroup extensions nil
"Emacs Lisp language extensions."
:group 'development)
(defgroup internal nil
"Code for Emacs internals, build process, defaults."
:group 'development)
(defgroup maint nil
"Maintenance aids for the Emacs development group."
:tag "Maintenance"
:group 'development)
(defgroup environment nil
"Fitting Emacs with its environment."
:group 'emacs)
(defgroup hardware nil
"Support for interfacing with miscellaneous hardware."
:group 'environment)
(defgroup terminals nil
"Support for terminal types."
:group 'environment)
(defgroup unix nil
"Interfaces, assistants, and emulators for UNIX features."
:group 'environment)
(defgroup i18n nil
"Internationalization and alternate character-set support."
:link '(custom-manual "(emacs)International")
:group 'environment
:group 'editing)
(defgroup x nil
"The X Window system."
:group 'environment)
(defgroup frames nil
"Support for Emacs frames and window systems."
:group 'environment)
(defgroup tex nil
"Code related to the TeX formatter."
:link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
:group 'wp)
(defgroup faces nil
"Support for multiple fonts."
:group 'emacs)
(defgroup help nil
"Support for on-line help systems."
:group 'emacs)
(defgroup multimedia nil
"Non-textual support, specifically images and sound."
:group 'emacs)
(defgroup local nil
"Code local to your site."
:group 'emacs)
(defgroup customize '((widgets custom-group))
"Customization of the Customization support."
:prefix "custom-"
:group 'help)
(defgroup custom-faces nil
"Faces used by customize."
:group 'customize
:group 'faces)
(defgroup custom-browse nil
"Control customize browser."
:prefix "custom-"
:group 'customize)
(defgroup custom-buffer nil
"Control customize buffers."
:prefix "custom-"
:group 'customize)
(defgroup custom-menu nil
"Control customize menus."
:prefix "custom-"
:group 'customize)
(defgroup alloc nil
"Storage allocation and gc for GNU Emacs Lisp interpreter."
:tag "Storage Allocation"
:group 'internal)
(defgroup undo nil
"Undoing changes in buffers."
:link '(custom-manual "(emacs)Undo")
:group 'editing)
(defgroup mode-line nil
"Contents of the mode line."
:group 'environment)
(defgroup editing-basics nil
"Most basic editing facilities."
:group 'editing)
(defgroup display nil
"How characters are displayed in buffers."
:group 'environment)
(defgroup execute nil
"Executing external commands."
:group 'processes)
(defgroup installation nil
"The Emacs installation."
:group 'environment)
(defgroup dired nil
"Directory editing."
:group 'environment)
(defgroup limits nil
"Internal Emacs limits."
:group 'internal)
(defgroup debug nil
"Debugging Emacs itself."
:group 'development)
(defgroup keyboard nil
"Input from the keyboard."
:group 'environment)
(defgroup mouse nil
"Input from the mouse."
:group 'environment)
(defgroup menu nil
"Input from the menus."
:group 'environment)
(defgroup dnd nil
"Handling data from drag and drop."
:group 'environment)
(defgroup auto-save nil
"Preventing accidental loss of data."
:group 'files)
(defgroup processes-basics nil
"Basic stuff dealing with processes."
:group 'processes)
(defgroup mule nil
"MULE Emacs internationalization."
:group 'i18n)
(defgroup windows nil
"Windows within a frame."
:link '(custom-manual "(emacs)Windows")
:group 'environment)
;;; Custom mode keymaps
(defvar custom-mode-map
(let ((map (make-keymap)))
(set-keymap-parent map widget-keymap)
(define-key map [remap self-insert-command] 'Custom-no-edit)
(define-key map "\^m" 'Custom-newline)
(define-key map " " 'scroll-up-command)
(define-key map [?\S-\ ] 'scroll-down-command)
(define-key map "\177" 'scroll-down-command)
(define-key map "\C-c\C-c" 'Custom-set)
(define-key map "\C-x\C-s" 'Custom-save)
(define-key map "q" 'Custom-buffer-done)
(define-key map "u" 'Custom-goto-parent)
(define-key map "n" 'widget-forward)
(define-key map "p" 'widget-backward)
map)
"Keymap for `Custom-mode'.")
(defvar custom-mode-link-map
(let ((map (make-keymap)))
(set-keymap-parent map custom-mode-map)
(define-key map [down-mouse-2] nil)
(define-key map [down-mouse-1] 'mouse-drag-region)
(define-key map [mouse-2] 'widget-move-and-invoke)
map)
"Local keymap for links in `Custom-mode'.")
(defvar custom-field-keymap
(let ((map (copy-keymap widget-field-keymap)))
(define-key map "\C-c\C-c" 'Custom-set)
(define-key map "\C-x\C-s" 'Custom-save)
map)
"Keymap used inside editable fields in customization buffers.")
(widget-put (get 'editable-field 'widget-type) :keymap custom-field-keymap)
;;; Utilities.
(defun custom-split-regexp-maybe (regexp)
"If REGEXP is a string, split it to a list at `\\|'.
You can get the original back from the result with:
(mapconcat 'identity result \"\\|\")
IF REGEXP is not a string, return it unchanged."
(if (stringp regexp)
(split-string regexp "\\\\|")
regexp))
(defun custom-variable-prompt ()
"Prompt for a custom variable, defaulting to the variable at point.
Return a list suitable for use in `interactive'."
(let* ((v (variable-at-point))
(default (and (symbolp v) (custom-variable-p v) (symbol-name v)))
(enable-recursive-minibuffers t)
val)
(setq val (completing-read
(if default (format "Customize variable (default %s): " default)
"Customize variable: ")
obarray 'custom-variable-p t nil nil default))
(list (if (equal val "")
(if (symbolp v) v nil)
(intern val)))))
(defun custom-menu-filter (menu widget)
"Convert MENU to the form used by `widget-choose'.
MENU should be in the same format as `custom-variable-menu'.
WIDGET is the widget to apply the filter entries of MENU on."
(let ((result nil)
current name action filter)
(while menu
(setq current (car menu)
name (nth 0 current)
action (nth 1 current)
filter (nth 2 current)
menu (cdr menu))
(if (or (null filter) (funcall filter widget))
(push (cons name action) result)
(push name result)))
(nreverse result)))
;;; Unlispify.
(defvar custom-prefix-list nil
"List of prefixes that should be ignored by `custom-unlispify'.")
(defcustom custom-unlispify-menu-entries t
"Display menu entries as words instead of symbols if non-nil."
:group 'custom-menu
:type 'boolean)
(defcustom custom-unlispify-remove-prefixes nil
"Non-nil means remove group prefixes from option names in buffer.
Discarding prefixes often leads to confusing names for options
and faces in Customize buffers, so do not set this to a non-nil
value unless you are sure you know what it does."
:group 'custom-menu
:group 'custom-buffer
:type 'boolean)
(defun custom-unlispify-menu-entry (symbol &optional no-suffix)
"Convert SYMBOL into a menu entry."
(cond ((not custom-unlispify-menu-entries)
(symbol-name symbol))
((get symbol 'custom-tag)
(if no-suffix
(get symbol 'custom-tag)
(concat (get symbol 'custom-tag) "...")))
(t
(with-current-buffer (get-buffer-create " *Custom-Work*")
(erase-buffer)
(princ symbol (current-buffer))
(goto-char (point-min))
(if custom-unlispify-remove-prefixes
(let ((prefixes custom-prefix-list)
prefix)
(while prefixes
(setq prefix (car prefixes))
(if (search-forward prefix (+ (point) (length prefix)) t)
(progn
(setq prefixes nil)
(delete-region (point-min) (point)))
(setq prefixes (cdr prefixes))))))
(subst-char-in-region (point-min) (point-max) ?- ?\ t)
(capitalize-region (point-min) (point-max))
(unless no-suffix
(goto-char (point-max))
(insert "..."))
(buffer-string)))))
(defcustom custom-unlispify-tag-names t
"Display tag names as words instead of symbols if non-nil."
:group 'custom-buffer
:type 'boolean)
(defun custom-unlispify-tag-name (symbol)
"Convert SYMBOL into a menu entry."
(let ((custom-unlispify-menu-entries custom-unlispify-tag-names))
(custom-unlispify-menu-entry symbol t)))
(defun custom-prefix-add (symbol prefixes)
"Add SYMBOL to list of ignored PREFIXES."
(cons (or (get symbol 'custom-prefix)
(concat (symbol-name symbol) "-"))
prefixes))
;;; Guess.
(defcustom custom-guess-name-alist
'(("-p\\'" boolean)
("-flag\\'" boolean)
("-hook\\'" hook)
("-face\\'" face)
("-file\\'" file)
("-function\\'" function)
("-functions\\'" (repeat function))
("-list\\'" (repeat sexp))
("-alist\\'" (alist :key-type sexp :value-type sexp)))
"Alist of (MATCH TYPE).
MATCH should be a regexp matching the name of a symbol, and TYPE should
be a widget suitable for editing the value of that symbol. The TYPE
of the first entry where MATCH matches the name of the symbol will be
used.
This is used for guessing the type of variables not declared with
customize."
:type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
:group 'custom-buffer)
(defcustom custom-guess-doc-alist
'(("\\`\\*?Non-nil " boolean))
"Alist of (MATCH TYPE).
MATCH should be a regexp matching a documentation string, and TYPE
should be a widget suitable for editing the value of a variable with
that documentation string. The TYPE of the first entry where MATCH
matches the name of the symbol will be used.
This is used for guessing the type of variables not declared with
customize."
:type '(repeat (group (regexp :tag "Match") (sexp :tag "Type")))
:group 'custom-buffer)
(defun custom-guess-type (symbol)
"Guess a widget suitable for editing the value of SYMBOL.
This is done by matching SYMBOL with `custom-guess-name-alist' and
if that fails, the doc string with `custom-guess-doc-alist'."
(let ((name (symbol-name symbol))
(names custom-guess-name-alist)
current found)
(while names
(setq current (car names)
names (cdr names))
(when (string-match (nth 0 current) name)
(setq found (nth 1 current)
names nil)))
(unless found
(let ((doc (documentation-property symbol 'variable-documentation))
(docs custom-guess-doc-alist))
(when doc
(while docs
(setq current (car docs)
docs (cdr docs))
(when (string-match (nth 0 current) doc)
(setq found (nth 1 current)
docs nil))))))
found))
;;; Sorting.
;;;###autoload
(defcustom custom-browse-sort-alphabetically nil
"If non-nil, sort customization group alphabetically in `custom-browse'."
:type 'boolean
:group 'custom-browse)
(defcustom custom-browse-order-groups nil
"If non-nil, order group members within each customization group.
If `first', order groups before non-groups.
If `last', order groups after non-groups."
:type '(choice (const first)
(const last)
(const :tag "none" nil))
:group 'custom-browse)
(defcustom custom-browse-only-groups nil
"If non-nil, show group members only within each customization group."
:type 'boolean
:group 'custom-browse)
;;;###autoload
(defcustom custom-buffer-sort-alphabetically t
"Whether to sort customization groups alphabetically in Custom buffer."
:type 'boolean
:group 'custom-buffer
:version "24.1")
(defcustom custom-buffer-order-groups 'last
"If non-nil, order group members within each customization group.
If `first', order groups before non-groups.
If `last', order groups after non-groups."
:type '(choice (const first)
(const last)
(const :tag "none" nil))
:group 'custom-buffer)
;;;###autoload
(defcustom custom-menu-sort-alphabetically nil
"If non-nil, sort each customization group alphabetically in menus."
:type 'boolean
:group 'custom-menu)
(defcustom custom-menu-order-groups 'first
"If non-nil, order group members within each customization group.
If `first', order groups before non-groups.
If `last', order groups after non-groups."
:type '(choice (const first)
(const last)
(const :tag "none" nil))
:group 'custom-menu)
(defun custom-sort-items (items sort-alphabetically order-groups)
"Return a sorted copy of ITEMS.
ITEMS should be a `custom-group' property.
If SORT-ALPHABETICALLY non-nil, sort alphabetically.
If ORDER-GROUPS is `first' order groups before non-groups, if `last' order
groups after non-groups, if nil do not order groups at all."
(sort (copy-sequence items)
(lambda (a b)
(let ((typea (nth 1 a)) (typeb (nth 1 b))
(namea (nth 0 a)) (nameb (nth 0 b)))
(cond ((not order-groups)
;; Since we don't care about A and B order, maybe sort.
(when sort-alphabetically
(string-lessp namea nameb)))
((eq typea 'custom-group)
;; If B is also a group, maybe sort. Otherwise, order A and B.
(if (eq typeb 'custom-group)
(when sort-alphabetically
(string-lessp namea nameb))
(eq order-groups 'first)))
((eq typeb 'custom-group)
;; Since A cannot be a group, order A and B.
(eq order-groups 'last))
(sort-alphabetically
;; Since A and B cannot be groups, sort.
(string-lessp namea nameb)))))))
;;; Custom Mode Commands.
;; This variable is used by `custom-tool-bar-map', or directly by
;; `custom-buffer-create-internal' if `custom-buffer-verbose-help' is non-nil.
(defvar custom-commands
'((" Apply " Custom-set t
"Apply settings (for the current session only)"
"index"
"Apply")
(" Apply and Save " Custom-save
(or custom-file user-init-file)
"Apply settings and save for future sessions."
"save"
"Save")
(" Undo Edits " Custom-reset-current t
"Restore customization buffer to reflect existing settings."
"refresh"
"Undo")
(" Reset Customizations " Custom-reset-saved t
"Undo any settings applied only for the current session."
"undo"
"Reset")
(" Erase Customizations " Custom-reset-standard
(or custom-file user-init-file)
"Un-customize settings in this and future sessions."
"delete"
"Uncustomize")
(" Help for Customize " Custom-help t
"Get help for using Customize."
"help"
"Help")
(" Exit " Custom-buffer-done t "Exit Customize." "exit" "Exit")))
(defun Custom-help ()
"Read the node on Easy Customization in the Emacs manual."
(interactive)
(info "(emacs)Easy Customization"))
(defvar custom-reset-menu
'(("Undo Edits in Customization Buffer" . Custom-reset-current)
("Revert This Session's Customizations" . Custom-reset-saved)
("Erase Customizations" . Custom-reset-standard))
"Alist of actions for the `Reset' button.
The key is a string containing the name of the action, the value is a
Lisp function taking the widget as an element which will be called
when the action is chosen.")
(defvar custom-options nil
"Customization widgets in the current buffer.")
(defun custom-command-apply (fun query &optional strong-query)
"Call function FUN on all widgets in `custom-options'.
If there is more than one widget, ask user for confirmation using
the query string QUERY, using `y-or-n-p' if STRONG-QUERY is nil,
and `yes-or-no-p' otherwise."
(if (or (and (= 1 (length custom-options))
(memq (widget-type (car custom-options))
'(custom-variable custom-face)))
(funcall (if strong-query 'yes-or-no-p 'y-or-n-p) query))
(progn (mapc fun custom-options) t)
(message "Aborted")
nil))
(defun Custom-set (&rest _ignore)
"Set the current value of all edited settings in the buffer."
(interactive)
(custom-command-apply
(lambda (child)
(when (eq (widget-get child :custom-state) 'modified)
(widget-apply child :custom-set)))
"Set all values according to this buffer? "))
(defun Custom-save (&rest _ignore)
"Set all edited settings, then save all settings that have been set.
If a setting was edited and set before, this saves it. If a
setting was merely edited before, this sets it then saves it."
(interactive)
(when (custom-command-apply
(lambda (child)
(when (memq (widget-get child :custom-state)
'(modified set changed rogue))
(widget-apply child :custom-mark-to-save)))
"Save all settings in this buffer? " t)
;; Save changes to buffer and redraw.
(custom-save-all)
(dolist (child custom-options)
(widget-apply child :custom-state-set-and-redraw))))
(defun custom-reset (_widget &optional event)
"Select item from reset menu."
(let* ((completion-ignore-case t)
(answer (widget-choose "Reset settings"
custom-reset-menu
event)))
(if answer
(funcall answer))))
(defun Custom-reset-current (&rest _ignore)
"Reset all edited settings in the buffer to show their current values."
(interactive)
(custom-command-apply
(lambda (widget)
(if (memq (widget-get widget :custom-state) '(modified changed))
(widget-apply widget :custom-reset-current)))
"Reset all settings' buffer text to show current values? "))
(defun Custom-reset-saved (&rest _ignore)
"Reset all edited or set settings in the buffer to their saved value.
This also shows the saved values in the buffer."
(interactive)
(custom-command-apply
(lambda (widget)
(if (memq (widget-get widget :custom-state) '(modified set changed rogue))
(widget-apply widget :custom-reset-saved)))
"Reset all settings (current values and buffer text) to saved values? "))
;; The next two variables are bound to '(t) by `Custom-reset-standard'
;; and `custom-group-reset-standard'. If these variables are nil, both
;; `custom-variable-reset-standard' and `custom-face-reset-standard'
;; save, reset and redraw the handled widget immediately. Otherwise,
;; they add the widget to the corresponding list and leave it to
;; `custom-reset-standard-save-and-update' to save, reset and redraw it.
(defvar custom-reset-standard-variables-list nil)
(defvar custom-reset-standard-faces-list nil)
;; The next function was excerpted from `custom-variable-reset-standard'
;; and `custom-face-reset-standard' and is used to avoid calling
;; `custom-save-all' repeatedly (and thus saving settings to file one by
;; one) when erasing all customizations.
(defun custom-reset-standard-save-and-update ()
"Save settings and redraw after erasing customizations."
(when (or (and custom-reset-standard-variables-list
(not (eq custom-reset-standard-variables-list '(t))))
(and custom-reset-standard-faces-list
(not (eq custom-reset-standard-faces-list '(t)))))
;; Save settings to file.
(custom-save-all)
;; Set state of and redraw variables.
(dolist (widget custom-reset-standard-variables-list)
(unless (eq widget t)
(widget-put widget :custom-state 'unknown)
(custom-redraw widget)))
;; Set state of and redraw faces.
(dolist (widget custom-reset-standard-faces-list)
(unless (eq widget t)
(let* ((symbol (widget-value widget))
(child (car (widget-get widget :children)))
(comment-widget (widget-get widget :comment-widget)))
(put symbol 'face-comment nil)
(widget-value-set child
(custom-pre-filter-face-spec
(list (list t (custom-face-attributes-get
symbol nil)))))
;; This call manages the comment visibility
(widget-value-set comment-widget "")
(custom-face-state-set widget)
(custom-redraw-magic widget))))))
(defun Custom-reset-standard (&rest _ignore)
"Erase all customizations (either current or saved) in current buffer.
The immediate result is to restore them to their standard values.
This operation eliminates any saved values for the group members,
making them as if they had never been customized at all."
(interactive)
;; Bind these temporarily.
(let ((custom-reset-standard-variables-list '(t))
(custom-reset-standard-faces-list '(t)))
(custom-command-apply
(lambda (widget)
(and (or (null (widget-get widget :custom-standard-value))
(widget-apply widget :custom-standard-value))
(memq (widget-get widget :custom-state)
'(modified set changed saved rogue))
(widget-apply widget :custom-mark-to-reset-standard)))
"The settings will revert to their default values, in this
and future sessions. Really erase customizations? " t)
(custom-reset-standard-save-and-update)))
;;; The Customize Commands
(defun custom-prompt-variable (prompt-var prompt-val &optional comment)
"Prompt for a variable and a value and return them as a list.
PROMPT-VAR is the prompt for the variable, and PROMPT-VAL is the
prompt for the value. The %s escape in PROMPT-VAL is replaced with
the name of the variable.
If the variable has a `variable-interactive' property, that is used as if
it were the arg to `interactive' (which see) to interactively read the value.
If the variable has a `custom-type' property, it must be a widget and the
`:prompt-value' property of that widget will be used for reading the value.
If the variable also has a `custom-get' property, that is used for finding
the current value of the variable, otherwise `symbol-value' is used.
If optional COMMENT argument is non-nil, also prompt for a comment and return
it as the third element in the list."
(let* ((var (read-variable prompt-var))
(minibuffer-help-form '(describe-variable var))
(val
(let ((prop (get var 'variable-interactive))
(type (get var 'custom-type))
(prompt (format prompt-val var)))
(unless (listp type)
(setq type (list type)))
(cond (prop
;; Use VAR's `variable-interactive' property
;; as an interactive spec for prompting.
(call-interactively `(lambda (arg)
(interactive ,prop)
arg)))
(type
(widget-prompt-value type
prompt
(if (boundp var)
(funcall
(or (get var 'custom-get) 'symbol-value)
var))
(not (boundp var))))
(t
(eval-minibuffer prompt))))))
(if comment
(list var val
(read-string "Comment: " (get var 'variable-comment)))
(list var val))))
;;;###autoload
(defun customize-set-value (variable value &optional comment)
"Set VARIABLE to VALUE, and return VALUE. VALUE is a Lisp object.
If VARIABLE has a `variable-interactive' property, that is used as if
it were the arg to `interactive' (which see) to interactively read the value.
If VARIABLE has a `custom-type' property, it must be a widget and the
`:prompt-value' property of that widget will be used for reading the value.
If given a prefix (or a COMMENT argument), also prompt for a comment."
(interactive (custom-prompt-variable "Set variable: "
"Set %s to value: "
current-prefix-arg))
(cond ((string= comment "")
(put variable 'variable-comment nil))
(comment
(put variable 'variable-comment comment)))
(set variable value))
;;;###autoload
(defun customize-set-variable (variable value &optional comment)
"Set the default for VARIABLE to VALUE, and return VALUE.
VALUE is a Lisp object.
If VARIABLE has a `custom-set' property, that is used for setting
VARIABLE, otherwise `set-default' is used.
If VARIABLE has a `variable-interactive' property, that is used as if
it were the arg to `interactive' (which see) to interactively read the value.
If VARIABLE has a `custom-type' property, it must be a widget and the
`:prompt-value' property of that widget will be used for reading the value.
If given a prefix (or a COMMENT argument), also prompt for a comment."
(interactive (custom-prompt-variable "Set variable: "
"Set customized value for %s to: "
current-prefix-arg))
(custom-load-symbol variable)
(custom-push-theme 'theme-value variable 'user 'set (custom-quote value))
(funcall (or (get variable 'custom-set) 'set-default) variable value)
(put variable 'customized-value (list (custom-quote value)))
(cond ((string= comment "")
(put variable 'variable-comment nil)
(put variable 'customized-variable-comment nil))
(comment
(put variable 'variable-comment comment)
(put variable 'customized-variable-comment comment)))
value)
;;;###autoload
(defun customize-save-variable (variable value &optional comment)
"Set the default for VARIABLE to VALUE, and save it for future sessions.
Return VALUE.
If VARIABLE has a `custom-set' property, that is used for setting
VARIABLE, otherwise `set-default' is used.
If VARIABLE has a `variable-interactive' property, that is used as if
it were the arg to `interactive' (which see) to interactively read the value.
If VARIABLE has a `custom-type' property, it must be a widget and the
`:prompt-value' property of that widget will be used for reading the value.
If given a prefix (or a COMMENT argument), also prompt for a comment."
(interactive (custom-prompt-variable "Set and save variable: "
"Set and save value for %s as: "
current-prefix-arg))
(funcall (or (get variable 'custom-set) 'set-default) variable value)
(put variable 'saved-value (list (custom-quote value)))
(custom-push-theme 'theme-value variable 'user 'set (custom-quote value))
(cond ((string= comment "")
(put variable 'variable-comment nil)
(put variable 'saved-variable-comment nil))
(comment
(put variable 'variable-comment comment)
(put variable 'saved-variable-comment comment)))
(put variable 'customized-value nil)
(put variable 'customized-variable-comment nil)
(if (custom-file t)
(custom-save-all)
(message "Setting `%s' temporarily since \"emacs -q\" would overwrite customizations"
variable)
(set variable value))
value)
;; Some parts of Emacs might prompt the user to save customizations,
;; during startup before customizations are loaded. This function
;; handles this corner case by avoiding calling `custom-save-variable'
;; too early, which could wipe out existing customizations.
;;;###autoload
(defun customize-push-and-save (list-var elts)
"Add ELTS to LIST-VAR and save for future sessions, safely.
ELTS should be a list. This function adds each entry to the
value of LIST-VAR using `add-to-list'.
If Emacs is initialized, call `customize-save-variable' to save
the resulting list value now. Otherwise, add an entry to
`after-init-hook' to save it after initialization."
(dolist (entry elts)
(add-to-list list-var entry))
(if after-init-time
(let ((coding-system-for-read nil))
(customize-save-variable list-var (eval list-var)))
(add-hook 'after-init-hook
`(lambda ()
(customize-push-and-save ',list-var ',elts)))))
;;;###autoload
(defun customize ()
"Select a customization buffer which you can use to set user options.
User options are structured into \"groups\".
Initially the top-level group `Emacs' and its immediate subgroups
are shown; the contents of those subgroups are initially hidden."
(interactive)
(customize-group 'emacs))
;;;###autoload
(defun customize-mode (mode)
"Customize options related to the current major mode.
If a prefix \\[universal-argument] was given (or if the current major mode has no known group),
then prompt for the MODE to customize."
(interactive
(list
(let ((completion-regexp-list '("-mode\\'"))
(group (custom-group-of-mode major-mode)))
(if (and group (not current-prefix-arg))
major-mode
(intern
(completing-read (if group
(format "Major mode (default %s): " major-mode)
"Major mode: ")
obarray
'custom-group-of-mode
t nil nil (if group (symbol-name major-mode))))))))
(customize-group (custom-group-of-mode mode)))
(defun customize-read-group ()
(let ((completion-ignore-case t))
(completing-read "Customize group (default emacs): "
obarray
(lambda (symbol)
(or (and (get symbol 'custom-loads)
(not (get symbol 'custom-autoload)))
(get symbol 'custom-group)))
t)))
;;;###autoload
(defun customize-group (&optional group other-window)
"Customize GROUP, which must be a customization group.
If OTHER-WINDOW is non-nil, display in another window."
(interactive (list (customize-read-group)))
(when (stringp group)
(if (string-equal "" group)
(setq group 'emacs)
(setq group (intern group))))
(let ((name (format "*Customize Group: %s*"
(custom-unlispify-tag-name group))))
(cond
((null (get-buffer name))
(funcall (if other-window
'custom-buffer-create-other-window
'custom-buffer-create)
(list (list group 'custom-group))
name
(concat " for group "
(custom-unlispify-tag-name group))))
(other-window
(switch-to-buffer-other-window name))
(t
(pop-to-buffer-same-window name)))))
;;;###autoload
(defun customize-group-other-window (&optional group)
"Customize GROUP, which must be a customization group, in another window."
(interactive (list (customize-read-group)))
(customize-group group t))
;;;###autoload
(defalias 'customize-variable 'customize-option)
;;;###autoload
(defun customize-option (symbol)
"Customize SYMBOL, which must be a user option."
(interactive (custom-variable-prompt))
(unless symbol
(error "No variable specified"))
(let ((basevar (indirect-variable symbol)))
(custom-buffer-create (list (list basevar 'custom-variable))
(format "*Customize Option: %s*"
(custom-unlispify-tag-name basevar)))
(unless (eq symbol basevar)
(message "`%s' is an alias for `%s'" symbol basevar))))
;;;###autoload
(defalias 'customize-variable-other-window 'customize-option-other-window)
;;;###autoload
(defun customize-option-other-window (symbol)
"Customize SYMBOL, which must be a user option.
Show the buffer in another window, but don't select it."
(interactive (custom-variable-prompt))
(unless symbol
(error "No variable specified"))
(let ((basevar (indirect-variable symbol)))
(custom-buffer-create-other-window
(list (list basevar 'custom-variable))
(format "*Customize Option: %s*" (custom-unlispify-tag-name basevar)))
(unless (eq symbol basevar)
(message "`%s' is an alias for `%s'" symbol basevar))))
(defvar customize-changed-options-previous-release "24.1"
"Version for `customize-changed-options' to refer back to by default.")
;; Packages will update this variable, so make it available.
;;;###autoload
(defvar customize-package-emacs-version-alist nil
"Alist mapping versions of a package to Emacs versions.
We use this for packages that have their own names, but are released
as part of Emacs itself.
Each elements looks like this:
(PACKAGE (PVERSION . EVERSION)...)
Here PACKAGE is the name of a package, as a symbol. After
PACKAGE come one or more elements, each associating a
package version PVERSION with the first Emacs version
EVERSION in which it (or a subsequent version of PACKAGE)
was first released. Both PVERSION and EVERSION are strings.
PVERSION should be a string that this package used in
the :package-version keyword for `defcustom', `defgroup',
and `defface'.
For example, the MH-E package updates this alist as follows:
(add-to-list 'customize-package-emacs-version-alist
'(MH-E (\"6.0\" . \"22.1\") (\"6.1\" . \"22.1\")
(\"7.0\" . \"22.1\") (\"7.1\" . \"22.1\")
(\"7.2\" . \"22.1\") (\"7.3\" . \"22.1\")
(\"7.4\" . \"22.1\") (\"8.0\" . \"22.1\")))
The value of PACKAGE needs to be unique and it needs to match the
PACKAGE value appearing in the :package-version keyword. Since
the user might see the value in a error message, a good choice is
the official name of the package, such as MH-E or Gnus.")
;;;###autoload
(defalias 'customize-changed 'customize-changed-options)
;;;###autoload
(defun customize-changed-options (&optional since-version)
"Customize all settings whose meanings have changed in Emacs itself.
This includes new user options and faces, and new customization
groups, as well as older options and faces whose meanings or
default values have changed since the previous major Emacs
release.
With argument SINCE-VERSION (a string), customize all settings
that were added or redefined since that version."
(interactive
(list
(read-from-minibuffer
(format "Customize options changed, since version (default %s): "
customize-changed-options-previous-release))))
(if (equal since-version "")
(setq since-version nil)
(unless (condition-case nil
(numberp (read since-version))
(error nil))
(signal 'wrong-type-argument (list 'numberp since-version))))
(unless since-version
(setq since-version customize-changed-options-previous-release))
;; Load the information for versions since since-version. We use
;; custom-load-symbol for this.
(put 'custom-versions-load-alist 'custom-loads nil)
(dolist (elt custom-versions-load-alist)
(if (customize-version-lessp since-version (car elt))
(dolist (load (cdr elt))
(custom-add-load 'custom-versions-load-alist load))))
(custom-load-symbol 'custom-versions-load-alist)
(put 'custom-versions-load-alist 'custom-loads nil)
(let (found)
(mapatoms
(lambda (symbol)
(let* ((package-version (get symbol 'custom-package-version))
(version
(or (and package-version
(customize-package-emacs-version symbol
package-version))
(get symbol 'custom-version))))
(if version
(when (customize-version-lessp since-version version)
(if (or (get symbol 'custom-group)
(get symbol 'group-documentation))
(push (list symbol 'custom-group) found))
(if (custom-variable-p symbol)
(push (list symbol 'custom-variable) found))
(if (custom-facep symbol)
(push (list symbol 'custom-face) found)))))))
(if found
(custom-buffer-create (custom-sort-items found t 'first)
"*Customize Changed Options*")
(user-error "No user option defaults have been changed since Emacs %s"
since-version))))
(defun customize-package-emacs-version (symbol package-version)
"Return the Emacs version in which SYMBOL's meaning last changed.
PACKAGE-VERSION has the form (PACKAGE . VERSION). We use
`customize-package-emacs-version-alist' to find the version of
Emacs that is associated with version VERSION of PACKAGE."
(let (package-versions emacs-version)
;; Use message instead of error since we want user to be able to
;; see the rest of the symbols even if a package author has
;; botched things up.
(cond ((not (listp package-version))
(message "Invalid package-version value for %s" symbol))
((setq package-versions (assq (car package-version)
customize-package-emacs-version-alist))
(setq emacs-version
(cdr (assoc (cdr package-version) package-versions)))
(unless emacs-version
(message "%s version %s not found in %s" symbol
(cdr package-version)
"customize-package-emacs-version-alist")))
(t
(message "Package %s version %s lists no corresponding Emacs version"
(car package-version)
(cdr package-version))))
emacs-version))
(defun customize-version-lessp (version1 version2)
;; Why are the versions strings, and given that they are, why aren't
;; they converted to numbers and compared as such here? -- fx
;; In case someone made a mistake and left out the quotes
;; in the :version value.
(if (numberp version2)
(setq version2 (prin1-to-string version2)))
(let (major1 major2 minor1 minor2)
(string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version1)
(setq major1 (read (or (match-string 1 version1)
"0")))
(setq minor1 (read (or (match-string 3 version1)
"0")))
(string-match "\\([0-9]+\\)\\(\\.\\([0-9]+\\)\\)?" version2)
(setq major2 (read (or (match-string 1 version2)
"0")))
(setq minor2 (read (or (match-string 3 version2)
"0")))
(or (< major1 major2)
(and (= major1 major2)
(< minor1 minor2)))))
;;;###autoload
(defun customize-face (&optional face other-window)
"Customize FACE, which should be a face name or nil.
If FACE is nil, customize all faces. If FACE is actually a
face-alias, customize the face it is aliased to.
If OTHER-WINDOW is non-nil, display in another window.
Interactively, when point is on text which has a face specified,
suggest to customize that face, if it's customizable."
(interactive (list (read-face-name "Customize face" '("all faces") t)))
(if (member face '(nil "" (all\ faces)))
(setq face (face-list)))
(if (and (listp face) (null (cdr face)))
(setq face (car face)))
(let ((display-fun (if other-window
'custom-buffer-create-other-window
'custom-buffer-create)))
(if (listp face)
(funcall display-fun
(custom-sort-items
(mapcar (lambda (s) (list s 'custom-face)) face)
t nil)
"*Customize Faces*")
;; If FACE is actually an alias, customize the face it is aliased to.
(if (get face 'face-alias)
(setq face (get face 'face-alias)))
(unless (facep face)
(error "Invalid face %S" face))
(funcall display-fun
(list (list face 'custom-face))
(format "*Customize Face: %s*"
(custom-unlispify-tag-name face))))))
;;;###autoload
(defun customize-face-other-window (&optional face)
"Show customization buffer for face FACE in other window.
If FACE is actually a face-alias, customize the face it is aliased to.
Interactively, when point is on text which has a face specified,
suggest to customize that face, if it's customizable."
(interactive (list (read-face-name "Customize face" "all faces" t)))
(customize-face face t))
(defalias 'customize-customized 'customize-unsaved)
;;;###autoload
(defun customize-unsaved ()
"Customize all options and faces set in this session but not saved."
(interactive)
(let ((found nil))
(mapatoms (lambda (symbol)
(and (or (get symbol 'customized-face)
(get symbol 'customized-face-comment))
(custom-facep symbol)
(push (list symbol 'custom-face) found))
(and (or (get symbol 'customized-value)
(get symbol 'customized-variable-comment))
(boundp symbol)
(push (list symbol 'custom-variable) found))))
(if (not found)
(error "No user options are set but unsaved")
(custom-buffer-create (custom-sort-items found t nil)
"*Customize Unsaved*"))))
;;;###autoload
(defun customize-rogue ()
"Customize all user variables modified outside customize."
(interactive)
(let ((found nil))
(mapatoms (lambda (symbol)
(let ((cval (or (get symbol 'customized-value)
(get symbol 'saved-value)
(get symbol 'standard-value))))
(when (and cval ;Declared with defcustom.
(default-boundp symbol) ;Has a value.
(not (equal (eval (car cval))
;; Which does not match customize.
(default-value symbol))))
(push (list symbol 'custom-variable) found)))))
(if (not found)
(user-error "No rogue user options")
(custom-buffer-create (custom-sort-items found t nil)
"*Customize Rogue*"))))
;;;###autoload
(defun customize-saved ()
"Customize all saved options and faces."
(interactive)
(let ((found nil))
(mapatoms (lambda (symbol)
(and (or (get symbol 'saved-face)
(get symbol 'saved-face-comment))
(custom-facep symbol)
(push (list symbol 'custom-face) found))
(and (or (get symbol 'saved-value)
(get symbol 'saved-variable-comment))
(boundp symbol)
(push (list symbol 'custom-variable) found))))
(if (not found)
(user-error "No saved user options")
(custom-buffer-create (custom-sort-items found t nil)
"*Customize Saved*"))))
(declare-function apropos-parse-pattern "apropos" (pattern))
;;;###autoload
(defun customize-apropos (pattern &optional type)
"Customize loaded options, faces and groups matching PATTERN.
PATTERN can be a word, a list of words (separated by spaces),
or a regexp (using some regexp special characters). If it is a word,
search for matches for that word as a substring. If it is a list of words,
search for matches for any two (or more) of those words.
If TYPE is `options', include only options.
If TYPE is `faces', include only faces.
If TYPE is `groups', include only groups."
(interactive (list (apropos-read-pattern "symbol") nil))
(require 'apropos)
(unless (memq type '(nil options faces groups))
(error "Invalid setting type %s" (symbol-name type)))
(apropos-parse-pattern pattern)
(let (found)
(mapatoms
`(lambda (symbol)
(when (string-match apropos-regexp (symbol-name symbol))
,(if (memq type '(nil groups))
'(if (get symbol 'custom-group)
(push (list symbol 'custom-group) found)))
,(if (memq type '(nil faces))
'(if (custom-facep symbol)
(push (list symbol 'custom-face) found)))
,(if (memq type '(nil options))
`(if (and (boundp symbol)
(eq (indirect-variable symbol) symbol)
(or (get symbol 'saved-value)
(custom-variable-p symbol)))
(push (list symbol 'custom-variable) found))))))
(unless found
(error "No customizable %s matching %s" (symbol-name type) pattern))
(custom-buffer-create
(custom-sort-items found t custom-buffer-order-groups)
"*Customize Apropos*")))
;;;###autoload
(defun customize-apropos-options (regexp &optional ignored)
"Customize all loaded customizable options matching REGEXP."
(interactive (list (apropos-read-pattern "options")))
(customize-apropos regexp 'options))
;;;###autoload
(defun customize-apropos-faces (regexp)
"Customize all loaded faces matching REGEXP."
(interactive (list (apropos-read-pattern "faces")))
(customize-apropos regexp 'faces))
;;;###autoload
(defun customize-apropos-groups (regexp)
"Customize all loaded groups matching REGEXP."
(interactive (list (apropos-read-pattern "groups")))
(customize-apropos regexp 'groups))
;;; Buffer.
(defcustom custom-buffer-style 'links
"Control the presentation style for customization buffers.
The value should be a symbol, one of:
brackets: groups nest within each other with big horizontal brackets.
links: groups have links to subgroups."
:type '(radio (const brackets)
(const links))
:group 'custom-buffer)
(defcustom custom-buffer-done-kill nil
"Non-nil means exiting a Custom buffer should kill it."
:type 'boolean
:version "22.1"
:group 'custom-buffer)
(defcustom custom-buffer-indent 3
"Number of spaces to indent nested groups."
:type 'integer
:group 'custom-buffer)
(defun custom-get-fresh-buffer (name)
"Get a fresh new buffer with name NAME.
If the buffer already exist, clean it up to be like new.
Beware: it's not quite like new. Good enough for custom, but maybe
not for everybody."
;; To be more complete, we should also kill all permanent-local variables,
;; but it's not needed for custom.
(let ((buf (get-buffer name)))
(when (and buf (buffer-local-value 'buffer-file-name buf))
;; This will check if the file is not saved.
(kill-buffer buf)
(setq buf nil))
(if (null buf)
(get-buffer-create name)
(with-current-buffer buf
(kill-all-local-variables)
(run-hooks 'kill-buffer-hook)
;; Delete overlays before erasing the buffer so the overlay hooks
;; don't get run spuriously when we erase the buffer.
(let ((ols (overlay-lists)))
(dolist (ol (nconc (car ols) (cdr ols)))
(delete-overlay ol)))
(erase-buffer)
buf))))
;;;###autoload
(defun custom-buffer-create (options &optional name description)
"Create a buffer containing OPTIONS.
Optional NAME is the name of the buffer.
OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
SYMBOL is a customization option, and WIDGET is a widget for editing
that option."
(pop-to-buffer-same-window (custom-get-fresh-buffer (or name "*Customization*")))
(custom-buffer-create-internal options description))
;;;###autoload
(defun custom-buffer-create-other-window (options &optional name description)
"Create a buffer containing OPTIONS, and display it in another window.
The result includes selecting that window.
Optional NAME is the name of the buffer.
OPTIONS should be an alist of the form ((SYMBOL WIDGET)...), where
SYMBOL is a customization option, and WIDGET is a widget for editing
that option."
(unless name (setq name "*Customization*"))
(switch-to-buffer-other-window (custom-get-fresh-buffer name))
(custom-buffer-create-internal options description))
(defcustom custom-reset-button-menu t
"If non-nil, only show a single reset button in customize buffers.
This button will have a menu with all three reset operations."
:type 'boolean
:group 'custom-buffer
:version "24.3")
(defcustom custom-buffer-verbose-help t
"If non-nil, include explanatory text in the customization buffer."
:type 'boolean
:group 'custom-buffer)
(defun Custom-buffer-done (&rest _ignore)
"Exit current Custom buffer according to `custom-buffer-done-kill'."
(interactive)
(quit-window custom-buffer-done-kill))
(defvar custom-button nil
"Face used for buttons in customization buffers.")
(defvar custom-button-mouse nil
"Mouse face used for buttons in customization buffers.")
(defvar custom-button-pressed nil
"Face used for pressed buttons in customization buffers.")
(defcustom custom-search-field t
"If non-nil, show a search field in Custom buffers."
:type 'boolean
:version "24.1"
:group 'custom-buffer)
(defcustom custom-raised-buttons (not (equal (face-valid-attribute-values :box)
'(("unspecified" . unspecified))))
"If non-nil, indicate active buttons in a `raised-button' style.
Otherwise use brackets."
:type 'boolean
:version "21.1"
:group 'custom-buffer
:set (lambda (variable value)
(custom-set-default variable value)
(setq custom-button
(if value 'custom-button 'custom-button-unraised))
(setq custom-button-mouse
(if value 'custom-button-mouse 'highlight))
(setq custom-button-pressed
(if value
'custom-button-pressed
'custom-button-pressed-unraised))))
(defun custom-buffer-create-internal (options &optional _description)
(Custom-mode)
(let ((init-file (or custom-file user-init-file)))
;; Insert verbose help at the top of the custom buffer.
(when custom-buffer-verbose-help
(unless init-file
(widget-insert "Custom settings cannot be saved; maybe you started Emacs with `-q'.\n"))
(widget-insert "For help using this buffer, see ")
(widget-create 'custom-manual
:tag "Easy Customization"
"(emacs)Easy Customization")
(widget-insert " in the ")
(widget-create 'custom-manual
:tag "Emacs manual"
:help-echo "Read the Emacs manual."
"(emacs)Top")
(widget-insert "."))
(widget-insert "\n")
;; Insert the search field.
(when custom-search-field
(widget-insert "\n")
(let* ((echo "Search for custom items.
You can enter one or more words separated by spaces,
or a regular expression.")
(search-widget
(widget-create
'editable-field
:size 40 :help-echo echo
:action `(lambda (widget &optional event)
(customize-apropos (split-string (widget-value widget)))))))
(widget-insert " ")
(widget-create-child-and-convert
search-widget 'push-button
:tag " Search "
:help-echo echo :action
(lambda (widget &optional _event)
(customize-apropos (split-string (widget-value (widget-get widget :parent))))))
(widget-insert "\n")))
;; The custom command buttons are also in the toolbar, so for a
;; time they were not inserted in the buffer if the toolbar was in use.
;; But it can be a little confusing for the buffer layout to
;; change according to whether or nor the toolbar is on, not to
;; mention that a custom buffer can in theory be created in a
;; frame with a toolbar, then later viewed in one without.
;; So now the buttons are always inserted in the buffer. (Bug#1326)
(if custom-buffer-verbose-help
(widget-insert "
Operate on all settings in this buffer:\n"))
(let ((button (lambda (tag action active help _icon _label)
(widget-insert " ")
(if (eval active)
(widget-create 'push-button :tag tag
:help-echo help :action action))))
(commands custom-commands))
(if custom-reset-button-menu
(progn
(widget-create 'push-button
:tag " Revert... "
:help-echo "Show a menu with reset operations."
:mouse-down-action 'ignore
:action 'custom-reset)
(apply button (pop commands)) ; Apply
(apply button (pop commands))) ; Apply and Save
(apply button (pop commands)) ; Apply
(apply button (pop commands)) ; Apply and Save
(widget-insert "\n")
(apply button (pop commands)) ; Undo
(apply button (pop commands)) ; Reset
(apply button (pop commands)) ; Erase
(widget-insert " ")
(pop commands) ; Help (omitted)
(apply button (pop commands)))) ; Exit
(widget-insert "\n\n"))
;; Now populate the custom buffer.
(message "Creating customization items...")
(buffer-disable-undo)
(setq custom-options
(if (= (length options) 1)
(mapcar (lambda (entry)
(widget-create (nth 1 entry)
:documentation-shown t
:custom-state 'unknown
:tag (custom-unlispify-tag-name
(nth 0 entry))
:value (nth 0 entry)))
options)
(let ((count 0)
(length (length options)))
(mapcar (lambda (entry)
(prog2
(message "Creating customization items ...%2d%%"
(/ (* 100.0 count) length))
(widget-create (nth 1 entry)
:tag (custom-unlispify-tag-name
(nth 0 entry))
:value (nth 0 entry))
(setq count (1+ count))
(unless (eq (preceding-char) ?\n)
(widget-insert "\n"))
(widget-insert "\n")))
options))))
(unless (eq (preceding-char) ?\n)
(widget-insert "\n"))
(message "Creating customization items ...done")
(message "Resetting customization items...")
(unless (eq custom-buffer-style 'tree)
(mapc 'custom-magic-reset custom-options))
(message "Resetting customization items...done")
(message "Creating customization setup...")
(widget-setup)
(buffer-enable-undo)
(goto-char (point-min))
(message "Creating customization setup...done"))
;;; The Tree Browser.
;;;###autoload
(defun customize-browse (&optional group)
"Create a tree browser for the customize hierarchy."
(interactive)
(unless group
(setq group 'emacs))
(let ((name "*Customize Browser*"))
(pop-to-buffer-same-window (custom-get-fresh-buffer name)))
(Custom-mode)
(widget-insert (format "\
%s buttons; type RET or click mouse-1
on a button to invoke its action.
Invoke [+] to expand a group, and [-] to collapse an expanded group.\n"
(if custom-raised-buttons
"`Raised' text indicates"
"Square brackets indicate")))
(if custom-browse-only-groups
(widget-insert "\
Invoke the [Group] button below to edit that item in another window.\n\n")
(widget-insert "Invoke the ")
(widget-create 'item
:format "%t"
:tag "[Group]"
:tag-glyph "folder")
(widget-insert ", ")
(widget-create 'item
:format "%t"
:tag "[Face]"
:tag-glyph "face")
(widget-insert ", and ")
(widget-create 'item
:format "%t"
:tag "[Option]"
:tag-glyph "option")
(widget-insert " buttons below to edit that
item in another window.\n\n"))
(let ((custom-buffer-style 'tree))
(widget-create 'custom-group
:custom-last t
:custom-state 'unknown
:tag (custom-unlispify-tag-name group)
:value group))
(widget-setup)
(goto-char (point-min)))
(define-widget 'custom-browse-visibility 'item
"Control visibility of items in the customize tree browser."
:format "%[[%t]%]"
:action 'custom-browse-visibility-action)
(defun custom-browse-visibility-action (widget &rest _ignore)
(let ((custom-buffer-style 'tree))
(custom-toggle-parent widget)))
(define-widget 'custom-browse-group-tag 'custom-group-link
"Show parent in other window when activated."
:tag "Group"
:tag-glyph "folder"
:action 'custom-browse-group-tag-action)
(defun custom-browse-group-tag-action (widget &rest _ignore)
(let ((parent (widget-get widget :parent)))
(customize-group-other-window (widget-value parent))))
(define-widget 'custom-browse-variable-tag 'custom-group-link
"Show parent in other window when activated."
:tag "Option"
:tag-glyph "option"
:action 'custom-browse-variable-tag-action)
(defun custom-browse-variable-tag-action (widget &rest _ignore)
(let ((parent (widget-get widget :parent)))
(customize-variable-other-window (widget-value parent))))
(define-widget 'custom-browse-face-tag 'custom-group-link
"Show parent in other window when activated."
:tag "Face"
:tag-glyph "face"
:action 'custom-browse-face-tag-action)
(defun custom-browse-face-tag-action (widget &rest _ignore)
(let ((parent (widget-get widget :parent)))
(customize-face-other-window (widget-value parent))))
(defconst custom-browse-alist '((" " "space")
(" | " "vertical")
("-\\ " "top")
(" |-" "middle")
(" `-" "bottom")))
(defun custom-browse-insert-prefix (prefix)
"Insert PREFIX. On XEmacs convert it to line graphics."
;; Fixme: do graphics.
(if nil ; (featurep 'xemacs)
(progn
(insert "*")
(while (not (string-equal prefix ""))
(let ((entry (substring prefix 0 3)))
(setq prefix (substring prefix 3))
(let ((overlay (make-overlay (1- (point)) (point) nil t nil))
(name (nth 1 (assoc entry custom-browse-alist))))
(overlay-put overlay 'end-glyph (widget-glyph-find name entry))
(overlay-put overlay 'start-open t)
(overlay-put overlay 'end-open t)))))
(insert prefix)))
;;; Modification of Basic Widgets.
;;
;; We add extra properties to the basic widgets needed here. This is
;; fine, as long as we are careful to stay within our own namespace.
;;
;; We want simple widgets to be displayed by default, but complex
;; widgets to be hidden.
;; This widget type is obsolete as of Emacs 24.1.
(widget-put (get 'item 'widget-type) :custom-show t)
(widget-put (get 'editable-field 'widget-type)
:custom-show (lambda (_widget value)
(let ((pp (pp-to-string value)))
(cond ((string-match "\n" pp)
nil)
((> (length pp) 40)
nil)
(t t)))))
(widget-put (get 'menu-choice 'widget-type) :custom-show t)
;;; The `custom-manual' Widget.
(define-widget 'custom-manual 'info-link
"Link to the manual entry for this customization option."
:help-echo "Read the manual entry for this option."
:keymap custom-mode-link-map
:follow-link 'mouse-face
:button-face 'custom-link
:mouse-face 'highlight
:pressed-face 'highlight
:tag "Manual")
;;; The `custom-magic' Widget.
(defgroup custom-magic-faces nil
"Faces used by the magic button."
:group 'custom-faces
:group 'custom-buffer)
(defface custom-invalid '((((class color))
:foreground "yellow1" :background "red1")
(t :weight bold :slant italic :underline t))
"Face used when the customize item is invalid."
:group 'custom-magic-faces)
(defface custom-rogue '((((class color))
:foreground "pink" :background "black")
(t :underline t))
"Face used when the customize item is not defined for customization."
:group 'custom-magic-faces)
(defface custom-modified '((((min-colors 88) (class color))
:foreground "white" :background "blue1")
(((class color))
:foreground "white" :background "blue")
(t :slant italic))
"Face used when the customize item has been modified."
:group 'custom-magic-faces)
(defface custom-set '((((min-colors 88) (class color))
:foreground "blue1" :background "white")
(((class color))
:foreground "blue" :background "white")
(t :slant italic))
"Face used when the customize item has been set."
:group 'custom-magic-faces)
(defface custom-changed '((((min-colors 88) (class color))
:foreground "white" :background "blue1")
(((class color))
:foreground "white" :background "blue")
(t :slant italic))
"Face used when the customize item has been changed."
:group 'custom-magic-faces)
(defface custom-themed '((((min-colors 88) (class color))
:foreground "white" :background "blue1")
(((class color))
:foreground "white" :background "blue")
(t :slant italic))
"Face used when the customize item has been set by a theme."
:group 'custom-magic-faces)
(defface custom-saved '((t :underline t))
"Face used when the customize item has been saved."
:group 'custom-magic-faces)
(defconst custom-magic-alist
'((nil "#" underline "\
UNINITIALIZED, you should not see this.")
(unknown "?" italic "\
UNKNOWN, you should not see this.")
(hidden "-" default "\
HIDDEN, invoke \"Show\" in the previous line to show." "\
group now hidden, invoke \"Show\", above, to show contents.")
(invalid "x" custom-invalid "\
INVALID, the displayed value cannot be set.")
(modified "*" custom-modified "\
EDITED, shown value does not take effect until you set or save it." "\
something in this group has been edited but not set.")
(set "+" custom-set "\
SET for current session only." "\
something in this group has been set but not saved.")
(changed ":" custom-changed "\
CHANGED outside Customize." "\
something in this group has been changed outside customize.")
(saved "!" custom-saved "\
SAVED and set." "\
something in this group has been set and saved.")
(themed "o" custom-themed "\
THEMED." "\
visible group members are all at standard values.")
(rogue "@" custom-rogue "\
NO CUSTOMIZATION DATA; not intended to be customized." "\
something in this group is not prepared for customization.")
(standard " " nil "\
STANDARD." "\
visible group members are all at standard values."))
"Alist of customize option states.
Each entry is of the form (STATE MAGIC FACE ITEM-DESC [ GROUP-DESC ]), where
STATE is one of the following symbols:
`nil'
For internal use, should never occur.
`unknown'
For internal use, should never occur.
`hidden'
This item is not being displayed.
`invalid'
This item is modified, but has an invalid form.
`modified'
This item is modified, and has a valid form.
`set'
This item has been set but not saved.
`changed'
The current value of this item has been changed outside Customize.
`saved'
This item is marked for saving.
`rogue'
This item has no customization information.
`standard'
This item is unchanged from the standard setting.
MAGIC is a string used to present that state.
FACE is a face used to present the state.
ITEM-DESC is a string describing the state for options.
GROUP-DESC is a string describing the state for groups. If this is
left out, ITEM-DESC will be used.
The string %c in either description will be replaced with the
category of the item. These are `group'. `option', and `face'.
The list should be sorted most significant first.")
(defcustom custom-magic-show 'long
"If non-nil, show textual description of the state.
If `long', show a full-line description, not just one word."
:type '(choice (const :tag "no" nil)
(const long)
(other :tag "short" short))
:group 'custom-buffer)
(defcustom custom-magic-show-hidden '(option face)
"Control whether the State button is shown for hidden items.
The value should be a list with the custom categories where the State
button should be visible. Possible categories are `group', `option',
and `face'."
:type '(set (const group) (const option) (const face))
:group 'custom-buffer)
(defcustom custom-magic-show-button nil
"Show a \"magic\" button indicating the state of each customization option."
:type 'boolean
:group 'custom-buffer)
(define-widget 'custom-magic 'default
"Show and manipulate state for a customization option."
:format "%v"
:action 'widget-parent-action
:notify 'ignore
:value-get 'ignore
:value-create 'custom-magic-value-create
:value-delete 'widget-children-value-delete)
(defun widget-magic-mouse-down-action (widget &optional _event)
;; Non-nil unless hidden.
(not (eq (widget-get (widget-get (widget-get widget :parent) :parent)
:custom-state)
'hidden)))
(defun custom-magic-value-create (widget)
"Create compact status report for WIDGET."
(let* ((parent (widget-get widget :parent))
(state (widget-get parent :custom-state))
(hidden (eq state 'hidden))
(entry (assq state custom-magic-alist))
(magic (nth 1 entry))
(face (nth 2 entry))
(category (widget-get parent :custom-category))
(text (or (and (eq category 'group)
(nth 4 entry))
(nth 3 entry)))
(form (widget-get parent :custom-form))
children)
(unless (eq state 'hidden)
(while (string-match "\\`\\(.*\\)%c\\(.*\\)\\'" text)
(setq text (concat (match-string 1 text)
(symbol-name category)
(match-string 2 text))))
(when (and custom-magic-show
(or (not hidden)
(memq category custom-magic-show-hidden)))
(insert " ")
(when (and (eq category 'group)
(not (and (eq custom-buffer-style 'links)
(> (widget-get parent :custom-level) 1))))
(insert-char ?\ (* custom-buffer-indent
(widget-get parent :custom-level))))
(push (widget-create-child-and-convert
widget 'choice-item
:help-echo "Change the state of this item."
:format (if hidden "%t" "%[%t%]")
:button-prefix 'widget-push-button-prefix
:button-suffix 'widget-push-button-suffix
:mouse-down-action 'widget-magic-mouse-down-action
:tag " State ")
children)
(insert ": ")
(let ((start (point)))
(if (eq custom-magic-show 'long)
(insert text)
(insert (symbol-name state)))
(cond ((eq form 'lisp)
(insert " (lisp)"))
((eq form 'mismatch)
(insert " (mismatch)")))
(put-text-property start (point) 'face 'custom-state))
(insert "\n"))
(when (and (eq category 'group)
(not (and (eq custom-buffer-style 'links)
(> (widget-get parent :custom-level) 1))))
(insert-char ?\ (* custom-buffer-indent
(widget-get parent :custom-level))))
(when custom-magic-show-button
(when custom-magic-show
(let ((indent (widget-get parent :indent)))
(when indent
(insert-char ? indent))))
(push (widget-create-child-and-convert
widget 'choice-item
:mouse-down-action 'widget-magic-mouse-down-action
:button-face face
:button-prefix ""
:button-suffix ""
:help-echo "Change the state."
:format (if hidden "%t" "%[%t%]")
:tag (if (memq form '(lisp mismatch))
(concat "(" magic ")")
(concat "[" magic "]")))
children)
(insert " "))
(widget-put widget :children children))))
(defun custom-magic-reset (widget)
"Redraw the :custom-magic property of WIDGET."
(let ((magic (widget-get widget :custom-magic)))
(when magic
(widget-value-set magic (widget-value magic)))))
;;; The `custom' Widget.
(defface custom-button
'((((type x w32 ns) (class color)) ; Like default mode line
:box (:line-width 2 :style released-button)
:background "lightgrey" :foreground "black"))
"Face for custom buffer buttons if `custom-raised-buttons' is non-nil."
:version "21.1"
:group 'custom-faces)
(defface custom-button-mouse
'((((type x w32 ns) (class color))
:box (:line-width 2 :style released-button)
:background "grey90" :foreground "black")
(t
;; This is for text terminals that support mouse, like GPM mouse
;; or the MS-DOS terminal: inverse-video makes the button stand
;; out on mouse-over.
:inverse-video t))
"Mouse face for custom buffer buttons if `custom-raised-buttons' is non-nil."
:version "22.1"
:group 'custom-faces)
(defface custom-button-unraised
'((t :inherit underline))
"Face for custom buffer buttons if `custom-raised-buttons' is nil."
:version "22.1"
:group 'custom-faces)
(setq custom-button
(if custom-raised-buttons 'custom-button 'custom-button-unraised))
(setq custom-button-mouse
(if custom-raised-buttons 'custom-button-mouse 'highlight))
(defface custom-button-pressed
'((((type x w32 ns) (class color))
:box (:line-width 2 :style pressed-button)
:background "lightgrey" :foreground "black")
(t :inverse-video t))
"Face for pressed custom buttons if `custom-raised-buttons' is non-nil."
:version "21.1"
:group 'custom-faces)
(defface custom-button-pressed-unraised
'((default :inherit custom-button-unraised)
(((class color) (background light)) :foreground "magenta4")
(((class color) (background dark)) :foreground "violet"))
"Face for pressed custom buttons if `custom-raised-buttons' is nil."
:version "22.1"
:group 'custom-faces)
(setq custom-button-pressed
(if custom-raised-buttons
'custom-button-pressed
'custom-button-pressed-unraised))
(defface custom-documentation '((t nil))
"Face used for documentation strings in customization buffers."
:group 'custom-faces)
(defface custom-state '((((class color) (background dark))
:foreground "lime green")
(((class color) (background light))
:foreground "dark green"))
"Face used for State descriptions in the customize buffer."
:group 'custom-faces)
(defface custom-link '((t :inherit link))
"Face for links in customization buffers."
:version "22.1"
:group 'custom-faces)
(define-widget 'custom 'default
"Customize a user option."
:format "%v"
:convert-widget 'custom-convert-widget
:notify 'custom-notify
:custom-prefix ""
:custom-level 1
:custom-state 'hidden
:documentation-property 'widget-subclass-responsibility
:value-create 'widget-subclass-responsibility
:value-delete 'widget-children-value-delete
:value-get 'widget-value-value-get
:validate 'widget-children-validate
:match (lambda (_widget value) (symbolp value)))
(defun custom-convert-widget (widget)
"Initialize :value and :tag from :args in WIDGET."
(let ((args (widget-get widget :args)))
(when args
(widget-put widget :value (widget-apply widget
:value-to-internal (car args)))
(widget-put widget :tag (custom-unlispify-tag-name (car args)))
(widget-put widget :args nil)))
widget)
(defun custom-notify (widget &rest args)
"Keep track of changes."
(let ((state (widget-get widget :custom-state)))
(unless (eq state 'modified)
(unless (memq state '(nil unknown hidden))
(widget-put widget :custom-state 'modified))
(custom-magic-reset widget)
(apply 'widget-default-notify widget args))))
(defun custom-redraw (widget)
"Redraw WIDGET with current settings."
(let ((line (count-lines (point-min) (point)))
(column (current-column))
(pos (point))
(from (marker-position (widget-get widget :from)))
(to (marker-position (widget-get widget :to))))
(save-excursion
(widget-value-set widget (widget-value widget))
(custom-redraw-magic widget))
(when (and (>= pos from) (<= pos to))
(condition-case nil
(progn
(goto-char (point-min))
(forward-line (if (> column 0)
(1- line)
line))
(move-to-column column))
(error nil)))))
(defun custom-redraw-magic (widget)
"Redraw WIDGET state with current settings."
(while widget
(let ((magic (widget-get widget :custom-magic)))
(cond (magic
(widget-value-set magic (widget-value magic))
(when (setq widget (widget-get widget :group))
(custom-group-state-update widget)))
(t
(setq widget nil)))))
(widget-setup))
(defun custom-show (widget value)
"Non-nil if WIDGET should be shown with VALUE by default."
(declare (obsolete "this widget type is no longer supported." "24.1"))
(let ((show (widget-get widget :custom-show)))
(if (functionp show)
(funcall show widget value)
show)))
(defun custom-load-widget (widget)
"Load all dependencies for WIDGET."
(custom-load-symbol (widget-value widget)))
(defun custom-unloaded-symbol-p (symbol)
"Return non-nil if the dependencies of SYMBOL have not yet been loaded."
(let ((found nil)
(loads (get symbol 'custom-loads))
load)
(while loads
(setq load (car loads)
loads (cdr loads))
(cond ((symbolp load)
(unless (featurep load)
(setq found t)))
((assoc load load-history))
((assoc (locate-library load) load-history)
(message nil))
(t
(setq found t))))
found))
(defun custom-unloaded-widget-p (widget)
"Return non-nil if the dependencies of WIDGET have not yet been loaded."
(custom-unloaded-symbol-p (widget-value widget)))
(defun custom-toggle-hide (widget)
"Toggle visibility of WIDGET."
(custom-load-widget widget)
(let ((state (widget-get widget :custom-state)))
(cond ((memq state '(invalid modified set))
(error "There are unsaved changes"))
((eq state 'hidden)
(widget-put widget :custom-state 'unknown))
(t
(widget-put widget :documentation-shown nil)
(widget-put widget :custom-state 'hidden)))
(custom-redraw widget)
(widget-setup)))
(defun custom-toggle-parent (widget &rest _ignore)
"Toggle visibility of parent of WIDGET."
(custom-toggle-hide (widget-get widget :parent)))
(defun custom-add-see-also (widget &optional prefix)
"Add `See also ...' to WIDGET if there are any links.
Insert PREFIX first if non-nil."
(let* ((symbol (widget-get widget :value))
(links (get symbol 'custom-links))
(many (> (length links) 2))
(buttons (widget-get widget :buttons))
(indent (widget-get widget :indent)))
(when links
(when indent
(insert-char ?\ indent))
(when prefix
(insert prefix))
(insert "See also ")
(while links
(push (widget-create-child-and-convert
widget (car links)
:button-face 'custom-link
:mouse-face 'highlight
:pressed-face 'highlight)
buttons)
(setq links (cdr links))
(cond ((null links)
(insert ".\n"))
((null (cdr links))
(if many
(insert ", and ")
(insert " and ")))
(t
(insert ", "))))
(widget-put widget :buttons buttons))))
(defun custom-add-parent-links (widget &optional initial-string _doc-initial-string)
"Add \"Parent groups: ...\" to WIDGET if the group has parents.
The value is non-nil if any parents were found.
If INITIAL-STRING is non-nil, use that rather than \"Parent groups:\"."
(let ((name (widget-value widget))
(type (widget-type widget))
(buttons (widget-get widget :buttons))
(start (point))
(parents nil))
(insert (or initial-string "Groups:"))
(mapatoms (lambda (symbol)
(when (member (list name type) (get symbol 'custom-group))
(insert " ")
(push (widget-create-child-and-convert
widget 'custom-group-link
:tag (custom-unlispify-tag-name symbol)
symbol)
buttons)
(setq parents (cons symbol parents)))))
(if parents
(insert "\n")
(delete-region start (point)))
(widget-put widget :buttons buttons)
parents))
;;; The `custom-comment' Widget.
;; like the editable field
(defface custom-comment '((((type tty))
:background "yellow3"
:foreground "black")
(((class grayscale color)
(background light))
:background "gray85")
(((class grayscale color)
(background dark))
:background "dim gray")
(t
:slant italic))
"Face used for comments on variables or faces."
:version "21.1"
:group 'custom-faces)
;; like font-lock-comment-face
(defface custom-comment-tag
'((((class color) (background dark)) :foreground "gray80")
(((class color) (background light)) :foreground "blue4")
(((class grayscale) (background light))
:foreground "DimGray" :weight bold :slant italic)
(((class grayscale) (background dark))
:foreground "LightGray" :weight bold :slant italic)
(t :weight bold))
"Face used for the comment tag on variables or faces."
:group 'custom-faces)
(define-widget 'custom-comment 'string
"User comment."
:tag "Comment"
:help-echo "Edit a comment here."
:sample-face 'custom-comment-tag
:value-face 'custom-comment
:shown nil
:create 'custom-comment-create)
(defun custom-comment-create (widget)
(let* ((null-comment (equal "" (widget-value widget))))
(if (or (widget-get (widget-get widget :parent) :comment-shown)
(not null-comment))
(widget-default-create widget)
;; `widget-default-delete' expects markers in these slots --
;; maybe it shouldn't.
(widget-put widget :from (point-marker))
(widget-put widget :to (point-marker)))))
(defun custom-comment-hide (widget)
(widget-put (widget-get widget :parent) :comment-shown nil))
;; Those functions are for the menu. WIDGET is NOT the comment widget. It's
;; the global custom one
(defun custom-comment-show (widget)
(widget-put widget :comment-shown t)
(custom-redraw widget)
(widget-setup))
(defun custom-comment-invisible-p (widget)
(let ((val (widget-value (widget-get widget :comment-widget))))
(and (equal "" val)
(not (widget-get widget :comment-shown)))))
;;; The `custom-variable' Widget.
(defface custom-variable-tag
`((((class color) (background dark))
:foreground "light blue" :weight bold)
(((min-colors 88) (class color) (background light))
:foreground "blue1" :weight bold)
(((class color) (background light))
:foreground "blue" :weight bold)
(t :weight bold))
"Face used for unpushable variable tags."
:group 'custom-faces)
(defface custom-variable-button '((t :underline t :weight bold))
"Face used for pushable variable tags."
:group 'custom-faces)
(defcustom custom-variable-default-form 'edit
"Default form of displaying variable values."
:type '(choice (const edit)
(const lisp))
:group 'custom-buffer
:version "20.3")
(defun custom-variable-documentation (variable)
"Return documentation of VARIABLE for use in Custom buffer.
Normally just return the docstring. But if VARIABLE automatically
becomes buffer local when set, append a message to that effect."
(format "%s%s" (documentation-property variable 'variable-documentation)
(if (and (local-variable-if-set-p variable)
(or (not (local-variable-p variable))
(with-temp-buffer
(local-variable-if-set-p variable))))
"\n
This variable automatically becomes buffer-local when set outside Custom.
However, setting it through Custom sets the default value."
"")))
(define-widget 'custom-variable 'custom
"A widget for displaying a Custom variable.
The following properties have special meanings for this widget:
:hidden-states should be a list of widget states for which the
widget's initial contents are to be hidden.
:custom-form should be a symbol describing how to display and
edit the variable---either `edit' (using edit widgets),
`lisp' (as a Lisp sexp), or `mismatch' (should not happen);
if nil, use the return value of `custom-variable-default-form'.
:shown-value, if non-nil, should be a list whose `car' is the
variable value to display in place of the current value.
:custom-style describes the widget interface style; nil is the
default style, while `simple' means a simpler interface that
inhibits the magic custom-state widget."
:format "%v"
:help-echo "Set or reset this variable."
:documentation-property #'custom-variable-documentation
:custom-category 'option
:custom-state nil
:custom-menu 'custom-variable-menu-create
:custom-form nil
:value-create 'custom-variable-value-create
:action 'custom-variable-action
:hidden-states '(standard)
:custom-set 'custom-variable-set
:custom-mark-to-save 'custom-variable-mark-to-save
:custom-reset-current 'custom-redraw
:custom-reset-saved 'custom-variable-reset-saved
:custom-reset-standard 'custom-variable-reset-standard
:custom-mark-to-reset-standard 'custom-variable-mark-to-reset-standard
:custom-standard-value 'custom-variable-standard-value
:custom-state-set-and-redraw 'custom-variable-state-set-and-redraw)
(defun custom-variable-type (symbol)
"Return a widget suitable for editing the value of SYMBOL.
If SYMBOL has a `custom-type' property, use that.
Otherwise, try matching SYMBOL against `custom-guess-name-alist' and
try matching its doc string against `custom-guess-doc-alist'."
(let* ((type (or (get symbol 'custom-type)
(and (not (get symbol 'standard-value))
(custom-guess-type symbol))
'sexp))
(options (get symbol 'custom-options))
(tmp (if (listp type)
(copy-sequence type)
(list type))))
(when options
(widget-put tmp :options options))
tmp))
(defun custom-variable-value-create (widget)
"Here is where you edit the variable's value."
(custom-load-widget widget)
(unless (widget-get widget :custom-form)
(widget-put widget :custom-form custom-variable-default-form))
(let* ((buttons (widget-get widget :buttons))
(children (widget-get widget :children))
(form (widget-get widget :custom-form))
(symbol (widget-get widget :value))
(tag (widget-get widget :tag))
(type (custom-variable-type symbol))
(conv (widget-convert type))
(get (or (get symbol 'custom-get) 'default-value))
(prefix (widget-get widget :custom-prefix))
(last (widget-get widget :custom-last))
(style (widget-get widget :custom-style))
(value (let ((shown-value (widget-get widget :shown-value)))
(cond (shown-value
(car shown-value))
((default-boundp symbol)
(funcall get symbol))
(t (widget-get conv :value)))))
(state (or (widget-get widget :custom-state)
(if (memq (custom-variable-state symbol value)
(widget-get widget :hidden-states))
'hidden))))
;; If we don't know the state, see if we need to edit it in lisp form.
(unless state
(setq state (if (custom-show type value) 'unknown 'hidden)))
(when (eq state 'unknown)
(unless (widget-apply conv :match value)
(setq form 'mismatch)))
;; Now we can create the child widget.
(cond ((eq custom-buffer-style 'tree)
(insert prefix (if last " `--- " " |--- "))
(push (widget-create-child-and-convert
widget 'custom-browse-variable-tag)
buttons)
(insert " " tag "\n")
(widget-put widget :buttons buttons))
((eq state 'hidden)
;; Indicate hidden value.
(push (widget-create-child-and-convert
widget 'custom-visibility
:help-echo "Show the value of this option."
:on-glyph "down"
:on "Hide"
:off-glyph "right"
:off "Show Value"
:action 'custom-toggle-hide-variable
nil)
buttons)
(insert " ")
(push (widget-create-child-and-convert
widget 'item
:format "%{%t%} "
:sample-face 'custom-variable-tag
:tag tag
:parent widget)
buttons))
((memq form '(lisp mismatch))
(push (widget-create-child-and-convert
widget 'custom-visibility
:help-echo "Hide the value of this option."
:on "Hide"
:off "Show"
:on-glyph "down"
:off-glyph "right"
:action 'custom-toggle-hide-variable
t)
buttons)
(insert " ")
;; This used to try presenting the saved value or the
;; standard value, but it seems more intuitive to present
;; the current value (Bug#7600).
(let* ((value (cond ((default-boundp symbol)
(custom-quote (funcall get symbol)))
(t
(custom-quote (widget-get conv :value))))))
(insert (symbol-name symbol) ": ")
(push (widget-create-child-and-convert
widget 'sexp
:button-face 'custom-variable-button-face
:format "%v"
:tag (symbol-name symbol)
:parent widget
:value value)
children)))
(t
;; Edit mode.
(push (widget-create-child-and-convert
widget 'custom-visibility
:help-echo "Hide or show this option."
:on "Hide"
:off "Show"
:on-glyph "down"
:off-glyph "right"
:action 'custom-toggle-hide-variable
t)
buttons)
(insert " ")
(let* ((format (widget-get type :format))
tag-format value-format)
(unless (string-match ":" format)
(error "Bad format"))
(setq tag-format (substring format 0 (match-end 0)))
(setq value-format (substring format (match-end 0)))
(push (widget-create-child-and-convert
widget 'item
:format tag-format
:action 'custom-tag-action
:help-echo "Change value of this option."
:mouse-down-action 'custom-tag-mouse-down-action
:button-face 'custom-variable-button
:sample-face 'custom-variable-tag
tag)
buttons)
(push (widget-create-child-and-convert
widget type
:format value-format
:value value)
children))))
(unless (eq custom-buffer-style 'tree)
(unless (eq (preceding-char) ?\n)
(widget-insert "\n"))
;; Create the magic button.
(unless (eq style 'simple)
(let ((magic (widget-create-child-and-convert
widget 'custom-magic nil)))
(widget-put widget :custom-magic magic)
(push magic buttons)))
(widget-put widget :buttons buttons)
;; Insert documentation.
(widget-put widget :documentation-indent 3)
(unless (and (eq style 'simple)
(eq state 'hidden))
(widget-add-documentation-string-button
widget :visibility-widget 'custom-visibility))
;; The comment field
(unless (eq state 'hidden)
(let* ((comment (get symbol 'variable-comment))
(comment-widget
(widget-create-child-and-convert
widget 'custom-comment
:parent widget
:value (or comment ""))))
(widget-put widget :comment-widget comment-widget)
;; Don't push it !!! Custom assumes that the first child is the
;; value one.
(setq children (append children (list comment-widget)))))
;; Update the rest of the properties.
(widget-put widget :custom-form form)
(widget-put widget :children children)
;; Now update the state.
(if (eq state 'hidden)
(widget-put widget :custom-state state)
(custom-variable-state-set widget))
;; See also.
(unless (eq state 'hidden)
(when (eq (widget-get widget :custom-level) 1)
(custom-add-parent-links widget))
(custom-add-see-also widget)))))
(defun custom-toggle-hide-variable (visibility-widget &rest _ignore)
"Toggle the visibility of a `custom-variable' parent widget.
By default, this signals an error if the parent has unsaved
changes. If the parent has a `simple' :custom-style property,
the present value is saved to its :shown-value property instead."
(let ((widget (widget-get visibility-widget :parent)))
(unless (eq (widget-type widget) 'custom-variable)
(error "Invalid widget type"))
(custom-load-widget widget)
(let ((state (widget-get widget :custom-state)))
(if (eq state 'hidden)
(widget-put widget :custom-state 'unknown)
;; In normal interface, widget can't be hidden if modified.
(when (memq state '(invalid modified set))
(if (eq (widget-get widget :custom-style) 'simple)
(widget-put widget :shown-value
(list (widget-value
(car-safe
(widget-get widget :children)))))
(error "There are unsaved changes")))
(widget-put widget :documentation-shown nil)
(widget-put widget :custom-state 'hidden))
(custom-redraw widget)
(widget-setup))))
(defun custom-tag-action (widget &rest args)
"Pass :action to first child of WIDGET's parent."
(apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
:action args))
(defun custom-tag-mouse-down-action (widget &rest args)
"Pass :mouse-down-action to first child of WIDGET's parent."
(apply 'widget-apply (car (widget-get (widget-get widget :parent) :children))
:mouse-down-action args))
(defun custom-variable-state (symbol val)
"Return the state of SYMBOL if its value is VAL.
If SYMBOL has a non-nil `custom-get' property, it overrides VAL.
Possible return values are `standard', `saved', `set', `themed',
`changed', and `rogue'."
(let* ((get (or (get symbol 'custom-get) 'default-value))
(value (if (default-boundp symbol)
(funcall get symbol)
val))
(comment (get symbol 'variable-comment))
tmp
temp)
(cond ((progn (setq tmp (get symbol 'customized-value))
(setq temp
(get symbol 'customized-variable-comment))
(or tmp temp))
(if (condition-case nil
(and (equal value (eval (car tmp)))
(equal comment temp))
(error nil))
'set
'changed))
((progn (setq tmp (get symbol 'theme-value))
(setq temp (get symbol 'saved-variable-comment))
(or tmp temp))
(if (condition-case nil
(and (equal comment temp)
(equal value
(eval
(car (custom-variable-theme-value
symbol)))))
(error nil))
(cond
((eq (caar tmp) 'user) 'saved)
((eq (caar tmp) 'changed)
(if (condition-case nil
(and (null comment)
(equal value
(eval
(car (get symbol 'standard-value)))))
(error nil))
;; The value was originally set outside
;; custom, but it was set to the standard
;; value (probably an autoloaded defcustom).
'standard
'changed))
(t 'themed))
'changed))
((setq tmp (get symbol 'standard-value))
(if (condition-case nil
(and (equal value (eval (car tmp)))
(equal comment nil))
(error nil))
'standard
'changed))
(t 'rogue))))
(defun custom-variable-state-set (widget &optional state)
"Set the state of WIDGET to STATE.
If STATE is nil, the value is computed by `custom-variable-state'."
(widget-put widget :custom-state
(or state (custom-variable-state (widget-value widget)
(widget-get widget :value)))))
(defun custom-variable-standard-value (widget)
(get (widget-value widget) 'standard-value))
(defvar custom-variable-menu
`(("Set for Current Session" custom-variable-set
(lambda (widget)
(eq (widget-get widget :custom-state) 'modified)))
;; Note that in all the backquoted code in this file, we test
;; init-file-user rather than user-init-file. This is in case
;; cus-edit is loaded by something in site-start.el, because
;; user-init-file is not set at that stage.
;; http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00310.html
,@(when (or custom-file init-file-user)
'(("Save for Future Sessions" custom-variable-save
(lambda (widget)
(memq (widget-get widget :custom-state)
'(modified set changed rogue))))))
("Undo Edits" custom-redraw
(lambda (widget)
(and (default-boundp (widget-value widget))
(memq (widget-get widget :custom-state) '(modified changed)))))
("Revert This Session's Customization" custom-variable-reset-saved
(lambda (widget)
(memq (widget-get widget :custom-state)
'(modified set changed rogue))))
,@(when (or custom-file init-file-user)
'(("Erase Customization" custom-variable-reset-standard
(lambda (widget)
(and (get (widget-value widget) 'standard-value)
(memq (widget-get widget :custom-state)
'(modified set changed saved rogue)))))))
("Set to Backup Value" custom-variable-reset-backup
(lambda (widget)
(get (widget-value widget) 'backup-value)))
("---" ignore ignore)
("Add Comment" custom-comment-show custom-comment-invisible-p)
("---" ignore ignore)
("Show Current Value" custom-variable-edit
(lambda (widget)
(eq (widget-get widget :custom-form) 'lisp)))
("Show Saved Lisp Expression" custom-variable-edit-lisp
(lambda (widget)
(eq (widget-get widget :custom-form) 'edit))))
"Alist of actions for the `custom-variable' widget.
Each entry has the form (NAME ACTION FILTER) where NAME is the name of
the menu entry, ACTION is the function to call on the widget when the
menu is selected, and FILTER is a predicate which takes a `custom-variable'
widget as an argument, and returns non-nil if ACTION is valid on that
widget. If FILTER is nil, ACTION is always valid.")
(defun custom-variable-action (widget &optional event)
"Show the menu for `custom-variable' WIDGET.
Optional EVENT is the location for the menu."
(if (eq (widget-get widget :custom-state) 'hidden)
(custom-toggle-hide widget)
(unless (eq (widget-get widget :custom-state) 'modified)
(custom-variable-state-set widget))
(custom-redraw-magic widget)
(let* ((completion-ignore-case t)
(answer (widget-choose (concat "Operation on "
(custom-unlispify-tag-name
(widget-get widget :value)))
(custom-menu-filter custom-variable-menu
widget)
event)))
(if answer
(funcall answer widget)))))
(defun custom-variable-edit (widget)
"Edit value of WIDGET."
(widget-put widget :custom-state 'unknown)
(widget-put widget :custom-form 'edit)
(custom-redraw widget))
(defun custom-variable-edit-lisp (widget)
"Edit the Lisp representation of the value of WIDGET."
(widget-put widget :custom-state 'unknown)
(widget-put widget :custom-form 'lisp)
(custom-redraw widget))
(defun custom-variable-set (widget)
"Set the current value for the variable being edited by WIDGET."
(let* ((form (widget-get widget :custom-form))
(state (widget-get widget :custom-state))
(child (car (widget-get widget :children)))
(symbol (widget-value widget))
(set (or (get symbol 'custom-set) 'set-default))
(comment-widget (widget-get widget :comment-widget))
(comment (widget-value comment-widget))
val)
(cond ((eq state 'hidden)
(user-error "Cannot set hidden variable"))
((setq val (widget-apply child :validate))
(goto-char (widget-get val :from))
(error "%s" (widget-get val :error)))
((memq form '(lisp mismatch))
(when (equal comment "")
(setq comment nil)
;; Make the comment invisible by hand if it's empty
(custom-comment-hide comment-widget))
(custom-variable-backup-value widget)
(custom-push-theme 'theme-value symbol 'user
'set (custom-quote (widget-value child)))
(funcall set symbol (eval (setq val (widget-value child))))
(put symbol 'customized-value (list val))
(put symbol 'variable-comment comment)
(put symbol 'customized-variable-comment comment))
(t
(when (equal comment "")
(setq comment nil)
;; Make the comment invisible by hand if it's empty
(custom-comment-hide comment-widget))
(custom-variable-backup-value widget)
(custom-push-theme 'theme-value symbol 'user
'set (custom-quote (widget-value child)))
(funcall set symbol (setq val (widget-value child)))
(put symbol 'customized-value (list (custom-quote val)))
(put symbol 'variable-comment comment)
(put symbol 'customized-variable-comment comment)))
(custom-variable-state-set widget)
(custom-redraw-magic widget)))
(defun custom-variable-mark-to-save (widget)
"Set value and mark for saving the variable edited by WIDGET."
(let* ((form (widget-get widget :custom-form))
(state (widget-get widget :custom-state))
(child (car (widget-get widget :children)))
(symbol (widget-value widget))
(set (or (get symbol 'custom-set) 'set-default))
(comment-widget (widget-get widget :comment-widget))
(comment (widget-value comment-widget))
val)
(cond ((eq state 'hidden)
(user-error "Cannot set hidden variable"))
((setq val (widget-apply child :validate))
(goto-char (widget-get val :from))
(error "Saving %s: %s" symbol (widget-get val :error)))
((memq form '(lisp mismatch))
(when (equal comment "")
(setq comment nil)
;; Make the comment invisible by hand if it's empty
(custom-comment-hide comment-widget))
(put symbol 'saved-value (list (widget-value child)))
(custom-push-theme 'theme-value symbol 'user
'set (custom-quote (widget-value child)))
(funcall set symbol (eval (widget-value child)))
(put symbol 'variable-comment comment)
(put symbol 'saved-variable-comment comment))
(t
(when (equal comment "")
(setq comment nil)
;; Make the comment invisible by hand if it's empty
(custom-comment-hide comment-widget))
(put symbol 'saved-value
(list (custom-quote (widget-value child))))
(custom-push-theme 'theme-value symbol 'user
'set (custom-quote (widget-value child)))
(funcall set symbol (widget-value child))
(put symbol 'variable-comment comment)
(put symbol 'saved-variable-comment comment)))
(put symbol 'customized-value nil)
(put symbol 'customized-variable-comment nil)))
(defsubst custom-variable-state-set-and-redraw (widget)
"Set state of variable widget WIDGET and redraw with current settings."
(custom-variable-state-set widget)
(custom-redraw-magic widget))
(defun custom-variable-save (widget)
"Save value of variable edited by widget WIDGET."
(custom-variable-mark-to-save widget)
(custom-save-all)
(custom-variable-state-set-and-redraw widget))
(defun custom-variable-reset-saved (widget)
"Restore the value of the variable being edited by WIDGET.
If there is a saved value, restore it; otherwise reset to the
uncustomized (themed or standard) value.
Update the widget to show that value. The value that was current
before this operation becomes the backup value."
(let* ((symbol (widget-value widget))
(saved-value (get symbol 'saved-value))
(comment (get symbol 'saved-variable-comment)))
(custom-variable-backup-value widget)
(if (not (or saved-value comment))
;; If there is no saved value, remove the setting.
(custom-push-theme 'theme-value symbol 'user 'reset)
;; Otherwise, apply the saved value.
(put symbol 'variable-comment comment)
(custom-push-theme 'theme-value symbol 'user 'set (car-safe saved-value))
(ignore-errors
(funcall (or (get symbol 'custom-set) 'set-default)
symbol (eval (car saved-value)))))
(put symbol 'customized-value nil)
(put symbol 'customized-variable-comment nil)
(widget-put widget :custom-state 'unknown)
;; This call will possibly make the comment invisible
(custom-redraw widget)))
(defun custom-variable-mark-to-reset-standard (widget)
"Mark to restore standard setting for the variable edited by widget WIDGET.
If `custom-reset-standard-variables-list' is nil, save, reset and
redraw the widget immediately."
(let* ((symbol (widget-value widget)))
(if (get symbol 'standard-value)
(custom-variable-backup-value widget)
(user-error "No standard setting known for %S" symbol))
(put symbol 'variable-comment nil)
(put symbol 'customized-value nil)
(put symbol 'customized-variable-comment nil)
(custom-push-theme 'theme-value symbol 'user 'reset)
(custom-theme-recalc-variable symbol)
(if (and custom-reset-standard-variables-list
(or (get symbol 'saved-value) (get symbol 'saved-variable-comment)))
(progn
(put symbol 'saved-value nil)
(put symbol 'saved-variable-comment nil)
;; Append this to `custom-reset-standard-variables-list' to
;; have `custom-reset-standard-save-and-update' save setting
;; to the file, update the widget's state, and redraw it.
(setq custom-reset-standard-variables-list
(cons widget custom-reset-standard-variables-list)))
(when (or (get symbol 'saved-value) (get symbol 'saved-variable-comment))
(put symbol 'saved-value nil)
(put symbol 'saved-variable-comment nil)
(custom-save-all))
(widget-put widget :custom-state 'unknown)
;; This call will possibly make the comment invisible
(custom-redraw widget))))
(defun custom-variable-reset-standard (widget)
"Restore standard setting for the variable edited by WIDGET.
This operation eliminates any saved setting for the variable,
restoring it to the state of a variable that has never been customized.
The value that was current before this operation
becomes the backup value, so you can get it again."
(let (custom-reset-standard-variables-list)
(custom-variable-mark-to-reset-standard widget)))
(defun custom-variable-backup-value (widget)
"Back up the current value for WIDGET's variable.
The backup value is kept in the car of the `backup-value' property."
(let* ((symbol (widget-value widget))
(get (or (get symbol 'custom-get) 'default-value))
(type (custom-variable-type symbol))
(conv (widget-convert type))
(value (if (default-boundp symbol)
(funcall get symbol)
(widget-get conv :value))))
(put symbol 'backup-value (list value))))
(defun custom-variable-reset-backup (widget)
"Restore the backup value for the variable being edited by WIDGET.
The value that was current before this operation
becomes the backup value, so you can use this operation repeatedly
to switch between two values."
(let* ((symbol (widget-value widget))
(set (or (get symbol 'custom-set) 'set-default))
(value (get symbol 'backup-value))
(comment-widget (widget-get widget :comment-widget))
(comment (widget-value comment-widget)))
(if value
(progn
(custom-variable-backup-value widget)
(custom-push-theme 'theme-value symbol 'user 'set value)
(condition-case nil
(funcall set symbol (car value))
(error nil)))
(user-error "No backup value for %s" symbol))
(put symbol 'customized-value (list (custom-quote (car value))))
(put symbol 'variable-comment comment)
(put symbol 'customized-variable-comment comment)
(custom-variable-state-set widget)
;; This call will possibly make the comment invisible
(custom-redraw widget)))
;;; The `custom-visibility' Widget
(define-widget 'custom-visibility 'visibility
"Show or hide a documentation string."
:button-face 'custom-visibility
:pressed-face 'custom-visibility
:mouse-face 'highlight
:pressed-face 'highlight
:on-glyph nil
:off-glyph nil)
(defface custom-visibility
'((t :height 0.8 :inherit link))
"Face for the `custom-visibility' widget."
:version "23.1"
:group 'custom-faces)
;;; The `custom-face-edit' Widget.
(define-widget 'custom-face-edit 'checklist
"Widget for editing face attributes.
The following properties have special meanings for this widget:
:value is a plist of face attributes.
:default-face-attributes, if non-nil, is a plist of defaults for
face attributes (as specified by a `default' defface entry)."
:format "%v"
:extra-offset 3
:button-args '(:help-echo "Control whether this attribute has any effect.")
:value-to-internal 'custom-face-edit-fix-value
:match (lambda (widget value)
(widget-checklist-match widget
(custom-face-edit-fix-value widget value)))
:value-create 'custom-face-edit-value-create
:convert-widget 'custom-face-edit-convert-widget
:args (mapcar (lambda (att)
(list 'group :inline t
:sibling-args (widget-get (nth 1 att) :sibling-args)
(list 'const :format "" :value (nth 0 att))
(nth 1 att)))
custom-face-attributes))
(defun custom-face-edit-value-create (widget)
(let* ((alist (widget-checklist-match-find
widget (widget-get widget :value)))
(args (widget-get widget :args))
(show-all (widget-get widget :show-all-attributes))
(buttons (widget-get widget :buttons))
(defaults (widget-checklist-match-find
widget
(widget-get widget :default-face-attributes)))
entry)
(unless (looking-back "^ *")
(insert ?\n))
(insert-char ?\s (widget-get widget :extra-offset))
(if (or alist defaults show-all)
(dolist (prop args)
(setq entry (or (assq prop alist)
(assq prop defaults)))
(if (or entry show-all)
(widget-checklist-add-item widget prop entry)))
(insert (propertize "-- Empty face --" 'face 'shadow) ?\n))
(let ((indent (widget-get widget :indent)))
(if indent (insert-char ?\s (widget-get widget :indent))))
(push (widget-create-child-and-convert
widget 'visibility
:help-echo "Show or hide all face attributes."
:button-face 'custom-visibility
:pressed-face 'custom-visibility
:mouse-face 'highlight
:on "Hide Unused Attributes" :off "Show All Attributes"
:on-glyph nil :off-glyph nil
:always-active t
:action 'custom-face-edit-value-visibility-action
show-all)
buttons)
(insert ?\n)
(widget-put widget :buttons buttons)
(widget-put widget :children (nreverse (widget-get widget :children)))))
(defun custom-face-edit-value-visibility-action (widget &rest _ignore)
;; Toggle hiding of face attributes.
(let ((parent (widget-get widget :parent)))
(widget-put parent :show-all-attributes
(not (widget-get parent :show-all-attributes)))
(custom-redraw parent)))
(defun custom-face-edit-fix-value (_widget value)
"Ignoring WIDGET, convert :bold and :italic in VALUE to new form.
Also change :reverse-video to :inverse-video."
(custom-fix-face-spec value))
(defun custom-face-edit-convert-widget (widget)
"Convert :args as widget types in WIDGET."
(widget-put
widget
:args (mapcar (lambda (arg)
(widget-convert arg
:deactivate 'custom-face-edit-deactivate
:activate 'custom-face-edit-activate
:delete 'custom-face-edit-delete))
(widget-get widget :args)))
widget)
(defconst custom-face-edit (widget-convert 'custom-face-edit)
"Converted version of the `custom-face-edit' widget.")
(defun custom-face-edit-deactivate (widget)
"Make face widget WIDGET inactive for user modifications."
(unless (widget-get widget :inactive)
(let ((tag (custom-face-edit-attribute-tag widget))
(from (copy-marker (widget-get widget :from)))
(value (widget-value widget))
(inhibit-read-only t)
(inhibit-modification-hooks t))
(save-excursion
(goto-char from)
(widget-default-delete widget)
(insert tag ": " (propertize "--" 'face 'shadow) "\n")
(widget-put widget :inactive
(cons value (cons from (- (point) from))))))))
(defun custom-face-edit-activate (widget)
"Make face widget WIDGET active for user modifications."
(let ((inactive (widget-get widget :inactive))
(inhibit-read-only t)
(inhibit-modification-hooks t))
(when (consp inactive)
(save-excursion
(goto-char (car (cdr inactive)))
(delete-region (point) (+ (point) (cdr (cdr inactive))))
(widget-put widget :inactive nil)
(widget-apply widget :create)
(widget-value-set widget (car inactive))
(widget-setup)))))
(defun custom-face-edit-delete (widget)
"Remove WIDGET from the buffer."
(let ((inactive (widget-get widget :inactive))
(inhibit-read-only t)
(inhibit-modification-hooks t))
(if (not inactive)
;; Widget is alive, we don't have to do anything special
(widget-default-delete widget)
;; WIDGET is already deleted because we did so to deactivate it;
;; now just get rid of the label we put in its place.
(delete-region (car (cdr inactive))
(+ (car (cdr inactive)) (cdr (cdr inactive))))
(widget-put widget :inactive nil))))
(defun custom-face-edit-attribute-tag (widget)
"Return the first :tag property in WIDGET or one of its children."
(let ((tag (widget-get widget :tag)))
(or (and (not (equal tag "")) tag)
(let ((children (widget-get widget :children)))
(while (and (null tag) children)
(setq tag (custom-face-edit-attribute-tag (pop children))))
tag))))
;;; The `custom-display' Widget.
(define-widget 'custom-display 'menu-choice
"Select a display type."
:tag "Display"
:value t
:help-echo "Specify frames where the face attributes should be used."
:args '((const :tag "all" t)
(const :tag "defaults" default)
(checklist
:tag "specific display"
:offset 0
:extra-offset 9
:args ((group :sibling-args (:help-echo "\
Only match the specified window systems.")
(const :format "Type: "
type)
(checklist :inline t
:offset 0
(const :format "X "
:sibling-args (:help-echo "\
The X11 Window System.")
x)
(const :format "PM "
:sibling-args (:help-echo "\
OS/2 Presentation Manager.")
pm)
(const :format "W32 "
:sibling-args (:help-echo "\
Windows NT/9X.")
w32)
(const :format "NS "
:sibling-args (:help-echo "\
GNUstep or Macintosh OS Cocoa interface.")
ns)
(const :format "DOS "
:sibling-args (:help-echo "\
Plain MS-DOS.")
pc)
(const :format "TTY%n"
:sibling-args (:help-echo "\
Plain text terminals.")
tty)))
(group :sibling-args (:help-echo "\
Only match the frames with the specified color support.")
(const :format "Class: "
class)
(checklist :inline t
:offset 0
(const :format "Color "
:sibling-args (:help-echo "\
Match color frames.")
color)
(const :format "Grayscale "
:sibling-args (:help-echo "\
Match grayscale frames.")
grayscale)
(const :format "Monochrome%n"
:sibling-args (:help-echo "\
Match frames with no color support.")
mono)))
(group :sibling-args (:help-echo "\
The minimum number of colors the frame should support.")
(const :format "" min-colors)
(integer :tag "Minimum number of colors" ))
(group :sibling-args (:help-echo "\
Only match frames with the specified intensity.")
(const :format "\
Background brightness: "
background)
(checklist :inline t
:offset 0
(const :format "Light "
:sibling-args (:help-echo "\
Match frames with light backgrounds.")
light)
(const :format "Dark\n"
:sibling-args (:help-echo "\
Match frames with dark backgrounds.")
dark)))
(group :sibling-args (:help-echo "\
Only match frames that support the specified face attributes.")
(const :format "Supports attributes:" supports)
(custom-face-edit :inline t :format "%n%v"))))))
;;; The `custom-face' Widget.
(defface custom-face-tag
'((t :inherit custom-variable-tag))
"Face used for face tags."
:group 'custom-faces)
(defcustom custom-face-default-form 'selected
"Default form of displaying face definition."
:type '(choice (const all)
(const selected)
(const lisp))
:group 'custom-buffer
:version "20.3")
(define-widget 'custom-face 'custom
"Widget for customizing a face.
The following properties have special meanings for this widget:
:value is the face name (a symbol).
:custom-form should be a symbol describing how to display and
edit the face attributes---either `selected' (attributes for
selected display only), `all' (all attributes), `lisp' (as a
Lisp sexp), or `mismatch' (should not happen); if nil, use
the return value of `custom-face-default-form'.
:custom-style describes the widget interface style; nil is the
default style, while `simple' means a simpler interface that
inhibits the magic custom-state widget.
:sample-indent, if non-nil, is the number of columns to which to
indent the face sample (an integer).
:shown-value, if non-nil, is the face spec to display as the value
of the widget, instead of the current face spec."
:sample-face 'custom-face-tag
:help-echo "Set or reset this face."
:documentation-property #'face-doc-string
:value-create 'custom-face-value-create
:action 'custom-face-action
:custom-category 'face
:custom-form nil
:custom-set 'custom-face-set
:custom-mark-to-save 'custom-face-mark-to-save
:custom-reset-current 'custom-redraw
:custom-reset-saved 'custom-face-reset-saved
:custom-reset-standard 'custom-face-reset-standard
:custom-mark-to-reset-standard 'custom-face-mark-to-reset-standard
:custom-standard-value 'custom-face-standard-value
:custom-state-set-and-redraw 'custom-face-state-set-and-redraw
:custom-menu 'custom-face-menu-create)
(define-widget 'custom-face-all 'editable-list
"An editable list of display specifications and attributes."
:entry-format "%i %d %v"
:insert-button-args '(:help-echo "Insert new display specification here.")
:append-button-args '(:help-echo "Append new display specification here.")
:delete-button-args '(:help-echo "Delete this display specification.")
:args '((group :format "%v" custom-display custom-face-edit)))
(defconst custom-face-all (widget-convert 'custom-face-all)
"Converted version of the `custom-face-all' widget.")
(defun custom-filter-face-spec (spec filter-index &optional default-filter)
"Return a canonicalized version of SPEC using.
FILTER-INDEX is the index in the entry for each attribute in
`custom-face-attributes' at which the appropriate filter function can be
found, and DEFAULT-FILTER is the filter to apply for attributes that
don't specify one."
(mapcar (lambda (entry)
;; Filter a single face-spec entry
(let ((tests (car entry))
(unfiltered-attrs
;; Handle both old- and new-style attribute syntax
(if (listp (car (cdr entry)))
(car (cdr entry))
(cdr entry)))
(filtered-attrs nil))
;; Filter each face attribute
(while unfiltered-attrs
(let* ((attr (pop unfiltered-attrs))
(pre-filtered-value (pop unfiltered-attrs))
(filter
(or (nth filter-index (assq attr custom-face-attributes))
default-filter))
(filtered-value
(if filter
(funcall filter pre-filtered-value)
pre-filtered-value)))
(push filtered-value filtered-attrs)
(push attr filtered-attrs)))
;;
(list tests filtered-attrs)))
spec))
(defun custom-pre-filter-face-spec (spec)
"Return SPEC changed as necessary for editing by the face customization widget.
SPEC must be a full face spec."
(custom-filter-face-spec spec 2))
(defun custom-post-filter-face-spec (spec)
"Return the customized SPEC in a form suitable for setting the face."
(custom-filter-face-spec spec 3))
(defun custom-face-widget-to-spec (widget)
"Return a face spec corresponding to WIDGET.
WIDGET should be a `custom-face' widget."
(unless (eq (widget-type widget) 'custom-face)
(error "Invalid widget"))
(let ((child (car (widget-get widget :children))))
(custom-post-filter-face-spec
(if (eq (widget-type child) 'custom-face-edit)
`((t ,(widget-value child)))
(widget-value child)))))
(defun custom-face-get-current-spec (face)
(let ((spec (or (get face 'customized-face)
(get face 'saved-face)
(get face 'face-defface-spec)
;; Attempt to construct it.
`((t ,(custom-face-attributes-get
face (selected-frame)))))))
;; If the user has changed this face in some other way,
;; edit it as the user has specified it.
(if (not (face-spec-match-p face spec (selected-frame)))
(setq spec `((t ,(face-attr-construct face (selected-frame))))))
(custom-pre-filter-face-spec spec)))
(defun custom-toggle-hide-face (visibility-widget &rest _ignore)
"Toggle the visibility of a `custom-face' parent widget.
By default, this signals an error if the parent has unsaved
changes. If the parent has a `simple' :custom-style property,
the present value is saved to its :shown-value property instead."
(let ((widget (widget-get visibility-widget :parent)))
(unless (eq (widget-type widget) 'custom-face)
(error "Invalid widget type"))
(custom-load-widget widget)
(let ((state (widget-get widget :custom-state)))
(if (eq state 'hidden)
(widget-put widget :custom-state 'unknown)
;; In normal interface, widget can't be hidden if modified.
(when (memq state '(invalid modified set))
(if (eq (widget-get widget :custom-style) 'simple)
(widget-put widget :shown-value
(custom-face-widget-to-spec widget))
(error "There are unsaved changes")))
(widget-put widget :documentation-shown nil)
(widget-put widget :custom-state 'hidden))
(custom-redraw widget)
(widget-setup))))
(defun custom-face-value-create (widget)
"Create a list of the display specifications for WIDGET."
(let* ((buttons (widget-get widget :buttons))
(symbol (widget-get widget :value))
(tag (or (widget-get widget :tag)
(prin1-to-string symbol)))
(hiddenp (eq (widget-get widget :custom-state) 'hidden))
(style (widget-get widget :custom-style))
children)
(if (eq custom-buffer-style 'tree)
;; Draw a tree-style `custom-face' widget
(progn
(insert (widget-get widget :custom-prefix)
(if (widget-get widget :custom-last) " `--- " " |--- "))
(push (widget-create-child-and-convert
widget 'custom-browse-face-tag)
buttons)
(insert " " tag "\n")
(widget-put widget :buttons buttons))
;; Draw an ordinary `custom-face' widget
(let ((opoint (point)))
;; Visibility indicator.
(push (widget-create-child-and-convert
widget 'custom-visibility
:help-echo "Hide or show this face."
:on "Hide" :off "Show"
:on-glyph "down" :off-glyph "right"
:action 'custom-toggle-hide-face
(not hiddenp))
buttons)
;; Face name (tag).
(insert " " tag)
(widget-specify-sample widget opoint (point)))
(insert
(cond ((eq custom-buffer-style 'face) " ")
((string-match "face\\'" tag) ":")
(t " face: ")))
;; Face sample.
(let ((sample-indent (widget-get widget :sample-indent))
(indent-tabs-mode nil))
(and sample-indent
(<= (current-column) sample-indent)
(indent-to-column sample-indent)))
(push (widget-create-child-and-convert
widget 'item
:format "[%{%t%}]"
:sample-face (let ((spec (widget-get widget :shown-value)))
(if spec (face-spec-choose spec) symbol))
:tag "sample")
buttons)
(insert "\n")
;; Magic.
(unless (eq (widget-get widget :custom-style) 'simple)
(let ((magic (widget-create-child-and-convert
widget 'custom-magic nil)))
(widget-put widget :custom-magic magic)
(push magic buttons)))
;; Update buttons.
(widget-put widget :buttons buttons)
;; Insert documentation.
(unless (and hiddenp (eq style 'simple))
(widget-put widget :documentation-indent 3)
(widget-add-documentation-string-button
widget :visibility-widget 'custom-visibility)
;; The comment field
(unless hiddenp
(let* ((comment (get symbol 'face-comment))
(comment-widget
(widget-create-child-and-convert
widget 'custom-comment
:parent widget
:value (or comment ""))))
(widget-put widget :comment-widget comment-widget)
(push comment-widget children))))
;; Editor.
(unless (eq (preceding-char) ?\n)
(insert "\n"))
(unless hiddenp
(custom-load-widget widget)
(unless (widget-get widget :custom-form)
(widget-put widget :custom-form custom-face-default-form))
(let* ((spec (or (widget-get widget :shown-value)
(custom-face-get-current-spec symbol)))
(form (widget-get widget :custom-form))
(indent (widget-get widget :indent))
face-alist face-entry spec-default spec-match editor)
;; Find a display in SPEC matching the selected display.
;; This will use the usual face customization interface.
(setq face-alist spec)
(when (eq (car-safe (car-safe face-alist)) 'default)
(setq spec-default (pop face-alist)))
(while (and face-alist (listp face-alist) (null spec-match))
(setq face-entry (car face-alist))
(and (listp face-entry)
(face-spec-set-match-display (car face-entry)
(selected-frame))
(widget-apply custom-face-edit :match (cadr face-entry))
(setq spec-match face-entry))
(setq face-alist (cdr face-alist)))
;; Insert the appropriate editing widget.
(setq editor
(cond
((and (eq form 'selected)
(or spec-match spec-default))
(when indent (insert-char ?\s indent))
(widget-create-child-and-convert
widget 'custom-face-edit
:value (cadr spec-match)
:default-face-attributes (cadr spec-default)))
((and (not (eq form 'lisp))
(widget-apply custom-face-all :match spec))
(widget-create-child-and-convert
widget 'custom-face-all :value spec))
(t
(when indent
(insert-char ?\s indent))
(widget-create-child-and-convert
widget 'sexp :value spec))))
(custom-face-state-set widget)
(push editor children)
(widget-put widget :children children))))))
(defvar custom-face-menu
`(("Set for Current Session" custom-face-set)
,@(when (or custom-file init-file-user)
'(("Save for Future Sessions" custom-face-save)))
("Undo Edits" custom-redraw
(lambda (widget)
(memq (widget-get widget :custom-state) '(modified changed))))
("Revert This Session's Customization" custom-face-reset-saved
(lambda (widget)
(memq (widget-get widget :custom-state) '(modified set changed))))
,@(when (or custom-file init-file-user)
'(("Erase Customization" custom-face-reset-standard
(lambda (widget)
(get (widget-value widget) 'face-defface-spec)))))
("---" ignore ignore)
("Add Comment" custom-comment-show custom-comment-invisible-p)
("---" ignore ignore)
("For Current Display" custom-face-edit-selected
(lambda (widget)
(not (eq (widget-get widget :custom-form) 'selected))))
("For All Kinds of Displays" custom-face-edit-all
(lambda (widget)
(not (eq (widget-get widget :custom-form) 'all))))
("Show Lisp Expression" custom-face-edit-lisp
(lambda (widget)
(not (eq (widget-get widget :custom-form) 'lisp)))))
"Alist of actions for the `custom-face' widget.
Each entry has the form (NAME ACTION FILTER) where NAME is the name of
the menu entry, ACTION is the function to call on the widget when the
menu is selected, and FILTER is a predicate which takes a `custom-face'
widget as an argument, and returns non-nil if ACTION is valid on that
widget. If FILTER is nil, ACTION is always valid.")
(defun custom-face-edit-selected (widget)
"Edit selected attributes of the value of WIDGET."
(widget-put widget :custom-state 'unknown)
(widget-put widget :custom-form 'selected)
(custom-redraw widget))
(defun custom-face-edit-all (widget)
"Edit all attributes of the value of WIDGET."
(widget-put widget :custom-state 'unknown)
(widget-put widget :custom-form 'all)
(custom-redraw widget))
(defun custom-face-edit-lisp (widget)
"Edit the Lisp representation of the value of WIDGET."
(widget-put widget :custom-state 'unknown)
(widget-put widget :custom-form 'lisp)
(custom-redraw widget))
(defun custom-face-state (face)
"Return the current state of the face FACE.
This is one of `set', `saved', `changed', `themed', or `rogue'."
(let* ((comment (get face 'face-comment))
(state
(cond
((or (get face 'customized-face)
(get face 'customized-face-comment))
(if (equal (get face 'customized-face-comment) comment)
'set
'changed))
((or (get face 'saved-face)
(get face 'saved-face-comment))
(cond ((not (equal (get face 'saved-face-comment) comment))
'changed)
((eq 'user (caar (get face 'theme-face)))
'saved)
((eq 'changed (caar (get face 'theme-face)))
'changed)
(t 'themed)))
((get face 'face-defface-spec)
(cond (comment 'changed)
((get face 'theme-face) 'themed)
(t 'standard)))
(t 'rogue))))
;; If the user called set-face-attribute to change the default for
;; new frames, this face is "set outside of Customize".
(if (and (not (eq state 'rogue))
(get face 'face-modified))
'changed
state)))
(defun custom-face-state-set (widget)
"Set the state of WIDGET."
(widget-put widget :custom-state
(custom-face-state (widget-value widget))))
(defun custom-face-action (widget &optional event)
"Show the menu for `custom-face' WIDGET.
Optional EVENT is the location for the menu."
(if (eq (widget-get widget :custom-state) 'hidden)
(custom-toggle-hide widget)
(let* ((completion-ignore-case t)
(symbol (widget-get widget :value))
(answer (widget-choose (concat "Operation on "
(custom-unlispify-tag-name symbol))
(custom-menu-filter custom-face-menu
widget)
event)))
(if answer
(funcall answer widget)))))
(defun custom-face-set (widget)
"Make the face attributes in WIDGET take effect."
(let* ((symbol (widget-value widget))
(value (custom-face-widget-to-spec widget))
(comment-widget (widget-get widget :comment-widget))
(comment (widget-value comment-widget)))
(when (equal comment "")
(setq comment nil)
;; Make the comment invisible by hand if it's empty
(custom-comment-hide comment-widget))
(custom-push-theme 'theme-face symbol 'user 'set value)
(face-spec-set symbol value 'customized-face)
(put symbol 'face-comment comment)
(put symbol 'customized-face-comment comment)
(custom-face-state-set widget)
(custom-redraw-magic widget)))
(defun custom-face-mark-to-save (widget)
"Mark for saving the face edited by WIDGET."
(let* ((symbol (widget-value widget))
(value (custom-face-widget-to-spec widget))
(comment-widget (widget-get widget :comment-widget))
(comment (widget-value comment-widget))
(standard (eq (widget-get widget :custom-state) 'standard)))
(when (equal comment "")
(setq comment nil)
;; Make the comment invisible by hand if it's empty
(custom-comment-hide comment-widget))
(custom-push-theme 'theme-face symbol 'user 'set value)
(face-spec-set symbol value (if standard 'reset 'saved-face))
(put symbol 'face-comment comment)
(put symbol 'customized-face-comment nil)
(put symbol 'saved-face-comment comment)))
(defsubst custom-face-state-set-and-redraw (widget)
"Set state of face widget WIDGET and redraw with current settings."
(custom-face-state-set widget)
(custom-redraw-magic widget))
(defun custom-face-save (widget)
"Save the face edited by WIDGET."
(custom-face-mark-to-save widget)
(custom-save-all)
(custom-face-state-set-and-redraw widget))
;; For backward compatibility.
(define-obsolete-function-alias 'custom-face-save-command 'custom-face-save
"22.1")
(defun custom-face-reset-saved (widget)
"Restore WIDGET to the face's default attributes.
If there is a saved face, restore it; otherwise reset to the
uncustomized (themed or standard) face."
(let* ((face (widget-value widget))
(child (car (widget-get widget :children)))
(saved-face (get face 'saved-face))
(comment (get face 'saved-face-comment))
(comment-widget (widget-get widget :comment-widget)))
(custom-push-theme 'theme-face face 'user
(if saved-face 'set 'reset)
saved-face)
(face-spec-set face saved-face 'saved-face)
(put face 'face-comment comment)
(put face 'customized-face-comment nil)
(widget-value-set child saved-face)
;; This call manages the comment visibility
(widget-value-set comment-widget (or comment ""))
(custom-face-state-set widget)
(custom-redraw widget)))
(defun custom-face-standard-value (widget)
(get (widget-value widget) 'face-defface-spec))
(defun custom-face-mark-to-reset-standard (widget)
"Restore widget WIDGET to the face's standard attribute values.
If `custom-reset-standard-faces-list' is nil, save, reset and
redraw the widget immediately."
(let* ((symbol (widget-value widget))
(child (car (widget-get widget :children)))
(value (get symbol 'face-defface-spec))
(comment-widget (widget-get widget :comment-widget)))
(unless value
(user-error "No standard setting for this face"))
(custom-push-theme 'theme-face symbol 'user 'reset)
(face-spec-set symbol value 'reset)
(put symbol 'face-comment nil)
(put symbol 'customized-face-comment nil)
(if (and custom-reset-standard-faces-list
(or (get symbol 'saved-face) (get symbol 'saved-face-comment)))
;; Do this later.
(progn
(put symbol 'saved-face nil)
(put symbol 'saved-face-comment nil)
;; Append this to `custom-reset-standard-faces-list' and have
;; `custom-reset-standard-save-and-update' save setting to the
;; file, update the widget's state, and redraw it.
(setq custom-reset-standard-faces-list
(cons widget custom-reset-standard-faces-list)))
(when (or (get symbol 'saved-face) (get symbol 'saved-face-comment))
(put symbol 'saved-face nil)
(put symbol 'saved-face-comment nil)
(custom-save-all))
(widget-value-set child
(custom-pre-filter-face-spec
(list (list t (custom-face-attributes-get
symbol nil)))))
;; This call manages the comment visibility
(widget-value-set comment-widget "")
(custom-face-state-set widget)
(custom-redraw-magic widget))))
(defun custom-face-reset-standard (widget)
"Restore WIDGET to the face's standard attribute values.
This operation eliminates any saved attributes for the face,
restoring it to the state of a face that has never been customized."
(let (custom-reset-standard-faces-list)
(custom-face-mark-to-reset-standard widget)))
;;; The `face' Widget.
(defvar widget-face-prompt-value-history nil
"History of input to `widget-face-prompt-value'.")
(define-widget 'face 'symbol
"A Lisp face name (with sample)."
:format "%{%t%}: (%{sample%}) %v"
:tag "Face"
:value 'default
:sample-face-get 'widget-face-sample-face-get
:notify 'widget-face-notify
:match (lambda (_widget value) (facep value))
:completions (apply-partially #'completion-table-with-predicate
obarray #'facep 'strict)
:prompt-match 'facep
:prompt-history 'widget-face-prompt-value-history
:validate (lambda (widget)
(unless (facep (widget-value widget))
(widget-put widget
:error (format "Invalid face: %S"
(widget-value widget)))
widget)))
(defun widget-face-sample-face-get (widget)
(let ((value (widget-value widget)))
(if (facep value)
value
'default)))
(defun widget-face-notify (widget child &optional event)
"Update the sample, and notify the parent."
(overlay-put (widget-get widget :sample-overlay)
'face (widget-apply widget :sample-face-get))
(widget-default-notify widget child event))
;;; The `hook' Widget.
(define-widget 'hook 'list
"An Emacs Lisp hook."
:value-to-internal (lambda (_widget value)
(if (and value (symbolp value))
(list value)
value))
:match (lambda (widget value)
(or (symbolp value)
(widget-group-match widget value)))
;; Avoid adding undefined functions to the hook, especially for
;; things like `find-file-hook' or even more basic ones, to avoid
;; chaos.
:set (lambda (symbol value)
(dolist (elt value)
(if (fboundp elt)
(add-hook symbol elt))))
:convert-widget 'custom-hook-convert-widget
:tag "Hook")
(defun custom-hook-convert-widget (widget)
;; Handle `:options'.
(let* ((options (widget-get widget :options))
(other `(editable-list :inline t
:entry-format "%i %d%v"
(function :format " %v")))
(args (if options
(list `(checklist :inline t
,@(mapcar (lambda (entry)
`(function-item ,entry))
options))
other)
(list other))))
(widget-put widget :args args)
widget))
;;; The `custom-group-link' Widget.
(define-widget 'custom-group-link 'link
"Show parent in other window when activated."
:button-face 'custom-link
:mouse-face 'highlight
:pressed-face 'highlight
:help-echo "Create customization buffer for this group."
:keymap custom-mode-link-map
:follow-link 'mouse-face
:action 'custom-group-link-action)
(defun custom-group-link-action (widget &rest _ignore)
(customize-group (widget-value widget)))
;;; The `custom-group' Widget.
(defcustom custom-group-tag-faces nil
"Face used for group tags.
The first member is used for level 1 groups, the second for level 2,
and so forth. The remaining group tags are shown with `custom-group-tag'."
:type '(repeat face)
:group 'custom-faces)
(defface custom-group-tag-1
'((default :weight bold :height 1.2 :inherit variable-pitch)
(((class color) (background dark)) :foreground "pink")
(((min-colors 88) (class color) (background light)) :foreground "red1")
(((class color) (background light)) :foreground "red"))
"Face for group tags."
:group 'custom-faces)
(defface custom-group-tag
'((default :weight bold :height 1.2 :inherit variable-pitch)
(((class color) (background dark)) :foreground "light blue")
(((min-colors 88) (class color) (background light)) :foreground "blue1")
(((class color) (background light)) :foreground "blue")
(t :weight bold))
"Face for low level group tags."
:group 'custom-faces)
(defface custom-group-subtitle
'((t :weight bold))
"Face for the \"Subgroups:\" subtitle in Custom buffers."
:group 'custom-faces)
(defvar custom-group-doc-align-col 20)
(define-widget 'custom-group 'custom
"Customize group."
:format "%v"
:sample-face-get 'custom-group-sample-face-get
:documentation-property 'group-documentation
:help-echo "Set or reset all members of this group."
:value-create 'custom-group-value-create
:action 'custom-group-action
:custom-category 'group
:custom-set 'custom-group-set
:custom-mark-to-save 'custom-group-mark-to-save
:custom-reset-current 'custom-group-reset-current
:custom-reset-saved 'custom-group-reset-saved
:custom-reset-standard 'custom-group-reset-standard
:custom-mark-to-reset-standard 'custom-group-mark-to-reset-standard
:custom-state-set-and-redraw 'custom-group-state-set-and-redraw
:custom-menu 'custom-group-menu-create)
(defun custom-group-sample-face-get (widget)
;; Use :sample-face.
(or (nth (1- (widget-get widget :custom-level)) custom-group-tag-faces)
'custom-group-tag))
(define-widget 'custom-group-visibility 'visibility
"An indicator and manipulator for hidden group contents."
:create 'custom-group-visibility-create)
(defun custom-group-visibility-create (widget)
(let ((visible (widget-value widget)))
(if visible
(insert "--------")))
(widget-default-create widget))
(defun custom-group-members (symbol groups-only)
"Return SYMBOL's custom group members.
If GROUPS-ONLY non-nil, return only those members that are groups."
(if (not groups-only)
(get symbol 'custom-group)
(let (members)
(dolist (entry (get symbol 'custom-group))
(when (eq (nth 1 entry) 'custom-group)
(push entry members)))
(nreverse members))))
(defun custom-group-value-create (widget)
"Insert a customize group for WIDGET in the current buffer."
(unless (eq (widget-get widget :custom-state) 'hidden)
(custom-load-widget widget))
(let* ((state (widget-get widget :custom-state))
(level (widget-get widget :custom-level))
;; (indent (widget-get widget :indent))
(prefix (widget-get widget :custom-prefix))
(buttons (widget-get widget :buttons))
(tag (widget-get widget :tag))
(symbol (widget-value widget))
(members (custom-group-members symbol
(and (eq custom-buffer-style 'tree)
custom-browse-only-groups)))
(doc (widget-docstring widget)))
(cond ((and (eq custom-buffer-style 'tree)
(eq state 'hidden)
(or members (custom-unloaded-widget-p widget)))
(custom-browse-insert-prefix prefix)
(push (widget-create-child-and-convert
widget 'custom-browse-visibility
:tag "+")
buttons)
(insert "-- ")
(push (widget-create-child-and-convert
widget 'custom-browse-group-tag)
buttons)
(insert " " tag "\n")
(widget-put widget :buttons buttons))
((and (eq custom-buffer-style 'tree)
(zerop (length members)))
(custom-browse-insert-prefix prefix)
(insert "[ ]-- ")
(push (widget-create-child-and-convert
widget 'custom-browse-group-tag)
buttons)
(insert " " tag "\n")
(widget-put widget :buttons buttons))
((eq custom-buffer-style 'tree)
(custom-browse-insert-prefix prefix)
(if (zerop (length members))
(progn
(custom-browse-insert-prefix prefix)
(insert "[ ]-- ")
;; (widget-glyph-insert nil "[ ]" "empty")
;; (widget-glyph-insert nil "-- " "horizontal")
(push (widget-create-child-and-convert
widget 'custom-browse-group-tag)
buttons)
(insert " " tag "\n")
(widget-put widget :buttons buttons))
(push (widget-create-child-and-convert
widget 'custom-browse-visibility
;; :tag-glyph "minus"
:tag "-")
buttons)
(insert "-\\ ")
;; (widget-glyph-insert nil "-\\ " "top")
(push (widget-create-child-and-convert
widget 'custom-browse-group-tag)
buttons)
(insert " " tag "\n")
(widget-put widget :buttons buttons)
(message "Creating group...")
(let* ((members (custom-sort-items
members
;; Never sort the top-level custom group.
(unless (eq symbol 'emacs)
custom-browse-sort-alphabetically)
custom-browse-order-groups))
(prefixes (widget-get widget :custom-prefixes))
(custom-prefix-list (custom-prefix-add symbol prefixes))
(extra-prefix (if (widget-get widget :custom-last)
" "
" | "))
(prefix (concat prefix extra-prefix))
children entry)
(while members
(setq entry (car members)
members (cdr members))
(push (widget-create-child-and-convert
widget (nth 1 entry)
:group widget
:tag (custom-unlispify-tag-name (nth 0 entry))
:custom-prefixes custom-prefix-list
:custom-level (1+ level)
:custom-last (null members)
:value (nth 0 entry)
:custom-prefix prefix)
children))
(widget-put widget :children (reverse children)))
(message "Creating group...done")))
;; Nested style.
((eq state 'hidden)
;; Create level indicator.
;; Create tag.
(if (eq custom-buffer-style 'links)
(push (widget-create-child-and-convert
widget 'custom-group-link
:tag tag
symbol)
buttons)
(insert-char ?\ (* custom-buffer-indent (1- level)))
(insert "-- ")
(push (widget-create-child-and-convert
widget 'custom-group-visibility
:help-echo "Show members of this group."
:action 'custom-toggle-parent
(not (eq state 'hidden)))
buttons))
(if (>= (current-column) custom-group-doc-align-col)
(insert " "))
;; Create magic button.
(let ((magic (widget-create-child-and-convert
widget 'custom-magic nil)))
(widget-put widget :custom-magic magic)
(push magic buttons))
;; Update buttons.
(widget-put widget :buttons buttons)
;; Insert documentation.
(if (and (eq custom-buffer-style 'links) (> level 1))
(widget-put widget :documentation-indent
custom-group-doc-align-col))
(widget-add-documentation-string-button
widget :visibility-widget 'custom-visibility))
;; Nested style.
(t ;Visible.
;; Draw a horizontal line (this works for both graphical
;; and text displays):
(let ((p (point)))
(insert "\n")
(put-text-property p (1+ p) 'face '(:underline t))
(overlay-put (make-overlay p (1+ p))
'before-string
(propertize "\n" 'face '(:underline t)
'display '(space :align-to 999))))
;; Add parent groups references above the group.
(when (eq level 1)
(if (custom-add-parent-links widget "Parent groups:")
(insert "\n")))
(insert-char ?\ (* custom-buffer-indent (1- level)))
;; Create tag.
(let ((start (point)))
(insert tag " group: ")
(widget-specify-sample widget start (point)))
(cond
((not doc)
(insert " Group definition missing. "))
((< (length doc) 50)
(insert doc)))
;; Create visibility indicator.
(unless (eq custom-buffer-style 'links)
(insert "--------")
(push (widget-create-child-and-convert
widget 'visibility
:help-echo "Hide members of this group."
:action 'custom-toggle-parent
(not (eq state 'hidden)))
buttons)
(insert " "))
(insert "\n")
;; Create magic button.
(let ((magic (widget-create-child-and-convert
widget 'custom-magic
:indent 0
nil)))
(widget-put widget :custom-magic magic)
(push magic buttons))
;; Update buttons.
(widget-put widget :buttons buttons)
;; Insert documentation.
(when (and doc (>= (length doc) 50))
(widget-add-documentation-string-button
widget :visibility-widget 'custom-visibility))
;; Parent groups.
(if nil ;;; This should test that the buffer
;;; was not made to display a group.
(when (eq level 1)
(insert-char ?\ custom-buffer-indent)
(custom-add-parent-links widget)))
(custom-add-see-also widget
(make-string (* custom-buffer-indent level)
?\ ))
;; Members.
(message "Creating group...")
(let* ((members (custom-sort-items
members
;; Never sort the top-level custom group.
(unless (eq symbol 'emacs)
custom-buffer-sort-alphabetically)
custom-buffer-order-groups))
(prefixes (widget-get widget :custom-prefixes))
(custom-prefix-list (custom-prefix-add symbol prefixes))
(len (length members))
(count 0)
(reporter (make-progress-reporter
"Creating group entries..." 0 len))
(have-subtitle (and (not (eq symbol 'emacs))
(eq custom-buffer-order-groups 'last)))
prev-type
children)
(dolist (entry members)
(unless (eq prev-type 'custom-group)
(widget-insert "\n"))
(progress-reporter-update reporter (setq count (1+ count)))
(let ((sym (nth 0 entry))
(type (nth 1 entry)))
(when (and have-subtitle (eq type 'custom-group))
(setq have-subtitle nil)
(widget-insert
(propertize "Subgroups:\n" 'face 'custom-group-subtitle)))
(setq prev-type type)
(push (widget-create-child-and-convert
widget type
:group widget
:tag (custom-unlispify-tag-name sym)
:custom-prefixes custom-prefix-list
:custom-level (1+ level)
:value sym)
children)
(unless (eq (preceding-char) ?\n)
(widget-insert "\n"))))
(setq children (nreverse children))
(mapc 'custom-magic-reset children)
(widget-put widget :children children)
(custom-group-state-update widget)
(progress-reporter-done reporter))
;; End line
(let ((p (1+ (point))))
(insert "\n\n")
(put-text-property p (1+ p) 'face '(:underline t))
(overlay-put (make-overlay p (1+ p))
'before-string
(propertize "\n" 'face '(:underline t)
'display '(space :align-to 999))))))))
(defvar custom-group-menu
`(("Set for Current Session" custom-group-set
(lambda (widget)
(eq (widget-get widget :custom-state) 'modified)))
,@(when (or custom-file init-file-user)
'(("Save for Future Sessions" custom-group-save
(lambda (widget)
(memq (widget-get widget :custom-state) '(modified set))))))
("Undo Edits" custom-group-reset-current
(lambda (widget)
(memq (widget-get widget :custom-state) '(modified))))
("Revert This Session's Customizations" custom-group-reset-saved
(lambda (widget)
(memq (widget-get widget :custom-state) '(modified set))))
,@(when (or custom-file init-file-user)
'(("Erase Customization" custom-group-reset-standard
(lambda (widget)
(memq (widget-get widget :custom-state) '(modified set saved)))))))
"Alist of actions for the `custom-group' widget.
Each entry has the form (NAME ACTION FILTER) where NAME is the name of
the menu entry, ACTION is the function to call on the widget when the
menu is selected, and FILTER is a predicate which takes a `custom-group'
widget as an argument, and returns non-nil if ACTION is valid on that
widget. If FILTER is nil, ACTION is always valid.")
(defun custom-group-action (widget &optional event)
"Show the menu for `custom-group' WIDGET.
Optional EVENT is the location for the menu."
(if (eq (widget-get widget :custom-state) 'hidden)
(custom-toggle-hide widget)
(let* ((completion-ignore-case t)
(answer (widget-choose (concat "Operation on "
(custom-unlispify-tag-name
(widget-get widget :value)))
(custom-menu-filter custom-group-menu
widget)
event)))
(if answer
(funcall answer widget)))))
(defun custom-group-set (widget)
"Set changes in all modified group members."
(dolist (child (widget-get widget :children))
(when (eq (widget-get child :custom-state) 'modified)
(widget-apply child :custom-set))))
(defun custom-group-mark-to-save (widget)
"Mark all modified group members for saving."
(dolist (child (widget-get widget :children))
(when (memq (widget-get child :custom-state) '(modified set))
(widget-apply child :custom-mark-to-save))))
(defsubst custom-group-state-set-and-redraw (widget)
"Set state of group widget WIDGET and redraw with current settings."
(dolist (child (widget-get widget :children))
(when (memq (widget-get child :custom-state) '(modified set))
(widget-apply child :custom-state-set-and-redraw))))
(defun custom-group-save (widget)
"Save all modified group members."
(custom-group-mark-to-save widget)
(custom-save-all)
(custom-group-state-set-and-redraw widget))
(defun custom-group-reset-current (widget)
"Reset all modified group members."
(dolist (child (widget-get widget :children))
(when (eq (widget-get child :custom-state) 'modified)
(widget-apply child :custom-reset-current))))
(defun custom-group-reset-saved (widget)
"Reset all modified or set group members."
(dolist (child (widget-get widget :children))
(when (memq (widget-get child :custom-state) '(modified set))
(widget-apply child :custom-reset-saved))))
(defun custom-group-reset-standard (widget)
"Reset all modified, set, or saved group members."
(let ((custom-reset-standard-variables-list '(t))
(custom-reset-standard-faces-list '(t)))
(custom-group-mark-to-reset-standard widget)
(custom-reset-standard-save-and-update)))
(defun custom-group-mark-to-reset-standard (widget)
"Mark to reset all modified, set, or saved group members."
(dolist (child (widget-get widget :children))
(when (memq (widget-get child :custom-state)
'(modified set saved))
(widget-apply child :custom-mark-to-reset-standard))))
(defun custom-group-state-update (widget)
"Update magic."
(unless (eq (widget-get widget :custom-state) 'hidden)
(let* ((children (widget-get widget :children))
(states (mapcar (lambda (child)
(widget-get child :custom-state))
children))
(magics custom-magic-alist)
(found 'standard))
(while magics
(let ((magic (car (car magics))))
(if (and (not (eq magic 'hidden))
(memq magic states))
(setq found magic
magics nil)
(setq magics (cdr magics)))))
(widget-put widget :custom-state found)))
(custom-magic-reset widget))
\f
;;; Reading and writing the custom file.
;;;###autoload
(defcustom custom-file nil
"File used for storing customization information.
The default is nil, which means to use your init file
as specified by `user-init-file'. If the value is not nil,
it should be an absolute file name.
You can set this option through Custom, if you carefully read the
last paragraph below. However, usually it is simpler to write
something like the following in your init file:
\(setq custom-file \"~/.emacs-custom.el\")
\(load custom-file)
Note that both lines are necessary: the first line tells Custom to
save all customizations in this file, but does not load it.
When you change this variable outside Custom, look in the
previous custom file \(usually your init file) for the
forms `(custom-set-variables ...)' and `(custom-set-faces ...)',
and copy them (whichever ones you find) to the new custom file.
This will preserve your existing customizations.
If you save this option using Custom, Custom will write all
currently saved customizations, including the new one for this
option itself, into the file you specify, overwriting any
`custom-set-variables' and `custom-set-faces' forms already
present in that file. It will not delete any customizations from
the old custom file. You should do that manually if that is what you
want. You also have to put something like `\(load \"CUSTOM-FILE\")
in your init file, where CUSTOM-FILE is the actual name of the
file. Otherwise, Emacs will not load the file when it starts up,
and hence will not set `custom-file' to that file either."
:type '(choice (const :tag "Your Emacs init file" nil)
(file :format "%t:%v%d"
:doc
"Please read entire docstring below before setting \
this through Custom.
Click on \"More\" \(or position point there and press RETURN)
if only the first line of the docstring is shown."))
:group 'customize)
(defun custom-file (&optional no-error)
"Return the file name for saving customizations."
(if (null user-init-file)
;; Started with -q, i.e. the file containing Custom settings
;; hasn't been read. Saving settings there won't make much
;; sense.
(if no-error
nil
(user-error "Saving settings from \"emacs -q\" would overwrite existing customizations"))
(file-chase-links (or custom-file user-init-file))))
;; If recentf-mode is non-nil, this is defined.
(declare-function recentf-expand-file-name "recentf" (name))
;;;###autoload
(defun custom-save-all ()
"Save all customizations in `custom-file'."
(when (and (null custom-file) init-file-had-error)
(error "Cannot save customizations; init file was not fully loaded"))
(let* ((filename (custom-file))
(recentf-exclude
(if recentf-mode
(cons (concat "\\`"
(regexp-quote
(recentf-expand-file-name (custom-file)))
"\\'")
recentf-exclude)))
(old-buffer (find-buffer-visiting filename))
old-buffer-name)
(with-current-buffer (let ((find-file-visit-truename t))
(or old-buffer (find-file-noselect filename)))
;; We'll save using file-precious-flag, so avoid destroying
;; symlinks. (If we're not already visiting the buffer, this is
;; handled by find-file-visit-truename, above.)
(when old-buffer
(setq old-buffer-name (buffer-file-name))
(set-visited-file-name (file-chase-links filename)))
(unless (eq major-mode 'emacs-lisp-mode)
(emacs-lisp-mode))
(let ((inhibit-read-only t)
(print-length nil)
(print-level nil))
(custom-save-variables)
(custom-save-faces))
(let ((file-precious-flag t))
(save-buffer))
(if old-buffer
(progn
(set-visited-file-name old-buffer-name)
(set-buffer-modified-p nil))
(kill-buffer (current-buffer))))))
;;;###autoload
(defun customize-save-customized ()
"Save all user options which have been set in this session."
(interactive)
(mapatoms (lambda (symbol)
(let ((face (get symbol 'customized-face))
(value (get symbol 'customized-value))
(face-comment (get symbol 'customized-face-comment))
(variable-comment
(get symbol 'customized-variable-comment)))
(when face
(put symbol 'saved-face face)
(custom-push-theme 'theme-face symbol 'user 'set value)
(put symbol 'customized-face nil))
(when value
(put symbol 'saved-value value)
(custom-push-theme 'theme-value symbol 'user 'set value)
(put symbol 'customized-value nil))
(when variable-comment
(put symbol 'saved-variable-comment variable-comment)
(put symbol 'customized-variable-comment nil))
(when face-comment
(put symbol 'saved-face-comment face-comment)
(put symbol 'customized-face-comment nil)))))
;; We really should update all custom buffers here.
(custom-save-all))
\f
;; Editing the custom file contents in a buffer.
(defun custom-save-delete (symbol)
"Delete all calls to SYMBOL from the contents of the current buffer.
Leave point at the old location of the first such call,
or (if there were none) at the end of the buffer.
This function does not save the buffer."
(goto-char (point-min))
;; Skip all whitespace and comments.
(while (forward-comment 1))
(or (eobp)
(save-excursion (forward-sexp (buffer-size)))) ; Test for scan errors.
(let (first)
(catch 'found
(while t ;; We exit this loop only via throw.
;; Skip all whitespace and comments.
(while (forward-comment 1))
(let ((start (point))
(sexp (condition-case nil
(read (current-buffer))
(end-of-file (throw 'found nil)))))
(when (and (listp sexp)
(eq (car sexp) symbol))
(delete-region start (point))
(unless first
(setq first (point)))))))
(if first
(goto-char first)
;; Move in front of local variables, otherwise long Custom
;; entries would make them ineffective.
(let ((pos (point-max))
(case-fold-search t))
(save-excursion
(goto-char (point-max))
(search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
'move)
(when (search-forward "Local Variables:" nil t)
(setq pos (line-beginning-position))))
(goto-char pos)))))
(defvar sort-fold-case) ; defined in sort.el
(defun custom-save-variables ()
"Save all customized variables in `custom-file'."
(save-excursion
(custom-save-delete 'custom-set-variables)
(let ((standard-output (current-buffer))
(saved-list (make-list 1 0))
sort-fold-case)
;; First create a sorted list of saved variables.
(mapatoms
(lambda (symbol)
(if (and (get symbol 'saved-value)
;; ignore theme values
(or (null (get symbol 'theme-value))
(eq 'user (caar (get symbol 'theme-value)))))
(nconc saved-list (list symbol)))))
(setq saved-list (sort (cdr saved-list) 'string<))
(unless (bolp)
(princ "\n"))
(princ "(custom-set-variables
;; custom-set-variables was added by Custom.
;; If you edit it by hand, you could mess it up, so be careful.
;; Your init file should contain only one such instance.
;; If there is more than one, they won't work right.\n")
(dolist (symbol saved-list)
(let ((spec (car-safe (get symbol 'theme-value)))
(value (get symbol 'saved-value))
(requests (get symbol 'custom-requests))
(now (and (not (custom-variable-p symbol))
(or (boundp symbol)
(eq (get symbol 'force-value)
'rogue))))
(comment (get symbol 'saved-variable-comment)))
;; Check REQUESTS for validity.
(dolist (request requests)
(when (and (symbolp request) (not (featurep request)))
(message "Unknown requested feature: %s" request)
(setq requests (delq request requests))))
;; Is there anything customized about this variable?
(when (or (and spec (eq (car spec) 'user))
comment
(and (null spec) (get symbol 'saved-value)))
;; Output an element for this variable.
;; It has the form (SYMBOL VALUE-FORM NOW REQUESTS COMMENT).
;; SYMBOL is the variable name.
;; VALUE-FORM is an expression to return the customized value.
;; NOW if non-nil means always set the variable immediately
;; when the customizations are reloaded. This is used
;; for rogue variables
;; REQUESTS is a list of packages to load before setting the
;; variable. Each element of it will be passed to `require'.
;; COMMENT is whatever comment the user has specified
;; with the customize facility.
(unless (bolp)
(princ "\n"))
(princ " '(")
(prin1 symbol)
(princ " ")
(prin1 (car value))
(when (or now requests comment)
(princ " ")
(prin1 now)
(when (or requests comment)
(princ " ")
(prin1 requests)
(when comment
(princ " ")
(prin1 comment))))
(princ ")"))))
(if (bolp)
(princ " "))
(princ ")")
(unless (looking-at "\n")
(princ "\n")))))
(defun custom-save-faces ()
"Save all customized faces in `custom-file'."
(save-excursion
(custom-save-delete 'custom-reset-faces)
(custom-save-delete 'custom-set-faces)
(let ((standard-output (current-buffer))
(saved-list (make-list 1 0))
sort-fold-case)
;; First create a sorted list of saved faces.
(mapatoms
(lambda (symbol)
(if (and (get symbol 'saved-face)
(eq 'user (car (car-safe (get symbol 'theme-face)))))
(nconc saved-list (list symbol)))))
(setq saved-list (sort (cdr saved-list) 'string<))
;; The default face must be first, since it affects the others.
(if (memq 'default saved-list)
(setq saved-list (cons 'default (delq 'default saved-list))))
(unless (bolp)
(princ "\n"))
(princ "(custom-set-faces
;; custom-set-faces was added by Custom.
;; If you edit it by hand, you could mess it up, so be careful.
;; Your init file should contain only one such instance.
;; If there is more than one, they won't work right.\n")
(dolist (symbol saved-list)
(let ((spec (car-safe (get symbol 'theme-face)))
(value (get symbol 'saved-face))
(now (not (or (get symbol 'face-defface-spec)
(and (not (custom-facep symbol))
(not (get symbol 'force-face))))))
(comment (get symbol 'saved-face-comment)))
(when (or (and spec (eq (nth 0 spec) 'user))
comment
(and (null spec) (get symbol 'saved-face)))
;; Don't print default face here.
(unless (bolp)
(princ "\n"))
(princ " '(")
(prin1 symbol)
(princ " ")
(prin1 value)
(when (or now comment)
(princ " ")
(prin1 now)
(when comment
(princ " ")
(prin1 comment)))
(princ ")"))))
(if (bolp)
(princ " "))
(princ ")")
(unless (looking-at "\n")
(princ "\n")))))
\f
;;; The Customize Menu.
;;; Menu support
(defcustom custom-menu-nesting 2
"Maximum nesting in custom menus."
:type 'integer
:group 'custom-menu)
(defun custom-face-menu-create (_widget symbol)
"Ignoring WIDGET, create a menu entry for customization face SYMBOL."
(vector (custom-unlispify-menu-entry symbol)
`(customize-face ',symbol)
t))
(defun custom-variable-menu-create (_widget symbol)
"Ignoring WIDGET, create a menu entry for customization variable SYMBOL."
(let ((type (get symbol 'custom-type)))
(unless (listp type)
(setq type (list type)))
(if (and type (widget-get type :custom-menu))
(widget-apply type :custom-menu symbol)
(vector (custom-unlispify-menu-entry symbol)
`(customize-variable ',symbol)
t))))
;; Add checkboxes to boolean variable entries.
(widget-put (get 'boolean 'widget-type)
:custom-menu (lambda (_widget symbol)
(vector (custom-unlispify-menu-entry symbol)
`(customize-variable ',symbol)
':style 'toggle
':selected symbol)))
(defun custom-group-menu-create (_widget symbol)
"Ignoring WIDGET, create a menu entry for customization group SYMBOL."
`( ,(custom-unlispify-menu-entry symbol t)
:filter (lambda (&rest junk)
(let* ((menu (custom-menu-create ',symbol)))
(if (consp menu) (cdr menu) menu)))))
;;;###autoload
(defun custom-menu-create (symbol)
"Create menu for customization group SYMBOL.
The menu is in a format applicable to `easy-menu-define'."
(let* ((deactivate-mark nil)
(item (vector (custom-unlispify-menu-entry symbol)
`(customize-group ',symbol)
t)))
(if (and (or (not (boundp 'custom-menu-nesting))
(>= custom-menu-nesting 0))
(progn
(custom-load-symbol symbol)
(< (length (get symbol 'custom-group)) widget-menu-max-size)))
(let ((custom-prefix-list (custom-prefix-add symbol
custom-prefix-list))
(members (custom-sort-items (get symbol 'custom-group)
custom-menu-sort-alphabetically
custom-menu-order-groups)))
`(,(custom-unlispify-menu-entry symbol t)
,item
"--"
,@(mapcar (lambda (entry)
(widget-apply (if (listp (nth 1 entry))
(nth 1 entry)
(list (nth 1 entry)))
:custom-menu (nth 0 entry)))
members)))
item)))
;;;###autoload
(defun customize-menu-create (symbol &optional name)
"Return a customize menu for customization group SYMBOL.
If optional NAME is given, use that as the name of the menu.
Otherwise the menu will be named `Customize'.
The format is suitable for use with `easy-menu-define'."
(unless name
(setq name "Customize"))
`(,name
:filter (lambda (&rest junk)
(let ((menu (custom-menu-create ',symbol)))
(if (consp menu) (cdr menu) menu)))))
;;; Toolbar and menubar support
(easy-menu-define
Custom-mode-menu (list custom-mode-map custom-field-keymap)
"Menu used in customization buffers."
(nconc (list "Custom"
(customize-menu-create 'customize))
(mapcar (lambda (arg)
(let ((tag (nth 0 arg))
(command (nth 1 arg))
(active (nth 2 arg))
(help (nth 3 arg)))
(vector tag command :active (eval active) :help help)))
custom-commands)))
(defvar tool-bar-map)
;;; `custom-tool-bar-map' used to be set up here. This will fail to
;;; DTRT when `display-graphic-p' returns nil during compilation. Hence
;;; we set this up lazily in `Custom-mode'.
(defvar custom-tool-bar-map nil
"Keymap for toolbar in Custom mode.")
;;; The Custom Mode.
(defun Custom-no-edit (_pos &optional _event)
"Invoke button at POS, or refuse to allow editing of Custom buffer."
(interactive "@d")
(error "You can't edit this part of the Custom buffer"))
(defun Custom-newline (pos &optional event)
"Invoke button at POS, or refuse to allow editing of Custom buffer."
(interactive "@d")
(let ((button (get-char-property pos 'button)))
;; If there is no button at point, then use the one at the start
;; of the line, if it is a custom-group-link (bug#2298).
(or button
(if (setq button (get-char-property (line-beginning-position) 'button))
(or (eq (widget-type button) 'custom-group-link)
(setq button nil))))
(if button
(widget-apply-action button event)
(error "You can't edit this part of the Custom buffer"))))
(defun Custom-goto-parent ()
"Go to the parent group listed at the top of this buffer.
If several parents are listed, go to the first of them."
(interactive)
(save-excursion
(goto-char (point-min))
(if (search-forward "\nParent groups: " nil t)
(let* ((button (get-char-property (point) 'button))
(parent (downcase (widget-get button :tag))))
(customize-group parent)))))
(defcustom Custom-mode-hook nil
"Hook called when entering Custom mode."
:type 'hook
:group 'custom-buffer)
(defun custom-state-buffer-message (widget)
(if (eq (widget-get (widget-get widget :parent) :custom-state) 'modified)
(message "To install your edits, invoke [State] and choose the Set operation")))
(defun custom--initialize-widget-variables ()
(set (make-local-variable 'widget-documentation-face) 'custom-documentation)
(set (make-local-variable 'widget-button-face) custom-button)
(set (make-local-variable 'widget-button-pressed-face) custom-button-pressed)
(set (make-local-variable 'widget-mouse-face) custom-button-mouse)
;; We need this because of the "More" button on docstrings.
;; Otherwise clicking on "More" can push point offscreen, which
;; causes the window to recenter on point, which pushes the
;; newly-revealed docstring offscreen; which is annoying. -- cyd.
(set (make-local-variable 'widget-button-click-moves-point) t)
;; When possible, use relief for buttons, not bracketing. This test
;; may not be optimal.
(when custom-raised-buttons
(set (make-local-variable 'widget-push-button-prefix) "")
(set (make-local-variable 'widget-push-button-suffix) "")
(set (make-local-variable 'widget-link-prefix) "")
(set (make-local-variable 'widget-link-suffix) ""))
(setq show-trailing-whitespace nil))
(define-obsolete-variable-alias 'custom-mode-hook 'Custom-mode-hook "23.1")
(define-derived-mode Custom-mode nil "Custom"
"Major mode for editing customization buffers.
The following commands are available:
\\<widget-keymap>\
Move to next button, link or editable field. \\[widget-forward]
Move to previous button, link or editable field. \\[widget-backward]
\\<custom-field-keymap>\
Complete content of editable text field. \\[widget-complete]
\\<custom-mode-map>\
Invoke button under the mouse pointer. \\[widget-button-click]
Invoke button under point. \\[widget-button-press]
Set all options from current text. \\[Custom-set]
Make values in current text permanent. \\[Custom-save]
Make text match actual option values. \\[Custom-reset-current]
Reset options to permanent settings. \\[Custom-reset-saved]
Erase customizations; set options
and buffer text to the standard values. \\[Custom-reset-standard]
Entry to this mode calls the value of `Custom-mode-hook'
if that value is non-nil."
(use-local-map custom-mode-map)
(easy-menu-add Custom-mode-menu)
(set (make-local-variable 'tool-bar-map)
(or custom-tool-bar-map
;; Set up `custom-tool-bar-map'.
(let ((map (make-sparse-keymap)))
(mapc
(lambda (arg)
(tool-bar-local-item-from-menu
(nth 1 arg) (nth 4 arg) map custom-mode-map
:label (nth 5 arg)))
custom-commands)
(setq custom-tool-bar-map map))))
(make-local-variable 'custom-options)
(make-local-variable 'custom-local-buffer)
(custom--initialize-widget-variables)
(add-hook 'widget-edit-functions 'custom-state-buffer-message nil t))
(put 'Custom-mode 'mode-class 'special)
(define-obsolete-function-alias 'custom-mode 'Custom-mode "23.1")
(add-to-list 'debug-ignored-errors "^Invalid face:? ")
;;; The End.
(provide 'cus-edit)
;;; cus-edit.el ends here
|